CyberChef/Gruntfile.js

413 lines
15 KiB
JavaScript
Raw Normal View History

"use strict";
2017-04-13 20:00:55 +02:00
const webpack = require("webpack");
const HtmlWebpackPlugin = require("html-webpack-plugin");
const BundleAnalyzerPlugin = require("webpack-bundle-analyzer").BundleAnalyzerPlugin;
const NodeExternals = require("webpack-node-externals");
2017-04-13 20:00:55 +02:00
const Inliner = require("web-resource-inliner");
2018-03-27 00:14:23 +02:00
const glob = require("glob");
const path = require("path");
2016-12-14 17:39:17 +01:00
2017-07-04 00:15:57 +02:00
/**
* Grunt configuration for building the app in various formats.
*
* @author n1474335 [n1474335@gmail.com]
* @copyright Crown Copyright 2017
* @license Apache-2.0
*/
module.exports = function (grunt) {
2016-11-28 11:42:58 +01:00
grunt.file.defaultEncoding = "utf8";
grunt.file.preserveBOM = false;
2016-12-14 17:39:17 +01:00
2016-11-28 11:42:58 +01:00
// Tasks
grunt.registerTask("dev",
"A persistent task which creates a development build whenever source files are modified.",
["clean:dev", "clean:config", "exec:generateConfig", "concurrent:dev"]);
grunt.registerTask("node",
"Compiles CyberChef into a single NodeJS module.",
["clean:node", "clean:config", "exec:generateConfig", "webpack:node", "chmod:build"]);
2016-12-14 17:39:17 +01:00
grunt.registerTask("test",
"A task which runs all the operation tests in the tests directory.",
["exec:generateConfig", "exec:opTests"]);
grunt.registerTask("testui",
2018-12-30 01:26:28 +01:00
"A task which runs all the UI tests in the tests directory. The prod task must already have been run.",
["connect:prod", "exec:browserTests"]);
2016-12-14 17:39:17 +01:00
2016-11-28 11:42:58 +01:00
grunt.registerTask("docs",
"Compiles documentation in the /docs directory.",
["clean:docs", "jsdoc", "chmod:docs"]);
2016-12-14 17:39:17 +01:00
2017-03-27 17:08:36 +02:00
grunt.registerTask("prod",
"Creates a production-ready build. Use the --msg flag to add a compile message.",
["eslint", "clean:prod", "clean:config", "exec:generateConfig", "webpack:web", "inline", "chmod"]);
2016-11-28 11:42:58 +01:00
grunt.registerTask("default",
"Lints the code base",
["eslint", "exec:repoSize"]);
2016-12-14 17:39:17 +01:00
2017-03-27 17:08:36 +02:00
grunt.registerTask("inline",
"Compiles a production build of CyberChef into a single, portable web page.",
["exec:generateConfig", "webpack:webInline", "runInliner", "clean:inlineScripts"]);
2017-03-27 17:08:36 +02:00
grunt.registerTask("runInliner", runInliner);
2016-11-28 11:42:58 +01:00
grunt.registerTask("doc", "docs");
grunt.registerTask("tests", "test");
2016-12-14 17:39:17 +01:00
grunt.registerTask("lint", "eslint");
2016-11-28 11:42:58 +01:00
// Load tasks provided by each plugin
2016-12-14 17:39:17 +01:00
grunt.loadNpmTasks("grunt-eslint");
2017-03-27 17:08:36 +02:00
grunt.loadNpmTasks("grunt-webpack");
2016-11-28 11:42:58 +01:00
grunt.loadNpmTasks("grunt-jsdoc");
grunt.loadNpmTasks("grunt-contrib-clean");
grunt.loadNpmTasks("grunt-contrib-copy");
grunt.loadNpmTasks("grunt-contrib-watch");
2016-11-28 11:42:58 +01:00
grunt.loadNpmTasks("grunt-chmod");
grunt.loadNpmTasks("grunt-exec");
grunt.loadNpmTasks("grunt-accessibility");
grunt.loadNpmTasks("grunt-concurrent");
grunt.loadNpmTasks("grunt-contrib-connect");
2016-12-14 17:39:17 +01:00
2017-03-27 17:08:36 +02:00
// Project configuration
2017-05-03 00:03:28 +02:00
const compileTime = grunt.template.today("UTC:dd/mm/yyyy HH:MM:ss") + " UTC",
2017-07-04 00:15:57 +02:00
pkg = grunt.file.readJSON("package.json"),
webpackConfig = require("./webpack.config.js"),
BUILD_CONSTANTS = {
COMPILE_TIME: JSON.stringify(compileTime),
COMPILE_MSG: JSON.stringify(grunt.option("compile-msg") || grunt.option("msg") || ""),
PKG_VERSION: JSON.stringify(pkg.version),
ENVIRONMENT_IS_WORKER: function() {
return typeof importScripts === "function";
},
ENVIRONMENT_IS_NODE: function() {
return typeof process === "object" && typeof require === "function";
},
ENVIRONMENT_IS_WEB: function() {
return typeof window === "object";
}
2017-08-09 21:09:23 +02:00
},
moduleEntryPoints = listEntryModules();
2016-11-28 11:42:58 +01:00
2017-03-27 17:08:36 +02:00
/**
* Compiles a production build of CyberChef into a single, portable web page.
*/
function runInliner() {
2017-04-13 20:00:55 +02:00
const done = this.async();
2017-03-27 17:08:36 +02:00
Inliner.html({
relativeTo: "build/prod/",
fileContent: grunt.file.read("build/prod/cyberchef.htm"),
images: true,
svgs: true,
scripts: true,
links: true,
strict: true
}, function(error, result) {
if (error) {
2017-04-13 20:00:55 +02:00
if (error instanceof Error) {
2017-04-28 17:51:57 +02:00
done(error);
2017-04-13 20:00:55 +02:00
} else {
2017-04-28 17:51:57 +02:00
done(new Error(error));
2017-04-13 20:00:55 +02:00
}
} else {
2017-04-28 17:51:57 +02:00
grunt.file.write("build/prod/cyberchef.htm", result);
done(true);
2017-03-27 17:08:36 +02:00
}
});
}
2016-12-14 17:39:17 +01:00
2017-08-09 21:09:23 +02:00
/**
* Generates an entry list for all the modules.
*/
function listEntryModules() {
const entryModules = {};
2017-08-09 21:09:23 +02:00
2018-03-27 00:14:23 +02:00
glob.sync("./src/core/config/modules/*.mjs").forEach(file => {
const basename = path.basename(file);
if (basename !== "Default.mjs" && basename !== "OpModules.mjs")
entryModules[basename.split(".mjs")[0]] = path.resolve(file);
2017-08-09 21:09:23 +02:00
});
return entryModules;
}
2016-11-28 11:42:58 +01:00
grunt.initConfig({
2017-03-27 17:08:36 +02:00
clean: {
dev: ["build/dev/*"],
2018-03-27 00:14:23 +02:00
prod: ["build/prod/*"],
node: ["build/node/*"],
config: ["src/core/config/OperationConfig.json", "src/core/config/modules/*", "src/code/operations/index.mjs"],
2017-09-13 17:21:31 +02:00
docs: ["docs/*", "!docs/*.conf.json", "!docs/*.ico", "!docs/*.png"],
inlineScripts: ["build/prod/scripts.js"],
2017-03-27 17:08:36 +02:00
},
2016-12-14 17:39:17 +01:00
eslint: {
2016-11-28 11:42:58 +01:00
options: {
2017-04-28 17:51:57 +02:00
configFile: "./.eslintrc.json"
2016-11-28 11:42:58 +01:00
},
configs: ["*.{js,mjs}"],
2018-04-11 19:29:02 +02:00
core: ["src/core/**/*.{js,mjs}", "!src/core/vendor/**/*", "!src/core/operations/legacy/**/*"],
2018-03-27 00:14:23 +02:00
web: ["src/web/**/*.{js,mjs}"],
node: ["src/node/**/*.{js,mjs}"],
2018-12-28 22:49:40 +01:00
tests: ["tests/**/*.{js,mjs}"],
2016-11-28 11:42:58 +01:00
},
jsdoc: {
options: {
destination: "docs",
template: "node_modules/ink-docstrap/template",
recurse: true,
readme: "./README.md",
configure: "docs/jsdoc.conf.json"
},
all: {
src: [
"src/**/*.js",
2018-03-27 00:14:23 +02:00
"src/**/*.mjs",
"!src/core/vendor/**/*"
2016-11-28 11:42:58 +01:00
],
}
},
accessibility: {
options: {
accessibilityLevel: "WCAG2A",
verbose: false,
ignore: [
"WCAG2A.Principle1.Guideline1_3.1_3_1.H42.2"
]
},
test: {
src: ["build/**/*.html"]
}
},
webpack: {
2017-07-04 00:15:57 +02:00
options: webpackConfig,
web: () => {
return {
mode: "production",
target: "web",
entry: Object.assign({
main: "./src/web/index.js",
sitemap: "./src/web/static/sitemap.js"
}, moduleEntryPoints),
output: {
path: __dirname + "/build/prod",
globalObject: "this"
},
resolve: {
alias: {
"./config/modules/OpModules": "./config/modules/Default"
2017-03-27 17:08:36 +02:00
}
},
plugins: [
new webpack.DefinePlugin(BUILD_CONSTANTS),
new HtmlWebpackPlugin({
filename: "index.html",
template: "./src/web/html/index.html",
chunks: ["main"],
compileTime: compileTime,
version: pkg.version,
minify: {
removeComments: true,
collapseWhitespace: true,
minifyJS: true,
minifyCSS: true
}
}),
new BundleAnalyzerPlugin({
analyzerMode: "static",
reportFilename: "BundleAnalyzerReport.html",
openAnalyzer: false
}),
]
};
},
webInline: {
mode: "production",
target: "web",
entry: "./src/web/index.js",
output: {
filename: "scripts.js",
path: __dirname + "/build/prod"
},
plugins: [
new webpack.DefinePlugin(Object.assign({}, BUILD_CONSTANTS, {
INLINE: "true"
})),
new HtmlWebpackPlugin({
2017-03-27 17:08:36 +02:00
filename: "cyberchef.htm",
template: "./src/web/html/index.html",
compileTime: compileTime,
version: pkg.version + "s",
2017-03-27 17:08:36 +02:00
inline: true,
minify: {
removeComments: true,
collapseWhitespace: true,
minifyJS: true,
minifyCSS: true
}
}),
]
},
node: {
mode: "production",
target: "node",
2018-03-27 00:14:23 +02:00
entry: "./src/node/index.mjs",
externals: [NodeExternals()],
output: {
filename: "CyberChef.js",
path: __dirname + "/build/node",
library: "CyberChef",
libraryTarget: "commonjs2"
},
plugins: [
new webpack.DefinePlugin(BUILD_CONSTANTS)
]
}
},
2017-07-04 00:15:57 +02:00
"webpack-dev-server": {
options: {
webpack: webpackConfig,
host: "0.0.0.0",
disableHostCheck: true,
overlay: true,
inline: false,
clientLogLevel: "error",
2017-07-04 00:15:57 +02:00
stats: {
children: false,
chunks: false,
modules: false,
entrypoints: false,
2018-10-10 17:49:07 +02:00
warningsFilter: [
/source-map/,
/dependency is an expression/,
/export 'default'/
],
}
2017-07-04 00:15:57 +02:00
},
start: {
webpack: {
mode: "development",
2017-07-04 00:15:57 +02:00
target: "web",
2017-08-09 21:09:23 +02:00
entry: Object.assign({
main: "./src/web/index.js"
}, moduleEntryPoints),
resolve: {
alias: {
2018-03-27 00:14:23 +02:00
"./config/modules/OpModules": "./config/modules/Default"
}
},
output: {
globalObject: "this",
},
2017-07-04 00:15:57 +02:00
plugins: [
new webpack.DefinePlugin(BUILD_CONSTANTS),
new HtmlWebpackPlugin({
filename: "index.html",
template: "./src/web/html/index.html",
2017-08-09 21:09:23 +02:00
chunks: ["main"],
2017-07-04 00:15:57 +02:00
compileTime: compileTime,
version: pkg.version,
})
]
}
}
},
connect: {
prod: {
options: {
port: 8000,
base: "build/prod/"
}
}
},
2016-11-28 11:42:58 +01:00
copy: {
ghPages: {
options: {
2017-09-13 17:21:31 +02:00
process: function (content, srcpath) {
// Add Google Analytics code to index.html
2017-09-13 17:21:31 +02:00
if (srcpath.indexOf("index.html") >= 0) {
content = content.replace("</body></html>",
grunt.file.read("src/web/static/ga.html") + "</body></html>");
return grunt.template.process(content, srcpath);
} else {
return content;
}
},
noProcess: ["**", "!**/*.html"]
},
2017-09-13 17:21:31 +02:00
files: [
{
src: "build/prod/index.html",
dest: "build/prod/index.html"
},
{
expand: true,
src: "docs/**",
dest: "build/prod/"
},
2017-09-13 17:21:31 +02:00
]
2016-11-28 11:42:58 +01:00
}
},
chmod: {
build: {
options: {
mode: "755",
},
2017-03-27 17:08:36 +02:00
src: ["build/**/*", "build/"]
2016-11-28 11:42:58 +01:00
},
docs: {
options: {
mode: "755",
},
src: ["docs/**/*", "docs/"]
}
},
watch: {
config: {
files: ["src/core/operations/**/*", "!src/core/operations/index.mjs"],
tasks: ["exec:generateConfig"]
}
},
concurrent: {
dev: ["watch:config", "webpack-dev-server:start"],
options: {
logConcurrentOutput: true
}
},
2016-11-28 11:42:58 +01:00
exec: {
repoSize: {
2016-11-28 11:42:58 +01:00
command: [
2016-12-14 17:39:17 +01:00
"git ls-files | wc -l | xargs printf '\n%b\ttracked files\n'",
"du -hs | egrep -o '^[^\t]*' | xargs printf '%b\trepository size\n'"
].join(";"),
2016-11-28 11:42:58 +01:00
stderr: false
},
cleanGit: {
2016-11-28 11:42:58 +01:00
command: "git gc --prune=now --aggressive"
},
sitemap: {
command: "node build/prod/sitemap.js > build/prod/sitemap.xml"
2018-03-27 00:14:23 +02:00
},
generateConfig: {
command: [
"echo '\n--- Regenerating config files. ---'",
"echo [] > src/core/config/OperationConfig.json",
2018-08-31 15:58:06 +02:00
"node --experimental-modules --no-warnings --no-deprecation src/core/config/scripts/generateOpsIndex.mjs",
"node --experimental-modules --no-warnings --no-deprecation src/core/config/scripts/generateConfig.mjs",
"echo '--- Config scripts finished. ---\n'"
].join(";")
},
opTests: {
2018-12-28 22:49:40 +01:00
command: "node --experimental-modules --no-warnings --no-deprecation tests/operations/index.mjs"
},
browserTests: {
command: "./node_modules/.bin/nightwatch --env prod,inline"
}
},
2016-11-28 11:42:58 +01:00
});
};