jsii-rosetta 1.76.0 → 4.9.0-dev.1

package/test/markdown/xmldoccomments.test.js

@@ -1,89 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const lib_1 = require("../../lib");
-const DEBUG = false;
-test('emphasis and lists', () => {
-    expectOutput(`
-# Hello
-## Bye
-
-This is *very* **cool**.
-
-* Yes
-* Really
-`, `
-<h1>Hello</h1>
-
-<h2>Bye</h2>
-
-This is <em>very</em> <strong>cool</strong>.
-
-<list type="bullet">
-<description>Yes</description>
-<description>Really</description>
-</list>
-`);
-});
-test('special characters are escaped', () => {
-    expectOutput(`
-  Escape this & and this < and this >
-
-  ` +
-        '```' +
-        `
-  if (x < 3) {
-    System.Console.WriteLn("bloep");
-  }
-  ` +
-        '```', `
-Escape this &amp; and this &lt; and this &gt;
-
-<code><![CDATA[
-if (x < 3) {
-  System.Console.WriteLn("bloep");
-}
-]]></code>
-  `);
-});
-test('quotes are escaped inside attributes', () => {
-    expectOutput(`
-  ['tis but a "scratch"](http://bla.ck/"kni"gh&t)
-
-  ![nay merely a "flesh wound" &cet](http://bla.ck/"kni"gh&t.jpg)
-  `, `
-<a href="http://bla.ck/%22kni%22gh&amp;t">'tis but a "scratch"</a>
-
-<img alt="nay merely a &quot;flesh wound&quot; &amp;cet" src="http://bla.ck/%22kni%22gh&amp;t.jpg" />
-  `);
-});
-test('convert header properly', () => {
-    expectOutput(`
-  <!--BEGIN STABILITY BANNER-->
-
-  ---
-
-  ![Stability: Stable](https://img.shields.io/badge/stability-Stable-success.svg?style=for-the-badge)
-
-  ---
-  <!--END STABILITY BANNER-->
-  `, `
-<!--BEGIN STABILITY BANNER-->
-
-<hr />
-
-<img alt="Stability: Stable" src="https://img.shields.io/badge/stability-Stable-success.svg?style=for-the-badge" />
-
-<hr />
-
-  <!--END STABILITY BANNER-->
-  `);
-});
-function expectOutput(source, expected) {
-    if (DEBUG) {
-        // tslint:disable-next-line:no-console
-        console.log((0, lib_1.markDownToStructure)(source));
-    }
-    const output = (0, lib_1.markDownToXmlDoc)(source);
-    expect(output.trim()).toEqual(expected.trim());
-}
-//# sourceMappingURL=xmldoccomments.test.js.map

package/test/otree.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=otree.test.d.ts.map

package/test/otree.test.js

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const o_tree_1 = require("../lib/o-tree");
-test('test indentation', () => {
-    const tree = new o_tree_1.OTree(['{'], ['\na', '\nb', '\nc'], {
-        separator: ', ',
-        indent: 4,
-        suffix: '\n}',
-    });
-    expect((0, o_tree_1.renderTree)(tree)).toEqual('{\n    a,\n    b,\n    c\n}');
-});
-test('collapse subsequent unused indentation', () => {
-    const tree = new o_tree_1.OTree(['{'], [new o_tree_1.OTree([], ['\na', '\nb', '\nc'], { indent: 4, separator: ', ' })], {
-        separator: ', ',
-        indent: 4,
-        suffix: '\n}',
-    });
-    expect((0, o_tree_1.renderTree)(tree)).toEqual('{\n    a,\n    b,\n    c\n}');
-});
-test('don not collapse subsequent USED indentation', () => {
-    const tree = new o_tree_1.OTree(['{'], [
-        '\na',
-        new o_tree_1.OTree(['\n{'], ['\na', '\nb', '\nc'], {
-            indent: 4,
-            separator: ', ',
-            suffix: '\n}',
-        }),
-        '\nb',
-    ], {
-        separator: ', ',
-        indent: 4,
-        suffix: '\n}',
-    });
-    expect((0, o_tree_1.renderTree)(tree)).toEqual(['{', '    a,', '    {', '        a,', '        b,', '        c', '    },', '    b', '}'].join('\n'));
-});
-//# sourceMappingURL=otree.test.js.map

