@sanity/pkg-utils 3.1.1 → 3.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/pkg-utils",
-  "version": "3.1.1",
+  "version": "3.2.0",
   "description": "Simple utilities for modern npm packages.",
   "keywords": [
     "sanity-io",
@@ -46,6 +46,24 @@
     "!dist/stats.html",
     "src"
   ],
+  "scripts": {
+    "build": "run-s clean build:pkg check:pkg",
+    "build:pkg": "node --loader esbuild-register/loader -r esbuild-register scripts/build",
+    "check:pkg": "node --loader esbuild-register/loader -r esbuild-register scripts/check",
+    "check:types": "tsc --build",
+    "clean": "rimraf dist",
+    "commit": "cz",
+    "extract": "sanity-tsdoc etl --outDir etc/api/@sanity/pkg-utils --tsconfig tsconfig.dist.json",
+    "format": "prettier --write --cache --ignore-unknown . && eslint . --ext .cjs,.js,.ts,.tsx --fix --quiet",
+    "lint": "eslint . --ext .cjs,.js,.ts,.tsx",
+    "playground:build": "pnpm --filter './playground/**' build",
+    "playground:clean": "pnpm --filter './playground/**' --silent clean",
+    "prepublishOnly": "pnpm run build",
+    "test": "run-s playground:clean test:clean vitest:run",
+    "test:clean": "rimraf test/env/__tmp__",
+    "vitest:run": "vitest run",
+    "watch": "node --loader esbuild-register/loader -r esbuild-register scripts/watch"
+  },
   "commitlint": {
     "extends": [
       "@commitlint/config-conventional"
@@ -107,7 +125,7 @@
     "esbuild-register": "^3.5.0",
     "find-config": "^1.0.0",
     "get-latest-version": "^5.1.0",
-    "git-url-parse": "^13.1.0",
+    "git-url-parse": "^13.1.1",
     "globby": "^11.1.0",
     "jsonc-parser": "^3.2.0",
     "mkdirp": "^3.0.1",
@@ -127,8 +145,9 @@
     "zod": "^3.22.4"
   },
   "devDependencies": {
-    "@commitlint/cli": "^17.8.0",
-    "@commitlint/config-conventional": "^17.8.0",
+    "@commitlint/cli": "^18.0.0",
+    "@commitlint/config-conventional": "^18.0.0",
+    "@sanity/pkg-utils": "workspace:*",
     "@types/babel__core": "^7.20.3",
     "@types/cpx": "^1.5.4",
     "@types/find-config": "^1.0.3",
@@ -138,19 +157,19 @@
     "@types/prompts": "^2.4.7",
     "@types/rimraf": "^3.0.2",
     "@types/treeify": "^1.0.2",
-    "@types/uuid": "^9.0.5",
+    "@types/uuid": "^9.0.6",
     "@typescript-eslint/eslint-plugin": "^6.8.0",
     "@typescript-eslint/parser": "^6.8.0",
     "commitizen": "^4.3.0",
     "cpx": "^1.5.0",
     "cz-conventional-changelog": "^3.3.0",
-    "eslint": "^8.51.0",
+    "eslint": "^8.52.0",
     "eslint-config-prettier": "^9.0.0",
-    "eslint-plugin-import": "^2.28.1",
+    "eslint-plugin-import": "^2.29.0",
     "eslint-plugin-prettier": "^5.0.1",
     "eslint-plugin-simple-import-sort": "10.0.0",
     "husky": "^8.0.3",
-    "lint-staged": "^15.0.1",
+    "lint-staged": "^15.0.2",
     "npm-run-all": "^4.1.5",
     "outdent": "^0.8.0",
     "recast": "^0.23.4",
@@ -158,8 +177,7 @@
     "ts-node": "^10.9.1",
     "typescript": "^5.2.2",
     "vitest": "^0.34.6",
-    "vitest-github-actions-reporter": "^0.10.0",
-    "@sanity/pkg-utils": "3.1.1"
+    "vitest-github-actions-reporter": "^0.10.0"
   },
   "peerDependencies": {
     "typescript": "^4.7 || ^5"
@@ -171,21 +189,9 @@
   "publishConfig": {
     "access": "public"
   },
-  "scripts": {
-    "build": "run-s clean build:pkg check:pkg",
-    "build:pkg": "node --loader esbuild-register/loader -r esbuild-register scripts/build",
-    "check:pkg": "node --loader esbuild-register/loader -r esbuild-register scripts/check",
-    "check:types": "tsc --build",
-    "clean": "rimraf dist",
-    "commit": "cz",
-    "extract": "sanity-tsdoc etl --outDir etc/api/@sanity/pkg-utils --tsconfig tsconfig.dist.json",
-    "format": "prettier --write --cache --ignore-unknown . && eslint . --ext .cjs,.js,.ts,.tsx --fix --quiet",
-    "lint": "eslint . --ext .cjs,.js,.ts,.tsx",
-    "playground:build": "pnpm --filter './playground/**' build",
-    "playground:clean": "pnpm --filter './playground/**' --silent clean",
-    "test": "run-s playground:clean test:clean vitest:run",
-    "test:clean": "rimraf test/env/__tmp__",
-    "vitest:run": "vitest run",
-    "watch": "node --loader esbuild-register/loader -r esbuild-register scripts/watch"
+  "pnpm": {
+    "overrides": {
+      "@sanity/pkg-utils": "workspace:*"
+    }
   }
-}
+}

package/src/node/core/config/types.ts

@@ -79,6 +79,7 @@ export interface PkgConfigOptions {
   dist?: string
   exports?: PkgConfigProperty<PkgExports>
   extract?: {
+    bundledPackages?: string[]
     customTags?: TSDocCustomTag[]
     rules?: {
       'ae-forgotten-export'?: PkgRuleLevel

package/src/node/tasks/dts/createApiExtractorConfig.ts

@@ -2,6 +2,7 @@ import {IConfigFile, IExtractorMessagesConfig} from '@microsoft/api-extractor'
 import path from 'path'
 
 export function createApiExtractorConfig(options: {
+  bundledPackages?: string[]
   distPath: string
   exportPath: string
   filePath: string
@@ -11,6 +12,7 @@ export function createApiExtractorConfig(options: {
   tsconfigPath: string
 }): IConfigFile {
   const {
+    bundledPackages,
     distPath,
     exportPath,
     filePath,
@@ -25,7 +27,7 @@ export function createApiExtractorConfig(options: {
       enabled: false,
       reportFileName: '<unscopedPackageName>.api.md',
     },
-    // bundledPackages: [],
+    bundledPackages,
     compiler: {
       tsconfigFilePath: tsconfigPath,
     },

package/src/node/tasks/dts/doExtract.ts

@@ -47,6 +47,7 @@ export async function doExtract(
     const targetPath = path.resolve(cwd, entry.targetPath)
     const filePath = path.relative(outDir, targetPath)
     const result = await extractTypes({
+      bundledPackages: config?.extract?.bundledPackages || [],
       customTags: config?.extract?.customTags,
       cwd,
       distPath: outDir,
@@ -63,6 +64,7 @@ export async function doExtract(
     messages.push(...result.messages)
 
     const errors = result.messages.filter((msg) => msg.logLevel === 'error')
+
     if (errors.length > 0) {
       await rimraf(tmpPath)
       throw new DtsError(`encountered ${errors.length} errors when extracting types`, errors)

package/src/node/tasks/dts/extractTypes.ts

@@ -16,6 +16,7 @@ import {extractModuleBlocksFromTypes} from './extractModuleBlocks'
 import {getExtractMessagesConfig} from './getExtractMessagesConfig'
 
 export async function extractTypes(options: {
+  bundledPackages?: string[]
   customTags: NonNullable<PkgConfigOptions['extract']>['customTags']
   cwd: string
   distPath: string
@@ -29,6 +30,7 @@ export async function extractTypes(options: {
   tsconfigPath: string
 }): Promise<{extractorResult: ExtractorResult; messages: ExtractorMessage[]}> {
   const {
+    bundledPackages,
     customTags,
     distPath,
     exportPath,
@@ -47,6 +49,7 @@ export async function extractTypes(options: {
 
   const extractorConfig: ExtractorConfig = ExtractorConfig.prepare({
     configObject: createApiExtractorConfig({
+      bundledPackages,
       distPath,
       exportPath,
       filePath,