Skip to content
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.

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

Deprecate mvdan-sh npm package in favor of sh-syntax #1145

Closed
JounQin opened this issue Apr 7, 2025 · 7 comments
Closed

Deprecate mvdan-sh npm package in favor of sh-syntax #1145

JounQin opened this issue Apr 7, 2025 · 7 comments
Assignees

Comments

@JounQin
Copy link
Contributor

JounQin commented Apr 7, 2025

mvdan-sh is very outdated, sh-syntax is easier to maintain and faster.

https://github.com/un-ts/sh-syntax#benchmark

@mvdan
Copy link
Owner

mvdan commented Apr 7, 2025

I'm more than happy to entirely remove our js/wasm library here - I don't have the knowledge of JS and Wasm, nor the time to invest into it :)

Assuming you're happy to maintain it with updates to the Go module - which shouldn't be too hard as I don't intend to make API breaking changes anytime soon.

@JounQin
Copy link
Contributor Author

JounQin commented Apr 7, 2025

Assuming you're happy to maintain it with updates to the Go module

Indeed! It's very smooth to upgrade. See also un-ts/sh-syntax#104

@JounQin
Copy link
Contributor Author

JounQin commented Apr 7, 2025

@mvdan Do you accept a PR for removing _js entirely and recommend sh-syntax in README for js/wasm users?

@mvdan
Copy link
Owner

mvdan commented Apr 7, 2025

I'll do this myself later today, as I want to include plenty of context for any readers.

