-
Notifications
You must be signed in to change notification settings - Fork 27
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(tooling): Updating eslint and commitlint config. #435
Conversation
|
WalkthroughThe recent updates involve refining the project's coding standards and commit message guidelines. Specifically, adjustments were made to the ESLint configuration to better handle project-specific needs, such as including new plugins and adjusting rules for improved code quality. Additionally, the commit message configuration was enhanced to allow for more tailored guidelines while adhering to conventional commit standards. These changes aim to streamline development workflows and maintain high code quality. Changes
TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
✅ Deploy Preview for outlinejs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
New and removed dependencies detected. Learn more about Socket for GitHub ↗︎
🚮 Removed packages: npm/[email protected] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Review Status
Actionable comments generated: 1
Configuration used: CodeRabbit UI
Files ignored due to path filters (2)
package.json
is excluded by:!**/*.json
yarn.lock
is excluded by:!**/*.lock
Files selected for processing (3)
- .eslintignore (1 hunks)
- .eslintrc.json (1 hunks)
- commitlint.config.js (1 hunks)
Additional comments: 5
.eslintignore (1)
- 4-7: Added directories
.husky/
,.turbo/
, and.vscode/
to the ignore list. Ensure these directories do not contain any JavaScript files that should be linted. Ignoring.vscode/
might be unnecessary unless it contains project-specific scripts..eslintrc.json (3)
- 8-16: The addition of the
lit
plugin and thees2021
environment setting are positive changes for projects using modern JavaScript features and Lit for web components. Ensure all project contributors are aware of these updates to avoid linting errors due to unfamiliarity with the new rules.- 25-26: Replacing
lit-plugin/no-invalid-css
withlit/no-invalid-html
shifts the focus from CSS validation within Lit components to HTML validation. Verify that this change aligns with the project's priorities for component development and does not overlook the need for CSS validation.- 30-38: The updates to rule overrides for TypeScript and JavaScript files, such as disabling
@typescript-eslint/explicit-module-boundary-types
for.ts
files and@typescript-eslint/no-var-requires
for.js
files, should be carefully considered. These changes may impact the strictness of type checking and the use ofrequire
in modules. Ensure these overrides align with the project's coding standards and practices.commitlint.config.js (1)
- 1-27: Extending the default commitlint configuration with project-specific alterations is a sound strategy for maintaining consistency in commit messages while allowing for customization. Ensure that any project-specific rules added are well-documented and communicated to all contributors to facilitate adherence.
Summary by CodeRabbit