jsii-rosetta 1.76.0 → 4.9.0-dev.1

package/test/commands/trim-cache.test.d.ts

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

package/test/commands/trim-cache.test.js

@@ -1,85 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const path = require("path");
-const lib_1 = require("../../lib");
-const extract_1 = require("../../lib/commands/extract");
-const trim_cache_1 = require("../../lib/commands/trim-cache");
-const testutil_1 = require("../testutil");
-const DUMMY_README = `
-  Here is an example of how to use ClassA:
-
-  \`\`\`ts
-  import * as ass from 'my_assembly';
-  const aClass = new ass.ClassA();
-  aClass.someMethod();
-  \`\`\`
-`;
-let assembly;
-beforeEach(() => {
-    // Create an assembly in a temp directory
-    assembly = testutil_1.TestJsiiModule.fromSource({
-        'index.ts': `
-      export class ClassA {
-        public someMethod() {
-        }
-      }
-      export class ClassB {
-        public anotherMethod() {
-        }
-      }
-      `,
-        'README.md': DUMMY_README,
-    }, {
-        name: 'my_assembly',
-        jsii: testutil_1.DUMMY_JSII_CONFIG,
-    });
-});
-afterEach(() => assembly.cleanup());
-test('trim-cache removes unused snippets', async () => {
-    const cacheFile = path.join(assembly.moduleDirectory, 'dummy.tabl.json');
-    // GIVEN
-    const tbl = new lib_1.LanguageTablet();
-    tbl.addSnippet(bogusTranslatedSnippet());
-    await tbl.save(cacheFile);
-    // WHEN
-    await (0, trim_cache_1.trimCache)({
-        assemblyLocations: [assembly.moduleDirectory],
-        cacheFile,
-    });
-    // THEN
-    const updated = await lib_1.LanguageTablet.fromFile(cacheFile);
-    expect(updated.count).toEqual(0);
-});
-test('trim-cache leaves used snippets', async () => {
-    const defaultTablet = path.join(assembly.moduleDirectory, lib_1.DEFAULT_TABLET_NAME);
-    // GIVEN
-    await (0, extract_1.extractSnippets)([assembly.moduleDirectory]);
-    // WHEN
-    await (0, trim_cache_1.trimCache)({
-        assemblyLocations: [assembly.moduleDirectory],
-        cacheFile: defaultTablet,
-    });
-    // THEN
-    const updated = await lib_1.LanguageTablet.fromFile(defaultTablet);
-    expect(updated.count).toEqual(1);
-});
-test('trim-cache preserves tablet compression', async () => {
-    const compDefaultTablet = path.join(assembly.moduleDirectory, lib_1.DEFAULT_TABLET_NAME_COMPRESSED);
-    // GIVEN
-    const tbl = new lib_1.LanguageTablet();
-    tbl.addSnippets(bogusTranslatedSnippet());
-    // explicitly compress the tablet file
-    await tbl.save(compDefaultTablet, true);
-    // WHEN
-    await (0, trim_cache_1.trimCache)({
-        assemblyLocations: [assembly.moduleDirectory],
-        cacheFile: compDefaultTablet,
-    });
-    // THEN
-    const updated = await lib_1.LanguageTablet.fromFile(compDefaultTablet);
-    expect(updated.compressedSource).toBeTruthy();
-});
-function bogusTranslatedSnippet() {
-    return lib_1.TranslatedSnippet.fromTypeScript((0, lib_1.typeScriptSnippetFromVisibleSource)('console.log("hello");', (0, testutil_1.testSnippetLocation)('x.ts'), true), true);
-}
-//# sourceMappingURL=trim-cache.test.js.map

package/test/fixtures.test.d.ts

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

package/test/fixtures.test.js

