Skip to content

Commit

Permalink
Incorporate review feedback
Browse files Browse the repository at this point in the history
Co-authored-by: Johnathan Gilday <[email protected]>
  • Loading branch information
drdavella and gilday authored Jul 30, 2024
1 parent bdedd72 commit 83c74b3
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ The `executable` could involve multiple command line tokens (e.g., `npm run` or

The `--path-include` and `--path-exclude` patterns are interpreted as relative to the given `<project directory>`. In practice this means that the patterns should be joined with the `<project directory>` when used internally and also when passed to external tools.

In general, codemods that remediate the results of other tools should respect the file paths specified in findings by those tools. Explicit configuration provided by the user via `--path-include` and `--path-exclude` can be used to filter the applicable results. Remediation codemods should generally not impose their own defaults. The philosophy here is that an external tool has its own defaults and/or configuration, and this should be respected by codemodder.
In general, codemods that remediate the results of other tools respect the file paths specified in findings by those tools. Explicit configuration provided by the user via `--path-include` and `--path-exclude` takes precedence over any defaults a codemod may define. Remediation codemods must not impose their own defaults: the philosophy here is that an external tool has its own defaults and/or configuration, and this should be respected by codemodder.

Codemods that perform their own detection (i.e. "find-and-fix" codemods) may wish to define reasonable defaults for the paths to be included and excluded for analysis. It is recommended that such codemods should include only relevant source files and ignore test directories and build artifacts by default. For example, such codemods will generally want to exclude `**/tests/**` by default. This will be interpreted relative to the given `<project directory>`, which means that the effective pattern will be `<project directory>/**/tests/**`.

Expand Down

0 comments on commit 83c74b3

Please sign in to comment.