chore: upgrade doc & ci

.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

README.md

@@ -1,5 +1,8 @@
 # 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
 
 Install the package from the following command
@@ -75,9 +78,9 @@ module.exports = {
 
 ## Options
 
-### options.dev
+Current support argument, which may have change in the future
 
-### options.stylex
+### options.dev
 
 #### options.stylex.runtimeInjection
 
@@ -91,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)

examples/esbuild-example/package.json

@@ -11,7 +11,7 @@
     "@stylexjs/stylex": "^0.5.1",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "unplugin-stylex": "latest"
+    "unplugin-stylex": "workspace:*"
   },
   "devDependencies": {
     "@types/react": "^18.2.56",

examples/rspack-example/package.json

@@ -10,7 +10,7 @@
     "@stylexjs/stylex": "^0.5.1",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "unplugin-stylex": "0.1.0"
+    "unplugin-stylex": "workspace:*"
   },
   "devDependencies": {
     "@rspack/cli": "^0.5.4",

examples/vite-example/package.json

@@ -16,7 +16,7 @@
     "@types/react": "^18.2.56",
     "@types/react-dom": "^18.2.19",
     "@vitejs/plugin-react": "^4.2.1",
-    "unplugin-stylex": "latest",
+    "unplugin-stylex": "workspace:*",
     "vite": "^5.0.10"
   }
 }

examples/vue-example/package.json

@@ -15,7 +15,7 @@
     "@vitejs/plugin-vue": "^4.6.2",
     "@vitejs/plugin-vue-jsx": "^3.1.0",
     "typescript": "^5.3.3",
-    "unplugin-stylex": "latest",
+    "unplugin-stylex": "workspace:*",
     "vite": "^5.0.10",
     "vue-tsc": "^1.8.27"
   }

typos.toml

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