From 215b6f263fdaa7630db6bcf1100bab46209d1e20 Mon Sep 17 00:00:00 2001 From: Jialiang Liang <109499885+RyanL1997@users.noreply.github.com> Date: Tue, 16 Jan 2024 10:10:28 -0800 Subject: [PATCH 1/2] [CI/CD] Add eslint workflow (#316) * Add eslint workflow Signed-off-by: Ryan Liang * Correct the plugin name Signed-off-by: Ryan Liang * Correct the plugin name2 Signed-off-by: Ryan Liang * change the linting running dir Signed-off-by: Ryan Liang * Fix some comments Signed-off-by: Ryan Liang * Add stylelint back Signed-off-by: Ryan Liang --------- Signed-off-by: Ryan Liang --- .github/workflows/lint.yml | 80 +++++++++++++++++++++++++++++++ gantt-chart/.cypress/.eslintrc.js | 17 +++++++ gantt-chart/.eslintignore | 7 +++ gantt-chart/.eslintrc.js | 59 +++++++++++++++++++++++ gantt-chart/.eslintrc.yaml | 9 ---- gantt-chart/package.json | 3 +- 6 files changed, 165 insertions(+), 10 deletions(-) create mode 100644 .github/workflows/lint.yml create mode 100644 gantt-chart/.cypress/.eslintrc.js create mode 100644 gantt-chart/.eslintignore create mode 100644 gantt-chart/.eslintrc.js delete mode 100644 gantt-chart/.eslintrc.yaml diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 0000000..5f5995a --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,80 @@ +name: Lint + +on: [pull_request] + +env: + PLUGIN_NAME: dashboards-visualizations + OPENSEARCH_DASHBOARDS_VERSION: "main" + +jobs: + build: + name: Lint + runs-on: ubuntu-latest + + steps: + - name: Checkout Plugin + uses: actions/checkout@v2 + + - name: Checkout OpenSearch Dashboards + uses: actions/checkout@v2 + with: + repository: opensearch-project/Opensearch-Dashboards + ref: ${{ env.OPENSEARCH_DASHBOARDS_VERSION }} + path: OpenSearch-Dashboards + + - name: Install Gantt Chart to Opensearch Dashboards Plugins Dir + run: | + mv gantt-chart ./OpenSearch-Dashboards/plugins + + - 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/gantt-chart + run: yarn osd bootstrap + + - name: Get list of changed files using GitHub Action + uses: lots0logs/gh-action-get-changed-files@2.2.2 + 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 =~ ^gantt-chart/.+\.(js|ts|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/gantt-chart diff --git a/gantt-chart/.cypress/.eslintrc.js b/gantt-chart/.cypress/.eslintrc.js new file mode 100644 index 0000000..26edd9b --- /dev/null +++ b/gantt-chart/.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', + }, + }; + \ No newline at end of file diff --git a/gantt-chart/.eslintignore b/gantt-chart/.eslintignore new file mode 100644 index 0000000..c5e1946 --- /dev/null +++ b/gantt-chart/.eslintignore @@ -0,0 +1,7 @@ +node_modules +/data +/build +/target +/.eslintrc.js +/cypress.config.js +!.cypress/ diff --git a/gantt-chart/.eslintrc.js b/gantt-chart/.eslintrc.js new file mode 100644 index 0000000..12f093d --- /dev/null +++ b/gantt-chart/.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/gantt-chart/.eslintrc.yaml b/gantt-chart/.eslintrc.yaml deleted file mode 100644 index 593afaa..0000000 --- a/gantt-chart/.eslintrc.yaml +++ /dev/null @@ -1,9 +0,0 @@ ---- -extends: '@elastic/kibana' - -settings: - import/resolver: - '@osd/eslint-import-resolver-kibana': - rootPackageName: 'gantt-chart' - pluginPaths: - - . diff --git a/gantt-chart/package.json b/gantt-chart/package.json index 43254f1..fb1a2d3 100644 --- a/gantt-chart/package.json +++ b/gantt-chart/package.json @@ -5,8 +5,9 @@ "scripts": { "osd": "node ../../scripts/osd", "opensearch": "node ../../scripts/opensearch", - "lint": "eslint .", "lint:style": "node ../../scripts/stylelint", + "lint:es": "node ../../scripts/eslint", + "lint": "yarn lint:es", "build": "yarn plugin-helpers build", "plugin-helpers": "node ../../scripts/plugin_helpers", "test": "../../node_modules/.bin/jest --config ./test/jest.config.js", From 859ec2f505d98a403a150ee96b63d26a835e0d1a Mon Sep 17 00:00:00 2001 From: Ryan Liang Date: Fri, 19 Jan 2024 10:30:14 -0800 Subject: [PATCH 2/2] Change the branch ref Signed-off-by: Ryan Liang --- .github/workflows/lint.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 5f5995a..a794596 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -4,7 +4,7 @@ on: [pull_request] env: PLUGIN_NAME: dashboards-visualizations - OPENSEARCH_DASHBOARDS_VERSION: "main" + OPENSEARCH_DASHBOARDS_VERSION: "2.x" jobs: build: