eibens / edcb

A build tool and task runner for Deno.
MIT License
0 stars 0 forks source link
build ci deno formatting github-actions linting testing typescript

edcb

edcb is a build tool and task runner for Deno. It has support for formatting, linting, testing, code coverage, bundling, and more, and it can be used via command line or TypeScript import.

License deno.land/x Repository ci codecov

edcb in action

Features

Usage

Install the edcb CLI with Deno:

deno install -f -A --unstable https://deno.land/x/edcb/cli.ts

These are basic commands:

# show help text
edcb --help

# run formatter, linter, tests, and bundler
edcb build

# start development server
edcb serve

Config

Before it does anything else, edcb will look for the dev.ts module in the working directory and run it if it exists. This allows one to lock a particular edcb version to a project, provide default values for options, and add complex configuration such as the bundles option. The edcb CLI then essentially becomes an alias for this:

deno run -A --unstable dev.ts [...args]

The mod.ts module exports the cli function, which can be used to run the CLI using TypeScript. The specified options are used as defaults. For example, one can specify the ignore option, which will then be used if the --ignore option was not provided on the command-line. This is an example of a dev.ts file that uses edcb's TypeScript API:

/**
 * Always import a specific version of edcb.
 * Otherwise, your builds might break when edcb updates.
 *
 * @example
 *   import { cli } from "https://deno.land/x/edcb@v1.0.0/mod.ts";
 */
import { cli } from "./mod.ts";

await cli({
  ignore: "index.js",
  reload: true,
  bundles: [{
    source: "index.ts",
    target: "index.js",
  }],
});