feat: add more program options to create-fuels CLI

.changeset/unlucky-eggs-design.md

@@ -0,0 +1,5 @@
+---
+"create-fuels": minor
+---
+
+Add more program optoins to the `create-fuels` CLI. Users can now get a multiselect choice to choose out of contract, script & predicate.

packages/create-fuels/package.json

@@ -19,6 +19,7 @@
     "prepublishOnly": "cp -r ../../templates . && tsx ./scripts/rewriteTemplatePackageJson.ts"
   },
   "dependencies": {
+    "@iarna/toml": "^2.2.5",
     "chalk": "4",
     "commander": "^9.4.1",
     "fuels": "workspace:*",

packages/create-fuels/src/cli.ts

@@ -1,8 +1,9 @@
 /* eslint-disable no-console */
+import toml from '@iarna/toml';
 import chalk from 'chalk';
 import { execSync } from 'child_process';
 import { Command } from 'commander';
-import { existsSync } from 'fs';
+import { existsSync, readFileSync, rmSync, writeFileSync } from 'fs';
 import { cp, mkdir, rename } from 'fs/promises';
 import { join } from 'path';
 import prompts from 'prompts';
@@ -13,13 +14,49 @@ const log = (...data: unknown[]) => {
   process.stdout.write(`${data.join(' ')}\n`);
 };
 
+type ProgramsToInclude = {
+  contract: boolean;
+  predicate: boolean;
+  script: boolean;
+};
+
+const processWorkspaceToml = (fileContents: string, programsToInclude: ProgramsToInclude) => {
+  const parsed = toml.parse(fileContents) as {
+    workspace: {
+      members: string[];
+    };
+  };
+
+  parsed.workspace.members = parsed.workspace.members.filter((member) => {
+    if (member === 'predicate' && !programsToInclude.predicate) {
+      return false;
+    }
+    if (member === 'contract' && !programsToInclude.contract) {
+      return false;
+    }
+    if (member === 'script' && !programsToInclude.script) {
+      return false;
+    }
+    return true;
+  });
+
+  return toml.stringify(parsed);
+};
+
 export const runScaffoldCli = async (
   explicitProjectPath?: string,
   explicitPackageManger?: string,
-  shouldInstallDeps = true
+  shouldInstallDeps = true,
+  explicitProgramsToInclude?: ProgramsToInclude
 ) => {
   let projectPath = explicitProjectPath || '';
   let packageManager = explicitPackageManger || '';
+  let programsToInclude: ProgramsToInclude = explicitProgramsToInclude || {
+    contract: true,
+    predicate: false,
+    script: false,
+  };
+
   const program = new Command(packageJson.name).version(packageJson.version);
 
   if (!explicitProjectPath) {
@@ -61,11 +98,47 @@ export const runScaffoldCli = async (
     packageManager = packageManagerInput.packageManager;
   }
 
+  if (!explicitProgramsToInclude) {
+    const programsToIncludeInput = await prompts({
+      type: 'multiselect',
+      name: 'programsToInclude',
+      message: 'Which Sway programs do you want?',
+      choices: [
+        { title: 'Contract', value: 'contract', selected: true },
+        { title: 'Predicate', value: 'predicate' },
+        { title: 'Script', value: 'script' },
+      ],
+      instructions: false,
+    });
+    programsToInclude = {
+      contract: programsToIncludeInput.programsToInclude.includes('contract'),
+      predicate: programsToIncludeInput.programsToInclude.includes('predicate'),
+      script: programsToIncludeInput.programsToInclude.includes('script'),
+    };
+  }
+
   await mkdir(projectPath);
 
   await cp(join(__dirname, '../templates/nextjs'), projectPath, { recursive: true });
   await rename(join(projectPath, 'gitignore'), join(projectPath, '.gitignore'));
 
+  // delete the programs that are not to be included
+  if (!programsToInclude.contract) {
+    rmSync(join(projectPath, 'sway-programs/contract'), { recursive: true });
+  }
+  if (!programsToInclude.predicate) {
+    rmSync(join(projectPath, 'sway-programs/predicate'), { recursive: true });
+  }
+  if (!programsToInclude.script) {
+    rmSync(join(projectPath, 'sway-programs/script'), { recursive: true });
+  }
+
+  // remove the programs that are not included from the Forc.toml members field and rewrite the file
+  const forcTomlPath = join(projectPath, 'sway-programs', 'Forc.toml');
+  const forcTomlContents = readFileSync(forcTomlPath, 'utf-8');
+  const newForcTomlContents = processWorkspaceToml(forcTomlContents, programsToInclude);
+  writeFileSync(forcTomlPath, newForcTomlContents);
+
   if (shouldInstallDeps) {
     process.chdir(projectPath);
     execSync(`${packageManager} install`, { stdio: 'inherit' });

packages/create-fuels/test/cli.test.ts

@@ -3,34 +3,47 @@ import { join } from 'path';
 
 import { runScaffoldCli } from '../src/cli';
 
+const possibleProgramsToInclude = [
+  { contract: true, predicate: false, script: false },
+  { contract: false, predicate: true, script: false },
+  { contract: false, predicate: false, script: true },
+  { contract: true, predicate: true, script: false },
+  { contract: true, predicate: false, script: true },
+  { contract: false, predicate: true, script: true },
+  { contract: true, predicate: true, script: true },
+];
+
 /**
  * @group node
  */
-test('create-fuels extracts the template to the specified directory', async () => {
-  // move the templates folder from the root of the project to the root of the create-fuels package temporarily.
-  // this is needed because of the way the create-fuels package is setup.
-  // it expects the templates folder to be in the root of the create-fuels package. we move it there in the prepublishOnly script
-  await cp(join(__dirname, '../../../templates'), join(__dirname, '../templates'), {
-    recursive: true,
-  });
-
-  await runScaffoldCli('test-project', 'pnpm', false);
-
-  // check if the template was extracted to the test-project directory.
-  // compare the templates/nextjs folder with the test-project folder recursively
-  const originalTemplateFiles = await fs.readdir(join(__dirname, '../templates/nextjs'));
-
-  // remove the gitignore file from the array because it is not copied to the test-project folder
-  const gitIgnoreIndex = originalTemplateFiles.indexOf('gitignore');
-  if (gitIgnoreIndex > -1) {
-    originalTemplateFiles.splice(gitIgnoreIndex, 1);
+test.each(possibleProgramsToInclude)(
+  'create-fuels extracts the template to the specified directory',
+  async (programsToInclude) => {
+    // move the templates folder from the root of the project to the root of the create-fuels package temporarily.
+    // this is needed because of the way the create-fuels package is setup.
+    // it expects the templates folder to be in the root of the create-fuels package. we move it there in the prepublishOnly script
+    await cp(join(__dirname, '../../../templates'), join(__dirname, '../templates'), {
+      recursive: true,
+    });
+
+    await runScaffoldCli('test-project', 'pnpm', false, programsToInclude);
+
+    // check if the template was extracted to the test-project directory.
+    // compare the templates/nextjs folder with the test-project folder recursively
+    const originalTemplateFiles = await fs.readdir(join(__dirname, '../templates/nextjs'));
+
+    // remove the gitignore file from the array because it is not copied to the test-project folder
+    const gitIgnoreIndex = originalTemplateFiles.indexOf('gitignore');
+    if (gitIgnoreIndex > -1) {
+      originalTemplateFiles.splice(gitIgnoreIndex, 1);
+    }
+
+    const testProjectFiles = await fs.readdir('test-project');
+
+    expect(originalTemplateFiles).toEqual(testProjectFiles);
+
+    // cleanup - delete the test project and the templates folder
+    await fs.rm(join(__dirname, '../templates'), { recursive: true });
+    await fs.rm('test-project', { recursive: true });
   }
-
-  const testProjectFiles = await fs.readdir('test-project');
-
-  expect(originalTemplateFiles).toEqual(testProjectFiles);
-
-  // cleanup - delete the test project and the templates folder
-  await fs.rm(join(__dirname, '../templates'), { recursive: true });
-  await fs.rm('test-project', { recursive: true });
-});
+);

templates/nextjs/fuels.config.ts

@@ -1,6 +1,6 @@
 import { createConfig } from 'fuels';
 
 export default createConfig({
-  contracts: ['sway-contracts'],
+  workspace: './sway-programs',
   output: './src/sway-api',
 });

templates/nextjs/sway-programs/Forc.toml

@@ -0,0 +1,2 @@
+[workspace]
+members = ["contract", "predicate", "script"]

templates/nextjs/sway-programs/contract/.gitignore

@@ -0,0 +1,2 @@
+out
+target

templates/nextjs/sway-programs/predicate/.gitignore

@@ -0,0 +1,2 @@
+out
+target

templates/nextjs/sway-programs/predicate/Forc.toml

@@ -0,0 +1,7 @@
+[project]
+authors = ["Fuel Labs <contact@fuel.sh>"]
+entry = "main.sw"
+license = "Apache-2.0"
+name = "test-predicate"
+
+[dependencies]

templates/nextjs/sway-programs/predicate/src/main.sw

@@ -0,0 +1,5 @@
+predicate;
+
+fn main() -> bool {
+    return true;
+}

templates/nextjs/sway-programs/script/.gitignore

@@ -0,0 +1,2 @@
+out
+target

templates/nextjs/sway-programs/script/Forc.toml

@@ -0,0 +1,7 @@
+[project]
+authors = ["Fuel Labs <contact@fuel.sh>"]
+entry = "main.sw"
+license = "Apache-2.0"
+name = "test-script"
+
+[dependencies]

templates/nextjs/sway-programs/script/src/main.sw

@@ -0,0 +1,5 @@
+script;
+
+fn main() -> bool {
+    return true;
+}