StandardizeFilesOptions
Defined in: types.ts:93
Properties
Section titled “Properties”config
Section titled “config”config:
SetupConfig
Defined in: types.ts:94
gitignoreHeader?
Section titled “gitignoreHeader?”
optionalgitignoreHeader?:string
Defined in: types.ts:103
Prepended to the composed .gitignore. Omit to skip writing a .gitignore header (the file
is still written when at least one gitignore template contributed content).
jsonMergeFiles?
Section titled “jsonMergeFiles?”
optionaljsonMergeFiles?:string[]
Defined in: types.ts:118
Glob patterns, matched against the resolved relative destination path, whose target JSON is
deep-merged with the template JSON on write — the target’s existing values win on conflict
(including arrays, replaced outright rather than merged element-wise), and only keys the
template has that the target doesn’t are added. Checked before customization-block detection,
so a JSON file doesn’t need # -- START/END CUSTOMIZATION markers to be preserved.
projectPath?
Section titled “projectPath?”
optionalprojectPath?:string
Defined in: types.ts:98
Defaults to the nearest ancestor directory containing a package.json, else process.cwd().
protectedFiles?
Section titled “protectedFiles?”
optionalprotectedFiles?:string[]
Defined in: types.ts:110
Glob patterns, matched against the resolved relative destination path, that are only ever created, never overwritten once they exist.
regexCustomizations?
Section titled “regexCustomizations?”
optionalregexCustomizations?:RegexCustomization[]
Defined in: types.ts:123
Regex-scoped customization rules — see RegexCustomization. Checked before jsonMergeFiles
and customization-block detection.
renameFile?
Section titled “renameFile?”
optionalrenameFile?: (destRelativePath) =>string
Defined in: types.ts:105
Maps a template’s relative destination path to a different one, e.g. dropping a leading dot.
Parameters
Section titled “Parameters”destRelativePath
Section titled “destRelativePath”string
Returns
Section titled “Returns”string
templatesPath
Section titled “templatesPath”templatesPath:
string
Defined in: types.ts:96
Directory of feature packs — see this package’s README for the expected shape.
transformFile?
Section titled “transformFile?”
optionaltransformFile?: (context) =>string
Defined in: types.ts:125
Rewrites a copied file’s content before it’s written; return content unchanged to skip.
Parameters
Section titled “Parameters”context
Section titled “context”Returns
Section titled “Returns”string