\n\n# TemplGen\n\n\n\nExtensible template based file generator\n\n
\n\n\n\n
\n\n
\n\n\n\nTemplGen is a small and extensible template based file generator module that\nprovides a simple API for creating code scaffolding tools.\n\nIt borrows some ideas from [Nx][1] but it is meant to be used as a\nbuilding block for creating CLI tools rather than being a full fledged tool\nitself.\n\n## Features\n\n- ESM and CommonJS support\n- Support for copying binary files as well as rendering template files\n- Variable substitution in file names\n- Use EJS (by default) or [any other template engine][2]\n- Overridable file system methods. You can [override][3] the default functions used\n to create directories, read files, write files, and copy files. That is\n useful for [testing][4], logging, implementing interactive prompts, etc.\n\n## Installation\n\n```bash\nnpm install --save templgen\n```\n\n## Usage\n\n```javascript\nimport { FileGenerator } from \"templgen\";\n\nconst sourceDirectory = \"/source/directory\";\nconst targetDirectory = \"/target/directory\";\nconst files = [\n // Will be copied to /target/directory/copy_as_is\n \"/source/directory/copy_as_is\",\n // Will be rendered with EJS and written to /target/directory/render_with_ejs\n \"/source/directory/render_with_ejs.template\",\n // Will be copied to /target/directory/subdir/replaced.txt\n \"/source/directory/subdir/__variable__.txt\",\n];\nconst variables = {\n variable: \"replaced\",\n};\n\nconst fileGenerator = new FileGenerator();\nawait fileGenerator.generate(\n sourceDirectory,\n targetDirectory,\n files,\n variables,\n);\n```\n\nSee [example](./example) for a working example.\n\n### Advanced Usage\n\n#### Custom File System Functions\n\n```javascript\nimport fs from \"node:fs\";\nimport { FileGenerator } from \"templgen\";\n\nconst sourceDirectory = \"/source/directory\";\nconst targetDirectory = \"/target/directory\";\nconst files = [\"/source/directory/render_with_ejs.template\"];\nconst variables = {\n variable: \"replaced\",\n};\n\nconst myWriteFile = async (filePath, ...arguments_) => {\n console.log(`Writing file: ${path.relative(targetDirectory, filePath)}`);\n // you can show a prompt here\n return fs.promises.writeFile(filePath, ...arguments_);\n};\nconst myCopyFile = async (sourcePath, destinationPath, ...arguments_) => {\n console.log(\n `Writing file: ${path.relative(targetDirectory, destinationPath)}`,\n );\n // you can show a prompt here\n return fs.promises.copyFile(sourcePath, destinationPath, ...arguments_);\n};\n\nconst fileGenerator = new FileGenerator({\n writeFile: myWriteFile,\n copyFile: myCopyFile,\n // you can override mkdir and readFile too\n});\n\nawait fileGenerator.generate(\n sourceDirectory,\n targetDirectory,\n files,\n variables,\n);\n```\n\n#### Custom Template Engine\n\n```javascript\nimport Handlebars from \"handlebars\";\nimport { FileGenerator } from \"templgen\";\n\nconst sourceDirectory = \"/source/directory\";\nconst targetDirectory = \"/target/directory\";\nconst files = [\n // Will be rendered with custom template engine and written to /target/directory/render_with_custom\n \"/source/directory/render_with_custom.template\",\n];\nconst variables = {\n variable: \"replaced\",\n};\n\nconst fileGenerator = new FileGenerator({\n render: async (template, variables, paths) => {\n // The paths in the paths object can be used for caching, logging, etc.\n console.log(paths);\n\n return Handlebars.compile(template)(variables);\n },\n});\n\nawait fileGenerator.generate(\n sourceDirectory,\n targetDirectory,\n files,\n variables,\n);\n```\n\n[1]: https://nx.dev/core-features/plugin-features/use-code-generators\n[2]: #custom-template-engine\n[3]: #custom-file-system-functions\n[4]: ./src/index.test.ts\n","readmeFilename":"README.md"}
![\"TemplGen](\"./media/logo.png\"){kind=logo}
\n\nExtensible template based file generator\n\n![\"templgen\"](\"https://img.shields.io/npm/v/templgen\")
![\"templgen\"](\"https://img.shields.io/npm/dm/templgen\")
![\"test](\"https://img.shields.io/github/actions/workflow/status/fardjad/node-templgen/test-and-release.yml?branch=main\")
\n\n