Skip to main content

Find matching words in JCL source code

org.openrewrite.jcl.search.FindWord

Search for JCL words based on a search term.

Recipe source​

GitHub: FindWord.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.SYSOUT or sys.*
BooleanexactMatchSearch for a word based on an exact match of the search term.true

Example​

Parameters​
ParameterValue
searchTermDD
exactMatchtrue
Before​
//JOB1 JOB ,'H.H. MORRILL'
//SYSPRINT DD SYSOUT=*
After​
//JOB1 JOB ,'H.H. MORRILL'
//SYSPRINT ~~>DD SYSOUT=*

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.FindWordExample. 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.FindWordExample
displayName: Find matching words in JCL source code example
recipeList:
  - org.openrewrite.jcl.search.FindWord:
      searchTerm: SYSOUT or sys.*
      exactMatch: true

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

  1. Add the following to your build.gradle file:
    build.gradle
    plugins {
        id("org.openrewrite.rewrite") version("latest.release")
    }

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

    repositories {
        mavenCentral()
    }

    dependencies {
        rewrite("org.openrewrite:rewrite-cobol:2.17.0")
    }
  2. 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​

JCL word search results​

org.openrewrite.jcl.table.JclWordSearchResult

Words in JCL source code that match the search criteria.

Column NameDescription
Source pathThe source path of the file that contains the matching word.
Matched wordThe word text that matched the search criteria.