linter-bundle 5.0.0 → 5.0.1

package/.linter-bundle.js

@@ -34,10 +34,12 @@ export default {
 					'.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/CHANGELOG.md

@@ -6,14 +6,27 @@ 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.0.1...HEAD)
+
+## [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

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/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/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "linter-bundle",
-	"version": "5.0.0",
+	"version": "5.0.1",
 	"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');