chore(docs): remove old generated placeholders

npm · Aug 16, 2022 · c38f101 · c38f101
1 parent 08550f1
commit c38f101
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 531 deletions.
diff --git a/docs/lib/tags.js b/docs/lib/tags.js
diff --git a/docs/lib/transform.js b/docs/lib/transform.js
@@ -1,11 +1,16 @@
 const marked = require('marked-man')
 const { join } = require('path')
-const TAGS = require('./tags')
 const NPM = require('./npm.js')
 const transformHTML = require('./transform-html.js')
 
+const TAGS = {
+  CONFIG: '<!-- AUTOGENERATED CONFIG DESCRIPTIONS -->',
+  USAGE: '<!-- AUTOGENERATED USAGE DESCRIPTIONS -->',
+  SHORTHANDS: '<!-- AUTOGENERATED CONFIG SHORTHANDS -->',
+}
+
 const assertPlaceholder = (src, path, type) => {
-  const placeholder = TAGS[type].REPLACE
+  const placeholder = TAGS[type]
   if (!src.includes(placeholder)) {
     throw new Error(
       `Cannot replace ${type} in ${path} due to missing placeholder`
@@ -20,15 +25,9 @@ const removePlaceholders = (src) => src.replace(/^<!--.*-->$/gm, '')
 
 const replaceUsage = (src, { path, docExt }) => {
   const replacer = assertPlaceholder(src, path, 'USAGE')
-  const { usage, name, srcName } = NPM.getCommandByDoc(path, docExt)
+  const { usage, name } = NPM.getCommandByDoc(path, docExt)
 
-  const synopsis = [
-    TAGS.USAGE.START,
-    TAGS.USAGE.SEP(srcName),
-    '',
-    '```bash',
-    usage,
-  ]
+  const synopsis = ['```bash', usage]
 
   const cmdAliases = Object.keys(NPM.aliases).reduce((p, c) => {
     if (NPM.aliases[c] === name) {
@@ -45,7 +44,7 @@ const replaceUsage = (src, { path, docExt }) => {
     synopsis.push(`aliases: ${cmdAliases.join(', ')}`)
   }
 
-  synopsis.push('```', '', TAGS.USAGE.SEP(srcName), '', TAGS.USAGE.END)
+  synopsis.push('```')
 
   return src.replace(replacer, synopsis.join('\n'))
 }
@@ -58,38 +57,18 @@ const replaceParams = (src, { path, docExt }) => {
     return src
   }
 
-  const config = [
-    TAGS.CONFIG.START,
-    TAGS.CONFIG.SEP(),
-    NPM.describeParams(params).join('\n\n' + TAGS.CONFIG.SEP() + '\n\n'),
-    '',
-    TAGS.CONFIG.SEP(),
-    '',
-    TAGS.CONFIG.END,
-  ].join('\n')
-
-  return src.replace(replacer, config)
+  return src.replace(replacer, NPM.describeParams(params).join('\n\n'))
 }
 
 const replaceConfig = (src, { path }) => {
   const replacer = assertPlaceholder(src, path, 'CONFIG')
-
-  const config = [
-    TAGS.CONFIG.START,
-    TAGS.CONFIG.SEP(),
-    NPM.describeAll(),
-    '',
-    TAGS.CONFIG.SEP(),
-    TAGS.CONFIG.END,
-  ].join('\n')
-
-  return src.replace(replacer, config)
+  return src.replace(replacer, NPM.describeAll())
 }
 
 const replaceShorthands = (src, { path }) => {
   const replacer = assertPlaceholder(src, path, 'SHORTHANDS')
 
-  const sh = Object.entries(NPM.shorthands)
+  const shorthands = Object.entries(NPM.shorthands)
     .sort(([shorta, expansiona], [shortb, expansionb]) => {
       // sort by what they're short FOR
       return expansiona.join(' ').localeCompare(expansionb.join(' '), 'en') ||
@@ -98,16 +77,9 @@ const replaceShorthands = (src, { path }) => {
     .map(([short, expansion]) => {
       const dash = short.length === 1 ? '-' : '--'
       return `* \`${dash}${short}\`: \`${expansion.join(' ')}\``
-    }).join('\n')
-
-  return src.replace(replacer, [
-    TAGS.SHORTHANDS.START,
-    TAGS.SHORTHANDS.SEP(),
-    sh,
-    '',
-    TAGS.SHORTHANDS.SEP(),
-    TAGS.SHORTHANDS.END,
-  ].join('\n'))
+    })
+
+  return src.replace(replacer, shorthands.join('\n'))
 }
 
 const replaceHelpLinks = (src) => {

diff --git a/lib/utils/config/describe-all.js b/lib/utils/config/describe-all.js
@@ -12,9 +12,6 @@ const describeAll = () => {
   }
   return Object.entries(definitions).sort(sort)
     .map(([key, def]) => def.describe())
-    .join(
-      '\n\n<!-- automatically generated, do not edit manually -->\n' +
-        '<!-- see lib/utils/config/definitions.js -->\n\n'
-    )
+    .join('\n\n')
 }
 module.exports = describeAll