@enormora/eslint-config-base-with-prettier 0.0.2 → 0.0.4

package/package.json

@@ -4,15 +4,19 @@
         "Christian Rackerseder <github@echooff.de>"
     ],
     "dependencies": {
-        "@cspell/eslint-plugin": "10.0.0",
-        "@eslint-community/eslint-plugin-eslint-comments": "4.7.1",
+        "@ben_12/eslint-simple-parser": "0.1.0",
+        "@cspell/eslint-plugin": "10.0.1",
+        "@eslint-community/eslint-plugin-eslint-comments": "4.7.2",
+        "@eslint/markdown": "8.0.2",
         "@stylistic/eslint-plugin": "5.10.0",
         "eslint-plugin-array-func": "5.1.1",
         "eslint-plugin-destructuring": "2.2.1",
         "eslint-plugin-import-x": "4.16.2",
+        "eslint-plugin-markdown-links": "0.9.0",
+        "eslint-plugin-markdown-preferences": "0.41.1",
         "eslint-plugin-no-barrel-files": "1.3.1",
         "eslint-plugin-no-secrets": "2.3.3",
-        "eslint-plugin-prettier": "5.5.5",
+        "eslint-plugin-prettier": "5.5.6",
         "eslint-plugin-promise": "7.3.0",
         "eslint-plugin-sonarjs": "4.0.3",
         "eslint-plugin-unicorn": "64.0.0"
@@ -39,5 +43,5 @@
         "./rule-sets/restricted-syntax.js"
     ],
     "type": "module",
-    "version": "0.0.2"
+    "version": "0.0.4"
 }

package/presets/base/base-shared.js

@@ -20,6 +20,31 @@ const restrictedSyntaxPlugin = createRestrictedSyntaxPlugin([
     'no-in-operator'
 ]);
 
