Skip to content

Conversation

JounQin
Copy link
Member

@JounQin JounQin commented Apr 8, 2025

This PR was opened by the Changesets release GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to master, this PR will be updated.

Releases

prettier-plugin-sh@0.17.0

Minor Changes

Summary by CodeRabbit

  • New Features
    • Enhanced shell handling now uses a stable syntax mode while discontinuing older support.
    • Introduced a prototype fallback printer for Docker formatting, available via a specific parser option.
  • Chores
    • Upgraded the plugin version to 0.17.0.

Copy link

coderabbitai bot commented Apr 8, 2025

Walkthrough

This pull request updates the prettier-plugin-sh package to version 0.17.0. It removes a changeset file that previously documented the update and adds a new changelog entry in packages/sh/CHANGELOG.md describing the switch to using sh-syntax without the experimental flag, along with the removal of mvdan-sh support. The version is also bumped in packages/sh/package.json from 0.16.1 to 0.17.0. No changes were made to the declarations of exported or public entities.

Changes

File(s) Change Summary
.changeset/spotty-beds-applaud.md Deleted the file that documented the update for prettier-plugin-sh, which now uses sh-syntax without the experimental flag and removed mvdan-sh support.
packages/sh/CHANGELOG.md
packages/sh/package.json
Added a new version entry (0.17.0) to the changelog detailing the feature update and bumped the package version from 0.16.1 to 0.17.0.

Possibly related PRs

  • chore: release package(s) #428: The changes in this PR regarding the prettier-plugin-sh version update and the removal of support for mvdan-sh are directly related to the modifications in the retrieved PR, which also includes updates for prettier-plugin-sh with similar changes.
  • chore: release package(s) #417: This PR documents updates to the same plugin, specifically the exclusion of the ShellSession language, and is related to the changes in the main PR regarding the prettier-plugin-sh version update and the removal of support for mvdan-sh.

Poem

I'm a rabbit with a hopping beat,
Code has changed and it's oh-so-sweet.
Bumped the version, a new carrot treat,
Shining syntax makes it all complete.
🥕 Hop along and feel the code heat!


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

Copy link

codesandbox-ci bot commented Apr 8, 2025

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.

Copy link
Contributor

github-actions bot commented Apr 8, 2025

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 3.24 KB (0%)
packages/sql/lib/index.js 2.4 KB (0%)

Copy link
Contributor

github-actions bot commented Apr 8, 2025

Deploy preview for prettier ready!

✅ Preview
https://prettier-i70z1cqvo-1stg.vercel.app

Built with commit 1ffa26d.
This pull request is being automatically deployed with vercel-action

Copy link

pkg-pr-new bot commented Apr 8, 2025

Open in StackBlitz

prettier-plugin-autocorrect

npm i https://pkg.pr.new/prettier-plugin-autocorrect@431

prettier-plugin-pkg

npm i https://pkg.pr.new/prettier-plugin-pkg@431

prettier-plugin-sh

npm i https://pkg.pr.new/prettier-plugin-sh@431

prettier-plugin-sql

npm i https://pkg.pr.new/prettier-plugin-sql@431

prettier-plugin-toml

npm i https://pkg.pr.new/prettier-plugin-toml@431

commit: 1ffa26d

Copy link

codecov bot commented Apr 8, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.72%. Comparing base (d49d6e5) to head (1ffa26d).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #431   +/-   ##
=======================================
  Coverage   80.72%   80.72%           
=======================================
  Files          10       10           
  Lines         192      192           
  Branches       49       49           
=======================================
  Hits          155      155           
  Misses         36       36           
  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.

Copy link
Contributor

github-actions bot commented Apr 8, 2025

📊 Package size report   0.01%↑

