Import Cost 项目技术文档

Import Cost 项目技术文档

import-cost displays the import size of the package you are importing inside the code editor 项目地址: https://gitcode.com/gh_mirrors/im/import-cost

1. 安装指南

1.1 安装 VSCode 扩展

Import Cost 项目提供了一个 VSCode 扩展，用户可以直接从 VSCode 市场安装。以下是安装步骤：

1. 打开 VSCode。
2. 点击左侧活动栏中的扩展图标（或按 Ctrl+Shift+X）。
3. 在搜索框中输入 Import Cost。
4. 找到 Import Cost 扩展，点击 Install 按钮进行安装。

1.2 安装 Node 模块

如果你需要使用 Import Cost 的 Node 模块来开发其他 IDE 的扩展，可以按照以下步骤进行安装：

1. 打开终端。
2. 运行以下命令安装 Node 模块：

   npm install import-cost
   

2. 项目的使用说明

2.1 VSCode 扩展使用

安装完成后，Import Cost 扩展会自动在 VSCode 编辑器中显示导入包的大小。用户无需额外配置，只需在编辑 JavaScript 或 TypeScript 文件时，扩展会自动计算并显示每个导入包的大小。

2.2 Node 模块使用

如果你使用的是 Node 模块，可以通过以下方式在你的项目中使用：

const importCost = require('import-cost');

importCost('path/to/your/file.js', 'javascript').then(packages => {
    console.log(packages);
});

3. 项目 API 使用文档

3.1 importCost 函数

• 描述: 计算指定文件中导入包的大小。
• 参数:
  • filePath (String): 要计算的文件路径。
  • language (String): 文件的语言类型，支持 javascript 和 typescript。
• 返回值: 返回一个 Promise，解析为一个包含导入包大小信息的数组。

3.2 返回值示例

[
    {
        "basePackage": "react",
        "size": 12345,
        "gzip": 5432
    },
    {
        "basePackage": "lodash",
        "size": 67890,
        "gzip": 1234
    }
]

4. 项目安装方式

4.1 从源码安装

如果你希望从源码安装并进行开发，可以按照以下步骤进行：

1. 克隆项目仓库：

   git clone git@github.com:wix/import-cost.git
   

2. 安装依赖：

   npm install
   

3. 打开 VSCode 工作区：

   code packages/import-cost
   code packages/vscode-import-cost
   

4. 运行测试：

   npm test
   

4.2 发布新版本

如果你对项目进行了修改并希望发布新版本，可以按照以下步骤进行：

1. 提交所有更改：

   git commit -a -m "releasing version X.X.X"
   git push
   

2. 发布 import-cost 模块：

   cd packages/import-cost
   npm version patch | minor | major
   npm publish
   

3. 发布 VSCode 扩展：

   cd packages/vscode-import-cost
   npm version patch | minor | major
   vsce publish
   

通过以上步骤，你可以轻松地安装、使用和发布 Import Cost 项目。希望这篇文档能帮助你更好地理解和使用该项目。

import-cost displays the import size of the package you are importing inside the code editor 项目地址: https://gitcode.com/gh_mirrors/im/import-cost