linter-bundle 3.9.0 → 4.0.0

package/.linter-bundle.js

@@ -0,0 +1,51 @@
+const snippets = {
+	lowerCase: '[a-z]*([a-z0-9])',
+	upperCase: '[A-Z]*([A-Z0-9])',
+	snakeCase: '[a-z]*(*([a-z0-9]_)+([a-z0-9]))',
+	screamingSnakeCase: '[A-Z]*(*([A-Z0-9]_)+([A-Z0-9]))',
+	kebabCase: '[a-z]*(*([a-z0-9]-)+([a-z0-9]))',
+	camelCase: '[a-z]*([a-zA-Z0-9])',
+	pascalCase: '[A-Z]*([a-zA-Z0-9])'
+};
+
+module.exports = {
+	files: {
+		git: true,
+		restrictions: [
+			{
+				basePath: '.',
+				allowed: [
+					'.git/**',
+					'.github/FUNDING.yml',
+					'.vscode/settings.json',
+					`eslint/rules/${snippets.kebabCase}.{js,md}`,
+					`eslint/{index.js,overrides-${snippets.kebabCase}.js}`,
+					'files/index.js',
+					`helper/${snippets.kebabCase}.js`,
+					'markdownlint/base.json',
+					'node_modules/**',
+					'stylelint/index.js',
+					`stylelint/plugins/stylelint-${snippets.kebabCase}.js`,
+					'.editorconfig',
+					'.eslintrc.js',
+					'.gitattributes',
+					'.gitignore',
+					'.linter-bundle.js',
+					'.markdownlint.json',
+					'.npmignore',
+					'*.md',
+					'LICENSE',
+					'lint.js',
+					'package-lock.json',
+					'package.json',
+					'stylelint.config.js',
+					'tsconfig.json',
+					'types.d.ts',
+					'validate-stylelint-options.mjs',
+					'vscode-eslint-1.png',
+					'vscode-eslint-2.png'
+				]
+			}
+		]
+	}
+}

package/CHANGELOG.md

@@ -6,7 +6,31 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [Unreleased]
 
-[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v3.9.0...HEAD)
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v4.0.0...HEAD)
+
+## [4.0.0] - 2023-08-30
+
+### Breaking change
+
+- [general] The global configuration variable `global.linterBundleSettings` has been replaced by a `.linter-bundle.json` / `.linter-bundle.cjs` / `.linter-bundle.js` configuration file in the projects root directory
+
+### Changed
+
+- [eslint] Updated `eslint-plugin-jsdoc` from `46.5.0` to `46.5.1`
+
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v3.10.0...v4.0.0)
+
+## [3.10.0] - 2023-08-29
+
+### Changed
+
+- [eslint] Updated `@typescript-eslint` from `6.4.1` to `6.5.0`
+
+### Fixed
+
+- [eslint] Don't consider files outside of `basePath` in [`restricted-filenames`](./eslint/rules/restricted-filenames.md) rule
+
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v3.9.0...v3.10.0)
 
 ## [3.9.0] - 2023-08-28
 

package/README.md

@@ -83,8 +83,6 @@ npm install linter-bundle --save-dev
 
 #### .eslintrc.js
 
-##### Minimum configuration
-
 ```js
 module.exports = {
   extends: [
@@ -102,90 +100,6 @@ module.exports = {
 };
 ```
 
