# editorconfig-defaults

**Repository Path**: mirrors_editorconfig/editorconfig-defaults

## Basic Information

- **Project Name**: editorconfig-defaults
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-24
- **Last Updated**: 2026-02-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

EditorConfig Defaults
=====================

Description of the file format
------------------------------

```json
{
  "file_format": "1.0",
  "version":"0.1.0",
  "matches": {
    "<<matcher>>": {
      "description": "<<description>>",
      "comment": "<<comment>>",
      "flavors": {
        "<<flavor>>": {
          "description": "<<description>>",
          "comment": "<<comment>>",
          "reference": "<<reference>>",
          "editorconfig": {
            "<<setting>>": "<<value>>"
          }
        }
      }
    }
  }
}
```

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 `<<matcher>>` and `<<flavor>>` 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/