solargraph-dead_end 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1cb198b784ad3e4cfa4d956d034c1f5485b42512b49fcac24570ed631c9ea017
4
- data.tar.gz: f219d6ef309f2e6f4aa7a056a6d0db88cef722e4d7a238c70da4bbe7b631bbfd
3
+ metadata.gz: '0552583b0411900fe91116e4b7a9e2bf127b7adea05c52247822555dee8d4f83'
4
+ data.tar.gz: 4b1a99ed6552f4dbe7ea7b1519bfd4b83de8e70eb8b8d3b6f5bb3f53178e6bb1
5
5
  SHA512:
6
- metadata.gz: ae278e98e68e9f054c67e9360afa73f86372e74b40280630d952a8b58db9a94ce654afee509e049b317a2f0f7e47e48b675f19c1c38e1e3466d5a268efe53b85
7
- data.tar.gz: 61647b707c5ed3ce59314e13320acb48e1215abf9fdee212bbad51543a42ed3941c980bd4e6791ae9f9664b84c462415b55db4a4c074b770bef7b4e1902bb5bd
6
+ metadata.gz: 564dc0822e39837146de33c04390d7da4e8944df567a9f17852400a7d74412cfb3adf8b44b69d52d6aa5560a30859285251387e19760bf89e8315324856be786
7
+ data.tar.gz: 7171c804e0ae63d7aec369846d78ea5c6afa472bd444e15e7c262cd26b72ce49fc28cc5c2397bb0ca752e4f3787a85970c8d76f14117818ad308b17fbe2677f7
data/README.md CHANGED
@@ -1,39 +1,37 @@
1
1
  # Solargraph::DeadEnd
2
2
 
3
- 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.
3
+ 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!
4
4
 
5
- TODO: Delete this and the text above, and describe your gem
5
+ Any editor that has a solargraph plugin can use it:
6
6
 
7
- ## Installation
8
-
9
- Add this line to your application's Gemfile:
10
-
11
- ```ruby
12
- gem 'solargraph-dead_end'
13
- ```
14
-
15
- And then execute:
7
+ (Space)emacs with LSP mode
16
8
 
17
- $ bundle install
9
+ ![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)
10
+
18
11
 
19
- Or install it yourself as:
12
+ VSCode with solargraph plugin
20
13
 
21
- $ gem install solargraph-dead_end
22
14
 
23
- ## Usage
15
+ ![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)
24
16
 
25
- TODO: Write usage instructions here
17
+ 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:
26
18
 
27
- ## Development
19
+ ![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)
28
20
 
29
- 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.
30
-
31
- 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).
21
+ ## Installation
22
+ 1. [Install solargraph](https://github.com/castwide/solargraph#installation) if you don't have it already.
23
+ 2. Add this gem:
32
24
 
33
- ## Contributing
25
+ `gem install solargraph-dead_end`
34
26
 
35
- Bug reports and pull requests are welcome on GitHub at https://github.com/iftheshoefritz/solargraph-dead_end.
27
+ (or include it in your gemfile if you're using solargraph in bundle mode)
36
28
 
37
- ## License
29
+ 3. Configure your .solargraph.yml:
38
30
 
39
- The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
31
+ ```
32
+ reporters:
33
+ - dead_end
34
+ ...
35
+ plugins:
36
+ - solargraph-dead_end
37
+ ```
Binary file
Binary file
Binary file
@@ -2,6 +2,6 @@
2
2
 
3
3
  module Solargraph
4
4
  module DeadEnd
5
- VERSION = "0.1.0"
5
+ VERSION = "0.2.0"
6
6
  end
7
7
  end
@@ -5,11 +5,11 @@ require_relative "lib/solargraph/dead_end/version"
5
5
  Gem::Specification.new do |spec|
6
6
  spec.name = "solargraph-dead_end"
7
7
  spec.version = Solargraph::DeadEnd::VERSION
8
- spec.authors = ["Fritz Meissner"]
9
- spec.email = ["fritz.meissner@gmail.com"]
8
+ spec.authors = ["Fritz Meissner", "Jared Turner", "Nick Charlton"]
9
+ spec.email = ["fritz.meissner@gmail.com", "nick@nickcharlton.net", "jared.turner@thoughtbot.com"]
10
10
 
11
11
  spec.summary = "Solargraph DeadEnd reporter"
12
- spec.description = "Solargraph DeadEnd reporter"
12
+ spec.description = "Solargraph DeadEnd reporter tells you where you're missing a closing `end` for your method definitions or blocks"
13
13
  spec.homepage = "https://github.com/iftheshoefritz/solargraph-dead_end"
14
14
  spec.license = "MIT"
15
15
  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
metadata CHANGED
@@ -1,14 +1,16 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: solargraph-dead_end
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Fritz Meissner
8
+ - Jared Turner
9
+ - Nick Charlton
8
10
  autorequire:
9
11
  bindir: exe
10
12
  cert_chain: []
11
- date: 2021-12-10 00:00:00.000000000 Z
13
+ date: 2021-12-13 00:00:00.000000000 Z
12
14
  dependencies:
13
15
  - !ruby/object:Gem::Dependency
14
16
  name: solargraph
@@ -38,9 +40,12 @@ dependencies:
38
40
  - - ">="
39
41
  - !ruby/object:Gem::Version
40
42
  version: '0'
41
- description: Solargraph DeadEnd reporter
43
+ description: Solargraph DeadEnd reporter tells you where you're missing a closing
44
+ `end` for your method definitions or blocks
42
45
  email:
43
46
  - fritz.meissner@gmail.com
47
+ - nick@nickcharlton.net
48
+ - jared.turner@thoughtbot.com
44
49
  executables: []
45
50
  extensions: []
46
51
  extra_rdoc_files: []
@@ -53,6 +58,9 @@ files:
53
58
  - LICENSE.txt
54
59
  - README.md
55
60
  - Rakefile
61
+ - assets/emacs_multiple_errors.png
62
+ - assets/vscode_hover.png
63
+ - assets/vscode_no_hover.png
56
64
  - bin/console
57
65
  - bin/setup
58
66
  - lib/solargraph-dead_end.rb