git.zone/tswatch
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix(core): Replace smartchok/smartfile with smartwatch/smartfs, update watcher and plugins, and bump dependencies

Browse Source
This commit is contained in:
Jürgen Kunz
2025-12-01 12:03:00 +00:00
parent f73ca7ac2f
commit bcbf6fc139
11 changed files with 2681 additions and 1644 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
readme.md
View File

@@ -2,6 +2,10 @@
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/](https://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/](https://code.foss.global/) account to submit Pull Requests directly.
## Features
- 🔄 **Automatic recompilation** on file changes
@@ -11,11 +15,6 @@ A TypeScript file watcher that automatically recompiles and executes your projec
- 🛠️ **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:
@@ -44,6 +43,7 @@ tswatch service
## CLI Commands
### `tswatch` or `tswatch npm`
Watches TypeScript files and runs `npm test` on changes. This is the default mode.
```bash
@@ -53,6 +53,7 @@ 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/`
@@ -64,6 +65,7 @@ tswatch element
```
### `tswatch service`
Watches TypeScript files in `./ts/` and runs `npm run startTs` on changes. Ideal for backend services.
```bash
@@ -71,6 +73,7 @@ tswatch service
```
### `tswatch website`
Full website development mode:
- Bundles TypeScript files to `dist_serve/`
- Processes HTML files
@@ -82,6 +85,7 @@ tswatch website
```
### `tswatch test`
Runs `npm run test2` whenever files change. Useful for projects with custom test scripts.
```bash
@@ -93,6 +97,7 @@ tswatch test
tswatch expects certain project structures depending on the mode:
### NPM/Node Projects
```
project/
├── ts/ # TypeScript source files
@@ -101,6 +106,7 @@ project/
```
### Element Projects
```
project/
├── ts/ # Backend TypeScript
@@ -111,6 +117,7 @@ project/
```
### Website Projects
```
project/
├── ts/ # Backend TypeScript
@@ -137,8 +144,23 @@ await watcher.start();
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:
```typescript
import { Watcher } from '@git.zone/tswatch';
@@ -154,6 +176,8 @@ await customWatcher.start();
### Using Function Callbacks
```typescript
import { Watcher } from '@git.zone/tswatch';
const watcher = new Watcher({
filePathToWatch: './src',
functionToCall: async () => {
@@ -161,8 +185,19 @@ const watcher = new Watcher({
// 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:
@@ -178,6 +213,7 @@ Access your project at `http://localhost:3002` when running in element mode.
1. **TypeScript Config**: Ensure your `tsconfig.json` is properly configured for your target environment
2. **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
@@ -186,44 +222,54 @@ Access your project at `http://localhost:3002` when running in element mode.
## Common Use Cases
### Developing a Node.js Library
```bash
tswatch npm
```
Automatically runs tests when you modify source files.
### Building a Web Component
```bash
tswatch element
```
Get instant feedback with live reload while developing custom elements.
### Creating a Backend Service
```bash
tswatch service
```
Automatically restart your service on code changes.
### Full-Stack Web Application
```bash
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](license) file within this repository.
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [LICENSE](./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 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.
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.
### Company Information
Task Venture Capital GmbH
Registered at District court Bremen HRB 35230 HB, Germany
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.
For any legal inquiries or 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.