strip-comments

2018-12-08 admin

strip-comments是什么

什么是strip-comments,Strip comments from code. Removes line comments, block comments, the first comment only, or all comments. Optionally leave protected comments unharmed.

strip-comments使用教程帮助文档

strip-comments NPM version NPM monthly downloads NPM total downloads Linux Build Status

Strip comments from code. Removes line comments, block comments, the first comment only, or all comments. Optionally leave protected comments unharmed.

Please consider following this project’s author, Jon Schlinkert, and consider starring the project to show your <g-emoji class=“g-emoji” alias=“heart” fallback-src=“https://assets-cdn.github.com/images/icons/emoji/unicode/2764.png”>❤️</g-emoji> and support.

  • Install
  • Usage
  • API
  • About

(TOC generated by verb using markdown-toc)

Install

Install with npm:

$ npm install --save strip-comments

Usage

By default all comments are stripped.

const strip = require('strip-comments');
const str = strip('const foo = "bar";// this is a comment\n /* me too *\/');
console.log(str);
// => 'const foo = "bar";\n'

For more use-cases see the tests

API

strip

Strip all code comments from the given input, including protected comments that start with !, unless disabled by setting options.keepProtected to true.

Params

  • input {String}: string from which to strip comments
  • options {Object}: optional options, passed to extract-comments
  • returns {String}: modified input

Options

  • line {Boolean}: if false strip only block comments, default true
  • block {Boolean}: if false strip only line comments, default true
  • keepProtected {Boolean}: Keep ignored comments (e.g. /*!, /**! and //!)
  • preserveNewlines {Boolean}: Preserve newlines after comments are stripped

Example

const str = strip('const foo = "bar";// this is a comment\n /* me too */');
console.log(str);
// => 'const foo = "bar";'

.block

Strip only block comments.

Params

  • input {String}: string from which to strip comments
  • options {Object}: pass opts.keepProtected: true to keep ignored comments (e.g. /*!)
  • returns {String}: modified string

Example

const strip = require('..');
const str = strip.block('const foo = "bar";// this is a comment\n /* me too */');
console.log(str);
// => 'const foo = "bar";// this is a comment'

.line

Strip only line comments.

Params

  • input {String}: string from which to strip comments
  • options {Object}: pass opts.keepProtected: true to keep ignored comments (e.g. //!)
  • returns {String}: modified string

Example

const str = strip.line('const foo = "bar";// this is a comment\n /* me too */');
console.log(str);
// => 'const foo = "bar";\n/* me too */'

.first

Strip the first comment from the given input. Or, if opts.keepProtected is true, the first non-protected comment will be stripped.

Params

  • input {String}
  • options {Object}: pass opts.keepProtected: true to keep comments with !
  • returns {String}

Example

const output = strip.first(input, { keepProtected: true });
console.log(output);
// => '//! first comment\nfoo; '

About

<details><summary>Contributing</summary>

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.</details> <details><summary>Running Tests</summary>

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test
```</details> <details><summary>**Building docs**</summary>

_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](https://github.com/jonschlinkert/strip-comments/blob/master/.verb.md) readme template.)_

To generate the readme, run the following command:

```source-shell
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```</details> 

### Related projects

You might also be interested in these projects:

*   [babel-extract-comments](https://www.npmjs.com/package/babel-extract-comments): Uses babel (babylon) to extract JavaScript code comments from a JavaScript string or file. | [homepage](https://github.com/jonschlinkert/babel-extract-comments "Uses babel (babylon) to extract JavaScript code comments from a JavaScript string or file.")
*   [code-context](https://www.npmjs.com/package/code-context): Parse a string of javascript to determine the context for functions, variables and comments based… [more](https://github.com/jonschlinkert/code-context) | [homepage](https://github.com/jonschlinkert/code-context "Parse a string of javascript to determine the context for functions, variables and comments based on the code that follows.")
*   [extract-comments](https://www.npmjs.com/package/extract-comments): Uses esprima to extract line and block comments from a string of JavaScript. Also optionally… [more](https://github.com/jonschlinkert/extract-comments) | [homepage](https://github.com/jonschlinkert/extract-comments "Uses esprima to extract line and block comments from a string of JavaScript. Also optionally parses code context (the next line of code after a comment).")
*   [parse-code-context](https://www.npmjs.com/package/parse-code-context): Parse code context in a single line of javascript, for functions, variable declarations, methods, prototype… [more](https://github.com/jonschlinkert/parse-code-context) | [homepage](https://github.com/jonschlinkert/parse-code-context "Parse code context in a single line of javascript, for functions, variable declarations, methods, prototype properties, prototype methods etc.")
*   [parse-comments](https://www.npmjs.com/package/parse-comments): Parse code comments from JavaScript or any language that uses the same format. | [homepage](https://github.com/jonschlinkert/parse-comments "Parse code comments from JavaScript or any language that uses the same format.")

### Contributors

| **Commits** | **Contributor** |
| --- | --- |
| 59 | [jonschlinkert](https://github.com/jonschlinkert) |
| 4 | [charlike-old](https://github.com/charlike-old) |
| 2 | [mk-pmb](https://github.com/mk-pmb) |
| 1 | [kgryte](https://github.com/kgryte) |
| 1 | [epicoxymoron](https://github.com/epicoxymoron) |

### Author

**Jon Schlinkert**

*   [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)
*   [GitHub Profile](https://github.com/jonschlinkert)
*   [Twitter Profile](https://twitter.com/jonschlinkert)

### License

Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert). Released under the [MIT License](https://github.com/jonschlinkert/strip-comments/blob/master/LICENSE).

* * *

_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on March 24, 2018._
你可能感兴趣的文章:

本站文章除注明转载外,均为本站原创或编译。欢迎任何形式的转载,但请务必注明出处。

转载请注明:文章转载自 JavaScript中文网 [https://www.javascriptcn.com]

本文地址:https://www.javascriptcn.com/read-47630.html

文章标题:strip-comments

回到顶部