请问npm包有何规范?

好一点的npm包中打开看会有lib,es,dist各种文件夹,请问是否存在什么规范之类的,而不是简单的打成一个index.js和一个index.css。
image.png

阅读 153
评论
    2 个回答
    • 11.6k
    1. package.json 里用 main 标记入口文件
    2. 使用 .npmignore 可以屏蔽掉不需要的文件
    3. 其它就没什么了,基本上可以自己随便,按照使用需要和习惯来定

      npm 没有强制要求。

      而且这不是 npm 的包规范,二是 node 项目的目录规范。

      一般来说根目录下会存在这么几个文件夹:

      • src:源码源文件。
      • lib:依赖文件(没通过 npm,直接下载源码的那种)。
      • node_modules:npm 依赖文件。
      • bin:二进制可执行文件。
      • tests:单元测试或集成测试文件。
      • docs:文档、开发手册。
      • examples:示例代码或项目。
      • build:构建时所需文件。
      • dist:打包后的输出目录。

      没有相应的就不建;总共就一个文件的也用不着分 srcnode_modulesdist 一般不提交到 git 仓库里。

      至于 npm publish 出来的文件包含上述哪些,你即可以在 package.jsonfiles 里配置包含哪些,也可以在 .npmignore 里配置忽略哪些。

      你截图里这个 es 没见过,感觉是 ES Module 的缩写。一般打包出来的模块化都是 UMD 的,你这个可能为了直接提供 ES 原生模块化方法?

        撰写回答

        登录后参与交流、获取后续更新提醒