如何设置项目以在 npm 包上开发

Posted 2023-02-16

【中文标题】如何设置项目以在 npm 包上开发

【英文标题】：how to setup a project to develop on a npm package

【发布时间】：2022-01-08 04:21:05

【问题描述】：

我有一个 git root 项目，我在我的根项目中使用了一个 git 子项目。 例如，我有项目 MyApp 和一个子项目 UIComponents。 目前，我已将 UIComponents 存储库克隆到我的项目文件夹中，并将 UIComponents 添加到根项目的 .gitignore 中。 现在我想为 UIComponents 构建一个 npm 包，并且我希望能够在 npm 生产构建和开发之间切换。 问题在于开发中的导入是这样的：

import Button from './UIComponents'

使用 npm 包，导入是这样的：

import Button from '@my_name/UIComponents'

我不想每次都调整导入。 想到的第一个想法是在 node_modules 文件夹中开发 UIComponents，但这似乎不是一个好的解决方案。

【参考方案1】：

为了解决这个问题，请尝试使用npm link。 因此，不要将它克隆到需要添加到 gitignore 的子目录中，只需检查项目外部的存储库，然后链接它。

例子：

cd ~/projects/UIComponents
npm link  
cd ~/projects/MyApp
npm link @my_name/UIComponents 

通过这种方式，您可以使用相同的导入语法，但您可以同时在两个项目中进行本地开发，而无需发布每个更改。