add a Vite plugin

rubys · rubys · commit 499d9f5d15e2 · 2021-03-26T12:23:27.000-04:00
diff --git a/packages/vite-plugin/.gitignore b/packages/vite-plugin/.gitignore
@@ -0,0 +1,2 @@
+yarn.lock
+node_modules
diff --git a/packages/vite-plugin/README.md b/packages/vite-plugin/README.md
@@ -0,0 +1,53 @@
+# @ruby2js/rollup-plugin
+
+Integration between Vite and Ruby2JS
+
+## Description
+
+Since Vite supports both rollup and vite plugins, this plugin can be used
+interchangeably with the [Ruby2JS Rollup
+plugin](https://www.npmjs.com/package/@ruby2js/rollup-plugin) with if there
+the use of a refresh plugin is not needed.
+
+What this plugin does is integrate Ruby2JS with the refresh process.  In order
+to do this, the refresh plugin you would normally use needs to be passed as an
+option to the Ruby2JS plugin rather than included as a separate plugin.  An
+example of this usage follows below.
+
+## Installation
+
+```bash
+npm install --save-dev @ruby2js/vite-plugin
+# or
+yarn add -D @ruby2js/vite-plugin
+```
+
+## Usage
+
+The following is a example of a `vite.config.js` file configured for use with
+the React refresh plugin.  Note the addition of `.rb` and `.js.rb` extensions
+to `resolve.extensions` and the passing of the `reactRefresh` plugin as a
+`refresh` option to the `@ruby2js/vite-plugin`.
+
+```javascript
+import { defineConfig } from 'vite'
+import reactRefresh from '@vitejs/plugin-react-refresh'
+import ruby2js from '@ruby2js/vite-plugin';
+
+export default defineConfig({
+  resolve: {
+    extensions: ['.rb', '.js.rb'].concat(
+      ['.mjs', '.js', '.ts', '.jsx', '.tsx', '.json']
+    )
+  },
+
+  plugins: [
+    ruby2js({
+      refresh: reactRefresh(),
+      eslevel: 2021,
+      autoexports: 'default',
+      filters: ['react', 'esm', 'functions']
+    })
+  ]
+})
+```
diff --git a/packages/vite-plugin/index.js b/packages/vite-plugin/index.js
@@ -0,0 +1,19 @@
+const Ruby2JS = require('@ruby2js/ruby2js');
+const { extname } = require('path');
+
+module.exports = options => {
+  let extensions = options.extensions || ['.rb'];
+
+  return {
+    transform(code, id) {
+      if (!extensions.includes(extname(id))) return;
+
+      js = Ruby2JS.convert(code, {...options, file: id});
+
+      return {
+        code: js.toString(),
+        map: js.sourcemap
+      }
+    }
+  }
+}
diff --git a/packages/vite-plugin/package.json b/packages/vite-plugin/package.json
@@ -0,0 +1,25 @@
+{
+  "name": "@ruby2js/vite-plugin",
+  "version": "0.0.1",
+  "description": "ruby2js plugin for vite",
+  "author": "Sam Ruby <rubys@intertwingly.net>",
+  "license": "MIT",
+  "main": "index.js",
+  "homepage": "https://github.com/ruby2js/ruby2js/tree/master/packages/rollup-plugin#readme",
+  "keywords": [
+    "ruby2js",
+    "vite",
+    "vite-plugin"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ruby2js/ruby2js"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@ruby2js/rollup-plugin": ">= 0.0.2",
+    "btoa": "~1.2.1"
+  }
+}
