fileContents
Enforce that each package has a file with certain contents enforced by either a template or generator.
Options
file- Name of the file
generator(Optional)- Function that can generate the file
template(Optional)- Expected file contents
templateFile(Optional)- Path to a file to use as a template
Exactly one of generator, template, or templateFile needs to be specified.
Example
import { fileContents } from "@monorepolint/rules";
export default {
rules: [
fileContents({
options: {
file: "jest.config.js",
templateFile: "./templates/jest.config.js",
},
}),
fileContents({
options: {
file: "foo.txt",
template: "Hi mom",
},
}),
fileContents({
options: {
file: "badFile.txt",
template: undefined, // delete file
},
}),
// TODO: Generator example
],
};