master.adoc

Table of Contents

• Rules Development Guide
  • 1. Introduction
  • 2. Creating YAML rules
    • 2.1. Creating a basic YAML rule
  • Appendix A: Reference material

topics/templates/document-attributes.adoc

Rules Development Guide

topics/making-open-source-more-inclusive.adoc

1. Introduction

topics/rules-guide-intro.adoc

topics/mta-about-home-var.adoc

topics/mta-about-rules.adoc

2. Creating YAML rules

Each analyzer rule is a set of instructions that are used to analyze source code and detect issues that are problematic for migration.

The analyzer parses user-provided rules, applies them to applications' source code, and generates issues for matched rules. A collection of one or more rules forms a ruleset. Creating rulesets provides a way of organizing multiple rules that achieve a common goal. The analyzer CLI takes rulesets as input arguments.

topics/yaml-rule-structure-syntax.adoc

2.1. Creating a basic YAML rule

This section describes how to create a basic {ProductShortName} YAML rule. This assumes that you already have {ProductShortName} installed. See the {ProductShortName} {ProductDocUserGuideURL}[{UserCLIBookName}] for installation instructions.

topics/create-basic-yaml-rule-template.adoc

topics/create-basic-yaml-ruleset-template.adoc

topics/create-yaml-rule.adoc

topics/running-analysis-using-custom-yaml-rule.adoc

topics/create-first-yaml-rule.adoc

topics/testing-rules.adoc

topics/manually-test-rules.adoc

topics/rules-testing-junit.adoc

topics/validation-report.adoc

topics/validation-report-understanding.adoc

topics/validation-report-errors.adoc

topics/overriding-rules.adoc

topics/rule-categories.adoc

Appendix A: Reference material

topics/about-story-points.adoc