@@ -1,49 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const fixtures_1 = require("../lib/fixtures");
-const snippet_1 = require("../lib/snippet");
-const testutil_1 = require("./testutil");
-const location = (0, testutil_1.testSnippetLocation)('where');
-describe('fixturize', () => {
-    test('snippet retains properties', () => {
-        const snippet = {
-            visibleSource: 'visibleSource',
-            location,
-            parameters: {
-                [snippet_1.SnippetParameters.$PROJECT_DIRECTORY]: 'directory',
-                [snippet_1.SnippetParameters.NO_FIXTURE]: '',
-                key: 'value',
-            },
-            strict: true,
-        };
-        expect((0, fixtures_1.fixturize)(snippet)).toEqual(expect.objectContaining(snippet));
-    });
-    test('separates imports and declarations', () => {
-        const source = `import * as ns from 'mod';
-declare const mock: Tpe;
-const val = new Cls();`;
-        const snippet = {
-            visibleSource: source,
-            location,
-            parameters: {
-                [snippet_1.SnippetParameters.$PROJECT_DIRECTORY]: 'test',
-            },
-            strict: true,
-        };
-        const fixturizedSnippet = (0, fixtures_1.fixturize)(snippet);
-        expect(fixturizedSnippet.completeSource).toBe(`// Hoisted imports begin after !show marker below
-/// !show
-import * as ns from 'mod';
-declare const mock: Tpe;
-/// !hide
-// Hoisted imports ended before !hide marker above
-// Code snippet begins after !show marker below
-/// !show
-
-const val = new Cls();
-/// !hide
-// Code snippet ended before !hide marker above
-`);
-    });
-});
-//# sourceMappingURL=fixtures.test.js.map

package/test/jsii/assemblies.test.d.ts

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

package/test/jsii/assemblies.test.js

