solargraph-dead_end 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cb198b784ad3e4cfa4d956d034c1f5485b42512b49fcac24570ed631c9ea017
-  data.tar.gz: f219d6ef309f2e6f4aa7a056a6d0db88cef722e4d7a238c70da4bbe7b631bbfd
+  metadata.gz: '0552583b0411900fe91116e4b7a9e2bf127b7adea05c52247822555dee8d4f83'
+  data.tar.gz: 4b1a99ed6552f4dbe7ea7b1519bfd4b83de8e70eb8b8d3b6f5bb3f53178e6bb1
 SHA512:
-  metadata.gz: ae278e98e68e9f054c67e9360afa73f86372e74b40280630d952a8b58db9a94ce654afee509e049b317a2f0f7e47e48b675f19c1c38e1e3466d5a268efe53b85
-  data.tar.gz: 61647b707c5ed3ce59314e13320acb48e1215abf9fdee212bbad51543a42ed3941c980bd4e6791ae9f9664b84c462415b55db4a4c074b770bef7b4e1902bb5bd
+  metadata.gz: 564dc0822e39837146de33c04390d7da4e8944df567a9f17852400a7d74412cfb3adf8b44b69d52d6aa5560a30859285251387e19760bf89e8315324856be786
+  data.tar.gz: 7171c804e0ae63d7aec369846d78ea5c6afa472bd444e15e7c262cd26b72ce49fc28cc5c2397bb0ca752e4f3787a85970c8d76f14117818ad308b17fbe2677f7

data/README.md

@@ -1,39 +1,37 @@
 # Solargraph::DeadEnd
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/solargraph/dead_end`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem is a plugin for the Solargraph language server, to report missing do(s) and end(s) using [DeadEnd](https://github.com/zombocom/dead_end) inside your editor!
 
-TODO: Delete this and the text above, and describe your gem
+Any editor that has a solargraph plugin can use it:
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'solargraph-dead_end'
-```
-
-And then execute:
+(Space)emacs with LSP mode
 
-    $ bundle install
+![emacs shows output from this solargraph plugin. It uses dead_end gem to show you where your code has a broken block](assets/emacs_multiple_errors.png)
+ 
 
-Or install it yourself as:
+VSCode with solargraph plugin
 
-    $ gem install solargraph-dead_end
 
-## Usage
+![vscode shows output from this solargraph plugin. It uses dead_end gem to show you where your code has a broken block](assets/vscode_no_hover.png)
 
-TODO: Write usage instructions here
+The highlighted lines should give you a good clue about where the problem lies. If you hover over the error you'll get even more info:
 
-## Development
+![vscode shows a hover over with even more info from this solargraph plugin. It uses dead_end gem to show you where your code has a broken block](assets/vscode_hover.png)
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+## Installation
+1. [Install solargraph](https://github.com/castwide/solargraph#installation) if you don't have it already.
+2. Add this gem:
 
-## Contributing
+`gem install solargraph-dead_end`
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/iftheshoefritz/solargraph-dead_end.
+(or include it in your gemfile if you're using solargraph in bundle mode)
 
-## License
+3. Configure your .solargraph.yml:
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+```
+reporters:
+- dead_end
+...
+plugins:
+- solargraph-dead_end
+```

data/lib/solargraph/dead_end/version.rb

@@ -2,6 +2,6 @@
 
 module Solargraph
   module DeadEnd
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/solargraph-dead_end.gemspec

@@ -5,11 +5,11 @@ require_relative "lib/solargraph/dead_end/version"
 Gem::Specification.new do |spec|
   spec.name = "solargraph-dead_end"
   spec.version = Solargraph::DeadEnd::VERSION
-  spec.authors = ["Fritz Meissner"]
-  spec.email = ["fritz.meissner@gmail.com"]
+  spec.authors = ["Fritz Meissner", "Jared Turner", "Nick Charlton"]
+  spec.email = ["fritz.meissner@gmail.com", "nick@nickcharlton.net", "jared.turner@thoughtbot.com"]
 
   spec.summary = "Solargraph DeadEnd reporter"
-  spec.description = "Solargraph DeadEnd reporter"
+  spec.description = "Solargraph DeadEnd reporter tells you where you're missing a closing `end` for your method definitions or blocks"
   spec.homepage = "https://github.com/iftheshoefritz/solargraph-dead_end"
   spec.license = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: solargraph-dead_end
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Fritz Meissner
+- Jared Turner
+- Nick Charlton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-10 00:00:00.000000000 Z
+date: 2021-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: solargraph
@@ -38,9 +40,12 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Solargraph DeadEnd reporter
+description: Solargraph DeadEnd reporter tells you where you're missing a closing
+  `end` for your method definitions or blocks
 email:
 - fritz.meissner@gmail.com
+- nick@nickcharlton.net
+- jared.turner@thoughtbot.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -53,6 +58,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- assets/emacs_multiple_errors.png
+- assets/vscode_hover.png
+- assets/vscode_no_hover.png
 - bin/console
 - bin/setup
 - lib/solargraph-dead_end.rb