@backstage/cli 0.15.1 → 0.15.2-next.0

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @backstage/cli
 
+## 0.15.2-next.0
+
+### Patch Changes
+
+- 2c528506aa: Added `--since <ref>` flag for `repo build` command.`
+- d3d1b82198: chore(deps): bump `minimatch` from 5.0.0 to 5.0.1
+- e0a69ba49f: build(deps): bump `fs-extra` from 9.1.0 to 10.0.1
+- 44cc7c3b95: Added a new ESLint configuration setup for packages, which utilizes package roles to generate the correct configuration. The new configuration is available at `@backstage/cli/config/eslint-factory`.
+
+  Introduced a new `backstage-cli migrate package-lint-configs` command, which migrates old lint configurations to use `@backstage/cli/config/eslint-factory`.
+
+- b1aacbf96a: Applied the fix from version `0.15.1` of this package, which was part of the `v0.70.1` release of Backstage.
+- d2ecde959b: Package roles are now marked as stable and migration is encouraged. Please check out the [migration guide](https://backstage.io/docs/tutorials/package-role-migration).
+
+  The new `package`, `repo`, and `migrate` command categories are now marked as stable.
+
+  Marked all commands that are being replaced by the new `package` and `repo` commands as deprecated.
+
+  The package templates used by the `create` command have all been updated to use package roles.
+
+- f06da37290: The backend development setup now ignores the `"browser"` and `"module"` entry points in `package.json`, and instead always uses `"main"`.
+- 6a1fe077ad: Changed the logic for how modules are marked as external in the Rollup build of packages. Rather than only marking dependencies and build-in Node.js modules as external, all non-relative imports are now considered external.
+- dc6002a7b9: The `--since` flag of repo commands now silently falls back to using the provided `ref` directly if no merge base is available.
+- Updated dependencies
+  - @backstage/config-loader@0.9.7-next.0
+
 ## 0.15.1
 
 ### Patch Changes

package/config/eslint-factory.js

@@ -0,0 +1,286 @@
+/*
+ * Copyright 2020 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+const { join: joinPath } = require('path');
+
+/**
+ * Creates a ESLint configuration that extends the base Backstage configuration.
+ * In addition to the standard ESLint configuration options, the `extraConfig`
+ * parameter also accepts the following keys:
+ *
+ * - `tsRules`: Additional ESLint rules to apply to TypeScript
+ * - `testRules`: Additional ESLint rules to apply to tests
+ * - `restrictedImports`: Additional paths to add to no-restricted-imports
+ * - `restrictedSrcImports`: Additional paths to add to no-restricted-imports in src files
+ * - `restrictedTestImports`: Additional paths to add to no-restricted-imports in test files
+ * - `restrictedSyntax`: Additional patterns to add to no-restricted-syntax
+ * - `restrictedSrcSyntax`: Additional patterns to add to no-restricted-syntax in src files
+ * - `restrictedTestSyntax`: Additional patterns to add to no-restricted-syntax in test files
+ */
+function createConfig(dir, extraConfig = {}) {
+  const {
+    extends: extraExtends,
+    plugins,
+    env,
+    parserOptions,
+    ignorePatterns,
+
+    rules,
+    tsRules,
+    testRules,
+
+    restrictedImports,
+    restrictedSrcImports,
+    restrictedTestImports,
+    restrictedSyntax,
+    restrictedSrcSyntax,
+    restrictedTestSyntax,
+
+    ...otherConfig
+  } = extraConfig;
+
+  return {
+    ...otherConfig,
+    extends: [
+      '@spotify/eslint-config-base',
+      '@spotify/eslint-config-typescript',
+      'prettier',
+      'plugin:jest/recommended',
+      'plugin:monorepo/recommended',
+      ...(extraExtends ?? []),
+    ],
+    parser: '@typescript-eslint/parser',
+    plugins: ['import', ...(plugins ?? [])],
+    env: {
+      jest: true,
+      ...env,
+    },
+    parserOptions: {
+      ecmaVersion: 2018,
+      sourceType: 'module',
+      lib: require('./tsconfig.json').compilerOptions.lib,
+      ...parserOptions,
+    },
+    ignorePatterns: [
+      '.eslintrc.js',
+      '**/dist/**',
+      '**/dist-types/**',
+      ...(ignorePatterns ?? []),
+    ],
+    rules: {
+      'no-shadow': 'off',
+      'no-redeclare': 'off',
+      '@typescript-eslint/no-shadow': 'error',
+      '@typescript-eslint/no-redeclare': 'error',
+      'no-undef': 'off',
+      'import/newline-after-import': 'error',
+      'import/no-extraneous-dependencies': [
+        'error',
+        {
+          devDependencies: dir
+            ? [
+                `!${joinPath(dir, 'src/**')}`,
+                joinPath(dir, 'src/**/*.test.*'),
+                joinPath(dir, 'src/**/*.stories.*'),
+                joinPath(dir, 'src/setupTests.*'),
+              ]
+            : [
+                // Legacy config for packages that don't provide a dir
+                '**/*.test.*',
+                '**/*.stories.*',
+                '**/src/setupTests.*',
+                '**/dev/**',
+              ],
+          optionalDependencies: true,
+          peerDependencies: true,
+          bundledDependencies: true,
+        },
+      ],
+      'no-unused-expressions': 'off',
+      '@typescript-eslint/no-unused-expressions': 'error',
+      '@typescript-eslint/consistent-type-assertions': 'error',
+      '@typescript-eslint/no-unused-vars': [
+        'warn',
+        {
+          vars: 'all',
+          args: 'after-used',
+          ignoreRestSiblings: true,
+          argsIgnorePattern: '^_',
+        },
+      ],
+
+      'no-restricted-imports': [
+        2,
+        {
+          paths: [
+            ...(restrictedImports ?? []),
+            ...(restrictedSrcImports ?? []),
+          ],
+          // Avoid cross-package imports
+          patterns: ['**/../../**/*/src/**', '**/../../**/*/src'],
+        },
+      ],
+
+      'no-restricted-syntax': [
+        'error',
+        ...(restrictedSyntax ?? []),
+        ...(restrictedSrcSyntax ?? []),
+      ],
+
+      ...rules,
+    },
+    overrides: [
+      {
+        files: ['**/*.ts?(x)'],
+        rules: {
+          '@typescript-eslint/no-unused-vars': 'off',
+          'no-undef': 'off',
+          ...tsRules,
+        },
+      },
+      {
+        files: ['**/*.test.*', '**/*.stories.*', 'src/setupTests.*', '!src/**'],
+        rules: {
+          ...testRules,
+          'no-restricted-syntax': [
+            'error',
+            ...(restrictedSyntax ?? []),
+            ...(restrictedTestSyntax ?? []),
+          ],
+          'no-restricted-imports': [
+            2,
+            {
+              paths: [
+                ...(restrictedImports ?? []),
+                ...(restrictedTestImports ?? []),
+              ],
+              // Avoid cross-package imports
+              patterns: ['**/../../**/*/src/**', '**/../../**/*/src'],
+            },
+          ],
+        },
+      },
+    ],
+  };
+}
+
+/**
+ * Creates a ESLint configuration for the given package role.
+ * The `extraConfig` parameter accepts the same keys as for the `createConfig` function.
+ */
+function createConfigForRole(dir, role, extraConfig = {}) {
+  switch (role) {
+    case 'common-library':
+      return createConfig(dir, extraConfig);
+
+    case 'web-library':
+    case 'frontend':
+    case 'frontend-plugin':
+    case 'frontend-plugin-module':
+      return createConfig(dir, {
+        ...extraConfig,
+        extends: [
+          '@spotify/eslint-config-react',
+          ...(extraConfig.extends ?? []),
+        ],
+        parserOptions: {
+          ecmaFeatures: {
+            jsx: true,
+          },
+          ...extraConfig.parserOptions,
+        },
+        settings: {
+          react: {
+            version: 'detect',
+          },
+          ...extraConfig.settings,
+        },
+        restrictedImports: [
+          {
+            // Importing the entire MUI icons packages kills build performance as the list of icons is huge.
+            name: '@material-ui/icons',
+            message: "Please import '@material-ui/icons/<Icon>' instead.",
+          },
+          {
+            name: '@material-ui/icons/', // because this is possible too ._.
+            message: "Please import '@material-ui/icons/<Icon>' instead.",
+          },
+          ...require('module').builtinModules,
+          ...(extraConfig.restrictedImports ?? []),
+        ],
+        tsRules: {
+          'react/prop-types': 0,
+          ...extraConfig.tsRules,
+        },
+      });
+
+    case 'cli':
+    case 'node-library':
+    case 'backend':
+    case 'backend-plugin':
+    case 'backend-plugin-module':
+      return createConfig(dir, {
+        ...extraConfig,
+        globals: {
+          __non_webpack_require__: 'readonly',
+          ...extraConfig.globals,
+        },
+        rules: {
+          'no-console': 0, // Permitted in console programs
+          'new-cap': ['error', { capIsNew: false }], // Because Express constructs things e.g. like 'const r = express.Router()'
+          ...extraConfig.rules,
+        },
+        restrictedSyntax: [
+          {
+            message:
+              'Default import from winston is not allowed, import `* as winston` instead.',
+            selector:
+              'ImportDeclaration[source.value="winston"] ImportDefaultSpecifier',
+          },
+          ...(extraConfig.restrictedSyntax ?? []),
+        ],
+        restrictedSrcSyntax: [
+          {
+            message:
+              "`__dirname` doesn't refer to the same dir in production builds, try `resolvePackagePath()` from `@backstage/backend-common` instead.",
+            selector: 'Identifier[name="__dirname"]',
+          },
+          ...(extraConfig.restrictedSrcSyntax ?? []),
+        ],
+      });
+    default:
+      throw new Error(`Unknown package role ${role}`);
+  }
+}
+
+/**
+ * Creates a ESLint configuration for the package in the given directory.
+ * The `extraConfig` parameter accepts the same keys as for the `createConfig` function.
+ */
+function createPackageConfig(dir, extraConfig) {
+  const pkg = require(joinPath(dir, 'package.json'));
+  const role = pkg.backstage?.role;
+  if (!role) {
+    throw new Error(`Package ${pkg.name} does not have a backstage.role`);
+  }
+
+  return createConfigForRole(dir, role, extraConfig);
+}
+
+module.exports = createPackageConfig; // Alias
+module.exports.createConfig = createConfig;
+module.exports.createConfigForRole = createConfigForRole;
+module.exports.createPackageConfig = createPackageConfig;

package/config/eslint.backend.js

@@ -14,90 +14,7 @@
  * limitations under the License.
  */
 
-const globalRestrictedSyntax = [
-  {
-    message:
-      'Default import from winston is not allowed, import `* as winston` instead.',
-    selector:
-      'ImportDeclaration[source.value="winston"] ImportDefaultSpecifier',
-  },
-];
-
-module.exports = {
-  extends: [
-    '@spotify/eslint-config-base',
-    '@spotify/eslint-config-typescript',
-    'prettier',
-    'plugin:jest/recommended',
-    'plugin:monorepo/recommended',
-  ],
-  parser: '@typescript-eslint/parser',
-  plugins: ['import'],
-  env: {
-    jest: true,
-  },
-  globals: {
-    __non_webpack_require__: 'readonly',
-  },
-  parserOptions: {
-    ecmaVersion: 2018,
-    sourceType: 'module',
-    lib: require('./tsconfig.json').compilerOptions.lib,
-  },
-  ignorePatterns: ['.eslintrc.js', '**/dist/**', '**/dist-types/**'],
-  rules: {
-    'no-shadow': 'off',
-    'no-redeclare': 'off',
-    '@typescript-eslint/no-shadow': 'error',
-    '@typescript-eslint/no-redeclare': 'error',
-
-    'no-console': 0, // Permitted in console programs
-    'new-cap': ['error', { capIsNew: false }], // Because Express constructs things e.g. like 'const r = express.Router()'
-    'import/newline-after-import': 'error',
-    'import/no-extraneous-dependencies': [
-      'error',
-      {
-        devDependencies: ['**/*.test.*', 'src/setupTests.*', 'dev/**'],
-        optionalDependencies: true,
-        peerDependencies: true,
-        bundledDependencies: true,
-      },
-    ],
-    'no-unused-expressions': 'off',
-    '@typescript-eslint/no-unused-expressions': 'error',
-    '@typescript-eslint/no-unused-vars': [
-      'warn',
-      { vars: 'all', args: 'after-used', ignoreRestSiblings: true },
-    ],
-    // Avoid cross-package imports
-    'no-restricted-imports': [
-      2,
-      { patterns: ['**/../../**/*/src/**', '**/../../**/*/src'] },
-    ],
-    // Avoid default import from winston as it breaks at runtime
-    'no-restricted-syntax': [
-      'error',
-      {
-        message:
-          "`__dirname` doesn't refer to the same dir in production builds, try `resolvePackagePath()` from `@backstage/backend-common` instead.",
-        selector: 'Identifier[name="__dirname"]',
-      },
-      ...globalRestrictedSyntax,
-    ],
-  },
-  overrides: [
-    {
-      files: ['**/*.ts?(x)'],
-      rules: {
-        '@typescript-eslint/no-unused-vars': 'off',
-        'no-undef': 'off',
-      },
-    },
-    {
-      files: ['*.test.*', 'src/setupTests.*', 'dev/**'],
-      rules: {
-        'no-restricted-syntax': ['error', ...globalRestrictedSyntax],
-      },
-    },
-  ],
-};
+module.exports = require('./eslint-factory').createConfigForRole(
+  undefined,
+  'node-library',
+);

package/config/eslint.js

@@ -14,96 +14,7 @@
  * limitations under the License.
  */
 
-module.exports = {
-  extends: [
-    '@spotify/eslint-config-base',
-    '@spotify/eslint-config-react',
-    '@spotify/eslint-config-typescript',
-    'prettier',
-    'plugin:jest/recommended',
-    'plugin:monorepo/recommended',
-  ],
-  parser: '@typescript-eslint/parser',
-  plugins: ['import'],
-  env: {
-    jest: true,
-  },
-  parserOptions: {
-    ecmaVersion: 2018,
-    ecmaFeatures: {
-      jsx: true,
-    },
-    sourceType: 'module',
-    lib: require('./tsconfig.json').compilerOptions.lib,
-  },
-  settings: {
-    react: {
-      version: 'detect',
-    },
-  },
-  ignorePatterns: ['.eslintrc.js', '**/dist/**', '**/dist-types/**'],
-  rules: {
-    'no-shadow': 'off',
-    'no-redeclare': 'off',
-    '@typescript-eslint/no-shadow': 'error',
-    '@typescript-eslint/no-redeclare': 'error',
-    'no-undef': 'off',
-    'import/newline-after-import': 'error',
-    'import/no-extraneous-dependencies': [
-      'error',
-      {
-        devDependencies: [
-          '**/*.test.*',
-          '**/*.stories.*',
-          '**/src/setupTests.*',
-          '**/dev/**',
-        ],
-        optionalDependencies: true,
-        peerDependencies: true,
-        bundledDependencies: true,
-      },
-    ],
-    'no-unused-expressions': 'off',
-    '@typescript-eslint/no-unused-expressions': 'error',
-    '@typescript-eslint/consistent-type-assertions': 'error',
-    '@typescript-eslint/no-unused-vars': [
-      'warn',
-      {
-        vars: 'all',
-        args: 'after-used',
-        ignoreRestSiblings: true,
-        argsIgnorePattern: '^_',
-      },
-    ],
-    'no-restricted-imports': [
-      2,
-      {
-        paths: [
-          {
-            // Importing the entire MUI icons packages kills build performance as the list of icons is huge.
-            name: '@material-ui/icons',
-            message: "Please import '@material-ui/icons/<Icon>' instead.",
-          },
-          {
-            name: '@material-ui/icons/', // because this is possible too ._.
-            message: "Please import '@material-ui/icons/<Icon>' instead.",
-          },
-          ...require('module').builtinModules,
-        ],
-        // Avoid cross-package imports
-        patterns: ['**/../../**/*/src/**', '**/../../**/*/src'],
-      },
-    ],
-  },
-  overrides: [
-    {
-      files: ['**/*.ts?(x)'],
-      rules: {
-        // Default to not enforcing prop-types in typescript
-        'react/prop-types': 0,
-        '@typescript-eslint/no-unused-vars': 'off',
-        'no-undef': 'off',
-      },
-    },
-  ],
-};
+module.exports = require('./eslint-factory').createConfigForRole(
+  undefined,
+  'web-library',
+);

package/dist/cjs/{Lockfile-35661afa.cjs.js → Lockfile-276d1251.cjs.js}

@@ -152,4 +152,4 @@ class Lockfile {
 }
 
 exports.Lockfile = Lockfile;
-//# sourceMappingURL=Lockfile-35661afa.cjs.js.map
+//# sourceMappingURL=Lockfile-276d1251.cjs.js.map

package/dist/cjs/{PackageGraph-c403b5ba.cjs.js → PackageGraph-5c819ded.cjs.js}

@@ -2,7 +2,7 @@
 
 var path = require('path');
 var getPackages = require('@manypkg/get-packages');
-var index = require('./index-82dc75e2.cjs.js');
+var index = require('./index-4c13ec59.cjs.js');
 var errors = require('@backstage/errors');
 var child_process = require('child_process');
 var util = require('util');
@@ -34,8 +34,13 @@ async function listChangedFiles(ref) {
   if (!ref) {
     throw new Error("ref is required");
   }
-  const [base] = await runGit("merge-base", "HEAD", ref);
-  const tracked = await runGit("diff", "--name-only", base);
+  let diffRef = ref;
+  try {
+    const [base] = await runGit("merge-base", "HEAD", ref);
+    diffRef = base;
+  } catch {
+  }
+  const tracked = await runGit("diff", "--name-only", diffRef);
   const untracked = await runGit("ls-files", "--others", "--exclude-standard");
   return Array.from(/* @__PURE__ */ new Set([...tracked, ...untracked]));
 }
@@ -61,7 +66,12 @@ class PackageGraph extends Map {
         publishedLocalDependencies: /* @__PURE__ */ new Map(),
         localDependencies: /* @__PURE__ */ new Map(),
         localDevDependencies: /* @__PURE__ */ new Map(),
-        localOptionalDependencies: /* @__PURE__ */ new Map()
+        localOptionalDependencies: /* @__PURE__ */ new Map(),
+        allLocalDependents: /* @__PURE__ */ new Map(),
+        publishedLocalDependents: /* @__PURE__ */ new Map(),
+        localDependents: /* @__PURE__ */ new Map(),
+        localDevDependents: /* @__PURE__ */ new Map(),
+        localOptionalDependents: /* @__PURE__ */ new Map()
       });
     }
     for (const node of graph.values()) {
@@ -71,6 +81,9 @@ class PackageGraph extends Map {
           node.allLocalDependencies.set(depName, depPkg);
           node.publishedLocalDependencies.set(depName, depPkg);
           node.localDependencies.set(depName, depPkg);
+          depPkg.allLocalDependents.set(node.name, node);
+          depPkg.publishedLocalDependents.set(node.name, node);
+          depPkg.localDependents.set(node.name, node);
         }
       }
       for (const depName of Object.keys(node.packageJson.devDependencies || {})) {
@@ -78,6 +91,8 @@ class PackageGraph extends Map {
         if (depPkg) {
           node.allLocalDependencies.set(depName, depPkg);
           node.localDevDependencies.set(depName, depPkg);
+          depPkg.allLocalDependents.set(node.name, node);
+          depPkg.localDevDependents.set(node.name, node);
         }
       }
       for (const depName of Object.keys(node.packageJson.optionalDependencies || {})) {
@@ -86,6 +101,9 @@ class PackageGraph extends Map {
           node.allLocalDependencies.set(depName, depPkg);
           node.publishedLocalDependencies.set(depName, depPkg);
           node.localOptionalDependencies.set(depName, depPkg);
+          depPkg.allLocalDependents.set(node.name, node);
+          depPkg.publishedLocalDependents.set(node.name, node);
+          depPkg.localOptionalDependents.set(node.name, node);
         }
       }
     }
@@ -140,4 +158,4 @@ class PackageGraph extends Map {
 }
 
 exports.PackageGraph = PackageGraph;
-//# sourceMappingURL=PackageGraph-c403b5ba.cjs.js.map
+//# sourceMappingURL=PackageGraph-5c819ded.cjs.js.map

package/dist/cjs/{backend-96651fe4.cjs.js → backend-ba5674b1.cjs.js}

@@ -1,7 +1,7 @@
 'use strict';
 
 var webpack = require('webpack');
-var paths = require('./paths-4f873870.cjs.js');
+var paths = require('./paths-6403ea49.cjs.js');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -33,4 +33,4 @@ async function serveBackend(options) {
 }
 
 exports.serveBackend = serveBackend;
-//# sourceMappingURL=backend-96651fe4.cjs.js.map
+//# sourceMappingURL=backend-ba5674b1.cjs.js.map