随着 Web 开发的发展，前端工程化越来越成为了一个必要的环节。npm 包是前端工程化中非常重要的工具。本文将介绍一个非常实用的 npm 包：keystone-publishable，它可以帮助我们快速实现一个可以发布的 keystonejs 程序。
什么是 keystone-publishable
keystone-publishable 是一个 keystonejs 插件，它可以帮助我们将 keystonejs 项目打包成一个可以直接部署到服务器的压缩包。我们只需要将生成的压缩包上传到服务器，解压后运行应用即可。这样可以大大简化部署的流程。
keystone-publishable 的安装
我们可以通过 npm 安装 keystone-publishable：
npm install keystone-publishable
安装完成后，在 keystonejs 项目的 index.js 文件中加入以下代码：
keystone.set('compress', true);
keystone.set('port', process.env.PORT || 3000);
keystone.set('ip', process.env.IP || '0.0.0.0');
keystone.set('env', process.env.NODE_ENV || 'development');
var keystonePublishable = require('keystone-publishable');
keystone.use(keystonePublishable);接下来，在项目根目录下运行：
node keystone build
将生成一个以项目名为名字的压缩包。
实战演练
我们以一个简单的 keystonejs 项目为例，演示 keystone-publishable 的使用。
我们先创建一个名为 myProject 的 keystonejs 项目：
yo keystone
按照提示选择一些基本的配置，该项目会生成一个默认的 keystonejs 应用。
完成后，我们在项目根目录下运行：
npm install keystone-publishable
然后将以上提到的代码加入到项目的 index.js 文件中，并在项目根目录下运行：
node keystone build
完成后，该目录下会生成一个 myProject.zip 的压缩包。我们可以将该压缩包上传到服务器上，解压后运行 index.js 即可。
keystone-publishable 的深入探究
我们通过阅读源码，了解到 keystone-publishable 的实现原理。它的核心代码在 lib/publishable.js 中：
-- -------------------- ---- -------
-------- ---------------- ----------- --------- -
--- --- - --------------
--- ------- - ----------------
--- -------- - --- - --------
--- ----------- - -------- - --- - --------
-- ------------------------- -
------ ------------ ---------- --- ------ - - ----------
-
-- ------------------------- -
----------------------
-
--- -
-------------------------
---------------- - ---------- ----------- - -----------
---------------- - --------- ----------- - ----------
---------------- - --------------- ----------- - ----------------
------------------------- ----------- - --- - --------------------------------
--------------------- - ---------- ----------- - ---------- -------- ----- -
-- ----- -
------ --------------
-
------------- -------- ----------
---
- ----- ----- -
------ --------------
-
-
-------- ------------- -------- --------- -
--- ------ - ----------------------------- - --- - ------- - --------
--- ------- - --------------- -
----- - ------ - -
---
------------------ ---------- -
---------------
---
---------------- ---------- -
----------------- --- ---- ----------
---
------------------- ------------- -
--------------
---
---------------------
-------------------------- - --- - -------- ---------
-------------------
-
------- - -------------- - -------- ------------------------ ---- ----- -
--- ------- - --------------
--- ---------- - -------------------------- -----------------
-- --------- --- ----------- -
---------------- ----------- -------- ----- -
-- ----- -
------ ----------
-
------------------------------ -------
---
- ---- -
------ -------
-
--可以看到，它的实现并不复杂，主要是将 keystonejs 项目的文件复制到 dist 目录中，然后压缩成一个 zip 包。其中，最主要的函数是 publish 函数，它接受三个参数：appPath、appPackage 和 callback。appPath 是指 keystonejs 项目的根路径，appPackage 是指 package.json 文件，在该文件中我们可以找到项目的名称和入口文件的路径。该函数实现过程比较简单，我们可以根据注释了解每个步骤。
总结
通过本文的介绍，我们了解了 keystone-publishable 的基本用法，以及它的实现原理。将 keystonejs 项目打包成可发布的压缩包，在工程化的前端项目中非常有用。同时，通过分析其源码，我们也可以更深入地了解其实现原理以及如何编写一个实用的 npm 包。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005663681e8991b448e226e