-
Notifications
You must be signed in to change notification settings - Fork 1.3k
[eslint-plugin-azure-sdk] New rule to make sure TSdoc comments for private members don't use internal tags #18761
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
Merged
Merged
Changes from all commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
006d96a
worked on linter private member internal tag rule
hamsa-s 932c893
Merge remote-tracking branch 'upstream/main' into linter
hamsa-s fef3e95
fixed linter errors in packages and removed exportedSettings
hamsa-s 9c2c42a
Merge remote-tracking branch 'upstream/main' into linter
hamsa-s 3f9ce71
fixed formatting in files with linter errors
hamsa-s 3df2496
removed excluding code
hamsa-s 40950a7
removed interfaces and modules check
hamsa-s 83d5aec
Merge remote-tracking branch 'upstream/main' into linter
hamsa-s 134301f
checking for all syntax nodes with accessibility modifier
hamsa-s 4f0cb96
Merge remote-tracking branch 'upstream/main' into linter
hamsa-s 341e3b8
fixed sorted imports
hamsa-s fc27d94
Changed to warning
hamsa-s 22aafa7
style changes
hamsa-s 231b76b
Merge remote-tracking branch 'upstream/main' into linter
hamsa-s 70a40ca
fixed import sorting
hamsa-s 95536a7
Fixed package.json
hamsa-s File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
93 changes: 93 additions & 0 deletions
93
common/tools/eslint-plugin-azure-sdk/docs/rules/ts-doc-internal-private-member.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| # ts-doc-internal-private-member | ||
|
|
||
| Prevents the usage of the `@internal` tag in TSDoc comments for private members. | ||
|
|
||
| Internal objects are defined as classes, interfaces, or standalone functions that are not exported from the main entrypoint to the package and are not members of any exports from the main entrypoint (defined recursively). Because private members are already ignored by the docs generation tools, we do not need to use `@internal` in the TSDoc comments **Files that are specified as excluded in a `typedoc.json` file are ignored by this rule.** | ||
|
|
||
| ## Examples | ||
|
|
||
| ### Good | ||
|
|
||
| ```ts | ||
| /** | ||
| * Class documentation | ||
| */ | ||
| class ExampleClass { | ||
| private x = 0; | ||
| private y: number; | ||
|
|
||
| private [s: string]: boolean | ((s: string) => boolean); | ||
|
|
||
| /** | ||
| * Method documentation | ||
| */ | ||
| private testMethod(private x: number, private y: number) {} | ||
| } | ||
| ``` | ||
|
|
||
|
|
||
| ```ts | ||
| /** | ||
| * Class documentation | ||
| */ | ||
| class ExampleClass { | ||
| /** | ||
| * @internal | ||
| */ | ||
| x = 0; | ||
|
|
||
| /** | ||
| * @internal | ||
| */ | ||
| y: number; | ||
|
|
||
| /** | ||
| * @internal | ||
| */ | ||
| [s: string]: boolean | ((s: string) => boolean); | ||
|
|
||
| /** | ||
| * Method documentation | ||
| * @internal | ||
| */ | ||
| testMethod(private x: number, private y: number) {} | ||
| } | ||
| ``` | ||
|
|
||
| ### Bad | ||
|
|
||
| ```ts | ||
| /** | ||
| * Class documentation | ||
| */ | ||
| class ExampleClass { | ||
| /** | ||
| * @internal | ||
| */ | ||
| private x = 0; | ||
|
|
||
| /** | ||
| * @internal | ||
| */ | ||
| private y: number; | ||
|
|
||
| /** | ||
| * @internal | ||
| */ | ||
| private [s: string]: boolean | ((s: string) => boolean); | ||
|
|
||
| /** | ||
| * Method documentation | ||
| * @internal | ||
| */ | ||
| private testMethod(private x: number, private y: number) {} | ||
| } | ||
| ``` | ||
|
|
||
| ## When to turn off | ||
|
|
||
| If you are not using TypeDoc. | ||
|
|
||
| ## Source | ||
|
|
||
| Suggestion by [@deyaaeldeen](https://github.com/deyaaeldeen). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
78 changes: 78 additions & 0 deletions
78
common/tools/eslint-plugin-azure-sdk/src/rules/ts-doc-internal-private-member.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| // Copyright (c) Microsoft Corporation. | ||
| // Licensed under the MIT license. | ||
|
|
||
| /** | ||
| * @file Rule to check if a private class member is tagged with @internal | ||
| * @author Hamsa Shankar | ||
| */ | ||
|
|
||
| import { ParserServices, TSESTree } from "@typescript-eslint/experimental-utils"; | ||
| import { Node } from "estree"; | ||
| import { ParserWeakMapESTreeToTSNode } from "@typescript-eslint/typescript-estree/dist/parser-options"; | ||
| import { Rule } from "eslint"; | ||
| import { SyntaxKind } from "typescript"; | ||
| import { getRuleMetaData } from "../utils"; | ||
|
|
||
| //------------------------------------------------------------------------------ | ||
| // Rule Definition | ||
| //------------------------------------------------------------------------------ | ||
|
|
||
| /** | ||
| * Helper method for reporting on a node | ||
| * @param node the Node being operated on | ||
| * @param context the ESLint runtime context | ||
| * @param converter a converter from TSESTree Nodes to TSNodes | ||
| * @param typeChecker the TypeScript TypeChecker | ||
| * @throws if the Node passes throught the initial checks and has an internal tag | ||
| */ | ||
| const reportInternal = ( | ||
| node: Node, | ||
| context: Rule.RuleContext, | ||
| converter: ParserWeakMapESTreeToTSNode, | ||
| ): void => { | ||
| const tsNode = converter.get(node as TSESTree.Node); | ||
| const modifiers = tsNode.modifiers; | ||
|
|
||
| // if type is internal and has a TSDoc and is a private member | ||
| if ((tsNode as any).jsDoc !== undefined | ||
| && modifiers?.some((modifier) => modifier.kind === SyntaxKind.PrivateKeyword)) { | ||
| // fetch all tags | ||
| for (const comment of (tsNode as any).jsDoc) { | ||
| if (comment.tags !== undefined) { | ||
| for (const tag of comment.tags) { | ||
| if (tag.tagName.escapedText.match(/internal/)) { | ||
| context.report({ | ||
| node, | ||
| message: "private class members should not include an @internal tag" | ||
| }); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }; | ||
|
|
||
| export = { | ||
| meta: getRuleMetaData( | ||
| "ts-doc-internal-private-member", | ||
| "requires TSDoc comments to not include an '@internal' tag if the object is private" | ||
| ), | ||
| create: (context: Rule.RuleContext): Rule.RuleListener => { | ||
|
|
||
| const parserServices = context.parserServices as ParserServices; | ||
| if ( | ||
| parserServices.program === undefined || | ||
| parserServices.esTreeNodeToTSNodeMap === undefined | ||
| ) { | ||
| return {}; | ||
| } | ||
|
|
||
| const converter = parserServices.esTreeNodeToTSNodeMap; | ||
|
|
||
| return { | ||
| ":matches(ClassProperty, MethodDefinition, TSMethodSignature, TSPropertySignature, TSIndexSignature, TSParameterProperty)": ( | ||
| node: Node | ||
| ): void => reportInternal(node, context, converter) | ||
| }; | ||
| } | ||
| }; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
179 changes: 179 additions & 0 deletions
179
common/tools/eslint-plugin-azure-sdk/tests/rules/ts-doc-internal-private-member.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,179 @@ | ||
| // Copyright (c) Microsoft Corporation. | ||
| // Licensed under the MIT license. | ||
|
|
||
| /** | ||
| * @file Testing the ts-doc-internal-private-member rule. | ||
| * @author Hamsa Shankar | ||
| */ | ||
|
|
||
| import { RuleTester } from "eslint"; | ||
| import rule from "../../src/rules/ts-doc-internal-private-member"; | ||
|
|
||
| //------------------------------------------------------------------------------ | ||
| // Tests | ||
| //------------------------------------------------------------------------------ | ||
|
|
||
| const ruleTester = new RuleTester({ | ||
| parser: require.resolve("@typescript-eslint/parser"), | ||
| parserOptions: { | ||
| createDefaultProgram: true, | ||
| project: "./tsconfig.json" | ||
| } | ||
| }); | ||
|
|
||
| ruleTester.run("ts-doc-internal-private-member", rule, { | ||
| valid: [ | ||
| // all private | ||
| { | ||
| code: ` | ||
| /** | ||
| * Class documentation | ||
| */ | ||
| class ExampleClass { | ||
| /** | ||
| * Class Property | ||
| */ | ||
| private x = 0; | ||
|
|
||
| /** | ||
| * Property Signature | ||
| */ | ||
| private y: number; | ||
|
|
||
| /** | ||
| * Index signature | ||
| */ | ||
| private [s: string]: boolean | ((s: string) => boolean); | ||
|
|
||
| /** | ||
| * Parameter Property | ||
| */ | ||
| private testMethod(private x: number, private y: number) {} | ||
|
|
||
| /** | ||
| * Method Definition | ||
| */ | ||
| private get getter(): number { return 0 } | ||
|
|
||
| /** | ||
| * Method Signature | ||
| */ | ||
| private method1(): any; | ||
|
|
||
| }`, | ||
| filename: "src/test.ts" | ||
| }, | ||
| // all internal | ||
| { | ||
| code: ` | ||
| /** | ||
| * Class documentation | ||
| */ | ||
| class ExampleClass { | ||
| /** | ||
| * Class Property | ||
| * @internal | ||
| */ | ||
| x = 0; | ||
|
|
||
| /** | ||
| * Property Signature | ||
| * @internal | ||
| */ | ||
| y: number; | ||
|
|
||
| /** | ||
| * Index signature | ||
| * @internal | ||
| */ | ||
| [s: string]: boolean | ((s: string) => boolean); | ||
|
|
||
| /** | ||
| * Parameter Property | ||
| * @internal | ||
| */ | ||
| testMethod(private x: number, private y: number) {} | ||
|
|
||
| /** | ||
| * Method Definition | ||
| * @internal | ||
| */ | ||
| get getter(): number { return 0 } | ||
|
|
||
| /** | ||
| * Method Signature | ||
| * @internal | ||
| */ | ||
| method1(): any; | ||
| }`, | ||
| filename: "src/test.ts" | ||
| } | ||
| ], | ||
| invalid: [ | ||
| { | ||
| code: ` | ||
| /** | ||
| * Class documentation | ||
| */ | ||
| class ExampleClass { | ||
| /** | ||
| * Class Property | ||
| * @internal | ||
| */ | ||
| private x = 0; | ||
|
|
||
| /** | ||
| * Property Signature | ||
| * @internal | ||
| */ | ||
| private y: number; | ||
|
|
||
| /** | ||
| * Index signature | ||
| * @internal | ||
| */ | ||
| private [s: string]: boolean | ((s: string) => boolean); | ||
|
|
||
| /** | ||
| * Parameter Property | ||
| * @internal | ||
| */ | ||
| private testMethod(private x: number, private y: number) {} | ||
|
|
||
| /** | ||
| * Method Definition | ||
| * @internal | ||
| */ | ||
| private get getter(): number { return 0 } | ||
|
|
||
| /** | ||
| * Method Signature | ||
| * @internal | ||
| */ | ||
| private method1(): any; | ||
|
|
||
| }`, | ||
| filename: "src/test.ts", | ||
| errors: [ | ||
| { | ||
jeremymeng marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| message: "private class members should not include an @internal tag" | ||
| }, | ||
| { | ||
| message: "private class members should not include an @internal tag" | ||
| }, | ||
| { | ||
| message: "private class members should not include an @internal tag" | ||
| }, | ||
| { | ||
| message: "private class members should not include an @internal tag" | ||
| }, | ||
| { | ||
| message: "private class members should not include an @internal tag" | ||
| }, | ||
| { | ||
| message: "private class members should not include an @internal tag" | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| }); | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.