' + ' ' + self.translate('NOT') + diff --git a/src/plugins/sortable/plugin.js b/src/plugins/sortable/plugin.js index 0d7dcaab..1eeb9dab 100644 --- a/src/plugins/sortable/plugin.js +++ b/src/plugins/sortable/plugin.js @@ -63,7 +63,7 @@ QueryBuilder.define('sortable', function(options) { .addClass('dragging'); // create drop placeholder - var ph = $('

 

') + var ph = $($.parseHTML('

 

')) .height(src.$el.outerHeight()); placeholder = src.parent.addRule(ph, src.getPos()); @@ -162,14 +162,14 @@ QueryBuilder.define('sortable', function(options) { if (!options.disable_template) { this.on('getGroupTemplate.filter', function(h, level) { if (level > 1) { - var $h = $(h.value); + var $h = $($.parseHTML(h.value)); $h.find(QueryBuilder.selectors.condition_container).after('

'); h.value = $h.prop('outerHTML'); } }); this.on('getRuleTemplate.filter', function(h) { - var $h = $(h.value); + var $h = $($.parseHTML(h.value)); $h.find(QueryBuilder.selectors.rule_header).after('

'); h.value = $h.prop('outerHTML'); }); From 4c30ebd69404f2c347d236e68b66211e6530fb08 Mon Sep 17 00:00:00 2001 From: mistic100 Date: Sat, 20 Mar 2021 14:39:09 +0100 Subject: [PATCH 07/22] Remove npmignore --- .npmignore | 5 ----- package.json | 4 ++++ 2 files changed, 4 insertions(+), 5 deletions(-) delete mode 100644 .npmignore diff --git a/.npmignore b/.npmignore deleted file mode 100644 index 54026ae7..00000000 --- a/.npmignore +++ /dev/null @@ -1,5 +0,0 @@ -.* -build -composer.json -Gruntfile.js -tests/ diff --git a/package.json b/package.json index 14a80bfd..926ae20f 100644 --- a/package.json +++ b/package.json @@ -8,6 +8,10 @@ }, "description": "jQuery plugin for user friendly query/filter creator", "main": "dist/js/query-builder.js", + "files": [ + "dist/", + "src/" + ], "dependencies": { "bootstrap": "^3.4.1", "dot": "^1.1.3", From 9e08bc083f5d1d29d4b4b25a92da1ca995eeaa38 Mon Sep 17 00:00:00 2001 From: mistic100 Date: Sat, 20 Mar 2021 14:52:09 +0100 Subject: [PATCH 08/22] Update README --- Gruntfile.js | 2 +- README.md | 8 +------- 2 files changed, 2 insertions(+), 8 deletions(-) diff --git a/Gruntfile.js b/Gruntfile.js index a2298e83..52cc8a99 100644 --- a/Gruntfile.js +++ b/Gruntfile.js @@ -27,7 +27,7 @@ module.exports = function(grunt) { 'src/jquery.js' ], js_files_for_standalone: [ - 'node_modules/jquery-extendext/jQuery.extendext.js', + 'node_modules/jquery-extendext/jquery-extendext.js', 'node_modules/dot/doT.js', 'dist/js/query-builder.js' ] diff --git a/README.md b/README.md index 262fd046..84e74403 100644 --- a/README.md +++ b/README.md @@ -24,12 +24,6 @@ jQuery plugin offering an simple interface to create complex queries. [Download the latest release](https://github.com/mistic100/jQuery-QueryBuilder/releases) -#### With Bower - -```bash -$ bower install jQuery-QueryBuilder -``` - #### With npm ```bash @@ -51,7 +45,7 @@ jQuery-QueryBuilder is available on [jsDelivr](https://www.jsdelivr.com/package/ ($.extendext and doT.js are directly included in the [standalone](https://github.com/mistic100/jQuery-QueryBuilder/blob/master/dist/js/query-builder.standalone.js) file) ### Browser support - * Internet Explorer >= 9 + * Internet Explorer >= 11 * All other recent browsers From 7e8527d877634e67120a028b0296473057e94ca0 Mon Sep 17 00:00:00 2001 From: Rick Dubiel Date: Sun, 5 Sep 2021 02:39:35 -0500 Subject: [PATCH 09/22] Fix #924 filter plugin select2 whitespace error. (#923) Co-authored-by: Richard Dubiel --- src/core.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/core.js b/src/core.js index 6944c9a3..bcb7c912 100644 --- a/src/core.js +++ b/src/core.js @@ -700,7 +700,7 @@ QueryBuilder.prototype.createRuleInput = function(rule) { var filter = rule.filter; for (var i = 0; i < rule.operator.nb_inputs; i++) { - var $ruleInput = $($.parseHTML(this.getRuleInput(rule, i))); + var $ruleInput = $($.parseHTML($.trim(this.getRuleInput(rule, i)))); if (i > 0) $valueContainer.append(this.settings.inputs_separator); $valueContainer.append($ruleInput); $inputs = $inputs.add($ruleInput); From b6160dc7ffebef9ae72c5e128725b82fb05b7698 Mon Sep 17 00:00:00 2001 From: mistic100 Date: Sat, 9 Oct 2021 12:10:08 +0200 Subject: [PATCH 10/22] Fix #928 error when getting rules with "allow_invalid" flag --- src/public.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/public.js b/src/public.js index 79491b96..8e8117af 100644 --- a/src/public.js +++ b/src/public.js @@ -272,7 +272,7 @@ QueryBuilder.prototype.getRules = function(options) { }; if (rule.filter && rule.filter.data || rule.data) { - ruleData.data = $.extendext(true, 'replace', {}, rule.filter.data, rule.data); + ruleData.data = $.extendext(true, 'replace', {}, rule.filter ? rule.filter.data : {}, rule.data); } if (options.get_flags) { From e83536fc79868d19c6595834557f2b6685373401 Mon Sep 17 00:00:00 2001 From: mistic100 Date: Sat, 9 Oct 2021 12:49:37 +0200 Subject: [PATCH 11/22] Fix #929 escaping of raw SQL --- src/plugins/sql-support/plugin.js | 29 +++++++++++++++++++++-------- src/utils.js | 15 +++++++++++++-- 2 files changed, 34 insertions(+), 10 deletions(-) diff --git a/src/plugins/sql-support/plugin.js b/src/plugins/sql-support/plugin.js index 17f5c506..4bfb996a 100644 --- a/src/plugins/sql-support/plugin.js +++ b/src/plugins/sql-support/plugin.js @@ -24,12 +24,12 @@ QueryBuilder.defaults({ greater_or_equal: { op: '>= ?' }, between: { op: 'BETWEEN ?', sep: ' AND ' }, not_between: { op: 'NOT BETWEEN ?', sep: ' AND ' }, - begins_with: { op: 'LIKE(?)', mod: '{0}%' }, - not_begins_with: { op: 'NOT LIKE(?)', mod: '{0}%' }, - contains: { op: 'LIKE(?)', mod: '%{0}%' }, - not_contains: { op: 'NOT LIKE(?)', mod: '%{0}%' }, - ends_with: { op: 'LIKE(?)', mod: '%{0}' }, - not_ends_with: { op: 'NOT LIKE(?)', mod: '%{0}' }, + begins_with: { op: 'LIKE ?', mod: '{0}%', escape: '%_' }, + not_begins_with: { op: 'NOT LIKE ?', mod: '{0}%', escape: '%_' }, + contains: { op: 'LIKE ?', mod: '%{0}%', escape: '%_' }, + not_contains: { op: 'NOT LIKE ?', mod: '%{0}%', escape: '%_' }, + ends_with: { op: 'LIKE ?', mod: '%{0}', escape: '%_' }, + not_ends_with: { op: 'NOT LIKE ?', mod: '%{0}', escape: '%_' }, is_empty: { op: '= \'\'' }, is_not_empty: { op: '!= \'\'' }, is_null: { op: 'IS NULL' }, @@ -307,7 +307,7 @@ QueryBuilder.extend(/** @lends module:plugins.SqlSupport.prototype */ { v = v ? 1 : 0; } else if (!stmt && rule.type !== 'integer' && rule.type !== 'double' && rule.type !== 'boolean') { - v = Utils.escapeString(v); + v = Utils.escapeString(v, sql.escape); } if (sql.mod) { @@ -579,6 +579,19 @@ QueryBuilder.extend(/** @lends module:plugins.SqlSupport.prototype */ { Utils.error('SQLParse', 'Cannot find field name in {0}', JSON.stringify(data.left)); } + // unescape chars declared by the operator + var finalValue = opVal.val; + var sql = self.settings.sqlOperators[opVal.op]; + if (!stmt && sql && sql.escape) { + var searchChars = sql.escape.split('').map(function(c) { + return '\\\\' + c; + }).join('|'); + finalValue = finalValue + .replace(new RegExp('(' + searchChars + ')', 'g'), function(s) { + return s[1]; + }); + } + var id = self.getSQLFieldID(field, value); /** @@ -593,7 +606,7 @@ QueryBuilder.extend(/** @lends module:plugins.SqlSupport.prototype */ { id: id, field: field, operator: opVal.op, - value: opVal.val + value: finalValue }, data); curr.rules.push(rule); diff --git a/src/utils.js b/src/utils.js index ef9c81b7..d74f0817 100644 --- a/src/utils.js +++ b/src/utils.js @@ -145,14 +145,15 @@ Utils.changeType = function(value, type) { /** * Escapes a string like PHP's mysql_real_escape_string does * @param {string} value + * @param {string} [additionalEscape] additionnal chars to escape * @returns {string} */ -Utils.escapeString = function(value) { +Utils.escapeString = function(value, additionalEscape) { if (typeof value != 'string') { return value; } - return value + var escaped = value .replace(/[\0\n\r\b\\\'\"]/g, function(s) { switch (s) { // @formatter:off @@ -160,6 +161,7 @@ Utils.escapeString = function(value) { case '\n': return '\\n'; case '\r': return '\\r'; case '\b': return '\\b'; + case '\'': return '\'\''; default: return '\\' + s; // @formatter:off } @@ -167,6 +169,15 @@ Utils.escapeString = function(value) { // uglify compliant .replace(/\t/g, '\\t') .replace(/\x1a/g, '\\Z'); + + if (additionalEscape) { + escaped = escaped + .replace(new RegExp('[' + additionalEscape + ']', 'g'), function(s) { + return '\\' + s; + }); + } + + return escaped; }; /** From 4649d1abd014cfaa89b673e4f1553ef0a4b6311e Mon Sep 17 00:00:00 2001 From: mistic100 Date: Sat, 9 Oct 2021 12:53:04 +0200 Subject: [PATCH 12/22] Fix #926 Wrong example --- examples/index.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/index.html b/examples/index.html index 8fc91c18..1c734012 100644 --- a/examples/index.html +++ b/examples/index.html @@ -414,7 +414,7 @@

Output

max: 100, value: 0 }, - onAfterSetValue: function(rule, value) { + valueSetter: function(rule, value) { var input = rule.$el.find('.rule-value-container input'); input.slider('setValue', value); input.val(value); // don't know why I need it @@ -624,7 +624,7 @@

Output

// set rules from SQL $('.set-sql').on('click', function() { - $('#builder').queryBuilder('setRulesFromSQL', 'username NOT LIKE "Mistic%" OR price BETWEEN 100 OR 200 OR NOT (category IN(1, 2) AND rate <= 2)'); + $('#builder').queryBuilder('setRulesFromSQL', 'username NOT LIKE "Mistic%" OR price BETWEEN 100 OR 200 OR NOT (category IN(1, 2) AND rate <= 20)'); }); // reset builder From 48e1f09de01862e1bb12d98887b01a12079bd5ed Mon Sep 17 00:00:00 2001 From: TotPeRo Date: Sat, 26 Mar 2022 11:12:29 +0200 Subject: [PATCH 13/22] Update all Romainian language (#946) Translate also the errors messages and fix some transaltion --- src/i18n/ro.json | 36 ++++++++++++++++++++++++++++++++---- 1 file changed, 32 insertions(+), 4 deletions(-) diff --git a/src/i18n/ro.json b/src/i18n/ro.json index a0e1fc06..b2a6eae3 100644 --- a/src/i18n/ro.json +++ b/src/i18n/ro.json @@ -1,6 +1,6 @@ { "__locale": "Romanian (ro)", - "__author": "ArianServ", + "__author": "ArianServ, totpero", "add_rule": "Adaugă regulă", "add_group": "Adaugă grup", @@ -17,10 +17,12 @@ "not_equal": "diferit", "in": "în", "not_in": "nu în", - "less": "mai puţin", - "less_or_equal": "mai puţin sau egal", + "less": "mai mic", + "less_or_equal": "mai mic sau egal", "greater": "mai mare", "greater_or_equal": "mai mare sau egal", + "between": "între", + "not_between": "nu între", "begins_with": "începe cu", "not_begins_with": "nu începe cu", "contains": "conţine", @@ -31,5 +33,31 @@ "is_not_empty": "nu este gol", "is_null": "e nul", "is_not_null": "nu e nul" + }, + + "errors": { + "no_filter": "Nici un filtru selectat", + "empty_group": "Grupul este gol", + "radio_empty": "Nici o valoare nu este selectată", + "checkbox_empty": "Nici o valoare nu este selectată", + "select_empty": "Nici o valoare nu este selectată", + "string_empty": "Valoare goală", + "string_exceed_min_length": "Trebuie să conţină mai puţin de {0} caractere", + "string_exceed_max_length": "Trebuie să conţină mai mult de {0} caractere", + "string_invalid_format": "Format invalid ({0})", + "number_nan": "Nu este număr", + "number_not_integer": "Nu este număr întreg", + "number_not_double": "Nu este număr real", + "number_exceed_min": "Trebuie să fie mai mare decât {0}", + "number_exceed_max": "Trebuie să fie mai mic decât {0}", + "number_wrong_step": "Trebuie să fie multiplu de {0}", + "number_between_invalid": "Valori invalide, {0} este mai mare decât {1}", + "datetime_empty": "Valoare goală", + "datetime_invalid": "Format dată invalid ({0})", + "datetime_exceed_min": "Trebuie să fie după {0}", + "datetime_exceed_max": "Trebuie să fie înainte {0}", + "datetime_between_invalid": "Valori invalide, {0} este mai mare decât {1}", + "boolean_not_valid": "Nu este boolean", + "operator_not_multiple": "Operatorul \"{1}\" nu poate accepta mai multe valori" } -} \ No newline at end of file +} From 317df5c6656dbedd2bfdcb8c1689057448cc5fd0 Mon Sep 17 00:00:00 2001 From: mistic100 Date: Sun, 2 Jul 2023 11:58:12 +0200 Subject: [PATCH 14/22] chore: remove grunt + update dev tools --- .github/PULL_REQUEST_TEMPLATE.md | 1 - .github/workflows/main.yml | 17 +- .gitignore | 3 - .jscsrc | 37 - .jshintrc | 4 - .sass-lint.yml | 9 - Gruntfile.js | 443 ---- README.md | 36 +- build/cleanLn.js | 3 - build/dist.mjs | 211 ++ build/initConfig.js | 68 - build/liveserver.mjs | 20 + build/processLang.js | 30 - build/removeJshint.js | 5 - examples/index.html | 77 +- package.json | 40 +- src/data.js | 6 - src/plugins/filter-description/plugin.scss | 2 +- src/scss/default.scss | 3 - yarn.lock | 2450 ++++++++++++++++++++ 20 files changed, 2735 insertions(+), 730 deletions(-) delete mode 100644 .jscsrc delete mode 100644 .jshintrc delete mode 100644 .sass-lint.yml delete mode 100644 Gruntfile.js delete mode 100644 build/cleanLn.js create mode 100644 build/dist.mjs delete mode 100644 build/initConfig.js create mode 100644 build/liveserver.mjs delete mode 100644 build/processLang.js delete mode 100644 build/removeJshint.js create mode 100644 yarn.lock diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 7fe8317d..1131297f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -3,6 +3,5 @@ - [ ] I read the [guidelines for contributing](https://github.com/mistic100/jQuery-QueryBuilder/blob/master/.github/CONTRIBUTING.md) - [ ] I created my branch from `dev` and I am issuing the PR to `dev` - [ ] I didn't pushed the `dist` directory -- [ ] Unit tests are OK - [ ] If it's a new feature, I added the necessary unit tests - [ ] If it's a new language, I filled the `__locale` and `__author` fields diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 81718908..0648b398 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -8,9 +8,14 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v1 - - name: build - run: | - npm install - npm run test - npm run build + - uses: actions/checkout@v3 + + - uses: actions/setup-node@v3 + with: + node-version: '16' + cache: 'yarn' + + - name: build + run: | + yarn install + yarn build diff --git a/.gitignore b/.gitignore index d0a0ebb9..a50c5eea 100644 --- a/.gitignore +++ b/.gitignore @@ -1,10 +1,7 @@ -bower_components node_modules dist doc .sass-cache -.coverage-results .idea *.iml -yarn.lock package-lock.json diff --git a/.jscsrc b/.jscsrc deleted file mode 100644 index ce1e5220..00000000 --- a/.jscsrc +++ /dev/null @@ -1,37 +0,0 @@ -{ - "preset": "idiomatic", - "validateIndentation": 4, - "requireCamelCaseOrUpperCaseIdentifiers": false, - "disallowKeywordsOnNewLine": [], - "requireKeywordsOnNewLine": [ - "else" - ], - "requirePaddingNewLinesAfterBlocks": false, - "safeContextKeyword": "self", - "disallowMultipleLineStrings": false, - "requirePaddingNewLinesBeforeLineComments": false, - "requireSpaceBeforeBinaryOperators": [ - "=", "+", "-", "*", "/", "%", - "<<", ">>", ">>>", "&", "|", "^", - "&&", "||", - "===", "==", ">=", "<=", "<", ">", "!=", "!==" - ], - "requireDotNotation": false, - "requireSpacesInsideBrackets": false, - "requireSpacesInsideParentheses": false, - "maximumLineLength": null, - "maximumNumberOfLines": null, - "validateQuoteMarks": { - "mark": "'", - "escape": true - }, - "requireCurlyBraces": [ - "for", - "while", - "do", - "try", - "catch" - ], - "requireEarlyReturn": false, - "validateCommentPosition": false -} \ No newline at end of file diff --git a/.jshintrc b/.jshintrc deleted file mode 100644 index 518111a8..00000000 --- a/.jshintrc +++ /dev/null @@ -1,4 +0,0 @@ -{ - "-W069": true, // accesses to "regional" in language files - "multistr": true -} \ No newline at end of file diff --git a/.sass-lint.yml b/.sass-lint.yml deleted file mode 100644 index 2d387551..00000000 --- a/.sass-lint.yml +++ /dev/null @@ -1,9 +0,0 @@ -rules: - property-sort-order: [0] - force-pseudo-nesting: [0] - force-element-nesting: [0] - force-attribute-nesting: [0] - no-important: [0] - no-qualifying-elements: [0] - shorthand-values: [1, {allowed-shorthands: [1, 2, 4]}] - hex-notation: [1, {style: uppercase}] diff --git a/Gruntfile.js b/Gruntfile.js deleted file mode 100644 index 52cc8a99..00000000 --- a/Gruntfile.js +++ /dev/null @@ -1,443 +0,0 @@ -var initConfig = require('./build/initConfig'); -var processLang = require('./build/processLang'); -var removeJshint = require('./build/removeJshint'); -var cleanLn = require('./build/cleanLn'); - -module.exports = function(grunt) { - require('time-grunt')(grunt); - require('jit-grunt')(grunt, { - sasslint: 'grunt-sass-lint', - sass_injection: 'grunt-sass-injection', - usebanner: 'grunt-banner' - }); - - grunt.util.linefeed = '\n'; - - var config = initConfig(grunt, { - js_core_files: [ - 'src/main.js', - 'src/defaults.js', - 'src/plugins.js', - 'src/core.js', - 'src/public.js', - 'src/data.js', - 'src/template.js', - 'src/utils.js', - 'src/model.js', - 'src/jquery.js' - ], - js_files_for_standalone: [ - 'node_modules/jquery-extendext/jquery-extendext.js', - 'node_modules/dot/doT.js', - 'dist/js/query-builder.js' - ] - }); - - grunt.initConfig({ - pkg: grunt.file.readJSON('package.json'), - - banner: '/*!\n' + - ' * jQuery QueryBuilder <%= pkg.version %>\n' + - ' * Copyright 2014-<%= grunt.template.today("yyyy") %> Damien "Mistic" Sorel (http://www.strangeplanet.fr)\n' + - ' * Licensed under MIT (https://opensource.org/licenses/MIT)\n' + - ' */', - - langBanner: '/*!\n' + - ' * jQuery QueryBuilder <%= pkg.version %>\n' + - ' * Locale: <%= lang_locale %>\n' + - '<% if (lang_author) { %> * Author: <%= lang_author %>\n<% } %>' + - ' * Licensed under MIT (https://opensource.org/licenses/MIT)\n' + - ' */', - - // serve folder content - connect: { - dev: { - options: { - host: '0.0.0.0', - port: 9000, - livereload: true - } - }, - test: { - options: { - port: 9001 - } - } - }, - - // watchers - watch: { - options: { - livereload: true - }, - js: { - files: ['src/*.js', 'src/plugins/**/plugin.js'], - tasks: ['injector:example'] - }, - css: { - files: ['src/scss/*.scss', 'src/plugins/**/plugin.scss'], - tasks: ['build_css'] - }, - lang: { - files: ['src/i18n/*.json', 'src/plugins/**/i18n/*.json'], - tasks: ['build_lang'] - }, - example: { - files: ['examples/**'], - tasks: [] - } - }, - - // open example - open: { - dev: { - path: 'http://localhost:<%= connect.dev.options.port%>/examples/index.html' - } - }, - - // copy SASS files - copy: { - sass_core: { - files: [{ - expand: true, - flatten: true, - src: ['src/scss/*.scss'], - dest: 'dist/scss' - }] - }, - sass_plugins: { - files: config.loaded_plugins.map(function(name) { - return { - src: 'src/plugins/' + name + '/plugin.scss', - dest: 'dist/scss/plugins/_' + name + '.scss' - }; - }) - }, - doc_script: { - src: 'build/jsdoc.js', - dest: 'doc/js/custom.js' - } - }, - - concat: { - // concat all JS - js: { - src: config.js_files_to_load, - dest: 'dist/js/query-builder.js', - options: { - stripBanners: false, - separator: '\n\n', - process: function(src) { - return cleanLn(removeJshint(src)); - } - } - }, - // create standalone version - js_standalone: { - src: config.js_files_for_standalone, - dest: 'dist/js/query-builder.standalone.js', - options: { - stripBanners: false, - separator: '\n\n', - process: function(src, file) { - var name = file.match(/([^\/]+?).js$/)[1]; - - return cleanLn(removeJshint(src)) - .replace(/define\((.*?)\);/, 'define(\'' + name + '\', $1);'); - } - } - }, - // compile language files with AMD wrapper - lang: { - files: Object.keys(config.all_langs).map(function(name) { - return { - src: 'src/i18n/' + name + '.json', - dest: 'dist/i18n/query-builder.' + name + '.js' - }; - }), - options: { - process: function(src, file) { - var wrapper = cleanLn(grunt.file.read('src/i18n/.wrapper.js')).split(/@@js\n/); - return processLang(grunt, config.loaded_plugins)(file, src, wrapper); - } - } - }, - // compile language files without AMD wrapper - lang_temp: { - files: Object.keys(config.all_langs).map(function(name) { - return { - src: 'src/i18n/' + name + '.json', - dest: '.temp/i18n/' + name + '.js' - }; - }), - options: { - process: function(src, file) { - return processLang(grunt, config.loaded_plugins)(file, src); - } - } - } - }, - - // add AMD wrapper - wrap: { - js: { - src: ['dist/js/query-builder.js'], - dest: 'dist/js/query-builder.js', - options: { - separator: '', - wrapper: function() { - return cleanLn(grunt.file.read('src/.wrapper.js')).split(/@@js\n/); - } - } - } - }, - - // add banners - usebanner: { - options: { - banner: '<%= banner %>' - }, - js: { - src: ['dist/js/*.js'] - }, - css: { - src: ['dist/css/*.css', 'dist/scss/*.scss'] - } - }, - - // add plugins SASS imports - sass_injection: { - dist: { - options: { - replacePath: { - pattern: 'dist/scss/', - replace: '' - } - }, - src: ['dist/scss/plugins/*.scss'], - target: 'dist/scss/default.scss' - } - }, - - // parse scss - sass: { - options: { - sourceMap: false, - outputStyle: 'expanded' - }, - dist: { - files: [{ - expand: true, - flatten: true, - src: ['dist/scss/*.scss'], - dest: 'dist/css', - ext: '.css', - rename: function(dest, src) { - return dest + '/query-builder.' + src; - } - }] - } - }, - - // compress js - uglify: { - options: { - banner: '<%= banner %>\n', - mangle: { reserved: ['$'] }, - sourceMap: true, - }, - dist: { - files: [{ - expand: true, - flatten: true, - src: ['dist/js/*.js', '!dist/js/*.min.js'], - dest: 'dist/js', - ext: '.min.js', - extDot: 'last' - }] - } - }, - - // compress css - cssmin: { - dist: { - files: [{ - expand: true, - flatten: true, - src: ['dist/css/*.css', '!dist/css/*.min.css'], - dest: 'dist/css', - ext: '.min.css', - extDot: 'last' - }] - } - }, - - // clean build dir - clean: { - temp: ['.temp'], - doc: ['doc'] - }, - - // jshint tests - jshint: { - lib: { - options: { - jshintrc: '.jshintrc' - }, - src: ['src/**/*.js', '!src/**/.wrapper.js'] - } - }, - - // jscs tests - jscs: { - lib: { - options: { - config: '.jscsrc' - }, - src: ['src/**/*.js', '!src/**/.wrapper.js'] - } - }, - - // scss tests - sasslint: { - lib: { - options: { - configFile: '.sass-lint.yml' - }, - src: ['src/**/*.scss'] - } - }, - - // jsDoc generation - jsdoc: { - lib: { - src: ['src/**/*.js', '!src/**/.wrapper.js'], - options: { - destination: 'doc', - config: '.jsdoc.json' - } - } - }, - - // inject sources files and tests modules in demo and test - injector: { - options: { - relative: true, - addRootSlash: false - }, - example: { - src: config.all_js_files.concat(['dist/i18n/query-builder.en.js']), - dest: 'examples/index.html' - }, - testSrc: { - options: { - starttag: '', - transform: function(filepath) { - return ''; - } - }, - src: config.all_js_files, - dest: 'tests/index.html' - }, - testModules: { - options: { - starttag: '' - }, - src: ['tests/*.module.js'], - dest: 'tests/index.html' - } - }, - - // qunit test suite - qunit: { - all: { - options: { - urls: ['http://localhost:<%= connect.test.options.port %>/tests/index.html?coverage=true'], - noGlobals: true - } - } - }, - - // save LCOV files - qunit_blanket_lcov: { - all: { - files: [{ - expand: true, - src: ['src/*.js', 'src/plugins/**/plugin.js'] - }], - options: { - dest: '.coverage-results/all.lcov', - prefix: 'http://localhost:<%= connect.test.options.port %>/' - } - } - }, - - // coveralls data - coveralls: { - options: { - force: true - }, - all: { - src: '.coverage-results/all.lcov' - } - } - }); - - - grunt.registerTask('build_js', [ - 'concat:lang_temp', - 'concat:js', - 'wrap:js', - 'usebanner:js', - 'concat:js_standalone', - 'uglify', - 'clean:temp' - ]); - - grunt.registerTask('build_css', [ - 'copy:sass_core', - 'copy:sass_plugins', - 'sass_injection', - 'sass', - 'cssmin', - 'usebanner:css' - ]); - - grunt.registerTask('build_lang', [ - 'concat:lang' - ]); - - grunt.registerTask('default', [ - 'build_lang', - 'build_js', - 'build_css' - ]); - - grunt.registerTask('test', [ - 'jshint', - 'jscs', - 'sasslint', - 'build_lang', - 'build_css', - 'injector:testSrc', - 'injector:testModules', - 'connect:test', - 'qunit_blanket_lcov', - 'qunit' - ]); - - grunt.registerTask('serve', [ - 'build_lang', - 'build_css', - 'injector:example', - 'open', - 'connect:dev', - 'watch' - ]); - - grunt.registerTask('doc', [ - 'clean:doc', - 'jsdoc', - 'copy:doc_script' - ]); -}; diff --git a/README.md b/README.md index 84e74403..9e32b24d 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,6 @@ [](https://www.npmjs.com/package/jQuery-QueryBuilder) [](https://www.jsdelivr.com/package/npm/jQuery-QueryBuilder) [](https://github.com/mistic100/jQuery-QueryBuilder/actions) -[](https://coveralls.io/r/mistic100/jQuery-QueryBuilder) [](https://david-dm.org/mistic100/jQuery-QueryBuilder) [](https://gitlocalize.com/repo/5259/whole_project?utm_source=badge) @@ -50,40 +49,17 @@ jQuery-QueryBuilder is available on [jsDelivr](https://www.jsdelivr.com/package/ -## Build +## Developement -#### Prerequisites +Install Node dependencies with `npm install`. - * NodeJS + NPM: `apt-get install nodejs-legacy npm` - * Grunt CLI: `npm install -g grunt-cli` +#### Build -#### Run +Run `npm run build` in the root directory to generate production files inside `dist`. -Install Node dependencies `npm install` then run `grunt` in the root directory to generate production files inside `dist`. +#### Serve -#### Options - -You can choose which plugins to include with `--plugins` : -```bash -# include "sql-support" and "mongodb-support" plugins -grunt --plugins=sql-support,mongodb-support - -# disable all plugins -grunt --plugins=false -``` -All plugins are included by default. - -You can also include language files with `--languages` : -```bash -# include French & Italian translation -grunt --languages=fr,it -``` - -#### Other commands - - * `grunt test` to run jshint/jscs/scsslint and the QUnit test suite. - * `grunt serve` to open the example page with automatic build and livereload. - * `grunt doc` to generate the documentation. +Run `npm run serve` to open the example page with automatic build and livereload. ## License diff --git a/build/cleanLn.js b/build/cleanLn.js deleted file mode 100644 index f93432e8..00000000 --- a/build/cleanLn.js +++ /dev/null @@ -1,3 +0,0 @@ -module.exports = function(src) { - return src.replace(/\r\n/g, '\n'); -}; diff --git a/build/dist.mjs b/build/dist.mjs new file mode 100644 index 00000000..aa71a125 --- /dev/null +++ b/build/dist.mjs @@ -0,0 +1,211 @@ +import fs from 'fs'; +import path from 'path'; +import { globSync } from 'glob'; +import * as sass from 'sass'; +import pkg from '../package.json' assert { type: 'json' }; + +const DEV = process.argv[2] === '--dev'; + +const DIST = 'dist/'; + +const CORE_JS = [ + 'src/main.js', + 'src/defaults.js', + 'src/plugins.js', + 'src/core.js', + 'src/public.js', + 'src/data.js', + 'src/template.js', + 'src/utils.js', + 'src/model.js', + 'src/jquery.js', +]; + +const CORE_SASS = [ + 'src/scss/dark.scss', + 'src/scss/default.scss', +]; + +const STANDALONE_JS = { + 'jquery-extendext': 'node_modules/jquery-extendext/jquery-extendext.js', + 'dot/doT': 'node_modules/dot/doT.js', + 'query-builder': `${DIST}js/query-builder.js`, +}; + +const BANNER = () => `/*! + * jQuery QueryBuilder ${pkg.version} + * Copyright 2014-${new Date().getFullYear()} Damien "Mistic" Sorel (http://www.strangeplanet.fr) + * Licensed under MIT (https://opensource.org/licenses/MIT) + */`; + +const LANG_BANNER = (locale, author) => `/*! + * jQuery QueryBuilder ${pkg.version} + * Locale: ${locale} + * Author: ${author} + * Licensed under MIT (https://opensource.org/licenses/MIT) + */`; + +const ALL_PLUGINS_JS = glob('src/plugins/*/plugin.js') + .sort() + .reduce((all, p) => { + const n = p.split('/')[2]; + all[n] = p; + return all; + }, {}); + +const ALL_PLUGINS_SASS = glob('src/plugins/*/plugin.scss') + .sort() + .reduce((all, p) => { + const n = p.split('/')[2]; + all[n] = p; + return all; + }, {}); + +const ALL_LANGS = glob('src/i18n/*.json') + .map(p => p.split(/[\/\.]/)[2]) + .sort(); + +function glob(pattern) { + return globSync(pattern) + .map(p => p.split(path.sep).join('/')); +} + +/** + * Build lang files + */ +function buildLangs() { + const wrapper = fs.readFileSync('src/i18n/.wrapper.js', { encoding: 'utf8' }) + .split('@@js\n'); + + ALL_LANGS.forEach(lang => { + const outpath = `${DIST}i18n/query-builder.${lang}.js`; + console.log(`LANG ${lang} (${outpath})`); + fs.writeFileSync(outpath, getLang(lang, wrapper)); + }); +} + +/** + * Get the content of a single lang + */ +function getLang(lang, wrapper = ['', '']) { + const corepath = `src/i18n/${lang}.json`; + const content = JSON.parse(fs.readFileSync(corepath, { encoding: 'utf8' })); + + Object.keys(ALL_PLUGINS_JS).forEach(plugin => { + const pluginpath = `src/plugins/${plugin}/i18n/${lang}.json`; + try { + const plugincontent = JSON.parse(fs.readFileSync(pluginpath, { encoding: 'utf8' })); + Object.assign(content, plugincontent); + } catch { } + }); + + return LANG_BANNER(content.__locale || lang, content.__author || '') + + '\n\n' + + wrapper[0] + + `QueryBuilder.regional['${lang}'] = ` + + JSON.stringify(content, null, 2) + + ';\n\n' + + `QueryBuilder.defaults({ lang_code: '${lang}' });` + + wrapper[1]; +} + +/** + * Build main JS file + */ +function buildMain() { + const wrapper = fs.readFileSync('src/.wrapper.js', { encoding: 'utf8' }) + .split('@@js\n'); + + const files_to_load = [ + ...CORE_JS, + ...Object.values(ALL_PLUGINS_JS), + ]; + + const output = BANNER() + + '\n\n' + + wrapper[0] + + files_to_load.map(f => fs.readFileSync(f, { encoding: 'utf8' })).join('\n\n') + + '\n\n' + + getLang('en') + + wrapper[1]; + + const outpath = `${DIST}js/query-builder.js`; + console.log(`MAIN (${outpath})`); + fs.writeFileSync(outpath, output); +} + +/** + * Build standalone JS file + */ +function buildStandalone() { + const output = Object.entries(STANDALONE_JS) + .map(([name, file]) => { + return fs.readFileSync(file, { encoding: 'utf8' }) + .replace(/define\((.*?)\);/, `define('${name}', $1);`); + }) + .join('\n\n'); + + const outpath = `${DIST}js/query-builder.standalone.js`; + console.log(`STANDALONE (${outpath})`); + fs.writeFileSync(outpath, output); +} + +/** + * Copy SASS files + */ +function copySass() { + Object.entries(ALL_PLUGINS_SASS).forEach(([plugin, path]) => { + const outpath = `${DIST}scss/plugins/${plugin}.scss`; + console.log(`SASS ${plugin} (${path})`); + fs.copyFileSync(path, outpath); + }); + + CORE_SASS.forEach(path => { + const name = path.split('/').pop(); + + const content = fs.readFileSync(path, { encoding: 'utf8' }); + + let output = BANNER() + + '\n' + + content; + if (name === 'default.scss') { + output += '\n' + + Object.keys(ALL_PLUGINS_SASS).map(p => `@import "plugins/${p}";`).join('\n'); + } + + const outpath = `${DIST}scss/${name}`; + console.log(`SASS (${path})`); + fs.writeFileSync(outpath, output); + }); +} + +/** + * Build CSS files + */ +function buildCss() { + CORE_SASS.forEach(p => { + const path = p.replace('src/', DIST); + const name = path.split('/').pop(); + + const output = sass.compile(path); + + const outpath = `${DIST}css/query-builder.${name.split('.').shift()}.css`; + console.log(`CSS (${path})`); + fs.writeFileSync(outpath, output.css); + }); +} + +if (!DEV) { + fs.rmSync(DIST, { recursive: true, force: true }); +} +fs.mkdirSync(DIST + 'css', { recursive: true }); +fs.mkdirSync(DIST + 'i18n', { recursive: true }); +fs.mkdirSync(DIST + 'js', { recursive: true }); +fs.mkdirSync(DIST + 'scss', { recursive: true }); +fs.mkdirSync(DIST + 'scss/plugins', { recursive: true }); + +buildLangs(); +buildMain(); +buildStandalone(); +copySass(); +buildCss(); diff --git a/build/initConfig.js b/build/initConfig.js deleted file mode 100644 index 5bb333ee..00000000 --- a/build/initConfig.js +++ /dev/null @@ -1,68 +0,0 @@ -module.exports = function(grunt, config) { - config.all_plugins = {}; - config.all_langs = {}; - config.loaded_plugins = []; - config.loaded_langs = []; - config.js_files_to_load = config.js_core_files.slice(); - config.all_js_files = config.js_core_files.slice(); - - // list available plugins and languages - grunt.file.expand('src/plugins/**/plugin.js') - .forEach(function(f) { - var n = f.split('/')[2]; - config.all_plugins[n] = f; - }); - - grunt.file.expand('src/i18n/*.json') - .forEach(function(f) { - var n = f.split(/[\/\.]/)[2]; - config.all_langs[n] = f; - }); - - // fill all js files - for (var p in config.all_plugins) { - config.all_js_files.push(config.all_plugins[p]); - } - - // parse 'plugins' parameter - var arg_plugins = grunt.option('plugins'); - if (typeof arg_plugins === 'string') { - arg_plugins.replace(/ /g, '').split(',').forEach(function(p) { - if (config.all_plugins[p]) { - config.js_files_to_load.push(config.all_plugins[p]); - config.loaded_plugins.push(p); - } - else { - grunt.fail.warn('Plugin ' + p + ' unknown'); - } - }); - } - else if (arg_plugins === undefined) { - for (var p in config.all_plugins) { - config.js_files_to_load.push(config.all_plugins[p]); - config.loaded_plugins.push(p); - } - } - - // default language - config.js_files_to_load.push('.temp/i18n/en.js'); - config.loaded_langs.push('en'); - - // parse 'lang' parameter - var arg_langs = grunt.option('languages'); - if (typeof arg_langs === 'string') { - arg_langs.replace(/ /g, '').split(',').forEach(function(l) { - if (config.all_langs[l]) { - if (l !== 'en') { - config.js_files_to_load.push(config.all_langs[l].replace(/^src/, '.temp').replace(/json$/, 'js')); - config.loaded_langs.push(l); - } - } - else { - grunt.fail.warn('Language ' + l + ' unknown'); - } - }); - } - - return config; -}; diff --git a/build/liveserver.mjs b/build/liveserver.mjs new file mode 100644 index 00000000..3d60e23c --- /dev/null +++ b/build/liveserver.mjs @@ -0,0 +1,20 @@ +import liveServer from 'alive-server'; +import path from 'path'; + +const rootDir = process.cwd(); + +const EXAMPLES_DIR = 'examples'; +const DIST_DIR = 'dist'; + +liveServer.start({ + open: true, + root: path.join(rootDir, EXAMPLES_DIR), + watch: [ + path.join(rootDir, EXAMPLES_DIR), + path.join(rootDir, DIST_DIR), + ], + mount: [ + ['/node_modules', path.join(rootDir, 'node_modules')], + ['/dist', path.join(rootDir, DIST_DIR)], + ], +}); diff --git a/build/processLang.js b/build/processLang.js deleted file mode 100644 index 33c6b2c7..00000000 --- a/build/processLang.js +++ /dev/null @@ -1,30 +0,0 @@ -var deepmerge = require('deepmerge'); - -module.exports = function(grunt, loaded_plugins) { - return function(file, src, wrapper) { - var lang = file.split(/[\/\.]/)[2]; - var content = JSON.parse(src); - wrapper = wrapper || ['', '']; - - grunt.config.set('lang_locale', content.__locale || lang); - grunt.config.set('lang_author', content.__author); - var header = grunt.template.process('<%= langBanner %>'); - - loaded_plugins.forEach(function(p) { - var plugin_file = 'src/plugins/' + p + '/i18n/' + lang + '.json'; - - if (grunt.file.exists(plugin_file)) { - content = deepmerge(content, grunt.file.readJSON(plugin_file)); - } - }); - - return header - + '\n\n' - + wrapper[0] - + 'QueryBuilder.regional[\'' + lang + '\'] = ' - + JSON.stringify(content, null, 2) - + ';\n\n' - + 'QueryBuilder.defaults({ lang_code: \'' + lang + '\' });' - + wrapper[1]; - }; -}; diff --git a/build/removeJshint.js b/build/removeJshint.js deleted file mode 100644 index 4ff583ac..00000000 --- a/build/removeJshint.js +++ /dev/null @@ -1,5 +0,0 @@ -module.exports = function(src) { - return src - .replace(/\/\*jshint [a-z:]+ \*\/\r?\n\r?\n?/g, '') - .replace(/\/\*jshint -[EWI]{1}[0-9]{3} \*\/\r?\n\r?\n?/g, ''); -}; diff --git a/examples/index.html b/examples/index.html index 1c734012..f92b4702 100644 --- a/examples/index.html +++ b/examples/index.html @@ -6,14 +6,14 @@ - - - - - - - - + + + + + + + +

-

+

- +

jQuery QueryBuilder @@ -40,39 +32,39 @@

jQuery QueryBuilder Theme:

jQuery QueryBuilder

Reset - Set filters

@@ -106,22 +98,23 @@

Output