unplugin-stylex 0.1.0 → 0.2.4

package/.eslintrc.json

@@ -2,15 +2,13 @@
   "env": {
     "node": true
   },
-  "extends": [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/recommended"
-  ],
   "parser": "@typescript-eslint/parser",
-  "plugins": ["@typescript-eslint"],
+  "plugins": ["@stylistic/ts"],
   "root": true,
   "rules": {
-    "semi": "off",
+    "max-len": ["error", { "code": 120 }],
+    "semi": ["error", "never"],
+    "quotes": ["error", "single"],
     "@typescript-eslint/no-explicit-any": "off"
   }
 }

package/.github/renovate.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": ["config:base"],
+  "lockFileMaintenance": {"enabled": true, "automerge": false},
+  "rangeStrategy": "replace",
+  "postUpdateOptions": ["pnpmDedupe"],
+  "packageRules": [
+    {
+      "matchPackageNames": ["@tsd/typescript", "typescript"],
+      "groupName": "typescript"
+    },
+    {
+      "matchPackageNames": [
+        "@babel/core",
+        "@babel/plugin-syntax-flow",
+        "@babel/plugin-syntax-jsx",
+        "@babel/plugin-syntax-typescript"
+      ],
+      "groupName": "babel"
+    },
+
+    {
+      "matchPackageNames": ["@stylexjs/stylex", "@stylexjs/babel-plugin"],
+      "groupName": "stylex"
+    }
+  ]
+}

package/.github/workflows/release.yml

@@ -24,3 +24,16 @@ jobs:
       - run: npx changelogithub
         env:
           GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+
+  publish-jsr:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Publish package
+        run: npx jsr publish

package/.github/workflows/typos.yml

@@ -0,0 +1,15 @@
+name: Spell Check 
+on:
+  pull_request:
+  push:
+    branches:
+      - "main"
+jobs:
+  typos:
+    name: Spell Check with Typos
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Actions Repository
+        uses: actions/checkout@v4
+      - name: Check spelling
+        uses: crate-ci/typos@master

package/README.md

@@ -1,4 +1,7 @@
-# unplugin-stylex
+# unplugin-stylex · [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/eryue0220/unplugin-stylex/blob/main/LICENSE) [![npm version](https://img.shields.io/npm/v/unplugin-stylex.svg?style=flat)](https://www.npmjs.com/package/unplugin-stylex)
+
+> [!WARNING]  
+> This plugin is in early development and may not work as expected. Please report any issues you find.
 
 ## Installation
 
