switch to microbundle

2025-04-25 17:45:25 -04:00 · 2021-11-11 11:09:25 -05:00 · 2021-11-11 11:09:25 -05:00 · 625837697b
commit 625837697b
parent 5b3ea19ec0
11 changed files with 1969 additions and 2276 deletions
--- a/.eslintrc.json
+++ b/.eslintrc.json
@ -1,21 +1,16 @@
 {
  "extends": [
    "@jakejarvis/eslint-config",
-    "plugin:compat/recommended",
-    "plugin:import/recommended"
+    "plugin:@typescript-eslint/recommended"
  ],
-  "parser": "@babel/eslint-parser",
-  "parserOptions": {
-    "sourceType": "module",
-    "requireConfigFile": false
-  },
+  "plugins": [
+    "@typescript-eslint"
+  ],
+  "parser": "@typescript-eslint/parser",
  "env": {
-    "es6": true,
-    "browser": true,
-    "node": false
+    "browser": true
  },
  "ignorePatterns": [
-    "*.d.ts",
    "dist/**"
  ]
 }
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@ -3,18 +3,20 @@ name: CI
 on:
  push:
    branches:
-    - main
+      - main
  pull_request:

 jobs:
  test:
    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, '[skip ci]')"
    steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-node@v2
-      with:
-        node-version: '14.x'
-    - run: yarn install --frozen-lockfile
-    - run: yarn build
-    - run: yarn test
-    - run: yarn lint
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 16.x
+          cache: yarn
+      - run: yarn install --frozen-lockfile
+      - run: yarn build
+      - run: yarn test
+      - run: yarn lint
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@ -3,20 +3,19 @@ name: Release
 on:
  push:
    tags:
-    - 'v*'
+      - 'v*'

 jobs:
  npm:
    name: Publish to NPM
    runs-on: ubuntu-latest
    steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-node@v2
