{"version":3,"sources":["jsdelivr-header.js","/npm/readme-auto@1.0.3/generate.js"],"names":[],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA,ACMA,MAAM,GAAK,QAAQ,MACb,OAAS,QAAQ,kBAuBjB,kBAAoB,CACzB,CAAE,KAAM,WAAY,MAAO,IAAK,KAAM,QACtC,CAAE,KAAM,SAAU,MAAO,IAAK,UAAU,EAAM,KAAM,SAE/C,QAAU,QAAQ,oBAAR,CAA6B,mBAG7C,IAAK,IAAI,EAAI,EAAG,EAAI,QAAQ,OAAO,OAAQ,IACP,KAA/B,QAAQ,OAAO,GAAG,OAAO,IAA4C,KAA/B,QAAQ,OAAO,GAAG,OAAO,KAElE,QAAQ,OAAO,GAAK,KAAK,QAAQ,OAAO,IAK1C,IAAI,SAAW,SAAS,EAAK,GAC5B,IAAI,EAAa,GAAG,YAAY,GAE5B,EAAW,GAAY,GAczB,OAZF,EAAW,SAAQ,SAAS,GAEvB,QAAQ,OAAO,QAAQ,EAAI,IAAS,GAAK,CAAC,YAAa,iBAAiB,QAAQ,EAAK,gBAAkB,IAEvG,GAAG,SAAS,EAAM,GAAM,cACxB,EAAW,SAAS,EAAM,EAAO,IAAK,IAEtC,QAAQ,IAAI,sCAAsC,EAAI,EAAK,OACzD,EAAS,KAAK,IAEnB,IAEO,CACV,EAGI,MAAQ,SAAS,MAGrB,SAAS,eAER,IAAI,EAAW,GAEf,GAAG,SAAS,QAAQ,SAAU,QAAQ,SAAS,EAAK,GACnD,GAAI,EAAK,OAAO,QAAQ,IAAI,GAE5B,IAAI,EAAU,WAAW,OAAO,IAGhC,EAAQ,MAAQ,EAAQ,MAAQ,KAAK,EAAQ,MAAM,OAAS,GAC5D,EAAQ,KAAO,EAAQ,KAAO,WAAW,EAAQ,KAAK,QAAU,GAChE,EAAQ,YAAc,EAAQ,YAAc,EAAQ,YAAY,OAAS,GAGzE,EACC,EAAQ,MAER,EAAQ,KAER,EAAQ,YAEL,EAAQ,eAAc,GAAY,sBAAsB,EAAQ,aAAa,QAEjF,GAAY,aAEZ,MAAM,SAAQ,SAAS,EAAM,GAC5B,GAAG,SAAS,EAAM,QAAQ,SAAS,EAAU,GAC5C,GAAI,EAAU,OAAO,QAAQ,IAAI,GAEjC,GAAY,WAAW,EAAM,OAAO,IAEpC,QAAQ,IAAI,+BAA+B,EAAK,OAE3C,EAAQ,IAAO,MAAM,SACzB,QAAQ,IAAI,GAGZ,GAAG,UAAU,gBAAiB,GAAW,IACxC,EAAM,QAAQ,IAAI,GAAc,QAAQ,IAAI,yBAAwB,IAGvE,GACD,GAED,GACD,CAEA,SAAS,WAAW,GAEnB,OAAO,EAAK,UAAU,EAAG,GAAG,cAAc,EAAK,UAAU,EAC1D,CAGA,SAAS,WAAW,GAChB,IAAI,EAAe,EAAQ,OAAO,QAAQ,IAAI,EAAQ,KAAK,EAAQ,IAAI,OAAO,EAC1E,EAAU,EAAQ,OAAO,UAAU,GAKvC,MADiB,CAAC,gBACA,QAAQ,EAAQ,MAAQ,EAAI,EAAU,EAAQ,QAAQ,KAAM,OAClF,CAEA,SAAS,QAAQ,GAEb,IADA,IAAI,EAAU,CAAC,EACN,EAAI,EAAG,EAAI,EAAK,OAAQ,IAAK,CAElC,IAAI,EAAY,OAAO,OAAO,WAAW,EAAK,IAAK,CAAE,KAAM,EAAK,GAAG,KAAK,IACxE,EAAQ,EAAK,GAAG,KAAO,CAC3B,CACA,OAAO,CACX,CAEA,SAAS,WAAW,GAIhB,IAHA,IAAI,EAAW,CAAC,EAGP,EAAI,EAAG,EAAI,EAAS,GAAG,KAAK,OAAQ,IAAK,CAC9C,IAAI,EAAU,EAAS,GAAG,KAAK,GAE/B,EAAS,EAAQ,KAAO,WAAW,EACvC,CACA,OAAO,CACX,CAEA,SAAS,gBAAgB,GAErB,IADA,IAAI,EAAY,CAAC,EACR,EAAI,EAAG,EAAI,EAAS,OAAQ,IAAK,CAEtC,IACI,EAAU,QADE,EAAS,GAAG,MAG5B,EAAU,EAAQ,MAAQ,CAC9B,CACA,OAAO,CACX,CAEA,SAAS,WAAW,EAAU,GAC1B,IAAI,EAAe,gBAAgB,GAC/B,EAAY,OAAO,KAAK,GAE3B,EAAU,GAEd,GAAW,WAAW,EAAS,KAAK,EAAS,QAE1C,IAAK,IAAI,EAAI,EAAG,EAAI,EAAU,OAAQ,IAGrC,GAFA,YAAc,EAAa,EAAU,IAEhC,YAAY,KAAjB,CAEG,GAAW,cAAc,EAAU,GAAG,MAAM,EAAS,KAAK,YAAY,KAAK,KAAK,MAGhF,IADA,IAAI,EAAe,OAAO,KAAK,aACtB,EAAI,EAAG,EAAI,EAAa,OAAQ,IAAK,CAC1C,IAAI,EAAa,EAAa,GAC1B,EAAe,YAAY,GAC7B,YAAY,GAAY,KAE1B,GAAwB,SAApB,EAAa,GAAjB,CAOA,IAFT,EADsB,CAAC,UAAW,WAAY,eACjB,QAAQ,EAAW,gBAAkB,EAAI,GAAK,QAAQ,WAAW,GAAY,QAE3E,EAAa,MAPK,CAQ5C,CACA,GAAW,IAnBiB,CAsBhC,OAAO,CACX,CAtIA","file":"/npm/readme-auto@1.0.3/generate.js","sourceRoot":"","sourcesContent":["/**\n * Minified by jsDelivr using Terser v5.39.0.\n * Original file: /npm/readme-auto@1.0.3/generate.js\n *\n * Do NOT use SRI with dynamically generated files! More information: https://www.jsdelivr.com/using-sri-with-dynamic-files\n */\n","/**\n * @title README Generator\n * @logo readme.gif\n * @description Auto-generate a beautiful README for a project based on its code comments.\n * This very README was generated from readme-generator!\n * Supports any language that uses star comments.\n * @installation\n * ```\n * npm i -g readme-auto\n * ```\n * @author ethancrist\n **/\nconst fs = require('fs')\nconst parser = require('comment-parser')\n\n/**\n * @meta generate [command]\n * @purpose Generate a README using any child code files of the current directory.\n * @usage ```bash\n *        generate -m \"<mainFile.js>\" [ -i <ignore dir> ]\n *        ```\n * @options ##### `--mainFile`\n *          Alias: `-m` Type: `string` Required: `true`\n *\n *          The relative location of the main file to your code. This will be the file whose code comments supply application metadata.\n *\n *          ##### `--ignore`\n *          Alias: `-i` Type: `string` Required: `false`\n *\n *          Ignore a code file or a set of code files within a directory when creating the README. For example:\n *          ```bash\n *          generate -m mainFile.js -i node_modules\n *          ```\n *          Would create documentation in the README for all files in the current directory and child directories EXCEPT anything in node_modules.\n **/\n\nconst optionDefinitions = [\n\t{ name: 'mainFile', alias: 'm', type: String },\n\t{ name: 'ignore', alias: 'i', multiple: true, type: String }\n]\nconst options = require('command-line-args')(optionDefinitions)\n\n// Cleaning user args if needed\nfor (var i = 0; i < options.ignore.length; i++) {\n\tif (options.ignore[i].charAt(0) != '/' && options.ignore[i].charAt(1) != '/') {\n\t\t// Auto-setting ignore file to current dir if no dir was specified\n\t\toptions.ignore[i] = './'+options.ignore[i];\n\t}\n}\n\n// List all files in a directory in Node.js recursively in a synchronous fashion\nvar walkSync = function(dir, filelist) {\n\tvar theseFiles = fs.readdirSync(dir);\n\t\n\tvar\tfilelist = filelist || [];\n\t\t\n\ttheseFiles.forEach(function(file) {\t\t\n\t\t// Skipping --ignore folders and files \n\t\tif (options.ignore.indexOf(dir+file) > -1 || ['README.MD', 'README.GEN.MD'].indexOf(file.toUpperCase()) > -1) return;\n\t\t\n\t\tif (fs.statSync(dir + file).isDirectory()) {\n    \t\tfilelist = walkSync(dir + file + '/', filelist);\n    \t} else {\n\t    \tconsole.log('Preparing README documentation for '+dir+file+'...')    \t\n      \t\tfilelist.push(file);\n    \t}\n  \t});\n  \t\n  \treturn filelist;\n};\n\n// Entry\nvar files = walkSync('./');\ncreateReadme();\n\nfunction createReadme() {\n\n\tvar markdown = '';\n\n\tfs.readFile(options.mainFile, 'utf8', function(err, data) {\n\t\tif (err) return console.log(err);\n\t\t\n\t\tvar appData = getAppData(parser(data)); \n\n\t\t// Fallbacks\n\t\tappData.title = appData.title ? '# '+appData.title+'\\n\\n' : '';\n\t\tappData.logo = appData.logo ? '![logo]('+appData.logo+')\\n\\n' : '';\n\t\tappData.description = appData.description ? appData.description+'\\n\\n' : '';\n\n\n\t\tmarkdown = \n\t\t\tappData.title+\n\t\t\n\t\t\tappData.logo+\n\n\t\t\tappData.description;\n\n\t\tif (appData.installation) markdown += '## Installation\\n\\n'+appData.installation+'\\n\\n';\n\n\t\tmarkdown += '## API\\n\\n';\n\n\t\tfiles.forEach(function(file, index) {\n\t\t\tfs.readFile(file, 'utf8', function(subError, subData) {\n\t\t\t\tif (subError) return console.log(subError);\n\t\t\t\t\n\t\t\t\tmarkdown += getFileDoc(file, parser(subData));\n\t\t\t\n\t\t\t\tconsole.log('Creating README content for '+file+'...')\n\t\t\t\n\t\t\t\tif ((index + 1) === files.length) {\n\t\t\t\t\tconsole.log(markdown)\n\t\t\t\n\t\t\t\t\t// Last file done; writing README\n\t\t\t\t\tfs.writeFile('README.gen.md', markdown, (writeError) => {\n\t\t\t\t\t\terr ? console.log(writeError) : console.log('README.gen.md created.')\n\t\t\t\t\t});\n\t\t\t\t}\n\t\t\t});\n\t\t})\n\t\t\n\t});\n}\n\nfunction capitalize(word) {\n\t// Capitalize the first letter in a word\n\treturn word.substring(0, 1).toUpperCase()+word.substring(1)  \n}\n\n\nfunction getTagText(tagData) {\n    var tagTextStart = tagData.source.indexOf('@'+tagData.tag)+tagData.tag.length+2;\n    var tagText = tagData.source.substring(tagTextStart);\n\n    // Markdown requires two new lines to be visible\n    // In some exceptions, we won't add a new line.\n    var exceptions = ['installation'];\n    return exceptions.indexOf(tagData.tag) > -1 ? tagText : tagText.replace('\\n', '\\n\\n');\n}\n\nfunction getTags(tags) {\n    var newTags = {};\n    for (var i = 0; i < tags.length; i++) {\n        // Normal tag; adding it as is\n        var tagValues = Object.assign(getTagText(tags[i]), { line: tags[i].line-1 });\n        newTags[tags[i].tag] = tagValues\n    };\n    return newTags\n}\n\nfunction getAppData(metadata) {\n    var filtered = {};\n\n    // Looping through all code comment tags\n    for (var i = 0; i < metadata[0].tags.length; i++) {\n        var thisTag = metadata[0].tags[i];\n\n        filtered[thisTag.tag] = getTagText(thisTag)\n    };\n    return filtered\n}\n\nfunction getVariableData(metadata) {\n    var variables = {};\n    for (var i = 0; i < metadata.length; i++) {\n        // Each loop here is a new /** **/ area\n        var theseTags = metadata[i].tags;\n        var thisTag = getTags(theseTags);\n\n        variables[thisTag.meta] = thisTag\n    };\n    return variables\n}\n\nfunction getFileDoc(fileName, fileContents) {\n    var variableData = getVariableData(fileContents); \n    var variables = Object.keys(variableData);\n\n\tvar fileDoc = '';\n\n\tfileDoc += '###### ['+fileName+']('+fileName+')\\n\\n'; \n\n    for (var v = 0; v < variables.length; v++) {\n    \tthisVarData = variableData[variables[v]];\n    \t\n    \tif (!thisVarData.meta) continue;\n\n        fileDoc += '---\\n### [`'+variables[v]+'`]('+fileName+'#L'+thisVarData.meta.line+')\\n';\n\n        var variableTags = Object.keys(thisVarData);\n        for (var i = 0; i < variableTags.length; i++) {\n            var thisTagKey = variableTags[i];\n            var thisTagValue = thisVarData[thisTagKey];\n\t\t\tvar line = thisVarData[thisTagKey].line+2;\n\n            if (variableTags[i] === \"meta\") continue;\n\n\t\t\t// If the variable tag == one of these in the array, remove the title\n\t\t\t// for it above the description itself and just show the description\n\t\t\tvar descriptionTags = ['purpose', 'describe', 'description'];\n\t\t\tthisTagKey = descriptionTags.indexOf(thisTagKey.toLowerCase()) > -1 ? '' : '#### '+capitalize(thisTagKey)+'\\n\\n';\n\n            fileDoc += thisTagKey+thisTagValue+'\\n\\n'\n        }; \n        fileDoc += '\\n'\n    };\n    \n    return fileDoc\n}\n"]}