Moderne OnlyThis recipe is proprietary to Moderne and runs on the Moderne platform or CLI — it isn’t part of the open-source catalog. Available with a Moderne subscription.Contact Sales

Find a search term in the source or by name

Recipe IDio.moderne.mainframe.search.FindText

Artifactio.moderne.recipe:recipes-mainframe

Report every place a search term matches, with the file and the line, and mark each one in the source. The interactive search is the trigram index the CLI builds, and this is not a second engine: it is the same question asked so that the answer can be counted and exported, which is what a parity run against an existing search tool compares. What it has that an index over printed text does not is the tree — a literal continued across a column-7 break is one string, a comment is text rather than a line to skip, and a variable name resolves to the item, so a search for a quoted name finds where it is used and not where it is declared. Searching by name instead finds the declaration: a data name nothing in the program refers to is not a result, and a SET of a level-88 condition refers to the item it is declared under. Names of programs, copybooks and the other components are FindNames, which types them; this reports the identifiers and the text.

Single recipeOpenRewriteModerne Proprietary License

Try in PlatformTry this recipe in the Moderne platform. Not a user yet? You’ll get a no-setup demo environment, with nothing to install or configure.

Options

3 parameters

1 required2 optional

Parameter	Example	Type	Required
searchTerm	"open input" close	String	Required
What to look for. A term matches whole tokens, and a period, a hyphen and an underscore each end one, so ACCT finds WS-ACCT-ID and ACC finds nothing. Terms separated by a space are alternatives and a hit on any of them is a hit; quotes make one phrase of what they hold, matched in order and across a line break, a comment's asterisks and a column-7 continuation. A quoted variable name asks where the variable is used, so the declaration is left out.
mode	—	String	Optional
SOURCE to search the text a program is written in, which finds every occurrence, or NAME to search the names it declares, which finds the declaration. Defaults to SOURCE.
scope	—	String	Optional
Which layer of the text to read: ALL, SOURCE_WITHOUT_COMMENTS, COMMENTS_ONLY, STRINGS_AND_LITERALS, or DOCUMENTATION for the run book members and nothing else. Defaults to ALL. Outside COBOL a line is code or comment and nothing finer, so a scope of strings and literals finds nothing in JCL, BMS or a control card.

Usage

Run this recipe

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

shell

mod run . --recipe FindText --recipe-option "searchTerm="open input" close"

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

RELEASE resolves to the newest release and LATEST to the newest build of any kind, including snapshots. Either one lets mod config recipes upgrade pull in later versions without editing this command; a pinned version stays where you put it.

RELEASE

mod config recipes jar install io.moderne.recipe:recipes-mainframe:RELEASE

LATEST

mod config recipes jar install io.moderne.recipe:recipes-mainframe:LATEST

Pinned version

mod config recipes jar install io.moderne.recipe:recipes-mainframe:0.1.0

Data tables

Search matches

io.moderne.mainframe.analysis.table.SearchMatches

Every place a search term matches, with the line it is on. Core TextMatches says which file matched and what the match read; a parity count is compared per member and per line, which is what this adds.

Export after a run

mod study . --last-recipe-run \
  --data-table io.moderne.mainframe.analysis.table.SearchMatches

Column	Description
Source path	The file the match is in. A match in a copybook belongs to the copybook, not to the programs that copy it.
Line	The line within the source path, counted from 1, or 0 where the match could not be placed. A phrase continued across a column-7 break is reported on the line it starts on.
Layer	The text the match is in: CODE, COMMENT, STRING_LITERAL or NUMERIC_LITERAL. Outside COBOL a line is code or comment and nothing finer, so a scope of strings and literals finds nothing there.
Match	The tokens that matched, as written and separated by a space. A phrase reads as one match however many lines it was written across.
Context	The line the match is on, as written.

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Export after a run

mod study . --last-recipe-run \
  --data-table org.openrewrite.table.SourcesFileResults

Column	Description
Source path before the run	The source path of the file before the run. null when a source file was created during the run.
Source path after the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changes	In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changes	The specific recipe that made a change.
Estimated time saving	An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
Cycle	The recipe cycle in which the change was made.

Source files that had search results

org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

Export after a run

mod study . --last-recipe-run \
  --data-table org.openrewrite.table.SearchResults

Column	Description
Source path of search result before the run	The source path of the file with the search result markers present.
Source path of search result after run the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Result	The trimmed printed tree of the LST element that the marker is attached to.
Description	The content of the description of the marker.
Recipe that added the search marker	The specific recipe that added the Search marker.

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Export after a run

mod study . --last-recipe-run \
  --data-table org.openrewrite.table.SourcesFileErrors

Column	Description
Source path	The file that failed to parse.
Recipe that made changes	The specific recipe that made a change.
Stack trace	The stack trace of the failure.

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Export after a run

mod study . --last-recipe-run \
  --data-table org.openrewrite.table.RecipeRunStats

Column	Description
The recipe	The recipe whose stats are being measured both individually and cumulatively.
Source file count	The number of source files the recipe ran over.
Source file changed count	The number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time (ns)	The total time spent across the scanning phase of this recipe.
Max scanning time (ns)	The max time scanning any one source file.
Cumulative edit time (ns)	The total time spent across the editing phase of this recipe.
Max edit time (ns)	The max time editing any one source file.