你所不知道的模块调试技巧 - npm link #17

忘是亡心i 2023-05-22 06:41 11阅读 0赞

# 你所不知道的模块调试技巧 - npm link \#17 #

<table> 
 <tbody> 
  <tr> 
   <td> <h2>1. 背景</h2> <p>node 应用开发中，我们不可避免的需要使用或拆分为 npm 模块，经常遇到的一个问题是：</p> 
    <blockquote> 
     <p>新开发或修改的 npm 模块，如何在项目中试验？</p> 
    </blockquote> <p>新同学一般会有以下几种方式：</p> <p>为了方便示范，我们假设项目是&nbsp;<code>my-project</code>, 需要用到一个独立的&nbsp;<code>my-utils</code>&nbsp;模块</p> <h3>1.1 发布一个 beta 版本</h3> 
    <ul> 
     <li>优点：你高兴就好。</li> 
     <li><strong>缺点：</strong>&nbsp;无趣+无趣+无趣，麻烦+麻烦+麻烦。</li> 
    </ul><h3>1.2 直接用相对路径安装</h3> <pre><code>$ cd path/to/my-project
$ npm install path/to/my-utils</code></pre> 
    <ul> 
     <li>优点：简单明了</li> 
     <li><strong>缺点：</strong>&nbsp;调试过程中往往需要微调，此时需要切换到 my-utils 目录修改，然后反复重新 install，很麻烦</li> 
    </ul><h3>1.3 使用软链</h3> <pre><code>$ cd path/to/my-project/node_modules
$ ln -s path/to/my-utils my-utils</code></pre> 
    <ul> 
     <li>优点：软链后，两边修改直接同步</li> 
     <li><strong>缺点：</strong>&nbsp;指令操作麻烦，不同操作系统语法不一样</li> 
    </ul><h2>&nbsp;</h2> <h2>2. 正解 - npm link</h2> <p>但其实 npm 本身已经对此类情况提供了专门的&nbsp;<code>npm link</code>&nbsp;指令。</p> <p>相关文档：&nbsp;<a href="https://docs.npmjs.com/cli/link" rel="nofollow">https://docs.npmjs.com/cli/link</a></p> <p>下面我们简单介绍下用法：</p> <pre><code>$ cd path/to/my-project
$ npm link path/to/my-utils</code></pre> <p>简单的替换一个单词，就搞定了，cool~</p> <p>如果这两种的目录不在一起，那还有一种方法：</p> <pre><code>$ # 先去到模块目录，把它 link 到全局
$ cd path/to/my-utils
$ npm link
$
$ # 再去项目目录通过包名来 link
$ cd path/to/my-project
$ npm link my-utils</code></pre> <p>该指令还可以用来调试 node cli 模块，譬如需要本地调试我们的&nbsp;<a href="https://github.com/eggjs/egg-init" rel="nofollow">egg-init</a>，可以这样：</p> <pre><code>$ cd path/to/egg-init
$ npm link
$ # 此时全局的 egg-init 指令就已经指向你的本地开发目录了
$ egg-init # 即可</code></pre> <p>想去掉 link 也很简单：</p> <pre><code>$ npm unlink my-utils</code></pre> <h2>&nbsp;</h2> <h2>3. 写在最后</h2> 
    <ul> 
     <li>该方法只是为了最后一步调试，模块本身的正确性，应该更多的通过单元测试来保证。</li> 
     <li>单元测试相关内容，可以参见：<a href="https://eggjs.org/zh-cn/core/unittest.html" rel="nofollow">单元测试</a></li> 
    </ul></td> 
  </tr> 
 </tbody> 
</table>