Gruntfile.js

/* eslint no-undef: "error" */
/* eslint camelcase: 2 */
/* eslint-env node */

"use strict";

/**
 * Gruntfile for the SELMA enrol plugin.
 *
 * This file configures tasks to be run by Grunt
 * https://gruntjs.com/ for the current theme.
 *
 *
 * Requirements:
 * -------------
 * nodejs, npm, grunt-cli.
 *
 * Installation:
 * -------------
 * node and npm: instructions at https://nodejs.org/
 *
 * run: `[sudo] npm install -g grunt-cli --save-dev`
 *
 * node dependencies: run `npm install` in the root directory.
 *
 *
 * Usage:
 * ------
 * Call tasks from the plugin root directory. Default behaviour
 * (calling only `grunt`) is to run the watch task detailed below.
 *
 *
 * Porcelain tasks:
 * ----------------
 * The nice user interface intended for everyday use. Provide a
 * high level of automation and convenience for specific use-cases.
 *
 * grunt css     Create CSS from the SCSS.
 *
 *
 * Based on https://github.com/willianmano/moodle-theme_moove/ Gruntfile.js - thank you!
 * Based on https://gitlab.com/jezhops/moodle-theme_adaptable/  Gruntfile.js - thank you!
 *
 * @package     enrol_selma
 * @author      Based on code originally written by Willian Mano - {@link https://conecti.me} & G J Barnard - {@link https://moodle.org/user/profile.php?id=442195}
 * @copyright   2020 LearningWorks <selma@learningworks.ac.nz>
 * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

module.exports = function(grunt) {

    let decachephp = "../../admin/cli/purge_caches.php";

    grunt.initConfig({
        watch: {
            options: {
                nospawn: true,
                livereload: true
            },
            css: {
                files: ["scss/**/*.scss"],
                tasks: ["css", "decache"]
            }
        },
        sass: {
            dist: {
                files: {
                    "styles.css": "scss/main.scss"
                }
            },
            options: {
                includePaths: ["scss/"]
            }
        },
        stylelint: {
            scss: {
                options: {syntax: "scss"},
                src: ["scss/**/*.scss"]
            },
            css: {
                src: ["styles.css"],
                options: {
                    configOverrides: {
                        rules: {
                            "at-rule-no-unknown": true,
                        }
                    }
                }
            }
        },
        exec: {
            decache: {
                cmd: "php " + decachephp,
                callback: function(error) {
                    if (!error) {
                        grunt.log.writeln("Moodle caches purged.");
                    } else {
                        grunt.log.writeln("Some error occured:");
                        grunt.log.writeln(error);
                    }
                }
            }
        }
    });

    // Load tasks.
    grunt.loadNpmTasks("grunt-exec");
    grunt.loadNpmTasks("grunt-contrib-watch");
    grunt.loadNpmTasks('grunt-sass');
    grunt.loadNpmTasks("grunt-stylelint");

    // Register tasks.
    grunt.registerTask("default", ["watch"]);
    grunt.registerTask("css", ["stylelint:scss", "sass"]);
    grunt.registerTask("decache", ["exec:decache"]);
};