@flex-development/mlly 1.0.0-alpha.11 → 1.0.0-alpha.13

package/src/utils/resolve-module.ts

@@ -6,6 +6,10 @@
 import type { ResolveModuleOptions } from '#src/interfaces'
 import isFunction from '#src/internal/is-function'
 import Resolver from '#src/internal/resolver'
+import validateArraySet from '#src/internal/validate-array-set'
+import validateBoolean from '#src/internal/validate-boolean'
+import validateString from '#src/internal/validate-string'
+import validateURLString from '#src/internal/validate-url-string'
 import { ErrorCode, type NodeError } from '@flex-development/errnode'
 import { isBuiltin } from '@flex-development/is-builtin'
 import pathe from '@flex-development/pathe'
@@ -57,6 +61,16 @@ const resolveModule = async (
     preserveSymlinks = false
   } = options
 
+  // ensure specifier is a string
+  validateString(specifier, 'specifier')
+
+  // ensure option schemas
+  validateString(condition, 'options.condition')
+  validateArraySet(conditions, 'options.conditions')
+  validateArraySet(extensions, 'options.extensions')
+  validateURLString(parent, 'options.parent')
+  validateBoolean(preserveSymlinks, 'options.preserveSymlinks')
+
   /**
    * Module resolver.
    *
@@ -65,21 +79,35 @@ const resolveModule = async (
   const resolver: Resolver = new Resolver()
 
   /**
-   * Module ids to try resolving.
+   * Boolean indicating only module id should be tried for resolution.
    *
-   * @const {string[]} tries
+   * @const {boolean} onetry
    */
-  const tries: string[] =
+  const onetry: boolean =
     isBuiltin(specifier) ||
     (/^\S+:/.test(specifier) && !specifier.startsWith('file:'))
-      ? []
-      : [...extensions]
-          .flatMap(ext => [
-            specifier + (ext = pathe.formatExt(ext)),
-            specifier.startsWith('#') ? specifier + '/index' : '',
-            specifier + '/index' + ext
-          ])
-          .filter(id => id.length > 0)
+
+  /**
+   * Module ids to try resolving.
+   *
+   * @const {string[]} tries
+   */
+  const tries: string[] = onetry
+    ? []
+    : [...extensions]
+        .flatMap(ext => [
+          specifier + (ext = pathe.formatExt(ext)),
+          specifier.startsWith('#') ? specifier + '/index' : '',
+          specifier + '/index' + ext
+        ])
+        .filter(id => id.length > 0)
+
+  // try @types resolution
+  if (!onetry) {
+    specifier.startsWith('@types')
+      ? tries.unshift(specifier + '/index.d.ts')
+      : tries.unshift('@types/' + specifier + '/index.d.ts')
+  }
 
   // ensure attempt to resolve original specifier is first
   tries.unshift(specifier)
