@hibi_10000/grunt-webfont 2.0.1

package/tasks/types.ts

@@ -0,0 +1,169 @@
+export interface Logger {
+	log: {
+		error: (...args: any[]) => void,
+		warn: (...args: any[]) => void,
+		info: (...args: any[]) => void,
+		verbose: (...args: any[]) => void,
+	},
+	fail: {
+		fatal: (...args: any[]) => void,
+		warn?: (...args: any[]) => void,
+	},
+}
+
+export interface CustomOutput {
+	template: string,
+	dest: string,
+	syntax?: string,
+	context?: Partial<Context>,
+}
+
+export interface TemplateOptions {
+	baseClass?: string,
+	classPrefix?: string,
+}
+
+export interface Configs {
+	[key: string]: Config,
+}
+
+export interface Config {
+	src: string,
+	dest?: string,
+	destCss?: string,
+	destScss?: string,
+	destSass?: string,
+	destLess?: string,
+	destStyl?: string,
+	options?: Options,
+}
+
+export interface Options {
+	font?: string,
+	destCss?: string,
+	destScss?: string,
+	destSass?: string,
+	destLess?: string,
+	destStyl?: string,
+	dest?: string,
+	relativeFontPath?: string,
+	fontPathVariables?: boolean,
+	hashes?: boolean,
+	ligatures?: boolean,
+	template?: string,
+	syntax?: string,
+	templateOptions?: TemplateOptions,
+	stylesheets?: string[],
+	stylesheet?: string,
+	htmlDemo?: boolean,
+	htmlDemoTemplate?: string,
+	htmlDemoFilename?: string,
+	styles?: string, //"foo,bar"
+	types?: string, //"foo,bar"
+	order?: string, //"foo,bar"
+	embed?: boolean | string, //"foo,bar"
+	rename?: (path: string, suffix?: string) => string,
+	engine?: 'fontforge' | 'node',
+	autoHint?: boolean,
+	codepoints?: { [key: string]: number },
+	codepointsFile?: string, // | fs.PathLike,
+	startCodepoint?: number,
+	ie7?: boolean,
+	normalize?: boolean,
+	optimize?: boolean,
+	round?: number,
+	fontHeight?: number,
+	descent?: number,
+	version?: string | boolean,
+	cache?: string,
+	callback?: (filename: string, types: string[], glyphs: string[], hash: string) => void,
+	customOutputs?: CustomOutput[],
+	execMaxBuffer?: number,
+
+	destHtml?: string,
+	fontFilename?: string,
+	fontFamilyName?: string,
+	skip?: boolean,
+}
+
+export interface OptionsInternal extends TemplateOptions {
+	logger: Logger,
+	fontBaseName: string,
+	destCss: string,
+	destScss: string,
+	destSass: string,
+	destLess: string,
+	destStyl: string,
+	dest: string,
+	relativeFontPath: string,
+	fontPathVariables: boolean,
+	addHashes: boolean,
+	addLigatures: boolean,
+	template: string,
+	syntax: string,
+	templateOptions: TemplateOptions,
+	stylesheets: string[],
+	htmlDemo: boolean,
+	htmlDemoTemplate: string,
+	htmlDemoFilename: string,
+	styles: string[] | string,
+	types: string[],
+	order: string[],
+	embed: string[],
+	rename: (path: string, suffix?: string) => string,
+	engine: 'fontforge' | 'node',
+	autoHint: boolean,
+	codepoints: { [key: string]: number },
+	codepointsFile: string, // | fs.PathLike,
+	startCodepoint: number,
+	ie7: boolean,
+	normalize: boolean,
+	optimize: boolean,
+	round: number,
+	fontHeight: number,
+	descent: number,
+	version: string | boolean,
+	cache: string,
+	callback: (filename: string, types: string[], glyphs: string[], hash: string) => void,
+	customOutputs: CustomOutput[],
+	execMaxBuffer: number,
+
+	fontName?: string,
+	destCssPaths?: {
+		css: string,
+		scss: string,
+		sass: string,
+		less: string,
+		styl: string,
+	},
+	destHtml?: string,
+	fontfaceStyles?: boolean,
+	baseStyles?: boolean,
+	extraStyles?: boolean,
+	files?: string[],
+	glyphs?: string[],
+	hash?: string,
+	fontFilename?: string,
+	fontFamilyName?: string,
+	fontSrc1?: string,
+	fontSrc2?: string,
+	fontRawSrcs?: string[][],
+	cssTemplate?: {
+		filename: string,
+		template: string, //html code
+	},
+	fontPathVariable?: string,
+}
+
+export interface Context extends OptionsInternal {
+	testHeading?: string,
+	stylesheet?: string,
+	iconsStyles?: true,
+}
+
+export interface ReadableStreamWithMetadata extends NodeJS.ReadableStream {
+	metadata?: {
+		unicode: string[],
+		name: string,
+	}
+}

