npm 包 shifter 使用教程

前言

前端开发中,随着项目的不断壮大和前端工具的不断发展,我们需要管理的文件和代码也在逐渐增加,为了方便管理这些代码,我们需要一个良好的打包工具来打包我们的代码,这时候 shifter 就派上了用场。shifter 不仅可以打包 JS、CSS 等文件,还可以根据配置信息自动生成文档、zip 包等。

shifter 简介

Shifter 是一款轻量级的打包构建工具,它使用 YUI3 的构建系统,可以方便地将多个文件合并成一个文件、提取公共部分、压缩代码等,在前端开发中被广泛使用。Shifter 使用 NodeJS 的命令行工具,需要在终端下运行。

安装 shifter

Shifter 依赖 NodeJS 环境,如果你还没有安装 NodeJS,请先安装它。

安装命令:

--- ------- -- -------

如果出现权限问题,可以使用 sudo 命令来安装。

shifter 配置文件

shifter 的配置文件是 package.json,通过配置 package.json 文件中的 build 来确定要生成的模块。

-
  ------- ------------
  ---------- --------
  -------- -
    --------- -
      ------- ---------
      -------- -----------
    --
    ------------ -----------
    -------- ------------
    --------------- --------------------
    ----------- ---------------
    ------------- ------------------
  -
-
  • source.path:指定源代码路径。
  • source.files:指定源代码中需要编译的文件,可以用通配符表示。
  • buildPath:指定编译后的文件路径。
  • files:指定编译后需要打包的文件,可以用通配符表示。
  • globalConfig:指定全局配置文件路径。
  • tempPath:指定临时文件夹路径,用于生成中间文件。
  • configPath:指定配置文件路径,用于对不同的模块进行定制化配置。

编译 JS 文件

配置好 package.json 文件后,就可以开始编译文件了。

-------

这个命令会把 source.path 中指定的 JavaScript 文件编译成适合产品环境使用的代码并且存放在 buildPath 中。同时,还可以使用 -v 参数查看编译过程中的详细信息。

------- --

打包文件

有时候我们需要把多个文件合并成一个文件来减少 HTTP 请求,shifter 非常适合做这个事情。只需要在 package.json 中配置好 build.files 就可以了。

-
  ------- ------------
  ---------- --------
  -------- -
    --------- -
      ------- ---------
      -------- -----------
    --
    ------------ -----------
    -------- ------------
    --------------- --------------------
    ----------- ---------------
    ------------- ------------------
  -
-

然后在终端中运行:

------- -----

这个命令会把 build.files 中指定的 JavaScript 文件打包成一个文件,并且压缩代码存放在 buildPath 中。打包完成后,可以使用 shifter list 命令查看打包后的文件列表。

自动生成文档

shifter 还支持自动生成 API 文档,只需要在 build.globalConfig(全局配置文件)中加入以下代码:

----- ----------- - ----------- ---- - -------------- ----------- -
  --- ------ - --------------
  --- --------
    --------- --------------
    ------ ----
    -------- --
  ---------
---

然后在终端中运行:

------- ---

这个命令会在 buildPath 中生成一个名为 docs 的文件夹,里面包含了生成的 API 文档。

结语

以上就是 shifter 的基本使用方法,该工具可以帮助我们方便地管理前端项目代码,让前端开发更加高效快捷。学会使用 shifter,可以让我们在前端开发中更加得心应手!如果需要更多详细使用信息,可以参考 官方文档

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/77191


