chore: bump @reteps/dockerfmt to v0.3.2
#442
Conversation
WalkthroughThis pull request updates several dependency versions and adds a new optional property to control Dockerfile formatting. A changeset entry was added for the prettier-plugin-sh patch and a chore bumped the @reteps/dockerfmt package version. Additionally, a new cleanup command was introduced in a Dockerfile fixture and dependency versions in both the root and package-specific package.json files were incremented. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant dockerPrinter
participant formatDockerfileContents
User->>dockerPrinter: Call print(options)
dockerPrinter->>formatDockerfileContents: Format Dockerfile (with spaceRedirects flag)
formatDockerfileContents-->>dockerPrinter: Return formatted output
dockerPrinter-->>User: Deliver formatted Dockerfile
Assessment against linked issues
Possibly related PRs
Poem
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
packages/sh/src/index.tsOops! Something went wrong! :( ESLint: 9.24.0 Error [ERR_MODULE_NOT_FOUND]: Cannot find package '@1stg/eslint-config' imported from /eslint.config.js ✨ Finishing Touches
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Copilot reviewed 2 out of 6 changed files in this pull request and generated no comments.
Files not reviewed (4)
- package.json: Language not supported
- packages/sh/package.json: Language not supported
- packages/sh/test/snapshots/fixtures.spec.ts.snap: Language not supported
- packages/sh/test/fixtures/441.Dockerfile: Language not supported
Comments suppressed due to low confidence (1)
packages/sh/src/index.ts:117
- Consider adding test cases to verify the behavior of the new 'spaceRedirects' option to ensure it functions as expected.
spaceRedirects = false,
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub ↗. |
|
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. |
size-limit report 📦
|
prettier-plugin-autocorrect
prettier-plugin-pkg
prettier-plugin-sql
prettier-plugin-sh
prettier-plugin-toml
commit: |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #442 +/- ##
==========================================
- Coverage 86.18% 85.71% -0.48%
==========================================
Files 10 10
Lines 181 182 +1
Branches 46 47 +1
==========================================
Hits 156 156
- Misses 24 25 +1
Partials 1 1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
🦋 Changeset detectedLatest commit: 1aa35c3 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
package.json (1)
1-115: Verification of @reteps/dockerfmt Update.
The PR title indicates a bump of@reteps/dockerfmtto v0.3.2, yet this file (the rootpackage.json) does not include an update for that dependency. Please confirm that the@reteps/dockerfmtupdate has been applied in the appropriate location (likely in thepackages/sh/package.jsonfile) and that all related changes are properly tracked.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (2)
packages/sh/test/__snapshots__/fixtures.spec.ts.snapis excluded by!**/*.snapyarn.lockis excluded by!**/yarn.lock,!**/*.lock
📒 Files selected for processing (5)
.changeset/many-impalas-beam.md(1 hunks)package.json(2 hunks)packages/sh/package.json(1 hunks)packages/sh/src/index.ts(2 hunks)packages/sh/test/fixtures/441.Dockerfile(1 hunks)
🧰 Additional context used
🪛 Hadolint (2.12.0)
packages/sh/test/fixtures/441.Dockerfile
[error] 1-1: Invalid instruction order. Dockerfile must begin with FROM, ARG or comment.
(DL3061)
⏰ Context from checks skipped due to timeout of 90000ms (7)
- GitHub Check: Codacy Static Code Analysis
- GitHub Check: Lint and Test with Node.js 18 on windows-latest
- 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 macos-latest
- GitHub Check: Lint and Test with Node.js 22 on windows-latest
- GitHub Check: Lint and Test with Node.js 20 on windows-latest
🔇 Additional comments (10)
packages/sh/test/fixtures/441.Dockerfile (2)
1-3: Intentional test fixture for Dockerfile formattingThis fixture appears to be intentionally created to test the new
spaceRedirectsformatting capability added in this PR. It provides a simple RUN command with a cleanup operation.🧰 Tools
🪛 Hadolint (2.12.0)
[error] 1-1: Invalid instruction order. Dockerfile must begin with
FROM,ARGor comment.(DL3061)
1-3:✅ Verification successful
Note: This fixture doesn't follow Dockerfile best practices
While this is a valid test fixture, note that Hadolint reports it doesn't follow the standard Dockerfile format which requires starting with a
FROM,ARG, or comment instruction.Since this is likely intentional for testing purposes, no changes are needed. However, if you're interested in seeing what Hadolint expects:
🏁 Script executed:
#!/bin/bash echo 'FROM ubuntu:latest' > test.Dockerfile echo 'RUN \\' >> test.Dockerfile echo ' # cleanup' >> test.Dockerfile echo ' ls -la' >> test.Dockerfile cat test.DockerfileLength of output: 159
Fixture intentionally deviates from Dockerfile best practices for testing
The test fixture in
packages/sh/test/fixtures/441.Dockerfileis intentionally kept without aFROM,ARG, or comment instruction. As verified by the provided shell script—which shows a compliant fixture starting with aFROMdirective—it’s clear that this deviation is deliberate for testing purposes. No changes are needed.🧰 Tools
🪛 Hadolint (2.12.0)
[error] 1-1: Invalid instruction order. Dockerfile must begin with
FROM,ARGor comment.(DL3061)
.changeset/many-impalas-beam.md (1)
1-5: Well-structured changeset entryThe changeset entry appropriately documents both the patch for prettier-plugin-sh and the version bump for @reteps/dockerfmt, which aligns with the PR objectives.
packages/sh/package.json (1)
53-53: Version bump implemented correctlyThe dependency version for
@reteps/dockerfmthas been successfully updated from^0.2.6to^0.3.2as specified in the PR objective.packages/sh/src/index.ts (3)
15-16: Good API extension with backward compatibilityAdding an optional property
spaceRedirectsto theDockerfilePrintOptionsinterface is a non-breaking change that extends functionality while maintaining backward compatibility.
117-117: Default value set for new optionSetting
spaceRedirects = falseas the default is appropriate, ensuring existing behavior doesn't change for users who don't explicitly set this option.
123-123: Parameter correctly passed to formatterThe
spaceRedirectsparameter is properly passed to theformatDockerfileContentsfunction, completing the implementation of this new formatting option.package.json (3)
43-43: Dependency Version Bump for @shikijs/rehype.
The version is updated from^3.2.1to^3.2.2, which is a minor update. Please ensure there are no breaking changes in this release.
47-47: Dependency Version Bump for @types/react-dom.
The version change to^19.1.2is a minor update for improved type definitions. It would be good to run any related type tests to ensure compatibility.
76-76: Dependency Version Bump for Vite.
Vite is bumped from^6.2.5to^6.2.6. As this is a minor update, it should be backwards compatible; however, please verify that the build and development tasks function as expected with this version change.
close #441
Summary by CodeRabbit
New Features
Chores