@graphprotocol/graph-cli 0.38.1-alpha-20230208031159-e8f0545 → 0.38.1-alpha-20230208032550-ddc8362

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # @graphprotocol/graph-cli
 
-## 0.38.1-alpha-20230208031159-e8f0545
+## 0.38.1-alpha-20230208032550-ddc8362
 
 ### Patch Changes
 

package/dist/commands/codegen.js

@@ -27,69 +27,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const path_1 = __importDefault(require("path"));
-const chalk_1 = __importDefault(require("chalk"));
+const core_1 = require("@oclif/core");
 const DataSourcesExtractor = __importStar(require("../command-helpers/data-sources"));
-const gluegun_1 = require("../command-helpers/gluegun");
 const version_1 = require("../command-helpers/version");
 const debug_1 = __importDefault(require("../debug"));
 const protocols_1 = __importDefault(require("../protocols"));
 const type_generator_1 = __importDefault(require("../type-generator"));
-const HELP = `
-${chalk_1.default.bold('graph codegen')} [options] ${chalk_1.default.bold('[<subgraph-manifest>]')}
-Options:
-  -h, --help                    Show usage information
-  -o, --output-dir <path>       Output directory for generated types (default: generated/)
-  --skip-migrations         Skip subgraph migrations (default: false)
-  -w, --watch                   Regenerate types when subgraph files change (default: false)
-  -u, --uncrashable            Generate Float Subgraph Uncrashable helper file
-  -uc, --uncrashable-config <path>  Directory for uncrashable config (default: ./uncrashable-config.yaml)
-  `;
 const codegenDebug = (0, debug_1.default)('graph-cli:codegen');