-##### Maximum configuration
-
-```js
-// Sometimes it's required to adjust specific settings. These can be defined here:
-global.linterBundleSettings = {
-  overrides: {
-    general: {
-      'no-restricted-globals': {
-        additionalRestrictions: [
-          {
-            name: 'fetch',
-            message: 'Use Utils.fetchWithTimeout() instead.'
-          }
-        ]
-      },
-      'no-restricted-properties': {
-        additionalRestrictions: [
-          {
-            object: 'localStorage',
-            property: 'getItem',
-            message: 'Use StorageHelper.getItem() instead.'
-          },
-          {
-            object: 'localStorage',
-            property: 'setItem',
-            message: 'Use StorageHelper.setItem() instead.'
-          },
-          {
-            object: 'localStorage',
-            property: 'removeItem',
-            message: 'Use StorageHelper.removeItem() instead.'
-          }
-        ]
-      },
-      'no-restricted-syntax': {
-        additionalRestrictions: [
-          {
-            selector: 'NewExpression[callee.name="Blob"]',
-            message: 'Use BlobHelper.create() instead of new Blob().'
-          }
-        ]
-      },
-      'import/order': {
-        additionalExternalPatterns: ['@sentry/*']
-      }
-    },
-    react: {
-      'react/forbid-component-props': {
-        allowClassNameFor: ['Checkbox', 'Grid', 'GridItem', 'Button'],
-        allowStyleFor: []
-      }
-    }
-  }
-};
-
-module.exports = {
-  extends: [
-    require.resolve('linter-bundle/eslint'),
-    require.resolve('linter-bundle/eslint/overrides-gatsby'),
-    require.resolve('linter-bundle/eslint/overrides-javascript'),
-    // require.resolve('linter-bundle/eslint/overrides-javascript-lazy'),
-    require.resolve('linter-bundle/eslint/overrides-jest'),
-    require.resolve('linter-bundle/eslint/overrides-jsdoc'),
-    require.resolve('linter-bundle/eslint/overrides-react'),
-    require.resolve('linter-bundle/eslint/overrides-storybook'),
-    require.resolve('linter-bundle/eslint/overrides-type-declarations'),
-    require.resolve('linter-bundle/eslint/overrides-worker')
-  ],
-  ignorePatterns: [
-    // Define paths which should be ignored here. (The following paths are ignored by default: '.cache/', '.vscode/', 'coverage/', 'node_modules/')
-    'build/',
-    'etc/',
-    'private/'
-  ],
-  globals: {
-    // Define project-specific global variables. JavaScript built-in objects (like ArrayBuffer, typed arrays, Promise, Set/Map etc.) are automatically set to
-    // 'readonly', and don't need to be added here.
-    __DEV__: 'readonly',
-    APP_NAME: 'readonly',
-    APP_VERSION: 'readonly',
-  }
-};
-```
-
 ##### Available `extends`
 
 Source | Description | Rules setup
@@ -204,11 +118,6 @@ Source | Description | Rules setup
 #### stylelint.config.js
 
 ```js
-global.linterBundleSettings = {
-  // The prefix used for the 'custom-media-pattern' (`@media (--my-prefix-foo)`) and 'custom-property-pattern' (`var(--my-prefix-bar)`) rule. If not defined, these rules are disabled.
-  propertyPrefix: 'my-prefix'
-};
-
 module.exports = {
   extends: 'linter-bundle/stylelint'
 };
@@ -229,13 +138,379 @@ module.exports = {
 .eslintcache
 ```
 
