-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
[docs] generate code paths for webpack raw-loader efficiency #27301
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
dca671c
[docs] wip - generate code paths for webpack raw-loader efficiency
cmpadden 44d084d
generate import mapping
cmpadden 1c398e3
wrap imports in function
cmpadden f10acb4
rename file
cmpadden 1b30d92
include in build step
cmpadden c2dcbc3
add generate on yarn start
cmpadden 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 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 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,71 @@ | ||
const fs = require('fs'); | ||
const path = require('path'); | ||
|
||
const DOCUMENTATION_DIRECTORY = 'docs'; | ||
const VALID_DOCUMENT_EXTENSIONS = ['.md', '.mdx']; | ||
const CODE_EXAMPLE_PATH_REGEX = /<CodeExample\s+[^>]*path=["']([^"']+)["'][^>]*>/g; | ||
|
||
/** | ||
* Returns a list of file paths for a given `dir`. | ||
*/ | ||
function getAllDocuments(dir) { | ||
let results = []; | ||
const list = fs.readdirSync(dir); | ||
|
||
list.forEach((file) => { | ||
file = path.join(dir, file); | ||
const stat = fs.statSync(file); | ||
if (stat && stat.isDirectory()) { | ||
results = results.concat(getAllDocuments(file)); // Recurse into subdirectory | ||
} else { | ||
if (VALID_DOCUMENT_EXTENSIONS.indexOf(path.extname(file)) !== -1) { | ||
results.push(file); // Add file to results | ||
} | ||
} | ||
}); | ||
|
||
return results; | ||
} | ||
|
||
/** | ||
* Extracts all `regex` group `1` matches found in a list of `files`. | ||
*/ | ||
function getUniqueRegexMatches(files, regex) { | ||
const matches = new Set(); | ||
|
||
files.forEach((file) => { | ||
const content = fs.readFileSync(file, 'utf-8'); | ||
let foundMatches; | ||
while ((foundMatches = regex.exec(content)) !== null) { | ||
matches.add(foundMatches[1]); // Extract group 1 | ||
} | ||
}); | ||
|
||
return Array.from(matches); | ||
} | ||
|
||
/** | ||
* Helper function to create a `raw-loader` import from a `path`. | ||
*/ | ||
function pathToImport(path) { | ||
return `import('!!raw-loader!/../../examples/${path}')`; | ||
} | ||
|
||
const files = getAllDocuments('docs'); | ||
|
||
const uniqueMatches = getUniqueRegexMatches(files, CODE_EXAMPLE_PATH_REGEX); | ||
|
||
const _module = ` | ||
/// THIS FILE IS AUTOMATICALLY GENERATED BY \`yarn generate-code-imports\` DO NOT MODIFY /// | ||
// | ||
export const CODE_EXAMPLE_PATH_MAPPINGS = \{ | ||
${uniqueMatches.map((path) => ` '${path}': () => ${pathToImport(path)},`).join('\n')} | ||
\}; | ||
|
||
/// THIS FILE IS AUTOMATICALLY GENERATED BY \`yarn generate-code-imports\` DO NOT MODIFY /// | ||
`; | ||
|
||
fs.writeFile('src/code-examples-content.js', _module, (err) => { | ||
if (err) throw err; | ||
console.log(`Succesfully generated mappings for ${uniqueMatches.length} references...`); | ||
}); |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do we also need to generate code imports before running
yarn start
?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah, I can add it there too! was a little worried about performance impact, but it would be a much better user experience.