Feature | Order list of EVM chains in graph init command (#1634)

* src/command-helpers: Add priority sort function

* src/command-helpers: Add priority sort tests

* src/commands/init: Sort imports

* src/commands/init: sort network choices before showing them to user

* remove jsdoc

* src/command-helpers: improve priority sort JSDoc

* Add changeset file

* Fix formatting

Author: joshuanazareth97

.changeset/early-walls-talk.md

@@ -0,0 +1,5 @@
+---
+'@graphprotocol/graph-cli': patch
+---
+
+Order list of evm chains in graph init command

packages/cli/src/command-helpers/sort.test.ts

@@ -0,0 +1,36 @@
+import { describe, expect, it } from 'vitest';
+import { sortWithPriority } from './sort'; // adjust the import based on your file structure
+
+describe('sortWithPriority', () => {
+  it('should sort numbers with specific priority elements', () => {
+    const numbers = [5, 3, 9, 1, 4];
+    const priorityNumbers = [9, 1];
+    const result = sortWithPriority(numbers, priorityNumbers);
+    expect(result).toEqual([1, 9, 3, 4, 5]);
+  });
+
+  it('should default sort numbers if no priority specifier', () => {
+    const numbers = [5, 3, 9, 1, 4];
+    const result = sortWithPriority(numbers);
+    expect(result).toEqual([1, 3, 4, 5, 9]);
+  });
+
+  it('should sort strings with priority determined by a function', () => {
+    const fruits = ['apple', 'orange', 'banana', 'mango', 'kiwi', 'melon'];
+    const sortedFruits = sortWithPriority(fruits, fruit => fruit.startsWith('m'));
+    expect(sortedFruits).toEqual(['mango', 'melon', 'apple', 'banana', 'kiwi', 'orange']);
+  });
+
+  it('should handle an empty array', () => {
+    const emptyArray: never[] = [];
+    const result = sortWithPriority(emptyArray, x => x > 3);
+    expect(result).toEqual([]);
+  });
+
+  it('should sort using a custom compare function', () => {
+    const numbers = [5, 3, 9, 1, 4];
+    const priorityNumbers = [9, 1];
+    const result = sortWithPriority(numbers, priorityNumbers, (a, b) => a - b);
+    expect(result).toEqual([1, 9, 3, 4, 5]);
+  });
+});

packages/cli/src/command-helpers/sort.ts

@@ -0,0 +1,45 @@
+/**
+ * Sorts an array with specified elements given priority.
+ * Use a predicate function, or provide an array to prioritise elements.
+ * If no compare function is provided, default JS sorting (ascending) behaviour prevails.
+ *
+ * @param {T[]} array - The array to be sorted.
+ * @param {((element: T) => boolean) | T[]} prioritySpecifier - A function that returns true if an element should be prioritized, or an array of elements to be prioritized.
+ * @param {(a: T, b: T) => number} [compareFunction] - An optional comparison function to sort the elements of the array. If omitted, the array is sorted in default order.
+ * @returns {T[]} The sorted array with priority elements first.
+ *
+ * @example
+ * const numbers = [5, 3, 9, 1, 4];
+ * sortWithPriority(numbers, x => x > 5); // [9, 1, 3, 4, 5]
+ * sortWithPriority(numbers, [9, 1]); // [1, 9, 3, 4, 5]
+ */
+function sortWithPriority<T>(
+  array: T[],
+  prioritySpecifier?: ((element: T) => boolean) | T[],
+  compareFunction?: (a: T, b: T) => number,
+): T[] {
+  // prioritySpecifier can be an array or a function so handle each case
+  let isPriorityElement: (element: T) => boolean;
+
+  if (Array.isArray(prioritySpecifier) || !prioritySpecifier) {
+    const prioritySet = new Set(prioritySpecifier ?? []);
+    isPriorityElement = (element: T) => prioritySet.has(element);
+  } else {
+    isPriorityElement = prioritySpecifier;
+  }
+
+  const priorityArray = array.filter(isPriorityElement);
+  const regularArray = array.filter(item => !isPriorityElement(item));
+
+  if (compareFunction) {
+    priorityArray.sort(compareFunction);
+    regularArray.sort(compareFunction);
+  } else {
+    priorityArray.sort();
+    regularArray.sort();
+  }
+
+  return priorityArray.concat(regularArray);
+}
+
+export { sortWithPriority };

packages/cli/src/commands/init.ts

@@ -1,8 +1,8 @@
 import fs from 'fs';
 import os from 'os';
 import path from 'path';
-import { filesystem, prompt, system } from 'gluegun';
 import * as toolbox from 'gluegun';
+import { filesystem, prompt, system } from 'gluegun';
 import { Args, Command, Flags, ux } from '@oclif/core';
 import {
   loadAbiFromBlockScout,
@@ -12,6 +12,7 @@ import {
 import { initNetworksConfig } from '../command-helpers/network';
 import { chooseNodeUrl, SUBGRAPH_STUDIO_URL } from '../command-helpers/node';
 import { generateScaffold, writeScaffold } from '../command-helpers/scaffold';
+import { sortWithPriority } from '../command-helpers/sort';
 import { withSpinner } from '../command-helpers/spinner';
 import { getSubgraphBasename, validateSubgraphName } from '../command-helpers/subgraph';
 import { GRAPH_CLI_SHARED_HEADERS } from '../constants';
@@ -630,7 +631,7 @@ async function processInitForm(
       },
     ]);
 
-    const choices = (await AVAILABLE_NETWORKS())?.[
+    let choices = (await AVAILABLE_NETWORKS())?.[
       product === 'subgraph-studio' ? 'studio' : 'hostedService'
     ];
 
@@ -641,6 +642,8 @@ async function processInitForm(
       );
     }
 
+    choices = sortWithPriority(choices, ['mainnet']);
+
     const { network } = await prompt.ask<{ network: string }>([
       {
         type: 'select',