Skip to content

Commit 134564f

Browse files
author
mosop
committed
bump up to 0.2.0
1 parent b6dbe56 commit 134564f

File tree

4 files changed

+13
-15
lines changed

4 files changed

+13
-15
lines changed

README.md

+10-12
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ result.args # => ["bar"]
129129
result.unparsed_args # => ["baz"]
130130
```
131131

132-
### Accessible Argument
132+
### Named Argument
133133

134134
```crystal
135135
class Model < Optarg::Model
@@ -139,8 +139,12 @@ end
139139
140140
result = Model.parse(%w(/path/to/src /path/to/build and more))
141141
result.src_dir # => "/path/to/src"
142+
result.args.src_dir # => "/path/to/src"
142143
result.build_dir # => "/path/to/build"
143-
result.args # => ["and", "more"]
144+
result.args.build_dir # => "/path/to/build"
145+
result.args # => ["/path/to/src", "/path/to/build", "and", "more"]
146+
result.args.named # => {"src_dir" => "/path/to/src", "build_dir" => "/path/to/build"}
147+
result.args.nameless # => ["and", "more"]
144148
```
145149

146150
### Inheritance (Reusable Model)
@@ -180,23 +184,15 @@ Model.parse %w(--goodbye) # raises "Goodbye, world!"
180184

181185
```crystal
182186
class Profile < Optarg::Model
183-
string "--birth", required: true
184-
185-
def run
186-
puts "birth date: #{options.birth}"
187-
end
187+
string "--birthday", required: true
188188
end
189189
190-
Birthday.parse %w() # raises a Required exception.
190+
Profile.parse %w() # raises a Required exception.
191191
```
192192

193193
```crystal
194194
class Compile < Optarg::Model
195195
arg "source_file", required: true
196-
197-
def run
198-
Compiler.compile options.source_file
199-
end
200196
end
201197
202198
Compile.parse %w() # raises a Required exception.
@@ -246,6 +242,8 @@ and see [Features](#features).
246242

247243
## Release Notes
248244

245+
* v0.2.0
246+
* (Breaking Change) Model#args separates values into nameless and named.
249247
* v0.1.14
250248
* Required Arguments and Options
251249
* Minimum Length of Array

shard.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: optarg
2-
version: 0.1.14
2+
version: 0.2.0
33

44
authors:
55
- mosop

spec/features/required_arguments_and_options_spec.cr

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ module Optarg::RequiredArgumentsAndOptionsFeature
1010
end
1111

1212
class Profile < Optarg::Model
13-
string "--birth", required: true
13+
string "--birthday", required: true
1414
end
1515

1616
it "Required Options" do

src/optarg/version.cr

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
module Optarg
2-
VERSION = "0.1.14"
2+
VERSION = "0.2.0"
33
end

0 commit comments

Comments
 (0)