+### .linter-bundle.json / .linter-bundle.cjs / .linter-bundle.js
+
+`linter-bundle` supports a couple of additional options, which can be configured in the configuration file, in the root of your project.  
+Some of the options are also available as command line arguments (see below).  
+The file itself, and any of the options is optional.
+
+#### Minimum example configuration (`.linter-bundle.json`)
+
+```json
+{
+  "verbose": true,
+  "timing": true,
+  "git": true,
+  "tsc": {
+    "tsconfig": "./tsconfig.lint.json"
+  },
+  "ts": {
+    "tsconfig": "./tsconfig.lint.json",
+    "include": ["./included/*.ts"],
+    "exclude": ["./excluded/*.ts"],
+    "overrides": {
+      "general": {
+        "no-restricted-globals": {
+          "additionalRestrictions": [
+            {
+              "name": "fetch",
+              "message": "Use Utils.fetchWithTimeout() instead."
+            }
+          ]
+        },
+        "no-restricted-properties": {
+          "additionalRestrictions": [
+            {
+              "object": "localStorage",
+              "property": "getItem",
+              "message": "Use StorageHelper.getItem() instead."
+            }
+          ]
+        },
+        "no-restricted-syntax": {
+          "additionalRestrictions": [
+            {
+              "selector": "NewExpression[callee.name=\"Blob\"]",
+              "message": "Use BlobHelper.create() instead of new Blob()."
+            }
+          ]
+        },
+        "import/order": {
+          "additionalExternalPatterns": ["@sentry/*"]
+        }
+      },
+      "react": {
+        "react/forbid-component-props": {
+          "allowClassNameFor": ["Checkbox", "Grid", "GridItem", "Button"],
+          "allowStyleFor": ["Grid", "GridItem"]
+        }
+      }
+    }
+  },
+  "sass": {
+    "include": ["./included/*.ts"],
+    "patternPrefix": "--my-prefix"
+  },
+  "md": {
+    "include": ["./included/*.md"],
+  },
+  "audit": {
+    "minSeverity": "high",
+    "exclude": ["975", "1751"]
+  },
+  "files": {
+    "restrictions": [
+      {
+        "basePath": "./src",
+        "allow": [
+          "components/**/index.tsx",
+          "utils/{index.ts,lib/[a-z]+([a-zA-Z])?(.spec).ts}"
+        ],
+        "disallow": [
+          "components/NotAllowed/index.tsx"
+        ]
+      }
+    ]
+  }
+}
+```
+
+#### Maximum example configuration (`.linter-bundle.js`)
+
+<!-- markdownlint-disable-next-line MD033 -->
+<details><summary>Click here to see the example configuration with descriptions</summary>
+
+```js
+module.exports = {
+  /**
+   * Same as `--verbose` command line argument.
+   * 
+   * @type {boolean}
+   */
+  verbose: true,
+
+  /**
+   * Same as `--timing` command line argument.
+   * 
+   * @type {boolean}
+   */
+  timing: true,
+
+  /**
+   * Same as `--git` command line argument.
+   * 
+   * @type {boolean}
+   */
+  git: true,
+
+  /**
+   * Configuration, specific to the `tsc` command.
+   */
+  tsc: {
+    /**
+     * `verbose`, `timing` and `git` are the same as in the root node.
+     */
+    verbose: true,
+    timing: true,
+    git: true,
+
+    /**
+     * Same as `--tsconfig` command line argument.
+     * 
+     * @type {string}
+     */
+    tsconfig: './tsconfig.lint.json'
+  },
+
+  /**
+   * Configuration, specific to the `ts` command.
+   */
+  ts: {
+    /**
+     * `verbose`, `timing` and `git` are the same as in the root node.
+     */
+    verbose: true,
+    timing: true,
+    git: true,
+
+    /**
+     * Same as `--tsconfig` command line argument.
+     * 
+     * @type {string}
+     */
+    tsconfig: './tsconfig.lint.json',
+
+    /**
+     * Same as `--include` command line argument.
+     * 
+     * @type {string[]}
+     */
+    include: ['./included/*.ts'],
+
+    /**
+     * Same as `--exclude` command line argument.
+     * 
+     * @type {string[]}
+     */
+    exclude: ['./excluded/*.ts'],
+
+    /**
+     * Overrides and extensions for specific ESLint rules.
+     */
+    overrides: {
+      /**
+       * Rules that are applied to `linter-bundle/eslint`.
+       */
+      general: {
+        'no-restricted-globals': {
+          /**
+           * Extend the `restrictions` of the `no-restricted-globals` rule.
+           * 
+           * @type {{ name: string; message: string; }[]}
+           */
+          additionalRestrictions: [
+            {
+              name: 'fetch',
+              message: 'Use Utils.fetchWithTimeout() instead.'
+            }
+          ]
+        },
+        'no-restricted-properties': {
+          /**
+           * Extend the `restrictions` of the `no-restricted-properties` rule.
+           * 
+           * @type {{ object: string; property: string; message: string; }[]}
+           */
+          additionalRestrictions: [
+            {
+              object: 'localStorage',
+              property: 'getItem',
+              message: 'Use StorageHelper.getItem() instead.'
+            }
+          ]
+        },
+        'no-restricted-syntax': {
+          /**
+           * Extend the `restrictions` of the `no-restricted-syntax` rule.
+           * 
+           * @type {{ selector: string; message: string; }[]}
+           */
+          additionalRestrictions: [
+            {
+              selector: 'NewExpression[callee.name="Blob"]',
+              message: 'Use BlobHelper.create() instead of new Blob().'
+            }
+          ]
+        },
+        'import/order': {
+          /**
+           * Extend the `externalPatterns` of the `import/order` rule.
+           *
+           * @type {string[]}
+           */
+          additionalExternalPatterns: ['@sentry/*']
+        }
+      },
+
+      /**
+       * Rules that are applied to `linter-bundle/eslint/overrides-react`.
+       */
+      react: {
+        'react/forbid-component-props': {
+          /**
+           * Allows the `className` property for the specified components.
+           *
+           * @type {string[]}
+           */
+          allowClassNameFor: ['Checkbox', 'Grid', 'GridItem', 'Button'],
+
+          /**
+           * Allows the `style` property for the specified components.
+           *
+           * @type {string[]}
+           */
+          allowStyleFor: ['Grid', 'GridItem']
+        }
+      }
+    }
+  },
+
+  /**
+   * Configuration, specific to the `sass` command.
+   */
+  sass: {
+    /**
+     * `verbose`, `timing` and `git` are the same as in the root node.
+     */
+    verbose: true,
+    timing: true,
+    git: true,
+
+    /**
+     * Same as `--include` command line argument.
+     * 
+     * @type {string[]}
+     */
+    include: ['./included/*.ts'],
+
+    /**
+     * The prefix used for the 'custom-media-pattern' (`@media (--my-prefix-foo)`) and 'custom-property-pattern' (`var(--my-prefix-bar)`) rule.
+     *
+     * If not defined, these rules are disabled.
+     */
+    patternPrefix: '--my-prefix'
+  },
+
+  /**
+   * Configuration, specific to the `audit` command.
+   */
+  md: {
+    /**
+     * Same as `--include` command line argument.
+     * 
+     * @type {string[]}
+     */
+    include: ['./included/*.ts']
+  },
+
+  /**
+   * Configuration, specific to the `audit` command.
+   */
+  audit: {
+    /**
+     * `verbose`, `timing` and `git` are the same as in the root node.
+     */
+    verbose: true,
+    timing: true,
+    git: true,
+
+    /**
+     * Same as `--min-severity` command line argument.
+     * 
+     * @type {'info' | 'low' | 'moderate' | 'high' | 'critical'}
+     */
+    minSeverity: 'high',
+
+    /**
+     * Same as `--exclude` command line argument.
+     * 
+     * @type {string[]}
+     */
+    exclude: ['975', '1751']
+  },
+
+  /**
+   * Configuration, specific to the `files` command.
+   */
+  files: {
+    /**
+     * `verbose`, `timing` and `git` are the same as in the root node.
+     */
+    verbose: true,
+    timing: true,
+    git: true,
+
+    /**
+     * Array of restrictions for different base paths.
+     *
+     * The configuration is equal to the `restricted-filenames` ESLint plugin.
+     * This plugin is using the configuration here, if ESLint is used outside of `linter-bundle` (e.g. in VSCode).
+     *
+     * @see https://github.com/jens-duttke/linter-bundle/blob/main/eslint/rules/restricted-filenames.md
+     */
+    restrictions: [
+      {
+        /**
+         * Same as `--exclude` command line argument.
+         * 
+         * @type {string}
+         */
+        basePath: './src',
+
+        /**
+         * Glob pattern Same as `--exclude` command line argument.
+         * 
+         * @type {string[]}
+         */
+        allow: [
+          'components/**/index.tsx',
+          'utils/{index.ts,lib/[a-z]+([a-zA-Z])?(.spec).ts}'
+        ],
+
+        /**
+         * Same as `--exclude` command line argument.
+         * 
+         * @type {string[]}
+         * 
+         */
+        disallow: [
+          'components/NotAllowed/index.tsx'
+        ]
+      }
+    ]
+  }
+}
+```
+
+</details>
+
 ## Available commands
 
 The command line arguments are separated in groups. Here are some examples:
 
 ```sh
-# Run TypeScript compiler, ESLint, Stylelint, Markdownlint, and audit in the given order, using the default configuration
-lint tsc ts sass md audit
+# Run File restrictions, TypeScript compiler, ESLint, Stylelint, Markdownlint, and audit in the given order, using the default configuration
+lint files tsc ts sass md audit
 
 # Run ESLint and Audit, and show their terminal output even on success
 lint --verbose ts audit
@@ -260,6 +535,10 @@ Argument | Description | Example
 `--timing` | Show information how long each linting process was running. | `--timing`
 `--git` | **Experimental** Only lint (ESLint, Stylelint and Markdownlint) files which have been detected as changed (compared to the upstream branch) by Git. This can result into massive performance improvements on large code bases, but also lead to undetected issues with cross-file rules. | `--git`
 
+### `lint files`
+
+Will check if the files in the project match the restrictions defined in the linter-bundle configuration file.
+
 ### `lint tsc`
 
 Will execute:

package/TODO.md

@@ -2,15 +2,6 @@
 
 <!-- markdownlint-disable -->
 
-- Keine Hard-kodierten HexEdit-spezifischen Werte:
-    react: {
-      'react/forbid-component-props': {
-        allowClassNameFor: ['Checkbox', 'Grid', 'GridItem', 'Button'],
-        allowStyleFor: []
-      }
-    }
-    Diese müssen konfigurierbar sein. Hier gibt es neu auch `disallowFor`, aber ggf. sollte das gesammte Konfig-Objekt von aussen kommen.
-
 - Bereiche in Readme aufklappbar machen:
 <details>
  summary>yarn</summary>
@@ -20,12 +11,12 @@ yarn add click-to-react-component
 ```
 </details>
 
