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

chore: remove broken lint:tpl:validator script and its references #1490

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

Aditya08Vashisht
Copy link

@Aditya08Vashisht Aditya08Vashisht commented Apr 11, 2025

This PR removes the unnecessary script npm run lint:tpl:validator and its references in many important files of the generator

Fixes: #1463

also i have verified it by running the lint.

image
image

Summary by CodeRabbit

  • Chores
    • Updated linting configuration by removing an outdated exclusion rule and an obsolete lint script from the workflow.
  • Tests
    • Restructured the test pipeline configuration to disable caching for multiple test segments, ensuring a more consistent testing process.

Copy link

changeset-bot bot commented Apr 11, 2025

⚠️ No Changeset found

Latest commit: ce3a8be

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

coderabbitai bot commented Apr 11, 2025

Walkthrough

The changes remove a specific ESLint ignore directive from the .eslintignore file to stop excluding files located in .github/templates-list-validator/dist/*. Additionally, the "lint:tpl:validator" script has been removed from the generator's package.json because it referenced a non-existent file location. The turbo.json file has been reformatted by restructuring the test pipeline configuration and related sections, while keeping the overall functionality unchanged.

Changes

File(s) Change Summary
.eslintignore
apps/generator/package.json
Removed the ESLint ignore directive for .github/templates-list-validator/dist/* and deleted the obsolete "lint:tpl:validator" script that targeted this path.
turbo.json Restructured the test pipeline configuration by adding explicit sub-sections (test:update, test:unit, test:integration) and updating related sections (test, lint:fix, test:integration:update) with cache: false.

Assessment against linked issues

Objective Addressed Explanation
Fix non-working lint:tpl:validator script (#1463)

Poem

I'm a rabbit in the codefield, hopping free,
Cleaning up lint and configs for all to see.
The old script vanished like a fleeting breeze,
And tests now dance with clarity and ease.
Hoppity hop, our code's as fresh as can be! 🐰

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f02dc4d and a33c9f0.

📒 Files selected for processing (3)
  • .eslintignore (0 hunks)
  • apps/generator/package.json (0 hunks)
  • turbo.json (1 hunks)
💤 Files with no reviewable changes (2)
  • apps/generator/package.json
  • .eslintignore
🔇 Additional comments (6)
turbo.json (6)

12-15: Review of "test" configuration update
The "test" block now explicitly states "dependsOn": ["build"] and sets "cache": false, ensuring that tests always run against a freshly built environment. This explicit configuration improves clarity and maintains consistency across the pipeline settings.


16-18: Addition of "test:update" configuration
The new "test:update" block with "cache": false clearly separates update-related testing from other tests. This ensures that any updates are processed without caching artifacts, which is desirable in continuous integration workflows.


19-21: Addition of "test:unit" configuration
Including a dedicated "test:unit" block with caching disabled provides explicit control over unit testing procedures. This consistency across the test pipelines will help avoid any unintended caching issues during unit tests.


22-23: Update to "test:integration" configuration
The "test:integration" block now sets "cache": false to prevent stale integration test results. Verify that disabling caching here aligns with the desired performance characteristics for integration tests.


29-31: Consistency check for "lint:fix" configuration
The "lint:fix" block has been reformatted to include "cache": false, aligning it with the new structured approach seen in other sections. This change supports the broader removal of the broken linting script reference and promotes a unified configuration style.


32-34: Addition of "test:integration:update" configuration
The new "test:integration:update" block, with "cache": false, further details the test pipeline, ensuring that integration update tests run without relying on cached results. This explicit configuration is a good step in maintaining consistency across all test-related commands.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

Copy link
Contributor

@nightknighto nightknighto Apr 11, 2025

Choose a reason for hiding this comment

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

This file is unintended.

Copy link
Contributor

Choose a reason for hiding this comment

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

This file has more changes than needed, specifically formatting the file, when it should just be deleting a line. I'm not sure if that will be accepted.

Copy link
Contributor

@nightknighto nightknighto Apr 11, 2025

Choose a reason for hiding this comment

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

Generally, I'd advise looking at changes made via VS Code's Git tab and committing file by file from the UI, instead of committing all files at once. This will make it easier to detect unintended changes.

Copy link
Author

Choose a reason for hiding this comment

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

Generally, I'd advise looking at changes made via VS Code's Git tab and committing file by file from the UI, instead of committing all files at once. This will make it easier to detect unintended changes.

well great advice but after i ran the lint it was still giving me great results without changing the harmony of the code and the repo
so no problem is coming yet.

image

still if the maintainers will advice me to change something in turbo.json

I'll do!

Copy link
Author

Choose a reason for hiding this comment

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

This file has more changes than needed, specifically formatting the file, when it should just be deleting a line. I'm not sure if that will be accepted.

Let the maintainers decide that!

Copy link
Contributor

@nightknighto nightknighto left a comment

Choose a reason for hiding this comment

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

There's another line that needs to be deleted: line 21 of the root package.json.

No Need for that file it was by mistakenly added
@Aditya08Vashisht
Copy link
Author

There's another line that needs to be deleted: line 21 of the root package.json.

There are no dead scripts, no references to templates-list-validator, and no unnecessary dependencies remained for the removed feature.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] The script npm run lint:tpl:validator of generator is not working
3 participants