@@ -1,230 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const spec = require("@jsii/spec");
-const fs_1 = require("fs");
-const mockfs = require("mock-fs");
-const path = require("path");
-const assemblies_1 = require("../../lib/jsii/assemblies");
-const snippet_1 = require("../../lib/snippet");
-const testutil_1 = require("../testutil");
-const fake_assembly_1 = require("./fake-assembly");
-test('Extract snippet from README', async () => {
-    const snippets = Array.from(await (0, assemblies_1.allTypeScriptSnippets)([
-        {
-            assembly: (0, fake_assembly_1.fakeAssembly)({
-                readme: {
-                    markdown: ['Before the example.', '```ts', 'someExample();', '```', 'After the example.'].join('\n'),
-                },
-            }),
-            directory: path.join(__dirname, 'fixtures'),
-        },
-    ]));
-    expect(snippets[0].visibleSource).toEqual('someExample();');
-});
-test('Extract snippet from submodule READMEs', async () => {
-    const snippets = Array.from(await (0, assemblies_1.allTypeScriptSnippets)([
-        {
-            assembly: (0, fake_assembly_1.fakeAssembly)({
-                submodules: {
-                    'my.submodule': {
-                        readme: {
-                            markdown: ['Before the example.', '```ts', 'someExample();', '```', 'After the example.'].join('\n'),
-                        },
-                    },
-                },
-            }),
-            directory: path.join(__dirname, 'fixtures'),
-        },
-    ]));
-    expect(snippets[0].visibleSource).toEqual('someExample();');
-});
-test('Extract snippet from type docstring', async () => {
-    const snippets = Array.from(await (0, assemblies_1.allTypeScriptSnippets)([
-        {
-            assembly: (0, fake_assembly_1.fakeAssembly)({
-                types: {
-                    'asm.MyType': {
-                        kind: spec.TypeKind.Class,
-                        assembly: 'asm',
-                        fqn: 'asm.MyType',
-                        name: 'MyType',
-                        docs: {
-                            summary: 'My Type',
-                            remarks: ['Before the example.', '```ts', 'someExample();', '```', 'After the example.'].join('\n'),
-                        },
-                    },
-                },
-            }),
-            directory: path.join(__dirname, 'fixtures'),
-        },
-    ]));
-    expect(snippets[0].visibleSource).toEqual('someExample();');
-});
-test('Snippet can include fixture', async () => {
-    const snippets = Array.from(await (0, assemblies_1.allTypeScriptSnippets)([
-        {
-            assembly: (0, fake_assembly_1.fakeAssembly)({
-                readme: {
-                    markdown: [
-                        'Before the example.',
-                        '```ts fixture=explicit',
-                        'someExample();',
-                        '```',
-                        'After the example.',
-                    ].join('\n'),
-                },
-            }),
-            directory: path.join(__dirname, 'fixtures'),
-        },
-    ]));
-    expect(snippets[0].visibleSource).toEqual('someExample();');
-    expect(snippets[0].completeSource).toMatchInlineSnapshot(`
-    "// This is a fixture
-
-    // This is a wrapper so that \`import\` statements are invalid if included in
-    // the code example that'll be inlined at the \`here\` marker.
-    (function () {
-      // Code snippet begins after !show marker below
-    /// !show
-    someExample();
-    /// !hide
-    // Code snippet ended before !hide marker above
-    })()
-    "
-  `);
-});
-test('Use fixture from example', async () => {
-    const snippets = Array.from(await (0, assemblies_1.allTypeScriptSnippets)([
-        {
-            assembly: (0, fake_assembly_1.fakeAssembly)({
-                types: {
-                    'asm.MyType': {
-                        kind: spec.TypeKind.Class,
-                        assembly: 'asm',
-                        fqn: 'asm.MyType',
-                        name: 'MyType',
-                        docs: {
-                            example: ['/// fixture=explicit', 'someExample();'].join('\n'),
-                        },
-                    },
-                },
-            }),
-            directory: path.join(__dirname, 'fixtures'),
-        },
-    ]));
-    expect(snippets[0].completeSource).toMatchInlineSnapshot(`
-    "// This is a fixture
-
-    // This is a wrapper so that \`import\` statements are invalid if included in
-    // the code example that'll be inlined at the \`here\` marker.
-    (function () {
-      // Code snippet begins after !show marker below
-    /// !show
-    someExample();
-    /// !hide
-    // Code snippet ended before !hide marker above
-    })()
-    "
-  `);
-    expect(snippets[0].visibleSource).toEqual('someExample();');
-});
-test('Fixture allows use of import statements', async () => {
-    const snippets = Array.from(await (0, assemblies_1.allTypeScriptSnippets)([
-        {
-            assembly: (0, fake_assembly_1.fakeAssembly)({
-                types: {
-                    'asm.MyType': {
-                        kind: spec.TypeKind.Class,
-                        assembly: 'asm',
-                        fqn: 'asm.MyType',
-                        name: 'MyType',
-                        docs: {
-                            example: ['/// fixture=explicit', 'import { exit } from "process";', 'someExample();', 'exit(0);'].join('\n'),
-                        },
-                    },
-                },
-            }),
-            directory: path.join(__dirname, 'fixtures'),
-        },
-    ]));
-    expect(snippets[0].completeSource).toMatchInlineSnapshot(`
-    "// Hoisted imports begin after !show marker below
-    /// !show
-    import { exit } from "process";
-    /// !hide
-    // Hoisted imports ended before !hide marker above
-    // This is a fixture
-
-    // This is a wrapper so that \`import\` statements are invalid if included in
-    // the code example that'll be inlined at the \`here\` marker.
-    (function () {
-      // Code snippet begins after !show marker below
-    /// !show
-
-    someExample();
-    exit(0);
-    /// !hide
-    // Code snippet ended before !hide marker above
-    })()
-    "
-  `);
-    expect(snippets[0].visibleSource).toEqual(['import { exit } from "process";', 'someExample();', 'exit(0);'].join('\n'));
-});
-test('Backwards compatibility with literate integ tests', async () => {
-    mockfs({
-        '/package/test/integ.example.lit.ts': '# Some literate source file',
-    });
-    try {
-        const snippets = Array.from(await (0, assemblies_1.allTypeScriptSnippets)([
-            {
-                assembly: (0, fake_assembly_1.fakeAssembly)({
-                    readme: {
-                        markdown: [
-                            'Before the example.',
-                            '```ts lit=test/integ.example.lit.ts',
-                            'someExample();',
-                            '```',
-                            'After the example.',
-                        ].join('\n'),
-                    },
-                }),
-                directory: '/package',
-            },
-        ]));
-        expect(snippets[0].visibleSource).toEqual('someExample();');
-        expect(snippets[0].completeSource).toEqual('# Some literate source file');
-        expect(snippets[0]?.parameters?.[snippet_1.SnippetParameters.$COMPILATION_DIRECTORY]).toEqual(path.normalize('/package/test'));
-    }
-    finally {
-        mockfs.restore();
-    }
-});
-test('rosetta fixture from submodule is preferred if it exists', async () => {
-    const jsiiModule = testutil_1.TestJsiiModule.fromSource({
-        'index.ts': 'export * as submodule from "./submodule"',
-        'submodule.ts': `
-        /**
-         * @example new ClassA();
-         */
-        export class ClassA {
-          public someMethod() {
-          }
-        }`,
-    }, {
-        name: 'my_assembly',
-        jsii: testutil_1.DUMMY_JSII_CONFIG,
-    });
-    try {
-        await fs_1.promises.mkdir(path.join(jsiiModule.moduleDirectory, 'rosetta', 'submodule'), { recursive: true });
-        await fs_1.promises.writeFile(path.join(jsiiModule.moduleDirectory, 'rosetta', 'submodule', 'default.ts-fixture'), 'pick me\n/// here');
-        await fs_1.promises.writeFile(path.join(jsiiModule.moduleDirectory, 'rosetta', 'default.ts-fixture'), 'dont pick me\n/// here');
-        const snippets = await (0, assemblies_1.allTypeScriptSnippets)([
-            { assembly: jsiiModule.assembly, directory: jsiiModule.moduleDirectory },
-        ]);
-        expect(snippets[0].completeSource).toMatch(/^pick me/);
-    }
-    finally {
-        jsiiModule.cleanup();
-    }
-});
-//# sourceMappingURL=assemblies.test.js.map

