Socket
Socket
Sign inDemoInstall

extract-function

Package Overview
Dependencies
54
Maintainers
1
Versions
8
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    extract-function

Extract module using comment in the source code.


Version published
Maintainers
1
Created

Readme

Source

GitHub release

You can extract the function in the source code and use it for testing.

Installation

npm i extract-function --save-dev

Using module in source code

var sourceCode = `
  /**
   * @extract BasicFunc
   * */
  function basicFunc() {
    // OK
  }
  function test() {
    // OK
  }
  `;
var ExtractFunction = require("extract-function");
var ef = new ExtractFunction(sourceCode);
ef.hasAnnotationName("extract"); // -> `true`
ef.getAnnotationnValue("extract"); // -> `BasicFunc`
ef.getComments(); // -> `/**\n    * @extract BasicFunc\n    * */`
ef.getClosestFunction(); // -> `function basicFuc() {\n      // OK\n    }`

Using the Command Line

Usage

  extract-function --src files --out directory --beautify boolean

Example

  $ extract-function -s ./src/**.js -o ./test/extractFiles --beatufiy false

Options

  -s, --src files          A list of files containing annotations to extract.
  -o, --out directory      The directory where extracted files will be created.
  -b, --beautify boolean   Apply beautify-js to the extracted files.
  --help                   Display this usage guide.

Demo

./node_modules/.bin/extract-function -s ./test/sample.js -o ./result
(() => {
  /**
   * @extract BasicFunc
   * */
  function basicFunc() {
    // OK
  }

  /**
   * @extract ArgsTest
   * */
  function argsTest(a, b, c, d) {
    // OK
  }

  /**
   * @extract FunctionLiteral
   * */
  var functionLiteral = function () {
    // OK
  };

  var obj = {
    /**
     * @extract ObjectInFunction
     * */
    objInFunction: function () {
      // OK
    },
  };

  /**
   * @extract AnonymousFunction
   * */
  (function () {
    // OK
  })();

  function outerFunction() {
    /**
     * @extract InnerFunction
     * */
    function innerFunction() {
      // OK
    }
  }
});

Output : A list of extracted files.

./result
├── AnonymousFunction.js
├── ArgsTest.js
├── BasicFunc.js
├── FunctionLiteral.js
├── InnerFunction.js
└── ObjectInFunction.js

Keywords

FAQs

Last updated on 24 Aug 2017

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc