@formatjs/ts-transformer 4.1.0 → 4.2.0

package/index.d.ts

@@ -1,3 +1,3 @@
-export * from './src/transform.js';
-export * from './src/types.js';
-export * from './src/interpolate-name.js';
+export * from "./src/transform.js";
+export * from "./src/types.js";
+export * from "./src/interpolate-name.js";

package/index.js

@@ -1,3 +1,3 @@
-export * from './src/transform.js';
-export * from './src/types.js';
-export * from './src/interpolate-name.js';
+export * from "./src/transform.js";
+export * from "./src/types.js";
+export * from "./src/interpolate-name.js";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@formatjs/ts-transformer",
   "description": "TS Compiler transformer for formatjs",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "license": "MIT",
   "author": "Long Ho <holevietlong@gmail.com>",
   "type": "module",
@@ -12,7 +12,7 @@
     "json-stable-stringify": "^1.3.0",
     "tslib": "^2.8.0",
     "typescript": "^5.6.0",
-    "@formatjs/icu-messageformat-parser": "3.2.1"
+    "@formatjs/icu-messageformat-parser": "3.3.0"
   },
   "devDependencies": {
     "ts-jest": "^29"

package/src/console_utils.js

@@ -1,26 +1,26 @@
-import * as chalkNs from 'chalk';
-import { format } from 'util';
+import * as chalkNs from "chalk";
+import { format } from "util";
 const chalk = chalkNs.default ?? chalkNs;
 const LEVEL_COLORS = {
-    debug: chalk.green,
-    warn: chalk.yellow,
-    error: chalk.red,
+	debug: chalk.green,
+	warn: chalk.yellow,
+	error: chalk.red
 };
 function label(level, message) {
-    return `[@formatjs/ts-transformer] [${LEVEL_COLORS[level](level.toUpperCase())}] ${message}`;
+	return `[@formatjs/ts-transformer] [${LEVEL_COLORS[level](level.toUpperCase())}] ${message}`;
 }
 export async function debug(message, ...args) {
-    if (process.env.LOG_LEVEL !== 'debug') {
-        return;
-    }
-    console.error(format(label('debug', message), ...args));
-    console.error('\n');
+	if (process.env.LOG_LEVEL !== "debug") {
+		return;
+	}
+	console.error(format(label("debug", message), ...args));
+	console.error("\n");
 }
 export function warn(message, ...args) {
-    console.error(format(label('warn', message), ...args));
-    console.error('\n');
+	console.error(format(label("warn", message), ...args));
+	console.error("\n");
 }
 export function error(message, ...args) {
-    console.error(format(label('error', message), ...args));
-    console.error('\n');
+	console.error(format(label("error", message), ...args));
+	console.error("\n");
 }

package/src/interpolate-name.d.ts

@@ -1,14 +1,14 @@
 export interface LoaderContext {
-    resourceQuery?: string;
-    resourcePath?: string;
-    options?: {
-        customInterpolateName(this: LoaderContext, url: string, name: string | NameFn, options: Options): string;
-    };
+	resourceQuery?: string;
+	resourcePath?: string;
+	options?: {
+		customInterpolateName(this: LoaderContext, url: string, name: string | NameFn, options: Options): string;
+	};
 }
 export interface Options {
-    context?: string;
-    content?: string;
-    regExp?: RegExp;
+	context?: string;
+	content?: string;
+	regExp?: RegExp;
 }
 export type NameFn = (resourcePath?: string, resourceQuery?: string) => string;
 export declare function interpolateName(loaderContext: LoaderContext, name: string | NameFn, options: Options): string;

package/src/interpolate-name.js

@@ -1,86 +1,71 @@
-import { createHash } from 'crypto';
-import * as path from 'path';
-function getHashDigest(content, hashType = 'md5', digestType = 'hex', length = 9999) {
-    const hasher = createHash(hashType);
-    hasher.update(content);
-    return hasher.digest(digestType).slice(0, length);
+import { createHash } from "crypto";
+import * as path from "path";
+function getHashDigest(content, hashType = "md5", digestType = "hex", length = 9999) {
+	const hasher = createHash(hashType);
+	hasher.update(content);
+	return hasher.digest(digestType).slice(0, length);
 }
 export function interpolateName(loaderContext, name, options) {
-    let filename;
-    const hasQuery = loaderContext.resourceQuery && loaderContext.resourceQuery.length > 1;
-    if (typeof name === 'function') {
-        filename = name(loaderContext.resourcePath, hasQuery ? loaderContext.resourceQuery : undefined);
-    }
-    else {
-        filename = name || '[hash].[ext]';
-    }
-    const context = options.context;
-    const content = options.content;
-    const regExp = options.regExp;
-    let ext = 'bin';
-    let basename = 'file';
-    let directory = '';
-    let folder = '';
-    let query = '';
-    if (loaderContext.resourcePath) {
-        const parsed = path.parse(loaderContext.resourcePath);
-        let resourcePath = loaderContext.resourcePath;
-        if (parsed.ext) {
-            ext = parsed.ext.slice(1);
-        }
-        if (parsed.dir) {
-            basename = parsed.name;
-            resourcePath = parsed.dir + path.sep;
-        }
-        if (typeof context !== 'undefined') {
-            directory = path
-                .relative(context, resourcePath + '_')
-                .replace(/\\/g, '/')
-                .replace(/\.\.(\/)?/g, '_$1');
-            directory = directory.slice(0, -1);
-        }
-        else {
-            directory = resourcePath.replace(/\\/g, '/').replace(/\.\.(\/)?/g, '_$1');
-        }
-        if (directory.length === 1) {
-            directory = '';
-        }
-        else if (directory.length > 1) {
-            folder = path.basename(directory);
-        }
-    }
-    if (loaderContext.resourceQuery && loaderContext.resourceQuery.length > 1) {
-        query = loaderContext.resourceQuery;
-        const hashIdx = query.indexOf('#');
-        if (hashIdx >= 0) {
-            query = query.slice(0, hashIdx);
-        }
-    }
-    let url = filename;
-    if (content) {
-        // Match hash template
-        url = url
-            // `hash` and `contenthash` are same in `loader-utils` context
-            // let's keep `hash` for backward compatibility
-            .replace(/\[(?:([^:\]]+):)?(?:hash|contenthash)(?::([a-z]+\d*[a-z]*))?(?::(\d+))?\]/gi, (_, hashType, digestType, maxLength) => getHashDigest(content, hashType, digestType, parseInt(maxLength, 10)));
-    }
-    url = url
-        .replace(/\[ext\]/gi, () => ext)
-        .replace(/\[name\]/gi, () => basename)
-        .replace(/\[path\]/gi, () => directory)
-        .replace(/\[folder\]/gi, () => folder)
-        .replace(/\[query\]/gi, () => query);
-    if (regExp && loaderContext.resourcePath) {
-        const match = loaderContext.resourcePath.match(new RegExp(regExp));
-        if (match) {
-            match.forEach((matched, i) => {
-                url = url.replace(new RegExp('\\[' + i + '\\]', 'ig'), matched);
-            });
-        }
-    }
-    if (typeof loaderContext.options === 'object' &&
-        typeof loaderContext.options.customInterpolateName === 'function') {
-        url = loaderContext.options.customInterpolateName.call(loaderContext, url, name, options);
-    }
-    return url;
+	let filename;
+	const hasQuery = loaderContext.resourceQuery && loaderContext.resourceQuery.length > 1;
+	if (typeof name === "function") {
+		filename = name(loaderContext.resourcePath, hasQuery ? loaderContext.resourceQuery : undefined);
+	} else {
+		filename = name || "[hash].[ext]";
+	}
+	const context = options.context;
+	const content = options.content;
+	const regExp = options.regExp;
+	let ext = "bin";
+	let basename = "file";
+	let directory = "";
+	let folder = "";
+	let query = "";
+	if (loaderContext.resourcePath) {
+		const parsed = path.parse(loaderContext.resourcePath);
+		let resourcePath = loaderContext.resourcePath;
+		if (parsed.ext) {
+			ext = parsed.ext.slice(1);
+		}
+		if (parsed.dir) {
+			basename = parsed.name;
+			resourcePath = parsed.dir + path.sep;
+		}
+		if (typeof context !== "undefined") {
+			directory = path.relative(context, resourcePath + "_").replace(/\\/g, "/").replace(/\.\.(\/)?/g, "_$1");
+			directory = directory.slice(0, -1);
+		} else {
+			directory = resourcePath.replace(/\\/g, "/").replace(/\.\.(\/)?/g, "_$1");
+		}
+		if (directory.length === 1) {
+			directory = "";
+		} else if (directory.length > 1) {
+			folder = path.basename(directory);
+		}
+	}
+	if (loaderContext.resourceQuery && loaderContext.resourceQuery.length > 1) {
+		query = loaderContext.resourceQuery;
+		const hashIdx = query.indexOf("#");
+		if (hashIdx >= 0) {
+			query = query.slice(0, hashIdx);
+		}
+	}
+	let url = filename;
+	if (content) {
+		// Match hash template
+		url = url.replace(/\[(?:([^:\]]+):)?(?:hash|contenthash)(?::([a-z]+\d*[a-z]*))?(?::(\d+))?\]/gi, (_, hashType, digestType, maxLength) => getHashDigest(content, hashType, digestType, parseInt(maxLength, 10)));
+	}
+	url = url.replace(/\[ext\]/gi, () => ext).replace(/\[name\]/gi, () => basename).replace(/\[path\]/gi, () => directory).replace(/\[folder\]/gi, () => folder).replace(/\[query\]/gi, () => query);
+	if (regExp && loaderContext.resourcePath) {
+		const match = loaderContext.resourcePath.match(new RegExp(regExp));
+		if (match) {
+			match.forEach((matched, i) => {
+				url = url.replace(new RegExp("\\[" + i + "\\]", "ig"), matched);
+			});
+		}
+	}
+	if (typeof loaderContext.options === "object" && typeof loaderContext.options.customInterpolateName === "function") {
+		url = loaderContext.options.customInterpolateName.call(loaderContext, url, name, options);
+	}
+	return url;
 }

