Skip to content

refactor: simplify jsox usage #427

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 6 commits into from
Apr 6, 2025
Merged

refactor: simplify jsox usage #427

merged 6 commits into from
Apr 6, 2025

Conversation

JounQin
Copy link
Member

@JounQin JounQin commented Apr 6, 2025 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • Chores

    • Updated dependencies for SQL formatting and parsing to ensure improved compatibility and maintenance.
    • Bumped node-sql-parser package version and updated @types/react-dom and vite to newer versions.

  • Refactor

    • Streamlined the integration of the SQL formatting tool, simplifying the underlying implementation while keeping user-facing behavior consistent.
    • Simplified the export of the JSOX entity for easier access in the code.
    • Reorganized documentation for JSON schema definitions in the README.

@JounQin JounQin requested a review from Copilot April 6, 2025 06:29
@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Apr 6, 2025 •
edited
Loading

🦋 Changeset detected

Latest commit: 63b4274

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
prettier-plugin-sql Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Apr 6, 2025 •
edited
Loading

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduce two new changeset files documenting a minor version bump for the prettier-plugin-sql and a patch related to its usage simplification. Additionally, the export declaration of the JSOX module is simplified in the type definition file, and its import in the SQL index file is updated from a namespace import to a named import, eliminating a redundant fallback declaration. The package.json file is updated to reflect version changes for specific dependencies. No public API declarations were altered.

Changes

Files Change Summary
.changeset/eight-taxis-sell.md, .changeset/five-chefs-move.md Added new changeset entries documenting a minor version bump for prettier-plugin-sql and a patch/refactor note, plus a dependency bump for node-sql-parser.
packages/sql/shim.d.ts, packages/sql/src/index.ts Updated the JSOX export: simplified type declaration in the shim and changed the import in the index file from a namespace import to a named import, removing fallback.
package.json Updated dependency version for @types/react-dom from ^18.3.6 to ^19.1.1 and for vite from ^5.4.17 to ^6.2.5.
packages/pkg/README.md Modified JSON schema definition by adding and removing the keys "types", "typings", and "typesVersions", reorganizing their presentation.

Poem

I'm a rabbit in the code forest, hopping with cheer,
Each change makes the structure much clearer,
Changelogs updated with a skip and a bound,
With JSOX refined and clean imports found,
Thump-thump goes my heart as these commits endear! 🐰

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f17f9ee and 63b4274.

📒 Files selected for processing (1)
  • packages/pkg/README.md (1 hunks)
🪧 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 plan to trigger planning for file edits and PR creation.
  • @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
Copilot AI reviewed Apr 6, 2025
View reviewed changes
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

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

Comments suppressed due to low confidence (1)

packages/sql/src/index.ts:3

  • Verify that the 'jsox' package provides a named export 'JSOX'. If not, this change could lead to runtime issues by eliminating the fallback mechanism.
import { JSOX } from 'jsox'

@socket-security Socket Security
Copy link

socket-security bot commented Apr 6, 2025 •
edited
Loading

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

Package New capabilities Transitives Size Publisher
npm/eslint-plugin-import-x@4.10.0 ➜ 4.10.1 None 0 1.04 MB jounqin
npm/possible-typed-array-names@1.1.0 None 0 9.7 kB ljharb

View full report↗︎

@codesandbox-ci CodeSandbox CI
Copy link

codesandbox-ci bot commented Apr 6, 2025 •
edited
Loading

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Apr 6, 2025 •
edited
Loading

size-limit report 📦

Path Size
packages/autocorrect/lib/index.js 538 B (0%)
packages/pkg/lib/index.js 447 B (0%)
packages/sh/lib/index.js 2.33 KB (0%)
packages/sql/lib/index.js 2.4 KB (0%)

@pkg-pr-new pkg.pr.new
Copy link

pkg-pr-new bot commented Apr 6, 2025 •
edited
Loading

Open in StackBlitz

prettier-plugin-autocorrect

npm i https://pkg.pr.new/un-ts/prettier/prettier-plugin-autocorrect@427

prettier-plugin-pkg

npm i https://pkg.pr.new/un-ts/prettier/prettier-plugin-pkg@427

prettier-plugin-sql

npm i https://pkg.pr.new/un-ts/prettier/prettier-plugin-sql@427

prettier-plugin-sh

npm i https://pkg.pr.new/un-ts/prettier/prettier-plugin-sh@427

prettier-plugin-toml

npm i https://pkg.pr.new/un-ts/prettier/prettier-plugin-toml@427

commit: 63b4274

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Apr 6, 2025 •
edited
Loading

📊 Package size report   No changes

