Added @internal Js comments to internal API functions #2484
Conversation
This file contains 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
nveenjain
force-pushed
the
enhancement/JSDocInternalRule
branch
4 times, most recently
from
3f851bb to
a7f5bc7
Compare
|
@nveenjain Please add ignoring of |
|
@nveenjain Also please ignore all files under |
nveenjain
force-pushed
the
enhancement/JSDocInternalRule
branch
2 times, most recently
from
e6ebbc6 to
b3b56b4
Compare
nveenjain
commented
Mar 13, 2020
| @@ -28,7 +28,9 @@ | |||
| "test:ci": "yarn check --integrity && npm run prettier:check && npm run lint -- --no-cache && npm run check && npm run testonly:cover && npm run check:ts && npm run check:spelling && npm run build", | |||
| "testonly": "mocha --full-trace src/**/__tests__/**/*-test.js", | |||
| "testonly:cover": "nyc npm run testonly", | |||
| "lint": "eslint --rulesdir './resources/eslint-rules' --rule 'no-dir-import: error' --cache --ext .js,.ts src resources", | |||
| "prelint": "node resources/generate-exported", | |||
| "lint": "eslint --rulesdir './resources/eslint-rules' --rule 'no-dir-import: error' --cache --ext .js,.ts src resources && eslint --rulesdir ./resources/eslint-rules/ --rule 'internal-func: 1' src --ignore-pattern 'src/jsutils/*' --ignore-pattern 'src/polyfills/*' --ignore-pattern 'src/**/__tests__/**' --ignore-pattern 'src/__tests__/*'", | |||
There was a problem hiding this comment.
@IvanGoncharov, I've ignored all the files under __tests__ by ignoring them in the when we invoke eslint itself ( using --ignore-pattern ). But the command itself turned out to be larger in length... Should i break the lint commands in two parts or does this work?
Created ESLint rule to check whether internal API functions are properly annotated or not Added support to get list of puvlic API functions (map.json created during linting) Signed-off-by: Naveen Jain <[email protected]>
nveenjain
force-pushed
the
enhancement/JSDocInternalRule
branch
from
b3b56b4 to
42fb05d
Compare
|
@IvanGoncharov , is there anything else that needs to be done apart from resolving conflicts? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #2183
Created ESLint rule to check whether internal API functions are properly annotated or not
Added support to get list of public API functions (map.json created during linting) to get the json file, remove the postlint step.
Signed-off-by: Naveen Jain [email protected]