First blood

gera2ld · gera2ld · commit ad8432b8c048 · 2021-03-24T22:44:53.000+08:00
diff --git a/.babelrc.js b/.babelrc.js
@@ -0,0 +1,7 @@
+module.exports = {
+  extends: require.resolve('@gera2ld/plaid/config/babelrc-base'),
+  presets: [
+  ],
+  plugins: [
+  ].filter(Boolean),
+};
diff --git a/.browserslistrc b/.browserslistrc
@@ -0,0 +1 @@
+node >= 12
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,13 @@
+# http://editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,3 @@
+/*
+!/src
+!/test
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,14 @@
+module.exports = {
+  root: true,
+  extends: [
+    require.resolve('@gera2ld/plaid/eslint'),
+  ],
+  settings: {
+    'import/resolver': {
+      'babel-module': {},
+    },
+  },
+  rules: {
+    'import/no-unresolved': 'off',
+  },
+};
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,8 @@
+node_modules
+*.log
+*.lock
+/.idea
+/dist
+/.nyc_output
+/coverage
+/types
diff --git a/.husky/.gitignore b/.husky/.gitignore
@@ -0,0 +1 @@
+_
diff --git a/.husky/pre-push b/.husky/pre-push
@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run lint
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Gerald &lt;gera2ld@live.com&gt;
+
+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.
diff --git a/README.md b/README.md
@@ -0,0 +1,9 @@
+# rollup-plugin-userscript
+
+![NPM](https://img.shields.io/npm/v/rollup-plugin-userscript.svg)
+![License](https://img.shields.io/npm/l/rollup-plugin-userscript.svg)
+![Downloads](https://img.shields.io/npm/dt/rollup-plugin-userscript.svg)
+
+Automatically parse metadata and set `@grant`s.
+
+With this plugin, `@grant`s for [`GM_*` functions](https://violentmonkey.github.io/api/metadata-block/) will be added at compile time.
diff --git a/package.json b/package.json
@@ -0,0 +1,42 @@
+{
+  "name": "rollup-plugin-userscript",
+  "version": "0.0.0",
+  "description": "Rollup plugin for userscript",
+  "author": "Gerald <gera2ld@live.com>",
+  "license": "MIT",
+  "scripts": {
+    "ci": "run-s lint",
+    "lint": "eslint src",
+    "dev": "rollup -wc rollup.conf.js",
+    "clean": "del-cli dist",
+    "build:js": "rollup -c rollup.conf.js",
+    "build": "run-s ci clean build:js",
+    "prepare": "husky install"
+  },
+  "main": "dist/index.common.js",
+  "module": "dist/index.esm.js",
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "rollup",
+    "userscript"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "dependencies": {
+    "@babel/runtime": "^7.13.10",
+    "@rollup/pluginutils": "^4.1.0"
+  },
+  "devDependencies": {
+    "@gera2ld/plaid": "~2.3.0",
+    "@gera2ld/plaid-rollup": "~2.3.0",
+    "del-cli": "^3.0.1",
+    "estree-walker": "^3.0.0",
+    "husky": "^5.1.3",
+    "is-reference": "^2.0.0"
+  },
+  "repository": "git@github.com:violentmonkey/rollup-plugin-userscript.git"
+}
diff --git a/rollup.conf.js b/rollup.conf.js
@@ -0,0 +1,73 @@
+const {
+  defaultOptions,
+  getRollupExternal,
+  getRollupPlugins,
+  loadConfigSync,
+} = require('@gera2ld/plaid');
+const pkg = require('./package.json');
+
+const DIST = defaultOptions.distDir;
+const FILENAME = 'index';
+const BANNER = `/*! ${pkg.name} v${pkg.version} | ${pkg.license} License */`;
+
+const external = getRollupExternal([
+  ...require('module').builtinModules,
+  ...Object.keys(pkg.dependencies),
+]);
+const bundleOptions = {
+  extend: true,
+  esModule: false,
+};
+const postcssConfig = loadConfigSync('postcss') || require('@gera2ld/plaid/config/postcssrc');
+const postcssOptions = {
+  ...postcssConfig,
+  inject: false,
+};
+const rollupConfig = [
+  {
+    input: {
+      input: 'src/index.js',
+      plugins: getRollupPlugins({
+        extensions: defaultOptions.extensions,
+        postcss: postcssOptions,
+      }),
+      external,
+    },
+    output: {
+      format: 'cjs',
+      file: `${DIST}/${FILENAME}.common.js`,
+    },
+  },
+  {
+    input: {
+      input: 'src/index.js',
+      plugins: getRollupPlugins({
+        esm: true,
+        extensions: defaultOptions.extensions,
+        postcss: postcssOptions,
+      }),
+      external,
+    },
+    output: {
+      format: 'esm',
+      file: `${DIST}/${FILENAME}.esm.js`,
+    },
+  },
+];
+
+rollupConfig.forEach((item) => {
+  item.output = {
+    indent: false,
+    // If set to false, circular dependencies and live bindings for external imports won't work
+    externalLiveBindings: false,
+    ...item.output,
+    ...BANNER && {
+      banner: BANNER,
+    },
+  };
+});
+
+module.exports = rollupConfig.map(({ input, output }) => ({
+  ...input,
+  output,
+}));
diff --git a/src/index.js b/src/index.js
@@ -0,0 +1,91 @@
+import { promises as fs } from 'fs';
+import { attachScopes } from '@rollup/pluginutils';
+import { walk } from 'estree-walker';
+import isReference from 'is-reference';
+
+const gmAPIs = [
+  'GM_info',
+  'GM_getValue',
+  'GM_setValue',
+  'GM_deleteValue',
+  'GM_listValues',
+  'GM_addValueChangeListener',
+  'GM_removeValueChangeListener',
+  'GM_getResourceText',
+  'GM_getResourceURL',
+  'GM_addStyle',
+  'GM_openInTab',
+  'GM_registerMenuCommand',
+  'GM_unregisterMenuCommand',
+  'GM_notification',
+  'GM_setClipboard',
+  'GM_xmlhttpRequest',
+  'GM_download',
+];
+const META_START = '// ==UserScript==';
+const META_END = '// ==/UserScript==';
+
+export default (metafile, transform) => {
+  const grants = new Set();
+  return {
+    name: 'banner',
+    buildStart() {
+      this.addWatchFile(metafile);
+      grants.clear();
+    },
+    transform(code) {
+      const ast = this.parse(code);
+      let scope = attachScopes(ast, 'scope');
+      walk(ast, {
+        enter(node, parent) {
+          if (node.scope) scope = node.scope;
+          if (node.type === 'Identifier' && isReference(node, parent) && !scope.contains(node.name)) {
+            if (gmAPIs.includes(node.name)) {
+              grants.add(node.name);
+            }
+          }
+        },
+        leave(node) {
+          if (node.scope) scope = scope.parent;
+        },
+      });
+    },
+    async banner() {
+      let meta = await fs.readFile(metafile, 'utf8');
+      const lines = meta.split('\n').map(line => line.trim());
+      const start = lines.indexOf(META_START);
+      const end = lines.indexOf(META_END);
+      if (start < 0 || end < 0) {
+        console.warn('Invalid metadata block. For more details see https://violentmonkey.github.io/api/metadata-block/');
+        return;
+      }
+      const items = lines.slice(start + 1, end)
+        .map(line => {
+          if (!line.startsWith('// ')) return;
+          line = line.slice(3).trim();
+          const i = line.indexOf(' ');
+          if (i < 0) return;
+          const key = line.slice(0, i);
+          const value = line.slice(i + 1).trim();
+          if (key === '@grant') {
+            grants.add(value);
+            return;
+          }
+          return [key, value];
+        })
+        .filter(Boolean);
+      for (const grant of grants) {
+        items.push(['@grant', grant]);
+      }
+      const maxKeyWidth = Math.max(...items.map(([key]) => key.length));
+      meta = [
+        META_START,
+        ...items.map(([key, value]) => `// ${key.padEnd(maxKeyWidth)} ${value}`),
+        META_END,
+        '',
+      ].join('\n');
+      if (transform) meta = transform(meta);
+      return meta;
+    },
+  };
+};
