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

v0.13.0: Cumulative updates #87

Merged
merged 10 commits into from
Jul 16, 2024
Merged

v0.13.0: Cumulative updates #87

merged 10 commits into from
Jul 16, 2024

Conversation

kurone-kito
Copy link
Owner

@kurone-kito kurone-kito commented Jul 16, 2024

⚠️ BREAKING CHANGES

  • TypeScript: Bumped the minimum version of TypeScript from 4.7.x or higher to 5.0.x or higher.

Features

  • decc1e3 CSpell: added some dictionary
  • 221495c Lint-staged: added the linting by the oxlint
  • f9e6cd8 TypeScript: removed the newline flag

Other updates

  • 50a8e8c: bumped the package version
  • 46dd336: updated the dependencies
  • 0eede11: updated the Yarn version
  • 03ffa98: increased the specified Node.js version
  • c5aa82d: refactored the npm-scripts
  • 320bae2: improved the VSCode configuration
  • 2dca4aa: improved the pre-commit

Summary by CodeRabbit

  • New Features

    • Introduced support for CSS, F#, and PHP dictionaries in spell-check configurations.
    • Added the davidanson.vscode-markdownlint extension to recommended VS Code extensions.
    • Enhanced VS Code settings for better file organization and nesting.
  • Bug Fixes

    • Improved pre-commit script handling when Prettier configuration is missing.
  • Dependencies

    • Updated multiple development dependencies and tools to their latest versions for improved performance and security.

@kurone-kito kurone-kito added the dependencies add, remove, or update the dependencies label Jul 16, 2024
@kurone-kito kurone-kito self-assigned this Jul 16, 2024
Copy link

coderabbitai bot commented Jul 16, 2024

Walkthrough

The update primarily includes version bumps for Node.js and various development dependencies, improvements to pre-commit scripts, and configuration file changes focused on enhancing developer experience. Key updates involve enabling corepack commands in the .husky/pre-commit script, adding the oxlint linter to lint-staged configurations, and introducing file nesting settings in VS Code. These changes aim to streamline the development workflow and maintain consistency across tools and environments.

Changes

Files/Groups Change Summary
.husky/pre-commit Replaced error messages for missing Prettier config with commands to enable corepack, update corepack, and build using yarn.
.node-version, .nvmrc, .tool-versions Updated Node.js version from 18.20.3 to 18.20.4.
.vscode/extensions.json Added "davidanson.vscode-markdownlint" extension to recommended extensions.
.vscode/settings.json Added new file nesting configurations to enhance file organization in VS Code.
package.json Updated versions for various dependencies including ESLint plugins, Prettier, rimraf, and TypeScript.
packages/commitlint-config/package.json Updated version from 0.12.0 to 0.13.0 and adjusted build and clean scripts.
packages/cspell-config/cspell.config.yml Added support for CSS, F#, and PHP dictionaries and updated language settings.
packages/cspell-config/package.json Updated version from 0.12.0 to 0.13.0 and modified build scripts.
packages/eslint-config-base/package.json Updated version from 0.12.0 to 0.13.0, updated devDependencies, and adjusted build and clean scripts.
packages/eslint-config-react/package.json Updated version from 0.12.0 to 0.13.0, updated devDependencies, and adjusted build and clean scripts.
packages/lint-staged-config/lint-staged.config.yml Added oxlint --fix to linting process.
packages/lint-staged-config/package.json Updated version from 0.12.0 to 0.13.0 and modified build and clean scripts.
packages/markdownlint-config/package.json Updated version from 0.12.0 to 0.13.0 and modified build and clean scripts.
packages/prettier-config/package.json Updated version from 0.12.0 to 0.13.0, updated dependencies, and adjusted build and clean scripts.
packages/typescript-config/package.json Updated version from 0.12.0 to 0.13.0, updated devDependencies, and adjusted build and clean scripts.
packages/typescript-config/tsconfig.json Removed "newLine": "LF" configuration setting.

Poem

In the land where coders dwell,
Updates arrive with tales to tell.
Node.js climbs to heights anew,
Configs align, the skies so blue.
Tools refreshed, scripts refined,
🎉 A smoother path for all combined.
CodeRabbit cheers, with joy unconfined!


Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)
.husky/pre-commit (1)

6-8: Ensure robust error handling in pre-commit hooks.

The script now includes commands to handle the absence of a Prettier configuration by enabling corepack, updating it, and building with yarn. Consider adding error handling to ensure that each command executes successfully before proceeding to the next.

+ corepack enable && corepack up && yarn run build
Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between fcfb23a and 50a8e8c.

