Skip to content

SETUP.md

Latest commit

 

History

History
85 lines (54 loc) · 1.24 KB

SETUP.md

File metadata and controls

85 lines (54 loc) · 1.24 KB

Setup Instructions

Initial Setup

After cloning this repository, follow these steps:

1. Install Dependencies

npm install

This will install:

  • ESLint for JavaScript linting
  • Markdownlint for Markdown linting
  • Husky for Git hooks
  • Lint-staged for running linters on staged files

2. Verify Setup

Run the linters to make sure everything is working:

npm run lint

3. Test Pre-Commit Hook

The pre-commit hook should now be active. Try making a commit to verify it works.

Available Commands

Linting

# Run all linters
npm run lint

# Run JavaScript linter only
npm run lint:js

# Run Markdown linter only
npm run lint:md

# Auto-fix all issues
npm run lint:fix

# Auto-fix JavaScript issues
npm run lint:js:fix

# Auto-fix Markdown issues
npm run lint:md:fix

Troubleshooting

Hooks Not Running

If the pre-commit hook doesn't run automatically:

npm run prepare

Permission Issues (Unix/Mac)

If you get permission errors on Unix/Mac:

chmod +x .husky/pre-commit

Fresh Install

To completely reinstall:

rm -rf node_modules package-lock.json
npm install

More Information

See CONTRIBUTING.md for detailed contributing guidelines.