@graphprotocol/graph-cli 0.40.0 → 0.40.1-alpha-20230216174117-760a195

package/dist/commands/build.js

@@ -26,88 +26,32 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const chalk_1 = __importDefault(require("chalk"));
+const core_1 = require("@oclif/core");
+const gluegun_1 = require("gluegun");
 const compiler_1 = require("../command-helpers/compiler");
 const DataSourcesExtractor = __importStar(require("../command-helpers/data-sources"));
-const gluegun_1 = require("../command-helpers/gluegun");
 const network_1 = require("../command-helpers/network");
 const debug_1 = __importDefault(require("../debug"));
 const protocols_1 = __importDefault(require("../protocols"));
 const buildDebug = (0, debug_1.default)('graph-cli:build');
-const HELP = `
-${chalk_1.default.bold('graph build')} [options] ${chalk_1.default.bold('[<subgraph-manifest>]')}
-
-Options:
-
-  -h, --help                    Show usage information
-  -i, --ipfs <node>             Upload build results to an IPFS node
-  -o, --output-dir <path>       Output directory for build results (default: build/)
-  -t, --output-format <format>  Output format for mappings (wasm, wast) (default: wasm)
-      --skip-migrations         Skip subgraph migrations (default: false)
-  -w, --watch                   Regenerate types when subgraph files change (default: false)
-      --network <name>          Network configuration to use from the networks config file
-      --network-file <path>     Networks config file path (default: "./networks.json")
-`;
-exports.default = {
-    description: 'Builds a subgraph and (optionally) uploads it to IPFS',
-    run: async (toolbox) => {
-        // Obtain tools
-        const { filesystem, print } = toolbox;
-        // Parse CLI parameters
-        let { i, h, help, ipfs, o, outputDir, outputFormat, skipMigrations, t, w, watch, network, networkFile, } = toolbox.parameters.options;
-        // Support both short and long option variants
-        help || (help = h);
-        ipfs || (ipfs = i);
-        outputDir || (outputDir = o);
-        outputFormat || (outputFormat = t);
-        watch || (watch = w);
-        let manifest;
-        try {
-            [manifest] = (0, gluegun_1.fixParameters)(toolbox.parameters, {
-                h,
-                help,
-                w,
-                watch,
-            });
-        }
-        catch (e) {
-            print.error(e.message);
-            process.exitCode = 1;
-            return;
-        }
-        // Fall back to default values for options / parameters
-        outputFormat = outputFormat && ['wasm', 'wast'].includes(outputFormat) ? outputFormat : 'wasm';
-        outputDir = outputDir && outputDir !== '' ? outputDir : filesystem.path('build');
-        manifest =
-            manifest !== undefined && manifest !== '' ? manifest : filesystem.resolve('subgraph.yaml');
-        networkFile =
-            networkFile !== undefined && networkFile !== ''
-                ? networkFile
-                : filesystem.resolve('networks.json');
-        // Show help text if requested
-        if (help) {
-            print.info(HELP);
-            return;
-        }
+class BuildCommand extends core_1.Command {
+    async run() {
+        const { args: { 'subgraph-manifest': manifest }, flags: { ipfs, 'output-dir': outputDir, 'output-format': outputFormat, 'skip-migrations': skipMigrations, watch, network, 'network-file': networkFile, }, } = await this.parse(BuildCommand);
         let protocol;
         try {
             const dataSourcesAndTemplates = await DataSourcesExtractor.fromFilePath(manifest);
             protocol = protocols_1.default.fromDataSources(dataSourcesAndTemplates);
         }
         catch (e) {
-            print.error(e.message);
-            process.exitCode = 1;
-            return;
+            this.error(e, { exit: 1 });
         }
         buildDebug('Detected protocol "%s" (%o)', protocol.name, protocol);
-        if (network && filesystem.exists(networkFile) !== 'file') {
-            print.error(`Network file '${networkFile}' does not exists or is not a file!`);
-            process.exitCode = 1;
-            return;
+        if (network && gluegun_1.filesystem.exists(networkFile) !== 'file') {
+            this.error(`Network file '${networkFile}' does not exists or is not a file!`, { exit: 1 });
         }
         if (network) {
             const identifierName = protocol.getContract().identifierName();
-            await (0, network_1.updateSubgraphNetwork)(toolbox, manifest, network, networkFile, identifierName);
+            await (0, network_1.updateSubgraphNetwork)(manifest, network, networkFile, identifierName);
         }
         const compiler = (0, compiler_1.createCompiler)(manifest, {
             ipfs,
@@ -118,7 +62,7 @@ exports.default = {
         });
         // Exit with an error code if the compiler couldn't be created
         if (!compiler) {
-            process.exitCode = 1;
+            this.exit(1);
             return;
         }
         // Watch subgraph files for changes or additions, trigger
@@ -129,8 +73,47 @@ exports.default = {
         else {
             const result = await compiler.compile();
             if (result === false) {
-                process.exitCode = 1;
+                this.exit(1);
             }
         }
-    },
+    }
+}
+exports.default = BuildCommand;
+BuildCommand.description = 'Builds a subgraph and (optionally) uploads it to IPFS.';
+BuildCommand.args = {
+    'subgraph-manifest': core_1.Args.string({
+        default: 'subgraph.yaml',
+    }),
+};
+BuildCommand.flags = {
+    ipfs: core_1.Flags.string({
+        summary: 'Upload build results to an IPFS node.',
+        char: 'i',
+    }),
+    'output-dir': core_1.Flags.directory({
+        summary: 'Output directory for build results.',
+        char: 'o',
+        default: 'build/',
+    }),
+    'output-format': core_1.Flags.string({
+        summary: 'Output format for mappings.',
+        char: 't',
+        options: ['wasm', 'wast'],
+        default: 'wasm',
+    }),
+    'skip-migrations': core_1.Flags.boolean({
+        summary: 'Skip subgraph migrations.',
+    }),
+    watch: core_1.Flags.boolean({
+        summary: 'Regenerate types when subgraph files change.',
+        char: 'w',
+    }),
+    network: core_1.Flags.string({
+        summary: 'Network configuration to use from the networks config file.',
+    }),
+    // TODO: should be networksFile (with an "s"), or?
+    'network-file': core_1.Flags.file({
+        summary: 'Networks config file path.',
+        default: 'networks.json',
+    }),
 };

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: uncrashableConfig || 'uncrashable-config.yaml',
         });
         // Watch working directory for file updates or additions, trigger
         // type generation (if watch argument specified)
@@ -124,5 +70,37 @@ 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({
+        default: 'subgraph.yaml',
+    }),
+};
+CodegenCommand.flags = {
+    'output-dir': core_1.Flags.directory({
+        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.file({
+        summary: 'Directory for uncrashable config.',
+        aliases: ['uc'],
+        // TODO: using a default sets the value and therefore requires --uncrashable
+        // default: 'uncrashable-config.yaml',
+        dependsOn: ['uncrashable'],
+    }),
 };

package/dist/commands/create.js

@@ -1,59 +1,18 @@
 "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 create')} ${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: 'Registers 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
-        node || (node = g);
-        help || (help = h);
-        // 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 CreateCommand extends core_1.Command {
+    async run() {
+        const { args: { 'subgraph-name': subgraphName }, flags: { 'access-token': accessTokenFlag, node }, } = await this.parse(CreateCommand);
         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);
@@ -63,12 +22,12 @@ exports.default = {
             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(`Creating subgraph in Graph node: ${requestUrl}`);
         client.request('subgraph_create', { name: subgraphName }, (
         // @ts-expect-error TODO: why are the arguments not typed?
         requestError, 
@@ -78,17 +37,34 @@ exports.default = {
         // @ts-expect-error TODO: why are the arguments not typed?
         _res) => {
             if (jsonRpcError) {
-                spinner.fail(`Error creating the subgraph: ${jsonRpcError.message}`);
-                process.exitCode = 1;
+                core_1.ux.action.stop(`✖ Error creating the subgraph: ${jsonRpcError.message}`);
+                this.exit(1);
             }
             else if (requestError) {
-                spinner.fail(`HTTP error creating the subgraph: ${requestError.code}`);
-                process.exitCode = 1;
+                core_1.ux.action.stop(`✖ HTTP error creating the subgraph: ${requestError.code}`);
+                this.exit(1);
             }
             else {
-                spinner.stop();
-                print.success(`Created subgraph: ${subgraphName}`);
+                core_1.ux.action.stop('Subgraph created');
+                this.exit(1);
             }
         });
-    },
+    }
+}
+exports.default = CreateCommand;
+CreateCommand.description = 'Registers a subgraph name';
+CreateCommand.args = {
+    'subgraph-name': core_1.Args.string({
+        required: true,
+    }),
+};
+CreateCommand.flags = {
+    node: core_1.Flags.string({
+        summary: 'Graph node to create the subgraph in.',
+        char: 'g',
+        required: true,
+    }),
+    'access-token': core_1.Flags.string({
+        summary: 'Graph access token.',
+    }),
 };