ts-const-value-transformer 0.6.0 → 0.7.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## v0.7.0
+
+- Fix for printing 'minus numeric value' and 'void 0', and remove using `ts.createPrinter`
+- Fix that `recreateProgram` creates the new fresh program instead of passing `oldProgram`
+- Fix to cache source code with no transformation
+- Add option to disable caching original source content (changed to false by default)
+- Fix some codes for better memory usage
+
 ## v0.6.0
 
 - Remove skipping satisfies expression

package/README.md

@@ -295,6 +295,8 @@ interface CreatePortalTransformerOptions extends TransformOptions {
    * If 0 or `undefined`, recreation will not be performed.
    */
   recreateProgramOnTransformCount?: number;
+  /** Specifies to cache base (original) source code for check if the input is changed. Default is false. */
+  cacheBaseSource?: boolean;
 }
 ```
 

package/dist/createPortalTransformer.d.mts

@@ -9,12 +9,22 @@ export interface CreatePortalTransformerOptions extends TransformOptions {
     /** The current directory for file search. Also affects to `project` option. */
     cwd?: string;
     /**
-     * Speficies the count. When the transformation count reaches this value, `program` instance will be recreated (and count will be reset).
+     * Specifies the count. When the transformation count reaches this value, `program` instance will be recreated (and count will be reset).
      * This is useful if the project is big and out-of-memory occurs during transformation, but the process may be slower.
      * If 0 or `undefined`, recreation will not be performed.
      */
     recreateProgramOnTransformCount?: number;
+    /** Specifies to cache base (original) source code for check if the input is changed. Default is false. */
+    cacheBaseSource?: boolean;
 }
+export type PortalTransformerResult = [
+    newSource: string | null,
+    newSourceMap: RawSourceMap | undefined
+];
+export type PortalTransformerResultNonNull = [
+    newSource: string,
+    newSourceMap: RawSourceMap | undefined
+];
 export interface PortalTransformer {
     /** The `typescript` namespace object */
     readonly ts: typeof tsNamespace;
@@ -32,7 +42,7 @@ export interface PortalTransformer {
      * @param options Transform options (addition to `options` passed to `createPortalTransformer`)
      * @returns Tuple of new source code and source map. Source map may be undefined if source code is unchanged.
      */
-    transform(content: string, fileName: string, sourceMap?: string | RawSourceMap | null, options?: TransformOptions): [newSource: string, newSourceMap: RawSourceMap | undefined];
+    transform(content: string, fileName: string, sourceMap?: string | RawSourceMap | null, options?: TransformOptions): PortalTransformerResultNonNull;
     /**
      * Performs transformation.
      * @param content Base source code. If null, uses loaded source code in the TS project.
@@ -41,7 +51,7 @@ export interface PortalTransformer {
      * @param options Transform options (addition to `options` passed to `createPortalTransformer`)
      * @returns Tuple of new source code and source map. Source map may be undefined if source code is unchanged.
      */
-    transform(content: string | null, fileName: string, sourceMap?: string | RawSourceMap | null, options?: TransformOptions): [newSource: string | null, newSourceMap: RawSourceMap | undefined];
+    transform(content: string | null, fileName: string, sourceMap?: string | RawSourceMap | null, options?: TransformOptions): PortalTransformerResult;
 }
 /**
  * Creates the new portal transformer instance for the TS project.

package/dist/createPortalTransformer.mjs

@@ -20,6 +20,7 @@ function createPortalTransformerImpl(options, ts) {
     const ignoreFiles = getIgnoreFilesFunction(options.ignoreFiles);
     const cwd = options.cwd ?? process.cwd();
     const recreateProgramOnTransformCount = options.recreateProgramOnTransformCount ?? 0;
+    const cacheBaseSource = options.cacheBaseSource ?? false;
     // eslint-disable-next-line @typescript-eslint/unbound-method
     const foundConfigPath = ts.findConfigFile(cwd, ts.sys.fileExists, project);
     if (foundConfigPath == null) {
@@ -50,11 +51,15 @@ function createPortalTransformerImpl(options, ts) {
     });
     let transformationCount = 0;
     const recreateProgram = () => {
-        const oldProgram = program;
+        // @ts-expect-error: We must clear reference first to give change for gc
+        delete instance.program;
+        // @ts-expect-error: We must clear reference first to give change for gc
+        program = null;
+        // We don't pass `oldProgram` because the transformed source codes should not be necessary (the transformation does not change logics and types)
+        // If we pass `oldProgram`, temporal memory usage may increase because gc cannot release `oldProgram` before creating new program
         program = ts.createProgram({
             options: config.options,
             rootNames: config.fileNames,
-            oldProgram,
         });
         instance.program = program;
         transformationCount = 0;
@@ -69,7 +74,7 @@ function createPortalTransformerImpl(options, ts) {
             const individualOptionsJson = optionsToString(individualOptions ?? {});
             const cachedData = cache.get(fileName);
             if (cachedData &&
-                cachedData.content === content &&
+                (!cacheBaseSource || cachedData.content === content) &&
                 cachedData.optJson === individualOptionsJson) {
                 return cachedData.result;
             }
@@ -80,15 +85,15 @@ function createPortalTransformerImpl(options, ts) {
             if (ignoreFiles(fileName)) {
                 return [content, rawSourceMap];
             }
+            const sourceFile = program.getSourceFile(fileName);
+            if (!sourceFile) {
+                return [content, rawSourceMap];
+            }
             transformationCount++;
             if (recreateProgramOnTransformCount > 0 &&
                 transformationCount >= recreateProgramOnTransformCount) {
                 recreateProgram();
             }
-            const sourceFile = program.getSourceFile(fileName);
-            if (!sourceFile) {
-                return [content, rawSourceMap];
-            }
             // If input content is changed, replace it
             if (content != null && sourceFile.text !== content) {
                 sourceFile.update(content, {
@@ -102,12 +107,19 @@ function createPortalTransformerImpl(options, ts) {
             });
             const transformResult = ts.transform(sourceFile, [transformer], program.getCompilerOptions());
             const transformedSource = transformResult.transformed[0];
+            let result;
             // If unchanged, return base file as-is
             if (transformedSource === sourceFile) {
-                return [content ?? sourceFile.text, rawSourceMap];
+                result = [content ?? sourceFile.text, rawSourceMap];
             }
-            const result = printSourceWithMap(transformedSource, fileName, rawSourceMap, ts);
-            cache.set(fileName, { content, optJson: individualOptionsJson, result });
+            else {
+                result = printSourceWithMap(transformedSource, fileName, rawSourceMap, ts);
+            }
+            cache.set(fileName, {
+                content: cacheBaseSource ? content : '',
+                optJson: individualOptionsJson,
+                result,
+            });
             return result;
         },
     };

package/dist/index.d.mts

@@ -1,5 +1,5 @@
-import createPortalTransformer, { createPortalTransformerSync, type CreatePortalTransformerOptions, type PortalTransformer } from './createPortalTransformer.mjs';
+import createPortalTransformer, { createPortalTransformerSync, type CreatePortalTransformerOptions, type PortalTransformer, type PortalTransformerResult, type PortalTransformerResultNonNull } from './createPortalTransformer.mjs';
 import createTransformer from './createTransformer.mjs';
 import version from './version.mjs';
 export { printSource, printSourceWithMap, transformSource, type TransformOptions, } from './transform.mjs';
-export { createPortalTransformer, createPortalTransformerSync, createTransformer, type CreatePortalTransformerOptions, type PortalTransformer, version, };
+export { createPortalTransformer, createPortalTransformerSync, createTransformer, type CreatePortalTransformerOptions, type PortalTransformer, type PortalTransformerResult, type PortalTransformerResultNonNull, version, };

package/dist/transform.mjs

@@ -1,6 +1,6 @@
 import * as sourceMap from 'source-map';
 import * as tsNamespace from 'typescript';
-const SYMBOL_ORIGINAL_NODE = Symbol('originalNode');
+const SYMBOL_ORIGINAL_NODE_DATA = Symbol('originalNodeData');
 function assignDefaultValues(options = {}) {
     return {
         // avoid using spread syntax to override `undefined` (not missing) values
@@ -46,7 +46,7 @@ export function transformSource(sourceFile, program, context, options) {
 function visitNodeChildren(node, parent, sourceFile, program, options) {
     const ts = options.ts;
     const newNode = visitNodeAndReplaceIfNeeded(node, parent, sourceFile, program, options);
-    if (newNode[SYMBOL_ORIGINAL_NODE]) {
+    if (newNode[SYMBOL_ORIGINAL_NODE_DATA]) {
         return newNode;
     }
     // skip statements which would not have 'value' expressions
@@ -126,34 +126,50 @@ function visitNodeAndReplaceIfNeeded(node, parent, sourceFile, program, options)
         if (type.isUnionOrIntersection()) {
             return node;
         }
+        let newSource;
         if (type.isStringLiteral()) {
             newNode = ts.factory.createStringLiteral(type.value);
+            newSource =
+                // TypeScript namespace may export `function escapeNonAsciiString(s: string, quoteChar?: CharacterCodes.doubleQuote | CharacterCodes.singleQuote | CharacterCodes.backtick): string`
+                'escapeNonAsciiString' in ts
+                    ? `"${ts.escapeNonAsciiString(type.value, 'CharacterCodes' in ts
+                        ? ts.CharacterCodes.doubleQuote
+                        : 34 /* doubleQuote */)}"`
+                    : JSON.stringify(type.value);
         }
         else if (type.isNumberLiteral()) {
             if (type.value < 0) {
-                newNode = ts.factory.createPrefixUnaryExpression(ts.SyntaxKind.MinusToken, ts.factory.createNumericLiteral(-type.value));
+                newNode = ts.factory.createParenthesizedExpression(ts.factory.createPrefixUnaryExpression(ts.SyntaxKind.MinusToken, ts.factory.createNumericLiteral(-type.value)));
+                newSource = `(-${-type.value})`;
             }
             else {
                 newNode = ts.factory.createNumericLiteral(type.value);
+                newSource = `${type.value}`;
             }
         }
         else if (flags & ts.TypeFlags.BigIntLiteral) {
-            newNode = ts.factory.createBigIntLiteral(typeChecker.typeToString(type));
+            const text = typeChecker.typeToString(type);
+            newNode = ts.factory.createBigIntLiteral(text);
+            newSource = text;
         }
         else if (flags & ts.TypeFlags.BooleanLiteral) {
             const text = typeChecker.typeToString(type);
             newNode =
                 text === 'true' ? ts.factory.createTrue() : ts.factory.createFalse();
+            newSource = text;
         }
         else if (flags & ts.TypeFlags.Null) {
             newNode = ts.factory.createNull();
+            newSource = 'null';
         }
         else if (flags & ts.TypeFlags.Undefined) {
             if (options.useUndefinedSymbolForUndefinedValue) {
                 newNode = ts.factory.createIdentifier('undefined');
+                newSource = 'undefined';
             }
             else {
-                newNode = ts.factory.createVoidZero();
+                newNode = ts.factory.createParenthesizedExpression(ts.factory.createVoidZero());
+                newSource = '(void 0)';
             }
         }
         else {
@@ -161,7 +177,12 @@ function visitNodeAndReplaceIfNeeded(node, parent, sourceFile, program, options)
         }
         const result = ts.addSyntheticTrailingComment(newNode, ts.SyntaxKind.MultiLineCommentTrivia, ` ${node.getText(sourceFile)} `);
         ts.setTextRange(result, node);
