@graphprotocol/graph-cli 0.38.0 → 0.38.1-alpha-20230208030436-e93ce80

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @graphprotocol/graph-cli
 
+## 0.38.1-alpha-20230208030436-e93ce80
+
+### Patch Changes
+
+- [#1055](https://github.com/graphprotocol/graph-tooling/pull/1055)
+  [`9932c57`](https://github.com/graphprotocol/graph-tooling/commit/9932c579a0a3f569fc61712ed2e3f2e1538f25ed)
+  Thanks [@enisdenjo](https://github.com/enisdenjo)! - dependencies updates:
+  - Added dependency [`@oclif/core@2.0.7` ↗︎](https://www.npmjs.com/package/@oclif/core/v/2.0.7) (to
+    `dependencies`)
+
 ## 0.38.0
 
 ### Minor Changes

package/dist/bin.js

@@ -1,6 +1,34 @@
 #!/usr/bin/env node
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-// run the CLI with the current process arguments
-const cli_1 = require("./cli");
-(0, cli_1.run)(process.argv);
+const oclif = __importStar(require("@oclif/core"));
+const flush_1 = __importDefault(require("@oclif/core/flush"));
+// @ts-expect-error Handle is a pure JS file
+const handle_1 = __importDefault(require("@oclif/core/handle"));
+oclif.run().then(flush_1.default).catch(handle_1.default);

package/dist/command-helpers/network.js

@@ -5,17 +5,20 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.updateNetworksFile = exports.initNetworksConfig = exports.updateSubgraphNetwork = void 0;
 const path_1 = __importDefault(require("path"));
+const gluegun_1 = require("gluegun");
 const yaml_1 = __importDefault(require("yaml"));
 const spinner_1 = require("./spinner");
-const updateSubgraphNetwork = async (toolbox, manifest, network, networksFile, identifierName) => await (0, spinner_1.withSpinner)(`Update sources network`, `Failed to update sources network`, `Warnings while updating sources network`, async (spinner) => {
+const updateSubgraphNetwork = async (manifest, network, networksFile, identifierName) => 
+// TODO: use useSpinner
+await (0, spinner_1.withSpinner)(`Update sources network`, `Failed to update sources network`, `Warnings while updating sources network`, async (spinner) => {
     (0, spinner_1.step)(spinner, `Reading networks config`);
-    const allNetworks = await toolbox.filesystem.read(networksFile, 'json');
+    const allNetworks = await gluegun_1.filesystem.read(networksFile, 'json');
     const networkConfig = allNetworks[network];
     // Exit if the network passed with --network does not exits in networks.json
     if (!networkConfig) {
         throw new Error(`Network '${network}' was not found in '${networksFile}'`);
     }
-    await toolbox.patching.update(manifest, content => {
+    await gluegun_1.patching.update(manifest, content => {
         const subgraph = yaml_1.default.parse(content);
         const networkSources = Object.keys(networkConfig);
         const subgraphSources = subgraph.dataSources.map((value) => value.name);
@@ -37,10 +40,12 @@ const updateSubgraphNetwork = async (toolbox, manifest, network, networksFile, i
         });
         // All data sources shoud be on the same network,
         // so we have to update the network of all templates too.
-        subgraph.templates && (subgraph.templates = subgraph.templates.map((template) => ({
-            ...template,
-            network,
-        })));
+        // eslint-disable-next-line -- prettier has problems with &&=
+        subgraph.templates &&
+            (subgraph.templates = subgraph.templates.map((template) => ({
+                ...template,
+                network,
+            })));
         const unsusedSources = networkSources.filter(x => !subgraphSources.includes(x));
         unsusedSources.forEach(source => {
             (0, spinner_1.step)(spinner, `dataSource '${source}' from '${networksFile}' not found in ${manifest}`);
@@ -51,8 +56,10 @@ const updateSubgraphNetwork = async (toolbox, manifest, network, networksFile, i
     });
 });
 exports.updateSubgraphNetwork = updateSubgraphNetwork;
-const initNetworksConfig = async (toolbox, directory, identifierName) => await (0, spinner_1.withSpinner)(`Initialize networks config`, `Failed to initialize networks config`, `Warnings while initializing networks config`, async () => {
-    const subgraphStr = toolbox.filesystem.read(path_1.default.join(directory, 'subgraph.yaml'));
+const initNetworksConfig = async (directory, identifierName) => 
+// TODO: use useSpinner
+await (0, spinner_1.withSpinner)(`Initialize networks config`, `Failed to initialize networks config`, `Warnings while initializing networks config`, async () => {
+    const subgraphStr = gluegun_1.filesystem.read(path_1.default.join(directory, 'subgraph.yaml'));
     const subgraph = yaml_1.default.parse(subgraphStr);
     const networks = subgraph.dataSources.reduce((acc, source) => Object.assign(acc, {
         [source.network]: {
@@ -62,7 +69,7 @@ const initNetworksConfig = async (toolbox, directory, identifierName) => await (
             },
         },
     }), {});
-    toolbox.filesystem.write(`${directory}/networks.json`, networks);
+    gluegun_1.filesystem.write(`${directory}/networks.json`, networks);
     return true;
 });
 exports.initNetworksConfig = initNetworksConfig;
@@ -76,8 +83,8 @@ function hasChanges(identifierName, network, networkConfig, dataSource) {
     const startBlockChanged = networkConfig.startBlock !== dataSource.source.startBlock;
     return networkChanged || addressChanged || startBlockChanged;
 }
-const updateNetworksFile = async (toolbox, network, dataSource, address, networksFile) => {
-    await toolbox.patching.update(networksFile, config => {
+async function updateNetworksFile(network, dataSource, address, networksFile) {
+    await gluegun_1.patching.update(networksFile, config => {
         if (Object.keys(config).includes(network)) {
             Object.assign(config[network], { [dataSource]: { address } });
         }
@@ -86,5 +93,5 @@ const updateNetworksFile = async (toolbox, network, dataSource, address, network
         }
         return config;
     });
-};
+}
 exports.updateNetworksFile = updateNetworksFile;

package/dist/command-helpers/network.test.js

@@ -33,7 +33,7 @@ const network_1 = require("./network");
 const SUBGRAPH_PATH_BASE = path_1.default.join(__dirname, '..', '..', '..', '..', 'examples', 'example-subgraph');
 describe('initNetworksConfig', () => {
     beforeAll(async () => {
-        await (0, network_1.initNetworksConfig)(toolbox, SUBGRAPH_PATH_BASE, 'address');
+        await (0, network_1.initNetworksConfig)(SUBGRAPH_PATH_BASE, 'address');
     });
     afterAll(async () => {
         toolbox.filesystem.remove(`${SUBGRAPH_PATH_BASE}/networks.json`);
@@ -75,7 +75,7 @@ describe('updateSubgraphNetwork', () => {
         let address = subgraphObj.dataSources[0].source.address;
         expect(network).toBe('mainnet');
         expect(address).toBe('0x22843e74c59580b3eaf6c233fa67d8b7c561a835');
-        await (0, network_1.updateSubgraphNetwork)(toolbox, manifest, 'optimism', networksFie, 'address');
+        await (0, network_1.updateSubgraphNetwork)(manifest, 'optimism', networksFie, 'address');
         subgraph = toolbox.filesystem.read(manifest);
         subgraphObj = yaml_1.default.parse(subgraph);
         network = subgraphObj.dataSources[0].network;

package/dist/command-helpers/spinner.js

@@ -23,8 +23,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.withSpinner = exports.step = void 0;
+exports.useSpinner = exports.withSpinner = exports.step = void 0;
 const toolbox = __importStar(require("gluegun"));
+const core_1 = require("@oclif/core");
 const step = (spinner, subject, text) => {
     if (text) {
         spinner.stopAndPersist({
@@ -47,6 +48,8 @@ exports.step = step;
 //   spinner stops with the warning message and returns the `result` value.
 // Otherwise the spinner prints the in-progress message with a check mark
 //   and simply returns the value returned by `f`.
+//
+// @deprecated
 const withSpinner = async (text, errorText, warningText, f) => {
     const spinner = toolbox.print.spin(text);
     try {
@@ -78,3 +81,36 @@ const withSpinner = async (text, errorText, warningText, f) => {
     }
 };
 exports.withSpinner = withSpinner;
+// Executes the function `f` while displaying a command-line spinner.
+async function useSpinner(text, errorText, warningText, f) {
+    const { action } = core_1.ux;
+    action.start(text);
+    try {
+        const result = await f(action);
+        if (result && typeof result === 'object') {
+            const hasError = 'error' in result;
+            const hasWarning = 'warning' in result;
+            const hasResult = 'result' in result;
+            if (hasError) {
+                action.stop(`✖ ${errorText}: ${result.error}`);
+                return (hasResult ? result.result : result);
+            }
+            if (hasWarning && hasResult) {
+                if (result.warning !== null) {
+                    action.stop(`⚠️ ${warningText}: ${result.warning}`);
+                }
+                action.stop('✔');
+                return result.result;
+            }
+            action.stop('✔');
+            return result;
+        }
+        action.stop('✔');
+        return result;
+    }
+    catch (e) {
+        action.stop(`✖ ${errorText}: ${e.message}`);
+        throw e;
+    }
+}
+exports.useSpinner = useSpinner;

package/dist/commands/add.js

@@ -26,61 +26,21 @@ 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 errors_1 = require("@oclif/core/lib/errors");
+const gluegun_1 = require("gluegun");
 const immutable_1 = __importDefault(require("immutable"));
 const abi_1 = require("../command-helpers/abi");
 const DataSourcesExtractor = __importStar(require("../command-helpers/data-sources"));
-const gluegun_1 = require("../command-helpers/gluegun");
 const network_1 = require("../command-helpers/network");
 const scaffold_1 = require("../command-helpers/scaffold");
 const spinner_1 = require("../command-helpers/spinner");
 const protocols_1 = __importDefault(require("../protocols"));
 const abi_2 = __importDefault(require("../protocols/ethereum/abi"));
 const subgraph_1 = __importDefault(require("../subgraph"));
-const HELP = `
-${chalk_1.default.bold('graph add')} <address> [<subgraph-manifest default: "./subgraph.yaml">]
-
-${chalk_1.default.dim('Options:')}
-
-      --abi <path>              Path to the contract ABI (default: download from Etherscan)
-      --contract-name           Name of the contract (default: Contract)
-      --merge-entities          Whether to merge entities with the same name (default: false)
-      --network-file <path>     Networks config file path (default: "./networks.json")
-  -h, --help                    Show usage information
-`;
-exports.default = {
-    description: 'Adds a new datasource to a subgraph',
-    run: async (toolbox) => {
-        // Obtain tools
-        const { print, system } = toolbox;
-        // Read CLI parameters
-        let { abi, contractName, h, help, mergeEntities, networkFile } = toolbox.parameters.options;
-        contractName || (contractName = 'Contract');
-        try {
-            (0, gluegun_1.fixParameters)(toolbox.parameters, {
-                h,
-                help,
-                mergeEntities,
-            });
-        }
-        catch (e) {
-            print.error(e.message);
-            process.exitCode = 1;
-            return;
-        }
-        const address = toolbox.parameters.first || toolbox.parameters.array?.[0];
-        const manifestPath = toolbox.parameters.second || toolbox.parameters.array?.[1] || './subgraph.yaml';
-        // Show help text if requested
-        if (help || h) {
-            print.info(HELP);
-            return;
-        }
-        // Validate the address
-        if (!address) {
-            print.error('No contract address provided');
-            process.exitCode = 1;
-            return;
-        }
+class AddCommand extends core_1.Command {
+    async run() {
+        const { args: { address, subgraphManifest: manifestPath }, flags: { abi, contractName, mergeEntities, networkFile: networksFile }, } = await this.parse(AddCommand);
         const dataSourcesAndTemplates = await DataSourcesExtractor.fromFilePath(manifestPath);
         const protocol = protocols_1.default.fromDataSources(dataSourcesAndTemplates);
         const manifest = await subgraph_1.default.load(manifestPath, { protocol });
@@ -89,9 +49,7 @@ exports.default = {
         const entities = getEntities(manifest);
         const contractNames = getContractNames(manifest);
         if (contractNames.includes(contractName)) {
-            print.error(`Datasource or template with name ${contractName} already exists, please choose a different name`);
-            process.exitCode = 1;
-            return;
+            this.error(`Datasource or template with name ${contractName} already exists, please choose a different name.`, { exit: 1 });
         }
         let ethabi = null;
         if (abi) {
@@ -103,7 +61,7 @@ exports.default = {
         else {
             ethabi = await (0, abi_1.loadAbiFromEtherscan)(abi_2.default, network, address);
         }
-        const { collisionEntities, onlyCollisions, abiData } = updateEventNamesOnCollision(toolbox, ethabi, entities, contractName, mergeEntities);
+        const { collisionEntities, onlyCollisions, abiData } = updateEventNamesOnCollision(ethabi, entities, contractName, mergeEntities);
         ethabi.data = abiData;
         await (0, scaffold_1.writeABI)(ethabi, contractName);
         await (0, scaffold_1.writeSchema)(ethabi, protocol, result.getIn(['schema', 'file']), collisionEntities);
@@ -124,20 +82,47 @@ exports.default = {
         result.set('dataSources', dataSources.push(dataSource));
         await subgraph_1.default.write(result, manifestPath);
         // Update networks.json
-        const networksFile = networkFile || './networks.json';
-        await (0, network_1.updateNetworksFile)(toolbox, network, contractName, address, networksFile);
+        await (0, network_1.updateNetworksFile)(network, contractName, address, networksFile);
         // Detect Yarn and/or NPM
-        const yarn = system.which('yarn');
-        const npm = system.which('npm');
+        const yarn = gluegun_1.system.which('yarn');
+        const npm = gluegun_1.system.which('npm');
         if (!yarn && !npm) {
-            print.error(`Neither Yarn nor NPM were found on your system. Please install one of them.`);
-            process.exitCode = 1;
-            return;
+            this.error('Neither Yarn nor NPM were found on your system. Please install one of them.', {
+                exit: 1,
+            });
         }
-        await (0, spinner_1.withSpinner)('Running codegen', 'Failed to run codegen', 'Warning during codegen', async () => {
-            await system.run(yarn ? 'yarn codegen' : 'npm run codegen');
-        });
-    },
+        await (0, spinner_1.useSpinner)('Running codegen', 'Failed to run codegen', 'Warning during codegen', () => gluegun_1.system.run(yarn ? 'yarn codegen' : 'npm run codegen'));
+    }
+}
+exports.default = AddCommand;
+AddCommand.description = 'Adds a new datasource to a subgraph.';
+AddCommand.args = {
+    address: core_1.Args.string({
+        description: 'The contract address',
+        required: true,
+    }),
+    subgraphManifest: core_1.Args.string({
+        default: 'subgraph.yaml',
+    }),
+};
+AddCommand.flags = {
+    abi: core_1.Flags.string({
+        summary: 'Path to the contract ABI.',
+        default: '*Download from Etherscan*',
+    }),
+    contractName: core_1.Flags.string({
+        summary: 'Name of the contract.',
+        default: 'Contract',
+    }),
+    mergeEntities: core_1.Flags.boolean({
+        summary: 'Whether to merge entities with the same name.',
+        default: false,
+    }),
+    // TODO: should be networksFile (with an "s"), or?
+    networkFile: core_1.Flags.string({
+        summary: 'Networks config file path.',
+        default: 'networks.json',
+    }),
 };
 const getEntities = (manifest) => {
     const dataSources = manifest.result.get('dataSources', immutable_1.default.List());
@@ -152,9 +137,8 @@ const getContractNames = (manifest) => {
     const templates = manifest.result.get('templates', immutable_1.default.List());
     return dataSources.concat(templates).map((dataSource) => dataSource.get('name'));
 };
-const updateEventNamesOnCollision = (toolbox, ethabi, entities, contractName, mergeEntities) => {
+const updateEventNamesOnCollision = (ethabi, entities, contractName, mergeEntities) => {
     let abiData = ethabi.data;
-    const { print } = toolbox;
     const collisionEntities = [];
     let onlyCollisions = true;
     for (let i = 0; i < abiData.size; i++) {
@@ -162,10 +146,7 @@ const updateEventNamesOnCollision = (toolbox, ethabi, entities, contractName, me
         if (dataRow.get('type') === 'event') {
             if (entities.includes(dataRow.get('name'))) {
                 if (entities.includes(`${contractName}${dataRow.get('name')}`)) {
-                    print.error(`Contract name ('${contractName}')
-            + event name ('${dataRow.get('name')}') entity already exists.`);
-                    process.exitCode = 1;
-                    break;
+                    throw new errors_1.CLIError(`Contract name ('${contractName}') + event name ('${dataRow.get('name')}') entity already exists.`, { exit: 1 });
                 }
                 if (mergeEntities) {
                     collisionEntities.push(dataRow.get('name'));

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.string({
+        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.string({
+        summary: 'Networks config file path.',
+        default: 'networks.json',
+    }),
 };

package/dist/commands/deploy.js

@@ -209,7 +209,7 @@ exports.default = {
         }
         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 isStudio = node.match(/studio/);
         const isHostedService = node.match(/thegraph.com/) && !isStudio;

package/dist/commands/init.js

@@ -26,11 +26,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.comm = void 0;
 const fs_1 = __importDefault(require("fs"));
 const os_1 = __importDefault(require("os"));
 const path_1 = __importDefault(require("path"));
+const core_1 = require("@oclif/core");
 const chalk_1 = __importDefault(require("chalk"));
-const graphCli = __importStar(require("../cli"));
 const abi_1 = require("../command-helpers/abi");
 const DataSourcesExtractor = __importStar(require("../command-helpers/data-sources"));
 const gluegun_1 = require("../command-helpers/gluegun");
@@ -44,10 +45,85 @@ const debug_1 = __importDefault(require("../debug"));
 const protocols_1 = __importDefault(require("../protocols"));
 const schema_1 = require("../scaffold/schema");
 const validation_1 = require("../validation");
+const add_1 = __importDefault(require("./add"));
 const protocolChoices = Array.from(protocols_1.default.availableProtocols().keys());
 const availableNetworks = protocols_1.default.availableNetworks();
 const DEFAULT_EXAMPLE_SUBGRAPH = 'ethereum/gravatar';
 const initDebug = (0, debug_1.default)('graph-cli:init');
+class InitCommand extends core_1.Command {
+    async run() {
+        const { flags } = await this.parse(InitCommand);
+        console.log(flags);
+    }
+}
+exports.default = InitCommand;
+InitCommand.args = {
+    subgraphName: core_1.Args.string({
+        required: true,
+    }),
+    directory: core_1.Args.string({
+        required: true,
+    }),
+};
+InitCommand.flags = {
+    protocol: core_1.Flags.string({
+        required: true,
+        options: protocolChoices,
+    }),
+    product: core_1.Flags.string({
+        summary: 'Selects the product for which to initialize.',
+        required: true,
+        options: ['subgraph-studio', 'hosted-service'],
+    }),
+    studio: core_1.Flags.boolean({
+        summary: 'Shortcut for "--product subgraph-studio".',
+        exclusive: ['product'],
+    }),
+    node: core_1.Flags.string({
+        summary: 'Graph node for which to initialize.',
+        char: 'g',
+        required: true,
+    }),
+    'allow-simple-name': core_1.Flags.boolean({
+        description: 'Use a subgraph name without a prefix.',
+        default: false,
+    }),
+    'from-contract': core_1.Flags.string({
+        helpGroup: 'Scaffold',
+        description: 'Creates a scaffold based on an existing contract.',
+        required: true,
+        exclusive: ['from-example'],
+    }),
+    'from-example': core_1.Flags.string({
+        helpGroup: 'Scaffold',
+        description: 'Creates a scaffold based on an example subgraph.',
+        default: 'Contract',
+        exclusive: ['from-contract'],
+    }),
+    'contract-name': core_1.Flags.string({
+        helpGroup: 'Scaffold from contract',
+        description: 'Name of the contract.',
+        required: true,
+        dependsOn: ['from-contract'],
+    }),
+    'index-events': core_1.Flags.boolean({
+        helpGroup: 'Scaffold from contract',
+        description: 'Index contract events as entities.',
+        dependsOn: ['from-contract'],
+    }),
+    'start-block': core_1.Flags.integer({
+        helpGroup: 'Scaffold from contract',
+        description: 'Block number to start indexing from.',
+        default: 0,
+        dependsOn: ['from-contract'],
+    }),
+    abi: core_1.Flags.string({
+        helpGroup: 'Ethereum',
+    }),
+    network: core_1.Flags.string({
+        helpGroup: 'Ethereum',
+    }),
+};
 const HELP = `
 ${chalk_1.default.bold('graph init')} [options] [subgraph-name] [directory]
 
@@ -102,7 +178,8 @@ const processInitForm = async (toolbox, { protocol, product, studio, node, abi,
             choices: protocolChoices,
             skip: protocolChoices.includes(protocol),
             result: (value) => {
-                protocol || (protocol = value);
+                // eslint-disable-next-line -- prettier has problems with ||=
+                protocol = protocol || value;
                 protocolInstance = new protocols_1.default(protocol);
                 return protocol;
             },
@@ -315,14 +392,15 @@ const loadAbiFromFile = (toolbox, ABI, filename) => {
         return ABI.load('Contract', filename);
     }
 };
-exports.default = {
+exports.comm = {
     description: 'Creates a new subgraph with basic scaffolding',
     run: async (toolbox) => {
         // Obtain tools
         const { print, system } = toolbox;
         // Read CLI parameters
         let { protocol, product, studio, node, g, abi, allowSimpleName, fromContract, contractName, fromExample, h, help, indexEvents, network, startBlock, } = toolbox.parameters.options;
-        node || (node = g);
+        // eslint-disable-next-line -- prettier has problems with ||=
+        node = node || g;
         ({ node, allowSimpleName } = (0, node_1.chooseNodeUrl)({
             product,
             studio,
@@ -606,7 +684,7 @@ const initSubgraphFromExample = async (toolbox, { fromExample, allowSimpleName,
         process.exitCode = 1;
         return;
     }
-    const networkConf = await (0, network_1.initNetworksConfig)(toolbox, directory, 'address');
+    const networkConf = await (0, network_1.initNetworksConfig)(directory, 'address');
     if (networkConf !== true) {
         process.exitCode = 1;
         return;
@@ -716,7 +794,7 @@ const initSubgraphFromContract = async (toolbox, { protocolInstance, allowSimple
     }
     if (protocolInstance.hasContract()) {
         const identifierName = protocolInstance.getContract().identifierName();
-        const networkConf = await (0, network_1.initNetworksConfig)(toolbox, directory, identifierName);
+        const networkConf = await (0, network_1.initNetworksConfig)(directory, identifierName);
         if (networkConf !== true) {
             process.exitCode = 1;
             return;
@@ -803,7 +881,7 @@ const addAnotherContract = async (toolbox, { protocolInstance, directory }) => {
                     commandLine.push('--abi', abi);
                 }
             }
-            await graphCli.run(commandLine);
+            await add_1.default.run(commandLine);
         }
         catch (e) {
             toolbox.print.error(e);

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.run = void 0;
+var core_1 = require("@oclif/core");
+Object.defineProperty(exports, "run", { enumerable: true, get: function () { return core_1.run; } });

package/oclif.manifest.json

@@ -0,0 +1,327 @@
+{
+  "version": "0.38.1-alpha-20230208030436-e93ce80",
+  "commands": {
+    "add": {
+      "id": "add",
+      "description": "Adds a new datasource to a subgraph.",
+      "strict": true,
+      "pluginName": "@graphprotocol/graph-cli",
+      "pluginAlias": "@graphprotocol/graph-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {
+        "abi": {
+          "name": "abi",
+          "type": "option",
+          "summary": "Path to the contract ABI.",
+          "multiple": false,
+          "default": "*Download from Etherscan*"
+        },
+        "contractName": {
+          "name": "contractName",
+          "type": "option",
+          "summary": "Name of the contract.",
+          "multiple": false,
+          "default": "Contract"
+        },
+        "mergeEntities": {
+          "name": "mergeEntities",
+          "type": "boolean",
+          "summary": "Whether to merge entities with the same name.",
+          "allowNo": false
+        },
+        "networkFile": {
+          "name": "networkFile",
+          "type": "option",
+          "summary": "Networks config file path.",
+          "multiple": false,
+          "default": "networks.json"
+        }
+      },
+      "args": {
+        "address": {
+          "name": "address",
+          "description": "The contract address",
+          "required": true
+        },
+        "subgraphManifest": {
+          "name": "subgraphManifest",
+          "default": "subgraph.yaml"
+        }
+      }
+    },
+    "auth": {
+      "id": "auth",
+      "description": "Sets the deploy key to use when deploying to a Graph node",
+      "pluginName": "@graphprotocol/graph-cli",
+      "pluginAlias": "@graphprotocol/graph-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {},
+      "args": {}
+    },
+    "build": {
+      "id": "build",
+      "description": "Builds a subgraph and (optionally) uploads it to IPFS.",
+      "strict": true,
+      "pluginName": "@graphprotocol/graph-cli",
+      "pluginAlias": "@graphprotocol/graph-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {
+        "ipfs": {
+          "name": "ipfs",
+          "type": "option",
+          "char": "i",
+          "summary": "Upload build results to an IPFS node.",
+          "multiple": false
+        },
+        "output-dir": {
+          "name": "output-dir",
+          "type": "option",
+          "char": "o",
+          "summary": "Output directory for build results.",
+          "multiple": false,
+          "default": "build/"
+        },
+        "output-format": {
+          "name": "output-format",
+          "type": "option",
+          "char": "t",
+          "summary": "Output format for mappings.",
+          "multiple": false,
+          "options": [
+            "wasm",
+            "wast"
+          ],
+          "default": "wasm"
+        },
+        "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
+        },
+        "network": {
+          "name": "network",
+          "type": "option",
+          "summary": "Network configuration to use from the networks config file.",
+          "multiple": false
+        },
+        "network-file": {
+          "name": "network-file",
+          "type": "option",
+          "summary": "Networks config file path.",
+          "multiple": false,
+          "default": "networks.json"
+        }
+      },
+      "args": {
+        "subgraph-manifest": {
+          "name": "subgraph-manifest",
+          "default": "subgraph.yaml"
+        }
+      }
+    },
+    "codegen": {
+      "id": "codegen",
+      "description": "Generates AssemblyScript types for a subgraph",
+      "pluginName": "@graphprotocol/graph-cli",
+      "pluginAlias": "@graphprotocol/graph-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {},
+      "args": {}
+    },
+    "create": {
+      "id": "create",
+      "description": "Registers a subgraph name",
+      "pluginName": "@graphprotocol/graph-cli",
+      "pluginAlias": "@graphprotocol/graph-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {},
+      "args": {}
+    },
+    "deploy": {
+      "id": "deploy",
+      "description": "Deploys the subgraph to a Graph node",
+      "pluginName": "@graphprotocol/graph-cli",
+      "pluginAlias": "@graphprotocol/graph-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {},
+      "args": {}
+    },
+    "init": {
+      "id": "init",
+      "strict": true,
+      "pluginName": "@graphprotocol/graph-cli",
+      "pluginAlias": "@graphprotocol/graph-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {
+        "protocol": {
+          "name": "protocol",
+          "type": "option",
+          "required": true,
+          "multiple": false,
+          "options": [
+            "arweave",
+            "ethereum",
+            "near",
+            "cosmos",
+            "substreams"
+          ]
+        },
+        "product": {
+          "name": "product",
+          "type": "option",
+          "summary": "Selects the product for which to initialize.",
+          "required": true,
+          "multiple": false,
+          "options": [
+            "subgraph-studio",
+            "hosted-service"
+          ]
+        },
+        "studio": {
+          "name": "studio",
+          "type": "boolean",
+          "summary": "Shortcut for \"--product subgraph-studio\".",
+          "allowNo": false,
+          "exclusive": [
+            "product"
+          ]
+        },
+        "node": {
+          "name": "node",
+          "type": "option",
+          "char": "g",
+          "summary": "Graph node for which to initialize.",
+          "required": true,
+          "multiple": false
+        },
+        "allow-simple-name": {
+          "name": "allow-simple-name",
+          "type": "boolean",
+          "description": "Use a subgraph name without a prefix.",
+          "allowNo": false
+        },
+        "from-contract": {
+          "name": "from-contract",
+          "type": "option",
+          "description": "Creates a scaffold based on an existing contract.",
+          "required": true,
+          "helpGroup": "Scaffold",
+          "multiple": false,
+          "exclusive": [
+            "from-example"
+          ]
+        },
+        "from-example": {
+          "name": "from-example",
+          "type": "option",
+          "description": "Creates a scaffold based on an example subgraph.",
+          "helpGroup": "Scaffold",
+          "multiple": false,
+          "exclusive": [
+            "from-contract"
+          ],
+          "default": "Contract"
+        },
+        "contract-name": {
+          "name": "contract-name",
+          "type": "option",
+          "description": "Name of the contract.",
+          "required": true,
+          "helpGroup": "Scaffold from contract",
+          "multiple": false,
+          "dependsOn": [
+            "from-contract"
+          ]
+        },
+        "index-events": {
+          "name": "index-events",
+          "type": "boolean",
+          "description": "Index contract events as entities.",
+          "helpGroup": "Scaffold from contract",
+          "allowNo": false,
+          "dependsOn": [
+            "from-contract"
+          ]
+        },
+        "start-block": {
+          "name": "start-block",
+          "type": "option",
+          "description": "Block number to start indexing from.",
+          "helpGroup": "Scaffold from contract",
+          "multiple": false,
+          "dependsOn": [
+            "from-contract"
+          ],
+          "default": 0
+        },
+        "abi": {
+          "name": "abi",
+          "type": "option",
+          "helpGroup": "Ethereum",
+          "multiple": false
+        },
+        "network": {
+          "name": "network",
+          "type": "option",
+          "helpGroup": "Ethereum",
+          "multiple": false
+        }
+      },
+      "args": {
+        "subgraphName": {
+          "name": "subgraphName",
+          "required": true
+        },
+        "directory": {
+          "name": "directory",
+          "required": true
+        }
+      }
+    },
+    "local": {
+      "id": "local",
+      "description": "Runs local tests against a Graph Node environment (using Ganache by default)",
+      "pluginName": "@graphprotocol/graph-cli",
+      "pluginAlias": "@graphprotocol/graph-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {},
+      "args": {}
+    },
+    "remove": {
+      "id": "remove",
+      "description": "Unregisters a subgraph name",
+      "pluginName": "@graphprotocol/graph-cli",
+      "pluginAlias": "@graphprotocol/graph-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {},
+      "args": {}
+    },
+    "test": {
+      "id": "test",
+      "description": "Runs rust binary for subgraph testing",
+      "pluginName": "@graphprotocol/graph-cli",
+      "pluginAlias": "@graphprotocol/graph-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {},
+      "args": {}
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphprotocol/graph-cli",
-  "version": "0.38.0",
+  "version": "0.38.1-alpha-20230208030436-e93ce80",
   "description": "CLI for building for and deploying to The Graph",
   "license": "(Apache-2.0 OR MIT)",
   "engines": {
@@ -9,14 +9,16 @@
   "bin": {
     "graph": "dist/bin.js"
   },
-  "main": "dist/cli.js",
+  "main": "dist/index.js",
   "files": [
     "CHANGELOG.md",
     "dist",
+    "oclif.manifest.json",
     "README.md"
   ],
   "dependencies": {
     "@float-capital/float-subgraph-uncrashable": "^0.0.0-alpha.4",
+    "@oclif/core": "2.0.7",
     "assemblyscript": "0.19.23",
     "binary-install-raw": "0.0.13",
     "chalk": "3.0.0",
@@ -52,6 +54,7 @@
     "@types/which": "^2.0.1",
     "copyfiles": "^2.4.1",
     "jest": "26.0.0",
+    "oclif": "3.6.1",
     "spawn-command": "0.0.2-1",
     "strip-ansi": "6.0.0",
     "tern": "0.24.3",
@@ -60,8 +63,12 @@
   "publishConfig": {
     "access": "public"
   },
+  "oclif": {
+    "bin": "graph",
+    "commands": "./dist/commands"
+  },
   "scripts": {
-    "build": "tsc -b tsconfig.build.json && copyfiles -u 1 src/**/*.graphql dist/ && chmod +x ./dist/bin.js",
+    "build": "tsc -b tsconfig.build.json && oclif manifest && copyfiles -u 1 src/**/*.graphql dist/ && chmod +x ./dist/bin.js",
     "test": "jest --verbose",
     "test:init": "jest tests/cli/init.test.ts --verbose",
     "test:validation": "jest tests/cli/validation.test.ts --verbose",

package/dist/cli.js

@@ -1,26 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.run = void 0;
-const path_1 = __importDefault(require("path"));
-const gluegun_1 = require("gluegun");
-const run = async (argv) => {
-    let builder = (0, gluegun_1.build)().brand('graph').src(__dirname);
-    const pluginDirs = [];
-    await Promise.all(['npm root -g', 'npm root', 'yarn global dir'].map(async (cmd) => {
-        try {
-            const dir = await gluegun_1.system.run(cmd, { trim: true });
-            pluginDirs.push(dir);
-        }
-        catch (_) {
-            // noop
-        }
-    }));
-    // Inject potential plugin directories
-    builder = pluginDirs.reduce((cli, dir) => cli.plugin(path_1.default.join(dir, '@graphprotocol', 'indexer-cli', 'dist')), builder);
-    const cli = builder.help().version().defaultCommand().create();
-    return await cli.run(argv);
-};
-exports.run = run;