Merge pull request #4 from maxmorozoff/ts-plugin

feat: introduce ts-plugin

Author: maxmorozoff

.changeset/lazy-insects-hammer.md

@@ -0,0 +1,5 @@
+---
+"@maxmorozoff/try-catch-tuple": patch
+---
+
+introduce branded tuple type

.changeset/slow-showers-matter.md

@@ -0,0 +1,5 @@
+---
+"@maxmorozoff/try-catch-tuple-ts-plugin": patch
+---
+
+introduce ts plugin and transformer

LICENSE

@@ -1,6 +1,5 @@
-MIT License
-
-Copyright (c) 2025 Flowscripter
+The MIT License (MIT)
+Copyright (c) 2025 Max Morozov
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -26,7 +26,8 @@
   "linter": {
     "enabled": true,
     "rules": {
-      "recommended": true
+      "recommended": true,
+      "suspicious": { "noExplicitAny": "off" }
     }
   },
   "javascript": {

biome.json

@@ -0,0 +1,175 @@
+# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore
+
+# Logs
+
+logs
+_.log
+npm-debug.log_
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Caches
+
+.cache
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+
+report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
+
+# Runtime data
+
+pids
+_.pid
+_.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+
+lib-cov
+
+# Coverage directory used by tools like istanbul
+
+coverage
+*.lcov
+
+# nyc test coverage
+
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+
+bower_components
+
+# node-waf configuration
+
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+
+build/Release
+
+# Dependency directories
+
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+
+web_modules/
+
+# TypeScript cache
+
+*.tsbuildinfo
+
+# Optional npm cache directory
+
+.npm
+
+# Optional eslint cache
+
+.eslintcache
+
+# Optional stylelint cache
+
+.stylelintcache
+
+# Microbundle cache
+
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+
+.node_repl_history
+
+# Output of 'npm pack'
+
+*.tgz
+
+# Yarn Integrity file
+
+.yarn-integrity
+
+# dotenv environment variable files
+
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+
+.parcel-cache
+
+# Next.js build output
+
+.next
+out
+
+# Nuxt.js build / generate output
+
+.nuxt
+dist
+
+# Gatsby files
+
+# Comment in the public line in if your project uses Gatsby and not Next.js
+
+# https://nextjs.org/blog/next-9-1#public-directory-support
+
+# public
+
+# vuepress build output
+
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+
+.temp
+
+# Docusaurus cache and generated files
+
+.docusaurus
+
+# Serverless directories
+
+.serverless/
+
+# FuseBox cache
+
+.fusebox/
+
+# DynamoDB Local files
+
+.dynamodb/
+
+# TernJS port file
+
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+
+.vscode-test
+
+# yarn v2
+
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+# IntelliJ based IDEs
+.idea
+
+# Finder (MacOS) folder config
+.DS_Store

bun.lock

@@ -0,0 +1,15 @@
+# test-ts-plugin
+
+To install dependencies:
+
+```bash
+bun install
+```
+
+To run:
+
+```bash
+bun run index.ts
+```
+
+This project was created using `bun init` in bun v1.2.2. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.

examples/ts-plugin-example/.gitignore

@@ -0,0 +1,84 @@
+import { tryCatch } from "@maxmorozoff/try-catch-tuple";
+
+{
+  const [user, error] = tryCatch(parseUserJson('{"id":1}')); // ok
+}
+{
+  const [user, ,] = tryCatch(parseUserJson('{"id":1}')); // ok
+}
+{
+  const [user] = tryCatch(parseUserJson('{"id":1}'));
+}
+{
+  const wrappedTryCatch = () => tryCatch(parseUserJson('{"id":1}'));
+  const [user] = wrappedTryCatch();
+}
+{
+  const wrappedTryCatch = () => tryCatch(fetchMeUser);
+  const user = await wrappedTryCatch();
+}
+
+{
+  const [result] = await tryCatch(fetchMeUser);
+}
+{
+  const result = tryCatch(() => null);
+}
+function foo() {
+  const result = tryCatch(() => null);
+}
+const bar = () => {
+  const result = tryCatch(() => null);
+};
+// const data = tryCatch(() => null);
+// let data1 = tryCatch(() => null);
+// export const result = tryCatch(() => null);
+
+{
+  {
+    const [result] = tryCatch(() => null);
+  }
+  {
+    // biome-ignore lint/complexity/noUselessLoneBlockStatements:
+    // biome-ignore lint/style/noVar:
+    // biome-ignore lint/correctness/noInnerDeclarations:
+    var [result] = tryCatch(() => null);
+  }
+  {
+    // biome-ignore lint/style/useSingleVarDeclarator:
+    const foo = "bar",
+      [result] = tryCatch(() => null);
+  }
+  {
+    const wrappedTryCatch = () => tryCatch(() => null);
+    const [result] = wrappedTryCatch();
+  }
+  {
+    const wrappedTryCatch = () => tryCatch(async () => null);
+    const [result] = await wrappedTryCatch();
+  }
+  {
+    const [result] = await tryCatch(async () => null);
+  }
+  {
+    const result = tryCatch(() => null);
+  }
+  function foo() {
+    const result = tryCatch(() => null);
+  }
+  const bar = () => {
+    const result = tryCatch(() => null);
+  };
+  const data = tryCatch(() => null);
+  // biome-ignore lint/style/useConst: <explanation>
+  let data1 = tryCatch(() => null);
+  const result = tryCatch(() => null);
+}
+
+type User = { id: number };
+async function fetchMeUser() {
+  return {} as User;
+}
+function parseUserJson(jsonString: string) {
+  return () => JSON.parse(jsonString) as User;
+}

examples/ts-plugin-example/README.md

@@ -0,0 +1,26 @@
+{
+  "name": "test-ts-plugin",
+  "private": true,
+  "license": "MIT",
+  "author": "Max Morozov <[email protected]",
+  "homepage": "https://github.com/maxmorozoff/try-catch-tuple#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/maxmorozoff/try-catch-tuple.git"
+  },
+  "type": "module",
+  "scripts": {
+    "test:unit": "bun test",
+    "test:types": "tspc --project ./tsconfig.transformer.json",
+    "clean": "rm -rf out && echo done"
+  },
+  "dependencies": {
+    "@maxmorozoff/try-catch-tuple": "workspace:*",
+    "@maxmorozoff/try-catch-tuple-ts-plugin": "workspace:*"
+  },
+  "devDependencies": {
+    "@types/bun": "^1.2.5",
+    "ts-patch": "^3.3.0",
+    "typescript": "^5.0.0"
+  }
+}