@metamask/snaps-cli 0.22.2 → 0.23.0

package/README.md

@@ -18,12 +18,12 @@ Install a dev dependency in your snap project or globally using `yarn` or `npm`:
 Usage: mm-snap <command> [options]
 
 Commands:
-  mm-snap build     Build Snap from source                          [aliases: b]
-  mm-snap eval      Attempt to evaluate Snap bundle in SES          [aliases: e]
-  mm-snap init      Initialize Snap package                         [aliases: i]
-  mm-snap manifest  Validate the snap.manifest.json file            [aliases: m]
-  mm-snap serve     Locally serve Snap file(s) for testing          [aliases: s]
-  mm-snap watch     Build Snap on change                            [aliases: w]
+  mm-snap build             Build Snap from source                  [aliases: b]
+  mm-snap eval              Attempt to evaluate Snap bundle in SES  [aliases: e]
+  mm-snap init [directory]  Initialize Snap package                 [aliases: i]
+  mm-snap manifest          Validate the snap.manifest.json file    [aliases: m]
+  mm-snap serve             Locally serve Snap file(s) for testing  [aliases: s]
+  mm-snap watch             Build Snap on change                    [aliases: w]
 
 Options:
       --version           Show version number                          [boolean]

package/dist/__mocks__/fs.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("memfs/lib/volume").Volume;
+export = _default;

package/dist/__mocks__/fs.js

@@ -0,0 +1,4 @@
+"use strict";
+const memfs_1 = require("memfs");
+module.exports = new memfs_1.Volume();
+//# sourceMappingURL=fs.js.map

package/dist/__mocks__/fs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fs.js","sourceRoot":"","sources":["../../src/__mocks__/fs.ts"],"names":[],"mappings":";AAAA,iCAA+B;AAG/B,iBAAS,IAAI,cAAM,EAAE,CAAC","sourcesContent":["import { Volume } from 'memfs';\n\n// Note: `Volume` implements most of the `fs` API, but not all.\nexport = new Volume();\n"]}

package/dist/builders.d.ts

