semverve 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 436e6dece23a174761d954e1c1efc74d95d68b8b47d82f876bb5b785eb204748
-  data.tar.gz: 62e9b4496586062f8e03f71d0838ddd510e5e42faa200d10fbef2560f214fa4c
+  metadata.gz: b04f97b571e0eed652d155221cddb5afe06d703f2a27546f15c11e3d26a3d214
+  data.tar.gz: 6c824db22d1967e9daa8de369ca199b6cc7969f6ab2179933600fbba34d1aa6e
 SHA512:
-  metadata.gz: cc055ab321689871de38a8fc0276a8cc85011ea9c7765c7844d97c71962bba2765cd867cd9dbb96236b11ea695edc63e8289c087fd5a90482ab1ea376d82981a
-  data.tar.gz: 8a4cbb86d9548b4aeeedf94bd883e300532a6d4c062dc1c1c1170d412ae5bb94a4fe50bdfbc29098482a51632a194ef32be93cee35ef8a5219d77f5957d54c98
+  metadata.gz: 31208572bd96d1d1bb00537673e9960594501a2b4226f821114d8cb624965fd0cd7282722d6284cf0666f80a908706174a3ca3d0bb4109a3b18dc882e9a26ecd
+  data.tar.gz: 8deb952db13cfdf0f8a13fbbcffb07afc23c402ece2efc3d50899d4158ea7455a6bedc993cb79c9d3de8dfc83c8142981f87f52777ee79a8dba1c1b09bc58dcd

data/CONTRIBUTING.md

@@ -100,6 +100,27 @@ When changing behavior, update the README at the same time. The README is the
 primary user guide, so examples should match real task names, configuration
 names, defaults, and output.
 
+## Rake Task Interface Design
+Semverve should feel natural from a shell while staying Rake-native. Prefer
+Rake task arguments for direct task inputs:
+
+```sh
+bundle exec rake 'semverve:set[x.y.z]'
+bundle exec rake 'semverve:generate[simple,force]'
+```
+
+For tasks with more than one optional value, prefer meaning-bearing tokens over
+strict positional placeholders. For example, `semverve:generate` treats semantic
+versions as the generated version, `module` or `simple` as the format, and
+`force` as the overwrite mode. That keeps invocations like
+`rake 'semverve:generate[simple]'` and `rake 'semverve:generate[force]'`
+readable without requiring awkward empty slots.
+
+Reserve environment variables for cross-cutting runtime toggles that compose
+across related tasks, such as `SEMVERVE_REPORT_IGNORED=true rake
+semverve:check`. Avoid generic environment variables like `VERSION`, `FORMAT`,
+or `FORCE`; they can collide with a user's shell, CI, or parent build process.
+
 ## Versioning and Release Checks
 Semverve uses Semverve to maintain itself, which doubles as useful
 smoke-testing. The project Rakefile requires `lib/semverve/task` and installs

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    semverve (0.2.0)
+    semverve (0.2.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -133,6 +133,7 @@ Semverve tasks use Rake task arguments for values:
 ```sh
 rake 'semverve:set[1.2.3]'
 rake 'semverve:generate[1.0.0,simple]'
+rake 'semverve:generate[simple]'
 rake 'semverve:generate[force]'
 ```
 
@@ -250,6 +251,7 @@ Generate a specific version or format:
 
 ```sh
 rake 'semverve:generate[1.0.0,simple]'
+rake 'semverve:generate[simple]'
 ```
 
 Generation fails if the target file already exists. To replace it:
@@ -258,11 +260,14 @@ Generation fails if the target file already exists. To replace it:
 rake 'semverve:generate[force]'
 ```
 
-`semverve:generate` accepts optional `version` and `format` arguments. Add a
-`force` token to overwrite an existing version file:
+`semverve:generate` accepts optional tokens for version, format, and force.
+Token order does not matter: semantic versions set the generated version,
+`module` or `simple` sets the format, and `force` overwrites an existing version
+file.
 
 ```sh
 rake 'semverve:generate[1.0.0,force]'
+rake 'semverve:generate[simple,force]'
 rake 'semverve:generate[1.0.0,simple,force]'
 ```
 
@@ -620,6 +625,39 @@ For release CI, run the release check before building or pushing:
 bundle exec rake semverve:check:release build
 ```
 
+## Vim
+While there's no official vim support (yet), you can add the following to
+`~/.vim/plugin/semverve.vim`.
+
+```vim
+command! -bang SemverveAudit call <SID>semverve_audit(<bang>0)
+function! s:semverve_audit(report_ignored) abort
+  let l:old_efm = &errorformat
+  try
+    let &errorformat = '%f:%l:%c:%m'
+    let l:string = ""
+    if !a:report_ignored
+      let l:string .= 'SEMVERVE_REPORT_IGNORED=true '
+    endif
+    let l:string .= 'bundle exec rake semverve:check 2>/dev/null'
+    cexpr systemlist(l:string)
+    if v:shell_error != 0
+      copen
+    else
+      cclose
+      echo 'Semverve checks passed.'
+    endif
+  finally
+    let &errorformat = l:old_efm
+  endtry
+endfunction
+```
+
+You can then call `:SemverveAudit`, which will call `bundle exec rake
+semverve:check`, and `:SemverveAudit!` which will call the same command with
+`SEMVERVE_REPORT_IGNORED=true`, and populate and open the quickfix list if any
+offenses are found.
+
 ## Reporting Bugs and Requesting Features
 If you have an idea or find a bug, please [create an
 issue](https://github.com/evanthegrayt/semverve/issues/new). Just make sure

data/lib/semverve/task.rb

@@ -366,17 +366,37 @@ module Semverve
     #
     # @return [Hash]
     def generate_options(args)
-      values = args.to_a
-      force = values.delete("force")
-      if values.length > 2
-        raise Error, "Run rake 'semverve:generate[VERSION,FORMAT,force]'."
+      args.to_a.each_with_object({force: false}) do |value, options|
+        assign_generate_option(value, options)
       end
+    end
 
-      {
-        version: values[0],
-        format: values[1],
-        force: !force.nil?
-      }
+    ##
+    # Assigns a single +semverve:generate+ token by meaning.
+    #
+    # @param [String] value
+    # @param [Hash] options
+    #
+    # @return [void]
+    def assign_generate_option(value, options)
+      case value
+      when nil, ""
+        nil
+      when "force"
+        raise Error, "Duplicate generate option force." if options[:force]
+
+        options[:force] = true
+      when SemanticVersion::PATTERN
+        raise Error, "Duplicate generate version #{value.inspect}." if options[:version]
+
+        options[:version] = value
+      when "module", "simple"
+        raise Error, "Duplicate generate format #{value.inspect}." if options[:format]
+
+        options[:format] = value
+      else
+        raise Error, "Unknown generate option #{value.inspect}. Use a semantic version, module, simple, or force."
+      end
     end
 
     ##

data/lib/semverve/version.rb

@@ -21,7 +21,7 @@ module Semverve
     # Patch version.
     #
     # @return [Integer]
-    PATCH = 0
+    PATCH = 1
 
     module_function
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: semverve
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Evan Gray