@webneat/codewiki 0.0.5 → 0.0.6

package/dist/bin.js

@@ -552,7 +552,7 @@ var symbols2 = {
   where: {}
 };
 var external_dependencies2 = {
-  select: ["id", "package", "subpath", "name", "state", "error"],
+  select: ["id", "package", "subpath", "name", "is_builtin", "state", "error"],
   order_by: ["id", "asc"],
   limit: 20,
   offset: 0,
@@ -2913,12 +2913,23 @@ var describe = new Command3("describe");
 describe.description("Show the next item to describe");
 describe.action(async () => {
   const wiki = await load_wiki();
-  const next = get_next_to_describe(wiki);
-  if (!next) return env.log("All items are described!");
-  if (next.type === "dependency") return describe_dependency(next.entity);
-  env.log(
-    `All external dependencies are described, and we don't support describing other items yet (we are implementing the right order ...). You are done for now!`
-  );
+  const result = wiki.to_describe(1);
+  if (result.type === "none") {
+    return env.log("All items are described!");
+  }
+  if (result.type === "dependencies" && result.items.length > 0) {
+    return describe_dependency(result.items[0]);
+  }
+  if (result.type === "symbols" && result.items.length > 0) {
+    return describe_symbol(wiki, result.items[0]);
+  }
+  if (result.type === "files" && result.items.length > 0) {
+    return describe_file(result.items[0]);
+  }
+  if (result.type === "directories" && result.items.length > 0) {
+    return describe_directory(result.items[0]);
+  }
+  env.log("No items to describe.");
 });
 function describe_dependency(dep) {
   env.log(dedent2`
@@ -2934,40 +2945,42 @@ function describe_dependency(dep) {
       \`codewiki dependencies set-description ${dep.id} <markdown-file>\`
   `);
 }
-function get_next_to_describe(wiki) {
-  const deps = wiki.dependencies.search({
-    where: { state: "to_describe" },
-    limit: 1,
-    select: ["id", "package", "subpath", "name", "version", "github_repo"]
-  });
-  if (deps.length > 0) {
-    return { type: "dependency", entity: deps[0] };
-  }
-  const symbols4 = wiki.symbols.search({
-    where: { state: "to_describe" },
-    limit: 1,
-    select: ["id", "name", "type", "file_id", "is_exported"]
-  });
-  if (symbols4.length > 0) {
-    return { type: "symbol", entity: symbols4[0] };
-  }
-  const files5 = wiki.files.search({
-    where: { state: "to_describe" },
-    limit: 1,
-    select: ["id", "path"]
-  });
-  if (files5.length > 0) {
-    return { type: "file", entity: files5[0] };
-  }
-  const directories4 = wiki.directories.search({
-    where: { state: "to_describe" },
-    limit: 1,
-    select: ["id", "path"]
-  });
-  if (directories4.length > 0) {
-    return { type: "directory", entity: directories4[0] };
-  }
-  return null;
+function describe_symbol(wiki, sym) {
+  const file = wiki.files.get(sym.file_id);
+  env.log(dedent2`
+    Your task is to describe the following symbol:
+
+    name: ${sym.name}
+    type: ${sym.type}
+    file: ${file?.path || "unknown"}
+    exported: ${sym.is_exported}
+
+    Write a concise developer documentation for this ${sym.type} into a markdown file, then run:
+
+    codewiki symbols set-description ${sym.id} <markdown-file>
+  `);
+}
+function describe_file(file) {
+  env.log(dedent2`
+    Your task is to describe the following file:
+
+    path: ${file.path}
+
+    Write a concise description of this file's purpose and contents into a markdown file, then run:
+
+    codewiki files set-description ${file.id} <markdown-file>
+  `);
+}
+function describe_directory(dir) {
+  env.log(dedent2`
+    Your task is to describe the following directory:
+
+    path: ${dir.path}
+
+    Write a concise description of this directory's purpose and contents into a markdown file, then run:
+
+    codewiki directories set-description ${dir.id} <markdown-file>
+  `);
 }
 
 // src/cli/commands/files/index.ts