Customize the way we render sidebar

benoittgt · benoittgt · commit 37ff527595d6 · 2023-03-02T23:47:46.000+01:00
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -1,62 +1,62 @@
   - [CHANGELOG](/CHANGELOG.md)
   - [CONTRIBUTING](/CONTRIBUTING.md)
   - [DEVELOPMENT](/DEVELOPMENT.md)
-  - [allow_unused_http_interactions](/allow_unused_http_interactions.md)
-  - cassettes
-    - [allow_unused_http_interactions](/cassettes/allow_unused_http_interactions.md)
-    - [automatic_re_recording](/cassettes/automatic_re_recording.md)
-    - [decompress](/cassettes/decompress.md)
-    - [drop_unused_requests](/cassettes/drop_unused_requests.md)
-    - [dynamic_erb](/cassettes/dynamic_erb.md)
-    - [exclusive](/cassettes/exclusive.md)
-    - [format](/cassettes/format.md)
-    - [freezing_time](/cassettes/freezing_time.md)
-    - [naming](/cassettes/naming.md)
-    - [no_cassette](/cassettes/no_cassette.md)
-    - [update_content_length_header](/cassettes/update_content_length_header.md)
-  - configuration
-    - [allow_http_connections_when_no_cassette](/configuration/allow_http_connections_when_no_cassette.md)
-    - [cassette_library_dir](/configuration/cassette_library_dir.md)
-    - [debug_logging](/configuration/debug_logging.md)
-    - [default_cassette_options](/configuration/default_cassette_options.md)
-    - [filter_sensitive_data](/configuration/filter_sensitive_data.md)
-    - [hook_into](/configuration/hook_into.md)
-    - [ignore_request](/configuration/ignore_request.md)
-    - [preserve_exact_body_bytes](/configuration/preserve_exact_body_bytes.md)
-    - [query_parser](/configuration/query_parser.md)
-    - [uri_parser](/configuration/uri_parser.md)
-  - hooks
-    - [after_http_request](/hooks/after_http_request.md)
-    - [around_http_request](/hooks/around_http_request.md)
-    - [before_http_request](/hooks/before_http_request.md)
-    - [before_playback](/hooks/before_playback.md)
-    - [before_record](/hooks/before_record.md)
-  - http_libraries
-    - [em_http_request](/http_libraries/em_http_request.md)
-    - [net_http](/http_libraries/net_http.md)
-  - middleware
-    - [faraday](/middleware/faraday.md)
-    - [rack](/middleware/rack.md)
-  - record_modes
-    - [all](/record_modes/all.md)
-    - [new_episodes](/record_modes/new_episodes.md)
-    - [none](/record_modes/none.md)
-    - [once](/record_modes/once.md)
-    - [record_on_error](/record_modes/record_on_error.md)
-  - request_matching
-    - [body](/request_matching/body.md)
-    - [body_as_json](/request_matching/body_as_json.md)
-    - [custom_matcher](/request_matching/custom_matcher.md)
-    - [headers](/request_matching/headers.md)
-    - [host](/request_matching/host.md)
-    - [identical_request_sequence](/request_matching/identical_request_sequence.md)
-    - [method](/request_matching/method.md)
-    - [path](/request_matching/path.md)
-    - [playback_repeats](/request_matching/playback_repeats.md)
-    - [query](/request_matching/query.md)
-    - [uri](/request_matching/uri.md)
-    - [uri_without_param](/request_matching/uri_without_param.md)
-  - test_frameworks
-    - [cucumber](/test_frameworks/cucumber.md)
-    - [rspec_metadata](/test_frameworks/rspec_metadata.md)
-    - [test_unit](/test_frameworks/test_unit.md)
+  - [Allow unused http interactions](/allow_unused_http_interactions.md)
+  - Cassettes
+    - [Allow unused http interactions](/cassettes/allow_unused_http_interactions.md)
+    - [Automatic re recording](/cassettes/automatic_re_recording.md)
+    - [Decompress](/cassettes/decompress.md)
+    - [Drop unused requests](/cassettes/drop_unused_requests.md)
+    - [Dynamic erb](/cassettes/dynamic_erb.md)
+    - [Exclusive](/cassettes/exclusive.md)
+    - [Format](/cassettes/format.md)
+    - [Freezing time](/cassettes/freezing_time.md)
+    - [Naming](/cassettes/naming.md)
+    - [No cassette](/cassettes/no_cassette.md)
+    - [Update content length header](/cassettes/update_content_length_header.md)
+  - Configuration
+    - [Allow http connections when no cassette](/configuration/allow_http_connections_when_no_cassette.md)
+    - [Cassette library dir](/configuration/cassette_library_dir.md)
+    - [Debug logging](/configuration/debug_logging.md)
+    - [Default cassette options](/configuration/default_cassette_options.md)
+    - [Filter sensitive data](/configuration/filter_sensitive_data.md)
+    - [Hook into](/configuration/hook_into.md)
+    - [Ignore request](/configuration/ignore_request.md)
+    - [Preserve exact body bytes](/configuration/preserve_exact_body_bytes.md)
+    - [Query parser](/configuration/query_parser.md)
+    - [Uri parser](/configuration/uri_parser.md)
+  - Hooks
+    - [After http request](/hooks/after_http_request.md)
+    - [Around http request](/hooks/around_http_request.md)
+    - [Before http request](/hooks/before_http_request.md)
+    - [Before playback](/hooks/before_playback.md)
+    - [Before record](/hooks/before_record.md)
+  - Http libraries
+    - [Em http request](/http_libraries/em_http_request.md)
+    - [Net http](/http_libraries/net_http.md)
+  - Middleware
+    - [Faraday](/middleware/faraday.md)
+    - [Rack](/middleware/rack.md)
+  - Record modes
+    - [All](/record_modes/all.md)
+    - [New episodes](/record_modes/new_episodes.md)
+    - [None](/record_modes/none.md)
+    - [Once](/record_modes/once.md)
+    - [Record on error](/record_modes/record_on_error.md)
+  - Request matching
+    - [Body](/request_matching/body.md)
+    - [Body as json](/request_matching/body_as_json.md)
+    - [Custom matcher](/request_matching/custom_matcher.md)
+    - [Headers](/request_matching/headers.md)
+    - [Host](/request_matching/host.md)
+    - [Identical request sequence](/request_matching/identical_request_sequence.md)
+    - [Method](/request_matching/method.md)
+    - [Path](/request_matching/path.md)
+    - [Playback repeats](/request_matching/playback_repeats.md)
+    - [Query](/request_matching/query.md)
+    - [Uri](/request_matching/uri.md)
+    - [Uri without param](/request_matching/uri_without_param.md)
+  - Test frameworks
+    - [Cucumber](/test_frameworks/cucumber.md)
+    - [Rspec metadata](/test_frameworks/rspec_metadata.md)
+    - [Test unit](/test_frameworks/test_unit.md)
diff --git a/script/doc b/script/doc
@@ -7,6 +7,6 @@ gherkin2markdown features/ docs/
 echo ">> Feature file to markdown ok"
 cp -f CHANGELOG.md    CONTRIBUTING.md DEVELOPMENT.md  README.md docs/
 echo ">> Copy ok"
