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

[docs] It's not clear what languages or identifiers are supported on first look on README #53

Open
JounQin opened this issue Dec 25, 2023 · 4 comments
Labels
enhancement New feature or request

Comments

@JounQin
Copy link

JounQin commented Dec 25, 2023

It seems we have to expand a details section to check what languages are supported and we have to jump into the source codes to see what related identifiers are supported.

@Sec-ant
Copy link
Owner

Sec-ant commented Dec 25, 2023

👍 Yes but currently I'm afraid I don't have the sufficient energy to maintain a well organized document. And many of the default identifiers or APIs may still be prone to change. I'll have to manually keep them updated if they are hardcoded in the docs. If you have better suggestions I'm all ears ❤️.

And the main question that somewhat concerns me is that it seems there aren't many users are currently benefit from this package. I may get more motivated if I can gather more feedbacks from the real world users, and the Prettier team, if this plugin helps.

@JounQin
Copy link
Author

JounQin commented Dec 25, 2023

You can add a section with comments like <!-- languages and identifiers start --> + <!-- languages and identifiers end -->, and then use ts to generate that section automatically every time before releasing.

I can raise a PR for it.

@JounQin
Copy link
Author

JounQin commented Dec 25, 2023

And the main question that somewhat concerns me is that it seems there aren't many users are currently benefit from this package. I may get more motivated if I can gather more feedbacks from the real world users, and the Prettier team, if this plugin helps.

I was seeking if markdown is supported by this plugin, but I can't find out easily.

And I believe this plugin should be a standard and change to be an official prettier plugin.

cc @fisker and @sosukesuzuki

@Sec-ant
Copy link
Owner

Sec-ant commented Dec 25, 2023

I can raise a PR for it.

You're more than welcome ❤️

And I believe this plugin should be a standard and change to be an official prettier plugin.
cc @fisker and @sosukesuzuki

Thanks a lot for your voice~

@Sec-ant Sec-ant added the enhancement New feature or request label Dec 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants