Initial commit

Author: jsejcksn

.eslint/deno-json.ts

@@ -0,0 +1,20 @@
+// deno run deno-json.ts > deno.json
+
+const caseInsensitiveSort = (strA: string, strB: string): number => {
+  const a = strA.toLowerCase();
+  const b = strB.toLowerCase();
+  if (a < b) return -1;
+  if (a > b) return 1;
+  return 0;
+};
+
+const sortedGlobals = [...Object.getOwnPropertyNames(globalThis)]
+  .sort(caseInsensitiveSort);
+
+const globals: Record<string, string> = {};
+for (const key of sortedGlobals) globals[key] = 'readonly';
+
+const spaces = 2;
+const json = JSON.stringify({globals}, null, spaces);
+
+console.log(json);

.eslint/deno.json

@@ -0,0 +1,158 @@
+{
+  "globals": {
+    "AbortController": "readonly",
+    "AbortSignal": "readonly",
+    "addEventListener": "readonly",
+    "AggregateError": "readonly",
+    "alert": "readonly",
+    "Array": "readonly",
+    "ArrayBuffer": "readonly",
+    "atob": "readonly",
+    "Atomics": "readonly",
+    "BigInt": "readonly",
+    "BigInt64Array": "readonly",
+    "BigUint64Array": "readonly",
+    "Blob": "readonly",
+    "Boolean": "readonly",
+    "btoa": "readonly",
+    "ByteLengthQueuingStrategy": "readonly",
+    "clearInterval": "readonly",
+    "clearTimeout": "readonly",
+    "close": "readonly",
+    "closed": "readonly",
+    "CloseEvent": "readonly",
+    "confirm": "readonly",
+    "console": "readonly",
+    "CountQueuingStrategy": "readonly",
+    "crypto": "readonly",
+    "CustomEvent": "readonly",
+    "DataView": "readonly",
+    "Date": "readonly",
+    "decodeURI": "readonly",
+    "decodeURIComponent": "readonly",
+    "Deno": "readonly",
+    "dispatchEvent": "readonly",
+    "DOMException": "readonly",
+    "encodeURI": "readonly",
+    "encodeURIComponent": "readonly",
+    "Error": "readonly",
+    "ErrorEvent": "readonly",
+    "escape": "readonly",
+    "eval": "readonly",
+    "EvalError": "readonly",
+    "Event": "readonly",
+    "EventTarget": "readonly",
+    "fetch": "readonly",
+    "File": "readonly",
+    "FileReader": "readonly",
+    "FinalizationRegistry": "readonly",
+    "Float32Array": "readonly",
+    "Float64Array": "readonly",
+    "FormData": "readonly",
+    "Function": "readonly",
+    "globalThis": "readonly",
+    "GPU": "readonly",
+    "GPUAdapter": "readonly",
+    "GPUAdapterFeatures": "readonly",
+    "GPUAdapterLimits": "readonly",
+    "GPUBindGroup": "readonly",
+    "GPUBindGroupLayout": "readonly",
+    "GPUBuffer": "readonly",
+    "GPUBufferUsage": "readonly",
+    "GPUColorWrite": "readonly",
+    "GPUCommandBuffer": "readonly",
+    "GPUCommandEncoder": "readonly",
+    "GPUComputePassEncoder": "readonly",
+    "GPUComputePipeline": "readonly",
+    "GPUDevice": "readonly",
+    "GPUMapMode": "readonly",
+    "GPUOutOfMemoryError": "readonly",
+    "GPUPipelineLayout": "readonly",
+    "GPUQuerySet": "readonly",
+    "GPUQueue": "readonly",
+    "GPURenderBundle": "readonly",
+    "GPURenderBundleEncoder": "readonly",
+    "GPURenderPassEncoder": "readonly",
+    "GPURenderPipeline": "readonly",
+    "GPUSampler": "readonly",
+    "GPUShaderModule": "readonly",
+    "GPUShaderStage": "readonly",
+    "GPUTexture": "readonly",
+    "GPUTextureUsage": "readonly",
+    "GPUTextureView": "readonly",
+    "GPUValidationError": "readonly",
+    "Headers": "readonly",
+    "Infinity": "readonly",
+    "Int16Array": "readonly",
+    "Int32Array": "readonly",
+    "Int8Array": "readonly",
+    "Intl": "readonly",
+    "isFinite": "readonly",
+    "isNaN": "readonly",
+    "JSON": "readonly",
+    "Location": "readonly",
+    "location": "readonly",
+    "Map": "readonly",
+    "Math": "readonly",
+    "MessageEvent": "readonly",
+    "NaN": "readonly",
+    "Navigator": "readonly",
+    "navigator": "readonly",
+    "Number": "readonly",
+    "Object": "readonly",
+    "onload": "readonly",
+    "onunload": "readonly",
+    "parseFloat": "readonly",
+    "parseInt": "readonly",
+    "Performance": "readonly",
+    "performance": "readonly",
+    "PerformanceEntry": "readonly",
+    "PerformanceMark": "readonly",
+    "PerformanceMeasure": "readonly",
+    "ProgressEvent": "readonly",
+    "Promise": "readonly",
+    "prompt": "readonly",
+    "Proxy": "readonly",
+    "queueMicrotask": "readonly",
+    "RangeError": "readonly",
+    "ReadableStream": "readonly",
+    "ReadableStreamDefaultReader": "readonly",
+    "ReferenceError": "readonly",
+    "Reflect": "readonly",
+    "RegExp": "readonly",
+    "removeEventListener": "readonly",
+    "Request": "readonly",
+    "Response": "readonly",
+    "self": "readonly",
+    "Set": "readonly",
+    "setInterval": "readonly",
+    "setTimeout": "readonly",
+    "SharedArrayBuffer": "readonly",
+    "String": "readonly",
+    "Symbol": "readonly",
+    "SyntaxError": "readonly",
+    "TextDecoder": "readonly",
+    "TextEncoder": "readonly",
+    "TransformStream": "readonly",
+    "TypeError": "readonly",
+    "Uint16Array": "readonly",
+    "Uint32Array": "readonly",
+    "Uint8Array": "readonly",
+    "Uint8ClampedArray": "readonly",
+    "undefined": "readonly",
+    "unescape": "readonly",
+    "URIError": "readonly",
+    "URL": "readonly",
+    "URLSearchParams": "readonly",
+    "WeakMap": "readonly",
+    "WeakRef": "readonly",
+    "WeakSet": "readonly",
+    "WebAssembly": "readonly",
+    "WebSocket": "readonly",
+    "Window": "readonly",
+    "window": "readonly",
+    "Worker": "readonly",
+    "WritableStream": "readonly",
+    "WritableStreamDefaultWriter": "readonly"
+  }
+}

