如何在npm软件包中拆分库及其插件?

如何解决如何在npm软件包中拆分库及其插件?

我正在使用JavaScript库,我希望将来的用户能够与主库一起选择要添加到项目中的插件。我在模块和webpack方面遇到了一些问题。我正在编写伪代码,以了解代码的组织方式。

我在主库中的index.js看起来像这样:

import ClassA from "./classA";
import ClassB from "./classB";

export default class MyLib { 
    .....
}
export { ClassA,ClassB } 

我可以使用webpack轻松输出库:

output: {
     path: ...
     filename: 'mylib.min.js',library: "MyLib",libraryTarget: "umd"
}

为了能够选择要添加的插件,我正在创建不同的npm包(每个插件一个),将MyLib添加为外部依赖项,然后执行以下操作:

import {ClassA,ClassB} from "MyLib";


class PluginA extends ClassB {
   constructor() {
      this.test = new ClassA();
   }
}

这很好用,但是,当“编译” PluginA时,webpack会将MyLib包含在PluginA的最终js文件中。如果我想包含多个插件,则代码将以主库的多个副本结束。

我的最终目标是组织代码,以便可以使用以下npm命令轻松安装它们,而无需到处重复代码:

npm install MyLib
npm install MyLib-PluginA
npm install MyLib-PluginB

当然,一个明显的解决方案是不对插件使用webpack,但我想将此选项保留为最后一个资源,以防其他任何事情起作用。

谢谢!

解决方法

我不建议使用webpack构建您的插件/库。相反,我会让图书馆的使用者决定他们自己的捆扎机。对于该库,最好的步骤应该只是将任何中间代码(如babel功能的JS或TypeScript)(如果需要)转译为可以由节点安全地require插入的内容。

此外,每个插件都应将MyLib作为peerDependency,而不是常规的依赖项。这样可以确保MyLib不会嵌套在插件的node_modules内部,从而避免重复项被捆绑在一起。为了进行单元测试,这些插件还可以将MyLib作为devDependency,但是重要的一点是,它从来都不是常规的dependency

,

深入研究webpack文档,我发现了一个使用webpack外部组件的解决方案。

从webpack文档中:

外部配置选项提供了一种从输出包中排除依赖项的方法。

我刚刚在Webpack的插件配置中添加了以下几行:

module.exports = {
    ...,externals: {
        mylib: { 
            commonjs: 'MyLib',commonjs2: 'MyLib',amd: 'MyLib',root: 'MyLib'
        }
    }
};

Webpack文档:https://webpack.js.org/configuration/externals/

希望这对其他人有帮助。

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。

相关推荐


依赖报错 idea导入项目后依赖报错,解决方案:https://blog.csdn.net/weixin_42420249/article/details/81191861 依赖版本报错:更换其他版本 无法下载依赖可参考:https://blog.csdn.net/weixin_42628809/a
错误1:代码生成器依赖和mybatis依赖冲突 启动项目时报错如下 2021-12-03 13:33:33.927 ERROR 7228 [ main] o.s.b.d.LoggingFailureAnalysisReporter : *************************** APPL
错误1:gradle项目控制台输出为乱码 # 解决方案:https://blog.csdn.net/weixin_43501566/article/details/112482302 # 在gradle-wrapper.properties 添加以下内容 org.gradle.jvmargs=-Df
错误还原:在查询的过程中,传入的workType为0时,该条件不起作用 <select id="xxx"> SELECT di.id, di.name, di.work_type, di.updated... <where> <if test=&qu
报错如下,gcc版本太低 ^ server.c:5346:31: 错误:‘struct redisServer’没有名为‘server_cpulist’的成员 redisSetCpuAffinity(server.server_cpulist); ^ server.c: 在函数‘hasActiveC
解决方案1 1、改项目中.idea/workspace.xml配置文件,增加dynamic.classpath参数 2、搜索PropertiesComponent,添加如下 <property name="dynamic.classpath" value="tru
删除根组件app.vue中的默认代码后报错:Module Error (from ./node_modules/eslint-loader/index.js): 解决方案:关闭ESlint代码检测,在项目根目录创建vue.config.js,在文件中添加 module.exports = { lin
查看spark默认的python版本 [root@master day27]# pyspark /home/software/spark-2.3.4-bin-hadoop2.7/conf/spark-env.sh: line 2: /usr/local/hadoop/bin/hadoop: No s
使用本地python环境可以成功执行 import pandas as pd import matplotlib.pyplot as plt # 设置字体 plt.rcParams['font.sans-serif'] = ['SimHei'] # 能正确显示负号 p
错误1:Request method ‘DELETE‘ not supported 错误还原:controller层有一个接口,访问该接口时报错:Request method ‘DELETE‘ not supported 错误原因:没有接收到前端传入的参数,修改为如下 参考 错误2:cannot r
错误1:启动docker镜像时报错:Error response from daemon: driver failed programming external connectivity on endpoint quirky_allen 解决方法:重启docker -> systemctl r
错误1:private field ‘xxx‘ is never assigned 按Altʾnter快捷键,选择第2项 参考:https://blog.csdn.net/shi_hong_fei_hei/article/details/88814070 错误2:启动时报错,不能找到主启动类 #
报错如下,通过源不能下载,最后警告pip需升级版本 Requirement already satisfied: pip in c:\users\ychen\appdata\local\programs\python\python310\lib\site-packages (22.0.4) Coll
错误1:maven打包报错 错误还原:使用maven打包项目时报错如下 [ERROR] Failed to execute goal org.apache.maven.plugins:maven-resources-plugin:3.2.0:resources (default-resources)
错误1:服务调用时报错 服务消费者模块assess通过openFeign调用服务提供者模块hires 如下为服务提供者模块hires的控制层接口 @RestController @RequestMapping("/hires") public class FeignControl
错误1:运行项目后报如下错误 解决方案 报错2:Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:3.8.1:compile (default-compile) on project sb 解决方案:在pom.
参考 错误原因 过滤器或拦截器在生效时,redisTemplate还没有注入 解决方案:在注入容器时就生效 @Component //项目运行时就注入Spring容器 public class RedisBean { @Resource private RedisTemplate<String
使用vite构建项目报错 C:\Users\ychen\work>npm init @vitejs/app @vitejs/create-app is deprecated, use npm init vite instead C:\Users\ychen\AppData\Local\npm-