neilotoole/sq
1
1
Fork 0
mirror of https://github.com/neilotoole/sq.git synced 2024-11-28 03:53:07 +03:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Doc cleanup

Browse Source
This commit is contained in:
neilotoole 2023-05-07 00:29:42 -06:00
parent 11525eae10
commit 7b3f9f9dab
4 changed files with 14 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
CHANGELOG.md
View File

@ -7,14 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
Breaking changes are annotated with ☢️. Breaking changes are annotated with ☢️.
## Upcoming ## [v0.34.0] - 2023-05-07
This release significantly overhauls `sq`'s config mechanism ([#199]). There This release significantly overhauls `sq`'s config mechanism ([#199]).
are several minor breaking changes ☢️. For an overview, see the new [config docs](https://sq.io/docs/config).
Alas, this release has several minor breaking changes ☢️.
### Added ### Added
- `sq config get` prints config. DOCS - `sq config ls` shows config.
- `sq config get` gets individual config option.
- `sq config set` sets config values. - `sq config set` sets config values.
- `sq config edit` edits config. - `sq config edit` edits config.
- Editor can be specified via `$EDITOR` or `$SQ_EDITOR`. - Editor can be specified via `$EDITOR` or `$SQ_EDITOR`.
@ -452,3 +455,4 @@ make working with lots of sources much easier.
[v0.31.0]: https://github.com/neilotoole/sq/compare/v0.30.0...v0.31.0 [v0.31.0]: https://github.com/neilotoole/sq/compare/v0.30.0...v0.31.0
[v0.32.0]: https://github.com/neilotoole/sq/compare/v0.31.0...v0.32.0 [v0.32.0]: https://github.com/neilotoole/sq/compare/v0.31.0...v0.32.0
[v0.33.0]: https://github.com/neilotoole/sq/compare/v0.32.0...v0.33.0 [v0.33.0]: https://github.com/neilotoole/sq/compare/v0.32.0...v0.33.0
[v0.34.0]: https://github.com/neilotoole/sq/compare/v0.33.0...v0.34.0

5
cli/cmd_config_edit.go
View File

@ -35,8 +35,9 @@ func newConfigEditCmd() *cobra.Command {
return execConfigEditSource(cmd, args) return execConfigEditSource(cmd, args)
}, },
Short: "Edit config or source options", Short: "Edit config in $EDITOR",
Long: `Edit config or source options in the editor specified in envar $SQ_EDITOR or $EDITOR.`, Long: `Edit config or source options in the editor specified
in envar $SQ_EDITOR or $EDITOR.`,
Example: ` # Edit default options Example: ` # Edit default options
$ sq config edit $ sq config edit

4
cli/cmd_config_get.go
View File

@ -10,8 +10,8 @@ import (
func newConfigGetCmd() *cobra.Command { func newConfigGetCmd() *cobra.Command {
cmd := &cobra.Command{ cmd := &cobra.Command{
Use: "get", Use: "get",
Short: "Show config", Short: "Show config option",
Long: `Show config. By default, only explicitly set options are shown. Long: `Show config option. By default, only explicitly set options are shown.
Use the -v flag to see all options. When flag --src is provided, show config Use the -v flag to see all options. When flag --src is provided, show config
just for that source.`, just for that source.`,
Args: cobra.ExactArgs(1), Args: cobra.ExactArgs(1),

2
cli/cmd_config_ls.go
View File

@ -10,7 +10,7 @@ import (
func newConfigListCmd() *cobra.Command { func newConfigListCmd() *cobra.Command {
cmd := &cobra.Command{ cmd := &cobra.Command{
Use: "ls [--src @HANDLE]", Use: "ls [--src @HANDLE]",
Short: "Show config", Short: "List config options",
Long: `Show config. By default, only explicitly set options are shown. Long: `Show config. By default, only explicitly set options are shown.
Use the -v flag to see all options. When flag --src is provided, show config Use the -v flag to see all options. When flag --src is provided, show config
just for that source.`, just for that source.`,