style(code): setup commit convention

.github/workflows/node.js.yml

@@ -29,4 +29,5 @@ jobs:
           node-version: ${{ matrix.node-version }}
           cache: 'npm'
       - run: yarn install --frozen-lockfile
+      - run: yarn stylelint:actions
       - run: yarn build

.husky/commit-msg

@@ -0,0 +1 @@
+yarn commitlint --edit $1

.prettierignore

@@ -0,0 +1,4 @@
+yarn.lock
+.prettierignore
+.gitignore
+.husky

.stylelintrc.json

@@ -0,0 +1,15 @@
+{
+  "plugins": ["stylelint-plugin-defensive-css"],
+  "extends": [
+    "stylelint-config-standard-scss",
+    "stylelint-config-tailwindcss/scss"
+  ],
+  "rules": {
+    "plugin/use-defensive-css": [
+      true,
+      {
+        "severity": "warning"
+      }
+    ]
+  }
+}

README.md

@@ -1 +1,13 @@
 # Lynx Scanner
+
+## Project setup
+
+### NodeJS
+
+```shell
+yarn
+```
+
+### Git
+
+After a git pull, don't forget to do a yarn again

commitlint.config.ts

@@ -0,0 +1,23 @@
+export default {
+  extends: ['@commitlint/config-conventional'],
+  formatter: '@commitlint/format',
+  rules: {
+    'type-enum': [
+      2,
+      'always',
+      [
+        'build',
+        'chore',
+        'ci',
+        'docs',
+        'feat',
+        'fix',
+        'perf',
+        'refactor',
+        'revert',
+        'style',
+        'test',
+      ],
+    ],
+  },
+};

package.json

@@ -11,7 +11,8 @@
     "typedoc": "typedoc",
     "prepare": "husky",
     "eslint": "eslint --fix .",
-    "prettier": "prettier --write ."
+    "prettier": "prettier --write .",
+    "stylelint:actions": "stylelint --fix \"src/**/*.{css,scss}\""
   },
   "dependencies": {
     "autoprefixer": "^10.4.19",
@@ -22,6 +23,9 @@
     "tailwindcss": "^3.4.3"
   },
   "devDependencies": {
+    "@commitlint/cli": "^19.3.0",
+    "@commitlint/config-conventional": "^19.2.2",
+    "@commitlint/format": "^19.3.0",
     "@eslint/eslintrc": "^3.0.2",
     "@types/react": "^18.2.66",
     "@types/react-dom": "^18.2.22",
@@ -39,6 +43,11 @@
     "lint-staged": "^15.2.2",
     "prettier": "^3.2.5",
     "sass": "^1.75.0",
+    "stylelint": "^16.4.0",
+    "stylelint-actions-formatters": "^16.3.1",
+    "stylelint-config-standard-scss": "^13.1.0",
+    "stylelint-config-tailwindcss": "^0.0.7",
+    "stylelint-plugin-defensive-css": "^1.0.3",
     "typedoc": "^0.25.13",
     "typedoc-plugin-markdown": "^3.17.1",
     "typedoc-plugin-mdn-links": "^3.1.22",
@@ -47,9 +56,16 @@
     "vite-plugin-eslint": "^1.8.1"
   },
   "lint-staged": {
-    "*.{ts,tsx,cjs,svg,json}": [
+    "*.{css,scss}": [
+      "stylelint --fix",
+      "prettier --write"
+    ],
+    "*.{js,jsx,ts,tsx}": [
       "eslint --fix",
       "prettier --write"
+    ],
+    "!(*.{css,scss,js,jsx,ts,tsx})": [
+      "prettier --write"
     ]
   }
 }

postcss.config.js

@@ -3,4 +3,4 @@ export default {
     tailwindcss: {},
     autoprefixer: {},
   },
-}
+};

src/app.tsx

@@ -1,5 +1,4 @@
 import { JSX } from 'react';
-import './app.scss';
 import { BrowserRouter as Router, Routes, Route } from 'react-router-dom';
 import UserLogin from './components/UserLogin';
 import Homepage from './components/home-page';

src/index.scss

@@ -0,0 +1,3 @@
+@import 'tailwindcss/base';
+@import 'tailwindcss/components';
+@import 'tailwindcss/utilities';

tailwind.config.js

@@ -1,9 +1,8 @@
 /** @type {import('tailwindcss').Config} */
 export default {
-  content: ["./src/**/*.{tsx,scss}"],
+  content: ['./src/**/*.{tsx,scss}'],
   theme: {
     extend: {},
   },
   plugins: [],
-}
-
+};