@getkist/action-sass

中文文档
1.0.28发布于 2026/10/09MITTypeScriptESM + CJS近 30 天下载 2216

SASS/SCSS compilation with PostCSS processing actions for kist build tool

原始使用文档
文档目录19 节
  1. Features
  2. Installation
  3. Usage
  4. Basic Style Compilation
  5. Expanded Output
  6. Action: StyleProcessingAction
  7. Options
  8. Processing Features
  9. PostCSS Plugins
  10. Examples
  11. Multiple Style Files
  12. Development vs Production
  13. Multiple Outputs from a Single Input
  14. TypeScript Types
  15. StyleProcessingActionOptions
  16. Requirements
  17. Contributing
  18. License
  19. Links

@getkist/action-sass

npm version CI Coverage License: MIT kist plugin

SASS/SCSS compilation with PostCSS processing for kist build tool.

Features

  • SASS/SCSS Compilation - Modern SASS compilation using Dart Sass
  • PostCSS Integration - Automatic PostCSS processing with autoprefixer
  • Compression Support - Expanded and compressed output styles
  • CSS Optimization - Built-in cssnano for minification
  • Node Package Importer - Import from node_modules directly

Installation

npm install --save-dev @getkist/action-sass

Usage

Basic Style Compilation

Add to your kist.yml:

pipeline:
    stages:
        - name: styles
          steps:
              - name: compile-styles
                action: StyleProcessingAction
                options:
                    inputFile: ./src/styles/main.scss
                    outputFile: ./dist/styles/main.css
                    styleOption: compressed

Expanded Output

pipeline:
    stages:
        - name: dev-styles
          steps:
              - name: compile-dev-styles
                action: StyleProcessingAction
                options:
                    inputFile: ./src/styles/app.scss
                    outputFile: ./dist/styles/app.css
                    styleOption: expanded

Action: StyleProcessingAction

Compiles SCSS files to CSS with PostCSS transformations.

Options

OptionTypeRequiredDescription
inputFilestringYesPath to the input SCSS file
outputFilestringNoSingle output CSS file path (mutually exclusive with outputs)
styleOptionstringNoSingle output style: 'expanded' or 'compressed' (mutually exclusive with outputs)
outputsStyleOutputConfig[]NoMultiple outputs from a single input, e.g. both expanded and compressed CSS (mutually exclusive with outputFile/styleOption)
sourceMapbooleanNoEnable sourcemap generation for single output mode (default: false)
sourceMapIncludeSourcesbooleanNoInclude original source content in the sourcemap (default: true when sourceMap is enabled)

Processing Features

Expanded Mode:

  • Readable, formatted CSS output
  • Autoprefixer for browser compatibility
  • Ideal for development

Compressed Mode:

  • Minified CSS with cssnano
  • Autoprefixer for browser compatibility
  • Optimized for production

PostCSS Plugins

  • autoprefixer - Automatically adds vendor prefixes
  • cssnano - CSS minification (compressed mode only)

Examples

Multiple Style Files

pipeline:
    stages:
        - name: compile-all-styles
          steps:
              - name: main-styles
                action: StyleProcessingAction
                options:
                    inputFile: ./src/styles/main.scss
                    outputFile: ./dist/styles/main.css
                    styleOption: compressed

              - name: admin-styles
                action: StyleProcessingAction
                options:
                    inputFile: ./src/styles/admin.scss
                    outputFile: ./dist/styles/admin.css
                    styleOption: compressed

Development vs Production

pipeline:
    stages:
        - name: dev-build
          steps:
              - name: dev-styles
                action: StyleProcessingAction
                options:
                    inputFile: ./src/styles/app.scss
                    outputFile: ./dist/dev/app.css
                    styleOption: expanded

        - name: prod-build
          steps:
              - name: prod-styles
                action: StyleProcessingAction
                options:
                    inputFile: ./src/styles/app.scss
                    outputFile: ./dist/prod/app.css
                    styleOption: compressed

Multiple Outputs from a Single Input

Use outputs to generate several CSS files (e.g. expanded and compressed) from a single SCSS source in one step:

pipeline:
    stages:
        - name: styles
          steps:
              - name: compile-styles
                action: StyleProcessingAction
                options:
                    inputFile: ./src/styles/app.scss
                    outputs:
                        - file: ./dist/css/app.css
                          style: expanded
                          sourceMap: true
                        - file: ./dist/css/app.min.css
                          style: compressed

TypeScript Types

import { StyleProcessingAction } from "@getkist/action-sass";

const action = new StyleProcessingAction();

StyleProcessingActionOptions

interface StyleOutputConfig {
    file: string;
    style: "expanded" | "compressed";
    sourceMap?: boolean;
}

interface StyleProcessingActionOptions {
    inputFile: string;
    outputFile?: string;
    styleOption?: "expanded" | "compressed";
    outputs?: StyleOutputConfig[];
    sourceMap?: boolean;
    sourceMapIncludeSources?: boolean;
}

Requirements

  • Node.js >= 22.0.0
  • npm >= 10.0.0
  • kist >= 0.1.58

Contributing

See CONTRIBUTING.md for contribution guidelines.

License

MIT © kist

版本与发布记录

@getkist/action-sass 共发布 9 个版本,首次发布于 2026/02/09;过去 12 个月发布了 9 个版本。

版本发布日期距今
1.0.28latest2026/10/091 个月前
1.0.232026/04/236 个月前
1.0.92026/02/109 个月前
1.0.72026/02/099 个月前
1.0.52026/02/099 个月前
1.0.42026/02/099 个月前

关于 @getkist/action-sass 的常见问题

@getkist/action-sass 是什么?

SASS/SCSS compilation with PostCSS processing actions for kist build tool

如何安装 @getkist/action-sass?

在项目目录运行 npm install @getkist/action-sass,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:kist(>=0.1.58)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@getkist/action-sass 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@getkist/action-sass 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@getkist/action-sass 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@getkist/action-sass 可以商用吗?

@getkist/action-sass 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@getkist/action-sass 的下载量有多少?

根据 npm 官方下载统计,@getkist/action-sass 在 2026/10/17 – 2026/11/15 这 30 天内被下载 2,216 次,日均约 74 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@getkist/action-sass 还在维护吗?

最新版本 1.0.28 发布于 2026/10/09(1 个月前);至今共发布 9 个版本,其中过去 12 个月发布了 9 个;首次发布于 2026/02/09。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。