@codedrifters/configulator 0.0.270 → 0.0.272
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/index.d.mts +96 -2
- package/lib/index.d.ts +97 -3
- package/lib/index.js +159 -28
- package/lib/index.js.map +1 -1
- package/lib/index.mjs +160 -30
- package/lib/index.mjs.map +1 -1
- package/package.json +3 -1
package/lib/index.d.mts
CHANGED
|
@@ -6329,6 +6329,100 @@ interface AwsOrganization {
|
|
|
6329
6329
|
accounts: Array<AwsAccount>;
|
|
6330
6330
|
}
|
|
6331
6331
|
|
|
6332
|
+
/**
|
|
6333
|
+
* One row in the doc reference-extraction report — describes a single
|
|
6334
|
+
* inline-code symbol mention found in a markdown page and whether
|
|
6335
|
+
* that symbol is present in the supplied `knownSymbols` list.
|
|
6336
|
+
*/
|
|
6337
|
+
interface DocReferenceRecord {
|
|
6338
|
+
/**
|
|
6339
|
+
* Path to the markdown file the mention was found in. Resolved
|
|
6340
|
+
* relative to the configured `docsRoot` so reports are stable
|
|
6341
|
+
* across machines (no absolute prefixes leak through).
|
|
6342
|
+
*/
|
|
6343
|
+
readonly docPath: string;
|
|
6344
|
+
/**
|
|
6345
|
+
* 1-indexed line number of the inline-code span in the markdown
|
|
6346
|
+
* source.
|
|
6347
|
+
*/
|
|
6348
|
+
readonly line: number;
|
|
6349
|
+
/**
|
|
6350
|
+
* 1-indexed column where the inline-code span starts (the position
|
|
6351
|
+
* of the opening backtick).
|
|
6352
|
+
*/
|
|
6353
|
+
readonly column: number;
|
|
6354
|
+
/**
|
|
6355
|
+
* The exact symbol text inside the backticks, e.g. `analyzeTsDocCoverage`.
|
|
6356
|
+
* Whitespace inside the inline-code span is preserved as-is and
|
|
6357
|
+
* the candidate is included only when it matches the configured
|
|
6358
|
+
* identifier pattern.
|
|
6359
|
+
*/
|
|
6360
|
+
readonly symbol: string;
|
|
6361
|
+
/**
|
|
6362
|
+
* `true` when the symbol appears in the supplied `knownSymbols`
|
|
6363
|
+
* set. The downstream scan phase (#519) treats `false` as an
|
|
6364
|
+
* orphan reference candidate (advisory).
|
|
6365
|
+
*/
|
|
6366
|
+
readonly isKnown: boolean;
|
|
6367
|
+
}
|
|
6368
|
+
/**
|
|
6369
|
+
* Options accepted by {@link extractDocReferences}.
|
|
6370
|
+
*/
|
|
6371
|
+
interface ExtractDocReferencesOptions {
|
|
6372
|
+
/**
|
|
6373
|
+
* Absolute path to the docs root that should be walked for
|
|
6374
|
+
* `*.md` files. Defaults to `docs/src/content/docs/` relative
|
|
6375
|
+
* to the current working directory when omitted.
|
|
6376
|
+
*
|
|
6377
|
+
* @default "docs/src/content/docs"
|
|
6378
|
+
*/
|
|
6379
|
+
readonly docsRoot?: string;
|
|
6380
|
+
/**
|
|
6381
|
+
* List of known public symbols to cross-index inline-code
|
|
6382
|
+
* mentions against. Typically the `symbol` column of the
|
|
6383
|
+
* report returned by `analyzeTsDocCoverage()` plus, optionally,
|
|
6384
|
+
* any extra names sourced from the api-extractor `.api.md`
|
|
6385
|
+
* rollup. Order is irrelevant; duplicates are deduplicated.
|
|
6386
|
+
*/
|
|
6387
|
+
readonly knownSymbols?: ReadonlyArray<string>;
|
|
6388
|
+
/**
|
|
6389
|
+
* Regular expression a candidate must match to be considered a
|
|
6390
|
+
* TypeScript-identifier-shaped symbol. The default rejects
|
|
6391
|
+
* obvious non-symbol prose tokens (paths with slashes, prose
|
|
6392
|
+
* with spaces, lowercase one-letter words) while accepting the
|
|
6393
|
+
* three common identifier shapes used in the monorepo:
|
|
6394
|
+
* camelCase (`analyzeTsDocCoverage`), PascalCase
|
|
6395
|
+
* (`TsDocCoverageRecord`), and UPPER_SNAKE_CASE (`MAX_RETRIES`).
|
|
6396
|
+
*
|
|
6397
|
+
* Override this only if a project uses an unusual identifier
|
|
6398
|
+
* style — a custom pattern that is too permissive will produce
|
|
6399
|
+
* a noisy backlog of false positives.
|
|
6400
|
+
*
|
|
6401
|
+
* @default /^(?:[a-z][a-zA-Z0-9]*|[A-Z][a-zA-Z0-9]*|[A-Z][A-Z0-9_]*)$/
|
|
6402
|
+
*/
|
|
6403
|
+
readonly symbolPattern?: RegExp;
|
|
6404
|
+
}
|
|
6405
|
+
/**
|
|
6406
|
+
* Walks every `*.md` file under the configured docs root and
|
|
6407
|
+
* returns one record per inline-code symbol mention.
|
|
6408
|
+
*
|
|
6409
|
+
* The walker is AST-based — markdown is parsed with
|
|
6410
|
+
* `mdast-util-from-markdown` and only `inlineCode` nodes are
|
|
6411
|
+
* inspected. This means fenced code blocks, indented code blocks,
|
|
6412
|
+
* and HTML comments are skipped natively and never produce false
|
|
6413
|
+
* positives. Mentions inside link text or list items are
|
|
6414
|
+
* extracted normally.
|
|
6415
|
+
*
|
|
6416
|
+
* Candidates are filtered with the configured `symbolPattern`
|
|
6417
|
+
* (defaults to TS-identifier shapes — camelCase, PascalCase,
|
|
6418
|
+
* UPPER_SNAKE_CASE) so prose tokens like flags, file paths, or
|
|
6419
|
+
* multi-word phrases never appear in the report.
|
|
6420
|
+
*
|
|
6421
|
+
* @param options - Extraction options. All fields are optional;
|
|
6422
|
+
* pass an empty object to use defaults.
|
|
6423
|
+
*/
|
|
6424
|
+
declare function extractDocReferences(options?: ExtractDocReferencesOptions): Array<DocReferenceRecord>;
|
|
6425
|
+
|
|
6332
6426
|
/**
|
|
6333
6427
|
* One row in the TSDoc-coverage report — describes a single public
|
|
6334
6428
|
* symbol exported (transitively) from the package's entry point and
|
|
@@ -8292,7 +8386,7 @@ interface StarlightProjectOptions extends AstroProjectOptions {
|
|
|
8292
8386
|
readonly sharpVersion?: string;
|
|
8293
8387
|
/**
|
|
8294
8388
|
* Emit sample Starlight content (`src/content/docs/index.mdx`,
|
|
8295
|
-
* `src/content
|
|
8389
|
+
* `src/content.config.ts`).
|
|
8296
8390
|
*
|
|
8297
8391
|
* @default false
|
|
8298
8392
|
*/
|
|
@@ -8347,4 +8441,4 @@ declare const COMPLETE_JOB_ID = "complete";
|
|
|
8347
8441
|
*/
|
|
8348
8442
|
declare function addBuildCompleteJob(buildWorkflow: BuildWorkflow): void;
|
|
8349
8443
|
|
|
8350
|
-
export { AGENT_MODEL, AGENT_PLATFORM, AGENT_RULE_SCOPE, AGENT_TIER_ROLES, AGENT_TIER_VALUES, AgentConfig, type AgentConfigOptions, type AgentExpansionRules, type AgentFeaturesConfig, type AgentModel, type AgentPathsConfig, type AgentPlatform, type AgentPlatformOverrides, type AgentProcedure, type AgentRule, type AgentRuleBundle, type AgentRuleScope, type AgentSkill, type AgentSubAgent, type AgentSubAgentPlatformOverrides, type AgentTier, type AgentTierConfig, type AgentTierEntry, type AnalyzeTsDocCoverageOptions, ApiExtractor, type ApiExtractorOptions, type ApiExtractorReportOptions, type ApproveMergeUpgradeOptions, AstroConfig, type AstroConfigOptions, type AstroIntegrationSpec, AstroOutput, AstroProject, type AstroProjectOptions, type AwsAccount, AwsCdkProject, type AwsCdkProjectOptions, AwsDeployWorkflow, AwsDeploymentConfig, AwsDeploymentTarget, type AwsDeploymentTargetOptions, type AwsLocalDeploymentConfig, type AwsOrganization, type AwsRegion, AwsTeardownWorkflow, type AwsTeardownWorkflowOptions, BUILT_IN_BUNDLES, CLAUDE_RULE_TARGET, COMPLETE_JOB_ID, type CiDeploymentConfig, type ClassTypeOptions, type ClaudeAutoModeConfig, type ClaudeHookAction, type ClaudeHookEntry, type ClaudeHooksConfig, type ClaudePermissionsConfig, type ClaudeRuleTarget, type ClaudeSandboxConfig, type ClaudeSettingsConfig, type CopilotHandoff, type CursorHookAction, type CursorHooksConfig, type CursorSettingsConfig, type CustomDocSection, DEFAULT_AC_THRESHOLDS, DEFAULT_AGENT_PATHS, DEFAULT_AGENT_TIERS, DEFAULT_API_EXTRACTOR_CONFIG_FILE, DEFAULT_API_EXTRACTOR_ENTRY_POINT, DEFAULT_API_EXTRACTOR_REPORT_FILENAME, DEFAULT_API_EXTRACTOR_REPORT_FOLDER, DEFAULT_DECOMPOSITION_TEMPLATE, DEFAULT_DELEGATE_TO_PR_REVIEWER, DEFAULT_DISPATCH_MODEL, DEFAULT_DISPATCH_TO_HOUSEKEEPING_RATIO, DEFAULT_HOUSEKEEPING_MODEL, DEFAULT_ISSUE_TEMPLATES_BUNDLE_PATH_PATTERNS, DEFAULT_ISSUE_TEMPLATES_EMIT_CHECKER, DEFAULT_ISSUE_TEMPLATES_EMIT_STARTER, DEFAULT_ISSUE_TEMPLATES_ENABLED, DEFAULT_ISSUE_TEMPLATES_PATH, DEFAULT_ISSUE_TEMPLATES_REQUIRE_REFERENCE, DEFAULT_MERGE_METHOD, DEFAULT_OFF_PEAK_CRON_EXAMPLE, DEFAULT_PARTIAL_UNBLOCK_COMMENT_TEMPLATE, DEFAULT_PRIORITY_LABELS, DEFAULT_PRODUCT_CONTEXT_PATH, DEFAULT_PROGRESS_FILES_ENABLED, DEFAULT_PROGRESS_FILES_FILENAME_PATTERN, DEFAULT_PROGRESS_FILES_FORMAT, DEFAULT_PROGRESS_FILES_STALE_AFTER_HOURS, DEFAULT_PROGRESS_FILES_STATE_DIR, DEFAULT_REQUIRE_LINKED_ISSUE, DEFAULT_REQUIRE_PRODUCT_CONTEXT, DEFAULT_SCHEDULED_TASKS_ROOT, DEFAULT_SCHEDULED_TASK_ENTRIES, DEFAULT_SHARED_EDITING_CONFLICT_STRATEGY, DEFAULT_SHARED_EDITING_EMIT_HELPER, DEFAULT_SHARED_EDITING_ENABLED, DEFAULT_SHARED_EDITING_VERIFY_COMMIT, DEFAULT_SHARED_INDEX_PATHS, DEFAULT_SKILL_EVALS_EMIT_RUNNER, DEFAULT_SKILL_EVALS_ENABLED, DEFAULT_SKILL_EVALS_SKILLS_ROOT, DEFAULT_SOURCES_THRESHOLDS, DEFAULT_STATE_FILE_PATH, DEFAULT_STATUS_LABELS, DEFAULT_TEARDOWN_BRANCH_PATTERNS, DEFAULT_TYPE_LABELS, DEFAULT_UNBLOCK_COMMENT_TEMPLATE, DEFAULT_UNBLOCK_DEPENDENTS_ENABLED, DEFAULT_WORKFLOW_DIAGRAMS_BUNDLE_PATH_PATTERNS, DEFAULT_WORKFLOW_DIAGRAMS_EMIT_CHECKER, DEFAULT_WORKFLOW_DIAGRAMS_EMIT_STARTER, DEFAULT_WORKFLOW_DIAGRAMS_ENABLED, DEFAULT_WORKFLOW_DIAGRAMS_PATH, DEFAULT_WORKFLOW_DIAGRAMS_REQUIRE_UPDATE, type DeployWorkflowOptions, type DeploymentMetadata, type FocusArea, type FocusAreaMatch, type FocusConfig, type GitBranch, type GitHubBoardMetadata, type GitHubProjectMetadata, type GitHubSprintMetadata, type IDependencyResolver, type IssueTemplatesConfig, JsiiFaker, LAYOUT_ENFORCEMENT, LAYOUT_ROOT_BY_PROJECT_TYPE, type LabelDefinition, type LayoutEnforcement, type LayoutViolation, MCP_TRANSPORT, MERGE_METHODS, MIMIMUM_RELEASE_AGE, MINIMUM_RELEASE_AGE, MONOREPO_LAYOUT, type McpServerConfig, type McpTransport, type MeetingArea, type MeetingScope, type MeetingType, type MeetingTypeKind, type MeetingsConfig, type MergeMethod, type MonorepoLayoutRoot, MonorepoProject, type MonorepoProjectOptions, type OrganizationMetadata, PREFLIGHT_MERGE_METHOD_VALUES, PROD_DEPLOY_NAME, PROGRESS_FILES_FORMAT_VALUES, PnpmWorkspace, type PnpmWorkspaceOptions, type PreflightMergeMethod, type PreflightPrConfig, type PriorityRule, type ProgressFilesConfig, ProjectMetadata, type ProjectMetadataOptions, REQUIREMENTS_WRITER_PATHS, ROOT_CI_TASK_NAME, ROOT_TURBO_TASK_NAME, type RemoteCacheOptions, type RepositoryMetadata, ResetTask, type ResetTaskOptions, type ResolvedAgentPaths, type ResolvedAgentTier, type ResolvedIssueTemplates, type ResolvedPreflightPr, type ResolvedProgressFiles, type ResolvedProjectMetadata, type ResolvedRunRatio, type ResolvedScheduledTask, type ResolvedScheduledTasks, type ResolvedScopeGate, type ResolvedSharedEditing, type ResolvedSkillEvals, type ResolvedUnblockDependents, type ResolvedWorkflowDiagrams, type RunRatioConfig, SCHEDULED_TASK_MODEL_VALUES, SCOPE_CLASS_VALUES, SHARED_EDITING_CONFLICT_STRATEGY_VALUES, STARLIGHT_ROLE, type ScheduledTaskEntry, type ScheduledTaskModel, type ScheduledTaskOverride, type ScheduledTasksConfig, type ScopeClass, type ScopeGateConfig, type ScopeGateThresholds, type SharedEditingConfig, type SkillEvalsConfig, type SlackMetadata, type SourceTierExamples, type StarlightEditLink, type StarlightLogo, StarlightProject, type StarlightProjectOptions, type StarlightRole, type StarlightSidebarItem, type StarlightSingletonViolation, type StarlightSocialLink, type SyncLabelsOptions, type TemplateResolveResult, TestRunner, TsDocCoverageKind, type TsDocCoverageRecord, TurboRepo, type TurboRepoOptions, TurboRepoTask, type TurboRepoTaskOptions, TypeScriptConfig, TypeScriptProject, type TypeScriptProjectOptions, UNKNOWN_TYPE_FALLBACK_TIER, type UnblockDependentsConfig, VERSION, VERSION_KEYS_SKIP, VERSION_NPM_PACKAGES, VSCodeConfig, type VersionKey, Vitest, type VitestConfigOptions, type VitestOptions, type WorkflowDiagramsConfig, addApproveMergeUpgradeWorkflow, addBuildCompleteJob, addSyncLabelsWorkflow, agendaBundle, analyzeTsDocCoverage, awsCdkBundle, baseBundle, bcmWriterBundle, buildBaseBundle, buildBcmWriterBundle, buildBuiltInBundles, buildBusinessModelsBundle, buildCheckBlockedProcedure, buildCompanyProfileBundle, buildCustomerProfileBundle, buildDocsSyncBundle, buildIndustryDiscoveryBundle, buildMaintenanceAuditBundle, buildOrchestratorConventionsContent, buildPeopleProfileBundle, buildRegulatoryResearchBundle, buildRequirementsAnalystBundle, buildRequirementsReviewerBundle, buildRequirementsWriterBundle, buildResearchPipelineBundle, buildSoftwareProfileBundle, buildStandardsResearchBundle, buildUnblockDependentsProcedure, businessModelsBundle, classifyIssueScope, classifyRun, companyProfileBundle, customerProfileBundle, docsSyncBundle, extractApiProcedure, formatLayoutViolation, formatStarlightSingletonViolation, getLatestEligibleVersion, githubWorkflowBundle, industryDiscoveryBundle, jestBundle, maintenanceAuditBundle, meetingAnalysisBundle, orchestratorBundle, peopleProfileBundle, pnpmBundle, prReviewBundle, projenBundle, regulatoryResearchBundle, renderAgentTierCaseStatement, renderAgentTierSection, renderCustomDocSectionBlock, renderCustomDocSections, renderExtractApiProcedure, renderFocusSection, renderIssueTemplatesBundleHook, renderIssueTemplatesCheckerScript, renderIssueTemplatesRuleContent, renderIssueTemplatesStarterPage, renderMeetingTypesSection, renderPreflightPrSection, renderPreflightPrShellHelpers, renderPriorityRulesSection, renderProgressFileName, renderProgressFilePath, renderProgressFilesBundleHook, renderProgressFilesRuleContent, renderRunRatioSection, renderRunRatioShellHelpers, renderScheduledTaskSkillFile, renderScheduledTasksSection, renderScopeGateSection, renderScopeGateShellHelpers, renderSharedEditingBundleHook, renderSharedEditingHelperScript, renderSharedEditingRuleContent, renderSkillEvalsBundleHook, renderSkillEvalsRuleContent, renderSkillEvalsRunnerScript, renderSourceTierExamples, renderUnblockDependentsScript, renderUnblockDependentsSection, renderWorkflowDiagramsBundleHook, renderWorkflowDiagramsCheckerScript, renderWorkflowDiagramsRuleContent, renderWorkflowDiagramsStarterPage, requirementsAnalystBundle, requirementsReviewerBundle, requirementsWriterBundle, researchPipelineBundle, resolveAgentPaths, resolveAgentTiers, resolveAstroProjectOutdir, resolveAwsCdkProjectOutdir, resolveIssueTemplates, resolveModelAlias, resolveOrchestratorAssets, resolveOutdirFromPackageName, resolvePreflightPr, resolveProgressFiles, resolveRunRatio, resolveScheduledTasks, resolveScopeGate, resolveSharedEditing, resolveSkillEvals, resolveTemplateVariables, resolveTypeScriptProjectOutdir, resolveUnblockDependents, resolveWorkflowDiagrams, slackBundle, softwareProfileBundle, standardsResearchBundle, turborepoBundle, typescriptBundle, validateAgentTierConfig, validateIssueTemplatesConfig, validateMonorepoLayout, validatePreflightPrConfig, validateProgressFilesConfig, validateRunRatioConfig, validateScheduledTasksConfig, validateScopeGateConfig, validateSharedEditingConfig, validateSkillEvalsConfig, validateStarlightSingleton, validateUnblockDependentsConfig, validateWorkflowDiagramsConfig, vitestBundle };
|
|
8444
|
+
export { AGENT_MODEL, AGENT_PLATFORM, AGENT_RULE_SCOPE, AGENT_TIER_ROLES, AGENT_TIER_VALUES, AgentConfig, type AgentConfigOptions, type AgentExpansionRules, type AgentFeaturesConfig, type AgentModel, type AgentPathsConfig, type AgentPlatform, type AgentPlatformOverrides, type AgentProcedure, type AgentRule, type AgentRuleBundle, type AgentRuleScope, type AgentSkill, type AgentSubAgent, type AgentSubAgentPlatformOverrides, type AgentTier, type AgentTierConfig, type AgentTierEntry, type AnalyzeTsDocCoverageOptions, ApiExtractor, type ApiExtractorOptions, type ApiExtractorReportOptions, type ApproveMergeUpgradeOptions, AstroConfig, type AstroConfigOptions, type AstroIntegrationSpec, AstroOutput, AstroProject, type AstroProjectOptions, type AwsAccount, AwsCdkProject, type AwsCdkProjectOptions, AwsDeployWorkflow, AwsDeploymentConfig, AwsDeploymentTarget, type AwsDeploymentTargetOptions, type AwsLocalDeploymentConfig, type AwsOrganization, type AwsRegion, AwsTeardownWorkflow, type AwsTeardownWorkflowOptions, BUILT_IN_BUNDLES, CLAUDE_RULE_TARGET, COMPLETE_JOB_ID, type CiDeploymentConfig, type ClassTypeOptions, type ClaudeAutoModeConfig, type ClaudeHookAction, type ClaudeHookEntry, type ClaudeHooksConfig, type ClaudePermissionsConfig, type ClaudeRuleTarget, type ClaudeSandboxConfig, type ClaudeSettingsConfig, type CopilotHandoff, type CursorHookAction, type CursorHooksConfig, type CursorSettingsConfig, type CustomDocSection, DEFAULT_AC_THRESHOLDS, DEFAULT_AGENT_PATHS, DEFAULT_AGENT_TIERS, DEFAULT_API_EXTRACTOR_CONFIG_FILE, DEFAULT_API_EXTRACTOR_ENTRY_POINT, DEFAULT_API_EXTRACTOR_REPORT_FILENAME, DEFAULT_API_EXTRACTOR_REPORT_FOLDER, DEFAULT_DECOMPOSITION_TEMPLATE, DEFAULT_DELEGATE_TO_PR_REVIEWER, DEFAULT_DISPATCH_MODEL, DEFAULT_DISPATCH_TO_HOUSEKEEPING_RATIO, DEFAULT_HOUSEKEEPING_MODEL, DEFAULT_ISSUE_TEMPLATES_BUNDLE_PATH_PATTERNS, DEFAULT_ISSUE_TEMPLATES_EMIT_CHECKER, DEFAULT_ISSUE_TEMPLATES_EMIT_STARTER, DEFAULT_ISSUE_TEMPLATES_ENABLED, DEFAULT_ISSUE_TEMPLATES_PATH, DEFAULT_ISSUE_TEMPLATES_REQUIRE_REFERENCE, DEFAULT_MERGE_METHOD, DEFAULT_OFF_PEAK_CRON_EXAMPLE, DEFAULT_PARTIAL_UNBLOCK_COMMENT_TEMPLATE, DEFAULT_PRIORITY_LABELS, DEFAULT_PRODUCT_CONTEXT_PATH, DEFAULT_PROGRESS_FILES_ENABLED, DEFAULT_PROGRESS_FILES_FILENAME_PATTERN, DEFAULT_PROGRESS_FILES_FORMAT, DEFAULT_PROGRESS_FILES_STALE_AFTER_HOURS, DEFAULT_PROGRESS_FILES_STATE_DIR, DEFAULT_REQUIRE_LINKED_ISSUE, DEFAULT_REQUIRE_PRODUCT_CONTEXT, DEFAULT_SCHEDULED_TASKS_ROOT, DEFAULT_SCHEDULED_TASK_ENTRIES, DEFAULT_SHARED_EDITING_CONFLICT_STRATEGY, DEFAULT_SHARED_EDITING_EMIT_HELPER, DEFAULT_SHARED_EDITING_ENABLED, DEFAULT_SHARED_EDITING_VERIFY_COMMIT, DEFAULT_SHARED_INDEX_PATHS, DEFAULT_SKILL_EVALS_EMIT_RUNNER, DEFAULT_SKILL_EVALS_ENABLED, DEFAULT_SKILL_EVALS_SKILLS_ROOT, DEFAULT_SOURCES_THRESHOLDS, DEFAULT_STATE_FILE_PATH, DEFAULT_STATUS_LABELS, DEFAULT_TEARDOWN_BRANCH_PATTERNS, DEFAULT_TYPE_LABELS, DEFAULT_UNBLOCK_COMMENT_TEMPLATE, DEFAULT_UNBLOCK_DEPENDENTS_ENABLED, DEFAULT_WORKFLOW_DIAGRAMS_BUNDLE_PATH_PATTERNS, DEFAULT_WORKFLOW_DIAGRAMS_EMIT_CHECKER, DEFAULT_WORKFLOW_DIAGRAMS_EMIT_STARTER, DEFAULT_WORKFLOW_DIAGRAMS_ENABLED, DEFAULT_WORKFLOW_DIAGRAMS_PATH, DEFAULT_WORKFLOW_DIAGRAMS_REQUIRE_UPDATE, type DeployWorkflowOptions, type DeploymentMetadata, type DocReferenceRecord, type ExtractDocReferencesOptions, type FocusArea, type FocusAreaMatch, type FocusConfig, type GitBranch, type GitHubBoardMetadata, type GitHubProjectMetadata, type GitHubSprintMetadata, type IDependencyResolver, type IssueTemplatesConfig, JsiiFaker, LAYOUT_ENFORCEMENT, LAYOUT_ROOT_BY_PROJECT_TYPE, type LabelDefinition, type LayoutEnforcement, type LayoutViolation, MCP_TRANSPORT, MERGE_METHODS, MIMIMUM_RELEASE_AGE, MINIMUM_RELEASE_AGE, MONOREPO_LAYOUT, type McpServerConfig, type McpTransport, type MeetingArea, type MeetingScope, type MeetingType, type MeetingTypeKind, type MeetingsConfig, type MergeMethod, type MonorepoLayoutRoot, MonorepoProject, type MonorepoProjectOptions, type OrganizationMetadata, PREFLIGHT_MERGE_METHOD_VALUES, PROD_DEPLOY_NAME, PROGRESS_FILES_FORMAT_VALUES, PnpmWorkspace, type PnpmWorkspaceOptions, type PreflightMergeMethod, type PreflightPrConfig, type PriorityRule, type ProgressFilesConfig, ProjectMetadata, type ProjectMetadataOptions, REQUIREMENTS_WRITER_PATHS, ROOT_CI_TASK_NAME, ROOT_TURBO_TASK_NAME, type RemoteCacheOptions, type RepositoryMetadata, ResetTask, type ResetTaskOptions, type ResolvedAgentPaths, type ResolvedAgentTier, type ResolvedIssueTemplates, type ResolvedPreflightPr, type ResolvedProgressFiles, type ResolvedProjectMetadata, type ResolvedRunRatio, type ResolvedScheduledTask, type ResolvedScheduledTasks, type ResolvedScopeGate, type ResolvedSharedEditing, type ResolvedSkillEvals, type ResolvedUnblockDependents, type ResolvedWorkflowDiagrams, type RunRatioConfig, SCHEDULED_TASK_MODEL_VALUES, SCOPE_CLASS_VALUES, SHARED_EDITING_CONFLICT_STRATEGY_VALUES, STARLIGHT_ROLE, type ScheduledTaskEntry, type ScheduledTaskModel, type ScheduledTaskOverride, type ScheduledTasksConfig, type ScopeClass, type ScopeGateConfig, type ScopeGateThresholds, type SharedEditingConfig, type SkillEvalsConfig, type SlackMetadata, type SourceTierExamples, type StarlightEditLink, type StarlightLogo, StarlightProject, type StarlightProjectOptions, type StarlightRole, type StarlightSidebarItem, type StarlightSingletonViolation, type StarlightSocialLink, type SyncLabelsOptions, type TemplateResolveResult, TestRunner, TsDocCoverageKind, type TsDocCoverageRecord, TurboRepo, type TurboRepoOptions, TurboRepoTask, type TurboRepoTaskOptions, TypeScriptConfig, TypeScriptProject, type TypeScriptProjectOptions, UNKNOWN_TYPE_FALLBACK_TIER, type UnblockDependentsConfig, VERSION, VERSION_KEYS_SKIP, VERSION_NPM_PACKAGES, VSCodeConfig, type VersionKey, Vitest, type VitestConfigOptions, type VitestOptions, type WorkflowDiagramsConfig, addApproveMergeUpgradeWorkflow, addBuildCompleteJob, addSyncLabelsWorkflow, agendaBundle, analyzeTsDocCoverage, awsCdkBundle, baseBundle, bcmWriterBundle, buildBaseBundle, buildBcmWriterBundle, buildBuiltInBundles, buildBusinessModelsBundle, buildCheckBlockedProcedure, buildCompanyProfileBundle, buildCustomerProfileBundle, buildDocsSyncBundle, buildIndustryDiscoveryBundle, buildMaintenanceAuditBundle, buildOrchestratorConventionsContent, buildPeopleProfileBundle, buildRegulatoryResearchBundle, buildRequirementsAnalystBundle, buildRequirementsReviewerBundle, buildRequirementsWriterBundle, buildResearchPipelineBundle, buildSoftwareProfileBundle, buildStandardsResearchBundle, buildUnblockDependentsProcedure, businessModelsBundle, classifyIssueScope, classifyRun, companyProfileBundle, customerProfileBundle, docsSyncBundle, extractApiProcedure, extractDocReferences, formatLayoutViolation, formatStarlightSingletonViolation, getLatestEligibleVersion, githubWorkflowBundle, industryDiscoveryBundle, jestBundle, maintenanceAuditBundle, meetingAnalysisBundle, orchestratorBundle, peopleProfileBundle, pnpmBundle, prReviewBundle, projenBundle, regulatoryResearchBundle, renderAgentTierCaseStatement, renderAgentTierSection, renderCustomDocSectionBlock, renderCustomDocSections, renderExtractApiProcedure, renderFocusSection, renderIssueTemplatesBundleHook, renderIssueTemplatesCheckerScript, renderIssueTemplatesRuleContent, renderIssueTemplatesStarterPage, renderMeetingTypesSection, renderPreflightPrSection, renderPreflightPrShellHelpers, renderPriorityRulesSection, renderProgressFileName, renderProgressFilePath, renderProgressFilesBundleHook, renderProgressFilesRuleContent, renderRunRatioSection, renderRunRatioShellHelpers, renderScheduledTaskSkillFile, renderScheduledTasksSection, renderScopeGateSection, renderScopeGateShellHelpers, renderSharedEditingBundleHook, renderSharedEditingHelperScript, renderSharedEditingRuleContent, renderSkillEvalsBundleHook, renderSkillEvalsRuleContent, renderSkillEvalsRunnerScript, renderSourceTierExamples, renderUnblockDependentsScript, renderUnblockDependentsSection, renderWorkflowDiagramsBundleHook, renderWorkflowDiagramsCheckerScript, renderWorkflowDiagramsRuleContent, renderWorkflowDiagramsStarterPage, requirementsAnalystBundle, requirementsReviewerBundle, requirementsWriterBundle, researchPipelineBundle, resolveAgentPaths, resolveAgentTiers, resolveAstroProjectOutdir, resolveAwsCdkProjectOutdir, resolveIssueTemplates, resolveModelAlias, resolveOrchestratorAssets, resolveOutdirFromPackageName, resolvePreflightPr, resolveProgressFiles, resolveRunRatio, resolveScheduledTasks, resolveScopeGate, resolveSharedEditing, resolveSkillEvals, resolveTemplateVariables, resolveTypeScriptProjectOutdir, resolveUnblockDependents, resolveWorkflowDiagrams, slackBundle, softwareProfileBundle, standardsResearchBundle, turborepoBundle, typescriptBundle, validateAgentTierConfig, validateIssueTemplatesConfig, validateMonorepoLayout, validatePreflightPrConfig, validateProgressFilesConfig, validateRunRatioConfig, validateScheduledTasksConfig, validateScopeGateConfig, validateSharedEditingConfig, validateSkillEvalsConfig, validateStarlightSingleton, validateUnblockDependentsConfig, validateWorkflowDiagramsConfig, vitestBundle };
|
package/lib/index.d.ts
CHANGED
|
@@ -6378,6 +6378,100 @@ interface AwsOrganization {
|
|
|
6378
6378
|
accounts: Array<AwsAccount>;
|
|
6379
6379
|
}
|
|
6380
6380
|
|
|
6381
|
+
/**
|
|
6382
|
+
* One row in the doc reference-extraction report — describes a single
|
|
6383
|
+
* inline-code symbol mention found in a markdown page and whether
|
|
6384
|
+
* that symbol is present in the supplied `knownSymbols` list.
|
|
6385
|
+
*/
|
|
6386
|
+
interface DocReferenceRecord {
|
|
6387
|
+
/**
|
|
6388
|
+
* Path to the markdown file the mention was found in. Resolved
|
|
6389
|
+
* relative to the configured `docsRoot` so reports are stable
|
|
6390
|
+
* across machines (no absolute prefixes leak through).
|
|
6391
|
+
*/
|
|
6392
|
+
readonly docPath: string;
|
|
6393
|
+
/**
|
|
6394
|
+
* 1-indexed line number of the inline-code span in the markdown
|
|
6395
|
+
* source.
|
|
6396
|
+
*/
|
|
6397
|
+
readonly line: number;
|
|
6398
|
+
/**
|
|
6399
|
+
* 1-indexed column where the inline-code span starts (the position
|
|
6400
|
+
* of the opening backtick).
|
|
6401
|
+
*/
|
|
6402
|
+
readonly column: number;
|
|
6403
|
+
/**
|
|
6404
|
+
* The exact symbol text inside the backticks, e.g. `analyzeTsDocCoverage`.
|
|
6405
|
+
* Whitespace inside the inline-code span is preserved as-is and
|
|
6406
|
+
* the candidate is included only when it matches the configured
|
|
6407
|
+
* identifier pattern.
|
|
6408
|
+
*/
|
|
6409
|
+
readonly symbol: string;
|
|
6410
|
+
/**
|
|
6411
|
+
* `true` when the symbol appears in the supplied `knownSymbols`
|
|
6412
|
+
* set. The downstream scan phase (#519) treats `false` as an
|
|
6413
|
+
* orphan reference candidate (advisory).
|
|
6414
|
+
*/
|
|
6415
|
+
readonly isKnown: boolean;
|
|
6416
|
+
}
|
|
6417
|
+
/**
|
|
6418
|
+
* Options accepted by {@link extractDocReferences}.
|
|
6419
|
+
*/
|
|
6420
|
+
interface ExtractDocReferencesOptions {
|
|
6421
|
+
/**
|
|
6422
|
+
* Absolute path to the docs root that should be walked for
|
|
6423
|
+
* `*.md` files. Defaults to `docs/src/content/docs/` relative
|
|
6424
|
+
* to the current working directory when omitted.
|
|
6425
|
+
*
|
|
6426
|
+
* @default "docs/src/content/docs"
|
|
6427
|
+
*/
|
|
6428
|
+
readonly docsRoot?: string;
|
|
6429
|
+
/**
|
|
6430
|
+
* List of known public symbols to cross-index inline-code
|
|
6431
|
+
* mentions against. Typically the `symbol` column of the
|
|
6432
|
+
* report returned by `analyzeTsDocCoverage()` plus, optionally,
|
|
6433
|
+
* any extra names sourced from the api-extractor `.api.md`
|
|
6434
|
+
* rollup. Order is irrelevant; duplicates are deduplicated.
|
|
6435
|
+
*/
|
|
6436
|
+
readonly knownSymbols?: ReadonlyArray<string>;
|
|
6437
|
+
/**
|
|
6438
|
+
* Regular expression a candidate must match to be considered a
|
|
6439
|
+
* TypeScript-identifier-shaped symbol. The default rejects
|
|
6440
|
+
* obvious non-symbol prose tokens (paths with slashes, prose
|
|
6441
|
+
* with spaces, lowercase one-letter words) while accepting the
|
|
6442
|
+
* three common identifier shapes used in the monorepo:
|
|
6443
|
+
* camelCase (`analyzeTsDocCoverage`), PascalCase
|
|
6444
|
+
* (`TsDocCoverageRecord`), and UPPER_SNAKE_CASE (`MAX_RETRIES`).
|
|
6445
|
+
*
|
|
6446
|
+
* Override this only if a project uses an unusual identifier
|
|
6447
|
+
* style — a custom pattern that is too permissive will produce
|
|
6448
|
+
* a noisy backlog of false positives.
|
|
6449
|
+
*
|
|
6450
|
+
* @default /^(?:[a-z][a-zA-Z0-9]*|[A-Z][a-zA-Z0-9]*|[A-Z][A-Z0-9_]*)$/
|
|
6451
|
+
*/
|
|
6452
|
+
readonly symbolPattern?: RegExp;
|
|
6453
|
+
}
|
|
6454
|
+
/**
|
|
6455
|
+
* Walks every `*.md` file under the configured docs root and
|
|
6456
|
+
* returns one record per inline-code symbol mention.
|
|
6457
|
+
*
|
|
6458
|
+
* The walker is AST-based — markdown is parsed with
|
|
6459
|
+
* `mdast-util-from-markdown` and only `inlineCode` nodes are
|
|
6460
|
+
* inspected. This means fenced code blocks, indented code blocks,
|
|
6461
|
+
* and HTML comments are skipped natively and never produce false
|
|
6462
|
+
* positives. Mentions inside link text or list items are
|
|
6463
|
+
* extracted normally.
|
|
6464
|
+
*
|
|
6465
|
+
* Candidates are filtered with the configured `symbolPattern`
|
|
6466
|
+
* (defaults to TS-identifier shapes — camelCase, PascalCase,
|
|
6467
|
+
* UPPER_SNAKE_CASE) so prose tokens like flags, file paths, or
|
|
6468
|
+
* multi-word phrases never appear in the report.
|
|
6469
|
+
*
|
|
6470
|
+
* @param options - Extraction options. All fields are optional;
|
|
6471
|
+
* pass an empty object to use defaults.
|
|
6472
|
+
*/
|
|
6473
|
+
declare function extractDocReferences(options?: ExtractDocReferencesOptions): Array<DocReferenceRecord>;
|
|
6474
|
+
|
|
6381
6475
|
/**
|
|
6382
6476
|
* One row in the TSDoc-coverage report — describes a single public
|
|
6383
6477
|
* symbol exported (transitively) from the package's entry point and
|
|
@@ -8341,7 +8435,7 @@ interface StarlightProjectOptions extends AstroProjectOptions {
|
|
|
8341
8435
|
readonly sharpVersion?: string;
|
|
8342
8436
|
/**
|
|
8343
8437
|
* Emit sample Starlight content (`src/content/docs/index.mdx`,
|
|
8344
|
-
* `src/content
|
|
8438
|
+
* `src/content.config.ts`).
|
|
8345
8439
|
*
|
|
8346
8440
|
* @default false
|
|
8347
8441
|
*/
|
|
@@ -8396,5 +8490,5 @@ declare const COMPLETE_JOB_ID = "complete";
|
|
|
8396
8490
|
*/
|
|
8397
8491
|
declare function addBuildCompleteJob(buildWorkflow: BuildWorkflow): void;
|
|
8398
8492
|
|
|
8399
|
-
export { AGENT_MODEL, AGENT_PLATFORM, AGENT_RULE_SCOPE, AGENT_TIER_ROLES, AGENT_TIER_VALUES, AgentConfig, ApiExtractor, AstroConfig, AstroOutput, AstroProject, AwsCdkProject, AwsDeployWorkflow, AwsDeploymentConfig, AwsDeploymentTarget, AwsTeardownWorkflow, BUILT_IN_BUNDLES, CLAUDE_RULE_TARGET, COMPLETE_JOB_ID, DEFAULT_AC_THRESHOLDS, DEFAULT_AGENT_PATHS, DEFAULT_AGENT_TIERS, DEFAULT_API_EXTRACTOR_CONFIG_FILE, DEFAULT_API_EXTRACTOR_ENTRY_POINT, DEFAULT_API_EXTRACTOR_REPORT_FILENAME, DEFAULT_API_EXTRACTOR_REPORT_FOLDER, DEFAULT_DECOMPOSITION_TEMPLATE, DEFAULT_DELEGATE_TO_PR_REVIEWER, DEFAULT_DISPATCH_MODEL, DEFAULT_DISPATCH_TO_HOUSEKEEPING_RATIO, DEFAULT_HOUSEKEEPING_MODEL, DEFAULT_ISSUE_TEMPLATES_BUNDLE_PATH_PATTERNS, DEFAULT_ISSUE_TEMPLATES_EMIT_CHECKER, DEFAULT_ISSUE_TEMPLATES_EMIT_STARTER, DEFAULT_ISSUE_TEMPLATES_ENABLED, DEFAULT_ISSUE_TEMPLATES_PATH, DEFAULT_ISSUE_TEMPLATES_REQUIRE_REFERENCE, DEFAULT_MERGE_METHOD, DEFAULT_OFF_PEAK_CRON_EXAMPLE, DEFAULT_PARTIAL_UNBLOCK_COMMENT_TEMPLATE, DEFAULT_PRIORITY_LABELS, DEFAULT_PRODUCT_CONTEXT_PATH, DEFAULT_PROGRESS_FILES_ENABLED, DEFAULT_PROGRESS_FILES_FILENAME_PATTERN, DEFAULT_PROGRESS_FILES_FORMAT, DEFAULT_PROGRESS_FILES_STALE_AFTER_HOURS, DEFAULT_PROGRESS_FILES_STATE_DIR, DEFAULT_REQUIRE_LINKED_ISSUE, DEFAULT_REQUIRE_PRODUCT_CONTEXT, DEFAULT_SCHEDULED_TASKS_ROOT, DEFAULT_SCHEDULED_TASK_ENTRIES, DEFAULT_SHARED_EDITING_CONFLICT_STRATEGY, DEFAULT_SHARED_EDITING_EMIT_HELPER, DEFAULT_SHARED_EDITING_ENABLED, DEFAULT_SHARED_EDITING_VERIFY_COMMIT, DEFAULT_SHARED_INDEX_PATHS, DEFAULT_SKILL_EVALS_EMIT_RUNNER, DEFAULT_SKILL_EVALS_ENABLED, DEFAULT_SKILL_EVALS_SKILLS_ROOT, DEFAULT_SOURCES_THRESHOLDS, DEFAULT_STATE_FILE_PATH, DEFAULT_STATUS_LABELS, DEFAULT_TEARDOWN_BRANCH_PATTERNS, DEFAULT_TYPE_LABELS, DEFAULT_UNBLOCK_COMMENT_TEMPLATE, DEFAULT_UNBLOCK_DEPENDENTS_ENABLED, DEFAULT_WORKFLOW_DIAGRAMS_BUNDLE_PATH_PATTERNS, DEFAULT_WORKFLOW_DIAGRAMS_EMIT_CHECKER, DEFAULT_WORKFLOW_DIAGRAMS_EMIT_STARTER, DEFAULT_WORKFLOW_DIAGRAMS_ENABLED, DEFAULT_WORKFLOW_DIAGRAMS_PATH, DEFAULT_WORKFLOW_DIAGRAMS_REQUIRE_UPDATE, JsiiFaker, LAYOUT_ENFORCEMENT, LAYOUT_ROOT_BY_PROJECT_TYPE, MCP_TRANSPORT, MERGE_METHODS, MIMIMUM_RELEASE_AGE, MINIMUM_RELEASE_AGE, MONOREPO_LAYOUT, MonorepoProject, PREFLIGHT_MERGE_METHOD_VALUES, PROD_DEPLOY_NAME, PROGRESS_FILES_FORMAT_VALUES, PnpmWorkspace, ProjectMetadata, REQUIREMENTS_WRITER_PATHS, ROOT_CI_TASK_NAME, ROOT_TURBO_TASK_NAME, ResetTask, SCHEDULED_TASK_MODEL_VALUES, SCOPE_CLASS_VALUES, SHARED_EDITING_CONFLICT_STRATEGY_VALUES, STARLIGHT_ROLE, StarlightProject, TestRunner, TsDocCoverageKind, TurboRepo, TurboRepoTask, TypeScriptConfig, TypeScriptProject, UNKNOWN_TYPE_FALLBACK_TIER, VERSION, VERSION_KEYS_SKIP, VERSION_NPM_PACKAGES, VSCodeConfig, Vitest, addApproveMergeUpgradeWorkflow, addBuildCompleteJob, addSyncLabelsWorkflow, agendaBundle, analyzeTsDocCoverage, awsCdkBundle, baseBundle, bcmWriterBundle, buildBaseBundle, buildBcmWriterBundle, buildBuiltInBundles, buildBusinessModelsBundle, buildCheckBlockedProcedure, buildCompanyProfileBundle, buildCustomerProfileBundle, buildDocsSyncBundle, buildIndustryDiscoveryBundle, buildMaintenanceAuditBundle, buildOrchestratorConventionsContent, buildPeopleProfileBundle, buildRegulatoryResearchBundle, buildRequirementsAnalystBundle, buildRequirementsReviewerBundle, buildRequirementsWriterBundle, buildResearchPipelineBundle, buildSoftwareProfileBundle, buildStandardsResearchBundle, buildUnblockDependentsProcedure, businessModelsBundle, classifyIssueScope, classifyRun, companyProfileBundle, customerProfileBundle, docsSyncBundle, extractApiProcedure, formatLayoutViolation, formatStarlightSingletonViolation, getLatestEligibleVersion, githubWorkflowBundle, industryDiscoveryBundle, jestBundle, maintenanceAuditBundle, meetingAnalysisBundle, orchestratorBundle, peopleProfileBundle, pnpmBundle, prReviewBundle, projenBundle, regulatoryResearchBundle, renderAgentTierCaseStatement, renderAgentTierSection, renderCustomDocSectionBlock, renderCustomDocSections, renderExtractApiProcedure, renderFocusSection, renderIssueTemplatesBundleHook, renderIssueTemplatesCheckerScript, renderIssueTemplatesRuleContent, renderIssueTemplatesStarterPage, renderMeetingTypesSection, renderPreflightPrSection, renderPreflightPrShellHelpers, renderPriorityRulesSection, renderProgressFileName, renderProgressFilePath, renderProgressFilesBundleHook, renderProgressFilesRuleContent, renderRunRatioSection, renderRunRatioShellHelpers, renderScheduledTaskSkillFile, renderScheduledTasksSection, renderScopeGateSection, renderScopeGateShellHelpers, renderSharedEditingBundleHook, renderSharedEditingHelperScript, renderSharedEditingRuleContent, renderSkillEvalsBundleHook, renderSkillEvalsRuleContent, renderSkillEvalsRunnerScript, renderSourceTierExamples, renderUnblockDependentsScript, renderUnblockDependentsSection, renderWorkflowDiagramsBundleHook, renderWorkflowDiagramsCheckerScript, renderWorkflowDiagramsRuleContent, renderWorkflowDiagramsStarterPage, requirementsAnalystBundle, requirementsReviewerBundle, requirementsWriterBundle, researchPipelineBundle, resolveAgentPaths, resolveAgentTiers, resolveAstroProjectOutdir, resolveAwsCdkProjectOutdir, resolveIssueTemplates, resolveModelAlias, resolveOrchestratorAssets, resolveOutdirFromPackageName, resolvePreflightPr, resolveProgressFiles, resolveRunRatio, resolveScheduledTasks, resolveScopeGate, resolveSharedEditing, resolveSkillEvals, resolveTemplateVariables, resolveTypeScriptProjectOutdir, resolveUnblockDependents, resolveWorkflowDiagrams, slackBundle, softwareProfileBundle, standardsResearchBundle, turborepoBundle, typescriptBundle, validateAgentTierConfig, validateIssueTemplatesConfig, validateMonorepoLayout, validatePreflightPrConfig, validateProgressFilesConfig, validateRunRatioConfig, validateScheduledTasksConfig, validateScopeGateConfig, validateSharedEditingConfig, validateSkillEvalsConfig, validateStarlightSingleton, validateUnblockDependentsConfig, validateWorkflowDiagramsConfig, vitestBundle };
|
|
8400
|
-
export type { AgentConfigOptions, AgentExpansionRules, AgentFeaturesConfig, AgentModel, AgentPathsConfig, AgentPlatform, AgentPlatformOverrides, AgentProcedure, AgentRule, AgentRuleBundle, AgentRuleScope, AgentSkill, AgentSubAgent, AgentSubAgentPlatformOverrides, AgentTier, AgentTierConfig, AgentTierEntry, AnalyzeTsDocCoverageOptions, ApiExtractorOptions, ApiExtractorReportOptions, ApproveMergeUpgradeOptions, AstroConfigOptions, AstroIntegrationSpec, AstroProjectOptions, AwsAccount, AwsCdkProjectOptions, AwsDeploymentTargetOptions, AwsLocalDeploymentConfig, AwsOrganization, AwsRegion, AwsTeardownWorkflowOptions, CiDeploymentConfig, ClassTypeOptions, ClaudeAutoModeConfig, ClaudeHookAction, ClaudeHookEntry, ClaudeHooksConfig, ClaudePermissionsConfig, ClaudeRuleTarget, ClaudeSandboxConfig, ClaudeSettingsConfig, CopilotHandoff, CursorHookAction, CursorHooksConfig, CursorSettingsConfig, CustomDocSection, DeployWorkflowOptions, DeploymentMetadata, FocusArea, FocusAreaMatch, FocusConfig, GitBranch, GitHubBoardMetadata, GitHubProjectMetadata, GitHubSprintMetadata, IDependencyResolver, IssueTemplatesConfig, LabelDefinition, LayoutEnforcement, LayoutViolation, McpServerConfig, McpTransport, MeetingArea, MeetingScope, MeetingType, MeetingTypeKind, MeetingsConfig, MergeMethod, MonorepoLayoutRoot, MonorepoProjectOptions, OrganizationMetadata, PnpmWorkspaceOptions, PreflightMergeMethod, PreflightPrConfig, PriorityRule, ProgressFilesConfig, ProjectMetadataOptions, RemoteCacheOptions, RepositoryMetadata, ResetTaskOptions, ResolvedAgentPaths, ResolvedAgentTier, ResolvedIssueTemplates, ResolvedPreflightPr, ResolvedProgressFiles, ResolvedProjectMetadata, ResolvedRunRatio, ResolvedScheduledTask, ResolvedScheduledTasks, ResolvedScopeGate, ResolvedSharedEditing, ResolvedSkillEvals, ResolvedUnblockDependents, ResolvedWorkflowDiagrams, RunRatioConfig, ScheduledTaskEntry, ScheduledTaskModel, ScheduledTaskOverride, ScheduledTasksConfig, ScopeClass, ScopeGateConfig, ScopeGateThresholds, SharedEditingConfig, SkillEvalsConfig, SlackMetadata, SourceTierExamples, StarlightEditLink, StarlightLogo, StarlightProjectOptions, StarlightRole, StarlightSidebarItem, StarlightSingletonViolation, StarlightSocialLink, SyncLabelsOptions, TemplateResolveResult, TsDocCoverageRecord, TurboRepoOptions, TurboRepoTaskOptions, TypeScriptProjectOptions, UnblockDependentsConfig, VersionKey, VitestConfigOptions, VitestOptions, WorkflowDiagramsConfig };
|
|
8493
|
+
export { AGENT_MODEL, AGENT_PLATFORM, AGENT_RULE_SCOPE, AGENT_TIER_ROLES, AGENT_TIER_VALUES, AgentConfig, ApiExtractor, AstroConfig, AstroOutput, AstroProject, AwsCdkProject, AwsDeployWorkflow, AwsDeploymentConfig, AwsDeploymentTarget, AwsTeardownWorkflow, BUILT_IN_BUNDLES, CLAUDE_RULE_TARGET, COMPLETE_JOB_ID, DEFAULT_AC_THRESHOLDS, DEFAULT_AGENT_PATHS, DEFAULT_AGENT_TIERS, DEFAULT_API_EXTRACTOR_CONFIG_FILE, DEFAULT_API_EXTRACTOR_ENTRY_POINT, DEFAULT_API_EXTRACTOR_REPORT_FILENAME, DEFAULT_API_EXTRACTOR_REPORT_FOLDER, DEFAULT_DECOMPOSITION_TEMPLATE, DEFAULT_DELEGATE_TO_PR_REVIEWER, DEFAULT_DISPATCH_MODEL, DEFAULT_DISPATCH_TO_HOUSEKEEPING_RATIO, DEFAULT_HOUSEKEEPING_MODEL, DEFAULT_ISSUE_TEMPLATES_BUNDLE_PATH_PATTERNS, DEFAULT_ISSUE_TEMPLATES_EMIT_CHECKER, DEFAULT_ISSUE_TEMPLATES_EMIT_STARTER, DEFAULT_ISSUE_TEMPLATES_ENABLED, DEFAULT_ISSUE_TEMPLATES_PATH, DEFAULT_ISSUE_TEMPLATES_REQUIRE_REFERENCE, DEFAULT_MERGE_METHOD, DEFAULT_OFF_PEAK_CRON_EXAMPLE, DEFAULT_PARTIAL_UNBLOCK_COMMENT_TEMPLATE, DEFAULT_PRIORITY_LABELS, DEFAULT_PRODUCT_CONTEXT_PATH, DEFAULT_PROGRESS_FILES_ENABLED, DEFAULT_PROGRESS_FILES_FILENAME_PATTERN, DEFAULT_PROGRESS_FILES_FORMAT, DEFAULT_PROGRESS_FILES_STALE_AFTER_HOURS, DEFAULT_PROGRESS_FILES_STATE_DIR, DEFAULT_REQUIRE_LINKED_ISSUE, DEFAULT_REQUIRE_PRODUCT_CONTEXT, DEFAULT_SCHEDULED_TASKS_ROOT, DEFAULT_SCHEDULED_TASK_ENTRIES, DEFAULT_SHARED_EDITING_CONFLICT_STRATEGY, DEFAULT_SHARED_EDITING_EMIT_HELPER, DEFAULT_SHARED_EDITING_ENABLED, DEFAULT_SHARED_EDITING_VERIFY_COMMIT, DEFAULT_SHARED_INDEX_PATHS, DEFAULT_SKILL_EVALS_EMIT_RUNNER, DEFAULT_SKILL_EVALS_ENABLED, DEFAULT_SKILL_EVALS_SKILLS_ROOT, DEFAULT_SOURCES_THRESHOLDS, DEFAULT_STATE_FILE_PATH, DEFAULT_STATUS_LABELS, DEFAULT_TEARDOWN_BRANCH_PATTERNS, DEFAULT_TYPE_LABELS, DEFAULT_UNBLOCK_COMMENT_TEMPLATE, DEFAULT_UNBLOCK_DEPENDENTS_ENABLED, DEFAULT_WORKFLOW_DIAGRAMS_BUNDLE_PATH_PATTERNS, DEFAULT_WORKFLOW_DIAGRAMS_EMIT_CHECKER, DEFAULT_WORKFLOW_DIAGRAMS_EMIT_STARTER, DEFAULT_WORKFLOW_DIAGRAMS_ENABLED, DEFAULT_WORKFLOW_DIAGRAMS_PATH, DEFAULT_WORKFLOW_DIAGRAMS_REQUIRE_UPDATE, JsiiFaker, LAYOUT_ENFORCEMENT, LAYOUT_ROOT_BY_PROJECT_TYPE, MCP_TRANSPORT, MERGE_METHODS, MIMIMUM_RELEASE_AGE, MINIMUM_RELEASE_AGE, MONOREPO_LAYOUT, MonorepoProject, PREFLIGHT_MERGE_METHOD_VALUES, PROD_DEPLOY_NAME, PROGRESS_FILES_FORMAT_VALUES, PnpmWorkspace, ProjectMetadata, REQUIREMENTS_WRITER_PATHS, ROOT_CI_TASK_NAME, ROOT_TURBO_TASK_NAME, ResetTask, SCHEDULED_TASK_MODEL_VALUES, SCOPE_CLASS_VALUES, SHARED_EDITING_CONFLICT_STRATEGY_VALUES, STARLIGHT_ROLE, StarlightProject, TestRunner, TsDocCoverageKind, TurboRepo, TurboRepoTask, TypeScriptConfig, TypeScriptProject, UNKNOWN_TYPE_FALLBACK_TIER, VERSION, VERSION_KEYS_SKIP, VERSION_NPM_PACKAGES, VSCodeConfig, Vitest, addApproveMergeUpgradeWorkflow, addBuildCompleteJob, addSyncLabelsWorkflow, agendaBundle, analyzeTsDocCoverage, awsCdkBundle, baseBundle, bcmWriterBundle, buildBaseBundle, buildBcmWriterBundle, buildBuiltInBundles, buildBusinessModelsBundle, buildCheckBlockedProcedure, buildCompanyProfileBundle, buildCustomerProfileBundle, buildDocsSyncBundle, buildIndustryDiscoveryBundle, buildMaintenanceAuditBundle, buildOrchestratorConventionsContent, buildPeopleProfileBundle, buildRegulatoryResearchBundle, buildRequirementsAnalystBundle, buildRequirementsReviewerBundle, buildRequirementsWriterBundle, buildResearchPipelineBundle, buildSoftwareProfileBundle, buildStandardsResearchBundle, buildUnblockDependentsProcedure, businessModelsBundle, classifyIssueScope, classifyRun, companyProfileBundle, customerProfileBundle, docsSyncBundle, extractApiProcedure, extractDocReferences, formatLayoutViolation, formatStarlightSingletonViolation, getLatestEligibleVersion, githubWorkflowBundle, industryDiscoveryBundle, jestBundle, maintenanceAuditBundle, meetingAnalysisBundle, orchestratorBundle, peopleProfileBundle, pnpmBundle, prReviewBundle, projenBundle, regulatoryResearchBundle, renderAgentTierCaseStatement, renderAgentTierSection, renderCustomDocSectionBlock, renderCustomDocSections, renderExtractApiProcedure, renderFocusSection, renderIssueTemplatesBundleHook, renderIssueTemplatesCheckerScript, renderIssueTemplatesRuleContent, renderIssueTemplatesStarterPage, renderMeetingTypesSection, renderPreflightPrSection, renderPreflightPrShellHelpers, renderPriorityRulesSection, renderProgressFileName, renderProgressFilePath, renderProgressFilesBundleHook, renderProgressFilesRuleContent, renderRunRatioSection, renderRunRatioShellHelpers, renderScheduledTaskSkillFile, renderScheduledTasksSection, renderScopeGateSection, renderScopeGateShellHelpers, renderSharedEditingBundleHook, renderSharedEditingHelperScript, renderSharedEditingRuleContent, renderSkillEvalsBundleHook, renderSkillEvalsRuleContent, renderSkillEvalsRunnerScript, renderSourceTierExamples, renderUnblockDependentsScript, renderUnblockDependentsSection, renderWorkflowDiagramsBundleHook, renderWorkflowDiagramsCheckerScript, renderWorkflowDiagramsRuleContent, renderWorkflowDiagramsStarterPage, requirementsAnalystBundle, requirementsReviewerBundle, requirementsWriterBundle, researchPipelineBundle, resolveAgentPaths, resolveAgentTiers, resolveAstroProjectOutdir, resolveAwsCdkProjectOutdir, resolveIssueTemplates, resolveModelAlias, resolveOrchestratorAssets, resolveOutdirFromPackageName, resolvePreflightPr, resolveProgressFiles, resolveRunRatio, resolveScheduledTasks, resolveScopeGate, resolveSharedEditing, resolveSkillEvals, resolveTemplateVariables, resolveTypeScriptProjectOutdir, resolveUnblockDependents, resolveWorkflowDiagrams, slackBundle, softwareProfileBundle, standardsResearchBundle, turborepoBundle, typescriptBundle, validateAgentTierConfig, validateIssueTemplatesConfig, validateMonorepoLayout, validatePreflightPrConfig, validateProgressFilesConfig, validateRunRatioConfig, validateScheduledTasksConfig, validateScopeGateConfig, validateSharedEditingConfig, validateSkillEvalsConfig, validateStarlightSingleton, validateUnblockDependentsConfig, validateWorkflowDiagramsConfig, vitestBundle };
|
|
8494
|
+
export type { AgentConfigOptions, AgentExpansionRules, AgentFeaturesConfig, AgentModel, AgentPathsConfig, AgentPlatform, AgentPlatformOverrides, AgentProcedure, AgentRule, AgentRuleBundle, AgentRuleScope, AgentSkill, AgentSubAgent, AgentSubAgentPlatformOverrides, AgentTier, AgentTierConfig, AgentTierEntry, AnalyzeTsDocCoverageOptions, ApiExtractorOptions, ApiExtractorReportOptions, ApproveMergeUpgradeOptions, AstroConfigOptions, AstroIntegrationSpec, AstroProjectOptions, AwsAccount, AwsCdkProjectOptions, AwsDeploymentTargetOptions, AwsLocalDeploymentConfig, AwsOrganization, AwsRegion, AwsTeardownWorkflowOptions, CiDeploymentConfig, ClassTypeOptions, ClaudeAutoModeConfig, ClaudeHookAction, ClaudeHookEntry, ClaudeHooksConfig, ClaudePermissionsConfig, ClaudeRuleTarget, ClaudeSandboxConfig, ClaudeSettingsConfig, CopilotHandoff, CursorHookAction, CursorHooksConfig, CursorSettingsConfig, CustomDocSection, DeployWorkflowOptions, DeploymentMetadata, DocReferenceRecord, ExtractDocReferencesOptions, FocusArea, FocusAreaMatch, FocusConfig, GitBranch, GitHubBoardMetadata, GitHubProjectMetadata, GitHubSprintMetadata, IDependencyResolver, IssueTemplatesConfig, LabelDefinition, LayoutEnforcement, LayoutViolation, McpServerConfig, McpTransport, MeetingArea, MeetingScope, MeetingType, MeetingTypeKind, MeetingsConfig, MergeMethod, MonorepoLayoutRoot, MonorepoProjectOptions, OrganizationMetadata, PnpmWorkspaceOptions, PreflightMergeMethod, PreflightPrConfig, PriorityRule, ProgressFilesConfig, ProjectMetadataOptions, RemoteCacheOptions, RepositoryMetadata, ResetTaskOptions, ResolvedAgentPaths, ResolvedAgentTier, ResolvedIssueTemplates, ResolvedPreflightPr, ResolvedProgressFiles, ResolvedProjectMetadata, ResolvedRunRatio, ResolvedScheduledTask, ResolvedScheduledTasks, ResolvedScopeGate, ResolvedSharedEditing, ResolvedSkillEvals, ResolvedUnblockDependents, ResolvedWorkflowDiagrams, RunRatioConfig, ScheduledTaskEntry, ScheduledTaskModel, ScheduledTaskOverride, ScheduledTasksConfig, ScopeClass, ScopeGateConfig, ScopeGateThresholds, SharedEditingConfig, SkillEvalsConfig, SlackMetadata, SourceTierExamples, StarlightEditLink, StarlightLogo, StarlightProjectOptions, StarlightRole, StarlightSidebarItem, StarlightSingletonViolation, StarlightSocialLink, SyncLabelsOptions, TemplateResolveResult, TsDocCoverageRecord, TurboRepoOptions, TurboRepoTaskOptions, TypeScriptProjectOptions, UnblockDependentsConfig, VersionKey, VitestConfigOptions, VitestOptions, WorkflowDiagramsConfig };
|
package/lib/index.js
CHANGED
|
@@ -316,6 +316,7 @@ __export(index_exports, {
|
|
|
316
316
|
customerProfileBundle: () => customerProfileBundle,
|
|
317
317
|
docsSyncBundle: () => docsSyncBundle,
|
|
318
318
|
extractApiProcedure: () => extractApiProcedure,
|
|
319
|
+
extractDocReferences: () => extractDocReferences,
|
|
319
320
|
formatLayoutViolation: () => formatLayoutViolation,
|
|
320
321
|
formatStarlightSingletonViolation: () => formatStarlightSingletonViolation,
|
|
321
322
|
getLatestEligibleVersion: () => getLatestEligibleVersion,
|
|
@@ -26770,8 +26771,8 @@ var FALLBACKS = {
|
|
|
26770
26771
|
monorepoLayoutSeedBlock: ""
|
|
26771
26772
|
};
|
|
26772
26773
|
var TEMPLATE_RE = /\{\{(\w+(?:\.\w+)*)\}\}/g;
|
|
26773
|
-
function getNestedValue(obj,
|
|
26774
|
-
const parts =
|
|
26774
|
+
function getNestedValue(obj, path4) {
|
|
26775
|
+
const parts = path4.split(".");
|
|
26775
26776
|
let current = obj;
|
|
26776
26777
|
for (const part of parts) {
|
|
26777
26778
|
if (current == null || typeof current !== "object") {
|
|
@@ -26997,20 +26998,20 @@ var ClaudeRenderer = class _ClaudeRenderer {
|
|
|
26997
26998
|
obj.excludedCommands = [...sandbox.excludedCommands];
|
|
26998
26999
|
}
|
|
26999
27000
|
if (sandbox.filesystem) {
|
|
27000
|
-
const
|
|
27001
|
+
const fs2 = {};
|
|
27001
27002
|
if (sandbox.filesystem.allowRead?.length) {
|
|
27002
|
-
|
|
27003
|
+
fs2.allowRead = [...sandbox.filesystem.allowRead];
|
|
27003
27004
|
}
|
|
27004
27005
|
if (sandbox.filesystem.denyRead?.length) {
|
|
27005
|
-
|
|
27006
|
+
fs2.denyRead = [...sandbox.filesystem.denyRead];
|
|
27006
27007
|
}
|
|
27007
27008
|
if (sandbox.filesystem.allowWrite?.length) {
|
|
27008
|
-
|
|
27009
|
+
fs2.allowWrite = [...sandbox.filesystem.allowWrite];
|
|
27009
27010
|
}
|
|
27010
27011
|
if (sandbox.filesystem.denyWrite?.length) {
|
|
27011
|
-
|
|
27012
|
+
fs2.denyWrite = [...sandbox.filesystem.denyWrite];
|
|
27012
27013
|
}
|
|
27013
|
-
if (Object.keys(
|
|
27014
|
+
if (Object.keys(fs2).length > 0) obj.filesystem = fs2;
|
|
27014
27015
|
}
|
|
27015
27016
|
if (sandbox.network) {
|
|
27016
27017
|
const net = {};
|
|
@@ -28755,8 +28756,125 @@ var AwsDeploymentTarget = class _AwsDeploymentTarget extends import_projen12.Com
|
|
|
28755
28756
|
}
|
|
28756
28757
|
};
|
|
28757
28758
|
|
|
28758
|
-
// src/docs-sync/
|
|
28759
|
+
// src/docs-sync/reference-extraction/extraction.ts
|
|
28760
|
+
var fs = __toESM(require("fs"));
|
|
28759
28761
|
var path2 = __toESM(require("path"));
|
|
28762
|
+
var import_mdast_util_from_markdown = require("mdast-util-from-markdown");
|
|
28763
|
+
var DEFAULT_DOCS_ROOT = "docs/src/content/docs";
|
|
28764
|
+
var DEFAULT_SYMBOL_PATTERN = /^(?:[a-z][a-zA-Z0-9]*|[A-Z][a-zA-Z0-9]*|[A-Z][A-Z0-9_]*)$/;
|
|
28765
|
+
function extractDocReferences(options = {}) {
|
|
28766
|
+
const docsRoot = path2.resolve(options.docsRoot ?? DEFAULT_DOCS_ROOT);
|
|
28767
|
+
const symbolPattern = options.symbolPattern ?? DEFAULT_SYMBOL_PATTERN;
|
|
28768
|
+
const knownSymbols = new Set(options.knownSymbols ?? []);
|
|
28769
|
+
if (!fs.existsSync(docsRoot)) {
|
|
28770
|
+
return [];
|
|
28771
|
+
}
|
|
28772
|
+
const records = [];
|
|
28773
|
+
for (const absolutePath of walkMarkdownFiles(docsRoot)) {
|
|
28774
|
+
const docPath = toPosix(path2.relative(docsRoot, absolutePath));
|
|
28775
|
+
const source = fs.readFileSync(absolutePath, "utf-8");
|
|
28776
|
+
const tree = (0, import_mdast_util_from_markdown.fromMarkdown)(stripYamlFrontmatter(source));
|
|
28777
|
+
collectInlineCode(tree, (symbol, position) => {
|
|
28778
|
+
if (!symbolPattern.test(symbol)) {
|
|
28779
|
+
return;
|
|
28780
|
+
}
|
|
28781
|
+
records.push({
|
|
28782
|
+
docPath,
|
|
28783
|
+
line: position.line,
|
|
28784
|
+
column: position.column,
|
|
28785
|
+
symbol,
|
|
28786
|
+
isKnown: knownSymbols.has(symbol)
|
|
28787
|
+
});
|
|
28788
|
+
});
|
|
28789
|
+
}
|
|
28790
|
+
records.sort((a, b) => {
|
|
28791
|
+
if (a.docPath !== b.docPath) {
|
|
28792
|
+
return a.docPath.localeCompare(b.docPath);
|
|
28793
|
+
}
|
|
28794
|
+
if (a.line !== b.line) {
|
|
28795
|
+
return a.line - b.line;
|
|
28796
|
+
}
|
|
28797
|
+
if (a.column !== b.column) {
|
|
28798
|
+
return a.column - b.column;
|
|
28799
|
+
}
|
|
28800
|
+
return a.symbol.localeCompare(b.symbol);
|
|
28801
|
+
});
|
|
28802
|
+
return records;
|
|
28803
|
+
}
|
|
28804
|
+
function walkMarkdownFiles(root) {
|
|
28805
|
+
const out = [];
|
|
28806
|
+
const stack = [root];
|
|
28807
|
+
while (stack.length > 0) {
|
|
28808
|
+
const dir = stack.pop();
|
|
28809
|
+
let entries;
|
|
28810
|
+
try {
|
|
28811
|
+
entries = fs.readdirSync(dir, { withFileTypes: true });
|
|
28812
|
+
} catch {
|
|
28813
|
+
continue;
|
|
28814
|
+
}
|
|
28815
|
+
for (const entry of entries) {
|
|
28816
|
+
const full = path2.join(dir, entry.name);
|
|
28817
|
+
if (entry.isDirectory()) {
|
|
28818
|
+
stack.push(full);
|
|
28819
|
+
} else if (entry.isFile() && full.toLowerCase().endsWith(".md")) {
|
|
28820
|
+
out.push(full);
|
|
28821
|
+
}
|
|
28822
|
+
}
|
|
28823
|
+
}
|
|
28824
|
+
out.sort();
|
|
28825
|
+
return out;
|
|
28826
|
+
}
|
|
28827
|
+
function collectInlineCode(tree, visit) {
|
|
28828
|
+
walk(tree);
|
|
28829
|
+
function walk(node) {
|
|
28830
|
+
if (node.type === "inlineCode") {
|
|
28831
|
+
const start = node.position?.start;
|
|
28832
|
+
if (!start) {
|
|
28833
|
+
return;
|
|
28834
|
+
}
|
|
28835
|
+
visit(node.value, { line: start.line, column: start.column });
|
|
28836
|
+
return;
|
|
28837
|
+
}
|
|
28838
|
+
if (node.type === "code" || node.type === "html") {
|
|
28839
|
+
return;
|
|
28840
|
+
}
|
|
28841
|
+
const parent = node;
|
|
28842
|
+
if (Array.isArray(parent.children)) {
|
|
28843
|
+
for (const child of parent.children) {
|
|
28844
|
+
walk(child);
|
|
28845
|
+
}
|
|
28846
|
+
}
|
|
28847
|
+
}
|
|
28848
|
+
}
|
|
28849
|
+
function toPosix(p) {
|
|
28850
|
+
return p.split(path2.sep).join("/");
|
|
28851
|
+
}
|
|
28852
|
+
function stripYamlFrontmatter(source) {
|
|
28853
|
+
if (!source.startsWith("---")) {
|
|
28854
|
+
return source;
|
|
28855
|
+
}
|
|
28856
|
+
const lines = source.split("\n");
|
|
28857
|
+
if (lines[0] !== "---") {
|
|
28858
|
+
return source;
|
|
28859
|
+
}
|
|
28860
|
+
let endIndex = -1;
|
|
28861
|
+
for (let i = 1; i < lines.length; i++) {
|
|
28862
|
+
if (lines[i] === "---") {
|
|
28863
|
+
endIndex = i;
|
|
28864
|
+
break;
|
|
28865
|
+
}
|
|
28866
|
+
}
|
|
28867
|
+
if (endIndex < 0) {
|
|
28868
|
+
return source;
|
|
28869
|
+
}
|
|
28870
|
+
for (let i = 0; i <= endIndex; i++) {
|
|
28871
|
+
lines[i] = "";
|
|
28872
|
+
}
|
|
28873
|
+
return lines.join("\n");
|
|
28874
|
+
}
|
|
28875
|
+
|
|
28876
|
+
// src/docs-sync/tsdoc-coverage/coverage.ts
|
|
28877
|
+
var path3 = __toESM(require("path"));
|
|
28760
28878
|
var import_tsdoc = require("@microsoft/tsdoc");
|
|
28761
28879
|
var ts = __toESM(require("typescript"));
|
|
28762
28880
|
var TsDocCoverageKind = {
|
|
@@ -28774,8 +28892,8 @@ var DEFAULT_THIN_SUMMARY_WORD_THRESHOLD = 4;
|
|
|
28774
28892
|
var DEFAULT_ENTRY_POINT = "src/index.ts";
|
|
28775
28893
|
function analyzeTsDocCoverage(options) {
|
|
28776
28894
|
const resolvedOptions = typeof options === "string" ? { packageRoot: options } : options;
|
|
28777
|
-
const packageRoot =
|
|
28778
|
-
const entryPoint =
|
|
28895
|
+
const packageRoot = path3.resolve(resolvedOptions.packageRoot);
|
|
28896
|
+
const entryPoint = path3.resolve(
|
|
28779
28897
|
packageRoot,
|
|
28780
28898
|
resolvedOptions.entryPoint ?? DEFAULT_ENTRY_POINT
|
|
28781
28899
|
);
|
|
@@ -28838,7 +28956,7 @@ function analyzeTsDocCoverage(options) {
|
|
|
28838
28956
|
}
|
|
28839
28957
|
function resolveCompilerOptions(packageRoot, tsconfigPath) {
|
|
28840
28958
|
if (tsconfigPath) {
|
|
28841
|
-
const absoluteTsconfig =
|
|
28959
|
+
const absoluteTsconfig = path3.resolve(packageRoot, tsconfigPath);
|
|
28842
28960
|
const configFile = ts.readConfigFile(absoluteTsconfig, ts.sys.readFile);
|
|
28843
28961
|
if (configFile.error) {
|
|
28844
28962
|
throw new Error(
|
|
@@ -28848,7 +28966,7 @@ function resolveCompilerOptions(packageRoot, tsconfigPath) {
|
|
|
28848
28966
|
const parsed = ts.parseJsonConfigFileContent(
|
|
28849
28967
|
configFile.config,
|
|
28850
28968
|
ts.sys,
|
|
28851
|
-
|
|
28969
|
+
path3.dirname(absoluteTsconfig)
|
|
28852
28970
|
);
|
|
28853
28971
|
return { ...parsed.options, noEmit: true };
|
|
28854
28972
|
}
|
|
@@ -29135,6 +29253,7 @@ var JsiiFaker = class _JsiiFaker extends import_projen13.Component {
|
|
|
29135
29253
|
|
|
29136
29254
|
// src/projects/astro-project.ts
|
|
29137
29255
|
var import_projen18 = require("projen");
|
|
29256
|
+
var import_ts_deepmerge3 = require("ts-deepmerge");
|
|
29138
29257
|
|
|
29139
29258
|
// src/projects/monorepo-layout.ts
|
|
29140
29259
|
var MONOREPO_LAYOUT = {
|
|
@@ -29156,14 +29275,14 @@ var LAYOUT_ROOT_BY_PROJECT_TYPE = {
|
|
|
29156
29275
|
};
|
|
29157
29276
|
function validateMonorepoLayout(root) {
|
|
29158
29277
|
const violations = [];
|
|
29159
|
-
const rootOutdir =
|
|
29278
|
+
const rootOutdir = toPosix2(root.outdir);
|
|
29160
29279
|
for (const sub of root.subprojects) {
|
|
29161
29280
|
const className = sub.constructor.name;
|
|
29162
29281
|
const expectedRoot = expectedRootFor(sub, className);
|
|
29163
29282
|
if (expectedRoot === void 0) {
|
|
29164
29283
|
continue;
|
|
29165
29284
|
}
|
|
29166
|
-
const relOutdir = relativeOutdir(rootOutdir,
|
|
29285
|
+
const relOutdir = relativeOutdir(rootOutdir, toPosix2(sub.outdir));
|
|
29167
29286
|
if (!outdirMatchesRoot(relOutdir, expectedRoot)) {
|
|
29168
29287
|
violations.push({
|
|
29169
29288
|
projectName: sub.name,
|
|
@@ -29222,7 +29341,7 @@ function outdirMatchesRoot(relOutdir, expectedRoot) {
|
|
|
29222
29341
|
}
|
|
29223
29342
|
return segments.length >= 2;
|
|
29224
29343
|
}
|
|
29225
|
-
function
|
|
29344
|
+
function toPosix2(p) {
|
|
29226
29345
|
return p.replace(/\\/g, "/");
|
|
29227
29346
|
}
|
|
29228
29347
|
function relativeOutdir(rootOutdir, subOutdir) {
|
|
@@ -29302,8 +29421,8 @@ var ResetTask = class _ResetTask extends import_projen14.Component {
|
|
|
29302
29421
|
const resetTask = this.project.tasks.addTask(this.taskName, {
|
|
29303
29422
|
description: "Delete build artifacts specified by pathsToRemove option, or artifactsDirectory if pathsToRemove is empty"
|
|
29304
29423
|
});
|
|
29305
|
-
this.pathsToRemove.forEach((
|
|
29306
|
-
resetTask.exec(`[ -e "${
|
|
29424
|
+
this.pathsToRemove.forEach((path4) => {
|
|
29425
|
+
resetTask.exec(`[ -e "${path4}" ] && rm -rf ${path4} || true`);
|
|
29307
29426
|
});
|
|
29308
29427
|
const rootHasTurbo = TurboRepo.of(this.project.root) !== void 0;
|
|
29309
29428
|
const isSubproject = this.project !== this.project.root;
|
|
@@ -30319,20 +30438,27 @@ var TypeScriptProject = class extends import_projen17.typescript.TypeScriptProje
|
|
|
30319
30438
|
var AstroProject = class extends TypeScriptProject {
|
|
30320
30439
|
constructor(userOptions) {
|
|
30321
30440
|
const resolvedOutdir = userOptions.outdir ?? resolveAstroProjectOutdir(userOptions.packageName ?? userOptions.name);
|
|
30322
|
-
const
|
|
30441
|
+
const defaultOptions = {
|
|
30323
30442
|
testRunner: TestRunner.VITEST,
|
|
30324
30443
|
// Astro sites don't expose a library API surface — skip the
|
|
30325
30444
|
// `@microsoft/api-extractor` wiring the TypeScriptProject base adds
|
|
30326
30445
|
// by default. Callers can opt in with `apiExtractor: { ... }` if a
|
|
30327
30446
|
// given site genuinely ships typed re-exports.
|
|
30328
30447
|
apiExtractor: false,
|
|
30329
|
-
|
|
30330
|
-
|
|
30448
|
+
tsconfig: {
|
|
30449
|
+
compilerOptions: {
|
|
30450
|
+
declaration: false
|
|
30451
|
+
}
|
|
30452
|
+
},
|
|
30331
30453
|
depsUpgradeOptions: {
|
|
30332
|
-
|
|
30333
|
-
exclude: [...userOptions.depsUpgradeOptions?.exclude ?? [], "astro"]
|
|
30454
|
+
exclude: ["astro"]
|
|
30334
30455
|
}
|
|
30335
30456
|
};
|
|
30457
|
+
const merged = (0, import_ts_deepmerge3.merge)(defaultOptions, userOptions);
|
|
30458
|
+
const options = {
|
|
30459
|
+
...merged,
|
|
30460
|
+
outdir: resolvedOutdir
|
|
30461
|
+
};
|
|
30336
30462
|
super(options);
|
|
30337
30463
|
const astroVersion = options.astroVersion ?? VERSION.ASTRO_VERSION;
|
|
30338
30464
|
const astroTsconfigExtends = options.astroTsconfigExtends ?? "astro/tsconfigs/strict";
|
|
@@ -30384,6 +30510,9 @@ var AstroProject = class extends TypeScriptProject {
|
|
|
30384
30510
|
parser: "astro-eslint-parser"
|
|
30385
30511
|
});
|
|
30386
30512
|
this.eslint?.addLintPattern("src/**/*.astro");
|
|
30513
|
+
this.eslint?.addRules({
|
|
30514
|
+
"import/no-unresolved": ["error", { ignore: ["^astro:"] }]
|
|
30515
|
+
});
|
|
30387
30516
|
this.gitignore.addPatterns(".astro", ".vercel", ".netlify");
|
|
30388
30517
|
const turbo = TurboRepo.of(this);
|
|
30389
30518
|
if (turbo?.compileTask) {
|
|
@@ -30429,7 +30558,7 @@ var DEFAULT_FAVICON_SVG = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0
|
|
|
30429
30558
|
var import_projen21 = require("projen");
|
|
30430
30559
|
var import_javascript5 = require("projen/lib/javascript");
|
|
30431
30560
|
var import_release2 = require("projen/lib/release");
|
|
30432
|
-
var
|
|
30561
|
+
var import_ts_deepmerge4 = require("ts-deepmerge");
|
|
30433
30562
|
|
|
30434
30563
|
// src/workflows/aws-deploy-workflow.ts
|
|
30435
30564
|
var import_utils11 = __toESM(require_lib());
|
|
@@ -30999,7 +31128,7 @@ var AwsCdkProject = class extends import_projen21.awscdk.AwsCdkTypeScriptApp {
|
|
|
30999
31128
|
paths: [`${resolvedOutdir}/src/**`, `${resolvedOutdir}/package.json`]
|
|
31000
31129
|
})
|
|
31001
31130
|
};
|
|
31002
|
-
const options = (0,
|
|
31131
|
+
const options = (0, import_ts_deepmerge4.merge)(defaultOptions, userOptions);
|
|
31003
31132
|
super(options);
|
|
31004
31133
|
this.addDevDeps("@types/node@catalog:");
|
|
31005
31134
|
this.tsconfig?.addExclude("**/*.test.*");
|
|
@@ -31071,7 +31200,7 @@ var AwsCdkProject = class extends import_projen21.awscdk.AwsCdkTypeScriptApp {
|
|
|
31071
31200
|
]
|
|
31072
31201
|
};
|
|
31073
31202
|
const userResetTaskOptions = options.resetTaskOptions ?? {};
|
|
31074
|
-
const resetTaskOptions = (0,
|
|
31203
|
+
const resetTaskOptions = (0, import_ts_deepmerge4.merge)(
|
|
31075
31204
|
defaultResetTaskOptions,
|
|
31076
31205
|
{
|
|
31077
31206
|
...userResetTaskOptions,
|
|
@@ -31148,7 +31277,7 @@ var StarlightProject = class extends AstroProject {
|
|
|
31148
31277
|
new import_projen22.SampleFile(this, "src/content/docs/index.mdx", {
|
|
31149
31278
|
contents: DEFAULT_INDEX_MDX
|
|
31150
31279
|
});
|
|
31151
|
-
new import_projen22.SampleFile(this, "src/content
|
|
31280
|
+
new import_projen22.SampleFile(this, "src/content.config.ts", {
|
|
31152
31281
|
contents: DEFAULT_CONTENT_CONFIG_TS
|
|
31153
31282
|
});
|
|
31154
31283
|
}
|
|
@@ -31188,10 +31317,11 @@ description: Starlight-powered documentation site.
|
|
|
31188
31317
|
Edit \`src/content/docs/index.mdx\` to replace this page.
|
|
31189
31318
|
`;
|
|
31190
31319
|
var DEFAULT_CONTENT_CONFIG_TS = `import { defineCollection } from "astro:content";
|
|
31320
|
+
import { docsLoader } from "@astrojs/starlight/loaders";
|
|
31191
31321
|
import { docsSchema } from "@astrojs/starlight/schema";
|
|
31192
31322
|
|
|
31193
31323
|
export const collections = {
|
|
31194
|
-
docs: defineCollection({ schema: docsSchema() }),
|
|
31324
|
+
docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }),
|
|
31195
31325
|
};
|
|
31196
31326
|
`;
|
|
31197
31327
|
|
|
@@ -31367,6 +31497,7 @@ var TypeScriptConfig = class extends import_projen23.Component {
|
|
|
31367
31497
|
customerProfileBundle,
|
|
31368
31498
|
docsSyncBundle,
|
|
31369
31499
|
extractApiProcedure,
|
|
31500
|
+
extractDocReferences,
|
|
31370
31501
|
formatLayoutViolation,
|
|
31371
31502
|
formatStarlightSingletonViolation,
|
|
31372
31503
|
getLatestEligibleVersion,
|