sass - Gulp 的 includePaths 有什么作用？

Question

我正在尝试在我的项目中开始使用 Bourbon 和 Neat Sass 库。我想用 Gulp 编译 Sass。这是我在其中一个教程中找到的一个简单的 styles 任务设置:

var gulp = require('gulp'),
    sass = require('gulp-sass'),
    neat = require('node-neat').includePaths;

var paths = {
    scss: './assets/styles/*.scss'
};

gulp.task('styles', function () {
    return gulp.src(paths.scss)
        .pipe(sass({
            includePaths: ['styles'].concat(neat)
        }))
        .pipe(gulp.dest('./dist/styles'));
});

gulp.task('default', function () {
    gulp.start('styles');
});

然后在主 .scss 文件中我放置导入:

@import "bourbon";
@import "base/base";
@import "neat";

该任务正确执行。

让我困惑的是 includePaths 到底做了什么？根据上面的例子，有人可以向我解释一下 includePath 的作用是什么吗？

Answer 1

SASS 编译器在解析 SASS @imports 时使用 loadPaths 中的每个路径。

loadPaths: ['styles/foo', 'styles/bar']

@import "x"; // found via ./styles/foo/_x.scss
@import "y"; // found via ./styles/bar/_y.scss

请注意，编译器通过从从左到右考虑loadPaths中的每个路径来解析每个@import(类似于UNIX环境中的$PATH)。一个示例场景可能是:

loadPaths: ['styles/i', 'styles/ii', 'styles/iii', 'styles/iv']

@import "x"; // no file at ./styles/i/_x.scss
             // no file  at ./styles/ii/_x.scss
             // found a file  at ./styles/iii/_x.scss ...
             //     ... this file will be used as the import
             //     ... terminate lookup
             // the file ./styles/iv/_x.scss will be ignored

styles/i 中没有 _x.scss 文件，因此它继续查看 styles/ii 内部。最终它在styles/iii中找到了一个_x.scss文件并完成了查找。它从数组中的第一个元素开始向右移动，查看 loadPaths 中的每个文件夹。尝试所有路径后，如果找不到该文件，则声明此 @import 语句无效。

如果您有外部库(例如 bournon/neat)，加载路径会很有用。外部库很大并且会使用大量@import语句。但是，它们与您的项目文件夹结构不匹配，因此无法解析。但是，您可以向 loadPaths 添加额外的文件夹，以便外部库内的 @importsdo 得到解析。