[rush-lib] support users to provide their own assets file for init subspace #5134
Conversation
jzhang026
requested review from
iclanton,
octogonz,
apostolisms,
D4N14L and
dmichon-msft
as code owners
… a new subspace beside the default rush-init/assets folder
jzhang026
force-pushed
the
chore/support-users-to-provide-their-own-assets-file-for-init-subspace
branch
from
c2f952e to
a8edb30
Compare
...chore-support-users-to-provide-their-own-assets-file-for-init-subspace_2025-02-25-07-23.json
Outdated
Show resolved
Hide resolved
| /** | ||
| * the starting assets folder relative to rush.json location you want to use when init a subspace | ||
| */ | ||
| // "subspaceInitAssetsFolder": "", |
There was a problem hiding this comment.
In this design, it seems that a given monorepo can have at most one set of custom file templates to use with rush init-subspace. Therefore, why do we need to configure its location?
We could instead designate a standard location, e.g. common/config-templates/rush-init-subspace. Then everyone will know that is where to find it, without having to read subspaces.json to find the particular location for a particular repo.
There was a problem hiding this comment.
Got it, thanks! I’ll update it accordingly.
There was a problem hiding this comment.
Or maybe common/templates/config. We could eventually have other kinds of templates (project templates?)
| if (userDefinedAssetsFolder) { | ||
| // if user provided their own assets file for subspace initiation | ||
| // we just copy and overwrite the default files | ||
| await copyTemplateFileAsync(userDefinedAssetsFolder, destinationPath, true); |
There was a problem hiding this comment.
This approach seems like it will (1) try to copy a file that doesn't exist and (2) print a notice like Overwriting: .pnpmfile.js when really it is just overwriting its own file that it wrote on line 79.
Both issues could be avoided using FileSystem.existsAsync().
There was a problem hiding this comment.
Also, userDefinedAssetsFolder is the path of a directory. Shouldn't copyTemplateFileAsync() receive a file path?
Please fill out the How it was tested PR notes 😸
…their-own-assets-file-for-init-subspace_2025-02-25-07-23.json Co-authored-by: Pete Gonzalez <[email protected]>
Co-authored-by: Ian Clanton-Thuon <[email protected]>
jzhang026
force-pushed
the
chore/support-users-to-provide-their-own-assets-file-for-init-subspace
branch
from
5b78458 to
ccbaf8b
Compare
Summary
support users to provide their own assets file when init subspace beside using the default one provided by Rush Engine
Details
How it was tested
Impacted documentation
updated schema template of subspace as well