Onboard Stylelint (#229) (#300)

(cherry picked from commit 37a3545) Co-authored-by: Matt Provost <[email protected]>
opensearch-project · Dec 13, 2023 · 20a5fae · 20a5fae
1 parent 24ed657
commit 20a5fae
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 12 deletions.
diff --git a/.github/workflows/test-and-build-workflow.yml b/.github/workflows/test-and-build-workflow.yml
@@ -1,11 +1,10 @@
-
 name: Test and Build Gantt Chart
 
 on: [pull_request, push]
 
 env:
   PLUGIN_NAME: gantt-chart-dashboards
-  OPENSEARCH_VERSION: '2.x'
+  OPENSEARCH_VERSION: "2.x"
   OPENSEARCH_PLUGIN_VERSION: 2.10.0.0
 
 jobs:
@@ -67,7 +66,6 @@ jobs:
           path: ./dashboards-visualizations/OpenSearch-Dashboards/plugins/gantt-chart/build
 
   windows-build:
-
     runs-on: windows-latest
     steps:
       - name: Checkout Plugin
@@ -86,8 +84,8 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v3
         with:
-          node-version-file: './dashboards-visualizations/OpenSearch-Dashboards/.nvmrc'
-          registry-url: 'https://registry.npmjs.org'
+          node-version-file: "./dashboards-visualizations/OpenSearch-Dashboards/.nvmrc"
+          registry-url: "https://registry.npmjs.org"
 
       - name: Install Yarn
         # Need to use bash to avoid having a windows/linux specific step
@@ -109,6 +107,11 @@ jobs:
           cd ./dashboards-visualizations/OpenSearch-Dashboards/plugins/gantt-chart
           yarn osd bootstrap
 
+      - name: Run Stylelint
+        run: |
+          cd ./dashboards-visualizations/OpenSearch-Dashboards/plugins/gantt-chart
+          yarn lint:style
+
       - name: Test
         run: |
           cd ./dashboards-visualizations/OpenSearch-Dashboards/plugins/gantt-chart
@@ -125,9 +128,8 @@ jobs:
         with:
           name: gantt-chart-windows
           path: ./dashboards-visualizations/OpenSearch-Dashboards/plugins/gantt-chart/build
-
-  macos-build:
 
+  macos-build:
     runs-on: macos-latest
 
     steps:
@@ -144,8 +146,8 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v3
         with:
-          node-version-file: './dashboards-visualizations/OpenSearch-Dashboards/.nvmrc'
-          registry-url: 'https://registry.npmjs.org'
+          node-version-file: "./dashboards-visualizations/OpenSearch-Dashboards/.nvmrc"
+          registry-url: "https://registry.npmjs.org"
 
       - name: Install Yarn
         # Need to use bash to avoid having a windows/linux specific step
@@ -167,6 +169,11 @@ jobs:
           cd ./dashboards-visualizations/OpenSearch-Dashboards/plugins/gantt-chart
           yarn osd bootstrap
 
+      - name: Run Stylelint
+        run: |
+          cd ./dashboards-visualizations/OpenSearch-Dashboards/plugins/gantt-chart
+          yarn lint:style
+
       - name: Test
         run: |
           cd ./dashboards-visualizations/OpenSearch-Dashboards/plugins/gantt-chart
@@ -183,5 +190,3 @@ jobs:
         with:
           name: gantt-chart-macos
           path: ./dashboards-visualizations/OpenSearch-Dashboards/plugins/gantt-chart/build
-
-
diff --git a/gantt-chart/package.json b/gantt-chart/package.json
@@ -6,6 +6,7 @@
     "osd": "node ../../scripts/osd",
     "opensearch": "node ../../scripts/opensearch",
     "lint": "eslint .",
+    "lint:style": "node ../../scripts/stylelint",
     "build": "yarn plugin-helpers build",
     "plugin-helpers": "node ../../scripts/plugin_helpers",
     "test": "../../node_modules/.bin/jest --config ./test/jest.config.js",

diff --git a/gantt-chart/public/index.scss b/gantt-chart/public/index.scss
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-.embPanel__content[data-loading][data-type=plotlyGanttChart] {
+.embPanel__content[data-loading][data-type="plotlyGanttChart"] {
   pointer-events: auto;
   filter: none;
 }