https://github.com/editorconfig/editorconfig-defaults
https://github.com/editorconfig/editorconfig-defaults
defaults editorconfig
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/editorconfig/editorconfig-defaults
- Owner: editorconfig
- Created: 2017-11-13T13:12:51.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-04-26T22:27:53.000Z (about 3 years ago)
- Last Synced: 2025-01-01T21:21:52.734Z (over 1 year ago)
- Topics: defaults, editorconfig
- Size: 3.91 KB
- Stars: 25
- Watchers: 10
- Forks: 7
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
EditorConfig Defaults
=====================
Description of the file format
------------------------------
```json
{
"file_format": "1.0",
"version":"0.1.0",
"matches": {
"<>": {
"description": "<>",
"comment": "<>",
"flavors": {
"<>": {
"description": "<>",
"comment": "<>",
"reference": "<>",
"editorconfig": {
"<>": "<>"
}
}
}
}
}
}
```
Where
* `matcher` stands for the default files-glob the section defines; the format
should allow to use it to filter the defaults based on a list of files.
This is what goes between `[` and `]` in the editorconfig-file.
* `flavors` stands for the given flavor name; it should be used to let the
user choose the preferred style; the using tool might omit showing it if
there is only one flavor (f.e. `common` or `convention`) for the section.
* `setting` and `value` are the editorconfig-settings for that flavor;
they should be used to populate the editorconfig-file.
`value` can be a string, boolean or int value.
* `description` contains the plain-text description of that flavor;
it should be used as an introductory description of the flavor.
* `reference` is the reference to the source of the flavor; it should a URL
that leads to a authoritative description of the flavor.
* `comment` can be placed within a `<>` and `<>` and is
an optional string.
Linting
-------
To perform all the checks that are available:
```
npm install
npm run lint
```
To validate the JSON without node, there are several sites available like
https://www.jsonschemavalidator.net/ and https://jsonschemalint.com/