@cto.af/eslint-config 3.1.0 → 4.0.1

package/jsdoc.js

@@ -1,16 +1,16 @@
 'use strict';
 
-// Use when you're going to generate docs with JSDoc.
-
-// module.exports = {
-//   extends: '@cto.af/eslint-config/jsdoc'
-// }
-//
-
-module.exports = {
-  plugins: [
-    'jsdoc',
+const {rules} = require('./rules/jsdoc.js');
+module.exports = [{
+  files: [
+    '**/*.js',
+    '**/*.cjs',
+    '**/*.mjs',
+    '**/*.ts',
   ],
+  plugins: {
+    jsdoc: require('eslint-plugin-jsdoc'),
+  },
   settings: {
     jsdoc: {
       tagNamePreference: {
@@ -18,78 +18,5 @@ module.exports = {
       },
     },
   },
-  rules: {
-    // [Stylistic Issues](https://eslint.org/docs/rules/#stylistic-issues)
-    'jsdoc/require-jsdoc': ['error', {
-      publicOnly: {ancestorsOnly: true},
-    }],
-
-    'jsdoc/check-access': 'error',
-    'jsdoc/check-alignment': 'error',
-    // https://github.com/eslint/eslint/issues/14745
-    'jsdoc/check-examples': 'off',
-    'jsdoc/check-indentation': 'off',
-    'jsdoc/check-line-alignment': ['error', 'never', {
-      wrapIndent: '  ',
-    }],
-    'jsdoc/check-param-names': 'error',
-    'jsdoc/check-property-names': 'error',
-    'jsdoc/check-syntax': 'error',
-    'jsdoc/check-tag-names': 'error',
-    'jsdoc/check-types': 'error',
-    'jsdoc/check-values': 'error',
-    'jsdoc/empty-tags': 'error',
-    'jsdoc/implements-on-classes': 'error',
-    'jsdoc/imports-as-dependencies': 'error',
-    'jsdoc/informative-docs': 'off', // This sounds annoying
-    'jsdoc/match-description': 'error',
-    'jsdoc/match-name': 'off',
-    'jsdoc/multiline-blocks': 'error',
-    'jsdoc/no-bad-blocks': 'error',
-    'jsdoc/no-blank-blocks': 'error',
-    'jsdoc/no-blank-block-descriptions': 'off', // I use blank lines intentionally
-    'jsdoc/no-defaults': 'off',
-    'jsdoc/no-missing-syntax': 'off',
-    'jsdoc/no-multi-asterisks': 'error',
-    'jsdoc/no-restricted-syntax': 'off',
-    'jsdoc/no-types': 'off',
-    'jsdoc/no-undefined-types': 'off', // Use typedoc
-    'jsdoc/require-asterisk-prefix': 'error',
-    'jsdoc/require-description': ['error', {exemptedBy: ['inheritdoc', 'private', 'ignore']}],
-    'jsdoc/require-description-complete-sentence': 'error',
-    'jsdoc/require-example': 'off',
-    'jsdoc/require-file-overview': 'off',
-    'jsdoc/require-hyphen-before-param-description': ['error', 'never'],
-    'jsdoc/require-param': ['error', {exemptedBy: ['inheritdoc', 'private', 'ignore']}],
-    'jsdoc/require-param-description': 'error',
-    'jsdoc/require-param-name': 'error',
-    'jsdoc/require-param-type': 'error',
-    'jsdoc/require-property': 'error',
-    'jsdoc/require-property-description': 'error',
-    'jsdoc/require-property-name': 'error',
-    'jsdoc/require-property-type': 'error',
-    'jsdoc/require-returns': ['error', {
-      exemptedBy: ['ignore'],
-    }],
-    'jsdoc/require-returns-check': 'error',
-    'jsdoc/require-returns-description': 'error',
-    'jsdoc/require-returns-type': 'error',
-    'jsdoc/require-throws': 'error',
-    'jsdoc/require-yields': 'error',
-    'jsdoc/require-yields-check': 'error',
-    'jsdoc/sort-tags': 'error',
-    'jsdoc/tag-lines': 'off',
-    'jsdoc/text-escaping': 'off', // Painful
-    'jsdoc/valid-types': 'error',
-  },
-  overrides: [
-    {
-      files: ['*.ts'],
-      rules: {
-        'jsdoc/no-undefined-types': 'off', // Switch to typedoc
-        'jsdoc/require-param-type': 'off', // Not needed in TS
-        'jsdoc/require-returns-type': 'off', // Not needed in TS
-      },
-    },
-  ],
-};
+  rules,
+}];

package/jsdoc_ts.js

@@ -0,0 +1,12 @@
+'use strict';
+
+module.exports = [{
+  files: [
+    '**/*.ts',
+  ],
+  rules: {
+    'jsdoc/no-undefined-types': 'off', // Switch to typedoc
+    'jsdoc/require-param-type': 'off', // Not needed in TS
+    'jsdoc/require-returns-type': 'off', // Not needed in TS
+  },
+}];

package/markdown.js

@@ -0,0 +1,35 @@
+'use strict';
+const markdown = require('eslint-plugin-markdown');
+
+module.exports = [
+  {
+    files: [
+      '**/*.md',
+    ],
+    plugins: {
+      markdown,
+    },
+    processor: 'markdown/markdown',
+  },
+  {
+    files: [
+      '**/*.md/**',
+    ],
+    languageOptions: {
+      parserOptions: {
+        ecmaFeatures: {impliedStrict: true},
+      },
+    },
+    rules: {
+      'eol-last': 'off',
+      'no-undef': 'off',
+      'no-unused-expressions': 'off',
+      'no-unused-vars': 'off',
+      'padded-blocks': 'off',
+      'strict': 'off',
+      'unicode-bom': 'off',
+      'no-console': 'off',
+      'n/no-missing-import': 'off',
+    },
+  },
+];

package/mjs.js

@@ -0,0 +1,11 @@
+'use strict';
+
+module.exports = [{
+  files: [
+    '**/*.mjs',
+    '**/*.ts',
+  ],
+  languageOptions: {
+    sourceType: 'module',
+  },
+}];

package/module.js

@@ -0,0 +1,8 @@
+'use strict';
+
+module.exports = [{
+  files: ['**/*.js'],
+  languageOptions: {
+    sourceType: 'module',
+  },
+}];

package/package.json

@@ -1,14 +1,12 @@
 {
   "name": "@cto.af/eslint-config",
-  "version": "3.1.0",
+  "version": "4.0.1",
   "description": "hildjj's lint rules",
   "main": "index.js",
   "scripts": {
-    "test": "cd test; npm run test",
-    "lint": "eslint . --ext js,cjs,mjs,ts",
-    "unused": "eslint-find-rules index.js -u && eslint-find-rules ava.js -u --no-core && eslint-find-rules jsdoc.js -u --no-core && eslint-find-rules ts.js -u --no-core",
-    "update": "ncu -u --deep && ncu --dep peer -u && npm run unused && pnpm i -r && npm test",
-    "ci": "npm run lint && npm run test && npm run unused"
+    "test": "cd test; npm run test; npm run lint",
+    "lint": "eslint .",
+    "ci": "npm run lint && npm run test"
   },
   "keywords": [
     "lint"
@@ -17,45 +15,22 @@
   "license": "MIT",
   "repository": "cto-af/eslint-config",
   "dependencies": {
-    "@stylistic/eslint-plugin": "1.5.4",
-    "eslint-plugin-n": "16.6.2"
-  },
-  "peerDependencies": {
-    "@typescript-eslint/eslint-plugin": "~6",
-    "@typescript-eslint/parser": "~6",
-    "eslint": "~8",
-    "eslint-plugin-ava": "~14",
-    "eslint-plugin-jsdoc": "~48",
-    "typescript": "~5"
-  },
-  "peerDependenciesMeta": {
-    "@typescript-eslint/eslint-plugin": {
-      "optional": true
-    },
-    "@typescript-eslint/parser": {
-      "optional": true
-    },
-    "typescript": {
-      "optional": true
-    },
-    "eslint-plugin-ava": {
-      "optional": true
-    },
-    "eslint-plugin-jsdoc": {
-      "optional": true
-    }
+    "@stylistic/eslint-plugin": "1.6.3",
+    "eslint-plugin-n": "16.6.2",
+    "globals": "14.0.0"
   },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "6.19.1",
-    "@typescript-eslint/parser": "6.19.1",
-    "eslint": "^8.56.0",
-    "eslint-find-rules": "4.1.0",
+    "@hildjj/sort-rules": "link:sort-rules",
+    "eslint": "^8.57.0",
+    "eslint-find-rules": "^4.1.0",
     "eslint-plugin-ava": "^14.0.0",
-    "eslint-plugin-hildjj": "link:rules",
-    "eslint-plugin-jsdoc": "^48.0.2",
-    "npm-check-updates": "16.14.12",
-    "typescript": "5.3.3"
+    "eslint-plugin-jsdoc": "^48.2.1",
+    "eslint-plugin-markdown": "^4.0.1",
+    "npm-check-updates": "^16.14.15",
+    "typescript": "^5.4.2",
+    "typescript-eslint": "^7.2.0"
   },
+  "packageManager": "pnpm@8.15.4",
   "engines": {
     "node": ">=18"
   }

package/rules/ava.js

@@ -0,0 +1,44 @@
+'use strict';
+
+module.exports = {
+  rules: {
+    // Check: ava
+
+    // [ava](https://github.com/avajs/eslint-plugin-ava?tab=readme-ov-file#rules)
+    'ava/assertion-arguments': 'error',
+    'ava/hooks-order': 'error',
+    'ava/max-asserts': 'off',
+    'ava/no-async-fn-without-await': 'error',
+    'ava/no-duplicate-modifiers': 'error',
+    'ava/no-identical-title': 'error',
+    'ava/no-ignored-test-files': 'off', // Buggy
+    'ava/no-import-test-files': 'error',
+    'ava/no-incorrect-deep-equal': 'error',
+    'ava/no-inline-assertions': 'error',
+    'ava/no-nested-tests': 'error',
+    'ava/no-only-test': 'error',
+    'ava/no-skip-assert': 'error',
+    'ava/no-skip-test': 'error',
+    'ava/no-todo-implementation': 'error',
+    'ava/no-todo-test': 'error',
+    'ava/no-unknown-modifiers': 'error',
+    'ava/prefer-async-await': 'error',
+    'ava/prefer-power-assert': 'off',
+    'ava/prefer-t-regex': 'error',
+    'ava/test-title': 'error',
+    'ava/test-title-format': 'error',
+    'ava/use-t': 'error',
+    'ava/use-t-throws-async-well': 'error',
+    'ava/use-t-well': 'error',
+    'ava/use-test': 'error',
+    'ava/use-true-false': 'off',
+
+    // [Possible Errors](https://github.com/eslint-community/eslint-plugin-n#possible-errors)
+    'n/no-extraneous-import': ['error', {
+      // This is an extraneous error because of the way ava is built and the
+      // way that esplugin-n finds depedencies.
+      allowModules: ['ava'],
+    }],
+    'n/no-extraneous-require': ['error', {allowModules: ['ava']}],
+  },
+};