init

Build Coverage Status

Start Deno projects faster with deno-init, a simple executable that scaffolds the project structure for you.

Please note this module’s API is not stable yet and there may be breaking changes on 0.x version increments.

Requirements

  • deno installed and available on a terminal.

Installation

Use the deno install command to install or upgrade the executable. If you download it without specifying a version the latest will be installed.

deno install --allow-read --allow-write -n deno-init https://deno.land/x/init@0.9.0/mod.ts

Basic Usage

You can run the command without specifying any options. This will prompt you for a few values:

  • TypeScript? (default y)
  • Entrypoint? (default mod.ts)
  • Dependency entrypoint? (default deps.ts)
  • Add debug configuration? (default y).
deno-init

Choosing all defaults will create the following structure in the current directory:

.
│   .gitignore
│   deps.ts  
│   mod.ts
│
└───.vscode
│   │   launch.json
│   │   settings.json

The generated .gitignore will include .vscode and launch.json as well as settings.json will contain the necessary setup.

Available Options

Use --help to print all available options. In addition, they are listed below:

Use --yes or -y if you simply want to use all the default values without being prompted:

deno-init -y

deno-init will not overwrite files or directories unless --force is passed.

Use --editor or -e to generate editor-specific configuration for a project. At this moment only the option vscode is supported and it is also set as the default.

deno-init --editor vscode

Use --force or -f in case you explicitly want to overwrite existing files. This can be helpful to re-initialize but use with caution.

deno-init -f

Use --name or -n to make a new directory in the current directory where the files will be placed.

deno-init --name my_deno_project

Use --template or -t to initialize project templates for various Deno frameworks. This is still a work in progress. Right now the available templates are oak,restful_oak and opine.

deno-init --template oak

Roadmap

  • Support more editor/IDE setups
  • Add more project templates