@graphprotocol/graph-cli 0.37.3-alpha-20230112170916-36bdc67 → 0.37.3-alpha-20230112190020-19838fd

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # @graphprotocol/graph-cli
 
-## 0.37.3-alpha-20230112170916-36bdc67
+## 0.37.3-alpha-20230112190020-19838fd
 
 ### Patch Changes
 

package/dist/command-helpers/gluegun.js

@@ -1,6 +1,4 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fixParameters = void 0;
 // Workaround for https://github.com/infinitered/gluegun/pull/464.
 //
 // There is currently no way in Gluegun to define command-line options
@@ -26,7 +24,8 @@ exports.fixParameters = void 0;
 // The `fixParameters` function checks if any of the provided boolean
 // options has a string value; if so, it pushes it to the front of the
 // parameters array and returns the result of that.
-//
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fixParameters = void 0;
 const fixParameters = (parameters, booleanOptions) => {
     let unexpectedStringOptions = Object.keys(booleanOptions)
         .filter(key => typeof booleanOptions[key] === 'string')

package/dist/command-helpers/jsonrpc.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createJsonRpcClient = void 0;
 const jayson_1 = __importDefault(require("jayson"));
 const gluegun_1 = require("gluegun");
-const createJsonRpcClient = (url) => {
+function createJsonRpcClient(url) {
     const params = {
         host: url.hostname,
         port: url.port,
@@ -25,5 +25,5 @@ const createJsonRpcClient = (url) => {
         gluegun_1.print.error('The Graph Node URL must be of the following format: http(s)://host[:port]/[path]');
         return null;
     }
-};
+}
 exports.createJsonRpcClient = createJsonRpcClient;

package/dist/commands/add.js

@@ -27,7 +27,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const chalk_1 = __importDefault(require("chalk"));
-const toolbox = __importStar(require("gluegun/toolbox"));
+const toolbox = __importStar(require("gluegun"));
 const immutable_1 = __importDefault(require("immutable"));
 const spinner_1 = require("../command-helpers/spinner");
 const subgraph_1 = __importDefault(require("../subgraph"));
@@ -55,7 +55,7 @@ exports.default = {
         // Obtain tools
         let { print, system } = toolbox;
         // Read CLI parameters
-        let { abi, contractName, h, help, mergeEntities, networkFile } = toolbox.parameters.options;
+        let { abi, contractName, h, help, mergeEntities, networkFile, } = toolbox.parameters.options;
         contractName = contractName || 'Contract';
         try {
             (0, gluegun_1.fixParameters)(toolbox.parameters, {
@@ -69,8 +69,8 @@ exports.default = {
             process.exitCode = 1;
             return;
         }
-        let address = toolbox.parameters.first || toolbox.parameters.array[0];
-        let manifestPath = toolbox.parameters.second || toolbox.parameters.array[1] || './subgraph.yaml';
+        let address = toolbox.parameters.first || toolbox.parameters.array?.[0];
+        let manifestPath = toolbox.parameters.second || toolbox.parameters.array?.[1] || './subgraph.yaml';
         // Show help text if requested
         if (help || h) {
             print.info(HELP);
@@ -85,7 +85,7 @@ exports.default = {
         const dataSourcesAndTemplates = await DataSourcesExtractor.fromFilePath(manifestPath);
         let protocol = protocols_1.default.fromDataSources(dataSourcesAndTemplates);
         let manifest = await subgraph_1.default.load(manifestPath, { protocol });
-        let network = manifest.result.get('dataSources').get(0).get('network');
+        let network = manifest.result.getIn(['dataSources', 0, 'network']);
         let result = manifest.result.asMutable();
         let entities = getEntities(manifest);
         let contractNames = getContractNames(manifest);
@@ -130,30 +130,30 @@ exports.default = {
         const networksFile = networkFile || './networks.json';
         await (0, network_1.updateNetworksFile)(toolbox, network, contractName, address, networksFile);
         // Detect Yarn and/or NPM
-        let yarn = await system.which('yarn');
-        let npm = await system.which('npm');
+        let yarn = system.which('yarn');
+        let npm = 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;
         }
-        await (0, spinner_1.withSpinner)('Running codegen', 'Failed to run codegen', 'Warning during codegen', async (spinner) => {
+        await (0, spinner_1.withSpinner)('Running codegen', 'Failed to run codegen', 'Warning during codegen', async () => {
             await system.run(yarn ? 'yarn codegen' : 'npm run codegen');
         });
     },
 };
-const getEntities = manifest => {
+const getEntities = (manifest) => {
     let dataSources = manifest.result.get('dataSources', immutable_1.default.List());
     let templates = manifest.result.get('templates', immutable_1.default.List());
     return dataSources
         .concat(templates)
-        .map(dataSource => dataSource.getIn(['mapping', 'entities']))
+        .map((dataSource) => dataSource.getIn(['mapping', 'entities']))
         .flatten();
 };
-const getContractNames = manifest => {
+const getContractNames = (manifest) => {
     let dataSources = manifest.result.get('dataSources', immutable_1.default.List());
     let templates = manifest.result.get('templates', immutable_1.default.List());
-    return dataSources.concat(templates).map(dataSource => dataSource.get('name'));
+    return dataSources.concat(templates).map((dataSource) => dataSource.get('name'));
 };
 const updateEventNamesOnCollision = (ethabi, entities, contractName, mergeEntities) => {
     let abiData = ethabi.data;
@@ -168,7 +168,7 @@ const updateEventNamesOnCollision = (ethabi, entities, contractName, mergeEntiti
                     print.error(`Contract name ('${contractName}')
             + event name ('${dataRow.get('name')}') entity already exists.`);
                     process.exitCode = 1;
-                    return;
+                    break;
                 }
                 if (mergeEntities) {
                     collisionEntities.push(dataRow.get('name'));

package/dist/commands/auth.js

@@ -48,9 +48,9 @@ exports.default = {
     description: 'Sets the deploy key to use when deploying to a Graph node',
     run: async (toolbox) => {
         // Obtain tools
-        let { filesystem, print, system } = toolbox;
+        const { print } = toolbox;
         // Read CLI parameters
-        let { product, studio, h, help } = toolbox.parameters.options;
+        const { product, studio, h, help } = toolbox.parameters.options;
         // Show help text if requested
         if (help || h) {
             print.info(HELP);

package/dist/commands/create.js

@@ -21,7 +21,7 @@ exports.default = {
     description: 'Registers a subgraph name',
     run: async (toolbox) => {
         // Obtain tools
-        let { filesystem, print, system } = toolbox;
+        const { print } = toolbox;
         // Read CLI parameters
         let { accessToken, g, h, help, node } = toolbox.parameters.options;
         let subgraphName = toolbox.parameters.first;
@@ -65,10 +65,15 @@ exports.default = {
         // Use the access token, if one is set
         accessToken = await (0, auth_1.identifyDeployKey)(node, accessToken);
         if (accessToken !== undefined && accessToken !== null) {
+            // @ts-expect-error options property seems to exist
             client.options.headers = { Authorization: `Bearer ${accessToken}` };
         }
         let spinner = print.spin(`Creating subgraph in Graph node: ${requestUrl}`);
-        client.request('subgraph_create', { name: subgraphName }, function (requestError, jsonRpcError, res) {
+        client.request('subgraph_create', { name: subgraphName }, function (
+        // @ts-expect-error TODO: why are the arguments not typed?
+        requestError, 
+        // @ts-expect-error TODO: why are the arguments not typed?
+        jsonRpcError) {
             if (jsonRpcError) {
                 spinner.fail(`Error creating the subgraph: ${jsonRpcError.message}`);
                 process.exitCode = 1;

package/dist/commands/test.js

@@ -29,8 +29,12 @@ exports.default = {
     description: 'Runs rust binary for subgraph testing',
     run: async (toolbox) => {
         // Read CLI parameters
-        let { c, coverage, d, docker, f, force, h, help, l, logs, r, recompile, v, version } = toolbox.parameters.options;
-        let opts = {};
+        let { c, coverage, d, docker, f, force, h, help, l, logs, r, recompile, v, version, } = toolbox.parameters.options;
+        const testsFolder = './tests';
+        let opts = {
+            testsFolder,
+            cachePath: path_1.default.join(testsFolder, '.latest.json'),
+        };
         // Support both long and short option variants
         opts.coverage = coverage || c;
         opts.docker = docker || d;
@@ -39,7 +43,6 @@ exports.default = {
         opts.logs = logs || l;
         opts.recompile = recompile || r;
         opts.version = version || v;
-        opts.testsFolder = './tests';
         // Fix if a boolean flag (e.g -c, --coverage) has an argument
         try {
             (0, gluegun_2.fixParameters)(toolbox.parameters, {
@@ -62,7 +65,7 @@ exports.default = {
             process.exitCode = 1;
             return;
         }
-        let datasource = toolbox.parameters.first || toolbox.parameters.array[0];
+        let datasource = toolbox.parameters.first || toolbox.parameters.array?.[0];
         // Show help text if requested
         if (opts.help) {
             gluegun_1.print.info(HELP);
@@ -85,7 +88,6 @@ exports.default = {
                 process.exit(1);
             }
         }
-        opts.cachePath = path_1.default.join(opts.testsFolder, '.latest.json');
         setVersionFromCache(opts);
         // Fetch the latest version tag if version is not specified with -v/--version or if the version is not cached
         if (opts.force || (!opts.version && !opts.latestVersion)) {
@@ -127,7 +129,8 @@ async function runBinary(datasource, opts) {
     let latestVersion = opts.latestVersion;
     let recompileOpt = opts.recompile;
     const platform = await getPlatform(logsOpt);
-    const url = `https://github.com/LimeChain/matchstick/releases/download/${versionOpt || latestVersion}/${platform}`;
+    const url = `https://github.com/LimeChain/matchstick/releases/download/${versionOpt ||
+        latestVersion}/${platform}`;
     if (logsOpt) {
         gluegun_1.print.info(`Download link: ${url}`);
     }
@@ -150,9 +153,10 @@ async function getPlatform(logsOpt) {
     const linuxInfo = type === 'Linux' ? await getLinuxInfo() : {};
     const linuxDistro = linuxInfo.name;
     const release = linuxInfo.version || os_1.default.release();
-    const majorVersion = parseInt(linuxInfo.version, 10) || semver_1.default.major(release);
+    const majorVersion = parseInt(linuxInfo.version || '', 10) || semver_1.default.major(release);
     if (logsOpt) {
-        gluegun_1.print.info(`OS type: ${linuxDistro || type}\nOS arch: ${arch}\nOS release: ${release}\nOS major version: ${majorVersion}\nCPU model: ${cpuCore.model}`);
+        gluegun_1.print.info(`OS type: ${linuxDistro ||
+            type}\nOS arch: ${arch}\nOS release: ${release}\nOS major version: ${majorVersion}\nCPU model: ${cpuCore.model}`);
     }
     if (arch === 'x64' || isAppleSilicon) {
         if (type === 'Darwin') {
@@ -206,9 +210,9 @@ async function runDocker(datasource, opts) {
     let recompileOpt = opts.recompile;
     // Remove binary-install-raw binaries, because docker has permission issues
     // when building the docker images
-    await gluegun_1.filesystem.remove('./node_modules/binary-install-raw/bin');
+    gluegun_1.filesystem.remove('./node_modules/binary-install-raw/bin');
     // Get current working directory
-    let current_folder = await gluegun_1.filesystem.cwd();
+    let current_folder = gluegun_1.filesystem.cwd();
     // Declate dockerfilePath with default location
     let dockerfilePath = path_1.default.join(opts.testsFolder || 'tests', '.docker/Dockerfile');
     // Check if the Dockerfil already exists
@@ -219,7 +223,7 @@ async function runDocker(datasource, opts) {
         await dockerfile(dockerfilePath, versionOpt, latestVersion);
     }
     // Run a command to check if matchstick image already exists
-    (0, child_process_1.exec)('docker images -q matchstick', (error, stdout, stderr) => {
+    (0, child_process_1.exec)('docker images -q matchstick', (_error, stdout, _stderr) => {
         // Collect all(if any) flags and options that have to be passed to the matchstick binary
         let testArgs = '';
         if (coverageOpt)
@@ -247,7 +251,7 @@ async function runDocker(datasource, opts) {
         // Use spawn() and {stdio: 'inherit'} so we can see the logs in real time.
         if (!dockerfileExists || stdout === '' || versionOpt || forceOpt) {
             if (stdout !== '') {
-                (0, child_process_1.exec)('docker image rm matchstick', (error, stdout, stderr) => {
+                (0, child_process_1.exec)('docker image rm matchstick', (_error, stdout, _stderr) => {
                     gluegun_1.print.info(chalk_1.default.bold(`Removing matchstick image\n${stdout}`));
                 });
             }
@@ -283,9 +287,9 @@ async function dockerfile(dockerfilePath, versionOpt, latestVersion) {
             }
         });
         // Write the Dockerfile
-        await gluegun_1.filesystem.write(dockerfilePath, content);
+        gluegun_1.filesystem.write(dockerfilePath, content);
         // Replaces the version placeholders
-        await gluegun_1.patching.replace(dockerfilePath, '<MATCHSTICK_VERSION>', versionOpt || latestVersion);
+        await gluegun_1.patching.replace(dockerfilePath, '<MATCHSTICK_VERSION>', versionOpt || latestVersion || 'unknown');
     }
     catch (error) {
         spinner.fail(`A problem occurred while generating the Dockerfile. Please attend to the errors below:\n ${error.message}`);

package/jest.config.js

@@ -49,10 +49,10 @@ module.exports = {
   // forceCoverageMatch: [],
 
   // A path to a module which exports an async function that is triggered once before all test suites
-  globalSetup: './tests/cli/globalSetup',
+  globalSetup: './tests/cli/globalSetup.ts',
 
   // A path to a module which exports an async function that is triggered once after all test suites
-  globalTeardown: './tests/cli/globalTeardown',
+  globalTeardown: './tests/cli/globalTeardown.ts',
 
   // A set of global variables that need to be available in all test environments
   // globals: {},
@@ -136,7 +136,7 @@ module.exports = {
   testMatch: ['**/?(*.)+(spec|test).(t|j)s?(x)'],
 
   // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
-  testPathIgnorePatterns: ['/src/commands/test.js', '/node_modules/', '/dist/'],
+  testPathIgnorePatterns: ['/src/commands/test.ts', '/node_modules/', '/dist/'],
 
   // The regexp pattern Jest uses to detect test files
   // testRegex: "",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphprotocol/graph-cli",
-  "version": "0.37.3-alpha-20230112170916-36bdc67",
+  "version": "0.37.3-alpha-20230112190020-19838fd",
   "license": "(Apache-2.0 OR MIT)",
   "description": "CLI for building for and deploying to The Graph",
   "main": "dist/cli.js",
@@ -55,9 +55,9 @@
   },
   "scripts": {
     "test": "jest --verbose",
-    "test:init": "jest tests/cli/init.test.js --verbose",
-    "test:validation": "jest tests/cli/validation.test.js --verbose",
+    "test:init": "jest tests/cli/init.test.ts --verbose",
+    "test:validation": "jest tests/cli/validation.test.ts --verbose",
     "type-check": "tsc --noEmit",
-    "build": "tsc --build && copyfiles -u 1 src/**/*.graphql dist/ && chmod +x ./dist/bin.js"
+    "build": "tsc -b tsconfig.build.json && copyfiles -u 1 src/**/*.graphql dist/ && chmod +x ./dist/bin.js"
   }
 }

package/src/command-helpers/gluegun.ts

@@ -23,8 +23,13 @@
 // The `fixParameters` function checks if any of the provided boolean
 // options has a string value; if so, it pushes it to the front of the
 // parameters array and returns the result of that.
-//
-export const fixParameters = (parameters: any, booleanOptions: any) => {
+
+import { GluegunParameters } from 'gluegun'
+
+export const fixParameters = (
+  parameters: GluegunParameters,
+  booleanOptions: Record<string, string>,
+) => {
   let unexpectedStringOptions = Object.keys(booleanOptions)
     .filter(key => typeof booleanOptions[key] === 'string')
     .map(key => ({ key, value: booleanOptions[key] }))
@@ -39,9 +44,9 @@ export const fixParameters = (parameters: any, booleanOptions: any) => {
     )
   } else if (unexpectedStringOptions.length == 1) {
     let params = parameters.array
-    params.unshift(unexpectedStringOptions[0].value)
-    return params
+    params!.unshift(unexpectedStringOptions[0].value)
+    return params!
   } else {
-    return parameters.array
+    return parameters.array!
   }
 }

package/src/command-helpers/jsonrpc.ts

@@ -1,7 +1,7 @@
 import jayson from 'jayson'
 import { print } from 'gluegun'
 
-const createJsonRpcClient = (url: URL) => {
+export function createJsonRpcClient(url: URL): jayson.Client | null {
   const params = {
     host: url.hostname,
     port: url.port,
@@ -24,5 +24,3 @@ const createJsonRpcClient = (url: URL) => {
     return null
   }
 }
-
-export { createJsonRpcClient }

package/src/command-helpers/node.ts

@@ -16,8 +16,8 @@ export function chooseNodeUrl({
 }: {
   product: string
   studio: string
-  node: string
-  allowSimpleName: boolean
+  node?: string
+  allowSimpleName?: boolean
 }) {
   if (node) {
     try {

package/src/commands/{add.js → add.ts}

@@ -1,5 +1,5 @@
 import chalk from 'chalk'
-import * as toolbox from 'gluegun/toolbox'
+import * as toolbox from 'gluegun'
 import immutable from 'immutable'
 import { withSpinner } from '../command-helpers/spinner'
 import Subgraph from '../subgraph'
@@ -29,15 +29,29 @@ ${chalk.dim('Options:')}
   -h, --help                    Show usage information
 `
 
+export interface AddOptions {
+  abi?: string
+  contractName?: string
+  mergeEntities?: boolean
+  networkFile?: string
+  help?: boolean
+}
+
 export default {
   description: 'Adds a new datasource to a subgraph',
-  run: async toolbox => {
+  run: async (toolbox: toolbox.GluegunToolbox) => {
     // Obtain tools
     let { print, system } = toolbox
 
     // Read CLI parameters
-    let { abi, contractName, h, help, mergeEntities, networkFile } =
-      toolbox.parameters.options
+    let {
+      abi,
+      contractName,
+      h,
+      help,
+      mergeEntities,
+      networkFile,
+    } = toolbox.parameters.options
 
     contractName = contractName || 'Contract'
 
@@ -53,9 +67,9 @@ export default {
       return
     }
 
-    let address = toolbox.parameters.first || toolbox.parameters.array[0]
+    let address = toolbox.parameters.first || toolbox.parameters.array?.[0]
     let manifestPath =
-      toolbox.parameters.second || toolbox.parameters.array[1] || './subgraph.yaml'
+      toolbox.parameters.second || toolbox.parameters.array?.[1] || './subgraph.yaml'
 
     // Show help text if requested
     if (help || h) {
@@ -73,7 +87,7 @@ export default {
     const dataSourcesAndTemplates = await DataSourcesExtractor.fromFilePath(manifestPath)
     let protocol = Protocol.fromDataSources(dataSourcesAndTemplates)
     let manifest = await Subgraph.load(manifestPath, { protocol })
-    let network = manifest.result.get('dataSources').get(0).get('network')
+    let network = manifest.result.getIn(['dataSources', 0, 'network']) as any
     let result = manifest.result.asMutable()
 
     let entities = getEntities(manifest)
@@ -109,7 +123,7 @@ export default {
     await writeSchema(
       ethabi,
       protocol,
-      result.getIn(['schema', 'file']),
+      result.getIn(['schema', 'file']) as any,
       collisionEntities,
     )
     await writeMapping(ethabi, protocol, contractName, collisionEntities)
@@ -127,7 +141,7 @@ export default {
     // Handle the collisions edge case by copying another data source yaml data
     if (mergeEntities && onlyCollisions) {
       let firstDataSource = dataSources.get(0)
-      let source = dataSource.get('source')
+      let source = dataSource.get('source') as any
       let mapping = firstDataSource.get('mapping').asMutable()
 
       // Save the address of the new data source
@@ -146,8 +160,8 @@ export default {
     await updateNetworksFile(toolbox, network, contractName, address, networksFile)
 
     // Detect Yarn and/or NPM
-    let yarn = await system.which('yarn')
-    let npm = await system.which('npm')
+    let yarn = system.which('yarn')
+    let npm = system.which('npm')
     if (!yarn && !npm) {
       print.error(
         `Neither Yarn nor NPM were found on your system. Please install one of them.`,
@@ -160,31 +174,36 @@ export default {
       'Running codegen',
       'Failed to run codegen',
       'Warning during codegen',
-      async spinner => {
+      async () => {
         await system.run(yarn ? 'yarn codegen' : 'npm run codegen')
       },
     )
   },
 }
 
-const getEntities = manifest => {
+const getEntities = (manifest: any) => {
   let dataSources = manifest.result.get('dataSources', immutable.List())
   let templates = manifest.result.get('templates', immutable.List())
 
   return dataSources
     .concat(templates)
-    .map(dataSource => dataSource.getIn(['mapping', 'entities']))
+    .map((dataSource: any) => dataSource.getIn(['mapping', 'entities']))
     .flatten()
 }
 
-const getContractNames = manifest => {
+const getContractNames = (manifest: any) => {
   let dataSources = manifest.result.get('dataSources', immutable.List())
   let templates = manifest.result.get('templates', immutable.List())
 
-  return dataSources.concat(templates).map(dataSource => dataSource.get('name'))
+  return dataSources.concat(templates).map((dataSource: any) => dataSource.get('name'))
 }
 
-const updateEventNamesOnCollision = (ethabi, entities, contractName, mergeEntities) => {
+const updateEventNamesOnCollision = (
+  ethabi: any,
+  entities: any,
+  contractName: string,
+  mergeEntities: boolean,
+) => {
   let abiData = ethabi.data
   let { print } = toolbox
   let collisionEntities = []
@@ -199,7 +218,7 @@ const updateEventNamesOnCollision = (ethabi, entities, contractName, mergeEntiti
           print.error(`Contract name ('${contractName}')
             + event name ('${dataRow.get('name')}') entity already exists.`)
           process.exitCode = 1
-          return
+          break
         }
 
         if (mergeEntities) {

package/src/commands/{auth.js → auth.ts}

@@ -1,4 +1,5 @@
 import chalk from 'chalk'
+import { GluegunToolbox } from 'gluegun'
 import { saveDeployKey } from '../command-helpers/auth'
 import { chooseNodeUrl } from '../command-helpers/node'
 import { fixParameters } from '../command-helpers/gluegun'
@@ -16,7 +17,19 @@ ${chalk.dim('Options:')}
   -h, --help                    Show usage information
 `
 
-const processForm = async (toolbox, { product, studio, node, deployKey }) => {
+export interface AuthOptions {
+  product?: 'subgraph-studio' | 'hosted-service'
+  studio?: string
+  help?: boolean
+  // not a cli arg
+  node?: string
+  deployKey?: string
+}
+
+const processForm = async (
+  toolbox: GluegunToolbox,
+  { product, studio, node, deployKey }: AuthOptions,
+) => {
   const questions = [
     {
       type: 'select',
@@ -47,12 +60,12 @@ const processForm = async (toolbox, { product, studio, node, deployKey }) => {
 
 export default {
   description: 'Sets the deploy key to use when deploying to a Graph node',
-  run: async toolbox => {
+  run: async (toolbox: GluegunToolbox) => {
     // Obtain tools
-    let { filesystem, print, system } = toolbox
+    const { print } = toolbox
 
     // Read CLI parameters
-    let { product, studio, h, help } = toolbox.parameters.options
+    const { product, studio, h, help } = toolbox.parameters.options
 
     // Show help text if requested
     if (help || h) {
@@ -60,7 +73,7 @@ export default {
       return
     }
 
-    let firstParam, secondParam
+    let firstParam: string, secondParam: string
     try {
       ;[firstParam, secondParam] = fixParameters(toolbox.parameters, {
         h,
@@ -74,7 +87,7 @@ export default {
     }
 
     // if user specifies --product or --studio then deployKey is the first parameter
-    let node
+    let node: string | undefined
     let deployKey
     if (product || studio) {
       ;({ node } = chooseNodeUrl({ product, studio, node }))
@@ -119,7 +132,7 @@ export default {
     }
 
     try {
-      await saveDeployKey(node, deployKey)
+      await saveDeployKey(node!, deployKey)
       print.success(`Deploy key set for ${node}`)
     } catch (e) {
       print.error(e)

package/src/commands/binary-install-raw.d.ts

@@ -0,0 +1 @@
+declare module 'binary-install-raw'

package/src/commands/{create.js → create.ts}

@@ -1,5 +1,6 @@
 import { URL } from 'url'
 import chalk from 'chalk'
+import * as toolbox from 'gluegun'
 import { validateNodeUrl } from '../command-helpers/node'
 import { identifyDeployKey as identifyAccessToken } from '../command-helpers/auth'
 import { createJsonRpcClient } from '../command-helpers/jsonrpc'
@@ -14,11 +15,17 @@ ${chalk.dim('Options:')}
   -g, --node <url>              Graph node to create the subgraph in
 `
 
+export interface AddOptions {
+  accessToken?: string
+  help?: boolean
+  node?: string
+}
+
 export default {
   description: 'Registers a subgraph name',
-  run: async toolbox => {
+  run: async (toolbox: toolbox.GluegunToolbox) => {
     // Obtain tools
-    let { filesystem, print, system } = toolbox
+    const { print } = toolbox
 
     // Read CLI parameters
     let { accessToken, g, h, help, node } = toolbox.parameters.options
@@ -69,25 +76,27 @@ export default {
     // Use the access token, if one is set
     accessToken = await identifyAccessToken(node, accessToken)
     if (accessToken !== undefined && accessToken !== null) {
+      // @ts-expect-error options property seems to exist
       client.options.headers = { Authorization: `Bearer ${accessToken}` }
     }
 
     let spinner = print.spin(`Creating subgraph in Graph node: ${requestUrl}`)
-    client.request(
-      'subgraph_create',
-      { name: subgraphName },
-      function (requestError, jsonRpcError, res) {
-        if (jsonRpcError) {
-          spinner.fail(`Error creating the subgraph: ${jsonRpcError.message}`)
-          process.exitCode = 1
-        } else if (requestError) {
-          spinner.fail(`HTTP error creating the subgraph: ${requestError.code}`)
-          process.exitCode = 1
-        } else {
-          spinner.stop()
-          print.success(`Created subgraph: ${subgraphName}`)
-        }
-      },
-    )
+    client.request('subgraph_create', { name: subgraphName }, function(
+      // @ts-expect-error TODO: why are the arguments not typed?
+      requestError,
+      // @ts-expect-error TODO: why are the arguments not typed?
+      jsonRpcError,
+    ) {
+      if (jsonRpcError) {
+        spinner.fail(`Error creating the subgraph: ${jsonRpcError.message}`)
+        process.exitCode = 1
+      } else if (requestError) {
+        spinner.fail(`HTTP error creating the subgraph: ${requestError.code}`)
+        process.exitCode = 1
+      } else {
+        spinner.stop()
+        print.success(`Created subgraph: ${subgraphName}`)
+      }
+    })
   },
 }

package/src/commands/{test.js → test.ts}

@@ -2,7 +2,7 @@ import { Binary } from 'binary-install-raw'
 import os from 'os'
 import chalk from 'chalk'
 import fetch from 'node-fetch'
-import { filesystem, patching, print, system } from 'gluegun'
+import { filesystem, GluegunToolbox, patching, print, system } from 'gluegun'
 import { fixParameters } from '../command-helpers/gluegun'
 import path from 'path'
 import semver from 'semver'
@@ -22,14 +22,46 @@ ${chalk.dim('Options:')}
   -v, --version <tag>           Choose the version of the rust binary that you want to be downloaded/used
   `
 
+export interface TestOptions {
+  coverage?: boolean
+  docker?: boolean
+  force?: boolean
+  help?: boolean
+  logs?: boolean
+  recompile?: boolean
+  version?: string
+  // not a cli arg
+  testsFolder: string
+  cachePath: string
+  latestVersion?: string
+}
+
 export default {
   description: 'Runs rust binary for subgraph testing',
-  run: async toolbox => {
+  run: async (toolbox: GluegunToolbox) => {
     // Read CLI parameters
-    let { c, coverage, d, docker, f, force, h, help, l, logs, r, recompile, v, version } =
-      toolbox.parameters.options
-
-    let opts = {}
+    let {
+      c,
+      coverage,
+      d,
+      docker,
+      f,
+      force,
+      h,
+      help,
+      l,
+      logs,
+      r,
+      recompile,
+      v,
+      version,
+    } = toolbox.parameters.options
+
+    const testsFolder = './tests'
+    let opts: TestOptions = {
+      testsFolder,
+      cachePath: path.join(testsFolder, '.latest.json'),
+    }
     // Support both long and short option variants
     opts.coverage = coverage || c
     opts.docker = docker || d
@@ -38,7 +70,6 @@ export default {
     opts.logs = logs || l
     opts.recompile = recompile || r
     opts.version = version || v
-    opts.testsFolder = './tests'
     // Fix if a boolean flag (e.g -c, --coverage) has an argument
     try {
       fixParameters(toolbox.parameters, {
@@ -61,7 +92,7 @@ export default {
       return
     }
 
-    let datasource = toolbox.parameters.first || toolbox.parameters.array[0]
+    let datasource = toolbox.parameters.first || toolbox.parameters.array?.[0]
     // Show help text if requested
     if (opts.help) {
       print.info(HELP)
@@ -72,7 +103,7 @@ export default {
     if (filesystem.exists('matchstick.yaml')) {
       try {
         // Load the config
-        let config = await yaml.load(filesystem.read('matchstick.yaml', 'utf8'))
+        let config = await yaml.load(filesystem.read('matchstick.yaml', 'utf8')!)
 
         // Check if matchstick.yaml and testsFolder not null
         if (config && config.testsFolder) {
@@ -88,7 +119,6 @@ export default {
       }
     }
 
-    opts.cachePath = path.join(opts.testsFolder, '.latest.json')
     setVersionFromCache(opts)
 
     // Fetch the latest version tag if version is not specified with -v/--version or if the version is not cached
@@ -116,7 +146,7 @@ export default {
   },
 }
 
-async function setVersionFromCache(opts) {
+async function setVersionFromCache(opts: TestOptions) {
   if (filesystem.exists(opts.cachePath) == 'file') {
     let cached = filesystem.read(opts.cachePath, 'json')
     // Get the cache age in days
@@ -128,7 +158,7 @@ async function setVersionFromCache(opts) {
   }
 }
 
-async function runBinary(datasource, opts) {
+async function runBinary(datasource: string | undefined, opts: TestOptions) {
   let coverageOpt = opts.coverage
   let forceOpt = opts.force
   let logsOpt = opts.logs
@@ -138,9 +168,8 @@ async function runBinary(datasource, opts) {
 
   const platform = await getPlatform(logsOpt)
 
-  const url = `https://github.com/LimeChain/matchstick/releases/download/${
-    versionOpt || latestVersion
-  }/${platform}`
+  const url = `https://github.com/LimeChain/matchstick/releases/download/${versionOpt ||
+    latestVersion}/${platform}`
 
   if (logsOpt) {
     print.info(`Download link: ${url}`)
@@ -156,7 +185,7 @@ async function runBinary(datasource, opts) {
   args.length > 0 ? binary.run(...args) : binary.run()
 }
 
-async function getPlatform(logsOpt) {
+async function getPlatform(logsOpt: boolean | undefined) {
   const type = os.type()
   const arch = os.arch()
   const cpuCore = os.cpus()[0]
@@ -164,13 +193,12 @@ async function getPlatform(logsOpt) {
   const linuxInfo = type === 'Linux' ? await getLinuxInfo() : {}
   const linuxDistro = linuxInfo.name
   const release = linuxInfo.version || os.release()
-  const majorVersion = parseInt(linuxInfo.version, 10) || semver.major(release)
+  const majorVersion = parseInt(linuxInfo.version || '', 10) || semver.major(release)
 
   if (logsOpt) {
     print.info(
-      `OS type: ${
-        linuxDistro || type
-      }\nOS arch: ${arch}\nOS release: ${release}\nOS major version: ${majorVersion}\nCPU model: ${
+      `OS type: ${linuxDistro ||
+        type}\nOS arch: ${arch}\nOS release: ${release}\nOS major version: ${majorVersion}\nCPU model: ${
         cpuCore.model
       }`,
     )
@@ -199,7 +227,21 @@ async function getPlatform(logsOpt) {
   throw new Error(`Unsupported platform: ${type} ${arch} ${majorVersion}`)
 }
 
-async function getLinuxInfo() {
+/**
+ * The result of running `cat /etc/*-release | grep -E '(^VERSION|^NAME)='`
+ *
+ * May look like this:
+ * ```sh
+ * NAME="Ubuntu"
+ * VERSION="16.04.7 LTS (Xenial Xerus)"
+ * ```
+ */
+interface LinuxInfo {
+  name?: string
+  version?: string
+}
+
+async function getLinuxInfo(): Promise<LinuxInfo> {
   try {
     let result = await system.run("cat /etc/*-release | grep -E '(^VERSION|^NAME)='", {
       trim: true,
@@ -208,10 +250,10 @@ async function getLinuxInfo() {
       .replace(/['"]+/g, '')
       .split('\n')
       .map(p => p.split('='))
-    let linuxInfo = {}
+    let linuxInfo: LinuxInfo = {}
 
     infoArray.forEach(val => {
-      linuxInfo[val[0].toLowerCase()] = val[1]
+      linuxInfo[val[0].toLowerCase() as keyof LinuxInfo] = val[1]
     })
 
     return linuxInfo
@@ -221,7 +263,7 @@ async function getLinuxInfo() {
   }
 }
 
-async function runDocker(datasource, opts) {
+async function runDocker(datasource: string | undefined, opts: TestOptions) {
   let coverageOpt = opts.coverage
   let forceOpt = opts.force
   let versionOpt = opts.version
@@ -230,10 +272,10 @@ async function runDocker(datasource, opts) {
 
   // Remove binary-install-raw binaries, because docker has permission issues
   // when building the docker images
-  await filesystem.remove('./node_modules/binary-install-raw/bin')
+  filesystem.remove('./node_modules/binary-install-raw/bin')
 
   // Get current working directory
-  let current_folder = await filesystem.cwd()
+  let current_folder = filesystem.cwd()
 
   // Declate dockerfilePath with default location
   let dockerfilePath = path.join(opts.testsFolder || 'tests', '.docker/Dockerfile')
@@ -248,7 +290,7 @@ async function runDocker(datasource, opts) {
   }
 
   // Run a command to check if matchstick image already exists
-  exec('docker images -q matchstick', (error, stdout, stderr) => {
+  exec('docker images -q matchstick', (_error, stdout, _stderr) => {
     // Collect all(if any) flags and options that have to be passed to the matchstick binary
     let testArgs = ''
     if (coverageOpt) testArgs = testArgs + ' -c'
@@ -277,7 +319,7 @@ async function runDocker(datasource, opts) {
     // Use spawn() and {stdio: 'inherit'} so we can see the logs in real time.
     if (!dockerfileExists || stdout === '' || versionOpt || forceOpt) {
       if (stdout !== '') {
-        exec('docker image rm matchstick', (error, stdout, stderr) => {
+        exec('docker image rm matchstick', (_error, stdout, _stderr) => {
           print.info(chalk.bold(`Removing matchstick image\n${stdout}`))
         })
       }
@@ -300,7 +342,11 @@ async function runDocker(datasource, opts) {
 
 // Downloads Dockerfile template from the demo-subgraph repo
 // Replaces the placeholders with their respective values
-async function dockerfile(dockerfilePath, versionOpt, latestVersion) {
+async function dockerfile(
+  dockerfilePath: string,
+  versionOpt: string | undefined,
+  latestVersion: string | undefined,
+) {
   let spinner = print.spin('Generating Dockerfile...')
 
   try {
@@ -318,13 +364,13 @@ async function dockerfile(dockerfilePath, versionOpt, latestVersion) {
     })
 
     // Write the Dockerfile
-    await filesystem.write(dockerfilePath, content)
+    filesystem.write(dockerfilePath, content)
 
     // Replaces the version placeholders
     await patching.replace(
       dockerfilePath,
       '<MATCHSTICK_VERSION>',
-      versionOpt || latestVersion,
+      versionOpt || latestVersion || 'unknown',
     )
   } catch (error) {
     spinner.fail(

package/src/subgraph.ts

@@ -275,7 +275,7 @@ More than one template named '${name}', template names must be unique.`,
       }
     }
 
-    let manifest = immutable.fromJS(data)
+    let manifest = immutable.fromJS(data) as immutable.Map<any, any>
 
     // Validate the schema
     Subgraph.validateSchema(manifest, { resolveFile })

package/tests/cli/spawn-command.d.ts

@@ -0,0 +1,6 @@
+declare module 'spawn-command' {
+  import { spawn, SpawnOptions, ChildProcessByStdio, StdioPipe } from 'child_process'
+  type SpawnResult = ChildProcessByStdio<Writable, Readable, Readable>
+  export { SpawnOptions, SpawnResult }
+  export default function spawn(command: string, options: SpawnOptions): SpawnResult
+}

package/tests/cli/{util.js → util.ts}

@@ -6,20 +6,30 @@ import stripAnsi from 'strip-ansi'
 // Deletes folder if:
 // - flag is true
 // - folder exists
-const deleteDir = (dir, flag) => {
+const deleteDir = (dir: string, flag: boolean) => {
   if (flag && fs.existsSync(dir)) {
     fs.removeSync(dir)
   }
 }
 
-const resolvePath = p => path.join(__dirname, p)
-
-const cliTest = (title, args, testPath, options = {}) => {
+const resolvePath = (p: string) => path.join(__dirname, p)
+
+export function cliTest(
+  title: string,
+  args: string[],
+  testPath: string,
+  options: {
+    cwd?: string
+    deleteDir?: boolean
+    exitCode?: number
+    timeout?: number
+  } = {},
+) {
   test(
     title,
     async () => {
       try {
-        deleteDir(resolvePath(`./${testPath}`), options.deleteDir)
+        deleteDir(resolvePath(`./${testPath}`), !!options.deleteDir)
 
         // Use the provided cwd if desired
         let cwd = options.cwd ? options.cwd : resolvePath(`./${testPath}`)
@@ -62,14 +72,24 @@ const cliTest = (title, args, testPath, options = {}) => {
           expect(stripAnsi(stdout)).toBe(expectedStdout)
         }
       } finally {
-        deleteDir(resolvePath(`./${testPath}`), options.deleteDir)
+        deleteDir(resolvePath(`./${testPath}`), !!options.deleteDir)
       }
     },
     options.timeout || undefined,
   )
 }
 
-const runCommand = async (command, args = [], cwd = process.cwd()) => {
+function runCommand(
+  command: string,
+  args: string[] = [],
+  cwd = process.cwd(),
+): Promise<
+  [
+    number | null, // exitCode
+    string, // stdout
+    string, // stderr
+  ]
+> {
   // Make sure to set an absolute working directory
   cwd = cwd[0] !== '/' ? path.resolve(__dirname, cwd) : cwd
 
@@ -82,11 +102,11 @@ const runCommand = async (command, args = [], cwd = process.cwd()) => {
       reject(error)
     })
 
-    child.stdout.on('data', data => {
+    child.stdout.on('data', (data: Buffer) => {
       stdout += data.toString()
     })
 
-    child.stderr.on('data', data => {
+    child.stderr.on('data', (data: Buffer) => {
       stderr += data.toString()
     })
 
@@ -96,15 +116,13 @@ const runCommand = async (command, args = [], cwd = process.cwd()) => {
   })
 }
 
-const runGraphCli = async (args, cwd) => {
+export function runGraphCli(args: string[], cwd: string) {
   // Resolve the path to graph.js
   let graphCli = path.join(__dirname, '..', '..', 'dist', 'bin.js')
 
-  return await runCommand(graphCli, args, cwd)
+  return runCommand(graphCli, args, cwd)
 }
 
-const npmLinkCli = () => runCommand('npm', ['link'])
-
-const npmUnlinkCli = () => runCommand('npm', ['unlink'])
+export const npmLinkCli = () => runCommand('npm', ['link'])
 
-export { cliTest, npmLinkCli, npmUnlinkCli, runGraphCli }
+export const npmUnlinkCli = () => runCommand('npm', ['unlink'])

package/tsconfig.build.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["./src"]
+}

package/tsconfig.json

@@ -14,5 +14,6 @@
     "skipLibCheck": true,
     "allowJs": true
   },
-  "include": ["./src"]
+  "include": ["./src", "./tests"],
+  "exclude": ["./tests/cli/init", "./tests/cli/validation"]
 }