@plumeria/next-plugin 16.5.0 → 17.0.0

package/README.md

@@ -0,0 +1,103 @@
+# @plumeria/next-plugin
+
+Next.js plugin for Plumeria.  
+It registers the compiler with Turbopack and Webpack, and emits the project's stylesheet at build time.
+
+## Installation
+
+```bash
+npm install -D @plumeria/next-plugin
+# or
+yarn add -D @plumeria/next-plugin
+# or
+pnpm add -D @plumeria/next-plugin
+```
+
+No PostCSS setup is required. `@plumeria/postcss-plugin` was removed in 17.0.0 — if you are upgrading, delete `postcss.config.js` and the `@plumeria` at-rule from your global stylesheet.
+
+## How to Use
+
+Wrap your config with `withPlumeria`. It works with both Turbopack and Webpack.
+
+```ts
+// next.config.ts
+import type { NextConfig } from 'next';
+import { withPlumeria } from '@plumeria/next-plugin';
+
+const nextConfig: NextConfig = {
+  /* config options here */
+};
+
+export default withPlumeria(nextConfig);
+```
+
+Then declare the styling prop once in your project. `@plumeria/core` ships no prop declaration of its own, so nothing is accepted on host elements until you do:
+
+```ts
+// plumeria.d.ts
+/// <reference types="@plumeria/core/style-name" />
+```
+
+## Options
+
+Options are passed as the second argument.
+
+```ts
+export default withPlumeria(nextConfig, {
+  styleProp: 'sx',
+  include: ['./src/**/*.{ts,tsx}'],
+  exclude: ['**/node_modules/**', '**/.next/**'],
+});
+```
+
+| Option | Default | Description |
+| :-- | :-- | :-- |
+| `styleProp` | `'styleName'` | The JSX prop that carries styles. |
+| `include` | all `js/jsx/ts/tsx` | Globs the stylesheet is compiled from. |
+| `exclude` | `node_modules`, `dist`, `.next` | Globs excluded from that compilation. |
+
+### styleProp
+
+Renaming the prop takes two steps, and they have to agree. Tell the plugin:
+
+```ts
+export default withPlumeria(nextConfig, { styleProp: 'sx' });
+```
+
+and declare the same name for TypeScript instead of referencing the default:
+
+```ts
+// plumeria.d.ts
+import type { Style } from '@plumeria/core';
+
+declare global {
+  namespace React {
+    interface HTMLAttributes<T> {
+      sx?: Style
+    }
+    interface SVGAttributes<T> {
+      sx?: Style
+    }
+  }
+}
+```
+
+If the two disagree, the prop type-checks but is never compiled away. [`@plumeria/eslint-plugin`](https://www.npmjs.com/package/@plumeria/eslint-plugin) reads the same name from `settings.plumeria.styleProp`.
+
+### include / exclude
+
+The stylesheet is compiled from every source file by default. Narrowing the globs reduces build times on large projects.
+
+```ts
+export default withPlumeria(nextConfig, {
+  include: ['./app/**/*.{ts,tsx}', './components/**/*.{ts,tsx}'],
+});
+```
+
+## Requirements
+
+Turbopack rule conditions keep the compiler from being handed every module in the graph, `node_modules` included. They are a Next.js 16 option, and the plugin applies them only from 16.0.0 up — on 15.x the rule stays unfiltered and builds are slower. Everything else works on both.
+
+## License
+
+Plumeria is [MIT licensed](https://github.com/zss-in-js/plumeria/blob/main/LICENSE).

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 import type { NextConfig } from 'next';
-export declare function withPlumeria(nextConfig?: NextConfig): NextConfig;
+import type { LoaderOptions } from '@plumeria/turbopack-loader';
+export declare function withPlumeria(nextConfig?: NextConfig, options?: LoaderOptions): NextConfig;

package/dist/index.js

@@ -36,10 +36,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.withPlumeria = withPlumeria;
 const fs = __importStar(require("fs"));
 const isRuleConfigItem = (rule) => !Array.isArray(rule) && typeof rule === 'object' && rule !== null;
-function withPlumeria(nextConfig = {}) {
+function supportsRuleCondition() {
+    try {
+        const { version } = require('next/package.json');
+        return Number(version.split('.')[0]) >= 16;
+    }
+    catch {
+        return false;
+    }
+}
+function withPlumeria(nextConfig = {}, options = {}) {
     const globalRef = global;
-    if (process.env.NODE_ENV === 'development' &&
-        !globalRef.__PLUMERIA_RESET_DONE__) {
+    if (!globalRef.__PLUMERIA_RESET_DONE__) {
         globalRef.__PLUMERIA_RESET_DONE__ = true;
         try {
             const VIRTUAL_FILE_PATH = require.resolve('@plumeria/turbopack-loader/zero-virtual.css');
@@ -59,13 +67,24 @@ function withPlumeria(nextConfig = {}) {
     }
     const originalWebpack = nextConfig.webpack;
     const turbopackLoaders = [
-        { loader: '@plumeria/turbopack-loader', options: {} },
+        {
+            loader: '@plumeria/turbopack-loader',
+            options: options,
+        },
     ];
+    const ruleItem = supportsRuleCondition()
+        ? {
+            loaders: turbopackLoaders,
+            condition: {
+                all: [{ not: 'foreign' }, { content: /@plumeria\/core/ }],
+            },
+        }
+        : { loaders: turbopackLoaders };
     const plumeriaRules = {
-        '*.ts': { loaders: turbopackLoaders },
-        '*.tsx': { loaders: turbopackLoaders },
-        '*.js': { loaders: turbopackLoaders },
-        '*.jsx': { loaders: turbopackLoaders },
+        '*.ts': ruleItem,
+        '*.tsx': ruleItem,
+        '*.js': ruleItem,
+        '*.jsx': ruleItem,
     };
     const mergeTurbopackRules = (existingRules = {}, newRules) => {
         const mergedRules = { ...existingRules };
@@ -119,7 +138,7 @@ function withPlumeria(nextConfig = {}) {
                 enforce: 'pre',
                 test: /\.(tsx|ts|jsx|js)$/,
                 exclude: [/node_modules/, /\.next/, /\.git/],
-                use: '@plumeria/turbopack-loader',
+                use: { loader: '@plumeria/turbopack-loader', options },
             });
             return config;
         },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plumeria/next-plugin",
-  "version": "16.5.0",
+  "version": "17.0.0",
   "description": "Plumeria Next.js plugin",
   "author": "Refirst 11",
   "license": "MIT",
@@ -29,7 +29,7 @@
     "dist/"
   ],
   "dependencies": {
-    "@plumeria/turbopack-loader": "^16.5.0"
+    "@plumeria/turbopack-loader": "^17.0.0"
   },
   "devDependencies": {
     "next": "^16.2.10",