fix: update to create packages folder when it doesn't already exist #1395
Conversation
jkmdev
requested review from
awentzel,
chrisdholt,
janechu and
nicholasrice
as code owners
![codeclimate[bot]](https://avatars.githubusercontent.com/in/9403?s=60&v=4){kind=small}
| */ | ||
| function createPackagesDir() { | ||
|
|
||
| if (!fs.existsSync(destDir)) { |
There was a problem hiding this comment.
Similar blocks of code found in 2 locations. Consider refactoring.
…if said folder doesn't exist
|
Code Climate has analyzed commit 3be6988 and detected 0 issues on this pull request. The test coverage on the diff in this pull request is 100.0% (50% is the threshold). This pull request will bring the total coverage in the repository to 88.3% (0.0% change). View more on Code Climate. |
There was a problem hiding this comment.
Thanks @jkmdev! This looks good, although I do think we should consider renaming the utility currently named createDirectory
| * Utility function that creates new folders | ||
| * based off dir argument | ||
| */ | ||
| function createDirectory(dir) { |
There was a problem hiding this comment.
This is somewhat of a naming nit, but I think it may be helpful - perhaps we should consider renaming this function to something more along the lines of ensureDirectoryExists. This is really a function that checks to ensure a directory exists and if it doesn't, it creates it. I think naming it to better align with that will help clarify it's purpose when reading through the copy and create functions above.
There was a problem hiding this comment.
Oh! Yes that's a much clearer name, I'll make that change
There was a problem hiding this comment.
@jkmdev Looks like this was merged prior to you being able to push the change here - would you mind pushing a new PR to address the name change here?
There was a problem hiding this comment.
I think it's named appropriately. The assurance is included in the conditional creation.
awentzel
changed the title
Description
Fixes #1392
Makes it so that the
copy-package-readme.jsscript creates thedocs/en/packagesfolder if it doesn't exist, instead of generating an error.Motivation & context
Without this change running
npm run docs:buildornpm run docs:dry-runwould fail if thedocs/en/packagesfolder didn't exist.Issue type checklist
Is this a breaking change?
Process & policy checklist