dzp v1.5.8

About

DeniZip (dzp), the Denizen Project Manager, is a command-line tool that aids in the creation of DenizenScript projects.

Features

• Intuitive interface
• Customizable
• Multiple styles
• Dependency manager
• Efficient, lightweight

Setup

Requires Node.js v12 or newer. Install the package globally:

npm install dzp -g

Example

Make a new directory for your project - it works in the Denizen plugin's scripts folder too!

mkdir fiery && cd fiery

Run dzp new, and enter the corresponding values for the prompts.

project name: Fiery
acronym: fy
description: Set anything on fire
version: (1.0.0)
repository: https://github.com/cool_guy78/fiery
author: cool_guy78

In your directory, you'll see the following directory tree appear:

deps/
src/
├─ data/
│  ├─ config.dsc
├─ main/
│  ├─ fiery.dsc
├─ util/
.gitignore
dzp.json
LICENSE
README.md

If you're going for a one-file project, try using the --style drop-in flag.

The Denizen files and README are pre-fitted with boilerplate code, and the dzp.json file holds the information that you entered upon initialization.

Advanced Documentation

Commands

View all commands with dzp help --usage. To view a specific command and its extended description, run dzp <command> --help.

compile

Usage: dzp compile <path> Compiles the project to a single file.

get

Usage: dzp get <key> Retrieves a project config value.

help

Usage: dzp help [--usage] Displays the help message.

install

Usage: dzp install [<repo>] [--here] [--update] Installs a dependency chain.

new

Usage: dzp new [--style <style>] [--spacing <spaces>] [--no-deps] [--no-git] Creates a new DeniZip project.

readme

Usage: dzp readme [--json] [--use <path>] Generates a README file.

script

Usage: dzp script [<name>] [--list] [--data] [--save] [--force] [--no-deps] Finds info about a script.

set

Usage: dzp set <key> <value> Updates a project config value.

style

Usage: dzp style [<name>] Lists the loaded style names.

uninstall

Usage: dzp uninstall <name> [--here] Uninstalls a dependency.

License

MIT © 2021 Kyle Prince