Files ignored due to path filters (3)
  • .yarn/sdks/prettier/package.json is excluded by !**/.yarn/**, !.yarn/**/*
  • .yarn/sdks/typescript/package.json is excluded by !**/.yarn/**, !.yarn/**/*
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock
Files selected for processing (18)
  • .husky/pre-commit (1 hunks)
  • .node-version (1 hunks)
  • .nvmrc (1 hunks)
  • .tool-versions (1 hunks)
  • .vscode/extensions.json (1 hunks)
  • .vscode/settings.json (1 hunks)
  • package.json (5 hunks)
  • packages/commitlint-config/package.json (2 hunks)
  • packages/cspell-config/cspell.config.yml (4 hunks)
  • packages/cspell-config/package.json (2 hunks)
  • packages/eslint-config-base/package.json (3 hunks)
  • packages/eslint-config-react/package.json (3 hunks)
  • packages/lint-staged-config/lint-staged.config.yml (1 hunks)
  • packages/lint-staged-config/package.json (2 hunks)
  • packages/markdownlint-config/package.json (2 hunks)
  • packages/prettier-config/package.json (3 hunks)
  • packages/typescript-config/package.json (2 hunks)
  • packages/typescript-config/tsconfig.json (1 hunks)
Files skipped from review due to trivial changes (3)
  • .node-version
  • .nvmrc
  • packages/typescript-config/tsconfig.json
Additional comments not posted (50)
.tool-versions (1)

1-1: Version update approved.

The Node.js version has been updated correctly to 18.20.4. This change is consistent with the PR objective of increasing the Node.js version.

packages/lint-staged-config/lint-staged.config.yml (1)

3-4: Integration of oxlint in lint-staged configuration approved.

The addition of oxlint --fix alongside eslint --fix is a good enhancement. Ensure that both linters are configured to not conflict with each other, especially in their fix operations.

.vscode/extensions.json (1)

4-4: Addition of davidanson.vscode-markdownlint approved.

The inclusion of the davidanson.vscode-markdownlint extension is a positive step towards ensuring quality in Markdown files. It complements the existing linter and formatter extensions well.

packages/cspell-config/cspell.config.yml (3)

7-7: Added CSS dictionary.

This addition is consistent with the PR's objective to enhance developer tools and configurations.


15-15: Added F# dictionary.

This addition is consistent with the PR's objective to enhance developer tools and configurations.


25-25: Added PHP dictionary.

This addition is consistent with the PR's objective to enhance developer tools and configurations.

packages/markdownlint-config/package.json (4)

3-3: Version bump to 0.13.0.

This change aligns with the PR's objective of cumulative updates and version synchronization across packages.


31-31: Updated build:license script.

This change likely reflects a restructuring or consolidation of resources within the project.


32-32: Updated clean script.

The adjustment in the script's arguments suggests an optimization or a change in the build artifacts management.


39-39: Updated rimraf to version 5.0.9.

Keeping dependencies up-to-date is crucial for security and functionality, aligning with best practices.

.vscode/settings.json (1)

2-14: Enhanced file nesting settings in VS Code.

These settings are designed to improve file management and organization within the IDE, which aligns with the PR's goals of enhancing the developer experience.

packages/commitlint-config/package.json (3)

3-3: Version bump to 0.13.0.

This change aligns with the PR's objective of cumulative updates and version synchronization across packages.


33-33: Updated build:license script.

This change likely reflects a restructuring or consolidation of resources within the project.


34-34: Updated clean script.

The adjustment in the script's arguments suggests an optimization or a change in the build artifacts management.

packages/prettier-config/package.json (4)

3-3: Version update approved.

The version has been updated from 0.12.0 to 0.13.0 as part of the cumulative updates in this release.


33-33: Review of updated build script for license file.

The build:license script now uses cpy --flat which is a simpler and more efficient command for copying the license file. This change aligns with the PR's objective to streamline configurations.


34-34: Review of the clean script update.

The clean script now explicitly includes LICENSE and .prettierrc.json files for deletion. This ensures a cleaner build environment and prevents potential issues with stale files.


44-45: Dependency updates reviewed.

Updated dependencies prettier to ^3.3.3 and rimraf to ^5.0.9. These updates are consistent with the PR's objective to keep the project dependencies up-to-date.

packages/typescript-config/package.json (5)

3-3: Version update approved.

The version has been updated from 0.12.0 to 0.13.0 as part of the cumulative updates in this release.


30-30: Review of updated build script for license file.

The build script update to use cpy --flat is appropriate for simplifying the copying process of the license file.


31-31: Review of the clean script update.

The clean script now appropriately includes *.tsbuildinfo for deletion, which is crucial for avoiding issues with stale TypeScript build information.


