Skip to content

Update: Move grunt/helpers into adapt-project library (fixes #3757) #3758

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
oliverfoster wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update: Move grunt/helpers into adapt-project library (fixes #3757) #3758

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
270fcb7
Fix: Move grunt/helpers into adapt-project library (fixes #3757)
oliverfoster Feb 11, 2026
8cd8f86
Switch to property
oliverfoster Feb 11, 2026
979b15b
Fix: Updated dependencies
oliverfoster Feb 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 3 additions & 113 deletions grunt/helpers.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ const fs = require('fs-extra');
const path = require('path');
// extends grunt.file.expand with { order: cb(filePaths) }
require('grunt-file-order');
const Framework = require('./helpers/Framework');
const { Framework } = require('adapt-project');

module.exports = function(grunt) {

Expand Down Expand Up @@ -49,53 +49,6 @@ module.exports = function(grunt) {
if (grunt.config('languages') !== '**') grunt.log.ok(`The following languages will be included in the build '${grunt.config('languages')}'`);
});

// privates
const generateIncludedRegExp = function() {
const includes = grunt.config('includes') || [];
const pluginTypes = exports.defaults.pluginTypes;

// Return a more specific plugin regExp including src path.
const re = _.map(includes, function(plugin) {
return _.map(pluginTypes, function(type) {
// eslint-disable-next-line no-useless-escape
return exports.defaults.sourcedir + type + '\/' + plugin + '\/';
}).join('|');
}).join('|');
// eslint-disable-next-line no-useless-escape
const core = exports.defaults.sourcedir + 'core\/';
return new RegExp(core + '|' + re, 'i');
};

const generateNestedIncludedRegExp = function() {
const includes = grunt.config('includes') || [];
const folderRegEx = 'less/plugins';

// Return a more specific plugin regExp including src path.
const re = _.map(includes, function(plugin) {
// eslint-disable-next-line no-useless-escape
return exports.defaults.sourcedir + '([^\/]*)\/([^\/]*)\/' + folderRegEx + '\/' + plugin + '\/';
}).join('|');
return new RegExp(re, 'i');
};

const generateExcludedRegExp = function() {
const excludes = grunt.config('excludes') || [];
if (grunt.config('type') === 'production') {
const productionExcludes = grunt.config('productionExcludes') || [];
excludes.push(...productionExcludes);
}
const pluginTypes = exports.defaults.pluginTypes;

// Return a more specific plugin regExp including src path.
const re = _.map(excludes, function(plugin) {
return _.map(pluginTypes, function(type) {
// eslint-disable-next-line no-useless-escape
return exports.defaults.sourcedir + type + '\/' + plugin + '\/';
}).join('|');
}).join('|');
return new RegExp(re, 'i');
};

const generateScriptSafeRegExp = function() {
const includes = grunt.config('scriptSafe') || [];
let re = '';
Expand All @@ -116,27 +69,6 @@ module.exports = function(grunt) {
}
};

// eslint-disable-next-line no-unused-vars
const includedProcess = function(content, filepath) {
if (!exports.isPathIncluded(filepath)) return '';
else return content;
};

const getIncludedRegExp = function() {
const configValue = grunt.config('includedRegExp');
return configValue || grunt.config('includedRegExp', generateIncludedRegExp());
};

const getNestedIncludedRegExp = function() {
const configValue = grunt.config('nestedIncludedRegExp');
return configValue || grunt.config('nestedIncludedRegExp', generateNestedIncludedRegExp());
};

const getExcludedRegExp = function() {
const configValue = grunt.config('excludedRegExp');
return configValue || grunt.config('excludedRegExp', generateExcludedRegExp());
};

const getScriptSafeRegExp = function() {
const configValue = grunt.config('scriptSafeRegExp');
return configValue || grunt.config('scriptSafeRegExp', generateScriptSafeRegExp());
Expand Down Expand Up @@ -273,7 +205,6 @@ module.exports = function(grunt) {
outputPath: data.outputdir,
sourcePath: data.sourcedir,
courseDir: data.coursedir,
includedFilter: exports.includedFilter,
jsonext: data.jsonext,
trackingIdType: data.trackingIdType,
useOutputData: Boolean(grunt.option('outputdir')),
Expand All @@ -282,6 +213,8 @@ module.exports = function(grunt) {
});
framework.load();

exports.includedFilter = framework.includedFilter;

data.availableLanguageNames = [];
try {
data.availableLanguageNames = framework.getData().languageNames;
Expand Down Expand Up @@ -314,44 +247,6 @@ module.exports = function(grunt) {
return false;
},

isPathIncluded: function(pluginPath) {
pluginPath = pluginPath.replace(convertSlashes, '/');

const includes = grunt.config('includes');
const excludes = grunt.config('excludes') || (grunt.config('type') === 'production' && grunt.config('productionExcludes'));

// carry on as normal if no includes/excludes
if (!includes && !excludes) return true;

// Very basic check to see if the file path string contains any
// of the included list of plugin string names.
const isIncluded = includes && pluginPath.search(getIncludedRegExp()) !== -1;
const isExcluded = excludes && pluginPath.search(getExcludedRegExp()) !== -1;

// Exclude any plugins that don't match any part of the full file path string.
if (isExcluded || isIncluded === false) {
return false;
}

// Check the LESS plugins folder exists.
// The LESS 'plugins' folder doesn't exist, so add the file,
// as the plugin has already been found in the previous check.
const nestedPluginsPath = !!pluginPath.match(/(?:.)+(?:\/less\/plugins)/g);
if (!nestedPluginsPath) {
return true;
}

// The LESS 'plugins' folder exists, so check that any plugins in this folder are allowed.
const hasPluginSubDirectory = !!pluginPath.match(getNestedIncludedRegExp());
if (hasPluginSubDirectory) {
return true;
}

// File might be in the included plugin/less/plugins directory,
// but the naming convention or directory structure is not correct.
return false;
},

isPluginScriptSafe: function(pluginPath) {

pluginPath = pluginPath.replace(convertSlashes, '/');
Expand All @@ -363,10 +258,6 @@ module.exports = function(grunt) {

},

includedFilter: function(filepath) {
return exports.isPathIncluded(filepath);
},

scriptSafeFilter: function(filepath) {
return exports.isPluginScriptSafe(filepath);
},
Expand All @@ -382,7 +273,6 @@ module.exports = function(grunt) {
outputPath: buildConfig.outputdir,
sourcePath: buildConfig.sourcedir,
courseDir: buildConfig.coursedir,
includedFilter: exports.includedFilter,
jsonext: buildConfig.jsonext,
trackingIdType: buildConfig.trackingIdType,
useOutputData,
Expand Down
187 changes: 0 additions & 187 deletions grunt/helpers/Data.js
View file
Open in desktop

This file was deleted.

Loading