@contractspec/app.cli-databases 3.7.5 → 3.7.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +42 -16
  2. package/package.json +7 -5
package/README.md CHANGED
@@ -1,36 +1,62 @@
1
1
  # @contractspec/app.cli-databases
2
2
 
3
- Website: https://contractspec.io/
3
+ Website: https://contractspec.io
4
4
 
5
+ **CLI orchestrator for multi-database workflows. Coordinates operations across multiple database profiles defined in a project.**
5
6
 
6
- Orchestration CLI for managing database profiles and connection strategies.
7
+ ## What It Does
7
8
 
8
- ## Purpose
9
+ - Lightweight CLI with no workspace bundle dependencies.
10
+ - Uses minimist for argument parsing, execa for subprocess execution.
11
+ - Delegates per-database work to `cli-database`.
12
+ - Related ContractSpec packages include `@contractspec/tool.tsdown`, `@contractspec/tool.typescript`.
9
13
 
10
- To manage multi-database configurations (profiles) and orchestrate operations across them. Useful for environments with multiple database shards or distinct service databases.
14
+ ## Running Locally
11
15
 
12
- ## Installation
16
+ From `packages/apps/cli-databases`:
17
+ - `bun run dev`
18
+ - `bun run build`
19
+
20
+ ## Usage
13
21
 
14
22
  ```bash
15
- npm install @contractspec/app.cli-databases
23
+ npx databases --help
16
24
  # or
17
- bun add @contractspec/app.cli-databases
25
+ bunx databases --help
18
26
  ```
19
27
 
20
- ## Key Concepts
28
+ ## Architecture
21
29
 
22
- - **Profiles**: Define sets of database connection parameters.
23
- - **Orchestration**: Run commands against specific profiles or all defined databases.
30
+ - Lightweight CLI with no workspace bundle dependencies.
31
+ - Uses minimist for argument parsing, execa for subprocess execution.
32
+ - Delegates per-database work to `cli-database`.
33
+ - `src/cli.ts` is the CLI entrypoint.
34
+ - `src/index.ts` is the root public barrel and package entrypoint.
24
35
 
25
- ## Usage
36
+ ## Public Entry Points
26
37
 
27
- ### CLI
38
+ - Binary `databases` points to `dist/cli.js`.
39
+ - Export `.` resolves through `./dist/index.mjs`.
40
+ - Export `./cli` resolves through `./dist/cli.mjs`.
41
+ - Export `./profile` resolves through `./dist/profile.mjs`.
42
+ - Export `./*` resolves through `./*`.
28
43
 
29
- ```bash
30
- # Check help
31
- bun databases --help
32
- ```
44
+ ## Local Commands
45
+
46
+ - `bun run dev` — bun run build --watch
47
+ - `bun run build` — tsdown
48
+ - `bun run lint` — bun run lint:fix
49
+ - `bun run lint:check` — biome check .
50
+ - `bun run lint:fix` — biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .
51
+ - `bun run publish:pkg` — bun publish --tolerate-republish --ignore-scripts --verbose
52
+ - `bun run publish:pkg:canary` — bun publish:pkg --tag canary
53
+ - `bun run clean` — rm -rf dist
33
54
 
55
+ ## Recent Updates
34
56
 
57
+ - Replace eslint+prettier by biomejs to optimize speed.
35
58
 
59
+ ## Notes
36
60
 
61
+ - Keep this as a thin orchestrator — business logic belongs in `cli-database`.
62
+ - Do not change CLI argument signatures without updating docs and CI scripts.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@contractspec/app.cli-databases",
3
- "version": "3.7.5",
3
+ "version": "3.7.8",
4
4
  "type": "module",
5
5
  "bin": {
6
6
  "databases": "dist/cli.js"
@@ -11,16 +11,18 @@
11
11
  "publish:pkg:canary": "bun publish:pkg --tag canary",
12
12
  "build": "tsdown",
13
13
  "dev": "bun run build --watch",
14
- "lint": "eslint src --fix"
14
+ "lint": "bun run lint:fix",
15
+ "lint:fix": "biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .",
16
+ "lint:check": "biome check ."
15
17
  },
16
18
  "dependencies": {
17
19
  "minimist": "^1.2.8",
18
20
  "execa": "^9.6.1"
19
21
  },
20
22
  "devDependencies": {
21
- "@contractspec/tool.typescript": "3.7.5",
22
- "@contractspec/tool.tsdown": "3.7.5",
23
- "tsdown": "^0.21.0"
23
+ "@contractspec/tool.typescript": "3.7.8",
24
+ "@contractspec/tool.tsdown": "3.7.8",
25
+ "tsdown": "^0.21.4"
24
26
  },
25
27
  "types": "./dist/index.d.mts",
26
28
  "files": [