https://github.com/10sr/editorconfig-micro

EditorConfig Plugin for micro Editor
https://github.com/10sr/editorconfig-micro

editorconfig editorconfig-micro micro

Last synced: about 2 months ago
JSON representation

EditorConfig Plugin for micro Editor

• Host: GitHub
• URL: https://github.com/10sr/editorconfig-micro
• Owner: 10sr
• License: mit
• Created: 2016-11-29T16:09:36.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2024-04-30T08:52:30.000Z (8 months ago)
• Last Synced: 2024-04-30T10:05:44.975Z (8 months ago)
• Topics: editorconfig, editorconfig-micro, micro
• Language: Lua
• Homepage:
• Size: 86.9 KB
• Stars: 50
• Watchers: 6
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Maintainer Needed

I usually do not use the Micro editor now, and I don't have the time to maintain this project any more.

Forking and replacing this repository is really appreciated. Thanks!

# editorconfig-micro

[EditorConfig] plugin for the [`micro`] editor. Works with `micro` v2.

![Syntax Highlight](https://raw.githubusercontent.com/10sr/editorconfig-micro/master/assets/syntax_highlight.png)

### Prerequisites

You'll need an `editorconfig` core executable, like [EditorConfig C Core], installed and on your PATH.

### Installation

From the command line, type `micro -plugin install editorconfig`. Or, in micro's command mode, type `plugin install editorconfig`.

Alternatively, you may directly clone this repository:

    git clone https://github.com/10sr/editorconfig-micro "${XDG_CONFIG_HOME:-~/.config}/micro/plug/editorconfig"

That's all! This plugin will be automatically enabled after you restart [`micro`]. It will automatically apply the appropriate editorconfig properties on files when they are opened and saved.

It's also recommended to disable micro's `ftoptions` builtin plugin (set it to false in micro's settings.json) as it's a very limited subset of duplicate functionality than what editorconfig provides.

For more information, use `help editorconfig` in command mode or view `help/editorconfig.md` in this repo.

### Supported Properties

* `root` (only used by EditorConfig Core)

* `indent_style`

* `indent_size`

* `tab_width`

* `charset`

  * Currently, [`micro`] only [supports][EditorConfig Options] the `utf-8` charset.

* `end_of_line`

  * Currently, [`micro`] only [supports][EditorConfig Options] `lf` and `crlf`.

* `insert_final_newline`

* `trim_trailing_whitespace`

### Unsupported Properties

* `max_line_length`

### License

This software is licensed under MIT License.

See [LICENSE](LICENSE) for details.

[`micro`]: https://micro-editor.github.io

[EditorConfig]: http://editorconfig.org

[EditorConfig Options]: https://github.com/zyedidia/micro/blob/master/runtime/help/options.md

[EditorConfig C Core]: https://github.com/editorconfig/editorconfig-core-c