Create TOML file
Recipe ID
org.openrewrite.toml.CreateTomlFileArtifact
org.openrewrite:rewrite-tomlCreate a new TOML file.
Usage
You’ll need the Moderne CLI configured before running the command below.
mod run . --recipe org.openrewrite.toml.CreateTomlFile --recipe-option "relativeFileName=pyproject.toml"If the recipe isn’t available locally, install it with:
mod config recipes jar install org.openrewrite:rewrite-toml:8.88.0Options
| Name | Type | Description |
|---|---|---|
relativeFileNamerequired | String | File path of the new file. e.g. pyproject.toml |
fileContents | String | Multiline text content for the file. e.g. [tool.poetry]
name = "my-project"
version = "0.1.0" |
fileContentsUrl | String | URL to fetch the TOML file contents from a remote source. e.g. https://raw.githubusercontent.com/example/repo/main/pyproject.toml |
overwriteExisting | Boolean | If there is an existing file, should it be overwritten? |
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