From 37867e0c2c17540ea97f158d89a03908d3d7a789 Mon Sep 17 00:00:00 2001 From: Andre Wanlin Date: Fri, 22 Dec 2023 06:56:15 -0600 Subject: [PATCH] Renamed based on feedback Signed-off-by: Andre Wanlin --- .changeset/young-rules-repeat.md | 2 +- docs/tutorials/migrate-to-mui5.md | 2 +- packages/eslint-plugin/README.md | 12 ++++++------ ...orts.md => no-top-level-material-ui-4-imports.md} | 4 ++-- packages/eslint-plugin/index.js | 2 +- ...orts.js => no-top-level-material-ui-4-imports.js} | 2 +- ...ts => no-top-level-material-ui-4-imports.test.ts} | 2 +- plugins/azure-devops/.eslintrc.js | 2 +- plugins/devtools/.eslintrc.js | 2 +- plugins/linguist/.eslintrc.js | 2 +- 10 files changed, 16 insertions(+), 16 deletions(-) rename packages/eslint-plugin/docs/rules/{no-top-level-mui4-imports.md => no-top-level-material-ui-4-imports.md} (83%) rename packages/eslint-plugin/rules/{no-top-level-mui4-imports.js => no-top-level-material-ui-4-imports.js} (98%) rename packages/eslint-plugin/src/{no-top-level-mui4-imports.test.ts => no-top-level-material-ui-4-imports.test.ts} (98%) diff --git a/.changeset/young-rules-repeat.md b/.changeset/young-rules-repeat.md index 5c9d790214..6fb17f0608 100644 --- a/.changeset/young-rules-repeat.md +++ b/.changeset/young-rules-repeat.md @@ -2,4 +2,4 @@ '@backstage/eslint-plugin': patch --- -Added new `@backstage/no-top-level-mui4-imports` rule that forbids top level imports from Material UI v4 packages +Added new `@backstage/no-top-level-material-ui-4-imports` rule that forbids top level imports from Material UI v4 packages diff --git a/docs/tutorials/migrate-to-mui5.md b/docs/tutorials/migrate-to-mui5.md index 1b21c8b419..aaf8cff7f5 100644 --- a/docs/tutorials/migrate-to-mui5.md +++ b/docs/tutorials/migrate-to-mui5.md @@ -56,7 +56,7 @@ For current known issues with the Material UI v5 migration, follow our [Mileston To migrate your plugin to Material UI v5, you can build on the resources available. -1. Manually fix the imports from named to default imports to match the new [linting rules for minimizing bundle size](https://mui.com/material-ui/guides/minimizing-bundle-size). Note: you can use the [new `@backstage/no-top-level-mui4-imports` ESLint](https://github.com/backstage/backstage/blob/master/packages/eslint-plugin/docs/rules/no-top-level-mui4-imports.md) rule to help with this. +1. Manually fix the imports from named to default imports to match the new [linting rules for minimizing bundle size](https://mui.com/material-ui/guides/minimizing-bundle-size). Note: you can use the [new `@backstage/no-top-level-material-ui-4-imports` ESLint](https://github.com/backstage/backstage/blob/master/packages/eslint-plugin/docs/rules/no-top-level-material-ui-4-imports.md) rule to help with this. 2. Run the migration `codemod` for the path of the specific plugin: `npx @mui/codemod v5.0.0/preset-safe plugins/`. 3. Take a look at possible `TODO:` items the `codemod` could not fix. 4. Remove types & methods from `@backstage/theme` which are marked as `@deprecated`. diff --git a/packages/eslint-plugin/README.md b/packages/eslint-plugin/README.md index 1304239caf..600b3268e1 100644 --- a/packages/eslint-plugin/README.md +++ b/packages/eslint-plugin/README.md @@ -35,9 +35,9 @@ rules: { The following rules are provided by this plugin: -| Rule | Description | -| --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | -| [@backstage/no-forbidden-package-imports](./docs/rules/no-forbidden-package-imports.md) | Disallow internal monorepo imports from package subpaths that are not exported. | -| [@backstage/no-relative-monorepo-imports](./docs/rules/no-relative-monorepo-imports.md) | Forbid relative imports that reach outside of the package in a monorepo. | -| [@backstage/no-undeclared-imports](./docs/rules/no-undeclared-imports.md) | Forbid imports of external packages that have not been declared in the appropriate dependencies field in `package.json`. | -| [@backstage/no-top-level-mui4-imports](./docs/rules/no-top-level-mui4-imports.md) | Forbid top level import from Material UI v4 packages. | +| Rule | Description | +| --------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | +| [@backstage/no-forbidden-package-imports](./docs/rules/no-forbidden-package-imports.md) | Disallow internal monorepo imports from package subpaths that are not exported. | +| [@backstage/no-relative-monorepo-imports](./docs/rules/no-relative-monorepo-imports.md) | Forbid relative imports that reach outside of the package in a monorepo. | +| [@backstage/no-undeclared-imports](./docs/rules/no-undeclared-imports.md) | Forbid imports of external packages that have not been declared in the appropriate dependencies field in `package.json`. | +| [@backstage/no-top-level-material-ui-4-imports](./docs/rules/no-top-level-material-ui-4-imports.md) | Forbid top level import from Material UI v4 packages. | diff --git a/packages/eslint-plugin/docs/rules/no-top-level-mui4-imports.md b/packages/eslint-plugin/docs/rules/no-top-level-material-ui-4-imports.md similarity index 83% rename from packages/eslint-plugin/docs/rules/no-top-level-mui4-imports.md rename to packages/eslint-plugin/docs/rules/no-top-level-material-ui-4-imports.md index 85f5821b01..a00eb73ffd 100644 --- a/packages/eslint-plugin/docs/rules/no-top-level-mui4-imports.md +++ b/packages/eslint-plugin/docs/rules/no-top-level-material-ui-4-imports.md @@ -1,4 +1,4 @@ -# @backstage/no-top-level-mui4-imports +# @backstage/no-top-level-material-ui-4-imports Forbid top level import from Material UI v4 packages. @@ -7,7 +7,7 @@ Forbid top level import from Material UI v4 packages. Add the rules as follows, it has no options: ```js -"@backstage/no-top-level-mui4-imports": ["error"] +"@backstage/no-top-level-material-ui-4-imports": ["error"] ``` ## Rule Details diff --git a/packages/eslint-plugin/index.js b/packages/eslint-plugin/index.js index 6fdc4f89fb..af1a8891c3 100644 --- a/packages/eslint-plugin/index.js +++ b/packages/eslint-plugin/index.js @@ -29,6 +29,6 @@ module.exports = { 'no-forbidden-package-imports': require('./rules/no-forbidden-package-imports'), 'no-relative-monorepo-imports': require('./rules/no-relative-monorepo-imports'), 'no-undeclared-imports': require('./rules/no-undeclared-imports'), - 'no-top-level-mui4-imports': require('./rules/no-top-level-mui4-imports'), + 'no-top-level-material-ui-4-imports': require('./rules/no-top-level-material-ui-4-imports'), }, }; diff --git a/packages/eslint-plugin/rules/no-top-level-mui4-imports.js b/packages/eslint-plugin/rules/no-top-level-material-ui-4-imports.js similarity index 98% rename from packages/eslint-plugin/rules/no-top-level-mui4-imports.js rename to packages/eslint-plugin/rules/no-top-level-material-ui-4-imports.js index c3367a2346..dad034e6f2 100644 --- a/packages/eslint-plugin/rules/no-top-level-mui4-imports.js +++ b/packages/eslint-plugin/rules/no-top-level-material-ui-4-imports.js @@ -37,7 +37,7 @@ module.exports = { }, docs: { description: 'Forbid top level import from Material UI v4 packages.', - url: 'https://github.com/backstage/backstage/blob/master/packages/eslint-plugin/docs/rules/no-top-level-mui4-imports.md', + url: 'https://github.com/backstage/backstage/blob/master/packages/eslint-plugin/docs/rules/no-top-level-material-ui-4-imports.md', }, }, create: context => ({ diff --git a/packages/eslint-plugin/src/no-top-level-mui4-imports.test.ts b/packages/eslint-plugin/src/no-top-level-material-ui-4-imports.test.ts similarity index 98% rename from packages/eslint-plugin/src/no-top-level-mui4-imports.test.ts rename to packages/eslint-plugin/src/no-top-level-material-ui-4-imports.test.ts index 16605aa46f..cb68a529e9 100644 --- a/packages/eslint-plugin/src/no-top-level-mui4-imports.test.ts +++ b/packages/eslint-plugin/src/no-top-level-material-ui-4-imports.test.ts @@ -15,7 +15,7 @@ */ import { RuleTester } from 'eslint'; -import rule from '../rules/no-top-level-mui4-imports'; +import rule from '../rules/no-top-level-material-ui-4-imports'; const ruleTester = new RuleTester({ parserOptions: { diff --git a/plugins/azure-devops/.eslintrc.js b/plugins/azure-devops/.eslintrc.js index 9932358b45..e487f765b2 100644 --- a/plugins/azure-devops/.eslintrc.js +++ b/plugins/azure-devops/.eslintrc.js @@ -1,5 +1,5 @@ module.exports = require('@backstage/cli/config/eslint-factory')(__dirname, { rules: { - '@backstage/no-top-level-mui4-imports': 'error', + '@backstage/no-top-level-material-ui-4-imports': 'error', }, }); diff --git a/plugins/devtools/.eslintrc.js b/plugins/devtools/.eslintrc.js index 9932358b45..e487f765b2 100644 --- a/plugins/devtools/.eslintrc.js +++ b/plugins/devtools/.eslintrc.js @@ -1,5 +1,5 @@ module.exports = require('@backstage/cli/config/eslint-factory')(__dirname, { rules: { - '@backstage/no-top-level-mui4-imports': 'error', + '@backstage/no-top-level-material-ui-4-imports': 'error', }, }); diff --git a/plugins/linguist/.eslintrc.js b/plugins/linguist/.eslintrc.js index 9932358b45..e487f765b2 100644 --- a/plugins/linguist/.eslintrc.js +++ b/plugins/linguist/.eslintrc.js @@ -1,5 +1,5 @@ module.exports = require('@backstage/cli/config/eslint-factory')(__dirname, { rules: { - '@backstage/no-top-level-mui4-imports': 'error', + '@backstage/no-top-level-material-ui-4-imports': 'error', }, });