npm 包 wp-timber-cli 使用教程

阅读时长 4 分钟读完

简介

wp-timber-cli 是一个基于 Node.js 和 Gulp 构建的 WordPress 主题开发工具,它支持快速生成 Timber 主题,并提供了一些实用的工具和配置来方便开发者进行主题开发。

使用 wp-timber-cli 可以快速搭建 Timber 主题开发环境,同时还可以自动化完成一些繁琐的任务(如编译 CSS、JS、图片等),提高开发效率。

安装

使用 wp-timber-cli 需要先安装 Node.js 和 npm,建议使用最新稳定版本。

安装完成后,在命令行输入如下命令安装 wp-timber-cli:

命令执行完成后,wp-timber-cli 就已经安装成功了。

使用

初始化项目

在使用 wp-timber-cli 创建 Timber 主题之前,需要先初始化项目。使用命令行进入想要创建主题的 WordPress 主题目录,比如:

然后执行如下命令:

其中 my-theme 是主题的名称,可以自定义,执行该命令会在 themes 目录下生成一个名为 my-theme 的主题目录,并且自动安装 Timber 和其他所需的依赖。

编译 CSS 和 JS

在主题开发过程中,我们需要将开发版本的 CSS 和 JS 编译成生产环境所需的格式,wp-timber-cli 提供了如下命令来完成这一任务:

该命令会将当前主题目录中的 src/css 和 src/js 目录中的文件编译成最终所需的格式,并输出到主题目录中的 dist/css 和 dist/js 目录中,编译完毕后可以直接使用。

监听文件变化

在开发过程中,为了提高开发效率,我们需要监听 CSS 和 JS 文件的变化,当文件发生变化时自动编译,wp-timber-cli 提供了如下命令来完成这一任务:

该命令会在命令行中输出监听状态,当 CSS 或 JS 文件发生变化时会自动编译,并输出成功信息。

支持的配置选项

wp-timber-cli 支持如下配置选项:

  • src: 指定源文件目录,默认为 src。
  • dist: 指定输出目录,默认为 dist。
  • css: 指定 CSS 编译器,默认为 sass。
  • js: 指定 JS 编译器,默认为 babel。
  • image: 指定图片压缩质量,默认为 75。

这些选项可以在 themes 目录下的 wp-timber.json 文件中配置,例如:

示例代码

以下是一个使用 wp-timber-cli 创建的最简单的 Timber 主题示例代码:

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

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

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

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

在命令行中执行如下命令即可编译并使用该主题:

总结

wp-timber-cli 是一个非常实用的 Timber 开发工具,它可以帮助开发者快速搭建 Timber 主题开发环境,并自动化完成一些繁琐的任务,提高开发效率。通过本文的介绍和学习,相信读者已经对 wp-timber-cli 有了更加深入的了解和认识,在开发实践中能够更加顺畅地使用该工具。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600671158dd3466f61ffe5e2

纠错
反馈