package/tasks/util/util.ts

@@ -0,0 +1,119 @@
+/**
+ * grunt-webfont: common stuff
+ *
+ * @author Artem Sapegin (http://sapegin.me), Hibi_10000
+ */
+
+import path from 'node:path';
+import { globSync } from 'glob';
+import { consola } from 'consola';
+
+import type { Logger, OptionsInternal } from '../types.ts';
+
+export const consolaLogger: Logger = {
+	log: {
+		error: consola.error.raw,
+		warn: consola.warn.raw,
+		info: consola.info.raw,
+		verbose: consola.verbose.raw,
+	},
+	fail: {
+		fatal: (...args) => {
+			consola.fatal.raw(...args);
+			process.exit(1);
+		}
+	},
+}
+
+/**
+ * Unicode Private Use Area start.
+ * http://en.wikipedia.org/wiki/Private_Use_(Unicode)
+ */
+export const UNICODE_PUA_START = 0xF101;
+
+/**
+ * @font-face’s src values generation rules.
+ */
+export const fontsSrcsMap = {
+	eot: {
+		0: {
+			ext: '.eot',
+		},
+		1: {
+			ext: '.eot?#iefix',
+			format: 'embedded-opentype',
+		},
+	},
+	woff: {
+		0: false as false,
+		1: {
+			ext: '.woff',
+			format: 'woff',
+			embeddable: true,
+		},
+	},
+	woff2: {
+		0: false as false,
+		1: {
+			ext: '.woff2',
+			format: 'woff2',
+			embeddable: true,
+		},
+	},
+	ttf: {
+		0: false as false,
+		1: {
+			ext: '.ttf',
+			format: 'truetype',
+			embeddable: true,
+		},
+	},
+	svg: {
+		0: false as false,
+		1: {
+			ext: '.svg#{fontBaseName}',
+			format: 'svg',
+		},
+	},
+};
+
+/**
+ * CSS fileaname prefixes: _icons.scss.
+ */
+export const cssFilePrefixes = {
+	_default: '',
+	sass: '_',
+	scss: '_'
+};
+
+/**
+ * @font-face’s src parts seperators.
+ */
+export const fontSrcSeparators = {
+	_default: ',\n\t\t',
+	styl: ', '
+};
+
+/**
+ * List of available font formats.
+ */
+export const fontFormats = 'eot,woff2,woff,ttf,svg';
+
+/**
+ * Returns list of all generated font files.
+ *
+ * @param o Options.
+ */
+export const generatedFontFiles = (o: OptionsInternal): string[] => {
+	return globSync(path.posix.join(o.dest, `${o.fontFilename}*.{${o.types}}`));
+};
+
+/**
+ * Returns path to font of specified format.
+ *
+ * @param o Options.
+ * @param type Font type (see `wf.fontFormats`).
+ */
+export const getFontPath = (o: OptionsInternal, type: string): string => {
+	return path.join(o.dest, `${o.fontFilename}.${type}`);
+};