Skip to content

feat: Add comprehensive linting and formatting enforcement#47

Open
alepouna wants to merge 3 commits into
masterfrom
feature/linting-enforcement-clean
Open

feat: Add comprehensive linting and formatting enforcement#47
alepouna wants to merge 3 commits into
masterfrom
feature/linting-enforcement-clean

Conversation

@alepouna
Copy link
Copy Markdown
Member

Closes #37

Description

  • Add ESLint with Prettier integration (eslint-config-prettier)
  • Add Prettier for code formatting enforcement
  • Add markdownlint for documentation quality
  • Add pre-commit hooks via husky and lint-staged
  • Update CONTRIBUTING.md with code quality standards and available commands
  • Add IDE configurations for VS Code and Zed editors
  • Add npm scripts: lint, lint:fix, format, format:check, markdown:lint, markdown:fix, check:all

Requires Admin:

  • Add GitHub Actions workflow for CI/CD enforcement (3 jobs: ESLint, Prettier, Markdown)

To fully enforce these standards, we need to enable branch protection rules, without them, contributors can still merge PRs even when checks fail:

  1. Go to Settings > Branches > Add branch protection rule
  2. Branch name pattern: "master"
  3. Enable "Require status checks to pass before merging"
  4. Enable "Require branches to be up to date before merging"
  5. Select required status checks:
    • ESLint
    • Prettier Format Check
    • Markdown Lint
  6. Save changes
    Voila

Discord Username

alepouna

- Add ESLint with Prettier integration (eslint-config-prettier)
- Add Prettier for code formatting enforcement
- Add markdownlint for documentation quality
- Add pre-commit hooks via husky and lint-staged
- Add GitHub Actions workflow for CI/CD enforcement (3 jobs: ESLint, Prettier, Markdown)
- Update CONTRIBUTING.md with code quality standards and available commands
- Add IDE configurations for VS Code and Zed editors
- Add npm scripts: lint, lint:fix, format, format:check, markdown:lint, markdown:fix, check:all

Closes #37
@alepouna alepouna requested a review from Copilot January 28, 2026 00:24
@alepouna
Copy link
Copy Markdown
Member Author

lets see how copilot reviews work lol

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request adds comprehensive linting and formatting enforcement to improve code quality and maintainability. It introduces ESLint with Prettier integration, Prettier for code formatting, markdownlint for documentation quality, and pre-commit hooks via husky and lint-staged.

Changes:

  • Added development dependencies: eslint-config-prettier, husky, lint-staged, markdownlint-cli, and prettier
  • Configured automated code quality checks with pre-commit hooks and npm scripts
  • Added GitHub Actions workflow for CI/CD enforcement with three separate jobs
  • Updated CONTRIBUTING.md with detailed code quality standards and available commands
  • Added IDE configurations for VS Code and Zed editors

Reviewed changes

Copilot reviewed 9 out of 10 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
package.json Added 8 new npm scripts for linting/formatting, 5 new devDependencies, and lint-staged configuration
package-lock.json Added dependency lockfile entries for all new packages and their transitive dependencies
.eslintrc.json Extended with prettier config, added parserOptions, and ignorePatterns
.prettierignore New file to exclude directories/files from Prettier formatting
.markdownlintrc.json New markdown linting configuration with some rules disabled for flexibility
.vscode/settings.json New VS Code settings to configure ESLint and Prettier integration
.zed/settings.json New Zed editor settings for consistent development experience
.husky/pre-commit New pre-commit hook that runs lint-staged checks
.github/workflows/lint.yml New CI workflow with three jobs: ESLint, Prettier Format Check, and Markdown Lint
.github/CONTRIBUTING.md Updated with code quality standards, pre-commit workflow, and available scripts documentation

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread package.json Outdated
Comment thread package.json Outdated
alepouna and others added 2 commits January 28, 2026 03:30
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@alepouna
Copy link
Copy Markdown
Member Author

If this PR is merged I will make a new PR to fix the linting errors to also test the system works a-ok.

@alepouna alepouna self-assigned this Jan 29, 2026
@alepouna alepouna added the enhancement New feature or request label Jan 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Linting, styling

2 participants