@ohos-ports/vite-plugin-rails 0.6.0-beta.1

package/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Maximo Mussini
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,132 @@
+<h2 align='center'><samp>vite-plugin-rails</samp></h2>
+
+<p align='center'>Convention over configuration for Rails projects using Vite</p>
+
+<p align='center'>
+  <a href='https://www.npmjs.com/package/vite-plugin-rails'>
+    <img src='https://img.shields.io/npm/v/vite-plugin-rails?color=222&style=flat-square'>
+  </a>
+  <a href='https://github.com/ElMassimo/vite_ruby/blob/master/LICENSE.txt'>
+    <img src='https://img.shields.io/badge/license-MIT-blue.svg'>
+  </a>
+</p>
+
+<br>
+
+[vite_rails]: https://github.com/ElMassimo/vite_ruby/tree/main/vite_rails
+[vite-plugin-ruby]: https://github.com/ElMassimo/vite_ruby/tree/main/vite-plugin-ruby
+[configuration options]: https://github.com/ElMassimo/vite_ruby/tree/main/vite-plugin-rails/src/index.ts#L12-L84
+[rollup-plugin-gzip]: https://github.com/kryops/rollup-plugin-gzip
+[vite-plugin-environment]: https://github.com/ElMassimo/vite-plugin-environment
+[vite-plugin-full-reload]: https://github.com/ElMassimo/vite-plugin-full-reload
+[vite-plugin-stimulus-hmr]: https://github.com/ElMassimo/vite-plugin-stimulus-hmr
+[vite-plugin-manifest-sri]: https://github.com/ElMassimo/vite-plugin-manifest-sri
+
+## Installation 💿
+
+In the future, [<kbd>vite_rails</kbd>][vite_rails] might install this plugin by default.
+
+You can install it manually by running:
+
+```bash
+npm i vite-plugin-rails # yarn add vite-plugin-rails
+```
+
+## Usage 🚀
+
+Add it to your plugins in `vite.config.ts`
+
+```ts
+// vite.config.ts
+import Vue from '@vitejs/plugin-vue' // Example, could be using other plugins.
+import ViteRails from 'vite-plugin-rails'
+
+export default {
+  plugins: [
+    Vue(),
+    ViteRails(),
+  ],
+};
+```
+
+## Batteries Included 🔋
+
+Unlike [`vite-plugin-ruby`][vite-plugin-ruby], which provides the minimum amount of configuration necessary to get started, this plugin takes a Rails-approach of including plugins you would normally add.
+
+You can configure each plugin by passing options, which are fully typed. See the [configuration options] for reference.
+
+If you need finer-grained control, you can opt-out and use `vite-plugin-ruby` instead, manually adding only the plugins you need.
+
+### [Ruby][vite-plugin-ruby]
+
+[`vite-plugin-ruby`][vite-plugin-ruby] is added by default.
+
+### Compression
+
+This plugin uses [`rollup-plugin-gzip`][rollup-plugin-gzip] to create `gzip` and `brotli` compressed copies of your assets after build.
+
+You can disable each manually:
+
+```ts
+    ViteRails({
+      compress: { brotli: false }
+    }),
+```
+
+```ts
+    ViteRails({
+      compress: false
+    }),
+```
+
+
+### [Environment](https://github.com/ElMassimo/vite-plugin-environment)
+
+[`vite-plugin-environment`][vite-plugin-environment] is used to expose environment variables to your
+client code, using the [`import.meta.env`](https://vitejs.dev/guide/env-and-mode.html#env-files) convention from Vite.
+
+This plugin allows you to conveniently provide defaults, or fail on required env variables:
+
+```ts
+    ViteRails({
+      envVars: {
+        API_KEY: null,
+        OPTIONAL_KEY: '<opt-value>',
+      },
+    }),
+```
+
+### [Full Reload](https://github.com/ElMassimo/vite-plugin-full-reload)
+
+[`vite-plugin-full-reload`][vite-plugin-full-reload] comes pre-configured to automatically reload the page
+when making changes to server-rendered layouts and templates, improving the
+feedback cycle.
+
+You can override the default paths, or pass additional ones:
+
+```ts
+    ViteRails({
+      fullReload: {
+        additionalPaths: ['app/serializers/**/*']
+      },
+    }),
+```
+
+### [Stimulus HMR](https://github.com/ElMassimo/vite-plugin-stimulus-hmr)
+
+[`vite-plugin-stimulus-hmr`][vite-plugin-stimulus-hmr] is included by default,
+allowing you to see changes to your Stimulus controllers instantly without refreshing the page.
+
+You can use the `stimulus` option if you need to configure it.
+
+### [Subresource Integrity](https://github.com/ElMassimo/vite-plugin-manifest-sri)
+
+[`vite-plugin-manifest-sri`][vite-plugin-manifest-sri] is included by default,
+calculating a cryptographic hash for JavaScript and CSS assets, so that the browser
+can verify the resources it fetches.
+
+You can use the `sri` option if you need to configure it.
+
+## License
+
+This library is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

package/dist/index.d.mts

@@ -0,0 +1,78 @@
+import { Config } from "vite-plugin-full-reload";
+import { Options as Options$1 } from "vite-plugin-manifest-sri";
+import { EnvOptions, EnvVars } from "vite-plugin-environment";
+import { Options as Options$2 } from "vite-plugin-stimulus-hmr";
+import { GzipPluginOptions } from "rollup-plugin-gzip";
+import { PluginOption } from "vite";
+
+//#region src/index.d.ts
+interface Options {
+  /**
+   * Whether to create compressed copies of relevant assets.
+   *
+   * Can use it to turn off `gzip` and `brotli` at once.
+   *
+   * @default true
+   */
+  compress?: boolean | {
+    /**
+     * Whether to create gzip copies of relevant assets.
+     * @default true
+     */
+    gzip?: boolean;
+    /**
+     * Whether to create brotli copies of relevant assets.
+     * @default true
+     */
+    brotli?: boolean;
+  };
+  /**
+   * Options for rollup-plugin-gzip, will be used both for brotli and gzip.
+   *
+   * https://github.com/kryops/rollup-plugin-gzip
+   */
+  compression?: GzipPluginOptions;
+  /**
+   * Environment variables that should be exposed to the client build.
+   *
+   * By default, they are exposed under `import.meta.env`.
+   *
+   * https://github.com/ElMassimo/vite-plugin-environment
+   */
+  envVars?: EnvVars;
+  /**
+   * Options for vite-plugin-environment.
+   *
+   * By default, they are exposed under `import.meta.env`.
+   *
+   * https://github.com/ElMassimo/vite-plugin-environment
+   */
+  envOptions?: EnvOptions;
+  /**
+   * Options for vite-plugin-manifest-sri.
+   *
+   * https://github.com/ElMassimo/vite-plugin-manifest-sri
+   */
+  sri?: false | Options$1;
+  /**
+   * Options for vite-plugin-stimulus-hmr.
+   *
+   * https://github.com/ElMassimo/vite-plugin-stimulus-hmr
+   */
+  stimulus?: false | Options$2;
+  /**
+   * Options for vite-plugin-full-reload.
+   *
+   * By default it's configured for a standard Rails structure, assuming you
+   * would want to automatically reload when modifying views or routes.
+   *
+   * https://github.com/ElMassimo/vite-plugin-full-reload
+   */
+  fullReload?: false | Config & {
+    additionalPaths?: string | string[];
+    overridePaths?: string | string[];
+  };
+}
+declare function ViteRubyPlugin(options?: Options): PluginOption[];
+//#endregion
+export { Options, ViteRubyPlugin as default };

package/dist/index.mjs

@@ -0,0 +1,72 @@
+import { brotliCompressSync } from "zlib";
+import fullReloadPlugin from "vite-plugin-full-reload";
+import manifestSRI from "vite-plugin-manifest-sri";
+import ruby from "vite-plugin-ruby";
+import environment from "vite-plugin-environment";
+import stimulusHMRPlugin from "vite-plugin-stimulus-hmr";
+import gzipPlugin from "rollup-plugin-gzip";
+//#region src/index.ts
+/**
+* [defaultReloadPaths description]
+* @type {Array}
+*/
+const defaultReloadPaths = [
+	"config/routes.rb",
+	"config/routes/*.rb",
+	"app/views/**/*"
+];
+function ViteRubyPlugin(options = {}) {
+	let { compress = true } = options;
+	if (compress !== false) compress = {
+		gzip: true,
+		brotli: true,
+		...compress === true ? {} : compress
+	};
+	const envOptions = {
+		defineOn: "import.meta.env",
+		...options.envOptions
+	};
+	const { overridePaths, additionalPaths = [], ...reloadOptions } = options.fullReload || {};
+	const reloadPaths = overridePaths || [...defaultReloadPaths, ...wrapArray(additionalPaths)];
+	const plugins = [
+		ruby(),
+		options.envVars && environment(options.envVars, envOptions),
+		options.sri !== false && manifestSRI(options.sri),
+		options.stimulus !== false && stimulusHMRPlugin(options.stimulus),
+		options.fullReload !== false && fullReloadPlugin(reloadPaths, reloadOptions),
+		compress && compress.gzip && gzipPlugin(options.compression),
+		compress && compress.brotli && gzipPlugin({
+			...options.compression,
+			customCompression: (content) => brotliCompressSync(Buffer.from(content)),
+			fileName: ".br"
+		})
+	].flat(Infinity).filter((plugin) => plugin);
+	return [...plugins, dupDetector(plugins.map((plugin) => plugin.name))];
+}
+function wrapArray(array) {
+	return Array.isArray(array) ? array : [array];
+}
+function dupDetector(originalPluginNames) {
+	return {
+		name: "vite-plugin-rails:dup-detector",
+		configResolved(config) {
+			if (config.plugins) {
+				const pluginNames = new Set(originalPluginNames);
+				pluginNames.delete("gzip");
+				const pluginCounts = Object.create(null);
+				config.plugins.filter((plugin) => pluginNames.has(plugin.name)).forEach((plugin) => {
+					pluginCounts[plugin.name] = (pluginCounts[plugin.name] || 0) + 1;
+				});
+				const duplicates = Object.entries(pluginCounts).filter(([name, count]) => count > 1).map(([name, count]) => name);
+				if (duplicates.length) throw new Error(`
+            [vite-plugin-rails] Duplicate plugins detected: ${duplicates.join(", ")}.
+
+            If migrating from vite-plugin-ruby, make sure to remove these manually added
+            plugins, and instead pass the options to vite-plugin-rails.
+          `);
+			}
+		}
+	};
+}
+//#endregion
+export { ViteRubyPlugin as default };

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@ohos-ports/vite-plugin-rails",
+  "description": "Convention over configuration for using Vite in Rails apps",
+  "version": "0.6.0-beta.1",
+  "type": "module",
+  "types": "./dist/index.d.mts",
+  "exports": {
+    ".": "./dist/index.mjs",
+    "./package.json": "./package.json"
+  },
+  "license": "MIT",
+  "author": "Máximo Mussini <maximomussini@gmail.com> (https://maximomussini.com)",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ohos-ports/ohos-ports.git",
+    "directory": "ports/vite-plugin-rails/0.6.0"
+  },
+  "keywords": [
+    "plugin",
+    "rails",
+    "ruby",
+    "vite",
+    "vite-plugin",
+    "vitejs"
+  ],
+  "homepage": "https://github.com/ohos-ports/ohos-ports/tree/main/ports/vite-plugin-rails/0.6.0",
+  "bugs": "https://github.com/ohos-ports/ohos-ports/issues",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "rollup-plugin-gzip": "^4.2.0",
+    "vite-plugin-environment": "^1.1.3",
+    "vite-plugin-full-reload": "^1.1.0",
+    "vite-plugin-manifest-sri": "^0.2.0",
+    "vite-plugin-ruby": "^5.0.0",
+    "vite-plugin-stimulus-hmr": "^3.0.0"
+  },
+  "peerDependencies": {
+    "vite": ">=5.0.0"
+  },
+  "devDependencies": {
+    "@types/debug": "^4.1.12",
+    "@types/node": "^22.0.0",
+    "standard-version": "^9.5.0",
+    "typescript": "^5.0.0",
+    "@ohos-ports/rollup": "^4.62.2-beta.2",
+    "vite": "^8.0.0",
+    "vitest": "^0.34.6",
+    "@ohos-ports/tsdown": "^0.23.0-beta.0"
+  },
+  "scripts": {
+    "lint": "eslint .",
+    "dev": "npm run build -- --watch",
+    "example:dev": "npm -C example run dev",
+    "example:build": "npm -C example run build",
+    "build": "tsdown",
+    "test": "vitest"
+  }
+}