From dcc138568767fc08fa3f0e958534e2de2f18de47 Mon Sep 17 00:00:00 2001 From: Tony Air Date: Fri, 9 Feb 2018 19:10:40 +0700 Subject: [PATCH] [IMPROVEMENT] eslint configuration --- .editorconfig | 26 ++ .eslintignore | 1 + .eslintrc | 256 ++++++++++++++++++ .eslintrc.js | 1 + site/src/js/_components/_spinner.js | 8 +- site/src/js/_events.js | 6 +- .../js/_pageType_and_component_template.js | 19 +- site/src/js/app.js | 35 +-- site/src/js/main.js | 25 +- 9 files changed, 330 insertions(+), 47 deletions(-) create mode 100755 .editorconfig create mode 100644 .eslintignore create mode 100644 .eslintrc create mode 100644 .eslintrc.js diff --git a/.editorconfig b/.editorconfig new file mode 100755 index 0000000..d3832ba --- /dev/null +++ b/.editorconfig @@ -0,0 +1,26 @@ +# For more information about the properties used in +# this file, please see the EditorConfig documentation: +# http://editorconfig.org/ + +root = true + +[*] +charset = utf-8 +end_of_line = lf +indent_size = 4 +indent_style = space +insert_final_newline = true +trim_trailing_whitespace = true + +[*.md] +trim_trailing_whitespace = false + +[*.yml] +indent_size = 2 +indent_style = space + +[{.travis.yml,package.json}] +# The indent size used in the `package.json` file cannot be changed +# https://github.com/npm/npm/pull/3180#issuecomment-16336516 +indent_size = 2 +indent_style = space diff --git a/.eslintignore b/.eslintignore new file mode 100644 index 0000000..0665a7a --- /dev/null +++ b/.eslintignore @@ -0,0 +1 @@ +/site/dist \ No newline at end of file diff --git a/.eslintrc b/.eslintrc new file mode 100644 index 0000000..82e9a6a --- /dev/null +++ b/.eslintrc @@ -0,0 +1,256 @@ +{ + // http://eslint.org/docs/rules/ + "extends": "eslint:recommended", + + "env": { + "browser": true, // browser global variables. + "node": true, // Node.js global variables and Node.js-specific rules. + "amd": true, // defines require() and define() as global variables as per the amd spec. + "mocha": false, // adds all of the Mocha testing global variables. + "jasmine": false, // adds all of the Jasmine testing global variables for version 1.3 and 2.0. + "phantomjs": false, // phantomjs global variables. + "jquery": true, // jquery global variables. + "prototypejs": false, // prototypejs global variables. + "shelljs": false, // shelljs global variables. + "es6": true + }, + + "globals": { + // e.g. "angular": true + }, + + "plugins": [ + "react", + "import", + "jquery" + ], + + "parser": "babel-eslint", + + "parserOptions": { + "ecmaVersion": 6, + "sourceType": "module", + "ecmaFeatures": { + "jsx": true, + "experimentalObjectRestSpread": true + } + }, + + "rules": { + ////////// Possible Errors ////////// + + "no-comma-dangle": 0, // disallow trailing commas in object literals + "no-cond-assign": 0, // disallow assignment in conditional expressions + "no-console": 0, // disallow use of console (off by default in the node environment) + "no-constant-condition": 0, // disallow use of constant expressions in conditions + "no-control-regex": 0, // disallow control characters in regular expressions + "no-debugger": 0, // disallow use of debugger + "no-dupe-keys": 0, // disallow duplicate keys when creating object literals + "no-empty": 0, // disallow empty statements + "no-empty-class": 0, // disallow the use of empty character classes in regular expressions + "no-ex-assign": 0, // disallow assigning to the exception in a catch block + "no-extra-boolean-cast": 0, // disallow double-negation boolean casts in a boolean context + "no-extra-parens": 0, // disallow unnecessary parentheses (off by default) + "no-extra-semi": 0, // disallow unnecessary semicolons + "no-func-assign": 0, // disallow overwriting functions written as function declarations + "no-inner-declarations": 0, // disallow function or variable declarations in nested blocks + "no-invalid-regexp": 0, // disallow invalid regular expression strings in the RegExp constructor + "no-irregular-whitespace": 0, // disallow irregular whitespace outside of strings and comments + "no-negated-in-lhs": 0, // disallow negation of the left operand of an in expression + "no-obj-calls": 0, // disallow the use of object properties of the global object (Math and JSON) as functions + "no-regex-spaces": 0, // disallow multiple spaces in a regular expression literal + "no-reserved-keys": 0, // disallow reserved words being used as object literal keys (off by default) + "no-sparse-arrays": 0, // disallow sparse arrays + "no-unreachable": 0, // disallow unreachable statements after a return, throw, continue, or break statement + "use-isnan": 0, // disallow comparisons with the value NaN + "valid-jsdoc": 0, // Ensure JSDoc comments are valid (off by default) + "valid-typeof": 0, // Ensure that the results of typeof are compared against a valid string + + + ////////// Best Practices ////////// + + "block-scoped-var": 0, // treat var statements as if they were block scoped (off by default) + "complexity": 0, // specify the maximum cyclomatic complexity allowed in a program (off by default) + "consistent-return": 0, // require return statements to either always or never specify values + "curly": 0, // specify curly brace conventions for all control statements + "default-case": 0, // require default case in switch statements (off by default) + "dot-notation": 0, // encourages use of dot notation whenever possible + "eqeqeq": 0, // require the use of === and !== + "guard-for-in": 0, // make sure for-in loops have an if statement (off by default) + "no-alert": 0, // disallow the use of alert, confirm, and prompt + "no-caller": 0, // disallow use of arguments.caller or arguments.callee + "no-div-regex": 0, // disallow division operators explicitly at beginning of regular expression (off by default) + "no-else-return": 0, // disallow else after a return in an if (off by default) + "no-empty-label": 0, // disallow use of labels for anything other then loops and switches + "no-eq-null": 0, // disallow comparisons to null without a type-checking operator (off by default) + "no-eval": 0, // disallow use of eval() + "no-extend-native": 0, // disallow adding to native types + "no-extra-bind": 0, // disallow unnecessary function binding + "no-fallthrough": 0, // disallow fallthrough of case statements + "no-floating-decimal": 0, // disallow the use of leading or trailing decimal points in numeric literals (off by default) + "no-implied-eval": 0, // disallow use of eval()-like methods + "no-iterator": 0, // disallow usage of __iterator__ property + "no-labels": 0, // disallow use of labeled statements + "no-lone-blocks": 0, // disallow unnecessary nested blocks + "no-loop-func": 0, // disallow creation of functions within loops + "no-multi-spaces": 0, // disallow use of multiple spaces + "no-multi-str": 0, // disallow use of multiline strings + "no-native-reassign": 0, // disallow reassignments of native objects + "no-new": 0, // disallow use of new operator when not part of the assignment or comparison + "no-new-func": 0, // disallow use of new operator for Function object + "no-new-wrappers": 0, // disallows creating new instances of String, Number, and Boolean + "no-octal": 0, // disallow use of octal literals + "no-octal-escape": 0, // disallow use of octal escape sequences in string literals, such as var foo = "Copyright \251"; + "no-process-env": 0, // disallow use of process.env (off by default) + "no-proto": 0, // disallow usage of __proto__ property + "no-redeclare": 0, // disallow declaring the same variable more then once + "no-return-assign": 0, // disallow use of assignment in return statement + "no-script-url": 0, // disallow use of javascript: urls. + "no-self-compare": 0, // disallow comparisons where both sides are exactly the same (off by default) + "no-sequences": 0, // disallow use of comma operator + "no-unused-expressions": 0, // disallow usage of expressions in statement position + "no-void": 0, // disallow use of void operator (off by default) + "no-warning-comments": 0, // disallow usage of configurable warning terms in comments, e.g. TODO or FIXME (off by default) + "no-with": 0, // disallow use of the with statement + "radix": 0, // require use of the second argument for parseInt() (off by default) + "vars-on-top": 0, // requires to declare all vars on top of their containing scope (off by default) + "wrap-iife": 0, // require immediate function invocation to be wrapped in parentheses (off by default) + "yoda": 0, // require or disallow Yoda conditions + + + ////////// Strict Mode ////////// + + "global-strict": 0, // (deprecated) require or disallow the "use strict" pragma in the global scope (off by default in the node environment) + "no-extra-strict": 0, // (deprecated) disallow unnecessary use of "use strict"; when already in strict mode + "strict": 0, // controls location of Use Strict Directives + + + ////////// Variables ////////// + + "no-catch-shadow": 0, // disallow the catch clause parameter name being the same as a variable in the outer scope (off by default in the node environment) + "no-delete-var": 0, // disallow deletion of variables + "no-label-var": 0, // disallow labels that share a name with a variable + "no-shadow": 0, // disallow declaration of variables already declared in the outer scope + "no-shadow-restricted-names": 0, // disallow shadowing of names such as arguments + "no-undef": 0, // disallow use of undeclared variables unless mentioned in a /*global */ block + "no-undef-init": 0, // disallow use of undefined when initializing variables + "no-undefined": 0, // disallow use of undefined variable (off by default) + "no-unused-vars": 0, // disallow declaration of variables that are not used in the code + "no-use-before-define": 0, // disallow use of variables before they are defined + + + ////////// Node.js ////////// + + "handle-callback-err": 0, // enforces error handling in callbacks (off by default) (on by default in the node environment) + "no-mixed-requires": 0, // disallow mixing regular variable and require declarations (off by default) (on by default in the node environment) + "no-new-require": 0, // disallow use of new operator with the require function (off by default) (on by default in the node environment) + "no-path-concat": 0, // disallow string concatenation with __dirname and __filename (off by default) (on by default in the node environment) + "no-process-exit": 0, // disallow process.exit() (on by default in the node environment) + "no-restricted-modules": 0, // restrict usage of specified node modules (off by default) + "no-sync": 0, // disallow use of synchronous methods (off by default) + + + ////////// Stylistic Issues ////////// + + "brace-style": 0, // enforce one true brace style (off by default) + "camelcase": 0, // require camel case names + "comma-spacing": 0, // enforce spacing before and after comma + "comma-style": 0, // enforce one true comma style (off by default) + "consistent-this": 0, // enforces consistent naming when capturing the current execution context (off by default) + "eol-last": 0, // enforce newline at the end of file, with no multiple empty lines + "func-names": 0, // require function expressions to have a name (off by default) + "func-style": 0, // enforces use of function declarations or expressions (off by default) + "key-spacing": 0, // enforces spacing between keys and values in object literal properties + "max-nested-callbacks": 0, // specify the maximum depth callbacks can be nested (off by default) + "new-cap": 0, // require a capital letter for constructors + "new-parens": 0, // disallow the omission of parentheses when invoking a constructor with no arguments + "no-array-constructor": 0, // disallow use of the Array constructor + "no-inline-comments": 0, // disallow comments inline after code (off by default) + "no-lonely-if": 0, // disallow if as the only statement in an else block (off by default) + "no-mixed-spaces-and-tabs": 0, // disallow mixed spaces and tabs for indentation + "no-multiple-empty-lines": 0, // disallow multiple empty lines (off by default) + "no-nested-ternary": 0, // disallow nested ternary expressions (off by default) + "no-new-object": 0, // disallow use of the Object constructor + "no-space-before-semi": 0, // disallow space before semicolon + "no-spaced-func": 0, // disallow space between function identifier and application + "no-ternary": 0, // disallow the use of ternary operators (off by default) + "no-trailing-spaces": 0, // disallow trailing whitespace at the end of lines + "no-underscore-dangle": 0, // disallow dangling underscores in identifiers + "no-wrap-func": 0, // disallow wrapping of non-IIFE statements in parens + "one-var": 0, // allow just one var statement per function (off by default) + "operator-assignment": 0, // require assignment operator shorthand where possible or prohibit it entirely (off by default) + "padded-blocks": 0, // enforce padding within blocks (off by default) + "quote-props": 0, // require quotes around object literal property names (off by default) + "quotes": 0, // specify whether double or single quotes should be used + "semi": 0, // require or disallow use of semicolons instead of ASI + "sort-vars": 0, // sort variables within the same declaration block (off by default) + "space-after-function-name": 0, // require a space after function names (off by default) + "space-after-keywords": 0, // require a space after certain keywords (off by default) + "space-before-blocks": 0, // require or disallow space before blocks (off by default) + "space-in-brackets": 0, // require or disallow spaces inside brackets (off by default) + "space-in-parens": 0, // require or disallow spaces inside parentheses (off by default) + "space-infix-ops": 0, // require spaces around operators + "space-return-throw-case": 0, // require a space after return, throw, and case + "space-unary-ops": 0, // Require or disallow spaces before/after unary operators (words on by default, nonwords off by default) + "spaced-line-comment": 0, // require or disallow a space immediately following the // in a line comment (off by default) + "wrap-regex": 0, // require regex literals to be wrapped in parentheses (off by default) + + + ////////// ECMAScript 6 ////////// + + "no-var": 0, // require let or const instead of var (off by default) + "generator-star": 0, // enforce the position of the * in generator functions (off by default) + + + ////////// Legacy ////////// + + "max-depth": 0, // specify the maximum depth that blocks can be nested (off by default) + "max-len": 0, // specify the maximum length of a line in your program (off by default) + "max-params": 0, // limits the number of parameters that can be used in the function declaration. (off by default) + "max-statements": 0, // specify the maximum number of statement allowed in a function (off by default) + "no-bitwise": 0, // disallow use of bitwise operators (off by default) + "no-plusplus": 0 // disallow use of unary operators, ++ and -- (off by default) + + //////// Extra ////////// + "array-bracket-spacing": ["error", "never"], + "array-callback-return": "error", + "arrow-parens": ["error", "always"], + "arrow-spacing": ["error", { "before": true, "after": true }], + "comma-dangle": ["error", "always-multiline"], + "indent": ["error", 2, { "SwitchCase": 1 }], + "no-case-declarations": "error", + "no-confusing-arrow": "error", + "no-duplicate-imports": "error", + "no-param-reassign": "error", + "no-useless-escape": "error", + "object-curly-spacing": ["error", "always"], + "object-shorthand": ["error", "properties"], + "prefer-arrow-callback": "error", + "prefer-const": "error", + "prefer-template": "error", + "react/jsx-closing-bracket-location": "error", + "react/jsx-curly-spacing": ["error", "never", {"allowMultiline": true}], + "react/jsx-filename-extension": ["error", { "extensions": [".react.js", ".js", ".jsx"] }], + "react/jsx-no-duplicate-props": "error", + "react/jsx-no-bind": ["error", { "ignoreRefs": true, "allowArrowFunctions": true, "allowBind": false }], + "react/jsx-no-undef": "error", + "react/jsx-pascal-case": "error", + "react/jsx-tag-spacing": ["error", {"closingSlash": "never", "beforeSelfClosing": "always", "afterOpening": "never"}], + "react/jsx-uses-react": "error", + "react/jsx-uses-vars": "error", + "react/no-danger": "error", + "react/no-deprecated": "error", + "react/no-did-mount-set-state": "error", + "react/no-did-update-set-state": "error", + "react/no-direct-mutation-state": "error", + "react/no-is-mounted": "error", + "react/no-multi-comp": "error", + "react/prefer-es6-class": "error", + "react/prop-types": "error", + "react/require-render-return": "error", + "react/self-closing-comp": "error", + "react/sort-comp": "error", + "import/no-mutable-exports": "error", + "import/imports-first": "error" + } +} \ No newline at end of file diff --git a/.eslintrc.js b/.eslintrc.js new file mode 100644 index 0000000..4b81cff --- /dev/null +++ b/.eslintrc.js @@ -0,0 +1 @@ +module.exports = require('@silverstripe/eslint-config/.eslintrc'); diff --git a/site/src/js/_components/_spinner.js b/site/src/js/_components/_spinner.js index 95c3042..47d663e 100644 --- a/site/src/js/_components/_spinner.js +++ b/site/src/js/_components/_spinner.js @@ -1,19 +1,19 @@ /** * Just an example component */ -import $ from "jquery"; +import $ from 'jquery'; const SpinnerUI = (($) => { class SpinnerUI { static show(callback) { - $("#PageLoading").show(0, callback); + $('#PageLoading').show(0, callback); } static hide(callback) { - $("#PageLoading").hide("slow", callback); + $('#PageLoading').hide('slow', callback); } } return SpinnerUI; })($); -export default SpinnerUI; \ No newline at end of file +export default SpinnerUI; diff --git a/site/src/js/_events.js b/site/src/js/_events.js index 7f0c0ab..2e649ad 100644 --- a/site/src/js/_events.js +++ b/site/src/js/_events.js @@ -3,6 +3,6 @@ */ module.exports = { - AJAX: "ajax-load", - LOADED: "load" -}; \ No newline at end of file + AJAX: 'ajax-load', + LOADED: 'load' +}; diff --git a/site/src/js/_pageType_and_component_template.js b/site/src/js/_pageType_and_component_template.js index 231da64..47985a0 100644 --- a/site/src/js/_pageType_and_component_template.js +++ b/site/src/js/_pageType_and_component_template.js @@ -1,21 +1,20 @@ -import $ from "jquery"; +import $ from 'jquery'; const TypePage = (($) => { - // Constants - const NAME = "TypePage"; - //const DATA_KEY = "pageUI." + NAME; + const NAME = 'TypePage'; + // const DATA_KEY = "pageUI." + NAME; - const Events = require("./_events"); + const Events = require('./_events'); class TypePage { // Static methods static init() { - console.log("Initializing: " + NAME); + console.log(`Initializing: ${NAME}`); } static destroy() { - console.log("Destroying: " + NAME); + console.log(`Destroying: ${NAME}`); } /** @@ -50,7 +49,7 @@ const TypePage = (($) => { */ } - $(window).on(Events.AJAX + " " + Events.LOADED, function() { + $(window).on(`${Events.AJAX} ${Events.LOADED}`, () => { TypePage.init(); }); @@ -65,7 +64,7 @@ const TypePage = (($) => { // auto-apply $(".ui." + NAME).ready(function(){ $(".ui." + NAME).TypePage(); - });*/ + }); */ return TypePage; })($); @@ -90,4 +89,4 @@ import $ from 'jquery'; $(document).ready(function () { G.initPulsePage(); }); -}(this));*/ \ No newline at end of file +}(this)); */ diff --git a/site/src/js/app.js b/site/src/js/app.js index 2a20a9a..fdd54aa 100644 --- a/site/src/js/app.js +++ b/site/src/js/app.js @@ -3,31 +3,32 @@ function importAll(r) { return r.keys().map(r); } -const images = importAll(require.context("../img/", false, /\.(png|jpe?g|svg)$/)); +const images = importAll(require.context('../img/', false, /\.(png|jpe?g|svg)$/)); -import "../scss/app.scss"; +import '../scss/app.scss'; // import Bootstrap -import Popper from "popper.js"; +import Popper from 'popper.js'; + window.Popper = Popper; -import "bootstrap/js/dist/util"; -import "bootstrap/js/dist/alert"; -import "bootstrap/js/dist/button"; -import "bootstrap/js/dist/carousel"; -import "bootstrap/js/dist/collapse"; -import "bootstrap/js/dist/dropdown"; -import "bootstrap/js/dist/modal"; -import "bootstrap/js/dist/tooltip"; -import "bootstrap/js/dist/popover"; -import "bootstrap/js/dist/scrollspy"; -import "bootstrap/js/dist/tab"; +import 'bootstrap/js/dist/util'; +import 'bootstrap/js/dist/alert'; +import 'bootstrap/js/dist/button'; +import 'bootstrap/js/dist/carousel'; +import 'bootstrap/js/dist/collapse'; +import 'bootstrap/js/dist/dropdown'; +import 'bootstrap/js/dist/modal'; +import 'bootstrap/js/dist/tooltip'; +import 'bootstrap/js/dist/popover'; +import 'bootstrap/js/dist/scrollspy'; +import 'bootstrap/js/dist/tab'; // // import your custom UI components -import "./main.js"; +import './main'; // TODO: hot module update -/*const Events = require("./_events"); +/* const Events = require("./_events"); if (module.hot) { module.hot.accept(); module.hot.addStatusHandler(status => { @@ -35,4 +36,4 @@ if (module.hot) { $(window).trigger(Events.AJAX); } }); -}*/ \ No newline at end of file +} */ diff --git a/site/src/js/main.js b/site/src/js/main.js index a0cdb55..0606edd 100644 --- a/site/src/js/main.js +++ b/site/src/js/main.js @@ -1,38 +1,37 @@ -import $ from "jquery"; +import $ from 'jquery'; -import Events from "./_events"; +import Events from './_events'; // import an example component -import Spinner from "./_components/_spinner"; +import Spinner from './_components/_spinner'; const MainUI = (($) => { - // Constants - const NAME = "MainUI"; + const NAME = 'MainUI'; class MainUI { // Static methods static init() { this.destroy(); - console.log("Initializing: " + NAME); + console.log(`Initializing: ${NAME}`); - Spinner.hide(function() { - $("body").addClass("loaded"); + Spinner.hide(() => { + $('body').addClass('loaded'); }); } static destroy() { - console.log("Destroying: " + NAME); - Spinner.show(function() { - $("body").removeClass("loaded"); + console.log(`Destroying: ${NAME}`); + Spinner.show(() => { + $('body').removeClass('loaded'); }); } } - $(window).on(Events.AJAX + " " + Events.LOADED, function() { + $(window).on(`${Events.AJAX} ${Events.LOADED}`, () => { MainUI.init(); }); return MainUI; })($); -export default MainUI; \ No newline at end of file +export default MainUI;