Merge pull request #47 from gsandf/feature/add-rendering-folders

✨ add `renderGlob` and `renderToFolder`

Author: blakek

.eslintignore

@@ -1 +1,2 @@
 dist/*
+__tests/helpers/output/

.gitignore

@@ -3,6 +3,8 @@ node_modules
 
 # Built code
 dist/
+__tests__/helpers/output/
+__tests__/helpers/large/
 
 # Logs
 logs

__tests__/helpers/templates/also-cool.json

@@ -0,0 +1 @@
+{ "fullName": "{{ name }}" }

__tests__/helpers/templates/cool.md

@@ -0,0 +1 @@
+# Hello, {{name}}!

__tests__/helpers/templates/not-rendered.txt

@@ -0,0 +1 @@
+This {{ name }} is not changed.

__tests__/index.ts

@@ -1,7 +1,14 @@
 import test from 'ava';
 import { promises as fs } from 'fs';
+import mkdirp from 'mkdirp';
 import path from 'path';
-import { renderString, renderTemplateFile } from '../src';
+import {
+  renderGlob,
+  renderString,
+  renderTemplateFile,
+  renderToFolder
+} from '../src';
+import { limitOpenFiles } from '../src/utils';
 
 test('Data is replaced when given string', t => {
   // Should return the same without regard of consistent spacing
@@ -67,3 +74,91 @@ test('Data is replaced when given file path', async t => {
 
   t.is(actual, expected);
 });
+
+test('Renders from a glob', async t => {
+  const actualFiles: { name: string; contents: string }[] = [];
+  const expectedFiles = [
+    {
+      name: './__tests__/helpers/templates/also-cool.json',
+      contents: '{ "fullName": "Bob" }\n'
+    },
+    {
+      name: './__tests__/helpers/templates/cool.md',
+      contents: '# Hello, Bob!\n'
+    }
+  ];
+
+  await renderGlob(
+    './__tests__/helpers/templates/**/*.!(txt)',
+    { name: 'Bob' },
+    (name, contents) => {
+      actualFiles.push({ name, contents });
+    }
+  );
+
+  t.is(actualFiles.length, 2);
+
+  if (actualFiles[0].name === expectedFiles[0].name) {
+    t.deepEqual(actualFiles, expectedFiles);
+  } else {
+    t.deepEqual(actualFiles.reverse(), expectedFiles);
+  }
+});
+
+test('Can render output to a file', async t => {
+  const expectedFiles = [
+    {
+      name: './__tests__/helpers/output/also-cool.json',
+      contents: '{ "fullName": "Kai" }\n'
+    },
+    {
+      name: './__tests__/helpers/output/cool.md',
+      contents: '# Hello, Kai!\n'
+    }
+  ];
+
+  await renderToFolder(
+    './__tests__/helpers/templates/**/*.!(txt)',
+    './__tests__/helpers/output',
+    { name: 'Kai' }
+  );
+
+  for (const { name, contents } of expectedFiles) {
+    const actualContents = await fs.readFile(name, { encoding: 'utf-8' });
+    t.is(actualContents, contents);
+  }
+});
+
+test('Can render a ton of files', async t => {
+  const expectedFiles = [] as { name: string; contents: string }[];
+
+  // Pre-test setup
+  const templateFolder = './__tests__/helpers/large/';
+  const outputFolder = `${templateFolder}/output`;
+  const template = 'Hello, {{ name }}';
+
+  await mkdirp(templateFolder);
+  await Promise.all(
+    Array.from({ length: 50000 }, (_, i) => {
+      const basename = `${i}.template`;
+
+      expectedFiles.push({
+        name: `${outputFolder}/${basename}`,
+        contents: 'Hello, Test'
+      });
+
+      return limitOpenFiles(() =>
+        fs.writeFile(`${templateFolder}/${basename}`, template)
+      );
+    })
+  );
+
+  await renderToFolder(`${templateFolder}/*.template`, outputFolder, {
+    name: 'Test'
+  });
+
+  for (const { name, contents } of expectedFiles) {
+    const actualContents = await fs.readFile(name, { encoding: 'utf-8' });
+    t.is(actualContents, contents);
+  }
+});

package.json

@@ -39,7 +39,8 @@
     ],
     "require": [
       "ts-node/register"
-    ]
+    ],
+    "timeout": "30s"
   },
   "browserslist": [
     ">0.2%",
@@ -50,6 +51,7 @@
     "@blakek/deep": "^2.1.1",
     "glob": "^7.1.6",
     "meow": "^8.0.0",
+    "mkdirp": "^1.0.4",
     "p-limit": "^3.1.0"
   },
   "devDependencies": {
@@ -63,6 +65,7 @@
     "@rollup/plugin-node-resolve": "^11.0.0",
     "@rollup/plugin-typescript": "^8.0.0",
     "@types/glob": "^7.1.3",
+    "@types/mkdirp": "^1.0.1",
     "@typescript-eslint/eslint-plugin": "^4.9.0",
     "@typescript-eslint/parser": "^4.9.0",
     "amper-scripts": "^1.0.0-1",

src/cli.ts

@@ -1,17 +1,10 @@
 #!/usr/bin/env node
 
-import { promises as fs } from 'fs';
-import _glob from 'glob';
 import meow from 'meow';
-import pLimit from 'p-limit';
 import path from 'path';
-import { promisify } from 'util';
-import { renderTemplateFile } from '.';
+import { renderToFolder } from '.';
 
 async function main() {
-  const glob = promisify(_glob);
-  const limitOpenFiles = pLimit(64);
-
   const cli = meow(`
     Usage
       $ template-file <dataFile> <sourceGlob> <destination>
@@ -36,21 +29,7 @@ async function main() {
   const [dataFile, sourceGlob, destination] = cli.input;
   const data = await import(path.resolve(dataFile));
 
-  function renderToFile(file: string, destination: string) {
-    return limitOpenFiles(() =>
-      renderTemplateFile(file, data).then(renderedString =>
-        fs.writeFile(destination, renderedString)
-      )
-    );
-  }
-
-  glob(sourceGlob)
-    .then(files =>
-      files.map(file =>
-        renderToFile(file, path.join(destination, path.basename(file)))
-      )
-    )
-    .then(fileWriteOperations => Promise.all(fileWriteOperations));
+  renderToFolder(sourceGlob, destination, data);
 }
 
 main();

src/index.ts

@@ -1,12 +1,31 @@
 import { get } from '@blakek/deep';
 import { promises as fs } from 'fs';
+import _glob from 'glob';
+import mkdirp from 'mkdirp';
+import path from 'path';
+import { promisify } from 'util';
+import { limitOpenFiles } from './utils';
 
 interface Data
   extends Record<
     string | number | symbol,
     string | number | Data | (() => string | number | Data)
   > {}
 
+export async function renderGlob(
+  sourceGlob: string,
+  data: Data,
+  onFileCallback: (filename: string, contents: string) => void
+): Promise<void> {
+  const glob = promisify(_glob);
+  const files = await glob(sourceGlob);
+
+  for (const file of files) {
+    const contents = await limitOpenFiles(() => renderTemplateFile(file, data));
+    onFileCallback(file, contents);
+  }
+}
+
 export function renderString(
   template: string,
   data: Data
@@ -35,3 +54,18 @@ export async function renderTemplateFile(
   const templateString = await fs.readFile(filepath, { encoding: 'utf-8' });
   return renderString(templateString, data);
 }
+
+export async function renderToFolder(
+  sourceGlob: string,
+  destination: string,
+  data: Data
+): Promise<void> {
+  await mkdirp(destination);
+
+  function writeFile(filename: string, contents: string) {
+    const fullPath = path.join(destination, path.basename(filename));
+    fs.writeFile(fullPath, contents);
+  }
+
+  return renderGlob(sourceGlob, data, writeFile);
+}

src/utils.ts

@@ -0,0 +1,5 @@
+import pLimit from 'p-limit';
+
+const OPEN_FILE_LIMIT = Number(process.env.TF_FILE_LIMIT) || 1024;
+
+export const limitOpenFiles = pLimit(OPEN_FILE_LIMIT);