@electron-forge/plugin-base 6.0.0-beta.9 → 6.0.1

package/dist/Plugin.d.ts

@@ -1,12 +1,17 @@
-/// <reference types="node" />
-import { ForgeHookFn, StartOptions } from '@electron-forge/shared-types';
-import { ChildProcess } from 'child_process';
+import { ForgeHookFn, ForgeListrTask, ForgeMultiHookMap, IForgePlugin, ResolvedForgeConfig, StartOptions, StartResult } from '@electron-forge/shared-types';
 export { StartOptions };
-export default abstract class Plugin<C> {
+export default abstract class Plugin<C> implements IForgePlugin {
     config: C;
     abstract name: string;
+    /** @internal */
     __isElectronForgePlugin: true;
+    /** @internal */
+    _resolvedHooks: ForgeMultiHookMap;
     constructor(config: C);
-    getHook(hookName: string): ForgeHookFn | null;
-    startLogic(startOpts: StartOptions): Promise<ChildProcess | string | false>;
+    init(_dir: string, _config: ResolvedForgeConfig): void;
+    getHooks(): ForgeMultiHookMap;
+    startLogic(_startOpts: StartOptions): Promise<StartResult>;
 }
+export declare const namedHookWithTaskFn: <Hook extends keyof import("@electron-forge/shared-types").ForgeSimpleHookSignatures | keyof import("@electron-forge/shared-types").ForgeMutatingHookSignatures>(hookFn: (task: ForgeListrTask<never> | null, ...args: Parameters<ForgeHookFn<Hook>>) => ReturnType<ForgeHookFn<Hook>>, name: string) => ForgeHookFn<Hook>;
+export { Plugin as PluginBase };
+//# sourceMappingURL=Plugin.d.ts.map

package/dist/Plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Plugin.d.ts","sourceRoot":"","sources":["../src/Plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EAEX,cAAc,EACd,iBAAiB,EACjB,YAAY,EACZ,mBAAmB,EACnB,YAAY,EACZ,WAAW,EACZ,MAAM,8BAA8B,CAAC;AAEtC,OAAO,EAAE,YAAY,EAAE,CAAC;AAExB,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,MAAM,CAAC,CAAC,CAAE,YAAW,YAAY;IAQ1C,MAAM,EAAE,CAAC;IAP5B,SAAgB,IAAI,EAAE,MAAM,CAAC;IAE7B,gBAAgB;IAChB,uBAAuB,EAAG,IAAI,CAAC;IAC/B,gBAAgB;IAChB,cAAc,EAAE,iBAAiB,CAAM;gBAEpB,MAAM,EAAE,CAAC;IAQ5B,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,mBAAmB,GAAG,IAAI;IAOtD,QAAQ,IAAI,iBAAiB;IAIvB,UAAU,CAAC,UAAU,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC;CAGjE;AAUD,eAAO,MAAM,mBAAmB,kLACf,eAAe,KAAK,CAAC,GAAG,IAAI,kFACrC,MAAM,sBAQb,CAAC;AAGF,OAAO,EAAE,MAAM,IAAI,UAAU,EAAE,CAAC"}

package/dist/Plugin.js

@@ -1,58 +1,49 @@
 "use strict";
-
 Object.defineProperty(exports, "__esModule", {
-  value: true
+    value: true
 });
 Object.defineProperty(exports, "StartOptions", {
-  enumerable: true,
-  get: function get() {
-    return _sharedTypes.StartOptions;
-  }
+    enumerable: true,
+    get: function() {
+        return _sharedTypes.StartOptions;
+    }
 });
-exports.default = void 0;
-
-require("source-map-support/register");
-
+exports.namedHookWithTaskFn = exports.PluginBase = exports.default = void 0;
 var _sharedTypes = require("@electron-forge/shared-types");
-
-function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function step(key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } } function _next(value) { step("next", value); } function _throw(err) { step("throw", err); } _next(); }); }; }
-
 class Plugin {
-  /* tslint:disable variable-name */
-
-  /* tslint:enable variable-name */
-  constructor(config) {
-    this.config = config;
-    Object.defineProperty(this, "name", {
-      configurable: true,
-      enumerable: true,
-      writable: true,
-      value: void 0
-    });
-    Object.defineProperty(this, "__isElectronForgePlugin", {
-      configurable: true,
-      enumerable: true,
-      writable: true,
-      value: void 0
-    });
-    Object.defineProperty(this, '__isElectronForgePlugin', {
-      value: true,
-      enumerable: false,
-      configurable: false
-    });
-  }
-
-  getHook(hookName) {
-    return null;
-  }
-
-  startLogic(startOpts) {
-    return _asyncToGenerator(function* () {
-      return false;
-    })();
-  }
-
+    constructor(config){
+        this.config = config;
+        /** @internal */ this._resolvedHooks = {};
+        Object.defineProperty(this, '__isElectronForgePlugin', {
+            value: true,
+            enumerable: false,
+            configurable: false
+        });
+    }
+    init(_dir, _config) {
+        // This logic ensures that we only call getHooks once regardless of how many
+        // times we trip hook logic in the PluginInterface.
+        this._resolvedHooks = this.getHooks();
+        this.getHooks = ()=>this._resolvedHooks
+        ;
+    }
+    getHooks() {
+        return {};
+    }
+    async startLogic(_startOpts) {
+        return false;
+    }
 }
-
 exports.default = Plugin;
-//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uL3NyYy9QbHVnaW4udHMiXSwibmFtZXMiOlsiUGx1Z2luIiwiY29uc3RydWN0b3IiLCJjb25maWciLCJPYmplY3QiLCJkZWZpbmVQcm9wZXJ0eSIsInZhbHVlIiwiZW51bWVyYWJsZSIsImNvbmZpZ3VyYWJsZSIsImdldEhvb2siLCJob29rTmFtZSIsInN0YXJ0TG9naWMiLCJzdGFydE9wdHMiXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7Ozs7OztBQUFBOzs7O0FBS2UsTUFBZUEsTUFBZixDQUF5QjtBQUV0Qzs7QUFFQTtBQUVBQyxjQUFtQkMsTUFBbkIsRUFBOEI7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUM1QkMsV0FBT0MsY0FBUCxDQUFzQixJQUF0QixFQUE0Qix5QkFBNUIsRUFBdUQ7QUFDckRDLGFBQU8sSUFEOEM7QUFFckRDLGtCQUFZLEtBRnlDO0FBR3JEQyxvQkFBYztBQUh1QyxLQUF2RDtBQUtEOztBQUVEQyxVQUFRQyxRQUFSLEVBQThDO0FBQzVDLFdBQU8sSUFBUDtBQUNEOztBQUVLQyxZQUFOLENBQWlCQyxTQUFqQixFQUFrRjtBQUFBO0FBQ2hGLGFBQU8sS0FBUDtBQURnRjtBQUVqRjs7QUFwQnFDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgRm9yZ2VIb29rRm4sIFN0YXJ0T3B0aW9ucyB9IGZyb20gJ0BlbGVjdHJvbi1mb3JnZS9zaGFyZWQtdHlwZXMnO1xuaW1wb3J0IHsgQ2hpbGRQcm9jZXNzIH0gZnJvbSAnY2hpbGRfcHJvY2Vzcyc7XG5cbmV4cG9ydCB7IFN0YXJ0T3B0aW9ucyB9O1xuXG5leHBvcnQgZGVmYXVsdCBhYnN0cmFjdCBjbGFzcyBQbHVnaW48Qz4ge1xuICBwdWJsaWMgYWJzdHJhY3QgbmFtZTogc3RyaW5nO1xuICAvKiB0c2xpbnQ6ZGlzYWJsZSB2YXJpYWJsZS1uYW1lICovXG4gIF9faXNFbGVjdHJvbkZvcmdlUGx1Z2luITogdHJ1ZTtcbiAgLyogdHNsaW50OmVuYWJsZSB2YXJpYWJsZS1uYW1lICovXG5cbiAgY29uc3RydWN0b3IocHVibGljIGNvbmZpZzogQykge1xuICAgIE9iamVjdC5kZWZpbmVQcm9wZXJ0eSh0aGlzLCAnX19pc0VsZWN0cm9uRm9yZ2VQbHVnaW4nLCB7XG4gICAgICB2YWx1ZTogdHJ1ZSxcbiAgICAgIGVudW1lcmFibGU6IGZhbHNlLFxuICAgICAgY29uZmlndXJhYmxlOiBmYWxzZSxcbiAgICB9KTtcbiAgfVxuXG4gIGdldEhvb2soaG9va05hbWU6IHN0cmluZyk6IEZvcmdlSG9va0ZuIHwgbnVsbCB7XG4gICAgcmV0dXJuIG51bGw7XG4gIH1cblxuICBhc3luYyBzdGFydExvZ2ljKHN0YXJ0T3B0czogU3RhcnRPcHRpb25zKTogUHJvbWlzZTxDaGlsZFByb2Nlc3MgfCBzdHJpbmcgfCBmYWxzZT4ge1xuICAgIHJldHVybiBmYWxzZTtcbiAgfVxufVxuIl19
+exports.PluginBase = Plugin;
+const namedHookWithTaskFn = (hookFn, name)=>{
+    function namedHookWithTaskInner(...args) {
+        return hookFn(this, ...args);
+    }
+    const fn = namedHookWithTaskInner;
+    fn.__hookName = name;
+    return fn;
+};
+exports.namedHookWithTaskFn = namedHookWithTaskFn;
+
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uL3NyYy9QbHVnaW4udHMiXSwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHtcbiAgRm9yZ2VIb29rRm4sXG4gIEZvcmdlSG9va05hbWUsXG4gIEZvcmdlTGlzdHJUYXNrLFxuICBGb3JnZU11bHRpSG9va01hcCxcbiAgSUZvcmdlUGx1Z2luLFxuICBSZXNvbHZlZEZvcmdlQ29uZmlnLFxuICBTdGFydE9wdGlvbnMsXG4gIFN0YXJ0UmVzdWx0LFxufSBmcm9tICdAZWxlY3Ryb24tZm9yZ2Uvc2hhcmVkLXR5cGVzJztcblxuZXhwb3J0IHsgU3RhcnRPcHRpb25zIH07XG5cbmV4cG9ydCBkZWZhdWx0IGFic3RyYWN0IGNsYXNzIFBsdWdpbjxDPiBpbXBsZW1lbnRzIElGb3JnZVBsdWdpbiB7XG4gIHB1YmxpYyBhYnN0cmFjdCBuYW1lOiBzdHJpbmc7XG5cbiAgLyoqIEBpbnRlcm5hbCAqL1xuICBfX2lzRWxlY3Ryb25Gb3JnZVBsdWdpbiE6IHRydWU7XG4gIC8qKiBAaW50ZXJuYWwgKi9cbiAgX3Jlc29sdmVkSG9va3M6IEZvcmdlTXVsdGlIb29rTWFwID0ge307XG5cbiAgY29uc3RydWN0b3IocHVibGljIGNvbmZpZzogQykge1xuICAgIE9iamVjdC5kZWZpbmVQcm9wZXJ0eSh0aGlzLCAnX19pc0VsZWN0cm9uRm9yZ2VQbHVnaW4nLCB7XG4gICAgICB2YWx1ZTogdHJ1ZSxcbiAgICAgIGVudW1lcmFibGU6IGZhbHNlLFxuICAgICAgY29uZmlndXJhYmxlOiBmYWxzZSxcbiAgICB9KTtcbiAgfVxuXG4gIGluaXQoX2Rpcjogc3RyaW5nLCBfY29uZmlnOiBSZXNvbHZlZEZvcmdlQ29uZmlnKTogdm9pZCB7XG4gICAgLy8gVGhpcyBsb2dpYyBlbnN1cmVzIHRoYXQgd2Ugb25seSBjYWxsIGdldEhvb2tzIG9uY2UgcmVnYXJkbGVzcyBvZiBob3cgbWFueVxuICAgIC8vIHRpbWVzIHdlIHRyaXAgaG9vayBsb2dpYyBpbiB0aGUgUGx1Z2luSW50ZXJmYWNlLlxuICAgIHRoaXMuX3Jlc29sdmVkSG9va3MgPSB0aGlzLmdldEhvb2tzKCk7XG4gICAgdGhpcy5nZXRIb29rcyA9ICgpID0+IHRoaXMuX3Jlc29sdmVkSG9va3M7XG4gIH1cblxuICBnZXRIb29rcygpOiBGb3JnZU11bHRpSG9va01hcCB7XG4gICAgcmV0dXJuIHt9O1xuICB9XG5cbiAgYXN5bmMgc3RhcnRMb2dpYyhfc3RhcnRPcHRzOiBTdGFydE9wdGlvbnMpOiBQcm9taXNlPFN0YXJ0UmVzdWx0PiB7XG4gICAgcmV0dXJuIGZhbHNlO1xuICB9XG59XG5cbi8qIGVzbGludC1kaXNhYmxlIEB0eXBlc2NyaXB0LWVzbGludC9uby1leHBsaWNpdC1hbnkgKi9cbi8vIFRoaXMgaXMgYSBmaWx0aHkgaGFjayBhcm91bmQgdHlwZXNjcmlwdCB0byBhbGxvdyBpbnRlcm5hbCBob29rcyBpbiBvdXJcbi8vIGludGVybmFsIHBsdWdpbnMgdG8gaGF2ZSBzb21lIGxldmVsIG9mIGFjY2VzcyB0byB0aGUgXCJUYXNrXCIgdGhhdCBsaXN0ciBydW5zLlxuLy8gU3BlY2lmaWNhbGx5IHRoZSBhYmlsaXR5IHRvIHNldCBhIGN1c3RvbSB0YXNrIG5hbWUgYW5kIHJlY2VpdmUgdGhlIHRhc2tcbi8vIGluc3RhbmNlIGFzIGEgcGFyYW1ldGVyXG4vL1xuLy8gVGhpcyBtZXRob2QgaXMgbm90IHR5cGUgc2FmZSBpbnRlcm5hbGx5LCBidXQgaXMgdHlwZSBzYWZlIGZvciBjb25zdW1lcnNcbi8vIEBpbnRlcm5hbFxuZXhwb3J0IGNvbnN0IG5hbWVkSG9va1dpdGhUYXNrRm4gPSA8SG9vayBleHRlbmRzIEZvcmdlSG9va05hbWU+KFxuICBob29rRm46ICh0YXNrOiBGb3JnZUxpc3RyVGFzazxuZXZlcj4gfCBudWxsLCAuLi5hcmdzOiBQYXJhbWV0ZXJzPEZvcmdlSG9va0ZuPEhvb2s+PikgPT4gUmV0dXJuVHlwZTxGb3JnZUhvb2tGbjxIb29rPj4sXG4gIG5hbWU6IHN0cmluZ1xuKTogRm9yZ2VIb29rRm48SG9vaz4gPT4ge1xuICBmdW5jdGlvbiBuYW1lZEhvb2tXaXRoVGFza0lubmVyKHRoaXM6IEZvcmdlTGlzdHJUYXNrPGFueT4gfCBudWxsLCAuLi5hcmdzOiBhbnlbXSkge1xuICAgIHJldHVybiAoaG9va0ZuIGFzIGFueSkodGhpcywgLi4uYXJncyk7XG4gIH1cbiAgY29uc3QgZm4gPSBuYW1lZEhvb2tXaXRoVGFza0lubmVyIGFzIGFueTtcbiAgZm4uX19ob29rTmFtZSA9IG5hbWU7XG4gIHJldHVybiBmbjtcbn07XG4vKiBlc2xpbnQtZW5hYmxlIEB0eXBlc2NyaXB0LWVzbGludC9uby1leHBsaWNpdC1hbnkgKi9cblxuZXhwb3J0IHsgUGx1Z2luIGFzIFBsdWdpbkJhc2UgfTtcbiJdLCJuYW1lcyI6WyJTdGFydE9wdGlvbnMiLCJQbHVnaW4iLCJjb25maWciLCJfcmVzb2x2ZWRIb29rcyIsIk9iamVjdCIsImRlZmluZVByb3BlcnR5IiwidmFsdWUiLCJlbnVtZXJhYmxlIiwiY29uZmlndXJhYmxlIiwiaW5pdCIsIl9kaXIiLCJfY29uZmlnIiwiZ2V0SG9va3MiLCJzdGFydExvZ2ljIiwiX3N0YXJ0T3B0cyIsIlBsdWdpbkJhc2UiLCJuYW1lZEhvb2tXaXRoVGFza0ZuIiwiaG9va0ZuIiwibmFtZSIsIm5hbWVkSG9va1dpdGhUYXNrSW5uZXIiLCJhcmdzIiwiZm4iLCJfX2hvb2tOYW1lIl0sIm1hcHBpbmdzIjoiOzs7OytCQVdTQSxDQUFZOzs7ZUFBWkEsWUFBWTs7OztBQUZkLEdBQThCLENBQTlCLFlBQThCO01BSVBDLE1BQU07Z0JBUWZDLE1BQVMsQ0FBRSxDQUFDO2FBQVpBLE1BQVMsR0FBVEEsTUFBUztRQUg1QixFQUFnQixBQUFoQixZQUFnQixBQUFoQixFQUFnQixDQUxILElBOEJkLENBeEJDQyxjQUFjLEdBQXNCLENBQUMsQ0FBQztRQUdwQ0MsTUFBTSxDQUFDQyxjQUFjLENBQUMsSUFBSSxFQUFFLENBQXlCLDBCQUFFLENBQUM7WUFDdERDLEtBQUssRUFBRSxJQUFJO1lBQ1hDLFVBQVUsRUFBRSxLQUFLO1lBQ2pCQyxZQUFZLEVBQUUsS0FBSztRQUNyQixDQUFDO0lBQ0gsQ0FBQztJQUVEQyxJQUFJLENBQUNDLElBQVksRUFBRUMsT0FBNEIsRUFBUSxDQUFDO1FBQ3RELEVBQTRFLEFBQTVFLDBFQUE0RTtRQUM1RSxFQUFtRCxBQUFuRCxpREFBbUQ7UUFDbkQsSUFBSSxDQUFDUixjQUFjLEdBQUcsSUFBSSxDQUFDUyxRQUFRO1FBQ25DLElBQUksQ0FBQ0EsUUFBUSxPQUFTLElBQUksQ0FBQ1QsY0FBYzs7SUFDM0MsQ0FBQztJQUVEUyxRQUFRLEdBQXNCLENBQUM7UUFDN0IsTUFBTSxDQUFDLENBQUMsQ0FBQztJQUNYLENBQUM7VUFFS0MsVUFBVSxDQUFDQyxVQUF3QixFQUF3QixDQUFDO1FBQ2hFLE1BQU0sQ0FBQyxLQUFLO0lBQ2QsQ0FBQzs7a0JBN0IyQmIsTUFBTTtRQXFEakJjLFVBQVUsR0FBcEJkLE1BQU07QUFiUixLQUFLLENBQUNlLG1CQUFtQixJQUM5QkMsTUFBcUgsRUFDckhDLElBQVksR0FDVSxDQUFDO2FBQ2RDLHNCQUFzQixJQUFzQ0MsSUFBSSxFQUFTLENBQUM7UUFDakYsTUFBTSxDQUFFSCxNQUFNLENBQVMsSUFBSSxLQUFLRyxJQUFJO0lBQ3RDLENBQUM7SUFDRCxLQUFLLENBQUNDLEVBQUUsR0FBR0Ysc0JBQXNCO0lBQ2pDRSxFQUFFLENBQUNDLFVBQVUsR0FBR0osSUFBSTtJQUNwQixNQUFNLENBQUNHLEVBQUU7QUFDWCxDQUFDO1FBVllMLG1CQUFtQixHQUFuQkEsbUJBQW1CIn0=

