https://github.com/fibo/dot-editorconfig
creates a .editorconfig file in your package dir
https://github.com/fibo/dot-editorconfig
editorconfig
Last synced: about 1 year ago
JSON representation
creates a .editorconfig file in your package dir
- Host: GitHub
- URL: https://github.com/fibo/dot-editorconfig
- Owner: fibo
- License: mit
- Created: 2016-07-18T13:41:02.000Z (about 10 years ago)
- Default Branch: main
- Last Pushed: 2022-09-19T15:11:54.000Z (almost 4 years ago)
- Last Synced: 2025-03-30T14:51:12.683Z (over 1 year ago)
- Topics: editorconfig
- Language: JavaScript
- Homepage: https://fibo.github.io/dot-editorconfig
- Size: 19.5 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# dot-editorconfig
> creates a *.editorconfig* file in your package dir
[Usage](#usage) |
[Source](#source) |
[Contributing](#contributing) |
[License](#license)
[](https://fibo.github.io/kiss-literate-programming)
## Usage
> [EditorConfig] helps developers define and maintain consistent coding styles between different editors and IDEs.
Launch the command
npm install dot-editorconfig --no-save
If you prefer to add *dot-editorconfig* package as a dev dependency, you can launch
npm install dot-editorconfig --save-dev
A *.editorconfig* will be created in your package dir. See its [content here](#source).
Notice that installing *dot-editorconfig* **will not override** your *.editorconfig* file, if it already exists.
If you need to upgrade it is necessary to remove it manually before, for instance
rm .editorconfig
It is up to you to choose to add it to *.gitignore* or to version it and modify it further.
## Source
If you don't have npm you can just copy and paste the following source.
```sh
# EditorConfig is awesome: http://EditorConfig.org
# Stop the editor from looking for .editorconfig files in the parent directories.
root = true
[*]
# Non-configurable Prettier behaviors
charset = utf-8
insert_final_newline = true
# Configurable Prettier behaviors
# (change these if your Prettier config differs)
end_of_line = lf
indent_style = space
indent_size = 2
max_line_length = 80
trim_trailing_whitespace = true
[*{.conf,.pl,.pm,.py,.sol}]
indent_size = 4
[*{.glsl,.go,.sh,.sql}]
indent_style = tab
[Makefile]
indent_style = tab
```
## Contributing
If you also like the idea to have an easy way to install and share an
*.editorconfig* file, and you think you can contribute adding something
missing or improving current configuration, edit this [README] in the
**Source** section and send a pull request.
Do not edit this [*.editorconfig* file](https://github.com/fibo/dot-editorconfig/blob/main/.editorconfig), since it is generated by commands
npm install markdown2code --no-save
npm run markdown2code
## License
[MIT](https://fibo.github.io/mit-license/)
[EditorConfig]: http://editorconfig.org/ "EditorConfig"
[README]: https://github.com/fibo/dot-editorconfig/blob/master/README.md "README.md"