@git.zone/tswatch
A TypeScript file watcher that automatically recompiles and executes your project when files change. Designed to streamline development workflows for various TypeScript project types.
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
Prerequisites
- Node.js (v14 or higher)
- pnpm (recommended) or npm
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();
Custom Watchers
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
const watcher = new Watcher({
filePathToWatch: './src',
functionToCall: async () => {
console.log('Files changed!');
// Your custom logic here
}
});
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 modestartTs
: For service/website modesbuild
: For general compilation
-
File Organization: Keep TypeScript files in
ts/
(backend) andts_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 that is licensed under the MIT License. A copy of the MIT License can be found in the license file within this repository.
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 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, and any usage must be approved in writing by Task Venture Capital GmbH.
Company Information
Task Venture Capital GmbH
Registered at District court Bremen HRB 35230 HB, Germany
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.