Skip to content

docs: fix imported types not showing up in docs #667

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.

Sign up for GitHub

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
Brailor merged 2 commits into from
Aug 5, 2021
Merged

docs: fix imported types not showing up in docs #667

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
70118eb
docs: fix imported types not showing up in docs
Brailor Aug 3, 2021
962daf2
chore: add correct yarn.lock
Brailor Aug 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion packages/__docs__/buildScripts/utils/getReactDoc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ module.exports = function getReactDoc(source, fileName, error) {
reactDocgen.resolver.findAllExportedComponentDefinitions,
null,
{
filename: fileName
filename: fileName,
importer: reactDocgen.importers.makeFsImporter()
Copy link
Contributor Author

@Brailor Brailor Aug 3, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This new upcoming feature of react-docgen allows us to operate on imported types as well.

}
)
if (Array.isArray(doc)) {
Expand Down
2 changes: 1 addition & 1 deletion packages/__docs__/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@
"html-webpack-plugin": "^4",
"jsdoc-api": "^6.0.0",
"mkdirp": "^1",
"react-docgen": "^5",
"react-docgen": "^6.0.0-alpha.0",
Copy link
Contributor Author

@Brailor Brailor Aug 3, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This new importer feature is not fully released in production yet, but according to the maintainers of the repo v6 won't contain any breaking changes, so it seems like a safe thing for us to use the pre-release version of the lib.

Copy link
Contributor

@ke1k0 ke1k0 Aug 3, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The yarn.lock is missing, please add it :) I couldn't find any problems with it, the View props display correctly now, and it could recognise the "query" and "props" prop of Responsive as "object" (typeof this and that) too. Well, it cannot go deeper than one level, but that's why we need that type-linking ticket too :)

"svg-inline-loader": "^0.8.0",
"webpack-bundle-analyzer": "^4"
}
Expand Down
17 changes: 17 additions & 0 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19374,6 +19374,23 @@ react-docgen@^5, react-docgen@^5.0.0:
node-dir "^0.1.10"
strip-indent "^3.0.0"

react-docgen@^6.0.0-alpha.0:
version "6.0.0-alpha.0"
resolved "https://registry.npmjs.org/react-docgen/-/react-docgen-6.0.0-alpha.0.tgz#62bbedb63e5cf43e13957dc84cd9d7c3a4acb2ed"
integrity sha512-x04mIC8H6sLypv0bA87WW5hKmJXXM48aHaw5XD44LHcb+IqF3eL1Ev0YtXzxb7BXCoXV/WzpzCTuaqjUA39dyw==
dependencies:
"@babel/core" "^7.7.5"
"@babel/generator" "^7.12.11"
"@babel/runtime" "^7.7.6"
ast-types "^0.14.2"
commander "^2.19.0"
doctrine "^3.0.0"
estree-to-babel "^3.1.0"
neo-async "^2.6.1"
node-dir "^0.1.10"
resolve "^1.17.0"
strip-indent "^3.0.0"

react-dom@^17.0.0:
version "17.0.2"
resolved "https://registry.npmjs.org/react-dom/-/react-dom-17.0.2.tgz#ecffb6845e3ad8dbfcdc498f0d0a939736502c23"
Expand Down