This repository was archived by the owner on Feb 1, 2024. It is now read-only.
Fixes #1
Open
Fixes #1
Conversation
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
w8r
commented
Mar 28, 2022
w8r
commented
Mar 28, 2022
.eslintrc
Outdated
| @@ -26,7 +26,7 @@ | |||
| "no-shadow": 0, | |||
| "no-undef": 2 | |||
| }, | |||
| "extends": ["eslint:recommended", "prettier"], | |||
| "extends": ["eslint:recommended", "airbnb-typescript-prettier"], | |||
There was a problem hiding this comment.
for this stuff, you can create another .eslintrc in the folder when you want to use these rules. Otherwise the PR will never be accepted upstream
w8r
commented
Mar 28, 2022
| @@ -1,3 +1,5 @@ | |||
| coverage | |||
| .nyc_output | |||
| /node_modules | |||
| docs/index.html | |||
There was a problem hiding this comment.
docs folder is used for the project documentation. Is there something like dist here?
w8r
commented
Mar 28, 2022
| @@ -0,0 +1,3 @@ | |||
| { | |||
There was a problem hiding this comment.
better not to commit in this PR
w8r
commented
Mar 28, 2022
| undocumentedMethod(): string; | ||
| } | ||
|
|
||
| export { Utils, I, Test }; |
w8r
commented
Mar 28, 2022
src/extractors/exported.js
Outdated
| traverse(ast, { | ||
| Statement(path) { | ||
| // https://stackoverflow.com/a/66294873 |
There was a problem hiding this comment.
can you add a comment about what happens if you don't do this trick?
w8r
commented
Mar 28, 2022
src/extractors/exported.js
Outdated
| @@ -125,17 +130,24 @@ export default function walkExported( | |||
| bindingPath = tmp.ast; | |||
| specData = tmp.data; | |||
| } else if (exportKind === 'value') { | |||
| bindingPath = path.scope.getBinding(local).path; | |||
| const binding = path.scope.getBinding(local); | |||
w8r
commented
Mar 28, 2022
| @@ -72,7 +72,8 @@ export default function inferProperties(comment) { | |||
| function inferProperties(value, prefix) { | |||
| if ( | |||
| value.type === 'ObjectTypeAnnotation' || | |||
| value.type === 'TSTypeLiteral' | |||
| value.type === 'TSTypeLiteral' || | |||
| value.type === 'TSInterfaceBody' | |||
w8r
commented
Mar 28, 2022
src/output/markdown_ast.js
Outdated
| @@ -36,7 +36,7 @@ function buildMarkdownAST(comments, config) { | |||
| comments, | |||
| namespace => { | |||
| const slugger = new GithubSlugger(); | |||
| return '#' + slugger.slug(namespace); | |||
| return `#${slugger.slug(namespace)}`; | |||
w8r
commented
Mar 28, 2022
src/output/util/format_type.js
Outdated
| } | ||
| return [t(node.key)]; | ||
|
|
||
| case Syntax.FunctionType: | ||
| result = [t('function (')]; | ||
|
|
||
| if (node['this']) { | ||
| if (node['new']) { | ||
| if (node.this) { |
There was a problem hiding this comment.
I would keep it they way they had it before, for clarity. Reserved words should be handled with care
w8r
commented
Mar 28, 2022
src/parse.js
Outdated
| * @param {string[]} tags tags to consider | ||
| * @returns description string | ||
| */ | ||
| function retreiveDescriptionNextToTags(rawComment, tags) { |
w8r
commented
Mar 29, 2022
| */ | ||
| function retreiveDescriptionNextToTags(rawComment, tags) { | ||
| // regex to retreive the whole description string (new lines included) | ||
| const descLines = new RegExp( |
There was a problem hiding this comment.
can it be just starts with * and ends either with */ or * @ (new tag start)?
There was a problem hiding this comment.
you are matching all the description lines from JSDoc, right?
/**
* @tag xxx
* <MATCHED_CONTENT>
* @other_tag
*/
w8r
commented
Mar 29, 2022
| @@ -660,7 +698,7 @@ export default function parseJSDoc(comment, loc, context) { | |||
| flatteners[tag.title](result, tag, tag.title); | |||
| } else { | |||
| result.errors.push({ | |||
| message: 'unknown tag @' + tag.title, | |||
| message: `unknown tag @${tag.title}`, | |||
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Hi @Ebernn , can you edit this PR to list the changes, please? It it the main branch where you are adding changes?
Changes