Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.Sign up
chore: add script for copying package readme files to docs/en/packages #1315
Adds a script to
Motivation & context
Incremental addition to #1312.
Issue type checklist
Is this a breaking change?
Process & policy checklist
I tried running this on my system (Windows) that has two folders already existing and it rewrote those which is great (though I did lose the header of the files in my case since I had templated out steps you have not yet gotten too so not a big deal)
But, the script didn't create any of the folders or files for all the other packages?
Is there special documentation notes we should add? How did you test? Should we add a parameter for
Error: ENOENT: no such file or directory, mkdir 'D:\projects\fast-dna\docs/en/packages\fast-breakpoint-tracker-react\README.md'
There was that error because I wrote this in Linux, my use of forward-slashes in some places made it so that the filepaths weren't recognized by Windows.
I made the fix and tested it in Windows, it should work now after running
To test I've just been running
awentzel left a comment •
Works great on Windows now including the
fs.js:909 return binding.mkdir(pathModule.toNamespacedPath(path), ^ Error: ENOENT: no such file or directory, mkdir '/Users/aaronw/aWork/Microsoft/Projects/FAST/fast-dna/docs\en\packages/fast-animation/README.md' at Object.fs.mkdirSync (fs.js:909:18) at files.forEach (/Users/aaronw/aWork/Microsoft/Projects/FAST/fast-dna/build/documentation/copy-package-readme.js:45:83) at Array.forEach (<anonymous>) at /Users/aaronw/aWork/Microsoft/Projects/FAST/fast-dna/build/documentation/copy-package-readme.js:41:15 at f (/Users/aaronw/aWork/Microsoft/Projects/FAST/fast-dna/node_modules/once/once.js:25:25) at Glob.<anonymous> (/Users/aaronw/aWork/Microsoft/Projects/FAST/fast-dna/node_modules/glob/glob.js:151:7) at Glob.emit (events.js:180:13) at Glob._finish (/Users/aaronw/aWork/Microsoft/Projects/FAST/fast-dna/node_modules/glob/glob.js:197:8) at next (/Users/aaronw/aWork/Microsoft/Projects/FAST/fast-dna/node_modules/glob/glob.js:216:12) at /Users/aaronw/aWork/Microsoft/Projects/FAST/fast-dna/node_modules/glob/glob.js:248:9