feat(chore): add lint using CI

.eslintrc.js

@@ -0,0 +1,109 @@
+module.exports = {
+    env: {
+        browser: true,
+        es6: true,
+    },
+    extends: [
+    ],
+    parserOptions: {
+        ecmaVersion: '2020',
+        sourceType: 'module',
+    },
+    ignorePatterns: [
+        '/dist',
+        '/examples/assets/library',
+        '/test/coverage',
+        '/test/helpers',
+    ],
+    rules: {
+        indent: ['error', 4, { SwitchCase: 1 }],
+        'keyword-spacing': ['error'],
+        'space-in-parens': ['error'],
+        'comma-spacing': ['error'],
+        'comma-style': ['error', 'last', {
+            // https://github.com/airbnb/javascript/blob/eslint-config-airbnb-v19.0.4/packages/eslint-config-airbnb-base/rules/style.js#L54
+            exceptions: {
+                ArrayExpression: false,
+                ArrayPattern: false,
+                ArrowFunctionExpression: false,
+                CallExpression: false,
+                FunctionDeclaration: false,
+                FunctionExpression: false,
+                ImportDeclaration: false,
+                ObjectExpression: false,
+                ObjectPattern: false,
+                VariableDeclaration: false,
+                NewExpression: false,
+            },
+        }],
+        'space-before-function-paren': ['error', {
+            named: 'never',
+            anonymous: 'always',
+            asyncArrow: 'always',
+        }],
+        'space-infix-ops': ['error'],
+        'array-bracket-spacing': ['error', 'never'],
+        'object-curly-spacing': ['error', 'always'],
+        'computed-property-spacing': ['error', 'never'],
+        'space-before-blocks': ['error'],
+        'one-var-declaration-per-line': ['error', 'always'],
+        'function-paren-newline': ['error', 'multiline-arguments'],
+        'padding-line-between-statements': ['error', {
+            blankLine: 'always',
+            prev: '*',
+            next: ['continue', 'break', 'export', 'return', 'throw'],
+        }],
+        'spaced-comment': ['error', 'always', {
+            line: {
+                markers: ['/'],
+                exceptions: ['-', '+'],
+            },
+            block: {
+                markers: ['!'],
+                exceptions: ['*'],
+                balanced: true,
+            },
+        }],
+        'padded-blocks': ['error', 'never'],
+        'no-multiple-empty-lines': ['error', {
+            max: 1,
+            maxBOF: 0,
+            maxEOF: 0,
+        }],
+        'no-multi-spaces': ['error', {
+            exceptions: {
+                Property: true,
+                VariableDeclarator: true,
+            },
+        }],
+        'brace-style': ['error'],
+        curly: ['error'],
+        'object-shorthand': ['error', 'never'],
+        'object-curly-newline': ['error', {
+            // https://github.com/airbnb/javascript/blob/eslint-config-airbnb-v19.0.4/packages/eslint-config-airbnb-base/rules/style.js#L395
+            ObjectExpression: { minProperties: 4, multiline: true, consistent: true },
+            ObjectPattern: { minProperties: 4, multiline: true, consistent: true },
+            ImportDeclaration: { minProperties: 4, multiline: true, consistent: true },
+            ExportDeclaration: { minProperties: 4, multiline: true, consistent: true },
+        }],
+        'operator-linebreak': ['error', 'before', { overrides: { '=': 'none' } }],
+        'dot-notation': ['error', { allowKeywords: true }],
+        'arrow-parens': ['error'],
+        quotes: ['error', 'single', { avoidEscape: true }],
+        'quote-props': ['error', 'as-needed', {
+            keywords: false,
+            numbers: false,
+        }],
+        'comma-dangle': ['error', {
+            arrays: 'always-multiline',
+            objects: 'always-multiline',
+            functions: 'never',
+            imports: 'always-multiline',
+            exports: 'always-multiline',
+        }],
+        semi: ['error'],
+        'no-extra-semi': ['error'],
+        'no-trailing-spaces': ['error'],
+    },
+    reportUnusedDisableDirectives: true,
+};

.github/workflows/ci.yml

@@ -1,9 +1,19 @@
 name: CI
-on: [pull_request]
+on: [push, pull_request]
 permissions:
   contents: read
 
 jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-node@v3
+    - name: Install dependencies
+      run: yarn
+    - name: Lint JS files
+      run: npm run lint
   test:
     name: Test build process on node ${{ matrix.node-version }}
     runs-on: ubuntu-latest
@@ -13,13 +23,13 @@ jobs:
         node-version: [12, 14, 16, 18]
     steps:
     - uses: actions/checkout@v3
-    - name: Use Node.js ${{ matrix.node-version }}
+    - name: Setup Node.js ${{ matrix.node-version }}
       uses: actions/setup-node@v3
       with:
         node-version: ${{ matrix.node-version }}
     - name: pre-install
       run: sh ./scripts/preinstall.sh
-    - name: install dependencies
+    - name: Install dependencies
       run: yarn
     - name: pre fomantic install & gulp build
       run: yarn gulp install

examples/assets/show-examples.js

@@ -1,15 +1,15 @@
 $(document)
-  .ready(function() {
-      // add popup to show name
-      $('.ui:not(.container, .grid)').each(function() {
-        $(this)
-          .popup({
-            on        : 'hover',
-            variation : 'small inverted',
-            exclusive : true,
-            content   : $(this).attr('class')
-          })
-        ;
-      });
-  })
+    .ready(function () {
+        // add popup to show name
+        $('.ui:not(.container, .grid)').each(function () {
+            $(this)
+                .popup({
+                    on: 'hover',
+                    variation: 'small inverted',
+                    exclusive: true,
+                    content: $(this).attr('class'),
+                })
+            ;
+        });
+    })
 ;

gulpfile.js

@@ -3,13 +3,12 @@
  *******************************/
 
 var
-  gulp   = require('gulp'),
+    gulp   = require('gulp'),
 
-  // read user config to know what task to load
-  config = require('./tasks/config/user')
+    // read user config to know what task to load
+    config = require('./tasks/config/user')
 ;
 
-
 /*******************************
  *            Tasks
  *******************************/
@@ -20,21 +19,21 @@ require('./tasks/collections/install')(gulp);
 
 gulp.task('default', gulp.series('check-install'));
 
-/*--------------
+/* --------------
       Docs
----------------*/
+--------------- */
 
 require('./tasks/collections/docs')(gulp);
 
-/*--------------
+/* --------------
       RTL
----------------*/
+--------------- */
 
 if (config.rtl) {
-  require('./tasks/collections/rtl')(gulp);
+    require('./tasks/collections/rtl')(gulp);
 }
 
 /* Admin Tasks */
 if (config.admin) {
-  require('./tasks/collections/admin')(gulp);
+    require('./tasks/collections/admin')(gulp);
 }

package.json

@@ -25,7 +25,9 @@
   },
   "scripts": {
     "build": "gulp build",
-    "changelog": "auto-changelog -p"
+    "changelog": "auto-changelog -p",
+    "lint": "eslint -c .eslintrc.js --ext .js .",
+    "lint-fix": "eslint -c .eslintrc.js --ext .js . --fix"
   },
   "dependencies": {
     "@actions/core": "^1.6.0",
@@ -73,6 +75,7 @@
   "devDependencies": {
     "all-contributors-cli": "^6.7.0",
     "auto-changelog": "^2.4.0",
+    "eslint": "^8.28.0",
     "node-fetch": "^2.6.0",
     "semver": "^7.3.5"
   },