Add CSpell (#25)

PR: #25

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.lintstagedrc.js

@@ -1,5 +1,9 @@
+const toRelative = require('./src/utils/relativePath.js');
+
 module.exports = {
   '*': 'prettier --check --ignore-unknown',
   '*.js': 'eslint --cache',
   '*.{js,ts}': () => 'npm run typescript:check',
+  '*': (files) =>
+    `cspell --show-suggestions --quiet --gitignore ${toRelative(files)}`,
 };

cspell.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
+  "version": "0.2",
+  "dictionaryDefinitions": [
+    {
+      "name": "project-words",
+      "path": "./project-words.txt",
+      "addWords": true
+    }
+  ],
+  "dictionaries": ["project-words"],
+  "ignorePaths": ["node_modules", "/project-words.txt"]
+}

package.json

@@ -14,7 +14,8 @@
     "prettier:check": "prettier --check .",
     "prettier:write": "prettier --write .",
     "typescript:check": "tsc -p tsconfig.json",
-    "prepare": "husky install"
+    "prepare": "husky install",
+    "cspell": "cspell --show-suggestions --show-context --gitignore ."
   },
   "author": "",
   "license": "MIT",
@@ -32,6 +33,7 @@
   "devDependencies": {
     "@flydotio/dockerfile": "^0.4.10",
     "@types/node": "^20.8.6",
+    "cspell": "^7.3.8",
     "eslint": "^8.50.0",
     "husky": "^8.0.3",
     "lint-staged": "^14.0.1",

prisma/README.md

@@ -1,11 +1,9 @@
 # Messenger
-
 > Generated by [`prisma-markdown`](https://github.com/samchon/prisma-markdown)
 
 - [default](#default)
 
 ## default
-
 ```mermaid
 erDiagram
 User {
@@ -34,27 +32,24 @@ Message }|--|| Chat : chat
 ### `User`
 
 **Properties**
-
-- `id`:
-- `username`:
-- `email`:
-- `password`:
-- `createdAt`:
+  - `id`: 
+  - `username`: 
+  - `email`: 
+  - `password`: 
+  - `createdAt`: 
 
 ### `Message`
 
 **Properties**
-
-- `id`:
-- `content`:
-- `senderId`:
-- `chatId`:
-- `createdAt`:
+  - `id`: 
+  - `content`: 
+  - `senderId`: 
+  - `chatId`: 
+  - `createdAt`: 
 
 ### `Chat`
 
 **Properties**
-
-- `id`:
-- `name`:
-- `createdAt`:
+  - `id`: 
+  - `name`: 
+  - `createdAt`: 

project-words.txt

@@ -0,0 +1,6 @@
+nocheck
+datasource
+fastify
+Fastify
+pino
+flydotio

src/utils/relativePath.js

@@ -0,0 +1,6 @@
+const path = require('node:path');
+
+const toRelative = (files) =>
+  files.map((file) => path.relative(process.cwd(), file)).join(' ');
+
+module.exports = toRelative;