JSPM – code-quality-kit@1.0.6

Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (code-quality-kit) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

🔧 Code Quality Kit – IgniteX

This Code Quality Kit provides a plug-and-play setup to enforce consistent code quality across projects using:

✅ Prettier – Code formatting
✅ ESLint – Linting with Prettier integration
✅ Husky – Git hooks
✅ Lint-Staged – Only run formatters on staged files
✅ Commitlint – Enforce conventional commits
✅ GitHub Actions – CI for quality checks

📦 Installation

1. Install the Kit

npm install --save-dev code-quality-kit

🚀 Setup

Run the provided setup script:

node node_modules/code-quality-kit/scripts/setup.js

This will:

Create config files
Set up Husky pre-commit & commit-msg hooks
Add GitHub Actions CI workflow
Enable Prettier + ESLint + Commitlint

⚙️ Configuration

Customize features by adding a .codequalityrc.json file in your project root:

{
  "husky": true,
  "eslint": true,
  "prettier": true,
  "commitlint": true,
  "ci": true
}

You can turn off any part of the setup by setting its value to false.

🧪 Pre-commit Hook

The pre-commit hook runs:

✅ Prettier formatting (npx prettier --write .)
✅ ESLint autofix (npx eslint . --fix)
✅ Lint-staged for staged files only

🧪 Commit-msg Hook

Ensures commit messages follow Conventional Commits:

npx commitlint --edit $1

✅ GitHub Actions – Quality Check

Automatically runs formatting and linting checks on push and pull request:

.github/workflows/quality-check.yml

📁 Output Files

The following files will be created or updated:

.prettierrc.js
.eslintrc.js
commitlint.config.js
lint-staged.config.js
.husky/pre-commit
.husky/commit-msg
.github/workflows/quality-check.yml

👥 Author

Kasun Udara – kasunu2001@gmail.com IgniteX