-      with:
-        node-version: 14
-        registry-url: https://registry.npmjs.org/
-    - env:
-        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-      run: |
-        yarn install --frozen-lockfile
-        yarn publish
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 16.x
+          registry-url: https://registry.npmjs.org/
+      - run: yarn install --frozen-lockfile
+      - run: yarn publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
--- a/README.md
+++ b/README.md
@ -1,8 +1,7 @@
 # 🔗 get-canonical-url

 [![CI](https://github.com/jakejarvis/get-canonical-url/actions/workflows/ci.yml/badge.svg)](https://github.com/jakejarvis/get-canonical-url/actions/workflows/ci.yml)
-[![npm](https://img.shields.io/npm/v/get-canonical-url?logo=npm)](https://www.npmjs.com/package/get-canonical-url)
-[![MIT License](https://img.shields.io/github/license/jakejarvis/get-canonical-url?color=violet)](LICENSE)
+[![npm](https://img.shields.io/npm/v/get-canonical-url)](https://www.npmjs.com/package/get-canonical-url)

 Determines the current page's canonical URL and optionally normalizes it via [normalize-url](https://github.com/sindresorhus/normalize-url) for consistency.

@ -14,6 +13,12 @@ npm install get-canonical-url
 yarn add get-canonical-url
 ```

+Or pull directly from [unpkg](https://unpkg.com/browse/get-canonical-url/) in-browser:
+
+```html
+<script src="https://unpkg.com/get-canonical-url/dist/get-canonical-url.min.js"></script>
+```
+
 ## Usage

 ### With `<link rel="canonical">`
--- a/package.json
+++ b/package.json
@ -3,64 +3,47 @@
  "version": "1.0.1",
  "description": "🔗 Determines the current page's canonical URL and optionally normalizes it for consistency.",
  "license": "MIT",
-  "homepage": "https://github.com/jakejarvis/get-canonical-url",
+  "repository": "jakejarvis/get-canonical-url",
  "author": {
    "name": "Jake Jarvis",
    "email": "jake@jarv.is",
    "url": "https://jarv.is/"
  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/jakejarvis/get-canonical-url.git"
-  },
  "type": "module",
  "files": [
    "dist"
  ],
-  "main": "./dist/get-canonical-url.cjs.js",
+  "source": "./src/get-canonical-url.ts",
+  "main": "./dist/get-canonical-url.cjs",
  "module": "./dist/get-canonical-url.esm.js",
  "unpkg": "./dist/get-canonical-url.min.js",
-  "types": "./dist/get-canonical-url.d.ts",
  "exports": {
-    "require": "./dist/get-canonical-url.cjs.js",
+    "require": "./dist/get-canonical-url.cjs",
    "import": "./dist/get-canonical-url.esm.js",
    "browser": "./dist/get-canonical-url.min.js"
  },
+  "types": "./dist/get-canonical-url.d.ts",
  "scripts": {
-    "build": "rollup -c",
-    "watch": "rollup -c -w",
+    "build": "microbundle --format cjs,esm,umd --name 'canonicalUrl'",
    "test": "mocha",
    "lint": "eslint .",
    "prepublishOnly": "yarn build"
  },
-  "dependencies": {
-    "normalize-url": "^7.0.2"
-  },
+  "dependencies": {},
  "devDependencies": {
-    "@babel/core": "^7.15.8",
-    "@babel/eslint-parser": "^7.15.8",
-    "@babel/preset-env": "^7.15.8",
    "@jakejarvis/eslint-config": "*",
-    "@rollup/plugin-babel": "^5.3.0",
-    "@rollup/plugin-commonjs": "^21.0.0",
-    "@rollup/plugin-eslint": "^8.0.1",
-    "@rollup/plugin-node-resolve": "^13.0.5",
    "@types/chai": "^4.2.22",
    "@types/jsdom": "^16.2.13",
    "@types/mocha": "^9.0.0",
-    "builtin-modules": "^3.2.0",
+    "@typescript-eslint/eslint-plugin": "^5.3.1",
+    "@typescript-eslint/parser": "^5.3.1",
    "chai": "^4.3.4",
-    "eslint": "^8.0.0",
-    "eslint-plugin-compat": "~3.13.0",
-    "eslint-plugin-import": "~2.25.2",
-    "jsdom": "^18.0.0",
-    "mocha": "^9.1.2",
-    "rollup": "^2.58.0",
-    "rollup-plugin-copy": "^3.4.0",
-    "rollup-plugin-delete": "^2.0.0",
-    "rollup-plugin-filesize": "^9.1.1",
-    "rollup-plugin-node-externals": "^2.2.0",
-    "rollup-plugin-terser": "^7.0.2"
+    "eslint": "^8.2.0",
+    "jsdom": "^18.0.1",
+    "microbundle": "^0.14.1",
+    "mocha": "^9.1.3",
+    "normalize-url": "^7.0.2",
+    "typescript": "^4.4.4"
  },
  "keywords": [
    "url",
--- a/rollup.config.js
+++ b/rollup.config.js
@ -1,97 +0,0 @@
-import pkg from "./package.json";
-import resolve from "@rollup/plugin-node-resolve";
-import externals from "rollup-plugin-node-externals";
-import { babel } from "@rollup/plugin-babel";
-import { terser } from "rollup-plugin-terser";
-import filesize from "rollup-plugin-filesize";
-import copy from "rollup-plugin-copy";
-import del from "rollup-plugin-delete";
-import commonjs from "@rollup/plugin-commonjs";
-import eslint from "@rollup/plugin-eslint";
-
-const exportName = "canonicalUrl";
-const input = "src/index.js";
-const banner = `/*! ${pkg.name} v${pkg.version} | ${pkg.license} License | ${pkg.homepage} */`;
-
-export default [
-  {
-    // universal (browser and node)
-    input,
-    output: [
-      {
-        name: exportName,
-        file: pkg.exports.browser.replace(".min.js", ".js"), // unminified (.js)
-        format: "umd",
-        exports: "default",
-        esModule: false,
-        banner,
-      },
-      {
-        name: exportName,
-        file: pkg.exports.browser, // minified (.min.js)
-        format: "umd",
-        exports: "default",
-        esModule: false,
-        plugins: [
-          terser({
-            format: {
-              preamble: banner,
-            },
-          }),
-        ],
-      },
-    ],
-    plugins: [
-      del({ targets: "dist/*" }),
-      eslint(),
-      resolve(),
-      commonjs(),
-      babel({
-        babelHelpers: "bundled",
-        presets: [["@babel/preset-env"]],
-        exclude: ["node_modules/**"],
-      }),
-      copy({
-        // clearly this isn't really typescript, so we need to manually copy the type definition file
-        targets: [
-          {
-            src: input.replace(".js", ".d.ts"),
-            dest: "dist",
-            rename: pkg.types.replace("./dist/", ""),
-          },
-        ],
-      }),
-      filesize(),
-    ],
-  },
-  {
-    // modules
-    input,
-    output: [
-      {
-        // ES6 module (import)
-        file: pkg.exports.import,
-        format: "esm",
-        exports: "named",
-        banner: banner,
-      },
-      {
-        // commonjs (require)
-        file: pkg.exports.require,
-        format: "cjs",
-        exports: "named",
-        banner: banner,
-      },
-    ],
-    external: ["normalize-url"],
-    plugins: [
-      externals({ deps: true }),
-      commonjs(),
-      babel({
-        babelHelpers: "bundled",
-        exclude: ["node_modules/**"],
-      }),
-      filesize(),
-    ],
-  },
-];
--- a/src/get-canonical-url.ts
+++ b/src/get-canonical-url.ts
@ -0,0 +1,80 @@
+/*! get-canonical-url | MIT | https://github.com/jakejarvis/get-canonical-url */
+import normalizeUrl from "normalize-url";
+import type { Options as NormalizeOptions } from "normalize-url";
+
+export interface Options {
+  /**
+   * Clean-up and normalize the determined canonical URL.
+   *
+   * @default false
+   */
+  readonly normalize?: boolean;
+
+  /**
+   * Options passed directly to [`normalize-url`](https://github.com/sindresorhus/normalize-url#options).
+   *
+   * Requires `options.normalize = true`.
+   *
+   * @default { stripWWW: false, stripHash: true, removeQueryParameters: true, removeTrailingSlash: false }
+   */
+  readonly normalizeOptions?: NormalizeOptions;
+
+  /**
+   * Make an educated guess using other clues if canonical isn't explicitly set in the page's `<head>`.
+   *
+   * @default false
+   */
+  readonly guess?: boolean;
+}
+
+/**
+ * Returns the current page's canonical URL.
+ *
+ * @example
+ * ```
+ * // This imaginary page's <head> contains the following link tag:
+ * //   <link rel="canonical" href="https://www.example.com/" />
+ *
+ * import canonicalUrl from "get-canonical-url";
+ *
+ * canonicalUrl();
+ * //=> 'https://www.example.com/'
+ * ```
+ */
+export default function canonicalUrl(options: Options = {}): string | undefined {
+  options = {
+    normalize: false,
+    normalizeOptions: {
+      // A few sensible normalize-url defaults:
+      // https://github.com/sindresorhus/normalize-url#options
+      stripWWW: false,
+      stripHash: true,
+      removeQueryParameters: true,
+      removeTrailingSlash: false,
+    },
+    guess: false,
+    ...options,
+  };
+
+  // Start with a blank slate
+  let url: string | undefined = undefined;
+
+  // Look for a <link rel="canonical"> tag in the page's <head>
+  const linkElement: HTMLLinkElement | null = document.head.querySelector("link[rel='canonical']");
+
+  if (linkElement !== null) {
+    // Easy peasy, there was a <link rel="canonical"> tag!
+    url = linkElement.href;
+  } else if (options.guess) {
+    // We've been told to make an educated guess if canonical isn't explicitly set
+    url = document.documentURI || document.URL || window.location.href;
+  }
+
+  if (url && options.normalize) {
+    // Pass either custom options or defaults (above) directly to normalize-url
+    url = normalizeUrl(url, options.normalizeOptions);
+  }
+
+  // Some sort of URL has been determined by this point, unless it's impossible
+  return url;
+}
--- a/src/index.d.ts
+++ b/src/index.d.ts
@ -1,42 +0,0 @@
-import type { Options as NormalizeOptions } from "normalize-url";
-
-export interface Options {
-  /**
-   * Clean-up and normalize the determined canonical URL.
-   *
-   * @default false
-   */
-  readonly normalize?: boolean;
-
-  /**
-   * Options passed directly to [`normalize-url`](https://github.com/sindresorhus/normalize-url#options).
-   *
-   * Requires `options.normalize = true`.
-   *
-   * @default { stripWWW: false, stripHash: true, removeQueryParameters: true, removeTrailingSlash: false }
-   */
-  readonly normalizeOptions?: NormalizeOptions;
-
-  /**
-   * Make an educated guess using other clues if canonical isn't explicitly set in the page's `<head>`.
-   *
-   * @default false
-   */
-  readonly guess?: boolean;
-}
-
-/**
- * Returns the current page's canonical URL.
- *
- * @example
- * ```
- * // This imaginary page's <head> contains the following link tag:
- * //   <link rel="canonical" href="https://www.example.com/" />
- *
- * import canonicalUrl from "get-canonical-url";
- *
- * canonicalUrl();
- * //=> 'https://www.example.com/'
- * ```
- */
-export default function canonicalUrl(options?: Options): string | undefined;
--- a/src/index.js
+++ b/src/index.js
@ -1,39 +0,0 @@
-import normalizeUrl from "normalize-url";
-
-export default function canonicalUrl(options = {}) {
-  options = {
-    normalize: false,
-    normalizeOptions: {
-      // A few sensible normalize-url defaults:
-      // https://github.com/sindresorhus/normalize-url#options
-      stripWWW: false,
-      stripHash: true,
-      removeQueryParameters: true,
-      removeTrailingSlash: false,
-    },
-    guess: false,
-    ...options,
-  };
-
-  // Start with a blank slate
-  let url = undefined;
-
-  // Look for a <link rel="canonical"> tag in the page's <head>
-  const linkElement = document.head.querySelector("link[rel='canonical']");
-
-  if (linkElement !== null) {
-    // Easy peasy, there was a <link rel="canonical"> tag!
-    url = linkElement.href;
-  } else if (options.guess) {
-    // We've been told to make an educated guess if canonical isn't explicitly set
-    url = document.documentURI || document.URL || window.location.href;
-  }
-
-  if (options.normalize) {
-    // Pass either custom options or defaults (above) directly to normalize-url
-    url = normalizeUrl(url, options.normalizeOptions);
-  }
-
-  // Some sort of URL has been determined by this point, unless it's impossible
-  return url;
-}
--- a/test/index.spec.js
+++ b/test/index.spec.js
@ -68,7 +68,6 @@ describe("without canonical tag", () => {
 });

 async function wait(ms) {
-  // eslint-disable-next-line compat/compat
  return new Promise((resolve) => {
    setTimeout(resolve, ms);
  });
--- a/yarn.lock
+++ b/yarn.lock