SAF Documentation

@saflib/monorepo

index ​

Interfaces ​

InterfaceDescription
PackageInfoPackage metadata indexed by workspace package name.

Type Aliases ​

Type AliasDescription
PackageIndexIndex of workspace packages discovered under a monorepo root.
ResolveResult-

Variables ​

VariableDescription
ROOT_IMPORT_CATCHALLCatch-all only when exports includes ./*.

Functions ​

FunctionDescription
buildPackageIndexBuild a map of workspace package name → { dir, exports }.
existsResolveResolve a path candidate with common TS/Vue extensions and index files.
findMonorepoRootWalk up from fromDir until a package.json with a workspaces field is found.
importGlobForTopLevelSegmentDerive package-local # import maps from exports.
importsFromExportsBuild a default imports map from an exports map.
isEmbeddedProductMonorepoTrue when rootDir is a product monorepo with a nested saflib/ workspace.
matchExportPatternMatch a Node.js package.json exports subpath pattern.
resolvePackageExportPathResolve a package export subpath to an absolute file path (no extension probing).
resolveSpecifierResolve an import specifier relative to fromFile against the package index.
sortExportPatternKeysPrefer longer (more specific) pattern keys, matching Node's best-match preference.
stripTemplateImportPlaceholdersRemove template placeholder import keys/values (e.g. #__group-name__/*).
upsertImportGlob-

References ​

checkExportPatternCoverage ​

Re-exports checkExportPatternCoverage

checkExports ​

Re-exports checkExports

CheckExportsResult ​

Re-exports CheckExportsResult

checkPackageLayout ​

Re-exports checkPackageLayout

checkPackageLayoutFromInputs ​

Re-exports checkPackageLayoutFromInputs

CheckPackageLayoutFromInputsOptions ​

Re-exports CheckPackageLayoutFromInputsOptions

CheckPackageLayoutOptions ​

Re-exports CheckPackageLayoutOptions

classifySafPackage ​

Re-exports classifySafPackage

collectPublicExportRepoPaths ​

Re-exports collectPublicExportRepoPaths

computeExportsMap ​

Re-exports computeExportsMap

DEFAULT_MAX_SOURCE_LINES ​

Re-exports DEFAULT_MAX_SOURCE_LINES

exportGlobForTopLevelSegment ​

Re-exports exportGlobForTopLevelSegment

ExportModulePathLayout ​

Re-exports ExportModulePathLayout

ExportsMap ​

Re-exports ExportsMap

generateExports ​

Re-exports generateExports

hasSdkRequestsExport ​

Re-exports hasSdkRequestsExport

isAllowedRootTsFile ​

Re-exports isAllowedRootTsFile

isPackageKind ​

Re-exports isPackageKind

leafExportRemapDiffs ​

Re-exports leafExportRemapDiffs

listExportableFiles ​

Re-exports listExportableFiles

listPackageJsonExportTargetFiles ​

Re-exports listPackageJsonExportTargetFiles

PACKAGE_KIND_IDENTIFIERS ​

Re-exports PACKAGE_KIND_IDENTIFIERS

PACKAGE_KINDS ​

Re-exports PACKAGE_KINDS

packageHasWorkflowMarkers ​

Re-exports packageHasWorkflowMarkers

PackageJsonLayoutFields ​

Re-exports PackageJsonLayoutFields

PackageKind ​

Re-exports PackageKind

PackageKindClassification ​

Re-exports PackageKindClassification

PackageLayoutIssue ​

Re-exports PackageLayoutIssue

PackageLayoutIssueKind ​

Re-exports PackageLayoutIssueKind

parseSafPackageJson ​

Re-exports parseSafPackageJson

prepareNewPackageExports ​

Re-exports prepareNewPackageExports

resolveExportModulePathLayout ​

Re-exports resolveExportModulePathLayout

resolvePackageDir ​

Re-exports resolvePackageDir

ROOT_TS_ALLOWLIST ​

Re-exports ROOT_TS_ALLOWLIST

SafPackageJson ​

Re-exports SafPackageJson

sortExportsMap ​

Re-exports sortExportsMap

stripTemplateExportPlaceholders ​

Re-exports stripTemplateExportPlaceholders

upsertExplicitExport ​

Re-exports upsertExplicitExport

upsertExportGlob ​

Re-exports upsertExportGlob

upsertPackageExportForModule ​

Re-exports upsertPackageExportForModule

upsertPackageJsonExportsForModule ​

Re-exports upsertPackageJsonExportsForModule