chore: add git hooks to lint on commit

.stylelintrc

@@ -2,5 +2,8 @@
   "plugins": ["stylelint-prettier"],
   "rules": {
     "prettier/prettier": true
-  }
+  },
+  "ignoreFiles": [
+     "build/**/*.css"
+ ]
 }

Makefile

@@ -5,6 +5,13 @@ clean-docker:
 	docker ps --filter name=terraso_web_client* -aq | xargs docker stop
 	docker ps --filter name=terraso_web_client* -aq | xargs docker rm
 
+setup-git-hooks:
+	@cp scripts/git/pre-commit.sample .git/hooks/pre-commit
+	@cp scripts/git/commit-msg.sample .git/hooks/commit-msg
+	@echo "git hooks installed"
+
+pre-commit: lint
+
 run:
 	./scripts/docker/run.sh \
 		"--name terraso_web_client -p 3000:3000" \
@@ -21,34 +28,25 @@ build:
 		"npm run build"
 
 format:
-	./scripts/docker/run.sh \
-		"--name terraso_web_client_format" \
-		"npm run format-js && npm run format-css"
+		npm run format-js && npm run format-css
 
 lint:
-	./scripts/docker/run.sh \
-		"--name terraso_web_client_lint" \
-		"npm run lint-js && npm run lint-css"
+		npm run lint-js && npm run lint-css && npm run check-ts
 
 format-css:
-	./scripts/docker/run.sh \
-		"--name terraso_web_client_format" \
-		"npm run format-css"
+		npm run format-css
 
 format-js:
-	./scripts/docker/run.sh \
-		"--name terraso_web_client_format" \
-		"npm run format-js"
+		npm run format-js
 
 lint-js:
-	./scripts/docker/run.sh \
-		"--name terraso_web_client_lint" \
-		"npm run lint-js"
+		npm run lint-js
 
 lint-css:
-	./scripts/docker/run.sh \
-		"--name terraso_web_client_lint" \
-		"npm run lint-css"
+		npm run lint-css
+
+check-ts:
+		npm run check-ts
 
 test:
 	./scripts/docker/run.sh \

README.md

@@ -2,6 +2,18 @@
 
 Terraso web client is a React application that powers the frontend of the Terraso platform.
 
+## Contributing
+
+Before contributing to the project, it's recommended that you set up
+your local git running the following command:
+
+```sh
+$ make setup-git-hooks
+```
+
+This will activate two git hooks to automatically check JavaScript code
+style and commit message structure before each commit.
+
 ## Requirements
 
 - Docker: Version 24.0.2

scripts/git/commit-msg.sample

@@ -0,0 +1,35 @@
+#!/usr/bin/env python
+
+import re
+import sys
+
+CC_TYPES = r"build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test"
+CC_PATTERN = r"(" + CC_TYPES + r")(\([\w\-]+\))?:\s.*"
+
+
+def main():
+    commit_msg_file = sys.argv[1]
+
+    with open(commit_msg_file, "r") as commit_msg_content:
+        commit_msg = commit_msg_content.read()
+
+    match = re.match(CC_PATTERN, commit_msg)
+    if match:
+        return sys.exit(0)
+
+    print("")
+    print("The commit message doesn't follow www.conventionalcommits.org convention")
+    print("It should be structured as follows:")
+    print("<type>[optional scope]: <description>")
+    print("")
+    print("[optional body]")
+    print("")
+    print("[optional footer]")
+    print("")
+    print("Allowed types: " + CC_TYPES)
+
+    sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()

scripts/git/pre-commit.sample

@@ -0,0 +1,2 @@
+#!/bin/sh
+make pre-commit