@goto-bus-stop/common-shake

中文文档
2.4.1发布于 2024/01/04MITCommonJS近 30 天下载 9.6万

CommonJS Tree Shake (fork)

原始使用文档
文档目录3 节
  1. Usage
  2. Graphviz
  3. LICENSE

@goto-bus-stop/common-shake

NPM version Build Status

This is a fork of indutny/common-shake, pending #3.


See webpack-common-shake for webpack plugin. See common-shakeify for a browserify plugin.

Usage

const acorn = require('acorn');
const Analyzer = require('@goto-bus-stop/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 format may be generated from the modules hierarchy using following API:

const Graph = require('@goto-bus-stop/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.

版本与发布记录

@goto-bus-stop/common-shake 共发布 4 个版本,首次发布于 2018/04/11;过去 12 个月发布了 0 个版本。

版本发布日期距今
2.4.1latest2024/01/042 年前
2.4.02020/03/106 年前
2.3.02019/06/307 年前
2.2.02018/04/118 年前

关于 @goto-bus-stop/common-shake 的常见问题

@goto-bus-stop/common-shake 是什么?

CommonJS Tree Shake (fork)

如何安装 @goto-bus-stop/common-shake?

在项目目录运行 npm install @goto-bus-stop/common-shake,或使用 pnpm add / yarn add / bun add。

@goto-bus-stop/common-shake 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/goto-bus-stop__common-shake 是否存在。

@goto-bus-stop/common-shake 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@goto-bus-stop/common-shake 可以商用吗?

@goto-bus-stop/common-shake 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@goto-bus-stop/common-shake 的下载量有多少?

根据 npm 官方下载统计,@goto-bus-stop/common-shake 在 2026/10/17 – 2026/11/15 这 30 天内被下载 95,841 次,日均约 3,195 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@goto-bus-stop/common-shake 还在维护吗?

最新版本 2.4.1 发布于 2024/01/04(2 年前);至今共发布 4 个版本,其中过去 12 个月发布了 0 个;首次发布于 2018/04/11。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。