-npx docsify-auto-sidebar -d docs/
+node script/docsify-auto-sidebar.js -d docs
 echo ">> Sidebar ok"
 npx http-server docs/
diff --git a/script/docsify-auto-sidebar.js b/script/docsify-auto-sidebar.js
@@ -0,0 +1,86 @@
+#!/usr/bin/env node
+"use strict";
+exports.__esModule = true;
+var fs = require("fs");
+var path = require("path");
+var yargs = require("yargs");
+var ignores = /node_modules|^\.|_sidebar|_docsify/;
+var isDoc = /.md$/;
+function niceName(name) {
+    var splitName = name.split('-');
+    if (Number.isNaN(Number(splitName[0]))) {
+        var str = splitName.join(' ').replace(/_/g, ' ');
+        return str.charAt(0).toUpperCase() + str.slice(1);
+    }
+    return splitName.slice(1).join(' ');
+}
+function buildTree(dirPath, name, dirLink) {
+    if (name === void 0) { name = ''; }
+    if (dirLink === void 0) { dirLink = ''; }
+    var children = [];
+    for (var _i = 0, _a = fs.readdirSync(dirPath); _i < _a.length; _i++) {
+        var fileName = _a[_i];
+        if (ignores.test(fileName))
+            continue;
+        var fileLink = dirLink + '/' + fileName;
+        var filePath = path.join(dirPath, fileName);
+        if (fs.statSync(filePath).isDirectory()) {
+            var sub = buildTree(filePath, fileName, fileLink);
+            if (sub.children != null && sub.children.length > 0)
+                children.push(sub);
+        }
+        else if (isDoc.test(fileName)) {
+            children.push({ name: fileName, link: fileLink });
+        }
+    }
+    return { name: name, children: children, link: dirLink };
+}
+function renderToMd(tree, linkDir) {
+    if (linkDir === void 0) { linkDir = false; }
+    if (!tree.children) {
+        return "- [".concat(niceName(path.basename(tree.name, '.md')), "](").concat(tree.link.replace(/ /g, '%20'), ")");
+    }
+    else {
+        var fileNames_1 = new Set(tree.children.filter(function (c) { return !c.children; }).map(function (c) { return c.name; }));
+        var dirNames_1 = new Set(tree.children.filter(function (c) { return c.children; }).map(function (c) { return c.name + '.md'; }));
+        var content = tree.children
+            .filter(function (c) { return (!fileNames_1.has(c.name) || !dirNames_1.has(c.name)) && c.name != 'README.md'; })
+            .map(function (c) { return renderToMd(c, dirNames_1.has(c.name + '.md') && fileNames_1.has(c.name + '.md')); })
+            .join('\n')
+            .split('\n')
+            .map(function (item) { return '  ' + item; })
+            .join('\n');
+        var prefix = '';
+        if (tree.name) {
+            if (linkDir || fileNames_1.has('README.md')) {
+                var linkPath = tree.link.replace(/ /g, '%20');
+                if (fileNames_1.has('README.md'))
+                    linkPath += '/README.md';
+                prefix = "- [".concat(niceName(path.basename(tree.name, '.md')), "](").concat(linkPath, ")\n");
+            }
+            else
+                prefix = "- ".concat(niceName(tree.name), "\n");
+        }
+        return prefix + content;
+    }
+}
+var args = yargs
+    .wrap(yargs.terminalWidth() - 1)
+    .usage('$0 [-d docsDir] ')
+    .options({
+    docsDir: {
+        alias: 'd',
+        type: 'string',
+        describe: 'Where to look for the documentation (defaults to docs subdir of repo directory)'
+    }
+}).argv;
+var dir = path.resolve(process.cwd(), args.docsDir || './docs');
+try {
+    var root = buildTree(dir);
+    fs.writeFileSync(path.join(dir, '_sidebar.md'), renderToMd(root));
+}
+catch (e) {
+    console.error('Unable to generate sidebar for directory', dir);
+    console.error('Reason:', e.message);
+    process.exit(1);
+}
