{"_id":"@asaperski/eslint-plugin-fast-fluentui-tsdoc-rules","_rev":"2-cb11079757cc380be1d8d80f12cbb796","name":"@asaperski/eslint-plugin-fast-fluentui-tsdoc-rules","dist-tags":{"latest":"0.5.1"},"versions":{"0.4.0":{"name":"@asaperski/eslint-plugin-fast-fluentui-tsdoc-rules","version":"0.4.0","description":"eslint rules for TSDoc comments validation in FAST/Fluent UI","author":{"name":"Andrei Saperski","email":"andrei@saperski.net"},"license":"MIT","main":"index.js","repository":{"type":"git","url":"git+https://github.com/andreisaperski/eslint-plugin-fast-fluentui-tsdoc-rules.git"},"homepage":"https://github.com/andreisaperski/eslint-plugin-fast-fluentui-tsdoc-rules","bugs":{"url":"https://github.com/andreisaperski/eslint-plugin-fast-fluentui-tsdoc-rules/issues"},"keywords":["eslint","typescript","lint","rules"],"scripts":{"test":"jest","build":"tsc && tsc-alias && yarn copy-files","copy-files":"copyfiles package.json dist/"},"devDependencies":{"@types/jest":"^29.5.2","@types/node":"16.18.1","copyfiles":"^2.4.1","eslint":"7.25.0","jest":"^29.5.0","ts-jest":"^29.1.1","ts-node":"^10.9.1","ts-node-dev":"^2.0.0","tsc-alias":"^1.8.7","typescript":"4.7.4"},"peerDependencies":{"@typescript-eslint/eslint-plugin":">= 4.22 < 5.0.0","@typescript-eslint/experimental-utils":">= 4.22 < 5.0.0","@typescript-eslint/parser":">= 4.22 < 5.0.0","eslint":"^6.0.0 || ^7.0.0 || ^8.0.0"},"dependencies":{"@typescript-eslint/eslint-plugin":"^4.22.0","@typescript-eslint/experimental-utils":"^4.22.0","@typescript-eslint/parser":"^4.22.0"},"gitHead":"3bd1c43e80caa52c5e7db6609d852289938ca497","_id":"@asaperski/eslint-plugin-fast-fluentui-tsdoc-rules@0.4.0","_nodeVersion":"16.20.0","_npmVersion":"8.19.4","dist":{"integrity":"sha512-d0jEBJOtSI4f641xzBLlI2YUai7Zn8ktE3wBFbtHgZoenSQsxd4DW564+QTS7Ds8UO6xfoLY9sF+yvU2ansKWg==","shasum":"c8d1397c033db41cd629167de96701f957d95a99","tarball":"https://registry.npmjs.org/@asaperski/eslint-plugin-fast-fluentui-tsdoc-rules/-/eslint-plugin-fast-fluentui-tsdoc-rules-0.4.0.tgz","fileCount":14,"unpackedSize":42964,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEITje3W/X+950cckc3wq32O6TKa43xZ0vrMPcUxkPtcAiEA86w2RaOxtwSjnUYfaEAdywd7HS1aQWSu6oL9zfM6kOQ="}]},"_npmUser":{"name":"asaperski","email":"andrei@saperski.net"},"directories":{},"maintainers":[{"name":"asaperski","email":"andrei@saperski.net"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/eslint-plugin-fast-fluentui-tsdoc-rules_0.4.0_1689866888696_0.7076430946239844"},"_hasShrinkwrap":false},"0.5.0":{"name":"@asaperski/eslint-plugin-fast-fluentui-tsdoc-rules","version":"0.5.0","description":"eslint rules for TSDoc comments validation in FAST/Fluent UI","author":{"name":"Andrei Saperski","email":"andrei@saperski.net"},"license":"MIT","main":"index.js","repository":{"type":"git","url":"git+https://github.com/andreisaperski/eslint-plugin-fast-fluentui-tsdoc-rules.git"},"homepage":"https://github.com/andreisaperski/eslint-plugin-fast-fluentui-tsdoc-rules","bugs":{"url":"https://github.com/andreisaperski/eslint-plugin-fast-fluentui-tsdoc-rules/issues"},"keywords":["eslint","typescript","lint","rules"],"scripts":{"test":"jest","build":"tsc && tsc-alias && yarn copy-files","copy-files":"copyfiles package.json dist/"},"devDependencies":{"@types/jest":"^29.5.2","@types/node":"16.18.1","copyfiles":"^2.4.1","eslint":"7.25.0","jest":"^29.5.0","ts-jest":"^29.1.1","ts-node":"^10.9.1","ts-node-dev":"^2.0.0","tsc-alias":"^1.8.7","typescript":"4.7.4"},"peerDependencies":{"@typescript-eslint/eslint-plugin":">= 5.0.0","@typescript-eslint/parser":">= 5.0.0","eslint":"^6.0.0 || ^7.0.0 || ^8.0.0"},"dependencies":{"@typescript-eslint/eslint-plugin":"^5.60.1","@typescript-eslint/parser":"^5.60.1"},"gitHead":"f8f4d58c7355dda5cc271905ff3e45ed5bdaf1c0","_id":"@asaperski/eslint-plugin-fast-fluentui-tsdoc-rules@0.5.0","_nodeVersion":"16.20.0","_npmVersion":"8.19.4","dist":{"integrity":"sha512-oopFqfWV0HgLgjNXjtjxy0CuIs29n+fwX8ZWUnvp8EHHZ5lxdVK5JDVJna0EECyNsFwRwQfig3ZyGT5wEQyeEg==","shasum":"86a725dc6e6e9790ba2721fc35b072c46ca28ede","tarball":"https://registry.npmjs.org/@asaperski/eslint-plugin-fast-fluentui-tsdoc-rules/-/eslint-plugin-fast-fluentui-tsdoc-rules-0.5.0.tgz","fileCount":13,"unpackedSize":41941,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCICKp3uQEqK1tGwYCq7XtUmynwNYWIo6KvjMKNKnt8I8nAiEA+DZKx09jPl2Q0h4RtHt148xsofKeMVlabdLuFI8Igys="}]},"_npmUser":{"name":"asaperski","email":"andrei@saperski.net"},"directories":{},"maintainers":[{"name":"asaperski","email":"andrei@saperski.net"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/eslint-plugin-fast-fluentui-tsdoc-rules_0.5.0_1689868480209_0.9942270215067586"},"_hasShrinkwrap":false},"0.5.1":{"name":"@asaperski/eslint-plugin-fast-fluentui-tsdoc-rules","version":"0.5.1","description":"eslint rules for TSDoc comments validation in FAST/Fluent UI","author":{"name":"Andrei Saperski","email":"andrei@saperski.net"},"license":"MIT","main":"index.js","repository":{"type":"git","url":"git+https://github.com/andreisaperski/eslint-plugin-fast-fluentui-tsdoc-rules.git"},"homepage":"https://github.com/andreisaperski/eslint-plugin-fast-fluentui-tsdoc-rules","bugs":{"url":"https://github.com/andreisaperski/eslint-plugin-fast-fluentui-tsdoc-rules/issues"},"keywords":["eslint","typescript","lint","rules"],"scripts":{"test":"jest","build":"tsc && tsc-alias && yarn copy-files","copy-files":"copyfiles package.json dist/"},"devDependencies":{"@types/jest":"^29.5.2","@types/node":"16.18.1","copyfiles":"^2.4.1","eslint":"7.25.0","jest":"^29.5.0","ts-jest":"^29.1.1","ts-node":"^10.9.1","ts-node-dev":"^2.0.0","tsc-alias":"^1.8.7","typescript":"4.7.4"},"peerDependencies":{"@typescript-eslint/eslint-plugin":">= 5.0.0","@typescript-eslint/parser":">= 5.0.0","eslint":"^6.0.0 || ^7.0.0 || ^8.0.0"},"dependencies":{"@typescript-eslint/eslint-plugin":"^5.60.1","@typescript-eslint/parser":"^5.60.1"},"gitHead":"f8f4d58c7355dda5cc271905ff3e45ed5bdaf1c0","_id":"@asaperski/eslint-plugin-fast-fluentui-tsdoc-rules@0.5.1","_nodeVersion":"16.20.0","_npmVersion":"8.19.4","dist":{"integrity":"sha512-YPLT3R47xOFja2uDCHcVapcGKnYVoTDjHUW486ZlJY2cY7tJ7EHmm5jCUtEZxgvnA5aIwB8hakCbd+qX1Bnzfg==","shasum":"fd1c76f2b719453b12b38879d0d590454aa0d714","tarball":"https://registry.npmjs.org/@asaperski/eslint-plugin-fast-fluentui-tsdoc-rules/-/eslint-plugin-fast-fluentui-tsdoc-rules-0.5.1.tgz","fileCount":14,"unpackedSize":46364,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCjf7egZaY22jyIPWvf4VF7JjFBTraRp2r7WjnQZS998wIgV9KxCZxaMIB6CQ+TC4YSFlK29vQlr4pjsmYcEcZ6EkA="}]},"_npmUser":{"name":"asaperski","email":"andrei@saperski.net"},"directories":{},"maintainers":[{"name":"asaperski","email":"andrei@saperski.net"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/eslint-plugin-fast-fluentui-tsdoc-rules_0.5.1_1689868679280_0.08067984685297946"},"_hasShrinkwrap":false}},"time":{"created":"2023-07-20T15:28:08.538Z","0.4.0":"2023-07-20T15:28:08.877Z","modified":"2023-07-20T15:57:59.673Z","0.5.0":"2023-07-20T15:54:40.356Z","0.5.1":"2023-07-20T15:57:59.519Z"},"maintainers":[{"name":"asaperski","email":"andrei@saperski.net"}],"description":"eslint rules for TSDoc comments validation in FAST/Fluent UI","homepage":"https://github.com/andreisaperski/eslint-plugin-fast-fluentui-tsdoc-rules","keywords":["eslint","typescript","lint","rules"],"repository":{"type":"git","url":"git+https://github.com/andreisaperski/eslint-plugin-fast-fluentui-tsdoc-rules.git"},"author":{"name":"Andrei Saperski","email":"andrei@saperski.net"},"bugs":{"url":"https://github.com/andreisaperski/eslint-plugin-fast-fluentui-tsdoc-rules/issues"},"license":"MIT","readme":"#eslint-plugin-fast-fluentui-tsdoc-rules\r\n\r\neslint rules for TSDoc comments validation in [FAST](https://github.com/microsoft/fast) and [Fluent UI](https://github.com/microsoft/fluentui/tree/web-components-v3/packages/web-components) Web Components packages.\r\n\r\n## Install\r\n\r\n### Fluent UI\r\n\r\n    yarn add @asaperski/eslint-plugin-fast-fluentui-tsdoc-rules@0.4 --dev\r\n\r\n### FAST\r\n\r\n    yarn add @asaperski/eslint-plugin-fast-fluentui-tsdoc-rules --dev\r\n\r\n## Example Configuration\r\n\r\nAdd to your `.eslintrc`:\r\n\r\n``` js\r\n{\r\n    \"plugins\": [\"fast-fluentui-tsdoc-rules\"],\r\n    \"rules\": {\r\n        // other rules...\r\n        \"@asaperski/fast-fluentui-tsdoc-rules/tsdoc-html-element\": \"warn\",\r\n        \"@asaperski/fast-fluentui-tsdoc-rules/tsdoc-html-attribute\": \"warn\"\r\n    }\r\n}\r\n```\r\n\r\n## Rules\r\n\r\n### tsdoc-html-element\r\n\r\n> Detects missing, incorrectly formatted TSDoc comments which describe HTML element\r\n\r\n```js\r\nimport { FluentDesignSystem } from '../fluent-design-system.js';\r\nimport { Component } from './component.js';\r\nimport { styles } from './component.styles.js';\r\nimport { template } from './component.template.js';\r\n\r\nexport const definition = Component.compose({\r\n  name: `${FluentDesignSystem.prefix}-component`,\r\n  template,\r\n  styles,\r\n});\r\n```\r\n\r\nProduces the following output:\r\n\r\n     6:1  warning  TSDoc comment is missing. Should specify HTML element name in description of @remarks tag  fast-fluentui-tsdoc-rules/tsdoc-html-element\r\n\r\n```js\r\nimport { FluentDesignSystem } from '../fluent-design-system.js';\r\nimport { Component } from './component.js';\r\nimport { styles } from './component.styles.js';\r\nimport { template } from './component.template.js';\r\n\r\n/**\r\n * @remarks\r\n * HTML Element: \\<fluent-other-component\\>\r\n */\r\nexport const definition = Component.compose({\r\n  name: `${FluentDesignSystem.prefix}-component`,\r\n  template,\r\n  styles,\r\n});\r\n```\r\n\r\nProduces the following output:\r\n\r\n     10:1  warning  Wrong HTML element name is specified in @remarks tag, expected: \\<fluent-component\\>  fast-fluentui-tsdoc-rules/tsdoc-html-element\r\n\r\n```js\r\nimport { FluentDesignSystem } from '../fluent-design-system.js';\r\nimport { Component } from './component.js';\r\nimport { styles } from './component.styles.js';\r\nimport { template } from './component.template.js';\r\n\r\n/**\r\n * @remarks\r\n * HTMLElement: \\<fluent-component\\>\r\n */\r\nexport const definition = Component.compose({\r\n  name: `${FluentDesignSystem.prefix}-component`,\r\n  template,\r\n  styles,\r\n});\r\n```\r\n\r\nProduces the following output:\r\n\r\n     10:1  warning  Invalid HTML element name descripion, expected: HTML Element: \\<fluent-component\\>  fast-fluentui-tsdoc-rules/tsdoc-html-element\r\n\r\n\r\n### tsdoc-html-attribute\r\n\r\n> Detects missing, incorrectly formatted TSDoc comments which describe attribute of HTML element\r\n\r\n```js\r\nimport { attr, FASTElement } from \"@microsoft/fast-element\";\r\n\r\nexport class FASTTab extends FASTElement {\r\n    @attr\r\n    public disabled: boolean;\r\n}\r\n```\r\n\r\nProduces the following output:\r\n\r\n     4:5  warning  TSDoc comment is missing. Should specify HTML attribute name in description of @remarks tag  fast-fluentui-tsdoc-rules/tsdoc-html-attribute\r\n\r\n```js\r\nimport { attr, FASTElement } from \"@microsoft/fast-element\";\r\n\r\nexport class FASTTab extends FASTElement {\r\n    /**\r\n     * @remarks\r\n     * HTML Attribute: enabled\r\n     */\r\n    @attr\r\n    public disabled: boolean;\r\n}\r\n```\r\n\r\nProduces the following output:\r\n\r\n     8:5  warning  Wrong HTML attribute name is specified in @remarks tag, expected: disabled  fast-fluentui-tsdoc-rules/tsdoc-html-attribute\r\n\r\n```js\r\nimport { attr, FASTElement } from \"@microsoft/fast-element\";\r\n\r\nexport class FASTTab extends FASTElement {\r\n    /**\r\n     * @remarks\r\n     * HTML Attribute: disabled\r\n     */\r\n    @attr({attribute: \"data-disabled\"})\r\n    public disabled: boolean;\r\n}\r\n```\r\n\r\nProduces the following output:\r\n\r\n     8:5  warning  Wrong HTML attribute name is specified in @remarks tag, expected: data-disabled  fast-fluentui-tsdoc-rules/tsdoc-html-attribute\r\n\r\n```js\r\nimport { attr, FASTElement } from \"@microsoft/fast-element\";\r\n\r\nexport class FASTTab extends FASTElement {\r\n    /**\r\n     * @remarks\r\n     * HTML Attr: disabled\r\n     */\r\n    @attr\r\n    public disabled: boolean;\r\n}\r\n```\r\n\r\nProduces the following output:\r\n\r\n     8:5  Invalid HTML attribute name descripion, expected: HTML Attribute: disabled  fast-fluentui-tsdoc-rules/tsdoc-html-attribute\r\n","readmeFilename":"README.md"}