TTY::Editor Gitter

Gem Version Build Status Build status Code Climate Coverage Status Inline docs

Opens a file or text in the user's preferred editor.

TTY::Editor provides independent component for TTY toolkit.

Installation

Add this line to your application's Gemfile:

gem 'tty-editor'

And then execute:

$ bundle

Or install it yourself as:

$ gem install tty-editor

Usage

Open file or text in default editor by calling open:

TTY::Editor.open               # opens editor with no input
TTY::Editor.open('hello.rb')   # opens editor with the file contents
TTY::Editor.open('some text')  # opens editor with text

You can force to always use a specific editor by passing :command option:


TTY::Editor.open('hello.rb', command: :vim)

Use :env key to forward environment variables to the editor.

TTY::Editor.open('hello.rb', env: { ... })

Interface

open

When editor successfully opens file or content then true is returned as value, otherwise TTY::Editor::CommandInvocation error is raised.

Development

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 tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/piotrmurach/tty-editor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Copyright

Copyright (c) 2017 Piotr Murach. See LICENSE for further details.