Git Product home page Git Product logo

open-editor's Introduction

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

open-editor's People

Contributors

sindresorhus avatar bendingbender avatar simenb avatar coreyfarrell avatar koenpunt avatar sphinxknight avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.