@poveste/plugin-tailwind 0.6.0

package/README.md

@@ -0,0 +1,28 @@
+# @poveste/plugin-tailwind
+
+Renders a project's Tailwind design system — colours, spacing, typography — as a
+story in its book.
+
+```ts
+import { HstTailwind } from '@poveste/plugin-tailwind'
+
+export default defineConfig({
+  plugins: [
+    HstTailwind(),
+  ],
+})
+```
+
+The CSS entrypoint is found automatically: the plugin looks for the usual names
+(`src/style.css`, `src/app.css`, `app/assets/css/main.css`, …) and takes the
+first that is actually a Tailwind entrypoint — one importing `tailwindcss`, or
+declaring `@theme`. Point it somewhere else with `HstTailwind({ cssFile })`.
+
+Tailwind v4 only. The theme is read from CSS custom properties, which is where
+v4 keeps it; a v3 project using `@tailwind base` has nothing for this to read.
+
+Adding the plugin also adds a `Design System` group to the story tree.
+
+> This used to be built into `poveste` and enabled by default, which meant a
+> project that merely had a file named `src/app.css` got a design-system group
+> and a story full of Tailwind's defaults it never asked for. It is opt-in now.

package/dist/index.d.ts

@@ -0,0 +1,27 @@
+import type { Plugin } from '@poveste/shared';
+export interface TailwindTokensOptions {
+    /**
+     * Path to the CSS entrypoint that imports Tailwind and declares `@theme`.
+     * Tailwind v4 is CSS-first, so the design tokens are read from CSS rather
+     * than from a JS config. Auto-detected when omitted.
+     */
+    cssFile?: string;
+}
+/**
+ * Whether a stylesheet is a Tailwind entrypoint, rather than merely a file with
+ * one of the names Tailwind entrypoints tend to have.
+ *
+ * Every name in `CSS_ENTRY_CANDIDATES` is an ordinary one — `src/app.css`,
+ * `styles.css` — so matching on the name alone hands the whole feature to
+ * projects that have never used Tailwind: a `Design System` group inserted into
+ * their tree, and a story rendering Tailwind's own defaults as if it were their
+ * design system.
+ *
+ * Both markers are Tailwind v4, which is what this plugin reads: the theme comes
+ * from CSS custom properties, so a v3 project using `@tailwind base` would be
+ * accepted here and then produce nothing.
+ */
+export declare function isTailwindEntry(filePath: string): boolean;
+export declare function HstTailwind(options?: TailwindTokensOptions): Plugin;
+/** @deprecated Use `HstTailwind`. Kept for books that named the old builtin. */
+export declare const tailwindTokens: typeof HstTailwind;