development/deno
development/deno
1
0
Fork 0
mirror of https://github.com/denoland/deno synced 2024-09-13 21:31:18 +00:00
Code Issues Packages Projects Releases Wiki Activity
deno/cli/tools/init/mod.rs

76 lines
1.8 KiB
Rust
Raw Normal View History

chore: update copyright to 2024 (#21753)
2024-01-01 19:58:21 +00:00
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
feat: add "deno init" subcommand (#15469) This adds an init subcommand to that creates a project starter similar to cargo init. ``` $ deno init my_project Project initialized Run these commands to get started: cd my_project deno run main.ts deno run main_test.ts $ deno run main.ts Add 2 + 3 5 $ cat main.ts export function add(a: number, b: number): number { return a + b; } if (import.meta.main) { console.log("Add 2 + 3", add(2, 3)); } $ cat main_test.ts import { assertEquals } from "https://deno.land/std@0.151.0/testing/asserts.ts"; import { add } from "./main.ts"; Deno.test(function addTest() { assertEquals(add(2, 3), 5); }); ``` Co-authored-by: Bartek Iwańczuk <biwanczuk@gmail.com>
2022-08-19 23:37:05 +00:00
use crate::args::InitFlags;
feat(init): Generate deno.json by default (#16389) Updates `deno init` subcommand to create a `deno.json` when initializing a new project. Slightly changes the output, to make it more readable.
2022-12-08 05:34:28 +00:00
use crate::colors;
refactor(cli): Remove cli/node dependency on cli/compat (#15654)
2022-08-29 18:19:54 +00:00
use deno_core::anyhow::Context;
use deno_core::error::AnyError;
fix(init): suppress info logs when using quiet mode (#15741)
2022-09-02 15:59:36 +00:00
use log::info;
feat: add "deno init" subcommand (#15469) This adds an init subcommand to that creates a project starter similar to cargo init. ``` $ deno init my_project Project initialized Run these commands to get started: cd my_project deno run main.ts deno run main_test.ts $ deno run main.ts Add 2 + 3 5 $ cat main.ts export function add(a: number, b: number): number { return a + b; } if (import.meta.main) { console.log("Add 2 + 3", add(2, 3)); } $ cat main_test.ts import { assertEquals } from "https://deno.land/std@0.151.0/testing/asserts.ts"; import { add } from "./main.ts"; Deno.test(function addTest() { assertEquals(add(2, 3), 5); }); ``` Co-authored-by: Bartek Iwańczuk <biwanczuk@gmail.com>
2022-08-19 23:37:05 +00:00
use std::io::Write;
use std::path::Path;
fn create_file(
dir: &Path,
filename: &str,
content: &str,
) -> Result<(), AnyError> {
fix(init): skip existing files instead of erroring (#20434) ### What Skip writing files from the template if the files already exist in the project directory. ### Why When I run deno init in a directory that already has a main.ts, or one of the other template files, I usually want to initialize a workspace around a file I've started working in. A hard error in this case seems counter productive. An informational message about what's being skipped seems sufficient. Close #20433
2023-09-12 10:55:26 +00:00
let path = dir.join(filename);
if path.exists() {
info!(
"ℹ️ {}",
colors::gray(format!("Skipped creating {filename} as it already exists"))
);
Ok(())
} else {
let mut file = std::fs::OpenOptions::new()
.write(true)
.create_new(true)
.open(path)
.with_context(|| format!("Failed to create {filename} file"))?;
file.write_all(content.as_bytes())?;
Ok(())
}
feat: add "deno init" subcommand (#15469) This adds an init subcommand to that creates a project starter similar to cargo init. ``` $ deno init my_project Project initialized Run these commands to get started: cd my_project deno run main.ts deno run main_test.ts $ deno run main.ts Add 2 + 3 5 $ cat main.ts export function add(a: number, b: number): number { return a + b; } if (import.meta.main) { console.log("Add 2 + 3", add(2, 3)); } $ cat main_test.ts import { assertEquals } from "https://deno.land/std@0.151.0/testing/asserts.ts"; import { add } from "./main.ts"; Deno.test(function addTest() { assertEquals(add(2, 3), 5); }); ``` Co-authored-by: Bartek Iwańczuk <biwanczuk@gmail.com>
2022-08-19 23:37:05 +00:00
}
chore: enable clippy unused_async rule (#22834)
2024-03-12 03:48:00 +00:00
pub fn init_project(init_flags: InitFlags) -> Result<(), AnyError> {
feat: add "deno init" subcommand (#15469) This adds an init subcommand to that creates a project starter similar to cargo init. ``` $ deno init my_project Project initialized Run these commands to get started: cd my_project deno run main.ts deno run main_test.ts $ deno run main.ts Add 2 + 3 5 $ cat main.ts export function add(a: number, b: number): number { return a + b; } if (import.meta.main) { console.log("Add 2 + 3", add(2, 3)); } $ cat main_test.ts import { assertEquals } from "https://deno.land/std@0.151.0/testing/asserts.ts"; import { add } from "./main.ts"; Deno.test(function addTest() { assertEquals(add(2, 3), 5); }); ``` Co-authored-by: Bartek Iwańczuk <biwanczuk@gmail.com>
2022-08-19 23:37:05 +00:00
let cwd =
std::env::current_dir().context("Can't read current working directory.")?;
let dir = if let Some(dir) = &init_flags.dir {
let dir = cwd.join(dir);
std::fs::create_dir_all(&dir)?;
dir
} else {
cwd
};
let main_ts = include_str!("./templates/main.ts");
create_file(&dir, "main.ts", main_ts)?;
feat(init): use jsr specifier for @std/assert (#23073) This commit changes "deno init" subcommand to use "jsr:" specifier for standard library "assert" module. It is unversioned, but we will change it to `@^1` once `@std/assert` release version 1.0. This allows us to start decoupling `deno` and `deno_std` release. The release scripts have been updated to take that into account.
2024-03-27 17:51:52 +00:00
create_file(
&dir,
"main_test.ts",
include_str!("./templates/main_test.ts"),
)?;
refactor(init): simplify template (#20325) - Don't include benchmark file - most people won't need this. - Use deno.json instead of deno.jsonc, because it's a more common file format.
2023-08-29 19:58:56 +00:00
create_file(&dir, "deno.json", include_str!("./templates/deno.json"))?;
feat(init): Generate deno.json by default (#16389) Updates `deno init` subcommand to create a `deno.json` when initializing a new project. Slightly changes the output, to make it more readable.
2022-12-08 05:34:28 +00:00
info!("✅ {}", colors::green("Project initialized"));
info!("");
info!("{}", colors::gray("Run these commands to get started"));
info!("");
feat: add "deno init" subcommand (#15469) This adds an init subcommand to that creates a project starter similar to cargo init. ``` $ deno init my_project Project initialized Run these commands to get started: cd my_project deno run main.ts deno run main_test.ts $ deno run main.ts Add 2 + 3 5 $ cat main.ts export function add(a: number, b: number): number { return a + b; } if (import.meta.main) { console.log("Add 2 + 3", add(2, 3)); } $ cat main_test.ts import { assertEquals } from "https://deno.land/std@0.151.0/testing/asserts.ts"; import { add } from "./main.ts"; Deno.test(function addTest() { assertEquals(add(2, 3), 5); }); ``` Co-authored-by: Bartek Iwańczuk <biwanczuk@gmail.com>
2022-08-19 23:37:05 +00:00
if let Some(dir) = init_flags.dir {
fix(init): suppress info logs when using quiet mode (#15741)
2022-09-02 15:59:36 +00:00
info!(" cd {}", dir);
feat(init): Generate deno.json by default (#16389) Updates `deno init` subcommand to create a `deno.json` when initializing a new project. Slightly changes the output, to make it more readable.
2022-12-08 05:34:28 +00:00
info!("");
feat: add "deno init" subcommand (#15469) This adds an init subcommand to that creates a project starter similar to cargo init. ``` $ deno init my_project Project initialized Run these commands to get started: cd my_project deno run main.ts deno run main_test.ts $ deno run main.ts Add 2 + 3 5 $ cat main.ts export function add(a: number, b: number): number { return a + b; } if (import.meta.main) { console.log("Add 2 + 3", add(2, 3)); } $ cat main_test.ts import { assertEquals } from "https://deno.land/std@0.151.0/testing/asserts.ts"; import { add } from "./main.ts"; Deno.test(function addTest() { assertEquals(add(2, 3), 5); }); ``` Co-authored-by: Bartek Iwańczuk <biwanczuk@gmail.com>
2022-08-19 23:37:05 +00:00
}
fix(init): update comment style (#17074) The output of `init` are commands, so this should be treated as a "Shell script". In Shell script, comments must start with `#`, not `//`. (This also makes the commands example easier to be copied to somewhere.)
2022-12-17 22:26:25 +00:00
info!(" {}", colors::gray("# Run the program"));
fix(init): suppress info logs when using quiet mode (#15741)
2022-09-02 15:59:36 +00:00
info!(" deno run main.ts");
feat(init): Generate deno.json by default (#16389) Updates `deno init` subcommand to create a `deno.json` when initializing a new project. Slightly changes the output, to make it more readable.
2022-12-08 05:34:28 +00:00
info!("");
info!(
" {}",
fix(init): update comment style (#17074) The output of `init` are commands, so this should be treated as a "Shell script". In Shell script, comments must start with `#`, not `//`. (This also makes the commands example easier to be copied to somewhere.)
2022-12-17 22:26:25 +00:00
colors::gray("# Run the program and watch for file changes")
feat(init): Generate deno.json by default (#16389) Updates `deno init` subcommand to create a `deno.json` when initializing a new project. Slightly changes the output, to make it more readable.
2022-12-08 05:34:28 +00:00
);
info!(" deno task dev");
info!("");
fix(init): update comment style (#17074) The output of `init` are commands, so this should be treated as a "Shell script". In Shell script, comments must start with `#`, not `//`. (This also makes the commands example easier to be copied to somewhere.)
2022-12-17 22:26:25 +00:00
info!(" {}", colors::gray("# Run the tests"));
fix(init): suppress info logs when using quiet mode (#15741)
2022-09-02 15:59:36 +00:00
info!(" deno test");
feat: add "deno init" subcommand (#15469) This adds an init subcommand to that creates a project starter similar to cargo init. ``` $ deno init my_project Project initialized Run these commands to get started: cd my_project deno run main.ts deno run main_test.ts $ deno run main.ts Add 2 + 3 5 $ cat main.ts export function add(a: number, b: number): number { return a + b; } if (import.meta.main) { console.log("Add 2 + 3", add(2, 3)); } $ cat main_test.ts import { assertEquals } from "https://deno.land/std@0.151.0/testing/asserts.ts"; import { add } from "./main.ts"; Deno.test(function addTest() { assertEquals(add(2, 3), 5); }); ``` Co-authored-by: Bartek Iwańczuk <biwanczuk@gmail.com>
2022-08-19 23:37:05 +00:00
Ok(())
}
Reference in a new issue Copy permalink