Skip to content

refactor(taskfiles): Change lint task -check and -fix suffixes to prefixes; Rename yml to yaml in relevant tasks.#749

Merged
davidlion merged 2 commits into
y-scope:mainfrom
davidlion:task-rename
Mar 7, 2025
Merged

refactor(taskfiles): Change lint task -check and -fix suffixes to prefixes; Rename yml to yaml in relevant tasks.#749
davidlion merged 2 commits into
y-scope:mainfrom
davidlion:task-rename

Conversation

@davidlion

@davidlion davidlion commented Mar 7, 2025 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Member

Description

As title says.

Checklist

  • The PR satisfies the contribution guidelines.
  • This is a breaking change and that has been indicated in the PR title, OR this isn't a
    breaking change.
  • Necessary docs have been updated, OR no docs need to be updated.

Validation performed

Tasks tested locally and with CI.

Summary by CodeRabbit

  • Chore
    • Refined naming conventions for linting tasks to improve consistency and clarity in the documentation and command usage.

@davidlion davidlion requested a review from kirkrodrigues March 7, 2025 16:17
@davidlion davidlion requested a review from a team as a code owner March 7, 2025 16:17
@coderabbitai

coderabbitai Bot commented Mar 7, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Walkthrough

The pull request updates the lint-tasks.yml file by renaming task signatures and associated commands for consistency and clarity. The tasks for checking and fixing code for C++, JavaScript, Python, and YAML have been renamed to a more descriptive format. The underlying functionality remains unchanged.

Changes

File Change Summary
lint-tasks.yml Renamed tasks for checking and fixing: cpp-check → check-cpp, cpp-fix → fix-cpp, js-check → check-js, js-fix → fix-js, py-check → check-py, py-fix → fix-py; updated YAML task name from yml to yaml; and renamed format-specific commands: cpp-format-check → check-cpp-format, cpp-format-fix → fix-cpp-format.
docs/src/dev-guide/components-log-viewer-webui.md Updated linting commands: task lint:js-check → task lint:check-js, task lint:js-fix → task lint:fix-js.
docs/src/dev-guide/components-webui.md Updated linting commands: lint:js-check → lint:check-js, lint:js-fix → lint:fix-js.

Possibly related PRs

Suggested reviewers

  • kirkrodrigues
📜 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 1b86895 and 574b465.

📒 Files selected for processing (2)
  • docs/src/dev-guide/components-log-viewer-webui.md (1 hunks)
  • docs/src/dev-guide/components-webui.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: lint-check (ubuntu-latest)
🔇 Additional comments (4)
docs/src/dev-guide/components-webui.md (2)

66-67: Updated lint check command is correctly renamed.
The new task command lint:check-js now uses the prefix format as required by the PR objectives. This improves clarity and consistency across our documentation.

74-75: Updated lint fix command is correctly renamed.
The renaming to lint:fix-js meets the new naming convention, ensuring consistency with our linting task requirements.

docs/src/dev-guide/components-log-viewer-webui.md (2)

60-61: Lint check command updated consistently.
The task command has been changed to lint:check-js, aligning with the revised naming conventions and ensuring documentation consistency.

66-67: Lint fix command updated consistently.
Changing the command to lint:fix-js maintains consistency with our new naming approach for lint tasks, and it is clearly reflected here in the documentation.

🪧 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 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.

kirkrodrigues
kirkrodrigues requested changes Mar 7, 2025
View reviewed changes

@kirkrodrigues kirkrodrigues left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

There are still some instances of js-check/fix in the docs.

@kirkrodrigues

kirkrodrigues commented Mar 7, 2025

Copy link
Copy Markdown
Member

Should also mention the change from yml to yaml in the PR title.

@davidlion davidlion changed the title refactor(taskfiles): Change lint task -check and -fix suffixes to prefixes. refactor(taskfiles): Change lint task -check and -fix suffixes to prefixes; Rename yml to yaml in relevant tasks. Mar 7, 2025
@davidlion davidlion requested a review from kirkrodrigues March 7, 2025 16:36
@davidlion davidlion merged commit ea2b5b0 into y-scope:main Mar 7, 2025
@davidlion davidlion deleted the task-rename branch March 7, 2025 16:47
@coderabbitai coderabbitai Bot mentioned this pull request Mar 10, 2025
Merged
3 tasks
@coderabbitai coderabbitai Bot mentioned this pull request Apr 16, 2025
Merged
3 tasks
junhaoliao pushed a commit to junhaoliao/clp that referenced this pull request May 17, 2026
@davidlion
refactor(taskfiles): Change lint task -check and -fix suffixes to…
5b79f49 
… prefixes; Rename `yml` to `yaml` in relevant tasks. (y-scope#749)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kirkrodrigues kirkrodrigues kirkrodrigues approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@davidlion @kirkrodrigues