@small-web/kitten-types 1.1.5 → 2.0.0

package/README.md

@@ -4,6 +4,8 @@ Type-safety for [Kitten](https://kitten.small-web.org) apps and sites.
 
 This is a **types-only** package. It declares the global `kitten` namespace (via `declare global`) and exports reusable Kitten types you can use to annotate your own code.
 
+The types are automatically generated from the [Kitten source code](https://codeberg.org/kitten/app).
+
 ## Install
 
 ```shell
@@ -33,7 +35,8 @@ How you add language intelligence and static type checking for Kitten to your pr
 ### JavaScript
 
 1. [Install Kitten Types (@small-web/kitten-types)](#install) as a development-time dependency.
-2. *Either* add `@ts-check` to the tops of your JavaScript files or add a jsconfig.json file to your project to enable type checking.
+
+2. *Either* add `@ts-check` to the tops of your JavaScript files or [add a jsconfig.json file](https://kitten.small-web.org/reference/#jsconfig-json) to your project to enable type checking.
 
 That’s it!
 
@@ -56,7 +59,11 @@ There’s one extra step (compared to JavaScript) when using TypeScript.
 
 1. [Install Kitten Types (@small-web/kitten-types)](#install) as a development-time dependency.
 
-2. Create a tsconfig.json file.
+    ```shell
+    npm install --save-dev @small-web/kitten-types
+    ```
+
+2. [Create a tsconfig.json file.](https://kitten.small-web.org/reference/#tsconfig-json)
 
 3. Create a *globals.d.ts* file in your project:
 

package/fragments.d.ts

@@ -1,14 +1,13 @@
-type Fragment = (props?: {SLOT?: any}) => string
-
-declare module '*.fragment.html' {
-  const fragment: Fragment
-  export default fragment
-}
-declare module '*.fragment.css' {
-  const fragment: Fragment
-  export default fragment
-}
-declare module '*.fragment.md' {
-  const fragment: Fragment
-  export default fragment
-}
+/**
+  Kitten Types (@small-web/kitten-types)
+
+  Ambient module declarations for Kitten fragment imports
+  (*.fragment.html, *.fragment.css, *.fragment.md).
+
+  Generated from Kitten’s TypeScript source code
+  (see kitten/ – regenerated via `npm run sync-types` in the Kitten repository).
+*/
+
+import './kitten/src/types/fragments.d.ts'
+
+export {}