@@ -25,15 +25,15 @@ _All properties are optional._
2525
2626_ Object containing the following properties:_
2727
28- | Property | Description | Type |
29- | :----------------------- | :----------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
30- | ** ` slug ` ** (\* ) | Unique ID (human-readable, URL-safe) | [ Slug] ( #slug ) |
31- | ** ` title ` ** (\* ) | Descriptive name | ` string ` (_ max length: 256_ ) |
32- | ` docsUrl ` | Documentation site | ` '' ` _ or_ ` string ` (_ url_ ) (_ optional_ ) |
33- | ** ` scores ` ** (\* ) | Score comparison | _ Object with properties:_ <ul ><li >** ` before ` ** (\* ): [ Score] ( #score ) - Value between 0 and 1 (source commit)</li ><li >** ` after ` ** (\* ): [ Score] ( #score ) - Value between 0 and 1 (target commit)</li ><li >** ` diff ` ** (\* ): ` number ` (_ ≥-1, ≤1_ ) - Score change (` scores.after - scores.before ` )</li ></ul > |
34- | ** ` plugin ` ** (\* ) | Plugin which defines it | _ Object with properties:_ <ul ><li >** ` slug ` ** (\* ): [ Slug] ( #slug ) - Unique plugin slug within core config</li ><li >** ` title ` ** (\* ): ` string ` (_ max length: 256_ ) - Descriptive name</li ><li >` docsUrl ` : ` '' ` _ or_ ` string ` (_ url_ ) (_ optional_ ) - Plugin documentation site</li ></ul > |
35- | ** ` values ` ** (\* ) | Audit ` value ` comparison | _ Object with properties:_ <ul ><li >** ` before ` ** (\* ): ` number ` ( _ ≥0 _ ) - Raw numeric value (source commit)</li ><li >** ` after ` ** (\* ): ` number ` ( _ ≥0 _ ) - Raw numeric value (target commit)</li ><li >** ` diff ` ** (\* ): ` number ` - Value change (` values.after - values.before ` )</li ></ul > |
36- | ** ` displayValues ` ** (\* ) | Audit ` displayValue ` comparison | _ Object with properties:_ <ul ><li >` before ` : ` string ` - Formatted value (e.g. '0.9 s', '2.1 MB') (source commit)</li ><li >` after ` : ` string ` - Formatted value (e.g. '0.9 s', '2.1 MB') (target commit)</li ></ul > |
28+ | Property | Description | Type |
29+ | :----------------------- | :----------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
30+ | ** ` slug ` ** (\* ) | Unique ID (human-readable, URL-safe) | [ Slug] ( #slug ) |
31+ | ** ` title ` ** (\* ) | Descriptive name | ` string ` (_ max length: 256_ ) |
32+ | ` docsUrl ` | Documentation site | ` '' ` _ or_ ` string ` (_ url_ ) (_ optional_ ) |
33+ | ** ` scores ` ** (\* ) | Score comparison | _ Object with properties:_ <ul ><li >** ` before ` ** (\* ): [ Score] ( #score ) - Value between 0 and 1 (source commit)</li ><li >** ` after ` ** (\* ): [ Score] ( #score ) - Value between 0 and 1 (target commit)</li ><li >** ` diff ` ** (\* ): ` number ` (_ ≥-1, ≤1_ ) - Score change (` scores.after - scores.before ` )</li ></ul > |
34+ | ** ` plugin ` ** (\* ) | Plugin which defines it | _ Object with properties:_ <ul ><li >** ` slug ` ** (\* ): [ Slug] ( #slug ) - Unique plugin slug within core config</li ><li >** ` title ` ** (\* ): ` string ` (_ max length: 256_ ) - Descriptive name</li ><li >` docsUrl ` : ` '' ` _ or_ ` string ` (_ url_ ) (_ optional_ ) - Plugin documentation site</li ></ul > |
35+ | ** ` values ` ** (\* ) | Audit ` value ` comparison | _ Object with properties:_ <ul ><li >** ` before ` ** (\* ): [ NonnegativeNumber ] ( #nonnegativenumber ) - Raw numeric value (source commit)</li ><li >** ` after ` ** (\* ): [ NonnegativeNumber ] ( #nonnegativenumber ) - Raw numeric value (target commit)</li ><li >** ` diff ` ** (\* ): ` number ` - Value change (` values.after - values.before ` )</li ></ul > |
36+ | ** ` displayValues ` ** (\* ) | Audit ` displayValue ` comparison | _ Object with properties:_ <ul ><li >` before ` : ` string ` - Formatted value (e.g. '0.9 s', '2.1 MB') (source commit)</li ><li >` after ` : ` string ` - Formatted value (e.g. '0.9 s', '2.1 MB') (target commit)</li ></ul > |
3737
3838_ (\* ) Required._
3939
@@ -43,14 +43,14 @@ Audit information
4343
4444_ Object containing the following properties:_
4545
46- | Property | Description | Type |
47- | :--------------- | :--------------------------------------- | :---------------------------- |
48- | ** ` slug ` ** (\* ) | Reference to audit | [ Slug] ( #slug ) |
49- | ` displayValue ` | Formatted value (e.g. '0.9 s', '2.1 MB') | ` string ` |
50- | ** ` value ` ** (\* ) | Raw numeric value | ` number ` ( _ ≥0 _ ) |
51- | ** ` score ` ** (\* ) | Value between 0 and 1 | [ Score] ( #score ) |
52- | ` scoreTarget ` | Pass/fail score threshold (0-1) | ` number ` (_ ≥0, ≤1_ ) |
53- | ` details ` | Detailed information | [ AuditDetails] ( #auditdetails ) |
46+ | Property | Description | Type |
47+ | :--------------- | :--------------------------------------- | :-------------------------------------- |
48+ | ** ` slug ` ** (\* ) | Reference to audit | [ Slug] ( #slug ) |
49+ | ` displayValue ` | Formatted value (e.g. '0.9 s', '2.1 MB') | ` string ` |
50+ | ** ` value ` ** (\* ) | Raw numeric value | [ NonnegativeNumber ] ( #nonnegativenumber ) |
51+ | ** ` score ` ** (\* ) | Value between 0 and 1 | [ Score] ( #score ) |
52+ | ` scoreTarget ` | Pass/fail score threshold (0-1) | ` number ` (_ ≥0, ≤1_ ) |
53+ | ` details ` | Detailed information | [ AuditDetails] ( #auditdetails ) |
5454
5555_ (\* ) Required._
5656
@@ -72,7 +72,7 @@ _Object containing the following properties:_
7272| ` docsUrl ` | Link to documentation (rationale) | ` '' ` _ or_ ` string ` (_ url_ ) (_ optional_ ) |
7373| ` isSkipped ` | Indicates whether the audit is skipped | ` boolean ` |
7474| ` displayValue ` | Formatted value (e.g. '0.9 s', '2.1 MB') | ` string ` |
75- | ** ` value ` ** (\* ) | Raw numeric value | ` number ` ( _ ≥0 _ ) |
75+ | ** ` value ` ** (\* ) | Raw numeric value | [ NonnegativeNumber ] ( #nonnegativenumber ) |
7676| ** ` score ` ** (\* ) | Value between 0 and 1 | [ Score] ( #score ) |
7777| ` scoreTarget ` | Pass/fail score threshold (0-1) | ` number ` (_ ≥0, ≤1_ ) |
7878| ` details ` | Detailed information | [ AuditDetails] ( #auditdetails ) |
@@ -90,7 +90,7 @@ _Object containing the following properties:_
9090| ` docsUrl ` | Documentation site | ` '' ` _ or_ ` string ` (_ url_ ) (_ optional_ ) |
9191| ** ` plugin ` ** (\* ) | Plugin which defines it | _ Object with properties:_ <ul ><li >** ` slug ` ** (\* ): [ Slug] ( #slug ) - Unique plugin slug within core config</li ><li >** ` title ` ** (\* ): ` string ` (_ max length: 256_ ) - Descriptive name</li ><li >` docsUrl ` : ` '' ` _ or_ ` string ` (_ url_ ) (_ optional_ ) - Plugin documentation site</li ></ul > |
9292| ** ` score ` ** (\* ) | Value between 0 and 1 | [ Score] ( #score ) |
93- | ** ` value ` ** (\* ) | Raw numeric value | ` number ` ( _ ≥0 _ ) |
93+ | ** ` value ` ** (\* ) | Raw numeric value | [ NonnegativeNumber ] ( #nonnegativenumber ) |
9494| ` displayValue ` | Formatted value (e.g. '0.9 s', '2.1 MB') | ` string ` |
9595
9696_ (\* ) Required._
@@ -198,12 +198,12 @@ _(\*) Required._
198198
199199_ Object containing the following properties:_
200200
201- | Property | Description | Type |
202- | :---------------- | :----------------------------------------------------------------- | :------------------- |
203- | ** ` slug ` ** (\* ) | Slug of an audit or group (depending on ` type ` ) | [ Slug] ( #slug ) |
204- | ** ` weight ` ** (\* ) | Weight used to calculate score | ` number ` ( _ ≥0 _ ) |
205- | ** ` type ` ** (\* ) | Discriminant for reference kind, affects where ` slug ` is looked up | ` 'audit' \| 'group' ` |
206- | ** ` plugin ` ** (\* ) | Plugin slug (plugin should contain referenced audit or group) | [ Slug] ( #slug ) |
201+ | Property | Description | Type |
202+ | :---------------- | :----------------------------------------------------------------- | :-------------------------------------- |
203+ | ** ` slug ` ** (\* ) | Slug of an audit or group (depending on ` type ` ) | [ Slug] ( #slug ) |
204+ | ** ` weight ` ** (\* ) | Weight used to calculate score | [ NonnegativeNumber ] ( #nonnegativenumber ) |
205+ | ** ` type ` ** (\* ) | Discriminant for reference kind, affects where ` slug ` is looked up | ` 'audit' \| 'group' ` |
206+ | ** ` plugin ` ** (\* ) | Plugin slug (plugin should contain referenced audit or group) | [ Slug] ( #slug ) |
207207
208208_ (\* ) Required._
209209
@@ -332,10 +332,10 @@ Weighted reference to a group
332332
333333_ Object containing the following properties:_
334334
335- | Property | Description | Type |
336- | :---------------- | :-------------------------------------------------------------- | :-------------- |
337- | ** ` slug ` ** (\* ) | Reference slug to a group within this plugin (e.g. 'max-lines') | [ Slug] ( #slug ) |
338- | ** ` weight ` ** (\* ) | Weight used to calculate score | ` number ` ( _ ≥0 _ ) |
335+ | Property | Description | Type |
336+ | :---------------- | :-------------------------------------------------------------- | :-------------------------------------- |
337+ | ** ` slug ` ** (\* ) | Reference slug to a group within this plugin (e.g. 'max-lines') | [ Slug] ( #slug ) |
338+ | ** ` weight ` ** (\* ) | Weight used to calculate score | [ NonnegativeNumber ] ( #nonnegativenumber ) |
339339
340340_ (\* ) Required._
341341
@@ -1262,6 +1262,10 @@ _Enum, one of the following possible values:_
12621262
12631263</details >
12641264
1265+ ## NonnegativeNumber
1266+
1267+ _ Number which is greater than or equal to 0._
1268+
12651269## PersistConfig
12661270
12671271_ Object containing the following properties:_
@@ -1374,7 +1378,7 @@ _Union of the following possible types:_
13741378
13751379- ` string ` (_ url_ )
13761380- ` Array<string (_url_)> `
1377- - _ Object with dynamic keys of type_ ` string ` (_ url_ ) _ and values of type_ ` number ` ( _ ≥0 _ )
1381+ - _ Object with dynamic keys of type_ ` string ` (_ url_ ) _ and values of type_ [ NonnegativeNumber ] ( #nonnegativenumber )
13781382
13791383## PositiveInt
13801384
@@ -1574,3 +1578,9 @@ _Object containing the following properties:_
15741578| ` timeout ` | Request timeout in minutes (default is 5) | ` number ` (_ >0, int_ ) |
15751579
15761580_ (\* ) Required._
1581+
1582+ ## Weight
1583+
1584+ Coefficient for the given score (use weight 0 if only for display)
1585+
1586+ _ Number which is greater than or equal to 0._
0 commit comments