onetaskgraph-plugin-api 0.2.31

The plugin contract onetaskgraph sources implement: the traits, the work types, and the capability declaration.
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

//! The contract every onetaskgraph source is written against.
//!
//! This crate holds exactly what a plugin author needs in order to implement a
//! source, and nothing else: the two traits, the work types, the query and paging
//! types, the capability declaration, and the error enum. The engine that drives
//! sources lives in `onetaskgraph-core`, and **no plugin crate may depend on it**:
//! `deny.toml` permits that crate exactly one wrapper, the binary, failing the
//! required `deny` job, and `scripts/check-plugin-isolation.sh` reads the real
//! `cargo metadata` graph inside `just check`.
//!
//! Keeping this crate still is the point. Every change here rebuilds and re-tests
//! every plugin, which is exactly the cost the split exists to avoid paying on an
//! ordinary engine change. When a new type could plausibly sit on either side, it
//! belongs in `onetaskgraph-core` unless a trait signature names it.
#![deny(missing_docs)]

mod capability;
mod comment;
mod error;
mod id;
mod metering;
mod query;
mod source;
mod work;
mod write;

pub use capability::{Capabilities, DependencySupport, Support};
pub use comment::{Comment, CommentBody, NewComment, commentless};
pub use error::SourceError;
pub use id::{NativeId, SOURCE_NAME_PATTERN, SourceName};
pub use metering::{Metered, Metering};
pub use query::{
    Cursor, DocumentQuery, LabelFilter, Page, PageRequest, ProjectFilter, ProjectQuery, TaskQuery,
    TextFields, TextQuery,
};
pub use source::{Health, SecretResolver, SourcePlugin, TaskSource};
pub use work::{
    DependencyEdge, DependencyEndpoint, DependencyKind, Direction, Document, ItemKind, Label,
    Location, Project, Repository, Status, StatusCategory, Task,
};
pub use write::{ItemWrite, WriteSupport, documentless, unwritable};