Skip to content

Commit b26904c

Browse files
committed
docs: clarify PoC status of ts-plugin
1 parent 07f528f commit b26904c

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,12 @@ A TypeScript utility for Go-style structured error handling (`[data, error]`) co
1212

1313
This repository provides two key components designed to work together:
1414

15-
1. **`@maxmorozoff/try-catch-tuple`:** A utility function for wrapping synchronous or asynchronous operations, returning a tuple `[data, error]` inspired by Go's error handling pattern (error last).
16-
2. **`@maxmorozoff/try-catch-tuple-ts-plugin`:** Tooling (Language Service Plugin + Build Transformer) that integrates with TypeScript to enforce correct destructuring and handling of the `[data, error]` tuple returned by the utility.
15+
1. **[`try-catch-tuple`](#trycatch-utility-maxmorozofftry-catch-tuple):** A utility function for wrapping synchronous or asynchronous operations, returning a tuple `[data, error]` inspired by Go's error handling pattern (error last).
16+
2. **[`try-catch-tuple-ts-plugin`](#plugin--transformer-maxmorozofftry-catch-tuple-ts-plugin):** Tooling (Language Service Plugin + Build Transformer) that integrates with TypeScript to enforce correct destructuring and handling of the `[data, error]` tuple returned by the utility.
17+
18+
> [!IMPORTANT]
19+
> While `try-catch-tuple` is considered production-ready due to its minimal implementation approach,
20+
> `try-catch-tuple-ts-plugin` is a proof of concept (PoC) and still in its early stages.
1721
1822
## Showcase: Plugin & Code Fixes
1923

0 commit comments

Comments
 (0)