Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Maintenance] Add JS linter to CI #17630

Open
wants to merge 1 commit into
base: 2.0
Choose a base branch
from

Conversation

mpysiak
Copy link
Member

@mpysiak mpysiak commented Jan 15, 2025

Q A
Branch? 2.0
Bug fix? no
New feature? no
BC breaks? no
Deprecations? no
Related tickets n/a
License MIT

Added JS linter to CI

Summary by CodeRabbit

  • Chores
    • Enhanced CI/CD pipeline by adding a JavaScript linting step to ensure code quality and consistency.

@mpysiak mpysiak requested review from a team as code owners January 15, 2025 05:23
@probot-autolabeler probot-autolabeler bot added the Maintenance CI configurations, READMEs, releases, etc. label Jan 15, 2025
Copy link

coderabbitai bot commented Jan 15, 2025

Walkthrough

The pull request introduces a new linting step to the frontend GitHub Actions workflow. The modification adds a "Run javascript linter" step using the yarn lint command within the existing frontend job. This enhancement aims to improve code quality by automatically checking JavaScript code for potential errors and style inconsistencies during the continuous integration process.

Changes

File Change Summary
.github/workflows/ci_frontend.yaml Added new step "Run javascript linter" with yarn lint command in frontend job

Poem

🐰 A linter hops into the CI lane,
Checking code with a critical refrain,
Yarn spins its magical lint-y thread,
Catching bugs before they can spread,
A rabbit's code review, swift and clean! 🔍


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@mpysiak mpysiak added the DX Issues and PRs aimed at improving Developer eXperience. label Jan 15, 2025
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
.github/workflows/ci_frontend.yaml (2)

86-87: Consider adding error handling and artifact collection for lint failures.

While the linting step is correctly placed after the build step, consider:

  1. Adding continue-on-error: false to ensure the workflow fails on linting errors
  2. Collecting lint results as artifacts for easier debugging
 -   name: "Run javascript linter"
-    run: yarn lint
+    run: |
+      yarn lint > lint-results.txt || {
+        cat lint-results.txt
+        exit 1
+      }
+    continue-on-error: false
+
+-   name: Upload lint results
+    if: failure()
+    uses: actions/upload-artifact@v3
+    with:
+      name: lint-results
+      path: lint-results.txt
🧰 Tools
🪛 yamllint (1.35.1)

[warning] 86-86: too many spaces after hyphen

(hyphens)


85-86: Fix YAML formatting issues.

The static analysis tool identified formatting inconsistencies:

  1. Remove trailing spaces on line 85
  2. Fix hyphen spacing on line 86
-                    
--   name: "Run javascript linter"
+
+    name: "Run javascript linter"
🧰 Tools
🪛 yamllint (1.35.1)

[error] 85-85: trailing spaces

(trailing-spaces)


[warning] 86-86: too many spaces after hyphen

(hyphens)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7e6da24 and f29e893.

📒 Files selected for processing (1)
  • .github/workflows/ci_frontend.yaml (1 hunks)
🧰 Additional context used
🪛 yamllint (1.35.1)
.github/workflows/ci_frontend.yaml

[error] 85-85: trailing spaces

(trailing-spaces)


[warning] 86-86: too many spaces after hyphen

(hyphens)

⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Static checks / PHP 8.3, Symfony ^7.1
  • GitHub Check: Static checks / PHP 8.2, Symfony ^6.4
🔇 Additional comments (1)
.github/workflows/ci_frontend.yaml (1)

87-87: Verify the lint script configuration in package.json.

The yarn lint command assumes a "lint" script is defined in package.json. Let's verify this configuration.

✅ Verification successful

Lint script is properly configured

The yarn lint command is correctly set up to run eslint . which will lint all files in the project.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if the lint script is properly configured

# Check if package.json exists and contains a lint script
if [ -f "package.json" ]; then
  echo "Checking lint script in package.json:"
  jq '.scripts.lint' package.json
else
  echo "package.json not found in the root directory"
  # Search for package.json files in the repository
  fd --type f "package.json" --exec sh -c 'echo "Found: {}"; jq ".scripts.lint" "{}"'
fi

Length of output: 153

Copy link

Bunnyshell Preview Environment deployed

It will be automatically stopped in 4 hours.

Use the command /bns:start to start it if it's stopped.

Component Endpoints
mailhog https://mailhog-m2coiy.bunnyenv.com/
php https://store-m2coiy.bunnyenv.com/

Available commands:

  • /bns:stop to stop the environment
  • /bns:deploy to redeploy the environment
  • /bns:delete to remove the environment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DX Issues and PRs aimed at improving Developer eXperience. Maintenance CI configurations, READMEs, releases, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants