@exbotanical/eslint-config 2.0.1 → 2.1.0

package/dist/index.d.ts

@@ -11635,6 +11635,18 @@ interface OptionsJsonc extends AllOptions, OptionsSortKeys {
     indent?: 'tab' | number;
 }
 
+interface OptionsMarkdown extends AllOptions {
+    /**
+     * Lints the code blocks inside Markdown files as source files. Code blocks are often
+     * documentation examples, including intentional counterexamples, so autofix rules that
+     * reorder or remove code are turned off for them. Other fixes still rewrite them.
+     * `overrides` passed here apply to the code blocks.
+     *
+     * @default false
+     */
+    lintCodeBlocks?: boolean | OptionsOverrides;
+}
+
 interface OptionsPerfectionist extends AllOptions {
     /**
      * Sorts declarations whose order can carry meaning: interfaces, object types, enums,
@@ -11790,11 +11802,12 @@ interface OptionsConfig extends OptionsProjectType {
      */
     toml?: boolean | OptionsToml;
     /**
-     * Enables linting for Markdown and Markdown code snippets.
-     * TODO: update rules
+     * Enables Markdown document rules. Code blocks are linted only when
+     * `lintCodeBlocks` is set.
+     *
      * @default true
      */
-    markdown?: boolean | (OptionsOverrides & OptionsFiles);
+    markdown?: boolean | OptionsMarkdown;
     /**
      * Configurable global ignores.
      */

package/dist/index.js

@@ -903,33 +903,53 @@ var JsxConfig = class extends CustomConfig {
 // src/configs/markdown.ts
 var MarkdownConfig = class extends CustomConfig {
   namespace = "markdown";
-  constructor({ files = [GLOB_MARKDOWN], ...rest } = {}) {
+  constructor({
+    files = [GLOB_MARKDOWN],
+    lintCodeBlocks = false,
+    ...rest
+  } = {}) {
     super({
       files,
+      lintCodeBlocks,
       ...rest
     });
   }
   async _rules() {
-    const { files = [GLOB_MARKDOWN], overrides = {} } = this.options;
+    const {
+      files = [GLOB_MARKDOWN],
+      lintCodeBlocks = false,
+      overrides = {}
+    } = this.options;
     const markdown = await interopDefault(import("@eslint/markdown"));
     return [
       this.createRuleConfig("setup", {
         plugins: { markdown }
       }),
-      this.createRuleConfig("processor", {
-        files,
-        ignores: ["**/*.md/*.md"],
-        // `eslint-plugin-markdown` only creates virtual files for code blocks,
-        // but not the markdown file itself (we use passthrough for this).
-        processor: mergeProcessors([markdown.processors.markdown, processorPassThrough])
-      }),
       this.createRuleConfig("rules", {
         files,
         language: "markdown/gfm",
         rules: {
-          ...markdown.configs.recommended[0].rules
+          ...markdown.configs.recommended[0].rules,
+          ...overrides
         }
       }),
+      ...lintCodeBlocks ? this.codeBlockRules(files, markdown, lintCodeBlocks) : []
+    ];
+  }
+  /**
+   * Builds the records that extract code blocks into virtual files and turn off the
+   * rules that do not fit documentation examples.
+   */
+  codeBlockRules(files, markdown, lintCodeBlocks) {
+    const codeBlockOverrides = lintCodeBlocks === true ? {} : lintCodeBlocks.overrides ?? {};
+    return [
+      this.createRuleConfig("processor", {
+        files,
+        ignores: ["**/*.md/*.md"],
+        // The markdown processor only creates virtual files for code blocks, but not
+        // the markdown file itself (we use passthrough for this).
+        processor: mergeProcessors([markdown.processors.markdown, processorPassThrough])
+      }),
       this.createRuleConfig("disables", {
         files: [GLOB_MARKDOWN_CODE],
         languageOptions: {
@@ -938,7 +958,13 @@ var MarkdownConfig = class extends CustomConfig {
           }
         },
         rules: {
+          "import/first": "off",
           "import/newline-after-import": "off",
+          "import/no-duplicates": "off",
+          "import/no-empty-named-blocks": "off",
+          "import/order": "off",
+          "jsdoc/no-blank-blocks": "off",
+          "jsdoc/sort-tags": "off",
           "no-alert": "off",
           "no-console": "off",
           "no-labels": "off",
@@ -948,7 +974,24 @@ var MarkdownConfig = class extends CustomConfig {
           "no-unused-expressions": "off",
           "no-unused-labels": "off",
           "no-unused-vars": "off",
+          "no-useless-return": "off",
           "node/prefer-global/process": "off",
+          "perfectionist/sort-array-includes": "off",
+          "perfectionist/sort-classes": "off",
+          "perfectionist/sort-enums": "off",
+          "perfectionist/sort-exports": "off",
+          "perfectionist/sort-heritage-clauses": "off",
+          "perfectionist/sort-interfaces": "off",
+          "perfectionist/sort-intersection-types": "off",
+          "perfectionist/sort-modules": "off",
+          "perfectionist/sort-named-exports": "off",
+          "perfectionist/sort-named-imports": "off",
+          "perfectionist/sort-object-types": "off",
+          "perfectionist/sort-sets": "off",
+          "perfectionist/sort-union-types": "off",
+          "regexp/sort-alternatives": "off",
+          "regexp/sort-character-class-elements": "off",
+          "regexp/sort-flags": "off",
           "style/comma-dangle": "off",
           "style/eol-last": "off",
           "ts/consistent-type-imports": "off",
@@ -960,9 +1003,10 @@ var MarkdownConfig = class extends CustomConfig {
           "ts/no-unused-vars": "off",
           "ts/no-use-before-define": "off",
           "unicode-bom": "off",
+          "unicorn/prefer-export-from": "off",
           "unused-imports/no-unused-imports": "off",
           "unused-imports/no-unused-vars": "off",
-          ...overrides
+          ...codeBlockOverrides
         }
       })
     ];
@@ -2523,9 +2567,6 @@ async function exbotanical({
   if (optionsCss) {
     configs2.push(new CssConfig({ ...factoryConfig(optionsCss) }).rules());
   }
-  if (optionsMarkdown) {
-    configs2.push(new MarkdownConfig({ ...factoryConfig(optionsMarkdown) }).rules());
-  }
   if (optionsGraphql) {
     configs2.push(new GraphqlConfig().rules());
   }
@@ -2552,6 +2593,9 @@ async function exbotanical({
       new YamlConfig({ ...factoryConfig(optionsYaml), ...optionsStyle }).rules()
     );
   }
+  if (optionsMarkdown) {
+    configs2.push(new MarkdownConfig({ ...factoryConfig(optionsMarkdown) }).rules());
+  }
   configs2.push(
     new DataFilesConfig({
       files: [

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@exbotanical/eslint-config",
   "type": "module",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "private": false,
   "description": "Zito's eslint config",
   "author": "Matthew Zito <exbotanical@protonmail.com> (https://github.com/exbotanical/)",