feat: outputJsii

allows emitting the .jsii file during compilation (for testing purposes mostly).

Author: Elad Ben-Israel

lib/compile.ts

@@ -20,19 +20,29 @@ export async function compile(workdir: string, options: Options) {
   const basepath = path.join(path.dirname(entrypoint), path.basename(entrypoint, '.ts'));
 
   // jsii modules to include
-  const modules = options.modules ?? [];
+  const moduleDirs = options.moduleDirs ?? [];
 
   const targets: Record<string, any> = { };
 
   const deps: Record<string, string> = { };
-  for (const mod of modules) {
-    if (mod.startsWith('@types/')) {
-      continue;
-    }
 
-    deps[mod] = '*';
+  for (const dir of moduleDirs) {
+    // read module metadata
+    const metadata = await fs.readJson(path.join(dir, 'package.json'));
+    const moduleName: string = metadata.name;
+    const moduleVersion: string = metadata.version;
+
+    const targetdir = path.join(path.join(workdir, 'node_modules'), moduleName);
+    await fs.mkdirp(path.dirname(targetdir));
+    await fs.ensureSymlink(dir, targetdir);
+
+    // add to "deps" and "peer deps"
+    if (!moduleName.startsWith('@types/')) {
+      deps[moduleName] = moduleVersion;
+    }
   }
 
+
   const pkg = {
     name: 'generated',
     version: '0.0.0',
@@ -56,11 +66,6 @@ export async function compile(workdir: string, options: Options) {
     };
   }
 
-  for (const mod of modules) {
-    const sourcedir = path.dirname(require.resolve(`${mod}/package.json`));
-    await fs.mkdirp(path.join(workdir, path.join('node_modules', path.dirname(mod))));
-    await fs.ensureSymlink(sourcedir, path.join(workdir, 'node_modules', mod));
-  }
 
   await fs.writeFile(path.join(workdir, 'package.json'), JSON.stringify(pkg, undefined, 2));
 

lib/options.ts

@@ -1,18 +1,29 @@
-export interface Options {
+export interface CommonOptions {
   /**
    * The relative path of the .ts entrypoint within the source directory.
    * @default "index.ts"
    */
   entrypoint?: string;
 
   /**
-   * The name of the the python module to generate. If omitted python will not be generated.
+   * List of directories that include node modules to symlink into the compiled
+   * package. For example, if your generated code references some library, you
+   * should include it's module directory in here.
    */
-  pythonName?: string;
+  moduleDirs?: string[];
 
   /**
-   * List of module names to compile against. These modules must be resolvable
-   * against the current executable and their version will be the same version.
+   * Path to output the .jsii file output.
+   * @default - jsii file is not emitted.
    */
-  modules?: string[];
+  outputJsii?: string;
 }
+
+export interface PythonOptions extends CommonOptions {
+  /**
+   * The name of the the python module to generate. If omitted python will not be generated.
+   */
+  pythonName?: string;
+}
+
+export type Options = PythonOptions; /* | JavaOptions | DotNetOptions */

lib/srcmak.ts

@@ -6,10 +6,12 @@ import { Options } from './options';
 
 const pacmakModule = require.resolve('jsii-pacmak/bin/jsii-pacmak');
 
-export async function srcmak(srcdir: string, targetdir: string, options: Options) {
+export async function srcmak(srcdir: string, targetdir: string, options: Options = { }) {
   srcdir = path.resolve(srcdir);
   targetdir = path.resolve(targetdir);
 
+  const outputJsii = options.outputJsii ? path.resolve(options.outputJsii) : undefined;
+
   await withTempDir('jsii-codemak', async () => {
     // copy sources to temp directory
     await fs.copy(srcdir, '.');
@@ -20,6 +22,10 @@ export async function srcmak(srcdir: string, targetdir: string, options: Options
     // run pacmak to generate code
     await exec(pacmakModule, [ '--code-only' ]);
 
+    if (outputJsii) {
+      await fs.copy('.jsii', outputJsii);
+    }
+
     // extract code based on selected languages
     if (options.pythonName) {
       const reldir = options.pythonName.replace(/\./g, '/'); // replace "." with "/"

…t/__snapshots__/jsii-srcmak.test.js.snap test/__snapshots__/srcmak.test.js.snaptest/__snapshots__/jsii-srcmak.test.js.snap renamed to test/__snapshots__/srcmak.test.js.snap test/__snapshots__/jsii-srcmak.test.js.snap renamed to test/__snapshots__/srcmak.test.js.snap

@@ -1,5 +1,61 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`outputJsii can be used to look at the jsii file 1`] = `
+Object {
+  "author": Object {
+    "name": "generated@generated.com",
+    "roles": Array [
+      "author",
+    ],
+  },
+  "description": "generated",
+  "fingerprint": "mDN1As+e+zwuytAHqC8o+7gwTrnrzC2d65pSGEUAe1I=",
+  "homepage": "http://generated",
+  "jsiiVersion": "1.5.0 (build 46538f8)",
+  "license": "Apache-2.0",
+  "name": "generated",
+  "repository": Object {
+    "type": "git",
+    "url": "http://generated",
+  },
+  "schema": "jsii/0.10.0",
+  "targets": Object {
+    "js": Object {
+      "npm": "generated",
+    },
+  },
+  "types": Object {
+    "generated.Foo": Object {
+      "assembly": "generated",
+      "fqn": "generated.Foo",
+      "initializer": Object {},
+      "kind": "class",
+      "locationInModule": Object {
+        "filename": "index.ts",
+        "line": 2,
+      },
+      "methods": Array [
+        Object {
+          "locationInModule": Object {
+            "filename": "index.ts",
+            "line": 3,
+          },
+          "name": "hello",
+          "returns": Object {
+            "type": Object {
+              "primitive": "string",
+            },
+          },
+          "static": true,
+        },
+      ],
+      "name": "Foo",
+    },
+  },
+  "version": "0.0.0",
+}
+`;
+
 exports[`python + different entrypoint + submodule 1`] = `
 Object {
   "my_python_module/submodule/__init__.py": "import abc
@@ -12,7 +68,7 @@ import jsii
 import jsii.compat
 import publication
 
-__jsii_assembly__ = jsii.JSIIAssembly.load(\\"generated\\", \\"0.0.0\\", __name__, \\"generated@0.0.0.jsii.tgz\\")
+from ._jsii import *
 
 
 class Hello(metaclass=jsii.JSIIMeta, jsii_type=\\"generated.Hello\\"):
@@ -32,7 +88,7 @@ class Hello(metaclass=jsii.JSIIMeta, jsii_type=\\"generated.Hello\\"):
 
 @jsii.data_type(jsii_type=\\"generated.Operands\\", jsii_struct_bases=[], name_mapping={'lhs': 'lhs', 'rhs': 'rhs'})
 class Operands():
-    def __init__(self, *, lhs: jsii.Number, rhs: jsii.Number):
+    def __init__(self, *, lhs: jsii.Number, rhs: jsii.Number) -> None:
         \\"\\"\\"
         :param lhs: -
         :param rhs: -
@@ -60,7 +116,10 @@ class Operands():
         return 'Operands(%s)' % ', '.join(k + '=' + repr(v) for k, v in self._values.items())
 
 
-__all__ = [\\"Hello\\", \\"Operands\\", \\"__jsii_assembly__\\"]
+__all__ = [
+    \\"Hello\\",
+    \\"Operands\\",
+]
 
 publication.publish()
 ",
@@ -73,7 +132,12 @@ import typing
 import jsii
 import jsii.compat
 import publication
-__all__ = []
+
+__jsii_assembly__ = jsii.JSIIAssembly.load(\\"generated\\", \\"0.0.0\\", __name__[0:-6], \\"generated@0.0.0.jsii.tgz\\")
+
+__all__ = [
+    \\"__jsii_assembly__\\",
+]
 
 publication.publish()
 ",

test/jsii-srcmak.test.ts test/srcmak.test.tstest/jsii-srcmak.test.ts renamed to test/srcmak.test.ts

@@ -22,7 +22,7 @@ test('just compile', async () => {
     `);
 
     await withTempDir('target', async target => {
-      await srcmak(source, target, { modules: [] });
+      await srcmak(source, target);
     });
   });
 });
@@ -33,7 +33,7 @@ test('compilation error fails and includes error message', async () => {
 
     await withTempDir('target', async target => {
       let error;
-      try { await srcmak(source, target, { modules: [] }); }
+      try { await srcmak(source, target); }
       catch (e) { error = e; }
 
       expect(error).toBeDefined();
@@ -65,7 +65,6 @@ test('python + different entrypoint + submodule', async () => {
       await srcmak(source, target, {
         entrypoint: 'different/entry.ts',
         pythonName: 'my_python_module.submodule',
-        modules: [],
       });
 
       const dir = await snapshotDirectory(target, [ 'generated@0.0.0.jsii.tgz' ]);
@@ -88,10 +87,28 @@ test('compile against a local jsii dependency', async () => {
 
     await withTempDir('target', async target => {
       await srcmak(source, target, {
-        modules: [
-          'constructs', // <<---- this is the magic
+        moduleDirs: [
+          path.dirname(require.resolve('constructs/package.json')), // <<---- this is the magic
         ],
       });
     });
   });
 });
+
+test('outputJsii can be used to look at the jsii file', async () => {
+  await withTempDir('source', async source => {
+    await fs.writeFile('index.ts', `
+    export class Foo {
+      public static hello() { return "world"; }
+    }
+    `);
+
+    await withTempDir('target', async target => {
+      await srcmak(source, target, {
+        outputJsii: '.jsii',
+      });
+
+      expect(await fs.readJson('.jsii')).toMatchSnapshot();
+    });
+  })
+});