Skip to content
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

263: Update custom eslint base config #265

Merged
merged 1 commit into from
May 25, 2024

Conversation

JensAstrup
Copy link
Owner

No description provided.

Copy link

The changes introduced in the diff involve updates and modifications across multiple files related to ESLint configuration, GitHub workflows, and package dependency updates. Below is a review of these changes, highlighting key points based on the criteria provided:

.eslintrc.cjs Modifications:

  • Added the project property to the parserOptions with the value "./tsconfig.json". This inclusion is a best practice when working with TypeScript projects as it allows ESLint to understand the TypeScript configuration and enforce rules more accurately based on the project setup. This is a positive change that enhances the linter's capability to assess TypeScript files more effectively.

.github/workflows/lint.yml Modifications:

  • Changed the linter execution command from npm run lint to a more specialized GitHub Action, tj-actions/eslint-changed-files@v25. This action focuses on running ESLint only on changed files rather than the entire project on every run. This approach can significantly improve the efficiency of the CI process by reducing run times for projects with a large codebase. It is a notably good practice for optimizing CI workflows, especially for projects expecting frequent updates.

package.json Modifications:

  • The change in the lint and lint:fix scripts from including the tests directory to only focusing on the src directory could be project-specific. It's essential to ensure that this change aligns with the project's testing strategy. Excluding the tests directory might be intentional (e.g., if tests are linted differently), but it's worth confirming to ensure that code quality checks are consistently applied across the project.
  • The update of the eslint-config-yenz package from version 2.0.1 to 5.1.0 introduces a significant version jump. This change likely brings several new rules and configuration improvements. It's crucial to review these changes to ensure they align with the project's coding standards and to make any necessary adjustments to the codebase or configuration to adhere to the new rules.

yarn.lock Modifications:

  • Various updates to package dependencies reflect the changes in package.json. It’s important to ensure that these updates do not introduce breaking changes or conflicts with the project's existing dependencies. Given the nature of these updates, it seems the project maintainers are keeping dependencies up-to-date, which is generally a good practice for maintaining the security and stability of the software.

This review covers the key aspects of the changes based on the code modifications presented. It's always a good idea to perform thorough testing and review when making significant updates to tooling and dependencies to ensure compatibility and maintain project quality.

Copy link

codecov bot commented May 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.45%. Comparing base (888eb12) to head (2c755c9).

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #265      +/-   ##
===========================================
+ Coverage    91.48%   92.45%   +0.96%     
===========================================
  Files           50       50              
  Lines         2479     2479              
  Branches       308      311       +3     
===========================================
+ Hits          2268     2292      +24     
+ Misses         209      187      -22     
+ Partials         2        0       -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@JensAstrup JensAstrup merged commit 9983449 into develop May 25, 2024
10 checks passed
@JensAstrup JensAstrup deleted the 263-update-eslint-base-config branch May 25, 2024 04:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant