-
Notifications
You must be signed in to change notification settings - Fork 45
feat: documentation for console arguments #132
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -93,11 +93,67 @@ When you write console commands, it's typical to collect user input through `arg | |||||||||
| Follow the arguments after the command: | ||||||||||
|
|
||||||||||
| ```shell | ||||||||||
| go run . artisan send:emails NAME EMAIL | ||||||||||
| go run . artisan send:emails SUBJECT EMAIL_1 EMAIL_2 | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| Definition: | ||||||||||
|
|
||||||||||
| ```go | ||||||||||
| // send:emails <subject> <email...> | ||||||||||
| func (receiver *SendEmails) Extend() command.Extend { | ||||||||||
| return command.Extend{ | ||||||||||
| Arguments: []command.Argument{ | ||||||||||
| &command.ArgumentString{ | ||||||||||
| Name: "subject", | ||||||||||
| Usage: "subject of email", | ||||||||||
| Required: true, | ||||||||||
| }, | ||||||||||
| &command.ArgumentStringSlice{ | ||||||||||
| Name: "emails", | ||||||||||
| Usage: "target emails", | ||||||||||
| Min: 1, | ||||||||||
| Max: -1, | ||||||||||
| }, | ||||||||||
| }, | ||||||||||
| } | ||||||||||
| } | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| Supported agrument types : `ArgumentFloat32`, `ArgumentFloat64`, `ArgumentInt`, `ArgumentInt8`, `ArgumentInt16`, `ArgumentInt32`, `ArgumentInt64`, `ArgumentString`, `ArgumentUint`, `ArgumentUint8`, `ArgumentUint16`, `ArgumentUint32`, `ArgumentUint64`, `ArgumentTimestamp`, `ArgumentFloat32Slice`, `ArgumentFloat64Slice`, `ArgumentIntSlice`, `ArgumentInt8Slice`, `ArgumentInt16Slice`, `ArgumentInt32Slice`, `ArgumentInt64Slice`, `ArgumentStringSlice`, `ArgumentUintSlice`, `ArgumentUint8Slice`, `ArgumentUint16Slice`, `ArgumentUint32Slice`, `ArgumentUint64Slice`, `ArgumentTimestampSlice` | ||||||||||
|
|
||||||||||
| Argument types with single value support next fields: | ||||||||||
|
|
||||||||||
| ```go | ||||||||||
| Name string // the name of this argument | ||||||||||
| Value T // the default value of this argument | ||||||||||
| Usage string // the usage text to show | ||||||||||
| Required bool // if this argument is required | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| Slice argument types fields: | ||||||||||
|
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.
Suggested change
|
||||||||||
|
|
||||||||||
| ```go | ||||||||||
| Name string // the name of this argument | ||||||||||
| Value T // the default value of this argument | ||||||||||
| Usage string // the usage text to show | ||||||||||
| Min int // the min num of occurrences of this argument | ||||||||||
| Max int // the max num of occurrences of this argument, set to -1 for unlimited | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| Timestamp arguments additionally supports `Layouts []string` field, that should be filled with [supported layouts](https://pkg.go.dev/time#pkg-constants) | ||||||||||
|
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.
Suggested change
|
||||||||||
|
|
||||||||||
| Get arguments: | ||||||||||
|
|
||||||||||
| ```go | ||||||||||
| func (receiver *SendEmails) Handle(ctx console.Context) error { | ||||||||||
| subject := ctx.ArgumentString("subject"))) | ||||||||||
| emails := ctx.ArgumentStringSlice("emails"))) | ||||||||||
|
|
||||||||||
| return nil | ||||||||||
| } | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| Alternatively, it is possible to access arguments directly: | ||||||||||
| ```go | ||||||||||
| func (receiver *SendEmails) Handle(ctx console.Context) error { | ||||||||||
| name := ctx.Argument(0) | ||||||||||
|
|
||||||||||
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 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.
updated