script to generate command pages lives!

Author: b5

command-code-examples/python/doc-set.py

@@ -0,0 +1,3 @@
+import iroh from 'iroh'
+
+iroh.set('doc', 'set', 'example', 'value')

package.json

@@ -8,6 +8,7 @@
     "start": "next start",
     "lint": "next lint"
   },
+  "type": "module",
   "browserslist": "defaults, not ie <= 11",
   "dependencies": {
     "@algolia/autocomplete-core": "^1.7.3",

scripts/generate-commands-pages.js

@@ -1,13 +1,13 @@
-import { readFileSync, writeFileSync } from 'fs'
+import { readFileSync, writeFileSync, mkdirSync } from 'fs'
 import ejs from 'ejs'
 
-import {commands} from '../src/app/docs/commands/commands';
+import commands from '../src/data/commands.js';
 
 (function() {
   try {
     let templateSource = readFileSync('./templates/command.template.mdx');
     Object.keys(commands).forEach((key) => {
-      console.log('Generating commands for %s', key);
+      console.log('%s commands:', key);
       generateCommands(commands[key], templateSource);
     });
   }
@@ -37,8 +37,8 @@ function generateCommand(command, templateSource) {
 
   // mkdir -p ../src/app/docs/commands/{slug}
   mkdir(command.slug);
-  const path = `../src/app/docs/commands/${slug}/page.mdx`;
-  console.log('Writing %s with examples %s', path, Object.keys(examples).join(', '));
+  const path = `../src/app/docs/commands/${command.slug}/page.mdx`;``
+  console.log('  writing %s with examples: %s', path, Object.keys(examples).filter(k => !!examples[k]).join(', '));
   writeFileSync(path, result);
 }
 

scripts/templates/command.template.mdx

@@ -1,92 +1,47 @@
 {/* THIS FILE IS GENERATED FROM A TEMPLATE. See scripts/generate-commands-pages.js for more */}
 export const metadata = {
-    title: "Set Command",
-    description: "Set an entry in a document"
+    title: "<%= command.name %>",
+    description: "<%= command.description %>"
 }
 
-# Set
+# <%= command.name %>
 
-Set an entry in a document {{ className: 'lead' }}
+<%= command.description %> {{ className: 'lead' }}
 
+<% if (command.arguments) { %>
 ### Arguments
 
 | name | necessity | description |
 | ---- | --------- | ----------- |
-| KEY  | required | Key to the entry (parsed as UTF-8 string) |
-| VALUE | required | Content to store for this entry (parsed as UTF-8 string) |
-| author | required | Author of this entry. Required unless the author is set through the console or the IROH_AUTHOR environment variable. |
+<% command.arguments.forEach((arg) => { %>
+| <%= arg.name  %>  | <%= arg.necessity%> | <%= arg.description %> |
+<% }) %>
+<% } %>
 
 ## Examples
 
 <CodeGroup title="SET">
 
 
 ```text {{ title: 'console' }}
-> docs create --use
-> set key value
-@ydzwyyes…: key = azceusiw… (5 B)
+<%- examples.console %>
 ```
 
-```bash {{ title: 'CLI'}}
-# create an author if you haven't already
-$ IROH_AUTHOR=$(iroh author create)
-
-# create a document
-$ iroh docs create
-created d7bb0092bf6d7ee3cb6bd255e88596d3ca16d50ce6935a7721f2ff836a3c0355
+<% if (examples.cli) { %>
+```bash {{ title: 'CLI' }}
+<%- examples.cli %>
+```
+<% } %>
 
-# set a key
-$ iroh doc 674deec7a19fec50fd6f486a5eef20509073ecf7c527b60a27c84baea90d3816 set "key" "value"
-@ydzwyyes…: key = azceusiw… (5 B)
+<% if (examples.python) { %>
+```python {{ title: 'python' }}
+<%- examples.python %>
 ```
+<% } %>
 
+<% if (examples.rust) { %>
 ```rust {{ title: 'rust' }}
-#![cfg(feature = "mem-db")]
-
-use anyhow::{anyhow, Result};
-use futures::StreamExt;
-
-use iroh::{
-    collection::IrohCollectionParser,
-    node::Node,
-    bytes::util::runtime,
-};
-use iroh_sync::store::GetFilter;
-
-#[tokio::main]
-async fn main() -> Result<()> {
-    // build the node
-    let rt = runtime::Handle::from_currrent(1).unwrap();
-    let db = iroh::baomap::mem::Store::new(rt.clone());
-    let store = iroh_sync::store::memory::Store::default();
-    let node = Node::builder(db, store)
-        .collection_parser(IrohCollectionParser)
-        .runtime(&rt)
-        .bind_addr("127.0.0.1:0".parse()?);
-    
-    // start the node & create a client
-    let node = node.spawn().await?;
-    let client = node.client();
-
-    // create a document & author
-    let author = client.create_author().await?;
-    let doc = client.create_doc().await?;
-
-    // set the key "key" to "value"
-    let key = b"key";
-    let value = b"value";
-    doc.set_bytes(author, key.to_vec(), value.to_vec()).await?;
-    println!("key is set!");
-
-    // read the value back
-    let filter = GetFilter::latest().with_key(key);
-    let entry = doc.get(filter).await?.next().await.ok_or_else(|| anyhow!("entry not found"))??;
-    let content = doc.get_content_bytes(&entry).await?;
-    
-    println!("value bytes: {:?}", content);
-
-    Ok(())
-}
+<%- examples.rust %>
 ```
-
+<% } %>
 </CodeGroup>

src/app/docs/commands/author-create/page.mdx

@@ -0,0 +1,27 @@
+{/* THIS FILE IS GENERATED FROM A TEMPLATE. See scripts/generate-commands-pages.js for more */}
+export const metadata = {
+    title: "author create",
+    description: "Create a new author"
+}
+
+# author create
+
+Create a new author {{ className: 'lead' }}
+
+
+
+## Examples
+
+<CodeGroup title="SET">
+
+
+```text {{ title: 'console' }}
+> 
+```
+
+
+
+
+
+
+</CodeGroup>

src/app/docs/commands/author-list/page.mdx

@@ -0,0 +1,27 @@
+{/* THIS FILE IS GENERATED FROM A TEMPLATE. See scripts/generate-commands-pages.js for more */}
+export const metadata = {
+    title: "author list",
+    description: "List authors"
+}
+
+# author list
+
+List authors {{ className: 'lead' }}
+
+
+
+## Examples
+
+<CodeGroup title="SET">
+
+
+```text {{ title: 'console' }}
+> 
+```
+
+
+
+
+
+
+</CodeGroup>

src/app/docs/commands/author-switch/page.mdx

@@ -0,0 +1,27 @@
+{/* THIS FILE IS GENERATED FROM A TEMPLATE. See scripts/generate-commands-pages.js for more */}
+export const metadata = {
+    title: "author switch",
+    description: "Set the active author for doc insertion"
+}
+
+# author switch
+
+Set the active author for doc insertion {{ className: 'lead' }}
+
+
+
+## Examples
+
+<CodeGroup title="SET">
+
+
+```text {{ title: 'console' }}
+> 
+```
+
+
+
+
+
+
+</CodeGroup>

src/app/docs/commands/blob-add/page.mdx

@@ -0,0 +1,27 @@
+{/* THIS FILE IS GENERATED FROM A TEMPLATE. See scripts/generate-commands-pages.js for more */}
+export const metadata = {
+    title: "blob add",
+    description: "Add data from PATH to the running provider's database"
+}
+
+# blob add
+
+Add data from PATH to the running provider's database {{ className: 'lead' }}
+
+
+
+## Examples
+
+<CodeGroup title="SET">
+
+
+```text {{ title: 'console' }}
+> 
+```
+
+
+
+
+
+
+</CodeGroup>

src/app/docs/commands/blob-list/page.mdx

@@ -0,0 +1,27 @@
+{/* THIS FILE IS GENERATED FROM A TEMPLATE. See scripts/generate-commands-pages.js for more */}
+export const metadata = {
+    title: "blob list",
+    description: "List availble content on the node"
+}
+
+# blob list
+
+List availble content on the node {{ className: 'lead' }}
+
+
+
+## Examples
+
+<CodeGroup title="SET">
+
+
+```text {{ title: 'console' }}
+> 
+```
+
+
+
+
+
+
+</CodeGroup>

src/app/docs/commands/blob-share/page.mdx

@@ -0,0 +1,27 @@
+{/* THIS FILE IS GENERATED FROM A TEMPLATE. See scripts/generate-commands-pages.js for more */}
+export const metadata = {
+    title: "blob share",
+    description: "Download data to the running provider's database and provide it"
+}
+
+# blob share
+
+Download data to the running provider's database and provide it {{ className: 'lead' }}
+
+
+
+## Examples
+
+<CodeGroup title="SET">
+
+
+```text {{ title: 'console' }}
+> 
+```
+
+
+
+
+
+
+</CodeGroup>