@sonnyt/just NPM

Just

Zero config TypeScript build and development toolkit.

Features

Fast SWC compiler
TypeScript type check support
Live reload support
.env file support
Path alias support
Typescript script runner
REPL support

Install

# Locally in your project.
npm install -D @sonnyt/just

# Or globally
npm install -g @sonnyt/just

Usage

To start a dev server in the root of your project just (😉) run:

just dev

To build:

just build

Commands

Build

just build [options] [files]

Compiles the application for production deployment.

Arguments

files - glob file path to compile. If not present, includes from config.json is used.

Dev

just dev [options] [entry]

Starts the application in development mode. Watches for any file changes and live reloads the server.

Arguments

entry - server entry path to start. If not present, main from package.json is used.

Run

just run [options] <command> [args...]

Runs .ts file scripts.

Arguments

<command> - script/command to run.
[args...] - arguments passed to the script/command.

Programmatic

You can require Just runner programmatically two ways:

Import Just as early as possible in your application code.

require('@sonnyt/just/register');

Or you can use the --require (-r) command line option to preload Just. By doing this, you do not need to require and load Just in your application code.

node -r @sonnyt/just/register myscript.ts

Please note that runner does not support type checking.

Default Config File

Just automatically finds and loads tsconfig.json or jsconfig.json. By default, this search is performed relative to the entrypoint script. If neither file is found nor the file is not provided as an argument. Just falls back to using default settings shown below.

{
  "compilerOptions": {
    "module": "CommonJS",
    "target": "ES2021",
    "moduleResolution": "Node",
    "inlineSourceMap": true,
    "strict": true,
    "baseUrl": "./",
    "experimentalDecorators": true,
    "emitDecoratorMetadata": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "importHelpers": true,
    "outDir": "dist",
    "paths": {}
  },
  "include": [
    "./"
  ],
  "exclude": [
    "node_modules"
  ]
}

Environment Variables

When using the dev or run commands. Just automatically finds and loads environment variables from a .env file into process.env. By default, this search is performed relative to the entrypoint script.