Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/welovecoding/editorconfig-netbeans
A NetBeans IDE plugin supporting the EditorConfig standard. ⛺
https://github.com/welovecoding/editorconfig-netbeans
code-style editorconfig editorconfig-files editorconfig-netbeans formatter formatting indentation java netbeans-ide
Last synced: 3 months ago
JSON representation
A NetBeans IDE plugin supporting the EditorConfig standard. ⛺
- Host: GitHub
- URL: https://github.com/welovecoding/editorconfig-netbeans
- Owner: welovecoding
- License: mit
- Archived: true
- Created: 2014-10-04T23:02:09.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2020-07-25T06:55:23.000Z (over 4 years ago)
- Last Synced: 2024-06-29T12:32:41.042Z (4 months ago)
- Topics: code-style, editorconfig, editorconfig-files, editorconfig-netbeans, formatter, formatting, indentation, java, netbeans-ide
- Language: Java
- Homepage: https://editorconfig.org/
- Size: 901 KB
- Stars: 126
- Watchers: 10
- Forks: 22
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-netbeans - EditorConfig NetBeans - A NetBeans IDE plugin supporting the EditorConfig standard. (:electric_plug: Plugins <a name="plugins"></a> / Productivity)
README
⚠️ **This repository is deprecated and unmaintained.** Please follow the "[First class EditorConfig support](https://issues.apache.org/jira/browse/NETBEANS-1287)" thread on the Apache's JIRA issue tracker to be informed about updates.
# EditorConfig NetBeans Plugin
A NetBeans IDE plugin supporting the [EditorConfig][editorconfig] standard.
- Supports NetBeans 8 and above
- Requires Java 7+
## Features
- Reads EditorConfig files
- [Syntax highlighting](https://user-images.githubusercontent.com/469989/49339218-fee2b900-f62e-11e8-8d57-070313add68b.png)
- [Navigation in EditorConfig files](https://user-images.githubusercontent.com/469989/49339216-fee2b900-f62e-11e8-9a8b-7bd5bd08ff20.png)
## 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][editorconfig].
## Example file
**.editorconfig**
```ini
# 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
### :construction: 1. charset
*Values:* `latin1`, `utf-8`, `utf-8-bom`, `utf-16be`, `utf-16le`
### :white_check_mark: 2. end_of_line
*Values:* `lf`, `cr`, `crlf`
### :white_check_mark: 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](https://github.com/welovecoding/editorconfig-netbeans/wiki/EditorConfig---Rule-Evaluation#indentation).
### :white_check_mark: 4. indent_style
*Values:* `space`, `tab`
Read our notes on [Indentation](https://github.com/welovecoding/editorconfig-netbeans/wiki/EditorConfig---Rule-Evaluation#indentation).
### :white_check_mark: 5. insert_final_newline
*Values:* `false`, `true`
### :white_check_mark: 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](https://github.com/welovecoding/editorconfig-netbeans/wiki/EditorConfig---Rule-Evaluation#indentation).
### :white_check_mark: 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
```bash
mvn clean install
```
### Releases
- [Release Versions](https://github.com/welovecoding/editorconfig-netbeans/releases)
### Status
[](https://travis-ci.org/welovecoding/editorconfig-netbeans)
## 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]
:---:|:---:|:---:|:---:
[**Benny Neugebauer**][benny_neugebauer] | [**Michael Koppen**][michael_koppen] | [**Junichi Yamamoto**][junichi_yamamoto] | [**Emily Mabrey**][emily_mabrey]
### Special Credits
- [Geertjan Wielenga](https://blogs.oracle.com/geertjan) for his posts on [EditorConfig and NetBeans IDE](https://blogs.oracle.com/geertjan/entry/editorconfig_and_netbeans_ide)
[benny_neugebauer]: http://www.bennyn.de/ "Benny Neugebauer"
[editorconfig]: http://editorconfig.org/ "EditorConfig"
[emily_mabrey]: https://www.openhub.net/accounts/emabrey "Emily Mabrey"
[junichi_yamamoto]: http://junichi11.com/ "Junichi Yamamoto"
[michael_koppen]: https://beanbelt.blogspot.de/ "Michael Koppen"