Grand reformat (#7)

Enabling prettier for the repository

Author: jeremy-rifkin

.eslintrc.yml

@@ -7,89 +7,67 @@ extends:
 ignorePatterns:
   - scratch
   - "*.js"
-parser: '@typescript-eslint/parser'
+parser: "@typescript-eslint/parser"
 parserOptions:
   ecmaVersion: latest
   sourceType: module
   project: ./tsconfig.json
 plugins:
-  - '@typescript-eslint'
+  - "@typescript-eslint"
+  - prettier
 rules:
   indent:
     - error
     - 4
     - FunctionDeclaration:
-        parameters:
-          first
+        parameters: first
       CallExpression:
-        arguments:
-          first
-      MemberExpression:
-        1
-      SwitchCase:
-        1
-      ImportDeclaration:
-        first
+        arguments: first
+      MemberExpression: 1
+      SwitchCase: 1
+      ImportDeclaration: first
   max-len:
     - error
     - 120
   semi:
     - error
     - always
-  quotes:
-    - error
-    - double
   no-unused-vars:
     - off
   no-constant-condition:
     - off
   semi-spacing:
     - error
-    - before:
-        false
-      after:
-        true
+    - before: false
+      after: true
   no-empty:
     - error
-    - allowEmptyCatch:
-        true
+    - allowEmptyCatch: true
   object-curly-spacing:
     - error
     - always
-  array-bracket-spacing:
-    - error
-    - always
-    - singleValue:
-        false
-      objectsInArrays:
-        false
-      arraysInArrays:
-        false
-  space-in-parens:
-    - error
-    - never
   comma-spacing:
     - error
   computed-property-spacing:
     - error
   brace-style:
     - error
     - 1tbs
-    - allowSingleLine:
-        true
+    - allowSingleLine: true
   eol-last:
     - error
   semi-style:
     - error
     - last
+  prefer-const:
+    - error
+    - destructuring: all
+  "prettier/prettier": "error"
   "@typescript-eslint/no-unused-vars":
     - warn
-    - destructuredArrayIgnorePattern:
-        ^_
-      argsIgnorePattern:
-        ^_
-      varsIgnorePattern:
-        ^assert$|^M$
+    - destructuredArrayIgnorePattern: ^_
+      argsIgnorePattern: ^_
+      varsIgnorePattern: ^assert$|^M$
   "@typescript-eslint/no-non-null-assertion":
     - off
   "@typescript-eslint/no-explicit-any":
@@ -98,12 +76,11 @@ rules:
     - error
   "@typescript-eslint/no-unnecessary-condition":
     - error
-    - allowConstantLoopConditions:
-        true
+    - allowConstantLoopConditions: true
   "@typescript-eslint/no-this-alias":
     - error
     - allowedNames:
-      - self
+        - self
   "@typescript-eslint/no-floating-promises":
     - "error"
   "@typescript-eslint/no-misused-promises":

.github/workflows/build.yml

@@ -8,19 +8,19 @@ jobs:
   build:
     runs-on: ubuntu-20.04
     steps:
-    - name: checkout
-      uses: actions/checkout@v3
-    - name: dependencies
-      run: |
-           npm install -g typescript
-           npm i
-    - name: build bot
-      run: tsc
-    - name: build cppref scraper
-      run: |
-           cd indexes/cppref
-           tsc
-    - name: build man7 scraper
-      run: |
-           cd indexes/man7
-           tsc
+      - name: checkout
+        uses: actions/checkout@v3
+      - name: dependencies
+        run: |
+          npm install -g typescript
+          npm i
+      - name: build bot
+        run: tsc
+      - name: build cppref scraper
+        run: |
+          cd indexes/cppref
+          tsc
+      - name: build man7 scraper
+        run: |
+          cd indexes/man7
+          tsc

.github/workflows/eslint.yml

@@ -8,9 +8,9 @@ jobs:
   run-eslint:
     runs-on: ubuntu-20.04
     steps:
-    - name: checkout
-      uses: actions/checkout@v3
-    - name: dependencies
-      run: npm i --dev
-    - name: lint
-      run: npm run lint
+      - name: checkout
+        uses: actions/checkout@v3
+      - name: dependencies
+        run: npm i --dev
+      - name: lint
+        run: npm run lint

.github/workflows/test.yml

@@ -8,9 +8,9 @@ jobs:
   run-tests:
     runs-on: ubuntu-20.04
     steps:
-    - name: checkout
-      uses: actions/checkout@v3
-    - name: dependencies
-      run: npm i --dev
-    - name: run test
-      run: npm test
+      - name: checkout
+        uses: actions/checkout@v3
+      - name: dependencies
+        run: npm i --dev
+      - name: run test
+        run: npm test

.husky/pre-commit

@@ -2,5 +2,5 @@
 . "$(dirname -- "$0")/_/husky.sh"
 
 #tsc --noEmit
-npx lint-staged
+npx lint-staged --verbose
 #npm test

.prettierignore

@@ -0,0 +1,6 @@
+indexes
+build
+.vscode
+.idea
+node_modules
+wiki_articles

.prettierrc.cjs

@@ -0,0 +1,16 @@
+module.exports = {
+    trailingComma: "all",
+    printWidth: 120,
+    singleQuote: false,
+    arrowParens: "avoid",
+    tabWidth: 4,
+    proseWrap: "always",
+    overrides: [
+        {
+            files: "*.{yml,md}",
+            options: {
+                tabWidth: 2,
+            },
+        },
+    ],
+};

README.md

@@ -25,11 +25,11 @@ Secrets and other bot info must be configured in the bot.json file. An example l
 
 ```json
 {
-    "id": "<bot id>",
-    "guild": "<guild id>",
-    "token": "<discord api token>",
-    "mongouser": "wheatley",
-    "mongopassword": "<mongo password>"
+  "id": "<bot id>",
+  "guild": "<guild id>",
+  "token": "<discord api token>",
+  "mongouser": "wheatley",
+  "mongopassword": "<mongo password>"
 }
 ```
 
@@ -38,8 +38,8 @@ can be specified to turn on only components which don't rely on channels etc. sp
 
 ## Database
 
-The bot uses MongoDB. It previously used a giant json file (the migration script is located in the scripts folder).
-For local development you likely won't need to setup a mongo database, depending on the components you're working on.
+The bot uses MongoDB. It previously used a giant json file (the migration script is located in the scripts folder). For
+local development you likely won't need to setup a mongo database, depending on the components you're working on.
 However, if you are contributing to components that do need the database here are the installation steps for ubuntu:
 
 https://www.mongodb.com/docs/manual/tutorial/install-mongodb-on-ubuntu/

lint-staged.config.mjs

@@ -0,0 +1,5 @@
+export default {
+    "*.ts": [() => "npm run ts-check", "npm run format-files --", "npm run lint-files --"],
+    "*.js": ["npm run format-files --", "npm run lint-files --"],
+    "*.{html,md}": ["npm run format-files --"],
+};