package/test/record-references.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=record-references.test.d.ts.map

package/test/record-references.test.js

@@ -1,88 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const testutil_1 = require("./testutil");
-let assembly;
-beforeAll(() => {
-    assembly = testutil_1.TestJsiiModule.fromSource({
-        'index.ts': `
-        export class ClassA {
-          public someMethod() {
-          }
-        }
-        export class ClassB {
-          public argumentMethod(args: BeeArgs) {
-            Array.isArray(args);
-          }
-        }
-
-        export interface BeeArgs { readonly value: string; readonly nested?: NestedType; }
-
-        export interface NestedType { readonly x: number; }
-
-        export * as submod from './submodule';
-        `,
-        'submodule.ts': `
-        export class SubmoduleClass {
-        }
-      `,
-    }, {
-        name: 'my_assembly',
-        jsii: testutil_1.DUMMY_JSII_CONFIG,
-    });
-});
-afterAll(() => assembly.cleanup());
-test('detect class instantiations', () => {
-    const translator = assembly.successfullyCompile(`
-    import * as ass from 'my_assembly';
-    const a = new ass.ClassA();
-  `);
-    expect(translator.fqnsReferenced()).toEqual(['my_assembly.ClassA']);
-});
-test("don't detect hidden class instantiations", () => {
-    const translator = assembly.successfullyCompile(`
-    /// !hide
-    import * as ass from 'my_assembly';
-    const a = new ass.ClassA();
-    /// !show
-    const b = new ass.ClassB();
-  `);
-    expect(translator.fqnsReferenced()).toEqual(['my_assembly.ClassB']);
-});
-test('detect method calls', () => {
-    const translator = assembly.successfullyCompile(`
-    /// !hide
-    import * as ass from 'my_assembly';
-    const a = new ass.ClassA();
-    /// !show
-    a.someMethod();
-  `);
-    expect(translator.fqnsReferenced()).toEqual(['my_assembly.ClassA#someMethod']);
-});
-test('detect types of parameter used in method calls', () => {
-    const translator = assembly.successfullyCompile(`
-    /// !hide
-    import * as ass from 'my_assembly';
-    const b = new ass.ClassB();
-    /// !show
-    b.argumentMethod({ value: 'hello' });
-  `);
-    expect(translator.fqnsReferenced()).toEqual(['my_assembly.BeeArgs', 'my_assembly.ClassB#argumentMethod']);
-});
-test('detect nested types of parameter used in method calls', () => {
-    const translator = assembly.successfullyCompile(`
-    /// !hide
-    import * as ass from 'my_assembly';
-    const b = new ass.ClassB();
-    /// !show
-    b.argumentMethod({ value: 'hello', nested: { x: 3 } });
-  `);
-    expect(translator.fqnsReferenced()).toContain('my_assembly.NestedType');
-});
-test('detect types in submodules', () => {
-    const translator = assembly.successfullyCompile(`
-    import { submod as subby } from 'my_assembly';
-    const b = new subby.SubmoduleClass();
-  `);
-    expect(translator.fqnsReferenced()).toContain('my_assembly.submod.SubmoduleClass');
-});
-//# sourceMappingURL=record-references.test.js.map

package/test/rosetta/default.ts-fixture

@@ -1 +0,0 @@
-/// here

package/test/rosetta-translator.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=rosetta-translator.test.d.ts.map

package/test/rosetta-translator.test.js

