@formatjs/ts-transformer 3.9.9 → 3.9.10

package/tests/fixtures/resourcePath.tsx

@@ -0,0 +1,23 @@
+export function foo() {
+  props.intl.formatMessage(
+    {
+      defaultMessage: 'props {intl}',
+      description: 'bar',
+    },
+    {bar: 'bar'}
+  )
+  this.props.intl.formatMessage(
+    {
+      defaultMessage: 'this props {intl}',
+      description: 'bar',
+    },
+    {bar: 'bar'}
+  )
+  return intl.formatMessage(
+    {
+      defaultMessage: 'foo {bar}',
+      description: 'bar',
+    },
+    {bar: 'bar'}
+  )
+}

package/tests/fixtures/stringConcat.tsx

@@ -0,0 +1,26 @@
+import React, {Component} from 'react'
+import {FormattedMessage, defineMessage} from 'react-intl'
+
+export default class Foo extends Component {
+  render() {
+    return (
+      <div>
+        <FormattedMessage
+          id={'foo.bar.baz' + 'id'}
+          defaultMessage={'Hello World!' + 'far' + 'baz'}
+          description="The default message."
+        />
+        {intl.formatMessage({
+          id: 'header',
+          defaultMessage: 'Hello World!' + 'foo' + 'bar',
+          description: 'The default message',
+        })}
+        {defineMessage({
+          id: 'header2',
+          defaultMessage: 'Hello World!',
+          description: 'The default message' + ' asd',
+        })}
+      </div>
+    )
+  }
+}

package/tests/fixtures/templateLiteral.tsx

@@ -0,0 +1,21 @@
+import React, {Component} from 'react'
+import {FormattedMessage, defineMessage} from 'react-intl'
+
+defineMessage({
+  id: `template`,
+  defaultMessage: `should remove
+    newline and
+    extra spaces`,
+})
+
+export default class Foo extends Component {
+  render() {
+    return (
+      <FormattedMessage
+        id="foo.bar.baz"
+        defaultMessage={`Hello World!`}
+        description="The default message."
+      />
+    )
+  }
+}

package/tests/index.test.ts

@@ -0,0 +1,127 @@
+import {join} from 'path'
+import {transform, Opts, MessageDescriptor} from '../'
+import * as ts from 'typescript'
+import {readFile as readFileAsync} from 'fs'
+import {promisify} from 'util'
+
+const readFile = promisify(readFileAsync)
+
+const FILES_TO_TESTS: Record<string, Partial<Opts>> = {
+  additionalComponentNames: {
+    additionalComponentNames: ['CustomMessage'],
+    pragma: 'react-intl',
+  },
+  additionalFunctionNames: {
+    additionalFunctionNames: ['$formatMessage'],
+    pragma: 'react-intl',
+  },
+  defineMessages: {
+    pragma: 'react-intl',
+  },
+  extractFromFormatMessage: {
+    pragma: 'react-intl',
+  },
+  extractFromFormatMessageStateless: {},
+  nested: {
+    overrideIdFn: (id, defaultMessage, description) => {
+      return `HELLO.${id}.${defaultMessage!.length}.${typeof description}`
+    },
+  },
+  extractSourceLocation: {
+    extractSourceLocation: true,
+  },
+  descriptionsAsObjects: {},
+  formatMessageCall: {},
+  FormattedMessage: {},
+  inline: {},
+  stringConcat: {},
+  templateLiteral: {},
+  overrideIdFn: {
+    overrideIdFn: (id, defaultMessage, description) => {
+      return `HELLO.${id}.${defaultMessage!.length}.${typeof description}`
+    },
+  },
+  ast: {
+    ast: true,
+    overrideIdFn: (id, defaultMessage, description) => {
+      return `HELLO.${id}.${defaultMessage!.length}.${typeof description}`
+    },
+  },
+  removeDefaultMessage: {
+    removeDefaultMessage: true,
+  },
+  noImport: {
+    overrideIdFn: '[hash:base64:5]',
+  },
+  resourcePath: {
+    overrideIdFn: '[name]-[hash:base64:5]',
+  },
+  removeDescription: {},
+  defineMessagesPreserveWhitespace: {
+    pragma: 'react-intl',
+    preserveWhitespace: true,
+  },
+}
+
+const FIXTURES_DIR = join(__dirname, 'fixtures')
+
+describe('emit asserts for', function () {
+  const filenames = Object.keys(FILES_TO_TESTS)
+  filenames.forEach(function (fn) {
+    if (fn === 'extractSourceLocation') {
+      it(`[special] ${fn}`, async function () {
+        const output = await compile(
+          join(FIXTURES_DIR, `${fn}.tsx`),
+          FILES_TO_TESTS[fn]
+        )
+        // Check code output
+        expect(output.code).toMatchSnapshot()
+        expect(output.msgs).toHaveLength(1)
+        expect(output.msgs[0]).toMatchSnapshot({
+          file: expect.stringContaining('extractSourceLocation.tsx'),
+        })
+      })
+    } else {
+      it(fn, async function () {
+        const output = await compile(
+          join(FIXTURES_DIR, `${fn}.tsx`),
+          FILES_TO_TESTS[fn]
+        )
+        expect(output).toMatchSnapshot()
+      })
+    }
+  })
+})
+
+async function compile(filePath: string, options?: Partial<Opts>) {
+  let msgs: MessageDescriptor[] = []
+  let meta: Record<string, string> = {}
+  const input = await readFile(filePath, 'utf8')
+  const output = ts.transpileModule(input, {
+    compilerOptions: {
+      target: ts.ScriptTarget.ESNext,
+      allowJs: true,
+    },
+    fileName: filePath,
+    reportDiagnostics: true,
+    transformers: {
+      before: [
+        transform({
+          overrideIdFn: '[hash:base64:10]',
+          onMsgExtracted: (_, extractedMsgs) => {
+            msgs = msgs.concat(extractedMsgs)
+          },
+          onMetaExtracted: (_, m) => {
+            meta = m
+          },
+          ...(options || {}),
+        }),
+      ],
+    },
+  })
+  return {
+    msgs,
+    meta,
+    code: output.outputText,
+  }
+}

package/tests/interpolate-name.test.ts

@@ -0,0 +1,14 @@
+import {interpolateName} from '../src/interpolate-name'
+import {createHash} from 'crypto'
+describe('interpolateName', function () {
+  it('should match native', function () {
+    const hasher = createHash('sha1')
+    const content = 'foo#bar'
+    hasher.update(content)
+    expect(
+      interpolateName({}, '[sha1:contenthash:base64:6]', {
+        content,
+      })
+    ).toBe(hasher.digest('base64').slice(0, 6))
+  })
+})

package/ts-jest-integration.ts

@@ -0,0 +1,9 @@
+import {transformWithTs, Opts} from '.'
+import type {TsCompilerInstance} from 'ts-jest'
+
+export const name = '@formatjs/ts-transformer'
+export const version = '2.10.1'
+
+export function factory(compilerInstance: TsCompilerInstance, opts: Opts) {
+  return transformWithTs(compilerInstance.configSet.compilerModule, opts)
+}

package/tsconfig.json

@@ -0,0 +1,5 @@
+// @generated
+{
+  // This is purely for IDE, not for compilation
+  "extends": "../../tsconfig.json"
+}

package/index.d.ts

@@ -1,4 +0,0 @@
-export * from './src/transform';
-export * from './src/types';
-export * from './src/interpolate-name';
-//# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../packages/ts-transformer/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,aAAa,CAAA;AAC3B,cAAc,wBAAwB,CAAA"}

package/index.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var tslib_1 = require("tslib");
-(0, tslib_1.__exportStar)(require("./src/transform"), exports);
-(0, tslib_1.__exportStar)(require("./src/types"), exports);
-(0, tslib_1.__exportStar)(require("./src/interpolate-name"), exports);

package/src/console_utils.d.ts

@@ -1,4 +0,0 @@
-export declare function debug(message: string, ...args: any[]): Promise<void>;
-export declare function warn(message: string, ...args: any[]): void;
-export declare function error(message: string, ...args: any[]): void;
-//# sourceMappingURL=console_utils.d.ts.map

package/src/console_utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"console_utils.d.ts","sourceRoot":"","sources":["../../../../../../packages/ts-transformer/src/console_utils.ts"],"names":[],"mappings":"AAeA,wBAAsB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,iBAM1D;AAED,wBAAgB,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAG1D;AAED,wBAAgB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAG3D"}

package/src/console_utils.js

@@ -1,49 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.error = exports.warn = exports.debug = void 0;
-var tslib_1 = require("tslib");
-var chalk_1 = require("chalk");
-var util_1 = require("util");
-var LEVEL_COLORS = {
-    debug: chalk_1.green,
-    warn: chalk_1.yellow,
-    error: chalk_1.red,
-};
-function label(level, message) {
-    return "[@formatjs/ts-transformer] [".concat(LEVEL_COLORS[level](level.toUpperCase()), "] ").concat(message);
-}
-function debug(message) {
-    var args = [];
-    for (var _i = 1; _i < arguments.length; _i++) {
-        args[_i - 1] = arguments[_i];
-    }
-    return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
-        return (0, tslib_1.__generator)(this, function (_a) {
-            if (process.env.LOG_LEVEL !== 'debug') {
-                return [2 /*return*/];
-            }
-            console.error(util_1.format.apply(void 0, (0, tslib_1.__spreadArray)([label('debug', message)], args, false)));
-            console.error('\n');
-            return [2 /*return*/];
-        });
-    });
-}
-exports.debug = debug;
-function warn(message) {
-    var args = [];
-    for (var _i = 1; _i < arguments.length; _i++) {
-        args[_i - 1] = arguments[_i];
-    }
-    console.error(util_1.format.apply(void 0, (0, tslib_1.__spreadArray)([label('warn', message)], args, false)));
-    console.error('\n');
-}
-exports.warn = warn;
-function error(message) {
-    var args = [];
-    for (var _i = 1; _i < arguments.length; _i++) {
-        args[_i - 1] = arguments[_i];
-    }
-    console.error(util_1.format.apply(void 0, (0, tslib_1.__spreadArray)([label('error', message)], args, false)));
-    console.error('\n');
-}
-exports.error = error;

package/src/interpolate-name.d.ts

@@ -1,15 +0,0 @@
-export interface LoaderContext {
-    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;
-}
-export declare type NameFn = (resourcePath?: string, resourceQuery?: string) => string;
-export declare function interpolateName(loaderContext: LoaderContext, name: string | NameFn, options: Options): string;
-//# sourceMappingURL=interpolate-name.d.ts.map

package/src/interpolate-name.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"interpolate-name.d.ts","sourceRoot":"","sources":["../../../../../../packages/ts-transformer/src/interpolate-name.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,aAAa;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,OAAO,CAAC,EAAE;QACR,qBAAqB,CACnB,IAAI,EAAE,aAAa,EACnB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,GAAG,MAAM,EACrB,OAAO,EAAE,OAAO,GACf,MAAM,CAAA;KACV,CAAA;CACF;AAED,MAAM,WAAW,OAAO;IACtB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,oBAAY,MAAM,GAAG,CAAC,YAAY,CAAC,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,KAAK,MAAM,CAAA;AAa9E,wBAAgB,eAAe,CAC7B,aAAa,EAAE,aAAa,EAC5B,IAAI,EAAE,MAAM,GAAG,MAAM,EACrB,OAAO,EAAE,OAAO,UA6GjB"}

package/src/interpolate-name.js

