Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/benduran/turbo-tools
A collection of TurboRepo CLI tools to test, lint, build, version and publish packages in your Turborepo monorepo
https://github.com/benduran/turbo-tools
Last synced: about 1 month ago
JSON representation
A collection of TurboRepo CLI tools to test, lint, build, version and publish packages in your Turborepo monorepo
- Host: GitHub
- URL: https://github.com/benduran/turbo-tools
- Owner: benduran
- License: mpl-2.0
- Created: 2023-01-16T21:49:46.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-05T17:37:53.000Z (5 months ago)
- Last Synced: 2024-07-21T15:39:28.040Z (5 months ago)
- Language: JavaScript
- Size: 1.22 MB
- Stars: 7
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome - benduran/turbo-tools - A collection of TurboRepo CLI tools to test, lint, build, version and publish packages in your Turborepo monorepo (JavaScript)
README
# turbo-tools
A collection of TurboRepo CLI tools to test, lint, build, version and publish packages in your Turborepo monorepo.
[TurboRepo](https://turbo.build/), by itself, is fantastic, and you should definitely use it! However, there are a few extra commands that could be added to really make the TurboRepo experience perfect and fully-featured out of the box. This is where [Turbo Tools](https://github.com/benduran/turbo-tools) comes in!
Turbo Tools add the ability for you to perform version bumps of all your packages, as well as publishing of these packages. Turbo Tools can detect which packages have changed and only version bump and publish those, leaving the rest of your repository unchanged. You can also run the version and publish commands independently from each other, which is perfect if you're building internal applications for your company, but want each `git` change to have a real-world change to your application's version number.
## used by
## dependencies
**Turbo Tools supports `npm`, `yarn` and `pnpm`.**
You must have `turbo@>=1.9.9` declared in your `package.json` file.
---
## installation
**npm**
`npm install @better-builds/turbo-tools -D`
**yarn**
`yarn add @better-builds/turbo-tools -D`
**pnpm**
`pnpm add @better-builds/turbo-tools -D`
## usage
```bash
turbo-tools [command]
Commands:
turbo-tools version Skips publishing and just version bumps packages in your
monorepo
turbo-tools publish Publishes packages in a Turborepo-powered Monorepo, and
optionally uses whichever custom Publish command you may
need (if overwritten in turboTools.config.mjs)
turbo-tools run Pass-through to Turborepo's run command
turbo-tools init Initializes a sane default configuration of config files
to work with the turbo-tools
turbo-tools ls Lists all the packages in the monorepo, as detected
officially by NPM
Options:
--version Show version number [boolean]
--help Show help [boolean]
```
### `version` command
Used to version bump each package in your repository. `alpha` and `beta` releases are treated as special cases, and a unique `git sha` value is appended to the generated / bumped version number.
```bash
npx turbo-tools version --help
Options:
--version Show version number [boolean]
-p, --package Scope the version bump and / or publish operation to s
pecific packages. You can specify multiple by doing -p
-p -p [array]
-a, --all If true, dirties all monorepo packages and thus, force
s them all to be version bumped and published
[deprecated: Use --force instead] [boolean] [default: false]
--allowUncommitted If true, will allow the version operation to continue
when there are uncommitted files in the repo at versio
n bump time. This is usefull if you have some scripts
that need to run after version bumps are performed, bu
t potentially before you issue a git commit and subseq
uent npm publish operation. [boolean] [default: false]
-d, --dryRun If true, will perform all steps right up until publish
, and then output what would happen if publish were to
continue [boolean] [default: false]
--force If true, dirties all monorepo packages and thus, force
s them all to be version bumped and published
[boolean] [default: false]
--noChangelog If true, will not write CHANGELOG.md updates for each
package that has changed [boolean] [default: false]
--noCommit If true, will modify all required files but leave them
uncommitted after all operations have completed. This
will also prevent a git push from occurring
[boolean] [default: false]
--noFetchAll If true, will not fetch information from remote via "g
it fetch origin" [boolean] [default: false]
--noFetchTags If true, does not force fetch tags from origin. By def
ault, lets-version will do "git fetch origin --tags --
force" to ensure your branch if up-to-date with the ta
gs on origin [boolean] [default: false]
--noPush If true, will not push changes and tags to origin
[boolean] [default: false]
--updatePeer If true, will update any dependent "package.json#peerD
ependencies" fields [boolean] [default: false]
--updateOptional If true, will update any dependent "package.json#optio
nalDependencies" fields [boolean] [default: false]
--releaseAs Releases each changed package as this release type or
as an exact version. "major" "minor" "patch" "alpha" "
beta" or an exact semver version number are allowed.
[string]
--rollupChangelog If true, in addition to updating changelog files for a
ll packages that will be bumped, creates a "rollup" CH
ANGELOG.md at the root of the repo that contains an ag
gregate of changes [boolean] [default: false]
--uniqify If true, will append the git SHA at version bunp time
to the end of the version number (while maintaining va
lid semver) [boolean] [default: false]
--saveExact If true, saved dependencies will be configured with an
exact version rather than using npm's default semver
range operator [boolean] [default: false]
-y, --yes If true, bypasses any prompts
[boolean] [default: false]
--help Show help [boolean]
```
### `publish` command
Performs version bumping of your packages, and then attempts to publish said packages to whichever NPM registry you are using.
```bash
npx turbo-tools publish --help
Options:
--version Show version number [boolean]
-p, --package Scope the version bump and / or publish operation to s
pecific packages. You can specify multiple by doing -p
-p -p [array]
-a, --all If true, dirties all monorepo packages and thus, force
s them all to be version bumped and published
[deprecated: Use --force instead] [boolean] [default: false]
--allowUncommitted If true, will allow the version operation to continue
when there are uncommitted files in the repo at versio
n bump time. This is usefull if you have some scripts
that need to run after version bumps are performed, bu
t potentially before you issue a git commit and subseq
uent npm publish operation. [boolean] [default: false]
-d, --dryRun If true, will perform all steps right up until publish
, and then output what would happen if publish were to
continue [boolean] [default: false]
--force If true, dirties all monorepo packages and thus, force
s them all to be version bumped and published
[boolean] [default: false]
--noChangelog If true, will not write CHANGELOG.md updates for each
package that has changed [boolean] [default: false]
--noCommit If true, will modify all required files but leave them
uncommitted after all operations have completed. This
will also prevent a git push from occurring
[boolean] [default: false]
--noFetchAll If true, will not fetch information from remote via "g
it fetch origin" [boolean] [default: false]
--noFetchTags If true, does not force fetch tags from origin. By def
ault, lets-version will do "git fetch origin --tags --
force" to ensure your branch if up-to-date with the ta
gs on origin [boolean] [default: false]
--noPush If true, will not push changes and tags to origin
[boolean] [default: false]
--updatePeer If true, will update any dependent "package.json#peerD
ependencies" fields [boolean] [default: false]
--updateOptional If true, will update any dependent "package.json#optio
nalDependencies" fields [boolean] [default: false]
--releaseAs Releases each changed package as this release type or
as an exact version. "major" "minor" "patch" "alpha" "
beta" or an exact semver version number are allowed.
[string]
--rollupChangelog If true, in addition to updating changelog files for a
ll packages that will be bumped, creates a "rollup" CH
ANGELOG.md at the root of the repo that contains an ag
gregate of changes [boolean] [default: false]
--uniqify If true, will append the git SHA at version bunp time
to the end of the version number (while maintaining va
lid semver) [boolean] [default: false]
--saveExact If true, saved dependencies will be configured with an
exact version rather than using npm's default semver
range operator [boolean] [default: false]
-y, --yes If true, bypasses any prompts
[boolean] [default: false]
--skipBuild If true, skips running the build command across all ch
anged repositories before attempting to publish
[boolean] [default: false]
--skipLint If true, skips running the lint command across all cha
nged repositories before attempting to publish
[boolean] [default: false]
--skipTest If true, skips running the test command across all cha
nged repositories before attempting to publish
[boolean] [default: false]
--help Show help [boolean]
```
### `run` command
This is a straight pass-through to `turbo run`, and accepts all the same values that [Turbo run does](https://turbo.build/repo/docs/reference/command-line-reference#turbo-run-task).
### `init` command
Set your repository up to use Turbo Repo with a set of sensible defaults (including generating a `turbo.json` file).
```bash
npx turbo-tools init --help
Options:
--version Show version number [boolean]
--help Show help [boolean]
-n, --noPublish If true, skips writing config files required for publishing
packages to NPM [boolean] [default: false]
-d, --noDeps If true, skips modifying your root package.json and
installing the missing dependencies required to power your
monorepo experience [boolean] [default: false]
```
### `ls` command
Lists all of the packages that have been detected by the tools and NPM's workspace feature
```bash
npx turbo-tools ls --help
Options:
--version Show version number [boolean]
--help Show help [boolean]
-j, --json If true, prints resulting monorepo package information as JSON.
If false, prints the path to each package instead.
[boolean] [default: false]
```
## customizing behaviors
There are many cases where you might want to use Turbo Tools at your enterprise software organization, and might not be publishing packages to the public NPM registry. As such, you can customize which publish command is used for your use case, override guards for publishing, or merge additional contents into `package.json` files when you initialize your repository to work with Turbo and Turbo Tools. These can all be customized by placing a `turboTools.config.mjs` (**Note the `.mjs` extension**) file at the root of your repository. To get typing and IDE assistance for this config, you can use the provided pass-through `defineConfig` function (see below). Not all of the options are required!
```javascript
import { defineTurboToolsConfig } from '@better-builds/turbo-tools';
export default defineTurboConfig({
init: {
// Will be called for every child package that exists in the monorepo when "init" is called.
// You can completely customize the contents and they will be merged in with Turbo Tools' defaults
addToPackageJson({ monorepoRoot, noDeps, noPublish, whichPackageManager }) {
return {
somethingCustom: new Date().toISOString(),
};
},
},
publish: {
// you can perform some async operation here if you'd like to check whether
// a publish should continue or not
async checkCanPublish({ dryRun, force, releaseAs, packagePath, publishTag, yes }) {
return true;
},
// if you need to use something other than "npm publish" for publishing your packages,
// you can construct the command and its arguments here and return them to have Turbo Tools
// call the command when publishing each package in the repository
getCommand({ dryRun, force, releaseAs, packageName, packagePath, publishTag, yes }) {
if (packageName === '@my-monorepo-package/some-package') {
return { args: [], cmd: 'package-specific-publish-command' };
}
const cmd = 'custom-publish-command';
const args = ['publish'];
if (releaseAs) args.push('--release-as', releaseAs);
if (dryRun) args.push('--dry-run');
if (publishTag) args.push('--tag', publishTag);
args.push('--no-commit', '--no-push', '--no-publish-confirm');
return { args, cmd };
},
},
version: {
// accepts all the same configuration options supported by the @better-builds/lets-version library.
// https://github.com/benduran/lets-version#advanced-configuration
changelog: {
},
},
});
```
## get started contributing
1. Clone this repo
2. Run `./repo-setup.sh`
3. Happy hacking! ⌨️