vite-userscript-plugin 0.1.0 → 0.2.0

package/README.md

@@ -0,0 +1,98 @@
+# vite-userscript-plugin
+
+![ci](https://img.shields.io/github/workflow/status/crashmax-dev/vite-userscript-plugin/npm-publish)
+![npm](https://img.shields.io/npm/v/vite-userscript-plugin)
+![license](https://img.shields.io/github/license/crashmax-dev/vite-userscript-plugin)
+
+> Tampermonkey userscript developing and build plugin based on [Vite](https://vitejs.dev).
+
+## Features
+
+- 🔥 Hot reloading after changing any files.
+- 🔧 Configure Tampermonkey's Userscript header.
+- 💨 Import all `grant` by default in development mode.
+- 📝 Automatically add used `grant` when building for production.
+
+## Install
+
+```
+npm install vite-userscript-plugin -D
+```
+
+```
+yarn add vite-userscript-plugin -D
+```
+
+```
+pnpm add vite-userscript-plugin -D
+```
+
+## Usage
+
+### `vite.config.ts`
+
+```js
+import { resolve } from 'path'
+import { defineConfig } from 'vite'
+import { UserscriptPlugin } from 'vite-userscript-plugin'
+import { name, version } from './package.json'
+
+export default defineConfig({
+  plugins: [
+    UserscriptPlugin({
+      entry: resolve(__dirname, 'src/index.ts'),
+      metadata: {
+        name,
+        version,
+        match: [
+          'https://example.com',
+          'https://example.org',
+          'https://example.edu'
+        ]
+      }
+    })
+  ]
+})
+```
+
+### `package.json`
+
+```json
+{
+  "scripts": {
+    "dev": "vite build --watch",
+    "build": "vite build"
+  }
+}
+```
+
+## Plugin Configuration
+
+```ts
+export interface UserscriptPluginConfig {
+  /**
+   * Path of userscript entry.
+   */
+  entry: string
+
+  /**
+   * Userscript header config.
+   */
+  metadata: MetadataConfig
+
+  /**
+   * Import all `@grant` in development mode.
+   * @default true
+   */
+  autoGrants?: boolean
+
+  /**
+   * Server config (used in development mode for hot reloading).
+   */
+  server?: ServerConfig
+}
+```
+
+## Example
+
+See the [example](https://github.com/crashmax-dev/vite-userscript-plugin/tree/master/packages/demo) folder.

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { PluginOption } from 'vite';
-import type { PluginConfig } from './types.js';
-declare function UserscriptPlugin(config: PluginConfig): PluginOption;
+import type { UserscriptPluginConfig } from './types.js';
+declare function UserscriptPlugin(config: UserscriptPluginConfig): PluginOption;
 export { UserscriptPlugin };
 export default UserscriptPlugin;
-export type { PluginConfig };
+export type { UserscriptPluginConfig };

package/dist/index.js

@@ -82,7 +82,7 @@ function UserscriptPlugin(config) {
                         // prettier-ignore
                         config.metadata.grant = removeDuplicates(isBuildWatch
                             ? grants
-                            : config.autoGrants
+                            : config.autoGrants ?? true
                                 ? defineGrants(file)
                                 : [...(config.metadata.grant ?? []), 'GM_addStyle', 'GM_info']);
                         // prettier-ignore-end

package/dist/types.d.ts

@@ -191,22 +191,27 @@ export declare type MetadataConfig = {
 };
 export interface ServerConfig {
     /**
+     * Server port.
      * @default 8000
      */
     port?: number;
 }
-export interface PluginConfig {
+export interface UserscriptPluginConfig {
     /**
      * Path of userscript entry.
      */
     entry: string;
     /**
-     * @default false
+     * Userscript header config.
+     */
+    metadata: MetadataConfig;
+    /**
+     * Import all `@grant` in development mode.
+     * @default true
      */
     autoGrants?: boolean;
-    server?: ServerConfig;
     /**
-     * Userscript Metadata config.
+     * Server config (used in development mode for hot reloading).
      */
-    metadata: MetadataConfig;
+    server?: ServerConfig;
 }

package/package.json

@@ -1,12 +1,31 @@
 {
   "name": "vite-userscript-plugin",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "type": "module",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",
   "files": [
     "dist"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/crashmax-dev/vite-userscript-plugin.git"
+  },
+  "keywords": [
+    "vite",
+    "vite-plugin",
+    "userscript",
+    "tampermonkey"
+  ],
+  "author": {
+    "name": "Vitalij Ryndin",
+    "email": "sys@crashmax.ru",
+    "url": "https://crashmax.ru"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/crashmax-dev/vite-userscript-plugin/issues"
+  },
   "dependencies": {
     "websocket": "^1.0.34"
   },