Design: Configuration file

[azu]

secretlint will support secretlintrc.json as configuration file.

This issue discuss about the configuration format.

Condition

• Configuration file can be parsed as JSON
  • It means that limit usage of RegExp literal

Format

textlint-pattern

Props

• Simple object

Cons

• System options to each rule is difficult
  • For example, severity is reserved word, but it is just a options value
  • https://textlint.github.io/docs/configuring.html#severity-config-of-rules.

{
  "rules": {
    "<pkg_1>": <option>
    "<pkg_2>": {
      "severity": "waring"
    }
  }
}

Babel/ESLint style

Depend on order of array.

{
  "presets": [
    [
      "@babel/preset-env",
      {
        "useBuiltIns": "entry"
      }
    ]
  ]
}

Array Rule

Props

• explicitly
• System options can be separated
• It is flexible

Cons

• A bit long
• Should handle duplicated id?

{
  "rules": [
    { 
      "name": "<pkg>"
      "options": <option>
      // Additional by systems
      "severity": "warning"
    }
  ]
}

[azu]

Implemented Array Rule