@vanillaes/jsdown 0.1.1 → 0.1.3

package/README.md

@@ -2,7 +2,7 @@
 
 <h1 align="center">JSDown</h1>
 
-<div align="center">📜  Markdown Doc Generator for JSDoc  📜</div>
+<div align="center">📜  Markdown Documentation Generator for JSDoc  📜</div>
 
 <br />
 
@@ -18,6 +18,8 @@
 
 - **No Configuration**
 - Feed it JSDoc types and it spits out Markdown
+- The following are ignored by default: `node_modules/`, `coverage/`, `vendor/`, `*.spec.js`, `*.min.js`, and hidden files.
+
 
 ## jsdown
 
@@ -25,7 +27,7 @@
 
 `jsdown [...options] [files...]`
 
-- `[files]` - File(s) to lint (default `**/!(*.spec|index).js`)
+- `[files]` - File(s) to lint (default `**/!(index).js`)
 
 ### Usage
 
@@ -35,7 +37,7 @@ jsdown
 
 ```sh
 # generate documentation (matching a different file(s))
-lint-es '**/!(*.spec|index).cjs'
+jsdown '**/!(*.spec|index).cjs'
 ```
 
 *Note: In Linux/OSX, matcher patterns must be delimited in quotes.*

package/bin/jsdown.js

@@ -1,19 +1,23 @@
 #!/usr/bin/env node
 import { createDocs } from '../src/index.js'
 import { Command } from 'commander'
+import { Package } from '@vanillaes/esmtk'
 
-import { createRequire } from 'node:module'
-const require = createRequire(import.meta.url)
-const pkg = require('../package.json')
-
+const pkg = new Package()
 const program = new Command()
   .name('jsdown')
-  .description('Markdown Doc Generator for JSDoc')
   .version(pkg.version, '-v, --version')
+  .usage(`jsdown [...options] [files...]
+    If [files...] is omitted, all JavaScript source files (**/*.js)
+    in the current working directory are converted, recursively.
+
+    Certain paths (node_modules/, coverage/, vendor/, *.min.js, *.spec.js,
+    hidden files) are automatically ignored.
 
-program
-  .description('Lint file(s) matching the provided pattern (default *.spec.js)')
-  .argument('[files]', 'file(s) to lint', '**/!(*.spec|index).js')
+    Paths in a project's .gitignore file are also automatically ignored.
+  `)
+  .description('Markdown Documentation Generator for JSDoc')
+  .argument('[files]', 'file(s) to document', '**/!(index).js')
   .action((files, options) => {
     createDocs(files, options)
   })

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vanillaes/jsdown",
-  "version": "0.1.1",
-  "description": "Markdown Doc Generator for JSDoc",
+  "version": "0.1.3",
+  "description": "Markdown Documentation Generator for JSDoc",
   "keywords": [
     "ecmascript",
     "esm",
@@ -22,9 +22,9 @@
     ".": "./src/index.js"
   },
   "scripts": {
+    "jsdown": "node ./bin/jsdown.js",
     "test": "esmtk test",
     "lint": "esmtk lint",
-    "type": "esmtk type",
     "typings": "esmtk typings",
     "clean": "esmtk clean --typings",
     "preview": "esmtk preview",
@@ -32,7 +32,7 @@
     "postversion": "git push --follow-tags"
   },
   "dependencies": {
-    "@vanillaes/esmtk": "^1.8.0",
+    "@vanillaes/esmtk": "^2.0.0",
     "commander": "^14.0.3",
     "doctrine": "^3.0.0",
     "lodash-es": "^4.18.1"

package/src/jsdown.js

@@ -1,5 +1,5 @@
 import { docdown } from './index.js'
-import { fileExists, match } from '@vanillaes/esmtk'
+import { exists, readGitIgnore, match } from '@vanillaes/esmtk'
 import { mkdir, writeFile } from 'node:fs/promises'
 import { basename, dirname, join } from 'node:path'
 
@@ -9,7 +9,13 @@ import { basename, dirname, join } from 'node:path'
  * @param {object} options 'jsdown' options
  */
 export async function createDocs (files, options = {}) {
-  const sources = await match(files)
+  const defaultIgnores = ['node_modules/', 'coverage/', 'vendor/', '**/*.spec.js', '**/*.min.js', '.*']
+  const gitIgnores = await readGitIgnore(process.cwd())
+  let ignores = [...defaultIgnores, ...gitIgnores]
+  // de-duplicate
+  ignores = [...new Set(ignores)]
+  const ignore = ignores.join(',')
+  const sources = await match(files, process.cwd(), ignore)
   sources.forEach(file => createDoc(file))
 }
 
@@ -28,8 +34,8 @@ async function createDoc (path) {
   const srcPath = join(process.cwd(), 'src') // TODO: make this configurable?
   const docPath = join(process.cwd(), 'docs') // TODO: make this configurable?
 
-  const exists = await !fileExists(docPath)
-  if (!exists) {
+  const dirExists = await exists(docPath)
+  if (!dirExists) {
     await mkdir(docPath, { recursive: true })
   }