[BACKPORT] Backport linter CI to 2.x (#1313)

* linter CI (#1301) Signed-off-by: Eric <[email protected]> * change version to 2.x Signed-off-by: Eric <[email protected]> * add missing scripts Signed-off-by: Eric <[email protected]> --------- Signed-off-by: Eric <[email protected]>
opensearch-project · Dec 20, 2023 · 138bd21 · 138bd21
1 parent 566981f
commit 138bd21
Show file tree

Hide file tree

Showing 4 changed files with 102 additions and 0 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,7 @@
+node_modules
+/data
+/build
+/target
+/.eslintrc.js
+/cypress.config.js
+!.cypress/
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -14,7 +14,37 @@ module.exports = {
     '@elastic/eslint-config-kibana',
     'plugin:@elastic/eui/recommended',
     'plugin:react-hooks/recommended',
+    "eslint:recommended",
+    "plugin:cypress/recommended",
+    "plugin:import/recommended",
+    "prettier"
   ],
+  env: {
+    'cypress/globals': true,
+  },
+  plugins: [
+    'cypress',
+  ],
+  rules: {
+    '@osd/eslint/no-restricted-paths': [
+      'error',
+      {
+        basePath: __dirname,
+        zones: [
+          {
+            target: ['(public|server)/**/*'],
+            from: ['../../packages/**/*','packages/**/*'],
+          },
+        ],
+      },
+    ],
+    // Add cypress specific rules here
+    'cypress/no-assigning-return-values': 'error',
+    'cypress/no-unnecessary-waiting': 'error',
+    'cypress/assertion-before-screenshot': 'warn',
+    'cypress/no-force': 'warn',
+    'cypress/no-async-tests': 'error',
+  },
   overrides: [
     {
       files: ['**/*.{js,ts,tsx}'],
@@ -29,4 +59,5 @@ module.exports = {
       },
     },
   ],
+  "ignorePatterns": ["**/*.d.ts"]
 };
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -0,0 +1,61 @@
+name: Lint
+
+on:  [push, pull_request]
+
+env:
+  PLUGIN_NAME: dashboards-observability
+  OPENSEARCH_DASHBOARDS_VERSION: '2.x'
+
+jobs:
+  build:
+    name: Lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout OpenSearch Dashboards
+        uses: actions/checkout@v2
+        with:
+          repository: opensearch-project/Opensearch-Dashboards
+          ref: ${{ env.OPENSEARCH_DASHBOARDS_VERSION }}
+          path: OpenSearch-Dashboards
+
+      - name: Checkout dashboards observability
+        uses: actions/checkout@v2
+        with:
+          path: OpenSearch-Dashboards/plugins/${{ env.PLUGIN_NAME }}         
+
+      - name: Get node and yarn versions
+        working-directory: ${{ env.WORKING_DIR }}
+        id: versions_step
+        run: |
+          echo "::set-output name=node_version::$(cat ./OpenSearch-Dashboards/.nvmrc | cut -d"." -f1)"
+          echo "::set-output name=yarn_version::$(node -p "(require('./OpenSearch-Dashboards/package.json').engines.yarn).match(/[.0-9]+/)[0]")"
+
+      - name: Setup node
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ steps.versions_step.outputs.node_version }}
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install correct yarn version for OpenSearch Dashboards
+        run: |
+          npm uninstall -g yarn
+          echo "Installing yarn ${{ steps.versions_step.outputs.yarn_version }}"
+          npm i -g yarn@${{ steps.versions_step.outputs.yarn_version }}
+
+      - name: Bootstrap the plugin
+        working-directory: OpenSearch-Dashboards/plugins/${{ env.PLUGIN_NAME }}  
+        run:
+          yarn osd bootstrap
+
+      - name: lint code base
+        working-directory: OpenSearch-Dashboards/plugins/${{ env.PLUGIN_NAME }}
+        run: |
+          git fetch origin 2.x
+          CHANGED_FILES=$(git diff --name-only --diff-filter=ACMRTUXB origin/2.x | grep -E "\.(js|ts|tsx)$")
+          if [ -n "$CHANGED_FILES" ]; then
+            echo "Linting changed files..."
+            yarn lint $CHANGED_FILES
+          else
+            echo "No JavaScript/TypeScript files changed."
+          fi
diff --git a/package.json b/package.json
@@ -10,6 +10,9 @@
     "cypress:run": "TZ=America/Los_Angeles cypress run",
     "cypress:open": "TZ=America/Los_Angeles cypress open",
     "plugin-helpers": "node ../../scripts/plugin_helpers",
+    "prepare": "husky install",
+    "lint:es": "node ../../scripts/eslint",
+    "lint": "yarn lint:es",
     "cypress:parallel": "cypress-parallel -s cypress:run -t 2 -d .cypress/integration"
   },
   "dependencies": {