猜你喜欢

  • npm 包 gulp-config-sync 使用教程

    前言 前端是一个非常快速发展的行业,我们在开发的过程中常常需要使用工具来提高效率。其中,gulp 是我们非常常用的一个打包工具,可以自动化处理文件,提高我们的工作效率。

    5 年前
  • npm包google-material-color使用教程

    在前端开发中,我们常常需要使用到颜色,但是每个项目都是不同的,有时候难免会遇到一些设计师要求使用哪些颜色,那么我们就需要找一个方便、普适性高的解决方案,这时候 google-material-colo...

    5 年前
  • npm 包 kissy 使用教程

    1. 简介 Kissy 是一款由阿里前端团队开发的 Web 前端框架,它基于 JavaScript 和 CSS3 技术实现,为 Web 开发者提供了良好的开发体验和高效的开发效率。

    5 年前
  • npm 包 kissy-pp 使用教程

    什么是 kissy-pp? kissy-pp 是基于 KISSY.PP 的工具库,它是由淘宝前端团队开发并维护的,主要提供了一些方便的方法和插件,用于快速开发 Web 前端项目。

    5 年前
  • npm 包 kiss.js 使用教程

    kiss.js 是一个轻量级的 JavaScript 框架,旨在提供一种简单易用的开发体验,同时又能够满足大多数 Web 应用的需求。本文将介绍 kiss.js 的使用方法,包括安装、初始化、模块化开...

    5 年前
  • npm 包 ki 使用教程

    什么是 ki ki 是一个 JavaScript 库,旨在提供一些方便的功能,以使前端开发更加简单、快速。具体来说,ki 包含以下功能: 浏览器硬件加速 CSS3 动画 支持移动端手势事件 自适应布...

    5 年前
  • npm 包 kis 使用教程

    简介 在前端开发过程中,使用现有的开源库可以大大提高开发效率和代码质量。kis 是一款常用于 Web 前端开发的工具类库,提供了多种常用的实用函数和工具。本篇文章将介绍如何在项目中引入和使用 kis。

    5 年前
  • npm 包 kendo-lint 使用教程

    在前端开发中,我们经常需要使用各种工具来帮助我们完成代码的规范性检查和调试。kendo-lint 就是一个非常好用的 npm 包,它可以帮助我们检查代码是否符合 Kendo UI 框架的编码规范。

    5 年前
  • npm 包 lance 使用教程

    简介 lance 是一个轻量级的、基于 Node.js 的游戏 server/client 引擎,可用于开发多人在线游戏 (MMOG) 和实时多人游戏 (RTS)。

    5 年前
  • npm 包 lambda 使用教程

    什么是 lambda? Lambda 是一个 Serverless 计算服务,它让开发者能够在无需管理服务器的情况下运行代码。Lambda 可以处理从几个字节到数 GB 的代码,并且它完全自动扩展代码...

    5 年前
  • npm 包 uneval 使用教程

    在前端开发中,我们经常需要将 JavaScript 对象转换成字符串,以便在不同的环境中传递和存储。通常情况下,我们会使用 JSON.stringify 方法来实现这一目的。

    5 年前
  • npm 包 lamda-optimizer 使用教程

    AWS Lambda 已经成为了现在很多企业使用的一种计算机服务。通过 AWS Lambda,我们可以快速构建、部署和运行服务端的应用程序代码,并允许自动扩展。然而,AWS Lambda 运行时会收到...

    5 年前
  • npm 包 krunch 使用教程

    简介 krunch 是一款前端开发中常用的 npm 包,它是一个基于 Node.js 平台的前端自动化工具,用于优化前端资源加载速度、压缩 CSS 和 JavaScript 文件等。

    5 年前
  • npm 包 nimble 使用教程

    在前端开发中,有时我们需要进行异步操作或者任务队列的处理,这时就可以借助 npm 包 nimble 来帮助我们完成。本文将详细介绍如何使用 nimble 完成异步任务队列的添加、执行及其它相关操作。

    5 年前
  • npm 包 github-flavored-markdown 使用教程

    前言 在前端开发中,我们常常需要处理富文本数据,而 Markdown 就是一种轻量级的标记语言,它可以快速地将纯文本转换成 HTML 文档,并且可以很好地处理代码块、表格和列表等。

    5 年前
  • npm 包 Kranium 使用教程

    Kranium 是一个轻量级的前端框架,使用了类似 jQuery 的语法来操作 DOM 元素,并且对于路由、模板等方面也有很好的支持。本文将介绍如何在项目中使用 Kranium,以及一些常见的用法和技...

    5 年前
  • npm包 koala-t 的使用教程

    简介 koala-t是一款基于Node.js平台的npm包。它为前端开发者提供了一种简单、高效的开发方式。如果您是前端开发新手或者希望提高前端开发效率,koala-t将会成为您的好帮手。

    5 年前
  • npm 包 Knightkit Tag Extension 使用教程

    简介 Knightkit Tag Extension 是一个基于 JavaScript 的 npm 包,提供了许多有用的标签扩展来帮助前端开发人员更轻松地构建网站的标签。

    5 年前
  • npm包Knightkit-publish使用教程

    简介 npm是一个开源的软件包管理器,也是前端开发中用来安装和管理JavaScript包的标准工具。通过npm,开发人员可以轻松地分享和重用代码,方便项目的维护和升级。

    5 年前
  • npm 包 knightkit-cms 使用教程

    1. 简介 knightkit-cms 是一款适用于前端开发的 npm 包,可以帮助开发者快速搭建内容管理系统的前端界面,提高开发效率和开发质量。 2. 安装 使用 npm 进行安装: --- ---...

    5 年前

相关推荐

    暂无文章