Update "documentation" lib and make ES6 changes (#611)

docs/custom_theme/index.js

@@ -0,0 +1,111 @@
+import fs from 'fs/promises'
+import path from 'path'
+import { fileURLToPath } from 'url'
+import template from 'lodash/template.js'
+import GithubSlugger from 'github-slugger'
+import hljs from 'highlight.js'
+import { util } from '../../node_modules/documentation/src/index.js'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+
+const { LinkerStack, createFormatters } = util
+
+async function copyDir(sorce, dest) {
+  await fs.mkdir(dest, { recursive: true })
+  const entries = await fs.readdir(sorce, { withFileTypes: true })
+
+  for (const entry of entries) {
+    const srcPath = path.join(sorce, entry.name)
+    const destPath = path.join(dest, entry.name)
+
+    entry.isDirectory() ? await copyDir(srcPath, destPath) : await fs.copyFile(srcPath, destPath)
+  }
+}
+
+function isFunction(section) {
+  return section.kind === 'function' || (section.kind === 'typedef' && section.type && section.type.type === 'NameExpression' && section.type.name === 'Function')
+}
+
+const slugger = new GithubSlugger()
+const slugs = {}
+
+function getSlug(str) {
+  if (slugs[str] === undefined) {
+    slugs[str] = slugger.slug(str)
+  }
+  return slugs[str]
+}
+
+export default async function (comments, config) {
+  const linkerStack = new LinkerStack(config).namespaceResolver(comments, function (namespace) {
+    return `#${getSlug(namespace)}`
+  })
+
+  const formatters = createFormatters(linkerStack.link)
+
+  hljs.configure(config.hljs || {})
+
+  const sharedImports = {
+    imports: {
+      slug(str) {
+        return getSlug(str)
+      },
+      shortSignature(section) {
+        let prefix = ''
+        if (section.kind === 'class') {
+          prefix = 'new '
+        } else if (!isFunction(section)) {
+          return section.name
+        }
+        return prefix + section.name + formatters.parameters(section, true)
+      },
+      signature(section) {
+        let returns = ''
+        let prefix = ''
+        if (section.kind === 'class') {
+          prefix = 'new '
+        } else if (!isFunction(section)) {
+          return section.name
+        }
+        if (section.returns.length) {
+          returns = `: ${formatters.type(section.returns[0].type)}`
+        }
+        return prefix + section.name + formatters.parameters(section) + returns
+      },
+      md(ast, inline) {
+        if (inline && ast && ast.children.length && ast.children[0].type === 'paragraph') {
+          ast = {
+            type: 'root',
+            children: ast.children[0].children.concat(ast.children.slice(1)),
+          }
+        }
+        return formatters.markdown(ast)
+      },
+      formatType: formatters.type,
+      autolink: formatters.autolink,
+      highlight(example) {
+        if (config.hljs && config.hljs.highlightAuto) {
+          return hljs.highlightAuto(example).value
+        }
+        return hljs.highlight(example, { language: 'js' }).value
+      },
+    },
+  }
+
+  sharedImports.imports.renderSectionList = template(await fs.readFile(path.join(__dirname, 'section_list._'), 'utf8'), sharedImports)
+  sharedImports.imports.renderSection = template(await fs.readFile(path.join(__dirname, 'section._'), 'utf8'), sharedImports)
+  sharedImports.imports.renderNote = template(await fs.readFile(path.join(__dirname, 'note._'), 'utf8'), sharedImports)
+  sharedImports.imports.renderParamProperty = template(await fs.readFile(path.join(__dirname, 'paramProperty._'), 'utf8'), sharedImports)
+
+  const pageTemplate = template(await fs.readFile(path.join(__dirname, 'index._'), 'utf8'), sharedImports)
+
+  const string = pageTemplate({ docs: comments, config })
+
+  if (!config.output) {
+    return string
+  }
+
+  await copyDir(`${__dirname}/assets/`, `${config.output}/assets/`)
+  await fs.writeFile(`${config.output}/index.html`, string, 'utf8')
+}

docs/theme/section._ → docs/custom_theme/section._

@@ -4,7 +4,7 @@
   <div class='clearfix'>
     <% if (typeof nested === 'undefined') { %>
     <h3 class='fl m0' id='<%- slug(section.namespace) %>'>
-      <%- section.name %>  
+      <%- section.name %>
     </h3>
     <% } %>
     <% if (section.context && section.context.github) { %>
@@ -160,10 +160,10 @@
     <%= renderSectionList({ members: section.members.events, renderSection: renderSection, renderParamProperty: renderParamProperty, noun: 'Event' }) %>
   <% } %>
 
-  <div class='filenameLine'>
+    <div class='filenameLine'>
     <% const fna = section.context.file.split("/") %>
     <div class='py1 quiet mt1 prose-big'>Source File</div>
     <span class="filename"><pre><%- fna[fna.length-1] %></pre></span>
   </div>
-
+  
 </section>