TrueCloudLab/rclone
16
0
Fork 2
Code Issues Pull requests 1 Projects Releases Packages Wiki Activity Actions 1

fs: add Groups and FieldName to Option

Browse source
This commit is contained in:
Nick Craig-Wood 2024-07-02 10:38:54 +01:00
parent 8d72698d5a
commit 671a15f65f
2 changed files with 5 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
fs/fs_test.go
View file

@ -232,6 +232,7 @@ func TestOptionMarshalJSON(t *testing.T) {
assert.NoError(t, err) assert.NoError(t, err)
require.Equal(t, `{ require.Equal(t, `{
"Name": "case_insensitive", "Name": "case_insensitive",
"FieldName": "",
"Help": "", "Help": "",
"Provider": "", "Provider": "",
"Default": false, "Default": false,

4
fs/registry.go
View file

@ -149,6 +149,8 @@ const (
// //
// This also describes command line options and environment variables. // This also describes command line options and environment variables.
// //
// It is also used to describe options for the API.
//
// To create a multiple-choice option, specify the possible values // To create a multiple-choice option, specify the possible values
// in the Examples property. Whether the option's value is required // in the Examples property. Whether the option's value is required
// to be one of these depends on other properties: // to be one of these depends on other properties:
@ -159,7 +161,9 @@ const (
// and do not set Default. // and do not set Default.
type Option struct { type Option struct {
Name string // name of the option in snake_case Name string // name of the option in snake_case
FieldName string // name of the field used in the rc JSON - will be auto filled normally
Help string // help, start with a single sentence on a single line that will be extracted for command line help Help string // help, start with a single sentence on a single line that will be extracted for command line help
Groups string `json:",omitempty"` // groups this option belongs to - comma separated string for options classification
Provider string // set to filter on provider Provider string // set to filter on provider
Default interface{} // default value, nil => "", if set (and not to nil or "") then Required does nothing Default interface{} // default value, nil => "", if set (and not to nil or "") then Required does nothing
Value interface{} // value to be set by flags Value interface{} // value to be set by flags