Skip to content

Commit 5534907

Browse files
Zapper9982Zapper9982
authored
feat(linting): adding Commitlint ,Commitzen, Husky config (#105)
1 parent 861643d commit 5534907

8 files changed

Lines changed: 3579 additions & 0 deletions

File tree

‎.github/workflows/commit-lint.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Commit Compliance
2+
3+
on:
4+
pull_request:
5+
types: [opened, synchronize, reopened]
6+
7+
jobs:
8+
commitlint:
9+
runs-on: ubuntu-latest
10+
11+
steps:
12+
- name: Checkout code with submodule
13+
uses: actions/checkout@v4
14+
with:
15+
ref: ${{ github.event.pull_request.head.ref }}
16+
repository: ${{ github.event.pull_request.head.repo.full_name }}
17+
submodules: true
18+
fetch-depth: 0
19+
20+
- name: Setup Node.js
21+
uses: actions/setup-node@v4
22+
with:
23+
node-version: 18
24+
25+
- name: Install dependencies
26+
run: |
27+
npm ci --legacy-peer-deps
28+
npm i --legacy-peer-deps
29+
30+
- name: Run commitlint on PR
31+
run: |
32+
npx commitlint --from ${{ github.event.pull_request.base.sha }} \
33+
--to ${{ github.event.pull_request.head.sha }} \
34+
--verbose

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,4 @@ target
77
.DS_Store
88
# Properties
99
src/main/environment/ecd_local.properties
10+
node_modules

‎.husky/commit-msg‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
npx --no -- commitlint --edit $1

‎.husky/pre-commit‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
npx lint-staged

‎README.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,49 @@ To build the ECD module from source, follow these steps:
4949

5050
- Open your browser and navigate to http://localhost:8080/swagger-ui.html#!/
5151

52+
## Setting Up Commit Hooks
53+
54+
This project uses Git hooks to enforce consistent code quality and commit message standards. Even though this is a Java project, the hooks are powered by Node.js. Follow these steps to set up the hooks locally:
55+
56+
### Prerequisites
57+
- Node.js (v14 or later)
58+
- npm (comes with Node.js)
59+
60+
### Setup Steps
61+
62+
1. **Install Node.js and npm**
63+
- Download and install from [nodejs.org](https://nodejs.org/)
64+
- Verify installation with:
65+
```
66+
node --version
67+
npm --version
68+
```
69+
2. **Install dependencies**
70+
- From the project root directory, run:
71+
```
72+
npm ci
73+
```
74+
- This will install all required dependencies including Husky and commitlint
75+
3. **Verify hooks installation**
76+
- The hooks should be automatically installed by Husky
77+
- You can verify by checking if the `.husky` directory contains executable hooks
78+
### Commit Message Convention
79+
This project follows a specific commit message format:
80+
- Format: `type(scope): subject`
81+
- Example: `feat(login): add remember me functionality`
82+
Types include:
83+
- `feat`: A new feature
84+
- `fix`: A bug fix
85+
- `docs`: Documentation changes
86+
- `style`: Code style changes (formatting, etc.)
87+
- `refactor`: Code changes that neither fix bugs nor add features
88+
- `perf`: Performance improvements
89+
- `test`: Adding or fixing tests
90+
- `build`: Changes to build process or tools
91+
- `ci`: Changes to CI configuration
92+
- `chore`: Other changes (e.g., maintenance tasks, dependencies)
93+
Your commit messages will be automatically validated when you commit, ensuring project consistency.
94+
5295
## Filing Issues
5396
5497
If you encounter any issues, bugs, or have feature requests, please file them in the [main AMRIT repository](https://github.com/PSMRI/AMRIT/issues). Centralizing all feedback helps us streamline improvements and address concerns efficiently.

‎commitlint.config.js‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
module.exports = {
2+
extends: ['@commitlint/config-conventional'],
3+
rules: {
4+
'body-leading-blank': [1, 'always'],
5+
'body-max-line-length': [2, 'always', 100],
6+
'footer-leading-blank': [1, 'always'],
7+
'footer-max-line-length': [2, 'always', 100],
8+
'header-max-length': [2, 'always', 100],
9+
'subject-case': [
10+
2,
11+
'never',
12+
['sentence-case', 'start-case', 'pascal-case', 'upper-case'],
13+
],
14+
'subject-empty': [2, 'never'],
15+
'subject-full-stop': [2, 'never', '.'],
16+
'type-case': [2, 'always', 'lower-case'],
17+
'type-empty': [2, 'never'],
18+
'type-enum': [
19+
2,
20+
'always',
21+
[
22+
'build',
23+
'chore',
24+
'ci',
25+
'docs',
26+
'feat',
27+
'fix',
28+
'perf',
29+
'refactor',
30+
'revert',
31+
'style',
32+
'test',
33+
],
34+
],
35+
}
36+
};

0 commit comments

Comments
 (0)