edwinhuish / better-comments-next

https://marketplace.visualstudio.com/items?itemName=EdwinHuiSH.better-comments-next
MIT License
33 stars 2 forks source link

Does not work with extensions using `setLanguageConfiguration` #11

Closed jonbarrow closed 5 months ago

jonbarrow commented 7 months ago

Using:

Just switched from the original extension since it was abandoned and didn't support protobufs either, and this one claims to work on "any language that your editor correctly recognizes". But this also does not work in protobuf files

Screenshot from 2024-02-04 14-48-01

edwinhuish commented 7 months ago

better-comments-next read the extensions language configuration json to know the comments formats of each language.

But I checked vscode-proto3 extension, it doesn't have configuration json in contributes.languages

You should find another extension.

jonbarrow commented 7 months ago

If that's the case you should make that more clear somewhere. Right now you're claiming that this extension supports

Any language that your editor correctly recognizes

Which is, evidently, false. This only supports languages which use configuration in the package.json, and only if it sets comments.lineComment and comments.blockComment (which also may not be set, even if using configuration in the package.json)

Saying this works with any language the editor recognizes, and then telling someone to just find another extension when a language doesn't work, doesn't seem like a great solution imo? My editor does recognize the language correctly, as the language extension uses vscode.languages.setLanguageConfiguration, so by this extensions claims it should be supported

If you actually wan't to support any language the editor recognizes, then these cases should also be handled. There is an open issue with VSC to add an official getLanguageConfiguration method, but for now this library seems to fill the need and provides a getLanguageConfiguration method

Otherwise if you have no intentions of handling these cases, you should probably update this extensions supported languages section to mention the actual cases a language is supported

edwinhuish commented 7 months ago

English not my native language, PR wellcome for any wrong doc.

I already check vscode-textmate-languageservice, it also reads the extension's language configuration JSON to get the configuration.

For the extension who only set configuration by setLanguageConfdiguration, but no language configuration JSON, it's no way to read the language's configuration.

Also, PR wellcome for better implement.

edwinhuish commented 7 months ago

Close for no more information

jonbarrow commented 7 months ago

I think closing this issue was the wrong call, especially since it was closed as "completed", as it hides pretty relevant information about how the extension works and it wasn't actually solved. I saw your reply about being open to PRs and I have been looking into possible solutions in my free time, but I'm a busy person

The issues brought up in this issue have not been resolved, regardless of the lack of activity on the issue, and closing it hides those issues from others who may be using similar extensions

Until something is actually decided I would recommend reopening this