-        result[SYMBOL_ORIGINAL_NODE] = node;
+        result[SYMBOL_ORIGINAL_NODE_DATA] = [
+            node.getText(sourceFile),
+            newSource,
+            node.pos,
+            node.end,
+        ];
         return result;
     }
     catch {
@@ -432,22 +453,27 @@ function positionToLineAndColumn(sourceFile, pos, generatedDiff) {
 }
 function printSourceImpl(tsInstance, sourceFile, originalSourceName, mapGenerator) {
     const ts = tsInstance ?? tsNamespace;
-    const printer = ts.createPrinter({ removeComments: true });
-    const r = printNode(ts, printer, sourceFile.getFullText(), sourceFile, sourceFile, { pos: 0, diff: 0, lastLine: 0 }, originalSourceName, mapGenerator);
-    return [r, mapGenerator?.toJSON()];
+    const r = printNode(ts, sourceFile.getFullText(), sourceFile, sourceFile, { pos: 0, diff: 0, lastLine: 0 }, originalSourceName, mapGenerator);
+    // This forces to concatenate strings into flatten one to reduce object trees for ConsString
+    void (r | 0);
+    const json = mapGenerator?.toJSON();
+    if (json) {
+        void (json.mappings | 0);
+    }
+    return [r, json];
 }
-function printNode(tsInstance, printer, baseSource, sourceFile, node, posContext, originalSourceName, mapGenerator) {
-    const originalNode = node[SYMBOL_ORIGINAL_NODE];
-    if (originalNode) {
-        let result = printer.printNode(tsInstance.EmitHint.Unspecified, node, sourceFile);
+function printNode(tsInstance, baseSource, sourceFile, node, posContext, originalSourceName, mapGenerator) {
+    const originalNodeData = node[SYMBOL_ORIGINAL_NODE_DATA];
+    if (originalNodeData) {
+        let result = originalNodeData[1];
         const comments = tsInstance.getSyntheticTrailingComments(node);
         if (comments) {
             for (const comment of comments) {
                 result += ` /*${comment.text}*/`;
             }
         }
-        const old = originalNode.getText(sourceFile);
-        const oldFull = baseSource.substring(originalNode.pos, originalNode.end);
+        const old = originalNodeData[0];
+        const oldFull = baseSource.substring(originalNodeData[2], originalNodeData[3]);
         const i = oldFull.lastIndexOf(old);
         const leadingUnchanged = i < 0 ? 0 : i;
         const newText = i < 0
@@ -490,7 +516,7 @@ function printNode(tsInstance, printer, baseSource, sourceFile, node, posContext
             addMappingForCurrent();
             posContext.pos = child.pos;
         }
-        output += printNode(tsInstance, printer, baseSource, sourceFile, child, posContext, originalSourceName, mapGenerator);
+        output += printNode(tsInstance, baseSource, sourceFile, child, posContext, originalSourceName, mapGenerator);
         lastChildPos = child.end;
         return child;
     }, void 0);

package/dist/version.d.mts

@@ -1,2 +1,2 @@
-declare const _default: "0.6.0";
+declare const _default: "0.7.0";
 export default _default;

package/dist/version.mjs

@@ -1 +1 @@
-export default '0.6.0';
+export default '0.7.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-const-value-transformer",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "engines": {
     "node": ">=20.19.3"
   },