Skip to content

A small utility to strip out jsDoc-style comments from a JavaScript file

License

Notifications You must be signed in to change notification settings

MichaelRFox/fxStripJsDoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

fxStripJsDoc

npm version npm bundle size npm GitHub last commit GitHub top language NPM

Description

fxStripJsDoc is used to strip out jsDoc-style comments from a JavaScript file. One may want to do this to reduce the size of a distribution file while retaining jsDoc comments in the source file. This utility will not strip out inline comments.

Example:

/**
 * @desc The fxStripJsDoc utility will strip out comments
 * like this one.
 */

/** Or single line comments like this one */

// but not comments like this

Installation

npm install fxstripjsdoc --save-dev

Usage

The fxStripJsDoc utility takes one required argument, the path to the file to be stripped. To use the the fxStripJsDoc utility simply add a script to your package.json file like this:

"scripts": {
	"stripComments": "fxstripjsdoc ./dist/myFile.js"
}

About

A small utility to strip out jsDoc-style comments from a JavaScript file

Resources

License

Stars

Watchers

Forks

Packages

No packages published