Skip to content

Commit

Permalink
[FIX] Rename "studio" to "suite" (#129)
Browse files Browse the repository at this point in the history
**User-Facing Changes**
There is no user facing changes

**Description**
In order to keep the consistency between the application and it's name
conventions we are changing the mentions of "studio" to "suite". Taking
advantage of the PR we are also fixing some wrong github links and old naming references.

**Checklist**

- [x] The web version was tested and it is running ok
- [x] The desktop version was tested and it is running ok
- [x] I've updated/created the storybook file(s)
- [x] The release version was updated on package.json files
  • Loading branch information
laisspportugal authored Aug 5, 2024
1 parent 3ed68e7 commit b62a564
Show file tree
Hide file tree
Showing 1,259 changed files with 2,550 additions and 2,561 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/post-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ jobs:

- run: yarn install --immutable

- run: npm publish ./packages/studio
- run: npm publish ./packages/suite
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}

Expand Down
2 changes: 1 addition & 1 deletion .storybook/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

/* eslint-disable filenames/match-exported */

import { makeConfig } from "@lichtblick/studio-base/webpack";
import { makeConfig } from "@lichtblick/suite-base/webpack";
import { StorybookConfig } from "@storybook/react-webpack5";
import path from "path";
import { Configuration } from "webpack";
Expand Down
24 changes: 12 additions & 12 deletions .storybook/preview.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@
// file, You can obtain one at http://mozilla.org/MPL/2.0/