@@ -1,33 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const lib_1 = require("../lib");
-const testutil_1 = require("./testutil");
-const location = { api: { api: 'file', fileName: 'test.ts' } };
-jest.setTimeout(60000);
-test('translator can translate', async () => {
-    const translator = new lib_1.RosettaTranslator({
-        includeCompilerDiagnostics: true,
-    });
-    const snippet = (0, lib_1.typeScriptSnippetFromVisibleSource)('console.log("hello world");', location, true);
-    const { translatedSnippets } = await translator.translateAll([snippet]);
-    expect(translatedSnippets).toHaveLength(1);
-    expect(translatedSnippets[0].get(lib_1.TargetLanguage.PYTHON)?.source).toEqual('print("hello world")');
-    expect(translator.tablet.snippetKeys).toHaveLength(1);
-});
-test('translator can read from cache', async () => {
-    await (0, testutil_1.withTemporaryDirectory)(async () => {
-        // GIVEN: prepare cache
-        const cacheBuilder = new lib_1.RosettaTranslator({ includeCompilerDiagnostics: true });
-        const snippet = (0, lib_1.typeScriptSnippetFromVisibleSource)('console.log("hello world");', location, true);
-        await cacheBuilder.translateAll([snippet]);
-        await cacheBuilder.tablet.save('temp.tabl.json');
-        // WHEN: new translatro
-        const translator = new lib_1.RosettaTranslator({ includeCompilerDiagnostics: true });
-        await translator.loadCache('temp.tabl.json');
-        const cached = translator.readFromCache([snippet]);
-        expect(cached.translations).toHaveLength(1);
-        expect(cached.remaining).toHaveLength(0);
-        expect(translator.tablet.snippetKeys).toHaveLength(1);
-    });
-});
-//# sourceMappingURL=rosetta-translator.test.js.map

package/test/rosetta.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=rosetta.test.d.ts.map

package/test/rosetta.test.js