@@ -93,6 +121,7 @@ const resolveModule = async (
    * @const {Set<ErrorCode>} ignore
    */
   const ignore: Set<ErrorCode> = new Set<ErrorCode>([
+    ErrorCode.ERR_INVALID_MODULE_SPECIFIER,
     ErrorCode.ERR_MODULE_NOT_FOUND,
     ErrorCode.ERR_PACKAGE_PATH_NOT_EXPORTED,
     ErrorCode.ERR_UNSUPPORTED_DIR_IMPORT

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

@@ -5,6 +5,7 @@
 
 import type { PackageScope, ParsedModuleId } from '#src/interfaces'
 import regexp from '#src/internal/escape-reg-exp'
+import validateSet from '#src/internal/validate-set'
 import validateURLString from '#src/internal/validate-url-string'
 import type { ModuleId } from '#src/types'
 import {
@@ -71,6 +72,7 @@ const toBareSpecifier = (
 ): string => {
   validateURLString(specifier, 'specifier')
   validateURLString(parent, 'parent')
+  validateSet(conditions, 'conditions')
 
   // ensure specifier is a string
   if (specifier instanceof URL) specifier = specifier.href
@@ -102,26 +104,22 @@ const toBareSpecifier = (
    *
    * @const {Nullable<PackageScope>} scope
    */
-  const scope: Nullable<PackageScope> = lookupPackageScope(
-    url,
-    pathToFileURL('.')
-  )
+  const scope: Nullable<PackageScope> =
+    lookupPackageScope(url, pathToFileURL('.')) ??
+    lookupPackageScope(specifier, pathToFileURL('.'))
 
   // throw if package scope was not found
   if (!scope) {
     throw new ERR_OPERATION_FAILED(`Package scope for '${specifier}' not found`)
   }
 
-  // get directory containing package.json file and package.json object
-  const { dir: pkgdir, pkgjson } = scope
-
   // get package exports and name
-  const { exports, main, name = '', types } = pkgjson
+  const { exports, main, name = '', types } = scope.pkgjson
 
   // convert specifier to bare specifier
   specifier = url.pathname.includes(name)
     ? name + url.pathname.replace(new RegExp(`.*?${regexp(name)}`), '')
-    : name + specifier.replace(fileURLToPath(pkgdir.replace(/\/$/, '')), '')
+    : name + specifier.replace(fileURLToPath(scope.dir.replace(/\/$/, '')), '')
 
   /**
    * Parsed module specifier.
@@ -145,7 +143,7 @@ const toBareSpecifier = (
 
   // check if specifier contains valid subpath export
   try {
-    parseSubpath(specifier, exports, { dir: pkgdir, parent })
+    parseSubpath(specifier, exports, { dir: scope.dir, parent })
   } catch (e: unknown) {
     // try finding defined subpath if specifier is invalid package path
     if ((e as NodeError).code === ErrorCode.ERR_PACKAGE_PATH_NOT_EXPORTED) {
@@ -164,14 +162,14 @@ const toBareSpecifier = (
        */
       let subpath: Nullable<string> = findSubpath(target, exports, {
         conditions,
-        dir: pkgdir,
+        dir: scope.dir,
         parent
       })
 
       // throw if target was not matched to a subpath
       if (subpath === null) {
         throw new ERR_PACKAGE_PATH_NOT_EXPORTED(
-          fileURLToPath(pkgdir),
+          fileURLToPath(scope.dir),
           id.path,
           fileURLToPath(parent)
         )

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

@@ -3,7 +3,9 @@
  * @module mlly/utils/toRelativeSpecifier
  */
 
+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 { URL, fileURLToPath } from 'node:url'
 
@@ -21,8 +23,13 @@ import { URL, fileURLToPath } from 'node:url'
  * @param {ModuleId} specifier - Module specifier to convert
  * @param {ModuleId} parent - Parent module URL or path to resolve from
  * @return {string} `specifier` as relative specifier
+ * @throws {NodeError<TypeError>} If either `specifier` or `parent` is not a
+ * string or an instance of {@linkcode URL}
  */
 const toRelativeSpecifier = (specifier: ModuleId, parent: ModuleId): string => {
+  validateURLString(specifier, 'specifier')
+  validateURLString(parent, 'parent')
+
   // convert file url objects to file url strings
   if (parent instanceof URL) parent = parent.href
   if (specifier instanceof URL) specifier = specifier.href

package/src/utils/to-url.ts

@@ -17,10 +17,9 @@ import { URL, pathToFileURL } from 'node:url'
  *
  * @param {ModuleId} id - Module id to evaluate
  * @param {ModuleId?} [base=pathToFileURL('./')] - Base URL to resolve against
- * if `id` is not absolute
- * @return {URL} `id` as instance of `URL`
+ * @return {URL} `id` as instance of {@linkcode URL}
  * @throws {NodeError<TypeError>} If either `id` or `base` is not a string or an
- * instance of `URL`
+ * instance of {@linkcode URL}
  */
 const toURL = (id: ModuleId, base: ModuleId = pathToFileURL('./')): URL => {
   validateURLString(id, 'id')

package/src/utils/validate-assertions.ts

@@ -7,6 +7,7 @@ import type { Format } from '#src/enums'
 import { AssertType } from '#src/enums'
 import type { ImportAssertions } from '#src/interfaces'
 import FORMAT_TYPE_MAP from '#src/internal/format-type-map'
+import validateObject from '#src/internal/validate-object'
 import validateString from '#src/internal/validate-string'
 import validateURLString from '#src/internal/validate-url-string'
 import type { ModuleId } from '#src/types'
@@ -39,6 +40,7 @@ const validateAssertions = (
 ): true => {
   validateURLString(url, 'url')
   validateString(format, 'format')
+  validateObject(assertions, 'assertions')
 
   // ensure url is a string
   if (url instanceof URL) url = url.href

package/src/utils/validate-exports.ts

@@ -26,8 +26,8 @@ import { URL, fileURLToPath } from 'node:url'
  * @param {ModuleId} pkg - URL of relevant `package.json` file
  * @param {ModuleId} parent - URL of module to resolve from
  * @return {true} `true` if `exports` configuration and schema are valid
- * @throws {NodeError<Error | TypeError>} If either `pkg` or `parent` is not an
- * instance of {@linkcode URL} or a string, or if `exports` configuration or
+ * @throws {NodeError<Error | TypeError>} If either `pkg` or `parent` is not a
+ * string or an instance of {@linkcode URL}, or if `exports` configuration or
  * schema is invalid
  */
 const validateExports = (
@@ -35,6 +35,9 @@ const validateExports = (
   pkg: ModuleId,
   parent: ModuleId
 ): true => {
+  validateURLString(pkg, 'pkg')
+  validateURLString(parent, 'parent')
+
   switch (true) {
     case Array.isArray(exports):
       for (const item of exports as unknown[]) {
@@ -70,9 +73,6 @@ const validateExports = (
     default:
       exports = exports as Record<string, Exports>
 
-      validateURLString(pkg, 'pkg')
-      validateURLString(parent, 'parent')
-
       /**
        * Keys defined in {@linkcode exports}.
        *

package/changelog.config.ts

@@ -1,404 +0,0 @@
-/**
- * @file Changelog Configuration
- * @module config/changelog
- * @see https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-conventionalcommits
- * @see https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-core
- * @see https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-writer
- * @see https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-commits-parser
- * @see https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/git-raw-commits
- */
-
-import pathe from '@flex-development/pathe'
-import { CompareResult, isNIL } from '@flex-development/tutils'
-import addStream from 'add-stream'
-import conventionalChangelog from 'conventional-changelog'
-import type { Options } from 'conventional-changelog-core'
-import type {
-  CommitGroup,
-  GeneratedContext
-} from 'conventional-changelog-writer'
-import type { Commit, ICommit } from 'conventional-commits-parser'
-import dateformat from 'dateformat'
-import type mri from 'mri'
-import {
-  createReadStream,
-  createWriteStream,
-  readFileSync,
-  type ReadStream,
-  type WriteStream
-} from 'node:fs'
-import type { Readable } from 'node:stream'
-import sade from 'sade'
-import semver from 'semver'
-import tempfile from 'tempfile'
-import pkg from './package.json' assert { type: 'json' }
-
-/**
- * CLI flags.
- */
-interface Flags {
-  /**
-   * Output unreleased changelog.
-   *
-   * To the set the current version, pass a string value.
-   *
-   * @example
-   *  '1.0.0-alpha.7'
-   * @example
-   *  true
-   *
-   * @default true
-   */
-  'output-unreleased'?: boolean | string
-
-  /**
-   * Number of releases to be generated.
-   *
-   * If `0`, the changelog will be regenerated and the output file will be
-   * overwritten.
-   *
-   * @default 1
-   */
-  'release-count'?: number
-
-  /**
-   * Output content to {@linkcode infile}.
-   *
-   * @default false
-   */
-  'same-file'?: boolean
-
-  /**
-   * Enable verbose output.
-   *
-   * @default false
-   */
-  debug?: boolean
-
-  /**
-   * Read CHANGELOG from this file.
-   */
-  infile?: string
-
-  /**
-   * Write content to this file.
-   *
-   * **Note**: Requires {@linkcode write} to be `true`.
-   */
-  outfile?: string
-
-  /**
-   * Write content to file instead of {@linkcode process.stdout}.
-   *
-   * @default false
-   */
-  write?: boolean
-}
-
-sade('changelog', true)
-  .option('-d, --debug', 'Enable verbose output', false)
-  .option('-i, --infile', 'Read CHANGELOG from this file')
-  .option('-o, --outfile', 'Write content to this file (requires --write)')
-  .option('-r, --release-count', 'Number of releases to be generated', 1)
-  .option('-s, --same-file', 'Output content to infile', false)
-  .option('-u, --output-unreleased', 'Output unreleased changelog')
-  .option('-w, --write', 'Write content to file', false)
-  .action((flags: mri.Argv<Flags>): void => {
-    const {
-      'release-count': releaseCount = 1,
-      debug = false,
-      write = false
-    } = flags
-    let {
-      'output-unreleased': outputUnreleased = true,
-      infile,
-      'same-file': samefile,
-      outfile
-    } = flags
-
-    // convert possible 'false' or 'true' to boolean value
-    if (outputUnreleased === 'false' || outputUnreleased === 'true') {
-      outputUnreleased = JSON.parse(outputUnreleased)
-    }
-
-    /**
-     * Regex used to extract a release version from a string containing
-     * Git tags.
-     *
-     * @const {RegExp} vgx
-     */
-    const vgx: RegExp = pkg.tagPrefix
-      ? new RegExp(`tag:\\s*[=]?${pkg.tagPrefix}(.+?)[,)]`, 'gi')
-      : /tag:\s*[=v]?(.+?)[),]/gi
-
-    /**
-     * Changelog content stream.
-     *
-     * @const {Readable} changelog
-     */
-    const changelog: Readable = conventionalChangelog(
-      {
-        append: false,
-        debug: debug ? console.debug.bind(console) : undefined,
-        outputUnreleased:
-          typeof outputUnreleased === 'boolean'
-            ? outputUnreleased
-            : typeof outputUnreleased === 'string'
-            ? !!outputUnreleased.trim()
-            : false,
-        pkg: { path: pathe.resolve('package.json') },
-        // @ts-expect-error ts(2322)
-        preset: {
-          header: '',
-          name: 'conventionalcommits',
-          releaseCommitMessageFormat: 'release: {{currentTag}}',
-          types: [
-            { section: ':package: Build', type: 'build' },
-            { section: ':house_with_garden: Housekeeping', type: 'chore' },
-            { section: ':robot: Continuous Integration', type: 'ci' },
-            { section: ':pencil: Documentation', type: 'docs' },
-            { section: ':sparkles: Features', type: 'feat' },
-            { section: ':bug: Fixes', type: 'fix' },
-            { section: ':fire: Performance Improvements', type: 'perf' },
-            { section: ':zap: Refactors', type: 'refactor' },
-            { section: ':rewind: Reverts', type: 'revert' },
-            { hidden: true, type: 'style' },
-            { section: ':white_check_mark: Testing', type: 'test' },
-            { hidden: true, type: 'wip' }
-          ]
-        },
-        releaseCount,
-        skipUnstable: false,
-        tagPrefix: pkg.tagPrefix,
-        /**
-         * Raw commit transformer.
-         *
-         * @see https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-core#transform-1
-         * @see https://github.com/conventional-changelog/conventional-changelog/issues/415
-         *
-         * @param {Commit} commit - Commit object
-         * @param {Options.Transform.Callback} apply - Commit handler
-         * @return {void} Nothing when complete
-         */
-        transform(commit: Commit, apply: Options.Transform.Callback): void {
-          return void apply(null, {
-            ...commit,
-            committerDate: dateformat(
-              commit.committerDate!,
-              'yyyy-mm-dd',
-              true
-            ),
-            mentions: commit.mentions.filter(m => m !== 'flexdevelopment'),
-            // @ts-expect-error ts(2322)
-            raw: commit,
-            references: commit.references.filter(ref => ref.action !== null),
-            shortHash: commit.hash!.slice(0, 7),
-            version: commit.gitTags ? vgx.exec(commit.gitTags)?.[1] : undefined
-          })
-        }
-      },
-      {},
-      {},
-      {
-        issuePrefixesCaseSensitive: true
-      },
-      {
-        /**
-         * Sorts commit groups in descending order by group title.
-         *
-         * GitHub emojis in titles will be ignored.
-         *
-         * @see https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-writer#commitgroupssort
-         *
-         * @param {CommitGroup} a - Commit group object
-         * @param {CommitGroup} b - Commit group object to compare to `a`
-         * @return {number} Compare result
-         */
-        commitGroupsSort(a: CommitGroup, b: CommitGroup): number {
-          if (a.title === false) return CompareResult.GREATER_THAN
-          if (b.title === false) return CompareResult.LESS_THAN
-
-          /**
-           * Regex used to extract commit group titles without GitHub emojis.
-           *
-           * @const {RegExp} tgx - Regex used to extract commit group title
-           */
-          const tgx: RegExp = /([A-Z])\w+/
-
-          return tgx.exec(a.title)![0]!.localeCompare(tgx.exec(b.title)![0]!)
-        },
-        /**
-         * Sorts commits in descending order by commit header and date.
-         *
-         * @see https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-writer#commitssort
-         *
-         * @param {ICommit} a - Commit object
-         * @param {ICommit} b - Commit object to compare to `b`
-         * @return {number} Compare result
-         */
-        commitsSort(a: ICommit, b: ICommit): number {
-          /**
-           * Compare result for {@linkcode b.committerDate} and
-           * {@linkcode a.committerDate}.
-           *
-           * @const {number} by_date
-           */
-          const by_date: number =
-            new Date(b.committerDate).getTime() -
-            new Date(a.committerDate).getTime()
-
-          return a.header && b.header
-            ? a.header.localeCompare(b.header) || by_date
-            : by_date
-        },
-        /**
-         * Modifies `context` before the changelog is generated.
-         *
-         * This includes:
-         *
-         * - Setting the current and previous release tags
-         * - Setting the release date
-         * - Determining patch release state
-         * - Determining if compare links should be generated
-         *
-         * @see https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-core#finalizecontext
-         * @see https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-writer#finalizecontext
-         *
-         * @param {GeneratedContext} context - Generated changelog context
-         * @param {Options} options - `conventional-changelog-core` options
-         * @param {ICommit[]} commits - Commits for release
-         * @param {ICommit | undefined} key - Release commit
-         * @return {GeneratedContext} Final changelog context
-         */
-        finalizeContext(
-          context: GeneratedContext,
-          options: Options,
-          commits: ICommit[],
-          key: ICommit | undefined
-        ): GeneratedContext {
-          const { gitSemverTags = [], isPatch, linkCompare, version } = context
-          let { currentTag, previousTag } = context
-
-          /**
-           * First commit in release.
-           *
-           * @const {ICommit | undefined} first_commit
-           */
-          const first_commit: ICommit | undefined = commits.at(0)
-
-          /**
-           * Last commit in release.
-           *
-           * @const {ICommit | undefined} last_commit
-           */
-          const last_commit: ICommit | undefined = commits.at(-1)
-
-          // set current and previous tags
-          if (key && (!currentTag || !previousTag)) {
-            currentTag = key.version ?? undefined
-
-            // try setting previous tag based on current tag
-            if (gitSemverTags.includes(currentTag ?? '')) {
-              const { version } = key
-              previousTag = gitSemverTags[gitSemverTags.indexOf(version!) + 1]
-              if (!previousTag) previousTag = last_commit?.hash ?? undefined
-            }
-          } else {
-            currentTag = /^unreleased$/i.test(version ?? '')
-              ? currentTag ??
-                (typeof outputUnreleased === 'string' && outputUnreleased
-                  ? outputUnreleased
-                  : first_commit?.hash ?? undefined)
-              : !currentTag && version
-              ? pkg.tagPrefix + version
-              : currentTag ?? version
-            previousTag = previousTag ?? gitSemverTags[0]
-          }
-
-          // set release date
-          context.date =
-            key?.committerDate ?? dateformat(new Date(), 'yyyy-mm-dd', true)
-
-          // determine patch release state
-          if (version && semver.valid(version)) {
-            context.isPatch = isPatch ?? semver.patch(version) !== 0
-          }
-
-          // @ts-expect-error ts(2322)
-          return {
-            ...context,
-            currentTag,
-            linkCompare: isNIL(linkCompare) && !!currentTag && !!previousTag,
-            previousTag,
-            repoUrl: pkg.repository.slice(0, -4)
-          }
-        },
-        headerPartial: readFileSync('templates/changelog/header.hbs', 'utf8'),
-        ignoreReverted: false
-      }
-    ).on('error', err => console.error(err.stack))
-
-    // override samefile if infile and outfile are the same file
-    if (infile && infile === outfile) samefile = true
-
-    // reset outfile if changelog should be output to infile
-    if (samefile) outfile = infile = infile ?? 'CHANGELOG.md'
-
-    /**
-     * Creates a file writer.
-     *
-     * If writing to file is disabled, {@linkcode process.stdout} will be used
-     * to write content to the terminal.
-     *
-     * Otherwise, {@linkcode createWriteStream} will be used to create a stream
-     * for {@linkcode outfile}.
-     *
-     * @see {@linkcode NodeJS.WriteStream}
-     * @see {@linkcode WriteStream}
-     * @see {@linkcode createWriteStream}
-     *
-     * @return {WriteStream | (NodeJS.WriteStream & { fd: 1 })} File writer
-     */
-    const writer = (): WriteStream | (NodeJS.WriteStream & { fd: 1 }) => {
-      return write && outfile ? createWriteStream(outfile) : process.stdout
-    }
-
-    // write changelog to infile, outfile, or stdout
-    switch (true) {
-      case infile && releaseCount !== 0:
-        /**
-         * Changelog file stream.
-         *
-         * @const {ReadStream} rs
-         */
-        const rs: ReadStream = createReadStream(infile!).on('error', () => {
-          if (debug) console.error('infile does not exist.')
-          if (samefile) changelog.pipe(writer())
-        })
-
-        // write changelog to infile or stdout
-        if (samefile) {
-          /**
-           * Absolute path to random temporary file.
-           *
-           * @const {string} tmp
-           */
-          const tmp: string = tempfile()
-
-          changelog
-            .pipe(addStream(rs))
-            .pipe(createWriteStream(tmp))
-            .on('finish', () => createReadStream(tmp).pipe(writer()))
-        } else {
-          changelog.pipe(addStream(rs)).pipe(writer())
-        }
-
-        break
-      default:
-        changelog.pipe(writer())
-        break
-    }
-
-    return void 0
-  })
-  .parse(process.argv)