Fixes

October 1, 2020 ยท View on GitHub

Below is a complete list of fixes that Repolinter can run, along with their configuration options.

Contents

Reference

file-create

Creates a file. Optionally removes or replaces files that failed.

InputRequiredTypeDefaultDescription
fileYesstringThe file to create. Path can be relative to the repository or absolute.
textYesstring | { url: string } | { file: string }The text to create the file with. Specify an object with the url or file property to pull text from a URL or file.
replaceNobooleanfalseSet to true to remove all failing files, as indicated by the rule.

file-modify

Modify a file that failed a rule.

InputRequiredTypeDefaultDescription
textYesstring | { url: string } | { file: string }The text to create the file with. Specify an object with the url or file property to pull text from a URL or file.
filesNostring[]Failing files specified by the ruleA list of globs to modify files with. If this value is omitted, file-modify will instead target files that failed the rule.
skip-paths-matchingNo{ extensions?: string[], patterns?: string[], flags?: string }{}Use this option to exclude paths from files, either by file extension or by regular expression.
write_modeNo"prepend" | "append""append"How file-modify should edit the file.
newlinesNo{ begin?: number, end?: number }{ begin: 0, end: 0 }How many newlines should be added to the start or end of text. This property allows formatters to print text without these newlines, creating a better user experience.

file-remove

Removes a file or files.

InputRequiredTypeDefaultDescription
globsAllNostring[]Failing files specified by the ruleThe list of globs to remove files for. If this value is omitted, file-remove will instead target files that failed the rule.
nocaseNobooleanfalseSet to true to perform an case insensitive search with globsAll.