npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

extract-documentation-comments

v0.4.2

Published

Simply extract documentation comments from a source file.

Downloads

77

Readme

extract-documentation-comments

standard-readme compliant Semantic Versioning 2.0.0 License npm CI Coverage Status Conventional Commits

Simply extract documentation comments from a source file.

Table of Contents

Background

I created this project because I felt all of the other "parse source-code comments to generate documentation" solutions were unsatisfactory for what I needed.

  • Doxygen Is dated, obtuse, and its assumptions make it difficult to extend to languages without very C-like syntax.
  • JavaDoc, JSDoc, or any other <LANGUAGE NAME>Doc-type solution are, obviously, limited to a single language; they can usually only produce opinionated HTML natively, relying on unmaintained third-party extensions to produce anything else; and they all have slightly unique syntaxes that are confusingly similar yet problematically different.
  • Natural Docs Well definitely my favourite solution I've seen so far, its comment syntax is breezy and readable and it can easily be extended to any language, it still suffers from the issue of only natively producing HTML and its syntax can be pretty limited.

Plus, I found all of the documentation solutions above to be kind of poorly documented (with the possible exception of Natural Docs) which is kind of ironic ... so I decided to create my own ultra-minimalist solution to the "generate document from special source code comments" problem!

extract-documentation-comments does just that: it simply extracts any documentation between /** and */ lines in a source code file, or any input really. Why? Because:

  • It's simple stupid: can easily be modified or extended to any specific use case.
  • It makes zero assumptions about the text between the /** and */ so you're free to markup the text in any way you want; Markdown, reStructuredText, XML, whatever and convert it to what you need after the fact. I recommend PanDoc for this.
  • It can easily be finagled to be backwards compatible with any existing source-code documenting solution.

Install

Using pnpm:

pnpm add --save extract-documentation-comments

It can, of course, also be installed by npm or Yarn using the normal methods.

Usage

To use the command-line interface pnpm extract-documentation-comments or just extract-documentation-comments if installed globally.

CLI

extract-documentation-comments

  Simply extract documentation comments from a source file. 

Options

  -h, --help                 Writes this help text to STDOUT.                                              
  -n, --noop                 [Reserved] Show what would be done without actually doing it.                 
  -v, --verbose              Verbose output to STDERR.                                                     
  -V, --version              Writes version information to STDOUT.                                         
  -x, --no-quick-exit        Don't immediately exit after printing help, version, and/or config            
                             information.                                                                  
  -i, --stdin                Read input from STDIN.                                                        
  -I, --input string[]       The path to the file to read input from. Multiple paths can be specified with 
                             this option, doing so will activate multi-file mode: in this mode,            
                             `--output` must also be used and given the name of the directory place the    
                             extracted documentation for each input file.                                  
  -t, --test                 Run unit tests and exit.                                                      
  -o, --stdout               Write output to STDOUT.                                                       
  -O, --output string        The name of the file to write output to or, in the case of us passing         
                             multiple paths to `--input`, the name of the directory to place the generated 
                             documentation files.                                                          
  -p, --pasteboard           [Reserved] Copy output to pasteboard (clipboard).                             
  -c, --config               Print search paths and configuration values to STDOUT.                        
  -C, --config-file string   [Reserved] Use the given config file instead of the default.                  

API

import * as ExtractDocumentationComments from 'extract-documentation-comments';

See API.md for full API.

Contributing

Changes are tracked in CHANGELOG.md.

License

MIT ©2020 Anadian

SEE LICENSE IN LICENSE

Creative Commons License
This project's documentation is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.