package/test/jsii/fake-assembly.d.ts

@@ -1,3 +0,0 @@
-import { Assembly } from '@jsii/spec';
-export declare function fakeAssembly(parts: Partial<Assembly>): Assembly;
-//# sourceMappingURL=fake-assembly.d.ts.map

package/test/jsii/fake-assembly.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fakeAssembly = void 0;
-const spec_1 = require("@jsii/spec");
-function fakeAssembly(parts) {
-    return {
-        schema: spec_1.SchemaVersion.LATEST,
-        name: 'test-assembly',
-        description: 'A fake assembly used for tests',
-        homepage: '',
-        repository: { directory: '', type: '', url: '' },
-        author: { email: '', name: '', organization: false, roles: [], url: '' },
-        fingerprint: '<NONE>',
-        version: '0.0.0-use.local',
-        jsiiVersion: '0.0.0-use.local',
-        license: 'UNLICENSED',
-        ...parts,
-    };
-}
-exports.fakeAssembly = fakeAssembly;
-//# sourceMappingURL=fake-assembly.js.map

package/test/jsii/fixtures/rosetta/explicit.ts-fixture

@@ -1,7 +0,0 @@
-// This is a fixture
-
-// This is a wrapper so that `import` statements are invalid if included in
-// the code example that'll be inlined at the `here` marker.
-(function () {
-  /// here
-})()

package/test/jsii/visible-spans.test.d.ts

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

package/test/jsii/visible-spans.test.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const visible_spans_1 = require("../../lib/typescript/visible-spans");
-test('full text visible by default', () => {
-    const vis = visible_spans_1.Spans.visibleSpansFromSource('asdf');
-    expect(vis.spans).toEqual([{ start: 0, end: 4, visible: true }]);
-});
-test('initial span visible if directive is hiding', () => {
-    const vis = visible_spans_1.Spans.visibleSpansFromSource('asdf\n/// !hide\nxyz');
-    expect(vis.spans).toEqual([{ start: 0, end: 5, visible: true }]);
-});
-test('initial span invisible if directive is showing', () => {
-    const s = 'asdf\n/// !show\nxyz';
-    const vis = visible_spans_1.Spans.visibleSpansFromSource('asdf\n/// !show\nxyz');
-    expect(s.substring(vis.spans[0].start, vis.spans[0].end)).toEqual('xyz');
-    expect(vis.spans).toEqual([{ start: 15, end: 18, visible: true }]);
-});
-test('merge adjacent spans', () => {
-    const spans = new visible_spans_1.Spans([
-        { start: 10, end: 18 },
-        { start: 18, end: 20 },
-    ]);
-    expect(spans.spans).toEqual([{ start: 10, end: 20 }]);
-});
-test('trim source to spans', () => {
-    const source = ['a', '/// !show', 'b', 'c', '/// !hide', 'd'].join('\n');
-    const trimmed = (0, visible_spans_1.trimCompleteSourceToVisible)(source);
-    expect(trimmed).toEqual('b\nc');
-});
-test('trim source to spans with leading whitespace ', () => {
-    const source = ['a', '   /// !show', 'b', 'c', ' /// !hide', 'd'].join('\n');
-    const trimmed = (0, visible_spans_1.trimCompleteSourceToVisible)(source);
-    expect(trimmed).toEqual('b\nc');
-});
-test('trim source to spans with trailing whitespace ', () => {
-    const source = ['a', '/// !show   ', 'b', 'c', ' /// !hide ', 'd'].join('\n');
-    const trimmed = (0, visible_spans_1.trimCompleteSourceToVisible)(source);
-    expect(trimmed).toEqual('b\nc');
-});
-//# sourceMappingURL=visible-spans.test.js.map

package/test/jsii-imports.test.d.ts

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