-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
On @api
JSDoc tag
#1949
Comments
Found the progenitor commit adding the highlighting later adopted by VS Code: 31d2a5f My assumption was right. The commit description reads:
|
Happy to change to I had noticed The main documentation used to be generated on the The utility used to extract the JSDoc from the code did explicitly support |
I found other usage examples and opened jsdoc/jsdoc#2066. Excited to see where it leads, but not expecting quick reaction since there has not been much activity in the repo recently. |
I've just realized |
|
Unfortunately, it is indeed quite uncommon (only 10k results in GitHub Search).
The problem is that if you check out shadowspawn/commander.js@caf721c and then replace all I don't think we should keep using |
And by the way, the TypeScript team strongly advocates for having public declarations even for private class members. But again quite unfortunately, TypeScript does not have an accessibility modifier that would be matched by the JSDoc So if we follow the guidelines and add typings for all package-private stuff, nothing will stop library users from accessing it, and they will even see it suggested by IntelliSense. It really frustrates me that TypeScript is such a mess :( |
Oh, yes indeed. And to be fair, correct! I have been accessing some methods as "package" accessible rather than being strict. That raises the bar. Not sure whether I want to change anything. |
Just found out TypeScript recognizes |
I prefer sticking with JSDoc for the Javascript tags, so could use mixture of |
Released in Commander v12.0.0. |
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [commander](https://github.com/tj/commander.js) | dependencies | major | [`^11.1.0` -> `^12.0.0`](https://renovatebot.com/diffs/npm/commander/11.1.0/12.0.0) | --- ### Release Notes <details> <summary>tj/commander.js (commander)</summary> ### [`v12.0.0`](https://github.com/tj/commander.js/blob/HEAD/CHANGELOG.md#1200-2024-02-03) [Compare Source](tj/commander.js@v11.1.0...v12.0.0) ##### Added - `.addHelpOption()` as another way of configuring built-in help option (\[[#​2006](tj/commander.js#2006)]) - `.helpCommand()` for configuring built-in help command (\[[#​2087](tj/commander.js#2087)]) ##### Fixed - *Breaking:* use non-zero exit code when spawned executable subcommand terminates due to a signal (\[[#​2023](tj/commander.js#2023)]) - *Breaking:* check `passThroughOptions` constraints when using `.addCommand` and throw if parent command does not have `.enablePositionalOptions()` enabled (\[[#​1937](tj/commander.js#1937)]) ##### Changed - *Breaking:* Commander 12 requires Node.js v18 or higher (\[[#​2027](tj/commander.js#2027)]) - *Breaking:* throw an error if add an option with a flag which is already in use (\[[#​2055](tj/commander.js#2055)]) - *Breaking:* throw an error if add a command with name or alias which is already in use (\[[#​2059](tj/commander.js#2059)]) - *Breaking:* throw error when calling `.storeOptionsAsProperties()` after setting an option value (\[[#​1928](tj/commander.js#1928)]) - replace non-standard JSDoc of `@api private` with documented `@private` (\[[#​1949](tj/commander.js#1949)]) - `.addHelpCommand()` now takes a Command (passing string or boolean still works as before but deprecated) (\[[#​2087](tj/commander.js#2087)]) - refactor internal implementation of built-in help option (\[[#​2006](tj/commander.js#2006)]) - refactor internal implementation of built-in help command (\[[#​2087](tj/commander.js#2087)]) ##### Deprecated - `.addHelpCommand()` passing string or boolean (use `.helpCommand()` or pass a Command) (\[[#​2087](tj/commander.js#2087)]) ##### Removed - *Breaking:* removed default export of a global Command instance from CommonJS (use the named `program` export instead) (\[[#​2017](tj/commander.js#2017)]) ##### Migration Tips **global program** If you are using the [deprecated](./docs/deprecated.md#default-import-of-global-command-object) default import of the global Command object, you need to switch to using a named import (or create a new `Command`). ```js // const program = require('commander'); const { program } = require('commander'); ``` **option and command clashes** A couple of configuration problems now throw an error, which will pick up issues in existing programs: - adding an option which uses the same flag as a previous option - adding a command which uses the same name or alias as a previous command </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, 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 has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4wLjAiLCJ1cGRhdGVkSW5WZXIiOiIzNy4wLjAiLCJ0YXJnZXRCcmFuY2giOiJkZXZlbG9wIn0=--> Reviewed-on: https://gitea.vylpes.xyz/RabbitLabs/random-bunny/pulls/145 Reviewed-by: Vylpes <ethan@vylpes.com> Co-authored-by: Renovate Bot <renovate@vylpes.com> Co-committed-by: Renovate Bot <renovate@vylpes.com>
The
@api
JSDoc tag has been used in the library code since the initial commit. However, I have not been able to find any documentation on it. The fact its values are properly highlighted in VS Code is due to microsoft/vscode@9ad4bcd, which includes no explanation on why the highlighting was added. My best guess is that it was added just to cover de facto usage like that in Commander (see microsoft/vscode#189812).The well-documented alternatives to
@api private
(which is currently used throughout the library) are@private
and@access private
. Should we use one of them instead?The text was updated successfully, but these errors were encountered: