with-zephyr 0.0.1 → 0.1.0-next.1

package/README.md

@@ -1,4 +1,4 @@
-# zephyr-codemod
+# with-zephyr
 
 A codemod tool that automatically adds the `withZephyr` plugin to bundler configurations in your project.
 
@@ -20,10 +20,13 @@ Get your project Zephyr-ready in seconds:
 
 ```bash
 # 1. Run the codemod to add Zephyr plugins to your bundler configs
-npx zephyr-codemod --install
-# or: pnpm dlx zephyr-codemod --install
-# or: yarn dlx zephyr-codemod --install  
-# or: bunx zephyr-codemod --install
+curl -fsSL https://with.zephyr-cloud.io | node
+
+# Alternative methods:
+npx with-zephyr
+pnpm dlx with-zephyr
+yarn dlx with-zephyr
+bunx with-zephyr
 
 # 2. That's it! Your bundler is now configured for Zephyr deployments
 # Visit https://app.zephyr-cloud.io to deploy your micro-frontends
@@ -31,7 +34,7 @@ npx zephyr-codemod --install
 
 ## Supported Bundlers
 
-This codemod supports **10+ bundlers** with their respective Zephyr plugins:
+This codemod supports **11+ bundlers** with their respective Zephyr plugins:
 
 - **Webpack** ([`zephyr-webpack-plugin`](https://www.npmjs.com/package/zephyr-webpack-plugin))
 - **Rspack** ([`zephyr-rspack-plugin`](https://www.npmjs.com/package/zephyr-rspack-plugin))
@@ -41,25 +44,23 @@ This codemod supports **10+ bundlers** with their respective Zephyr plugins:
 - **Modern.js** ([`zephyr-modernjs-plugin`](https://www.npmjs.com/package/zephyr-modernjs-plugin))
 - **RSPress** ([`zephyr-rspress-plugin`](https://www.npmjs.com/package/zephyr-rspress-plugin))
 - **Parcel** ([`parcel-reporter-zephyr`](https://www.npmjs.com/package/parcel-reporter-zephyr))
-- **RSBuild** ([`zephyr-rspack-plugin`](https://www.npmjs.com/package/zephyr-rspack-plugin))
+- **RSBuild** ([`zephyr-rsbuild-plugin`](https://www.npmjs.com/package/zephyr-rsbuild-plugin))
+- **RSLib** ([`zephyr-rsbuild-plugin`](https://www.npmjs.com/package/zephyr-rsbuild-plugin))
 - **Re.Pack** (React Native) ([`zephyr-repack-plugin`](https://www.npmjs.com/package/zephyr-repack-plugin))
 
 ## Installation
 
-**No installation required!** Use directly with your package manager:
+**No installation required!** Use directly with one command:
 
 ```bash
-# npm
-npx zephyr-codemod
-
-# pnpm  
-pnpm dlx zephyr-codemod
-
-# yarn
-yarn dlx zephyr-codemod
-
-# bun
-bunx zephyr-codemod
+# Recommended: Use the hosted version
+curl -fsSL https://with.zephyr-cloud.io | node
+
+# Alternative: Use with your package manager
+npx with-zephyr       # npm
+pnpm dlx with-zephyr  # pnpm
+yarn dlx with-zephyr  # yarn
+bunx with-zephyr      # bun
 ```
 
 > **💡 Tip:** Using `npx`/`dlx`/`bunx` ensures you always get the latest version without cluttering your global packages.
@@ -71,10 +72,15 @@ bunx zephyr-codemod
 Run the codemod in your project directory:
 
 ```bash
-npx zephyr-codemod
+# Recommended: Use the hosted version
+curl -fsSL https://with.zephyr-cloud.io | node
+
+# Alternative: Use with package managers
+npx with-zephyr
 ```
 
 This will:
+
 1. Search for bundler configuration files in the current directory and subdirectories
 2. Detect which bundler each config file is for
 3. Add the appropriate `withZephyr` plugin configuration
@@ -84,24 +90,24 @@ This will:
 
 ```bash
 # Show what would be changed without modifying files
-npx zephyr-codemod --dry-run
+npx with-zephyr --dry-run
 
-# Automatically install missing plugin packages  
-npx zephyr-codemod --install
+# Automatically install missing plugin packages
+npx with-zephyr --install
 
 # Specify a different directory
-npx zephyr-codemod ./my-project
+npx with-zephyr ./my-project
 
 # Only process specific bundlers
-npx zephyr-codemod --bundlers webpack vite
+npx with-zephyr --bundlers webpack vite
 
 # Combine options
-npx zephyr-codemod ./src --dry-run --bundlers rollup --install
+npx with-zephyr ./src --dry-run --bundlers rollup --install
 
 # Use with other package managers
