@litsx/typescript 0.6.0

package/README.md

@@ -0,0 +1,85 @@
+# @litsx/typescript
+
+[![npm](https://img.shields.io/badge/npm-@litsx%2Ftypescript-CB3837)](https://www.npmjs.com/package/@litsx/typescript)
+[![Release](https://img.shields.io/badge/release-public-2ea44f)](../../RELEASING.md)
+[![CLI](https://img.shields.io/badge/entrypoint-plugin%20%2B%20CLI-8250df)](./package.json)
+[![Provenance](https://img.shields.io/badge/npm_provenance-enabled-2ea44f)](../../RELEASING.md)
+
+TypeScript language-service support for LitSX-authored JSX.
+
+The plugin exists to make editor tooling tolerate Lit-flavoured JSX attributes such as:
+
+- `@click={handle}`
+- `.value={model.value}`
+- `?disabled={busy}`
+
+## Scope
+
+The plugin virtualizes prefixed JSX attribute names into TypeScript-safe names for the language service and then remaps the results back to the authored LitSX syntax.
+
+It provides:
+
+- tolerance for `@event`, `.prop` and `?attr` in `.jsx`, `.tsx`, `.litsx`, and `.litsx.jsx`
+- remapped diagnostics and quick info spans
+- filtered completions that hide the internal `__litsx_*` names
+- contextual completions for `@event`, `.prop` and `?attr`
+- authored diagnostics for obviously invalid Lit bindings
+- a `litsx-tsc` CLI path for virtualized type-checking when authored source uses Lit<sup>sx</sup>-specific syntax that plain `tsc` cannot parse directly
+
+It does not provide:
+
+- exhaustive DOM/custom-element semantics for every tag
+- editor refactors or quick-fixes
+- remapped rename/find-references flows
+
+## Usage
+
+```json
+{
+  "compilerOptions": {
+    "jsx": "react-jsx",
+    "jsxImportSource": "@litsx/core",
+    "plugins": [
+      { "name": "@litsx/typescript" }
+    ]
+  }
+}
+```
+
+For a workspace using the local package directly, the same shape works in `tsconfig.json`:
+
+```json
+{
+  "compilerOptions": {
+    "jsx": "react-jsx",
+    "jsxImportSource": "@litsx/core",
+    "plugins": [
+      {
+        "name": "@litsx/typescript"
+      }
+    ]
+  }
+}
+```
+
+VS Code picks this up through the bundled TypeScript server when the workspace is using the project `tsconfig.json`.
+
+## Exports
+
+- `@litsx/typescript`
+- `@litsx/typescript/editor-session`
+- `@litsx/typescript/virtualization`
+- `@litsx/typescript/typecheck`
+
+The `virtualization` entrypoint exposes the standalone source virtualization helper used internally by the plugin.
+The `editor-session` entrypoint exposes a project-backed editor service for integrations such as VS Code extensions that need LitSX-aware diagnostics, hover, and completions outside the tsserver plugin host. It complements the tsserver plugin rather than replacing it.
+
+## CLI Typecheck
+
+If a project wants CLI type-checking for authored syntax such as `@click`, `.value`, `?disabled`, or `static styles = ...`, use the virtualized wrapper instead of calling plain `tsc` directly:
+
+```sh
+litsx-tsc -p tsconfig.json --noEmit
+```
+
+This is a toolchain/CI concern, not a replacement for the editor plugin. The editor DX still comes from the tsserver plugin.