@@ -1,4 +1,4 @@
-import { Options } from 'yargs';
+import { Options, PositionalOptions } from 'yargs';
 export declare type SnapsCliBuilders = {
     readonly bundle: Readonly<Options>;
     readonly dist: Readonly<Options>;
@@ -16,16 +16,12 @@ export declare type SnapsCliBuilders = {
     readonly verboseErrors: Readonly<Options>;
     readonly writeManifest: Readonly<Options>;
     readonly serve: Readonly<Options>;
-    readonly template: Readonly<Options>;
+    readonly directory: Readonly<PositionalOptions>;
 };
 export declare enum TranspilationModes {
     localAndDeps = "localAndDeps",
     localOnly = "localOnly",
     none = "none"
 }
-export declare enum TemplateType {
-    TypeScript = "typescript",
-    JavaScript = "javascript"
-}
 declare const builders: SnapsCliBuilders;
 export default builders;

package/dist/builders.js

@@ -1,17 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TemplateType = exports.TranspilationModes = void 0;
+exports.TranspilationModes = void 0;
 var TranspilationModes;
 (function (TranspilationModes) {
     TranspilationModes["localAndDeps"] = "localAndDeps";
     TranspilationModes["localOnly"] = "localOnly";
     TranspilationModes["none"] = "none";
 })(TranspilationModes = exports.TranspilationModes || (exports.TranspilationModes = {}));
-var TemplateType;
-(function (TemplateType) {
-    TemplateType["TypeScript"] = "typescript";
-    TemplateType["JavaScript"] = "javascript";
-})(TemplateType = exports.TemplateType || (exports.TemplateType = {}));
 const builders = {
     bundle: {
         alias: 'b',
@@ -129,13 +124,9 @@ const builders = {
         demandOption: false,
         default: true,
     },
-    template: {
-        alias: 't',
-        describe: 'Specify which template to use (TypeScript or JavaScript)',
+    directory: {
+        describe: 'the directory to use',
         type: 'string',
-        demandOption: false,
-        default: TemplateType.TypeScript,
-        choices: Object.values(TemplateType),
     },
 };
 exports.default = builders;

package/dist/builders.js.map

@@ -1 +1 @@
-{"version":3,"file":"builders.js","sourceRoot":"","sources":["../src/builders.ts"],"names":[],"mappings":";;;AAsBA,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,mDAA6B,CAAA;IAC7B,6CAAuB,CAAA;IACvB,mCAAa,CAAA;AACf,CAAC,EAJW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAI7B;AAED,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,yCAAyB,CAAA;IACzB,yCAAyB,CAAA;AAC3B,CAAC,EAHW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAGvB;AAED,MAAM,QAAQ,GAAqB;IACjC,MAAM,EAAE;QACN,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,kBAAkB;QAC5B,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;QAClB,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,gBAAgB;KAC1B;IAED,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,kBAAkB;QAC5B,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;QAClB,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,MAAM;KAChB;IAED,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,wCAAwC;QAClD,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,IAAI;KACd;IAED,QAAQ,EAAE;QACR,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,6BAA6B;QACvC,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,IAAI;KACd;IAED,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,+BAA+B;QACzC,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;QAClB,OAAO,EAAE,IAAI;QACb,MAAM,EAAE,CAAC,GAAY,EAAE,EAAE;YACvB,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;YAC9C,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;gBACtB,MAAM,IAAI,KAAK,CAAC,iBAAiB,GAAG,EAAE,CAAC,CAAC;aACzC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;KACF;IAED,WAAW,EAAE;QACX,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,kBAAkB;QAC5B,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,WAAW;KACrB;IAED,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,uBAAuB;QACjC,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;QAClB,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,GAAG;KACb;IAED,UAAU,EAAE;QACV,QAAQ,EAAE,mCAAmC;QAC7C,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,KAAK;KACf;IAED,GAAG,EAAE;QACH,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,aAAa;QACvB,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;QAClB,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,cAAc;KACxB;IAED,aAAa,EAAE;QACb,KAAK,EAAE,OAAO;QACd,QAAQ,EAAE,uDAAuD;QACjE,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,IAAI;KACd;IAED,gBAAgB,EAAE;QAChB,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,8BAA8B;QACxC,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,KAAK;KACf;IAED,iBAAiB,EAAE;QACjB,IAAI,EAAE,QAAQ;QACd,QAAQ,EACN,iHAAiH;QACnH,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,kBAAkB,CAAC,SAAS;QACrC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC;KAC3C;IAED,eAAe,EAAE;QACf,IAAI,EAAE,OAAO;QACb,QAAQ,EAAE,yCAAyC;QACnD,YAAY,EAAE,KAAK;KACpB;IAED,aAAa,EAAE;QACb,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,yBAAyB;QACnC,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,IAAI;KACd;IAED,aAAa,EAAE;QACb,QAAQ,EAAE,kDAAkD;QAC5D,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,IAAI;KACd;IAED,KAAK,EAAE;QACL,QAAQ,EAAE,wCAAwC;QAClD,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,IAAI;KACd;IAED,QAAQ,EAAE;QACR,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,0DAA0D;QACpE,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,YAAY,CAAC,UAAU;QAChC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC;KACrC;CACF,CAAC;AAEF,kBAAe,QAAQ,CAAC","sourcesContent":["import { Options } from 'yargs';\n\nexport type SnapsCliBuilders = {\n  readonly bundle: Readonly<Options>;\n  readonly dist: Readonly<Options>;\n  readonly eval: Readonly<Options>;\n  readonly manifest: Readonly<Options>;\n  readonly outfileName: Readonly<Options>;\n  readonly port: Readonly<Options>;\n  readonly root: Readonly<Options>;\n  readonly sourceMaps: Readonly<Options>;\n  readonly src: Readonly<Options>;\n  readonly stripComments: Readonly<Options>;\n  readonly suppressWarnings: Readonly<Options>;\n  readonly transpilationMode: Readonly<Options>;\n  readonly depsToTranspile: Readonly<Options>;\n  readonly verboseErrors: Readonly<Options>;\n  readonly writeManifest: Readonly<Options>;\n  readonly serve: Readonly<Options>;\n  readonly template: Readonly<Options>;\n};\n\nexport enum TranspilationModes {\n  localAndDeps = 'localAndDeps',\n  localOnly = 'localOnly',\n  none = 'none',\n}\n\nexport enum TemplateType {\n  TypeScript = 'typescript',\n  JavaScript = 'javascript',\n}\n\nconst builders: SnapsCliBuilders = {\n  bundle: {\n    alias: 'b',\n    describe: 'Snap bundle file',\n    type: 'string',\n    demandOption: true,\n    normalize: true,\n    default: 'dist/bundle.js',\n  },\n\n  dist: {\n    alias: 'd',\n    describe: 'Output directory',\n    type: 'string',\n    demandOption: true,\n    normalize: true,\n    default: 'dist',\n  },\n\n  eval: {\n    alias: 'e',\n    describe: 'Attempt to evaluate Snap bundle in SES',\n    type: 'boolean',\n    demandOption: false,\n    default: true,\n  },\n\n  manifest: {\n    alias: 'm',\n    describe: 'Validate snap.manifest.json',\n    type: 'boolean',\n    demandOption: false,\n    default: true,\n  },\n\n  port: {\n    alias: 'p',\n    describe: 'Local server port for testing',\n    type: 'number',\n    demandOption: true,\n    default: 8081,\n    coerce: (arg: unknown) => {\n      const port = Number.parseInt(String(arg), 10);\n      if (Number.isNaN(port)) {\n        throw new Error(`Invalid port: ${arg}`);\n      }\n      return port;\n    },\n  },\n\n  outfileName: {\n    alias: 'n',\n    describe: 'Output file name',\n    type: 'string',\n    demandOption: false,\n    default: 'bundle.js',\n  },\n\n  root: {\n    alias: 'r',\n    describe: 'Server root directory',\n    type: 'string',\n    demandOption: true,\n    normalize: true,\n    default: '.',\n  },\n\n  sourceMaps: {\n    describe: 'Whether builds include sourcemaps',\n    type: 'boolean',\n    demandOption: false,\n    default: false,\n  },\n\n  src: {\n    alias: 's',\n    describe: 'Source file',\n    type: 'string',\n    demandOption: true,\n    normalize: true,\n    default: 'src/index.js',\n  },\n\n  stripComments: {\n    alias: 'strip',\n    describe: 'Whether to remove code comments from the build output',\n    type: 'boolean',\n    demandOption: false,\n    default: true,\n  },\n\n  suppressWarnings: {\n    type: 'boolean',\n    describe: 'Whether to suppress warnings',\n    demandOption: false,\n    default: false,\n  },\n\n  transpilationMode: {\n    type: 'string',\n    describe:\n      'Whether to use Babel to transpile all source code (including dependencies), local source code only, or nothing.',\n    demandOption: false,\n    default: TranspilationModes.localOnly,\n    choices: Object.values(TranspilationModes),\n  },\n\n  depsToTranspile: {\n    type: 'array',\n    describe: 'Transpile only the listed dependencies.',\n    demandOption: false,\n  },\n\n  verboseErrors: {\n    type: 'boolean',\n    describe: 'Display original errors',\n    demandOption: false,\n    default: true,\n  },\n\n  writeManifest: {\n    describe: 'Make necessary changes to the Snap manifest file',\n    type: 'boolean',\n    demandOption: false,\n    default: true,\n  },\n\n  serve: {\n    describe: 'Serve Snap file(s) locally for testing',\n    type: 'boolean',\n    demandOption: false,\n    default: true,\n  },\n\n  template: {\n    alias: 't',\n    describe: 'Specify which template to use (TypeScript or JavaScript)',\n    type: 'string',\n    demandOption: false,\n    default: TemplateType.TypeScript,\n    choices: Object.values(TemplateType),\n  },\n};\n\nexport default builders;\n"]}
+{"version":3,"file":"builders.js","sourceRoot":"","sources":["../src/builders.ts"],"names":[],"mappings":";;;AAsBA,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,mDAA6B,CAAA;IAC7B,6CAAuB,CAAA;IACvB,mCAAa,CAAA;AACf,CAAC,EAJW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAI7B;AAED,MAAM,QAAQ,GAAqB;IACjC,MAAM,EAAE;QACN,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,kBAAkB;QAC5B,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;QAClB,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,gBAAgB;KAC1B;IAED,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,kBAAkB;QAC5B,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;QAClB,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,MAAM;KAChB;IAED,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,wCAAwC;QAClD,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,IAAI;KACd;IAED,QAAQ,EAAE;QACR,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,6BAA6B;QACvC,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,IAAI;KACd;IAED,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,+BAA+B;QACzC,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;QAClB,OAAO,EAAE,IAAI;QACb,MAAM,EAAE,CAAC,GAAY,EAAE,EAAE;YACvB,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;YAC9C,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;gBACtB,MAAM,IAAI,KAAK,CAAC,iBAAiB,GAAG,EAAE,CAAC,CAAC;aACzC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;KACF;IAED,WAAW,EAAE;QACX,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,kBAAkB;QAC5B,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,WAAW;KACrB;IAED,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,uBAAuB;QACjC,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;QAClB,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,GAAG;KACb;IAED,UAAU,EAAE;QACV,QAAQ,EAAE,mCAAmC;QAC7C,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,KAAK;KACf;IAED,GAAG,EAAE;QACH,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,aAAa;QACvB,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;QAClB,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,cAAc;KACxB;IAED,aAAa,EAAE;QACb,KAAK,EAAE,OAAO;QACd,QAAQ,EAAE,uDAAuD;QACjE,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,IAAI;KACd;IAED,gBAAgB,EAAE;QAChB,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,8BAA8B;QACxC,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,KAAK;KACf;IAED,iBAAiB,EAAE;QACjB,IAAI,EAAE,QAAQ;QACd,QAAQ,EACN,iHAAiH;QACnH,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,kBAAkB,CAAC,SAAS;QACrC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC;KAC3C;IAED,eAAe,EAAE;QACf,IAAI,EAAE,OAAO;QACb,QAAQ,EAAE,yCAAyC;QACnD,YAAY,EAAE,KAAK;KACpB;IAED,aAAa,EAAE;QACb,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,yBAAyB;QACnC,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,IAAI;KACd;IAED,aAAa,EAAE;QACb,QAAQ,EAAE,kDAAkD;QAC5D,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,IAAI;KACd;IAED,KAAK,EAAE;QACL,QAAQ,EAAE,wCAAwC;QAClD,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,IAAI;KACd;IAED,SAAS,EAAE;QACT,QAAQ,EAAE,sBAAsB;QAChC,IAAI,EAAE,QAAQ;KACf;CACF,CAAC;AAEF,kBAAe,QAAQ,CAAC","sourcesContent":["import { Options, PositionalOptions } from 'yargs';\n\nexport type SnapsCliBuilders = {\n  readonly bundle: Readonly<Options>;\n  readonly dist: Readonly<Options>;\n  readonly eval: Readonly<Options>;\n  readonly manifest: Readonly<Options>;\n  readonly outfileName: Readonly<Options>;\n  readonly port: Readonly<Options>;\n  readonly root: Readonly<Options>;\n  readonly sourceMaps: Readonly<Options>;\n  readonly src: Readonly<Options>;\n  readonly stripComments: Readonly<Options>;\n  readonly suppressWarnings: Readonly<Options>;\n  readonly transpilationMode: Readonly<Options>;\n  readonly depsToTranspile: Readonly<Options>;\n  readonly verboseErrors: Readonly<Options>;\n  readonly writeManifest: Readonly<Options>;\n  readonly serve: Readonly<Options>;\n  readonly directory: Readonly<PositionalOptions>;\n};\n\nexport enum TranspilationModes {\n  localAndDeps = 'localAndDeps',\n  localOnly = 'localOnly',\n  none = 'none',\n}\n\nconst builders: SnapsCliBuilders = {\n  bundle: {\n    alias: 'b',\n    describe: 'Snap bundle file',\n    type: 'string',\n    demandOption: true,\n    normalize: true,\n    default: 'dist/bundle.js',\n  },\n\n  dist: {\n    alias: 'd',\n    describe: 'Output directory',\n    type: 'string',\n    demandOption: true,\n    normalize: true,\n    default: 'dist',\n  },\n\n  eval: {\n    alias: 'e',\n    describe: 'Attempt to evaluate Snap bundle in SES',\n    type: 'boolean',\n    demandOption: false,\n    default: true,\n  },\n\n  manifest: {\n    alias: 'm',\n    describe: 'Validate snap.manifest.json',\n    type: 'boolean',\n    demandOption: false,\n    default: true,\n  },\n\n  port: {\n    alias: 'p',\n    describe: 'Local server port for testing',\n    type: 'number',\n    demandOption: true,\n    default: 8081,\n    coerce: (arg: unknown) => {\n      const port = Number.parseInt(String(arg), 10);\n      if (Number.isNaN(port)) {\n        throw new Error(`Invalid port: ${arg}`);\n      }\n      return port;\n    },\n  },\n\n  outfileName: {\n    alias: 'n',\n    describe: 'Output file name',\n    type: 'string',\n    demandOption: false,\n    default: 'bundle.js',\n  },\n\n  root: {\n    alias: 'r',\n    describe: 'Server root directory',\n    type: 'string',\n    demandOption: true,\n    normalize: true,\n    default: '.',\n  },\n\n  sourceMaps: {\n    describe: 'Whether builds include sourcemaps',\n    type: 'boolean',\n    demandOption: false,\n    default: false,\n  },\n\n  src: {\n    alias: 's',\n    describe: 'Source file',\n    type: 'string',\n    demandOption: true,\n    normalize: true,\n    default: 'src/index.js',\n  },\n\n  stripComments: {\n    alias: 'strip',\n    describe: 'Whether to remove code comments from the build output',\n    type: 'boolean',\n    demandOption: false,\n    default: true,\n  },\n\n  suppressWarnings: {\n    type: 'boolean',\n    describe: 'Whether to suppress warnings',\n    demandOption: false,\n    default: false,\n  },\n\n  transpilationMode: {\n    type: 'string',\n    describe:\n      'Whether to use Babel to transpile all source code (including dependencies), local source code only, or nothing.',\n    demandOption: false,\n    default: TranspilationModes.localOnly,\n    choices: Object.values(TranspilationModes),\n  },\n\n  depsToTranspile: {\n    type: 'array',\n    describe: 'Transpile only the listed dependencies.',\n    demandOption: false,\n  },\n\n  verboseErrors: {\n    type: 'boolean',\n    describe: 'Display original errors',\n    demandOption: false,\n    default: true,\n  },\n\n  writeManifest: {\n    describe: 'Make necessary changes to the Snap manifest file',\n    type: 'boolean',\n    demandOption: false,\n    default: true,\n  },\n\n  serve: {\n    describe: 'Serve Snap file(s) locally for testing',\n    type: 'boolean',\n    demandOption: false,\n    default: true,\n  },\n\n  directory: {\n    describe: 'the directory to use',\n    type: 'string',\n  },\n};\n\nexport default builders;\n"]}

package/dist/cmds/init/index.js

@@ -5,7 +5,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 const builders_1 = __importDefault(require("../../builders"));
 const buildHandler_1 = require("../build/buildHandler");
 const initHandler_1 = require("./initHandler");
-const initUtils_1 = require("./initUtils");
 /**
  * The main entrypoint for the init command. This calls the init handler to
  * initialize the snap package, builds the snap, and then updates the manifest
@@ -16,23 +15,15 @@ const initUtils_1 = require("./initUtils");
 async function init(argv) {
     console.log();
     const newArgs = await (0, initHandler_1.initHandler)(argv);
+    process.chdir(newArgs.snapLocation);
     await (0, buildHandler_1.build)(Object.assign(Object.assign({}, newArgs), { manifest: false, eval: true }));
-    await (0, initHandler_1.updateManifestShasum)();
     console.log('\nSnap project successfully initiated!');
 }
 module.exports = {
-    command: ['init', 'i'],
+    command: ['init [directory]', 'i [directory]'],
     desc: 'Initialize Snap package',
     builder: (yarg) => {
-        yarg
-            .option('src', builders_1.default.src)
-            .option('dist', builders_1.default.dist)
-            .option('port', builders_1.default.port)
-            .option('outfileName', builders_1.default.outfileName)
-            .option('template', builders_1.default.template)
-            .middleware(((yargsArgv) => {
-            (0, initUtils_1.correctDefaultArgs)(yargsArgv);
-        }), true);
+        yarg.positional('directory', builders_1.default.directory);
     },
     handler: (argv) => init(argv),
 };

package/dist/cmds/init/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/cmds/init/index.ts"],"names":[],"mappings":";;;;AACA,8DAAsC;AAEtC,wDAA8C;AAC9C,+CAAkE;AAClE,2CAAiD;AAsBjD;;;;;;GAMG;AACH,KAAK,UAAU,IAAI,CAAC,IAAe;IACjC,OAAO,CAAC,GAAG,EAAE,CAAC;IACd,MAAM,OAAO,GAAG,MAAM,IAAA,yBAAW,EAAC,IAAI,CAAC,CAAC;IAExC,MAAM,IAAA,oBAAK,kCACN,OAAO,KACV,QAAQ,EAAE,KAAK,EACf,IAAI,EAAE,IAAI,IACV,CAAC;IAEH,MAAM,IAAA,kCAAoB,GAAE,CAAC;IAE7B,OAAO,CAAC,GAAG,CAAC,wCAAwC,CAAC,CAAC;AACxD,CAAC;AAxCD,iBAAS;IACP,OAAO,EAAE,CAAC,MAAM,EAAE,GAAG,CAAC;IACtB,IAAI,EAAE,yBAAyB;IAC/B,OAAO,EAAE,CAAC,IAAgB,EAAE,EAAE;QAC5B,IAAI;aACD,MAAM,CAAC,KAAK,EAAE,kBAAQ,CAAC,GAAG,CAAC;aAC3B,MAAM,CAAC,MAAM,EAAE,kBAAQ,CAAC,IAAI,CAAC;aAC7B,MAAM,CAAC,MAAM,EAAE,kBAAQ,CAAC,IAAI,CAAC;aAC7B,MAAM,CAAC,aAAa,EAAE,kBAAQ,CAAC,WAAW,CAAC;aAC3C,MAAM,CAAC,UAAU,EAAE,kBAAQ,CAAC,QAAQ,CAAC;aACrC,UAAU,CACT,CAAC,CAAC,SAAoB,EAAE,EAAE;YACxB,IAAA,8BAAkB,EAAC,SAAS,CAAC,CAAC;QAChC,CAAC,CAAQ,EACT,IAAI,CACL,CAAC;IACN,CAAC;IACD,OAAO,EAAE,CAAC,IAAe,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC;CACzC,CAAC","sourcesContent":["import yargs, { Arguments } from 'yargs';\nimport builders from '../../builders';\nimport { YargsArgs } from '../../types/yargs';\nimport { build } from '../build/buildHandler';\nimport { initHandler, updateManifestShasum } from './initHandler';\nimport { correctDefaultArgs } from './initUtils';\n\nexport = {\n  command: ['init', 'i'],\n  desc: 'Initialize Snap package',\n  builder: (yarg: yargs.Argv) => {\n    yarg\n      .option('src', builders.src)\n      .option('dist', builders.dist)\n      .option('port', builders.port)\n      .option('outfileName', builders.outfileName)\n      .option('template', builders.template)\n      .middleware(\n        ((yargsArgv: Arguments) => {\n          correctDefaultArgs(yargsArgv);\n        }) as any,\n        true,\n      );\n  },\n  handler: (argv: YargsArgs) => init(argv),\n};\n\n/**\n * The main entrypoint for the init command. This calls the init handler to\n * initialize the snap package, builds the snap, and then updates the manifest\n * with the shasum of the built snap.\n *\n * @param argv - The Yargs arguments object.\n */\nasync function init(argv: YargsArgs): Promise<void> {\n  console.log();\n  const newArgs = await initHandler(argv);\n\n  await build({\n    ...newArgs,\n    manifest: false,\n    eval: true,\n  });\n\n  await updateManifestShasum();\n\n  console.log('\\nSnap project successfully initiated!');\n}\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/cmds/init/index.ts"],"names":[],"mappings":";;;;AACA,8DAAsC;AAEtC,wDAA8C;AAC9C,+CAA4C;AAW5C;;;;;;GAMG;AACH,KAAK,UAAU,IAAI,CAAC,IAAe;IACjC,OAAO,CAAC,GAAG,EAAE,CAAC;IACd,MAAM,OAAO,GAAG,MAAM,IAAA,yBAAW,EAAC,IAAI,CAAC,CAAC;IAExC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IAEpC,MAAM,IAAA,oBAAK,kCACN,OAAO,KACV,QAAQ,EAAE,KAAK,EACf,IAAI,EAAE,IAAI,IACV,CAAC;IAEH,OAAO,CAAC,GAAG,CAAC,wCAAwC,CAAC,CAAC;AACxD,CAAC;AA7BD,iBAAS;IACP,OAAO,EAAE,CAAC,kBAAkB,EAAE,eAAe,CAAC;IAC9C,IAAI,EAAE,yBAAyB;IAC/B,OAAO,EAAE,CAAC,IAAgB,EAAE,EAAE;QAC5B,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,kBAAQ,CAAC,SAAS,CAAC,CAAC;IACnD,CAAC;IACD,OAAO,EAAE,CAAC,IAAe,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC;CACzC,CAAC","sourcesContent":["import yargs from 'yargs';\nimport builders from '../../builders';\nimport { YargsArgs } from '../../types/yargs';\nimport { build } from '../build/buildHandler';\nimport { initHandler } from './initHandler';\n\nexport = {\n  command: ['init [directory]', 'i [directory]'],\n  desc: 'Initialize Snap package',\n  builder: (yarg: yargs.Argv) => {\n    yarg.positional('directory', builders.directory);\n  },\n  handler: (argv: YargsArgs) => init(argv),\n};\n\n/**\n * The main entrypoint for the init command. This calls the init handler to\n * initialize the snap package, builds the snap, and then updates the manifest\n * with the shasum of the built snap.\n *\n * @param argv - The Yargs arguments object.\n */\nasync function init(argv: YargsArgs): Promise<void> {\n  console.log();\n  const newArgs = await initHandler(argv);\n\n  process.chdir(newArgs.snapLocation);\n\n  await build({\n    ...newArgs,\n    manifest: false,\n    eval: true,\n  });\n\n  console.log('\\nSnap project successfully initiated!');\n}\n"]}

package/dist/cmds/init/initHandler.d.ts

@@ -10,21 +10,17 @@ import { YargsArgs } from '../../types/yargs';
  * @throws If initialization of the snap package failed.
  */
 export declare function initHandler(argv: YargsArgs): Promise<{
-    [x: string]: unknown;
+    dist: string;
+    outfileName: string;
+    src: string;
+    snapLocation: string;
     sourceMaps: boolean;
     stripComments: boolean;
     transformHtmlComments: boolean;
     port: number;
-    dist: string;
-    src: string;
     eval: boolean;
-    outfileName: string;
     serve: boolean;
+    directory?: string | undefined;
     _?: (string | number)[] | undefined;
     $0?: string | undefined;
 }>;
-/**
- * This updates the Snap shasum value of the manifest after building the Snap
- * during the init command.
- */
-export declare function updateManifestShasum(): Promise<void>;

package/dist/cmds/init/initHandler.js

@@ -3,14 +3,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateManifestShasum = exports.initHandler = void 0;
-const fs_1 = require("fs");
+exports.initHandler = void 0;
 const path_1 = __importDefault(require("path"));
+const fs_1 = require("fs");
 const snap_utils_1 = require("@metamask/snap-utils");
-const mkdirp_1 = __importDefault(require("mkdirp"));
 const utils_1 = require("../../utils");
-const init_template_json_1 = __importDefault(require("./init-template.json"));
 const initUtils_1 = require("./initUtils");
+const SATISFIED_VERSION = '>=16';
 /**
  * Creates a new snap package, based on one of the provided templates. This
  * creates all the necessary files, like `package.json`, `snap.config.js`, etc.
@@ -22,99 +21,45 @@ const initUtils_1 = require("./initUtils");
  * @throws If initialization of the snap package failed.
  */
 async function initHandler(argv) {
-    console.log(`MetaMask Snaps: Initialize\n`);
-    const packageJson = await (0, initUtils_1.asyncPackageInit)(argv);
-    await (0, initUtils_1.prepareWorkingDirectory)();
-    console.log(`\nInit: Building '${snap_utils_1.NpmSnapFileNames.Manifest}'...\n`);
-    const [snapManifest, _newArgs] = await (0, initUtils_1.buildSnapManifest)(argv, packageJson);
-    const newArgs = Object.keys(_newArgs)
-        .sort()
-        .reduce((sorted, key) => {
-        sorted[key] = _newArgs[key];
-        return sorted;
-    }, {});
-    const isTypeScript = (0, initUtils_1.isTemplateTypescript)(argv.template);
-    try {
-        await fs_1.promises.writeFile(snap_utils_1.NpmSnapFileNames.Manifest, `${JSON.stringify(snapManifest, null, 2)}\n`);
-    }
-    catch (err) {
-        (0, utils_1.logError)(`Init Error: Failed to write '${snap_utils_1.NpmSnapFileNames.Manifest}'.`, err);
-        throw err;
+    const { directory } = argv;
+    const isVersionSupported = (0, snap_utils_1.satisfiesVersionRange)(process.version, SATISFIED_VERSION);
+    if (!isVersionSupported) {
+        (0, utils_1.logError)(`Init Error: You are using an outdated version of Node (${process.version}). Please update to Node ${SATISFIED_VERSION}.`);
+        throw new Error('Outdated node version.');
     }
-    console.log(`\nInit: Created '${snap_utils_1.NpmSnapFileNames.Manifest}'.`);
-    // Write main .js entry file
-    const { src } = newArgs;
-    try {
-        if (path_1.default.basename(src) !== src) {
-            await (0, mkdirp_1.default)(path_1.default.dirname(src));
-        }
-        await fs_1.promises.writeFile(src, isTypeScript ? init_template_json_1.default.typescriptSource : init_template_json_1.default.source);
-        console.log(`Init: Created '${src}'.`);
-    }
-    catch (err) {
-        (0, utils_1.logError)(`Init Error: Failed to write '${src}'.`, err);
-        throw err;
+    const gitExists = (0, initUtils_1.isGitInstalled)();
+    if (!gitExists) {
+        (0, utils_1.logError)(`Init Error: git is not installed. Please install git to continue.`);
+        throw new Error('Git is not installed.');
     }
-    // Write index.html
+    const directoryToUse = directory
+        ? path_1.default.join(process.cwd(), directory)
+        : process.cwd();
+    console.log(`Preparing ${directoryToUse}...`);
+    await (0, initUtils_1.prepareWorkingDirectory)(directoryToUse);
     try {
-        await fs_1.promises.writeFile('index.html', isTypeScript ? init_template_json_1.default.typescriptHtml : init_template_json_1.default.html);
-        console.log(`Init: Created 'index.html'.`);
+        console.log(`Cloning template...`);
+        await (0, initUtils_1.cloneTemplate)(directoryToUse);
+        fs_1.promises.rm(path_1.default.join(directoryToUse, '.git'), {
+            force: true,
+            recursive: true,
+        });
     }
     catch (err) {
-        (0, utils_1.logError)(`Init Error: Failed to write 'index.html'.`, err);
+        (0, utils_1.logError)('Init Error: Failed to create template, cleaning...');
         throw err;
     }
-    // Write tsconfig.json
-    if (isTypeScript) {
-        try {
-            await fs_1.promises.writeFile('tsconfig.json', init_template_json_1.default.typescriptConfig);
-            console.log(`Init: Created 'tsconfig.json'.`);
-        }
-        catch (err) {
-            (0, utils_1.logError)(`Init Error: Failed to write 'tsconfig.json'.`, err);
-            throw err;
-        }
-    }
-    // Write config file
-    try {
-        const defaultConfig = {
-            cliOptions: newArgs,
-        };
-        const defaultConfigFile = `module.exports = ${JSON.stringify(defaultConfig, null, 2)}
-    `;
-        await fs_1.promises.writeFile(utils_1.CONFIG_FILE, defaultConfigFile);
-        console.log(`Init: Wrote '${utils_1.CONFIG_FILE}' config file`);
+    console.log('Installing dependencies...');
+    await (0, initUtils_1.yarnInstall)(directoryToUse);
+    if (!(0, initUtils_1.isInGitRepository)(directoryToUse)) {
+        console.log('Initializing git repository...');
+        await (0, initUtils_1.gitInit)(directoryToUse);
     }
-    catch (err) {
-        (0, utils_1.logError)(`Init Error: Failed to write '${utils_1.CONFIG_FILE}'.`, err);
-        throw err;
-    }
-    // Write icon
-    const iconPath = 'images/icon.svg';
-    try {
-        if (path_1.default.basename(iconPath) !== iconPath) {
-            await (0, mkdirp_1.default)(path_1.default.dirname(iconPath));
-        }
-        await fs_1.promises.writeFile(iconPath, init_template_json_1.default.icon);
-        console.log(`Init: Created '${iconPath}'.`);
-    }
-    catch (err) {
-        (0, utils_1.logError)(`Init Error: Failed to write '${iconPath}'.`, err);
-        throw err;
-    }
-    (0, utils_1.closePrompt)();
-    return Object.assign(Object.assign({}, argv), newArgs);
+    const snapLocation = path_1.default.join(directoryToUse, initUtils_1.SNAP_LOCATION);
+    const manifest = await (0, snap_utils_1.readJsonFile)(path_1.default.join(snapLocation, snap_utils_1.NpmSnapFileNames.Manifest));
+    const packageJson = await (0, snap_utils_1.readJsonFile)(path_1.default.join(snapLocation, snap_utils_1.NpmSnapFileNames.PackageJson));
+    const distPath = manifest.source.location.npm.filePath.split('/');
+    return Object.assign(Object.assign({}, argv), { dist: distPath[0], outfileName: distPath[1], src: packageJson.main || 'src/index.js', snapLocation });
 }
 exports.initHandler = initHandler;
-/**
- * This updates the Snap shasum value of the manifest after building the Snap
- * during the init command.
- */
-async function updateManifestShasum() {
-    const manifest = await (0, snap_utils_1.readJsonFile)(snap_utils_1.NpmSnapFileNames.Manifest);
-    const bundleContents = await fs_1.promises.readFile(manifest.source.location.npm.filePath, 'utf8');
-    manifest.source.shasum = (0, snap_utils_1.getSnapSourceShasum)(bundleContents);
-    await fs_1.promises.writeFile(snap_utils_1.NpmSnapFileNames.Manifest, JSON.stringify((0, snap_utils_1.getWritableManifest)(manifest), null, 2));
-}
-exports.updateManifestShasum = updateManifestShasum;
 //# sourceMappingURL=initHandler.js.map

package/dist/cmds/init/initHandler.js.map

@@ -1 +1 @@
-{"version":3,"file":"initHandler.js","sourceRoot":"","sources":["../../../src/cmds/init/initHandler.ts"],"names":[],"mappings":";;;;;;AAAA,2BAAoC;AACpC,gDAA6B;AAC7B,qDAM8B;AAC9B,oDAA4B;AAE5B,uCAA6E;AAE7E,8EAA4C;AAC5C,2CAKqB;AAErB;;;;;;;;;GASG;AACI,KAAK,UAAU,WAAW,CAAC,IAAe;IAC/C,OAAO,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAC;IAE5C,MAAM,WAAW,GAAG,MAAM,IAAA,4BAAgB,EAAC,IAAI,CAAC,CAAC;IAEjD,MAAM,IAAA,mCAAuB,GAAE,CAAC;IAEhC,OAAO,CAAC,GAAG,CAAC,qBAAqB,6BAAgB,CAAC,QAAQ,QAAQ,CAAC,CAAC;IAEpE,MAAM,CAAC,YAAY,EAAE,QAAQ,CAAC,GAAG,MAAM,IAAA,6BAAiB,EAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAE5E,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;SAClC,IAAI,EAAE;SACN,MAAM,CAAC,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE;QACtB,MAAM,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,GAA4B,CAAC,CAAC;QACrD,OAAO,MAAM,CAAC;IAChB,CAAC,EAAE,EAAe,CAAC,CAAC;IAEtB,MAAM,YAAY,GAAG,IAAA,gCAAoB,EAAC,IAAI,CAAC,QAAwB,CAAC,CAAC;IACzE,IAAI;QACF,MAAM,aAAE,CAAC,SAAS,CAChB,6BAAgB,CAAC,QAAQ,EACzB,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAC7C,CAAC;KACH;IAAC,OAAO,GAAG,EAAE;QACZ,IAAA,gBAAQ,EACN,gCAAgC,6BAAgB,CAAC,QAAQ,IAAI,EAC7D,GAAG,CACJ,CAAC;QACF,MAAM,GAAG,CAAC;KACX;IAED,OAAO,CAAC,GAAG,CAAC,oBAAoB,6BAAgB,CAAC,QAAQ,IAAI,CAAC,CAAC;IAE/D,4BAA4B;IAC5B,MAAM,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;IAExB,IAAI;QACF,IAAI,cAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,GAAG,EAAE;YACnC,MAAM,IAAA,gBAAM,EAAC,cAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;SACtC;QAED,MAAM,aAAE,CAAC,SAAS,CAChB,GAAG,EACH,YAAY,CAAC,CAAC,CAAC,4BAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC,4BAAQ,CAAC,MAAM,CAC3D,CAAC;QAEF,OAAO,CAAC,GAAG,CAAC,kBAAkB,GAAG,IAAI,CAAC,CAAC;KACxC;IAAC,OAAO,GAAG,EAAE;QACZ,IAAA,gBAAQ,EAAC,gCAAgC,GAAG,IAAI,EAAE,GAAG,CAAC,CAAC;QACvD,MAAM,GAAG,CAAC;KACX;IAED,mBAAmB;IACnB,IAAI;QACF,MAAM,aAAE,CAAC,SAAS,CAChB,YAAY,EACZ,YAAY,CAAC,CAAC,CAAC,4BAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,4BAAQ,CAAC,IAAI,CACvD,CAAC;QAEF,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;KAC5C;IAAC,OAAO,GAAG,EAAE;QACZ,IAAA,gBAAQ,EAAC,2CAA2C,EAAE,GAAG,CAAC,CAAC;QAC3D,MAAM,GAAG,CAAC;KACX;IAED,sBAAsB;IACtB,IAAI,YAAY,EAAE;QAChB,IAAI;YACF,MAAM,aAAE,CAAC,SAAS,CAAC,eAAe,EAAE,4BAAQ,CAAC,gBAAgB,CAAC,CAAC;YAC/D,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAC;SAC/C;QAAC,OAAO,GAAG,EAAE;YACZ,IAAA,gBAAQ,EAAC,8CAA8C,EAAE,GAAG,CAAC,CAAC;YAC9D,MAAM,GAAG,CAAC;SACX;KACF;IAED,oBAAoB;IACpB,IAAI;QACF,MAAM,aAAa,GAAe;YAChC,UAAU,EAAE,OAAO;SACpB,CAAC;QACF,MAAM,iBAAiB,GAAG,oBAAoB,IAAI,CAAC,SAAS,CAC1D,aAAa,EACb,IAAI,EACJ,CAAC,CACF;KACA,CAAC;QACF,MAAM,aAAE,CAAC,SAAS,CAAC,mBAAW,EAAE,iBAAiB,CAAC,CAAC;QACnD,OAAO,CAAC,GAAG,CAAC,gBAAgB,mBAAW,eAAe,CAAC,CAAC;KACzD;IAAC,OAAO,GAAG,EAAE;QACZ,IAAA,gBAAQ,EAAC,gCAAgC,mBAAW,IAAI,EAAE,GAAG,CAAC,CAAC;QAC/D,MAAM,GAAG,CAAC;KACX;IAED,aAAa;IACb,MAAM,QAAQ,GAAG,iBAAiB,CAAC;IACnC,IAAI;QACF,IAAI,cAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,QAAQ,EAAE;YAC7C,MAAM,IAAA,gBAAM,EAAC,cAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;SAC3C;QACD,MAAM,aAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,4BAAQ,CAAC,IAAI,CAAC,CAAC;QAE5C,OAAO,CAAC,GAAG,CAAC,kBAAkB,QAAQ,IAAI,CAAC,CAAC;KAC7C;IAAC,OAAO,GAAG,EAAE;QACZ,IAAA,gBAAQ,EAAC,gCAAgC,QAAQ,IAAI,EAAE,GAAG,CAAC,CAAC;QAC5D,MAAM,GAAG,CAAC;KACX;IAED,IAAA,mBAAW,GAAE,CAAC;IACd,uCAAY,IAAI,GAAK,OAAO,EAAG;AACjC,CAAC;AA/GD,kCA+GC;AAED;;;GAGG;AACI,KAAK,UAAU,oBAAoB;IACxC,MAAM,QAAQ,GAAG,MAAM,IAAA,yBAAY,EAAe,6BAAgB,CAAC,QAAQ,CAAC,CAAC;IAE7E,MAAM,cAAc,GAAG,MAAM,aAAE,CAAC,QAAQ,CACtC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,EACrC,MAAM,CACP,CAAC;IAEF,QAAQ,CAAC,MAAM,CAAC,MAAM,GAAG,IAAA,gCAAmB,EAAC,cAAc,CAAC,CAAC;IAC7D,MAAM,aAAE,CAAC,SAAS,CAChB,6BAAgB,CAAC,QAAQ,EACzB,IAAI,CAAC,SAAS,CAAC,IAAA,gCAAmB,EAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CACvD,CAAC;AACJ,CAAC;AAbD,oDAaC","sourcesContent":["import { promises as fs } from 'fs';\nimport pathUtils from 'path';\nimport {\n  NpmSnapFileNames,\n  SnapManifest,\n  getSnapSourceShasum,\n  getWritableManifest,\n  readJsonFile,\n} from '@metamask/snap-utils';\nimport mkdirp from 'mkdirp';\nimport { YargsArgs } from '../../types/yargs';\nimport { closePrompt, CONFIG_FILE, logError, SnapConfig } from '../../utils';\nimport { TemplateType } from '../../builders';\nimport template from './init-template.json';\nimport {\n  asyncPackageInit,\n  buildSnapManifest,\n  isTemplateTypescript,\n  prepareWorkingDirectory,\n} from './initUtils';\n\n/**\n * Creates a new snap package, based on one of the provided templates. This\n * creates all the necessary files, like `package.json`, `snap.config.js`, etc.\n * to start developing a snap.\n *\n * @param argv - The Yargs arguments object.\n * @returns The Yargs arguments augmented with the new `dist`, `outfileName` and\n * `src` properties.\n * @throws If initialization of the snap package failed.\n */\nexport async function initHandler(argv: YargsArgs) {\n  console.log(`MetaMask Snaps: Initialize\\n`);\n\n  const packageJson = await asyncPackageInit(argv);\n\n  await prepareWorkingDirectory();\n\n  console.log(`\\nInit: Building '${NpmSnapFileNames.Manifest}'...\\n`);\n\n  const [snapManifest, _newArgs] = await buildSnapManifest(argv, packageJson);\n\n  const newArgs = Object.keys(_newArgs)\n    .sort()\n    .reduce((sorted, key) => {\n      sorted[key] = _newArgs[key as keyof typeof _newArgs];\n      return sorted;\n    }, {} as YargsArgs);\n\n  const isTypeScript = isTemplateTypescript(argv.template as TemplateType);\n  try {\n    await fs.writeFile(\n      NpmSnapFileNames.Manifest,\n      `${JSON.stringify(snapManifest, null, 2)}\\n`,\n    );\n  } catch (err) {\n    logError(\n      `Init Error: Failed to write '${NpmSnapFileNames.Manifest}'.`,\n      err,\n    );\n    throw err;\n  }\n\n  console.log(`\\nInit: Created '${NpmSnapFileNames.Manifest}'.`);\n\n  // Write main .js entry file\n  const { src } = newArgs;\n\n  try {\n    if (pathUtils.basename(src) !== src) {\n      await mkdirp(pathUtils.dirname(src));\n    }\n\n    await fs.writeFile(\n      src,\n      isTypeScript ? template.typescriptSource : template.source,\n    );\n\n    console.log(`Init: Created '${src}'.`);\n  } catch (err) {\n    logError(`Init Error: Failed to write '${src}'.`, err);\n    throw err;\n  }\n\n  // Write index.html\n  try {\n    await fs.writeFile(\n      'index.html',\n      isTypeScript ? template.typescriptHtml : template.html,\n    );\n\n    console.log(`Init: Created 'index.html'.`);\n  } catch (err) {\n    logError(`Init Error: Failed to write 'index.html'.`, err);\n    throw err;\n  }\n\n  // Write tsconfig.json\n  if (isTypeScript) {\n    try {\n      await fs.writeFile('tsconfig.json', template.typescriptConfig);\n      console.log(`Init: Created 'tsconfig.json'.`);\n    } catch (err) {\n      logError(`Init Error: Failed to write 'tsconfig.json'.`, err);\n      throw err;\n    }\n  }\n\n  // Write config file\n  try {\n    const defaultConfig: SnapConfig = {\n      cliOptions: newArgs,\n    };\n    const defaultConfigFile = `module.exports = ${JSON.stringify(\n      defaultConfig,\n      null,\n      2,\n    )}\n    `;\n    await fs.writeFile(CONFIG_FILE, defaultConfigFile);\n    console.log(`Init: Wrote '${CONFIG_FILE}' config file`);\n  } catch (err) {\n    logError(`Init Error: Failed to write '${CONFIG_FILE}'.`, err);\n    throw err;\n  }\n\n  // Write icon\n  const iconPath = 'images/icon.svg';\n  try {\n    if (pathUtils.basename(iconPath) !== iconPath) {\n      await mkdirp(pathUtils.dirname(iconPath));\n    }\n    await fs.writeFile(iconPath, template.icon);\n\n    console.log(`Init: Created '${iconPath}'.`);\n  } catch (err) {\n    logError(`Init Error: Failed to write '${iconPath}'.`, err);\n    throw err;\n  }\n\n  closePrompt();\n  return { ...argv, ...newArgs };\n}\n\n/**\n * This updates the Snap shasum value of the manifest after building the Snap\n * during the init command.\n */\nexport async function updateManifestShasum() {\n  const manifest = await readJsonFile<SnapManifest>(NpmSnapFileNames.Manifest);\n\n  const bundleContents = await fs.readFile(\n    manifest.source.location.npm.filePath,\n    'utf8',\n  );\n\n  manifest.source.shasum = getSnapSourceShasum(bundleContents);\n  await fs.writeFile(\n    NpmSnapFileNames.Manifest,\n    JSON.stringify(getWritableManifest(manifest), null, 2),\n  );\n}\n"]}
+{"version":3,"file":"initHandler.js","sourceRoot":"","sources":["../../../src/cmds/init/initHandler.ts"],"names":[],"mappings":";;;;;;AAAA,gDAA6B;AAC7B,2BAAoC;AACpC,qDAM8B;AAE9B,uCAAuC;AACvC,2CAQqB;AAErB,MAAM,iBAAiB,GAAG,MAAM,CAAC;AAEjC;;;;;;;;;GASG;AACI,KAAK,UAAU,WAAW,CAAC,IAAe;IAC/C,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;IAE3B,MAAM,kBAAkB,GAAG,IAAA,kCAAqB,EAC9C,OAAO,CAAC,OAAO,EACf,iBAAiB,CAClB,CAAC;IAEF,IAAI,CAAC,kBAAkB,EAAE;QACvB,IAAA,gBAAQ,EACN,0DAA0D,OAAO,CAAC,OAAO,4BAA4B,iBAAiB,GAAG,CAC1H,CAAC;QACF,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;KAC3C;IAED,MAAM,SAAS,GAAG,IAAA,0BAAc,GAAE,CAAC;IACnC,IAAI,CAAC,SAAS,EAAE;QACd,IAAA,gBAAQ,EACN,mEAAmE,CACpE,CAAC;QACF,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;KAC1C;IAED,MAAM,cAAc,GAAG,SAAS;QAC9B,CAAC,CAAC,cAAS,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,SAAS,CAAC;QAC1C,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;IAElB,OAAO,CAAC,GAAG,CAAC,aAAa,cAAc,KAAK,CAAC,CAAC;IAE9C,MAAM,IAAA,mCAAuB,EAAC,cAAc,CAAC,CAAC;IAE9C,IAAI;QACF,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;QACnC,MAAM,IAAA,yBAAa,EAAC,cAAc,CAAC,CAAC;QAEpC,aAAE,CAAC,EAAE,CAAC,cAAS,CAAC,IAAI,CAAC,cAAc,EAAE,MAAM,CAAC,EAAE;YAC5C,KAAK,EAAE,IAAI;YACX,SAAS,EAAE,IAAI;SAChB,CAAC,CAAC;KACJ;IAAC,OAAO,GAAG,EAAE;QACZ,IAAA,gBAAQ,EAAC,oDAAoD,CAAC,CAAC;QAC/D,MAAM,GAAG,CAAC;KACX;IAED,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;IAC1C,MAAM,IAAA,uBAAW,EAAC,cAAc,CAAC,CAAC;IAElC,IAAI,CAAC,IAAA,6BAAiB,EAAC,cAAc,CAAC,EAAE;QACtC,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAC;QAC9C,MAAM,IAAA,mBAAO,EAAC,cAAc,CAAC,CAAC;KAC/B;IAED,MAAM,YAAY,GAAG,cAAS,CAAC,IAAI,CAAC,cAAc,EAAE,yBAAa,CAAC,CAAC;IAEnE,MAAM,QAAQ,GAAiB,MAAM,IAAA,yBAAY,EAC/C,cAAS,CAAC,IAAI,CAAC,YAAY,EAAE,6BAAgB,CAAC,QAAQ,CAAC,CACxD,CAAC;IACF,MAAM,WAAW,GAAuB,MAAM,IAAA,yBAAY,EACxD,cAAS,CAAC,IAAI,CAAC,YAAY,EAAE,6BAAgB,CAAC,WAAW,CAAC,CAC3D,CAAC;IAEF,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAElE,uCACK,IAAI,KACP,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,EACjB,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC,EACxB,GAAG,EAAE,WAAW,CAAC,IAAI,IAAI,cAAc,EACvC,YAAY,IACZ;AACJ,CAAC;AAtED,kCAsEC","sourcesContent":["import pathUtils from 'path';\nimport { promises as fs } from 'fs';\nimport {\n  NpmSnapFileNames,\n  SnapManifest,\n  readJsonFile,\n  satisfiesVersionRange,\n  NpmSnapPackageJson,\n} from '@metamask/snap-utils';\nimport { YargsArgs } from '../../types/yargs';\nimport { logError } from '../../utils';\nimport {\n  cloneTemplate,\n  gitInit,\n  isGitInstalled,\n  isInGitRepository,\n  prepareWorkingDirectory,\n  SNAP_LOCATION,\n  yarnInstall,\n} from './initUtils';\n\nconst SATISFIED_VERSION = '>=16';\n\n/**\n * Creates a new snap package, based on one of the provided templates. This\n * creates all the necessary files, like `package.json`, `snap.config.js`, etc.\n * to start developing a snap.\n *\n * @param argv - The Yargs arguments object.\n * @returns The Yargs arguments augmented with the new `dist`, `outfileName` and\n * `src` properties.\n * @throws If initialization of the snap package failed.\n */\nexport async function initHandler(argv: YargsArgs) {\n  const { directory } = argv;\n\n  const isVersionSupported = satisfiesVersionRange(\n    process.version,\n    SATISFIED_VERSION,\n  );\n\n  if (!isVersionSupported) {\n    logError(\n      `Init Error: You are using an outdated version of Node (${process.version}). Please update to Node ${SATISFIED_VERSION}.`,\n    );\n    throw new Error('Outdated node version.');\n  }\n\n  const gitExists = isGitInstalled();\n  if (!gitExists) {\n    logError(\n      `Init Error: git is not installed. Please install git to continue.`,\n    );\n    throw new Error('Git is not installed.');\n  }\n\n  const directoryToUse = directory\n    ? pathUtils.join(process.cwd(), directory)\n    : process.cwd();\n\n  console.log(`Preparing ${directoryToUse}...`);\n\n  await prepareWorkingDirectory(directoryToUse);\n\n  try {\n    console.log(`Cloning template...`);\n    await cloneTemplate(directoryToUse);\n\n    fs.rm(pathUtils.join(directoryToUse, '.git'), {\n      force: true,\n      recursive: true,\n    });\n  } catch (err) {\n    logError('Init Error: Failed to create template, cleaning...');\n    throw err;\n  }\n\n  console.log('Installing dependencies...');\n  await yarnInstall(directoryToUse);\n\n  if (!isInGitRepository(directoryToUse)) {\n    console.log('Initializing git repository...');\n    await gitInit(directoryToUse);\n  }\n\n  const snapLocation = pathUtils.join(directoryToUse, SNAP_LOCATION);\n\n  const manifest: SnapManifest = await readJsonFile(\n    pathUtils.join(snapLocation, NpmSnapFileNames.Manifest),\n  );\n  const packageJson: NpmSnapPackageJson = await readJsonFile(\n    pathUtils.join(snapLocation, NpmSnapFileNames.PackageJson),\n  );\n\n  const distPath = manifest.source.location.npm.filePath.split('/');\n\n  return {\n    ...argv,\n    dist: distPath[0],\n    outfileName: distPath[1],\n    src: packageJson.main || 'src/index.js',\n    snapLocation,\n  };\n}\n"]}

package/dist/cmds/init/initUtils.d.ts

@@ -1,46 +1,39 @@
-import { SnapManifest, NpmSnapPackageJson } from '@metamask/snap-utils';
-import { Arguments } from 'yargs';
-import { YargsArgs } from '../../types/yargs';
-import { TemplateType } from '../../builders';
+export declare const TEMPLATE_GIT_URL = "https://github.com/MetaMask/template-snap-monorepo.git";
+export declare const SNAP_LOCATION = "packages/snap/";
 /**
- * Initializes a `package.json` file for a Snap project. Will attempt to read
- * and parse the existing file if it already exists, otherwise will intialize
- * a brand new one.
+ * Checks if the destination folder exists and if it's empty. Otherwise create it.
  *
- * @param argv - Yargs arguments object.
- * @returns The contents of the `package.json` file.
+ * @param directory - The desination folder.
  */
-export declare function asyncPackageInit(argv: YargsArgs): Promise<Readonly<NpmSnapPackageJson>>;
+export declare function prepareWorkingDirectory(directory: string): Promise<void>;
 /**
- * Interactively constructs a Snap manifest file by prompting the user.
+ * Clones the template in a directory.
  *
- * @param argv - The `yargs` `argv` object.
- * @param packageJson - The `package.json` object.
- * @returns A tuple of the resulting Snap manifest object and a new `argv`
- * object with properties to match the manifest.
+ * @param directory - The directory to clone the template in.
  */
-export declare function buildSnapManifest(argv: YargsArgs, packageJson: NpmSnapPackageJson): Promise<[SnapManifest, {
-    dist: string;
-    outfileName: string;
-    src: string;
-}]>;
+export declare function cloneTemplate(directory: string): Promise<void>;
 /**
- * Checks whether any files in the current working directory will be overwritten
- * by the initialization process, and asks the user whether to continue if so.
+ * Check if git is installed.
+ *
+ * @returns True if git is installed, or false otherwise.
+ */
+export declare function isGitInstalled(): boolean;
+/**
+ * Check if the actual working dir is a git repository.
+ *
+ * @param directory - The directory to check.
+ * @returns True if it's a git repository otherwise false.
  */
-export declare function prepareWorkingDirectory(): Promise<void>;
+export declare function isInGitRepository(directory: string): boolean;
 /**
- * In case when TypeScript version is used, default source file
- * will be updated if previous was not correct.
+ * Init a git repository.
  *
- * @param yargsArgv - The Yargs arguments object.
- * @returns Modified Yargs arguments object.
+ * @param directory - The directory to init.
  */
-export declare function correctDefaultArgs(yargsArgv: Arguments): Arguments;
+export declare function gitInit(directory: string): Promise<void>;
 /**
- * Check if template argument is TemplateType.TypeScript.
+ * Install dependencies in a yarn project.
  *
- * @param templateType - TemplateType value of the template argument passed from CLI.
- * @returns True or false.
+ * @param directory - The directory containing the project.
  */
-export declare function isTemplateTypescript(templateType: TemplateType): boolean;
+export declare function yarnInstall(directory: string): Promise<void>;