onlykit

Because is the only dependency you need.

onlykit is a meta-package that aggregates essential dependencies to build CLI and web applications with Node.

Install onlykit already gives you the main dependencies to run, build, develop, lint your application. On top of that, it also provides a CLI that wraps common commands to make your life easier, providing good defaults and sensible options.

onlykit also provide a custom transformation on the builder to give you the possibility to build and compile WAMS module via directive to easily use in your codebase.

Packages by export

• 🚀 onlykit/benchmark: A set of packages related to benchmarking
  • mitada
• ⚙️ onlykit/cli: A set of packages to create CLI applications
  • chalk
  • commander
  • execa
  • figlet
  • ora
• 🌐 onlykit/client: HTTP client utilities
  • ky
• 🛠️ onlykit/dev: Base configuration and tools for development and building
  • TypeScript
  • Biome
  • tsdown
  • Rolldown
• 🌍 onlykit/server: A set of packages to create web server applications
  • Hono
  • @hono/zod-validator
• ✅ onlykit/validation: A set of packages for data validation
  • Zod
• 🧩 onlykit/wasm: WASM compilation and transformation
  • AssemblyScript
  • Rolldown (custom plugin to compile AssemblyScript files)

Install

It's highly recommended to use pnpm as package manager, due to it's disk space efficiency (see more here), since onlykit depends on a lot of packages. So for this documentation, we will assume you are using pnpm, but you can use any package manager you want.

pnpm install onlykit

Scaffolding a new project

First, initialize a new project with:

pnpm init

Then, install onlykit as a dependency:

pnpm install onlykit

Now, you can use onlykit to scaffold a new project with the following command:

pnpx onlykit init .

If pnpx do not found the command, you can also run it with npx, event if you installed onlykit with pnpm:

npx onlykit init .

onlykit provides a few templates to start from. You can specify the template with the --template option:

pnpx onlykit init my-app --template cli

Usage

Once you have installed onlykit, you can use the CLI to run common commands. You can see the available commands by running:

pnpx onlykit --help

If you scaffolded a new project, you already have some scripts in your package.json to start developing your application. You can run them with:

pnpm run dev

Using the exports

The dependencies are grouped by functionality and can be imported from the corresponding path. They interface are transparent, whitch means you can use them as if you installed them directly.

import { chalk } from "onlykit/cli";
import { Hono } from "onlykit/server";
import { z } from "onlykit/validation";
// ...

WASM Support (use wasm)

onlykit provides built-in support for WebAssembly (WASM) through AssemblyScript. You can easily integrate and compile WASM modules in your project using a special directive.

The following example shows how to use the use wasm directive:

"use wasm";

export function add(a: i32, b: i32): i32 {
  return a + b;
}

By adding the "use wasm"; directive at the top of your AssemblyScript file, onlykit will automatically handle the compilation and integration of the WASM module into your project.

You can then import and use the compiled WASM module in your TypeScript code as follows:

import { chalk } from "onlykit/cli";
import { add } from "./wasm-module";

export function main() {
  const result = add(2, 3);

  console.log(chalk.blue(`2 + 3 = ${result}`));
}

main();

As said before, the compilation is made by AssemblyScript, so you need to know their concepts, syntax and limitations. You can find more information in the AssemblyScript documentation.

Philosophy

onlykit is designed to be the only dependency you need to build modern Node.js applications. It aggregates essential packages and provides a streamlined development experience, allowing you to focus on writing code rather than managing dependencies and configurations.

The packages was selected following these principles:

• Essential: Only include packages that are widely used and essential for building applications.
• Open Source: Prefer open-source packages with active communities and good maintenance.
• License: Ensure all packages have permissive licenses suitable for commercial use.
• Performance: Choose packages that are performant and efficient.
• Developer Experience: Focus on packages that enhance the developer experience with good documentation and ease of use.
• Good Defaults: Provide sensible defaults and configurations to minimize setup time.

Contributing

Contributions are welcome! If you have suggestions for new packages to include, improvements to the CLI, or any other ideas, please open an issue or submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.