feat(markdown): list nested schemas in README

adobe · Dec 3, 2019 · 87e8489 · 87e8489
1 parent e521541
commit 87e8489
Show file tree

Hide file tree

Showing 5 changed files with 79 additions and 4 deletions.
diff --git a/cli.js b/cli.js
@@ -28,6 +28,8 @@ const filterRefs = require('./lib/filterRefs');
 const validate = require('./lib/validateSchemas');
 const build = require('./lib/markdownBuilder');
 const write = require('./lib/writeMarkdown');
+const readme = require('./lib/readmeBuilder');
+const formatInfo = require('./lib/formatInfo');
 
 const { info, error, debug } = logger;
 
@@ -130,7 +132,6 @@ const metaElements = argv.m;
 const schemaPath = argv.d;
 const schemaDir = argv.x;
 const target = fs.statSync(schemaPath);
-const readme = !!argv.n;
 const schemaExtension = argv.e;
 
 // list all schema files in the specified directory
@@ -151,14 +152,24 @@ readdirp.promise(schemaPath, { root: schemaPath, fileFilter: `*.${schemaExtensio
     // find contained schemas
     map(traverse),
     flat,
+
+    // remove pure ref schemas
     filterRefs,
 
+    // format titles and descriptions
+    formatInfo({ extension: schemaExtension }),
+
     // make a nice object
     generate,
 
     // generate Markdown ASTs
     build,
 
+    // build readme
+    readme({
+      readme: !argv.n,
+    }),
+
     // write to files
 
     write({
@@ -170,5 +181,5 @@ readdirp.promise(schemaPath, { root: schemaPath, fileFilter: `*.${schemaExtensio
   ))
 
   .then((schemas) => {
-    console.log('allschemas', schemas);
+    // console.log('allschemas', schemas);
   });
diff --git a/lib/generateName.js b/lib/generateName.js
@@ -23,7 +23,6 @@
  */
 const { foldl } = require('ferrum');
 const GithubSlugger = require('github-slugger');
-const { formatname } = require('./formatname');
 
 /**
  * Turns a sequence of schemas into an object, using a human and
@@ -35,7 +34,7 @@ function generatenames(schemas) {
 
   return foldl(schemas, {}, (container, schema) => {
     const name = {};
-    name[slugger.slug(formatname(schema))] = schema;
+    name[slugger.slug(schema.title)] = schema;
     return Object.assign(container, name);
   });
 }

diff --git a/lib/traverseSchema.js b/lib/traverseSchema.js
@@ -70,6 +70,7 @@ function traverse(node) {
             direct: false,
             pointer: `${pointer}/${key}/${index}`,
             id,
+            root: schema,
             // TODO add additional properties for tracking
           })),
         );
@@ -83,6 +84,7 @@ function traverse(node) {
             direct: false,
             pointer: `${pointer}/${key}/${subkey}`,
             id,
+            root: schema,
             // TODO add additional properties for tracking
           })),
         );
@@ -94,6 +96,7 @@ function traverse(node) {
           direct: false,
           pointer: `${pointer}/${key}`,
           id,
+          root: schema,
           // TODO add additional properties for tracking
         }];
       }

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -24,8 +24,10 @@
     "i18next": "^19.0.1",
     "json-pointer": "^0.6.0",
     "mdast-builder": "^1.1.1",
+    "mdast-util-to-string": "^1.0.7",
     "mkdirp": "^0.5.1",
     "readdirp": "^3.1.1",
+    "remark-parse": "^7.0.2",
     "remark-stringify": "^7.0.4",
     "unified": "^8.4.2",
     "unist-builder": "^2.0.2",