-pnpm dlx zephyr-codemod --install
-yarn dlx zephyr-codemod --dry-run
-bunx zephyr-codemod --bundlers vite rollup
+pnpm dlx with-zephyr --install
+yarn dlx with-zephyr --dry-run
+bunx with-zephyr --bundlers vite rollup
 ```
 
 ### Options
@@ -118,64 +124,55 @@ bunx zephyr-codemod --bundlers vite rollup
 #### Webpack Configuration
 
 **Before:**
+
 ```javascript
 const { composePlugins, withNx, withReact } = require('@nx/webpack');
 
-module.exports = composePlugins(
-  withNx(),
-  withReact(),
-  (config) => {
-    return config;
-  }
-);
+module.exports = composePlugins(withNx(), withReact(), (config) => {
+  return config;
+});
 ```
 
 **After:**
+
 ```javascript
 const { withZephyr } = require('zephyr-webpack-plugin');
 const { composePlugins, withNx, withReact } = require('@nx/webpack');
 
-module.exports = composePlugins(
-  withNx(),
-  withReact(),
-  withZephyr(),
-  (config) => {
-    return config;
-  }
-);
+module.exports = composePlugins(withNx(), withReact(), withZephyr(), (config) => {
+  return config;
+});
 ```
 
 #### Vite Configuration
 
 **Before:**
+
 ```typescript
 import { defineConfig } from 'vite';
 import react from '@vitejs/plugin-react';
 
 export default defineConfig({
-  plugins: [
-    react(),
-  ],
+  plugins: [react()],
 });
 ```
 
 **After:**
+
 ```typescript
 import { withZephyr } from 'vite-plugin-zephyr';
 import { defineConfig } from 'vite';
 import react from '@vitejs/plugin-react';
 
 export default defineConfig({
-  plugins: [
-    react(),
-    withZephyr(),
-  ],
+  plugins: [react(), withZephyr()],
 });
 ```
 
 #### Rollup Configuration
 
 **Before:**
+
 ```javascript
 module.exports = (config) => {
   return config;
@@ -183,6 +180,7 @@ module.exports = (config) => {
 ```
 
 **After:**
+
 ```javascript
 const { withZephyr } = require('rollup-plugin-zephyr');
 
@@ -201,8 +199,9 @@ The codemod can automatically install missing Zephyr plugin packages using the `
 The tool automatically detects your package manager by checking for:
 
 1. **Lock files** (in order of priority):
+
    - `pnpm-lock.yaml` → pnpm
-   - `yarn.lock` → yarn  
+   - `yarn.lock` → yarn
    - `package-lock.json` → npm
    - `bun.lockb` → bun
 
@@ -221,13 +220,13 @@ The tool automatically detects your package manager by checking for:
 
 ```bash
 # Install packages and update configs in one command
-npx zephyr-codemod --install
+npx with-zephyr --install
 
 # Preview what packages would be installed
-npx zephyr-codemod --dry-run --install
+npx with-zephyr --dry-run --install
 
 # The tool will show you which packages need to be installed if you don't use --install
-npx zephyr-codemod
+npx with-zephyr
 # Output: 💡 Tip: Use --install to automatically install missing packages:
 #           vite-plugin-zephyr
 #           zephyr-webpack-plugin
@@ -244,6 +243,8 @@ The codemod automatically detects and processes these configuration files:
 - `rolldown.config.js/ts/mjs`
 - `modern.config.js/ts/mjs`
 - `rspress.config.js/ts/mjs`
+- `rsbuild.config.js/ts/mjs`
+- `rslib.config.js/ts/mjs`
 - `.parcelrc/.parcelrc.json`
 
 ## Integration Patterns
@@ -251,22 +252,27 @@ The codemod automatically detects and processes these configuration files:
 The codemod recognizes and handles various configuration patterns:
 
 ### Webpack/Rspack
+
 - `composePlugins()` calls (Nx style)
 - `plugins: []` arrays
 - Direct `module.exports` assignments
 
 ### Vite/Rolldown
+
 - `defineConfig()` calls
 - `plugins: []` arrays
 
 ### Rollup
+
 - Function-based configs with `config.plugins.push()`
 - `plugins: []` arrays
 
 ### Modern.js/RSPress
+
 - `defineConfig()` calls with `plugins: []` arrays
 
 ### Parcel
+
 - JSON configuration with `reporters` array
 
 ## Safety Features
@@ -328,7 +334,3 @@ src/
 ## Contributing
 
 Found a configuration pattern that isn't supported? Please open an issue or submit a pull request!
-
-## License
-
-Apache-2.0