appsettings.StormPetrel.json (SchemaStore) JSON Schema

Type	object
File match	`appsettings.StormPetrel.json`
Schema URL	https://catalog.lintel.tools/schemas/schemastore/appsettings-stormpetrel-json/latest.json
Source	https://raw.githubusercontent.com/Scandltd/storm-petrel/main/generator/assets/appsettings.StormPetrel.Schema.json

Validate with Lintel

npx @lintel/lintel check

Type: object

See more details in Configuration Documentation: https://github.com/Scandltd/storm-petrel/blob/main/generator/README.md#configuration

Properties

TargetProjectGeneratorExpression string

[optional] string, configures the default Generator. An expression for the IGenerator instance.

GeneratorConfig object | null

[optional] object to configure Generator behavior.

3 nested properties

BackuperExpression string | null

[optional] string, instantiates GeneratorBackuper by default. An expression for the IGeneratorBackuper instance. Set to 'null' to skip creating backup files.

DumperExpression string

[optional] string, instantiates GeneratorDumper by default. An expression for the IGeneratorDumper instance.

RewriterExpression string

[optional] string, instantiates GeneratorRewriter by default. An expression for the IGeneratorRewriter instance.

IsDisabled boolean

[optional] boolean, false is by default. Indicates whether the generator should create 'StormPetrel' classes. Even if set to 'false', the generator still adds classes like 'IGeneratorDumper', 'GeneratorDumper' to avoid test project compilation failures in the case when custom classes uses them.

IgnoreFilePathRegex string | null

[optional] string, empty by default. Regular Expression to exclude certain paths from 'StormPetrel' class generation.

IgnoreInvocationExpressionRegex string | null

[optional] string, empty by default. Regular Expression to detect invocation expressions to not execute StormPetrel rewriting for.

TestVariablePairConfigs object[]

[optional] array of objects. Configures naming pairs for actual/expected variables to generate correct expected baselines.

Definitions

targetProjectGeneratorExpression string

[optional] string, configures the default Generator. An expression for the IGenerator instance.

generatorConfig object | null

[optional] object to configure Generator behavior.

BackuperExpression string | null

[optional] string, instantiates GeneratorBackuper by default. An expression for the IGeneratorBackuper instance. Set to 'null' to skip creating backup files.

DumperExpression string

[optional] string, instantiates GeneratorDumper by default. An expression for the IGeneratorDumper instance.

RewriterExpression string

[optional] string, instantiates GeneratorRewriter by default. An expression for the IGeneratorRewriter instance.

isDisabled boolean

ignoreFilePathRegex string | null

[optional] string, empty by default. Regular Expression to exclude certain paths from 'StormPetrel' class generation.

ignoreInvocationExpressionRegex string | null

[optional] string, empty by default. Regular Expression to detect invocation expressions to not execute StormPetrel rewriting for.

isAddNullableEnable boolean

[optional] boolean, true is by default. Indicates whether the generator should add #nullable enable and related directives under #if !NETFRAMEWORK || SCAND_STORM_PETREL_NULLABLE_ENABLE condition to auto-generated StormPetrel' files. This allows to avoid related compiler warnings/errors since auto-generated code has nullable reference types disabled regardless project global settings.

testVariablePairConfigs object[]

[optional] array of objects. Configures naming pairs for actual/expected variables to generate correct expected baselines.

serilog object | null

[optional] Logging configuration using Serilog. Defaults to logging warnings to the test project's Logs folder. Set to 'null' to disable logging. Use the '{StormPetrelRootPath}' token to indicate the target test project root path.