[CI/CD] Add eslint workflow (opensearch-project#273)

* Add eslint workflow Signed-off-by: Ryan Liang <[email protected]> * Add eslint command Signed-off-by: Ryan Liang <[email protected]> --------- Signed-off-by: Ryan Liang <[email protected]>
RyanL1997 · Jan 16, 2024 · a33c80c · a33c80c
1 parent 09cb4c1
commit a33c80c
Show file tree

Hide file tree

Showing 6 changed files with 164 additions and 10 deletions.
diff --git a/.cypress/.eslintrc.js b/.cypress/.eslintrc.js
@@ -0,0 +1,17 @@
+module.exports = {
+    root: true,
+    extends: ['plugin:cypress/recommended'],
+    env: {
+      'cypress/globals': true,
+    },
+    plugins: ['cypress'],
+    rules: {
+      // 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',
+    },
+  };
+
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 b/.eslintrc
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,59 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+ const LICENSE_HEADER = `/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */`;
+
+module.exports = {
+  root: true,
+  extends: [
+    '@elastic/eslint-config-kibana',
+    'plugin:@elastic/eui/recommended',
+    'plugin:react-hooks/recommended',
+    'plugin:jest/recommended',
+    'plugin:prettier/recommended',
+  ],
+
+  rules: {
+    '@typescript-eslint/no-unused-vars': [
+      'error',
+      {
+        argsIgnorePattern: '^_',
+        varsIgnorePattern: '^_',
+        caughtErrorsIgnorePattern: '^_',
+      },
+    ],
+    '@osd/eslint/no-restricted-paths': [
+      'error',
+      {
+        basePath: __dirname,
+        zones: [
+          {
+            target: ['(public|server)/**/*'],
+            from: ['../../packages/**/*','packages/**/*'],
+          },
+        ],
+      },
+    ],
+  },
+  overrides: [
+    {
+      files: ['**/*.{js,ts,tsx}'],
+      rules: {
+        '@typescript-eslint/no-explicit-any': 'warn',
+        'no-console': 0,
+        '@osd/eslint/require-license-header': [
+          'error',
+          {
+            licenses: [LICENSE_HEADER],
+          },
+        ],
+      },
+    },
+  ],
+  "ignorePatterns": ["**/*.d.ts"]
+};
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -0,0 +1,79 @@
+name: Lint
+
+on: [pull_request]
+
+env:
+  PLUGIN_NAME: dashboards-reporting
+  OPENSEARCH_DASHBOARDS_VERSION: "main"
+
+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 reporting
+        uses: actions/checkout@v2
+        with:
+          path: OpenSearch-Dashboards/plugins/${{ env.PLUGIN_NAME }}
+          fetch-depth: 0
+
+      - 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: Get list of changed files using GitHub Action
+        uses: lots0logs/[email protected]
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Check Changes of Files
+        run: |
+          echo "FILES_MODIFIED=$(cat ${HOME}/files_modified.json)"
+          echo "FILES_ADDED=$(cat ${HOME}/files_added.json)"
+          echo "FILES_RENAMED=$(cat ${HOME}/files_renamed.json)"
+          echo "FILES_DELETED=$(cat ${HOME}/files_deleted.json)"
+
+      - name: Lint Changed Files
+        run: |
+          jq -r '.[]' ${HOME}/files_modified.json ${HOME}/files_added.json | sort | uniq > /tmp/changed_files.txt
+          CHANGED_FILES=$(cat /tmp/changed_files.txt)
+          echo "These are the changed files: $CHANGED_FILES"
+          if [[ -n "$CHANGED_FILES" ]]; then
+            echo "Linting changed files..."
+            while IFS= read -r file; do
+              if [[ $file == *.js || $file == *.ts || $file == *.tsx ]]; then
+                echo "linting file $file"
+                yarn lint "$file"
+              fi
+            done < /tmp/changed_files.txt
+          else
+            echo "No matched files to lint."
+          fi
+        working-directory: OpenSearch-Dashboards/plugins/${{ env.PLUGIN_NAME }}      
diff --git a/package.json b/package.json
@@ -7,7 +7,8 @@
   "scripts": {
     "osd": "node ../../scripts/osd",
     "opensearch": "node ../../scripts/opensearch",
-    "lint": "eslint .",
+    "lint:es": "node ../../scripts/eslint",
+    "lint": "yarn lint:es",
     "start": "yarn plugin-helpers start",
     "build": "yarn plugin-helpers build",
     "test": "../../node_modules/.bin/jest --config ./test/jest.config.js",