File Before After
.changeset/spotty-beds-applaud.md 189 B
.changeset/tiny-ghosts-press.md 159 B
packages/sh/CHANGELOG.md 13.2 kB 5%↑13.9 kB
Total (Includes all files) 3.0 MB 0.01%↑3.0 MB
Tarball size 1.1 MB 0.01%↑1.1 MB
Unchanged files
File Size
.changeset/config.json 313 B
.changeset/README.md 510 B
.codesandbox/ci.json 38 B
.editorconfig 161 B
.gitattributes 152 B
.github/workflows/autofix.yml 920 B
.github/workflows/ci.yml 1.1 kB
.github/workflows/pkg-pr-new.yml 686 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 901 B
.lintstagedrc.js 48 B
.nvmrc 6 B
.postcssrc.cjs 51 B
.prettierignore 23 B
.prettierrc 24 B
.remarkrc 159 B
.renovaterc 49 B
.simple-git-hooks.js 49 B
.size-limit.json 292 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 321 B
docs/index.tsx 211 B
eslint.config.js 516 B
index.html 414 B
LICENSE 1.1 kB
package.json 3.4 kB
packages/autocorrect/CHANGELOG.md 1.9 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 3.9 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.4 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.2 kB
packages/pkg/src/index.ts 1.4 kB
packages/pkg/src/rules/files.ts 1.7 kB
packages/pkg/src/rules/object.ts 899 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/index.d.cts 45 B
packages/sh/LICENSE 1.1 kB
packages/sh/package.json 1.5 kB
packages/sh/README.md 10.9 kB
packages/sh/src/index.ts 12.5 kB
packages/sh/test/__snapshots__/fixtures.spec.ts.snap 232 B
packages/sh/test/__snapshots__/shellscript.spec.ts.snap 394 B
packages/sh/test/error.spec.ts 502 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/376.Dockerfile 217 B
packages/sh/test/fixtures/384.Dockerfile 51 B
packages/sh/test/fixtures/398.Dockerfile 64 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/tsconfig.json 154 B
packages/sql/CHANGELOG.md 11.3 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 6.9 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 2.0 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.2 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.8 kB
scripts/format.ts 593 B
scripts/languages.ts 2.9 kB
test.js 184 B
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 544 B
vitest.config.ts 541 B

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

@JounQin
Copy link
Member Author

JounQin commented Apr 8, 2025

Hold on for #429

@github-actions github-actions bot force-pushed the changeset-release/master branch from bb69f07 to 1ffa26d Compare April 8, 2025 10:36
@JounQin JounQin closed this Apr 8, 2025
@JounQin JounQin reopened this Apr 8, 2025
Copy link

sonarqubecloud bot commented Apr 8, 2025

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

🧹 Nitpick comments (1)
packages/sh/CHANGELOG.md (1)

9-9: Link Formatting Improvement Suggestion

The standalone note "Please view mvdan/sh#1145 for more details." is informative. For consistency and improved clarity, consider merging this note into the bullet item above so that related details remain bundled together. For example, you might append the note in parentheses at the end of the bullet.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between bb69f07 and 1ffa26d.

📒 Files selected for processing (3)
  • .changeset/spotty-beds-applaud.md (0 hunks)
  • packages/sh/CHANGELOG.md (1 hunks)
  • packages/sh/package.json (1 hunks)
💤 Files with no reviewable changes (1)
  • .changeset/spotty-beds-applaud.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/sh/package.json
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Lint and Test with Node.js 22 on windows-latest
  • GitHub Check: Lint and Test with Node.js 20 on windows-latest
  • GitHub Check: Lint and Test with Node.js 18 on windows-latest
  • GitHub Check: Codacy Static Code Analysis
🔇 Additional comments (2)
packages/sh/CHANGELOG.md (2)

3-7: New Version Section (0.17.0) Added Correctly

The new version header and the "Minor Changes" section for 0.17.0 are clear and follow the existing changelog structure. The entry for PR #430 is detailed—with commit reference and contributor acknowledgment—accurately reflecting the change to use sh-syntax without the experimental flag and indicating the removal of mvdan-sh support.


11-11: Additional Minor Change Entry for PR #432

The entry for PR #432 is well-formatted and clearly explains the prototype feature for using dockerfmt as a fallback printer. The description is precise and user-friendly, consistent with the project's changelog style.

@JounQin JounQin merged commit 48e7779 into master Apr 8, 2025
26 checks passed
@JounQin JounQin deleted the changeset-release/master branch April 8, 2025 11:15
@coderabbitai coderabbitai bot mentioned this pull request May 9, 2025
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