@jsenv/urls 1.0.0 → 1.1.0

package/main.js

@@ -25,3 +25,20 @@ export {
 export { getCallerPosition } from "./src/caller_position.js"
 
 export { URL_META } from "./src/meta/url_meta.js"
+
+export { fileSystemPathToUrl } from "./src/filesystem_path_to_url.js"
+export { isFileSystemPath } from "./src/is_filesystem_path.js"
+export { resolveDirectoryUrl } from "./src/resolve_directory_url.js"
+export { moveUrl } from "./src/move_url.js"
+export { resolveUrl } from "./src/resolve_url.js"
+export { urlIsInsideOf } from "./src/url_is_inside_of.js"
+export { urlToBasename } from "./src/url_to_basename.js"
+export { urlToExtension } from "./src/url_to_extension.js"
+export { urlToFilename } from "./src/url_to_filename.js"
+export { urlToFileSystemPath } from "./src/url_to_filesystem_path.js"
+export { urlToOrigin } from "./src/url_to_origin.js"
+export { urlToParentUrl } from "./src/url_to_parent_url.js"
+export { urlToPathname } from "./src/url_to_pathname.js"
+export { urlToRelativeUrl } from "./src/url_to_relative_url.js"
+export { urlToRessource } from "./src/url_to_ressource.js"
+export { urlToScheme } from "./src/url_to_scheme.js"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/urls",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -8,8 +8,12 @@
     "directory": "packages/urls"
   },
   "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org"
+    "access": "public"
+  },
+  "author": {
+    "name": "dmail",
+    "email": "dmaillard06@gmail.com",
+    "url": "https://twitter.com/damienmaillard"
   },
   "type": "module",
   "exports": {
@@ -18,11 +22,15 @@
     },
     "./*": "./*"
   },
+  "files": [
+    "/src/",
+    "/main.js"
+  ],
   "scripts": {
     "test": "node --conditions=development ./test.mjs"
   },
   "dependencies": {
-    "@jsenv/filesystem": "3.1.0",
+    "@jsenv/filesystem": "4.0.0",
     "@jsenv/log": "1.6.3"
   }
-}
+}

package/src/caller_position.js

