[core] Update buildApi script to support new structure
#30245
Merged
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
…docs/restructure
This reverts commit fe374cb.
…docs/update-scripts
siriwatknp
commented
Dec 17, 2021
| "docs:api": "rimraf ./docs/pages/api-docs && yarn docs:api:build", | ||
| "docs:api:build": "cross-env BABEL_ENV=development __NEXT_EXPORT_TRAILING_SLASH=true babel-node --extensions \".tsx,.ts,.js\" ./docs/scripts/buildApi.ts ./docs/pages/api-docs ./packages/mui-base/src ./packages/mui-material/src ./packages/mui-lab/src --apiPagesManifestPath ./docs/src/pagesApi.js", | ||
| "docs:api": "rimraf ./docs/pages/**/api-docs && yarn docs:api:build", | ||
| "docs:api:build": "cross-env BABEL_ENV=development __NEXT_EXPORT_TRAILING_SLASH=true babel-node --extensions \".tsx,.ts,.js\" ./docs/scripts/buildApi.ts", |
There was a problem hiding this comment.
The specified directories are moved inside the script. (I think it is easier to add comment inside the script file)
siriwatknp
commented
Dec 17, 2021
| @@ -12,8 +12,8 @@ | |||
| "release:publish": "lerna publish from-package --dist-tag latest --contents build", | |||
| "release:publish:dry-run": "lerna publish from-package --dist-tag latest --contents build --registry=\"http://localhost:4873/\"", | |||
| "release:tag": "node scripts/releaseTag", | |||
| "docs:api": "rimraf ./docs/pages/api-docs && yarn docs:api:build", | |||
| "docs:api:build": "cross-env BABEL_ENV=development __NEXT_EXPORT_TRAILING_SLASH=true babel-node --extensions \".tsx,.ts,.js\" ./docs/scripts/buildApi.ts ./docs/pages/api-docs ./packages/mui-base/src ./packages/mui-material/src ./packages/mui-lab/src --apiPagesManifestPath ./docs/src/pagesApi.js", | |||
| "docs:api": "rimraf ./docs/pages/**/api-docs && yarn docs:api:build", | |||
There was a problem hiding this comment.
add /**/ to support nested directories in the future.
eg. ./docs/pages/material/api-docs, ./docs/pages/base/api-docs, ...etc
siriwatknp
commented
Dec 17, 2021
Comment on lines
+345
to
+347
| `${reactComponentName}: Unable to handle node of type "ts.TypeFlags.${ | ||
| ts.TypeFlags[type.flags] | ||
| }", using any`, |
There was a problem hiding this comment.
Improve debuggability to see which file cause this warning.
mnajdova
approved these changes
Dec 21, 2021
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.
Update
buildApi.tsscript to support component API generation for both current & new structure (NO functionalities are added or deleted, just refactor the code and move most of the logic toComponentApiBuilder.tsbecause we will need other type of ApiBuilder soon eg, react-hook).As mentioned in #30091, there are 3 phases.
The script usage remains the same (
yarn docs:api), this PR is using the config that produce the same result as in master branch.Once the 1st phase is done, I will run the scripts to clone pages and then switch the config to this one