Ensures that the tags @o3rRestrictionKey
are used with correct values.
[!WARNING] This rule must be configured to be used.
{
"@o3r/o3r-restriction-key-tags": [
"error",
{
"supportedInterfaceNames": ["NestedConfiguration", "Configuration", "CustomConfigurationInterface"],
"supportedKeys": ["restriction", "restriction_with_underscores", "restriction with spaces"]
}
]
}
export interface ConfigExample extends Configuration {
/**
* @o3rRestrictionKey restriction_with_underscores
*/
prop1: string;
/**
* @o3rRestrictionKey restriction
* @o3rRestrictionKey "restriction with spaces"
*/
prop2: string;
}
export interface ConfigExample extends Configuration {
/**
* @o3rRestrictionKey restriction with spaces
*/
prop: string;
}
export interface ConfigExample extends Configuration {
/**
* @o3rRestrictionKey unknownRestriction
*/
prop: string | number;
}
export interface NotAConfigInterface {
/**
* @o3rRestrictionKey restriction
*/
prop: string;
}