CLI: Add javascript as option for template flag to new (#3395)

CHANGELOG.md

@@ -4,6 +4,10 @@
 
 ### Build tool
 
+- The `--template` flag for `gleam new` takes the values `erlang` and
+  `javascript` to specify what target to use, with `erlang` being the default.
+  ([Mohammed Khouni](https://github.com/Tar-Tarus))
+
 ### Compiler
 
 - The compiler now prints correctly qualified or aliased type names when

Cargo.toml

@@ -57,7 +57,7 @@ thiserror = "1"
 # Test assertion errors with diffs
 pretty_assertions = "1"
 # Snapshot testing to make test maintenance easier
-insta = "1"
+insta = {version = "1", features = ["glob"]}
 # A transitive dependency needed to compile into wasm32-unknown-unknown
 # See https://docs.rs/getrandom/latest/getrandom/index.html#webassembly-support
 getrandom = { version = "0", features = ["js"] }

compiler-cli/Cargo.toml

@@ -65,6 +65,7 @@ walkdir.workspace = true
 # Creation of temporary directories
 tempfile = "3"
 pretty_assertions.workspace = true
+insta.workspace = true
 
 [build-dependencies]
 # For statically linking the VCRuntime on Windows when

compiler-cli/src/main.rs

@@ -253,6 +253,10 @@ enum Command {
     Export(ExportTarget),
 }
 
+fn template_doc() -> &'static str {
+    "The template to use"
+}
+
 fn target_doc() -> String {
     format!("The platform to target ({})", Target::VARIANTS.join("|"))
 }
@@ -288,7 +292,7 @@ pub struct NewOptions {
     #[arg(long)]
     pub name: Option<String>,
 
-    #[arg(long, ignore_case = true, default_value = "lib")]
+    #[arg(long, ignore_case = true, default_value = "erlang", help = template_doc())]
     pub template: new::Template,
 
     /// Skip git initialization and creation of .gitignore, .git/* and .github/* files

compiler-cli/src/new.rs

@@ -24,9 +24,13 @@ const ELIXIR_VERSION: &str = "1.15.4";
 #[derive(
     Debug, Serialize, Deserialize, Display, EnumString, VariantNames, ValueEnum, Clone, Copy,
 )]
-#[strum(serialize_all = "kebab_case")]
+#[strum(serialize_all = "lowercase")]
+#[clap(rename_all = "lower")]
 pub enum Template {
+    #[clap(skip)]
     Lib,
+    Erlang,
+    JavaScript,
 }
 
 #[derive(Debug)]
@@ -74,6 +78,10 @@ impl FileToCreate {
         let skip_git = creator.options.skip_git;
         let skip_github = creator.options.skip_github;
         let gleam_version = creator.gleam_version;
+        let target = match creator.options.template {
+            Template::JavaScript => "target = \"javascript\"\n",
+            Template::Lib | Template::Erlang => "",
+        };
 
         match self {
             Self::Readme => Some(format!(
@@ -142,7 +150,7 @@ pub fn hello_world_test() {
             Self::GleamToml => Some(format!(
                 r#"name = "{project_name}"
 version = "1.0.0"
-
+{target}
 # Fill out these fields if you intend to generate HTML documentation or publish
 # your project to the Hex package manager.
 #
@@ -241,7 +249,7 @@ impl Creator {
         }
 
         match self.options.template {
-            Template::Lib => {
+            Template::Lib | Template::Erlang | Template::JavaScript => {
                 for file in FileToCreate::iter() {
                     let path = file.location(self);
                     if let Some(contents) = file.contents(self) {

compiler-cli/src/new/snapshots/gleam__new__tests__new_with_default_template.snap

@@ -0,0 +1,23 @@
+---
+source: compiler-cli/src/new/tests.rs
+expression: "crate::fs::read(path.join(\"gleam.toml\")).unwrap()"
+---
+name = "my_project"
+version = "1.0.0"
+
+# Fill out these fields if you intend to generate HTML documentation or publish
+# your project to the Hex package manager.
+#
+# description = ""
+# licences = ["Apache-2.0"]
+# repository = { type = "github", user = "", repo = "" }
+# links = [{ title = "Website", href = "" }]
+#
+# For a full reference of all the available options, you can have a look at
+# https://gleam.run/writing-gleam/gleam-toml/.
+
+[dependencies]
+gleam_stdlib = ">= 0.34.0 and < 2.0.0"
+
+[dev-dependencies]
+gleeunit = ">= 1.0.0 and < 2.0.0"

compiler-cli/src/new/snapshots/gleam__new__tests__new_with_default_template@.gitignore.snap

@@ -0,0 +1,8 @@
+---
+source: compiler-cli/src/new/tests.rs
+expression: "crate::fs::read(Utf8PathBuf::from_path_buf(file_path.to_path_buf()).expect(\"Non Utf8 Path\")).unwrap()"
+---
+*.beam
+*.ez
+/build
+erl_crash.dump

compiler-cli/src/new/snapshots/gleam__new__tests__new_with_default_template@README.md.snap

@@ -0,0 +1,28 @@
+---
+source: compiler-cli/src/new/tests.rs
+expression: "crate::fs::read(Utf8PathBuf::from_path_buf(file_path.to_path_buf()).expect(\"Non Utf8 Path\")).unwrap()"
+---
+# my_project
+
+[![Package Version](https://img.shields.io/hexpm/v/my_project)](https://hex.pm/packages/my_project)
+[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/my_project/)
+
+```sh
+gleam add my_project@1
+```
+```gleam
+import my_project
+
+pub fn main() {
+  // TODO: An example of the project in use
+}
+```
+
+Further documentation can be found at <https://hexdocs.pm/my_project>.
+
+## Development
+
+```sh
+gleam run   # Run the project
+gleam test  # Run the tests
+```

compiler-cli/src/new/snapshots/gleam__new__tests__new_with_default_template@gleam.toml.snap

@@ -0,0 +1,23 @@
+---
+source: compiler-cli/src/new/tests.rs
+expression: "crate::fs::read(Utf8PathBuf::from_path_buf(file_path.to_path_buf()).expect(\"Non Utf8 Path\")).unwrap()"
+---
+name = "my_project"
+version = "1.0.0"
+
+# Fill out these fields if you intend to generate HTML documentation or publish
+# your project to the Hex package manager.
+#
+# description = ""
+# licences = ["Apache-2.0"]
+# repository = { type = "github", user = "", repo = "" }
+# links = [{ title = "Website", href = "" }]
+#
+# For a full reference of all the available options, you can have a look at
+# https://gleam.run/writing-gleam/gleam-toml/.
+
+[dependencies]
+gleam_stdlib = ">= 0.34.0 and < 2.0.0"
+
+[dev-dependencies]
+gleeunit = ">= 1.0.0 and < 2.0.0"

compiler-cli/src/new/snapshots/gleam__new__tests__new_with_javascript_template.snap

@@ -0,0 +1,24 @@
+---
+source: compiler-cli/src/new/tests.rs
+expression: "crate::fs::read(path.join(\"gleam.toml\")).unwrap()"
+---
+name = "my_project"
+version = "1.0.0"
+target = "javascript"
+
+# Fill out these fields if you intend to generate HTML documentation or publish
+# your project to the Hex package manager.
+#
+# description = ""
+# licences = ["Apache-2.0"]
+# repository = { type = "github", user = "", repo = "" }
+# links = [{ title = "Website", href = "" }]
+#
+# For a full reference of all the available options, you can have a look at
+# https://gleam.run/writing-gleam/gleam-toml/.
+
+[dependencies]
+gleam_stdlib = ">= 0.34.0 and < 2.0.0"
+
+[dev-dependencies]
+gleeunit = ">= 1.0.0 and < 2.0.0"

compiler-cli/src/new/snapshots/gleam__new__tests__new_with_javascript_template@.gitignore.snap

@@ -0,0 +1,8 @@
+---
+source: compiler-cli/src/new/tests.rs
+expression: "crate::fs::read(Utf8PathBuf::from_path_buf(file_path.to_path_buf()).expect(\"Non Utf8 Path\")).unwrap()"
+---
+*.beam
+*.ez
+/build
+erl_crash.dump

compiler-cli/src/new/snapshots/gleam__new__tests__new_with_javascript_template@README.md.snap

@@ -0,0 +1,28 @@
+---
+source: compiler-cli/src/new/tests.rs
+expression: "crate::fs::read(Utf8PathBuf::from_path_buf(file_path.to_path_buf()).expect(\"Non Utf8 Path\")).unwrap()"
+---
+# my_project
+
+[![Package Version](https://img.shields.io/hexpm/v/my_project)](https://hex.pm/packages/my_project)
+[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/my_project/)
+
+```sh
+gleam add my_project@1
+```
+```gleam
+import my_project
+
+pub fn main() {
+  // TODO: An example of the project in use
+}
+```
+
+Further documentation can be found at <https://hexdocs.pm/my_project>.
+
+## Development
+
+```sh
+gleam run   # Run the project
+gleam test  # Run the tests
+```

compiler-cli/src/new/snapshots/gleam__new__tests__new_with_javascript_template@gleam.toml.snap

@@ -0,0 +1,24 @@
+---
+source: compiler-cli/src/new/tests.rs
+expression: "crate::fs::read(Utf8PathBuf::from_path_buf(file_path.to_path_buf()).expect(\"Non Utf8 Path\")).unwrap()"
+---
+name = "my_project"
+version = "1.0.0"
+target = "javascript"
+
+# Fill out these fields if you intend to generate HTML documentation or publish
+# your project to the Hex package manager.
+#
+# description = ""
+# licences = ["Apache-2.0"]
+# repository = { type = "github", user = "", repo = "" }
+# links = [{ title = "Website", href = "" }]
+#
+# For a full reference of all the available options, you can have a look at
+# https://gleam.run/writing-gleam/gleam-toml/.
+
+[dependencies]
+gleam_stdlib = ">= 0.34.0 and < 2.0.0"
+
+[dev-dependencies]
+gleeunit = ">= 1.0.0 and < 2.0.0"