@iamu-dev/iamu 0.6.0-beta.0 → 0.7.0-beta.0

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.
@@ -0,0 +1,11 @@
1
+ import { type DesignOptions } from "./design-output.js";
2
+ /**
3
+ * Print a design doc draft in iamu's layout, filled in from the code;
4
+ * with --out also write it there; with --decline record that the offer
5
+ * was declined instead.
6
+ */
7
+ export declare function designTemplate(opts: DesignOptions): Promise<void>;
8
+ /** Check a draft: errors and warnings, writing nothing. */
9
+ export declare function designDraftCheck(opts: DesignOptions): Promise<void>;
10
+ /** Write a draft as the project's design doc and record it. */
11
+ export declare function designAdopt(opts: DesignOptions): Promise<void>;
@@ -23,6 +23,14 @@ export interface DesignOptions {
23
23
  * the designer's earlier notes, so it cannot just confirm them.
24
24
  */
25
25
  blind?: boolean;
26
+ /** template, draft-check, adopt: the app the doc is for. */
27
+ dir?: string;
28
+ /** template: also write the draft to this file. */
29
+ out?: string;
30
+ /** template: record that the offer was declined. */
31
+ decline?: boolean;
32
+ /** adopt: where the doc goes (default: <dir>/DESIGN.md). */
33
+ to?: string;
26
34
  }
27
35
  /** JSON with --json, else the human output. */
28
36
  export declare const out: (opts: DesignOptions, value: unknown, human: () => void) => void;