Add support for --ignore-validation

[neilenns]

Fixes #121

Requires elgatosf/cli#59 to get released before this can merge.

Summary by CodeRabbit

• New Features
  • Added support for an ignoreValidation option, allowing users to bypass validation errors when packaging.
• Documentation
  • Updated documentation to include the new ignoreValidation option, with a cautionary note about its use.

[coderabbitai]

Warning

Rate limit exceeded

@neilenns has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 21 minutes and 48 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 2b301db and c57f2e2.

⛔ Files ignored due to path filters (2)

• dist/index.js is excluded by !**/dist/**
• dist/index.js.map is excluded by !**/dist/**, !**/*.map

📒 Files selected for processing (2)

• README.md (1 hunks)
• src/main.js (1 hunks)

Walkthrough

A new configuration option, ignoreValidation, has been introduced. Documentation in the README was updated to describe this option, including its default value and a cautionary note. The main code logic was modified to append 'ignore-validation' to the command arguments when this option is enabled.

Changes

File(s)	Change Summary
README.md	Added documentation for the ignoreValidation configuration option.
src/main.js	Added logic to support the ignoreValidation input and update command args.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant MainJS
    participant StreamdeckPack

    User->>MainJS: Provide configuration (may include ignoreValidation)
    MainJS->>MainJS: Check if ignoreValidation is true
    alt ignoreValidation is true
        MainJS->>MainJS: Append 'ignore-validation' to args
    end
    MainJS->>StreamdeckPack: Execute with args

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Add support for --ignore-validation (#121)	✅
Document the ignoreValidation option (#121)	✅

Possibly related issues

• Add support for --ignore-validation #121: The changes directly implement the requested ignoreValidation option for the streamdeck pack command.

Poem

A bunny hopped and wrote with glee,
"Ignore validation? Now it's easy as can be!
With docs updated and logic in place,
Your commands will run at a quicker pace.
But hop with care, as warnings say—
Use this flag the cautious way!" 🐇✨

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b379f6b and 2b301db.

📒 Files selected for processing (2)

• README.md (1 hunks)
• src/main.js (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Lint Codebase

🔇 Additional comments (1)

README.md (1)

51-51: Good documentation with appropriate caution.

The documentation clearly describes the new ignoreValidation option with an appropriate warning about its use. The table formatting is consistent with existing entries and the default value is correctly specified.