Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add rule id property #28

Merged
merged 5 commits into from
Jan 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions DocsExamples/Example-rules.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
"codepage": 1200,
"rules": [
{
"id": "CHARTS_WIDER_THAN_TALL",
"name": "Charts wider than tall",
"description": "Want to check that your charts are wider than tall?",
"disabled": false,
Expand Down Expand Up @@ -49,6 +50,7 @@
]
},
{
"id": "DISABLE_SLOW_DATASOURCE_SETTINGS",
"name": "Disable local slow datasource settings",
"description": "Check that report slow data source settings are all disabled.",
"disabled": false,
Expand Down Expand Up @@ -91,6 +93,7 @@
]
},
{
"id": "LOCAL_REPORT_SETTINGS",
"name": "Local report settings",
"disabled": false,
"logType": "warning",
Expand Down Expand Up @@ -213,7 +216,8 @@
]
},
{
"name": "Show visual axes title",
"id": "SHOW_AXES_TITLES",
"name": "Show visual axes titles",
"description": "Check that certain charts have both axes title showing.",
"disabled": false,
"logType": "warning",
Expand Down Expand Up @@ -282,6 +286,7 @@
]
},
{
"id": "PERCENTAGE_OF_CHARTS_USING_CUSTOM_COLOURS",
"name": "Percentage of charts across the report using custom colours is not greater than 10%",
"description": "Check that charts avoid custom colours and use theme colours instead.",
"disabled": false,
Expand Down Expand Up @@ -372,6 +377,7 @@
]
},
{
"id": "ENSURE_ALT_TEXT_DEFINED_FOR_VISUALS",
"name": "Ensure alt-text has been defined for visuals",
"description": "Alt-text is required for screen readers.",
"disabled": true,
Expand Down Expand Up @@ -441,6 +447,7 @@
]
},
{
"id": "DISABLE_DROP_SHADOWS_ON_VISUALS",
"name": "Disable drop shadows on visuals",
"description": "Drop shadows are not suitable for everyone, this rule returns an array of visuals with drop shadows enabled.",
"disabled": false,
Expand Down Expand Up @@ -485,6 +492,7 @@
]
},
{
"id": "GIVE_VISIBLE_PAGES_MEANINGFUL_NAMES",
"name": "Give visible pages meaningful names",
"description": "Returns an array of visible page names with a default 'Page x' display name.",
"disabled": false,
Expand Down Expand Up @@ -533,6 +541,7 @@
]
},
{
"id": "DENEB_CHARTS_PROPERTIES",
"name": "Check Deneb charts properties - work in progress",
"description": "Checks that the drillvar custom rule can read deneb custom visual nested jsonspec properties. This is an example in progress that demonstrates the use of the drillvar custom rule but doesn't yet do anything useful.",
"disabled": true,
Expand Down Expand Up @@ -581,6 +590,7 @@
]
},
{
"id": "CHECK_FOR_VISUALS_OVERLAP",
"name": "Check for visuals overlap with a 5px margin",
"description": "Returns names of visuals that overlap while inflating visuals rectangle area by 5px left, right, top and bottom. Currently this does not check for overlap with the sides of report page itself. This rule does not currently work with visual groups.",
"disabled": false,
Expand Down Expand Up @@ -691,10 +701,11 @@
]
},
{
"id": "CHECK_FOR_LOCAL_MEASURES",
"name": "Check for locally defined measures",
"description": "Returns an array of report-level measure definitions",
"path": "$.config",
"pathErrorWhenNoMatch": true,
"pathErrorWhenNoMatch": false,
"test": [
{
"filter": [
Expand Down Expand Up @@ -751,6 +762,7 @@
"codepage": 65001,
"rules": [
{
"id": "REPORT_THEME_NAME",
"name": "Report theme name",
"description": "Check Report theme name",
"disabled": false,
Expand All @@ -771,6 +783,7 @@
]
},
{
"id": "REPORT_THEME_TITLE_FONT",
"name": "Report theme title font properties",
"description": "Checks theme's' title foreground, fontface and fontsize",
"disabled": false,
Expand Down
Loading
Loading