linter-bundle 3.7.0 → 3.9.0

package/CHANGELOG.md

@@ -6,16 +6,48 @@ 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.7.0...HEAD)
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v3.9.0...HEAD)
+
+## [3.9.0] - 2023-08-28
+
+### Changed
+
+- [general] Use users default shell for linting sub-processes
+
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v3.8.0...v3.9.0)
+
+## [3.8.0] - 2023-08-28
+
+### Changed
+
+- [eslint] Updated `@typescript-eslint` from `6.3.0` to `6.4.1`
+- [eslint] Updated `eslint` from `8.47.0` to `8.48.0`
+- [eslint] Updated `eslint-import-resolver-webpack` from `0.13.4` to `0.13.7`
+- [eslint] Updated `eslint-plugin-import` from `2.28.0` to `2.28.1`
+- [eslint] Updated `eslint-plugin-jsdoc` from `46.4.6` to `46.5.0`
+- [eslint] Updated `eslint-plugin-n` from `16.0.1` to `16.0.2`
+- [eslint] Updated `eslint-plugin-react` from `7.33.1` to `7.33.2`
+- [stylelint] Updated `postcss-scss` from `4.0.6` to `4.0.7`
+- [stylelint] Updated `stylelint` from `15.10.2` to `15.10.3`
+
+### Added
+
+- [eslint] New rule [`restricted-filenames`](./eslint/rules/restricted-filenames.md), which restrict file and path names with given glob patterns.
+
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v3.7.0...v3.8.0)
 
 ## [3.7.0] - 2023-08-11
 
+### Changed
+
 - [eslint] Adjusted `jsdoc/tag-lines` configuration to enforce no empty like for `@typedef`, `@property` and `@returns`; and weakened line configuration for `@see`
 
 [Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v3.6.0...v3.7.0)
 
 ## [3.6.0] - 2023-08-11
 
+### Changed
+
 - [general] Change peer-dependency of `typescript` from `^4.0.0` to `>=4.0.0`
 - [eslint] Updated `@typescript-eslint` from `6.2.0` to `6.3.0`
 - [eslint] Updated `eslint` from `8.45.0` to `8.47.0`
@@ -25,9 +57,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - [eslint] Updated `eslint-plugin-jsdoc` from `46.4.5` to `46.4.6`
 - [eslint] Updated `eslint-plugin-react` from `7.33.0` to `7.33.1`
 - [stylelint] Updated `stylelint-scss` from `5.0.1` to `5.1.0`
