From 51eb9d930576f6856aa62988891218e1af390535 Mon Sep 17 00:00:00 2001 From: lowlifeplanet <44231597+lowlifeplanet@users.noreply.github.com> Date: Sat, 23 Mar 2019 04:26:43 -0700 Subject: [PATCH 1/5] Fixed errors in README.md --- README.md | 33 +++++++++++++++------------------ 1 file changed, 15 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 99f42f0..694d723 100644 --- a/README.md +++ b/README.md @@ -6,46 +6,43 @@ Fylla, the Norse word for `complete`, is an autocompletion script generator for the [Thor](whatisthor.com) framework. -It currently generates zsh completion scripts, but will soon have support for bash scripts as well. +Fylla currently generates zsh completion scripts. Support for bash scripts will be added. ## Installation -Add this line to your application's Gemfile: +Add the following line to your application's Gemfile: ```ruby gem 'fylla' ``` -And then execute: +execute using the following command: $ bundle -Or install it yourself as: +Or install fylla manually: $ gem install fylla ## Usage -`Fylla` must be loaded before `Thor.start` is called in order for it to be used. +`Fylla` must be loaded before `Thor.start` can be used. General use case will be to create a new subcommand or option that calls `Fylla.zsh_completion(self)` -`Fylla#zsh_completion` returns a string containing the entire zsh completion script, that you can -use to do what you see fit. +`Fylla#zsh_completion` returns a string containing the entire zsh completion script and bash completion script. Scripts are ready for use after `Fylla#zsh_completion` returns. -Same for bash completion. - -The only requirement for calling `Fylla.zsh_completion(self)` is that `Thor` has loaded all commands/options/etc. +`Thor` is required to load commands/options/etc before calling `Fylla.zsh_completion(self)`. ## Development -After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. +After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. Run `bin/console` for an interactive prompt that allows experimentation. -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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). +To install the 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). ## Contributing -Bug reports and pull requests are welcome on GitHub at https://github.com/snowe2010/fylla. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. +Bug reports and pull requests are welcomed on GitHub at https://github.com/snowe2010/fylla. Fylla is intended to be a safe, welcoming space for collaboration. Contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. ## License @@ -53,11 +50,11 @@ The gem is available as open source under the terms of the [MIT License](https:/ ## Code of Conduct -Everyone interacting in the Fylla project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/fylla/blob/master/CODE_OF_CONDUCT.md). +People interacting in the Fylla project’s codebases, issue trackers, chat rooms and mailing lists are expected to follow the [code of conduct](https://github.com/[USERNAME]/fylla/blob/master/CODE_OF_CONDUCT.md). ## Todo list -* use desc if banner isn't present -* add completion parameter to Option class to use by default -* allow zsh_completion and bash_completion to be called from _anywhere_. This might be impossible. -* allow supplying custom templates +* Use description if banner isn't present, +* add completion parameter to Option class to use by default, +* allow zsh_completion and bash_completion to be called from _anywhere_, and +* allow supplying custom templates. From 80c429692bdc65d7bf3c7531ca8246b157c727c2 Mon Sep 17 00:00:00 2001 From: lowlifeplanet <44231597+lowlifeplanet@users.noreply.github.com> Date: Tue, 26 Mar 2019 16:12:04 -0700 Subject: [PATCH 2/5] Updated README.md Add requested changes. --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 694d723..2b069bb 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,6 @@ Fylla, the Norse word for `complete`, is an autocompletion script generator for the [Thor](whatisthor.com) framework. -Fylla currently generates zsh completion scripts. Support for bash scripts will be added. - ## Installation Add the following line to your application's Gemfile: @@ -16,7 +14,7 @@ Add the following line to your application's Gemfile: gem 'fylla' ``` -execute using the following command: +And execute using the following command: $ bundle @@ -26,17 +24,19 @@ Or install fylla manually: ## Usage -`Fylla` must be loaded before `Thor.start` can be used. +Fylla must be loaded before `Thor.start` (the method) is called, in order for Fylla to be callable, else no completions will be generated. General use case will be to create a new subcommand or option that calls `Fylla.zsh_completion(self)` `Fylla#zsh_completion` returns a string containing the entire zsh completion script and bash completion script. Scripts are ready for use after `Fylla#zsh_completion` returns. -`Thor` is required to load commands/options/etc before calling `Fylla.zsh_completion(self)`. +The only requirement for calling `Fylla.zsh_completion(self)` is for `Thor` to load all commands/options/etc.. ## Development -After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. Run `bin/console` for an interactive prompt that allows experimentation. +Same procedure works for bash completion. + +After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. To install the 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). @@ -54,7 +54,7 @@ People interacting in the Fylla project’s codebases, issue trackers, chat room ## Todo list -* Use description if banner isn't present, -* add completion parameter to Option class to use by default, -* allow zsh_completion and bash_completion to be called from _anywhere_, and -* allow supplying custom templates. +* Use description if banner isn't present +* add completion parameter to Option class to use by default +* allow zsh_completion and bash_completion to be called from _anywhere_ +* allow supplying custom templates From 8e2d9926fb23d4725e6c87e1577452612f39f6e0 Mon Sep 17 00:00:00 2001 From: lowlifeplanet <44231597+lowlifeplanet@users.noreply.github.com> Date: Tue, 26 Mar 2019 16:14:56 -0700 Subject: [PATCH 3/5] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2b069bb..be52517 100644 --- a/README.md +++ b/README.md @@ -30,12 +30,12 @@ General use case will be to create a new subcommand or option that calls `Fylla. `Fylla#zsh_completion` returns a string containing the entire zsh completion script and bash completion script. Scripts are ready for use after `Fylla#zsh_completion` returns. +Same for bash completion. + The only requirement for calling `Fylla.zsh_completion(self)` is for `Thor` to load all commands/options/etc.. ## Development -Same procedure works for bash completion. - After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. To install the 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). From 4621b8e97db0a09a2aca04b5954feb399f178e9a Mon Sep 17 00:00:00 2001 From: lowlifeplanet <44231597+lowlifeplanet@users.noreply.github.com> Date: Tue, 26 Mar 2019 16:17:18 -0700 Subject: [PATCH 4/5] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index be52517..83dff6f 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ People interacting in the Fylla project’s codebases, issue trackers, chat room ## Todo list -* Use description if banner isn't present +* Use desc if banner isn't present * add completion parameter to Option class to use by default -* allow zsh_completion and bash_completion to be called from _anywhere_ +* allow zsh_completion and bash_completion to be called from anywhere. This might be impossible. * allow supplying custom templates From 1a211b60101d46be85832c528926628977235dd3 Mon Sep 17 00:00:00 2001 From: lowlifeplanet <44231597+lowlifeplanet@users.noreply.github.com> Date: Tue, 26 Mar 2019 16:24:03 -0700 Subject: [PATCH 5/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 83dff6f..2c8fcfb 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ Fylla must be loaded before `Thor.start` (the method) is called, in order for Fy General use case will be to create a new subcommand or option that calls `Fylla.zsh_completion(self)` -`Fylla#zsh_completion` returns a string containing the entire zsh completion script and bash completion script. Scripts are ready for use after `Fylla#zsh_completion` returns. +`Fylla#zsh_completion` returns a string containing the entire zsh completion script, that you can use to do what you see fit. Same for bash completion.