A NetBeans IDE plugin supporting the EditorConfig standard.
Java HTML
Latest commit 98cc561 Nov 23, 2016 @bennyn bennyn committed on GitHub Added Emily Mabrey

README.md

EditorConfig NetBeans Plugin

A NetBeans IDE plugin supporting the EditorConfig standard.

  • Supports NetBeans 8 and above
  • Requires Java 7+

Features

Plugin Screenshot

EditorConfig Project

EditorConfig makes it easy to maintain the correct coding style when switching between different text editors and between different projects. The EditorConfig project maintains a file format and plugins for various text editors which allow this file format to be read and used by those editors. For information on the file format and supported text editors, see the EditorConfig website.

Example file

.editorconfig

# top-most EditorConfig file
root = true

# Unix-style newlines with a newline ending every file
[*]
end_of_line = lf
insert_final_newline = true

# 4 space indentation
[*.py]
indent_style = space
indent_size = 4

# Tab indentation (no size specified)
[*.js]
indent_style = tab

# Indentation override for all JS under lib directory
[lib/**.js]
indent_style = space
indent_size = 2

# Matches the exact files either package.json or .travis.yml
[{package.json,.travis.yml}]
indent_style = space
indent_size = 2

Supported properties

🚧 1. charset

Values: latin1, utf-8, utf-8-bom, utf-16be, utf-16le

βœ… 2. end_of_line

Values: lf, cr, crlf

βœ… 3. indent_size

Values: [number], tab

Special case: Indent_size can be set to tab if indent_size is unspecified and indent_style is set to tab. When set to tab, the value of tab_width (if specified) will be used.

Read our notes on Indentation.

βœ… 4. indent_style

Values: space, tab

Read our notes on Indentation.

βœ… 5. insert_final_newline

Values: false, true

βœ… 6. tab_width

Values: [number]

Special case: Defaults to the value of indent_size and doesn't usually need to be specified.

Read our notes on Indentation.

βœ… 7. trim_trailing_whitespace

Values: false, true

How to use

  • A project must be closed and opened after the plugin is installed, to setup hooks for .editorconfig files
  • Rules are applied when a file (which is matched by a rule) is saved

Build

Instructions

mvn clean install

Releases

Status

Disclaimer

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Contributors

Benny Neugebauer Michael Koppen Junichi Yamamoto Emily Mabrey

Special Credits