Wondering what’s next for npm?Check out our public roadmap! »

    env-editor
    TypeScript icon, indicating that this package has built-in type declarations

    0.5.0 • Public • Published

    env-editor

    Get metadata on 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
    • GNU nano
    • GNU Emacs
    • Android Studio
    • Xcode

    Install

    $ npm install env-editor
    

    Usage

    const {defaultEditor, getEditor, allEditors} = require('env-editor');
    
    defaultEditor();
    /*
    {
    	id: 'atom',
    	name: 'Atom',
    	binary: 'atom',
    	isTerminalEditor: false,
    	paths: [
    		'/Applications/Atom.app/Contents/Resources/app/atom.sh'
    	],
    	keywords: []
    }
    */
    
    getEditor('sublime');
    /*
    {
    	id: 'sublime',
    	name: 'Sublime Text',
    	binary: 'subl',
    	isTerminalEditor: false,
    	paths: [
    		'/Applications/Sublime Text.app/Contents/SharedSupport/bin/subl',
    		'/Applications/Sublime Text 2.app/Contents/SharedSupport/bin/subl'
    	],
    	keywords: []
    }
    */
    
    allEditors();
    /*
    [
    	{
    		id: 'atom',
    
    	},
    	{
    		id: 'sublime,
    
    	},
    
    ]
    */

    API

    defaultEditor()

    Returns metadata on the default editor.

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

    getEditor(editor)

    Returns metadata on 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.

    allEditors()

    Returns an array with metadata on all the editors.

    Install

    npm i env-editor

    DownloadsWeekly Downloads

    201,965

    Version

    0.5.0

    License

    MIT

    Unpacked Size

    8.71 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar