@mscharley/eslint-config 4.0.1 → 4.0.3

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Change Log - @mscharley/eslint-config
 
+## 4.0.3
+
+### Patch Changes
+
+- 7d2169b: Prevent better support for linting JS files
+- 4872523: Apply testing fixes to **mocks** as well as **utils**
+
+## 4.0.2
+
+### Patch Changes
+
+- ab92718: Cleanup some of the testing rules
+- 7d6a205: Fix readme for flat configurations
+
 ## 4.0.1
 
 ### Patch Changes

package/README.md

@@ -20,15 +20,15 @@ $ npm install --save-dev @mscharley/eslint-config
 ## Usage
 
 ```js
-// .eslintrc.js
-module.exports = {
-  root: true,
-  extends: [
-    '@mscharley', // Baseline rules for any TS or JS project.
-    '@mscharley/eslint-config/node', // For projects running on NodeJS.
-    // '@mscharley/eslint-config/react', // For projects running React.
-  ],
-};
+// eslint.config.js
+import { configs, withStyles } from "@mscharley/eslint-config";
+
+export const [
+    ...configs.recommended,
+    ...configs.node, // For projects running on NodeJS
+    // ...configs.react, // For projects running React
+    ...withStyles(), // Include formatting rules
+];
 ```
 
 ### Notes on Prettier
@@ -45,24 +45,13 @@ If using Prettier to format files other than TypeScript and JavaScript files the
 **/*.js
 ```
 
-## Extras
+### Usage in JavaScript projects
 
-### Deprecation warnings for JavaScript files
-
-As a general rule we can't enable the `deprecation/deprecation` rule for JavaScript files because this rule requires TypeScript type information to work. If you have a mixed TypeScript/JavaScript project then you can enable it for the JavaScript files inside your TypeScript project using the following override:
-
-```js
-// .eslintrc.js
-module.exports = {
-  overrides: [
-    {
-      // This must be a valid path inside your TypeScript source folders.
-      files: ["src/**/*.{js,jsx}"],
-      rules: { "deprecation/deprecation": "warn" },
-    },
-  ],
-};
 ```
+Parsing error: [...]/configFile.js was not found by the project service. Consider either including it in the tsconfig.json or including it in allowDefaultProject
+```
+
+If you get messages like this, you can disable type-checked rules using the `disableTypeCheckedRules()` helper function exported by this module. This takes a list of file paths and returns a single configuration object. This takes into account all type checked rules enabled by this configuration and is a superset of the helper configuration provided by `typescript-eslint` for a similar purpose.
 
 [gh-contrib]: https://github.com/mscharley/node-presets/graphs/contributors
 [gh-issues]: https://github.com/mscharley/node-presets/issues

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@mscharley/eslint-config",
-	"version": "4.0.1",
+	"version": "4.0.3",
 	"type": "module",
 	"module": "./rules/index.js",
 	"exports": {

package/rules/index.js

@@ -1,9 +1,9 @@
+import typescript, { disableTypeCheckedRules } from './typescript.js';
 import eslint from './eslint.js';
 import node from './node.js';
 import react from './react.js';
 import stylistic from '@stylistic/eslint-plugin';
 import testing from './testing.js';
-import typescript from './typescript.js';
 
 export const configs = {
 	recommended: [
@@ -37,4 +37,6 @@ export const withStyles = () => [
 	},
 ];
 
-export default { configs, withStyles };
+export { disableTypeCheckedRules };
+
+export default { configs, disableTypeCheckedRules, withStyles };

package/rules/testing.js

@@ -22,6 +22,7 @@ export default [
 		files: jestFiles,
 		rules: {
 			'@typescript-eslint/consistent-type-assertions': 'off',
+			'@typescript-eslint/no-magic-numbers': 'off',
 			'jest/prefer-todo': 'error',
 			'jest/no-conditional-in-test': 'warn',
 			'jest/no-untyped-mock-factory': 'error',
@@ -35,4 +36,13 @@ export default [
 			],
 		},
 	},
+	{
+		files: [
+			'**/__mocks__/**/*.{ts,js,tsx,jsx}',
+			'**/__utils__/**/*.{ts,js,tsx,jsx}',
+		],
+		rules: {
+			'jest/no-export': 'off',
+		},
+	},
 ];

package/rules/typescript.js

@@ -1,5 +1,15 @@
 import { configs as tseslint } from 'typescript-eslint';
 
+export const disableTypeCheckedRules = (...files) => ({
+	files,
+	...tseslint.disableTypeChecked,
+	rules: {
+		...tseslint.disableTypeChecked.rules,
+		'@typescript-eslint/explicit-function-return-type': 'off',
+		'@typescript-eslint/explicit-module-boundary-types': 'off',
+	},
+});
+
 /** @type import('eslint').Config[] */
 export default [
 	...tseslint.recommendedTypeChecked,
@@ -11,9 +21,6 @@ export default [
 		},
 	},
 	{
-		files: [
-			'**/*.ts', '**/*.tsx', '**/*.mts', '**/*.cts',
-		],
 		rules: {
 			'@typescript-eslint/no-deprecated': 'warn',
 			'@typescript-eslint/array-type': [
@@ -128,8 +135,13 @@ export default [
 			'@typescript-eslint/no-unused-vars': [
 				'warn',
 				{
+					args: 'all',
 					argsIgnorePattern: '^_',
+					caughtErrors: 'all',
+					caughtErrorsIgnorePattern: '^_',
+					destructuredArrayIgnorePattern: '^_',
 					varsIgnorePattern: '^_',
+					ignoreRestSiblings: true,
 				},
 			],
 			'@typescript-eslint/no-unnecessary-boolean-literal-compare': [
@@ -174,4 +186,5 @@ export default [
 			'@typescript-eslint/switch-exhaustiveness-check': 'error',
 		},
 	},
+	disableTypeCheckedRules('*.config.js'),
 ];