Skip to content

Commit 18dd2cf

Browse files
committed
output only lineno, filename and path from .meta
1 parent 6650642 commit 18dd2cf

4 files changed

Lines changed: 32 additions & 14 deletions

File tree

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -224,10 +224,10 @@ var parse = require("jsdoc-parse")
224224
* [jsdoc-parse](#module_jsdoc-parse)
225225
* [jsdocParse([options])](#exp_module_jsdoc-parse--jsdocParse) ⇒ <code>[TransformStream](http://nodejs.org/api/stream.html#stream_class_stream_transform)</code> ⏏
226226
* [~ParseOptions](#module_jsdoc-parse--jsdocParse..ParseOptions)
227-
* [.src](#module_jsdoc-parse--jsdocParse..ParseOptions+src) : <code>string</code> &#124; <code>Array.&lt;string&gt;</code>
228-
* [.private](#module_jsdoc-parse--jsdocParse..ParseOptions+private) : <code>boolean</code>
229-
* [.stats](#module_jsdoc-parse--jsdocParse..ParseOptions+stats) : <code>boolean</code>
230-
* [.html](#module_jsdoc-parse--jsdocParse..ParseOptions+html) : <code>boolean</code>
227+
* [.src](#module_jsdoc-parse--jsdocParse..ParseOptions.ParseOptions+src) : <code>string</code> &#124; <code>Array.&lt;string&gt;</code>
228+
* [.private](#module_jsdoc-parse--jsdocParse..ParseOptions.ParseOptions+private) : <code>boolean</code>
229+
* [.stats](#module_jsdoc-parse--jsdocParse..ParseOptions.ParseOptions+stats) : <code>boolean</code>
230+
* [.html](#module_jsdoc-parse--jsdocParse..ParseOptions.ParseOptions+html) : <code>boolean</code>
231231
* [.sort-by](#module_jsdoc-parse--jsdocParse..ParseOptions+sort-by) : <code>array</code>
232232

233233
<a name="exp_module_jsdoc-parse--jsdocParse"></a>
@@ -249,13 +249,13 @@ All options for jsdoc-parse, including defaults
249249
**Kind**: inner class of <code>[jsdocParse](#exp_module_jsdoc-parse--jsdocParse)</code>
250250

251251
* [~ParseOptions](#module_jsdoc-parse--jsdocParse..ParseOptions)
252-
* [.src](#module_jsdoc-parse--jsdocParse..ParseOptions+src) : <code>string</code> &#124; <code>Array.&lt;string&gt;</code>
253-
* [.private](#module_jsdoc-parse--jsdocParse..ParseOptions+private) : <code>boolean</code>
254-
* [.stats](#module_jsdoc-parse--jsdocParse..ParseOptions+stats) : <code>boolean</code>
255-
* [.html](#module_jsdoc-parse--jsdocParse..ParseOptions+html) : <code>boolean</code>
252+
* [.src](#module_jsdoc-parse--jsdocParse..ParseOptions.ParseOptions+src) : <code>string</code> &#124; <code>Array.&lt;string&gt;</code>
253+
* [.private](#module_jsdoc-parse--jsdocParse..ParseOptions.ParseOptions+private) : <code>boolean</code>
254+
* [.stats](#module_jsdoc-parse--jsdocParse..ParseOptions.ParseOptions+stats) : <code>boolean</code>
255+
* [.html](#module_jsdoc-parse--jsdocParse..ParseOptions.ParseOptions+html) : <code>boolean</code>
256256
* [.sort-by](#module_jsdoc-parse--jsdocParse..ParseOptions+sort-by) : <code>array</code>
257257

258-
<a name="module_jsdoc-parse--jsdocParse..ParseOptions+src"></a>
258+
<a name="module_jsdoc-parse--jsdocParse..ParseOptions.ParseOptions+src"></a>
259259
##### parseOptions.src : <code>string</code> &#124; <code>Array.&lt;string&gt;</code>
260260
A list of javascript source files (or glob expressions) to parse for documentation. If this option is not set jsdoc-parse will wait for source code on stdin (i.e. `cat *.js | jsdoc-parse <options>`).
261261

@@ -271,18 +271,18 @@ parse({ src: "example.js" }).pipe(process.stdout)
271271
// or pipe in source code
272272
fs.createReadStream("example.js").parse().pipe(process.stdout)
273273
```
274-
<a name="module_jsdoc-parse--jsdocParse..ParseOptions+private"></a>
274+
<a name="module_jsdoc-parse--jsdocParse..ParseOptions.ParseOptions+private"></a>
275275
##### parseOptions.private : <code>boolean</code>
276276
Include identifier documentation marked as `@private` in the output
277277

278278
**Kind**: instance property of <code>[ParseOptions](#module_jsdoc-parse--jsdocParse..ParseOptions)</code>
279279
**Default**: <code>false</code>
280-
<a name="module_jsdoc-parse--jsdocParse..ParseOptions+stats"></a>
280+
<a name="module_jsdoc-parse--jsdocParse..ParseOptions.ParseOptions+stats"></a>
281281
##### parseOptions.stats : <code>boolean</code>
282282
Print a few stats about the doclets parsed
283283

284284
**Kind**: instance property of <code>[ParseOptions](#module_jsdoc-parse--jsdocParse..ParseOptions)</code>
285-
<a name="module_jsdoc-parse--jsdocParse..ParseOptions+html"></a>
285+
<a name="module_jsdoc-parse--jsdocParse..ParseOptions.ParseOptions+html"></a>
286286
##### parseOptions.html : <code>boolean</code>
287287
Enable experimental parsing of .html files.
288288

es5/transform.js

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,15 @@ function removeUnwanted(identifier) {
171171
delete identifier.___id;
172172
delete identifier.___s;
173173

174+
if (identifier.meta) {
175+
var oldMeta = identifier.meta;
176+
identifier.meta = {
177+
lineno: oldMeta.lineno,
178+
filename: oldMeta.filename,
179+
path: oldMeta.path
180+
};
181+
}
182+
174183
return identifier;
175184
}
176185

lib/jsdoc-parse.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ jsdocParse.cliOptions = cliOptions.definitions
3232
class ParseOptions {
3333
constructor () {
3434
/**
35-
* A list of javascript source files (or glob expressions) to parse for documentation. If this option is not set jsdoc-parse will wait for source code on stdin (i.e. `cat *.js | jsdoc-parse <options>`).
35+
* A list of javascript source files (or glob expressions) to parse for documentation. If this option is not set jsdoc-parse will wait for source code on stdin (i.e. `cat *.js | jsdoc-parse <options>`).
3636
* @type {string | string[]}
3737
* @example
3838
* var parse = require("jsdoc-parse")
@@ -67,7 +67,7 @@ class ParseOptions {
6767
this.html = false
6868

6969
/**
70-
* Sort by one of more fields, e.g. `--sort-by kind category`. Pass the special value `none` to * remove the default sort order.
70+
* Sort by one of more fields, e.g. `--sort-by kind category`. Pass the special value `none` to remove the default sort order.
7171
* @member module:jsdoc-parse~ParseOptions#sort-by
7272
* @type {array}
7373
* @default

lib/transform.js

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,15 @@ function removeUnwanted (identifier) {
185185
delete identifier.___id
186186
delete identifier.___s
187187

188+
if (identifier.meta) {
189+
const oldMeta = identifier.meta
190+
identifier.meta = {
191+
lineno: oldMeta.lineno,
192+
filename: oldMeta.filename,
193+
path: oldMeta.path
194+
}
195+
}
196+
188197
return identifier
189198
}
190199

0 commit comments

Comments
 (0)