feat(json): Support formatted .json files

Author: coderwyd

.github/renovate.json5

@@ -1,3 +1,3 @@
 {
-  "extends": ["github>coderwyd/renovate-config"]
+  extends: ['github>coderwyd/renovate-config'],
 }

README.md

@@ -218,10 +218,11 @@ interface OptionsConfig {
    * {
    *  "html": true,
    *  "css": true,
-   *  "graphql": true,
-   *  "markdown": true
-   *  "yaml": true
-   *  "toml": true
+   *  "json": true,
+   *  "graphql": false,
+   *  "markdown": false
+   *  "yaml": false
+   *  "toml": false
    * }
    */
   formatter?: OptionsFormatters

example/html.html

@@ -20,6 +20,10 @@
       ga('create', 'UA-XXXXX-Y', 'auto')
       ga('send', 'pageview')
     </script>
-    <script src="https://www.google-analytics.com/analytics.js" async defer></script>
+    <script
+      src="https://www.google-analytics.com/analytics.js"
+      async
+      defer
+    ></script>
   </body>
 </html>

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@coderwyd/eslint-config",
   "type": "module",
-  "version": "2.1.4",
+  "version": "2.1.5",
   "packageManager": "[email protected]",
   "description": "Donny's ESLint config",
   "author": "Donny Wang <[email protected]> (https://github.com/coderwyd/)",
@@ -26,10 +26,7 @@
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "bin": "./bin/index.js",
-  "files": [
-    "bin",
-    "dist"
-  ],
+  "files": ["bin", "dist"],
   "publishConfig": {
     "access": "public"
   },

src/cli/run.ts

@@ -8,7 +8,14 @@ import c from 'picocolors'
 
 // @ts-expect-error missing types
 import parse from 'parse-gitignore'
-import { ARROW, CHECK, WARN, eslintVersion, version, vscodeSettingsString } from './constants'
+import {
+  ARROW,
+  CHECK,
+  WARN,
+  eslintVersion,
+  version,
+  vscodeSettingsString,
+} from './constants'
 import { isGitClean } from './utils'
 
 export interface RuleOptions {
@@ -29,14 +36,19 @@ export async function run(options: RuleOptions = {}) {
   const pathESLintIngore = path.join(cwd, '.eslintignore')
 
   if (fs.existsSync(pathFlatConfig)) {
-    console.log(c.yellow(`${WARN} eslint.config.js already exists, migration wizard exited.`))
+    console.log(
+      c.yellow(
+        `${WARN} eslint.config.js already exists, migration wizard exited.`,
+      ),
+    )
     return process.exit(1)
   }
 
   if (!SKIP_GIT_CHECK && !isGitClean()) {
     const { confirmed } = await prompts({
       initial: false,
-      message: 'There are uncommitted changes in the current repository, are you sure to continue?',
+      message:
+        'There are uncommitted changes in the current repository, are you sure to continue?',
       name: 'confirmed',
       type: 'confirm',
     })
@@ -67,7 +79,10 @@ export async function run(options: RuleOptions = {}) {
 
     for (const glob of globs) {
       if (glob.type === 'ignore') eslintIgnores.push(...glob.patterns)
-      else if (glob.type === 'unignore') eslintIgnores.push(...glob.patterns.map((pattern: string) => `!${pattern}`))
+      else if (glob.type === 'unignore')
+        eslintIgnores.push(
+          ...glob.patterns.map((pattern: string) => `!${pattern}`),
+        )
     }
   }
 
@@ -94,7 +109,8 @@ module.exports = defineConfig({\n${coderwydConfig}\n})
   const files = fs.readdirSync(cwd)
   const legacyConfig: string[] = []
   files.forEach(file => {
-    if (file.includes('eslint') || file.includes('prettier')) legacyConfig.push(file)
+    if (file.includes('eslint') || file.includes('prettier'))
+      legacyConfig.push(file)
   })
   if (legacyConfig.length > 0) {
     console.log(`${WARN} you can now remove those files manually:`)
@@ -112,7 +128,8 @@ module.exports = defineConfig({\n${coderwydConfig}\n})
       promptResult = await prompts(
         {
           initial: true,
-          message: 'Update .vscode/settings.json for better VS Code experience?',
+          message:
+            'Update .vscode/settings.json for better VS Code experience?',
           name: 'updateVscodeSettings',
           type: 'confirm',
         },
@@ -132,7 +149,8 @@ module.exports = defineConfig({\n${coderwydConfig}\n})
     const dotVscodePath: string = path.join(cwd, '.vscode')
     const settingsPath: string = path.join(dotVscodePath, 'settings.json')
 
-    if (!fs.existsSync(dotVscodePath)) await fsp.mkdir(dotVscodePath, { recursive: true })
+    if (!fs.existsSync(dotVscodePath))
+      await fsp.mkdir(dotVscodePath, { recursive: true })
 
     if (!fs.existsSync(settingsPath)) {
       await fsp.writeFile(settingsPath, `{${vscodeSettingsString}}\n`, 'utf-8')
@@ -141,7 +159,10 @@ module.exports = defineConfig({\n${coderwydConfig}\n})
       let settingsContent = await fsp.readFile(settingsPath, 'utf8')
 
       settingsContent = settingsContent.trim().replace(/\s*}$/, '')
-      settingsContent += settingsContent.endsWith(',') || settingsContent.endsWith('{') ? '' : ','
+      settingsContent +=
+        settingsContent.endsWith(',') || settingsContent.endsWith('{')
+          ? ''
+          : ','
       settingsContent += `${vscodeSettingsString}}\n`
 
       await fsp.writeFile(settingsPath, settingsContent, 'utf-8')
@@ -151,5 +172,7 @@ module.exports = defineConfig({\n${coderwydConfig}\n})
 
   // End update .vscode/settings.json
   console.log(c.green(`${CHECK} migration completed`))
-  console.log(`Now you can update the dependencies and run ${c.blue('eslint . --fix')}\n`)
+  console.log(
+    `Now you can update the dependencies and run ${c.blue('eslint . --fix')}\n`,
+  )
 }

src/configs/formatter.ts

@@ -2,6 +2,9 @@ import {
   GLOB_CSS,
   GLOB_GRAPHQL,
   GLOB_HTML,
+  GLOB_JSON,
+  GLOB_JSON5,
+  GLOB_JSONC,
   GLOB_LESS,
   GLOB_MARKDOWN,
   GLOB_POSTCSS,
@@ -11,19 +14,36 @@ import {
 } from '../constants/glob'
 
 import { ensurePackages, interopDefault, parserPlain } from '../shared'
-import type { FlatConfigItem, OptionsFormatters, PartialPrettierExtendedOptions, PrettierParser } from '../types'
+import type {
+  FlatConfigItem,
+  OptionsFormatters,
+  PartialPrettierExtendedOptions,
+  PrettierParser,
+} from '../types'
 
 export async function formatter(
   options: OptionsFormatters = {},
   prettierRules: PartialPrettierExtendedOptions = {},
 ): Promise<FlatConfigItem[]> {
   await ensurePackages(['eslint-plugin-prettier'])
 
-  const { css = true, graphql, html = true, markdown, toml, yaml } = options || {}
+  const {
+    css = true,
+    graphql,
+    html = true,
+    json = true,
+    markdown,
+    toml,
+    yaml,
+  } = options || {}
 
   const pluginPrettier = await interopDefault(import('eslint-plugin-prettier'))
 
-  function createPrettierFormatter(files: string[], parser: PrettierParser, plugins?: string[]) {
+  function createPrettierFormatter(
+    files: string[],
+    parser: PrettierParser,
+    plugins?: string[],
+  ) {
     const rules = {
       ...prettierRules,
       parser,
@@ -49,7 +69,10 @@ export async function formatter(
         prettier: pluginPrettier,
       },
       rules: {
-        'prettier/prettier': ['warn', parser === 'markdown' ? markdownRules : rules],
+        'prettier/prettier': [
+          'warn',
+          parser === 'markdown' ? markdownRules : rules,
+        ],
       },
     }
 
@@ -65,6 +88,11 @@ export async function formatter(
     },
   ]
 
+  if (html) {
+    const htmlConfig = createPrettierFormatter([GLOB_HTML], 'html')
+    configs.push(htmlConfig)
+  }
+
   if (css) {
     const cssConfig = createPrettierFormatter([GLOB_CSS, GLOB_POSTCSS], 'css')
     const scssConfig = createPrettierFormatter([GLOB_SCSS], 'scss')
@@ -73,9 +101,10 @@ export async function formatter(
     configs.push(cssConfig, scssConfig, lessConfig)
   }
 
-  if (html) {
-    const htmlConfig = createPrettierFormatter([GLOB_HTML], 'html')
-    configs.push(htmlConfig)
+  if (json) {
+    const jsonConfig = createPrettierFormatter([GLOB_JSON, GLOB_JSONC], 'json')
+    const json5Config = createPrettierFormatter([GLOB_JSON5], 'json5')
+    configs.push(jsonConfig, json5Config)
   }
 
   if (markdown) {
@@ -96,7 +125,9 @@ export async function formatter(
   if (toml) {
     await ensurePackages(['@toml-tools/parser', 'prettier-plugin-toml'])
 
-    const tomlConfig = createPrettierFormatter([GLOB_TOML], 'toml', ['prettier-plugin-toml'])
+    const tomlConfig = createPrettierFormatter([GLOB_TOML], 'toml', [
+      'prettier-plugin-toml',
+    ])
 
     configs.push(tomlConfig)
   }

src/configs/imports.ts

@@ -16,7 +16,10 @@ export async function imports(): Promise<FlatConfigItem[]> {
         'antfu/no-import-node-modules-by-path': 'error',
 
         'import/first': 'error',
-        'import/newline-after-import': ['error', { considerComments: true, count: 1 }],
+        'import/newline-after-import': [
+          'error',
+          { considerComments: true, count: 1 },
+        ],
         'import/no-duplicates': 'error',
         'import/no-mutable-exports': 'error',
         'import/no-named-default': 'error',
@@ -25,7 +28,16 @@ export async function imports(): Promise<FlatConfigItem[]> {
         'import/order': [
           'error',
           {
-            groups: ['builtin', 'external', 'internal', 'parent', 'sibling', 'index', 'object', 'type'],
+            groups: [
+              'builtin',
+              'external',
+              'internal',
+              'parent',
+              'sibling',
+              'index',
+              'object',
+              'type',
+            ],
             pathGroups: [{ group: 'internal', pattern: '{{@,~}/,#}**' }],
             pathGroupsExcludedImportTypes: ['type'],
           },

src/configs/javascript.ts

@@ -1,9 +1,15 @@
 import globals from 'globals'
 import { pluginUnusedImports } from '../plugins'
 import { GLOB_SRC, GLOB_SRC_EXT } from '../constants/glob'
-import type { FlatConfigItem, OptionsIsInEditor, OptionsOverrides } from '../types'
+import type {
+  FlatConfigItem,
+  OptionsIsInEditor,
+  OptionsOverrides,
+} from '../types'
 
-export async function javascript(options: OptionsIsInEditor & OptionsOverrides = {}): Promise<FlatConfigItem[]> {
+export async function javascript(
+  options: OptionsIsInEditor & OptionsOverrides = {},
+): Promise<FlatConfigItem[]> {
   const { isInEditor = false, overrides = {} } = options
 
   return [
@@ -35,15 +41,21 @@ export async function javascript(options: OptionsIsInEditor & OptionsOverrides =
         'unused-imports': pluginUnusedImports,
       },
       rules: {
-        'accessor-pairs': ['error', { enforceForClassMembers: true, setWithoutGet: true }],
+        'accessor-pairs': [
+          'error',
+          { enforceForClassMembers: true, setWithoutGet: true },
+        ],
 
         'array-callback-return': 'error',
         'block-scoped-var': 'error',
         'constructor-super': 'error',
         'default-case-last': 'error',
         'dot-notation': ['error', { allowKeywords: true }],
         eqeqeq: ['error', 'smart'],
-        'new-cap': ['error', { capIsNew: false, newIsCap: true, properties: true }],
+        'new-cap': [
+          'error',
+          { capIsNew: false, newIsCap: true, properties: true },
+        ],
         'no-alert': 'error',
         'no-array-constructor': 'error',
         'no-async-promise-executor': 'error',
@@ -102,7 +114,8 @@ export async function javascript(options: OptionsIsInEditor & OptionsOverrides =
         'no-restricted-properties': [
           'error',
           {
-            message: 'Use `Object.getPrototypeOf` or `Object.setPrototypeOf` instead.',
+            message:
+              'Use `Object.getPrototypeOf` or `Object.setPrototypeOf` instead.',
             property: '__proto__',
           },
           {
@@ -164,7 +177,10 @@ export async function javascript(options: OptionsIsInEditor & OptionsOverrides =
             vars: 'all',
           },
         ],
-        'no-use-before-define': ['error', { classes: false, functions: false, variables: true }],
+        'no-use-before-define': [
+          'error',
+          { classes: false, functions: false, variables: true },
+        ],
         'no-useless-backreference': 'error',
         'no-useless-call': 'error',
         'no-useless-catch': 'error',
@@ -227,7 +243,10 @@ export async function javascript(options: OptionsIsInEditor & OptionsOverrides =
             varsIgnorePattern: '^_',
           },
         ],
-        'use-isnan': ['error', { enforceForIndexOf: true, enforceForSwitchCase: true }],
+        'use-isnan': [
+          'error',
+          { enforceForIndexOf: true, enforceForSwitchCase: true },
+        ],
         'valid-typeof': ['error', { requireStringLiterals: true }],
         'vars-on-top': 'error',
         yoda: ['error', 'never'],

src/configs/jsonc.ts

@@ -2,8 +2,11 @@ import { GLOB_JSON, GLOB_JSON5, GLOB_JSONC } from '../constants/glob'
 import { interopDefault } from '../shared'
 import type { FlatConfigItem, OptionsFiles, OptionsOverrides } from '../types'
 
-export async function jsonc(options: OptionsFiles & OptionsOverrides = {}): Promise<FlatConfigItem[]> {
-  const { files = [GLOB_JSON, GLOB_JSON5, GLOB_JSONC], overrides = {} } = options || {}
+export async function jsonc(
+  options: OptionsFiles & OptionsOverrides = {},
+): Promise<FlatConfigItem[]> {
+  const { files = [GLOB_JSON, GLOB_JSON5, GLOB_JSONC], overrides = {} } =
+    options || {}
 
   const [pluginJsonc, parserJsonc] = await Promise.all([
     interopDefault(import('eslint-plugin-jsonc')),