-
Notifications
You must be signed in to change notification settings - Fork 128
chore: update prep for releasing ESM and yargs-based CLI as version 2.0 #806
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
Open
rossiam
wants to merge
1
commit into
SmartThingsCommunity:main
Choose a base branch
from
rossiam:final-yargs-esm-release-prep
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "@smartthings/cli": major | ||
| --- | ||
|
|
||
| refactor to use yargs |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| # TypeScript Project Coding Standards | ||
|
|
||
| You are an expert TypeScript developer. When generating code for this project, adhere to the following naming conventions and architectural rules. | ||
|
|
||
| ## General Guidelines | ||
| - **Respond Specifically to Prompts**: Never do things not explicitly requested. | ||
|
|
||
| ## Variable Naming Rules | ||
| - **No Single-Letter Variables:** Never use single-letter variable names (e.g., `i`, `e`, `v`, `k`, `v`). | ||
| - **Descriptive Naming:** Use clear, descriptive names that convey the intent and data type of the variable. | ||
| - **Loop Iterators:** Instead of `i`, use `index`. Instead of `e`, use a specific name like `user` or `account`. | ||
| - **Error Handling:** Use `error` instead of `e` in catch blocks. | ||
|
|
||
| ## TypeScript Best Practices | ||
| - **Strict Typing:** Avoid the `any` type if at all possible. Use `unknown` if the type is truly dynamic, or define proper `Interfaces` and `Types`. | ||
| - **Functional Approach:** Prefer `map`, `filter`, and `reduce` over traditional `for` loops where readability is maintained. | ||
| - **Explicit Returns:** Always define explicit return types for functions to ensure type safety across the boundary. | ||
|
|
||
| ## Examples | ||
|
|
||
| ### Incorrect | ||
| ```typescript | ||
| const data = list.map(x => x.id); | ||
|
|
||
| try { | ||
| // ... | ||
| } catch (e) { | ||
| console.error(e); | ||
| } | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should there be a "Correct" example as well? Or is that just extra useless tokens for the AI to process? |
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's an extra
vhere.