@hibi_10000/grunt-webfont 2.0.1 → 2.1.0

package/tasks/webfont.ts

@@ -10,42 +10,32 @@ import path from 'node:path';
 import crypto from 'node:crypto';
 import { globSync } from 'glob';
 import chalk from 'chalk';
-import _ from 'lodash';
+import { Eta } from 'eta';
 import ttf2woff2 from 'ttf2woff2';
 
 import fontforge from './engines/fontforge.ts';
 import node from './engines/node.ts';
 import * as wf from './util/util.ts';
-import type { Logger, CustomOutput, TemplateOptions, Config, Options, OptionsInternal, Context } from './types.ts';
+import type { Logger, FontFormat, CustomOutput, TemplateOptions, Config, Options, OptionsInternal, Context } from './types.ts';
 
 import packageJson from '../package.json' with { type: "json" };
 
-export default (grunt: IGrunt): void => {
+export const webfontGrunt = (grunt: IGrunt): void => {
 	grunt.registerMultiTask('webfont', 'Compile separate SVG files to webfont', function() {
 		/**
 		 * Consola to Grunt logger adapter.
 		 */
 		const logger: Logger = {
 			log: {
-				warn: (...args) => {
-					grunt.log.warn.apply(null, args);
-				},
-				error: (...args) => {
-					grunt.warn.apply(null, args);
-				},
-				info: (...args) => {
-					grunt.log.writeln.apply(null, args);
-				},
-				verbose: (...args) => {
-					grunt.log.verbose.writeln.apply(null, args);
-				},
+				error: grunt.warn,
+				warn: grunt.log.warn,
+				info: grunt.log.writeln,
+				verbose: grunt.log.verbose.writeln,
 			},
 			fail: {
-				fatal: (...args) => {
-					grunt.fail.fatal.apply(null, args);
-				},
+				fatal: grunt.fail.fatal,
 			},
-		};
+		} as const;
 
 		const allDone = this.async();
 		const params = this.data;
@@ -56,12 +46,31 @@ export default (grunt: IGrunt): void => {
 		 */
 		this.requiresConfig([this.name, this.target, 'src'].join('.'));
 
-		webfont(this.name, this.target, this.filesSrc, params, options, logger).finally(allDone);
+		webfontMain(this.name, this.target, this.filesSrc, params, options, logger).finally(allDone);
 	});
 };
 
-export const webfont = async (name: string, target: string, filesSrc: string[], params: Config, options: Options, logger?: Logger): Promise<void> => {
-	if (!logger) logger = wf.consolaLogger;
+export const webfont = async (targetName: string, config: Config): Promise<void> => {
+	const filesSrc = globSync(config.src, { posix: true });
+	await webfontMain("webfont", targetName, filesSrc, config);
+}
+
+const webfontGruntCjs = (grunt: IGrunt): void => webfontGrunt(grunt);
+Object.assign(webfontGruntCjs, {
+	default: webfontGrunt,
+	webfont: webfont,
+});
+
+export { webfontGrunt as default, webfontGruntCjs as "module.exports" };
+
+const webfontMain = async (
+	name: string,
+	target: string,
+	filesSrc: string[],
+	params: Config,
+	options: Options = params.options ?? {},
+	logger: Logger = wf.consolaLogger,
+): Promise<void> => {
 	const md5 = crypto.createHash('md5');
 
 	/*
@@ -110,10 +119,10 @@ export const webfont = async (name: string, target: string, filesSrc: string[],
 		htmlDemo: options.htmlDemo !== false,
 		htmlDemoTemplate: options.htmlDemoTemplate,
 		htmlDemoFilename: options.htmlDemoFilename,
-		styles: optionToArray(options.styles, 'font,icon'),
-		types: optionToArray(options.types, 'eot,woff,ttf'),
-		order: optionToArray(options.order, wf.fontFormats),
-		embed: options.embed === true ? ['woff'] : optionToArray(options.embed, false),
+		styles: optionToArray(options.styles, ['font', 'icon']),
+		types: optionToArray<FontFormat>(options.types, ['eot', 'woff', 'ttf']),
+		order: optionToArray<FontFormat>(options.order, wf.fontFormats),
+		embed: options.embed === true ? ['woff'] : optionToArray<FontFormat>(options.embed, false),
 		rename: options.rename || path.basename,
 		engine: options.engine || 'fontforge',
 		autoHint: options.autoHint !== false,
@@ -174,7 +183,7 @@ export const webfont = async (name: string, target: string, filesSrc: string[],
 
 	// Check if we need to generate font
 	const previousHash = readHash(name, target);
-	logger.log.verbose('New hash:', o.hash, '- previous hash:', previousHash);
+	logger.log.verbose(`New hash: ${o.hash} - previous hash: ${previousHash}`);
 	if (o.hash === previousHash) {
 		logger.log.verbose('Config and source files weren’t changed since last run, checking resulting files...');
 		let regenerationNeeded = false;
@@ -191,7 +200,7 @@ export const webfont = async (name: string, target: string, filesSrc: string[],
 			regenerationNeeded = generatedFiles.some((filename) => {
 				if (!filename) return false;
 				if (!fs.existsSync(filename)) {
-					logger.log.verbose('File', filename, ' is missed.');
+					logger.log.verbose(`File ${filename} is missed.`);
 					return true;
 				}
 				return false;
@@ -347,8 +356,8 @@ export const webfont = async (name: string, target: string, filesSrc: string[],
 		o.relativeFontPath = normalizePath(o.relativeFontPath);
 
 		// Generate font URLs to use in @font-face
-		const fontSrcs: { 0: string[], 1: string[] } = { 0: [], 1: [] };
-		o.order.forEach((type: 'eot'|'woff2'|'woff'|'ttf'|'svg') => {
+		const fontSrcs: { readonly 0: string[], readonly 1: string[] } = { 0: [], 1: [] };
+		o.order.forEach((type) => {
 			if (!has(o.types, type)) return;
 			const fontSrc1 = wf.fontsSrcsMap[type][0];
 			if (fontSrc1) fontSrcs[0].push(generateFontSrc(type, fontSrc1, stylesheet));
@@ -411,7 +420,7 @@ export const webfont = async (name: string, target: string, filesSrc: string[],
 			fs.writeFileSync(o.codepointsFile, codepointsToString);
 			logger.log.verbose(`Codepoints saved to file "${o.codepointsFile}".`);
 		} catch (err) {
-			logger.log.error(err.message);
+			logger.log.error((err as Error).message);
 		}
 	}
 
@@ -431,10 +440,10 @@ export const webfont = async (name: string, target: string, filesSrc: string[],
 
 		let context = prepareBaseTemplateContext();
 
-		let htmlStyles;
+		let htmlStyles: string;
 
 		// Prepare relative font paths for injection into @font-face refs in HTML
-		const relativeRe = new RegExp(_.escapeRegExp(o.relativeFontPath).replace(/[=!:\/]/g, '\\$&'), 'g');
+		const relativeRe = new RegExp(o.relativeFontPath.replace(/[\\^$.*+?()[\]{}|]/g, '\\$&').replace(/[=!:\/]/g, '\\$&'), 'g');
 		const htmlRelativeFontPath = normalizePath(path.relative(o.destHtml, o.dest));
 		const _fontSrc1 = o.fontSrc1.replace(relativeRe, htmlRelativeFontPath);
 		const _fontSrc2 = o.fontSrc2.replace(relativeRe, htmlRelativeFontPath);
@@ -483,9 +492,9 @@ export const webfont = async (name: string, target: string, filesSrc: string[],
 		// Prepares config attributes related to destination filepath
 		const dest = outputConfig.dest || o.dest;
 
-		let filepath;
-		let destParent;
-		let destName;
+		let filepath: string;
+		let destParent: string;
+		let destName: string;
 
 		if (path.extname(dest) === '') {
 			// If user specifies a directory, filename should be same as template
@@ -533,7 +542,7 @@ export const webfont = async (name: string, target: string, filesSrc: string[],
 			await fs.promises.mkdir(getDemoPath(), { recursive: true });
 		} catch (err) {
 			if (err) {
-				logger.log.info(err);
+				logger.log.info(err as string);
 				return;
 			}
 		}
@@ -560,9 +569,9 @@ export const webfont = async (name: string, target: string, filesSrc: string[],
 	 * @param val Input string
 	 * @param defVal Default value
 	 */
-	function optionToArray(val: string | false, defVal: string | false): string[] {
+	function optionToArray<T extends string>(val: string | false, defVal: T[] | false): T[] {
 		if (val === undefined) {
-			val = defVal;
+			return defVal || [];
 		}
 		if (!val) {
 			return [];
@@ -570,7 +579,7 @@ export const webfont = async (name: string, target: string, filesSrc: string[],
 		if (typeof val !== 'string') {
 			return val;
 		}
-		return val.split(',').map((value) => value.trim());
+		return val.split(',').map((value) => value.trim() as T);
 	}
 
 	/**
@@ -580,7 +589,7 @@ export const webfont = async (name: string, target: string, filesSrc: string[],
 	 * @param needle Value to find
 	 * @return Needle was found
 	 */
-	function has(haystack: string[] | string, needle: string): boolean {
+	function has(haystack: readonly string[] | string, needle: string): boolean {
 		return haystack.indexOf(needle) !== -1;
 	}
 
@@ -590,7 +599,7 @@ export const webfont = async (name: string, target: string, filesSrc: string[],
 	 * @param map Options object
 	 * @param key Option to find in the object
 	 */
-	function option(map: { _default?: string, [key: string]: string }, key: string): string {
+	function option(map: { readonly _default?: string, readonly [key: string]: string }, key: string): string {
 		if (key in map) {
 			return map[key];
 		} else {
@@ -661,11 +670,11 @@ export const webfont = async (name: string, target: string, filesSrc: string[],
 	 * @param font URL or Base64 string
 	 * @param stylesheet type: css, scss, ...
 	 */
-	function generateFontSrc(type: string, font: { ext: string, format?: string, embeddable?: boolean }, stylesheet: string): string {
+	function generateFontSrc(type: FontFormat, font: { readonly ext: string, readonly format?: string, readonly embeddable?: boolean }, stylesheet: string): string {
 		const filename = template(`${o.fontFilename}${font.ext}`, o);
 		let fontPathVariableName = `${o.fontFamilyName}-font-path`;
 
-		let url;
+		let url: string;
 		if (font.embeddable && has(o.embed, type)) {
 			url = embedFont(path.join(o.dest, filename));
 		} else {
@@ -739,10 +748,17 @@ export const webfont = async (name: string, target: string, filesSrc: string[],
 	 */
 	function renderTemplate(template: { filename: string, template: string }, context: Context): string {
 		try {
-			const func = _.template(template.template);
-			return func(context);
+			return new Eta({
+				autoTrim: ["nl", false],
+				parse: {
+					exec: "",
+					interpolate: "~",
+					raw: "=",
+				},
+				useWith: true,
+			}).renderString(template.template, context);
 		} catch (e) {
-			logger.fail.fatal(`Error while rendering template ${template.filename}: ${e.message}`);
+			logger.fail.fatal(`Error while rendering template ${template.filename}: ${(e as Error).message}`);
 		}
 	}
 

package/templates/demo.html

@@ -81,7 +81,7 @@
 		<pre><code>&lt;i class=&quot;ligature-icons&quot;&gt;<span id="name2">name</span>&lt;/i&gt;</code></pre>
 		<% } %>
 
-		<footer>Generated by <a href="https://github.com/sapegin/grunt-webfont">grunt-webfont</a>.</footer>
+		<footer>Generated by <a href="https://github.com/Hibi-10000/grunt-webfont">grunt-webfont</a>.</footer>
 
 		<script>
 		(function() {

package/tsconfig.json

@@ -1,19 +1,13 @@
 {
-  "typeAcquisition": {
-    "enable": true,
-  },
   "compilerOptions": {
     "module": "ESNext",
     "moduleResolution": "bundler",
-    "target": "ESNext",
-    "lib": ["ESNext"],
+    "target": "ES2023",
+    "lib": ["ES2023"],
+    "types": ["grunt"],
     "noEmit": true,
-    "allowJs": true,
-    "checkJs": true,
     "strict": true,
     "strictNullChecks": false,
-    "strictFunctionTypes": false,
-    "useUnknownInCatchVariables": false,
     "resolveJsonModule": true,
     "esModuleInterop": true,
     "allowImportingTsExtensions": true,
@@ -26,6 +20,5 @@
   },
   "exclude": [
     "dist",
-    "node_modules",
   ],
 }