linter-bundle 5.0.0 → 5.1.0

package/.linter-bundle.js

@@ -9,6 +9,7 @@ const snippets = {
 };
 
 export default {
+	timing: true,
 	files: {
 		restrictions: [
 			{
@@ -31,13 +32,16 @@ export default {
 					'.gitattributes',
 					'.gitignore',
 					'.linter-bundle.js',
+					'.linter-bundle.schema.json',
 					'.markdownlint.json',
 					'.npmignore',
 					'*.md',
+					'eslint.cjs',
 					'LICENSE',
 					'lint.js',
 					'package-lock.json',
 					'package.json',
+					'stylelint.cjs',
 					'stylelint.config.cjs',
 					'test-stylelint.js',
 					'tsconfig.json',

package/.linter-bundle.schema.json

@@ -0,0 +1,125 @@
+{
+	"$schema": "http://json-schema.org/draft-07/schema#",
+	"type": "object",
+	"properties": {
+		"verbose": {
+			"type": "boolean"
+		},
+		"timing": {
+			"type": "boolean"
+		},
+		"git": {
+			"type": "boolean"
+		},
+		"files": {
+			"type": "object",
+			"properties": {
+				"restrictions": {
+					"type": "array",
+					"items": {
+						"type": "object",
+						"properties": {
+							"basePath": {
+								"type": "string"
+							},
+							"allowed": {
+								"type": "array",
+								"items": {
+									"type": "string"
+								}
+							},
+							"disallowed": {
+								"type": "array",
+								"items": {
+									"type": "string"
+								}
+							}
+						},
+						"required": [
+							"restrictions"
+						],
+						"additionalProperties": false
+					}
+				}
+			},
+			"required": [
+				"restrictions"
+			],
+			"additionalProperties": false
+		},
+		"tsc": {
+			"type": "object",
+			"properties": {
+				"tsconfig": {
+					"type": "string"
+				}
+			},
+			"additionalProperties": false
+		},
+		"ts": {
+			"type": "object",
+			"properties": {
+				"tsconfig": {
+					"type": "string"
+				},
+				"include": {
+					"type": "array",
+					"items": {
+						"type": "string"
+					}
+				},
+				"exclude": {
+					"type": "array",
+					"items": {
+						"type": "string"
+					}
+				},
+				"overrides": {
+					"type": "object",
+					"properties": {
+						"general": {
+							"type": "object"
+						},
+						"react": {
+							"type": "object"
+						}
+					},
+					"additionalProperties": false
+				}
+			},
+			"additionalProperties": false
+		},
+		"sass": {
+			"type": "object",
+			"properties": {
+				"patternPrefix": {
+					"type": "string"
+				}
+			},
+			"additionalProperties": false
+		},
+		"audit": {
+			"type": "object",
+			"properties": {
+				"minSeverity": {
+					"type": "string",
+					"enum": [
+						"info",
+						"low",
+						"moderate",
+						"high",
+						"critical"
+					]
+				},
+				"exclude": {
+					"type": "array",
+					"items": {
+						"type": "string"
+					}
+				}
+			},
+			"additionalProperties": false
+		}
+	},
+	"additionalProperties": false
+}

package/CHANGELOG.md

@@ -6,14 +6,39 @@ 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/v5.0.0...HEAD)
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v5.1.0...HEAD)
+
+## [5.1.0] - 2023-09-03
+
+### Added
+
+- [general] Added basic schema for `.linter-bundle.json` configuration file
+
+### Fixed
+
+- [general] Fix support for `.linter-bundle.json`
+
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v5.0.1...v5.1.0)
+
+## [5.0.1] - 2023-09-03
+
+### Changed
+
+- [general] Updated [README.md](./README.md) to reflect breaking changes in v5.0.0.
+
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v5.0.0...v5.0.1)
 
 ## [5.0.0] - 2023-09-03
 
-## Changed
+### Breaking change
 
 - [general] Migrated the code base from CommonJS to ESModules (as far as possible, because ESLint currently does not support ESModules)
 - [general] The linter-bundle configuration can now be a ESModule (`.linter-bundle.mjs` is supported)
+- [general] `"extends"` in the .eslintrc.js needs to be suffixed with the ".cjs" file extension (e.g. `require.resolve('linter-bundle/eslint.cjs')`)
+- [general] `"extends"` in the stylelint.config.js needs to be suffixed with the ".cjs" file extension (e.g. `require.resolve('linter-bundle/stylelint.cjs')`)
+
+### Changed
+
 - [files] Report unmatched `allowed` pattern
 - [markdownlint] Updated `markdownlint-cli` from `0.35.0` to `0.36.0`
 - [eslint] Disabled `considerComments` option of [`import/new-after-import`](https://github.com/import-js/eslint-plugin-import/blob/v2.28.1/docs/rules/newline-after-import.md) rule
@@ -24,7 +49,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [4.0.3] - 2023-08-31
 
-### Changed
+### Fixed
 
 - [files] Don't show "No relevant files changed." if the `--git`` option was not used
 
@@ -32,7 +57,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [4.0.2] - 2023-08-31
 
-### Changed
+### Fixed
 
 - [files] Don't append `"**"` as fallback argument to the command line
 
@@ -43,6 +68,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 ### Changed
 
 - [eslint] Disabled `unicorn/filename-case` in favour of the new linter-bundle `files` task
+
+### Fixed
+
 - [files] Fixed path to `files` task
 
 [Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v4.0.0...v4.0.1)

package/README.md

@@ -86,16 +86,16 @@ npm install linter-bundle --save-dev
 ```js
 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')
+    require.resolve('linter-bundle/eslint.cjs'),
+    // require.resolve('linter-bundle/eslint/overrides-gatsby.cjs'),
+    // require.resolve('linter-bundle/eslint/overrides-javascript.cjs'),
+    require.resolve('linter-bundle/eslint/overrides-javascript-lazy.cjs'),
+    // require.resolve('linter-bundle/eslint/overrides-jest.cjs'),
+    require.resolve('linter-bundle/eslint/overrides-jsdoc.cjs'),
+    // require.resolve('linter-bundle/eslint/overrides-react.cjs'),
+    // require.resolve('linter-bundle/eslint/overrides-storybook.cjs'),
+    // require.resolve('linter-bundle/eslint/overrides-type-declarations.cjs'),
+    // require.resolve('linter-bundle/eslint/overrides-worker.cjs')
   ]
 };
 ```
@@ -104,22 +104,22 @@ module.exports = {
 
 Source | Description | Rules setup
 -|-|-
-`linter-bundle/eslint` | General rule setup. This is also the base for the following **overrides**. | [View](./eslint/index.js)
-`linter-bundle/eslint/overrides-gatsby` | Settings for Gatsby-based projects. | [View](./eslint/overrides-gatsby.js)
-`linter-bundle/eslint/overrides-javascript` |  Strict settings for JavaScript files, which enforces correct types everywhere. | [View](./eslint/overrides-javascript.js)
-`linter-bundle/eslint/overrides-javascript-lazy` | Can be used instead of `overrides-javascript`. It's less strict and allows the `any` type. | [View](./eslint/overrides-javascript-lazy.js)
-`linter-bundle/eslint/overrides-jest` | Settings for projects using Jest. | [View](./eslint/overrides-jest.js)
-`linter-bundle/eslint/overrides-jsdoc` | Settings for projects using JSDoc comments. | [View](./eslint/overrides-jsdoc.js)
-`linter-bundle/eslint/overrides-react` | Settings for projects using React comments. | [View](./eslint/overrides-react.js)
-`linter-bundle/eslint/overrides-storybook` | Settings for projects using Storybook comments. | [View](./eslint/overrides-storybook.js)
-`linter-bundle/eslint/overrides-type-declarations` | Settings for type declaration files (.d.ts). | [View](./eslint/overrides-type-declarations.js)
-`linter-bundle/eslint/overrides-worker` | Settings for projects using Web Workers. | [View](./eslint/overrides-worker.js)
+`linter-bundle/eslint.cjs` | General rule setup. This is also the base for the following **overrides**. | [View](./eslint/index.cjs)
+`linter-bundle/eslint/overrides-gatsby.cjs` | Settings for Gatsby-based projects. | [View](./eslint/overrides-gatsby.js)
+`linter-bundle/eslint/overrides-javascript.cjs` |  Strict settings for JavaScript files, which enforces correct types everywhere. | [View](./eslint/overrides-javascript.cjs)
+`linter-bundle/eslint/overrides-javascript-lazy.cjs` | Can be used instead of `overrides-javascript`. It's less strict and allows the `any` type. | [View](./eslint/overrides-javascript-lazy.cjs)
+`linter-bundle/eslint/overrides-jest.cjs` | Settings for projects using Jest. | [View](./eslint/overrides-jest.cjs)
+`linter-bundle/eslint/overrides-jsdoc.cjs` | Settings for projects using JSDoc comments. | [View](./eslint/overrides-jsdoc.cjs)
+`linter-bundle/eslint/overrides-react.cjs` | Settings for projects using React comments. | [View](./eslint/overrides-react.cjs)
+`linter-bundle/eslint/overrides-storybook.cjs` | Settings for projects using Storybook comments. | [View](./eslint/overrides-storybook.cjs)
+`linter-bundle/eslint/overrides-type-declarations.cjs` | Settings for type declaration files (.d.ts). | [View](./eslint/overrides-type-declarations.cjs)
+`linter-bundle/eslint/overrides-worker.cjs` | Settings for projects using Web Workers. | [View](./eslint/overrides-worker.cjs)
 
 #### stylelint.config.js
 
 ```js
 module.exports = {
-  extends: 'linter-bundle/stylelint'
+  extends: 'linter-bundle/stylelint.cjs'
 };
 
 ```
@@ -309,7 +309,7 @@ module.exports = {
      */
     overrides: {
       /**
-       * Rules that are applied to `linter-bundle/eslint`.
+       * Rules that are applied to `linter-bundle/eslint.cjs`.
        */
       general: {
         'no-restricted-globals': {
@@ -363,7 +363,7 @@ module.exports = {
       },
 
       /**
-       * Rules that are applied to `linter-bundle/eslint/overrides-react`.
+       * Rules that are applied to `linter-bundle/eslint/overrides-react.cjs`.
        */
       react: {
         'react/forbid-component-props': {

package/TODO.md

@@ -1,5 +1,10 @@
 # @todo
 
+- Timing funktioniert nicht - siehe HexEd.it-core
+
+- Wie erreichen wir auto-completion in der .linter-bundle.js datei?
+  .linter-bundle.json vielleicht mit Schema-Datei?
+
 <!-- markdownlint-disable -->
 
 - Bereiche in Readme aufklappbar machen:

package/eslint.cjs

@@ -0,0 +1,5 @@
+/**
+ * @file Wrapper which allows to extend "linter-bundle/eslint.cjs" instead of "linter-bundle/eslint/index.cjs"
+ */
+
+module.exports = require('./eslint/index.cjs');

package/helper/linter-bundle-config.d.ts

@@ -6,6 +6,13 @@ export interface LinterBundleConfig {
 	verbose?: boolean;
 	timing?: boolean;
 	git?: boolean;
+	files?: {
+		restrictions: {
+			basePath: string;
+			allowed?: string[];
+			disallowed?: string[];
+		}[];
+	};
 	tsc?: {
 		tsconfig?: string;
 	};
@@ -34,13 +41,6 @@ export interface LinterBundleConfig {
 		minSeverity?: 'info' | 'low' | 'moderate' | 'high' | 'critical';
 		exclude?: string[];
 	};
-	files?: {
-		restrictions: {
-			basePath: string;
-			allowed?: string[];
-			disallowed?: string[];
-		}[];
-	};
 }
 
 export const linterBundleConfig: LinterBundleConfig;

package/helper/linter-bundle-config.js

@@ -2,6 +2,7 @@
  * @file Returns the `.linter-bundle.js` configuration result.
  */
 
+import * as fs from 'node:fs/promises';
 import * as path from 'node:path';
 
 export const linterBundleConfig = (
@@ -19,9 +20,15 @@ export const linterBundleConfig = (
  * @returns {Promise<import('./linter-bundle-config.js').LinterBundleConfig | undefined>} - Either the file content for `undefined` if the file does not exist.
  * */
 async function loadConfig (fileName) {
-	const filePath = path.join('file://', process.cwd(), fileName);
-
 	try {
+		if (fileName.endsWith('.json')) {
+			const content = await fs.readFile(path.join(process.cwd(), fileName), 'utf8');
+
+			return JSON.parse(content);
+		}
+
+		const filePath = path.join('file://', process.cwd(), fileName);
+
 		const config = await import(filePath);
 
 		if ('default' in config) {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "linter-bundle",
-	"version": "5.0.0",
+	"version": "5.1.0",
 	"type": "module",
 	"description": "Ready-to use bundle of linting tools, containing configurations for ESLint, stylelint and markdownlint.",
 	"keywords": [

package/stylelint.cjs

@@ -0,0 +1,5 @@
+/**
+ * @file Wrapper which allows to extend "linter-bundle/stylelint.cjs" instead of "linter-bundle/stylelint/index.cjs"
+ */
+
+module.exports = require('./stylelint/index.cjs');