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, Code Genome Project

This recipe is available under the Moderne Source Available License. Moderne customers can download precompiled artifacts from The Code Genome Project. For non-commercial use you can build the artifact from source locally.

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. Recipes with required configuration parameters cannot be activated directly (unless you are running them via the Moderne CLI). To activate this recipe you must create a new recipe which fills in the required parameters. In your rewrite.yml create a new recipe with a unique name. For example: com.yourorg.FindReferenceExample. Here's how you can define and customize such a recipe within your rewrite.yml:

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

Now that com.yourorg.FindReferenceExample has been defined, activate it and take a dependency on org.openrewrite:rewrite-cobol:2.24.0 in your build file:

OpenRewrite artifacts, including the Maven and Gradle plugins themselves, are distributed through the Code Genome Project repository (https://artifacts.codegenomeproject.org/maven), which requires authentication. Sign in to the Code Genome Project to create a download token; your build authenticates with the email or username you signed in with, plus that token as the password. See the quickstart guide for details.

  1. Put your Code Genome Project credentials in ~/.gradle/gradle.properties, so that they are not committed alongside your build:
    ~/.gradle/gradle.properties
    codeGenomeUsername=you@example.com
    codeGenomeToken=your-download-token
  2. Add the Code Genome Project repository to your settings.gradle file, so that the plugin itself can be resolved:
    settings.gradle
    pluginManagement {
        repositories {
            maven {
                url = "https://artifacts.codegenomeproject.org/maven"
                credentials {
                    username = providers.gradleProperty("codeGenomeUsername").get()
                    password = providers.gradleProperty("codeGenomeToken").get()
                }
            }
            // Keep the portal for any other plugins your build applies
            gradlePluginPortal()
        }
    }
  3. Add the following to your build.gradle file:
    build.gradle
    plugins {
        id("org.openrewrite.rewrite") version("latest.release")
    }

    rewrite {
        activeRecipe("com.yourorg.FindReferenceExample")
        setExportDatatables(true)
    }

    repositories {
        mavenCentral()
        maven {
            url = "https://artifacts.codegenomeproject.org/maven"
            credentials {
                username = providers.gradleProperty("codeGenomeUsername").get()
                password = providers.gradleProperty("codeGenomeToken").get()
            }
        }
    }

    dependencies {
        rewrite("org.openrewrite:rewrite-cobol:2.24.0")
    }
  4. Run gradle rewriteRun to run the recipe.

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.