@@ -1,4 +1,4 @@
-import { isFileSystemPath, fileSystemPathToUrl } from "@jsenv/filesystem"
+import { isFileSystemPath, fileSystemPathToUrl } from "@jsenv/urls"
 
 export const getCallerPosition = () => {
   const { prepareStackTrace } = Error

package/src/common_pathname.js

@@ -0,0 +1,42 @@
+export const getCommonPathname = (pathname, otherPathname) => {
+  const firstDifferentCharacterIndex = findFirstDifferentCharacterIndex(
+    pathname,
+    otherPathname,
+  )
+
+  // pathname and otherpathname are exactly the same
+  if (firstDifferentCharacterIndex === -1) {
+    return pathname
+  }
+
+  const commonString = pathname.slice(0, firstDifferentCharacterIndex + 1)
+  // the first different char is at firstDifferentCharacterIndex
+  if (pathname.charAt(firstDifferentCharacterIndex) === "/") {
+    return commonString
+  }
+
+  if (otherPathname.charAt(firstDifferentCharacterIndex) === "/") {
+    return commonString
+  }
+
+  const firstDifferentSlashIndex = commonString.lastIndexOf("/")
+  return pathname.slice(0, firstDifferentSlashIndex + 1)
+}
+
+const findFirstDifferentCharacterIndex = (string, otherString) => {
+  const maxCommonLength = Math.min(string.length, otherString.length)
+  let i = 0
+  while (i < maxCommonLength) {
+    const char = string.charAt(i)
+    const otherChar = otherString.charAt(i)
+    if (char !== otherChar) {
+      return i
+    }
+    i++
+  }
+  if (string.length === otherString.length) {
+    return -1
+  }
+  // they differ at maxCommonLength
+  return maxCommonLength
+}

package/src/ensure_url_trailing_slash.js

@@ -0,0 +1,3 @@
+export const ensureUrlTrailingSlash = (url) => {
+  return url.endsWith("/") ? url : `${url}/`
+}

package/src/filesystem_path_to_url.js

@@ -0,0 +1,10 @@
+import { pathToFileURL } from "node:url"
+
+import { isFileSystemPath } from "./is_filesystem_path.js"
+
+export const fileSystemPathToUrl = (value) => {
+  if (!isFileSystemPath(value)) {
+    throw new Error(`value must be a filesystem path, got ${value}`)
+  }
+  return String(pathToFileURL(value))
+}

package/src/inline_content_url_generator.js

@@ -1,4 +1,4 @@
-import { urlToFilename } from "@jsenv/filesystem"
+import { urlToFilename } from "./url_to_filename.js"
 
 export const generateInlineContentUrl = ({
   url,

package/src/is_filesystem_path.js

@@ -0,0 +1,21 @@
+export const isFileSystemPath = (value) => {
+  if (typeof value !== "string") {
+    throw new TypeError(
+      `isFileSystemPath first arg must be a string, got ${value}`,
+    )
+  }
+  if (value[0] === "/") {
+    return true
+  }
+  return startsWithWindowsDriveLetter(value)
+}
+
+const startsWithWindowsDriveLetter = (string) => {
+  const firstChar = string[0]
+  if (!/[a-zA-Z]/.test(firstChar)) return false
+
+  const secondChar = string[1]
+  if (secondChar !== ":") return false
+
+  return true
+}

package/src/move_url.js

@@ -0,0 +1,10 @@
+import { urlToRelativeUrl } from "./url_to_relative_url.js"
+
+export const moveUrl = ({ url, from, to, preferAbsolute = false }) => {
+  const relativeUrl = urlToRelativeUrl(url, from)
+  const absoluteUrl = new URL(relativeUrl, to).href
+  if (preferAbsolute) {
+    return absoluteUrl
+  }
+  return urlToRelativeUrl(absoluteUrl, to)
+}

package/src/resolve_directory_url.js

@@ -0,0 +1,7 @@
+import { ensurePathnameTrailingSlash } from "./url_utils.js"
+import { resolveUrl } from "./resolve_url.js"
+
+export const resolveDirectoryUrl = (specifier, baseUrl) => {
+  const url = resolveUrl(specifier, baseUrl)
+  return ensurePathnameTrailingSlash(url)
+}

package/src/resolve_url.js

@@ -0,0 +1,6 @@
+export const resolveUrl = (specifier, baseUrl) => {
+  if (typeof baseUrl === "undefined") {
+    throw new TypeError(`baseUrl missing to resolve ${specifier}`)
+  }
+  return String(new URL(specifier, baseUrl))
+}

package/src/url_is_inside_of.js

@@ -0,0 +1,17 @@
+export const urlIsInsideOf = (url, otherUrl) => {
+  const urlObject = new URL(url)
+  const otherUrlObject = new URL(otherUrl)
+
+  if (urlObject.origin !== otherUrlObject.origin) {
+    return false
+  }
+
+  const urlPathname = urlObject.pathname
+  const otherUrlPathname = otherUrlObject.pathname
+  if (urlPathname === otherUrlPathname) {
+    return false
+  }
+
+  const isInside = urlPathname.startsWith(otherUrlPathname)
+  return isInside
+}

package/src/url_to_basename.js

@@ -0,0 +1,9 @@
+import { urlToFilename } from "./url_to_filename.js"
+
+export const urlToBasename = (url) => {
+  const filename = urlToFilename(url)
+  const dotLastIndex = filename.lastIndexOf(".")
+  const basename =
+    dotLastIndex === -1 ? filename : filename.slice(0, dotLastIndex)
+  return basename
+}

package/src/url_to_extension.js

@@ -0,0 +1,19 @@
+import { urlToPathname } from "./url_to_pathname.js"
+
+export const urlToExtension = (url) => {
+  const pathname = urlToPathname(url)
+  return pathnameToExtension(pathname)
+}
+
+const pathnameToExtension = (pathname) => {
+  const slashLastIndex = pathname.lastIndexOf("/")
+  if (slashLastIndex !== -1) {
+    pathname = pathname.slice(slashLastIndex + 1)
+  }
+
+  const dotLastIndex = pathname.lastIndexOf(".")
+  if (dotLastIndex === -1) return ""
+  // if (dotLastIndex === pathname.length - 1) return ""
+  const extension = pathname.slice(dotLastIndex)
+  return extension
+}

package/src/url_to_filename.js

@@ -0,0 +1,14 @@
+import { urlToPathname } from "./url_to_pathname.js"
+
+export const urlToFilename = (url) => {
+  const pathname = urlToPathname(url)
+  const pathnameBeforeLastSlash = pathname.endsWith("/")
+    ? pathname.slice(0, -1)
+    : pathname
+  const slashLastIndex = pathnameBeforeLastSlash.lastIndexOf("/")
+  const filename =
+    slashLastIndex === -1
+      ? pathnameBeforeLastSlash
+      : pathnameBeforeLastSlash.slice(slashLastIndex + 1)
+  return filename
+}

package/src/url_to_filesystem_path.js

@@ -0,0 +1,12 @@
+import { fileURLToPath } from "url"
+
+export const urlToFileSystemPath = (url) => {
+  let urlString = String(url)
+  if (urlString[urlString.length - 1] === "/") {
+    // remove trailing / so that nodejs path becomes predictable otherwise it logs
+    // the trailing slash on linux but does not on windows
+    urlString = urlString.slice(0, -1)
+  }
+  const fileSystemPath = fileURLToPath(urlString)
+  return fileSystemPath
+}

package/src/url_to_origin.js

@@ -0,0 +1,7 @@
+export const urlToOrigin = (url) => {
+  const urlString = String(url)
+  if (urlString.startsWith("file://")) {
+    return `file://`
+  }
+  return new URL(urlString).origin
+}

package/src/url_to_parent_url.js

@@ -0,0 +1,31 @@
+import { urlToOrigin } from "./url_to_origin.js"
+import { urlToRessource } from "./url_to_ressource.js"
+
+export const urlToParentUrl = (url) => {
+  const ressource = urlToRessource(url)
+  const slashLastIndex = ressource.lastIndexOf("/")
+  if (slashLastIndex === -1) {
+    const urlAsString = String(url)
+    return urlAsString
+  }
+
+  const lastCharacterIndex = ressource.length - 1
+  if (slashLastIndex === lastCharacterIndex) {
+    const slashPreviousIndex = ressource.lastIndexOf(
+      "/",
+      lastCharacterIndex - 1,
+    )
+    if (slashPreviousIndex === -1) {
+      const urlAsString = String(url)
+      return urlAsString
+    }
+
+    const origin = urlToOrigin(url)
+    const parentUrl = `${origin}${ressource.slice(0, slashPreviousIndex + 1)}`
+    return parentUrl
+  }
+
+  const origin = urlToOrigin(url)
+  const parentUrl = `${origin}${ressource.slice(0, slashLastIndex + 1)}`
+  return parentUrl
+}

package/src/url_to_pathname.js

@@ -0,0 +1,19 @@
+import { urlToRessource } from "./url_to_ressource.js"
+
+export const urlToPathname = (url) => {
+  const ressource = urlToRessource(url)
+  const pathname = ressourceToPathname(ressource)
+  return pathname
+}
+
+const ressourceToPathname = (ressource) => {
+  const searchSeparatorIndex = ressource.indexOf("?")
+  if (searchSeparatorIndex > -1) {
+    return ressource.slice(0, searchSeparatorIndex)
+  }
+  const hashIndex = ressource.indexOf("#")
+  if (hashIndex > -1) {
+    return ressource.slice(0, hashIndex)
+  }
+  return ressource
+}

package/src/url_to_relative_url.js

@@ -0,0 +1,56 @@
+import { getCommonPathname } from "./common_pathname.js"
+
+export const urlToRelativeUrl = (url, baseUrl) => {
+  const urlObject = new URL(url)
+  const baseUrlObject = new URL(baseUrl)
+
+  if (urlObject.protocol !== baseUrlObject.protocol) {
+    const urlAsString = String(url)
+    return urlAsString
+  }
+
+  if (
+    urlObject.username !== baseUrlObject.username ||
+    urlObject.password !== baseUrlObject.password ||
+    urlObject.host !== baseUrlObject.host
+  ) {
+    const afterUrlScheme = String(url).slice(urlObject.protocol.length)
+    return afterUrlScheme
+  }
+
+  const { pathname, hash, search } = urlObject
+  if (pathname === "/") {
+    const baseUrlRessourceWithoutLeadingSlash = baseUrlObject.pathname.slice(1)
+    return baseUrlRessourceWithoutLeadingSlash
+  }
+
+  const basePathname = baseUrlObject.pathname
+  const commonPathname = getCommonPathname(pathname, basePathname)
+  if (!commonPathname) {
+    const urlAsString = String(url)
+    return urlAsString
+  }
+  const specificPathname = pathname.slice(commonPathname.length)
+  const baseSpecificPathname = basePathname.slice(commonPathname.length)
+  if (baseSpecificPathname.includes("/")) {
+    const baseSpecificParentPathname =
+      pathnameToParentPathname(baseSpecificPathname)
+    const relativeDirectoriesNotation = baseSpecificParentPathname.replace(
+      /.*?\//g,
+      "../",
+    )
+    const relativeUrl = `${relativeDirectoriesNotation}${specificPathname}${search}${hash}`
+    return relativeUrl
+  }
+
+  const relativeUrl = `${specificPathname}${search}${hash}`
+  return relativeUrl
+}
+
+const pathnameToParentPathname = (pathname) => {
+  const slashLastIndex = pathname.lastIndexOf("/")
+  if (slashLastIndex === -1) {
+    return "/"
+  }
+  return pathname.slice(0, slashLastIndex + 1)
+}

package/src/url_to_ressource.js

@@ -0,0 +1,21 @@
+import { urlToScheme } from "./url_to_scheme.js"
+
+export const urlToRessource = (url) => {
+  const scheme = urlToScheme(url)
+
+  if (scheme === "file") {
+    const urlAsStringWithoutFileProtocol = String(url).slice("file://".length)
+    return urlAsStringWithoutFileProtocol
+  }
+
+  if (scheme === "https" || scheme === "http") {
+    // remove origin
+    const afterProtocol = String(url).slice(scheme.length + "://".length)
+    const pathnameSlashIndex = afterProtocol.indexOf("/", "://".length)
+    const urlAsStringWithoutOrigin = afterProtocol.slice(pathnameSlashIndex)
+    return urlAsStringWithoutOrigin
+  }
+
+  const urlAsStringWithoutProtocol = String(url).slice(scheme.length + 1)
+  return urlAsStringWithoutProtocol
+}

package/src/url_to_scheme.js

@@ -0,0 +1,10 @@
+export const urlToScheme = (url) => {
+  const urlString = String(url)
+  const colonIndex = urlString.indexOf(":")
+  if (colonIndex === -1) {
+    return ""
+  }
+
+  const scheme = urlString.slice(0, colonIndex)
+  return scheme
+}

package/src/url_trace.js

@@ -3,7 +3,7 @@
 // https://github.com/postcss/postcss/blob/fd30d3df5abc0954a0ec642a3cdc644ab2aacf9c/lib/terminal-highlight.js#L50
 // https://github.com/babel/babel/blob/eea156b2cb8deecfcf82d52aa1b71ba4995c7d68/packages/babel-code-frame/src/index.js#L1
 
-import { urlToFileSystemPath } from "@jsenv/filesystem"
+import { urlToFileSystemPath } from "./url_to_filesystem_path.js"
 import { ANSI } from "@jsenv/log"
 
 export const stringifyUrlTrace = (trace) => {

package/src/url_utils.js

@@ -1,4 +1,6 @@
-import { urlToOrigin, urlToExtension, urlToRessource } from "@jsenv/filesystem"
+import { urlToOrigin } from "./url_to_origin.js"
+import { urlToExtension } from "./url_to_extension.js"
+import { urlToRessource } from "./url_to_ressource.js"
 
 export const asUrlWithoutSearch = (url) => {
   const urlObject = new URL(url)

package/docs/url_meta/advanced.md

@@ -1,28 +0,0 @@
-# urlChildMayMatch
-
-_urlChildMayMatch_ is a function designed to ignore directory content that would never have specific metas.
-
-```js
-import { URL_META } from "@jsenv/urls"
-
-const associations = {
-  color: {
-    "file:///**/*": "blue",
-    "file:///**/node_modules/": "green",
-  },
-}
-
-const firstUrlCanHaveFilesWithColorBlue = URL_META.urlChildMayMatch({
-  url: "file:///src/",
-  associations,
-  predicate: ({ color }) => color === "blue",
-})
-firstUrlCanHaveFilesWithColorBlue // true
-
-const secondUrlCanHaveFileWithColorBlue = URL_META.urlChildMayMatch({
-  url: "file:///node_modules/src/",
-  associations,
-  predicate: ({ color }) => color === "blue",
-})
-secondUrlCanHaveFileWithColorBlue // false
-```

package/docs/url_meta/demo/apply_associations.mjs

@@ -1,27 +0,0 @@
-import { URL_META } from "@jsenv/urls"
-
-const associations = {
-  insideSrc: {
-    "file:///src/": true,
-  },
-  extensionIsJs: {
-    "file:///**/*.js": true,
-  },
-}
-
-const urlA = "file:///src/file.js"
-const urlB = "file:///src/file.json"
-console.log(
-  `${urlA}: ${JSON.stringify(
-    URL_META.applyAssociations({ url: urlA, associations }),
-    null,
-    "  ",
-  )}`,
-)
-console.log(
-  `${urlB}: ${JSON.stringify(
-    URL_META.applyAssociations({ url: urlB, associations }),
-    null,
-    "  ",
-  )}`,
-)

package/docs/url_meta/demo/full_match.mjs

@@ -1,7 +0,0 @@
-import { URL_META } from "@jsenv/urls"
-
-const fullMatch = URL_META.applyPatternMatching({
-  pattern: "file:///**/*",
-  url: "file:///Users/directory/file.js",
-})
-console.log(JSON.stringify(fullMatch, null, "  "))

package/docs/url_meta/demo/partial_match.mjs

@@ -1,7 +0,0 @@
-import { URL_META } from "@jsenv/urls"
-
-const partialMatch = URL_META.applyPatternMatching({
-  pattern: "file:///*.js",
-  url: "file:///file.jsx",
-})
-console.log(JSON.stringify(partialMatch, null, "  "))

package/docs/url_meta/demo/resolve_associations.mjs

@@ -1,12 +0,0 @@
-import { URL_META } from "@jsenv/urls"
-
-const associations = URL_META.resolveAssociations(
-  {
-    visible: {
-      "**/*/": true,
-      "**/.git/": false,
-    },
-  },
-  "file:///Users/directory/",
-)
-console.log(JSON.stringify(associations, null, "  "))

package/docs/url_meta/notes.md

@@ -1,26 +0,0 @@
-```js
-// Name of variables in the code below corresponds
-// to the terminology used in the codebase and documentation
-const pattern = "**/*"
-const value = { visible: true }
-const valueMap = {
-  [pattern]: value,
-}
-```
-
-## associations
-
-_associations composition_
-
-```js
-const pattern = "**/*/"
-const key = "visible"
-const value = true
-const meta = { [key]: value }
-const valueMap = {
-  [pattern]: meta,
-}
-const associations = {
-  [key]: valueMap,
-}
-```

package/docs/url_meta/pattern_matching.md

@@ -1,71 +0,0 @@
-# applyPatternMatching
-
-_applyPatternMatching_ is a function returning a _matchResult_ indicating if and how a _pattern_ matches an _url_.
-
-```js
-import { URL_META } from "@jsenv/urls"
-
-const matchResult = URL_META.applyPatternMatching({
-  pattern: "file:///**/*",
-  url: "file://Users/directory/file.js",
-})
-matchResult.matched // true
-```
-
-## pattern
-
-_pattern_ parameter is a string looking like an url but where `*` and `**` can be used so that one specifier can match several url.
-
-This parameter is **required**.
-
-## url
-
-_url_ parameter is a string representing a url.
-
-This parameter is **required**.
-
-## matchResult
-
-_matchResult_ represents if and how a _pattern_ matches an _url_.
-
-### Matching example
-
-```js
-import { URL_META } from "@jsenv/urls"
-
-const fullMatch = URL_META.applyPatternMatching({
-  pattern: "file:///**/*",
-  url: "file:///Users/directory/file.js",
-})
-console.log(JSON.stringify(fullMatch, null, "  "))
-```
-
-```json
-{
-  "matched": true,
-  "patternIndex": 12,
-  "urlIndex": 31,
-  "matchGroups": ["file.js"]
-}
-```
-
-### Partial matching example
-
-```js
-import { applyPatternMatching } from "@jsenv/urlss"
-
-const partialMatch = URL_META.applyPatternMatching({
-  pattern: "file:///*.js",
-  url: "file:///file.jsx",
-})
-console.log(JSON.stringify(partialMatch, null, "  "))
-```
-
-```json
-{
-  "matched": false,
-  "patternIndex": 12,
-  "urlIndex": 15,
-  "matchGroups": ["file"]
-}
-```