Pete Gonzalez
Pete Gonzalez
@iclanton pointed out that the **my-package/dist/tsdoc-metadata.json** includes somewhat arbitrary assumptions about the folder structure. Instead, he suggested the following lookup rules: 1. If **package.json** contains a field such as `"tsdocMetadata":...
We recently published [an ESLint rule](https://www.npmjs.com/package/eslint-plugin-tsdoc) that validates TSDoc syntax. For example it can underline errors as you are authoring code in your editor. The ESLint plugin has similar requirements...
I also want to make it an array so you can use `extends` to "mixin" more than one family of custom tags. For example _"I want API Extractor's tags plus...
After discussing this some more, @iclanton and I realized that `tsdoc-config.json` and `tsdoc-metadata.json` have different requirements. `tsdoc-config.json` scenario: - Used by ESLint to understand the TSDoc dialect for .ts files...
We could also shorten the name from `tsdoc-config.json` to `tsdoc.json`.
😊 Vote for the filename here: https://twitter.com/octogonz_/status/1195793782534393856
We went with `tsdoc.json` since it seemed to be the clear winner in the poll. A config loader was published as [`@microsoft/tsdoc-config`](https://www.npmjs.com/package/@microsoft/tsdoc-config), and is now supported by the [eslint-plugin-tsdoc](https://www.npmjs.com/package/eslint-plugin-tsdoc) plugin...
I agree that `///` is a better design, if we were starting from a clean slate. For example, `///` comments can easily be embedded inside other `///` comments without any...
> Coming from Rust, the triple-slash syntax is used everywhere and I've come to appreciate it a lot more than the usual block-style comments. Is there a specific benefit, though,...
I realize that this proposal would also require separate fixes for each tool that supports TSDoc, since the TSDoc library itself does not find comments within a source file. That...