Merge pull request #106 from codex-team/fix/prettier

fix(prettier): some fixes of prettier along with eslint
codex-team · Feb 23, 2024 · 3926af8 · 3926af8
2 parents 4da279d + d8d9bb0
commit 3926af8
Show file tree

Hide file tree

Showing 6 changed files with 217 additions and 10 deletions.
diff --git a/.eslintrc b/.eslintrc
@@ -2,20 +2,89 @@
   "extends": [
     "codex/ts",
     "plugin:vue/vue3-recommended",
-    ".architecture.eslintrc"
+    ".architecture.eslintrc",
+    "plugin:prettier-vue/recommended"
   ],
   "parserOptions": {
     "ecmaVersion": "latest",
     "sourceType": "module",
     "parser": "@typescript-eslint/parser"
   },
+  "settings": {
+    "prettier-vue": {
+      // Settings for how to process Vue SFC Blocks
+      "SFCBlocks": {
+        /**
+         * Use prettier to process `<template>` blocks or not
+         *
+         * If set to `false`, you may need to enable those vue rules that are disabled by `eslint-config-prettier`,
+         * because you need them to lint `<template>` blocks
+         *
+         * @default true
+         */
+        "template": true,
+
+        /**
+         * Use prettier to process `<script>` blocks or not
+         *
+         * If set to `false`, you may need to enable those rules that are disabled by `eslint-config-prettier`,
+         * because you need them to lint `<script>` blocks
+         *
+         * @default true
+         */
+        "script": true,
+
+        /**
+         * Use prettier to process `<style>` blocks or not
+         *
+         * @default true
+         */
+        "style": true,
+
+        // Settings for how to process custom blocks
+        "customBlocks": {
+          // Treat the `<docs>` block as a `.markdown` file
+          "docs": { "lang": "markdown" },
+
+          // Treat the `<config>` block as a `.json` file
+          "config": { "lang": "json" },
+
+          // Treat the `<module>` block as a `.js` file
+          "module": { "lang": "js" },
+
+          // Ignore `<comments>` block (omit it or set it to `false` to ignore the block)
+          "comments": false
+
+          // Other custom blocks that are not listed here will be ignored
+        }
+      },
+
+      // Use prettierrc for prettier options or not (default: `true`)
+      "usePrettierrc": true,
+
+      // Set the options for `prettier.getFileInfo`.
+      // @see https://prettier.io/docs/en/api.html#prettiergetfileinfofilepath-options
+      "fileInfoOptions": {
+        // Path to ignore file (default: `'.prettierignore'`)
+        // Notice that the ignore file is only used for this plugin
+        "ignorePath": ".testignore",
+
+        // Process the files in `node_modules` or not (default: `false`)
+        "withNodeModules": false
+      }
+    }
+  },
   "rules": {
     "vue/multi-word-component-names": "off",
-    "jsdoc/check-tag-names": ["error", {
-      "definedTags": ["template"]
-    }],
+    "jsdoc/check-tag-names": [
+      "error",
+      {
+        "definedTags": ["template"]
+      }
+    ],
     "jsdoc/require-param-type": "off",
     "jsdoc/require-returns": "off",
-    "jsdoc/require-returns-type": "off"
+    "jsdoc/require-returns-type": "off",
+    "prettier-vue/prettier": ["error"]
   }
 }
diff --git a/.prettierignore b/.prettierignore
@@ -1,2 +1,5 @@
 dist
 yarn.lock
+.eslintrc
+.architecture.eslintrc
+.nvmrc
diff --git a/.prettierrc b/.prettierrc
@@ -4,5 +4,14 @@
   "singleQuote": true,
   "singleAttributePerLine": true,
   "bracketSameLine": false,
-  "printWidth": 120
+  "printWidth": 120,
+  "overrides": [
+    {
+      "files": ["**/*.*rc"],
+      "options": {
+        "parser": "json",
+        "trailingComma": "none"
+      }
+    }
+  ]
 }
diff --git a/package.json b/package.json
@@ -11,8 +11,7 @@
     "lint": "eslint . --ext .ts,.vue",
     "lint:fix": "yarn lint --fix",
     "watch-ts": "vue-tsc --noEmit --watch",
-    "format": "prettier --write --cache .",
-    "format:check": "prettier --check --cache ."
+    "format": "prettier --write --cache ."
   },
   "private": true,
   "workspaces": [
@@ -48,8 +47,10 @@
     "@vitejs/plugin-vue": "^4.1.0",
     "eslint": "^8.51.0",
     "eslint-config-codex": "^1.9.1",
+    "eslint-config-prettier": "^9.1.0",
     "eslint-import-resolver-typescript": "^3.5.5",
     "eslint-plugin-boundaries": "^3.1.1",
+    "eslint-plugin-prettier-vue": "^5.0.0",
     "eslint-plugin-vue": "^9.15.1",
     "postcss": "^8.4.26",
     "postcss-apply": "^0.12.0",

diff --git a/src/infrastructure/note.repository.ts b/src/infrastructure/note.repository.ts
@@ -63,7 +63,9 @@ export default class NoteRepository implements NoteRepositoryInterface {
    * @param content - Note content (Editor.js data)
    */
   public async createNote(content: NoteContent): Promise<Note> {
-    const response = await this.transport.post<{ id: NoteId }>('/note', { content });
+    const response = await this.transport.post<{ id: NoteId }>('/note', {
+      content,
+    });
 
     const note: Note = {
       id: response.id,

diff --git a/yarn.lock b/yarn.lock
@@ -1127,6 +1127,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@pkgr/core@npm:^0.1.0":
+  version: 0.1.1
+  resolution: "@pkgr/core@npm:0.1.1"
+  checksum: 6f25fd2e3008f259c77207ac9915b02f1628420403b2630c92a07ff963129238c9262afc9e84344c7a23b5cc1f3965e2cd17e3798219f5fd78a63d144d3cceba
+  languageName: node
+  linkType: hard
+
 "@rollup/rollup-android-arm-eabi@npm:4.9.6":
   version: 4.9.6
   resolution: "@rollup/rollup-android-arm-eabi@npm:4.9.6"
@@ -1520,6 +1527,19 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@vue/compiler-core@npm:3.4.19":
+  version: 3.4.19
+  resolution: "@vue/compiler-core@npm:3.4.19"
+  dependencies:
+    "@babel/parser": ^7.23.9
+    "@vue/shared": 3.4.19
+    entities: ^4.5.0
+    estree-walker: ^2.0.2
+    source-map-js: ^1.0.2
+  checksum: 92fbcc52c0e0b44c88a5af84c9beb3aab80c85f9fc81bdb00ea64b6c0e524843670f576d6734c7fe385c116f71ae189bc6e9dc0674fd4898c3163b32c00aaebc
+  languageName: node
+  linkType: hard
+
 "@vue/compiler-dom@npm:3.3.4, @vue/compiler-dom@npm:^3.3.0":
   version: 3.3.4
   resolution: "@vue/compiler-dom@npm:3.3.4"
@@ -1540,6 +1560,16 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@vue/compiler-dom@npm:3.4.19":
+  version: 3.4.19
+  resolution: "@vue/compiler-dom@npm:3.4.19"
+  dependencies:
+    "@vue/compiler-core": 3.4.19
+    "@vue/shared": 3.4.19
+  checksum: b74c620c40b1bb9c06726fc61320291155bca44cf06ee55a7f030df90cd009af603ffeeacabebcca83a006d2f589997c2f32801f885a899ddb75818fc060d05c
+  languageName: node
+  linkType: hard
+
 "@vue/compiler-sfc@npm:3.3.4":
   version: 3.3.4
   resolution: "@vue/compiler-sfc@npm:3.3.4"
@@ -1575,6 +1605,23 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@vue/compiler-sfc@npm:^3.3.4":
+  version: 3.4.19
+  resolution: "@vue/compiler-sfc@npm:3.4.19"
+  dependencies:
+    "@babel/parser": ^7.23.9
+    "@vue/compiler-core": 3.4.19
+    "@vue/compiler-dom": 3.4.19
+    "@vue/compiler-ssr": 3.4.19
+    "@vue/shared": 3.4.19
+    estree-walker: ^2.0.2
+    magic-string: ^0.30.6
+    postcss: ^8.4.33
+    source-map-js: ^1.0.2
+  checksum: d622207fdb2030320d3612226da077914018cdf9deb06db0368bbb5dd4ee796aa5f83717287cd5834157d67596142957e7d955d16b5345eafa3e13cb48d3a79a
+  languageName: node
+  linkType: hard
+
 "@vue/compiler-ssr@npm:3.3.4":
   version: 3.3.4
   resolution: "@vue/compiler-ssr@npm:3.3.4"
@@ -1595,6 +1642,16 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@vue/compiler-ssr@npm:3.4.19":
+  version: 3.4.19
+  resolution: "@vue/compiler-ssr@npm:3.4.19"
+  dependencies:
+    "@vue/compiler-dom": 3.4.19
+    "@vue/shared": 3.4.19
+  checksum: b4599560fdad327f30b0a8fc72427bf2c17c44620924e948a3e87c3c35f2e98c080152e0540350b27b4dec832b74752bc94e1334ca8d114c741a4ae1ae67f6f7
+  languageName: node
+  linkType: hard
+
 "@vue/devtools-api@npm:^6.5.0":
   version: 6.5.1
   resolution: "@vue/devtools-api@npm:6.5.1"
@@ -1756,6 +1813,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@vue/shared@npm:3.4.19":
+  version: 3.4.19
+  resolution: "@vue/shared@npm:3.4.19"
+  checksum: 676c2ec007efc5963a37811e1991f7a114ea603d52721feb59e6c1ac119127d1bdf80c57b09b32a53bb803922edc50e3753d847e800e16018a80fc5f9b84fcf5
+  languageName: node
+  linkType: hard
+
 "@vue/typescript@npm:1.8.19":
   version: 1.8.19
   resolution: "@vue/typescript@npm:1.8.19"
@@ -2745,6 +2809,17 @@ __metadata:
   languageName: node
   linkType: hard
 
+"eslint-config-prettier@npm:^9.1.0":
+  version: 9.1.0
+  resolution: "eslint-config-prettier@npm:9.1.0"
+  peerDependencies:
+    eslint: ">=7.0.0"
+  bin:
+    eslint-config-prettier: bin/cli.js
+  checksum: 9229b768c879f500ee54ca05925f31b0c0bafff3d9f5521f98ff05127356de78c81deb9365c86a5ec4efa990cb72b74df8612ae15965b14136044c73e1f6a907
+  languageName: node
+  linkType: hard
+
 "eslint-config-standard@npm:^17.1.0":
   version: 17.1.0
   resolution: "eslint-config-standard@npm:17.1.0"
@@ -2890,6 +2965,19 @@ __metadata:
   languageName: node
   linkType: hard
 
+"eslint-plugin-prettier-vue@npm:^5.0.0":
+  version: 5.0.0
+  resolution: "eslint-plugin-prettier-vue@npm:5.0.0"
+  dependencies:
+    "@vue/compiler-sfc": ^3.3.4
+    picocolors: ^1.0.0
+    prettier: ^3.0.2
+    prettier-linter-helpers: ^1.0.0
+    synckit: ^0.8.5
+  checksum: 0ec8bd76182e833a60fafedd0d4b2f067414c74c8e3c5ea44a2be6f81b8c87a9707a3b2b98dc31a02f33ae1b5acc9a3a66ea9218f4bdf81bd47e49c7dd99bf2f
+  languageName: node
+  linkType: hard
+
 "eslint-plugin-promise@npm:^6.1.1":
   version: 6.1.1
   resolution: "eslint-plugin-promise@npm:6.1.1"
@@ -3044,6 +3132,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"fast-diff@npm:^1.1.2":
+  version: 1.3.0
+  resolution: "fast-diff@npm:1.3.0"
+  checksum: d22d371b994fdc8cce9ff510d7b8dc4da70ac327bcba20df607dd5b9cae9f908f4d1028f5fe467650f058d1e7270235ae0b8230809a262b4df587a3b3aa216c3
+  languageName: node
+  linkType: hard
+
 "fast-glob@npm:^3.2.9, fast-glob@npm:^3.3.1":
   version: 3.3.1
   resolution: "fast-glob@npm:3.3.1"
@@ -4193,8 +4288,10 @@ __metadata:
     codex-ui: "workspace:^"
     eslint: ^8.51.0
     eslint-config-codex: ^1.9.1
+    eslint-config-prettier: ^9.1.0
     eslint-import-resolver-typescript: ^3.5.5
     eslint-plugin-boundaries: ^3.1.1
+    eslint-plugin-prettier-vue: ^5.0.0
     eslint-plugin-vue: ^9.15.1
     jwt-decode: ^3.1.2
     normalize.css: ^8.0.1
@@ -4945,7 +5042,16 @@ __metadata:
   languageName: node
   linkType: hard
 
-"prettier@npm:3.2.5":
+"prettier-linter-helpers@npm:^1.0.0":
+  version: 1.0.0
+  resolution: "prettier-linter-helpers@npm:1.0.0"
+  dependencies:
+    fast-diff: ^1.1.2
+  checksum: 00ce8011cf6430158d27f9c92cfea0a7699405633f7f1d4a45f07e21bf78e99895911cbcdc3853db3a824201a7c745bd49bfea8abd5fb9883e765a90f74f8392
+  languageName: node
+  linkType: hard
+
+"prettier@npm:3.2.5, prettier@npm:^3.0.2":
   version: 3.2.5
   resolution: "prettier@npm:3.2.5"
   bin:
@@ -5459,6 +5565,16 @@ __metadata:
   languageName: node
   linkType: hard
 
+"synckit@npm:^0.8.5":
+  version: 0.8.8
+  resolution: "synckit@npm:0.8.8"
+  dependencies:
+    "@pkgr/core": ^0.1.0
+    tslib: ^2.6.2
+  checksum: 9ed5d33abb785f5f24e2531efd53b2782ca77abf7912f734d170134552b99001915531be5a50297aa45c5701b5c9041e8762e6cd7a38e41e2461c1e7fccdedf8
+  languageName: node
+  linkType: hard
+
 "tapable@npm:^2.2.0":
   version: 2.2.1
   resolution: "tapable@npm:2.2.1"
@@ -5533,6 +5649,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"tslib@npm:^2.6.2":
+  version: 2.6.2
+  resolution: "tslib@npm:2.6.2"
+  checksum: 329ea56123005922f39642318e3d1f0f8265d1e7fcb92c633e0809521da75eeaca28d2cf96d7248229deb40e5c19adf408259f4b9640afd20d13aecc1430f3ad
+  languageName: node
+  linkType: hard
+
 "type-check@npm:^0.4.0, type-check@npm:~0.4.0":
   version: 0.4.0
   resolution: "type-check@npm:0.4.0"