@jonmilner/ui 0.3.1 → 0.3.2

package/dist/docs/lint.md

@@ -0,0 +1,21 @@
+# Lint
+
+`@jonmilner/ui/lint` holds the options for `uiLint()` from `@jonmilner/oxlint-config` that follow the library's components. Import it in the app's `vite.config.ts`; nothing in it runs in the app.
+
+## textComponents
+
+The library's components and parts that render their children through `Text`. Pass it as `textComponents`, so documented usage such as `<Tabs.Tab>Privacy</Tabs.Tab>` or `<Field.Label>Email</Field.Label>` passes `ui/no-bare-text`.
+
+```ts
+import { lint, uiLint } from "@jonmilner/oxlint-config";
+import { textComponents } from "@jonmilner/ui/lint";
+import { defineConfig } from "vite-plus";
+
+export default defineConfig({
+  lint: { ...lint, ...uiLint({ textComponents: [...textComponents, "VisuallyHidden"] }) },
+});
+```
+
+- The option replaces the preset's default list, so add the app's own text components (here `VisuallyHidden`) after the library's.
+- Never copy the list into the app: it changes with the library, and an upgrade brings the new parts.
+- The rule matches a tag's last segment: `Tabs.Tab` is `Tab`. So `Item` and `Label` pass any component's part of that name, and `Trigger` and `Close` pass even without the look (`variant`, `size`, an icon) that makes them a Button. Give a look-less `Trigger` or `Close` a `Text` child yourself.

package/dist/docs/llms.txt

@@ -30,4 +30,5 @@
 
 - [manifest.json](manifest.json): every component, prop, variant, icon and token, as JSON
 - [theming.md](theming.md): themes, brands and tokens
+- [lint.md](lint.md): the `uiLint()` options the library ships
 - [migrations/](migrations/README.md): upgrade notes for breaking releases

package/dist/docs/manifest.json

@@ -1,7 +1,7 @@
 {
   "$schema": "./manifest.schema.json",
   "package": "@jonmilner/ui",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "components": [
     {
       "name": "AlertDialog",

package/dist/lint/index.d.mts

@@ -0,0 +1,9 @@
+//#region src/lint/index.d.ts
+/**
+ * The library's components and parts that render their children through `Text`, for the
+ * `textComponents` option of `uiLint()` from `@jonmilner/oxlint-config`. A part is named by its
+ * property (`Tabs.Tab` is `Tab`). Spread it and add the app's own text components; see
+ * `docs/lint.md`.
+ */
+export declare const textComponents: readonly string[];
+//#endregion

package/dist/lint/index.mjs

@@ -0,0 +1,18 @@
+//#region src/lint/index.ts
+var e = Object.freeze([
+	"Text",
+	"Heading",
+	"Button",
+	"Badge",
+	"Tag",
+	"Chip",
+	"Tab",
+	"Item",
+	"Label",
+	"Error",
+	"Description",
+	"Trigger",
+	"Close"
+]);
+//#endregion
+export { e as textComponents };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jonmilner/ui",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "files": [
     "dist",
     "THIRD_PARTY_NOTICES.md"
@@ -114,6 +114,10 @@
       "types": "./dist/testing/index.d.mts",
       "default": "./dist/testing/index.mjs"
     },
+    "./lint": {
+      "types": "./dist/lint/index.d.mts",
+      "default": "./dist/lint/index.mjs"
+    },
     "./base.css": "./dist/base.css",
     "./docs/*": "./dist/docs/*"
   },