Merge pull request #57 from joematthews/misc-changes-and-updates

Misc changes and updates

Author: joematthews

.prettierrc.json

@@ -1,8 +1,8 @@
 {
   "htmlWhitespaceSensitivity": "ignore",
   "plugins": [
-    "prettier-plugin-sh",
     "prettier-plugin-css-order",
-    "prettier-plugin-organize-imports"
+    "prettier-plugin-organize-imports",
+    "prettier-plugin-sh"
   ]
 }

README.md

@@ -4,9 +4,13 @@
 
 Extreme Angular is pre-configured with a strict and opinionated set of development tools that enforce best practices, ensure consistent code quality, and promote accessibility while remaining fully compatible with the [official Angular documentation](https://angular.dev/overview).
 
-However, Extreme Angular is not a fully-featured dashboard or a component library. It contains no custom application logic, components, or complex modifications. Instead, it offers a clean, strict base for your Angular project.
+However, Extreme Angular is not a fully-featured dashboard or a component library. It contains no custom application logic, components, or complex modifications. Instead, it offers a clean, strict base for your Angular project. The underlining Angular project was generated with:
 
-For additional utility like Angular Material, server-side rendering (SSR), internationalization (i18n), or End to End Testing (e2e) check out the [Optional Angular Schematics](#optional-angular-schematics) section.
+```
+ng new --strict --style=scss --ssr=false
+```
+
+For additional utility like Angular Material, Server-side & hybrid rendering (SSR, SSG, Hydration), Internationalization (i18n), or End to End testing (e2e) check out the [Optional Angular Schematics](#optional-angular-schematics) section.
 
 ## Contributions, Issues, & Suggestions
 
@@ -33,7 +37,7 @@ Thank you for your contributions!
   - [Continuous Integration (CI) Using GitHub Actions](#continuous-integration-ci-using-github-actions)
 - [Optional Angular Schematics](#optional-angular-schematics)
   - [Angular Material & Angular CDK](#angular-material--angular-cdk)
-  - [Server-side & hybrid rendering (SSR)](#server-side--hybrid-rendering-ssr)
+  - [Server-side & hybrid rendering (SSR, SSG, Hydration)](#server-side--hybrid-rendering-ssr-ssg-hydration)
   - [Internationalization (i18n)](#internationalization-i18n)
   - [End to End Testing (e2e)](#end-to-end-testing-e2e)
 - [Tips & Tricks](#tips--tricks)
@@ -141,13 +145,13 @@ To ensure effective linting for all project files, the following ESLint plugins
 - [@typescript-eslint](https://typescript-eslint.io/)
   - Uses both [strict-type-checked](https://typescript-eslint.io/linting/configs#strict-type-checked) and [stylistic-type-checked](https://typescript-eslint.io/linting/configs#stylistic-type-checked) rule sets.
   - [typescript-eslint rules configuration matrix](https://typescript-eslint.io/rules/).
-- [eslint-plugin-jasmine](https://www.npmjs.com/package/eslint-plugin-jasmine)
+- [eslint-plugin-jasmine](https://github.com/tlvince/eslint-plugin-jasmine)
   - Uses `recommended` rule set.
   - [eslint-plugin-jasmine rules configuration matrix](https://typescript-eslint.io/rules/).
-- [eslint-plugin-jsonc](https://www.npmjs.com/package/eslint-plugin-jsonc)
+- [eslint-plugin-jsonc](https://github.com/ota-meshi/eslint-plugin-jsonc)
   - Uses `recommended` rule set.
   - [eslint-plugin-jsonc rules configuration matrix](https://ota-meshi.github.io/eslint-plugin-jsonc/rules/).
-- [eslint-config-prettier](https://www.npmjs.com/package/eslint-config-prettier)
+- [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier)
   - Disables rules that may conflict with Prettier formatting.
 
 To lint all relevant files in the project (not just those in src/):
@@ -156,6 +160,12 @@ To lint all relevant files in the project (not just those in src/):
 npm run lint
 ```
 
+ESLint output is formatted using [eslint-formatter-mo](https://github.com/fengzilong/eslint-formatter-mo). To use normal formatting, remove the `-f mo` option from the `lint` script in [package.json](package.json):
+
+```json
+"lint": "eslint -f mo \"**/*.{js,ts,html,json}\"",
+```
+
 > [!TIP]
 > Suppress the urge to immediately set rules to "off" or "warn". First, look up the rule and the problem it is correcting for and discuss the rule with other developers on the project.
 
@@ -189,8 +199,8 @@ In [.prettierrc.json](./.prettierrc.json), the `htmlWhitespaceSensitivity` optio
 
 The following Prettier plugins are used:
 
-- [prettier-plugin-sh](https://www.npmjs.com/package/prettier-plugin-sh): Formats shell scripts, such as Git hooks.
-- [prettier-plugin-css-order](https://www.npmjs.com/package/prettier-plugin-css-order): Automatically organizes SCSS/CSS properties using [concentric-css](https://github.com/brandon-rhodes/Concentric-CSS)
+- [prettier-plugin-sh](https://github.com/un-ts/prettier/tree/master/packages/sh): Formats shell scripts, such as Git hooks.
+- [prettier-plugin-css-order](https://github.com/Siilwyn/prettier-plugin-css-order): Automatically organizes SCSS/CSS properties using [concentric-css](https://github.com/brandon-rhodes/Concentric-CSS)
 - [prettier-plugin-organize-imports](https://github.com/trivago/prettier-plugin-sort-imports): Automatically organizes, arranges, and removes unused imports.
 
 To format files within the project:
@@ -245,9 +255,9 @@ The following VSCode settings have been set in [.vscode/settings.json](.vscode/s
 
 [Husky](https://typicode.github.io/husky/) is used to manage the [pre-commit](.husky/pre-commit), [pre-push](.husky/pre-push), and [commit-msg](.husky/commit-msg) git hooks.
 
-[Commitlint](https://commitlint.js.org/#/) is used to enforce good commit messages according to the [@commitlint/config-conventional](https://www.npmjs.com/package/@commitlint/config-conventional) configuration in the commit-msg git hook. Additional Commitlint configuration is kept in [commitlint.config.js](./commitlint.config.js).
+[Commitlint](https://commitlint.js.org/#/) is used to enforce good commit messages according to the [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint) configuration in the commit-msg git hook. Additional Commitlint configuration is kept in [commitlint.config.js](./commitlint.config.js).
 
-[Lint-staged](https://www.npmjs.com/package/lint-staged) is used to run Prettier, ESLint, Stylelint, CSpell, and [tsc-files](https://www.npmjs.com/package/tsc-files) in the pre-commit git hook against all staged files. Lint-staged configuration is kept in [.lintstagedrc.json](.lintstagedrc.json)
+[Lint-staged](https://github.com/lint-staged/lint-staged) is used to run Prettier, ESLint, Stylelint, CSpell, and [tsc-files](https://github.com/gustavopch/tsc-files) in the pre-commit git hook against all staged files. Lint-staged configuration is kept in [.lintstagedrc.json](.lintstagedrc.json)
 
 ### Shove Progress
 
@@ -293,7 +303,7 @@ ng add @angular/cdk
 
 To add animations to your own components, check out [Introduction to Angular animations](https://angular.dev/guide/animations)
 
-### Server-side & hybrid rendering (SSR)
+### Server-side & hybrid rendering (SSR, SSG, Hydration)
 
 Consider enabling [Server-side & hybrid rendering](https://angular.dev/guide/performance) to improve SEO and user experience (at the cost of increased deployment complexity).
 
@@ -305,10 +315,8 @@ If you plan to implement internationalization in the future, adding i18n attribu
 
 To enable the i18n ESLint rule, simply remove or configure the following rule from the \*.html section of [eslint.config.js](./eslint.config.js):
 
-```json
-rules: {
-  "@angular-eslint/template/i18n": "off",
-},
+```js
+"@angular-eslint/template/i18n": "off",
 ```
 
 > [!NOTE]