Skip to main content

Find matching identifiers in COBOL, copybooks, and JCL

org.openrewrite.cobol.search.FindReference

Finds an identifier by an exact match or regex pattern in COBOL, copybooks, and/or JCL.

Recipe source

GitHub: FindReference.java, Issue Tracker, Maven Central

This recipe is available under the Moderne Source Available License.

Options

TypeNameDescriptionExample
StringsearchTermA word or regex pattern to find. By default the search term is case insensitive.CM102M or cm1.*
BooleanexactMatchSearch for a word based on an exact match of the search term.true

Usage

This recipe has required configuration parameters and can only be run by users of Moderne. To run this recipe, you will need to provide the Moderne CLI run command with the required options. Or, if you'd like to create a declarative recipe, please see the below example of a rewrite.yml file:

rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.FindReferenceExample
displayName: Find matching identifiers in COBOL, copybooks, and JCL example
recipeList:
- org.openrewrite.cobol.search.FindReference:
searchTerm: CM102M or cm1.*
exactMatch: true

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell
mod run . --recipe FindReference --recipe-option "searchTerm=CM102M or cm1.*" --recipe-option "exactMatch=true"

If the recipe is not available locally, then you can install it using:

mod config recipes jar install org.openrewrite:rewrite-cobol:{{VERSION_ORG_OPENREWRITE_REWRITE_COBOL}}

See how this recipe works across multiple open-source repositories

Run this recipe on OSS repos at scale with the Moderne SaaS.

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Data Tables

COBOL reference search results

org.openrewrite.cobol.table.ReferenceSearchResult

Identifier references found in COBOL, copybook, and JCL sources.

Column NameDescription
Source pathThe source path of the file that contains the matching reference.
Source typeThe type of source where the reference was found.
ReferenceThe identifier text that matched the search criteria.