Merge pull request #538 from return42/eslint

SearXNG JavaScript Style Guide
searxng · Dec 14, 2021 · 4f22615 · 4f22615
2 parents 5c7167c + f287787
commit 4f22615
Show file tree

Hide file tree

Showing 15 changed files with 236 additions and 207 deletions.
diff --git a/.dir-locals.el b/.dir-locals.el
@@ -91,7 +91,7 @@
 
  (json-mode
   . ((eval . (progn
-               (setq-local js-indent-level 2)
+               (setq-local js-indent-level 4)
                (flycheck-checker . json-python-json)))))
 
  (js-mode

diff --git a/Makefile b/Makefile
@@ -89,7 +89,7 @@ MANAGE += py.build py.clean
 MANAGE += pyenv pyenv.install pyenv.uninstall
 MANAGE += pypi.upload pypi.upload.test
 MANAGE += test.yamllint test.pylint test.pep8 test.unit test.coverage test.robot test.clean
-MANAGE += themes.all themes.oscar themes.simple pygments.less
+MANAGE += themes.all themes.oscar themes.simple themes.simple.test pygments.less
 MANAGE += static.build.commit static.build.drop static.build.restore
 MANAGE += nvm.install nvm.clean nvm.status nvm.nodejs
 

diff --git a/manage b/manage
@@ -714,6 +714,17 @@ themes.simple() {
     dump_return $?
 }
 
+themes.simple.test() {
+    build_msg TEST "theme: simple"
+    if ! nvm.min_node "${NODE_MINIMUM_VERSION}"; then
+        info_msg "install Node.js by NVM"
+        nvm.nodejs
+    fi
+    npm --prefix searx/static/themes/simple install
+    npm --prefix searx/static/themes/simple run test
+    dump_return $?
+}
+
 PYLINT_FILES=()
 while IFS= read -r line; do
    PYLINT_FILES+=("$line")

diff --git a/searx/static/themes/__common__/js/image_layout.js b/searx/static/themes/__common__/js/image_layout.js
@@ -22,7 +22,7 @@
 
 
 (function (w, d) {
-  function ImageLayout(container_selector, results_selector, img_selector, verticalMargin, horizontalMargin, maxHeight) {
+  function ImageLayout (container_selector, results_selector, img_selector, verticalMargin, horizontalMargin, maxHeight) {
     this.container_selector = container_selector;
     this.results_selector = results_selector;
     this.img_selector = img_selector;
@@ -57,7 +57,7 @@
       }
     }
 
-    return (width - images.length * this.verticalMargin) / r; //have to round down because Firefox will automatically roundup value with number of decimals > 3
+    return (width - images.length * this.verticalMargin) / r; // have to round down because Firefox will automatically roundup value with number of decimals > 3
   };
 
   ImageLayout.prototype._setSize = function (images, height) {
@@ -147,12 +147,12 @@
     var results_nodes = d.querySelectorAll(this.results_selector);
     var results_length = results_nodes.length;
 
-    function img_load_error(event) {
+    function img_load_error (event) {
       // console.log("ERROR can't load: " + event.originalTarget.src);
       event.originalTarget.src = w.searxng.static_path + w.searxng.theme.img_load_error;
     }
 
-    function throttleAlign() {
+    function throttleAlign () {
       if (obj.isAlignDone) {
         obj.isAlignDone = false;
         setTimeout(function () {

diff --git a/searx/static/themes/simple/.eslintrc.json b/searx/static/themes/simple/.eslintrc.json
@@ -9,5 +9,21 @@
         "ecmaVersion": 12
     },
     "rules": {
+        "indent": ["error", 2],
+        "keyword-spacing": ["error", { "before": true, "after": true }],
+        "no-trailing-spaces": 2,
+        "space-before-function-paren": ["error", "always"],
+        "space-infix-ops": "error",
+        "comma-spacing": ["error", { "before": false, "after": true }],
+        "brace-style": ["error", "1tbs", { "allowSingleLine": true }],
+        "curly": ["error", "multi-line"],
+        "block-spacing": ["error", "always"],
+        "comma-spacing": ["error", { "before": false, "after": true }],
+        "dot-location": ["error", "property"],
+        "key-spacing": ["error", { "beforeColon": false, "afterColon": true }],
+        "spaced-comment": ["error", "always", {
+            "line": { "markers": ["*package", "!", "/", ",", "="] },
+            "block": { "balanced": true, "markers": ["*package", "!", ",", ":", "::", "flow-include"], "exceptions": ["*"] }
+        }]
     }
 }
diff --git a/searx/static/themes/simple/gruntfile.js b/searx/static/themes/simple/gruntfile.js
@@ -1,6 +1,6 @@
-/*jshint esversion: 6 */
+/* SPDX-License-Identifier: AGPL-3.0-or-later */
 
-module.exports = function(grunt) {
+module.exports = function (grunt) {
 
   const eachAsync = require('each-async');
 
@@ -27,9 +27,11 @@ module.exports = function(grunt) {
     eslint: {
       options: {
         overrideConfigFile: '.eslintrc.json',
-        failOnError: false
+        failOnError: true,
+        fix: grunt.option('fix')
       },
       target: [
+        'gruntfile.js',
         'svg4web.svgo.js',
         'src/js/main/*.js',
         'src/js/head/*.js',
@@ -111,7 +113,7 @@ module.exports = function(grunt) {
             new (require('less-plugin-clean-css'))()
           ],
           sourceMap: true,
-          sourceMapURL: (name) => { const s = name.split('/'); return s[s.length - 1] + '.map';},
+          sourceMapURL: (name) => { const s = name.split('/'); return s[s.length - 1] + '.map'; },
           outputSourceFiles: true,
         },
         files: {
@@ -176,37 +178,37 @@ module.exports = function(grunt) {
     },
   });
 
-  grunt.registerMultiTask('svg2jinja', 'Create Jinja2 macro', function() {
+  grunt.registerMultiTask('svg2jinja', 'Create Jinja2 macro', function () {
     const ejs = require('ejs'), svgo = require('svgo');
     const icons = {}
-    for(const iconName in this.data.src) {
-        const svgFileName = this.data.src[iconName];
-        try {
-            const svgContent = grunt.file.read(svgFileName, { encoding: 'utf8' })
-            const svgoResult = svgo.optimize(svgContent, {
-              path: svgFileName,
-              multipass: true,
-              plugins: [
-                {
-                  name: "removeTitle",
-                },
-                {
-                  name: "removeXMLNS",
-                },
-                {
-                  name: "addAttributesToSVGElement",
-                  params: {
-                    attributes: [
-                      { "aria-hidden": "true" }
-                    ]
-                  }
-                }
-              ]
-            });
-            icons[iconName] = svgoResult.data.replace("'", "\\'");
-        } catch (err) {
-          grunt.log.error(err);
-        }
+    for (const iconName in this.data.src) {
+      const svgFileName = this.data.src[iconName];
+      try {
+        const svgContent = grunt.file.read(svgFileName, { encoding: 'utf8' })
+        const svgoResult = svgo.optimize(svgContent, {
+          path: svgFileName,
+          multipass: true,
+          plugins: [
+            {
+              name: "removeTitle",
+            },
+            {
+              name: "removeXMLNS",
+            },
+            {
+              name: "addAttributesToSVGElement",
+              params: {
+                attributes: [
+                  { "aria-hidden": "true" }
+                ]
+              }
+            }
+          ]
+        });
+        icons[iconName] = svgoResult.data.replace("'", "\\'");
+      } catch (err) {
+        grunt.log.error(err);
+      }
     }
     const template = `{# this file was generated by searx/static/themes/simple/gruntfile.js #}
 {%- set icons = {
@@ -266,13 +268,12 @@ module.exports = function(grunt) {
   grunt.loadNpmTasks('grunt-contrib-copy');
   grunt.loadNpmTasks('grunt-contrib-uglify');
   grunt.loadNpmTasks('grunt-image');
-  grunt.loadNpmTasks('grunt-contrib-jshint');
   grunt.loadNpmTasks('grunt-contrib-less');
   grunt.loadNpmTasks('grunt-contrib-cssmin');
   grunt.loadNpmTasks('grunt-stylelint');
   grunt.loadNpmTasks('grunt-eslint');
 
-  grunt.registerTask('test', ['jshint']);
+  grunt.registerTask('test', ['eslint']);
 
   grunt.registerTask('default', [
     'eslint',

diff --git a/searx/static/themes/simple/package.json b/searx/static/themes/simple/package.json
@@ -4,7 +4,6 @@
     "grunt": "~1.4.1",
     "grunt-contrib-copy": "^1.0.0",
     "grunt-contrib-cssmin": "^4.0.0",
-    "grunt-contrib-jshint": "~3.1.1",
     "grunt-contrib-less": "~3.0.0",
     "grunt-contrib-uglify": "~5.0.1",
     "grunt-xmlmin": "~0.1.8",
@@ -29,7 +28,9 @@
   "scripts": {
     "all": "npm install && grunt",
     "build": "grunt",
+    "test": "grunt test",
     "eslint": "grunt eslint",
+    "eslint-fix": "grunt eslint --fix",
     "watch": "grunt watch",
     "webfont": "grunt webfont",
     "clean": "rm -Rf node_modules package-lock.json ion.less",

diff --git a/searx/static/themes/simple/src/js/head/00_init.js b/searx/static/themes/simple/src/js/head/00_init.js
@@ -5,36 +5,36 @@
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 /* global DocumentTouch:readonly */
-(function(w, d) {
-    'use strict';
+(function (w, d) {
+  'use strict';
 
-    // add data- properties
-    var script = d.currentScript  || (function() {
-        var scripts = d.getElementsByTagName('script');
-        return scripts[scripts.length - 1];
-    })();
+  // add data- properties
+  var script = d.currentScript  || (function () {
+    var scripts = d.getElementsByTagName('script');
+    return scripts[scripts.length - 1];
+  })();
 
-    // try to detect touch screen
-    w.searxng = {
-        touch: (("ontouchstart" in w) || w.DocumentTouch && document instanceof DocumentTouch) || false,
-        method: script.getAttribute('data-method'),
-        autocompleter: script.getAttribute('data-autocompleter') === 'true',
-        search_on_category_select: script.getAttribute('data-search-on-category-select') === 'true',
-        infinite_scroll: script.getAttribute('data-infinite-scroll') === 'true',
-        hotkeys: script.getAttribute('data-hotkeys') === 'true',
-        static_path: script.getAttribute('data-static-path'),
-        translations: JSON.parse(script.getAttribute('data-translations')),
-        theme : {
-            // image that is displayed if load of <img src='...'> failed
-            img_load_error: 'img/img_load_error.svg'
-        }
-    };
-
-    // update the css
-    var hmtlElement = d.getElementsByTagName("html")[0];
-    hmtlElement.classList.remove('no-js');
-    hmtlElement.classList.add('js');
-    if (w.searxng.touch) {
-        hmtlElement.classList.add('touch');
+  // try to detect touch screen
+  w.searxng = {
+    touch: (("ontouchstart" in w) || w.DocumentTouch && document instanceof DocumentTouch) || false,
+    method: script.getAttribute('data-method'),
+    autocompleter: script.getAttribute('data-autocompleter') === 'true',
+    search_on_category_select: script.getAttribute('data-search-on-category-select') === 'true',
+    infinite_scroll: script.getAttribute('data-infinite-scroll') === 'true',
+    hotkeys: script.getAttribute('data-hotkeys') === 'true',
+    static_path: script.getAttribute('data-static-path'),
+    translations: JSON.parse(script.getAttribute('data-translations')),
+    theme: {
+      // image that is displayed if load of <img src='...'> failed
+      img_load_error: 'img/img_load_error.svg'
     }
+  };
+
+  // update the css
+  var hmtlElement = d.getElementsByTagName("html")[0];
+  hmtlElement.classList.remove('no-js');
+  hmtlElement.classList.add('js');
+  if (w.searxng.touch) {
+    hmtlElement.classList.add('touch');
+  }
 })(window, document);