@lumpcode/cli-types 0.0.4 → 0.0.6
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.
- package/README.md +8 -6
- package/dist/index.d.ts +1 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
TypeScript types and small `defineX` identity helpers for authoring **Lumpcode** lump configuration (`config.js`) and command modules (`.lumpcode/commands/<name>.js`). Runtime is just identity functions; the value is purely the type hints.
|
|
4
4
|
|
|
5
|
-
> Use **alongside the Lumpcode CLI** for typed `config.js` and command modules.
|
|
5
|
+
> Use **alongside the Lumpcode CLI** for typed `config.js` and command modules. Install the CLI with `npm install -g @lumpcode/cli` (Node 22+).
|
|
6
6
|
|
|
7
7
|
## Install
|
|
8
8
|
|
|
@@ -20,7 +20,7 @@ import { defineConfig } from '@lumpcode/cli-types';
|
|
|
20
20
|
export default defineConfig({
|
|
21
21
|
baseBranch: 'main',
|
|
22
22
|
contextListJson: { FILE: 'src/{NAME}.ts' },
|
|
23
|
-
prompt: { promptTemplate: 'Fix @{FILE}', command: '
|
|
23
|
+
prompt: { promptTemplate: 'Fix @{FILE}', command: 'copilot' },
|
|
24
24
|
});
|
|
25
25
|
```
|
|
26
26
|
|
|
@@ -39,10 +39,12 @@ export const setup = defineCommandSetup(async () => ({}));
|
|
|
39
39
|
|
|
40
40
|
## What's exported
|
|
41
41
|
|
|
42
|
-
- **Config helpers
|
|
43
|
-
- **Command-module helpers
|
|
44
|
-
- **Types
|
|
42
|
+
- **Config helpers** — `defineConfig`, `defineStep`, hook `define*` helpers for lump `config.js`.
|
|
43
|
+
- **Command-module helpers** — `defineCommandModule`, `defineCommand`, `defineCommandSetup`, `defineCommandTeardown`.
|
|
44
|
+
- **Types** — lump config and command-module shapes, plus engine types re-exported from `@lumpcode/core`.
|
|
45
|
+
|
|
46
|
+
Full list: [types.md](../DOCS/types.md).
|
|
45
47
|
|
|
46
48
|
## Docs
|
|
47
49
|
|
|
48
|
-
Field reference and hook signatures live in the CLI docs — see [
|
|
50
|
+
Field reference and hook signatures live in the CLI docs — see [lump-config.md](../DOCS/lump-config.md) and [commands.md](../DOCS/commands.md).
|
package/dist/index.d.ts
CHANGED
|
@@ -61,6 +61,7 @@ type LumpJsConfig<V extends LumpVariables = LumpVariables> = MergeObjs<Omit<{
|
|
|
61
61
|
steps?: LumpJsConfigSteps;
|
|
62
62
|
registerCommands?: string[];
|
|
63
63
|
keepHistory?: boolean;
|
|
64
|
+
verbose?: boolean;
|
|
64
65
|
}>;
|
|
65
66
|
|
|
66
67
|
declare const defineConfig: <V extends LumpVariables = LumpVariables>(config: LumpJsConfig<V>) => LumpJsConfig<V>;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@lumpcode/cli-types",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.6",
|
|
4
4
|
"description": "Types and defineX helpers for Lumpcode CLI lump config and command modules",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"author": "",
|
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
"build": "rollup -c"
|
|
23
23
|
},
|
|
24
24
|
"dependencies": {
|
|
25
|
-
"@lumpcode/core": "^0.0.
|
|
25
|
+
"@lumpcode/core": "^0.0.6"
|
|
26
26
|
},
|
|
27
27
|
"devDependencies": {
|
|
28
28
|
"@rollup/plugin-commonjs": "^28.0.1",
|