@g3nomaly/analyze 0.1.0 → 0.1.1

package/dist/scanner/tasks/layout.d.ts

@@ -4,32 +4,44 @@ export declare const TASKS_DIR = "tasks";
 export declare const DECISIONS_DIR = "decisions";
 /** File at the root of the tree that holds its terms. */
 export declare const VOCABULARY_FILE = "vocabulary.md";
-/** A phase of the tree as its files lay it out. */
+/**
+ * A phase of the tree as its files lay it out.
+ *
+ * @property name - Folder name of the phase.
+ * @property file - Tree-relative path of `<plan>/<phase>/<phase>.md`.
+ * @property tasks - Tree-relative paths of the task files, sorted by name.
+ */
 export interface PhaseFiles {
     readonly name: string;
-    /** Tree-relative path of `<plan>/<phase>/<phase>.md`. */
     readonly file: string;
-    /** Tree-relative paths of the task files, sorted by name. */
     readonly tasks: readonly string[];
 }
-/** A plan of the tree as its files lay it out. */
+/**
+ * A plan of the tree as its files lay it out.
+ *
+ * @property name - Folder name of the plan.
+ * @property file - Tree-relative path of `<plan>/<plan>.md`.
+ * @property phases - Sorted by folder name, which is the order task-manager queues them in.
+ * @property decisions - Tree-relative paths of the decision files, sorted by name.
+ */
 export interface PlanFiles {
     readonly name: string;
-    /** Tree-relative path of `<plan>/<plan>.md`. */
     readonly file: string;
-    /** Sorted by folder name, which is the order task-manager queues them in. */
     readonly phases: readonly PhaseFiles[];
-    /** Tree-relative paths of the decision files, sorted by name. */
     readonly decisions: readonly string[];
 }
-/** The task tree as its files lay it out. */
+/**
+ * The task tree as its files lay it out.
+ *
+ * @property plans - Plans in folder order.
+ * @property vocabulary - Tree-relative path of the vocabulary, or `null` when the tree has none.
+ */
 export interface TreeFiles {
     readonly plans: readonly PlanFiles[];
-    /** Tree-relative path of the vocabulary, or `null` when the tree has none. */
     readonly vocabulary: string | null;
 }
 /**
- * Sorts the files of a task tree into plans, phases, tasks and decisions by
+ * @brief Sorts the files of a task tree into plans, phases, tasks and decisions by
  * where they are: `<plan>/<plan>.md`, `<plan>/<phase>/<phase>.md`,
  * `<plan>/<phase>/tasks/<id>.md` and `<plan>/decisions/<id>.md`. Index files
  * and any other file are left out, since task-manager derives them.

package/dist/scanner/tasks/planner.d.ts

@@ -6,13 +6,16 @@ import type { GraphBuilder } from '../graph/builder';
 import type { ProseResolvers } from '../markdown/links';
 import type { MarkdownRenderer } from '../markdown/renderer';
 import type { Reporter } from '../reporter';
-/** The task tree of one scan: the files below its directory, with paths relative to the scanned root. */
+/**
+ * The task tree of one scan: the files below its directory, with paths relative to the scanned root.
+ *
+ * @property dir - Root-relative POSIX path of the tree, such as `docs/task-manager`.
+ */
 export interface TaskTreeSource extends Source {
-    /** Root-relative POSIX path of the tree, such as `docs/task-manager`. */
     readonly dir: string;
 }
 /**
- * Adds the tasks section to the graph from a task-manager tree: one `plan`
+ * @brief Adds the tasks section to the graph from a task-manager tree: one `plan`
  * page per plan, one `phase` page per phase, one `task` entry per task file,
  * a `decisions` page per plan with decision files, and the `vocabulary.md`
  * of the tree as a glossary. Created by `RepositoryScanner` for every scan.
@@ -38,6 +41,11 @@ export declare class TaskPlanner {
     /**
      * Creates a planner.
      *
+     * @param graph - Graph the tasks section is added to.
+     * @param files - Renders the markdown pages of plans and phases.
+     * @param markdown - Renders the bodies of tasks and decisions.
+     * @param resolvers - Resolves the links and inline code of each page.
+     * @param glossaries - Adds the vocabulary file as a glossary.
      * @param reporter - Receives a warning for every file that fails its schema and every `depends_on` that names nothing.
      */
     constructor(graph: GraphBuilder, files: FileRenderer, markdown: MarkdownRenderer, resolvers: ProseResolvers, glossaries: GlossaryPlanner, reporter: Reporter);