package/index.ts

@@ -0,0 +1,5 @@
+// ⚠️ AUTOGENERATED ⚠️ AUTOGENERATED ⚠️ AUTOGENERATED ⚠️
+// This file was automatically generated by `tools/gen-ts-glue.ts`. Do not modify directly if you want to keep your changes.
+export * from "./src/Plugin";
+import defaultExport from "./src/Plugin";
+export default defaultExport;

package/package.json

@@ -1,23 +1,20 @@
 {
   "name": "@electron-forge/plugin-base",
-  "version": "6.0.0-beta.9",
+  "version": "6.0.1",
   "description": "Base plugin for Electron Forge",
-  "repository": "https://github.com/electron-userland/electron-forge",
+  "repository": "https://github.com/electron/forge",
   "author": "Samuel Attard",
   "license": "MIT",
   "main": "dist/Plugin.js",
   "typings": "dist/Plugin.d.ts",
-  "scripts": {
-    "test": "exit 0"
-  },
   "devDependencies": {
-    "chai": "^4.0.0",
-    "mocha": "^5.0.0"
+    "chai": "^4.3.3",
+    "mocha": "^9.0.1"
   },
   "engines": {
-    "node": ">= 6.0"
+    "node": ">= 14.17.5"
   },
   "dependencies": {
-    "@electron-forge/shared-types": "6.0.0-beta.9"
+    "@electron-forge/shared-types": "6.0.1"
   }
 }

