dependabit / manifest/src
manifest/src
Manifest
| Name | Description |
|---|---|
| ValidationError | Wraps a Zod ZodError to provide human-readable formatted error messages. |
| AccessMethod | The protocol/service used to fetch and compare a dependency's state. |
| ChangeDetectionRecord | A persisted record of a single change detection event. |
| ChangeType | Classification of the kind of change detected during monitoring. |
| DependabitConfig | Root configuration object parsed from .dependabit.yml. |
| DependencyEntry | A single tracked external dependency inside a DependencyManifest. |
| DependencyManifest | A fully-validated dependency manifest document. |
| DependencyOverride | A per-URL configuration override inside DependabitConfig.dependencies. |
| DependencyType | Semantic category of an external dependency. |
| DetectionMethod | How a dependency was originally discovered. |
| IssueConfig | Configuration for GitHub issue creation on change detection. |
| LLMConfig | LLM provider configuration stored inside the manifest's generatedBy section and in DependabitConfig.llm. |
| MonitoringRules | Per-dependency monitoring rules (check frequency, enable/disable). |
| Schedule | Check schedule (cron-like, compatible with Dependabot syntax). |
| Severity | Change severity level used in notifications and issue creation. |
| DependabitConfigSchema | Zod schema for the top-level .dependabit.yml / .dependabit.json configuration file. |
| addDependency | Appends a new dependency entry to the on-disk manifest. |
| createEmptyManifest | Creates a minimal, valid manifest with an empty dependencies array. |
| getEffectiveMonitoringRules | Resolves the effective monitoring rules for a specific dependency URL by merging global config defaults with any per-URL override defined in config.dependencies. |
| mergeManifests | Merges an updated manifest generated by the detector over an existing one, optionally preserving manual entries and accumulated change history. |
| parseConfig | Parses a YAML string into a validated DependabitConfig. |
| readConfig | Reads a YAML configuration file from disk, parses it, and validates it against DependabitConfigSchema. |
| readManifest | Reads a manifest JSON file from disk and validates it against DependencyManifestSchema. |
| removeDependency | Removes a dependency from the on-disk manifest by ID. |
| shouldIgnoreUrl | Returns true if the given URL matches any exclusion rule defined in config.ignore (exact URL list or regex pattern list). |
| stringifyConfig | Serialises a validated DependabitConfig to a YAML string. |
| updateDependency | Updates a single dependency entry in the on-disk manifest by ID. |
| writeManifest | Serialises a manifest to pretty-printed JSON and writes it to disk. |
Other
| Name | Description |
|---|---|
| SizeCheckOptions | - |
| SizeCheckResult | Manifest size validation and warnings Checks manifest size and warns when approaching limits |
| AccessMethodSchema | - |
| AuthConfigSchema | - |
| ChangeDetectionRecordSchema | - |
| ChangeTypeSchema | - |
| DependencyEntrySchema | - |
| DependencyManifestSchema | - |
| DependencyOverrideSchema | - |
| DependencyTypeSchema | - |
| DetectionMethodSchema | - |
| IssueConfigSchema | - |
| LLMConfigSchema | - |
| ManifestVersionSchema | - |
| MonitoringRulesSchema | - |
| ScheduleSchema | - |
| SeveritySchema | - |
| canAddEntry | Check if adding an entry would exceed limits |
| checkManifestSize | Check manifest size and return status |
| estimateEntrySize | Estimate manifest size impact of adding an entry |
| formatSize | Get formatted size string |
| safeValidateConfig | Safe validation for config |
| safeValidateDependencyEntry | Safe validation for dependency entry |
| safeValidateManifest | Safe validation that returns success/error result |
| validateConfig | Validate a dependabit configuration |
| validateDependencyEntry | Validate a dependency entry |
| validateManifest | Validate a dependency manifest |
| validateManifestObject | Validate manifest object size before serialization |