https://github.com/indutny/common-shake

CommonJS Tree Shaker API
https://github.com/indutny/common-shake

commonjs tree-shaking

Last synced: about 1 month ago
JSON representation

CommonJS Tree Shaker API

• Host: GitHub
• URL: https://github.com/indutny/common-shake
• Owner: indutny
• Created: 2017-06-27T04:31:32.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-03-16T12:53:51.000Z (over 6 years ago)
• Last Synced: 2024-05-09T06:21:28.636Z (2 months ago)
• Topics: commonjs, tree-shaking
• Language: JavaScript
• Homepage:
• Size: 99.6 KB
• Stars: 151
• Watchers: 12
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Lists

• awesome-stars - common-shake - CommonJS Tree Shaker API (JavaScript)

README

        
# CommonJS Tree Shaker

[![NPM version](https://badge.fury.io/js/common-shake.svg)](http://badge.fury.io/js/common-shake)

[![Build Status](https://secure.travis-ci.org/indutny/common-shake.svg)](http://travis-ci.org/indutny/common-shake)

See [webpack-common-shake][0] for [webpack][1] plugin.

## Usage

```js

const acorn = require('acorn');

const Analyzer = require('common-shake').Analyzer;

const a = new Analyzer();

a.run(acorn.parse(`

  'use strict';

  const lib = require('./a.js');

  exports.a = lib.a;

`, { locations: true }), 'index.js');

a.run(acorn.parse(`

  'use strict';

  exports.a = 42;

`, { locations: true }), 'a.js');

a.resolve('index.js', './a.js', 'a.js');

console.log(a.isSuccess(), a.bailouts);

// true false

console.log(a.getModule('index.js').getInfo());

// { bailouts: false, declarations: [ 'a' ], uses: [] }

console.log(a.getModule('a.js').getInfo());

// { bailouts: false, declarations: [ 'a' ], uses: [ 'a' ] }

const module = a.getModule('a.js');

a.getDeclarations().forEach((decl) => {

  console.log(module.isUsed(decl.name) ? 'used' : 'not used');

  console.log(decl.name, decl.ast);

});

// If you want to mark all exported values of module as used:

a.getModule('root').forceExport();

```

## Graphviz

For debugging and inspection purposes a graph in [dot][2] format may be

generated from the modules hierarchy using following API:

```js

const Graph = require('common-shake').Graph;

const graph = new Graph('/path/to/working/dir');

console.log(graph.generate(analyzer.getModules()));

```

## LICENSE

This software is licensed under the MIT License.

Copyright Fedor Indutny, 2017.

Permission is hereby granted, free of charge, to any person obtaining a

copy of this software and associated documentation files (the

"Software"), to deal in the Software without restriction, including

without limitation the rights to use, copy, modify, merge, publish,

distribute, sublicense, and/or sell copies of the Software, and to permit

persons to whom the Software is furnished to do so, subject to the

following conditions:

The above copyright notice and this permission notice shall be included

in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS

OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN

NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,

DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR

OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE

USE OR OTHER DEALINGS IN THE SOFTWARE.

[0]: https://github.com/indutny/webpack-common-shake

[1]: https://webpack.github.io/

[2]: http://www.graphviz.org/content/dot-language