Gulp的includePaths有什么作用?



我正试图在我的项目中开始使用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的角色是什么吗?

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/nit),则加载路径非常有用。外部库很大,将使用大量的@import语句。但是,它们与您的项目文件夹结构不匹配,因此无法解决。但是,您可以向loadPaths添加额外的文件夹,以便外部库中的@imports进行解析。

包括路径

类型:阵列默认值:[]

libsas可以查找的路径数组,以尝试解析@import声明。使用数据时,建议您使用此选项。

在sass中,你可以将你的sass文件组织在多个文件夹中,但你希望你的main.sass能够在编译时导入它们,所以你可以指定includePaths,这样sass就知道在哪里可以找到@import sass file,这里你使用node-neat,如果你想从中导入一些样式,默认情况下,sass不知道在哪里,所以你需要告诉sass在哪里可以查找要导入的文件

相关内容

  • 没有找到相关文章