Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docs/cli/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@ For the latest full list of supported options, see `CliOptions` [in this file](h

The options below apply to most CLI commands.

| Option | Alias | Default | Description |
| --------------- | ----- | ------------------------- | -------------------------------------------------------------------------------------------- |
| `--branch, -b` | `-b` | | target branch; see [config docs][1] for details |
| `--config-path` | `-c` | [cosmiconfig][2] defaults | custom beachball config path |
| `--no-fetch` | | | skip fetching from the remote |
| `--change-dir` | | `'change'` | name of the directory to store change files |
| `--scope` | | | only consider matching package paths (can be specified multiple times); see [config docs][3] |
| `--since` | | | only consider changes or change files since this git ref (branch name, commit SHA) |
| `--verbose` | | | prints additional information to the console |
| Option | Alias | Default | Description |
| -------------- | ----- | ------------------------- | -------------------------------------------------------------------------------------------- |
| `--branch, -b` | `-b` | | target branch; see [config docs][1] for details |
| `--config` | `-c` | [cosmiconfig][2] defaults | custom beachball config path (alias: `--config-path`) |
| `--no-fetch` | | | skip fetching from the remote |
| `--change-dir` | | `'change'` | name of the directory to store change files |
| `--scope` | | | only consider matching package paths (can be specified multiple times); see [config docs][3] |
| `--since` | | | only consider changes or change files since this git ref (branch name, commit SHA) |
| `--verbose` | | | prints additional information to the console |

[1]: ../overview/configuration#determining-the-target-branch-and-remote
[2]: https://www.npmjs.com/package/cosmiconfig
Expand Down
5 changes: 2 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -53,15 +53,15 @@
},
"dependencies": {
"@vercel/detect-agent": "^1.2.1",
"commander": "^10.0.1",
"cosmiconfig": "^9.0.0",
"execa": "^5.0.0",
"minimatch": "^3.0.4",
"p-graph": "^1.1.2",
"p-limit": "^3.0.2",
"prompts": "^2.4.2",
"semver": "^7.0.0",
"workspace-tools": "^0.41.0",
"yargs-parser": "^21.0.0"
"workspace-tools": "^0.41.0"
},
"devDependencies": {
"@jest/globals": "^29.0.0",
Expand All @@ -70,7 +70,6 @@
"@types/prompts": "^2.4.2",
"@types/semver": "^7.3.13",
"@types/tmp": "^0.2.3",
"@types/yargs-parser": "^21.0.0",
"@typescript-eslint/eslint-plugin": "^5.0.0",
"@typescript-eslint/parser": "^5.0.0",
"@typescript-eslint/utils": "^5.0.0",
Expand Down
2 changes: 1 addition & 1 deletion src/__e2e__/bump.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ describe('bump command', () => {
function getOptions(repoOptions?: Partial<RepoOptions>, cwd?: string) {
const parsedOptions = getParsedOptions({
cwd: cwd || repo?.rootPath || '',
argv: [],
argv: ['node', 'beachball', 'bump'],
testRepoOptions: { branch: defaultRemoteBranchName, fetch: false, ...repoOptions },
});
return { options: parsedOptions.options, parsedOptions };
Expand Down
2 changes: 1 addition & 1 deletion src/__e2e__/getChangedPackages.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ describe('getChangedPackages (basic)', () => {
function getChangedPackagesWrapper(options?: Partial<BeachballOptions>) {
const parsedOptions = getParsedOptions({
cwd: reusedRepo.rootPath,
argv: [],
argv: ['node', 'beachball', 'change'],
testRepoOptions: {
fetch: false,
branch: defaultRemoteBranchName,
Expand Down
2 changes: 1 addition & 1 deletion src/__e2e__/validate.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ describe('validate', () => {
function validateWrapper(validateOptions?: ValidateOptions) {
const parsedOptions = getParsedOptions({
cwd: repo!.rootPath,
argv: [],
argv: ['node', 'beachball', 'check'],
testRepoOptions: {
branch: defaultRemoteBranchName,
},
Expand Down
2 changes: 1 addition & 1 deletion src/__functional__/changefile/readChangeFiles.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ describe('readChangeFiles', () => {
expect(cwd).toBeTruthy();
const parsedOptions = getParsedOptions({
cwd: cwd!,
argv: [],
argv: ['node', 'beachball', 'change'],
testRepoOptions: { branch: defaultRemoteBranchName, ...repoOptions },
});
const packageInfos = getPackageInfos(parsedOptions);
Expand Down
2 changes: 1 addition & 1 deletion src/__functional__/changelog/writeChangelog.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ describe('writeChangelog', () => {
function getOptionsAndPackages(repoOptions?: Partial<RepoOptions>, cwd?: string) {
const parsedOptions = getParsedOptions({
cwd: cwd || repo?.rootPath || '',
argv: [],
argv: ['node', 'beachball', 'bump'],
testRepoOptions: { branch: defaultRemoteBranchName, ...repoOptions },
});
const packageInfos = getPackageInfos(parsedOptions);
Expand Down
Loading
Loading