@genesiscommunitysuccess/analyzer-import-alias-plugin

中文文档
5.0.3发布于 2024/02/14MITTypeScriptES Module近 30 天下载 2万

自定义元素显示解析器处理导入别名的插件

中文使用文档
文档目录3 节
  1. 使用量
  2. 安装
  3. 配置

这个 创世纪全球 社区成功倡议致力于开放资源选择技术,我们认为开放资源社区将从中受益.

NPM version License

分析器导入异名插件

此插件允许您围绕导出分析器使用的 AST 导入异名的限制工作 。 考虑以下模式,如果使用组件设计系统和系统,则使用:

// Imported Button class is a custom element.
import { Button as LibButton } from 'my-library';

// Exported Button has extra styling applied to fit your design system.
export class Button extends LibButton { }

这允许您将您的自定义样式应用到库按钮并用同名导出,然后您的库的消费者可以互换导入来得到您的样式. 但是,这有问题...

AST 解析器,赋予分析器权力的解析器将寻找一个名为 LibButton 在您的图书库中, 当完成您阶级的继承树时依赖关系 Button但是因为这个班实际上叫做 Button 在图书馆,继承树被打破。 这意味着,在你的清单上,任何成员,你的 Button 类继承 my-library 阶级(或更高等的继承者)将在表里丧失.

此插件将允许您修复这个问题 .

使用量

安装

在您使用自定义元素显示分析器的同一工程中, 安装此软件包作为 dev 依赖性 .

npm i @genesiscommunitysuccess/analyzer-import-alias-plugin --save-dev

您需要应用此插件到 plugins 在您的设置中 custom-elements-manifest.config.mjs,参见 这里。 。 。 .

配置

在显示配置中的插件阵列中添加插件本身不会完成任何任务, 您还必须配置插件处理名称别名的方式 。 您可以为每个 npm 软件包添加配置, 如以下 .

import aliasPlugin from '@genesiscommunitysuccess/analyzer-import-alias-plugin';

export default {
    dependencies: true,
    plugins: [
        aliasPlugin({
            'my-library': {
                '*': (name) => name.replace('Lib','')
            }
        })
    ]
}

这将有效处理任何从 my-library 就像没有 Lib 前缀,所以在读取器的第一个示例中,本地 Button 类会从软件包中正确继承 Button 课.

囊括所有函数的形状定义为 * 实值 (name: string) => string 因此,您可能执行比上述例子更复杂的逻辑来变异名称。 如果您不想更改名称, 您应该返回输入名称 .

还可以选择为以下名称设定具体的替换:

aliasPlugin({
    'my-library': {
        '*': (name) => name.replace('Lib', ''),
        LibButton: 'MyButton',
        LibCheckbox: (name) => name.replace('Lib', 'My'),
    }
})

当使用上方配置时 LibButton 超阶级的遗产将被视为 MyButton。 。 。 . 重要任何明确的定义将优先于全面定义 * 函数.

为完整起见,您可以任意定义尽可能多的图书导入.

aliasPlugin({
    'my-library': { 
        LibButton: 'MyButton'
    },
    'another-library': {
        '*': (name) => name.replace('Another', ''),
    }
})

版本与发布记录

@genesiscommunitysuccess/analyzer-import-alias-plugin 共发布 18 个版本,首次发布于 2023/10/17;过去 12 个月发布了 0 个版本。

版本发布日期距今
5.0.3latest2024/02/142 年前
5.0.22023/12/202 年前
5.0.12023/12/202 年前
5.0.02023/12/132 年前
4.1.32023/12/122 年前
4.1.22023/12/122 年前

其他发布通道:prerelease → 2.1.1-prerelease.2。

关于 @genesiscommunitysuccess/analyzer-import-alias-plugin 的常见问题

@genesiscommunitysuccess/analyzer-import-alias-plugin 是什么?

自定义元素显示解析器处理导入别名的插件

如何安装 @genesiscommunitysuccess/analyzer-import-alias-plugin?

在项目目录运行 npm install @genesiscommunitysuccess/analyzer-import-alias-plugin,或使用 pnpm add / yarn add / bun add。

@genesiscommunitysuccess/analyzer-import-alias-plugin 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@genesiscommunitysuccess/analyzer-import-alias-plugin 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@genesiscommunitysuccess/analyzer-import-alias-plugin 可以商用吗?

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

@genesiscommunitysuccess/analyzer-import-alias-plugin 的下载量有多少?

根据 npm 官方下载统计,@genesiscommunitysuccess/analyzer-import-alias-plugin 在 2026/10/16 – 2026/11/14 这 30 天内被下载 20,373 次,日均约 679 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@genesiscommunitysuccess/analyzer-import-alias-plugin 还在维护吗?

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