package/tsconfig.json

@@ -1,23 +1,36 @@
 {
-	"compilerOptions": {
-		"module": "commonjs",
-		"target": "es6",
-		"outDir": "dist",
-		"lib": [
-			"es6",
-			"dom",
-			"es7"
-		],
-		"sourceMap": true,
-		"rootDir": "src",
-		"experimentalDecorators": true,
-		"strict": true,
-		"esModuleInterop": true,
-		"declaration": true
-	},
-	"exclude": [
-		"node_modules",
-		"dist",
-		"test"
-	]
+  "//": "⚠️ AUTOGENERATED ⚠️ This file was automatically generated by tools/gen-tsconfigs.ts, do not edit manually.",
+  "compilerOptions": {
+    "module": "commonjs",
+    "target": "es2019",
+    "outDir": "dist",
+    "lib": [
+      "dom",
+      "es2019"
+    ],
+    "sourceMap": true,
+    "rootDir": "src",
+    "experimentalDecorators": true,
+    "strict": true,
+    "esModuleInterop": true,
+    "declaration": true,
+    "composite": true,
+    "declarationMap": true,
+    "typeRoots": [
+      "../../../typings",
+      "../../../node_modules/@types"
+    ]
+  },
+  "exclude": [
+    "node_modules",
+    "dist",
+    "test",
+    "index.ts",
+    "tmpl"
+  ],
+  "references": [
+    {
+      "path": "../../utils/types"
+    }
+  ]
 }