Index
All Classes and Interfaces|All Packages
A
- AgentDocsPublishExtension - Class in io.github.duckasteroid.agentdocs.publish
-
Extension for configuring publish-side agent docs packaging.
- AgentDocsPublishExtension() - Constructor for class io.github.duckasteroid.agentdocs.publish.AgentDocsPublishExtension
- AgentDocsPublishPlugin - Class in io.github.duckasteroid.agentdocs.publish
-
Registers publish-side tasks that validate and package docs into an
agent-docssidecar zip. - AgentDocsPublishPlugin() - Constructor for class io.github.duckasteroid.agentdocs.publish.AgentDocsPublishPlugin
- AgentDocsValidationRule - Interface in io.github.duckasteroid.agentdocs.publish.validation
-
Contract for a skill validation rule.
- apply(Project) - Method in class io.github.duckasteroid.agentdocs.publish.AgentDocsPublishPlugin
D
- details() - Method in record class io.github.duckasteroid.agentdocs.publish.validation.ValidationResult
-
Returns the value of the
detailsrecord component. - docsDirectory() - Method in class io.github.duckasteroid.agentdocs.publish.validation.ValidationContext
-
Returns the configured docs directory.
- DocsDirectoryExistsRule - Class in io.github.duckasteroid.agentdocs.publish.validation
-
Ensures the configured docs directory exists.
- DocsDirectoryExistsRule() - Constructor for class io.github.duckasteroid.agentdocs.publish.validation.DocsDirectoryExistsRule
E
- equals(Object) - Method in record class io.github.duckasteroid.agentdocs.publish.validation.ValidationResult
-
Indicates whether some other object is "equal to" this one.
- error(String, String) - Static method in record class io.github.duckasteroid.agentdocs.publish.validation.ValidationResult
-
Creates an error result.
- ERROR - Enum constant in enum class io.github.duckasteroid.agentdocs.publish.validation.ValidationSeverity
G
- getDisabledValidationRules() - Method in class io.github.duckasteroid.agentdocs.publish.AgentDocsPublishExtension
-
Validation rule IDs to skip during
validateAgentDocs. - getDisabledValidationRules() - Method in class io.github.duckasteroid.agentdocs.publish.ValidateAgentDocsTask
-
Rule IDs that should be skipped for this task run.
- getDocsDirectory() - Method in class io.github.duckasteroid.agentdocs.publish.AgentDocsPublishExtension
-
Directory containing the agent docs source tree to package.
- getDocsDirectory() - Method in class io.github.duckasteroid.agentdocs.publish.ValidateAgentDocsTask
-
Docs directory containing the skill files to validate.
- getOutputFile() - Method in class io.github.duckasteroid.agentdocs.publish.InstallAgentDocsSkillTask
- getSkillContent() - Method in class io.github.duckasteroid.agentdocs.publish.InstallAgentDocsSkillTask
- getSkillsDirectory() - Method in class io.github.duckasteroid.agentdocs.publish.AgentDocsPublishExtension
-
Root directory for generated skill files.
H
- hashCode() - Method in record class io.github.duckasteroid.agentdocs.publish.validation.ValidationResult
-
Returns a hash code value for this object.
I
- id() - Method in interface io.github.duckasteroid.agentdocs.publish.validation.AgentDocsValidationRule
-
Stable rule identifier used for opt-out configuration.
- id() - Method in class io.github.duckasteroid.agentdocs.publish.validation.DocsDirectoryExistsRule
- id() - Method in class io.github.duckasteroid.agentdocs.publish.validation.SkillCompatibilityRule
- id() - Method in class io.github.duckasteroid.agentdocs.publish.validation.SkillDescriptionRule
- id() - Method in class io.github.duckasteroid.agentdocs.publish.validation.SkillEntrypointRule
- id() - Method in class io.github.duckasteroid.agentdocs.publish.validation.SkillFrontmatterStructureRule
- id() - Method in class io.github.duckasteroid.agentdocs.publish.validation.SkillNameRule
- id() - Method in class io.github.duckasteroid.agentdocs.publish.validation.StandardDirectoriesRule
- InstallAgentDocsSkillTask - Class in io.github.duckasteroid.agentdocs.publish
-
Writes the bundled agent-docs publish plugin usage guide (SKILL.md) into the consuming project's local agent skills folder so that local LLM agents can discover how to use the plugin.
- InstallAgentDocsSkillTask() - Constructor for class io.github.duckasteroid.agentdocs.publish.InstallAgentDocsSkillTask
- io.github.duckasteroid.agentdocs.publish - package io.github.duckasteroid.agentdocs.publish
- io.github.duckasteroid.agentdocs.publish.validation - package io.github.duckasteroid.agentdocs.publish.validation
P
- pass(String) - Static method in record class io.github.duckasteroid.agentdocs.publish.validation.ValidationResult
-
Creates a pass result with no severity.
R
- rootEntries() - Method in class io.github.duckasteroid.agentdocs.publish.validation.ValidationContext
-
Lists docs root entries.
- ruleId() - Method in record class io.github.duckasteroid.agentdocs.publish.validation.ValidationResult
-
Returns the value of the
ruleIdrecord component.
S
- severity() - Method in record class io.github.duckasteroid.agentdocs.publish.validation.ValidationResult
-
Returns the value of the
severityrecord component. - SkillCompatibilityRule - Class in io.github.duckasteroid.agentdocs.publish.validation
-
Validates optional
compatibilityfrontmatter length. - SkillCompatibilityRule() - Constructor for class io.github.duckasteroid.agentdocs.publish.validation.SkillCompatibilityRule
- SkillDescriptionRule - Class in io.github.duckasteroid.agentdocs.publish.validation
-
Validates required
descriptionfrontmatter presence and length. - SkillDescriptionRule() - Constructor for class io.github.duckasteroid.agentdocs.publish.validation.SkillDescriptionRule
- SkillEntrypointRule - Class in io.github.duckasteroid.agentdocs.publish.validation
-
Ensures exactly one
SKILL.mdexists at docs root. - SkillEntrypointRule() - Constructor for class io.github.duckasteroid.agentdocs.publish.validation.SkillEntrypointRule
- SkillFrontmatterStructureRule - Class in io.github.duckasteroid.agentdocs.publish.validation
-
Ensures
SKILL.mdcontains parseable YAML frontmatter. - SkillFrontmatterStructureRule() - Constructor for class io.github.duckasteroid.agentdocs.publish.validation.SkillFrontmatterStructureRule
- SkillNameRule - Class in io.github.duckasteroid.agentdocs.publish.validation
-
Warns when publisher-provided
nameis present because resolver naming is authoritative. - SkillNameRule() - Constructor for class io.github.duckasteroid.agentdocs.publish.validation.SkillNameRule
- StandardDirectoriesRule - Class in io.github.duckasteroid.agentdocs.publish.validation
-
Ensures standard optional skill directories are directories when present.
- StandardDirectoriesRule() - Constructor for class io.github.duckasteroid.agentdocs.publish.validation.StandardDirectoriesRule
T
- toString() - Method in record class io.github.duckasteroid.agentdocs.publish.validation.ValidationResult
-
Returns a string representation of this record class.
V
- validate(ValidationContext) - Method in interface io.github.duckasteroid.agentdocs.publish.validation.AgentDocsValidationRule
-
Validates the docs using the provided context.
- validate(ValidationContext) - Method in class io.github.duckasteroid.agentdocs.publish.validation.DocsDirectoryExistsRule
- validate(ValidationContext) - Method in class io.github.duckasteroid.agentdocs.publish.validation.SkillCompatibilityRule
- validate(ValidationContext) - Method in class io.github.duckasteroid.agentdocs.publish.validation.SkillDescriptionRule
- validate(ValidationContext) - Method in class io.github.duckasteroid.agentdocs.publish.validation.SkillEntrypointRule
- validate(ValidationContext) - Method in class io.github.duckasteroid.agentdocs.publish.validation.SkillFrontmatterStructureRule
- validate(ValidationContext) - Method in class io.github.duckasteroid.agentdocs.publish.validation.SkillNameRule
- validate(ValidationContext) - Method in class io.github.duckasteroid.agentdocs.publish.validation.StandardDirectoriesRule
- ValidateAgentDocsTask - Class in io.github.duckasteroid.agentdocs.publish
-
Validates docs by running a composite set of focused validation rules.
- ValidateAgentDocsTask() - Constructor for class io.github.duckasteroid.agentdocs.publish.ValidateAgentDocsTask
- ValidationContext - Class in io.github.duckasteroid.agentdocs.publish.validation
-
Shared state and file-system access helpers for validation rules.
- ValidationContext(File) - Constructor for class io.github.duckasteroid.agentdocs.publish.validation.ValidationContext
-
Creates a validation context for a docs directory.
- ValidationResult - Record Class in io.github.duckasteroid.agentdocs.publish.validation
-
Result of evaluating a single validation rule.
- ValidationResult(String, Optional<ValidationSeverity>, List<String>) - Constructor for record class io.github.duckasteroid.agentdocs.publish.validation.ValidationResult
-
Creates an instance of a
ValidationResultrecord class. - ValidationSeverity - Enum Class in io.github.duckasteroid.agentdocs.publish.validation
-
Severity emitted by a validation rule.
- valueOf(String) - Static method in enum class io.github.duckasteroid.agentdocs.publish.validation.ValidationSeverity
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class io.github.duckasteroid.agentdocs.publish.validation.ValidationSeverity
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- warn(String, String) - Static method in record class io.github.duckasteroid.agentdocs.publish.validation.ValidationResult
-
Creates a warning result.
- WARN - Enum constant in enum class io.github.duckasteroid.agentdocs.publish.validation.ValidationSeverity
All Classes and Interfaces|All Packages