mirror of
https://github.com/node-red/node-red.git
synced 2023-10-10 13:36:53 +02:00
546 lines
24 KiB
JavaScript
546 lines
24 KiB
JavaScript
/**
|
|
* Copyright JS Foundation and other contributors, http://js.foundation
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
**/
|
|
|
|
var path = require("path");
|
|
|
|
module.exports = function(grunt) {
|
|
|
|
var nodemonArgs = ["-v"];
|
|
var flowFile = grunt.option('flowFile');
|
|
if (flowFile) {
|
|
nodemonArgs.push(flowFile);
|
|
}
|
|
|
|
var nonHeadless = grunt.option('non-headless');
|
|
if (nonHeadless) {
|
|
process.env.NODE_RED_NON_HEADLESS = 'true';
|
|
}
|
|
grunt.initConfig({
|
|
pkg: grunt.file.readJSON('package.json'),
|
|
paths: {
|
|
dist: ".dist"
|
|
},
|
|
simplemocha: {
|
|
options: {
|
|
globals: ['expect'],
|
|
timeout: 3000,
|
|
ignoreLeaks: false,
|
|
ui: 'bdd',
|
|
reporter: 'spec'
|
|
},
|
|
all: { src: ['test/**/*_spec.js'] },
|
|
core: { src: ["test/_spec.js","test/unit/**/*_spec.js"]},
|
|
nodes: { src: ["test/nodes/**/*_spec.js"]}
|
|
},
|
|
webdriver: {
|
|
all: {
|
|
configFile: 'test/editor/wdio.conf.js'
|
|
}
|
|
},
|
|
mocha_istanbul: {
|
|
options: {
|
|
globals: ['expect'],
|
|
timeout: 3000,
|
|
ignoreLeaks: false,
|
|
ui: 'bdd',
|
|
reportFormats: ['lcov','html'],
|
|
print: 'both'
|
|
},
|
|
all: { src: ["test/unit/_spec.js","test/unit/**/*_spec.js","test/nodes/**/*_spec.js"] },
|
|
core: { src: ["test/unit/_spec.js","test/unit/**/*_spec.js"]},
|
|
nodes: { src: ["test/nodes/**/*_spec.js"]}
|
|
},
|
|
jshint: {
|
|
options: {
|
|
jshintrc:true
|
|
// http://www.jshint.com/docs/options/
|
|
//"asi": true, // allow missing semicolons
|
|
//"curly": true, // require braces
|
|
//"eqnull": true, // ignore ==null
|
|
//"forin": true, // require property filtering in "for in" loops
|
|
//"immed": true, // require immediate functions to be wrapped in ( )
|
|
//"nonbsp": true, // warn on unexpected whitespace breaking chars
|
|
////"strict": true, // commented out for now as it causes 100s of warnings, but want to get there eventually
|
|
//"loopfunc": true, // allow functions to be defined in loops
|
|
//"sub": true // don't warn that foo['bar'] should be written as foo.bar
|
|
},
|
|
all: [
|
|
'Gruntfile.js',
|
|
'red.js',
|
|
'packages/**/*.js'
|
|
],
|
|
core: {
|
|
files: {
|
|
src: [
|
|
'Gruntfile.js',
|
|
'red.js',
|
|
'packages/**/*.js',
|
|
]
|
|
}
|
|
},
|
|
nodes: {
|
|
files: {
|
|
src: [ 'nodes/core/*/*.js' ]
|
|
}
|
|
},
|
|
editor: {
|
|
files: {
|
|
src: [ 'editor/js/**/*.js' ]
|
|
}
|
|
},
|
|
tests: {
|
|
files: {
|
|
src: ['test/**/*.js']
|
|
},
|
|
options: {
|
|
"expr": true
|
|
}
|
|
}
|
|
},
|
|
concat: {
|
|
options: {
|
|
separator: ";",
|
|
},
|
|
build: {
|
|
src: [
|
|
// Ensure editor source files are concatenated in
|
|
// the right order
|
|
"packages/node_modules/@node-red/editor-client/src/js/red.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/events.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/i18n.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/settings.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/user.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/comms.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/text/bidi.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/text/format.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/state.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/nodes.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/history.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/validators.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/utils.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/common/editableList.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/common/checkboxSet.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/common/menu.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/common/panels.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/common/popover.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/common/searchBox.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/common/tabs.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/common/stack.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/common/typedInput.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/actions.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/deploy.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/diff.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/keyboard.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/workspaces.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/view.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/view-navigator.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/sidebar.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/palette.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/tab-info.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/tab-config.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/tab-context.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/palette-editor.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/editor.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/editors/*.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/tray.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/clipboard.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/library.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/notifications.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/search.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/typeSearch.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/subflow.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/userSettings.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/projects/projects.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/projects/projectSettings.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/projects/projectUserSettings.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/projects/tab-versionControl.js",
|
|
"packages/node_modules/@node-red/editor-client/src/js/ui/touch/radialMenu.js"
|
|
],
|
|
dest: "packages/node_modules/@node-red/editor-client/public/red/red.js"
|
|
},
|
|
vendor: {
|
|
files: {
|
|
"packages/node_modules/@node-red/editor-client/public/vendor/vendor.js": [
|
|
"packages/node_modules/@node-red/editor-client/src/vendor/jquery/js/jquery-1.11.3.min.js",
|
|
"packages/node_modules/@node-red/editor-client/src/vendor/bootstrap/js/bootstrap.min.js",
|
|
"packages/node_modules/@node-red/editor-client/src/vendor/jquery/js/jquery-ui-1.10.3.custom.min.js",
|
|
"packages/node_modules/@node-red/editor-client/src/vendor/jquery/js/jquery.ui.touch-punch.min.js",
|
|
"packages/node_modules/@node-red/editor-client/src/vendor/marked/marked.min.js",
|
|
"packages/node_modules/@node-red/editor-client/src/vendor/d3/d3.v3.min.js",
|
|
"packages/node_modules/@node-red/editor-client/src/vendor/i18next/i18next.min.js"
|
|
],
|
|
"packages/node_modules/@node-red/editor-client/public/vendor/vendor.css": [
|
|
// TODO: resolve relative resource paths in
|
|
// bootstrap/FA/jquery
|
|
],
|
|
"packages/node_modules/@node-red/editor-client/public/vendor/jsonata/jsonata.min.js": [
|
|
"node_modules/jsonata/jsonata-es5.min.js",
|
|
"packages/node_modules/@node-red/editor-client/src/vendor/jsonata/formatter.js"
|
|
],
|
|
"packages/node_modules/@node-red/editor-client/public/vendor/ace/worker-jsonata.js": [
|
|
"node_modules/jsonata/jsonata-es5.min.js",
|
|
"packages/node_modules/@node-red/editor-client/src/vendor/jsonata/worker-jsonata.js"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
uglify: {
|
|
build: {
|
|
files: {
|
|
'packages/node_modules/@node-red/editor-client/public/red/red.min.js': 'packages/node_modules/@node-red/editor-client/public/red/red.js',
|
|
'packages/node_modules/@node-red/editor-client/public/red/main.min.js': 'packages/node_modules/@node-red/editor-client/public/red/main.js',
|
|
'packages/node_modules/@node-red/editor-client/public/vendor/ace/mode-jsonata.js': 'packages/node_modules/@node-red/editor-client/src/vendor/jsonata/mode-jsonata.js',
|
|
'packages/node_modules/@node-red/editor-client/public/vendor/ace/snippets/jsonata.js': 'packages/node_modules/@node-red/editor-client/src/vendor/jsonata/snippets-jsonata.js'
|
|
}
|
|
}
|
|
},
|
|
sass: {
|
|
build: {
|
|
options: {
|
|
outputStyle: 'compressed'
|
|
},
|
|
files: [{
|
|
dest: 'packages/node_modules/@node-red/editor-client/public/red/style.min.css',
|
|
src: 'packages/node_modules/@node-red/editor-client/src/sass/style.scss'
|
|
},
|
|
{
|
|
dest: 'packages/node_modules/@node-red/editor-client/public/vendor/bootstrap/css/bootstrap.min.css',
|
|
src: 'packages/node_modules/@node-red/editor-client/src/vendor/bootstrap/css/bootstrap.css'
|
|
}]
|
|
}
|
|
},
|
|
jsonlint: {
|
|
messages: {
|
|
src: [
|
|
'packages/node_modules/@node-red/nodes/locales/**/*.json',
|
|
'packages/node_modules/@node-red/editor-api/lib/editor/locales/**/*.json',
|
|
'packages/node_modules/@node-red/runtime/locales/**/*.json'
|
|
]
|
|
},
|
|
keymaps: {
|
|
src: [
|
|
'packages/node_modules/@node-red/editor-client/src/js/keymap.json'
|
|
]
|
|
}
|
|
},
|
|
attachCopyright: {
|
|
js: {
|
|
src: [
|
|
'packages/node_modules/@node-red/editor-client/public/red/red.min.js',
|
|
'packages/node_modules/@node-red/editor-client/public/red/main.min.js'
|
|
]
|
|
},
|
|
css: {
|
|
src: [
|
|
'packages/node_modules/@node-red/editor-client/public/red/style.min.css'
|
|
]
|
|
}
|
|
},
|
|
clean: {
|
|
build: {
|
|
src: [
|
|
"packages/node_modules/@node-red/editor-client/public/red",
|
|
"packages/node_modules/@node-red/editor-client/public/index.html",
|
|
"packages/node_modules/@node-red/editor-client/public/favicon.ico",
|
|
"packages/node_modules/@node-red/editor-client/public/icons",
|
|
"packages/node_modules/@node-red/editor-client/public/vendor"
|
|
]
|
|
},
|
|
release: {
|
|
src: [
|
|
'<%= paths.dist %>'
|
|
]
|
|
}
|
|
},
|
|
watch: {
|
|
js: {
|
|
files: [
|
|
'packages/node_modules/@node-red/editor-client/src/js/**/*.js'
|
|
],
|
|
tasks: ['copy:build','concat','uglify','attachCopyright:js']
|
|
},
|
|
sass: {
|
|
files: [
|
|
'packages/node_modules/@node-red/editor-client/src/sass/**/*.scss'
|
|
],
|
|
tasks: ['sass','attachCopyright:css']
|
|
},
|
|
json: {
|
|
files: [
|
|
'packages/node_modules/@node-red/nodes/locales/**/*.json',
|
|
'packages/node_modules/@node-red/editor-api/lib/editor/locales/**/*.json',
|
|
'packages/node_modules/@node-red/runtime/locales/**/*.json'
|
|
],
|
|
tasks: ['jsonlint:messages']
|
|
},
|
|
keymaps: {
|
|
files: [
|
|
'packages/node_modules/@node-red/editor-client/src/js/keymap.json'
|
|
],
|
|
tasks: ['jsonlint:keymaps','copy:build']
|
|
},
|
|
misc: {
|
|
files: [
|
|
'CHANGELOG.md'
|
|
],
|
|
tasks: ['copy:build']
|
|
}
|
|
},
|
|
|
|
nodemon: {
|
|
/* uses .nodemonignore */
|
|
dev: {
|
|
script: 'packages/node_modules/node-red/red.js',
|
|
options: {
|
|
args: nodemonArgs,
|
|
ext: 'js,html,json',
|
|
watch: [
|
|
'packages/node_modules',
|
|
'!packages/node_modules/@node-red/editor-client'
|
|
]
|
|
}
|
|
}
|
|
},
|
|
|
|
concurrent: {
|
|
dev: {
|
|
tasks: ['nodemon', 'watch'],
|
|
options: {
|
|
logConcurrentOutput: true
|
|
}
|
|
}
|
|
},
|
|
|
|
copy: {
|
|
build: {
|
|
files:[
|
|
{
|
|
src: 'packages/node_modules/@node-red/editor-client/src/js/main.js',
|
|
dest: 'packages/node_modules/@node-red/editor-client/public/red/main.js'
|
|
},
|
|
{
|
|
src: 'packages/node_modules/@node-red/editor-client/src/js/keymap.json',
|
|
dest: 'packages/node_modules/@node-red/editor-client/public/red/keymap.json'
|
|
},
|
|
{
|
|
cwd: 'packages/node_modules/@node-red/editor-client/src/images',
|
|
src: '**',
|
|
expand: true,
|
|
dest: 'packages/node_modules/@node-red/editor-client/public/red/images/'
|
|
},
|
|
{
|
|
cwd: 'packages/node_modules/@node-red/editor-client/src/vendor',
|
|
src: [
|
|
'ace/**',
|
|
//'bootstrap/css/**',
|
|
'bootstrap/img/**',
|
|
'jquery/css/**',
|
|
'font-awesome/**'
|
|
],
|
|
expand: true,
|
|
dest: 'packages/node_modules/@node-red/editor-client/public/vendor/'
|
|
},
|
|
{
|
|
cwd: 'packages/node_modules/@node-red/editor-client/src/icons',
|
|
src: '**',
|
|
expand: true,
|
|
dest: 'packages/node_modules/@node-red/editor-client/public/icons/'
|
|
},
|
|
{
|
|
expand: true,
|
|
src: ['packages/node_modules/@node-red/editor-client/src/index.html','packages/node_modules/@node-red/editor-client/src/favicon.ico'],
|
|
dest: 'packages/node_modules/@node-red/editor-client/public/',
|
|
flatten: true
|
|
},
|
|
{
|
|
src: 'CHANGELOG.md',
|
|
dest: 'packages/node_modules/@node-red/editor-client/public/red/about'
|
|
}
|
|
]
|
|
}
|
|
},
|
|
chmod: {
|
|
options: {
|
|
mode: '755'
|
|
},
|
|
release: {
|
|
src: [
|
|
"packages/node_modules/@node-red/nodes/core/hardware/nrgpio",
|
|
"packages/node_modules/@node-red/runtime/lib/storage/localfilesystem/projects/git/node-red-*sh"
|
|
]
|
|
}
|
|
},
|
|
compress: {
|
|
release: {
|
|
options: {
|
|
archive: '<%= paths.dist %>/node-red-<%= pkg.version %>.zip'
|
|
},
|
|
expand: true,
|
|
cwd: 'packages/node_modules/',
|
|
src: [
|
|
'**',
|
|
'!@node-red/editor-client/src/**'
|
|
]
|
|
}
|
|
},
|
|
jsdoc : {
|
|
runtimeAPI: {
|
|
src: 'packages/node_modules/@node-red/runtime/lib/api/*.js',
|
|
options: {
|
|
destination: 'docs',
|
|
configure: './jsdoc.json'
|
|
}
|
|
},
|
|
nodeREDUtil: {
|
|
src: 'packages/node_modules/@node-red/util/**/*.js',
|
|
options: {
|
|
destination: 'packages/node_modules/@node-red/util/docs',
|
|
configure: './jsdoc.json'
|
|
}
|
|
}
|
|
},
|
|
jsdoc2md: {
|
|
runtimeAPI: {
|
|
options: {
|
|
separators: true
|
|
},
|
|
src: 'packages/node_modules/@node-red/runtime/lib/api/*.js',
|
|
dest: 'docs/runtime-api.md'
|
|
},
|
|
nodeREDUtil: {
|
|
options: {
|
|
separators: true
|
|
},
|
|
src: 'packages/node_modules/@node-red/util/**/*.js',
|
|
dest: 'packages/node_modules/@node-red/util/docs/api.md'
|
|
}
|
|
}
|
|
});
|
|
|
|
grunt.loadNpmTasks('grunt-simple-mocha');
|
|
grunt.loadNpmTasks('grunt-contrib-jshint');
|
|
grunt.loadNpmTasks('grunt-contrib-concat');
|
|
grunt.loadNpmTasks('grunt-contrib-uglify');
|
|
grunt.loadNpmTasks('grunt-contrib-clean');
|
|
grunt.loadNpmTasks('grunt-contrib-watch');
|
|
grunt.loadNpmTasks('grunt-concurrent');
|
|
grunt.loadNpmTasks('grunt-sass');
|
|
grunt.loadNpmTasks('grunt-nodemon');
|
|
grunt.loadNpmTasks('grunt-contrib-compress');
|
|
grunt.loadNpmTasks('grunt-contrib-copy');
|
|
grunt.loadNpmTasks('grunt-chmod');
|
|
grunt.loadNpmTasks('grunt-jsonlint');
|
|
grunt.loadNpmTasks('grunt-mocha-istanbul');
|
|
grunt.loadNpmTasks('grunt-webdriver');
|
|
grunt.loadNpmTasks('grunt-jsdoc');
|
|
grunt.loadNpmTasks('grunt-jsdoc-to-markdown');
|
|
|
|
grunt.registerMultiTask('attachCopyright', function() {
|
|
var files = this.data.src;
|
|
var copyright = "/**\n"+
|
|
" * Copyright JS Foundation and other contributors, http://js.foundation\n"+
|
|
" *\n"+
|
|
" * Licensed under the Apache License, Version 2.0 (the \"License\");\n"+
|
|
" * you may not use this file except in compliance with the License.\n"+
|
|
" * You may obtain a copy of the License at\n"+
|
|
" *\n"+
|
|
" * http://www.apache.org/licenses/LICENSE-2.0\n"+
|
|
" *\n"+
|
|
" * Unless required by applicable law or agreed to in writing, software\n"+
|
|
" * distributed under the License is distributed on an \"AS IS\" BASIS,\n"+
|
|
" * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n"+
|
|
" * See the License for the specific language governing permissions and\n"+
|
|
" * limitations under the License.\n"+
|
|
" **/\n";
|
|
|
|
if (files) {
|
|
for (var i=0; i<files.length; i++) {
|
|
var file = files[i];
|
|
if (!grunt.file.exists(file)) {
|
|
grunt.log.warn('File '+ file + ' not found');
|
|
return false;
|
|
} else {
|
|
var content = grunt.file.read(file);
|
|
if (content.indexOf(copyright) == -1) {
|
|
content = copyright+content;
|
|
if (!grunt.file.write(file, content)) {
|
|
return false;
|
|
}
|
|
grunt.log.writeln("Attached copyright to "+file);
|
|
} else {
|
|
grunt.log.writeln("Copyright already on "+file);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
});
|
|
|
|
grunt.registerTask('verifyPackageDependencies', function() {
|
|
var verifyDependencies = require("./scripts/verify-package-dependencies.js");
|
|
var failures = verifyDependencies();
|
|
if (failures.length > 0) {
|
|
failures.forEach(f => grunt.log.error(f));
|
|
grunt.fail.fatal("Failed to verify package dependencies");
|
|
}
|
|
});
|
|
|
|
grunt.registerTask('setDevEnv',
|
|
'Sets NODE_ENV=development so non-minified assets are used',
|
|
function () {
|
|
process.env.NODE_ENV = 'development';
|
|
});
|
|
|
|
grunt.registerTask('default',
|
|
'Builds editor content then runs code style checks and unit tests on all components',
|
|
['build','verifyPackageDependencies','jshint:editor','mocha_istanbul:all']);
|
|
|
|
grunt.registerTask('test-core',
|
|
'Runs code style check and unit tests on core runtime code',
|
|
['build','mocha_istanbul:core']);
|
|
|
|
grunt.registerTask('test-editor',
|
|
'Runs code style check on editor code',
|
|
['jshint:editor']);
|
|
|
|
grunt.registerTask('test-ui',
|
|
'Builds editor content then runs unit tests on editor ui',
|
|
['build','jshint:editor','webdriver:all']);
|
|
|
|
grunt.registerTask('test-nodes',
|
|
'Runs unit tests on core nodes',
|
|
['build','mocha_istanbul:nodes']);
|
|
|
|
grunt.registerTask('build',
|
|
'Builds editor content',
|
|
['clean:build','jsonlint','concat:build','concat:vendor','copy:build','uglify:build','sass:build','attachCopyright']);
|
|
|
|
grunt.registerTask('dev',
|
|
'Developer mode: run node-red, watch for source changes and build/restart',
|
|
['build','setDevEnv','concurrent:dev']);
|
|
|
|
grunt.registerTask('release',
|
|
'Create distribution zip file',
|
|
['build','verifyPackageDependencies','clean:release','chmod:release','compress:release']);
|
|
|
|
grunt.registerTask('coverage',
|
|
'Run Istanbul code test coverage task',
|
|
['build','mocha_istanbul:all']);
|
|
|
|
grunt.registerTask('docs',
|
|
'Generates API documentation',
|
|
['jsdoc','jsdoc2md']);
|
|
};
|