@@ -1,221 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const mockfs = require("mock-fs");
-const lib_1 = require("../lib");
-const languages_1 = require("../lib/languages");
-const fake_assembly_1 = require("./jsii/fake-assembly");
-const testutil_1 = require("./testutil");
-const SAMPLE_CODE = {
-    visibleSource: 'callThisFunction();',
-    location: (0, testutil_1.testSnippetLocation)('sample'),
-};
-const SAMPLE_CODE_COMPILING = {
-    visibleSource: 'console.log("hello");',
-    location: (0, testutil_1.testSnippetLocation)('sample'),
-};
-describe('Rosetta object can do live translation', () => {
-    let rosetta;
-    let translated;
-    beforeEach(() => {
-        // GIVEN
-        rosetta = new lib_1.Rosetta({
-            unknownSnippets: lib_1.UnknownSnippetMode.TRANSLATE,
-            targetLanguages: [languages_1.TargetLanguage.PYTHON],
-        });
-        // WHEN
-        translated = rosetta.translateSnippet(SAMPLE_CODE, languages_1.TargetLanguage.PYTHON);
-    });
-    test('output is correct', () => {
-        expect(translated).toMatchObject({
-            source: 'call_this_function()',
-            language: 'python',
-        });
-    });
-    test('translations are added to liveTablet', () => {
-        expect(rosetta.liveTablet.count).toEqual(1);
-    });
-});
-test('Can use preloaded tablet', () => {
-    // GIVEN
-    const rosetta = new lib_1.Rosetta();
-    const tablet = new lib_1.LanguageTablet();
-    tablet.addSnippet(makeSnippet(SAMPLE_CODE, {
-        python: 'Not Really Translated',
-        csharp: 'Not Really Translated C#',
-        java: 'Not Really Translated Java',
-        go: 'Not Really Translated Go',
-    }));
-    rosetta.addTablet(tablet);
-    // WHEN
-    const translated = rosetta.translateSnippet(SAMPLE_CODE, languages_1.TargetLanguage.PYTHON);
-    // THEN
-    expect(translated).toMatchObject({
-        source: 'Not Really Translated',
-        language: 'python',
-    });
-});
-test('Rosetta object can do live translation', () => {
-    // GIVEN
-    const rosetta = new lib_1.Rosetta({
-        unknownSnippets: lib_1.UnknownSnippetMode.TRANSLATE,
-        targetLanguages: [languages_1.TargetLanguage.PYTHON],
-    });
-    // WHEN
-    const translated = rosetta.translateSnippet(SAMPLE_CODE, languages_1.TargetLanguage.PYTHON);
-    // THEN
-    expect(translated).toMatchObject({
-        source: 'call_this_function()',
-        language: 'python',
-    });
-});
-test('Rosetta object can fail on untranslated snippet', () => {
-    // GIVEN
-    const rosetta = new lib_1.Rosetta({
-        unknownSnippets: lib_1.UnknownSnippetMode.FAIL,
-        targetLanguages: [languages_1.TargetLanguage.PYTHON],
-    });
-    // WHEN
-    expect(() => {
-        rosetta.translateSnippet(SAMPLE_CODE, languages_1.TargetLanguage.PYTHON);
-    }).toThrow(/snippet was not found/);
-});
-test('Rosetta can give you an untranslated snippet back', () => {
-    // GIVEN
-    const rosetta = new lib_1.Rosetta({
-        unknownSnippets: lib_1.UnknownSnippetMode.VERBATIM,
-        targetLanguages: [languages_1.TargetLanguage.PYTHON],
-    });
-    // WHEN
-    const translated = rosetta.translateSnippet(SAMPLE_CODE, languages_1.TargetLanguage.PYTHON);
-    expect(translated?.source).toEqual('callThisFunction();');
-});
-test('Rosetta object can do translation and annotation of snippets in MarkDown', () => {
-    // GIVEN
-    const rosetta = new lib_1.Rosetta({
-        unknownSnippets: lib_1.UnknownSnippetMode.TRANSLATE,
-        targetLanguages: [languages_1.TargetLanguage.PYTHON],
-    });
-    // WHEN
-    const translated = rosetta.translateSnippetsInMarkdown({ api: 'file', fileName: 'markdown' }, [
-        '# MarkDown Translation',
-        '',
-        'Now follows a snippet:',
-        '```ts',
-        SAMPLE_CODE.visibleSource,
-        '```',
-        'That was it, thank you for your attention.',
-    ].join('\n'), languages_1.TargetLanguage.PYTHON, false, (trans) => {
-        return {
-            ...trans,
-            source: `# We translated something!\n${trans.source}`,
-        };
-    });
-    // THEN
-    expect(translated).toEqual([
-        '# MarkDown Translation',
-        '',
-        'Now follows a snippet:',
-        '',
-        '```python',
-        '# We translated something!',
-        'call_this_function()',
-        '```',
-        '',
-        'That was it, thank you for your attention.',
-    ].join('\n'));
-});
-describe('Rosetta object with disclaimers', () => {
-    let rosetta;
-    beforeEach(() => {
-        // GIVEN
-        rosetta = new lib_1.Rosetta({
-            includeCompilerDiagnostics: true,
-            unknownSnippets: lib_1.UnknownSnippetMode.TRANSLATE,
-            targetLanguages: [languages_1.TargetLanguage.PYTHON],
-            prefixDisclaimer: true,
-        });
-    });
-    test('compiling source code has no disclaimer', () => {
-        // WHEN
-        const translated = rosetta.translateSnippet(SAMPLE_CODE_COMPILING, languages_1.TargetLanguage.PYTHON);
-        // THEN
-        expect(translated).toMatchObject({
-            source: 'print("hello")',
-            language: 'python',
-        });
-    });
-    test('noncompiling source code has disclaimer', () => {
-        // WHEN
-        const translated = rosetta.translateSnippet(SAMPLE_CODE, languages_1.TargetLanguage.PYTHON);
-        // THEN
-        expect(translated).toMatchObject({
-            source: '# Example automatically generated from non-compiling source. May contain errors.\ncall_this_function()',
-            language: 'python',
-        });
-    });
-    test('source with no compilation information has no disclaimer', () => {
-        // GIVEN
-        const rosettaNoCompile = new lib_1.Rosetta({
-            includeCompilerDiagnostics: false,
-            unknownSnippets: lib_1.UnknownSnippetMode.TRANSLATE,
-            targetLanguages: [languages_1.TargetLanguage.PYTHON],
-            prefixDisclaimer: true,
-        });
-        // WHEN
-        const translated = rosettaNoCompile.translateSnippet(SAMPLE_CODE, languages_1.TargetLanguage.PYTHON);
-        // THEN
-        expect(translated).toMatchObject({
-            source: 'call_this_function()',
-            language: 'python',
-        });
-    });
-});
-describe('with mocked filesystem', () => {
-    beforeEach(() => {
-        mockfs();
-    });
-    afterEach(() => {
-        mockfs.restore();
-    });
-    const tablet = new lib_1.LanguageTablet();
-    tablet.addSnippet(makeSnippet(SAMPLE_CODE, {
-        python: 'My Stored Translation',
-        csharp: 'My Stored Translation C#',
-        java: 'My Stored Translation Java',
-        go: 'My Stored Translation Go',
-    }));
-    test('Can save language tablet and load it in Rosetta class', async () => {
-        // GIVEN
-        await tablet.save('/test.tablet');
-        // WHEN
-        const rosetta = new lib_1.Rosetta();
-        await rosetta.loadTabletFromFile('/test.tablet');
-        const translated = rosetta.translateSnippet(SAMPLE_CODE, languages_1.TargetLanguage.PYTHON);
-        // THEN
-        expect(translated).toMatchObject({
-            source: 'My Stored Translation',
-            language: 'python',
-        });
-    });
-    test('Rosetta class automatically loads default-named tablets in same directory as assembly', async () => {
-        // GIVEN
-        await tablet.save(`/${lib_1.DEFAULT_TABLET_NAME}`);
-        // WHEN
-        const rosetta = new lib_1.Rosetta();
-        await rosetta.addAssembly((0, fake_assembly_1.fakeAssembly)({}), '/');
-        const translated = rosetta.translateSnippet(SAMPLE_CODE, languages_1.TargetLanguage.PYTHON);
-        // THEN
-        expect(translated).toMatchObject({
-            source: 'My Stored Translation',
-            language: 'python',
-        });
-    });
-});
-function makeSnippet(original, translations) {
-    const snippet = lib_1.TranslatedSnippet.fromTypeScript(original);
-    for (const [key, value] of Object.entries(translations)) {
-        snippet.addTranslation(key, value, 'x');
-    }
-    return snippet;
-}
-//# sourceMappingURL=rosetta.test.js.map