@@ -1,95 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.interpolateName = void 0;
-var tslib_1 = require("tslib");
-var path = (0, tslib_1.__importStar)(require("path"));
-var crypto_1 = require("crypto");
-function getHashDigest(content, hashType, digestType, length) {
-    if (hashType === void 0) { hashType = 'md5'; }
-    if (digestType === void 0) { digestType = 'hex'; }
-    if (length === void 0) { length = 9999; }
-    var hasher = (0, crypto_1.createHash)(hashType);
-    hasher.update(content);
-    return hasher.digest(digestType).slice(0, length);
-}
-function interpolateName(loaderContext, name, options) {
-    var filename;
-    var hasQuery = loaderContext.resourceQuery && loaderContext.resourceQuery.length > 1;
-    if (typeof name === 'function') {
-        filename = name(loaderContext.resourcePath, hasQuery ? loaderContext.resourceQuery : undefined);
-    }
-    else {
-        filename = name || '[hash].[ext]';
-    }
-    var context = options.context;
-    var content = options.content;
-    var regExp = options.regExp;
-    var ext = 'bin';
-    var basename = 'file';
-    var directory = '';
-    var folder = '';
-    var query = '';
-    if (loaderContext.resourcePath) {
-        var parsed = path.parse(loaderContext.resourcePath);
-        var 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;
-        var hashIdx = query.indexOf('#');
-        if (hashIdx >= 0) {
-            query = query.slice(0, hashIdx);
-        }
-    }
-    var 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*))?(?::(\d+))?\]/gi, function (_, hashType, digestType, maxLength) {
-            return getHashDigest(content, hashType, digestType, parseInt(maxLength, 10));
-        });
-    }
-    url = url
-        .replace(/\[ext\]/gi, function () { return ext; })
-        .replace(/\[name\]/gi, function () { return basename; })
-        .replace(/\[path\]/gi, function () { return directory; })
-        .replace(/\[folder\]/gi, function () { return folder; })
-        .replace(/\[query\]/gi, function () { return query; });
-    if (regExp && loaderContext.resourcePath) {
-        var match = loaderContext.resourcePath.match(new RegExp(regExp));
-        match &&
-            match.forEach(function (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;
-}
-exports.interpolateName = interpolateName;

package/src/transform.d.ts

@@ -1,78 +0,0 @@
-import * as typescript from 'typescript';
-import { MessageDescriptor } from './types';
-export declare type Extractor = (filePath: string, msgs: MessageDescriptor[]) => void;
-export declare type MetaExtractor = (filePath: string, meta: Record<string, string>) => void;
-export declare type InterpolateNameFn = (id?: MessageDescriptor['id'], defaultMessage?: MessageDescriptor['defaultMessage'], description?: MessageDescriptor['description'], filePath?: string) => string;
-declare 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;
-}
-export declare function transformWithTs(ts: TypeScript, opts: Opts): typescript.TransformerFactory<typescript.SourceFile>;
-export declare function transform(opts: Opts): typescript.TransformerFactory<typescript.SourceFile>;
-export {};
-//# sourceMappingURL=transform.d.ts.map

package/src/transform.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"transform.d.ts","sourceRoot":"","sources":["../../../../../../packages/ts-transformer/src/transform.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,UAAU,MAAM,YAAY,CAAA;AACxC,OAAO,EAAC,iBAAiB,EAAC,MAAM,SAAS,CAAA;AAKzC,oBAAY,SAAS,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,KAAK,IAAI,CAAA;AAC7E,oBAAY,aAAa,GAAG,CAC1B,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KACzB,IAAI,CAAA;AAET,oBAAY,iBAAiB,GAAG,CAC9B,EAAE,CAAC,EAAE,iBAAiB,CAAC,IAAI,CAAC,EAC5B,cAAc,CAAC,EAAE,iBAAiB,CAAC,gBAAgB,CAAC,EACpD,WAAW,CAAC,EAAE,iBAAiB,CAAC,aAAa,CAAC,EAC9C,QAAQ,CAAC,EAAE,MAAM,KACd,MAAM,CAAA;AAQX,aAAK,UAAU,GAAG,OAAO,UAAU,CAAA;AA2FnC,MAAM,WAAW,IAAI;IACnB;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;;;OAKG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAC9B;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,EAAE,CAAA;IACnC;;;;OAIG;IACH,uBAAuB,CAAC,EAAE,MAAM,EAAE,CAAA;IAClC;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,SAAS,CAAA;IAC1B;;;OAGG;IACH,eAAe,CAAC,EAAE,aAAa,CAAA;IAC/B;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,iBAAiB,GAAG,MAAM,CAAA;IACzC;;;OAGG;IACH,GAAG,CAAC,EAAE,OAAO,CAAA;IACb;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;CAC7B;AAmiBD,wBAAgB,eAAe,CAAC,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,wDA6BzD;AAED,wBAAgB,SAAS,CAAC,IAAI,EAAE,IAAI,wDAEnC"}