BREAKING CHANGE: use new dev env (#42)

* configure submodule

* configure submodule

* Simplify the pipeline

* configure

* add scripts

* ignore md files

* format

* fix type errors

* ignore scripts

* fix inline type imports

* fix: types

* fix: add general models

* push build files

* fix: update types

* push build files

* add various fixes

* push build files

* fix: check extra fields

* push build files

* fix: remove school teacher invitation

* delete lib files

* delete lib folder

* clean up, formatting, type helpers

* fixed formatting

* fix: linting errors

* fix: makeStore helper

* fix: test helpers

* fix: test

* include dependency types

* use correct env var

* rename helpers to utils

* imports: rename helpers to utils

* add node types as dependency

* fix: type deps

* fix: reusable deps

* fix: include git ignore

---------

Co-authored-by: cfl-bot <[email protected]>

Author: SKairinos

.devcontainer.json

@@ -8,7 +8,12 @@
         "davidanson.vscode-markdownlint",
         "bierner.markdown-mermaid",
         "streetsidesoftware.code-spell-checker",
-        "dbaeumer.vscode-eslint"
+        "dbaeumer.vscode-eslint",
+        "tamasfe.even-better-toml",
+        "github.vscode-github-actions",
+        "codecov.codecov",
+        "ritwickdey.liveserver",
+        "esbenp.prettier-vscode"
       ]
     }
   },

.eslintrc.json

@@ -1,36 +1,61 @@
 {
-  "env": {
-    "browser": true,
-    "es2021": true
-  },
   "extends": [
-    "plugin:react/recommended",
-    "standard-with-typescript"
+    "eslint:recommended",
+    "react-app",
+    "plugin:react/jsx-runtime",
+    "prettier"
   ],
-  "overrides": [],
+  "parser": "@typescript-eslint/parser",
   "parserOptions": {
-    "ecmaVersion": "latest",
-    "sourceType": "module",
-    "project": "tsconfig.json"
+    "project": true,
+    "tsconfigRootDir": "./"
   },
   "plugins": [
-    "react"
+    "@typescript-eslint"
   ],
+  "root": true,
   "ignorePatterns": [
-    "lib",
+    "dist",
     "src/scripts"
   ],
   "rules": {
-    "@typescript-eslint/semi": [
+    "@typescript-eslint/consistent-type-imports": [
       2,
-      "always"
+      {
+        "fixStyle": "inline-type-imports"
+      }
     ],
-    "@typescript-eslint/member-delimiter-style": "off",
-    "@typescript-eslint/space-before-function-paren": "off",
-    "@typescript-eslint/no-invalid-void-type": "off",
-    "@typescript-eslint/consistent-type-imports": "off",
-    "@typescript-eslint/strict-boolean-expressions": "off",
-    "@typescript-eslint/dot-notation": "off",
-    "@typescript-eslint/indent": "off"
-  }
+    "@typescript-eslint/no-restricted-imports": [
+      2,
+      {
+        "paths": [
+          {
+            "name": "react-redux",
+            "importNames": [
+              "useSelector",
+              "useStore",
+              "useDispatch"
+            ],
+            "message": "Please use pre-typed versions from `src/app/hooks.ts` instead."
+          }
+        ]
+      }
+    ]
+  },
+  "overrides": [
+    {
+      "files": [
+        "*.{c,m,}{t,j}s",
+        "*.{t,j}sx"
+      ]
+    },
+    {
+      "files": [
+        "*{test,spec}.{t,j}s?(x)"
+      ],
+      "env": {
+        "jest": true
+      }
+    }
+  ]
 }

.github/workflows/main.yml

@@ -1,97 +1,50 @@
-# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
-# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
-
 name: Main
 
 on:
   push:
     paths-ignore:
-      - "lib/**" # TODO: remove lib folder
-      - "**/*.md"
-      - "**/.*"
+      - '**/*.md'
+      - '**/*.code-*'
+      - '.vscode/**'
+      - '.devcontainer.json'
   workflow_dispatch:
 
 jobs:
   test:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node: [19.7]
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Set up Node ${{ matrix.node }}
-        uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.node }}
-
-      # TODO: cache node packages
-      - name: Install Node Packages
-        run: npm install
-
-      - name: Check Code Format
-        run: npm run lint
-
-      # TODO: https://www.pluralsight.com/guides/how-to-test-react-components-in-typescript
-      # - name: Test Code
-      #   run: npm run test -- --watchAll=false
-
-  # TODO: remove this job
-  build:
-    needs: [test]
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          token: ${{ secrets.CFL_BOT_GITHUB_TOKEN }}
-
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 19.7
-
-      - name: Setup Git
-        run: |
-          git config --local user.name cfl-bot
-          git config --local user.email [email protected]
-
-      # TODO: cache node packages
-      - name: Install Node Packages
-        run: npm install --only=dev
-
-      - name: Build Package
-        run: npm run build
-
-      - name: Push Build Files
-        run: |
-          git add lib/*
-          if ! git diff --staged --quiet; then
-            git commit -m "push build files"
-            git push
-          fi
+    uses: ocadotechnology/codeforlife-workspace/.github/workflows/test-javascript-code.yaml@main
+    secrets: inherit
+    with:
+      # Cannot be set with an env var. Value must match in the release job.
+      node-version: 18
 
   release:
-    needs: [build]
     concurrency: release
     runs-on: ubuntu-latest
+    needs: [test]
     if: github.ref_name == 'main'
+    env:
+      # Value must match in the test job.
+      NODE_VERSION: 18
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           token: ${{ secrets.CFL_BOT_GITHUB_TOKEN }}
           fetch-depth: 0
 
-      - name: Pull Build Files
-        run: git pull
-
-      - uses: actions/setup-node@v3
+      - name: 🌐 Set up Node ${{ env.NODE_VERSION }}
+        uses: actions/setup-node@v4
         with:
-          node-version: 19.7
+          node-version: ${{ env.NODE_VERSION }}
 
-      # TODO: group release dependencies
-      - name: Install Node Packages
-        run: npm install --only=dev
+      - name: 🛠 Install Dependencies
+        run: |
+          npm install --global npm
+          npm install --global \
+            semantic-release@^20.1.1 \
+            @semantic-release/git@^10.0.1 \
+            @semantic-release/changelog@^6.0.2
 
-      - name: Publish Semantic Release
+      - name: 🚀 Publish Semantic Release
         env:
           GH_TOKEN: ${{ secrets.CFL_BOT_GITHUB_TOKEN }}
           GIT_AUTHOR_NAME: cfl-bot

.prettierignore

@@ -0,0 +1,5 @@
+**/*.json
+**/*.yaml
+**/*.yml
+**/*.code-*
+**/*.md

.prettierrc.json

@@ -0,0 +1,4 @@
+{
+  "semi": false,
+  "arrowParens": "avoid"
+}

.vscode/settings.json

@@ -12,10 +12,15 @@
   "editor.codeActionsOnSave": {
     "source.organizeImports": "explicit"
   },
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
   "editor.formatOnSave": true,
   "editor.rulers": [
     80
   ],
   "editor.tabSize": 2,
-  "typescript.preferences.quoteStyle": "single"
+  "javascript.format.semicolons": "remove",
+  "javascript.preferences.quoteStyle": "double",
+  "prettier.configPath": ".prettierrc.json",
+  "typescript.format.semicolons": "remove",
+  "typescript.preferences.quoteStyle": "double"
 }

codecov.yml

@@ -0,0 +1,11 @@
+coverage: # https://docs.codecov.com/docs/codecov-yaml
+  precision: 2
+  round: down
+  range: 90...90
+  status: # https://docs.codecov.com/docs/commit-status
+    project:
+      default:
+        target: 90%
+        threshold: 0%
+
+comment: false