Have ideas to improve npm?Join in the discussion! »

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

    3.0.0 • Public • Published

    open-editor

    Open files in your editor at a specific line and column

    Supports any editor, but only the following editors will open at a specific line and column:

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

    *Doesn't support column.

    Install

    $ npm install open-editor
    

    Usage

    const openEditor = require('open-editor');
    
    openEditor([
    	'unicorn.js:5:3',
    	{
    		file: 'readme.md',
    		line: 10,
    		column: 2
    	}
    ]);

    API

    openEditor(files, options?)

    Open the given files in the user's editor at specific line and column if supported by the editor. It does not wait for the editor to start or quit.

    files

    Type: Array<string | object>

    Items should be in the format foo.js:1:5 or {file: 'foo.js', line: 1: column: 5}.

    options

    Type: object

    editor

    Type: string
    Default: Auto-detected

    Name, command, or binary path of the editor.

    Only use this option if you really have to. Can be useful if you want to force a specific editor or implement your own auto-detection.

    openEditor.make(files, options?)

    Same as openEditor(), but returns an object with the binary name, arguments, and a flag indicating whether the editor runs in the terminal.

    Example: {binary: 'subl', arguments: ['foo.js:1:5'], isTerminalEditor: false}

    Can be useful if you want to handle opening the files yourself.

    Related

    Install

    npm i open-editor

    DownloadsWeekly Downloads

    36,017

    Version

    3.0.0

    License

    MIT

    Unpacked Size

    7.25 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar