Skip to content

servexyz/file-genesis

Repository files navigation

logo

Build Status

Install


yarn add file-genesis

Use


const path = require("path");
const { File } = require("file-genesis");
const gitignore = `
  .DS_Store
  node_modules
`;

let filepathPlain = path.join(__dirname, ".gitignore");
File(filepathPlain).plain(gitignore);

Note: Prettier is used for formatting during creation


API


.plain(), .symlink(), .template()

This is used to specify the type and pass content

plain

File("/path/to/file.ext").plain("content");

symlink

File("/path/to/file.ext").symlink("/path/to/src", "/path/to/dest");

template

let variables = { replaceMe: "withThisValue" };
File("/path/to/file.ext").template("path/to/template.ext", variables);

Docs



Goals


  • consistent api for symlinks, plain UTF-8 files and templates
  • interoperable with content-genesis

Related