Skip to content

Fix Docker install snippet (image name must be lowercase) and typos - #1177

Open
toyeshhm wants to merge 1 commit into
JohnnyMorganz:mainfrom
toyeshhm:fix-doc-typos
Open

toyeshhm wants to merge 1 commit into
JohnnyMorganz:mainfrom
toyeshhm:fix-doc-typos

Conversation

@toyeshhm

Copy link
Copy Markdown

The Docker install snippet in the README fails to build:

COPY --from=JohnnyMorganz/StyLua:2.6.0 /stylua /usr/bin/stylua

Docker image references must be lowercase, so this fails with invalid reference format: repository name must be lowercase. The image is published as johnnymorganz/stylua (the images: value in release.yml, and the Docker Hub link just above the snippet), so the snippet now uses that name.

.github/release.py bumps this line with a case-sensitive StyLua:{old} match, so I changed that needle to stylua:{old} as well. Otherwise the Docker tag would stop updating on release. The new needle matches only the Docker line, since the -- stylua: ignore examples have no version after the colon.

Also fixes four typos:

  • README.md: preseve -> preserve
  • src/shape.rs: expontential -> exponential (doc comment)
  • src/formatters/functions.rs: COMPATABILITY -> COMPATIBILITY (comment)
  • src/cli/main.rs: Covert -> Convert (comment)

Only comments changed in the Rust files. No code changes there.

The README Docker snippet used `JohnnyMorganz/StyLua:2.6.0` as the
`COPY --from` image. Docker image references must be lowercase, so this
fails with "invalid reference format: repository name must be
lowercase". Use `johnnymorganz/stylua`, the name the release workflow
publishes to Docker Hub, and update the matching needle in
.github/release.py so the version keeps being bumped on release.

Also fix typos:
- README.md: preseve -> preserve
- src/shape.rs: expontential -> exponential
- src/formatters/functions.rs: COMPATABILITY -> COMPATIBILITY
- src/cli/main.rs: Covert -> Convert
Copilot AI balanced review requested due to automatic review settings October 17, 2026 00:09

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

This branch has not been deployed

No deployments
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.

2 participants