@movable/rollup-plugin-manifest-merger 3.0.0-canary.0 → 3.0.0

package/build/src/plugins/manifest-merger.js

@@ -80,10 +80,17 @@ function manifestMerger(opts) {
             }
             // Add the package manifests to the array
             const manifests = [];
+            const integrationIds = [...(appManifest.integration_ids || [])];
             for (const [, val] of packageCache.entries()) {
+                if (Array.isArray(val.integration_ids)) {
+                    integrationIds.push(...val.integration_ids);
+                }
                 manifests.push(val);
             }
             appManifest.package_manifests = manifests;
+            if (integrationIds.length) {
+                appManifest.integration_ids = [...new Set(integrationIds)];
+            }
             if (fileName) {
                 const inline = 12; // The level where you switch to inline YAML
                 const indent = 2; // The amount of spaces to use for indentation of nested nodes.

package/build/test/plugins/manifest-merger-test.js

@@ -11,99 +11,86 @@ const yamljs_1 = __importDefault(require("yamljs"));
 const index_1 = require("../../src/index");
 const setup_fixture_1 = __importDefault(require("../helpers/setup-fixture"));
 const studioFrameworkPkg = require('@movable/studio-framework/package.json');
-mocha_1.describe('manifestMerger - app test', () => {
-    setup_fixture_1.default('test-app');
-    mocha_1.it('can build the manifest via dependencies', async () => {
-        const bundle = await rollup_1.rollup({
-            input: 'index.js',
-            plugins: [index_1.manifestMerger({ output: 'manifest.yml' }), plugin_node_resolve_1.default()]
-        });
-        const { output } = await bundle.generate({
-            format: 'es'
-        });
-        const ymlFile = output.find(({ fileName }) => fileName === 'manifest.yml');
-        // @ts-ignore
-        const manifest = yamljs_1.default.parse(ymlFile.source);
-        chai_1.expect(manifest).to.deep.equal({
-            name: 'App Manifest',
-            options: [{ name: 'Option 2' }, { framework_version: '1.10.0' }],
-            string_array: ['one', 'two', 'three'],
-            package_manifests: [
-                {
-                    name: '@movable-internal/test-dep',
-                    authors: ['Test Developer']
-                }
-            ],
-            studio_options: {
-                framework_version: studioFrameworkPkg.version,
-                package_dependencies: [
-                    { name: '@movable/studio-framework', version: studioFrameworkPkg.version }
-                ]
-            }
-        });
+const expectedAppManifest = {
+    name: 'App Manifest',
+    options: [{ name: 'Option 2' }, { framework_version: '1.10.0' }],
+    string_array: ['one', 'two', 'three'],
+    package_manifests: [
+        {
+            name: '@movable-internal/test-dep',
+            authors: ['Test Developer']
+        }
+    ],
+    studio_options: {
+        framework_version: studioFrameworkPkg.version,
+        package_dependencies: [
+            { name: '@movable/studio-framework', version: studioFrameworkPkg.version }
+        ]
+    }
+};
+const bundledManifest = async ({ outputJSON = true, ignoreFrameworkVersionUpdate = false } = {}) => {
+    const outputFile = outputJSON ? 'manifest.json' : 'manifest.yml';
+    const bundle = await rollup_1.rollup({
+        input: 'index.js',
+        plugins: [
+            index_1.manifestMerger({
+                outputJSON,
+                output: outputFile,
+                ignoreFrameworkVersionUpdate
+            }),
+            plugin_node_resolve_1.default()
+        ]
+    });
+    const { output } = await bundle.generate({
+        format: 'es'
+    });
+    const file = output.find(({ fileName }) => fileName === outputFile);
+    // @ts-ignore
+    return outputJSON ? JSON.parse(file.source) : yamljs_1.default.parse(file.source);
+};
+mocha_1.describe('manifestMerger - app test', async () => {
+    setup_fixture_1.default('test-app-no-integration-ids');
+    mocha_1.it('can build the manifest via dependencies with yml output', async () => {
+        const manifest = await bundledManifest({ outputJSON: false });
+        chai_1.expect(manifest).to.deep.equal(expectedAppManifest);
     });
     mocha_1.it('can optionally ignore the actual Studio Framework version', async () => {
-        const bundle = await rollup_1.rollup({
-            input: 'index.js',
-            plugins: [
-                index_1.manifestMerger({ output: 'manifest.yml', ignoreFrameworkVersionUpdate: true }),
-                plugin_node_resolve_1.default()
-            ]
-        });
-        const { output } = await bundle.generate({
-            format: 'es'
+        const manifest = await bundledManifest({
+            outputJSON: false,
+            ignoreFrameworkVersionUpdate: true
         });
-        const ymlFile = output.find(({ fileName }) => fileName === 'manifest.yml');
-        // @ts-ignore
-        const manifest = yamljs_1.default.parse(ymlFile.source);
         chai_1.expect(manifest).to.deep.equal({
-            name: 'App Manifest',
-            options: [{ name: 'Option 2' }, { framework_version: '1.10.0' }],
-            string_array: ['one', 'two', 'three'],
-            package_manifests: [
-                {
-                    name: '@movable-internal/test-dep',
-                    authors: ['Test Developer']
-                }
-            ],
-            studio_options: {
-                framework_version: '2.15'
-            }
+            ...expectedAppManifest,
+            studio_options: { framework_version: '2.15' }
+        });
+        mocha_1.it('can build the manifest via dependencies with json output', async () => {
+            const manifest = await bundledManifest();
+            chai_1.expect(manifest).to.deep.equal(expectedAppManifest);
         });
     });
     mocha_1.it('can build the manifest via dependencies', async () => {
-        const bundle = await rollup_1.rollup({
-            input: 'index.js',
-            plugins: [
-                index_1.manifestMerger({
-                    outputJSON: true,
-                    output: 'manifest.json'
-                }),
-                plugin_node_resolve_1.default()
-            ]
+        const manifest = await bundledManifest();
+        chai_1.expect(manifest).to.deep.equal(expectedAppManifest);
+    });
+});
+mocha_1.describe('manifest merger - integration ids', () => {
+    mocha_1.describe('app with existing ids / dependencies with ids', () => {
+        setup_fixture_1.default('test-app-with-app-and-package-integration-ids');
+        mocha_1.it('it can build multiple integration ids from multiple packages', async () => {
+            const manifest = await bundledManifest();
+            chai_1.expect(manifest.integration_ids).to.have.members(['app-123', '123', 'abc', 'foo', 'bar']);
         });
-        const { output } = await bundle.generate({
-            format: 'es'
+        mocha_1.it('it does not duplicate appManifest.integration_ids upon regeneration', async () => {
+            await bundledManifest();
+            const manifest = await bundledManifest();
+            chai_1.expect(manifest.integration_ids).to.have.members(['app-123', '123', 'abc', 'foo', 'bar']);
         });
-        const ymlFile = output.find(({ fileName }) => fileName === 'manifest.json');
-        // @ts-ignore
-        const manifest = JSON.parse(ymlFile.source);
-        chai_1.expect(manifest).to.deep.equal({
-            name: 'App Manifest',
-            options: [{ name: 'Option 2' }, { framework_version: '1.10.0' }],
-            string_array: ['one', 'two', 'three'],
-            package_manifests: [
-                {
-                    name: '@movable-internal/test-dep',
-                    authors: ['Test Developer']
-                }
-            ],
-            studio_options: {
-                framework_version: studioFrameworkPkg.version,
-                package_dependencies: [
-                    { name: '@movable/studio-framework', version: studioFrameworkPkg.version }
-                ]
-            }
+    });
+    mocha_1.describe('app with existing ids / dependencies with no ids', () => {
+        setup_fixture_1.default('test-app-with-app-integration-ids');
+        mocha_1.it('it can build integration ids with no package integration ids', async () => {
+            const manifest = await bundledManifest();
+            chai_1.expect(manifest.integration_ids).to.have.members(['app-123']);
         });
     });
 });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@movable/rollup-plugin-manifest-merger",
-  "version": "3.0.0-canary.0",
-  "description": "Merges package manfests into an App manifest",
+  "version": "3.0.0",
+  "description": "Merges package manifests into an App manifest",
   "main": "build/src/index.js",
   "keywords": [],
   "homepage": "https://github.com/movableink/studio-framework/tree/master/packages/rollup-plugin-manifest-merger#readme",
@@ -17,36 +17,35 @@
     "name": "Movable Ink"
   },
   "scripts": {
-    "test": "NODE_ENV=test TS_NODE_FILES=true mocha --require ts-node/register test/**/*.ts",
+    "test": "NODE_ENV=test TS_NODE_FILES=true mocha --require ./node_modules/ts-node/register test/**/*.ts",
     "build": "tsc && copyfiles src/**/*.html build",
     "prepublish": "yarn run build"
   },
-  "volta": {
-    "node": "12.17.0",
-    "yarn": "1.22.4"
-  },
   "devDependencies": {
-    "@rollup/plugin-node-resolve": "^8.4.0",
-    "@types/chai": "^4.2.11",
-    "@types/find-root": "^1.1.1",
-    "@types/mocha": "^7.0.2",
-    "@types/uuid": "^8.0.0",
+    "@rollup/plugin-node-resolve": "^13.0.0",
+    "@types/chai": "^4.2.18",
+    "@types/find-root": "^1.1.2",
+    "@types/mocha": "^8.2.2",
+    "@types/uuid": "^8.3.0",
     "@types/yamljs": "^0.2.31",
-    "chai": "^4.2.0",
-    "mocha": "^7.2.0",
-    "rollup": "^2.11.2",
-    "ts-node": "^8.10.2",
-    "typescript": "^3.9.6"
+    "chai": "^4.3.4",
+    "mocha": "^8.4.0",
+    "rollup": "^2.52.2",
+    "ts-node": "^10.0.0",
+    "typescript": "^4.3.4"
   },
   "dependencies": {
-    "@rollup/pluginutils": "^3.0.10",
-    "ast-types": "^0.13.3",
-    "copyfiles": "^2.3.0",
-    "pkg-dir": "^4.2.0",
-    "recast": "^0.19.1",
-    "resolve": "^1.17.0",
-    "uuid": "^8.1.0",
+    "@rollup/pluginutils": "^4.1.0",
+    "ast-types": "^0.14.2",
+    "copyfiles": "^2.4.1",
+    "pkg-dir": "^5.0.0",
+    "recast": "^0.20.4",
+    "resolve": "^1.20.0",
+    "uuid": "^8.3.2",
     "yamljs": "^0.3.0"
   },
-  "gitHead": "893c1fc5711df5feb4d32c688670d01eb0c5e3cf"
+  "volta": {
+    "extends": "../../package.json"
+  },
+  "gitHead": "2b832ab5a64597cffdc7f1225bbbdf53c6299994"
 }

package/src/plugins/manifest-merger.ts

@@ -21,6 +21,7 @@ interface ManifestPackageDep {
 interface Manifest {
   name: string;
   package_manifests?: Manifest[];
+  integration_ids?: string[];
   studio_options?: {
     framework_version?: string;
     package_dependencies?: ManifestPackageDep[];
@@ -118,13 +119,21 @@ export default function manifestMerger(opts: Options): Plugin {
 
       // Add the package manifests to the array
       const manifests: Manifest[] = [];
+      const integrationIds = [...(appManifest.integration_ids || [])];
 
       for (const [, val] of packageCache.entries()) {
+        if (Array.isArray(val.integration_ids)) {
+          integrationIds.push(...val.integration_ids);
+        }
         manifests.push(val);
       }
 
       appManifest.package_manifests = manifests;
 
+      if (integrationIds.length) {
+        appManifest.integration_ids = [...new Set(integrationIds)];
+      }
+
       if (fileName) {
         const inline = 12; // The level where you switch to inline YAML
         const indent = 2; // The amount of spaces to use for indentation of nested nodes.

package/test/fixtures/test-app-with-app-and-package-integration-ids/app-manifest.yml

@@ -0,0 +1,12 @@
+name: App Manifest
+options:
+  - name: Option 2
+  - framework_version: '1.10.0'
+string_array:
+  - one
+  - two
+  - three
+studio_options:
+  framework_version: '2.15'
+integration_ids:
+  - app-123

package/test/fixtures/test-app-with-app-and-package-integration-ids/index.js

@@ -0,0 +1,9 @@
+/* eslint-disable import/no-unresolved */
+import something from '@movable-internal/test-dep';
+import something2 from '@movable-internal/test-dep-2';
+import '@movable-internal/test-dep/package-manifest.yml';
+import '@movable-internal/test-dep-2/package-manifest.yml';
+import './app-manifest.yml';
+
+// eslint-disable-next-line no-console
+console.log(something, something2);

package/test/fixtures/test-app-with-app-and-package-integration-ids/node_modules/@movable-internal/test-dep/index.js

@@ -0,0 +1 @@
+export default () => console.log('test-dep');

package/test/fixtures/test-app-with-app-and-package-integration-ids/node_modules/@movable-internal/test-dep/package-manifest.yml

@@ -0,0 +1,7 @@
+name: foo
+authors:
+  - "Test Developer"
+integration_ids:
+  - "123"
+  - "abc"
+  - "123"

package/test/fixtures/test-app-with-app-and-package-integration-ids/node_modules/@movable-internal/test-dep/package.json

@@ -0,0 +1,3 @@
+{
+  "name": "@movable-internal/test-dep"
+}

package/test/fixtures/test-app-with-app-and-package-integration-ids/node_modules/@movable-internal/test-dep-2/index.js

@@ -0,0 +1 @@
+export default () => console.log('test-dep-2');

package/test/fixtures/test-app-with-app-and-package-integration-ids/node_modules/@movable-internal/test-dep-2/package-manifest.yml

@@ -0,0 +1,7 @@
+name: bar
+authors:
+  - "Test Developer 2"
+integration_ids:
+  - "123"
+  - "foo"
+  - "bar"

package/test/fixtures/test-app-with-app-and-package-integration-ids/node_modules/@movable-internal/test-dep-2/package.json

@@ -0,0 +1,3 @@
+{
+  "name": "@movable-internal/test-dep-2"
+}

package/test/fixtures/test-app-with-app-and-package-integration-ids/package.json

@@ -0,0 +1,6 @@
+{
+  "dependencies": {
+    "@movable-internal/test-dep": "*",
+    "@movable-internal/test-dep-2": "*"
+  }
+}

package/test/fixtures/test-app-with-app-integration-ids/app-manifest.yml

@@ -0,0 +1,12 @@
+name: App Manifest
+options:
+  - name: Option 2
+  - framework_version: '1.10.0'
+string_array:
+  - one
+  - two
+  - three
+studio_options:
+  framework_version: '2.15'
+integration_ids:
+  - app-123

package/test/fixtures/test-app-with-app-integration-ids/index.js

@@ -0,0 +1,7 @@
+/* eslint-disable import/no-unresolved */
+import something from '@movable-internal/test-dep';
+import '@movable-internal/test-dep/package-manifest.yml';
+import './app-manifest.yml';
+
+// eslint-disable-next-line no-console
+console.log(something);

package/test/fixtures/test-app-with-app-integration-ids/node_modules/@movable-internal/test-dep/index.js

@@ -0,0 +1 @@
+export default () => console.log('test-dep');

package/test/fixtures/test-app-with-app-integration-ids/node_modules/@movable-internal/test-dep/package-manifest.yml

@@ -0,0 +1,3 @@
+name: foo
+authors:
+  - "Test Developer"

package/test/fixtures/test-app-with-app-integration-ids/node_modules/@movable-internal/test-dep/package.json

@@ -0,0 +1,3 @@
+{
+  "name": "@movable-internal/test-dep"
+}

package/test/fixtures/test-app-with-app-integration-ids/package.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "@movable-internal/test-dep": "*"
+  }
+}

package/test/helpers/expect-ast-equals.ts

@@ -1,8 +1,8 @@
 import { expect } from 'chai';
 import { prettyPrint, parse } from 'recast';
-import { Program } from 'ast-types/gen/nodes';
+import * as types from 'ast-types';
 
-function printAst(ast: Program): string {
+function printAst(ast: types.ASTNode): string {
   return prettyPrint(ast, { tabWidth: 2 }).code;
 }
 

package/test/plugins/manifest-merger-test.ts

@@ -8,115 +8,101 @@ import setupFixture from '../helpers/setup-fixture';
 import { PackageJSON } from '../../src/types/packages';
 
 const studioFrameworkPkg: PackageJSON = require('@movable/studio-framework/package.json');
+const expectedAppManifest = {
+  name: 'App Manifest',
+  options: [{ name: 'Option 2' }, { framework_version: '1.10.0' }],
+  string_array: ['one', 'two', 'three'],
+  package_manifests: [
+    {
+      name: '@movable-internal/test-dep',
+      authors: ['Test Developer']
+    }
+  ],
+  studio_options: {
+    framework_version: studioFrameworkPkg.version,
+    package_dependencies: [
+      { name: '@movable/studio-framework', version: studioFrameworkPkg.version }
+    ]
+  }
+};
+
+const bundledManifest = async ({
+  outputJSON = true,
+  ignoreFrameworkVersionUpdate = false
+} = {}) => {
+  const outputFile = outputJSON ? 'manifest.json' : 'manifest.yml';
+  const bundle = await rollup({
+    input: 'index.js',
+    plugins: [
+      manifestMerger({
+        outputJSON,
+        output: outputFile,
+        ignoreFrameworkVersionUpdate
+      }),
+      nodeResolve()
+    ]
+  });
 
-describe('manifestMerger - app test', () => {
-  setupFixture('test-app');
-
-  it('can build the manifest via dependencies', async () => {
-    const bundle = await rollup({
-      input: 'index.js',
-      plugins: [manifestMerger({ output: 'manifest.yml' }), nodeResolve()]
-    });
+  const { output } = await bundle.generate({
+    format: 'es'
+  });
 
-    const { output } = await bundle.generate({
-      format: 'es'
-    });
+  const file = output.find(({ fileName }) => fileName === outputFile);
 
-    const ymlFile = output.find(({ fileName }) => fileName === 'manifest.yml');
+  // @ts-ignore
+  return outputJSON ? JSON.parse(file.source) : YAML.parse(file.source);
+};
 
-    // @ts-ignore
-    const manifest = YAML.parse(ymlFile.source);
+describe('manifestMerger - app test', async () => {
+  setupFixture('test-app-no-integration-ids');
+  it('can build the manifest via dependencies with yml output', async () => {
+    const manifest = await bundledManifest({ outputJSON: false });
 
-    expect(manifest).to.deep.equal({
-      name: 'App Manifest',
-      options: [{ name: 'Option 2' }, { framework_version: '1.10.0' }],
-      string_array: ['one', 'two', 'three'],
-      package_manifests: [
-        {
-          name: '@movable-internal/test-dep',
-          authors: ['Test Developer']
-        }
-      ],
-      studio_options: {
-        framework_version: studioFrameworkPkg.version,
-        package_dependencies: [
-          { name: '@movable/studio-framework', version: studioFrameworkPkg.version }
-        ]
-      }
-    });
+    expect(manifest).to.deep.equal(expectedAppManifest);
   });
-
   it('can optionally ignore the actual Studio Framework version', async () => {
-    const bundle = await rollup({
-      input: 'index.js',
-      plugins: [
-        manifestMerger({ output: 'manifest.yml', ignoreFrameworkVersionUpdate: true }),
-        nodeResolve()
-      ]
+    const manifest = await bundledManifest({
+      outputJSON: false,
+      ignoreFrameworkVersionUpdate: true
     });
 
-    const { output } = await bundle.generate({
-      format: 'es'
+    expect(manifest).to.deep.equal({
+      ...expectedAppManifest,
+      studio_options: { framework_version: '2.15' }
     });
 
-    const ymlFile = output.find(({ fileName }) => fileName === 'manifest.yml');
+    it('can build the manifest via dependencies with json output', async () => {
+      const manifest = await bundledManifest();
 
-    // @ts-ignore
-    const manifest = YAML.parse(ymlFile.source);
-
-    expect(manifest).to.deep.equal({
-      name: 'App Manifest',
-      options: [{ name: 'Option 2' }, { framework_version: '1.10.0' }],
-      string_array: ['one', 'two', 'three'],
-      package_manifests: [
-        {
-          name: '@movable-internal/test-dep',
-          authors: ['Test Developer']
-        }
-      ],
-      studio_options: {
-        framework_version: '2.15'
-      }
+      expect(manifest).to.deep.equal(expectedAppManifest);
     });
   });
-
   it('can build the manifest via dependencies', async () => {
-    const bundle = await rollup({
-      input: 'index.js',
-      plugins: [
-        manifestMerger({
-          outputJSON: true,
-          output: 'manifest.json'
-        }),
-        nodeResolve()
-      ]
-    });
+    const manifest = await bundledManifest();
 
-    const { output } = await bundle.generate({
-      format: 'es'
+    expect(manifest).to.deep.equal(expectedAppManifest);
+  });
+});
+describe('manifest merger - integration ids', () => {
+  describe('app with existing ids / dependencies with ids', () => {
+    setupFixture('test-app-with-app-and-package-integration-ids');
+    it('it can build multiple integration ids from multiple packages', async () => {
+      const manifest = await bundledManifest();
+      expect(manifest.integration_ids).to.have.members(['app-123', '123', 'abc', 'foo', 'bar']);
     });
+    it('it does not duplicate appManifest.integration_ids upon regeneration', async () => {
+      await bundledManifest();
+      const manifest = await bundledManifest();
 
-    const ymlFile = output.find(({ fileName }) => fileName === 'manifest.json');
-
-    // @ts-ignore
-    const manifest = JSON.parse(ymlFile.source);
+      expect(manifest.integration_ids).to.have.members(['app-123', '123', 'abc', 'foo', 'bar']);
+    });
+  });
+  describe('app with existing ids / dependencies with no ids', () => {
+    setupFixture('test-app-with-app-integration-ids');
 
-    expect(manifest).to.deep.equal({
-      name: 'App Manifest',
-      options: [{ name: 'Option 2' }, { framework_version: '1.10.0' }],
-      string_array: ['one', 'two', 'three'],
-      package_manifests: [
-        {
-          name: '@movable-internal/test-dep',
-          authors: ['Test Developer']
-        }
-      ],
-      studio_options: {
-        framework_version: studioFrameworkPkg.version,
-        package_dependencies: [
-          { name: '@movable/studio-framework', version: studioFrameworkPkg.version }
-        ]
-      }
+    it('it can build integration ids with no package integration ids', async () => {
+      const manifest = await bundledManifest();
+      expect(manifest.integration_ids).to.have.members(['app-123']);
     });
   });
 });

package/.mocharc.yml

@@ -1 +0,0 @@
-require: 'ts-node/register'