+export const cspellSpellcheckerOptions = {
+    autoFix: false,
+    numSuggestions: 3,
+    generateSuggestions: true,
+    ignoreImports: true,
+    ignoreImportProperties: true,
+    checkIdentifiers: true,
+    checkStrings: true,
+    checkStringTemplates: true,
+    checkJSXText: true,
+    checkComments: true,
+    cspell: {
+        words: [],
+        ignoreWords: [],
+        flagWords: [],
+        ignoreRegExpList: [],
+        includeRegExpList: [],
+        allowCompoundWords: true,
+        import: [],
+        dictionaries: []
+    },
+    customWordListFile: undefined,
+    debugMode: false
+};
+
 export const baseSharedConfig = {
     languageOptions: {
         ecmaVersion,
@@ -185,7 +210,23 @@ export const baseSharedConfig = {
         'no-warning-comments': [
             'error',
             {
-                terms: [ 'todo', 'fixme', 'wtf', 'falls through', 'istanbul', 'c8' ],
+                terms: [
+                    'todo',
+                    'fixme',
+                    'wtf',
+                    'falls through',
+                    'istanbul',
+                    'c8',
+                    'v8 ignore',
+                    'node:coverage',
+                    'prettier-ignore',
+                    'dprint-ignore',
+                    'cspell:disable',
+                    'cspell:ignore',
+                    'cspell:words',
+                    'Stryker disable',
+                    'Stryker restore'
+                ],
                 location: 'anywhere'
             }
         ],
@@ -425,32 +466,6 @@ export const baseSharedConfig = {
         'import/no-rename-default': 'off',
         'import/prefer-namespace-import': 'off',
 
-        '@cspell/spellchecker': [
-            'warn',
-            {
-                autoFix: false,
-                numSuggestions: 3,
-                generateSuggestions: true,
-                ignoreImports: true,
-                ignoreImportProperties: true,
-                checkIdentifiers: true,
-                checkStrings: true,
-                checkStringTemplates: true,
-                checkJSXText: true,
-                checkComments: true,
-                cspell: {
-                    words: [],
-                    ignoreWords: [],
-                    flagWords: [],
-                    ignoreRegExpList: [],
-                    includeRegExpList: [],
-                    allowCompoundWords: true,
-                    import: [],
-                    dictionaries: []
-                },
-                customWordListFile: undefined,
-                debugMode: false
-            }
-        ]
+        '@cspell/spellchecker': [ 'error', cspellSpellcheckerOptions ]
     }
 };

package/presets/base/cspell-config.js

@@ -0,0 +1 @@
+import { cspellSpellcheckerOptions } from './base-shared.js';

package/presets/base/markdown-lint-rules.js

@@ -0,0 +1,98 @@
+import markdownPlugin from '@eslint/markdown';
+import markdownLinksPlugin from 'eslint-plugin-markdown-links';
+import markdownPreferencesPlugin from 'eslint-plugin-markdown-preferences';
+
+export const markdownLintPlugins = {
+    markdown: markdownPlugin,
+    'markdown-links': markdownLinksPlugin,
+    'markdown-preferences': markdownPreferencesPlugin
+};
+
+export const markdownLintRules = {
+    'markdown/fenced-code-language': 'error',
+    'markdown/fenced-code-meta': 'off',
+    'markdown/heading-increment': 'error',
+    'markdown/no-bare-urls': 'error',
+    'markdown/no-duplicate-definitions': 'error',
+    'markdown/no-duplicate-headings': 'error',
+    'markdown/no-empty-definitions': 'error',
+    'markdown/no-empty-images': 'error',
+    'markdown/no-empty-links': 'error',
+    'markdown/no-html': 'error',
+    'markdown/no-invalid-label-refs': 'error',
+    'markdown/no-missing-atx-heading-space': 'error',
+    'markdown/no-missing-label-refs': 'error',
+    'markdown/no-missing-link-fragments': 'error',
+    'markdown/no-multiple-h1': 'error',
+    'markdown/no-reference-like-urls': 'error',
+    'markdown/no-reversed-media-syntax': 'error',
+    'markdown/no-space-in-emphasis': 'error',
+    'markdown/no-unused-definitions': 'error',
+    'markdown/require-alt-text': 'error',
+    'markdown/table-column-count': 'error',
+
+    // markdown-links: external network check is opt-in to keep CI deterministic;
+    // local-path and fragment checks are pure wins.
+    'markdown-links/no-dead-urls': 'off',
+    'markdown-links/no-missing-fragments': 'error',
+    'markdown-links/no-missing-path': 'error',
+    'markdown-links/no-self-destination': 'error',
+
+    // markdown-preferences: many rules overlap with the active markdown formatter (dprint or
+    // prettier, depending on which base preset is used). We enable only the 8 rules from this
+    // plugin's `recommended` config (none of which fight either formatter) and explicitly turn
+    // the other 45 off. Override individually if a stricter style is desired.
+    'markdown-preferences/atx-heading-closing-sequence': 'off',
+    'markdown-preferences/atx-heading-closing-sequence-length': 'off',
+    'markdown-preferences/blockquote-marker-alignment': 'error',
+    'markdown-preferences/bullet-list-marker-style': 'off',
+    'markdown-preferences/canonical-code-block-language': 'off',
+    'markdown-preferences/code-fence-length': 'off',
+    'markdown-preferences/code-fence-spacing': 'off',
+    'markdown-preferences/code-fence-style': 'off',
+    'markdown-preferences/custom-container-marker-spacing': 'off',
+    'markdown-preferences/definitions-last': 'off',
+    'markdown-preferences/emoji-notation': 'off',
+    'markdown-preferences/emphasis-delimiters-style': 'off',
+    'markdown-preferences/hard-linebreak-style': 'error',
+    'markdown-preferences/heading-casing': 'off',
+    'markdown-preferences/indent': 'off',
+    'markdown-preferences/level1-heading-style': 'off',
+    'markdown-preferences/level2-heading-style': 'off',
+    'markdown-preferences/link-bracket-newline': 'off',
+    'markdown-preferences/link-bracket-spacing': 'off',
+    'markdown-preferences/link-destination-style': 'off',
+    'markdown-preferences/link-paren-newline': 'off',
+    'markdown-preferences/link-paren-spacing': 'off',
+    'markdown-preferences/link-title-style': 'off',
+    'markdown-preferences/list-marker-alignment': 'error',
+    'markdown-preferences/max-len': 'off',
+    'markdown-preferences/no-heading-trailing-punctuation': 'off',
+    'markdown-preferences/no-implicit-block-closing': 'error',
+    'markdown-preferences/no-laziness-blockquotes': 'error',
+    'markdown-preferences/no-multi-spaces': 'off',
+    'markdown-preferences/no-multiple-empty-lines': 'off',
+    'markdown-preferences/no-tabs': 'off',
+    'markdown-preferences/no-text-backslash-linebreak': 'error',
+    'markdown-preferences/no-trailing-spaces': 'off',
+    'markdown-preferences/ordered-list-marker-sequence': 'off',
+    'markdown-preferences/ordered-list-marker-start': 'off',
+    'markdown-preferences/ordered-list-marker-style': 'off',
+    'markdown-preferences/padded-custom-containers': 'off',
+    'markdown-preferences/padding-line-between-blocks': 'off',
+    'markdown-preferences/prefer-autolinks': 'error',
+    'markdown-preferences/prefer-fenced-code-blocks': 'error',
+    'markdown-preferences/prefer-inline-code-words': 'off',
+    'markdown-preferences/prefer-link-reference-definitions': 'off',
+    'markdown-preferences/prefer-linked-words': 'off',
+    'markdown-preferences/setext-heading-underline-length': 'off',
+    'markdown-preferences/sort-definitions': 'off',
+    'markdown-preferences/strikethrough-delimiters-style': 'off',
+    'markdown-preferences/table-header-casing': 'off',
+    'markdown-preferences/table-leading-trailing-pipes': 'off',
+    'markdown-preferences/table-pipe-alignment': 'off',
+    'markdown-preferences/table-pipe-spacing': 'off',
+    'markdown-preferences/thematic-break-character-style': 'off',
+    'markdown-preferences/thematic-break-length': 'off',
+    'markdown-preferences/thematic-break-sequence-pattern': 'off'
+};

package/presets/base-with-prettier/base-with-prettier.js

@@ -1,7 +1,10 @@
+import simpleParser from '@ben_12/eslint-simple-parser';
 import prettierPlugin from 'eslint-plugin-prettier';
 import { baseSharedConfig } from '../base/base-shared.js';
+import { markdownLintPlugins, markdownLintRules } from '../base/markdown-lint-rules.js';
 
-export const baseWithPrettierConfig = {
+const baseJsConfig = {
+    files: [ '**/*.{js,cjs,mjs,jsx,ts,cts,mts,tsx,vue}' ],
     ...baseSharedConfig,
     plugins: {
         ...baseSharedConfig.plugins,
@@ -10,6 +13,49 @@ export const baseWithPrettierConfig = {
     rules: {
         ...baseSharedConfig.rules,
 
-        'prettier/prettier': 'error'
+        'prettier/prettier': 'error',
+
+        // Prettier owns TypeScript member delimiter formatting; the stylistic rule would only fight it.
+        '@stylistic/member-delimiter-style': 'off'
     }
 };
+
+const prettierJsonConfig = {
+    files: [ '**/*.json' ],
+    languageOptions: { parser: simpleParser },
+    plugins: { prettier: prettierPlugin },
+    rules: { 'prettier/prettier': 'error' }
+};
+
+const prettierYamlConfig = {
+    files: [ '**/*.{yml,yaml}' ],
+    languageOptions: { parser: simpleParser },
+    plugins: { prettier: prettierPlugin },
+    rules: { 'prettier/prettier': 'error' }
+};
+
+const markdownConfig = {
+    files: [ '**/*.md' ],
+    plugins: {
+        ...markdownLintPlugins,
+        prettier: prettierPlugin
+    },
+    // See ../base/markdown.js for why this is pinned to commonmark instead of gfm.
+    language: 'markdown/commonmark',
+    rules: {
+        'prettier/prettier': 'error',
+
+        ...markdownLintRules
+    }
+};
+
+export const baseWithPrettierConfig = [
+    baseJsConfig,
+    prettierJsonConfig,
+    markdownConfig,
+    prettierYamlConfig
+];
+
+/* eslint-disable no-barrel-files/no-barrel-files -- expose cspell helper as public API so consumers can spread or call it when customizing */
+export { withCspellWords } from '../base/cspell-config.js';
+/* eslint-enable no-barrel-files/no-barrel-files -- end of public re-exports */

package/readme.md

@@ -6,7 +6,10 @@ Drop-in alternative to [`@enormora/eslint-config-base`](../base/base.md) that fo
 [prettier](https://prettier.io/) instead of dprint.
 
 This preset is itself a base preset — pick this one **or** `@enormora/eslint-config-base`, never both. It contains the
-same set of lint rules as the regular base preset; the only difference is the formatter integration.
+same set of lint rules as the regular base preset, including the semantic markdown linting stack
+(`@eslint/markdown`, `eslint-plugin-markdown-links`, `eslint-plugin-markdown-preferences`). The only differences are
+the formatter integration and that TOML is not covered (prettier has no native TOML support; see
+[Limitations](#limitations) below).
 
 ## Install & Setup
 
@@ -21,24 +24,98 @@ Provide a `prettier.config.js` at your project root with the formatting options
 
 ```javascript
 export default {
-  printWidth: 120,
-  tabWidth: 4,
-  singleQuote: true,
-  trailingComma: "none",
-  arrowParens: "always",
+    printWidth: 120,
+    tabWidth: 4,
+    singleQuote: true,
+    trailingComma: 'none',
+    arrowParens: 'always'
 };
 ```
 
-Create an ESLint configuration file (e.g., `eslint.config.js`) in your project and add the preset to the configuration
-array:
+Create an ESLint configuration file (e.g., `eslint.config.js`) in your project and spread the preset into the
+configuration array:
 
 ```javascript
-import { baseWithPrettierConfig } from "@enormora/eslint-config-base-with-prettier";
+import { baseWithPrettierConfig } from '@enormora/eslint-config-base-with-prettier';
 
 export default [
-  {
-    ignores: ["dist/**/*"],
-  },
-  baseWithPrettierConfig,
+    {
+        ignores: [ 'dist/**/*' ]
+    },
+    ...baseWithPrettierConfig
 ];
 ```
+
+`baseWithPrettierConfig` is an array of flat config blocks. The first block targets the JS/TS/Vue file set and carries
+the lint rules; the remaining blocks each scope `prettier/prettier` to one file family, with the markdown block
+additionally enabling the semantic markdown linters.
+
+| Block         | Files                                      | Rule(s)                                                                         |
+| :------------ | :----------------------------------------- | :------------------------------------------------------------------------------ |
+| JavaScript/TS | `**/*.{js,cjs,mjs,jsx,ts,cts,mts,tsx,vue}` | base lint rules + `prettier/prettier`                                           |
+| JSON          | `**/*.json`                                | `prettier/prettier`                                                             |
+| Markdown      | `**/*.md`                                  | `prettier/prettier`, `markdown/*`, `markdown-links/*`, `markdown-preferences/*` |
+| YAML          | `**/*.{yml,yaml}`                          | `prettier/prettier`                                                             |
+
+### Linting hidden directories
+
+ESLint's CLI walker skips dot-directories such as `.github/` when you run `eslint .`. Because the formatter blocks
+above match against file paths, they will silently _not_ run on files inside `.github/` unless you pass that path to
+ESLint explicitly. The recommended lint script is therefore:
+
+```json
+{
+    "scripts": {
+        "lint": "eslint . .github"
+    }
+}
+```
+
+### Customizing or disabling the formatter on a file family
+
+Because the blocks are plain flat config, override them the same way as any other ESLint config — add a later block
+whose `files` glob overlaps the one you want to change. Later blocks win.
+
+Disable prettier formatting for JSON entirely:
+
+```javascript
+export default [
+    ...baseWithPrettierConfig,
+    { files: [ '**/*.json' ], rules: { 'prettier/prettier': 'off' } }
+];
+```
+
+Ignore specific paths from formatting:
+
+```javascript
+export default [
+    ...baseWithPrettierConfig,
+    { ignores: [ 'vendor/**/*.json', 'fixtures/**/*.md' ] }
+];
+```
+
+### Tweaking markdown lint rules
+
+To override any markdown rule (from `@eslint/markdown`, `markdown-links`, or `markdown-preferences`), add a later
+block — the same pattern as for any other ESLint rule:
+
+```javascript
+export default [
+    ...baseWithPrettierConfig,
+    {
+        files: [ '**/*.md' ],
+        rules: {
+            'markdown/no-html': 'off',
+            'markdown/fenced-code-language': [ 'error', { required: [ 'js', 'ts' ] } ],
+            'markdown-links/no-dead-urls': 'error',
+            'markdown-preferences/heading-casing': [ 'error', { style: 'Sentence case' } ]
+        }
+    }
+];
+```
+
+## Limitations
+
+- **No TOML coverage.** Prettier does not natively format `.toml` files. If you need TOML formatting, either use
+  [`@enormora/eslint-config-base`](../base/base.md) (which formats TOML via dprint) or wire your own prettier plugin
+  for TOML.

package/sbom.cdx.json

@@ -9,44 +9,70 @@
                 {
                     "type": "application",
                     "name": "packtory",
-                    "version": "0.0.15"
+                    "version": "0.0.32"
                 }
             ]
         },
         "component": {
             "type": "library",
             "name": "@enormora/eslint-config-base-with-prettier",
-            "version": "0.0.2",
-            "bom-ref": "pkg:npm/@enormora/eslint-config-base-with-prettier@0.0.2",
-            "purl": "pkg:npm/@enormora/eslint-config-base-with-prettier@0.0.2"
+            "version": "0.0.4",
+            "bom-ref": "pkg:npm/@enormora/eslint-config-base-with-prettier@0.0.4",
+            "purl": "pkg:npm/@enormora/eslint-config-base-with-prettier@0.0.4"
         }
     },
     "components": [
+        {
+            "type": "library",
+            "name": "@ben_12/eslint-simple-parser",
+            "version": "0.1.0",
+            "bom-ref": "pkg:npm/@ben_12/eslint-simple-parser@0.1.0",
+            "scope": "required",
+            "licenses": [
+                {
+                    "expression": "MIT"
+                }
+            ],
+            "purl": "pkg:npm/@ben_12/eslint-simple-parser@0.1.0"
+        },
         {
             "type": "library",
             "name": "@cspell/eslint-plugin",
-            "version": "10.0.0",
-            "bom-ref": "pkg:npm/@cspell/eslint-plugin@10.0.0",
+            "version": "10.0.1",
+            "bom-ref": "pkg:npm/@cspell/eslint-plugin@10.0.1",
             "scope": "required",
             "licenses": [
                 {
                     "expression": "MIT"
                 }
             ],
-            "purl": "pkg:npm/@cspell/eslint-plugin@10.0.0"
+            "purl": "pkg:npm/@cspell/eslint-plugin@10.0.1"
         },
         {
             "type": "library",
             "name": "@eslint-community/eslint-plugin-eslint-comments",
-            "version": "4.7.1",
-            "bom-ref": "pkg:npm/@eslint-community/eslint-plugin-eslint-comments@4.7.1",
+            "version": "4.7.2",
+            "bom-ref": "pkg:npm/@eslint-community/eslint-plugin-eslint-comments@4.7.2",
+            "scope": "required",
+            "licenses": [
+                {
+                    "expression": "MIT"
+                }
+            ],
+            "purl": "pkg:npm/@eslint-community/eslint-plugin-eslint-comments@4.7.2"
+        },
+        {
+            "type": "library",
+            "name": "@eslint/markdown",
+            "version": "8.0.2",
+            "bom-ref": "pkg:npm/@eslint/markdown@8.0.2",
             "scope": "required",
             "licenses": [
                 {
                     "expression": "MIT"
                 }
             ],
-            "purl": "pkg:npm/@eslint-community/eslint-plugin-eslint-comments@4.7.1"
+            "purl": "pkg:npm/@eslint/markdown@8.0.2"
         },
         {
             "type": "library",
@@ -100,6 +126,32 @@
             ],
             "purl": "pkg:npm/eslint-plugin-import-x@4.16.2"
         },
+        {
+            "type": "library",
+            "name": "eslint-plugin-markdown-links",
+            "version": "0.9.0",
+            "bom-ref": "pkg:npm/eslint-plugin-markdown-links@0.9.0",
+            "scope": "required",
+            "licenses": [
+                {
+                    "expression": "MIT"
+                }
+            ],
+            "purl": "pkg:npm/eslint-plugin-markdown-links@0.9.0"
+        },
+        {
+            "type": "library",
+            "name": "eslint-plugin-markdown-preferences",
+            "version": "0.41.1",
+            "bom-ref": "pkg:npm/eslint-plugin-markdown-preferences@0.41.1",
+            "scope": "required",
+            "licenses": [
+                {
+                    "expression": "MIT"
+                }
+            ],
+            "purl": "pkg:npm/eslint-plugin-markdown-preferences@0.41.1"
+        },
         {
             "type": "library",
             "name": "eslint-plugin-no-barrel-files",
@@ -129,15 +181,15 @@
         {
             "type": "library",
             "name": "eslint-plugin-prettier",
-            "version": "5.5.5",
-            "bom-ref": "pkg:npm/eslint-plugin-prettier@5.5.5",
+            "version": "5.5.6",
+            "bom-ref": "pkg:npm/eslint-plugin-prettier@5.5.6",
             "scope": "required",
             "licenses": [
                 {
                     "expression": "MIT"
                 }
             ],
-            "purl": "pkg:npm/eslint-plugin-prettier@5.5.5"
+            "purl": "pkg:npm/eslint-plugin-prettier@5.5.6"
         },
         {
             "type": "library",
@@ -194,20 +246,27 @@
     ],
     "dependencies": [
         {
-            "ref": "pkg:npm/@cspell/eslint-plugin@10.0.0"
+            "ref": "pkg:npm/@ben_12/eslint-simple-parser@0.1.0"
         },
         {
-            "ref": "pkg:npm/@enormora/eslint-config-base-with-prettier@0.0.2",
+            "ref": "pkg:npm/@cspell/eslint-plugin@10.0.1"
+        },
+        {
+            "ref": "pkg:npm/@enormora/eslint-config-base-with-prettier@0.0.4",
             "dependsOn": [
-                "pkg:npm/@cspell/eslint-plugin@10.0.0",
-                "pkg:npm/@eslint-community/eslint-plugin-eslint-comments@4.7.1",
+                "pkg:npm/@ben_12/eslint-simple-parser@0.1.0",
+                "pkg:npm/@cspell/eslint-plugin@10.0.1",
+                "pkg:npm/@eslint-community/eslint-plugin-eslint-comments@4.7.2",
+                "pkg:npm/@eslint/markdown@8.0.2",
                 "pkg:npm/@stylistic/eslint-plugin@5.10.0",
                 "pkg:npm/eslint-plugin-array-func@5.1.1",
                 "pkg:npm/eslint-plugin-destructuring@2.2.1",
                 "pkg:npm/eslint-plugin-import-x@4.16.2",
+                "pkg:npm/eslint-plugin-markdown-links@0.9.0",
+                "pkg:npm/eslint-plugin-markdown-preferences@0.41.1",
                 "pkg:npm/eslint-plugin-no-barrel-files@1.3.1",
                 "pkg:npm/eslint-plugin-no-secrets@2.3.3",
-                "pkg:npm/eslint-plugin-prettier@5.5.5",
+                "pkg:npm/eslint-plugin-prettier@5.5.6",
                 "pkg:npm/eslint-plugin-promise@7.3.0",
                 "pkg:npm/eslint-plugin-sonarjs@4.0.3",
                 "pkg:npm/eslint-plugin-unicorn@64.0.0",
@@ -215,7 +274,10 @@
             ]
         },
         {
-            "ref": "pkg:npm/@eslint-community/eslint-plugin-eslint-comments@4.7.1"
+            "ref": "pkg:npm/@eslint-community/eslint-plugin-eslint-comments@4.7.2"
+        },
+        {
+            "ref": "pkg:npm/@eslint/markdown@8.0.2"
         },
         {
             "ref": "pkg:npm/@stylistic/eslint-plugin@5.10.0"
@@ -229,6 +291,12 @@
         {
             "ref": "pkg:npm/eslint-plugin-import-x@4.16.2"
         },
+        {
+            "ref": "pkg:npm/eslint-plugin-markdown-links@0.9.0"
+        },
+        {
+            "ref": "pkg:npm/eslint-plugin-markdown-preferences@0.41.1"
+        },
         {
             "ref": "pkg:npm/eslint-plugin-no-barrel-files@1.3.1"
         },
@@ -236,7 +304,7 @@
             "ref": "pkg:npm/eslint-plugin-no-secrets@2.3.3"
         },
         {
-            "ref": "pkg:npm/eslint-plugin-prettier@5.5.5"
+            "ref": "pkg:npm/eslint-plugin-prettier@5.5.6"
         },
         {
             "ref": "pkg:npm/eslint-plugin-promise@7.3.0"