import { Condvar } from "@lichtblick/den/async";
import CssBaseline from "@lichtblick/studio-base/components/CssBaseline";
import GlobalCss from "@lichtblick/studio-base/components/GlobalCss";
import MultiProvider from "@lichtblick/studio-base/components/MultiProvider";
import StudioToastProvider from "@lichtblick/studio-base/components/StudioToastProvider";
import AppConfigurationContext from "@lichtblick/studio-base/context/AppConfigurationContext";
import { initI18n, Language } from "@lichtblick/studio-base/i18n";
import TimelineInteractionStateProvider from "@lichtblick/studio-base/providers/TimelineInteractionStateProvider";
import ReadySignalContext from "@lichtblick/studio-base/stories/ReadySignalContext";
import ThemeProvider from "@lichtblick/studio-base/theme/ThemeProvider";
import { makeMockAppConfiguration } from "@lichtblick/studio-base/util/makeMockAppConfiguration";
import waitForFonts from "@lichtblick/studio-base/util/waitForFonts";
import CssBaseline from "@lichtblick/suite-base/components/CssBaseline";
import GlobalCss from "@lichtblick/suite-base/components/GlobalCss";
import MultiProvider from "@lichtblick/suite-base/components/MultiProvider";
import StudioToastProvider from "@lichtblick/suite-base/components/StudioToastProvider";
import AppConfigurationContext from "@lichtblick/suite-base/context/AppConfigurationContext";
import { initI18n, Language } from "@lichtblick/suite-base/i18n";
import TimelineInteractionStateProvider from "@lichtblick/suite-base/providers/TimelineInteractionStateProvider";
import ReadySignalContext from "@lichtblick/suite-base/stories/ReadySignalContext";
import ThemeProvider from "@lichtblick/suite-base/theme/ThemeProvider";
import { makeMockAppConfiguration } from "@lichtblick/suite-base/util/makeMockAppConfiguration";
import waitForFonts from "@lichtblick/suite-base/util/waitForFonts";
import { GlobalStyles } from "@mui/material";
import { Story, StoryContext } from "@storybook/react";
import { useMemo, useRef, useEffect } from "react";
Expand Down Expand Up @@ -164,7 +164,7 @@ function StudioContextProviders({

function WithContextProviders(Child: Story, ctx: StoryContext): JSX.Element {
if (
(ctx.parameters.fileName as string).includes("/packages/studio-base/") ||
(ctx.parameters.fileName as string).includes("/packages/suite-base/") ||
(ctx.parameters.fileName as string).includes("/packages/theme/")
) {
return (
Expand Down
2 changes: 1 addition & 1 deletion .storybook/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"experimentalDecorators": true,
"useUnknownInCatchVariables": false,
"paths": {
"@lichtblick/studio-base/*": ["../packages/studio-base/src/*"]
"@lichtblick/suite-base/*": ["../packages/suite-base/src/*"]
}
}
}
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<a href="https://github.com/bmw-software-engineering/lichtblick/issues"><img src="https://img.shields.io/github/issues/bmw-software-engineering/lichtblick" alt="Issues Badge"/></a>
<a href="https://github.com/bmw-software-engineering/lichtblick/issues"><img src="https://img.shields.io/github/issues/bmw-software-engineering/lichtblick" alt="Version"/></a>
<a href="https://github.com/bmw-software-engineering/lichtblick/graphs/contributors"><img alt="GitHub contributors" src="https://img.shields.io/github/contributors/bmw-software-engineering/lichtblick?color=2b9348"></a>
<a href="https://github.com/bmw-software-engineering/lichtblick/blob/master/LICENSE"><img src="https://img.shields.io/github/license/bmw-software-engineering/lichtblick?color=2b9348" alt="License Badge"/></a>
<img alt="GitHub License" src="https://img.shields.io/github/license/bmw-software-engineering/lichtblick">

<br />
<p align="center">
Expand Down
4 changes: 2 additions & 2 deletions benchmark/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
"name": "benchmark",
"private": true,
"dependencies": {
"@lichtblick/studio-base": "workspace:*"
"@lichtblick/suite-base": "workspace:*"
},
"devDependencies": {
"@foxglove/rostime": "1.1.2",
"@foxglove/schemas": "1.6.3",
"@foxglove/tsconfig": "2.0.0",
"@lichtblick/den": "workspace:*",
"@lichtblick/log": "workspace:*",
"@lichtblick/studio": "workspace:*",
"@lichtblick/suite": "workspace:*",
"@pmmmwh/react-refresh-webpack-plugin": "0.5.11",
"@types/react": "18.2.56",
"@types/react-dom": "18.2.7",
Expand Down
2 changes: 1 addition & 1 deletion benchmark/src/Root.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {
AppSetting,
LaunchPreferenceValue,
StudioApp,
} from "@lichtblick/studio-base";
} from "@lichtblick/suite-base";
import { useMemo, useState } from "react";

import { McapLocalBenchmarkDataSourceFactory, SyntheticDataSourceFactory } from "./dataSources";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
import {
IDataSourceFactory,
DataSourceFactoryInitializeArgs,
} from "@lichtblick/studio-base/context/PlayerSelectionContext";
import { McapIterableSource } from "@lichtblick/studio-base/players/IterablePlayer/Mcap/McapIterableSource";
import { Player } from "@lichtblick/studio-base/players/types";
} from "@lichtblick/suite-base/context/PlayerSelectionContext";
import { McapIterableSource } from "@lichtblick/suite-base/players/IterablePlayer/Mcap/McapIterableSource";
import { Player } from "@lichtblick/suite-base/players/types";

import { BenchmarkPlayer } from "../players";

Expand Down
4 changes: 2 additions & 2 deletions benchmark/src/dataSources/SyntheticDataSourceFactory.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
import {
IDataSourceFactory,
DataSourceFactoryInitializeArgs,
} from "@lichtblick/studio-base/context/PlayerSelectionContext";
import { Player } from "@lichtblick/studio-base/players/types";
} from "@lichtblick/suite-base/context/PlayerSelectionContext";
import { Player } from "@lichtblick/suite-base/players/types";

type PlayerConstructor = new () => Player;

Expand Down
4 changes: 2 additions & 2 deletions benchmark/src/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// file, You can obtain one at http://mozilla.org/MPL/2.0/

import Logger from "@lichtblick/log";
import { initI18n } from "@lichtblick/studio-base";
import { initI18n } from "@lichtblick/suite-base";
import ReactDOM from "react-dom";

const log = Logger.getLogger(__filename);
Expand All @@ -19,7 +19,7 @@ if (!rootEl) {
}

async function main() {
const { overwriteFetch, waitForFonts } = await import("@lichtblick/studio-base");
const { overwriteFetch, waitForFonts } = await import("@lichtblick/suite-base");
overwriteFetch();
// consider moving waitForFonts into App to display an app loading screen
await waitForFonts();
Expand Down
2 changes: 1 addition & 1 deletion benchmark/src/layouts.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
// License, v2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/

import { LayoutData } from "@lichtblick/studio-base/context/CurrentLayoutContext/actions";
import { LayoutData } from "@lichtblick/suite-base/context/CurrentLayoutContext/actions";

import DefaultMultipleThreeDee from "./layouts/DefaultMultipleThreeDee.json";
import Empty from "./layouts/Empty.json";
Expand Down
14 changes: 7 additions & 7 deletions benchmark/src/players/BenchmarkPlayer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@

import { filterMap } from "@lichtblick/den/collection";
import Log from "@lichtblick/log";
import { MessageEvent } from "@lichtblick/studio";
import { GlobalVariables } from "@lichtblick/studio-base/hooks/useGlobalVariables";
import { BlockLoader } from "@lichtblick/studio-base/players/IterablePlayer/BlockLoader";
import { IIterableSource } from "@lichtblick/studio-base/players/IterablePlayer/IIterableSource";
import PlayerProblemManager from "@lichtblick/studio-base/players/PlayerProblemManager";
import { MessageEvent } from "@lichtblick/suite";
import { GlobalVariables } from "@lichtblick/suite-base/hooks/useGlobalVariables";
import { BlockLoader } from "@lichtblick/suite-base/players/IterablePlayer/BlockLoader";
import { IIterableSource } from "@lichtblick/suite-base/players/IterablePlayer/IIterableSource";
import PlayerProblemManager from "@lichtblick/suite-base/players/PlayerProblemManager";
import {
AdvertiseOptions,
Player,
Expand All @@ -18,8 +18,8 @@ import {
Progress,
PublishPayload,
SubscribePayload,
} from "@lichtblick/studio-base/players/types";
import delay from "@lichtblick/studio-base/util/delay";
} from "@lichtblick/suite-base/players/types";
import delay from "@lichtblick/suite-base/util/delay";

import { toRFC3339String } from "@foxglove/rostime";

Expand Down
8 changes: 4 additions & 4 deletions benchmark/src/players/PointcloudPlayer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
// file, You can obtain one at http://mozilla.org/MPL/2.0/

import Log from "@lichtblick/log";
import { MessageEvent } from "@lichtblick/studio";
import { GlobalVariables } from "@lichtblick/studio-base/hooks/useGlobalVariables";
import { MessageEvent } from "@lichtblick/suite";
import { GlobalVariables } from "@lichtblick/suite-base/hooks/useGlobalVariables";
import {
AdvertiseOptions,
Player,
Expand All @@ -14,8 +14,8 @@ import {
SubscribePayload,
Topic,
TopicStats,
} from "@lichtblick/studio-base/players/types";
import { RosDatatypes } from "@lichtblick/studio-base/types/RosDatatypes";
} from "@lichtblick/suite-base/players/types";
import { RosDatatypes } from "@lichtblick/suite-base/types/RosDatatypes";

import * as rostime from "@foxglove/rostime";
import { Time } from "@foxglove/rostime";
Expand Down
8 changes: 4 additions & 4 deletions benchmark/src/players/SinewavePlayer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
// file, You can obtain one at http://mozilla.org/MPL/2.0/

import Log from "@lichtblick/log";
import { MessageEvent } from "@lichtblick/studio";
import { GlobalVariables } from "@lichtblick/studio-base/hooks/useGlobalVariables";
import { MessageEvent } from "@lichtblick/suite";
import { GlobalVariables } from "@lichtblick/suite-base/hooks/useGlobalVariables";
import {
AdvertiseOptions,
Player,
Expand All @@ -14,8 +14,8 @@ import {
SubscribePayload,
Topic,
TopicStats,
} from "@lichtblick/studio-base/players/types";
import { RosDatatypes } from "@lichtblick/studio-base/types/RosDatatypes";
} from "@lichtblick/suite-base/players/types";
import { RosDatatypes } from "@lichtblick/suite-base/types/RosDatatypes";

import * as rostime from "@foxglove/rostime";
import { Time } from "@foxglove/rostime";
Expand Down
10 changes: 5 additions & 5 deletions benchmark/src/players/TransformPlayer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
// file, You can obtain one at http://mozilla.org/MPL/2.0/

import Log from "@lichtblick/log";
import { MessageEvent } from "@lichtblick/studio";
import { GlobalVariables } from "@lichtblick/studio-base/hooks/useGlobalVariables";
import { MessageEvent } from "@lichtblick/suite";
import { GlobalVariables } from "@lichtblick/suite-base/hooks/useGlobalVariables";
import {
AdvertiseOptions,
Player,
Expand All @@ -14,9 +14,9 @@ import {
SubscribePayload,
Topic,
TopicStats,
} from "@lichtblick/studio-base/players/types";
import { RosDatatypes } from "@lichtblick/studio-base/types/RosDatatypes";
import { Quaternion } from "@lichtblick/studio-base/util/geometry";
} from "@lichtblick/suite-base/players/types";
import { RosDatatypes } from "@lichtblick/suite-base/types/RosDatatypes";
import { Quaternion } from "@lichtblick/suite-base/util/geometry";

import * as rostime from "@foxglove/rostime";
import { Time } from "@foxglove/rostime";
Expand Down
12 changes: 6 additions & 6 deletions benchmark/src/players/TransformPreloadingPlayer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
// file, You can obtain one at http://mozilla.org/MPL/2.0/

import Log from "@lichtblick/log";
import { MessageEvent } from "@lichtblick/studio";
import { GlobalVariables } from "@lichtblick/studio-base/hooks/useGlobalVariables";
import { normalizeFrameTransform } from "@lichtblick/studio-base/panels/ThreeDeeRender/normalizeMessages";
import { MessageEvent } from "@lichtblick/suite";
import { GlobalVariables } from "@lichtblick/suite-base/hooks/useGlobalVariables";
import { normalizeFrameTransform } from "@lichtblick/suite-base/panels/ThreeDeeRender/normalizeMessages";
import {
AdvertiseOptions,
BlockCache,
Expand All @@ -18,9 +18,9 @@ import {
SubscribePayload,
Topic,
TopicStats,
} from "@lichtblick/studio-base/players/types";
import { RosDatatypes } from "@lichtblick/studio-base/types/RosDatatypes";
import delay from "@lichtblick/studio-base/util/delay";
} from "@lichtblick/suite-base/players/types";
import { RosDatatypes } from "@lichtblick/suite-base/types/RosDatatypes";
import delay from "@lichtblick/suite-base/util/delay";

import { Time, compare } from "@foxglove/rostime";
import { FrameTransform, Vector3 } from "@foxglove/schemas";
Expand Down
2 changes: 1 addition & 1 deletion benchmark/src/services/MemoryAppConfiguration.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
// License, v2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/

import { IAppConfiguration, ChangeHandler, AppConfigurationValue } from "@lichtblick/studio-base";
import { IAppConfiguration, ChangeHandler, AppConfigurationValue } from "@lichtblick/suite-base";

/**
* MemoryAppConfiguration implements IAppConfiguration by storing and reading configuration from
Expand Down
2 changes: 1 addition & 1 deletion benchmark/src/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"experimentalDecorators": true,
"useUnknownInCatchVariables": false,
"paths": {
"@lichtblick/studio-base/*": ["../../packages/studio-base/src/*"]
"@lichtblick/suite-base/*": ["../../packages/suite-base/src/*"]
}
}
}
4 changes: 2 additions & 2 deletions benchmark/webpack.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
// License, v2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/

import type { WebpackArgv } from "@lichtblick/studio-base/WebpackArgv";
import { makeConfig } from "@lichtblick/studio-base/webpack";
import type { WebpackArgv } from "@lichtblick/suite-base/WebpackArgv";
import { makeConfig } from "@lichtblick/suite-base/webpack";
import ReactRefreshPlugin from "@pmmmwh/react-refresh-webpack-plugin";
import { CleanWebpackPlugin } from "clean-webpack-plugin";
import HtmlWebpackPlugin from "html-webpack-plugin";
Expand Down
8 changes: 4 additions & 4 deletions ci/lint-unused-exports.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,16 @@ import tsUnusedExports from "ts-unused-exports";
// Note: use the "// ts-unused-exports:disable-next-line" comment above an export if you would like to mark it
// as used even though it appears unused. This might happen for exports which are injected via webpack.
async function main(): Promise<void> {
const results = tsUnusedExports(path.join(__dirname, "../packages/studio-base/tsconfig.json"), [
const results = tsUnusedExports(path.join(__dirname, "../packages/suite-base/tsconfig.json"), [
"--findCompletelyUnusedFiles",
"--ignoreLocallyUsed",
]);
const ignorePathsRegex = new RegExp(
[
String.raw`\.stories\.tsx?$`,
String.raw`packages/studio-base/src/index\.ts`,
String.raw`packages/studio-base/src/panels/ThreeDeeRender/transforms/index\.ts`, // `export *` is not correctly analyzed <https://github.com/pzavolinsky/ts-unused-exports/issues/286>
String.raw`packages/studio-base/src/test/`,
String.raw`packages/suite-base/src/index\.ts`,
String.raw`packages/suite-base/src/panels/ThreeDeeRender/transforms/index\.ts`, // `export *` is not correctly analyzed <https://github.com/pzavolinsky/ts-unused-exports/issues/286>
String.raw`packages/suite-base/src/test/`,
].join("|"),
);

Expand Down
2 changes: 1 addition & 1 deletion desktop/electronBuilderConfig.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

const {
makeElectronBuilderConfig,
} = require("@lichtblick/studio-desktop/src/electronBuilderConfig");
} = require("@lichtblick/suite-desktop/src/electronBuilderConfig");
const path = require("path");

module.exports = makeElectronBuilderConfig({
Expand Down
2 changes: 1 addition & 1 deletion desktop/main/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
// License, v2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/

import { main } from "@lichtblick/studio-desktop/src/main";
import { main } from "@lichtblick/suite-desktop/src/main";

void main();
4 changes: 2 additions & 2 deletions desktop/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
"@foxglove/tsconfig": "2.0.0",
"@lichtblick/den": "workspace:*",
"@lichtblick/log": "workspace:*",
"@lichtblick/studio-base": "workspace:*",
"@lichtblick/studio-desktop": "workspace:*",
"@lichtblick/suite-base": "workspace:*",
"@lichtblick/suite-desktop": "workspace:*",
"electron": "25.8.4",
"playwright": "1.37.1",
"webpack": "5.93.0"
Expand Down
2 changes: 1 addition & 1 deletion desktop/preload/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
// License, v2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/

import { main } from "@lichtblick/studio-desktop/src/preload";
import { main } from "@lichtblick/suite-desktop/src/preload";

main();
2 changes: 1 addition & 1 deletion desktop/quicklook/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
// License, v2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/

import { main } from "@lichtblick/studio-desktop/src/quicklook";
import { main } from "@lichtblick/suite-desktop/src/quicklook";

main();
8 changes: 4 additions & 4 deletions desktop/renderer/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
// License, v2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/

import { AppSetting } from "@lichtblick/studio-base";
import { Storage } from "@lichtblick/studio-desktop/src/common/types";
import { main as rendererMain } from "@lichtblick/studio-desktop/src/renderer/index";
import NativeStorageAppConfiguration from "@lichtblick/studio-desktop/src/renderer/services/NativeStorageAppConfiguration";
import { AppSetting } from "@lichtblick/suite-base";
import { Storage } from "@lichtblick/suite-desktop/src/common/types";
import { main as rendererMain } from "@lichtblick/suite-desktop/src/renderer/index";
import NativeStorageAppConfiguration from "@lichtblick/suite-desktop/src/renderer/services/NativeStorageAppConfiguration";

const isDevelopment = process.env.NODE_ENV === "development";

Expand Down
2 changes: 1 addition & 1 deletion desktop/renderer/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"useUnknownInCatchVariables": false,
"lib": ["dom", "dom.iterable", "es2022", "webworker"],
"paths": {
"@lichtblick/studio-base/*": ["../../packages/studio-base/src/*"]
"@lichtblick/suite-base/*": ["../../packages/suite-base/src/*"]
}
}
}
Loading

0 comments on commit b62a564

Please sign in to comment.