resultar 3.0.0-alpha.2 → 3.0.0

package/README.md

@@ -22,8 +22,8 @@ Use it when expected failures should be impossible to miss:
   code.
 - Ignored `Result` values can be reported by a type-aware no-discard check.
 
-Resultar began as an initial fork of `neverthrow`. The v3 alpha line keeps the explicit wrapper
-model, then leans into Resultar-specific tagged errors, strict service-boundary types, TypeScript 6
+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 6
 support, and ESM-only packaging.
 
 ## Install
@@ -97,7 +97,7 @@ in normal TypeScript.
 | Production errors need stable names and metadata | `createTaggedError` classes with `_tag`, template props, `cause`, and `.toJSON()` |
 | Async flows turn into nested `try/catch` | `tryResultAsync`, `andThen`, `asyncAndThen`, `map`, `orElse`, `safeTry` |
 | Boundary handlers miss cases | `matchTags` for exhaustive tagged-error handling |
-| Results are easy to ignore | `resultar-no-discard` and the `resultar-ls` TypeScript plugin |
+| Results are easy to ignore | `resultar-lint check` and the `resultar-lint` TypeScript plugin |
 | You do not want another application runtime | A small ESM library around explicit values |
 
 Nested `try/catch` often masks the error the caller actually needs:
@@ -562,11 +562,11 @@ const config = safeTry({
 
 ## No-Discard Validation
 
-Resultar values should not be ignored. Install `resultar-ls` to report discarded `Result` and
+Resultar values should not be ignored. Install `resultar-lint` to report discarded `Result` and
 `ResultAsync` values.
 
 ```sh
-pnpm add -D resultar-ls typescript
+pnpm add -D resultar-lint typescript
 ```
 
 Add a lint-like script:
@@ -574,31 +574,36 @@ Add a lint-like script:
 ```json
 {
   "scripts": {
-    "lint:resultar": "resultar-no-discard --project tsconfig.json"
+    "lint:resultar": "resultar-lint check --project tsconfig.json"
   }
 }
 ```
 
-This fails:
+These fail in the default `must-use` mode:
 
 ```ts
 saveUser(input)
+const result = saveUser(input)
 ```
 
 These are intentional:
 
 ```ts
-const result = saveUser(input)
 return saveUser(input)
 void saveUser(input)
+saveUser(input).match(handleSaved, handleError)
 ```
 
+The default mode is neverthrow-style `must-use`: it also reports assigned `Result` values that are
+only passed around and never consumed with `match`, `unwrapOr`, `_unsafeUnwrap`, `isOk`, `isErr`,
+returned, or explicitly discarded. Use `--mode direct` for the lower-noise expression-only check.
+
 For editor diagnostics, enable the TypeScript language-service plugin:
 
 ```json
 {
   "compilerOptions": {
-    "plugins": [{ "name": "resultar-ls", "noDiscard": "error" }]
+    "plugins": [{ "name": "resultar-lint", "noDiscard": "error" }]
   }
 }
 ```
@@ -607,9 +612,9 @@ TypeScript language-service plugins are editor-only by default. To make `tsc` re
 diagnostics during builds, patch the local TypeScript installation:
 
 ```sh
-pnpm exec resultar-ls patch
-pnpm exec resultar-ls check
-pnpm exec resultar-ls unpatch
+pnpm exec resultar-lint patch
+pnpm exec resultar-lint doctor
+pnpm exec resultar-lint unpatch
 ```
 
 For TypeScript 7 native-preview projects, `resultar-tsgo` exposes a `tsgo` wrapper that runs native
@@ -645,9 +650,9 @@ TypeScript and then Resultar no-discard validation.
 | Throw intentionally at a final edge | `unwrapOrThrow()` |
 | Default intentionally at a final edge | `unwrapOr(defaultValue)` |
 
-## Version 3 Alpha Notes
+## Version 3 Notes
 
-`3.0.0-alpha.1` is a semver-major prerelease:
+`3.0.0` is a semver-major release:
 
 - `no-discard` tooling moved out of the runtime package and into dedicated packages.
 - TypeScript peer support is now `>=6.0.0`.
@@ -667,26 +672,27 @@ and `tryResultAsync` in new code and docs.
 
 ## Documentation
 
-This README is the project entry point. For a full guide with larger examples and the complete API
-map, see [DOCUMENTATION.md](DOCUMENTATION.md).
+This README is the runtime package entry point. For a full guide with larger examples and the
+complete API map, see the repository documentation.
 
 More focused material:
 
-- [Type-safe error handling article, English](articles/en/type-safe.md)
-- [Artigo sobre tratamento de erros type-safe, Portuguese](articles/pt/type-safe.md)
-- [resultar-ls package guide](packages/resultar-ls/README.md)
-- [resultar-tsgo package guide](packages/resultar-tsgo/README.md)
+- [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-lint package guide](https://github.com/inaiat/resultar/blob/main/packages/resultar-lint/README.md)
+- [resultar-tsgo package guide](https://github.com/inaiat/resultar/blob/main/packages/resultar-tsgo/README.md)
 
-## Workspace
+## Repository
 
 This repository is a pnpm workspace:
 
 - `packages/resultar`: Resultar runtime package.
-- `packages/resultar-ls`: TypeScript language-service diagnostics and no-discard CLI.
+- `packages/resultar-lint`: TypeScript language-service diagnostics and no-discard CLI.
 - `packages/resultar-tsgo`: TypeScript 7 native-preview `tsgo` wrapper plus Resultar no-discard
   validation.
 - `benchmarks`: benchmark package.
-- `examples/language-service`: TypeScript 6 no-discard smoke example.
+- `examples/resultar-lint`: TypeScript 6 no-discard smoke example.
 - `examples/tsgo`: TypeScript 7 native-preview smoke example.
 
 Common commands:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "resultar",
-  "version": "3.0.0-alpha.2",
+  "version": "3.0.0",
   "description": "Result pattern for TypeScript",
   "keywords": [
     "error-handling",