package/test/snippet-selectors.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=snippet-selectors.test.d.ts.map

package/test/snippet-selectors.test.js

@@ -1,57 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const snippet_1 = require("../lib/snippet");
-const snippet_selectors_1 = require("../lib/snippet-selectors");
-const tablets_1 = require("../lib/tablets/tablets");
-const testutil_1 = require("./testutil");
-const snippets = [];
-const sources = [
-    `export class ClassA {
-    public someMethod() {
-    }
-  }`,
-    `export class ClassA {
-    public someMethod() {
-    }
-  }
-  export interface BeeArgs { readonly value: string; }
-  `,
-    `export class ClassA {
-    public someMethod() {
-    }
-  }
-  export class ClassB {
-    public argumentMethod(args: BeeArgs) {
-      Array.isArray(args);
-    }
-  }
-  export interface BeeArgs { readonly value: string; }
-  `,
-];
-beforeAll(() => {
-    for (const source of sources) {
-        const snippet = tablets_1.TranslatedSnippet.fromTypeScript((0, snippet_1.typeScriptSnippetFromSource)(source, (0, testutil_1.testSnippetLocation)('selectors'), false));
-        snippets.push(snippet);
-    }
-});
-test('longest', () => {
-    const result = (0, snippet_selectors_1.longest)(snippets);
-    expect(result).toEqual(snippets[2]);
-});
-test('meanLength', () => {
-    const result = (0, snippet_selectors_1.meanLength)(snippets);
-    expect(result).toEqual(snippets[1]);
-});
-test('shortest', () => {
-    const result = (0, snippet_selectors_1.shortest)(snippets);
-    expect(result).toEqual(snippets[0]);
-});
-test('mean', () => {
-    // Add fake syntax counters to ensure that snippets[1] is the closest euclidean distance.
-    snippets[0].addSyntaxKindCounter({ 1: 1, 2: 5, 3: 1 });
-    snippets[1].addSyntaxKindCounter({ 1: 1, 2: 3, 3: 2 });
-    snippets[2].addSyntaxKindCounter({ 1: 1, 2: 1, 3: 4 });
-    const result = (0, snippet_selectors_1.mean)(snippets);
-    expect(result).toEqual(snippets[1]);
-});
-//# sourceMappingURL=snippet-selectors.test.js.map

