Skip to content

Repository files navigation

markup-generator AKA WRITE!

Simple TypeScript helper for generating unique filenames and writing HTML (or any text) to disk.

Requires Node.js >= 20.

Install

npm install markup-generator

Library

import { writeGeneratedFile, generateFileName } from 'markup-generator';

const fileName = generateFileName('newsletter');
const path = await writeGeneratedFile({
  content: '<html></html>',
  fileName,
  dir: 'generated',
});

Paths are resolved from process.cwd(). Missing directories are created. Encoding is UTF-8. Default overwrite policy is replace.

CLI

npx markup-generator name --prefix newsletter --ext html
npx markup-generator write --file ./in.html --prefix newsletter --dir generated

Example

npm install
npm run example

Errors

Thrown errors are MarkupGeneratorError with code: EMPTY_CONTENT, NOT_A_STRING, FILE_EXISTS, WRITE_FAILED.

See MIGRATION.md for 3.0.0 notes.

License

MIT

About

module for writing content into files

Topics

Resources

Contributing

Stars

0 stars

Watchers

1 watching

Forks

Releases

Used by

Contributors

Languages