feat: Add comprehensive linting and formatting enforcement#47
Open
alepouna wants to merge 3 commits into
Open
Conversation
- 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
Member
Author
|
lets see how copilot reviews work lol |
There was a problem hiding this comment.
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.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #37
Description
Requires Admin:
To fully enforce these standards, we need to enable branch protection rules, without them, contributors can still merge PRs even when checks fail:
Voila
Discord Username
alepouna