如何正确地配置入口文件?

网站建设2年前发布
18 00

在node中支持两种模块方案——CommonJS(cjs) 和 ECMAScript modules (esm)。
,随着ESModule的广泛使用,社区生态也在逐渐转向ESModule,ESModule相比于require的运行时执行,可以用来做一些静态代码分析如tree shaking等来减小代码体积,但是由于CommonJS已有庞大的用户基础,对于第三方库作者来说,不能完全一刀切只用ESModule,还要兼容CommonJS场景的使用,所以最合理的方式就是“鱼和熊掌兼得”,即使用ESModule编写库代码,然后通过TypeScript、Babel等工具辅助生成对应的CommonJS格式的代码,然后根据开发者的引用方式来动态替换为指定格式的代码。
,有了两种版本的代码,第三方库作者就需要编写相应的入口文件,来达到“动态”引入的目的(即import引用的时候指向ESModule的代码,require引入则指向CommonJS的代码),同时也方便于打包工具对于无用代码的剔除,减少代码体积,本篇文章主要聚焦于如何正确地配置入口文件。
,注:本篇文章以node规范为准,对于打包工具额外支持的配置方式会进行额外标注
,本文的涉及的示例代码可以通过 https://github.com/HomyeeKing/test-entry 进行查看、测试
,package.json的 main字段是最常见的指定入口文件的形式。,当开发者引入@homy/test-entry这个包的时候,可以确定@homy/test-entry 这个npm包的入口文件指向的是 index.js。,但是index.js究竟是cjs or esm?
,一种方式是我们可以通过后缀名来显示地标注出当前文件是cjs还是esm格式的:
,那么不同模块格式的文件如何相互引用呢?解释规则大致如下
,另一种方式是通过package.json的 type字段来标识
,package.json 里也提供了一个type字段 用于标注用什么格式来执行.js文件,,如果手动设置type: module, 则将index.js当做esmodule处理,否则视为CommonJS
,type: module ,只有Node.js >= 14 且使用import才能使用,不支持require引入
,注:关于.js的详细解析策略推荐阅读 https://nodejs.org/api/modules.html#enabling
,通过type和main字段,我们可以指定入口文件以及入口文件是什么类型,但是指定的只是一个入口文件,仍然不能够满足我们“动态”引入的需求,所以node又引入exports这个新的字段作为main更强大的替代品。
,相比较于main字段,exports可以指定多个入口文件,且优先级高于main,而且还有效限制了入口文件的范围,即如果你引入指定入口文件范围之外的文件,则会报错,如果想指定submodule, 我们可以这样编写,然后通过如下方式可以访问到子模块文件,另外还有一个imports 字段,主要用于控制import的解析路径,类似于Import Maps, 不过在node中指定的入口需要以#开头,感兴趣的可以阅读subpath-imports
,对于前端日常开发来说,我们的运行环境主要还是浏览器和各种webview,我们会使用各种打包工具来压缩、转译我们的代码,除了上面提到的main exports字段,被主流打包工具广泛支持的还有一个module字段
,大部分时候 我们也能在第三方库中看到module这个字段,用来指定esm的入口,但是这个提案没有被node采纳(使用exports)但是大多数打包工具比如webpack、rollup以及esbuild等支持了这一特性,方便进行tree shaking等优化策略
,如何正确地配置入口文件?,另外,TypeScript已经成为前端的主流开发方式,同时TypeScript也有自己的一套入口解析方式,只不过解析的是类型的入口文件,有效辅助开发者进行类型检查和代码提示,来提高我们编码的效率和准确性,下面我们继续了解下TypeScript是怎么解析类型文件的。
,TypeScript有着对Node的原生支持,所以会先检查main字段,然后找对应文件是否存在类型声明文件,比如main指向的是lib/index.js, TypeScript就会查找有没有lib/index.d.ts文件。
,另外一种方式,开发者可以在package.json中通过types字段来指定类型文件,exports中同理。,tsconfig.json包含一个moduleResolution字段,支持classic(默认)和node两种解析策略,主要针对相对路径引入和非相对路径引入两种方式,我们可以通过示例来理解下
,查找以.ts 或.d.ts结尾的文件
,相对路径会找当前目录下的.ts 或.d.ts的文件
,则会向上查找,直到找到moduleB 相关的.ts或.d.ts文件
,以类似于node的解析策略来查找,但是相应的查找的范围是以.ts .tsx .d.ts为后缀的文件,而且会读取package.json中对应的types(或typings)字段
,在node环境下,会依次解析.js 当前package.json中main字段指向的文件以及是否存在对应的index.js文件。
,TypeScript解析的时候则是把后缀名替换成ts专属的后缀.ts .tsx .d.ts,而且ts这时候会读取types字段 而非main,no-relative就直接查看指定node_modules下有没有对应文件,类似的 TypeScript也会替换对应后缀名,而且多了@types下类型的查找,另外TypeScript支持版本选择来映射不同的文件,感兴趣的可以阅读version-selection-with-typesversions(地址:https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html#version-selection-with-typesversions)

© 版权声明

相关文章