resultar 3.3.1 → 3.5.0

package/README.md

@@ -45,7 +45,7 @@ Use it when expected failures should be impossible to miss:
 - Ignored `Result` values can be reported by a type-aware no-discard check.
 
 Resultar began as an initial fork of `neverthrow`. The v3 line keeps the explicit wrapper model,
-then leans into Resultar-specific tagged errors, strict service-boundary types, TypeScript 7-first
+then leans into Resultar-specific tagged errors, strict service-boundary types, TypeScript >=7
 diagnostics, and ESM-only packaging.
 
 ## Install
@@ -61,7 +61,7 @@ npm install resultar
 ## Requirements
 
 - Node.js 24+
-- TypeScript 7 for the canonical Resultar diagnostics workflow
+- TypeScript >=7 for the canonical Resultar diagnostics workflow
 - ESM only
 
 ```ts
@@ -738,6 +738,21 @@ const lines = ResultAsync.withResource({
 })
 ```
 
+Adapt callback and subscription APIs with `ResultAsync.fromCallback`. The callback source can
+resolve or reject once, receives the cooperative signal, and returns a synchronous unsubscribe
+function that runs after success, failure, or cancellation.
+
+```ts
+const nextValue = ResultAsync.fromCallback<number, SubscriptionError>({
+  catch: (cause) => new SubscriptionError({ cause }),
+  signal,
+  subscribe: ({ reject, resolve }) => {
+    const subscription = source.subscribe({ error: reject, next: resolve })
+    return () => subscription.unsubscribe()
+  },
+})
+```
+
 For pull-based streams, keep the runtime native: expose an `AsyncIterable<Result<T, E>>` and close
 resources in `finally`. See
 [DOCUMENTATION.md](../../DOCUMENTATION.md#resourceful-async-iterables) for the full recipe.
@@ -756,6 +771,7 @@ where the failure appears.
 | Catch thrown sync code now | `tryResult(fn, toError?)` |
 | Wrap a throwing sync function for later | `fromThrowable(fn, toError?)` |
 | Catch an existing rejecting promise | `fromPromise(promise, toError)` |
+| Adapt a callback or subscription | `ResultAsync.fromCallback({ subscribe, catch, signal? })` |
 | Catch a promise or async factory | `tryResultAsync(promiseOrFactory, toError?)` |
 | Wrap an async function for later | `fromThrowableAsync(fn, toError?)` |
 | Turn one error into another | `mapErr(fn)` |
@@ -836,6 +852,27 @@ Use `fromPromise` when you already have a promise and need to map rejection into
 const user = fromPromise(loadUserFromRemote(id), (cause) => new FetchUserError({ cause, id }))
 ```
 
+Use `tryResultAsync` when the async boundary is the thing you want to name and document. The object
+form is useful for infrastructure helpers because the task and error mapper stay together:
+
+```ts
+import { createTaggedError, tryResultAsync } from 'resultar'
+import type { StrictResultAsync } from 'resultar'
+
+type AsyncTask = () => Promise<void>
+
+class TaskError extends createTaggedError({
+  name: 'TaskError',
+  message: 'Task failed: $label',
+}) {}
+
+const tryTask = (label: string, task: AsyncTask): StrictResultAsync<void, TaskError> =>
+  tryResultAsync({
+    try: task,
+    catch: (cause) => new TaskError({ cause, label }),
+  })
+```
+
 After that edge conversion, keep your own domain functions returning `Result` values instead of
 throwing expected failures.
 
@@ -950,11 +987,11 @@ const config = safeTry({
 
 ## No-Discard Validation
 
-Resultar values should not be ignored. Use `resultar-check` to run TypeScript 7 and Resultar
+Resultar values should not be ignored. Use `resultar-check` to run TypeScript >=7 and Resultar
 diagnostics through one command.
 
 ```sh
-pnpm add -D resultar-check typescript-7@npm:typescript@rc
+pnpm add -D resultar-check "typescript@>=7"
 ```
 
 Add a check script:
@@ -962,11 +999,13 @@ Add a check script:
 ```json
 {
   "scripts": {
-    "check": "resultar-check -p tsconfig.json --noEmit"
+    "check": "resultar-check"
   }
 }
 ```
 
+`resultar-check` defaults to `tsconfig.json` and runs TypeScript with no emit.
+
 These fail in the default `must-use` mode:
 
 ```ts
@@ -990,14 +1029,22 @@ Configure Resultar rules in `tsconfig.json`:
 
 ```json
 {
+  "$schema": "./node_modules/resultar-check/schema.json",
   "compilerOptions": {
     "plugins": [{ "name": "resultar-check", "noDiscard": "error" }]
   }
 }
 ```
 
-Oxlint is intentionally not part of the Resultar rules path; use it only for general linting if your
-project wants it.
+The package-local schema provides editor completion and validation for `resultar-check` plugin
+options.
+
+For fast AST-only Oxlint, ESLint, or Deno Lint feedback, use the adapter exports documented in the
+`resultar-check` package guide. Use the `resultar-check` CLI for the full TypeScript-backed rule set.
+The `examples/lint` package shows how to compare Oxlint, ESLint, and CLI counts by running the CLI
+with the same AST-only rule subset.
+
+For VS Code and Zed setup, use the editor integration section in the `resultar-check` package guide.
 
 ## API Decision Guide
 
@@ -1010,6 +1057,7 @@ project wants it.
 | Create an `Ok(undefined)` | `unit()` or `unitAsync()` |
 | Convert throwing sync code | `tryResult` or `fromThrowable` |
 | Convert rejecting async code | `tryResultAsync`, `fromPromise`, or `fromThrowableAsync` |
+| Convert a callback subscription | `ResultAsync.fromCallback` or `fromCallback` |
 | Treat an `Err` as unrecoverable at an edge | `unwrapOrThrow()` |
 | Transform success | `map` or `asyncMap` |
 | Replace success with a known value | `as(value)` |
@@ -1076,19 +1124,17 @@ More focused material:
 - [Full guide](https://github.com/inaiat/resultar/blob/main/DOCUMENTATION.md)
 - [Type-safe error handling article, English](https://github.com/inaiat/resultar/blob/main/articles/en/type-safe.md)
 - [Artigo sobre tratamento de erros type-safe, Portuguese](https://github.com/inaiat/resultar/blob/main/articles/pt/type-safe.md)
-- [resultar-check package guide](https://github.com/inaiat/resultar/blob/main/packages/resultar-check/README.md)
+- [resultar-check package guide](https://github.com/inaiat/resultar/blob/main/packages/check/README.md)
 
 ## Repository
 
 This repository is a pnpm workspace:
 
 - `packages/resultar`: Resultar runtime package.
-- `packages/resultar-check`: TypeScript 7 plus Resultar validation.
-- `packages/resultar-lint`: deprecated compatibility wrapper.
-- `packages/resultar-tsgo`: deprecated compatibility wrapper for older installs.
+- `packages/check`: TypeScript >=7 plus Resultar validation and AST-only lint adapters.
 - `benchmarks`: benchmark package.
 - `examples/resultar`: runnable core Resultar cookbook.
-- `examples/lint`: TypeScript 7 `resultar-check` smoke example.
+- `examples/lint`: adapter parity smoke for AST-only Resultar rules across Oxlint, ESLint, and `resultar-check` CLI.
 
 Common commands: