MI-72: Update template to match with recent changes

.editorconfig

@@ -8,11 +8,11 @@ indent_size = 4
 indent_style = space
 insert_final_newline = true
 trim_trailing_whitespace = true
+max_line_length = 100
 
 [{package.json,*.yml,*.md}]
 indent_size = 2
 indent_style = space
 
 [*.md]
-max_line_length = off
 trim_trailing_whitespace = false

.gitignore

@@ -31,7 +31,7 @@ node_modules
 # misc
 /.sass-cache
 /connect.lock
-/coverage
+**/coverage
 /libpeerconnection.log
 npm-debug.log
 yarn-error.log

.npmrc

@@ -1,2 +1,2 @@
-auto-install-peers = true
-engine-strict=true
+auto-install-peers=true
+engine-strict=true

.prettierignore

@@ -1,6 +1,6 @@
 # Add files here to ignore them from prettier formatting
-/dist
-/coverage
+**/dist
+**/coverage
 
 # nx format always picks this up and reformats
 # this file even if there's no issues, so we ignore it
@@ -10,4 +10,4 @@ tsconfig.base.json
 pnpm-lock.yaml
 package-lock.json
 
-/.nx/cache
+/.nx/cache

README.md

@@ -89,6 +89,43 @@ Below are some example of general Nx. commands. For more information, check out
 
 - This template is package manager agnostic. To use other package manager, install them by enabling [corepack](https://pnpm.io/installation#using-corepack).
 
+## Maintenance
+
+### Upgrading NPM packages
+
+The NPM packages in `devDependencies` in this repository has a complicated relationship with each other. Therefore, upgrading them should be handled with care.
+
+- All the `@nx` packages must be pinned at the same version with `nx` package to avoid conflict.
+
+  ```json
+    "@nx/devkit": "17.3.0",
+    "@nx/esbuild": "17.3.0",
+    "@nx/eslint": "17.3.0",
+    "@nx/eslint-plugin": "17.3.0",
+    "@nx/js": "17.3.0",
+    "@nx/plugin": "17.3.0",
+    "@nx/vite": "17.3.0",
+    "@nx/workspace": "17.3.0",
+    "nx": "17.3.0"
+  ```
+
+- All the packages that are in the same scope should be at the same version. For example:
+
+  ```json
+    "@typescript-eslint/eslint-plugin": "^6.13.2",
+    "@typescript-eslint/parser": "^6.13.2",
+  ```
+
+- `@nx/esbuild` lists `esbuild` as peerDependency. Double check the required version of `esbuild` in `package.json` of this [package](https://www.npmjs.com/package/@nx/esbuild/v/17.3.0?activeTab=code) before upgrading.
+- `eslint` is a peerDependency of the following packages. Double check the required version of `eslint` in `package.json` of these packages before upgrading.
+  - [@nx/eslint](https://www.npmjs.com/package/@nx/eslint/v/17.3.0?activeTab=code)
+  - [@typescript-eslint/eslint-plugin](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin/v/6.13.2?activeTab=code)
+  - [@typescript-eslint/parser](https://www.npmjs.com/package/@typescript-eslint/parser/v/6.13.2?activeTab=code)
+  - [eslint-config-prettier](https://www.npmjs.com/package/eslint-config-prettier/v/9.1.0?activeTab=code)
+  - [eslint-plugin-import](https://www.npmjs.com/package/eslint-plugin-import/v/2.29.1?activeTab=code)
+- `@nx/vite` lists `vite` and `vitest` as peerDependencies. Double check the required version of `vite` and `vitest` in `package.json` of this [package](https://www.npmjs.com/package/@nx/vite/v/17.3.0?activeTab=code) before upgrading.
+  - `vitest`, `@vitest/coverage-v8` and `@vitest/ui` should be at the same version.
+
 ## Under development
 
 - [-] Deployment pipeline -> nodeJS container + pnpm

nx.json

@@ -33,6 +33,7 @@
         },
         "test": {
             "inputs": ["default", "^production"],
+            "outputs": ["{projectRoot}/coverage"],
             "cache": true
         }
     },