@polyrepo/polyrepo-manager
v1.2.5
Published
Scripts for managing polyrepo projects
Readme
Polyrepo manager.
The purpose of monorepos should be questioned. Monorepos are used because sharing a set of code across multiple projects makes it inconvenient to frequently update dependencies, so everything is put into one repository. However, this makes it difficult to edit packages across different enterprises and projects. Traditional polyrepos do not have this issue. This approach does not align with first principles. Instead, we should focus on better combining multiple polyrepos rather than putting them into a single repository. Having each package in its own repository enhances modularity and flexibility. By creating a CLI tool to manage multiple polyrepos.
This package is designed to solve these issues through its CLI tools.
Install
npm i -g ployrepo-managerMultiple polyrepo dir
Create several polyrepos in a directory, then create a poly.config.json file in the directory.
poly.config.json:
{
// add some example
"repos": [
"https://github.com/polyrepos/template-base",
"https://github.com/polyrepos/template-fullstack",
"https://github.com/your-username/your-project",
]
// github pr and set-secret need username
"github": {
"username": "polyrepos"
}
}Run poly clone to achieve the following directory structure:
template-base
├── .git
├── .husky
├── src
├── LICENSE
├── biome.json
├── tsconfig.json
├── package.json
template-fullstack
├── .git
├── src
├── package.json
your-project
├── .git
├── src
├── package.json
poly.config.jsoncopy
To copy certain files from template-base to your-project, edit the package.json of your-project.
package.json:
{
"polyCopy": {
// @polyrepo/template-base is the template-bun/package.json's name
"@polyrepo/template-base": [
"package.json.merge",
".github",
"LICENSE",
"biome.json",
".husky",
"tsconfig.json"
]
}
}If a file ends with .json.merge and the target file ends with .json, the contents will be merged. It is safe and will not overwrite existing fields.
Run the script to execute the copy:
poly copyCommand Descriptions
poly --help:
Usage: poly [options] [command]
The purpose of monorepos should be questioned. Monorepos are used because sharing a set of code across multiple projects makes it inconvenient to frequently update dependencies, so everything is put into
one repository. However, this makes it difficult to edit packages across different enterprises and projects. Traditional polyrepos do not have this issue. This approach does not align with first
principles. Instead, we should focus on better combining multiple polyrepos rather than putting them into a single repository. Having each package in its own repository enhances modularity and flexibility.
By creating a CLI tool to manage multiple polyrepos.
Options:
-V, --version output the version number
-h, --help display help for command
Commands:
copy The copy command is used to copy a file from a source path to a destination path
run [options] <args> In all workspace run command, options: --all, --changed, --unchanged, --filter, --unmatched
set-secret [options] <key> <value> Run all workspace set github secret, options: --all, --changed, --unchanged, --filter, --unmatched
pr [options] <event> <matchTitle> merge pr, like: poly pr squash 'chore(main): release', options: --all, --changed, --unchanged, --filter, --unmatched
update [options] Update all workspace dependencies version, options: --all, --changed, --unchanged, --filter, --unmatched, --npm
clone Clone all repos in workspace
prettier-package [options] prettier your package.json, options: --all, --changed, --unchanged, --filter, --unmatched
help [command] display help for commandExample:
poly run "git add . && git commit -m 'chore: change readme'" --changedpoly run "git pull --rebase" --unchangedpoly update --all --npmpoly prettier-package --all