-exports.default = {
-    description: 'Generates AssemblyScript types for a subgraph',
-    run: async (toolbox) => {
-        // Obtain tools
-        const { filesystem, print } = toolbox;
-        // Read CLI parameters
-        let { h, help, o, outputDir, skipMigrations, w, watch, u, uncrashable, uc, uncrashableConfig } = toolbox.parameters.options;
-        // Support both long and short option variants
-        help || (help = h);
-        outputDir || (outputDir = o);
-        watch || (watch = w);
-        uncrashable || (uncrashable = u);
-        let uncrashable_config = uncrashableConfig || uc;
-        let manifest;
-        try {
-            [manifest] = (0, gluegun_1.fixParameters)(toolbox.parameters, {
-                h,
-                help,
-                skipMigrations,
-                w,
-                watch,
-                u,
-                uncrashable,
-            });
-        }
-        catch (e) {
-            print.error(e.message);
-            process.exitCode = 1;
-            return;
-        }
+class CodegenCommand extends core_1.Command {
+    async run() {
+        const { args: { 'subgraph-manifest': manifest }, flags: { 'output-dir': outputDir, 'skip-migrations': skipMigrations, watch, uncrashable, 'uncrashable-config': uncrashableConfig, }, } = await this.parse(CodegenCommand);
         codegenDebug('Initialized codegen manifest: %o', manifest);
-        // Fall back to default values for options / parameters
-        outputDir =
-            outputDir !== undefined && outputDir !== '' ? outputDir : filesystem.path('generated');
-        manifest =
-            manifest !== undefined && manifest !== '' ? manifest : filesystem.resolve('subgraph.yaml');
-        uncrashable_config =
-            uncrashable_config !== undefined && uncrashable_config !== ''
-                ? uncrashable_config
-                : filesystem.resolve('uncrashable-config.yaml');
-        // Show help text if requested
-        if (help) {
-            print.info(HELP);
-            return;
-        }
         let protocol;
         try {
             // Checks to make sure codegen doesn't run against
@@ -104,9 +52,7 @@ exports.default = {
             protocol = protocols_1.default.fromDataSources(dataSourcesAndTemplates);
         }
         catch (e) {
-            print.error(e.message);
-            process.exitCode = 1;
-            return;
+            this.error(e, { exit: 1 });
         }
         const generator = new type_generator_1.default({
             subgraphManifest: manifest,
@@ -114,7 +60,7 @@ exports.default = {
             skipMigrations,
             protocol,
             uncrashable,
-            uncrashableConfig: uncrashable_config,
+            uncrashableConfig,
         });
         // Watch working directory for file updates or additions, trigger
         // type generation (if watch argument specified)
@@ -124,5 +70,36 @@ exports.default = {
         else if (!(await generator.generateTypes())) {
             process.exitCode = 1;
         }
-    },
+    }
+}
+exports.default = CodegenCommand;
+CodegenCommand.description = 'Generates AssemblyScript types for a subgraph.';
+CodegenCommand.args = {
+    'subgraph-manifest': core_1.Args.string({
+        required: true,
+    }),
+};
+CodegenCommand.flags = {
+    'output-dir': core_1.Flags.string({
+        summary: 'Output directory for generated types.',
+        char: 'o',
+        default: 'generated/',
+    }),
+    'skip-migrations': core_1.Flags.boolean({
+        summary: 'Skip subgraph migrations.',
+    }),
+    watch: core_1.Flags.boolean({
+        summary: 'Regenerate types when subgraph files change.',
+        char: 'w',
+    }),
+    uncrashable: core_1.Flags.boolean({
+        summary: 'Generate Float Subgraph Uncrashable helper file.',
+        char: 'u',
+    }),
+    'uncrashable-config': core_1.Flags.string({
+        summary: 'Directory for uncrashable config.',
+        aliases: ['uc'],
+        default: 'uncrashable-config.yaml',
+        dependsOn: ['uncrashable'],
+    }),
 };

package/dist/commands/create.js

@@ -45,7 +45,7 @@ class CreateCommand extends core_1.Command {
                 this.exit(1);
             }
             else {
-                core_1.ux.action.stop();
+                core_1.ux.action.stop('Subgraph created');
                 this.exit(1);
             }
         });

package/dist/commands/remove.js

@@ -1,74 +1,33 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 const url_1 = require("url");
-const chalk_1 = __importDefault(require("chalk"));
+const core_1 = require("@oclif/core");
 const auth_1 = require("../command-helpers/auth");
 const jsonrpc_1 = require("../command-helpers/jsonrpc");
 const node_1 = require("../command-helpers/node");
-const HELP = `
-${chalk_1.default.bold('graph remove')} ${chalk_1.default.dim('[options]')} ${chalk_1.default.bold('<subgraph-name>')}
-
-${chalk_1.default.dim('Options:')}
-
-      --access-token <token>    Graph access token
-  -h, --help                    Show usage information
-  -g, --node <url>              Graph node to create the subgraph in
-`;
-exports.default = {
-    description: 'Unregisters a subgraph name',
-    run: async (toolbox) => {
-        // Obtain tools
-        const { print } = toolbox;
-        // Read CLI parameters
-        let { accessToken, g, h, help, node } = toolbox.parameters.options;
-        const subgraphName = toolbox.parameters.first;
-        // Support both long and short option variants
-        help || (help = h);
-        node || (node = g);
-        // Show help text if requested
-        if (help) {
-            print.info(HELP);
-            return;
-        }
-        // Validate the subgraph name
-        if (!subgraphName) {
-            print.error('No subgraph name provided');
-            print.info(HELP);
-            process.exitCode = 1;
-            return;
-        }
-        // Validate node
-        if (!node) {
-            print.error(`No Graph node provided`);
-            print.info(HELP);
-            process.exitCode = 1;
-            return;
-        }
+class RemoveCommand extends core_1.Command {
+    async run() {
+        const { args: { 'subgraph-name': subgraphName }, flags: { 'access-token': accessTokenFlag, node }, } = await this.parse(RemoveCommand);
         try {
             (0, node_1.validateNodeUrl)(node);
         }
         catch (e) {
-            print.error(`Graph node "${node}" is invalid: ${e.message}`);
-            process.exitCode = 1;
-            return;
+            this.error(`Graph node "${node}" is invalid: ${e.message}`, { exit: 1 });
         }
         const requestUrl = new url_1.URL(node);
         const client = (0, jsonrpc_1.createJsonRpcClient)(requestUrl);
         // Exit with an error code if the client couldn't be created
         if (!client) {
-            process.exitCode = 1;
+            this.exit(1);
             return;
         }
         // Use the access token, if one is set
-        accessToken = await (0, auth_1.identifyDeployKey)(node, accessToken);
+        const accessToken = await (0, auth_1.identifyDeployKey)(node, accessTokenFlag);
         if (accessToken !== undefined && accessToken !== null) {
             // @ts-expect-error options property seems to exist
             client.options.headers = { Authorization: `Bearer ${accessToken}` };
         }
-        const spinner = print.spin(`Creating subgraph in Graph node: ${requestUrl}`);
+        core_1.ux.action.start(`Removing subgraph in Graph node: ${requestUrl}`);
         client.request('subgraph_remove', { name: subgraphName }, (
         // @ts-expect-error TODO: why are the arguments not typed?
         requestError, 
@@ -79,17 +38,34 @@ exports.default = {
         // @ts-expect-error TODO: why are the arguments not typed?
         _res) => {
             if (jsonRpcError) {
-                spinner.fail(`Error removing the subgraph: ${jsonRpcError.message}`);
-                process.exitCode = 1;
+                core_1.ux.action.stop(`✖ Error removed the subgraph: ${jsonRpcError.message}`);
+                this.exit(1);
             }
             else if (requestError) {
-                spinner.fail(`HTTP error removing the subgraph: ${requestError.code}`);
-                process.exitCode = 1;
+                core_1.ux.action.stop(`✖ HTTP error removed the subgraph: ${requestError.code}`);
+                this.exit(1);
             }
             else {
-                spinner.stop();
-                print.success(`Removed subgraph: ${subgraphName}`);
+                core_1.ux.action.stop('Subgraph removed');
+                this.exit(1);
             }
         });
-    },
+    }
+}
+exports.default = RemoveCommand;
+RemoveCommand.description = 'Unregisters a subgraph name';
+RemoveCommand.args = {
+    'subgraph-name': core_1.Args.string({
+        required: true,
+    }),
+};
+RemoveCommand.flags = {
+    node: core_1.Flags.string({
+        summary: 'Graph node to delete the subgraph from.',
+        char: 'g',
+        required: true,
+    }),
+    'access-token': core_1.Flags.string({
+        summary: 'Graph access token.',
+    }),
 };

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.38.1-alpha-20230208031159-e8f0545",
+  "version": "0.38.1-alpha-20230208032550-ddc8362",
   "commands": {
     "add": {
       "id": "add",
@@ -132,13 +132,61 @@
     },
     "codegen": {
       "id": "codegen",
-      "description": "Generates AssemblyScript types for a subgraph",
+      "description": "Generates AssemblyScript types for a subgraph.",
+      "strict": true,
       "pluginName": "@graphprotocol/graph-cli",
       "pluginAlias": "@graphprotocol/graph-cli",
       "pluginType": "core",
       "aliases": [],
-      "flags": {},
-      "args": {}
+      "flags": {
+        "output-dir": {
+          "name": "output-dir",
+          "type": "option",
+          "char": "o",
+          "summary": "Output directory for generated types.",
+          "multiple": false,
+          "default": "generated/"
+        },
+        "skip-migrations": {
+          "name": "skip-migrations",
+          "type": "boolean",
+          "summary": "Skip subgraph migrations.",
+          "allowNo": false
+        },
+        "watch": {
+          "name": "watch",
+          "type": "boolean",
+          "char": "w",
+          "summary": "Regenerate types when subgraph files change.",
+          "allowNo": false
+        },
+        "uncrashable": {
+          "name": "uncrashable",
+          "type": "boolean",
+          "char": "u",
+          "summary": "Generate Float Subgraph Uncrashable helper file.",
+          "allowNo": false
+        },
+        "uncrashable-config": {
+          "name": "uncrashable-config",
+          "type": "option",
+          "summary": "Directory for uncrashable config.",
+          "multiple": false,
+          "dependsOn": [
+            "uncrashable"
+          ],
+          "default": "uncrashable-config.yaml",
+          "aliases": [
+            "uc"
+          ]
+        }
+      },
+      "args": {
+        "subgraph-manifest": {
+          "name": "subgraph-manifest",
+          "required": true
+        }
+      }
     },
     "create": {
       "id": "create",
@@ -327,12 +375,33 @@
     "remove": {
       "id": "remove",
       "description": "Unregisters a subgraph name",
+      "strict": true,
       "pluginName": "@graphprotocol/graph-cli",
       "pluginAlias": "@graphprotocol/graph-cli",
       "pluginType": "core",
       "aliases": [],
-      "flags": {},
-      "args": {}
+      "flags": {
+        "node": {
+          "name": "node",
+          "type": "option",
+          "char": "g",
+          "summary": "Graph node to delete the subgraph from.",
+          "required": true,
+          "multiple": false
+        },
+        "access-token": {
+          "name": "access-token",
+          "type": "option",
+          "summary": "Graph access token.",
+          "multiple": false
+        }
+      },
+      "args": {
+        "subgraph-name": {
+          "name": "subgraph-name",
+          "required": true
+        }
+      }
     },
     "test": {
       "id": "test",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphprotocol/graph-cli",
-  "version": "0.38.1-alpha-20230208031159-e8f0545",
+  "version": "0.38.1-alpha-20230208032550-ddc8362",
   "description": "CLI for building for and deploying to The Graph",
   "license": "(Apache-2.0 OR MIT)",
   "engines": {