Skip to content

Commit

Permalink
csscomb: refresh schema (#2610)
Browse files Browse the repository at this point in the history
* Simplify title

* Add links to docs

* Standardize all descriptions

* Add `uniqueItems` to `exclude` prop

* Add `type` for `color-case`

Add `type` for broken props

* Fix `sort-order-fallback` prop

* Add `always-semicolon` description

* Simplify `$schema` key

* Inline `path` def from `base-04`:
- it will be referenced properly later
  • Loading branch information
Emily Grace Seville authored Nov 24, 2022
1 parent 7c8f14c commit 05e7554
Showing 1 changed file with 34 additions and 28 deletions.
62 changes: 34 additions & 28 deletions src/schemas/json/csscomb.json
Original file line number Diff line number Diff line change
@@ -1,105 +1,111 @@
{
"$schema": "http://json-schema.org/draft-04/schema#",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"exclude": {
"description": "An array of files/globbing patterns to ignore",
"description": "A list of files to ignore in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
"type": "string",
"minLength": 1
}
},
"verbose": {
"type": "boolean"
},
"always-semicolon": {
"description": "Whether to add missing semicolon in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config",
"type": "boolean"
},
"block-indent": {
"description": "Whether to add a semicolon after the last value/mixin.",
"description": "A block indent style in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config",
"type": "string"
},
"color-case": {
"description": "Unify case of hexadecimal colors.",
"description": "A hexadecimal color style in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config",
"type": "string",
"enum": ["lower", "upper"]
},
"color-shorthand": {
"description": "Whether to expand hexadecimal colors or use shorthands.",
"description": "Whether to expand hexadecimal color or use shorthand in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config",
"type": "boolean"
},
"element-case": {
"description": "Unify case of element selectors.",
"description": "Whether to unify case of element selector in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config",
"type": "string",
"enum": ["lower", "upper"]
},
"eof-newline": {
"description": "Add/remove line break at EOF.",
"description": "Whether to add a trailing line break in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config",
"type": "boolean"
},
"leading-zero": {
"description": "Add/remove leading zero in dimensions.",
"description": "Whether to add leading zero in a dimension in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config",
"type": "boolean"
},
"quotes": {
"description": "Unify quotes style.",
"description": "A quote style in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config",
"type": "string",
"enum": ["single", "double"]
},
"remove-empty-rulesets": {
"description": "Remove all rulesets that contain nothing but spaces.",
"description": "Whether to remove empty rulesets\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config",
"type": "boolean"
},
"space-after-colon": {
"description": "Set space after `:` in declarations.",
"description": "A space style after a colon in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config",
"type": "string"
},
"space-after-combinator": {
"description": "Set space after combinator (for example, in selectors like `p > a`).",
"description": "A space style after a combinator in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config",
"type": "string"
},
"space-after-opening-brace": {
"description": "Set space after `{`.",
"description": "A space style after an opening brace in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config",
"type": "string"
},
"space-after-selector-delimiter": {
"description": "Set space after selector delimiter.",
"description": "A space style after a selector delimiter in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config",
"type": "string"
},
"space-after-closing-brace": {
"description": "Set space before `}`.",
"description": "A space style after a closing brace in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config",
"type": "string"
},
"space-before-colon": {
"description": "Set space before `:` in declarations.",
"description": "A space style before a colon in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config",
"type": "string"
},
"space-before-combinator": {
"description": "Set space before combinator (for example, in selectors like `p > a`).",
"description": "A space style before a combinator in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config",
"type": "string"
},
"space-before-opening-brace": {
"description": "Set space before `{`.",
"description": "A space style before an opening brace in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config",
"type": "string"
},
"space-before-selector-delimiter": {
"description": "Set space before selector delimiter.",
"description": "A space style before a selector delimiter in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config",
"type": "string"
},
"space-between-declarations": {
"description": "Set space between declarations (i.e. `color: tomato`).",
"description": "A space style between declarations in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config",
"type": "string"
},
"strip-spaces": {
"description": "Whether to trim trailing spaces.",
"description": "Whether to trim trailing space in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config",
"type": "boolean"
},
"unitless-zero": {
"description": "Whether to remove units in zero-valued dimensions.",
"description": "Whether to remove unit in zero-valued dimension in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config",
"type": "boolean"
},
"vendor-prefix-align": {
"description": "Whether to align prefixes in properties and values.",
"description": "Whether to align prefix in property and value in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config",
"type": "boolean"
},
"sort-order": {
"description": "Sort properties in particular order.",
"description": "A sort order in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config",
"type": "array",
"items": {
"type": "array",
Expand All @@ -112,10 +118,10 @@
"type": "boolean"
},
"sort-order-fallback": {
"description": "Sort unknown properties alphabetically",
"enum": ["abc"]
"description": "A sort style of unknown properties in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config",
"type": "string"
}
},
"title": "JSON schema for CSS Comb configuration files",
"title": "A CSS Comb config schema",
"type": "object"
}

0 comments on commit 05e7554

Please sign in to comment.