specman 3.0.0

SpecMan runtime library for dependency mapping, templating, and lifecycle automation.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

pub(crate) mod core;
pub(crate) mod graph;
pub(crate) mod index;
pub(crate) mod metadata;
pub(crate) mod ops;
pub(crate) mod scratchpad;
pub(crate) mod storage;
pub(crate) mod templates;
pub(crate) mod validation;
pub(crate) mod workspace;

pub use core::env::SpecmanEnv;
pub use core::error::{LifecycleError, SpecmanError};
pub use core::shared::{EntityKind, SchemaRef, SemVer};
pub use graph::tree::{
    ArtifactId, ArtifactKind, ArtifactSummary, DependencyEdge, DependencyGraphServices,
    DependencyMapping, DependencyRelation, DependencyTree, FilesystemDependencyMapper,
    InventoryDependent, WorkspaceInventorySnapshot,
};
pub use index::{
    ArtifactKey, ArtifactRecord, ConstraintIdentifier, ConstraintRecord,
    FilesystemStructureIndexer, HeadingIdentifier, HeadingRecord, RelationshipEdge,
    RelationshipKind, StructureIndexing, StructureQuery, WorkspaceIndex,
};
pub use metadata::frontmatter::{
    ArtifactIdentityFields, ArtifactFrontMatter, DependencyEntry, ImplementationFrontMatter,
    ReferenceEntry, ScratchFrontMatter, ScratchRefactorMetadata, ScratchRevisionMetadata,
    ScratchFixMetadata,
    ScratchWorkType, ScratchWorkloadExtras, SpecificationFrontMatter, split_front_matter,
};
pub use metadata::{
    FrontMatterUpdate, FrontMatterUpdateResult, IdentityUpdate, ImplementationUpdate,
    ScratchUpdate, SpecificationUpdate,
};
pub use ops::create::{
    CreateImplOptions, CreateResult, CreateScratchOptions, CreateSpecOptions,
    create_implementation, create_scratch_pad, create_specification,
};
pub use ops::delete::{DeleteOptions, DeleteResult, delete_artifact};
pub use ops::update::apply_front_matter_update;
pub use scratchpad::ScratchPadProfile;
pub use storage::adapter::{DataModelAdapter, InMemoryAdapter};
pub use storage::persistence::{
    ArtifactRemovalStore, PersistedArtifact, RemovedArtifact, WorkspacePersistence,
};
pub use templates::catalog::{ResolvedTemplate, TemplateCatalog};
pub use templates::engine::{
    ImplContext, MarkdownTemplateEngine, RenderedTemplate, ScratchPadContext, SpecContext,
    TemplateDescriptor, TemplateEngine, TemplateLocator, TemplateProvenance, TemplateScenario,
    TemplateTier, TokenMap,
};
pub use validation::status::{
    ArtifactStatus, StatusResult, WorkspaceStatusConfig, WorkspaceStatusReport,
    validate_workspace_status,
};
pub use validation::{ValidationTag, validate_compliance};
pub use validation::analysis::{DeletionImpact, check_deletion_impact};
pub use validation::references::{
    DestinationKind, DiscoveredReference, HttpsMethod, HttpsValidationMode, HttpsValidationOptions,
    IssueSeverity, ReachabilityPolicy, ReferenceIssueKind, ReferenceKind, ReferenceRecord,
    ReferenceSource, ReferenceValidationIssue, ReferenceValidationOptions,
    ReferenceValidationReport, ReferenceValidationStatus, ReferenceValidator, SourcePoint,
    SourceRange, TransitiveOptions, ValidationMode, validate_references,
};
pub use workspace::{
    FilesystemWorkspaceLocator, WorkspaceContext, WorkspaceDiscovery, WorkspaceError,
    WorkspaceLocator, WorkspacePaths, discover as discover_workspace, workspace_relative_path,
};