@jsenv/url-meta

url meta

Associate value to urls using pattern matching.

import { URL_META } from "@jsenv/url-meta"

// conditionally associates url and values
const associations = {
  color: {
    "file:///*": "black",
    "file:///*.js": "red",
  },
}
const getUrlColor = (url) => {
  const { color } = URL_META.applyAssociations({ url, associations })
  return color
}
console.log(`file.json color is ${getUrlColor("file:///file.json")}`)
console.log(`file.js color is ${getUrlColor("file:///file.js")}`)

Code above logs

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

associations

associations below translates into: "files are visible except thoose in .git/ directory"

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 is a function resolving associations keys that may contain relative urls against an url.

import { URL_META } from "@jsenv/url-meta"

const associations = URL_META.resolveAssociations(
  {
    visible: {
      "**/*/": true,
      "**/.git/": false,
    },
  },
  "file:///Users/directory/",
)
console.log(JSON.stringify(associations, null, "  "))

{
  "visible": {
    "file:///Users/directory/**/*/": true,
    "file:///Users/directory/**/.git/": false
  }
}

Changelog

37.0.0

• Update plugins API
  • context argument is dead (all hooks now called with a single argument)
  • context can be accessed either with urlInfo.context or reference.ownerUrlInfo.context
  • reference.parentUrl becomes reference.ownerUrlInfo.url
  • Add reference.urlInfo
  • All context.referenceUtils moved to urlInfo.dependencies
  • Add methods on urlInfo .cook, .cookDependencies, .getWithoutSearchParam, .isUsed
  • Add methods on reference .remove, .inline
  • Add reference.astInfo
  • Add urlInfo.referenceToOthersSet
  • Add urlInfo.referenceFromOthersSet
  • Add urlInfo.firstReference
  • Add urlInfo.contentFinalized
  • Add urlInfo.graph
  • Add graph.rootUrlInfo
  • Add lazy getters on urlInfo.contentAst and urlInfo.contentEtag
  • urlInfo.url now readonly and frozen
  • reference.url now readonly and frozen
  • reference.prev and reference.next always set early to be accessible inside resolveReference and redirectReference hooks
  • inlining always create a dedicated urlInfo
• Update versioning during build
  • now done using placeholders (no need to recook to inject versions)
• Ensure side effect file are properly injected into relevant entry points and only once
• Rename param used to hot reload ?hot (was ?hmr)
• Ensure assert keyword is entirely removed when import assertions are not supported
• Fix sourcemaps generation during build
• Properly update file written in outDirectoryUrl when url info content is modified after being cooked
• Improve code injection for side effect file, versioning and service worker
• Code injected into HTML files respects indentation to be readable