Skip to content

Commit

Permalink
Add check:scss task and use it in QA to avoid writing out the compile…
Browse files Browse the repository at this point in the history
…d files. (vufind-org#3029)
  • Loading branch information
EreMaijala authored Aug 14, 2023
1 parent 9945c2a commit 09faad7
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 30 deletions.
74 changes: 45 additions & 29 deletions Gruntfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -75,10 +75,14 @@ module.exports = function(grunt) {
scss: {
sass: {
options: {
style: 'compress'
outputStyle: 'compressed',
}
}
},
'check:scss': {
sass: {
}
},

// Convert LESS to SASS, mostly for development team use
lessToSass: {
Expand Down Expand Up @@ -203,35 +207,12 @@ module.exports = function(grunt) {
});

grunt.registerMultiTask('scss', function sassScan() {
var sassConfig = {},
path = require('path'),
themeList = fs.readdirSync(path.resolve('themes')).filter(function (theme) {
return fs.existsSync(path.resolve('themes/' + theme + '/scss/compiled.scss'));
});

for (var i in themeList) {
var config = {
options: {
implementation: require("node-sass"),
outputStyle: 'compressed'
},
files: [{
expand: true,
cwd: path.join('themes', themeList[i], 'scss'),
src: ['compiled.scss'],
dest: path.join('themes', themeList[i], 'css'),
ext: '.css'
}]
};
for (var key in this.data.options) {
config.options[key] = this.data.options[key] + '';
}
config.options.includePaths = getLoadPaths('themes/' + themeList[i] + '/scss/compiled.scss');

sassConfig[themeList[i]] = config;
}
grunt.config.set('sass', getSassConfig(this.data.options, false));
grunt.task.run('sass');
});

grunt.config.set('sass', sassConfig);
grunt.registerMultiTask('check:scss', function sassCheck() {
grunt.config.set('sass', getSassConfig(this.data.options, true));
grunt.task.run('sass');
});

Expand All @@ -241,10 +222,45 @@ module.exports = function(grunt) {
- grunt less = compile and compress all themes' LESS files to css.
- grunt scss = compile and map all themes' SASS files to css.
- grunt lessdev = compile and map all themes' LESS files to css.
- grunt check:scss = check all themes' SASS files.
- grunt watch:[cmd] = continuous monitor source files and run command when changes are detected.
- grunt watch:less
- grunt watch:scss
- grunt watch:lessdev
- grunt lessToSass = transpile all LESS files to SASS.`);
});

function getSassConfig(additionalOptions, checkOnly) {
var sassConfig = {},
path = require('path'),
themeList = fs.readdirSync(path.resolve('themes')).filter(function (theme) {
return fs.existsSync(path.resolve('themes/' + theme + '/scss/compiled.scss'));
});

for (var i in themeList) {
if (Object.prototype.hasOwnProperty.call(themeList, i)) {
var config = {
options: {
implementation: require("node-sass"),
},
files: [{
expand: true,
cwd: path.join('themes', themeList[i], 'scss'),
src: ['compiled.scss'],
dest: checkOnly ? null : path.join('themes', themeList[i], 'css'),
ext: '.css'
}]
};
for (var key in additionalOptions) {
if (Object.prototype.hasOwnProperty.call(additionalOptions, key)) {
config.options[key] = additionalOptions[key];
}
}
config.options.includePaths = getLoadPaths('themes/' + themeList[i] + '/scss/compiled.scss');

sassConfig[themeList[i]] = config;
}
}
return sassConfig;
}
};
2 changes: 1 addition & 1 deletion build.xml
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@

<!-- Run Sass build, error if it fails -->
<target name="checkSassBuild">
<exec command="npm run build:scss" checkreturn="true" passthru="true" />
<exec command="npm run check:scss" checkreturn="true" passthru="true" />
</target>

<!-- Run LessToSass, error if there are uncommitted changes (used by continuous integration) -->
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
"watch-dev:less": "grunt watch:lessdev",

"build:scss": "grunt scss",
"check:scss": "grunt check:scss",
"watch:scss": "grunt watch:scss",

"lessToSass": "grunt lessToSass",
Expand Down

0 comments on commit 09faad7

Please sign in to comment.