Skip to content

Commit

Permalink
breaking: Removed config.jsdoc (and the whole JSDoc-to-Markdown support)
Browse files Browse the repository at this point in the history
Signed-off-by: Jaid <jaid.jsx@gmail.com>
  • Loading branch information
Jaid committed Oct 1, 2021
1 parent 3e567b9 commit 28f9d05
Show file tree
Hide file tree
Showing 3 changed files with 0 additions and 100 deletions.
5 changes: 0 additions & 5 deletions src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ import generateReadme from "./generateReadme.js"
import hasContent from "./lib/esm/has-content.js"
import readFileString from "./lib/esm/read-file-string.js"
import readFileYaml from "./lib/esm/read-file-yaml.js"
import generateJsdocMarkdown from "./lib/generateJsdocMarkdown.js"
import guessRuntime from "./lib/guessRuntime.js"
import readConfig from "./lib/readConfig.js"
import readExampleResults from "./lib/readExampleResults.js"
Expand Down Expand Up @@ -65,7 +64,6 @@ import readUsageOptions from "./lib/readUsageOptions.js"
* @prop {string} exampleResults
* @prop {Args} args
* @prop {"node"|"web"|"hybrid"} runtime
* @prop {string} apiMarkdown
* @prop {string} license
* @prop {string} slug
* @prop {string} tag
Expand Down Expand Up @@ -211,9 +209,6 @@ const job = async args => {
context.hasExampleSection = Boolean(context.example || context.fragments.example)
context.hasDevelopmentSection = Boolean(context.fragments.development) || hasContent(context.developmentScripts)
context.hasOptionsSection = hasUsageOptions || Boolean(context.fragments.options)
if (config.jsdoc) {
context.apiMarkdown = await generateJsdocMarkdown(context)
}
const generatedReadme = await generateReadme(context)
const readmeText = generatedReadme.trim()
const outputFileExists = await fsp.pathExists(args.outputFile)
Expand Down
94 changes: 0 additions & 94 deletions src/lib/generateJsdocMarkdown.js

This file was deleted.

1 change: 0 additions & 1 deletion src/template.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,6 @@ typeof {{globalName}}.default
```
{{/if}}

{{{apiMarkdown}}}
{{#if binName}}
## CLI Usage
After installing package `{{{pkg.name}}}` globally, you can use its command line interface.
Expand Down

0 comments on commit 28f9d05

Please sign in to comment.