-- Make git diff-branch configurable
-  on GitHub Actions this could be used:
-  - run: git diff --name-only -z origin/${GITHUB_BASE_REF}
+- Make git diff-branch configurable  
+  on GitHub Actions this could be used:  
+  - run: git diff --name-only -z origin/${GITHUB_BASE_REF}  
   Is there a variable with includes origin/ already?
 
-Some tools like Gatsby ship deprecated dependencies of eslint and @typescript-eslint.
+Some tools like Gatsby ship deprecated dependencies of eslint and @typescript-eslint.  
 Since npm installs packages alphabetically, the outdated `gatsby` dependencies are installed in the `node_modules` root, instead of the newer `linter-bundle` dependencies. Since the old versions often do not support new rules or new options, this may cause linting to fail with errors like this:
 
 ```bash
@@ -47,11 +38,11 @@ By using the `enforce-deps` option, linter-bundle will ensure the right versions
 ```
 
 - Option to lint only changed files in Git
-  [lint-staged](https://github.com/okonet/lint-staged)
-  [affected](https://www.npmjs.com/package/affected)
-  [git-affected-files](https://www.npmjs.com/package/git-affected-files)
-  [affected-files](https://www.npmjs.com/package/affected-files)
-  [is-affected](https://www.npmjs.com/package/is-affected)
+  - [lint-staged](https://github.com/okonet/lint-staged)
+  - [affected](https://www.npmjs.com/package/affected)
+  - [git-affected-files](https://www.npmjs.com/package/git-affected-files)
+  - [affected-files](https://www.npmjs.com/package/affected-files)
+  - [is-affected](https://www.npmjs.com/package/is-affected)
 
-- Find stylelint rule which checks for wrong values like:
+- Find stylelint rule which checks for wrong values like:  
   `padding-top: 3px 3px 0;`

package/eslint/index.js

@@ -8,6 +8,7 @@
 const fs = require('node:fs');
 const path = require('node:path');
 
+const config = require('../helper/config.js');
 const ensureType = require('../helper/ensure-type');
 
 module.exports = {
@@ -282,16 +283,16 @@ module.exports = {
 						name: 'isNaN',
 						message: 'Use Number.isNaN() instead, and ensure that the input value is of type number. isNaN(undefined) !== Number.isNaN(undefined)'
 					},
-					...ensureType.array(global.linterBundleSettings?.overrides?.general?.['no-restricted-globals']?.additionalRestrictions)
+					...ensureType.array(config.ts?.overrides?.general?.['no-restricted-globals']?.additionalRestrictions)
 				],
 				'no-restricted-imports': 'off', // Covered by @typescript-eslint/no-restricted-imports
 				'no-restricted-properties': [
 					'error',
-					...ensureType.array(global.linterBundleSettings?.overrides?.general?.['no-restricted-properties']?.additionalRestrictions)
+					...ensureType.array(config.ts?.overrides?.general?.['no-restricted-properties']?.additionalRestrictions)
 				],
 				'no-restricted-syntax': [
 					'error',
-					...ensureType.array(global.linterBundleSettings?.overrides?.general?.['no-restricted-syntax']?.additionalRestrictions)
+					...ensureType.array(config.ts?.overrides?.general?.['no-restricted-syntax']?.additionalRestrictions)
 				],
 				'no-return-assign': 'error',
 				'no-script-url': 'error',
@@ -865,7 +866,7 @@ module.exports = {
 					'newlines-between': 'always',
 					'pathGroupsExcludedImportTypes': [],
 					'pathGroups': [
-						...ensureType.array(global.linterBundleSettings?.overrides?.general?.['import/order']?.additionalExternalPatterns).map(
+						...ensureType.array(config.ts?.overrides?.general?.['import/order']?.additionalExternalPatterns).map(
 							/**
 							 * Creates an "external" group using the additional external pattern configuration.
 							 * @param {string} pattern - A given pattern

package/eslint/overrides-react.js

@@ -2,6 +2,7 @@
  * @file Settings for React code in TypeScript (TSX) files.
  */
 
+const config = require('../helper/config.js');
 const ensureType = require('../helper/ensure-type');
 
 module.exports = {
@@ -90,11 +91,11 @@ module.exports = {
 				'react/forbid-component-props': ['error', { forbid: [
 					{
 						propName: 'className',
-						allowedFor: ensureType.array(global.linterBundleSettings?.overrides?.react?.['react/forbid-component-props']?.allowClassNameFor)
+						allowedFor: ensureType.array(config.ts?.overrides?.react?.['react/forbid-component-props']?.allowClassNameFor)
 					},
 					{
 						propName: 'style',
-						allowedFor: ensureType.array(global.linterBundleSettings?.overrides?.react?.['react/forbid-component-props']?.allowStyleFor)
+						allowedFor: ensureType.array(config.ts?.overrides?.react?.['react/forbid-component-props']?.allowStyleFor)
 					}
 				] }],
 				'react/forbid-dom-props': 'error',