package/test/snippet.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=snippet.test.d.ts.map

package/test/snippet.test.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const lib_1 = require("../lib");
-describe('construct TypeScriptSnippets', () => {
-    const source = ['a', '/// !show', 'b', '/// !hide', 'c'].join('\n');
-    const location = { api: { api: 'file', fileName: 'x' } };
-    test('using typeScriptSnippetFromVisibleSource', () => {
-        const snippet = (0, lib_1.typeScriptSnippetFromVisibleSource)(source, location, true);
-        expect(snippet.visibleSource).toEqual(source);
-        expect(snippet.completeSource).toEqual(undefined);
-    });
-    test('using typeScriptSnippetFromCompleteSource', () => {
-        const snippet = (0, lib_1.typeScriptSnippetFromCompleteSource)(source, location, true);
-        expect(snippet.visibleSource).toEqual('b');
-        expect(snippet.completeSource).toEqual(source);
-    });
-});
-//# sourceMappingURL=snippet.test.js.map

package/test/syntax-counter.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=syntax-counter.test.d.ts.map

package/test/syntax-counter.test.js

@@ -1,60 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const testutil_1 = require("./testutil");
-let assembly;
-beforeAll(() => {
-    assembly = testutil_1.TestJsiiModule.fromSource(`
-    export class ClassA {
-      public someMethod() {
-      }
-    }
-    export class ClassB {
-      public argumentMethod(args: BeeArgs) {
-        Array.isArray(args);
-      }
-    }
-    export interface BeeArgs { readonly value: string; readonly nested?: NestedType; }
-    export interface NestedType { readonly x: number; }
-    `, {
-        name: 'my_assembly',
-        jsii: testutil_1.DUMMY_JSII_CONFIG,
-    });
-});
-afterAll(() => assembly.cleanup());
-test('generate syntax counter', () => {
-    const translator = assembly.successfullyCompile(`
-    import * as ass from 'my_assembly';
-    const a = new ass.ClassA();
-  `);
-    expect(translator.syntaxKindCounter()).toEqual({
-        10: 1,
-        75: 4,
-        194: 1,
-        197: 1,
-        225: 1,
-        242: 1,
-        243: 1,
-        254: 1,
-        255: 1,
-        256: 1,
-        290: 1, // SourceFile
-    });
-});
-test('do not count syntax in hidden lines', () => {
-    const translator = assembly.successfullyCompile(`
-    /// !hide
-    import * as ass from 'my_assembly';
-    const a = new ass.ClassA();
-    /// !show
-    const b = new ass.ClassB();
-  `);
-    expect(translator.syntaxKindCounter()).toEqual({
-        75: 3,
-        194: 1,
-        197: 1,
-        225: 1,
-        242: 1,
-        243: 1, // VariableDeclarationList
-    });
-});
-//# sourceMappingURL=syntax-counter.test.js.map