Add a few rules to help with shortcuts #13
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR adds three new ESLint rules to help developers write better keyboard shortcuts in Raycast extensions. The rules enforce best practices around using common shortcuts, avoiding reserved shortcuts, and handling platform-specific shortcuts correctly.
Key Changes:
- Adds
prefer-common-shortcutrule that suggests usingKeyboard.Shortcut.Common.*constants instead of literal shortcut objects - Adds
no-reserved-shortcutrule to warn when shortcuts conflict with Raycast's reserved system shortcuts - Adds
no-ambiguous-platform-shortcutrule to detect ambiguous shortcuts in multi-platform extensions
Reviewed Changes
Copilot reviewed 12 out of 14 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
| lib/rules/prefer-common-shortcut.ts | Implements rule to suggest Common shortcuts with auto-fix support |
| lib/rules/no-reserved-shortcut.ts | Implements rule to detect reserved shortcut conflicts |
| lib/rules/no-ambiguous-platform-shortcut.ts | Implements rule to detect platform-ambiguous shortcuts in multi-platform extensions |
| tests/prefer-common-shortcut.test.ts | Test suite for prefer-common-shortcut rule with valid/invalid cases and auto-fix verification |
| tests/no-reserved-shortcut.test.ts | Test suite for no-reserved-shortcut rule |
| tests/no-ambiguous-platform-shortcut.test.ts | Test suite for no-ambiguous-platform-shortcut rule with multi-platform fixture testing |
| tests/fixtures/single-platform/package.json | Test fixture simulating single-platform extension |
| tests/fixtures/multi-platform/package.json | Test fixture simulating multi-platform extension |
| lib/index.ts | Registers new rules and adds them to recommended config |
| docs/rules/prefer-common-shortcut.md | Documentation for prefer-common-shortcut rule |
| docs/rules/no-reserved-shortcut.md | Documentation for no-reserved-shortcut rule |
| docs/rules/no-ambiguous-platform-shortcut.md | Documentation for no-ambiguous-platform-shortcut rule |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| defaultOptions: [], | ||
| create(context) { | ||
| const hasMultiPlatform = hasMultiPlatformConfig( | ||
| (context as TSESLint.RuleContext<any, any>).filename |
There was a problem hiding this comment.
Type assertion as TSESLint.RuleContext<any, any> bypasses type safety. The context parameter should already have the correct type from the rule definition. Using any here could mask type errors and should be avoided.
Suggested change
| (context as TSESLint.RuleContext<any, any>).filename | |
| context.filename |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.