-- [eslint] Removed deprecated (and currently disabled) `no-return-await` rule
 - [styleint] Added but disabled [`scss/function-disallowed-list`](https://github.com/stylelint-scss/stylelint-scss/blob/master/src/rules/function-disallowed-list) rule
 
+### Removed
+
+- [eslint] Removed deprecated (and currently disabled) `no-return-await` rule
+
 [Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v3.5.0...v3.6.0)
 
 ## [3.5.0] - 2023-07-28

package/README.md

@@ -39,6 +39,7 @@ Beside that, the following additional rules are part of this bundle:
 
 - [no-global-undefined-check](./eslint/rules/no-global-undefined-check.md)
 - [no-unnecessary-typeof](./eslint/rules/no-unnecessary-typeof.md)
+- [restricted-filenames](./eslint/rules/restricted-filenames.md)
 
 ### stylelint
 

package/eslint/index.js

@@ -5,8 +5,8 @@
 /* eslint-disable max-lines -- The rules can be easier managed if they are all in one file */
 /* eslint-disable n/no-process-env -- `process.env` is required to inject configuration adjustments */
 
-const fs = require('fs');
-const path = require('path');
+const fs = require('node:fs');
+const path = require('node:path');
 
 const ensureType = require('../helper/ensure-type');
 

package/eslint/rules/restricted-filenames.js

@@ -0,0 +1,97 @@
+/**
+ * @file ESLint rule which ensures that only files which match given glob patterns are part of your project.
+ */
+
+const path = require('node:path');
+
+const micromatch = require('micromatch');
+
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
+module.exports = {
+	meta: {
+		docs: {
+			description: 'Restrict file and path names with given glob patterns.',
+			recommended: true
+		},
+		messages: {
+			text: 'Disallowed filename "{{name}}".'
+		},
+		schema: {
+			type: 'array',
+			additionalItems: false,
+			items: [
+				{
+					type: 'object',
+					additionalProperties: false,
+					properties: {
+						basePath: {
+							type: 'string'
+						},
+						allowed: {
+							type: 'array',
+							items: {
+								type: 'string'
+							}
+						},
+						disallowed: {
+							type: 'array',
+							items: {
+								type: 'string'
+							}
+						}
+					}
+				}
+			]
+		}
+	},
+	create: (context) => ({
+		Program: (node) => {
+			const filePath = context.getFilename();
+			/** @type {{ basePath: string, allowed?: string[]; disallowed?: string[]; }[]} */
+			const options = context.options;
+
+			for (const { basePath, allowed, disallowed } of options) {
+				const normalizedName = path.relative(path.join(process.cwd(), basePath), filePath);
+
+				if (allowed && !disallowed) {
+					if (!micromatch.isMatch(normalizedName, allowed, { dot: true })) {
+						report();
+						return;
+					}
+				}
+				else if (!allowed && disallowed) {
+					if (micromatch.isMatch(normalizedName, disallowed, { dot: true })) {
+						report();
+						return;
+					}
+				}
+				else if (allowed && disallowed) {
+					if (
+						micromatch.isMatch(normalizedName, disallowed, { dot: true }) ||
+						!micromatch.isMatch(normalizedName, allowed, { dot: true })
+					) {
+						report();
+						return;
+					}
+				}
+			}
+
+			/**
+			 * Reports to ESLint.
+			 *
+			 * @returns {void}
+			 */
+			function report () {
+				context.report({
+					node,
+					messageId: 'text',
+					data: {
+						name: path.relative(process.cwd(), filePath).replace(/\\/gu, '/')
+					}
+				});
+			}
+		}
+	})
+};

package/eslint/rules/restricted-filenames.md

@@ -0,0 +1,92 @@
+# Restrict file and path names
+
+## Rule Details
+
+In projects in which several developers or even teams work together, it is important that files are not simply stored anywhere. This rule ensures that defined path/file name schemes are adhered to.
+
+Example configuration for this rule:
+
+```ts
+'restricted-filenames': ['error', {
+  basePath: './src',
+  allowed: [
+    'components/**/index.tsx',
+    'utils/{index.ts,lib/[a-z]+([a-zA-Z])?(.spec).ts}'
+  ],
+  disallowed: [
+    'components/NotAllowed/index.tsx'
+  ]
+}]
+```
+
+Examples of **valid** file paths:
+
+- components/MyComponent/index.tsx
+- utils/index.ts
+- utils/lib/myFunction.ts
+- utils/lib/myFunction.spec.ts
+
+Examples of **invalid** file paths:
+
+- components/myComponent/index.tsx
+- components/myComponent/index.ts
+- components/MyComponent/subfolder/index.tsx
+- components/NotAllowed/index.tsx
+- utils/index.tsx
+- utils/helper.ts
+- utils/helper/index.ts
+- utils/lib/MyFunction.ts
+- utils/lib/my-function.ts
+- utils/lib/myFunction.js
+- utils/lib/myFunction.test.ts
+
+### Priority of `allowed` and `disallowed`
+
+If only `allowed` is set, all unspecified files are disallowed.
+
+If only `disallowed` is set, all unspecified files are allowed.
+
+If both are set, `disallowed` wins over `allowed` and all unspecified files are disallowed.
+
+## Glob patterns for different casings
+
+| Name | Example | Glob pattern |
+|-|-|-|
+Snake case | number_of_donuts | `[a-z]*(*([a-z0-9])_+([a-z0-9]))` |
+Screaming snake case | NUMBER_OF_DONUTS | `[A-Z]*(*([A-Z0-9])_+([A-Z0-9]))` |
+Kebab case | number-of-donuts | `[a-z]*(*([a-z0-9])-+([a-z0-9]))` |
+Camel case | numberOfDonuts | `[a-z]*([a-zA-Z0-9])` |
+Pascal case | NumberOfDonuts | `[A-Z]*([a-zA-Z0-9])` |
+
+## Glob pattern templates
+
+Instead of defining the same complex patterns over and over again, e.g. for casing, you can write them into a variable and use them within the pattern, for example by using template strings.
+
+Example of `.eslintrc.js`:
+
+```ts
+const casing = {
+  snake: '[a-z]*(*([a-z0-9])_+([a-z0-9]))',
+  screamingSnake: '[A-Z]*(*([A-Z0-9])_+([A-Z0-9]))',
+  kebab: '[a-z]*(*([a-z0-9])-+([a-z0-9]))',
+  camel: '[a-z]*([a-zA-Z0-9])',
+  pascal: '[A-Z]*([a-zA-Z0-9])'
+};
+
+module.exports = {
+  rules: {
+    'restricted-filenames': ['error', {
+      basePath: './src',
+      allowed: [
+        `components/${casing.pascal}/index.tsx`,
+        `utils/{index.ts,lib/${casing.camel}?(.spec).ts}`
+      ]
+    }]
+  }
+};
+```
+
+## Further Reading
+
+See [Glob Tool - Test globs against sets of test strings quickly and easily online](https://www.digitalocean.com/community/tools/glob)  
+See [micromatch - The used Glob matching library](https://www.npmjs.com/package/micromatch)

package/helper/find-missing-overrides.js

@@ -5,8 +5,8 @@
  * @see https://classic.yarnpkg.com/en/docs/selective-version-resolutions/
  */
 
-const fs = require('fs');
-const path = require('path');
+const fs = require('node:fs');
+const path = require('node:path');
 
 /** @typedef {{ name: string; configuredVersion: string; expectedVersion: string; }} Dependency */
 

package/helper/get-stylelint-path.js

@@ -2,8 +2,8 @@
  * @file Returns the path to the Stylelint CLI script.
  */
 
-const fs = require('fs');
-const path = require('path');
+const fs = require('node:fs');
+const path = require('node:path');
 
 /**
  * Returns if the project is using npm or yarn.

package/helper/is-npm-or-yarn.js

@@ -2,8 +2,8 @@
  * @file Check if the project is using npm or yarn by checking the existence of a `package-lock.json` or a `yarn.lock`.
  */
 
-const fs = require('fs');
-const path = require('path');
+const fs = require('node:fs');
+const path = require('node:path');
 
 /**
  * Returns if the project is using npm or yarn.

package/helper/run-process.js

@@ -4,7 +4,8 @@
 
 /** @typedef {{ code: number; stdout: string; stderr: string; runtime: number; }} ProcessResult */
 
-const childProcess = require('child_process');
+const childProcess = require('node:child_process');
+const os = require('node:os');
 
 /**
  * Executes a process asynchronously.
@@ -24,7 +25,7 @@ async function runProcess (command, options) {
 		/** @type {string[]} */
 		const stderr = [];
 
-		const lintingProcess = childProcess.exec(command, options);
+		const lintingProcess = childProcess.exec(command, { ...options, shell: os.userInfo().shell });
 
 		lintingProcess.stdout?.on('data', (/** @type {string} */data) => {
 			stdout.push(data);

package/helper/validate-package-overrides.js

@@ -5,8 +5,8 @@
  * @see https://classic.yarnpkg.com/en/docs/selective-version-resolutions/
  */
 
-const fs = require('fs');
-const path = require('path');
+const fs = require('node:fs');
+const path = require('node:path');
 
 /** @typedef {{ name: string; configuredVersion: string; expectedVersion: string; }} Dependency */
 

package/lint.js

@@ -4,8 +4,8 @@
  * @file Entry point of the linter-bundle.
  */
 
-const path = require('path');
-const tty = require('tty');
+const path = require('node:path');
+const tty = require('node:tty');
 
 const micromatch = require('micromatch');
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "linter-bundle",
-	"version": "3.7.0",
+	"version": "3.9.0",
 	"description": "Ready-to use bundle of linting tools, containing configurations for ESLint, stylelint and markdownlint.",
 	"keywords": [
 		"eslint",
@@ -32,35 +32,35 @@
 		"publish:major": "npm version major",
 		"publish:minor": "npm version minor",
 		"publish:patch": "npm version patch",
-		"lint": "npm run validate-stylelint-options && npm run stylelint-find-rules && node ./lint tsc ts md audit --min-severity=critical",
+		"lint": "npm run _validate-stylelint-options && npm run _stylelint-find-rules && node ./lint tsc ts md audit --min-severity=critical",
 		"preversion": "npm run check-outdated && npm run lint",
 		"postversion": "git push && git push --tags && npm publish",
-		"stylelint-find-rules": "stylelint-find-new-rules ./stylelint/index.js",
-		"validate-stylelint-options": "node ./validate-stylelint-options.mjs",
-		"check-outdated": "npx --yes -- check-outdated --ignore-pre-releases"
+		"check-outdated": "npx --yes -- check-outdated --ignore-pre-releases",
+		"_stylelint-find-rules": "stylelint-find-new-rules ./stylelint/index.js",
+		"_validate-stylelint-options": "node ./validate-stylelint-options.mjs"
 	},
 	"dependencies": {
-		"@typescript-eslint/eslint-plugin": "6.3.0",
-		"@typescript-eslint/parser": "6.3.0",
-		"@typescript-eslint/utils": "6.3.0",
-		"eslint": "8.47.0",
+		"@typescript-eslint/eslint-plugin": "6.4.1",
+		"@typescript-eslint/parser": "6.4.1",
+		"@typescript-eslint/utils": "6.4.1",
+		"eslint": "8.48.0",
 		"eslint-import-resolver-typescript": "3.6.0",
-		"eslint-import-resolver-webpack": "0.13.4",
+		"eslint-import-resolver-webpack": "0.13.7",
 		"eslint-plugin-eslint-comments": "3.2.0",
 		"eslint-plugin-functional": "6.0.0",
-		"eslint-plugin-import": "2.28.0",
+		"eslint-plugin-import": "2.28.1",
 		"eslint-plugin-jest": "27.2.3",
-		"eslint-plugin-jsdoc": "46.4.6",
+		"eslint-plugin-jsdoc": "46.5.0",
 		"eslint-plugin-jsx-a11y": "6.7.1",
-		"eslint-plugin-n": "16.0.1",
+		"eslint-plugin-n": "16.0.2",
 		"eslint-plugin-promise": "6.1.1",
-		"eslint-plugin-react": "7.33.1",
+		"eslint-plugin-react": "7.33.2",
 		"eslint-plugin-react-hooks": "4.6.0",
 		"eslint-plugin-unicorn": "48.0.1",
 		"markdownlint-cli": "0.35.0",
 		"micromatch": "4.0.5",
-		"postcss-scss": "4.0.6",
-		"stylelint": "15.10.2",
+		"postcss-scss": "4.0.7",
+		"stylelint": "15.10.3",
 		"stylelint-declaration-block-no-ignored-properties": "2.7.0",
 		"stylelint-order": "6.0.3",
 		"stylelint-scss": "5.1.0",
@@ -73,8 +73,8 @@
 	"devDependencies": {
 		"@types/eslint": "8.44.2",
 		"@types/micromatch": "4.0.2",
-		"@types/node": "20.4.9",
-		"stylelint-find-new-rules": "4.1.0",
-		"typescript": "5.1.6"
+		"@types/node": "20.5.7",
+		"stylelint-find-new-rules": "4.1.1",
+		"typescript": "5.2.2"
 	}
 }

package/stylelint/index.js

@@ -4,7 +4,7 @@
 
 /* eslint-disable max-lines -- The rules can be easier managed if they are all in one file  */
 
-const path = require('path');
+const path = require('node:path');
 
 module.exports = {
 	reportNeedlessDisables: true,