diff options
| author | ruki <waruqi@gmail.com> | 2018-11-08 00:38:48 +0800 |
|---|---|---|
| committer | ruki <waruqi@gmail.com> | 2018-11-07 21:53:09 +0800 |
| commit | 26105034da4fcce7ac883c899d781f016559310d (patch) | |
| tree | c459a5dc4e3aa0972d9919033ece511ce76dd129 /node_modules/babel-extract-comments/index.js | |
| parent | 2c77f00f1a7ecb6c8192f9c16d3b2001b254a107 (diff) | |
| download | xmake-docs-26105034da4fcce7ac883c899d781f016559310d.tar.gz xmake-docs-26105034da4fcce7ac883c899d781f016559310d.zip | |
switch to vuepress
Diffstat (limited to 'node_modules/babel-extract-comments/index.js')
| -rw-r--r-- | node_modules/babel-extract-comments/index.js | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/node_modules/babel-extract-comments/index.js b/node_modules/babel-extract-comments/index.js new file mode 100644 index 00000000..0b9d142a --- /dev/null +++ b/node_modules/babel-extract-comments/index.js @@ -0,0 +1,63 @@ +/*! + * babel-extract-comments <https://github.com/jonschlinkert/babel-extract-comments> + * + * Copyright (c) 2014-2018, Jon Schlinkert. + * Released under the MIT License. + */ + +'use strict'; + +const fs = require('fs'); +const path = require('path'); +const babylon = require('babylon'); + +/** + * Extract code comments from the given `string`. + * + * ```js + * var extract = require('babel-extract-comments'); + * console.log(extract('// this is a code comment')); + * // [{ type: 'CommentBlock', + * // value: '!\n * babel-extract-comments <https://github.com/jonschlinkert/babel-extract-comments>\n *\n * + * // Copyright (c) 2014-2018, Jon Schlinkert.\n * Released under the MIT License.\n ', + * // start: 0, + * // end: 173, + * // loc: SourceLocation { start: [Position], end: [Position] } }] + * ``` + * @param {String} `string` String of javascript + * @return {Array} Array of code comment objects. + * @api public + */ + +function extract(str, options) { + const res = babylon.parse(str, options); + return res.comments; +} + +/** + * Extract code comments from a JavaScript file. + * + * ```js + * console.log(extract.file('some-file.js'), { cwd: 'some/path' }); + * // [ { type: 'Line', + * // value: ' this is a line comment', + * // range: [ 0, 25 ], + * // loc: { start: { line: 1, column: 0 }, end: { line: 1, column: 25 } } } ] + * ``` + * @param {String} `file` Filepath to the file to parse. + * @param {Object} `options` Options to pass to [esprima][]. + * @return {Array} Array of code comment objects. + * @api public + */ + +extract.file = function(file, options) { + const opts = Object.assign({ cwd: process.cwd() }, options); + const str = fs.readFileSync(path.resolve(opts.cwd, file), 'utf8'); + return extract(str, options); +}; + +/** + * Expose `extract` + */ + +module.exports = extract; |
