@flex-development/mlly 1.0.0-alpha.16 → 1.0.0-alpha.17

package/src/utils/has-esm-syntax.ts

@@ -1,40 +0,0 @@
-/**
- * @file hasESMSyntax
- * @module mlly/utils/hasESMSyntax
- */
-
-import validateString from '#src/internal/validate-string'
-import type { NodeError } from '@flex-development/errnode'
-
-/**
- * Detects if `code` contains ESM syntax. Ignores matches in comments.
- *
- * Syntax patterns:
- *
- * - `export` (declaration, default, named, star)
- * - `import` (default, dynamic, named, star)
- * - `import.meta.(env|resolve|url)`
- *
- * @see https://regex101.com/r/xfreyy
- *
- * @param {string} code - Code to evaluate
- * @return {boolean} `true` if `code` contains esm syntax, `false` otherwise
- * @throws {NodeError<TypeError>} If `code` is not a string
- */
-const hasESMSyntax = (code: string): boolean => {
-  validateString(code, 'code')
-
-  /**
-   * ESM syntax regex.
-   *
-   * @see https://regex101.com/r/xfreyy
-   *
-   * @const {RegExp} ESM_SYNTAX_REGEX
-   */
-  const ESM_SYNTAX_REGEX: RegExp =
-    /(?<!(?:\/\/|\*).*)((?:export|import)[\s\w*,{}]*(?=\sfrom)|export\b\s*(?:[*{]|async function|(?:abstract\s)?class|const|default|enum|function|interface|let|type|var)|await import|import\.meta\.(?:env(?:\.\w+)?|resolve|url))/gm
-
-  return !!code.match(ESM_SYNTAX_REGEX)
-}
-
-export default hasESMSyntax

package/src/utils/index.ts

@@ -1,45 +0,0 @@
-/**
- * @file Utilities
- * @module mlly/utils
- */
-
-export { default as compareSubpaths } from './compare-subpaths'
-export { default as CONDITIONS } from './conditions'
-export { default as detectSyntax } from './detect-syntax'
-export { default as EXTENSION_FORMAT_MAP } from './extension-format-map'
-export { default as extractStatements } from './extract-statements'
-export { default as fillModules } from './fill-modules'
-export { default as findDynamicImports } from './find-dynamic-imports'
-export { default as findExports } from './find-exports'
-export { default as findRequires } from './find-requires'
-export { default as findStaticImports } from './find-static-imports'
-export { default as findSubpath } from './find-subpath'
-export { default as getFormat } from './get-format'
-export { default as getSource } from './get-source'
-export { default as hasCJSSyntax } from './has-cjs-syntax'
-export { default as hasESMSyntax } from './has-esm-syntax'
-export { default as isAbsoluteSpecifier } from './is-absolute-specifier'
-export { default as isBareSpecifier } from './is-bare-specifier'
-export { default as isDirectory } from './is-directory'
-export { default as isExportsSugar } from './is-exports-sugar'
-export { default as isFile } from './is-file'
-export { default as isRelativeSpecifier } from './is-relative-specifier'
-export { default as lookupPackageScope } from './lookup-package-scope'
-export { default as parseDataURL } from './parse-data-url'
-export { default as parseModuleId } from './parse-module-id'
-export { default as parseSubpath } from './parse-subpath'
-export { default as PATTERN_CHARACTER } from './pattern-character'
-export { default as readPackageJson } from './read-package-json'
-export { default as resolveAlias } from './resolve-alias'
-export { default as resolveAliases } from './resolve-aliases'
-export { default as RESOLVE_EXTENSIONS } from './resolve-extensions'
-export { default as resolveModule } from './resolve-module'
-export { default as resolveModules } from './resolve-modules'
-export { default as toAbsoluteSpecifier } from './to-absolute-specifier'
-export { default as toBareSpecifier } from './to-bare-specifier'
-export { default as toDataURL } from './to-data-url'
-export { default as toNodeURL } from './to-node-url'
-export { default as toRelativeSpecifier } from './to-relative-specifier'
-export { default as toURL } from './to-url'
-export { default as validateAssertions } from './validate-assertions'
-export { default as validateExports } from './validate-exports'

package/src/utils/is-absolute-specifier.ts

@@ -1,53 +0,0 @@
-/**
- * @file isAbsoluteSpecifier
- * @module mlly/utils/isAbsoluteSpecifier
- */
-
-import validateString from '#src/internal/validate-string'
-import type { NodeError } from '@flex-development/errnode'
-import pathe from '@flex-development/pathe'
-import { URL } from 'node:url'
-
-/**
- * Checks if the given `specifier` is an absolute specifier.
- *
- * ::: warning
- * Only checks specifier syntax. Does **not** guarantee the specifier references
- * a file that exists.
- * :::
- *
- * @see https://nodejs.org/api/esm.html#terminology
- *
- * @param {string} specifier - Specifier to evaluate
- * @return {boolean} `true` if `specifier` is absolute specifier
- * @throws {NodeError<TypeError>} If `specifier` is not a string
- */
-const isAbsoluteSpecifier = (specifier: string): boolean => {
-  validateString(specifier, 'specifier')
-
-  /**
-   * Absolute specifier check.
-   *
-   * @var {string} absolute
-   */
-  let absolute: boolean = false
-
-  // check if specifier is absolute path or valid file url
-  switch (true) {
-    case pathe.isAbsolute(specifier):
-      absolute = true
-      break
-    case specifier.startsWith('file:'):
-      try {
-        new URL(specifier)
-        absolute = true
-      } /* c8 ignore next */ catch {}
-      break
-    default:
-      absolute = false
-  }
-
-  return absolute
-}
-
-export default isAbsoluteSpecifier

package/src/utils/is-bare-specifier.ts

@@ -1,36 +0,0 @@
-/**
- * @file isBareSpecifier
- * @module mlly/utils/isBareSpecifier
- */
-
-import validateString from '#src/internal/validate-string'
-import type { NodeError } from '@flex-development/errnode'
-import { trim } from '@flex-development/tutils'
-import isAbsoluteSpecifier from './is-absolute-specifier'
-import isRelativeSpecifier from './is-relative-specifier'
-
-/**
- * Checks if the given `specifier` is a bare specifier.
- *
- * ::: warning
- * Only checks specifier syntax. Does **not** guarantee the specifier references
- * a file that exists.
- * :::
- *
- * @see https://nodejs.org/api/esm.html#terminology
- *
- * @param {string} specifier - Specifier to evaluate
- * @return {boolean} `true` if `specifier` is bare specifier
- * @throws {NodeError<TypeError>} If `specifier` is not a string
- */
-const isBareSpecifier = (specifier: string): boolean => {
-  validateString(specifier, 'specifier')
-
-  return (
-    !!trim(specifier).length &&
-    !isAbsoluteSpecifier(specifier) &&
-    !isRelativeSpecifier(specifier)
-  )
-}
-
-export default isBareSpecifier

package/src/utils/is-directory.ts

@@ -1,25 +0,0 @@
-/**
- * @file Internal - isDirectory
- * @module mlly/internal/isDirectory
- */
-
-import validateURLString from '#src/internal/validate-url-string'
-import type { ModuleId } from '#src/types'
-import fs from 'node:fs'
-
-/**
- * Checks if a directory exists at the given module `id`.
- *
- * @param {ModuleId} id - Module id to evaluate
- * @return {boolean} `true` if directory exists at `id`
- */
-const isDirectory = (id: ModuleId): boolean => {
-  try {
-    validateURLString(id, 'id')
-    return fs.statSync(id, { throwIfNoEntry: false })?.isDirectory() ?? false
-  } catch {
-    return false
-  }
-}
-
-export default isDirectory

package/src/utils/is-exports-sugar.ts

@@ -1,81 +0,0 @@
-/**
- * @file isExportsSugar
- * @module mlly/utils/isExportsSugar
- */
-
-import type { ModuleId } from '#src/types'
-import type { NodeError } from '@flex-development/errnode'
-import type { Exports } from '@flex-development/pkg-types'
-import {
-  at,
-  cast,
-  DOT,
-  isArray,
-  isObjectCurly,
-  isString,
-  type Nilable
-} from '@flex-development/tutils'
-import validateExports from './validate-exports'
-
-/**
- * Checks if the given package [`exports`][1] value is using [exports sugar][2].
- *
- * [1]: https://nodejs.org/api/packages.html#exports
- * [2]: https://nodejs.org/api/packages.html#exports-sugar
- *
- * @see {@linkcode Exports}
- * @see {@linkcode ModuleId}
- *
- * @param {Nilable<Exports>} exports - Package `exports`
- * @param {ModuleId} pkg - URL of relevant `package.json` file
- * @param {ModuleId} parent - URL of module to resolve from
- * @return {boolean} `true` if `exports` is using exports sugar
- * @throws {NodeError<Error | TypeError>} If either `pkg` or `parent` is not an
- * instance of {@linkcode URL} or a string, or if `exports` configuration or
- * schema is invalid
- */
-const isExportsSugar = (
-  exports: Nilable<Exports>,
-  pkg: ModuleId,
-  parent: ModuleId
-): boolean => {
-  /**
-   * [Exports sugar][1] check.
-   *
-   * [1]: https://nodejs.org/api/packages.html#exports-sugar
-   *
-   * @var {boolean} sugar
-   */
-  let sugar: boolean = false
-
-  // check if exports sugar is being used
-  switch (true) {
-    case isArray(exports):
-    case isString(exports):
-      sugar = true
-      break
-    case !isObjectCurly(exports):
-      sugar = false
-      break
-    default:
-      exports = cast<Record<string, Exports>>(exports)
-
-      /*
-       * Validate exports object configuration.
-       *
-       * This ensures the exports object is either an object of package subpath
-       * keys (i.e. keys starting with '.') or an object of main entry condition
-       * name keys (i.e. keys not starting with '.') only. An error will be
-       * thrown otherwise. This also means only the first key in `keys` needs to
-       * be checked for exports sugar usage.
-       */
-      validateExports(exports, pkg, parent)
-
-      // check for exports sugar
-      sugar = !at(Object.getOwnPropertyNames(exports), 0, DOT).startsWith(DOT)
-  }
-
-  return sugar
-}
-
-export default isExportsSugar

package/src/utils/is-file.ts

@@ -1,25 +0,0 @@
-/**
- * @file Internal - isFile
- * @module mlly/internal/isFile
- */
-
-import validateURLString from '#src/internal/validate-url-string'
-import type { ModuleId } from '#src/types'
-import fs from 'node:fs'
-
-/**
- * Checks if a file exists at the given module `id`.
- *
- * @param {ModuleId} id - Module id to evaluate
- * @return {boolean} `true` if file exists at `id`
- */
-const isFile = (id: ModuleId): boolean => {
-  try {
-    validateURLString(id, 'id')
-    return fs.statSync(id, { throwIfNoEntry: false })?.isFile() ?? false
-  } catch {
-    return false
-  }
-}
-
-export default isFile

package/src/utils/is-relative-specifier.ts

@@ -1,34 +0,0 @@
-/**
- * @file isRelativeSpecifier
- * @module mlly/utils/isRelativeSpecifier
- */
-
-import validateString from '#src/internal/validate-string'
-import pathe from '@flex-development/pathe'
-import { DOT, at } from '@flex-development/tutils'
-
-/**
- * Checks if the given `specifier` is a relative specifier.
- *
- * ::: warning
- * Only checks specifier syntax. Does **not** guarantee the specifier references
- * a file that exists.
- * :::
- *
- * @see https://nodejs.org/api/esm.html#terminology
- *
- * @param {string} specifier - Specifier to evaluate
- * @return {boolean} `true` if `specifier` is relative specifier
- */
-const isRelativeSpecifier = (specifier: string): boolean => {
-  validateString(specifier, 'specifier')
-
-  return specifier.startsWith(DOT)
-    ? specifier.length === 1 || at(specifier, 1) === pathe.sep
-      ? true
-      : at(specifier, 1) === DOT &&
-        (specifier.length === 2 || at(specifier, 2) === pathe.sep)
-    : false
-}
-
-export default isRelativeSpecifier

package/src/utils/lookup-package-scope.ts

@@ -1,97 +0,0 @@
-/**
- * @file lookupPackageScope
- * @module mlly/utils/lookupPackageScope
- */
-
-import type { PackageScope } from '#src/interfaces'
-import validateURLString from '#src/internal/validate-url-string'
-import type { ModuleId } from '#src/types'
-import type { NodeError } from '@flex-development/errnode'
-import pathe from '@flex-development/pathe'
-import type { PackageJson } from '@flex-development/pkg-types'
-import { DOT, type Nullable } from '@flex-development/tutils'
-import { pathToFileURL } from 'node:url'
-import readPackageJson from './read-package-json'
-import toURL from './to-url'
-
-/**
- * Finds a `package.json` file for the given module `id`. Ends the search at the
- * given end point **after** checking for a `package.json` file.
- *
- * Returns `null` if a `package.json` file is not found.
- *
- * @see {@linkcode ModuleId}
- * @see {@linkcode PackageScope}
- *
- * @param {ModuleId} id - Id of module to get package scope for
- * @param {ModuleId?} [stopdir=pathe.sep] - Directory to end search
- * @param {string?} [specifier] - Module specifier passed by user
- * @param {ModuleId?} [parent] - Id of module to resolve from
- * @return {?PackageScope} Package scope result or `null`
- * @throws {NodeError<TypeError>} If either `id` or `stopdir` is not an instance
- * of {@linkcode URL} or a string
- */
-const lookupPackageScope = (
-  id: ModuleId,
-  stopdir: ModuleId = pathe.sep,
-  specifier?: string,
-  parent?: ModuleId
-): Nullable<PackageScope> => {
-  validateURLString(id, 'id')
-  validateURLString(stopdir, 'stopdir')
-
-  // ensure search endpoint is a path
-  stopdir = toURL(stopdir).pathname
-
-  /**
-   * Path to directory containing `package.json` file.
-   *
-   * @var {string} dir
-   */
-  let dir: string = toURL(id).pathname
-
-  /**
-   * Package scope result.
-   *
-   * @var {Nullable<PackageScope>} scope
-   */
-  let scope: Nullable<PackageScope> = null
-
-  // search for package.json
-  while (dir && !dir.endsWith('node_modules')) {
-    // stop search if outside of endpoint
-    if (pathe.relative(stopdir, dir).startsWith(DOT.repeat(2) + '/')) break
-
-    /**
-     * Possible `package.json` object.
-     *
-     * @const {Nullable<PackageJson>} pkgjson
-     */
-    const pkgjson: Nullable<PackageJson> = readPackageJson(
-      dir,
-      specifier,
-      parent
-    )
-
-    // stop search if package.json has been found
-    if (pkgjson) {
-      scope = {
-        dir: pathToFileURL((dir = pathe.resolve(process.cwd(), dir))).href,
-        pkg: pathToFileURL(pathe.join(dir, 'package.json')).href,
-        pkgjson
-      }
-
-      break
-    }
-
-    // stop search if endpoint has been reached
-    if (dir === stopdir.replace(/\/$/, '')) break
-
-    // continue searching for package.json
-    dir = pathe.dirname(dir)
-  }
-
-  return scope
-}
-
-export default lookupPackageScope

package/src/utils/parse-data-url.ts

@@ -1,71 +0,0 @@
-/**
- * @file parseDataURL
- * @module mlly/utils/parseDataURL
- */
-
-import type { ParsedDataUrl } from '#src/interfaces'
-import {
-  ERR_INVALID_URL,
-  type ErrInvalidUrl,
-  type NodeError
-} from '@flex-development/errnode'
-import { cast, trim, type Nullable } from '@flex-development/tutils'
-import type { URL } from 'node:url'
-import toURL from './to-url'
-
-/**
- * Parses a [`data:` URL][1].
- *
- * If valid, returns an object representing the given `url`.
- *
- * **Note**: A [MIME type][2] string is required.
- *
- * [1]: https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URLs
- * [2]: https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/MIME_types
- *
- * @see https://nodejs.org/api/esm.html#data-imports
- *
- * @param {URL | string} url - URL to evaluate
- * @return {ParsedDataUrl} Object representing `url`
- * @throws {ErrInvalidUrl | NodeError<TypeError>} If `url` is not a string or
- * instance of {@linkcode URL}, or if `url` not a valid `data:` URL
- */
-const parseDataURL = (url: URL | string): ParsedDataUrl => {
-  // ensure url is an instance of URL
-  url = toURL(url)
-
-  /**
-   * Regex to extract `data:` URL components.
-   *
-   * @see https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URLs
-   * @see https://regex101.com/r/Ie8Doq
-   *
-   * @const {RegExp} regex
-   */
-  const regex: RegExp =
-    /^(?<protocol>data:)(?<mime>[^/]+\/[^,;]+)[^,]*?(?:;(?<base64>base64))?,(?<data>[\S\s]*?)$/
-
-  /**
-   * `data:` URL match.
-   *
-   * @const {Nullable<RegExpExecArray>} match
-   */
-  const match: Nullable<RegExpExecArray> = regex.exec(url.href)
-
-  // throw if url is not data url
-  if (!match) throw new ERR_INVALID_URL(url.href)
-
-  // get data url components
-  const [, , mime = '', base64, data = ''] = match
-
-  return {
-    base64: !!base64,
-    data: trim(data),
-    href: url.href,
-    mime,
-    pathname: url.pathname,
-    protocol: cast(url.protocol)
-  }
-}
-
-export default parseDataURL