steveperrycreative/sass-partial-manager

管理 Sass 部分的快捷方式。

1.0.6 2017-06-23 08:49 UTC

This package is not auto-updated.

Last update: 2024-09-29 02:50:30 UTC


README

一个用于管理 Sass 部分的简单命令行工具。

我厌倦了手动创建 Sass 部分并且不知道为什么我的样式在浏览器中不更新,因为忘记在我的主样式文件中添加 @import,所以我创建了一个小巧的命令行工具来自动完成这项工作。

入门

首先,使用 Composer 下载 SPM 安装程序

composer global require steveperrycreative/sass-partial-manager

然后添加 ~/.composer/vendor/bin 目录到您的 $PATH,以便您的系统可以定位到 spm 可执行文件。

这样做最简单的方法是使用 export 命令

export PATH=$PATH:~/.composer/vendor/bin

现在 spm 命令将在您的当前工作目录中可用。

配置

按照以下方式向您的 composer.json 文件添加一些详细信息

"spm_config": {
  "sass_directory": "wp-content/themes/themename/scss",
  "stylesheet_filename": "styles.scss",
  "sort_imports": true
}
  • sass_directory 是您想要添加部分的完整路径(请确保这些目录存在)。
  • stylesheet_filename 是您的主 Sass 入口点文件名(默认为 styles.scss)。
  • sort_imports 当设置为 true 时,将按字母顺序排序所有导入。大多数用户可能不需要这个功能,因为它可能会引起样式的级联问题,所以默认为 false

您还可以在命令行中覆盖样式表名称。

创建新的部分

目前还处于早期阶段,部分目录的结构有点倾向于我自己的工作方式。如果有人对此感兴趣,这个结构可能会改变。

以下示例假设您正在使用名为 spc 的主题的 WordPress

"spm_config": {
  "sass_directory": "wp-content/themes/spc/scss",
  "stylesheet_filename": "styles.scss"
}

spm make:partial header 将在 components 文件夹中创建一个名为 _header.scss 的新部分

wp-content/themes/spc/scss/components/_header.scss

并将 @import "components/header"; 添加到您配置的样式文件中

wp-content/themes/spc/scss/styles.scss

如果您的样式文件不存在,它将被创建。如果它已经存在,则导入将被追加到文件的末尾。如果您尝试创建一个已存在的部分,则命令将停止运行。

指定组件类型

spm make:partial homepage --type="views" 将在 views 文件夹中创建一个名为 _homepage.scss 的新部分

wp-content/themes/spc/scss/views/_homepage.scss

并将 @import "views/homepage"; 添加到您配置的样式文件中

wp-content/themes/spc/scss/styles.scss

覆盖 Sass 目录

在创建部分时,您可以指定一个临时的 sass_directory 路径

spm make:partial homepage --type="views" --sass_directory="some/other/location" 将在指定的位置创建您的部分。这也会在该位置查找样式文件。