An open API service indexing awesome lists of open source software.

https://github.com/louis-thevenet/open-editor

Open files or strings in default editor
https://github.com/louis-thevenet/open-editor

edit editor open-editor rust-edit

Last synced: 12 months ago
JSON representation

Open files or strings in default editor

Awesome Lists containing this project

README

          

[![crates.io](https://img.shields.io/crates/v/open-editor.svg)](https://crates.io/crates/open-editor) [![docs.rs](https://docs.rs/open-editor/badge.svg)](https://docs.rs/open-editor/) ![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/louis-thevenet/open-editor/ci.yml)

# `open-editor`

## About

`open-editor` allows you to open the system default editor to edit files or simply get the result as a String.

It supports calling the editor with specific line and column numbers.

## Quick Start

See the examples for more details.

### Writing in a file

```rust
use open_editor::editor_call_builder::EditorCallBuilder;

let filename = "./file.txt";

EditorCallBuilder::new(filename)?
.at_line(5)
.at_column(42)
.call_editor()?;
```

### Getting the result as a String

```rust
use open_editor::open_editor;

let content = open_editor()?;
assert!(!content.is_empty(), "Editor returned empty content");
```

### Editing Strings

```rust
let template = "Hello, {name}!\nWelcome to {place}.";
let filled_template = edit_in_editor(template)?;
```