1
0
mirror of https://github.com/locomotivemtl/locomotive-boilerplate.git synced 2026-01-15 00:55:08 +08:00

Refactor template.js

Added:
- Function `resolve()` to process any template tags (in a string) in objects and arrays.

Changed:
- Renamed function `template()` to `resolveValue()`.
- Replaced default export `resolveValue()` with new function `resolve()`.
This commit is contained in:
Chauncey McAskill
2022-03-22 16:08:29 -04:00
parent d49d3eabb2
commit 48bd911804
6 changed files with 63 additions and 25 deletions

View File

@@ -2,7 +2,7 @@ import loconfig from '../../loconfig.json';
import glob from '../utils/glob.js';
import message from '../utils/message.js';
import notification from '../utils/notification.js';
import template from '../utils/template.js';
import resolve from '../utils/template.js';
import concat from 'concat';
import {
basename,
@@ -98,8 +98,8 @@ export default async function concatFiles(globOptions = null, concatOptions = nu
console.time(timeLabel);
try {
includes = includes.map((path) => template(path));
outfile = template(outfile);
includes = resolve(includes);
outfile = resolve(outfile);
let files;

View File

@@ -1,7 +1,7 @@
import loconfig from '../../loconfig.json';
import message from '../utils/message.js';
import notification from '../utils/notification.js';
import template from '../utils/template.js';
import resolve from '../utils/template.js';
import esbuild from 'esbuild';
import { basename } from 'node:path';
@@ -67,12 +67,12 @@ export default async function compileScripts(esBuildOptions = null) {
console.time(timeLabel);
try {
includes = includes.map((path) => template(path));
includes = resolve(includes);
if (outdir) {
outdir = template(outdir);
outdir = resolve(outdir);
} else if (outfile) {
outfile = template(outfile);
outfile = resolve(outfile);
} else {
throw new TypeError(
'Expected \'outdir\' or \'outfile\''

View File

@@ -2,7 +2,7 @@ import loconfig from '../../loconfig.json';
import message from '../utils/message.js';
import notification from '../utils/notification.js';
import postcss, { pluginsMap as postcssPluginsMap } from '../utils/postcss.js';
import template from '../utils/template.js';
import resolve from '../utils/template.js';
import { writeFile } from 'node:fs/promises';
import { basename } from 'node:path';
import { promisify } from 'node:util';
@@ -106,8 +106,8 @@ export default async function compileStyles(sassOptions = null, postcssOptions =
console.time(timeLabel);
try {
infile = template(infile);
outfile = template(outfile);
infile = resolve(infile);
outfile = resolve(outfile);
let result = await sassRender(Object.assign({}, sassOptions, {
file: infile,

View File

@@ -1,7 +1,7 @@
import loconfig from '../../loconfig.json';
import message from '../utils/message.js';
import notification from '../utils/notification.js';
import template from '../utils/template.js';
import resolve from '../utils/template.js';
import { basename } from 'node:path';
import mixer from 'svg-mixer';
@@ -60,8 +60,8 @@ export default async function compileSVGs(mixerOptions = null) {
console.time(timeLabel);
try {
includes = includes.map((path) => template(path));
outfile = template(outfile);
includes = resolve(includes);
outfile = resolve(outfile);
const result = await mixer(includes, mixerOptions);

View File

@@ -14,17 +14,53 @@ const templateData = flatten({
* If replacement pairs contain a mix of substrings, regular expressions,
* and functions, regular expressions are executed last.
*
* @param {string} input - The string being searched and replaced on.
* @param {object} data - An object in the form `{ 'from': 'to', … }`.
* @param {*} input - The value being searched and replaced on.
* If input is, or contains, a string, tags will be resolved.
* If input is, or contains, an object, it is mutated directly.
* If input is, or contains, an array, a shallow copy is returned.
* Otherwise, the value is left intact.
* @param {object} [data] - An object in the form `{ 'from': 'to', … }`.
* @return {*} Returns the transformed value.
*/
export default function resolve(input, data = templateData) {
switch (typeof input) {
case 'string': {
return resolveValue(input, data);
}
case 'object': {
if (input == null) {
break;
}
if (Array.isArray(input)) {
return input.map((value) => resolve(value, data));
} else {
for (const key in input) {
input[key] = resolve(input[key], data);
}
}
}
}
return input;
}
/**
* Replaces all template tags in a string from a map of keys and values.
*
* If replacement pairs contain a mix of substrings, regular expressions,
* and functions, regular expressions are executed last.
*
* @param {string} input - The string being searched and replaced on.
* @param {object} [data] - An object in the form `{ 'from': 'to', … }`.
* @return {string} Returns the translated string.
*/
export default function template(input, data) {
export function resolveValue(input, data = templateData) {
const tags = [];
if (data) {
if (data !== templateData) {
data = flatten(data);
} else {
data = templateData;
}
for (let tag in data) {
@@ -55,7 +91,7 @@ export default function template(input, data) {
return '';
});
};
}
/**
* Creates a new object with all nested object properties

View File

@@ -3,7 +3,7 @@ import concatFiles, { developmentConcatFilesArgs } from './tasks/concats.js';
import compileScripts, { developmentScriptsArgs } from './tasks/scripts.js';
import compileStyles, { developmentStylesArgs } from './tasks/styles.js' ;
import compileSVGs, { developmentSVGsArgs } from './tasks/svgs.js';
import template from './utils/template.js';
import resolve from './utils/template.js';
import server from 'browser-sync';
import { join } from 'node:path';
@@ -71,10 +71,12 @@ server.watch(
// Watch source concats
server.watch(
tasks.concats.reduce(
(patterns, { includes }) => patterns.concat(includes),
[]
).map((path) => template(path))
resolve(
tasks.concats.reduce(
(patterns, { includes }) => patterns.concat(includes),
[]
)
)
).on('change', () => {
concatFiles(...developmentConcatFilesArgs);
});