A TypeScript file watcher that automatically recompiles and executes your project when files change. Designed to streamline development workflows for various TypeScript project types.

Issue Reporting and Security

For reporting bugs, issues, or security vulnerabilities, please visit community.foss.global/. This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a code.foss.global/ account to submit Pull Requests directly.

Features

🔄 Automatic recompilation on file changes
🚀 Multiple project modes: npm packages, web elements, services, and websites
🌐 Built-in development server with live reload for web projects
⚡ Fast bundling with esbuild integration
🛠️ Flexible CLI and programmatic API
📦 Zero configuration for standard project structures

Installation

Install @git.zone/tswatch globally or as a development dependency:

# Global installation
pnpm install -g @git.zone/tswatch

# As a dev dependency
pnpm install --save-dev @git.zone/tswatch

Quick Start

# Watch and run tests on changes (default behavior)
tswatch

# Watch a web element project with dev server
tswatch element

# Watch a service project
tswatch service

CLI Commands

`tswatch` or `tswatch npm`

Watches TypeScript files and runs npm test on changes. This is the default mode.

tswatch
# or explicitly
tswatch npm

`tswatch element`

Sets up a development environment for web components/elements:

Starts a dev server on port 3002
Bundles TypeScript to dist_watch/
Enables live reload
Watches all ts*/ folders

tswatch element

`tswatch service`

Watches TypeScript files in ./ts/ and runs npm run startTs on changes. Ideal for backend services.

tswatch service

`tswatch website`

Full website development mode:

Bundles TypeScript files to dist_serve/
Processes HTML files
Handles assets
Runs npm run startTs for server-side code

tswatch website

`tswatch test`

Runs npm run test2 whenever files change. Useful for projects with custom test scripts.

tswatch test

Project Structure

tswatch expects certain project structures depending on the mode:

NPM/Node Projects

project/
├── ts/           # TypeScript source files
├── test/         # Test files
└── package.json  # With "test" script

Element Projects

project/
├── ts/           # Backend TypeScript
├── ts_web/       # Frontend TypeScript
├── html/         # HTML templates
│   └── index.ts  # Entry point
└── dist_watch/   # Output directory (auto-created)

Website Projects

project/
├── ts/           # Backend TypeScript
├── ts_web/       # Frontend TypeScript
│   └── index.ts  # Entry point
├── html/         # HTML files
│   └── index.html
├── assets/       # Static assets
└── dist_serve/   # Output directory

Programmatic API

Basic Usage

import { TsWatch } from '@git.zone/tswatch';

// Create and start a watcher
const watcher = new TsWatch('node');
await watcher.start();

// Stop when done
await watcher.stop();

Available Watch Modes

The TsWatch class accepts the following modes:

Mode	Description
`node`	Runs `npm test` on changes (default)
`test`	Runs `npm run test2` on changes
`element`	Web component development with dev server
`service`	Runs `npm run startTs` for services
`website`	Full website mode with bundling
`echo`	Test mode that runs `npm -v`

Custom Watchers

For more granular control, use the Watcher class directly:

import { Watcher } from '@git.zone/tswatch';

const customWatcher = new Watcher({
  filePathToWatch: './src',
  commandToExecute: 'npm run build',
  timeout: 5000 // Optional timeout in ms
});

await customWatcher.start();

Using Function Callbacks

import { Watcher } from '@git.zone/tswatch';

const watcher = new Watcher({
  filePathToWatch: './src',
  functionToCall: async () => {
    console.log('Files changed!');
    // Your custom logic here
  }
});

await watcher.start();

Watcher Options

Option	Type	Description
`filePathToWatch`	`string`	Path to watch for changes
`commandToExecute`	`string`	Shell command to run on changes
`functionToCall`	`() => Promise<any>`	Async function to call on changes
`timeout`	`number`	Optional timeout in milliseconds

Development Server

Element mode includes a built-in development server:

Port: 3002
Features: CORS enabled, gzip compression, live reload
Serve directory: ./dist_watch/

Access your project at http://localhost:3002 when running in element mode.

Configuration Tips

TypeScript Config: Ensure your tsconfig.json is properly configured for your target environment
Package Scripts: Define appropriate scripts in package.json:
- test: For npm mode
- test2: For test mode
- startTs: For service/website modes
- build: For general compilation
File Organization: Keep TypeScript files in ts/ (backend) and ts_web/ (frontend) directories

Common Use Cases

Developing a Node.js Library

tswatch npm

Automatically runs tests when you modify source files.

Building a Web Component

tswatch element

Get instant feedback with live reload while developing custom elements.

Creating a Backend Service

tswatch service

Automatically restart your service on code changes.

Full-Stack Web Application

tswatch website

Handle both frontend and backend compilation with asset processing.

License and Legal Information

This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the LICENSE file.

Please note: The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.

Trademarks

This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.

Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.

readme.md

@git.zone/tswatch