@jsenv/urls 1.0.0 → 1.1.0

package/docs/url_meta/readme.md

@@ -1,87 +0,0 @@
-# url meta
-
-Associate value to urls using pattern matching.
-
-```js
-import { URL_META } from "@jsenv/urls"
-
-// conditionally associates url and values
-const associations = {
-  color: {
-    "file:///*": "black",
-    "file:///*.js": "red",
-  },
-}
-const getUrlColor = (url) => {
-  return URL_META.applyAssociations({ url, associations }).color
-}
-console.log(`file.json color is ${getUrlColor("file:///file.json")}`)
-console.log(`file.js color is ${getUrlColor("file:///file.js")}`)
-```
-
-_Code above logs_
-
-```console
-file.json color is black
-file.js color is red
-```
-
-# Common pattern example
-
-| pattern            | Description                          |
-| ------------------ | ------------------------------------ |
-| `**/`              | Everything                           |
-| `*/**/`            | Inside a directory                   |
-| `**/.*/`           | Inside directory starting with a dot |
-| `**/node_modules/` | Inside any `node_modules` directory  |
-| `node_modules/`    | Inside root `node_modules` directory |
-| `**/*.map`         | Ending with `.map`                   |
-| `**/*.test.*`      | Contains `.test.`                    |
-| `*`                | Inside the root directory only       |
-| `*/*`              | Inside a directory of depth 1        |
-
-Read more at [./pattern_matching.md](./pattern_matching.md)
-
-# associations
-
-_associations_ below translates into: "files are visible except thoose in .git/ directory"
-
-```js
-const associations = {
-  visible: {
-    "**/*/": true,
-    "**/.git/": false,
-  },
-}
-```
-
-_associations_ allows to group patterns per property which are easy to read and compose.
-All keys in _associations_ must be absolute urls, this can be done with [resolveAssociations](#resolveAssociations).
-
-# resolveAssociations
-
-_resolveAssociations_ is a function resolving _associations_ keys that may contain relative urls against an _url_.
-
-```js
-import { URL_META } from "@jsenv/urls"
-
-const associations = URL_META.resolveAssociations(
-  {
-    visible: {
-      "**/*/": true,
-      "**/.git/": false,
-    },
-  },
-  "file:///Users/directory/",
-)
-console.log(JSON.stringify(associations, null, "  "))
-```
-
-```json
-{
-  "visible": {
-    "file:///Users/directory/**/*/": true,
-    "file:///Users/directory/**/.git/": false
-  }
-}
-```

package/test/data_url.test.mjs

@@ -1,57 +0,0 @@
-import { assert } from "@jsenv/assert"
-
-import { DataUrl } from "@jsenv/urls"
-
-{
-  const actual = DataUrl.parse("data:,")
-  const expected = {
-    contentType: "text/plain;charset=US-ASCII",
-    base64Flag: false,
-    data: "",
-  }
-  assert({ actual, expected })
-}
-
-{
-  const actual = DataUrl.parse("data:,Hello%2C%20World!")
-  const expected = {
-    contentType: "text/plain;charset=US-ASCII",
-    base64Flag: false,
-    data: "Hello%2C%20World!",
-  }
-  assert({ actual, expected })
-}
-
-{
-  const actual = DataUrl.parse(
-    "data:text/plain;base64,SGVsbG8sIFdvcmxkIQ%3D%3D",
-  )
-  const expected = {
-    contentType: "text/plain",
-    base64Flag: true,
-    data: "SGVsbG8sIFdvcmxkIQ%3D%3D",
-  }
-  assert({ actual, expected })
-}
-
-{
-  const actual = DataUrl.parse(
-    "data:text/html,%3Ch1%3EHello%2C%20World!%3C%2Fh1%3E",
-  )
-  const expected = {
-    contentType: "text/html",
-    base64Flag: false,
-    data: "%3Ch1%3EHello%2C%20World!%3C%2Fh1%3E",
-  }
-  assert({ actual, expected })
-}
-
-{
-  const actual = DataUrl.parse("data:text/html,<script>alert('hi');</script>")
-  const expected = {
-    contentType: "text/html",
-    base64Flag: false,
-    data: "<script>alert('hi');</script>",
-  }
-  assert({ actual, expected })
-}

package/test/meta/aliasing.test.mjs

@@ -1,47 +0,0 @@
-import { assert } from "@jsenv/assert"
-
-import { URL_META } from "@jsenv/urls"
-
-{
-  const actual = URL_META.applyAliases({
-    url: "file:///alias.json",
-    aliases: {
-      "file:///alias.json": "file:///data.json",
-    },
-  })
-  const expected = "file:///data.json"
-  assert({ actual, expected })
-}
-
-{
-  const actual = URL_META.applyAliases({
-    url: "file:///a.js",
-    aliases: {
-      "file:///*.js": "file:///file.js",
-    },
-  })
-  const expected = "file:///file.js"
-  assert({ actual, expected })
-}
-
-{
-  const actual = URL_META.applyAliases({
-    url: "file:///dir/b.txt",
-    aliases: {
-      "file:///dir/*": "file:///dir/a.txt",
-    },
-  })
-  const expected = "file:///dir/a.txt"
-  assert({ actual, expected })
-}
-
-{
-  const actual = URL_META.applyAliases({
-    url: "file:///foo/deep/4fhj.js",
-    aliases: {
-      "file:///*/deep/*.js": "file:///*/deep/file.js",
-    },
-  })
-  const expected = "file:///foo/deep/file.js"
-  assert({ actual, expected })
-}

package/test/meta/as_flat_associations/basic.test.mjs

@@ -1,64 +0,0 @@
-import { assert } from "@jsenv/assert"
-
-import { asFlatAssociations } from "@jsenv/urls/src/meta/as_flat_associations.js"
-
-{
-  const actual = asFlatAssociations({
-    visible: {
-      "file:///a.js": true,
-      "file:///b.js": false,
-    },
-  })
-  const expected = {
-    "file:///a.js": {
-      visible: true,
-    },
-    "file:///b.js": {
-      visible: false,
-    },
-  }
-  assert({ actual, expected })
-}
-
-{
-  const actual = asFlatAssociations({
-    visible: {
-      "file:///a.js": true,
-    },
-    whatever: {
-      "file:///a.js": true,
-    },
-  })
-  const expected = {
-    "file:///a.js": {
-      visible: true,
-      whatever: true,
-    },
-  }
-  assert({ actual, expected })
-}
-
-try {
-  asFlatAssociations("foo")
-  throw new Error("shoud crash")
-} catch (error) {
-  const actual = error
-  const expected = new TypeError(`associations must be a plain object, got foo`)
-  assert({ actual, expected })
-}
-
-try {
-  asFlatAssociations({
-    visible: "foo",
-    whatever: {
-      "file:///a.js": true,
-    },
-  })
-  throw new Error("shoud crash")
-} catch (error) {
-  const actual = error
-  const expected = new TypeError(
-    `all associations value must be objects, found "visible": foo`,
-  )
-  assert({ actual, expected })
-}

package/test/meta/assertions.test.mjs

@@ -1,23 +0,0 @@
-import { assert } from "@jsenv/assert"
-
-import { assertUrlLike } from "@jsenv/urls/src/meta/assertions.js"
-
-try {
-  assertUrlLike(["123"])
-  throw new Error("shoud crash")
-} catch (error) {
-  const actual = error
-  const expected = new TypeError(`url must be a url string, got 123`)
-  assert({ actual, expected })
-}
-
-try {
-  assertUrlLike("*$^=")
-  throw new Error("shoud crash")
-} catch (error) {
-  const actual = error
-  const expected = new TypeError(
-    `url must be a url and no scheme found, got *$^=`,
-  )
-  assert({ actual, expected })
-}

package/test/meta/get_url_meta/any.test.mjs

@@ -1,94 +0,0 @@
-import { assert } from "@jsenv/assert"
-
-import { URL_META } from "@jsenv/urls"
-
-{
-  const actual = URL_META.applyAssociations({
-    url: "file:///a",
-    associations: {
-      a: {
-        "file:///**/*": true,
-      },
-    },
-  })
-  const expected = { a: true }
-  assert({ actual, expected })
-}
-
-{
-  const actual = URL_META.applyAssociations({
-    url: "file:///node_modules",
-    associations: {
-      a: {
-        "file:///**/*": true,
-      },
-    },
-  })
-  const expected = { a: true }
-  assert({ actual, expected })
-}
-
-{
-  const actual = URL_META.applyAssociations({
-    url: "file:///a",
-    associations: {
-      a: {
-        "file:///a/**/*.test.js": true,
-      },
-    },
-  })
-  const expected = {}
-  assert({ actual, expected })
-}
-
-{
-  const actual = URL_META.applyAssociations({
-    url: "file:///a/b.test.js",
-    associations: {
-      a: {
-        "file:///a/**/*.test.js": true,
-      },
-    },
-  })
-  const expected = { a: true }
-  assert({ actual, expected })
-}
-
-{
-  const actual = URL_META.applyAssociations({
-    url: "file:///a/b.js",
-    associations: {
-      a: {
-        "file:///a/**/*.test.js": true,
-      },
-    },
-  })
-  const expected = {}
-  assert({ actual, expected })
-}
-
-{
-  const actual = URL_META.applyAssociations({
-    url: "file:///a/b/c.test.js",
-    associations: {
-      a: {
-        "file:///a/**/*.test.js": true,
-      },
-    },
-  })
-  const expected = { a: true }
-  assert({ actual, expected })
-}
-
-{
-  const actual = URL_META.applyAssociations({
-    url: "file:///index.test.js",
-    associations: {
-      a: {
-        "file:///**/*.js": true,
-      },
-    },
-  })
-  const expected = { a: true }
-  assert({ actual, expected })
-}

package/test/meta/get_url_meta/basic.test.mjs

@@ -1,226 +0,0 @@
-import { assert } from "@jsenv/assert"
-
-import { URL_META } from "@jsenv/urls"
-
-{
-  const url = "file:///file"
-  const associations = {
-    "/file": true,
-  }
-  try {
-    URL_META.applyAssociations({
-      url,
-      associations,
-    })
-  } catch (actual) {
-    const expected = new TypeError(
-      `all associations value must be objects, found "/file": true`,
-    )
-    assert({ actual, expected })
-  }
-}
-
-{
-  const url = "file:///"
-  const associations = {
-    "file:///foo": true,
-  }
-  try {
-    URL_META.applyAssociations({
-      url,
-      associations,
-    })
-  } catch (actual) {
-    const expected = new TypeError(
-      `all associations value must be objects, found "file:///foo": true`,
-    )
-    assert({ actual, expected })
-  }
-}
-
-{
-  const url = "file:///file"
-  const associations = {
-    whatever: {
-      "file:///*.js": true,
-      "file:///file.js": null,
-    },
-  }
-  const actual = URL_META.applyAssociations({
-    url,
-    associations,
-  })
-  const expected = {}
-  assert({ actual, expected })
-}
-
-{
-  const actual = URL_META.applyAssociations({
-    url: "file:///",
-    associations: {
-      a: {
-        "file:///foo": true,
-      },
-    },
-  })
-  const expected = {}
-  assert({ actual, expected })
-}
-
-{
-  const actual = URL_META.applyAssociations({
-    url: "file:///foo",
-    associations: {
-      a: {
-        "file:///foo": true,
-      },
-    },
-  })
-  const expected = { a: true }
-  assert({ actual, expected })
-}
-
-{
-  const actual = URL_META.applyAssociations({
-    url: "file:///a",
-    associations: {
-      a: {
-        "file:///a": true,
-      },
-    },
-  })
-  const expected = { a: true }
-  assert({ actual, expected })
-}
-
-{
-  const actual = URL_META.applyAssociations({
-    url: "file:///a.js",
-    associations: {
-      a: {
-        "file:///a": true,
-      },
-    },
-  })
-  const expected = {}
-  assert({ actual, expected })
-}
-
-{
-  const actual = URL_META.applyAssociations({
-    url: "file:///a/b",
-    associations: {
-      a: {
-        "file:///a": true,
-      },
-    },
-  })
-  const expected = {}
-  assert({ actual, expected })
-}
-
-{
-  const actual = URL_META.applyAssociations({
-    url: "file:///a/b.js",
-    associations: {
-      a: {
-        "file:///a": true,
-      },
-    },
-  })
-  const expected = {}
-  assert({ actual, expected })
-}
-
-{
-  const actual = URL_META.applyAssociations({
-    url: "file:///b/a",
-    associations: {
-      a: {
-        "file:///b/a": true,
-      },
-    },
-  })
-  const expected = { a: true }
-  assert({ actual, expected })
-}
-
-{
-  const actual = URL_META.applyAssociations({
-    url: "file:///b/a.js",
-    associations: {
-      a: {
-        "file:///b/a": true,
-      },
-    },
-  })
-  const expected = {}
-  assert({ actual, expected })
-}
-
-{
-  const actual = URL_META.applyAssociations({
-    url: "file:///b/c",
-    associations: {
-      a: {
-        "file:///b/a": true,
-      },
-    },
-  })
-  const expected = {}
-  assert({ actual, expected })
-}
-
-{
-  const actual = URL_META.applyAssociations({
-    url: "file:///b/a/c",
-    associations: {
-      a: {
-        "file:///b/a": true,
-      },
-    },
-  })
-  const expected = {}
-  assert({ actual, expected })
-}
-
-{
-  const actual = URL_META.applyAssociations({
-    url: "file:///dist",
-    associations: {
-      a: {
-        "file:///dist": 0,
-      },
-    },
-  })
-  const expected = { a: 0 }
-  assert({ actual, expected })
-}
-
-{
-  const actual = URL_META.applyAssociations({
-    url: "file:///a/dist",
-    associations: {
-      a: {
-        "file:///dist": 0,
-      },
-    },
-  })
-  const expected = {}
-  assert({ actual, expected })
-}
-
-// ensure getUrlMeta overrides in order (without sorting specifier keys by length)
-{
-  const actual = URL_META.applyAssociations({
-    url: "file:///abcd/",
-    associations: {
-      whatever: {
-        "file:///a*/": 41,
-        "file:///abcd/": 42,
-      },
-    },
-  })
-  const expected = { whatever: 42 }
-  assert({ actual, expected })
-}