Viteburner

Daemon tools of bitburner using vite for script transform, file syncing, RAM monitoring and more!

Why viteburner

• Write dynamic config in TypeScript and JavaScript.
• No need to monitor your dist folder anymore.
• Manual upload/download any time you wish.
• Monitor RAM usage of your selected scripts easily.
• Interactive CLI and well-formatted outputs.
• IDE and system independent.
• Vite is faster than tsc for TypeScript transform.
• Utilize various vite plugins.

Quick start

Prerequisites: Node.js

Using viteburner-template

git clone https://github.com/Tanimodori/viteburner-template.git
cd viteburner-template
npm i
npm run dev

In bitburner, select "Options > Remote API", enter the port of viteburner displays (default: 12525) and click "Connect".

checkout Quick Start for more details if you want to use viteburner in your existing project.

API

For detailed documentation, checkout docs.

export interface ViteBurnerUserConfig {
  watch?: WatchItem[];
  usePolling?: boolean | { interval?: number; binaryInterval?: number };
  sourcemap?: boolean | 'inline' | 'hidden';
  port?: number;
  timeout?: number;
  dts?: string | boolean;
  ignoreInitial?: boolean;
  download?: {
    server?: string | string[];
    location?: (file: string, server: string) => string | null | undefined;
    ignoreTs?: boolean;
    ignoreSourcemap?: boolean;
  };
  dumpFiles?: string | null | undefined | ((file: string, server: string) => string | null | undefined);
}

export interface WatchItem {
  pattern: string;
  transform?: boolean;
  location?: RenameOutput | ((file: string) => RenameOutput);
}

export type RenameOutput = string | RenameOutputObject | Array<string | RenameOutputObject> | null | undefined;

export type RenameOutputObject = {
  filename?: string;
  server?: string;
};

Thanks

Thank them for inspiring this package.

• acorn
• bitburner
• bitburner-filesync
• unconfig
• vite
• vitest
• vite-node

License

MIT License © 2022-present Tanimodori