37-42: Dependency updates reviewed.

The updates to dependencies like @typescript-eslint/parser, prettier, and typescript are aligned with the PR's objectives to maintain up-to-date and compatible versions.


46-46: Peer dependency requirements adjustment reviewed.

The adjustment to typescript and typescript-eslint-language-service peer dependencies to >=5.x.x is consistent with the PR's breaking change of requiring TypeScript version 5.0.x or higher.

packages/lint-staged-config/package.json (3)

3-3: Version update approved.

The version has been updated from 0.12.0 to 0.13.0 as part of the cumulative updates in this release.


36-37: Review of script updates.

The updates to the build:license and clean scripts using cpy --flat and the inclusion of lint-staged.config.json in the clean script are appropriate and help maintain a clean and efficient build environment.


44-44: Dependency update reviewed.

The update to rimraf to ^5.0.9 ensures that the project dependencies remain current and compatible with the latest versions.

packages/cspell-config/package.json (3)

3-3: Version update approved.

The version has been updated from 0.12.0 to 0.13.0 as part of the cumulative updates in this release.


38-39: Review of script updates.

The updates to the build:license and clean scripts using cpy --flat and the inclusion of cspell.config.json in the clean script are appropriate and help maintain a clean and efficient build environment.


43-48: Dependency updates reviewed.

The updates to dependencies such as @cspell/cspell-types, cspell, and rimraf to their latest versions are consistent with the PR's objective to keep the project dependencies up-to-date.

package.json (13)

55-55: Approved: Minor version update for @cspell/cspell-types.

This update is expected to be backward compatible and improve stability or functionality.


56-56: Approved: Minor version update for @cspell/eslint-plugin.

Following semantic versioning, this update should not introduce any breaking changes.


65-65: Approved: Minor version update for @typescript-eslint/eslint-plugin.

Ensures compatibility and possibly includes non-breaking enhancements.


66-66: Approved: Minor version update for @typescript-eslint/parser.

This update likely ensures better integration with the corresponding eslint plugin.


78-78: Approved: Minor version update for eslint-plugin-jsdoc.

This minor update should maintain compatibility and possibly include enhancements.


80-80: Approved: Minor version update for eslint-plugin-markdown.

Expected to be backward compatible with potential enhancements.


83-83: Approved: Minor version update for eslint-plugin-oxlint.

This update is expected to include improvements or bug fixes without breaking existing functionality.


84-84: Approved: Patch update for eslint-plugin-react.

Patch updates are generally safe and focus on bug fixes or minor improvements.


85-85: Approved: Patch update for eslint-plugin-yaml.

Patch updates are typically safe, focusing on bug fixes and minor tweaks.


90-90: Approved: Patch update for prettier.

This minor update is expected to improve formatting without affecting existing configurations.


91-91: Approved: Patch update for rimraf.

Patch updates typically focus on minor improvements and bug fixes.


92-92: Approved: Minor version update for TypeScript.

This update should include non-breaking changes and possibly new features that enhance the developer experience.


31-31: Approved: Enhancement to the clean:root script.

This change helps ensure a cleaner and more reliable build environment by removing additional files.

packages/eslint-config-base/package.json (4)

3-3: Version update approved.

The update from "0.12.0" to "0.13.0" correctly follows semantic versioning, assuming backward compatibility is maintained with new features.


33-33: Script modification approved.

Using cpy --flat simplifies the handling of the LICENSE file by avoiding unnecessary directory structures.


34-34: Clean script update approved.

The reordering of rimraf arguments is cosmetic and does not impact the functionality.


Line range hint 39-63: Dependency updates approved.

All dependencies have been updated to newer versions, which should include improvements and bug fixes.

However, ensure that these updates do not introduce any breaking changes by running comprehensive tests.

packages/eslint-config-react/package.json (4)

3-3: Version update approved.

The update from "0.12.0" to "0.13.0" correctly follows semantic versioning, assuming backward compatibility is maintained with new features.


34-34: Script modification approved.

Using cpy --flat simplifies the handling of the LICENSE file by avoiding unnecessary directory structures.


35-35: Clean script update approved.

The reordering of rimraf arguments is cosmetic and does not impact the functionality.


Line range hint 43-71: Dependency updates approved.

All dependencies have been updated to newer versions, which should include improvements and bug fixes.

However, ensure that these updates do not introduce any breaking changes by running comprehensive tests.

@kurone-kito kurone-kito merged commit 3ba52c7 into main Jul 16, 2024
12 checks passed
@kurone-kito kurone-kito deleted the cumulative-updates branch July 16, 2024 16:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies add, remove, or update the dependencies
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant