feat(interfaces): PackageScope

Signed-off-by: Lexus Drumgold <unicornware@flexdevelopment.llc>

Author: unicornware

docs/.vitepress/theme/comments/link-replacements.json

@@ -9,6 +9,8 @@
   "{@linkcode ExportStatement}": "/api/interfaces#exportstatement",
   "{@linkcode Ext}": "https://github.com/flex-development/pathe/blob/main/src/types/ext.ts",
   "{@linkcode ImportStatement}": "/api/interfaces#importstatement",
+  "{@linkcode PackageJson}": "https://github.com/flex-development/pkg-types/blob/2.0.0/src/interfaces/package-json.ts",
+  "{@linkcode PackageScope}": "/api/interfaces/#packagescope",
   "{@linkcode MIMEType}": "/api/types#mimetype",
   "{@linkcode ModuleSpecifierType}": "/api/types#modulespecifiertype",
   "{@linkcode RESOLVE_EXTENSIONS}": "/api/constants#resolve-extensions",

src/interfaces/__tests__/package-scope.spec-d.ts

@@ -0,0 +1,19 @@
+/**
+ * @file Type Tests - PackageScope
+ * @module mlly/interfaces/tests/unit-d/PackageScope
+ */
+
+import type { PackageJson } from '@flex-development/pkg-types'
+import type TestSubject from '../package-scope'
+
+describe('unit-d:interfaces/PackageScope', () => {
+  it('should match [dir: string]', () => {
+    expectTypeOf<TestSubject>().toHaveProperty('dir').toBeString()
+  })
+
+  it('should match [pkg: PackageJson]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('pkg')
+      .toEqualTypeOf<PackageJson>()
+  })
+})

src/interfaces/index.ts

@@ -7,6 +7,7 @@ export type { default as DynamicImport } from './import-dynamic'
 export type { default as StaticImport } from './import-static'
 export type { default as ResolveOptions } from './options-resolve'
 export type { default as ResolveAliasOptions } from './options-resolve-alias'
+export type { default as PackageScope } from './package-scope'
 export type { default as Statement } from './statement'
 export type { default as ExportStatement } from './statement-export'
 export type { default as ImportStatement } from './statement-import'

src/interfaces/package-scope.ts

@@ -0,0 +1,26 @@
+/**
+ * @file Interfaces - PackageScope
+ * @module mlly/interfaces/PackageScope
+ */
+
+import type { PackageJson } from '@flex-development/pkg-types'
+
+/**
+ * Object containing a `package.json` object and an absolute path to a directory
+ * containing a `package.json` file.
+ *
+ * @see {@linkcode PackageJson}
+ */
+interface PackageScope {
+  /**
+   * Absolute path to directory containing `package.json` file.
+   */
+  dir: string
+
+  /**
+   * `package.json` object.
+   */
+  pkg: PackageJson
+}
+
+export type { PackageScope as default }