@dsivd/prestations-ng 14.5.27 → 14.6.10-beta.6

package/CONTRIBUTING.md

@@ -2,7 +2,7 @@
 
 ## Prerequisite
 
--   Node 10.20+
+-   Node 16.15+
 -   yarn 1.22+
 -   Chrome or Chromium
 -   G++
@@ -62,7 +62,7 @@ of `prestations-ng`.
 
 ## Adding a schematic
 
-### Tips 
+### Tips
 
 -   Add logic into `utility` folder so you can reuse them in `ng-add` and `ng-update`.
 -   Create a proper schematic such as [update-karma-config](projects/prestations-ng/schematics/update-karma-config/index.ts) to be able to test it into a project when the library is linked.
@@ -74,6 +74,7 @@ run `yarn test:schematics` (at root level).
 ### Testing into a project such as **skeleton**
 
 -   **In prestations-ng**:
+
     -   if it is the first time, execute `yarn` then `yarn build:lib` (at root level)
     -   `cd dist/prestations-ng && yarn link` (it's critical to link the content of `dist/prestations-ng`, not the root)
     -   `yarn build:lib:dev` (at root level)
@@ -81,8 +82,8 @@ run `yarn test:schematics` (at root level).
 -   **In project**:
     -   `cd front`
     -   `yarn link @dsivd/prestations-ng`
-    -   `ng g @dsivd/prestations-ng:[YOUR_SCHEMATIC]` (i.e. `ng g @dsivd/prestations-ng:ng-add` or `ng g @dsivd/prestations-ng:update-karma-config`)
-    
+    -   `ng g @dsivd/prestations-ng:[YOUR_SCHEMATIC]` (i.e. `ng g @dsivd/prestations-ng:ng-add` or `ng g @dsivd/prestations-ng:update-karma-config` or `ng g @dsivd/prestations-ng:replace-browsers-list`)
+
 In your project, you can test any schematic added into [collection.json](projects/prestations-ng/schematics/collection.json).
 If you want to test `ng-update`, you will need to release the library under a beta version and then update your version of prestations-ng.
 
@@ -98,35 +99,51 @@ In case you're adding or modifying a `*.module.ts`, please update [MODULES.md](M
 -   Add a `title` for accessibility
 -   Import and export the new `*.component.ts` in [foehn-icons.module.ts](projects/prestations-ng/src/foehn-icons/foehn-icons.module.ts)
 
+## Notes about linting, formatting and pre-commit hooks
+
+This project uses a set of scripts to lint and format the code, along with pre-commit hooks.
+
+Important scripts are :
+
+-   `yarn lint` : run ESLint and Prettier on all files
+-   `yarn format`: run ESLint and Prettier on all files and fix errors automatically
+-   `yarn validate`: clean and run all tests
+
+**Husky** is used as a pre-commit hook to automatically output linting and formatting errors for staged files before committing.
+In the end, this utilitary calls `yarn lint-staged` which you can also call yourself of course. To have this pre-commit hook,
+run `yarn huskyInstall`. When you commit, Husky will run and show you potential errors. If you commit from Intellij, make sure you
+use the correct node version in the settings, otherwise it might fail. Same thing applies if you commit from terminal (run `which node`).
+
 ## Before committing
 
+-   **Make sure you have installed pre commit hook by running :** `yarn huskyInstall`
 -   Remove unnecessary `console.log`
 -   Update [CHANGELOG.md](CHANGELOG.md)
 -   Have it up to date with `yarn install`
--   Auto-format the code with `yarn format`
--   Validate the code with `yarn validate`
+-   If you want to autofix lint/format errors in your code : `yarn format`
+-   Run all tests `yarn validate`
 -   Ensure the commit message contains a Jira reference
 
-## Prettier
+> On commit, Husky will run ESLint and Prettier on all changed files. If you still want to run both on all files, please read the sections above.
 
-The project uses [Prettier](https://prettier.io/) to auto-format the code.
+## Prettier & ESLINT
+
+The project uses [Prettier](https://prettier.io/) to auto-format the code. To lint, this project use [ESLint](eslint.org) (see `angular.json`).
 
 You can auto-format the code on save with IntelliJ. More informations
 [on this guide](https://prettier.io/docs/en/webstorm.html).
 
-Please be careful, if the code isn't formatted as per Prettier standard, the build will fail.
-
-You can auto-format the code with `yarn format:prettier`
+Please make sure you have followed the **Before committing** section so you will see formating/linting errors before you commit.
 
 ## Publishing a new version of the package
 
 Please use the dedicated Jenkins build:
 
-[https://validation.portail.etat-de-vaud.ch/outils/jenkins-pee/job/AAC_Release_Prestakit](https://validation.portail.etat-de-vaud.ch/outils/jenkins-pee/job/AAC_Release_Prestakit/)
+[https://validation.portail.etat-de-vaud.ch/outils/jenkinsdgnsi/view/METIMT/job/AAC_Release_Prestakit/](https://validation.portail.etat-de-vaud.ch/outils/jenkinsdgnsi/view/METIMT/job/AAC_Release_Prestakit/)
 
 **Then**
 
--   Choose [Lancer un build avec des paramètres](https://validation.portail.etat-de-vaud.ch/outils/jenkins-pee/job/AAC_Release_Prestakit/build?delay=0sec) in the left menu
+-   Choose [Lancer un build avec des paramètres](https://validation.portail.etat-de-vaud.ch/outils/jenkinsdgnsi/view/METIMT/job/AAC_Release_Prestakit//build?delay=0sec) in the left menu
 -   Uncheck **RELEASE_BE** and check **RELEASE_NG** (if not already checked)
 -   Choose **origin/master** as **SOURCE_BRANCHE**
 -   Add version number in **TARGET_VERSION** (i.e.: 1.2.3) but before check in tags list if your version doesn't already exist
@@ -203,17 +220,21 @@ https://docs.cypress.io/guides/migrating-to-cypress/protractor#Introduction
 ### Running e2e in headless mode
 
 When launching Cypress in headless mode, execute:
+
 ```bash
 yarn e2e
 ```
-When a test fails, a screenshot will be added in `e2e/cypress/screenshots` folder.
+
+When a test fails, a screenshot will be added in `cypress/e2e/screenshots` folder.
 
 ### Running e2e using Cypress visual interface
 
 When launching Cypress visual interface for running tests files individually in `watch` mode, execute:
+
 ```bash
 yarn e2e:open
 ```
+
 To execute a test, just click on your integration test file listed in the newly open window.
 A new window will open showing your e2e test execution.
 To show back your test list window, just click on `Tests` button in the top left corner.