feat(eslint-config)!: update prettier config to use requireOf and d…

…isable for Markdown code blocks (#802)
bfra-me · Dec 25, 2024 · d6201d2 · d6201d2
1 parent d19124f
commit d6201d2
Show file tree

Hide file tree

Showing 4 changed files with 68 additions and 18 deletions.
diff --git a/.changeset/popular-chairs-jam.md b/.changeset/popular-chairs-jam.md
@@ -0,0 +1,6 @@
+---
+"@bfra.me/eslint-config": minor
+---
+
+Update prettier config to use `requireOf` and disable for Markdown code blocks.
+
diff --git a/packages/eslint-config/src/config.d.ts b/packages/eslint-config/src/config.d.ts
diff --git a/packages/eslint-config/src/configs/markdown.ts b/packages/eslint-config/src/configs/markdown.ts
@@ -8,6 +8,34 @@ import {interopDefault} from '../plugins'
  */
 export type MarkdownOptions = Flatten<OptionsFiles & OptionsOverrides & OptionsPrettier>
 
+export const mdFiles = [`*.md`].flatMap(p => [p, `**/${p}`])
+
+export const codeInMdFiles = mdFiles.flatMap(p => [
+  `${p}/*.js`,
+  `${p}/*.jsx`,
+  `${p}/*.cjs`,
+  `${p}/*.mjs`,
+  `${p}/*.ts`,
+  `${p}/*.tsx`,
+  `${p}/*.cts`,
+  `${p}/*.mts`,
+])
+
+export const extInMdFiles = [
+  ...codeInMdFiles,
+  ...mdFiles.flatMap(p => [
+    `${p}/*.json`,
+    `${p}/*.json5`,
+    `${p}/*.jsonc`,
+    `${p}/*.toml`,
+    `${p}/*.yml`,
+    `${p}/*.yaml`,
+    `${p}/*.vue`,
+    `${p}/*.svelte`,
+    `${p}/*.astro`,
+  ]),
+]
+
 /**
  * Configures the ESLint rules for Markdown files.
  * @param options - The configuration options for Markdown files.

diff --git a/packages/eslint-config/src/configs/prettier.ts b/packages/eslint-config/src/configs/prettier.ts
@@ -1,6 +1,9 @@
 import type {Config} from '../config'
 import type {Flatten, OptionsIsInEditor, OptionsOverrides} from '../options'
 import {interopDefault} from '../plugins'
+import {requireOf} from '../require-of'
+import {fallback} from './fallback'
+import {extInMdFiles} from './markdown'
 
 /**
  * Represents the options for the ESLint Prettier configuration.
@@ -14,25 +17,38 @@ export type PrettierOptions = Flatten<OptionsIsInEditor & OptionsOverrides>
  */
 export async function prettier(options: PrettierOptions = {}): Promise<Config[]> {
   const {isInEditor, overrides} = options
-  const [configPrettier, pluginPrettier] = await Promise.all([
-    interopDefault(import('eslint-config-prettier')),
-    interopDefault(import('eslint-plugin-prettier')),
-  ])
+  return requireOf(
+    ['eslint-config-prettier', 'eslint-plugin-prettier', 'prettier'],
+    async () => {
+      const [configPrettier, pluginPrettier] = await Promise.all([
+        interopDefault(import('eslint-config-prettier')),
+        interopDefault(import('eslint-plugin-prettier')),
+      ])
 
-  return [
-    {
-      name: '@bfra.me/prettier',
-      plugins: {
-        prettier: pluginPrettier,
-      },
-      rules: {
-        ...configPrettier.rules,
-        ...(pluginPrettier.configs?.recommended as Config).rules,
+      return [
+        {
+          name: '@bfra.me/prettier',
+          plugins: {
+            prettier: pluginPrettier,
+          },
+          rules: {
+            ...configPrettier.rules,
+            ...(pluginPrettier.configs?.recommended as Config).rules,
 
-        ...(isInEditor ? {} : {'prettier/prettier': 'error'}),
+            ...(isInEditor ? {} : {'prettier/prettier': 'error'}),
 
-        ...overrides,
-      },
+            ...overrides,
+          },
+        },
+        {
+          name: '@bfra.me/prettier/overrides',
+          files: extInMdFiles,
+          rules: {
+            'prettier/prettier': 'off',
+          },
+        },
+      ]
     },
-  ]
+    fallback,
+  )
 }