File Before After
Total (Includes all files) 3.1 MB 3.1 MB
Tarball size 1.1 MB 1.1 MB
Unchanged files
File Size
.changeset/config.json 313 B
.changeset/eight-taxis-sell.md 80 B
.changeset/eight-taxis-sell.md.md 80 B
.changeset/five-chefs-move.md 68 B
.changeset/four-llamas-burn.md 81 B
.changeset/huge-coats-jog.md 224 B
.changeset/README.md 510 B
.codesandbox/ci.json 38 B
.editorconfig 161 B
.gitattributes 152 B
.github/workflows/autofix.yml 917 B
.github/workflows/ci.yml 1.0 kB
.github/workflows/pkg-pr-new.yml 676 B
.github/workflows/pkg-size.yml 542 B
.github/workflows/release.yml 1.2 kB
.github/workflows/size-limit.yml 633 B
.github/workflows/vercel.yml 908 B
.lintstagedrc.js 48 B
.nvmrc 6 B
.postcssrc.cjs 51 B
.prettierignore 23 B
.prettierrc 24 B
.remarkrc 42 B
.renovaterc 49 B
.simple-git-hooks.js 49 B
.yarn/plugins/plugin-prepare-lifecycle.cjs 202 B
.yarn/releases/yarn-4.8.1.cjs 2.8 MB
.yarnrc.yml 397 B
assets/pkg.svg 15.1 kB
assets/sh.png 14.4 kB
CHANGELOG.md 393 B
docs/App.tsx 1.2 kB
docs/global.css 156 B
docs/index.tsx 211 B
eslint.config.js 216 B
index.html 404 B
LICENSE 1.1 kB
package.json 3.6 kB
packages/autocorrect/CHANGELOG.md 1.7 kB
packages/autocorrect/index.d.cts 63 B
packages/autocorrect/LICENSE 1.1 kB
packages/autocorrect/package.json 1.2 kB
packages/autocorrect/README.md 4.2 kB
packages/autocorrect/src/index.ts 1.4 kB
packages/autocorrect/src/types.ts 78 B
packages/autocorrect/test/__snapshots__/fixtures.spec.ts.snap 4.7 kB
packages/autocorrect/test/fixtures.spec.ts 983 B
packages/autocorrect/test/fixtures/test.css 189 B
packages/autocorrect/test/fixtures/test.go 470 B
packages/autocorrect/test/fixtures/test.html 1.1 kB
packages/autocorrect/test/fixtures/test.md 1.1 kB
packages/autocorrect/test/fixtures/test.py 368 B
packages/autocorrect/test/fixtures/test.rb 234 B
packages/autocorrect/test/fixtures/test0.js 453 B
packages/autocorrect/tsconfig.json 154 B
packages/pkg/CHANGELOG.md 11.0 kB
packages/pkg/index.d.cts 47 B
packages/pkg/LICENSE 16.7 kB
packages/pkg/package.json 1.1 kB
packages/pkg/README.md 6.4 kB
packages/pkg/src/index.ts 1.4 kB
packages/pkg/src/rules/files.ts 1.7 kB
packages/pkg/src/rules/object.ts 891 B
packages/pkg/src/rules/sort.ts 2.4 kB
packages/pkg/src/types.ts 1.0 kB
packages/pkg/src/utils.ts 567 B
packages/pkg/test/__snapshots__/engines.spec.ts.snap 158 B
packages/pkg/test/__snapshots__/files.spec.ts.snap 173 B
packages/pkg/test/__snapshots__/test.spec.ts.snap 2.0 kB
packages/pkg/test/engines.spec.ts 417 B
packages/pkg/test/files.spec.ts 409 B
packages/pkg/test/fixtures/fixture1.json 1.0 kB
packages/pkg/test/fixtures/fixture2.json 863 B
packages/pkg/test/fixtures/fixture3.json 430 B
packages/pkg/test/test.spec.ts 2.3 kB
packages/pkg/tsconfig.json 154 B
packages/sh/CHANGELOG.md 13.0 kB
packages/sh/index.d.cts 45 B
packages/sh/LICENSE 1.1 kB
packages/sh/package.json 1.5 kB
packages/sh/README.md 4.8 kB
packages/sh/src/index.ts 9.8 kB
packages/sh/test/__snapshots__/fixtures.spec.ts.snap 56.1 kB
packages/sh/test/__snapshots__/shellscript.spec.ts.snap 312 B
packages/sh/test/fixtures.spec.ts 1.5 kB
packages/sh/test/fixtures/.dockerignore 108 B
packages/sh/test/fixtures/.nvmrc 6 B
packages/sh/test/fixtures/.properties 177 B
packages/sh/test/fixtures/133.sh 5.2 kB
packages/sh/test/fixtures/146.ini 1.1 kB
packages/sh/test/fixtures/147.cfg 3.3 kB
packages/sh/test/fixtures/148.ini 3.1 kB
packages/sh/test/fixtures/162.sh 15.7 kB
packages/sh/test/fixtures/182.sh 1.9 kB
packages/sh/test/fixtures/191.sh 1.7 kB
packages/sh/test/fixtures/278.Dockerfile 32 B
packages/sh/test/fixtures/292.Dockerfile 95 B
packages/sh/test/fixtures/Dockerfile 394 B
packages/sh/test/fixtures/hosts 406 B
packages/sh/test/fixtures/jvm.options 162 B
packages/sh/test/fixtures/no-ext 37 B
packages/sh/test/fixtures/shell.sh 368 B
packages/sh/test/parser.spec.ts 2.1 kB
packages/sh/test/shellscript.spec.ts 741 B
packages/sh/tsconfig.json 154 B
packages/sql/CHANGELOG.md 10.4 kB
packages/sql/index.d.cts 47 B
packages/sql/LICENSE 1.1 kB
packages/sql/package.json 1.4 kB
packages/sql/README.md 7.2 kB
packages/sql/shim.d.ts 59 B
packages/sql/src/index.ts 13.0 kB
packages/sql/test/__snapshots__/fixtures-eol.spec.ts.snap 756 B
packages/sql/test/__snapshots__/fixtures.spec.ts.snap 2.0 kB
packages/sql/test/__snapshots__/sql.spec.ts.snap 374 B
packages/sql/test/fixtures-eol.spec.ts 1.3 kB
packages/sql/test/fixtures-eol/556.sql 73 B
packages/sql/test/fixtures-eol/557.sql 69 B
packages/sql/test/fixtures-eol/558.sql 69 B
packages/sql/test/fixtures-eol/559.sql 73 B
packages/sql/test/fixtures.spec.ts 1.7 kB
packages/sql/test/fixtures/144.sql 68 B
packages/sql/test/fixtures/233.sql 68 B
packages/sql/test/fixtures/277.sql 88 B
packages/sql/test/fixtures/279.sql 106 B
packages/sql/test/fixtures/291.sql 1.2 kB
packages/sql/test/fixtures/334.sql 15 B
packages/sql/test/fixtures/basic.sql 120 B
packages/sql/test/sql.spec.ts 660 B
packages/sql/tsconfig.json 154 B
packages/toml/CHANGELOG.md 1.7 kB
packages/toml/index.d.cts 49 B
packages/toml/LICENSE 1.1 kB
packages/toml/package.json 1.2 kB
packages/toml/README.md 5.4 kB
packages/toml/src/index.ts 1.3 kB
packages/toml/src/options.ts 2.6 kB
packages/toml/src/types.ts 381 B
packages/toml/test/__snapshots__/fixtures.spec.ts.snap 487 B
packages/toml/test/fixtures.spec.ts 955 B
packages/toml/test/fixtures/comments.toml 87 B
packages/toml/test/fixtures/fixture1.toml 162 B
packages/toml/tsconfig.json 154 B
README.md 6.6 kB
scripts/format.ts 612 B
scripts/languages.ts 2.9 kB
test/global.d.ts 41 B
test/tsconfig.json 223 B
tsconfig.base.json 89 B
tsconfig.json 275 B
vercel.json 229 B
vite.config.ts 266 B
vitest.config.ts 541 B

🤖 This report was automatically generated by pkg-size-action

@codecov Codecov
Copy link

codecov bot commented Apr 6, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.52%. Comparing base (facf7ac) to head (63b4274).
Report is 1 commits behind head on master.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master     #427      +/-   ##
==========================================
- Coverage   88.58%   88.52%   -0.07%     
==========================================
  Files          10       10              
  Lines         184      183       -1     
  Branches       52       51       -1     
==========================================
- Hits          163      162       -1     
  Misses         20       20              
  Partials        1        1

☔ 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.

@JounQin JounQin force-pushed the master branch 3 times, most recently from ff6650f to facf7ac Compare April 6, 2025 06:59
@sonarqubecloud SonarQubeCloud
Copy link

sonarqubecloud bot commented Apr 6, 2025

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@JounQin JounQin enabled auto-merge (squash) April 6, 2025 07:14
@JounQin JounQin merged commit f11e517 into master Apr 6, 2025
33 of 35 checks passed
@JounQin JounQin deleted the chore/jsox branch April 6, 2025 07:14
@JounQin JounQin mentioned this pull request Apr 6, 2025
Merged
@coderabbitai coderabbitai bot mentioned this pull request Apr 17, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

Copilot code review Copilot Copilot left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@JounQin