首页
学习
活动
专区
圈层
工具
发布

TypeScript Project References npm 包构建小实践

npm 包输出 es/cjs 产物 在开发一个 npm 包时,通常需要同时输出 ES 模块和 CommonJS 模块的产物供不同的构建进行使用。...在只使用tsc进行产物编译的情况下,我们通常可以通过配置两个独立的 tsconfig.json 配置文件,并在一个 npm script 中 执行两次 tsc 命令来实现 项目结构 假设我们的项目结构如下...", } } 通过运行 npm run build,可以生成同时包含 ES 模块和 CommonJS 模块的产物 TypeScript 的 references 是什么 TypeScript 的项目引用...(Project References)是 TypeScript 3.0 引入的一项功能,允许一个 TypeScript 项目引用另一个 TypeScript 项目。...在这个场景下 TypeScript 会根据项目引用的配置,自动构建 ES 模块和 CommonJS 模块,并且只会重新编译发生变化的部分,从而提升增量编译的性能

23110
  • 您找到你想要的搜索结果了吗?
    是的
    没有找到

    如何发布一个 TypeScript 编写的 npm 包

    前言在这篇文章中,我们将使用TypeScript和Jest从头开始构建和发布一个NPM包。我们将初始化一个项目,设置TypeScript,用Jest编写测试,并将其发布到NPM。...npm包可以在这里找到。GitHub仓库地址在这里。初始化项目让我们从创建空目录并初始化它开始。...npm i -D jest @types/jest ts-jestts-jest包是Jest理解TypeScript所需要的。另一个选择是使用babel,这将需要更多的配置和额外的模块。...注册成功后,通过你的终端用npm login登录。我们离发布我们的新包只有一步之遥。不过,还有几件事情需要处理。首先,确保我们的package.json中拥有正确的元数据。...总结我们从头开始创建并发布了一个简单的npm包。我们的库提供了一个ESM模块,TypeScript的类型,使用jest覆盖测试用例。你可能会认为,这其实一点都不难,的确如此。

    1.7K20

    如何发布一个 TypeScript 编写的 npm 包

    前言 在这篇文章中,我们将使用TypeScript和Jest从头开始构建和发布一个NPM包。 我们将初始化一个项目,设置TypeScript,用Jest编写测试,并将其发布到NPM。...npm包可以在这里[1]找到。GitHub仓库地址在这里[2]。 初始化项目 让我们从创建空目录并初始化它开始。...npm i -D jest @types/jest ts-jest ts-jest包是Jest理解TypeScript所需要的。另一个选择是使用babel,这将需要更多的配置和额外的模块。...注册成功后,通过你的终端用npm login登录。 我们离发布我们的新包只有一步之遥。不过,还有几件事情需要处理。 首先,确保我们的package.json中拥有正确的元数据。...总结 我们从头开始创建并发布了一个简单的npm包。 我们的库提供了一个ESM模块,TypeScript的类型,使用jest覆盖测试用例。 你可能会认为,这其实一点都不难,的确如此。

    2.2K20

    使用typescript编程实现npm包的开发、测试和发布过程

    使用typescript编程实现npm包的开发、测试和发布过程 以下是使用 TypeScript 进行 npm 包开发、测试和发布过程的步骤: 以上是使用 TypeScript 进行 npm 包开发、测试和发布过程的基本步骤...以下是使用 TypeScript 进行 npm 包开发、测试和发布过程的步骤: 创建项目目录并初始化:在终端中运行 npm init 命令,按照提示完成项目初始化。...创建源代码目录:在项目根目录中创建一个 src 目录,并在其中编写 TypeScript 代码。 编写代码:在 src 目录中编写你的 npm 包的代码。...确保你的代码符合 TypeScript 的语法规范,并且按照 npm 包的开发规范编写。...以上是使用 TypeScript 进行 npm 包开发、测试和发布过程的基本步骤。你可以根据具体的需求和项目情况进行调整和扩展。

    7510

    教你 30 秒发布一个 TypeScript 包到 NPM

    文章读译自 The 30 second guide to publishing a typescript package to npm,部分内容有修改哈。...这篇文章要求你有一定的 JS 、TS 和 NPM 的知识,如果你写过普通的 NPM 包就更好啦~如果没有的话网上也很多教程的,都很简单~ 发布过 npm 包的同学都知道,初始化一个 npm 项目,直接用...需要注意的是,当你使用私有的类型时,但是这个类型也外部 API 的一部分,这个包的使用者就得不到该类型的类型推断,TS 编译器也会报警告,这时你只需要在该类型前添加 export 即可。 2....添加 "types": "index.d.ts" 到你的 package.json 当其他人导入你的包的时候,这句话就告诉了 TS 编译器到哪里去寻找类型定义文件。...配合 commitizen 来发布 npm 包,感兴趣的同学可以自行了解一下~ 如果想要在发布前调试本地包,可以使用 npm link 命令,在此项目根目录执行npm link, 然后在要调试的 demo

    1.9K20

    了解可执行的NPM包

    了解可执行的NPM包 NPM是Node.js的包管理工具,随着Node.js的出现,以及前端开发开始使用gulp、webpack、rollup以及其他各种优秀的编译打包工具(大多数采用Node.js来实现...包,因为是一个简单的示例,所以不会真实的进行上传,会使用npm ln来代替npm publish + npm install。.../node_modules/ > npm rebuild 因为绕过了NPM的安装步骤,一定要记得npm rebuild来让NPM知道我们的包注册了bin 这时候我们修改脚本文件,在脚本中添加当前执行目录的输出...以及这样的做法很可能会导致一些其它包引用的问题。 比如说,webpack实际上是支持多种语言编写config配置文件的,就拿TypeScript举例吧,最近也一直在用这个。...node_modules # npm root 的位置 │ ├── webpack │ └── typescript └──

    1.5K10

    发布你自己的npm包

    特别是React,Angular和其他前端库主导的网络和node.js接管的服务器端,NPM软件包比以往任何时候都更受欢迎。...所以,从长远看,将所有可重用代码作为npm包发布上去将会帮助到你。 无论代码有多少,无论是一行还是一千行,都可以将其作为包发布,以便在多个代码库中轻松使用。 此外,你还可以成为这个库的作者。...npm init (根据提示)输入有意义的包名称和包的相应详细信息。这将为你创建package.json。所有NPM包都需要main键。这定义了我们库的入口点。...现在去发布,运行(下面指令) npm publish 这会将你的包发布到NPM注册表。...样板文件 我有一些我自己的npm软件包,并在线研究了创建NPM软件包的所有最佳实践,并专门为此创建了样板文件。它具有预先设置的所有功能,以便你可以在几秒钟内开始使用。

    45130

    学会发布自己的npm包

    准备工作 在npm官网注册账号,要记住用户名/邮箱/密码 三个信息,后面需要用到 需要发布的项目应该有相应的git地址 包括但不限于github 最好在项目中使用gulp来把跑测试用例和打包的过程进行自动化...,方便发布 操作流程 在修改完成后,首先本地提交,并执行单元测试(npm run unit) 如果测试通过,则可以打包出压缩后的成品代码(npm run build) 此时进入预发布流程,可以先通过npm...whoami来确认登录信息,如果当前未登录,则需要npm login来输入用户名/密码/邮箱来登录 确定处于登录状态后,npm version from-git把本地的npm包版本号更新到最新 使用npm...push && git push --tags同步到远程 执行npm publish将npm最新版本的包进行发布。...同步最新版本 需要在用到此npm包的项目中的package.json中更改此包的最新版本号,然后执行npm i来更新包的代码 之后就可以在最新包的基础上进行开发

    861120

    npm发布自己的插件包

    发布一个npm插件包,不仅能提升个人影响力,还能促进技术交流与共享。本文将手把手教你如何发布npm包,同时指出过程中常见的问题、易错点及避免策略,并附带实用的代码示例。 准备工作 1....注册npm账号 如果你还没有npm账号,访问npmjs.com注册一个。注意,从2021年起,npm要求所有新用户进行邮箱验证。 创建你的包 1....发布包 一切就绪后,运行以下命令发布你的包: npm publish 首次发布可能需要等待一段时间,发布成功后,你的包就会出现在npm官网上。 常见问题与避免策略 1....总结 发布npm包是分享代码、贡献社区的直接方式。通过遵循上述步骤和注意事项,你可以顺利地将自己的劳动成果分享给全世界的开发者。...记住,持续维护和优化你的包,及时响应用户反馈,是提升包质量和受欢迎度的关键。祝你在npm之旅上取得成功!

    25110
    领券