package/src/transform.d.ts

@@ -1,80 +1,80 @@
-import * as typescript from 'typescript';
-import { MessageDescriptor } from './types.js';
+import * as typescript from "typescript";
+import { type MessageDescriptor } from "./types.js";
 export type Extractor = (filePath: string, msgs: MessageDescriptor[]) => void;
 export type MetaExtractor = (filePath: string, meta: Record<string, string>) => void;
-export type InterpolateNameFn = (id?: MessageDescriptor['id'], defaultMessage?: MessageDescriptor['defaultMessage'], description?: MessageDescriptor['description'], filePath?: string) => string;
+export type InterpolateNameFn = (id?: MessageDescriptor["id"], defaultMessage?: MessageDescriptor["defaultMessage"], description?: MessageDescriptor["description"], filePath?: string) => string;
 type TypeScript = typeof typescript;
 export interface Opts {
-    /**
-     * Parse specific additional custom pragma.
-     * This allows you to tag certain file with metadata such as `project`.
-     * For example with this file:
-     * ```tsx
-     * // @intl-meta project:my-custom-project
-     * import {FormattedMessage} from 'react-intl';
-     * <FormattedMessage defaultMessage="foo" id="bar" />;
-     * ```
-     * and with option `{pragma: "@intl-meta"}`,
-     * we'll parse out `// @intl-meta project:my-custom-project`
-     * into `{project: 'my-custom-project'}` in the result file.
-     */
-    pragma?: string;
-    /**
-     * Whether the metadata about the location of the message in the source file
-     * should be extracted. If `true`, then `file`, `start`, and `end`
-     * fields will exist for each extracted message descriptors.
-     * Defaults to `false`.
-     */
-    extractSourceLocation?: boolean;
-    /**
-     * Remove `defaultMessage` field in generated js after extraction.
-     */
-    removeDefaultMessage?: boolean;
-    /**
-     * Additional component names to extract messages from,
-     * e.g: `['FormattedFooBarMessage']`.
-     */
-    additionalComponentNames?: string[];
-    /**
-     * Additional function names to extract messages from,
-     * e.g: `['formatMessage', '$t']`
-     * Default to `['formatMessage']`
-     */
-    additionalFunctionNames?: string[];
-    /**
-     * Callback function that gets called everytime we encountered something
-     * that looks like a MessageDescriptor
-     *
-     * @type {Extractor}
-     * @memberof Opts
-     */
-    onMsgExtracted?: Extractor;
-    /**
-     * Callback function that gets called when we successfully parsed meta
-     * declared in pragma
-     */
-    onMetaExtracted?: MetaExtractor;
-    /**
-     * webpack-style name interpolation.
-     * Can also be a string like '[sha512:contenthash:hex:6]'
-     *
-     * @type {(InterpolateNameFn | string)}
-     * @memberof Opts
-     */
-    overrideIdFn?: InterpolateNameFn | string;
-    /**
-     * Whether to compile `defaultMessage` to AST.
-     * This is no-op if `removeDefaultMessage` is `true`
-     */
-    ast?: boolean;
-    /**
-     * Whether to preserve whitespace and newlines.
-     */
-    preserveWhitespace?: boolean;
-    /**
-     * Whether to hoist selectors & flatten sentences
-     */
-    flatten?: boolean;
+	/**
+	* Parse specific additional custom pragma.
+	* This allows you to tag certain file with metadata such as `project`.
+	* For example with this file:
+	* ```tsx
+	* // @intl-meta project:my-custom-project
+	* import {FormattedMessage} from 'react-intl';
+	* <FormattedMessage defaultMessage="foo" id="bar" />;
+	* ```
+	* and with option `{pragma: "@intl-meta"}`,
+	* we'll parse out `// @intl-meta project:my-custom-project`
+	* into `{project: 'my-custom-project'}` in the result file.
+	*/
+	pragma?: string;
+	/**
+	* Whether the metadata about the location of the message in the source file
+	* should be extracted. If `true`, then `file`, `start`, and `end`
+	* fields will exist for each extracted message descriptors.
+	* Defaults to `false`.
+	*/
+	extractSourceLocation?: boolean;
+	/**
+	* Remove `defaultMessage` field in generated js after extraction.
+	*/
+	removeDefaultMessage?: boolean;
+	/**
+	* Additional component names to extract messages from,
+	* e.g: `['FormattedFooBarMessage']`.
+	*/
+	additionalComponentNames?: string[];
+	/**
+	* Additional function names to extract messages from,
+	* e.g: `['formatMessage', '$t']`
+	* Default to `['formatMessage']`
+	*/
+	additionalFunctionNames?: string[];
+	/**
+	* Callback function that gets called everytime we encountered something
+	* that looks like a MessageDescriptor
+	*
+	* @type {Extractor}
+	* @memberof Opts
+	*/
+	onMsgExtracted?: Extractor;
+	/**
+	* Callback function that gets called when we successfully parsed meta
+	* declared in pragma
+	*/
+	onMetaExtracted?: MetaExtractor;
+	/**
+	* webpack-style name interpolation.
+	* Can also be a string like '[sha512:contenthash:hex:6]'
+	*
+	* @type {(InterpolateNameFn | string)}
+	* @memberof Opts
+	*/
+	overrideIdFn?: InterpolateNameFn | string;
+	/**
+	* Whether to compile `defaultMessage` to AST.
+	* This is no-op if `removeDefaultMessage` is `true`
+	*/
+	ast?: boolean;
+	/**
+	* Whether to preserve whitespace and newlines.
+	*/
+	preserveWhitespace?: boolean;
+	/**
+	* Whether to hoist selectors & flatten sentences
+	*/
+	flatten?: boolean;
 }
 export declare function transformWithTs(ts: TypeScript, opts: Opts): typescript.TransformerFactory<typescript.SourceFile>;
 export declare function transform(opts: Opts): typescript.TransformerFactory<typescript.SourceFile>;