Skip to content

Commit abc7408

Browse files
committed
updated docs again
1 parent 4ea1b87 commit abc7408

File tree

3 files changed

+14
-14
lines changed

3 files changed

+14
-14
lines changed

docs/tools/chorale.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,16 @@ Run the commands from the project root:
1515

1616
```bash
1717
# create chorale.yaml by scanning packages
18-
php bin/chorale setup
18+
chorale setup
1919

2020
# preview changes without modifying files
21-
php bin/chorale plan --json > plan.json
21+
chorale plan --json > plan.json
2222

2323
# apply an exported plan
24-
php bin/chorale apply --file plan.json
24+
chorale apply --file plan.json
2525

2626
# build and apply a plan in one go
27-
php bin/chorale run
27+
chorale run
2828
```
2929

3030
Chorale automatically merges all package `composer.json` files into the root `composer.json` so the monorepo can be installed as a single package. Any dependency conflicts are recorded under the `extra.chorale.dependency-conflicts` section for review.

docs/tools/chorale/mirroring.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Mirroring & Overrides
22

3+
See also: [Rule Matrix & Examples](rules-matrix.md) for side‑by‑side input→output transformations of each rule.
4+
35
Chorale can mirror and merge selected keys from the root `composer.json` into each package’s `composer.json`.
46
This is fully opt‑in and controlled through `chorale.yaml` rules and per‑package overrides.
57

@@ -79,4 +81,3 @@ targets:
7981

8082
- `plan --json` includes the exact `apply` object per package.
8183
- Root steps include `meta.delta_*` with counts for added/removed/changed.
82-

docs/tools/chorale/plan.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The `plan` command is an advanced dry‑run that inspects your monorepo and prin
1313
## Usage
1414

1515
```bash
16-
php tools/chorale/bin/chorale plan [<vendor/name>] [options]
16+
chorale plan [<vendor/name>] [options]
1717
```
1818

1919
- `<vendor/name>`: Optional composer package name to focus on a single package
@@ -34,25 +34,25 @@ php tools/chorale/bin/chorale plan [<vendor/name>] [options]
3434

3535
```bash
3636
# All packages, detailed output
37-
php tools/chorale/bin/chorale plan
37+
chorale plan
3838

3939
# Concise one‑liners
40-
php tools/chorale/bin/chorale plan --concise
40+
chorale plan --concise
4141

4242
# Show no‑ops too
43-
php tools/chorale/bin/chorale plan --show-all
43+
chorale plan --show-all
4444

4545
# JSON output for apply
46-
php tools/chorale/bin/chorale plan --json > plan.json
46+
chorale plan --json > plan.json
4747

4848
# Focus on one package by composer name
49-
php tools/chorale/bin/chorale plan sonsofphp/cache
49+
chorale plan sonsofphp/cache
5050

5151
# Focused + concise
52-
php tools/chorale/bin/chorale plan sonsofphp/cache --concise
52+
chorale plan sonsofphp/cache --concise
5353

5454
# Limit discovery to a folder (path)
55-
php tools/chorale/bin/chorale plan --paths src/SonsOfPHP/Component/Cache
55+
chorale plan --paths src/SonsOfPHP/Component/Cache
5656
```
5757

5858
## Output Breakdown
@@ -106,4 +106,3 @@ Example snippet (root update):
106106
- Use `--concise` for quick scans, and omit it to see exact JSON diffs.
107107
- Combine the positional `<vendor/name>` with `--json` to isolate and export a single package’s plan.
108108
- For CI checks, run with `--strict` so the command exits non‑zero when action is required.
109-

0 commit comments

Comments
 (0)