TTY::Editor

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

To edit a file in default editor:

TTY::Editor.open('hello.rb')

To edit content in a default editor:

TTY::Editor.open(content: "some text")

You can also set your preferred editor command:

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

Also, the VISUAL or EDITOR shell environment variables take precedence when auto detecting available editors.

Interface

open

If you wish to open editor with no file or content do:

TTY::Editor.open

To open a file at a path pass it as a first argument:

TTY::Editor.open('../README.md')

When editor successfully opens file or content then true is returned.

If the editor cannot be opened, a TTY::Editor::CommandInvocation error is raised.

In order to open text content inside an editor do:

TTY::Editor.open(content: 'text')

You can also provide filename that will be created with specified content before editor is opened:

TTY::Editor.open('new.rb', content: 'text')

If you open a filename with already existing content then new content gets appended at the end of the file.

:env

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

TTY::Editor.open('hello.rb', env: {"FOO" => "bar"})

:command

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

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

To specify more than one command, and hence give a user a choice do:

TTY::Editor.open('hello.rb') do |editor|
  editor.command :vim, :emacs
end

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.