@@ -75,11 +78,9 @@ module.exports = {
 
 ## Options
 
-### options.dev
-
-### options.enforce
+Current support argument, which may have change in the future
 
-### options.stylex
+### options.dev
 
 #### options.stylex.runtimeInjection
 
@@ -93,6 +94,7 @@ module.exports = {
 
 #### options.stylex.unstable_moduleResolution
 
-## License
+# Acknowledgments
 
-StyleX is [MIT licensed](./LICENSE)
+- [@stylexjs/rollup-plugin](https://github.com/facebook/stylex/tree/main/packages/rollup-plugin)
+- [vite-plugin-stylex](https://github.com/HorusGoul/vite-plugin-stylex)

package/dist/esbuild.cjs

@@ -6,7 +6,8 @@ require('./chunk-N4Z3Z2PU.cjs');
 
 // src/esbuild.ts
 var _unplugin = require('unplugin');
-var esbuild_default = _unplugin.createEsbuildPlugin.call(void 0, _chunkNVMQARFAcjs.unpluginFactory);
+var esbuildPlugin = _unplugin.createEsbuildPlugin.call(void 0, _chunkNVMQARFAcjs.unpluginFactory);
+var esbuild_default = esbuildPlugin;
 
 
 exports.default = esbuild_default;

package/dist/esbuild.d.cts

@@ -1,6 +1,12 @@
-import * as unplugin from 'unplugin';
-import { UnpluginStylexOptions } from './types.cjs';
+import { EsbuildPlugin } from 'unplugin';
+import { UnpluginStylexInstance } from './types.cjs';
 
-declare const _default: (options?: UnpluginStylexOptions) => unplugin.EsbuildPlugin;
+/**
+ * This entry file is for esbuild plugin. Requires esbuild >= 0.15
+ *
+ * @module
+ */
 
-export { _default as default };
+declare const esbuildPlugin: UnpluginStylexInstance<EsbuildPlugin | EsbuildPlugin[]>;
+
+export { esbuildPlugin as default };

package/dist/esbuild.d.ts

@@ -1,6 +1,12 @@
-import * as unplugin from 'unplugin';
-import { UnpluginStylexOptions } from './types.js';
+import { EsbuildPlugin } from 'unplugin';
+import { UnpluginStylexInstance } from './types.js';
 
-declare const _default: (options?: UnpluginStylexOptions) => unplugin.EsbuildPlugin;
+/**
+ * This entry file is for esbuild plugin. Requires esbuild >= 0.15
+ *
+ * @module
+ */
 
-export { _default as default };
+declare const esbuildPlugin: UnpluginStylexInstance<EsbuildPlugin | EsbuildPlugin[]>;
+
+export { esbuildPlugin as default };

package/dist/esbuild.js

@@ -6,7 +6,8 @@ import "./chunk-36ARBXVP.js";
 
 // src/esbuild.ts
 import { createEsbuildPlugin } from "unplugin";
-var esbuild_default = createEsbuildPlugin(unpluginFactory);
+var esbuildPlugin = createEsbuildPlugin(unpluginFactory);
+var esbuild_default = esbuildPlugin;
 export {
   esbuild_default as default
 };

package/dist/index.d.cts

@@ -1,9 +1,8 @@
-import * as unplugin$1 from 'unplugin';
-import { UnpluginFactory } from 'unplugin';
+import { UnpluginFactory, UnpluginInstance } from 'unplugin';
 import { UnpluginStylexOptions } from './types.cjs';
-export { BabelConfig, StylexOptions } from './types.cjs';
+export { BabelConfig, StylexOptions, UnpluginStylexInstance } from './types.cjs';
 
 declare const unpluginFactory: UnpluginFactory<UnpluginStylexOptions | undefined>;
-declare const unplugin: unplugin$1.UnpluginInstance<UnpluginStylexOptions, boolean>;
+declare const unplugin: UnpluginInstance<UnpluginStylexOptions | undefined, boolean>;
 
 export { UnpluginStylexOptions, unplugin as default, unplugin, unpluginFactory };

package/dist/index.d.ts

@@ -1,9 +1,8 @@
-import * as unplugin$1 from 'unplugin';
-import { UnpluginFactory } from 'unplugin';
+import { UnpluginFactory, UnpluginInstance } from 'unplugin';
 import { UnpluginStylexOptions } from './types.js';
-export { BabelConfig, StylexOptions } from './types.js';
+export { BabelConfig, StylexOptions, UnpluginStylexInstance } from './types.js';
 
 declare const unpluginFactory: UnpluginFactory<UnpluginStylexOptions | undefined>;
-declare const unplugin: unplugin$1.UnpluginInstance<UnpluginStylexOptions, boolean>;
+declare const unplugin: UnpluginInstance<UnpluginStylexOptions | undefined, boolean>;
 
 export { UnpluginStylexOptions, unplugin as default, unplugin, unpluginFactory };

package/dist/rollup.cjs

@@ -5,7 +5,7 @@ var _chunkN4Z3Z2PUcjs = require('./chunk-N4Z3Z2PU.cjs');
 // src/rollup.ts
 var rollup_default = (options) => {
   if (_chunkN4Z3Z2PUcjs.isDevelopment || (options == null ? void 0 : options.dev)) {
-    throw new Error(`If you want to use this plugin through rollup, please use "@stylexjs/rollup-plugin" instead`);
+    throw new Error('If you want to use this plugin through rollup, please use "@stylexjs/rollup-plugin" instead');
   }
 };
 

package/dist/rollup.d.cts

@@ -1,3 +1,14 @@
-declare const _default: (options?: any) => void;
+import { UnpluginStylexOptions } from './types.cjs';
+
+/**
+ * This entry file is for Rollup plugin.
+ *
+ * @module
+ */
+
+/**
+ * Note: Current, please use @stylexjs/rollup-plugin
+ */
+declare const _default: (options?: UnpluginStylexOptions) => void;
 
 export { _default as default };

package/dist/rollup.d.ts

@@ -1,3 +1,14 @@
-declare const _default: (options?: any) => void;
+import { UnpluginStylexOptions } from './types.js';
+
+/**
+ * This entry file is for Rollup plugin.
+ *
+ * @module
+ */
+
+/**
+ * Note: Current, please use @stylexjs/rollup-plugin
+ */
+declare const _default: (options?: UnpluginStylexOptions) => void;
 
 export { _default as default };

package/dist/rollup.js

@@ -5,7 +5,7 @@ import {
 // src/rollup.ts
 var rollup_default = (options) => {
   if (isDevelopment || (options == null ? void 0 : options.dev)) {
-    throw new Error(`If you want to use this plugin through rollup, please use "@stylexjs/rollup-plugin" instead`);
+    throw new Error('If you want to use this plugin through rollup, please use "@stylexjs/rollup-plugin" instead');
   }
 };
 export {

package/dist/rspack.cjs

@@ -6,7 +6,8 @@ require('./chunk-N4Z3Z2PU.cjs');
 
 // src/rspack.ts
 var _unplugin = require('unplugin');
-var rspack_default = _unplugin.createRspackPlugin.call(void 0, _chunkNVMQARFAcjs.unpluginFactory);
+var rspackPlugin = _unplugin.createRspackPlugin.call(void 0, _chunkNVMQARFAcjs.unpluginFactory);
+var rspack_default = rspackPlugin;
 
 
 exports.default = rspack_default;

package/dist/rspack.d.cts

@@ -1,6 +1,13 @@
-import * as unplugin from 'unplugin';
-import { UnpluginStylexOptions } from './types.cjs';
+import { RspackPluginInstance } from 'unplugin';
+import { UnpluginStylexInstance } from './types.cjs';
 
-declare const _default: (options?: UnpluginStylexOptions) => unplugin.RspackPluginInstance;
+/**
+ * This entry file is for Rspac plugin.
+ *
+ * @module
+ */
 
-export { _default as default };
+type RspackPluginType = UnpluginStylexInstance<RspackPluginInstance | RspackPluginInstance[]>;
+declare const rspackPlugin: RspackPluginType;
+
+export { rspackPlugin as default };

package/dist/rspack.d.ts

@@ -1,6 +1,13 @@
-import * as unplugin from 'unplugin';
-import { UnpluginStylexOptions } from './types.js';
+import { RspackPluginInstance } from 'unplugin';
+import { UnpluginStylexInstance } from './types.js';
 
-declare const _default: (options?: UnpluginStylexOptions) => unplugin.RspackPluginInstance;
+/**
+ * This entry file is for Rspac plugin.
+ *
+ * @module
+ */
 
-export { _default as default };
+type RspackPluginType = UnpluginStylexInstance<RspackPluginInstance | RspackPluginInstance[]>;
+declare const rspackPlugin: RspackPluginType;
+
+export { rspackPlugin as default };

package/dist/rspack.js

@@ -6,7 +6,8 @@ import "./chunk-36ARBXVP.js";
 
 // src/rspack.ts
 import { createRspackPlugin } from "unplugin";
-var rspack_default = createRspackPlugin(unpluginFactory);
+var rspackPlugin = createRspackPlugin(unpluginFactory);
+var rspack_default = rspackPlugin;
 export {
   rspack_default as default
 };

package/dist/types.d.cts

@@ -9,7 +9,7 @@ type StylexOptions = {
     classNamePrefix?: string;
     useCSSLayers?: boolean;
     unstable_moduleResolution?: {
-        type: "commonjs" | "haste";
+        type: 'commonjs' | 'haste';
         rootDir: string;
     };
     babelConfig?: BabelConfig;
@@ -19,8 +19,9 @@ type StylexOptions = {
 type UnpluginStylexOptions = {
     compiler?: string;
     dev?: boolean;
-    enforce?: "post" | "pre";
+    enforce?: 'post' | 'pre';
     stylex?: StylexOptions;
 };
+type UnpluginStylexInstance<T> = (options?: UnpluginStylexOptions) => T;
 
-export type { BabelConfig, StylexOptions, UnpluginStylexOptions };
+export type { BabelConfig, StylexOptions, UnpluginStylexInstance, UnpluginStylexOptions };

package/dist/types.d.ts

@@ -9,7 +9,7 @@ type StylexOptions = {
     classNamePrefix?: string;
     useCSSLayers?: boolean;
     unstable_moduleResolution?: {
-        type: "commonjs" | "haste";
+        type: 'commonjs' | 'haste';
         rootDir: string;
     };
     babelConfig?: BabelConfig;
@@ -19,8 +19,9 @@ type StylexOptions = {
 type UnpluginStylexOptions = {
     compiler?: string;
     dev?: boolean;
-    enforce?: "post" | "pre";
+    enforce?: 'post' | 'pre';
     stylex?: StylexOptions;
 };
+type UnpluginStylexInstance<T> = (options?: UnpluginStylexOptions) => T;
 
-export type { BabelConfig, StylexOptions, UnpluginStylexOptions };
+export type { BabelConfig, StylexOptions, UnpluginStylexInstance, UnpluginStylexOptions };

package/dist/vite.cjs

@@ -6,7 +6,8 @@ require('./chunk-N4Z3Z2PU.cjs');
 
 // src/vite.ts
 var _unplugin = require('unplugin');
-var vite_default = _unplugin.createVitePlugin.call(void 0, _chunkNVMQARFAcjs.unpluginFactory);
+var vitePlugin = _unplugin.createVitePlugin.call(void 0, _chunkNVMQARFAcjs.unpluginFactory);
+var vite_default = vitePlugin;
 
 
 exports.default = vite_default;

package/dist/vite.d.cts

@@ -1,6 +1,12 @@
-import * as vite from 'vite';
-import { UnpluginStylexOptions } from './types.cjs';
+import { VitePlugin } from 'unplugin';
+import { UnpluginStylexInstance } from './types.cjs';
 
-declare const _default: (options?: UnpluginStylexOptions) => vite.Plugin<any> | vite.Plugin<any>[];
+/**
+ * This entry file is for Vite plugin.
+ *
+ * @module
+ */
 
-export { _default as default };
+declare const vitePlugin: UnpluginStylexInstance<VitePlugin | VitePlugin[]>;
+
+export { vitePlugin as default };

package/dist/vite.d.ts

@@ -1,6 +1,12 @@
-import * as vite from 'vite';
-import { UnpluginStylexOptions } from './types.js';
+import { VitePlugin } from 'unplugin';
+import { UnpluginStylexInstance } from './types.js';
 
-declare const _default: (options?: UnpluginStylexOptions) => vite.Plugin<any> | vite.Plugin<any>[];
+/**
+ * This entry file is for Vite plugin.
+ *
+ * @module
+ */
 
-export { _default as default };
+declare const vitePlugin: UnpluginStylexInstance<VitePlugin | VitePlugin[]>;
+
+export { vitePlugin as default };

package/dist/vite.js

@@ -6,7 +6,8 @@ import "./chunk-36ARBXVP.js";
 
 // src/vite.ts
 import { createVitePlugin } from "unplugin";
-var vite_default = createVitePlugin(unpluginFactory);
+var vitePlugin = createVitePlugin(unpluginFactory);
+var vite_default = vitePlugin;
 export {
   vite_default as default
 };

package/dist/webpack.cjs

@@ -5,7 +5,7 @@ var _chunkN4Z3Z2PUcjs = require('./chunk-N4Z3Z2PU.cjs');
 // src/webpack.ts
 var webpack_default = (options) => {
   if (_chunkN4Z3Z2PUcjs.isDevelopment || (options == null ? void 0 : options.dev)) {
-    throw new Error(`If you want to use this plugin through webpack, please use "@stylexjs/webpack-plugin" instead`);
+    throw new Error('If you want to use this plugin through webpack, please use "@stylexjs/webpack-plugin" instead');
   }
 };
 

package/dist/webpack.d.cts

@@ -1,3 +1,14 @@
-declare const _default: (options?: any) => void;
+import { UnpluginStylexOptions } from './types.cjs';
+
+/**
+ * This entry file is for Webpack plugin.
+ *
+ * @module
+ */
+
+/**
+ * Note: Current, please use @stylexjs/webpack-plugin
+ */
+declare const _default: (options?: UnpluginStylexOptions) => void;
 
 export { _default as default };

package/dist/webpack.d.ts

@@ -1,3 +1,14 @@
-declare const _default: (options?: any) => void;
+import { UnpluginStylexOptions } from './types.js';
+
+/**
+ * This entry file is for Webpack plugin.
+ *
+ * @module
+ */
+
+/**
+ * Note: Current, please use @stylexjs/webpack-plugin
+ */
+declare const _default: (options?: UnpluginStylexOptions) => void;
 
 export { _default as default };

package/dist/webpack.js

@@ -5,7 +5,7 @@ import {
 // src/webpack.ts
 var webpack_default = (options) => {
   if (isDevelopment || (options == null ? void 0 : options.dev)) {
-    throw new Error(`If you want to use this plugin through webpack, please use "@stylexjs/webpack-plugin" instead`);
+    throw new Error('If you want to use this plugin through webpack, please use "@stylexjs/webpack-plugin" instead');
   }
 };
 export {

package/jsr.json

@@ -0,0 +1,20 @@
+{
+  "name": "@eryue0220/unplugin-stylex",
+  "version": "0.2.4",
+  "exports": {
+    "./index": "./src/index.ts",
+    "./esbuild": "./src/esbuild.ts",
+    "./rollup": "./src/rollup.ts",
+    "./rspack": "./src/rspack.ts",
+    "./vite": "./src/vite.ts",
+    "./webpack": "./src/webpack.ts"
+  },
+  "exclude": [
+    ".eslintrc.json",
+    ".eslintignore",
+    "test",
+    "examples",
+    "pnpm-lock.yaml",
+    "pnpm-workspace.yaml"
+  ]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "unplugin-stylex",
-  "version": "0.1.0",
+  "version": "0.2.4",
   "packageManager": "pnpm@8.11.0",
   "description": "Unplugin for stylex",
   "repository": "https://github.com/eryue0220/unplugin-stylex",
@@ -46,9 +46,22 @@
     },
     "./*": "./*"
   },
+  "scripts": {
+    "dev": "tsup src/*ts --watch src",
+    "build": "tsup src/*.ts --format cjs,esm --dts --splitting --clean",
+    "test": "vitest",
+    "test:update": "vitest -u",
+    "test:cov": "vitest --coverage",
+    "lint": "eslint . --ext .ts,.tsx,.js,.jsx",
+    "check": "pnpm run lint && pnpm run typecheck",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  },
   "engines": {
     "node": ">=16.14.0"
   },
+  "peerDependencies": {
+    "@stylexjs/stylex": "^0.5.1"
+  },
   "dependencies": {
     "@babel/core": "^7.23.6",
     "@babel/plugin-syntax-flow": "^7.23.3",
@@ -59,6 +72,7 @@
     "unplugin": "^1.7.1"
   },
   "devDependencies": {
+    "@stylistic/eslint-plugin-ts": "^1.6.2",
     "@types/node": "^20.10.5",
     "@typescript-eslint/eslint-plugin": "^6.16.0",
     "@typescript-eslint/parser": "^6.16.0",
@@ -69,15 +83,5 @@
     "typescript": "^5.3.3",
     "vite": "^5.0.10",
     "vitest": "^1.1.0"
-  },
-  "scripts": {
-    "dev": "tsup src/*ts --watch src",
-    "build": "tsup src/*.ts --format cjs,esm --dts --splitting --clean",
-    "test": "vitest",
-    "test:update": "vitest -u",
-    "test:cov": "vitest --coverage",
-    "lint": "eslint . --ext .ts,.tsx,.js,.jsx",
-    "check": "pnpm run lint && pnpm run typecheck",
-    "typecheck": "tsc -p tsconfig.json --noEmit"
   }
-}
+}

package/src/esbuild.ts

@@ -1,4 +1,29 @@
+/**
+ * This entry file is for esbuild plugin. Requires esbuild >= 0.15
+ *
+ * @module
+ */
+
 import { createEsbuildPlugin } from 'unplugin'
-import { unpluginFactory } from '.'
+import type { EsbuildPlugin } from 'unplugin'
+import { unpluginFactory } from './index'
+import type { UnpluginStylexInstance } from './types'
+
+const esbuildPlugin: UnpluginStylexInstance<EsbuildPlugin | EsbuildPlugin[]> = createEsbuildPlugin(unpluginFactory)
+
 
-export default createEsbuildPlugin(unpluginFactory)
+/**
+ * Esbuild plugin
+ *
+ * @example
+ *
+ * import { build } from 'esbuild'
+ * import stylexPlugin from 'unplugin-stylex/esbuild'
+ *
+ * export default {
+ *   plugins: [
+ *     stylexPlugin(),
+ *   ],
+ * }
+ */
+export default esbuildPlugin

package/src/index.ts

@@ -1,7 +1,8 @@
 import * as path from 'node:path'
 
 import { createUnplugin } from 'unplugin'
-import type { UnpluginFactory } from 'unplugin'
+import type { UnpluginFactory, UnpluginInstance } from 'unplugin'
+import type { BuildOptions } from 'vite'
 
 import { buildStylexRules } from './core/build'
 import { PLUGIN_NAME } from './core/constants'
@@ -12,7 +13,7 @@ import type { UnpluginStylexOptions } from './types'
 export const unpluginFactory: UnpluginFactory<UnpluginStylexOptions | undefined> = (rawOptions = {}) => {
   const options = getOptions(rawOptions)
   const stylexRules = {}
-  let viteConfig = null
+  let viteConfig: { build: BuildOptions | undefined; base: string | undefined; } | null = null
 
   return {
     name: PLUGIN_NAME,
@@ -74,7 +75,7 @@ export const unpluginFactory: UnpluginFactory<UnpluginStylexOptions | undefined>
       },
 
       buildEnd() {
-        const fileName = `${viteConfig.build?.assetsDir ?? 'assets'}/${options.stylex.filename}`
+        const fileName = `${viteConfig!.build?.assetsDir ?? 'assets'}/${options.stylex.filename}`
         const collectedCSS = buildStylexRules(stylexRules, options.stylex.useCSSLayers)
 
         if (!collectedCSS) return
@@ -87,7 +88,7 @@ export const unpluginFactory: UnpluginFactory<UnpluginStylexOptions | undefined>
       },
 
       transformIndexHtml(html, ctx) {
-        const fileName = `${viteConfig.build?.assetsDir ?? 'assets'}/${options.stylex.filename}`
+        const fileName = `${viteConfig!.build?.assetsDir ?? 'assets'}/${options.stylex.filename}`
         const css = ctx.bundle?.[fileName]
 
         if (!css) {
@@ -95,7 +96,7 @@ export const unpluginFactory: UnpluginFactory<UnpluginStylexOptions | undefined>
         }
 
         const publicPath = path.posix.join(
-          viteConfig.base ?? '/',
+          viteConfig!.base ?? '/',
           fileName.replace(/\\/g, '/')
         )
 
@@ -114,7 +115,7 @@ export const unpluginFactory: UnpluginFactory<UnpluginStylexOptions | undefined>
   }
 }
 
-export const unplugin = createUnplugin(unpluginFactory)
+export const unplugin: UnpluginInstance<UnpluginStylexOptions | undefined, boolean> = createUnplugin(unpluginFactory)
 
 export * from './types'
 

package/src/rollup.ts

@@ -1,7 +1,17 @@
+/**
+ * This entry file is for Rollup plugin.
+ *
+ * @module
+ */
+
 import { isDevelopment } from './core/constants'
+import type { UnpluginStylexOptions } from './types'
 
-export default (options?) => {
+/**
+ * Note: Current, please use @stylexjs/rollup-plugin
+ */
+export default (options?: UnpluginStylexOptions) => {
   if (isDevelopment || options?.dev) {
-    throw new Error(`If you want to use this plugin through rollup, please use "@stylexjs/rollup-plugin" instead`)
+    throw new Error('If you want to use this plugin through rollup, please use "@stylexjs/rollup-plugin" instead')
   }
 }

package/src/rspack.ts

@@ -1,4 +1,29 @@
+/**
+ * This entry file is for Rspac plugin.
+ *
+ * @module
+ */
+
 import { createRspackPlugin } from 'unplugin'
-import { unpluginFactory } from '.'
+import type { RspackPluginInstance } from 'unplugin'
+import { unpluginFactory } from './index'
+import type { UnpluginStylexInstance } from './types'
+
+type RspackPluginType = UnpluginStylexInstance<RspackPluginInstance | RspackPluginInstance[]>
+
+const rspackPlugin: RspackPluginType = createRspackPlugin(unpluginFactory)
 
-export default createRspackPlugin(unpluginFactory)
+/**
+ * Rsapck plugin
+ *
+ * @example
+ *
+ * import stylexPlugin from 'unplugin-stylex/rspack'
+ *
+ * module.exports = {
+ *   plugins: [
+ *     stylexPlugin(),
+ *   ],
+ * }
+ */
+export default rspackPlugin

package/src/types.ts

@@ -10,7 +10,7 @@ export type StylexOptions = {
   classNamePrefix?: string
   useCSSLayers?:  boolean
   unstable_moduleResolution?: {
-    type: "commonjs" | "haste"
+    type: 'commonjs' | 'haste'
     rootDir: string
   }
   babelConfig?: BabelConfig
@@ -21,6 +21,8 @@ export type StylexOptions = {
 export type UnpluginStylexOptions = {
   compiler?: string
   dev?: boolean
-  enforce?: "post" | "pre"
+  enforce?: 'post' | 'pre'
   stylex?: StylexOptions
 }
+
+export type UnpluginStylexInstance<T> = (options?: UnpluginStylexOptions) => T

package/src/vite.ts

@@ -1,4 +1,28 @@
+/**
+ * This entry file is for Vite plugin.
+ *
+ * @module
+ */
+
 import { createVitePlugin } from 'unplugin'
-import { unpluginFactory } from '.'
+import type { VitePlugin } from 'unplugin'
+import { unpluginFactory } from './index'
+import type { UnpluginStylexInstance } from './types'
+
+const vitePlugin: UnpluginStylexInstance<VitePlugin | VitePlugin[]> = createVitePlugin(unpluginFactory)
 
-export default createVitePlugin(unpluginFactory)
+/**
+ * Vite example
+ *
+ * @example
+ *
+ * import { defineConfig } from 'vite'
+ * import stylexPlugin from 'unplugin-stylex/vite'
+ *
+ * export default defineConfig({
+ *   plugins: [
+ *     stylexPlugin(),
+ *   ],
+ * })
+ */
+export default vitePlugin

package/src/webpack.ts

@@ -1,7 +1,17 @@
+/**
+ * This entry file is for Webpack plugin.
+ *
+ * @module
+ */
+
 import { isDevelopment } from './core/constants'
+import type { UnpluginStylexOptions } from './types'
 
-export default (options?) => {
+/**
+ * Note: Current, please use @stylexjs/webpack-plugin
+ */
+export default (options?: UnpluginStylexOptions) => {
   if (isDevelopment || options?.dev) {
-    throw new Error(`If you want to use this plugin through webpack, please use "@stylexjs/webpack-plugin" instead`)
+    throw new Error('If you want to use this plugin through webpack, please use "@stylexjs/webpack-plugin" instead')
   }
 }

package/typos.toml

@@ -0,0 +1,10 @@
+[files]
+extend-exclude = [
+  "*.snap",
+  "examples/*",
+]
+
+[default.extend-words]
+# Ignore false-positives
+stylex = "stylex"
+unplugin = "unplugin"

package/vitest.config.ts

@@ -4,8 +4,8 @@ export default defineConfig({
   test: {
     coverage: {
       exclude: [
-        "examples/**",
-        "test/**"
+        'examples/**',
+        'test/**'
       ],
       reporter: ['text', 'json', 'html'],
     },