Merge pull request #35 from chocolat-chaud-io/23-linting-hooks

feat: added linting on pre-commit

README.md

@@ -259,6 +259,8 @@ To facilitate and optimize the usage of the monorepo, we make use of [NX](https:
 
 [eslint](https://github.com/eslint/eslint) enforces excellent standards, and [prettier](https://github.com/prettier/prettier) helps you apply them.
 
+Commit messages must abide to those [guidelines](https://www.conventionalcommits.org/en/v1.0.0/). If you need help following them, simply run `npm run commit` and you will be prompted with an interactive menu.
+
 File and directory names are enforced by the custom made `enforce-file-folder-naming-convention.js`.
 
 Branch names are enforced before you even commit to ensure everyone adopts the same standard: `{issue-number}-{branch-work-title-kebab-case}`.

package.json

@@ -34,7 +34,8 @@
     "mongo": "run-script-os",
     "mongo:win32": "docker-compose -f ./apps/database/mongo/docker-compose.yml up",
     "mongo:default": "sudo docker-compose -f ./apps/database/mongo/docker-compose.yml up",
-    "rename-project": "node ./tools/rename-project.js --project-name"
+    "rename-project": "node ./tools/rename-project.js --project-name",
+    "commit": "cz"
   },
   "private": true,
   "dependencies": {
@@ -59,7 +60,6 @@
     "clsx": "^1.1.1",
     "document-register-element": "1.13.1",
     "fastify-swagger": "^3.4.0",
-    "import-sort-style-module": "^6.0.0",
     "mongodb": "^3.6.2",
     "nx": "^10.3.0",
     "pg": "^8.4.1",
@@ -117,6 +117,7 @@
     "eslint-plugin-react": "^7.21.2",
     "eslint-plugin-react-hooks": "^4.0.0",
     "husky": "^4.3.0",
+    "import-sort-style-module": "^6.0.0",
     "jest": "26.2.2",
     "prettier": "^2.1.2",
     "prettier-plugin-import-sort": "0.0.6",
@@ -130,7 +131,7 @@
   "husky": {
     "hooks": {
       "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
-      "pre-commit": "branch-naming-check '^\\d+(-[a-z]+)+$'"
+      "pre-commit": "branch-naming-check '^\\d+(-[a-z]+)+$' && npm run lint:file-folder-convention"
     }
   },
   "config": {

tools/enforce-file-folder-naming-convention.js

@@ -15,7 +15,7 @@ async function* walk(dir, ignoredPaths) {
 }
 
 async function main() {
-  const ignoredFolders = ["node_modules", "dist", ".git", ".idea", ".gitkeep", ".eslintrc", "README", "LICENSE"]
+  const ignoredFolders = ["node_modules", "dist", ".git", ".idea", ".gitkeep", ".eslintrc", ".cache", "README", "LICENSE"]
   const capitalLetterRegex = /[A-Z]/gm
   const errorPathPaths = []
 
@@ -37,10 +37,10 @@ async function main() {
   if (errorPathPaths.length > 0) {
     const errorMessage = `${errorPathPaths.length} files/directories do not respect the kebab-case convention enforced.`
 
-    console.log(errorMessage)
+    console.error(errorMessage)
     console.error(errorPathPaths)
 
-    throw Error(errorMessage)
+    process.exit(1)
   }
 
   console.log("Congratulations, all your files and directories are properly named!")