https://github.com/basementuniverse/docblock-cli

Parse docblock-style comments into JSON on the command line
https://github.com/basementuniverse/docblock-cli

Last synced: 23 days ago
JSON representation

Parse docblock-style comments into JSON on the command line

• Host: GitHub
• URL: https://github.com/basementuniverse/docblock-cli
• Owner: basementuniverse
• License: mit
• Created: 2021-08-22T21:41:50.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-08-22T21:59:23.000Z (over 3 years ago)
• Last Synced: 2024-04-14T00:01:48.502Z (9 months ago)
• Language: JavaScript
• Size: 4.88 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# DocBlock CLI

Parse docblock-style comments into JSON on the command line.

Uses DocBlock internally (https://www.npmjs.com/package/docblock). `docblock-cli` is just a CLI wrapper around this library.

## Install

```bash

npm install @basementuniverse/docblock-cli

```

## Usage

```bash

docblock-cli -f myFile.js -f anotherFile.js

```

This will echo JSON output into your console.