Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: switch to adapter-react-v5 #1096

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

feat: switch to adapter-react-v5 #1096

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
058062b
edit templates to conform with adapter-react-v5
stevenengland Feb 20, 2024
c3137ab
accept baselines
stevenengland Feb 22, 2024
13197d3
update changelog
stevenengland Feb 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
## __WORK IN PROGRESS__
(at the beginning of a new line )
-->
## __WORK IN PROGRESS__
* (stevenengland) Migrate from adapter-react to adapter-react-v5 (#1095)

## 2.6.2 (2024-02-12)
* (theknut) Make ioBroker types available in the test directory (#1091)
* (theknut) Add `licenseInformation` field to `io-package.json` (#1092)
Expand Down
12 changes: 7 additions & 5 deletions templates/admin/src/app.tsx_jsx.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,21 @@ const templateFunction: TemplateFunction = answers => {

const template = `
import React from "react";
import { ${useTypeScript ? "Theme, " : ""}withStyles } from "@material-ui/core/styles";
import { withStyles } from "@mui/styles";
${useTypeScript ?
"import { Theme } from '@mui/material/styles';" : ""}

import GenericApp from "@iobroker/adapter-react/GenericApp";
import GenericApp from "@iobroker/adapter-react-v5/GenericApp";
import Settings from "./components/settings";
${useTypeScript ?
`import { GenericAppProps, GenericAppSettings } from "@iobroker/adapter-react/types";
import { StyleRules } from "@material-ui/core/styles";
`import { GenericAppProps, GenericAppSettings } from "@iobroker/adapter-react-v5/types";
import { StyleRules } from "@mui/styles/withStyles";
` : ""}
${useTypeScript ?
`const styles = (_theme: Theme): StyleRules => ({
root: {},
});` : `/**
* @type {(_theme: import("@material-ui/core/styles").Theme) => import("@material-ui/styles").StyleRules}
* @type {(_theme: import("@mui/material/styles").Theme) => import("@mui/styles/withStyles").StyleRules}
*/
const styles = (_theme) => ({
root: {},
Expand Down
27 changes: 15 additions & 12 deletions templates/admin/src/components/settings.tsx_jsx.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,20 +25,20 @@ const templateFunction: TemplateFunction = answers => {

const template = `
import React from "react";
import { withStyles } from "@material-ui/core/styles";
${useTypeScript ? `import { CreateCSSProperties } from "@material-ui/core/styles/withStyles";
` : ""}import TextField from "@material-ui/core/TextField";
import Input from "@material-ui/core/Input";
import FormHelperText from "@material-ui/core/FormHelperText";
import FormControl from "@material-ui/core/FormControl";
import Select from "@material-ui/core/Select";
import MenuItem from "@material-ui/core/MenuItem";
import FormControlLabel from "@material-ui/core/FormControlLabel";
import Checkbox from "@material-ui/core/Checkbox";
import I18n from "@iobroker/adapter-react/i18n";
import { withStyles } from "@mui/styles";
${useTypeScript ? `import { CreateCSSProperties } from "@mui/styles/withStyles";
` : ""}import TextField from "@mui/material/TextField";
import Input from "@mui/material/Input";
import FormHelperText from "@mui/material/FormHelperText";
import FormControl from "@mui/material/FormControl";
import Select from "@mui/material/Select";
import MenuItem from "@mui/material/MenuItem";
import FormControlLabel from "@mui/material/FormControlLabel";
import Checkbox from "@mui/material/Checkbox";
import I18n from "@iobroker/adapter-react-v5/i18n";

${useTypeScript ? "" : `/**
* @type {() => Record<string, import("@material-ui/core/styles/withStyles").CreateCSSProperties>}
* @type {() => Record<string, import("@mui/styles/withStyles").CreateCSSProperties>}
*/`}
const styles = ()${useTypeScript ? ": Record<string, CreateCSSProperties>" : ""} => ({
input: {
Expand Down Expand Up @@ -119,6 +119,7 @@ ${useTypeScript ? "" : `/**
type={type || "text"}
onChange={(e) => this.props.onChange(attr, e.target.value)}
margin="normal"
variant="standard"
/>
);
}
Expand All @@ -142,11 +143,13 @@ ${useTypeScript ? "" : `/**
paddingTop: 5,
...style
}}
variant="standard"
>
<Select
value={this.props.native[attr] || "_"}
onChange={(e) => this.props.onChange(attr, e.target.value === "_" ? "" : e.target.value)}
input={<Input name={attr} id={attr + "-helper"} />}
variant="standard"
>
{options.map((item) => (
<MenuItem key={"key-" + item.value} value={item.value || "_"}>
Expand Down
4 changes: 2 additions & 2 deletions templates/admin/src/i18n/i18n.dts.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ const templateFunction: TemplateFunction = answers => {
const template = `
/*
* This file loads the translations keys from \`i18n/en.json\` file and overrides
* the declarations for the translate function \`I18n.t\` available in "@iobroker/adapter-react/i18n".
* the declarations for the translate function \`I18n.t\` available in "@iobroker/adapter-react-v5/i18n".
* Using these definitions it is ensured that all used translations in the React
* context are defined at least in the english translations file.
* This will add no overhead in the generated code since it just reexports the
Expand All @@ -29,7 +29,7 @@ const templateFunction: TemplateFunction = answers => {
*/
declare type AdminWord = keyof typeof import("./en.json");

declare module "@iobroker/adapter-react/i18n" {
declare module "@iobroker/adapter-react-v5/i18n" {
/**
* Translate the given string to the selected language.
* @param word The (key) word to look up the string. Has to be defined at least in \`i18n/en.json\`.
Expand Down
28 changes: 15 additions & 13 deletions templates/admin/src/index.tsx_jsx.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,26 @@ const templateFunction: TemplateFunction = answers => {
const template = `
import React from "react";
import ReactDOM from "react-dom";
import { MuiThemeProvider } from "@material-ui/core/styles";
import theme from "@iobroker/adapter-react/Theme";
import Utils from "@iobroker/adapter-react/Components/Utils";
import { ThemeProvider, StyledEngineProvider } from '@mui/material/styles';
import theme from "@iobroker/adapter-react-v5/Theme";
import Utils from "@iobroker/adapter-react-v5/Components/Utils";
import App from "./app";

let themeName = Utils.getThemeName();

function build()${useTypeScript ? ": void" : ""} {
function build(${useTypeScript ? "this: any" : ""})${useTypeScript ? ": void" : ""} {
ReactDOM.render(
<MuiThemeProvider theme={theme(themeName)}>
<App
adapterName="${answers.adapterName}"
onThemeChange={(_theme) => {
themeName = _theme;
build();
}}
/>
</MuiThemeProvider>,
<StyledEngineProvider injectFirst>
<ThemeProvider theme={theme(themeName)}>
<App
adapterName="${answers.adapterName}"
onThemeChange={(_theme) => {
themeName = _theme;
build();
}}
/>
</ThemeProvider>
</StyledEngineProvider>,
document.getElementById("root"),
);
}
Expand Down
12 changes: 7 additions & 5 deletions templates/admin/src/tab-app.tsx_jsx.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,20 @@ const templateFunction: TemplateFunction = answers => {

const template = `
import React from "react";
import { ${useTypeScript ? "Theme, " : ""}withStyles } from "@material-ui/core/styles";
import { withStyles } from "@mui/styles";
${useTypeScript ?
"import { Theme } from '@mui/material/styles';" : ""}

import GenericApp from "@iobroker/adapter-react/GenericApp";
import GenericApp from "@iobroker/adapter-react-v5/GenericApp";
${useTypeScript ?
`import { GenericAppProps, GenericAppSettings } from "@iobroker/adapter-react/types";
import { StyleRules } from "@material-ui/core/styles";
`import { GenericAppProps, GenericAppSettings } from "@iobroker/adapter-react-v5/types";
import { StyleRules } from "@mui/styles/withStyles";
` : ""}
${useTypeScript ?
`const styles = (_theme: Theme): StyleRules => ({
root: {},
});` : `/**
* @type {(_theme: Theme) => import("@material-ui/styles").StyleRules}
* @type {(_theme: Theme) => import("@mui/styles/withStyles").StyleRules}
*/
const styles = (_theme) => ({
root: {},
Expand Down
26 changes: 14 additions & 12 deletions templates/admin/src/tab.tsx_jsx.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,26 @@ const templateFunction: TemplateFunction = answers => {
const template = `
import React from "react";
import ReactDOM from "react-dom";
import { MuiThemeProvider } from "@material-ui/core/styles";
import theme from "@iobroker/adapter-react/Theme";
import Utils from "@iobroker/adapter-react/Components/Utils";
import { ThemeProvider, StyledEngineProvider } from '@mui/material/styles';
import theme from "@iobroker/adapter-react-v5/Theme";
import Utils from "@iobroker/adapter-react-v5/Components/Utils";
import TabApp from "./tab-app";

let themeName = Utils.getThemeName();

function build()${useTypeScript ? ": void" : ""} {
ReactDOM.render(
<MuiThemeProvider theme={theme(themeName)}>
<TabApp
adapterName="${answers.adapterName}"
onThemeChange={(_theme) => {
themeName = _theme;
build();
}}
/>
</MuiThemeProvider>,
<StyledEngineProvider injectFirst>
<ThemeProvider theme={theme(themeName)}>
<TabApp
adapterName="${answers.adapterName}"
onThemeChange={(_theme) => {
themeName = _theme;
build();
}}
/>
</ThemeProvider>
</StyledEngineProvider>,
document.getElementById("root"),
);
}
Expand Down
6 changes: 4 additions & 2 deletions templates/package.json.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,11 @@ const templateFunction: TemplateFunction = async answers => {
"react@17",
"react-dom@17",
// ioBroker react framework
"@iobroker/adapter-react@2.0.22",
"@iobroker/adapter-react-v5@4",
// UI library
"@material-ui/core",
"@mui/material",
"@mui/styles",
"babel-eslint",
] : []),
...(useTypeChecking && useReact ? [
// React's type definitions
Expand Down
2 changes: 1 addition & 1 deletion test/baselines/ReleaseScript_JS/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
"@alcalzone/release-script-plugin-iobroker": "^3.7.0",
"@alcalzone/release-script-plugin-license": "^3.7.0",
"@alcalzone/release-script-plugin-manual-review": "^3.7.0",
"@iobroker/adapter-dev": "^1.2.0",
"@iobroker/adapter-dev": "^1.3.0",
"@iobroker/testing": "^4.1.0",
"chai-as-promised": "^7.1.1",
"chai": "^4.4.1",
Expand Down
8 changes: 4 additions & 4 deletions test/baselines/ReleaseScript_TS/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,18 +29,18 @@
"@alcalzone/release-script-plugin-iobroker": "^3.7.0",
"@alcalzone/release-script-plugin-license": "^3.7.0",
"@alcalzone/release-script-plugin-manual-review": "^3.7.0",
"@iobroker/adapter-dev": "^1.2.0",
"@iobroker/adapter-dev": "^1.3.0",
"@iobroker/testing": "^4.1.0",
"@tsconfig/node18": "^18.2.2",
"@types/chai": "^4.3.11",
"@types/chai-as-promised": "^7.1.8",
"@types/mocha": "^10.0.6",
"@types/node": "^18.19.15",
"@types/node": "^18.19.17",
"@types/proxyquire": "^1.3.31",
"@types/sinon": "^17.0.3",
"@types/sinon-chai": "^3.2.12",
"@typescript-eslint/eslint-plugin": "^6.21.0",
"@typescript-eslint/parser": "^6.21.0",
"@typescript-eslint/eslint-plugin": "^7.0.2",
"@typescript-eslint/parser": "^7.0.2",
"chai-as-promised": "^7.1.1",
"chai": "^4.4.1",
"eslint": "^8.56.0",
Expand Down
8 changes: 4 additions & 4 deletions test/baselines/TS_Prettier/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,18 +25,18 @@
"@iobroker/adapter-core": "^3.0.4"
},
"devDependencies": {
"@iobroker/adapter-dev": "^1.2.0",
"@iobroker/adapter-dev": "^1.3.0",
"@iobroker/testing": "^4.1.0",
"@tsconfig/node18": "^18.2.2",
"@types/chai": "^4.3.11",
"@types/chai-as-promised": "^7.1.8",
"@types/mocha": "^10.0.6",
"@types/node": "^18.19.15",
"@types/node": "^18.19.17",
"@types/proxyquire": "^1.3.31",
"@types/sinon": "^17.0.3",
"@types/sinon-chai": "^3.2.12",
"@typescript-eslint/eslint-plugin": "^6.21.0",
"@typescript-eslint/parser": "^6.21.0",
"@typescript-eslint/eslint-plugin": "^7.0.2",
"@typescript-eslint/parser": "^7.0.2",
"chai-as-promised": "^7.1.1",
"chai": "^4.4.1",
"eslint": "^8.56.0",
Expand Down
9 changes: 5 additions & 4 deletions test/baselines/TS_SingleQuotes/admin/src/app.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
import React from 'react';
import { Theme, withStyles } from '@material-ui/core/styles';
import { withStyles } from '@mui/styles';
import { Theme } from '@mui/material/styles';

import GenericApp from '@iobroker/adapter-react/GenericApp';
import GenericApp from '@iobroker/adapter-react-v5/GenericApp';
import Settings from './components/settings';
import { GenericAppProps, GenericAppSettings } from '@iobroker/adapter-react/types';
import { StyleRules } from '@material-ui/core/styles';
import { GenericAppProps, GenericAppSettings } from '@iobroker/adapter-react-v5/types';
import { StyleRules } from '@mui/styles/withStyles';

const styles = (_theme: Theme): StyleRules => ({
root: {},
Expand Down
25 changes: 14 additions & 11 deletions test/baselines/TS_SingleQuotes/admin/src/components/settings.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
import React from 'react';
import { withStyles } from '@material-ui/core/styles';
import { CreateCSSProperties } from '@material-ui/core/styles/withStyles';
import TextField from '@material-ui/core/TextField';
import Input from '@material-ui/core/Input';
import FormHelperText from '@material-ui/core/FormHelperText';
import FormControl from '@material-ui/core/FormControl';
import Select from '@material-ui/core/Select';
import MenuItem from '@material-ui/core/MenuItem';
import FormControlLabel from '@material-ui/core/FormControlLabel';
import Checkbox from '@material-ui/core/Checkbox';
import I18n from '@iobroker/adapter-react/i18n';
import { withStyles } from '@mui/styles';
import { CreateCSSProperties } from '@mui/styles/withStyles';
import TextField from '@mui/material/TextField';
import Input from '@mui/material/Input';
import FormHelperText from '@mui/material/FormHelperText';
import FormControl from '@mui/material/FormControl';
import Select from '@mui/material/Select';
import MenuItem from '@mui/material/MenuItem';
import FormControlLabel from '@mui/material/FormControlLabel';
import Checkbox from '@mui/material/Checkbox';
import I18n from '@iobroker/adapter-react-v5/i18n';

const styles = (): Record<string, CreateCSSProperties> => ({
input: {
Expand Down Expand Up @@ -71,6 +71,7 @@ class Settings extends React.Component<SettingsProps, SettingsState> {
type={type || 'text'}
onChange={(e) => this.props.onChange(attr, e.target.value)}
margin="normal"
variant="standard"
/>
);
}
Expand All @@ -88,11 +89,13 @@ class Settings extends React.Component<SettingsProps, SettingsState> {
paddingTop: 5,
...style
}}
variant="standard"
>
<Select
value={this.props.native[attr] || '_'}
onChange={(e) => this.props.onChange(attr, e.target.value === '_' ? '' : e.target.value)}
input={<Input name={attr} id={attr + '-helper'} />}
variant="standard"
>
{options.map((item) => (
<MenuItem key={'key-' + item.value} value={item.value || '_'}>
Expand Down
28 changes: 15 additions & 13 deletions test/baselines/TS_SingleQuotes/admin/src/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,25 @@
import React from 'react';
import ReactDOM from 'react-dom';
import { MuiThemeProvider } from '@material-ui/core/styles';
import theme from '@iobroker/adapter-react/Theme';
import Utils from '@iobroker/adapter-react/Components/Utils';
import { ThemeProvider, StyledEngineProvider } from '@mui/material/styles';
import theme from '@iobroker/adapter-react-v5/Theme';
import Utils from '@iobroker/adapter-react-v5/Components/Utils';
import App from './app';

let themeName = Utils.getThemeName();

function build(): void {
function build(this: any): void {
ReactDOM.render(
<MuiThemeProvider theme={theme(themeName)}>
<App
adapterName="test-adapter"
onThemeChange={(_theme) => {
themeName = _theme;
build();
}}
/>
</MuiThemeProvider>,
<StyledEngineProvider injectFirst>
<ThemeProvider theme={theme(themeName)}>
<App
adapterName="test-adapter"
onThemeChange={(_theme) => {
themeName = _theme;
build();
}}
/>
</ThemeProvider>
</StyledEngineProvider>,
document.getElementById('root'),
);
}
Expand Down
2 changes: 1 addition & 1 deletion test/baselines/TS_SingleQuotes/src/main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Created with @iobroker/create-adapter v2.6.1
* Created with @iobroker/create-adapter v2.6.2
*/

// The adapter-core module gives you access to the core ioBroker functions
Expand Down
Loading
Loading