chore: Lint workflow checks and cleanup (#102)

* Lint fixes * Template lint fix * Adding PR lint * lint status check * Added lint-staged & precommit hooks * Removed lint status check * Added CI badge to Read me * Workflow changes * Updated branch name
freshworks · Feb 5, 2020 · 83b940e · 83b940e
1 parent 2623f7a
commit 83b940e
Show file tree

Hide file tree

Showing 59 changed files with 506 additions and 54 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -45,6 +45,7 @@ module.exports = {
         node: true
       },
       plugins: ['node'],
+      // eslint-disable-next-line node/no-extraneous-require
       rules: Object.assign({}, require('eslint-plugin-node').configs.recommended.rules, {
         'comma-dangle': ['error', 'never'],
         'ember/new-module-imports': 'off',

diff --git a/.github/workflows/continuous-integration-workflow.yml b/.github/workflows/continuous-integration-workflow.yml
@@ -1,17 +1,38 @@
-name: CI
+name: Build
 
-on: 
+on:
   pull_request:
     branches:
     - master
 
+  push:
+    branches:
+    - master
+
 jobs:
-  build:
-    name: Build
+  Lint:
+    name: Lint
     runs-on: macos-latest
     steps:
     - uses: actions/checkout@v2
-
+
+    - name: Set Node.js 10.13.0
+      uses: actions/setup-node@master
+      with:
+        node-version: 10.13.0
+
+    - name: Install dependencies
+      run: yarn
+
+    - name: Run lint check
+      run: yarn lint
+
+  Test:
+    name: Test
+    runs-on: macos-latest
+    steps:
+    - uses: actions/checkout@v2
+
     - name: Set Node.js 10.13.0
       uses: actions/setup-node@master
       with:

diff --git a/README.md b/README.md
@@ -1,7 +1,6 @@
 Nucleus - The Freshworks Design System in Ember
 ==============================================================================
-
-[![Build Status](https://travis-ci.com/freshdesk/nucleus.svg?branch=master)](https://travis-ci.com/freshdesk/nucleus)
+![Build](https://github.com/freshdesk/nucleus/workflows/Build/badge.svg?branch=master)
 ![npm (scoped with tag)](https://img.shields.io/npm/v/@freshworks/button/latest)
 ![npm (scoped with tag)](https://img.shields.io/npm/v/@freshworks/button/beta)
 

diff --git a/package.json b/package.json
@@ -10,7 +10,8 @@
     "start": "yarn workspace nucleus start",
     "test": "lerna run test --no-private --stream --concurrency 1",
     "build": "lerna run build --parallel --no-private",
-    "lint": "lerna run lint:hbs",
+    "lint": "lerna run lint:hbs --parallel && lerna run lint:js --parallel",
+    "lint-staged": "lint-staged",
     "lerna:version": "lerna version prerelease --preid beta",
     "lerna:publish": "lerna publish --canary --yes --dist-tag beta",
     "deploy": "yarn workspace nucleus deploy",
@@ -21,8 +22,17 @@
     "ember-cli": "~3.11.0",
     "ember-source-channel-url": "^2.0.0",
     "ember-try": "^1.1.0",
-    "lerna": "^3.20.2"
+    "lerna": "^3.20.2",
+    "lint-staged": "^10.0.7",
+    "pre-commit": "^1.2.2"
   },
+  "lint-staged": {
+    "*.js": "lerna run lint:js",
+    "*.hbs": "lerna run lint:hbs"
+  },
+  "pre-commit": [
+    "lint-staged"
+  ],
   "engines": {
     "node": "^10.13.0",
     "yarn": "^1.17.3"

diff --git a/packages/@nucleus/ember-cli-build.js b/packages/@nucleus/ember-cli-build.js
@@ -1,8 +1,12 @@
 'use strict';
 
+// eslint-disable-next-line node/no-unpublished-require
 const EmberAddon = require('ember-cli/lib/broccoli/ember-addon');
+// eslint-disable-next-line node/no-unpublished-require
 const { UnwatchedDir } = require('broccoli-source');
+// eslint-disable-next-line node/no-unpublished-require
 const MergeTrees = require('broccoli-merge-trees');
+// eslint-disable-next-line node/no-unpublished-require
 const Funnel = require('broccoli-funnel');
 const { readdirSync } = require('fs');
 

diff --git a/packages/banner/.eslintrc.js b/packages/banner/.eslintrc.js
@@ -45,6 +45,7 @@ module.exports = {
         node: true
       },
       plugins: ['node'],
+      // eslint-disable-next-line node/no-unpublished-require
       rules: Object.assign({}, require('eslint-plugin-node').configs.recommended.rules, {
         'comma-dangle': ['error', 'never'],
         'ember/new-module-imports': 'off',

diff --git a/packages/banner/.template-lintrc.js b/packages/banner/.template-lintrc.js
@@ -0,0 +1,11 @@
+/* eslint-env node */
+'use strict';
+
+module.exports = {
+  extends: 'recommended',
+
+  rules: {
+    'no-bare-strings': false,
+    'quotes': 'double'
+  }
+};
diff --git a/packages/banner/addon/templates/components/nucleus-banner.hbs b/packages/banner/addon/templates/components/nucleus-banner.hbs
@@ -1,8 +1,8 @@
 {{#if bannerItems.length}}
   {{#ember-wormhole to="nucleus-banner-wormhole" renderInPlace=false}}
-    <div class="nucleus-banner nucleus-banner--{{displayedItem.type}} {{if isFixed 'nucleus-banner--fixed'}}">
+    <div class="nucleus-banner nucleus-banner--{{displayedItem.type}} {{if isFixed "nucleus-banner--fixed"}}">
       <div class="nucleus-banner__main">
-        {{nucleus-banner/item item=displayedItem onDelete=(action 'deleteItem')}}
+        {{nucleus-banner/item item=displayedItem onDelete=(action "deleteItem")}}
       </div>
       {{#if (and _isMultiple stackedItems)}}
         <div class="nucleus-banner__more">
@@ -20,7 +20,7 @@
                 <ul class="nucleus-banners">
                   {{#each stackedItems as |hiddenItem|}}
                     <li class="nucleus-banner--mini nucleus-banner--{{hiddenItem.type}}">
-                      {{nucleus-banner/item item=hiddenItem onDelete=(action 'deleteItem')}}
+                      {{nucleus-banner/item item=hiddenItem onDelete=(action "deleteItem")}}
                     </li>
                   {{/each}}
                 </ul>

diff --git a/packages/banner/addon/templates/components/nucleus-banner/item.hbs b/packages/banner/addon/templates/components/nucleus-banner/item.hbs
@@ -8,7 +8,7 @@
   <div class="nucleus-banner-item__content">
     {{item.title}}
     {{#if item.content}}
-      <a role="button" 
+      <a role="button"
       class="nucleus-banner-item__link"
       aria-label={{item.content.linkText}}
       onClick={{action item.content.linkAction}}>
@@ -24,5 +24,5 @@
     customClass=(concat "nucleus-banner-item__close")
     icon="nucleus-cross"
     iconSize="mini"
-    onClick=(action 'onClose' item)}}
-{{/if}}         
+    onClick=(action "onClose" item)}}
+{{/if}}
diff --git a/packages/banner/ember-backstop/backstop.js b/packages/banner/ember-backstop/backstop.js
@@ -1,5 +1,4 @@
-const path = require('path');
-
+/* eslint-env node */
 module.exports = {
   id: `ember-backstop test`,
   viewports: [

diff --git a/packages/banner/ember-backstop/backstop_data/engine_scripts/puppet/onReady.js b/packages/banner/ember-backstop/backstop_data/engine_scripts/puppet/onReady.js
@@ -2,7 +2,7 @@
 
 const debug = require('debug')('BackstopJS');
 
-module.exports = async (page, scenario, vp) => {
+module.exports = async (page, scenario) => {
   debug('SCENARIO > ' + scenario.label);
   await require('./overrideCSS')(page, scenario);
   await require('./clickAndHoverHelper')(page, scenario);

diff --git a/packages/banner/ember-backstop/backstop_data/engine_scripts/puppet/overrideCSS.js b/packages/banner/ember-backstop/backstop_data/engine_scripts/puppet/overrideCSS.js
@@ -1,6 +1,6 @@
 /* eslint-env browser, node */
 
-module.exports = function(page, scenario) {
+module.exports = function(page) {
   // inject arbitrary css to override styles
   page.evaluate(() => {
     const BACKSTOP_TEST_CSS_OVERRIDE = `#ember-testing {width: 100% !important; height: 100% !important; -webkit-transform: scale(1) !important; transform: scale(1) !important;}`;

diff --git a/packages/banner/ember-cli-build.js b/packages/banner/ember-cli-build.js
@@ -1,5 +1,6 @@
 'use strict';
 
+// eslint-disable-next-line node/no-unpublished-require
 const EmberAddon = require('ember-cli/lib/broccoli/ember-addon');
 
 module.exports = function(defaults) {

diff --git a/packages/banner/index.js b/packages/banner/index.js
@@ -1,6 +1,8 @@
 /* eslint-env node */
 'use strict';
+// eslint-disable-next-line node/no-unpublished-require
 const mergeTrees = require('broccoli-merge-trees');
+// eslint-disable-next-line node/no-unpublished-require
 const Funnel = require('broccoli-funnel');
 const path = require('path');
 

diff --git a/packages/banner/package.json b/packages/banner/package.json
@@ -15,7 +15,7 @@
   "scripts": {
     "build": "ember build",
     "lint:hbs": "ember-template-lint .",
-    "lint:js": "eslint .",
+    "lint:js": "eslint . --fix",
     "start": "ember serve -p 4003",
     "deploy": "ember deploy production",
     "test": "ember backstop-remote & COVERAGE=TRUE ember test --test-port=1512",
@@ -66,6 +66,7 @@
     "ember-sinon": "^4.0.0",
     "ember-sinon-qunit": "^3.4.0",
     "ember-source": "~3.13.0",
+    "ember-template-lint": "^1.13.2",
     "ember-test-selectors": "^2.1.0",
     "eslint-plugin-ember": "^7.1.0",
     "eslint-plugin-node": "^10.0.0",

diff --git a/packages/button/.eslintrc.js b/packages/button/.eslintrc.js
@@ -48,6 +48,7 @@ module.exports = {
         node: true
       },
       plugins: ['node'],
+      // eslint-disable-next-line node/no-unpublished-require
       rules: Object.assign({}, require('eslint-plugin-node').configs.recommended.rules, {
         'comma-dangle': ['error', 'never'],
         'ember/new-module-imports': 'off',

diff --git a/packages/button/.template-lintrc.js b/packages/button/.template-lintrc.js
@@ -0,0 +1,11 @@
+/* eslint-env node */
+'use strict';
+
+module.exports = {
+  extends: 'recommended',
+
+  rules: {
+    'no-bare-strings': false,
+    'quotes': 'double'
+  }
+};
diff --git a/packages/button/ember-backstop/backstop.js b/packages/button/ember-backstop/backstop.js
@@ -1,5 +1,4 @@
-const path = require('path');
-
+/* eslint-env node */
 module.exports = {
   id: `ember-backstop test`,
   viewports: [

diff --git a/packages/button/ember-backstop/backstop_data/engine_scripts/puppet/onReady.js b/packages/button/ember-backstop/backstop_data/engine_scripts/puppet/onReady.js
@@ -2,7 +2,7 @@
 
 const debug = require('debug')('BackstopJS');
 
-module.exports = async (page, scenario, vp) => {
+module.exports = async (page, scenario) => {
   debug('SCENARIO > ' + scenario.label);
   await require('./overrideCSS')(page, scenario);
   await require('./clickAndHoverHelper')(page, scenario);

diff --git a/packages/button/ember-backstop/backstop_data/engine_scripts/puppet/overrideCSS.js b/packages/button/ember-backstop/backstop_data/engine_scripts/puppet/overrideCSS.js
@@ -1,6 +1,6 @@
 /* eslint-env browser, node */
 
-module.exports = function(page, scenario) {
+module.exports = function(page) {
   // inject arbitrary css to override styles
   page.evaluate(() => {
     const BACKSTOP_TEST_CSS_OVERRIDE = `#ember-testing {width: 100% !important; height: 100% !important; -webkit-transform: scale(1) !important; transform: scale(1) !important;}`;

diff --git a/packages/button/ember-cli-build.js b/packages/button/ember-cli-build.js
@@ -1,5 +1,6 @@
 'use strict';
 
+// eslint-disable-next-line node/no-unpublished-require
 const EmberAddon = require('ember-cli/lib/broccoli/ember-addon');
 
 module.exports = function(defaults) {

diff --git a/packages/button/index.js b/packages/button/index.js
@@ -1,6 +1,8 @@
 /* eslint-env node */
 'use strict';
+// eslint-disable-next-line node/no-unpublished-require
 const mergeTrees = require('broccoli-merge-trees');
+// eslint-disable-next-line node/no-unpublished-require
 const Funnel = require('broccoli-funnel');
 const path = require('path');
 

diff --git a/packages/button/package.json b/packages/button/package.json
@@ -15,7 +15,7 @@
   "scripts": {
     "build": "ember build",
     "lint:hbs": "ember-template-lint .",
-    "lint:js": "eslint .",
+    "lint:js": "eslint . --fix",
     "start": "ember serve -p 4003",
     "deploy": "ember deploy production",
     "test": "ember backstop-remote & COVERAGE=TRUE ember test --test-port=1509",
@@ -64,6 +64,7 @@
     "ember-sinon": "^4.0.0",
     "ember-sinon-qunit": "^3.4.0",
     "ember-source": "~3.13.0",
+    "ember-template-lint": "^1.13.2",
     "ember-test-selectors": "^2.1.0",
     "eslint-plugin-ember": "^7.1.0",
     "eslint-plugin-node": "^10.0.0",

diff --git a/packages/core/.eslintrc.js b/packages/core/.eslintrc.js
@@ -45,6 +45,7 @@ module.exports = {
         node: true
       },
       plugins: ['node'],
+      // eslint-disable-next-line node/no-unpublished-require
       rules: Object.assign({}, require('eslint-plugin-node').configs.recommended.rules, {
         'comma-dangle': ['error', 'never'],
         'ember/new-module-imports': 'off',

diff --git a/packages/core/ember-cli-build.js b/packages/core/ember-cli-build.js
@@ -1,5 +1,6 @@
 'use strict';
 
+// eslint-disable-next-line node/no-unpublished-require
 const EmberAddon = require('ember-cli/lib/broccoli/ember-addon');
 
 module.exports = function(defaults) {

diff --git a/packages/icon/.eslintrc.js b/packages/icon/.eslintrc.js
@@ -48,6 +48,7 @@ module.exports = {
         node: true
       },
       plugins: ['node'],
+      // eslint-disable-next-line node/no-unpublished-require
       rules: Object.assign({}, require('eslint-plugin-node').configs.recommended.rules, {
         'comma-dangle': ['error', 'never'],
         'ember/new-module-imports': 'off',

diff --git a/packages/icon/.template-lintrc.js b/packages/icon/.template-lintrc.js
@@ -0,0 +1,11 @@
+/* eslint-env node */
+'use strict';
+
+module.exports = {
+  extends: 'recommended',
+
+  rules: {
+    'no-bare-strings': false,
+    'quotes': 'double'
+  }
+};
diff --git a/packages/icon/ember-backstop/backstop.js b/packages/icon/ember-backstop/backstop.js
@@ -1,5 +1,4 @@
-const path = require('path');
-
+/* eslint-env node */
 module.exports = {
   id: `ember-backstop test`,
   viewports: [

diff --git a/packages/icon/ember-backstop/backstop_data/engine_scripts/puppet/onReady.js b/packages/icon/ember-backstop/backstop_data/engine_scripts/puppet/onReady.js
@@ -2,7 +2,7 @@
 
 const debug = require('debug')('BackstopJS');
 
-module.exports = async (page, scenario, vp) => {
+module.exports = async (page, scenario) => {
   debug('SCENARIO > ' + scenario.label);
   await require('./overrideCSS')(page, scenario);
   await require('./clickAndHoverHelper')(page, scenario);

diff --git a/packages/icon/ember-backstop/backstop_data/engine_scripts/puppet/overrideCSS.js b/packages/icon/ember-backstop/backstop_data/engine_scripts/puppet/overrideCSS.js
@@ -1,6 +1,6 @@
 /* eslint-env browser, node */
 
-module.exports = function(page, scenario) {
+module.exports = function(page) {
   // inject arbitrary css to override styles
   page.evaluate(() => {
     const BACKSTOP_TEST_CSS_OVERRIDE = `#ember-testing {width: 100% !important; height: 100% !important; -webkit-transform: scale(1) !important; transform: scale(1) !important;}`;

diff --git a/packages/icon/ember-cli-build.js b/packages/icon/ember-cli-build.js
@@ -1,5 +1,6 @@
 'use strict';
 
+// eslint-disable-next-line node/no-unpublished-require
 const EmberAddon = require('ember-cli/lib/broccoli/ember-addon');
 
 module.exports = function(defaults) {

diff --git a/packages/icon/index.js b/packages/icon/index.js
@@ -1,6 +1,8 @@
 /* eslint-env node */
 'use strict';
+// eslint-disable-next-line node/no-unpublished-require
 const mergeTrees = require('broccoli-merge-trees');
+// eslint-disable-next-line node/no-unpublished-require
 const Funnel = require('broccoli-funnel');
 const path = require('path');
 

diff --git a/packages/icon/package.json b/packages/icon/package.json
@@ -15,7 +15,7 @@
   "scripts": {
     "build": "ember build",
     "lint:hbs": "ember-template-lint .",
-    "lint:js": "eslint .",
+    "lint:js": "eslint . --fix",
     "start": "ember serve -p 4003",
     "deploy": "ember deploy production",
     "test": "ember backstop-remote & COVERAGE=TRUE ember test --test-port=1514",
@@ -63,6 +63,7 @@
     "ember-sinon": "^4.0.0",
     "ember-sinon-qunit": "^3.4.0",
     "ember-source": "~3.13.0",
+    "ember-template-lint": "^1.13.2",
     "ember-test-selectors": "^2.1.0",
     "eslint-plugin-ember": "^7.1.0",
     "eslint-plugin-node": "^10.0.0",

diff --git a/packages/inline-banner/.eslintrc.js b/packages/inline-banner/.eslintrc.js
@@ -45,6 +45,7 @@ module.exports = {
         node: true
       },
       plugins: ['node'],
+      // eslint-disable-next-line node/no-unpublished-require
       rules: Object.assign({}, require('eslint-plugin-node').configs.recommended.rules, {
         'comma-dangle': ['error', 'never'],
         'ember/new-module-imports': 'off',