feat: use oxlint and prettier #48

fengmk2 · 2025-03-23T12:54:26Z

Summary by CodeRabbit

Chores
- Updated dependencies, automation workflows, and build scripts to streamline development and maintain consistency.
New Features
- Integrated an automated pre-commit hook to ensure code quality with every change.
Style
- Standardized and improved code formatting and readability across configuration, source, and test files.

coderabbitai · 2025-03-23T12:54:34Z

Walkthrough

This pull request removes legacy ESLint configuration files and revises formatting in various project files. New configuration files for linting and formatting (.oxlintrc.json, .prettierignore, .prettierrc) have been added while the branch specifications in GitHub workflows have been standardized. Dependency versions in package.json have been updated and additional tools like husky and lint-staged are now integrated to enforce code quality during commits. Several files across the project and test fixtures have received cosmetic formatting improvements, including changes to type-only imports and configuration object styles.

Changes

File(s)	Change Summary
`.eslintignore`, `.eslintrc`	Removed ESLint configuration files that previously ignored specific directories and extended ESLint rules.
`.github/workflows/nodejs.yml`, `.github/workflows/release.yml`	Standardized branch formatting by removing extra whitespace around branch names.
`.husky/pre-commit`	Added `npx lint-staged` command to run linting tasks before commits.
`.oxlintrc.json`, `.prettierignore`, `.prettierrc`	Introduced new linting and formatting configuration files with specified rules and ignore patterns.
`README.md`	Adjusted formatting in configuration examples for improved readability.
`example/hello/app/router.ts`, `example/hello/start.ts`	Updated import to a type-only import and added a lint-disabling directive for console logging.
`package.json`	Updated dependency versions; added new dependencies (husky, lint-staged, oxlint, prettier); revised scripts and lint-staged configuration.
`src/config/config.default.ts`, `src/lib/redis.ts`	Improved type safety and code formatting by updating import statements and loop iterations.
Multiple test fixture files under `test/fixtures/apps/...`	Applied consistent formatting improvements in function declarations and configuration objects across various test applications.
Multiple TypeScript test fixture files under `test/fixtures/apps/ts(-multi)/redisapp-ts/...`	Standardized formatting and indentation in route and configuration files.
`test/redis.test.ts`	Modified import to a type-only import and condensed method chaining in test assertions.

Sequence Diagram(s)

sequenceDiagram
    participant Dev as Developer
    participant Husky as Pre-commit Hook (.husky/pre-commit)
    participant Lint as lint-staged
    Dev->>Husky: Initiates commit
    Husky->>Lint: Executes "npx lint-staged"
    Lint->>Dev: Returns linting results
    alt Lint errors found
        Dev->>Husky: Commit blocked
    else No lint errors
        Husky->>Dev: Commit proceeds
    end

Suggested labels

enhancement

Poem

I'm a rabbit, hopping in the code field bright,
Where lint and format dance in the light.
With husky and staged checks guarding every hop,
Our code's in a garden that simply won't stop.
Dependencies updated, formatting so neat—
I nibble on changes with joy and a beat!
CodeRabbit cheers for each commit complete!

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 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>, please review it.
- 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @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 using 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 generate docstrings to generate docstrings for this 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.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

Copilot

Pull Request Overview

This PR aims to integrate oxlint and prettier into the project, along with some type and formatting improvements.

Updated configuration type definitions to improve type safety for Redis options.
Refactored Redis client creation logic to use for-of loops and strengthened assertion conditions.
Modified example code to include oxlint directives and use type-only imports for clarity.

Reviewed Changes

Copilot reviewed 28 out of 35 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
src/config/config.default.ts	Updated Redis option type for improved type safety
example/hello/start.ts	Added oxlint directive for console usage and reformatted logging
src/lib/redis.ts	Refactored Redis client creation, improved assertions, and logging
example/hello/app/router.ts	Converted import to type-only import for Application
README.md	Applied formatting consistency improvements in examples

Files not reviewed (7)

.eslintignore: Language not supported
.eslintrc: Language not supported
.husky/pre-commit: Language not supported
.oxlintrc.json: Language not supported
.prettierignore: Language not supported
.prettierrc: Language not supported
package.json: Language not supported

Comments suppressed due to low confidence (1)

src/lib/redis.ts:40

[nitpick] Consider renaming the loop variable 'client' to 'node' to avoid potential confusion with the outer 'client' variable.

