refactor: turn on some formatting rules

Author: coderwyd

README.md

@@ -218,7 +218,6 @@ interface OptionsConfig {
    * {
    *  "html": true,
    *  "css": true,
-   *  "json": true,
    *  "graphql": false,
    *  "markdown": false
    *  "yaml": false

package.json

@@ -15,6 +15,9 @@
     "eslint-config-svelte",
     "prettier"
   ],
+  "publishConfig": {
+    "access": "public"
+  },
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -27,9 +30,6 @@
   "types": "./dist/index.d.ts",
   "bin": "./bin/index.js",
   "files": ["bin", "dist"],
-  "publishConfig": {
-    "access": "public"
-  },
   "engines": {
     "node": ">=16.14.0"
   },
@@ -39,9 +39,9 @@
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
     "prepack": "nr build",
+    "prepare": "simple-git-hooks",
     "release": "bumpp && pnpm publish",
-    "typecheck": "tsc --noEmit",
-    "prepare": "simple-git-hooks"
+    "typecheck": "tsc --noEmit"
   },
   "peerDependencies": {
     "@unocss/eslint-plugin": ">=0.50.0",

src/configs/formatter.ts

@@ -2,9 +2,6 @@ import {
   GLOB_CSS,
   GLOB_GRAPHQL,
   GLOB_HTML,
-  GLOB_JSON,
-  GLOB_JSON5,
-  GLOB_JSONC,
   GLOB_LESS,
   GLOB_MARKDOWN,
   GLOB_POSTCSS,
@@ -31,7 +28,6 @@ export async function formatter(
     css = true,
     graphql,
     html = true,
-    json = true,
     markdown,
     toml,
     yaml,
@@ -101,12 +97,6 @@ export async function formatter(
     configs.push(cssConfig, scssConfig, lessConfig)
   }
 
-  if (json) {
-    const jsonConfig = createPrettierFormatter([GLOB_JSON, GLOB_JSONC], 'json')
-    const json5Config = createPrettierFormatter([GLOB_JSON5], 'json5')
-    configs.push(jsonConfig, json5Config)
-  }
-
   if (markdown) {
     const markdownConfig = createPrettierFormatter([GLOB_MARKDOWN], 'markdown')
     configs.push(markdownConfig)

src/configs/imports.ts

@@ -16,10 +16,6 @@ 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/no-duplicates': 'error',
         'import/no-mutable-exports': 'error',
         'import/no-named-default': 'error',
@@ -42,6 +38,14 @@ export async function imports(): Promise<FlatConfigItem[]> {
             pathGroupsExcludedImportTypes: ['type'],
           },
         ],
+
+        ...{
+          // format
+          'import/newline-after-import': [
+            'error',
+            { considerComments: true, count: 1 },
+          ],
+        },
       },
     },
     {

src/configs/jsdoc.ts

@@ -24,6 +24,12 @@ export async function jsdoc(): Promise<FlatConfigItem[]> {
         'jsdoc/require-returns-check': 'warn',
         'jsdoc/require-returns-description': 'warn',
         'jsdoc/require-yields-check': 'warn',
+
+        ...{
+          // format
+          'jsdoc/check-alignment': 'warn',
+          'jsdoc/multiline-blocks': 'warn',
+        },
       },
     },
   ]

src/configs/jsonc.ts

@@ -54,6 +54,29 @@ export async function jsonc(
         'jsonc/valid-json-number': 'error',
         'jsonc/vue-custom-block/no-parsing-error': 'error',
 
+        ...{
+          // format
+          'jsonc/array-bracket-spacing': ['error', 'never'],
+          'jsonc/comma-dangle': ['error', 'never'],
+          'jsonc/comma-style': ['error', 'last'],
+          'jsonc/indent': ['error', 2],
+          'jsonc/key-spacing': [
+            'error',
+            { afterColon: true, beforeColon: false },
+          ],
+          'jsonc/object-curly-newline': [
+            'error',
+            { consistent: true, multiline: true },
+          ],
+          'jsonc/object-curly-spacing': ['error', 'always'],
+          'jsonc/object-property-newline': [
+            'error',
+            { allowMultiplePropertiesPerLine: true },
+          ],
+          'jsonc/quote-props': 'error',
+          'jsonc/quotes': 'error',
+        },
+
         ...overrides,
       },
     },

src/configs/svelte.ts

@@ -87,6 +87,22 @@ export async function svelte(
           },
         ],
 
+        ...{
+          // format
+          'style/no-trailing-spaces': 'off', // superseded by svelte/no-trailing-spaces
+          'svelte/derived-has-same-inputs-outputs': 'error',
+          'svelte/html-closing-bracket-spacing': 'error',
+          'svelte/html-quotes': ['error', { prefer: 'single' }],
+          'svelte/indent': [
+            'error',
+            { alignAttributesVertically: true, indent: 2 },
+          ],
+          'svelte/mustache-spacing': 'error',
+          'svelte/no-spaces-around-equal-signs-in-attribute': 'error',
+          'svelte/no-trailing-spaces': 'error',
+          'svelte/spaced-html-comment': 'error',
+        },
+
         ...overrides,
       },
     },

src/configs/vue.ts

@@ -132,7 +132,6 @@ export async function vue(
             ignoreConstructors: false,
           },
         ],
-        'vue/padding-line-between-blocks': ['error', 'always'],
         'vue/prefer-separate-static-class': 'error',
         'vue/prefer-template': 'error',
         'vue/prop-name-casing': ['error', 'camelCase'],
@@ -142,6 +141,47 @@ export async function vue(
         'vue/space-unary-ops': ['error', { nonwords: false, words: true }],
         'vue/valid-define-options': 'warn',
 
+        ...{
+          // format
+          'vue/array-bracket-spacing': ['error', 'never'],
+          'vue/arrow-spacing': ['error', { after: true, before: true }],
+          'vue/block-spacing': ['error', 'always'],
+          'vue/block-tag-newline': [
+            'error',
+            {
+              multiline: 'always',
+              singleline: 'always',
+            },
+          ],
+          'vue/brace-style': ['error', 'stroustrup', { allowSingleLine: true }],
+          'vue/comma-dangle': ['error', 'always-multiline'],
+          'vue/comma-spacing': ['error', { after: true, before: false }],
+          'vue/comma-style': ['error', 'last'],
+          'vue/html-comment-content-spacing': [
+            'error',
+            'always',
+            {
+              exceptions: ['-'],
+            },
+          ],
+          'vue/key-spacing': [
+            'error',
+            { afterColon: true, beforeColon: false },
+          ],
+          'vue/keyword-spacing': ['error', { after: true, before: true }],
+          'vue/object-curly-newline': 'off',
+          'vue/object-curly-spacing': ['error', 'always'],
+          'vue/object-property-newline': [
+            'error',
+            { allowMultiplePropertiesPerLine: true },
+          ],
+          'vue/operator-linebreak': ['error', 'before'],
+          'vue/padding-line-between-blocks': ['error', 'always'],
+          'vue/quote-props': ['error', 'consistent-as-needed'],
+          'vue/space-in-parens': ['error', 'never'],
+          'vue/template-curly-spacing': 'error',
+        },
+
         ...overrides,
       },
     },

src/types/index.ts

@@ -28,11 +28,6 @@ export interface OptionsFormatters {
    */
   css?: boolean
 
-  /**
-   * Enable formatting support for Json.
-   */
-  json?: boolean
-
   /**
    * Enable formatting support for Markdown.
    */
@@ -223,7 +218,6 @@ export interface OptionsConfig extends OptionsComponentExts {
    * {
    *  "html": true,
    *  "css": true,
-   *  "json": true,
    *  "graphql": false,
    *  "markdown": false
    *  "yaml": false