feat(cli): support for filter-regexp and mapFilename

Author: FGRibreau

packages/cli/README.md

@@ -6,14 +6,17 @@ Generate documentation for JSON schemas through a command line interface.
 > - [**Charts, simple as a URL**. No more server-side rendering pain, 1 url = 1 chart](https://image-charts.com)
 > - [Looking for a free **Redis GUI**?](http://redsmin.com) [Or for **real-time alerting** & monitoring for Redis?](http://redsmin.com)
 
+<!--
 ### Install (docker)
 
-<!-- add a terminal gif here -->
+[add a terminal gif here
 
 ```bash
 docker run -it fgribreau/json-schema-documentation-cli
 ```
 
+ -->
+
 ### Install (nodejs)
 
 ```bash

packages/cli/package-lock.json

@@ -32,6 +32,7 @@
  "json-schema-documentation-generator": "^1.1.0",
  "json-schema-documentation-sample-generator": "^1.1.0",
  "json-schema-documentation-theme-default": "^1.1.0",
+ "slug": "^0.9.1",
  "yargs": "^10.0.3"
  },
  "engines": {

packages/cli/package.json

@@ -1,4 +1,5 @@
 const path = require('path');
+const slug = require('slug');
 const generator = require('json-schema-documentation-generator');
 
 const argv = require('yargs')
@@ -34,6 +35,22 @@ argv
  }
  },
  })
+ .option('mapFilename', {
+ describe: 'Mapping function to change each schema filename',
+ default: '(schema) => slug(schema.$id)',
+ coerce: mapper => {
+ const vm = require('vm');
+ return new vm.Script(mapper);
+ },
+ })
+ .option('filter-regexp', {
+ describe: 'Only keep schemas where $id match the specified regexp',
+ default: '.*',
+ coerce: regexp => {
+ const reg = new RegExp(regexp);
+ return schema => reg.test(schema.$id);
+ },
+ })
  .option('sample', {
  default: 'json-schema-documentation-sample-generator',
  describe: 'JSON-schema sample generator',
@@ -71,6 +88,8 @@ generator({
  require(path.resolve(process.cwd(), filePath))
  ),
 
+ filter: args.filterRegexp,
+
  // (required) schema sample generator
  samples: {
  generator: args.sample,
@@ -85,6 +104,10 @@ generator({
  // (required) override this to specify another generator
  directory: {
  path: args.output,
+ mapFilename: args.mapFilename.runInNewContext({
+ path: path,
+ slug: slug,
+ }),
  },
  },
  },