Code Quality Tools
This project uses several tools to maintain code quality and consistency.
Tools
ESLint
ESLint checks for code quality issues and potential bugs in JavaScript/TypeScript files.
Run linting:
npm run lint
Auto-fix issues:
npm run lint:fix
Prettier
Prettier formats code to maintain consistent style across the project.
Check formatting:
npm run format:check
Auto-format files:
npm run format
TypeScript
TypeScript provides static type checking for better code safety.
Run type checking:
npm run type-check
Run All Checks
To run all quality checks at once:
npm run quality
Pre-commit Hooks
This project uses Husky to run automatic checks before each commit. The pre-commit hook will:
- Run ESLint on staged files
- Format code with Prettier
- Prevent commits if there are linting errors
CI/CD Integration
The GitHub Actions workflow automatically runs:
- Linting checks
- Format checks
- Type checks
- Build verification
All checks must pass before deployment to GitHub Pages.
Configuration Files
.eslintrc.js- ESLint configuration.prettierrc.js- Prettier configuration.eslintignore- Files to ignore for linting.prettierignore- Files to ignore for formatting.husky/pre-commit- Pre-commit hook script
Customization
You can customize the rules in .eslintrc.js and formatting options in .prettierrc.js according to your preferences.