@@ -48,28 +56,75 @@ export declare class TaskPlanner {
      * @param trees - The task trees of the scan. Usually one, or none when the repository keeps no tasks.
      */
     plan(section: NodeRef, trees: readonly TaskTreeSource[]): Promise<void>;
-    /** Adds one plan with its phases and decisions. */
+    /**
+     * Adds one plan with its phases and decisions.
+     *
+     * @param section - Node of the tasks section the plan goes under.
+     * @param tree - Task tree the plan's files are read from.
+     * @param plan - Files of the plan, from `layoutTree`.
+     * @param targets - Nodes that `depends_on` names can point at, filled as nodes are added.
+     * @param pending - Dependencies to resolve once every node exists.
+     */
     private planPlan;
-    /** Adds one phase with its tasks. */
+    /**
+     * Adds one phase with its tasks.
+     *
+     * @param planRef - Node of the plan the phase belongs to.
+     * @param tree - Task tree the phase's files are read from.
+     * @param phase - Files of the phase, from `layoutTree`.
+     * @param phases - Phase nodes of this plan, by phase name.
+     * @param targets - Nodes that `depends_on` names can point at, filled as nodes are added.
+     * @param pending - Dependencies to resolve once every node exists.
+     */
     private planPhase;
-    /** Adds the decision log of a plan: one `decisions` page for its folder and one `decision` entry per file. */
+    /**
+     * Adds the decision log of a plan: one `decisions` page for its folder and one `decision` entry per file.
+     *
+     * @param planRef - Node of the plan the log belongs to.
+     * @param tree - Task tree the decision files are read from.
+     * @param plan - Files of the plan, from `layoutTree`.
+     * @param paths - Tree-relative paths of the decision files.
+     */
     private planDecisions;
     /**
      * Renders the page of a plan or a phase whose frontmatter passed its schema.
      *
+     * @param self - Node the page is rendered for.
+     * @param read - The file that holds the page.
+     * @param meta - Parsed frontmatter of the file.
      * @returns The content of the node: the rendered file, its title and summary, and where it stands.
      */
     private renderTracked;
-    /** Adds a tree file whose frontmatter failed its schema as a plain document. */
+    /**
+     * Adds a tree file whose frontmatter failed its schema as a plain document.
+     *
+     * @param parent - Node the document goes under.
+     * @param read - The file to show as a document.
+     * @returns The node of the document.
+     */
     private planDocument;
     /**
      * Checks the frontmatter of a file against its schema, and reports the file when it fails.
      *
+     * @param schema - Schema the frontmatter must match.
+     * @param read - The file whose frontmatter is checked.
      * @returns The parsed frontmatter, or `null` when it failed.
      */
     private parse;
-    /** Reads a file of the tree and splits off its frontmatter. */
+    /**
+     * Reads a file of the tree and splits off its frontmatter.
+     *
+     * @param tree - Task tree the file belongs to.
+     * @param treePath - Path of the file relative to the tree.
+     * @returns The file with its frontmatter, body and source text.
+     */
     private read;
-    /** The paths of a tree file as the planners of the docs section take them. */
+    /**
+     * The paths of a tree file as the planners of the docs section take them.
+     *
+     * @param tree - Task tree the file belongs to.
+     * @param treePath - Path of the file relative to the tree.
+     * @returns The file with its root, root-relative path and display path.
+     */
     private docFile;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@g3nomaly/analyze",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Turns a repository into one offline HTML documentation site, and queries the same linked model from the terminal and from hooks.",
   "keywords": [
     "documentation",
@@ -40,7 +40,7 @@
     "docs": "bun run build && bun dist/cli.js create_docs"
   },
   "dependencies": {
-    "@g3nomaly/core": "^0.3.1",
+    "@g3nomaly/core": "^0.3.2",
     "@t3-oss/env-core": "^0.13.11",
     "hast-util-to-string": "^3.0.1",
     "rehype-parse": "^9.0.1",