@mscharley/eslint-config 4.0.5 → 4.0.6

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log - @mscharley/eslint-config
 
+## 4.0.6
+
+### Patch Changes
+
+- 8bbdd14: Added a helper to maintain the MPL-2.0 header notices
+- 34655d9: fix(deps): update eslint packages
+
 ## 4.0.5
 
 ### Patch Changes

package/README.md

@@ -23,10 +23,11 @@ $ npm install --save-dev @mscharley/eslint-config
 // eslint.config.js
 import { configs, withStyles } from "@mscharley/eslint-config";
 
-export const [
+export default [
     ...configs.recommended,
     ...configs.node, // For projects running on NodeJS
     // ...configs.react, // For projects running React
+    // ...configs.license["MPL-2.0"](), // Some licenses require notices in each source file, and some of these are predefined for convenience
     ...withStyles(), // Include formatting rules
 ];
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mscharley/eslint-config",
-  "version": "4.0.5",
+  "version": "4.0.6",
   "type": "module",
   "module": "./rules/index.js",
   "exports": {
@@ -37,9 +37,10 @@
     "eslint-import-resolver-typescript": "^3.6.3",
     "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-jest": "^28.8.3",
-    "eslint-plugin-n": "^17.10.3",
+    "eslint-plugin-n": "^17.11.1",
+    "eslint-plugin-notice": "^1.0.0",
     "eslint-plugin-react": "^7.37.1",
-    "eslint-plugin-react-hooks": "5.1.0-beta-26f2496093-20240514",
+    "eslint-plugin-react-hooks": "5.1.0-rc-fb9a90fa48-20240614",
     "typescript": "^5.6.3",
     "typescript-eslint": "^8.8.1"
   },

package/rules/index.js

@@ -1,5 +1,6 @@
 import typescript, { disableTypeCheckedRules } from './typescript.js';
 import eslint from './eslint.js';
+import mpl2 from './mpl2.js';
 import node from './node.js';
 import react from './react.js';
 import stylistic from '@stylistic/eslint-plugin';
@@ -14,6 +15,9 @@ export const configs = {
 	],
 	node,
 	react,
+	license: {
+		'MPL-2.0': mpl2,
+	},
 };
 
 export const withStyles = () => [

package/rules/mpl2.js

@@ -0,0 +1,21 @@
+import notice from 'eslint-plugin-notice';
+
+export default (...files) => [{
+	plugins: { notice },
+	files: files.length === 0 ? ['**/*.{ts,js,tsx,jsx}'] : files,
+	rules: {
+		'notice/notice': [
+			'error',
+			{
+				template:
+				'/**\n'
+				+ ' * This Source Code Form is subject to the terms of the Mozilla Public\n'
+				+ ' * License, v. 2.0. If a copy of the MPL was not distributed with this\n'
+				+ ' * file, You can obtain one at http://mozilla.org/MPL/2.0/.\n'
+				+ ' */\n\n',
+				// The package entrypoint needs some extra grace since the first comment must be the @packageDocumentation.
+				chars: 5000,
+			},
+		],
+	},
+}];