Detect installed Rust version (#71)

Author: lorisleiva

.changeset/nine-sheep-wash.md

@@ -0,0 +1,5 @@
+---
+"create-solana-program": patch
+---
+
+Detect installed Rust version

index.ts

@@ -1,20 +1,19 @@
 #!/usr/bin/env node
 
-import * as path from 'node:path';
 import * as fs from 'node:fs';
+import * as path from 'node:path';
 
-import { createOrEmptyTargetDirectory } from './utils/fsHelpers';
-import { getInputs } from './utils/getInputs';
-import { getLanguage } from './utils/getLanguage';
-import { logBanner, logDone, logStep } from './utils/getLogs';
-import { RenderContext, getRenderContext } from './utils/getRenderContext';
+import { createOrEmptyTargetDirectory } from './utils/filesystem';
+import { getInputs } from './utils/inputs';
+import { getLanguage } from './utils/localization';
+import { logBanner, logDone, logStep } from './utils/logs';
+import { RenderContext, getRenderContext } from './utils/renderContext';
 import { renderTemplate } from './utils/renderTemplates';
-import {
-  detectAnchorVersion,
-  detectSolanaVersion,
-  generateKeypair,
-  patchSolanaDependencies,
-} from './utils/solanaCli';
+import { generateKeypair, patchSolanaDependencies } from './utils/solanaCli';
+import { detectAnchorVersion } from './utils/version-anchor';
+import { detectRustVersion } from './utils/version-rust';
+import { detectSolanaVersion } from './utils/version-solana';
+import { Version } from './utils/version-core';
 
 (async function init() {
   logBanner();
@@ -36,8 +35,14 @@ import {
     () => detectSolanaVersion(language)
   );
 
+  // Detect the Rust version.
+  const rustVersionDetected = await logStep(
+    language.infos.detectRustVersion,
+    () => detectRustVersion()
+  );
+
   // Detect the Anchor version.
-  let anchorVersionDetected: string | undefined;
+  let anchorVersionDetected: Version | undefined;
   if (inputs.programFramework === 'anchor') {
     anchorVersionDetected = await logStep(
       language.infos.detectAnchorVersion,
@@ -64,6 +69,7 @@ import {
     inputs,
     programAddress,
     solanaVersionDetected,
+    rustVersionDetected,
     anchorVersionDetected,
   });
 

locales/en-US.json

@@ -50,10 +50,11 @@
   "errors": {
     "anchorCliNotFound": "Command `$command` unavailable. Please install the Anchor CLI.",
     "cannotOverrideDirectory": "Cannot override target directory \"$targetDirectory\". Run with option --force to override.",
-    "invalidSolanaVersion": "Invalid Solana version: $version.",
-    "operationCancelled": "Operation cancelled",
+    "invalidVersion": "Invalid $tool version: $version.",
+    "operationCancelled": "Operation cancelled.",
+    "rustVersionIncompatibleWithSolana": "Solana version $solanaVersion requires at least Rust $minimumRustVersion installed, found Rust $rustVersion.",
     "solanaCliNotFound": "Command `$command` unavailable. Please install the Solana CLI.",
-    "solanaKeygenFailed": "Failed to generate program keypair"
+    "solanaKeygenFailed": "Failed to generate program keypair."
   },
   "defaultToggleOptions": {
     "active": "Yes",
@@ -65,6 +66,7 @@
   },
   "infos": {
     "detectAnchorVersion": "Detect Anchor version",
+    "detectRustVersion": "Detect Rust version",
     "detectSolanaVersion": "Detect Solana version",
     "generateKeypair": "Generate program keypair",
     "scaffold": "Scaffold project in $targetDirectory",

locales/fr-FR.json

@@ -53,10 +53,11 @@
   "errors": {
     "anchorCliNotFound": "Commande `$command` indisponible. Veuillez installer Anchor dans votre terminal.",
     "cannotOverrideDirectory": "Impossible de remplacer le répertoire cible \"$targetDirectory\". Exécutez avec l'option --force pour remplacer.",
-    "invalidSolanaVersion": "Version Solana invalide\u00a0: $version.",
-    "operationCancelled": "Operation annulée",
+    "invalidVersion": "Version de $tool invalide\u00a0: $version.",
+    "operationCancelled": "Operation annulée.",
+    "rustVersionIncompatibleWithSolana": "La version de Solana $solanaVersion nécessite au moins Rust $minimumRustVersion installé, Rust $rustVersion trouvé.",
     "solanaCliNotFound": "Commande `$command` indisponible. Veuillez installer Solana dans votre terminal.",
-    "solanaKeygenFailed": "La génération de la paire de clés a échoué"
+    "solanaKeygenFailed": "La génération de la paire de clés a échoué."
   },
   "defaultToggleOptions": {
     "active": "Oui",
@@ -67,8 +68,9 @@
     "multiselect": "[↑/↓]: Sélectionner / [espace]: Basculer la sélection / [a]: Basculer tout / [entrée]: Valider"
   },
   "infos": {
-    "detectAnchorVersion": "Détect la version d'Anchor",
-    "detectSolanaVersion": "Détect la version de Solana",
+    "detectAnchorVersion": "Détecte la version d'Anchor",
+    "detectRustVersion": "Détecte la version de Rust",
+    "detectSolanaVersion": "Détecte la version de Solana",
     "generateKeypair": "Génére la paire de clés du program",
     "scaffold": "Génére le projet dans $targetDirectory",
     "done": "Terminé. Exécutez maintenant\u00a0:"

template/anchor/base/program/Cargo.toml.njk

@@ -20,5 +20,5 @@ cpi = ["no-entrypoint"]
 idl-build = ["anchor-lang/idl-build"]
 
 [dependencies]
-anchor-lang = "{{ anchorVersion }}"
-solana-program = "~{{ solanaVersionWithoutPatch }}"
+anchor-lang = "{{ anchorVersion.full }}"
+solana-program = "~{{ solanaVersion.withoutPatch }}"

template/base/.github/actions/setup/action.yml.njk

@@ -48,7 +48,7 @@ runs:
       shell: bash
       run: pnpm zx ./scripts/ci/set-env.mjs
 
-{% if solanaVersionWithoutPatch === '2.0' %}
+{% if solanaVersion.withoutPatch === '2.0' %}
     - name: Install Protobuf Compiler (Temporary Workaround for Solana 2.0)
       if: {% raw %}${{ inputs.solana || inputs.rustfmt == 'true' || inputs.clippy == 'true' }}{% endraw %}
       shell: bash

template/base/.github/workflows/main.yml.njk

@@ -8,9 +8,9 @@ on:
 
 env:
   NODE_VERSION: 18
-  SOLANA_VERSION: {{ solanaVersion }}
+  SOLANA_VERSION: {{ solanaVersion.full }}
 {% if programFramework === 'anchor' %}
-  ANCHOR_VERSION: {{ anchorVersion }}
+  ANCHOR_VERSION: {{ anchorVersion.full }}
 {% endif %}
 
 jobs:

template/clients/rust/clients/rust/Cargo.toml.njk

@@ -15,10 +15,10 @@ num-derive = "^0.3"
 num-traits = "^0.2"
 serde = { version = "^1.0", features = ["derive"], optional = true }
 serde_with = { version = "^3.0", optional = true }
-solana-program = "~{{ solanaVersionWithoutPatch }}"
+solana-program = "~{{ solanaVersion.withoutPatch }}"
 thiserror = "^1.0"
 
 [dev-dependencies]
 assert_matches = "1.5.0"
-solana-program-test = "~{{ solanaVersionWithoutPatch }}"
-solana-sdk = "~{{ solanaVersionWithoutPatch }}"
+solana-program-test = "~{{ solanaVersion.withoutPatch }}"
+solana-sdk = "~{{ solanaVersion.withoutPatch }}"

template/shank/base/program/Cargo.toml.njk

@@ -19,5 +19,5 @@ borsh = "^0.10"
 shank = "^0.4.2"
 num-derive = "^0.3"
 num-traits = "^0.2"
-solana-program = "~{{ solanaVersionWithoutPatch }}"
+solana-program = "~{{ solanaVersion.withoutPatch }}"
 thiserror = "^1.0"

utils/runCommands.ts renamed to utils/commands.ts

@@ -1,8 +1,8 @@
 import * as fs from 'node:fs';
 import * as path from 'node:path';
 
-import { Language } from './getLanguage';
-import { logErrorAndExit } from './getLogs';
+import { Language } from './localization';
+import { logErrorAndExit } from './logs';
 
 export function createOrEmptyTargetDirectory(
   language: Language,

utils/fsHelpers.ts renamed to utils/filesystem.ts

@@ -3,9 +3,8 @@ import * as fs from 'node:fs';
 import { parseArgs } from 'node:util';
 import prompts from 'prompts';
 
-import { Language } from './getLanguage';
-import { kebabCase } from './stringHelpers';
-import { toMinorSolanaVersion } from './solanaCli';
+import { Language } from './localization';
+import { kebabCase } from './strings';
 
 export const allClients = ['js', 'rust'] as const;
 export type Client = (typeof allClients)[number];
@@ -20,14 +19,15 @@ export type Inputs = {
   programName: string;
   rustClient: boolean;
   rustClientCrateName: string;
+  rustVersion?: string;
   shouldOverride: boolean;
   solanaVersion?: string;
   targetDirectoryName: string;
   useDefaults: boolean;
 };
 
 export async function getInputs(language: Language): Promise<Inputs> {
-  const argInputs = getInputsFromArgs(language);
+  const argInputs = getInputsFromArgs();
   const defaultInputs = getDefaultInputs(argInputs);
 
   if (argInputs.useDefaults) {
@@ -212,7 +212,7 @@ async function getInputsFromPrompts(
   }
 }
 
-function getInputsFromArgs(language: Language): Partial<Inputs> {
+function getInputsFromArgs(): Partial<Inputs> {
   type ArgInputs = {
     address?: string;
     anchorProgram: boolean;
@@ -221,6 +221,7 @@ function getInputsFromArgs(language: Language): Partial<Inputs> {
     noClients: boolean;
     organizationName?: string;
     programName?: string;
+    rustVersion?: string;
     shankProgram: boolean;
     solanaVersion?: string;
     useDefaults: boolean;
@@ -235,11 +236,8 @@ function getInputsFromArgs(language: Language): Partial<Inputs> {
       inputs.organizationName = kebabCase(argInputs.organizationName);
     if (argInputs.programName)
       inputs.programName = kebabCase(argInputs.programName);
-    if (argInputs.solanaVersion)
-      inputs.solanaVersion = toMinorSolanaVersion(
-        language,
-        argInputs.solanaVersion
-      );
+    if (argInputs.rustVersion) inputs.rustVersion = argInputs.rustVersion;
+    if (argInputs.solanaVersion) inputs.solanaVersion = argInputs.solanaVersion;
     if (argInputs.targetDirectoryName)
       inputs.targetDirectoryName = argInputs.targetDirectoryName;
     if (argInputs.force) inputs.shouldOverride = true;
@@ -273,6 +271,7 @@ function getInputsFromArgs(language: Language): Partial<Inputs> {
       force: { type: 'boolean' },
       'no-clients': { type: 'boolean' },
       org: { type: 'string' },
+      rust: { type: 'string' },
       shank: { type: 'boolean' },
       solana: { type: 'string' },
     },
@@ -287,6 +286,7 @@ function getInputsFromArgs(language: Language): Partial<Inputs> {
     noClients: options['no-clients'] ?? false,
     organizationName: options.org,
     programName: positionals[1],
+    rustVersion: options.rust,
     shankProgram: options.shank ?? false,
     solanaVersion: options.solana,
     useDefaults: options.default ?? false,

utils/getRenderContext.ts

@@ -31,8 +31,9 @@ export interface Language {
   errors: {
     anchorCliNotFound: string;
     cannotOverrideDirectory: string;
-    invalidSolanaVersion: string;
+    invalidVersion: string;
     operationCancelled: string;
+    rustVersionIncompatibleWithSolana: string;
     solanaCliNotFound: string;
     solanaKeygenFailed: string;
   };
@@ -46,6 +47,7 @@ export interface Language {
   };
   infos: {
     detectAnchorVersion: string;
+    detectRustVersion: string;
     detectSolanaVersion: string;
     generateKeypair: string;
     scaffold: string;