for (const client of config.nodes) {

pkg-pr-new · 2025-03-23T12:55:15Z

Open in Stackblitz

npm i https://pkg.pr.new/eggjs/redis/@eggjs/redis@48

commit: d6876de

socket-security · 2025-03-23T12:55:49Z

New dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/[email protected]	None	`0`	4.04 kB	typicode
npm/[email protected]	Transitive: environment, filesystem, shell	`+48`	2.04 MB
npm/[email protected]	None	`+8`	123 MB	boshen
npm/[email protected]	None	`0`	0 B

View full report↗︎

codecov · 2025-03-23T12:56:15Z

Codecov Report

Attention: Patch coverage is 53.12500% with 30 lines in your changes missing coverage. Please review.

Project coverage is 82.64%. Comparing base (0afe42b) to head (d6876de).
Report is 2 commits behind head on master.

Files with missing lines	Patch %	Lines
src/lib/redis.ts	51.61%	30 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master      #48      +/-   ##
==========================================
- Coverage   87.08%   82.64%   -4.44%     
==========================================
  Files           4        4              
  Lines         209      242      +33     
  Branches       17       17              
==========================================
+ Hits          182      200      +18     
- Misses         27       42      +15

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

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[skip ci] ## [3.1.0](v3.0.0...v3.1.0) (2025-03-23) ### Features * use oxlint and prettier ([#48](#48)) ([9900e87](9900e87))

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (3)

README.md (2)

60-60: Markdownlint Suggestion: Use Heading Syntax.

Line 60 uses emphasis to denote a section title. Consider replacing this with a proper Markdown heading (e.g., ## Multi Clients) to comply with MD036.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

60-60: Emphasis used instead of a heading
null

(MD036, no-emphasis-as-heading)

139-139: Markdownlint Suggestion: Use Heading Syntax.

Similarly, the emphasis on line 139 for the weakDependent section could be replaced with a Markdown header to better adhere to markdownlint guidelines.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

139-139: Emphasis used instead of a heading
null

(MD036, no-emphasis-as-heading)
.oxlintrc.json (1)
25-30: JSON Comments Consideration
There are inline comments (e.g. on line 26: // eslint and line 54: // maybe warn) used within this JSON file. Standard JSON does not support comments, so please verify that the configuration parser accepts JSONC or a similar relaxed format. If not, consider removing or converting these comments to avoid potential parse errors.

Below is a diff suggestion if you decide to remove the comments:
@@ "rules": { 
-    // eslint
-    "constructor-super": "error",
+    "constructor-super": "error",
Repeat similar removals for other comment lines as needed.

🧰 Tools

🪛 Biome (1.9.4)

[error] 26-26: Expected a property but instead found '// eslint'.

Expected a property here.

(parse)

[error] 27-27: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)

[error] 27-27: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)

[error] 27-27: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)

[error] 27-27: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)

[error] 28-28: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)

[error] 28-28: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)

[error] 28-28: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)

[error] 28-28: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)

[error] 29-29: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)

[error] 29-29: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)

[error] 29-29: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)

[error] 29-29: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)

[error] 30-30: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)

[error] 30-30: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)

[error] 30-30: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)

[error] 30-30: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0afe42b and d6876de.

📒 Files selected for processing (35)

.eslintignore (0 hunks)
.eslintrc (0 hunks)
.github/workflows/nodejs.yml (1 hunks)
.github/workflows/release.yml (1 hunks)
.husky/pre-commit (1 hunks)
.oxlintrc.json (1 hunks)
.prettierignore (1 hunks)
.prettierrc (1 hunks)
README.md (4 hunks)
example/hello/app/router.ts (1 hunks)
example/hello/start.ts (2 hunks)
package.json (1 hunks)
src/config/config.default.ts (2 hunks)
src/lib/redis.ts (3 hunks)
test/fixtures/apps/redisapp-customize/app/router.js (1 hunks)
test/fixtures/apps/redisapp-customize/config/config.js (1 hunks)
test/fixtures/apps/redisapp-default/app/router.js (1 hunks)
test/fixtures/apps/redisapp-disable-offline-queue/app/router.js (1 hunks)
test/fixtures/apps/redisapp-supportTimeCommand-false/app/router.js (1 hunks)
test/fixtures/apps/redisapp-supportTimeCommand-false/config/config.js (1 hunks)
test/fixtures/apps/redisapp-weakdependent/app/router.js (1 hunks)
test/fixtures/apps/redisapp-weakdependent/config/config.js (1 hunks)
test/fixtures/apps/redisapp/app/router.js (1 hunks)
test/fixtures/apps/redisclusterapp/app/router.js (1 hunks)
test/fixtures/apps/redisclusterapp/config/config.js (1 hunks)
test/fixtures/apps/redispathapp/app/router.js (1 hunks)
test/fixtures/apps/redispathapp/config/config.js (1 hunks)
test/fixtures/apps/redissentinelapp/app/router.js (1 hunks)
test/fixtures/apps/redissentinelapp/config/config.js (1 hunks)
test/fixtures/apps/ts-multi/redisapp-ts/app/controller/home.ts (1 hunks)
test/fixtures/apps/ts-multi/redisapp-ts/app/router.ts (1 hunks)
test/fixtures/apps/ts-multi/redisapp-ts/config/config.ts (2 hunks)
test/fixtures/apps/ts/redisapp-ts/app/router.ts (1 hunks)
test/fixtures/apps/ts/redisapp-ts/config/config.ts (1 hunks)
test/redis.test.ts (11 hunks)

💤 Files with no reviewable changes (2)

.eslintrc
.eslintignore

🧰 Additional context used

🧬 Code Definitions (1)

test/fixtures/apps/redisapp-customize/app/router.js (3)

example/hello/app/router.ts (1)

app (3-12)

test/fixtures/apps/ts-multi/redisapp-ts/app/router.ts (1)

app (3-7)

test/fixtures/apps/ts/redisapp-ts/app/router.ts (1)

app (3-7)

🪛 markdownlint-cli2 (0.17.2)

README.md

60-60: Emphasis used instead of a heading
null

(MD036, no-emphasis-as-heading)

139-139: Emphasis used instead of a heading
null

(MD036, no-emphasis-as-heading)

🪛 Biome (1.9.4)

.oxlintrc.json

[error] 26-26: Expected a property but instead found '// eslint'.

Expected a property here.

(parse)

[error] 27-27: End of file expected