code-context

code-context

Parse a string of javascript to determine the context for functions, variables and comments based on the code that follows.

Currently supports:

• code comments
• function statements
• function expressions
• prototype methods
• prototype properties
• methods
• properties
• declarations

Install

Install with npm

$ npm i code-context --save

Usage

var parseContext = require('code-context');

Given the following code in my-app.js:

/**
 * My app
 */
var app = function(str) {
  return str
};

Pass my-app.js as a string:

var str = fs.readFileSync('my-app.js', 'utf8');
var context = parseContext(str);

Results in:

[{
  type: 'comment',
  begin: 1,
  end: 3
},
{
  begin: 4,
  type: 'function',
  name: 'app',
  string: 'app()',
  original: 'var app = function(str) {'
}]

Related projects

• extract-comments: Extract code comments from string or from a glob of files.
• parse-code-context: Parse code context in a single line of javascript, for functions, variable declarations, methods, prototype… more
• parse-comments: Parse code comments from JavaScript or any language that uses the same format.

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Authors

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright 2015 Jon Schlinkert Released under the MIT license.

---

This file was generated by verb-cli on August 01, 2015.