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

Rename vscode-remark to remark #66

Closed
4 tasks done
remcohaszing opened this issue Dec 15, 2021 · 12 comments
Closed
4 tasks done

Rename vscode-remark to remark #66

remcohaszing opened this issue Dec 15, 2021 · 12 comments

Comments

@remcohaszing
Copy link
Member

Initial checklist

Problem

The extension id is ${publisher}.${name}, so for this plugin it’s unifiedjs.vscode-remark. This id is used in some places, such as installation instructions and configuration of the formatter once #65 is finalized.

I.e.:

ext install unifiedjs.vscode-remark
"[markdown]": {
    "editor.defaultFormatter": "unifiedjs.vscode-remark"
}

I think the vscode- prefix is a bit superfluous in this context.

Solution

  1. Rename this extension from remark-vscode to `remark
  2. Unpublish the old extension
  3. Publish the new extension

Alternatives

Keep it as-is.

@ChristianMurphy
Copy link
Member

🤔 looking at how other plugins are named.

Several similar/related plugins seem to use the vscode prefix:

and one used it as a suffix https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode

I'm open to removing the prefix, but looking at common conventions, it seems many popular/official extensions do use the prefix.

@remcohaszing
Copy link
Member Author

I figured out 34 of my installed extensions use the vscode- prefix, and 45 don’t. Both camps include popular as well as unpopular plugins, even from Microsoft. IMO that’s pretty much even.

I still think it’s prettier to remove the prefix, but it’s not a big deal.

@Murderlon
Copy link
Member

I don't have a strong opinion on it but I'm not sure how many users are affected if we unpublish the current plugin just for a name change.

@wooorm
Copy link
Member

wooorm commented Dec 16, 2021

👍 on murderlon’s point: changing would introduce churn, which i’d weigh heavier than the “slightly prettier”?

Btw, I believe one of these VSCode-related projects (maybe this one?) has to get a new name to be published under unified, because vscode can’t grant published artefacts to new folks?

@Murderlon
Copy link
Member

Btw, I believe one of these VSCode-related projects (maybe this one?) has to get a new name to be published under unified, because vscode can’t grant published artefacts to new folks?

There are already two, one from mrmlnc, and one from us.

@remcohaszing
Copy link
Member Author

Btw, I believe one of these VSCode-related projects (maybe this one?) has to get a new name to be published under unified, because vscode can’t grant published artefacts to new folks?

There are already two, one from mrmlnc, and one from us.

The one published by unifiedjs isn’t that popular though (327 installs). Probably because it just doesn’t work with the unifiedjs ecosystem moving towards ESM and VSCode not being able to handle it.

There are also stefanprobst.remark-lint and drewbourne.vscode-remark-lint which suffer from the same issues.

There’s also https://github.com/mdx-js/vscode-mdx.


I’m getting vibes most prefer to not rename it. This is ok, the name isn’t that bad, but if it’s going to be renamed, I think now would be the right time.

@wooorm
Copy link
Member

wooorm commented Dec 19, 2021

/cc @stefanprobst @drewbourne

@wooorm
Copy link
Member

wooorm commented Dec 21, 2021

The plan was to deprecate mrmlncs one in favor of our new package: #44 (comment).

@remcohaszing
Copy link
Member Author

Since this is really minor and I’m sensing more pushback than support for this, I’ll close this issue.

@drewbourne
Copy link

@wooorm is there a request here for me to unpublish the drewbourne.vscode-remark-lint extension?

I haven't tested or used the extension in a few years due to some rough edges with loading/reloading the configs for remark, retext and custom dictionaries. I do think there is value in enabling some of the fixable / autocomplete features from remark & retext in a VS Code extension.

@remcohaszing
Copy link
Member Author

@drewbourne

@wooorm is there a request here for me to unpublish the drewbourne.vscode-remark-lint extension?

I haven't tested or used the extension in a few years due to some rough edges with loading/reloading the configs for remark, retext and custom dictionaries. I do think there is value in enabling some of the fixable / autocomplete features from remark & retext in a VS Code extension.

#65 introduces feature parity with your extension and more (including loading of ESM configurations 😄 ). I suggest you unpublish drewbourne.vscode-remark-lint after those changes have been published. However, until then I think your extension is the best option out there for people willing to use older (CJS) versions of remark plugins. So I recommend to wait for that.

@wooorm
Copy link
Member

wooorm commented Jan 8, 2022

It was firstly a friendly ping to share some info!

But I think so. As Remco comments, this updated package is much improved and does what your extension does (and much more).
I’m not sure what the best way is to deprecate a package and suggest an alternative though.
Perhaps publish an empty package with just a readme pointing to this project?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

5 participants