[go: up one dir, main page]

forc 0.66.3

Fuel Orchestrator.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

use crate::{cli::init::Command as InitCommand, ops::forc_init::init};
use anyhow::anyhow;
use clap::Parser;
use forc_util::{forc_result_bail, validate_project_name, ForcResult};
use std::path::{Path, PathBuf};

forc_util::cli_examples! {
    crate::cli::Opt {
        [Create a new project => "forc new --contract --name my_project <PATH>"]
        [Create a new workspace => "forc new --workspace --name my_workspace <PATH>"]
        [Create a new Forc project with a predicate => "forc new <PATH> --predicate"]
        [Create a new Forc library project => "forc new <PATH> --library"]
    }
}

/// Create a new Forc project at `<path>`.
#[derive(Debug, Parser)]
#[clap(bin_name = "forc new", version, after_help = help())]
pub struct Command {
    /// The default program type. Excluding all flags or adding this flag creates a basic contract
    /// program.
    #[clap(long)]
    pub contract: bool,
    /// Adding this flag creates an empty script program.
    #[clap(long)]
    pub script: bool,
    /// Adding this flag creates an empty predicate program.
    #[clap(long)]
    pub predicate: bool,
    /// Adding this flag creates an empty library program.
    #[clap(long)]
    pub library: bool,
    /// Adding this flag creates an empty workspace.
    #[clap(long)]
    pub workspace: bool,
    /// Set the package name. Defaults to the directory name
    #[clap(long)]
    pub name: Option<String>,
    /// The path at which the project directory will be created.
    pub path: String,
}

pub(crate) fn exec(command: Command) -> ForcResult<()> {
    // `forc new` is roughly short-hand for `forc init`, but we create the directory first if it
    // doesn't yet exist. Here we create the directory if it doesn't exist then re-use the existing
    // `forc init` logic.
    let Command {
        contract,
        script,
        predicate,
        library,
        workspace,
        name,
        path,
    } = command;

    match &name {
        Some(name) => validate_project_name(name)?,
        None => {
            // If there is no name specified for the project, the last component of the `path` (directory name)
            // will be used by default so we should also check that.
            let project_path = PathBuf::from(&path);
            let directory_name = project_path
                .file_name()
                .ok_or_else(|| anyhow!("missing path for new command"))?
                .to_string_lossy();
            validate_project_name(&directory_name)?;
        }
    }

    let dir_path = Path::new(&path);
    if dir_path.exists() {
        forc_result_bail!(
            "Directory \"{}\" already exists.\nIf you wish to initialise a forc project inside \
            this directory, consider using `forc init --path {}`",
            dir_path.canonicalize()?.display(),
            dir_path.display(),
        );
    } else {
        std::fs::create_dir_all(dir_path)?;
    }

    let init_cmd = InitCommand {
        path: Some(path),
        contract,
        script,
        predicate,
        library,
        workspace,
        name,
    };

    init(init_cmd)?;
    Ok(())
}