Remove ignoral of files or directories from .gitignore
Recipe ID
org.openrewrite.ExcludeFileFromGitignoreArtifact
org.openrewrite:rewrite-coreThis recipe will remove a file or directory from the .gitignore file. If the file or directory is already in the .gitignore file, it will be removed or negated. If the file or directory is not in the .gitignore file, no action will be taken.
Usage
You’ll need the Moderne CLI configured before running the command below.
mod run . --recipe org.openrewrite.ExcludeFileFromGitignore --recipe-option "paths=/folder/file.txt"If the recipe isn’t available locally, install it with:
mod config recipes jar install org.openrewrite:rewrite-core:8.88.0Options
| Name | Type | Description |
|---|---|---|
pathsrequired | List | The paths to find and remove from the gitignore files. e.g. /folder/file.txt |
Data tables
Structured output this recipe can produce.
- Source files that had resultsSource files that were modified by the recipe run.
org.openrewrite.table.SourcesFileResults - Source files that had search resultsSearch results that were found during the recipe run.
org.openrewrite.table.SearchResults - Source files that errored on a recipeThe details of all errors produced by a recipe run.
org.openrewrite.table.SourcesFileErrors - Recipe performanceStatistics used in analyzing the performance of recipes.
org.openrewrite.table.RecipeRunStats