mod

mod is a command line tool to quickly scaffold a new Deno module. It requires deno and optionally git.

Try it without installing anything:

deno run \
--allow-read=./my_deno_module \
--allow-run=git \
--allow-write=./my_deno_module \
https://deno.land/x/mod@v2.2.6/mod.ts \
--name my_deno_module

deno run `
--allow-read=./my_deno_module `
--allow-run=git `
--allow-write=./my_deno_module `
https://deno.land/x/mod@v2.2.6/mod.ts `
--name my_deno_module

Table of Contents

• Installation
• Permissions
• Usage
• Options
• Contributing

Installation

Install the latest stable release from deno.land (or nest.land):

deno install --allow-read --allow-run=git --allow-write -n mod https://deno.land/x/mod@v2.2.6/mod.ts

Or install the latest unstable (unreleased) version from GitHub:

deno install --allow-read --allow-run=git --allow-write -n mod https://raw.githubusercontent.com/GJZwiers/mod/main/mod.ts

To upgrade, run the command with a new version number and include -f.

Permissions

mod requires the following permissions

• read: to check if files already exists before writing.
• run=git: to run git commands, more specifically git init
• write: to make files as part of the module initialization.

Usage

mod

This will create the following file structure in the current working directory:

.
├── .gitignore
├── deps.ts
├── dev_deps.ts
├── mod.ts

Note that mod does not overwrite files unless --force is used explicitly. This means the program can also be used to ‘fill in the blanks’ in a directory where not all of the files above are present yet.

Also note that mod does not perform editor-specific setups such as enabling Deno in VS Code via .vscode/settings.json.

If git is installed on the machine then git init will be run as well.

To create the new module in a new directory:

mod --name my_deno_module

This will create the following file and directory structure:

.
├── my_deno_module
|   ├── .gitignore
|   ├── deps.ts
|   ├── dev_deps.ts
|   ├── mod.ts

mod can also create other files along with the basics, such as a pipeline:

mod -n my_deno_module --ci

.
├── my_deno_module
|   ├── .github
|   |   ├── workflows
|   |   |   ├── build.yaml
|   ├── .gitignore
|   ├── deps.ts
|   ├── dev_deps.ts
|   ├── mod.ts

You can also initialize with JavaScript:

mod --js

.
├── .gitignore
├── deps.js
├── dev_deps.js
├── mod.js

Options

mod can create other files with the module, such as an import map or a Deno configuration file. To see what options and flags are available use mod --help if you have the CLI installed or deno run https://deno.land/x/mod@v2.2.6/mod.ts --help

Contributing

Bug reports and feature requests are very welcome!