chore(hooks): added commit related hooks (#2)

* chore(hooks): added commit related hooks
* chore(readme): updated readme file with rules
* fix: run affected against origin/main
* fix: updated package-lock.json

Author: TapaiBalazs

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no-install commitlint --verbose --edit "$1"

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run pre-commit

README.md

@@ -1,5 +1,3 @@
-
-
 # ThisDot
 
 This project was generated using [Nx](https://nx.dev).
@@ -8,6 +6,26 @@ This project was generated using [Nx](https://nx.dev).
 
 🔎 **Powerful, Extensible Dev Tools**
 
+## Coding Standards
+
+Consistency is important on an application such as this, where many developers will work on this product over long periods of time. Therefore, we expect all developers to adhere to a common set of coding practices and expectations. This section should be updated as the team decides on new standards.
+
+- **Formatting** - We don't want to waste time debating tabs vs spaces. All code should be formatted using Prettier set to use the settings in the `.prettierc` file. There is a Git hook (using Husky and precise-commits) that will automatically format changed code prior to commit.
+- **Style Guides** - We're following the standard [Angular Style Guide](https://angular.io/guide/styleguide). Any deviation from the style guide is an error unless an exception is written in this set of coding standards.
+- **State Management** - We should use NgRx in place of "Subject-Wrapping Services". That said, local state management is not only OK, it's preferred. State should only be raised into the store when it delivers architectural value to do so. We follow the NgRx core team guidelines of event-based actions and [good action hygiene](https://www.youtube.com/watch?v=JmnsEvoy-gY)
+- **Testing** - All code is expected to be thoroughly tested. Code reviews should verify that each pull request contains an adequate number and variety of test cases. We try to follow the principles of the [testing trophy](https://kentcdodds.com/blog/write-tests/). The test suites should be filled with mostly integration tests written in ways that they contain minimal mocking and only testing in ways the user would interact with the UI. Unit tests should be used where appropriate, especially to test utilities, services, and the NgRx implementation. Finally, E2E tests should be used as appropriate to ensure that core user flows through the application are functioning.
+- **Developer Testing** - Developers are responsible for thoroughly testing their code prior to putting it up for review. It is NOT the responsibility of the code reviewer to execute the code and test it (though the reviewer might run the code to aid their review if they want).
+- **Naming Convention** - All commits and pull request names should follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specifications as it is a widely acceptable way within Angular ecosystem (e.g. `<type>(<scope>): <description>`).
+- **Minimal Pull Requests** - Do not commit changes to files where there was not a new feature added or an existing feature altered. Files altered only to remove unusued imports or change formatting should not be included in pull requests. Code authors are expected to review the files in each pull request and revert files that were only incidentally changed.
+- **Code Comments** - We're not following a strict code commenting pattern (like js-doc), but developer are encouraged to use comments liberally where it may aid understandability and readability of the code (esepecially for new team members). Comments that merely explain what a line of code does are not necessary. Instead, comments should indicate the intent of th author. It could mention assumptions, constraints, intent, algorithm design, etc.
+- **Commit/Pull Request Comments** - Code authors are strongly recommended to communicate the reason for the code changes, the nature of the changes, and the intent of the changes in their Git commit messages (this information should also make it into PR descriptions as well). Additionally, while not strictly required, we recommend that code authors make comments in their pull requests where useful to help code reviewers understand the background/intent for some of the less obvious changes.
+
+### Commit message convention
+
+This project uses [commitlint](https://github.com/conventional-changelog/commitlint) and [husky v6](https://github.com/typicode/husky/tree/master#install) to lint your commit messages. The project uses the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) guideline. See [@commitlint/config-conventional](https://www.npmjs.com/package/@commitlint/config-conventional) for further information on how to format your commits.
+
+---
+
 ## Quick Start & Documentation
 
 [Nx Documentation](https://nx.dev/angular)
@@ -87,11 +105,6 @@ Run `nx dep-graph` to see a diagram of the dependencies of your projects.
 
 Visit the [Nx Documentation](https://nx.dev/angular) to learn more.
 
-
-
-
-
-
 ## ☁ Nx Cloud
 
 ### Computation Memoization in the Cloud

commitlint.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+};

lint-staged.config.js

@@ -0,0 +1,41 @@
+const path = require('path');
+
+module.exports = {
+  '*.{json,md,css,scss}': (files) => {
+    if (
+      files.length > 0 &&
+      files[0] !== '[filename]' &&
+      files[0] !== '[file]'
+    ) {
+      const cwd = process.cwd();
+      const relativePaths = files.map((f) => path.relative(cwd, f));
+      /**
+       * We don't need to run the linter for these files.
+       */
+      return [`nx format:write --files="${relativePaths.join(',')}"`];
+    } else {
+      return [];
+    }
+  },
+  '*.{html,js,ts}': (files) => {
+    if (
+      files.length > 0 &&
+      files[0] !== '[filename]' &&
+      files[0] !== '[file]'
+    ) {
+      const cwd = process.cwd();
+      const relativePaths = files.map((f) => path.relative(cwd, f));
+      /**
+       * This reduces the memory consumption of the script, so it won't fail on particular machines.
+       */
+      return [
+        `nx format:write --files="${relativePaths.join(',')}"`, //
+        `nx affected:lint --files="${relativePaths.join(
+          ','
+        )}" --fix --parallel`, //
+      ];
+    } else {
+      return [];
+    }
+  },
+};

nx.json

@@ -7,19 +7,14 @@
     ".eslintrc.json": "*"
   },
   "affected": {
-    "defaultBase": "master"
+    "defaultBase": "origin/main"
   },
   "npmScope": "this-dot",
   "tasksRunnerOptions": {
     "default": {
       "runner": "@nrwl/nx-cloud",
       "options": {
-        "cacheableOperations": [
-          "build",
-          "lint",
-          "test",
-          "e2e"
-        ],
+        "cacheableOperations": ["build", "lint", "test", "e2e"],
         "accessToken": "M2M0MGQzYzktZjdlYy00NjU5LWE4MzQtZWFlNDgwM2JlNTFhfHJlYWQtd3JpdGU=",
         "canTrackAnalytics": false,
         "showUsageWarnings": true
@@ -32,9 +27,7 @@
     },
     "showcase-e2e": {
       "tags": [],
-      "implicitDependencies": [
-        "showcase"
-      ]
+      "implicitDependencies": ["showcase"]
     }
   }
-}
+}