.eslint/eslintrc.cjs

@@ -0,0 +1,10 @@
+const deno = require('./deno.json');
+const tsEslint = require('./typescript-eslint-base.json');
+
+module.exports = {
+  extends: [...tsEslint.extends, '@jsejcksn'],
+  globals: deno.globals,
+  parser: tsEslint.parser,
+  plugins: tsEslint.plugins,
+  root: true,
+};

.eslint/typescript-eslint-base.json

@@ -0,0 +1,11 @@
+{
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "plugins": [
+    "@typescript-eslint"
+  ],
+  "root": true
+}

.eslintrc.cjs

@@ -0,0 +1,4 @@
+module.exports = {
+  ...require('./.eslint/eslintrc.cjs'),
+  rules: {'func-style': 'off'},
+};

.gitignore

@@ -1,3 +1,5 @@
+/untracked/
+
 # Logs
 logs
 *.log

.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+  "deno.enable": true,
+  "deno.lint": false,
+  "deno.unstable": true,
+  "deno.suggest.imports.hosts": {
+    "https://deno.land": true
+  }
+}

README.md

@@ -1 +1,69 @@
-# deno-userscript-bundler
+# deno-userscript-bundler
+
+
+## To-do
+
+- Write documentation
+- Write tests
+
+
+## Install
+
+```
+deno install --unstable --name uscript-deno main.ts
+```
+
+> To avoid being prompted for permissions every time, install with the following permissions:
+
+```
+deno install --unstable --allow-net --allow-read --allow-run --allow-write --name uscript-deno main.ts
+```
+
+(Some permissions aren't strictly necessary, but allow for an enhanced experience — e.g. `--allow-run` is only used to open files in VS Code and to get the correct Windows path in WSL)
+
+
+## Use
+
+Generate a new directory with a script template (main.ts) and metablock template (metablock.yaml)
+```sh
+uscript-deno new $DIR
+# uscript-deno new path/to/new/dir
+```
+```
+Created:
+path/to/new/dir
+├ main.ts
+└ metablock.yaml
+```
+
+Bundle userscript
+```sh
+uscript-deno bundle $ENTRYPOINT
+# uscript-deno bundle path/to/project/main.ts
+```
+```
+Written:
+path/to/project/main.bundle.user.js
+```
+
+Run in development mode: Watches entrypoint file for changes and bundles again on each change. Also provides metablock userscript on localhost server for quick installation by a script manager extension (e.g. Tampermonkey) (requires fs access by the script manager)
+```sh
+uscript-deno dev $ENTRYPOINT
+# uscript-deno dev path/to/project/main.ts
+```
+```
+Development userscript metablock at:
+http://localhost:10741/meta.user.js
+
+Watching for file changes…
+Use ctrl+c to stop.
+
+18:33:11.796 Bundling…
+18:33:13.211 Done (1416ms)
+…
+```
+
+
+## Notes
+
+Template file data can be modified before installing and are located at [`data/templates.ts`](data/templates.ts)

bundler/mod.ts

@@ -0,0 +1,58 @@
+import {emitOptions} from './options.ts';
+export {baseCompilerOptions} from './options.ts';
+
+export type BundleOptions = {
+
+  /**
+   * TypeScript compiler options used by Deno. If not provided, a set of default
+   * options will be used, targeted for a browser and ESNext features
+   */
+  compilerOptions?: Deno.CompilerOptions;
+
+  /**
+   * String to prepend to the module text. If provided, a newline will be
+   * automatically inserted after the string.
+   */
+  header?: string;
+
+  /**
+   * Print any compilation diagnostic messages to the console. Default: `false`
+   */
+  logDiagnostics?: boolean;
+
+  /** Default: `"esm"` */
+  moduleType?: Deno.EmitOptions['bundle'];
+};
+
+export type BundleResult = {
+  bundle: string;
+  result: Deno.EmitResult;
+};
+
+export async function bundleModule (
+  entrypointPath: string,
+  options?: BundleOptions,
+): Promise<BundleResult> {
+  const result = await Deno.emit(entrypointPath, {
+    bundle: options?.moduleType ?? emitOptions.bundle,
+    compilerOptions: options?.compilerOptions ?? emitOptions.compilerOptions,
+  });
+
+  if (options?.logDiagnostics) {
+    if (result.ignoredOptions?.length) {
+      let message = 'Ignored options:\n';
+      message += result.ignoredOptions.map(str => `  ${str}`).join('\n');
+      console.warn(message);
+    }
+    if (result.diagnostics.length) {
+      console.warn(Deno.formatDiagnostics(result.diagnostics));
+    }
+  }
+
+  // https://deno.land/manual@v1.9.2/typescript/runtime#bundling
+  let bundle = result.files['deno:///bundle.js'];
+
+  if (options?.header) bundle = `${options.header}\n${bundle}`;
+
+  return {bundle, result};
+}

bundler/options.ts

@@ -0,0 +1,35 @@
+/* eslint-disable line-comment-position, max-len */
+// This is as close as possible to "WSYIWYG/just erase types"
+export const baseCompilerOptions: Deno.CompilerOptions = {
+  // allowJs: true // default
+  // declaration: true, // not supported for bundles [yet]
+  // declarationDir: 'types', // doesn't seem to work [yet?]
+  // inlineSourceMap: true,
+  // inlineSources: true,
+  lib: ['ESNext'],
+  // jsx: 'react-jsx', // not supported [yet?]
+  // module: 'esnext', // default
+  // noImplicitAny: true, // default
+  noImplicitReturns: true,
+  // removeComments: true, // default
+  sourceMap: false, // is documented as false by default, but appears to be true by default
+  // strict: true, // default
+  // target: 'esnext', // default
+  // types: [] // needed?
+};
+/* eslint-enable line-comment-position, max-len */
+
+export const browserCompilerOptions: Deno.CompilerOptions = {
+  ...baseCompilerOptions,
+  lib: [
+    'DOM',
+    'DOM.Iterable',
+    'ESNext',
+  ],
+};
+
+export const emitOptions: Deno.EmitOptions = {
+  bundle: 'esm',
+  compilerOptions: browserCompilerOptions,
+  // sources: {},
+};