Chore(UI): Add pretty and eslint for openmetadata-ui-core-components for code quality #26686
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -25,6 +25,7 @@ | |||||
| - ".github/workflows/ui-checkstyle.yml" | ||||||
| - openmetadata-ui/src/main/resources/ui/playwright/** | ||||||
| - openmetadata-ui/src/main/resources/ui/eslint.config.mjs | ||||||
| - "openmetadata-ui-core-components/src/main/resources/ui/**" | ||||||
|
|
||||||
| permissions: | ||||||
| contents: read | ||||||
|
|
@@ -35,14 +36,15 @@ | |||||
|
|
||||||
| env: | ||||||
| UI_WORKING_DIRECTORY: openmetadata-ui/src/main/resources/ui | ||||||
| CORE_COMPONENTS_WORKING_DIRECTORY: openmetadata-ui-core-components/src/main/resources/ui | ||||||
|
|
||||||
| jobs: | ||||||
| # ────────────────────────────────────────────────────────────────────────── | ||||||
| # Job 0: Authorize | ||||||
| # ────────────────────────────────────────────────────────────────────────── | ||||||
| authorize: | ||||||
| if: | | ||||||
| github.event_name == 'pull_request_target' && | ||||||
| (github.event.action != 'labeled' || github.event.label.name == 'safe to test') | ||||||
| runs-on: ubuntu-latest | ||||||
| steps: | ||||||
|
|
@@ -104,14 +106,14 @@ | |||||
| files_ignore: | | ||||||
| src/generated/** | ||||||
| files: | | ||||||
| src/**/*.{ts,tsx,js,jsx,json} | ||||||
|
|
||||||
| - name: ESLint + Prettier + Organise Imports | ||||||
| id: lint | ||||||
| if: steps.changed-files.outputs.any_changed == 'true' | ||||||
| working-directory: ${{ env.UI_WORKING_DIRECTORY }} | ||||||
| env: | ||||||
| CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }} | ||||||
|
There was a problem hiding this comment. Two operational issues here:
Suggested change
There was a problem hiding this comment.
|
||||||
| run: | | ||||||
| if [ -z "$CHANGED_FILES" ]; then | ||||||
| echo "No added or modified files to process." | ||||||
|
|
@@ -150,13 +152,14 @@ | |||||
| ### ❌ Lint Check Failed — ESLint + Prettier + Organise Imports (src) | ||||||
|
|
||||||
| The following files have style issues that need to be fixed: | ||||||
| ${{ steps.changed-files.outputs.all_changed_files }} | ||||||
|
|
||||||
| **Fix locally (fast — changed files only):** | ||||||
| ```bash | ||||||
| cd openmetadata-ui/src/main/resources/ui | ||||||
| yarn ui-checkstyle:changed | ||||||
| ``` | ||||||
| Or to fix all files: `yarn ui-checkstyle` | ||||||
| edit-mode: replace | ||||||
|
|
||||||
| - name: Delete comment on success | ||||||
|
|
@@ -211,7 +214,7 @@ | |||||
| if: steps.changed-files.outputs.any_changed == 'true' | ||||||
| working-directory: ${{ env.UI_WORKING_DIRECTORY }} | ||||||
| env: | ||||||
| CHANGED_FILES_ALL: ${{ steps.changed-files.outputs.all_changed_files }} | ||||||
| run: | | ||||||
| if [ -z "$CHANGED_FILES_ALL" ]; then | ||||||
| echo "No added or modified files to process." | ||||||
|
|
@@ -248,7 +251,7 @@ | |||||
| ### ❌ Licence Header Check Failed | ||||||
|
|
||||||
| The following files are missing or have outdated licence headers: | ||||||
| ${{ steps.changed-files.outputs.all_changed_files }} | ||||||
|
|
||||||
| **Fix locally:** | ||||||
| ```bash | ||||||
|
|
@@ -571,7 +574,7 @@ | |||||
| if: steps.changed-files.outputs.any_changed == 'true' | ||||||
| working-directory: ${{ env.UI_WORKING_DIRECTORY }} | ||||||
| env: | ||||||
| CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }} | ||||||
| run: | | ||||||
| if [ -z "$CHANGED_FILES" ]; then | ||||||
| echo "No added or modified files to process." | ||||||
|
|
@@ -610,13 +613,14 @@ | |||||
| ### ❌ Playwright Lint Check Failed — ESLint + Prettier + Organise Imports | ||||||
|
|
||||||
| The following files have style issues that need to be fixed: | ||||||
| ${{ steps.changed-files.outputs.all_changed_files }} | ||||||
|
|
||||||
| **Fix locally (fast — changed files only):** | ||||||
| ```bash | ||||||
| cd openmetadata-ui/src/main/resources/ui | ||||||
| yarn ui-checkstyle:playwright:changed | ||||||
| ``` | ||||||
| Or to fix all playwright files: `yarn ui-checkstyle:playwright` | ||||||
| edit-mode: replace | ||||||
|
|
||||||
| - name: Delete comment on success | ||||||
|
|
@@ -734,3 +738,103 @@ | |||||
| repo: context.repo.repo, | ||||||
| comment_id: process.env.COMMENT_ID | ||||||
| }) | ||||||
|
|
||||||
| # ────────────────────────────────────────────────────────────────────────── | ||||||
| # Job 8: Core Components — ESLint + Prettier | ||||||
| # ────────────────────────────────────────────────────────────────────────── | ||||||
| lint-core-components: | ||||||
| needs: authorize | ||||||
| runs-on: ubuntu-latest | ||||||
| permissions: | ||||||
| contents: read | ||||||
| pull-requests: write | ||||||
|
There was a problem hiding this comment. Switching from |
||||||
| steps: | ||||||
| - uses: actions/checkout@v4 | ||||||
| with: | ||||||
| ref: ${{ github.event.pull_request.head.sha }} | ||||||
| fetch-depth: 0 | ||||||
|
|
||||||
| - uses: actions/setup-node@v4 | ||||||
| with: | ||||||
| node-version-file: "${{ env.CORE_COMPONENTS_WORKING_DIRECTORY }}/.nvmrc" | ||||||
| cache: yarn | ||||||
| cache-dependency-path: "${{ env.CORE_COMPONENTS_WORKING_DIRECTORY }}/yarn.lock" | ||||||
|
|
||||||
| - name: Install Yarn Packages | ||||||
|
Comment on lines
+757
to
+763
Check failureCode scanning / CodeQL Checkout of untrusted code in a privileged context Critical |
||||||
| working-directory: ${{ env.CORE_COMPONENTS_WORKING_DIRECTORY }} | ||||||
| run: yarn install --frozen-lockfile | ||||||
|
|
||||||
|
|
||||||
| - name: Get changed core-components files | ||||||
|
Comment on lines
+763
to
+768
Check failureCode scanning / CodeQL Checkout of untrusted code in a privileged context Critical |
||||||
| id: changed-files | ||||||
| uses: tj-actions/changed-files@22103cc46bda19c2b464ffe86db46df6922fd323 | ||||||
| with: | ||||||
| path: ${{ env.CORE_COMPONENTS_WORKING_DIRECTORY }} | ||||||
| files: | | ||||||
| src/**/*.{ts,tsx,js,jsx,json} | ||||||
|
gitar-bot[bot] marked this conversation as resolved.
|
||||||
|
|
||||||
| - name: ESLint + Prettier (core-components) | ||||||
| id: lint | ||||||
| if: steps.changed-files.outputs.any_changed == 'true' | ||||||
| working-directory: ${{ env.CORE_COMPONENTS_WORKING_DIRECTORY }} | ||||||
| env: | ||||||
| CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }} | ||||||
| run: | | ||||||
|
Comment on lines
+776
to
+782
There was a problem hiding this comment. Two operational issues here:
|
||||||
| if [ -z "${CHANGED_FILES// }" ]; then | ||||||
| echo "No added or modified files to process." | ||||||
| exit 0 | ||||||
| fi | ||||||
| yarn lint:base --fix $CHANGED_FILES | ||||||
| yarn pretty:base --write $CHANGED_FILES | ||||||
|
Comment on lines
+787
to
+788
There was a problem hiding this comment. Using |
||||||
| if [ -n "$(git status --porcelain)" ]; then | ||||||
| FILES=$(git status --porcelain | awk '{print " - `" $2 "`"}' | head -30) | ||||||
| echo "changed_files<<EOF" >> "$GITHUB_OUTPUT" | ||||||
| echo "$FILES" >> "$GITHUB_OUTPUT" | ||||||
| echo "EOF" >> "$GITHUB_OUTPUT" | ||||||
| git checkout -- . | ||||||
| git clean -fd | ||||||
| exit 1 | ||||||
| fi | ||||||
|
|
||||||
| - name: Find existing lint comment | ||||||
|
Comment on lines
+776
to
+799
Check failureCode scanning / CodeQL Checkout of untrusted code in a privileged context Critical |
||||||
| if: always() | ||||||
| uses: peter-evans/find-comment@v3 | ||||||
| id: fc | ||||||
| with: | ||||||
| issue-number: ${{ github.event.pull_request.number }} | ||||||
| comment-author: github-actions[bot] | ||||||
| body-includes: '<!-- check:lint-core-components -->' | ||||||
|
|
||||||
| - name: Post failure comment | ||||||
| if: failure() | ||||||
|
Comment on lines
+808
to
+809
There was a problem hiding this comment. Switching from |
||||||
| uses: peter-evans/create-or-update-comment@v4 | ||||||
| with: | ||||||
| comment-id: ${{ steps.fc.outputs.comment-id }} | ||||||
| issue-number: ${{ github.event.pull_request.number }} | ||||||
| body: | | ||||||
| <!-- check:lint-core-components --> | ||||||
| ### ❌ Lint Check Failed — ESLint + Prettier (core-components) | ||||||
|
|
||||||
| The following files have style issues that need to be fixed: | ||||||
| ${{ steps.changed-files.outputs.all_changed_files }} | ||||||
|
|
||||||
| **Fix locally (fast — changed files only):** | ||||||
| ```bash | ||||||
| cd openmetadata-ui-core-components/src/main/resources/ui | ||||||
| yarn ui-checkstyle:changed | ||||||
| ``` | ||||||
| Or to fix all files: `yarn lint:fix && yarn pretty` | ||||||
| edit-mode: replace | ||||||
|
|
||||||
| - name: Delete comment on success | ||||||
| if: success() && steps.fc.outputs.comment-id != '' | ||||||
| uses: actions/github-script@v7 | ||||||
| env: | ||||||
| COMMENT_ID: ${{ steps.fc.outputs.comment-id }} | ||||||
| with: | ||||||
| script: | | ||||||
| github.rest.issues.deleteComment({ | ||||||
| owner: context.repo.owner, | ||||||
| repo: context.repo.repo, | ||||||
| comment_id: process.env.COMMENT_ID | ||||||
| }) | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| v22.17.0 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| # Copyright 2021 Collate | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| # Node | ||
| node/ | ||
|
|
||
| # Dependencies | ||
| node_modules/ | ||
|
|
||
| # Production | ||
| build/ | ||
| dist/ | ||
|
|
||
| # macOS | ||
| .DS_Store | ||
|
|
||
| # Ignore files (Prettier has trouble parsing files without extension) | ||
| .gitignore | ||
| .prettierignore | ||
|
|
||
| # Assets | ||
| *.gif | ||
| *.svg | ||
| *.png | ||
| *.ico | ||
| *.ttf | ||
| *.md | ||
| *.webp | ||
| *.jpg | ||
| *.jpeg | ||
|
|
||
| # Snapshots | ||
| *.snap |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| # | ||
| # Copyright 2022 Collate. | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
| # | ||
| --- | ||
| tabWidth: 2 | ||
| bracketSameLine: true | ||
| htmlWhitespaceSensitivity: 'strict' | ||
| singleQuote: true |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| body { | ||
| font-family: 'Inter', 'Poppins', sans-serif; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Switching the workflow from
pull_request_targettopull_requestcan break PR commenting/updates (e.g.,pull-requests: write) on PRs coming from forks because the GitHub token is read-only in that context. If you need automated PR comments, consider either (a) gating comment-writing steps to only run whengithub.event.pull_request.head.repo.full_name == github.repository, or (b) splitting into a safepull_requestcheck job (no comments) plus apull_request_targetjob that only posts comments using trusted data.