Get info about the default editor or a specific editor
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.editorconfig
.gitattributes
.gitignore
.travis.yml
index.js
license
package.json
readme.md
test.js

readme.md

env-editor Build Status

Get info about the default editor or a specific editor

This module is used by open-editor.

Supported editors

  • Sublime Text
  • Atom
  • Visual Studio Code
  • WebStorm
  • TextMate
  • Vim
  • NeoVim
  • IntelliJ

Install

$ npm install --save env-editor

Usage

const envEditor = require('env-editor');

envEditor.get('sublime');
/*
{
	id: 'sublime',
	name: 'Sublime Text',
	bin: 'subl',
	isTerminalEditor: false,
	paths: [
		'/Applications/Sublime Text.app/Contents/SharedSupport/bin/subl',
		'/Applications/Sublime Text 2.app/Contents/SharedSupport/bin/subl'
	],
	keywords: []
}
*/

API

.default()

Returns info about the default editor.

The user is expected to have the $EDITOR environment variable set, and if not, a user-friendly error is thrown.

.get(editor)

Returns info about the specified editor.

editor

Type: string

This can be pretty flexible. It matches against all the data it has.

For example, to get Sublime Text, you could write either of the following: sublime, Sublime Text, subl.

.all()

Returns an array with info on all the editors.

License

MIT © Sindre Sorhus