jsii-rosetta 1.65.1 → 1.66.0

package/lib/commands/extract.d.ts

@@ -56,9 +56,9 @@ export interface ExtractOptions {
      */
     readonly allowDirtyTranslations?: boolean;
     /**
-     * Compress the implicit tablet files
+     * Compress the implicit tablet files.
      *
-     * @default false
+     * @default - preserves the original compression status of each individual implicit tablet file.
      */
     readonly compressTablet?: boolean;
     /**

package/lib/commands/extract.js

@@ -69,12 +69,14 @@ async function extractSnippets(assemblyLocations, options = {}) {
     // Save to individual tablet files
     if (options.writeToImplicitTablets ?? true) {
         await Promise.all(Object.entries(snippetsPerAssembly).map(async ([location, snips]) => {
-            const asmTabletFile = path.join(location, options.compressTablet ? tablets_1.DEFAULT_TABLET_NAME_COMPRESSED : tablets_1.DEFAULT_TABLET_NAME);
+            // Compress the implicit tablet if explicitly asked to, otherwise compress only if the original tablet was compressed.
+            const compressedTablet = options.compressTablet ?? (0, assemblies_1.compressedTabletExists)(location);
+            const asmTabletFile = path.join(location, compressedTablet ? tablets_1.DEFAULT_TABLET_NAME_COMPRESSED : tablets_1.DEFAULT_TABLET_NAME);
             logging.debug(`Writing ${snips.length} translations to ${asmTabletFile}`);
             const translations = snips.map(({ key }) => translator.tablet.tryGetSnippet(key)).filter(util_1.isDefined);
             const asmTablet = new tablets_1.LanguageTablet();
             asmTablet.addSnippets(...translations);
-            await asmTablet.save(asmTabletFile, options.compressTablet);
+            await asmTablet.save(asmTabletFile, compressedTablet);
         }));
     }
     // optionally append to the output file

package/lib/jsii/assemblies.d.ts

@@ -37,6 +37,13 @@ export declare function loadAssemblies(assemblyLocations: readonly string[], val
  * Returns a map of { directory -> tablet }.
  */
 export declare function loadAllDefaultTablets(asms: readonly LoadedAssembly[]): Promise<Record<string, LanguageTablet>>;
+/**
+ * Returns the location of the tablet file, either .jsii.tabl.json or .jsii.tabl.json.gz.
+ * Assumes that a tablet exists in the directory and if not, the ensuing behavior is
+ * handled by the caller of this function.
+ */
+export declare function guessTabletLocation(directory: string): string;
+export declare function compressedTabletExists(directory: string): boolean;
 export declare type AssemblySnippetSource = {
     type: 'markdown';
     markdown: string;

package/lib/jsii/assemblies.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.findContainingSubmodule = exports.findTypeLookupAssembly = exports.allTypeScriptSnippets = exports.allSnippetSources = exports.loadAllDefaultTablets = exports.loadAssemblies = exports.EXAMPLE_METADATA_JSDOCTAG = void 0;
+exports.findContainingSubmodule = exports.findTypeLookupAssembly = exports.allTypeScriptSnippets = exports.allSnippetSources = exports.compressedTabletExists = exports.guessTabletLocation = exports.loadAllDefaultTablets = exports.loadAssemblies = exports.EXAMPLE_METADATA_JSDOCTAG = void 0;
 const spec = require("@jsii/spec");
 const spec_1 = require("@jsii/spec");
 const fs_1 = require("fs");
@@ -52,14 +52,24 @@ exports.loadAssemblies = loadAssemblies;
  * Returns a map of { directory -> tablet }.
  */
 async function loadAllDefaultTablets(asms) {
-    return (0, util_1.mkDict)(await Promise.all(asms.map(async (a) => [a.directory, await tablets_1.LanguageTablet.fromOptionalFile(guessTabletLocation(a))])));
-    function guessTabletLocation(a) {
-        const defaultTablet = path.join(a.directory, tablets_1.DEFAULT_TABLET_NAME);
-        const compDefaultTablet = path.join(a.directory, tablets_1.DEFAULT_TABLET_NAME_COMPRESSED);
-        return fs.existsSync(defaultTablet) ? defaultTablet : compDefaultTablet;
-    }
+    return (0, util_1.mkDict)(await Promise.all(asms.map(async (a) => [a.directory, await tablets_1.LanguageTablet.fromOptionalFile(guessTabletLocation(a.directory))])));
 }
 exports.loadAllDefaultTablets = loadAllDefaultTablets;
+/**
+ * Returns the location of the tablet file, either .jsii.tabl.json or .jsii.tabl.json.gz.
+ * Assumes that a tablet exists in the directory and if not, the ensuing behavior is
+ * handled by the caller of this function.
+ */
+function guessTabletLocation(directory) {
+    return compressedTabletExists(directory)
+        ? path.join(directory, tablets_1.DEFAULT_TABLET_NAME_COMPRESSED)
+        : path.join(directory, tablets_1.DEFAULT_TABLET_NAME);
+}
+exports.guessTabletLocation = guessTabletLocation;
+function compressedTabletExists(directory) {
+    return fs.existsSync(path.join(directory, tablets_1.DEFAULT_TABLET_NAME_COMPRESSED));
+}
+exports.compressedTabletExists = compressedTabletExists;
 /**
  * Return all markdown and example snippets from the given assembly
  */

package/lib/rosetta-reader.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Rosetta = exports.RosettaTabletReader = exports.UnknownSnippetMode = void 0;
-const path = require("path");
 const assemblies_1 = require("./jsii/assemblies");
 const logging = require("./logging");
 const markdown_1 = require("./markdown/markdown");
@@ -93,7 +92,7 @@ class RosettaTabletReader {
      * pacmak sends our way later on is not going to be enough to do that.
      */
     async addAssembly(assembly, assemblyDir) {
-        const defaultTablet = path.join(assemblyDir, tablets_1.DEFAULT_TABLET_NAME);
+        const defaultTablet = (0, assemblies_1.guessTabletLocation)(assemblyDir);
         if (await (0, util_1.pathExists)(defaultTablet)) {
             try {
                 await this.loadTabletFromFile(defaultTablet);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jsii-rosetta",
-  "version": "1.65.1",
+  "version": "1.66.0",
   "description": "Translate TypeScript code snippets to other languages",
   "main": "lib/index.js",
   "bin": {
@@ -19,14 +19,14 @@
     "@types/commonmark": "^0.27.5",
     "@types/mock-fs": "^4.13.1",
     "@types/workerpool": "^6.1.0",
-    "@types/semver": "^7.3.10",
-    "jsii-build-tools": "1.65.1",
+    "@types/semver": "^7.3.12",
+    "jsii-build-tools": "1.66.0",
     "memory-streams": "^0.1.3",
     "mock-fs": "^5.1.4"
   },
   "dependencies": {
-    "@jsii/check-node": "1.65.1",
-    "@jsii/spec": "1.65.1",
+    "@jsii/check-node": "1.66.0",
+    "@jsii/spec": "1.66.0",
     "commonmark": "^0.30.0",
     "typescript": "~3.9.10",
     "@xmldom/xmldom": "^0.8.2",
@@ -35,7 +35,7 @@
     "semver": "^7.3.7",
     "semver-intersect": "^1.4.0",
     "fast-glob": "^3.2.11",
-    "jsii": "1.65.1"
+    "jsii": "1.66.0"
   },
   "license": "Apache-2.0",
   "author": {

package/test/commands/extract.test.js

@@ -81,6 +81,57 @@ test('extract can compress implicit tablet file', async () => {
     await tablet.load(compImplicitTablet);
     expect(tablet.snippetKeys.length).toEqual(1);
 });
+describe('extract behavior regarding compressing implicit tablets', () => {
+    function hasCompressedDefaultTablet(directory) {
+        return (fs.existsSync(path.join(directory, lib_1.DEFAULT_TABLET_NAME_COMPRESSED)) &&
+            !fs.existsSync(path.join(directory, lib_1.DEFAULT_TABLET_NAME)));
+    }
+    function hasUncompressedDefaultTablet(directory) {
+        return (!fs.existsSync(path.join(directory, lib_1.DEFAULT_TABLET_NAME_COMPRESSED)) &&
+            fs.existsSync(path.join(directory, lib_1.DEFAULT_TABLET_NAME)));
+    }
+    function hasBothDefaultTablets(directory) {
+        return (fs.existsSync(path.join(directory, lib_1.DEFAULT_TABLET_NAME_COMPRESSED)) &&
+            fs.existsSync(path.join(directory, lib_1.DEFAULT_TABLET_NAME)));
+    }
+    test('preserve uncompressed tablet by default', async () => {
+        // Run extract with compressTablet = false to create .jsii.tabl.json file
+        await extract.extractSnippets([assembly.moduleDirectory], {
+            ...defaultExtractOptions,
+            compressTablet: false,
+        });
+        expect(hasUncompressedDefaultTablet(assembly.moduleDirectory)).toBeTruthy();
+        await extract.extractSnippets([assembly.moduleDirectory], {
+            ...defaultExtractOptions,
+        });
+        expect(hasUncompressedDefaultTablet(assembly.moduleDirectory)).toBeTruthy();
+    });
+    test('preserve compressed tablet by default', async () => {
+        // Run extract with compressTablet = true to create .jsii.tabl.json.gz file
+        await extract.extractSnippets([assembly.moduleDirectory], {
+            ...defaultExtractOptions,
+            compressTablet: true,
+        });
+        expect(hasCompressedDefaultTablet(assembly.moduleDirectory)).toBeTruthy();
+        await extract.extractSnippets([assembly.moduleDirectory], {
+            ...defaultExtractOptions,
+        });
+        expect(hasCompressedDefaultTablet(assembly.moduleDirectory)).toBeTruthy();
+    });
+    test('respects the explicit call to compress the tablet', async () => {
+        // Run extract with compressTablet = false to create .jsii.tabl.json file
+        await extract.extractSnippets([assembly.moduleDirectory], {
+            ...defaultExtractOptions,
+            compressTablet: false,
+        });
+        expect(hasUncompressedDefaultTablet(assembly.moduleDirectory)).toBeTruthy();
+        await extract.extractSnippets([assembly.moduleDirectory], {
+            ...defaultExtractOptions,
+            compressTablet: true,
+        });
+        expect(hasBothDefaultTablets(assembly.moduleDirectory)).toBeTruthy();
+    });
+});
 test('extract works from compressed test assembly', async () => {
     const compressedAssembly = testutil_1.TestJsiiModule.fromSource({
         'index.ts': `

package/test/commands/transliterate.test.js

@@ -1316,6 +1316,36 @@ test('will read translations from cache even if they are dirty', async () => {
         infusedAssembly.cleanup();
     }
 });
+test('will read translations from cache when tablet is compressed', async () => {
+    const infusedAssembly = testutil_1.TestJsiiModule.fromSource({
+        'index.ts': `
+        /**
+         * ClassA
+         *
+         * @example x
+         */
+        export class ClassA {
+          public someMethod() {
+          }
+        }
+        `,
+    }, {
+        name: 'my_assembly',
+        jsii: testutil_1.DUMMY_JSII_CONFIG,
+    });
+    try {
+        // Run an extract and tell it to compress the tablet
+        await (0, extract_1.extractSnippets)([infusedAssembly.moduleDirectory], {
+            compressTablet: true,
+        });
+        await (0, transliterate_1.transliterateAssembly)([infusedAssembly.moduleDirectory], [target_language_1.TargetLanguage.PYTHON]);
+        const translated = JSON.parse(await fs.promises.readFile(path.join(infusedAssembly.moduleDirectory, '.jsii.python'), 'utf-8'));
+        expect(translated.types?.['my_assembly.ClassA'].docs?.example).toEqual('x');
+    }
+    finally {
+        infusedAssembly.cleanup();
+    }
+});
 test('will output to specified directory', async () => (0, testutil_1.withTemporaryDirectory)(async (tmpDir) => {
     // GIVEN
     const compilationResult = jsii.compileJsiiForTest({