@mvdan mvdan self-assigned this Apr 7, 2025
renovate bot added a commit to u3u/prettier-config that referenced this issue Apr 10, 2025
This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
|
[prettier-plugin-sh](https://redirect.github.com/un-ts/prettier/tree/master/packages/sh)
([source](https://redirect.github.com/un-ts/prettier)) | [`^0.16.0` ->
`^0.17.2`](https://renovatebot.com/diffs/npm/prettier-plugin-sh/0.16.0/0.17.2)
|
[![age](https://developer.mend.io/api/mc/badges/age/npm/prettier-plugin-sh/0.17.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/prettier-plugin-sh/0.17.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/prettier-plugin-sh/0.16.0/0.17.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/prettier-plugin-sh/0.16.0/0.17.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
|
[prettier-plugin-sql](https://redirect.github.com/un-ts/prettier/tree/master/packages/sql)
([source](https://redirect.github.com/un-ts/prettier)) | [`^0.18.1` ->
`^0.19.0`](https://renovatebot.com/diffs/npm/prettier-plugin-sql/0.18.1/0.19.0)
|
[![age](https://developer.mend.io/api/mc/badges/age/npm/prettier-plugin-sql/0.19.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/prettier-plugin-sql/0.19.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/prettier-plugin-sql/0.18.1/0.19.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/prettier-plugin-sql/0.18.1/0.19.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
| [typescript](https://www.typescriptlang.org/)
([source](https://redirect.github.com/microsoft/TypeScript)) | [`^5.8.2`
-> `^5.8.3`](https://renovatebot.com/diffs/npm/typescript/5.8.2/5.8.3) |
[![age](https://developer.mend.io/api/mc/badges/age/npm/typescript/5.8.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/typescript/5.8.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/typescript/5.8.2/5.8.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/typescript/5.8.2/5.8.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>un-ts/prettier (prettier-plugin-sh)</summary>

###
[`v0.17.2`](https://redirect.github.com/un-ts/prettier/releases/tag/prettier-plugin-sh%400.17.2)

[Compare
Source](https://redirect.github.com/un-ts/prettier/compare/[email protected]@0.17.2)

##### Patch Changes

- [#&#8203;436](https://redirect.github.com/un-ts/prettier/pull/436)
[`560ba3f`](https://redirect.github.com/un-ts/prettier/commit/560ba3f1baaf73007366ba7c1285836e15f0db4a)
Thanks [@&#8203;JounQin](https://redirect.github.com/JounQin)! - feat:
make `dockerfile` default, no fallback needed

- [#&#8203;442](https://redirect.github.com/un-ts/prettier/pull/442)
[`dea6b3f`](https://redirect.github.com/un-ts/prettier/commit/dea6b3f7dd8f929d35f1615bace58a6130cef6f7)
Thanks [@&#8203;JounQin](https://redirect.github.com/JounQin)! - chore:
bump `@reteps/dockerfmt` to v0.3.2

**Full Changelog**:
https://github.com/un-ts/prettier/compare/[email protected]@0.17.2

###
[`v0.17.1`](https://redirect.github.com/un-ts/prettier/releases/tag/prettier-plugin-sh%400.17.1)

[Compare
Source](https://redirect.github.com/un-ts/prettier/compare/[email protected]@0.17.1)

##### Patch Changes

- [#&#8203;433](https://redirect.github.com/un-ts/prettier/pull/433)
[`6650f9d`](https://redirect.github.com/un-ts/prettier/commit/6650f9d1f24379b9cf167bfadf338ef8a75c4862)
Thanks [@&#8203;reteps](https://redirect.github.com/reteps)! - chore:
bump `@reteps/dockerfmt`, fix related ESM only usage

###
[`v0.17.0`](https://redirect.github.com/un-ts/prettier/releases/tag/prettier-plugin-sh%400.17.0)

[Compare
Source](https://redirect.github.com/un-ts/prettier/compare/[email protected]@0.17.0)

##### Minor Changes

- [#&#8203;430](https://redirect.github.com/un-ts/prettier/pull/430)
[`f7e38ae`](https://redirect.github.com/un-ts/prettier/commit/f7e38ae6584a42dca99bfdcd5d0237279dcfc865)
Thanks [@&#8203;JounQin](https://redirect.github.com/JounQin)! -
feat(sh): use `sh-syntax` without experimental flag, remove `mvdan-sh`
support

Please view
[mvdan/sh#1145](https://redirect.github.com/mvdan/sh/issues/1145) for
more details.

- [#&#8203;432](https://redirect.github.com/un-ts/prettier/pull/432)
[`d49d6e5`](https://redirect.github.com/un-ts/prettier/commit/d49d6e59151de0e875109fbab9baeb70afa3f090)
Thanks [@&#8203;JounQin](https://redirect.github.com/JounQin)! - feat:
prototype to use `dockerfmt` as fallback `printer`, you can also use
`parser: dockerfile` to enable it specifically

###
[`v0.16.1`](https://redirect.github.com/un-ts/prettier/releases/tag/prettier-plugin-sh%400.16.1)

[Compare
Source](https://redirect.github.com/un-ts/prettier/compare/[email protected]@0.16.1)

##### Patch Changes

-
[`facf7ac`](https://redirect.github.com/un-ts/prettier/commit/facf7acb0eff0520a74de4f8f710c8bdaeeb40e9)
Thanks [@&#8203;JounQin](https://redirect.github.com/JounQin)! - fix:
incorrect `require` entry types, add `module-sync` entry

</details>

<details>
<summary>microsoft/TypeScript (typescript)</summary>

###
[`v5.8.3`](https://redirect.github.com/microsoft/TypeScript/compare/v5.8.2...68cead182cc24afdc3f1ce7c8ff5853aba14b65a)

[Compare
Source](https://redirect.github.com/microsoft/TypeScript/compare/v5.8.2...v5.8.3)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "after 2am and before 3am" in timezone
Asia/Shanghai, Automerge - "schedule:daily" in timezone Asia/Shanghai.

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR is behind base branch, or you tick the
rebase/retry checkbox.

👻 **Immortal**: This PR will be recreated if closed unmerged. Get
[config
help](https://redirect.github.com/renovatebot/renovate/discussions) if
that's undesired.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR was generated by [Mend Renovate](https://mend.io/renovate/).
View the [repository job
log](https://developer.mend.io/github/u3u/prettier-config).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOS4yMzguMCIsInVwZGF0ZWRJblZlciI6IjM5LjIzOC4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
@mvdan
Copy link
Owner

mvdan commented Apr 10, 2025

I am also reminded that, over a year ago, I already wanted to give up on the JS wrapper built with GopherJS: #1018 (comment)

@mvdan mvdan closed this as completed in 142d054 Apr 10, 2025
@mvdan
Copy link
Owner

mvdan commented Apr 10, 2025

I have also marked https://www.npmjs.com/package/mvdan-sh as deprecated, so that any existing or new users get a warning against using the package. It's way out of date at this point anyway.

@JounQin do you know if I can update the README or description there to point at this issue or your library? I don't seem to be able to. I don't want to publish a new version to update the README, as that would give the impression that the package is maintained, when it is not.

@mvdan
Copy link
Owner

mvdan commented Apr 10, 2025

Ah, I managed to do it via npm deprecate mvdan-sh "See https://github.com/mvdan/sh/issues/1145". It seems like the web UI allows deprecating a package, but not with a custom message.

renovate bot added a commit to boneskull/impvol that referenced this issue Apr 11, 2025
This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
|
[prettier-plugin-sh](https://redirect.github.com/un-ts/prettier/tree/master/packages/sh)
([source](https://redirect.github.com/un-ts/prettier)) | [`0.16.1` ->
`0.17.0`](https://renovatebot.com/diffs/npm/prettier-plugin-sh/0.16.1/0.17.0)
|
[![age](https://developer.mend.io/api/mc/badges/age/npm/prettier-plugin-sh/0.17.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/prettier-plugin-sh/0.17.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/prettier-plugin-sh/0.16.1/0.17.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/prettier-plugin-sh/0.16.1/0.17.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>un-ts/prettier (prettier-plugin-sh)</summary>

###
[`v0.17.0`](https://redirect.github.com/un-ts/prettier/releases/tag/prettier-plugin-sh%400.17.0)

[Compare
Source](https://redirect.github.com/un-ts/prettier/compare/[email protected]@0.17.0)

##### Minor Changes

- [#&#8203;430](https://redirect.github.com/un-ts/prettier/pull/430)
[`f7e38ae`](https://redirect.github.com/un-ts/prettier/commit/f7e38ae6584a42dca99bfdcd5d0237279dcfc865)
Thanks [@&#8203;JounQin](https://redirect.github.com/JounQin)! -
feat(sh): use `sh-syntax` without experimental flag, remove `mvdan-sh`
support

Please view
[mvdan/sh#1145](https://redirect.github.com/mvdan/sh/issues/1145) for
more details.

- [#&#8203;432](https://redirect.github.com/un-ts/prettier/pull/432)
[`d49d6e5`](https://redirect.github.com/un-ts/prettier/commit/d49d6e59151de0e875109fbab9baeb70afa3f090)
Thanks [@&#8203;JounQin](https://redirect.github.com/JounQin)! - feat:
prototype to use `dockerfmt` as fallback `printer`, you can also use
`parser: dockerfile` to enable it specifically

**Full Changelog**:
https://github.com/un-ts/prettier/compare/[email protected]@0.17.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR is behind base branch, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR was generated by [Mend Renovate](https://mend.io/renovate/).
View the [repository job
log](https://developer.mend.io/github/boneskull/impvol).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOS4yMzguMCIsInVwZGF0ZWRJblZlciI6IjM5LjIzOC4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJkZXBlbmRlbmNpZXMiXX0=-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
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

No branches or pull requests

2 participants