onetaskgraph_plugin_api/
lib.rs

1//! The contract every onetaskgraph source is written against.
2//!
3//! This crate holds exactly what a plugin author needs in order to implement a
4//! source, and nothing else: the two traits, the work types, the query and paging
5//! types, the capability declaration, and the error enum. The engine that drives
6//! sources lives in `onetaskgraph-core`, and **no plugin crate may depend on it**:
7//! `deny.toml` permits that crate exactly one wrapper, the binary, failing the
8//! required `deny` job, and `scripts/check-plugin-isolation.sh` reads the real
9//! `cargo metadata` graph inside `just check`.
10//!
11//! Keeping this crate still is the point. Every change here rebuilds and re-tests
12//! every plugin, which is exactly the cost the split exists to avoid paying on an
13//! ordinary engine change. When a new type could plausibly sit on either side, it
14//! belongs in `onetaskgraph-core` unless a trait signature names it.
15#![deny(missing_docs)]
16
17mod capability;
18mod comment;
19mod error;
20mod id;
21mod metadata;
22mod metering;
23mod query;
24mod source;
25mod work;
26mod write;
27
28pub use capability::{Capabilities, DependencySupport, Support};
29pub use comment::{Comment, CommentBody, NewComment, commentless};
30pub use error::SourceError;
31pub use id::{NativeId, SOURCE_NAME_PATTERN, SourceName};
32pub use metadata::{MetadataKey, MetadataRecord, unwritable_metadata};
33pub use metering::{Metered, Metering};
34pub use query::{
35    Cursor, DocumentQuery, LabelFilter, Page, PageRequest, ProjectFilter, ProjectQuery, TaskQuery,
36    TextFields, TextQuery,
37};
38pub use source::{Health, SecretResolver, SourcePlugin, TaskSource};
39pub use work::{
40    DependencyEdge, DependencyEndpoint, DependencyKind, Direction, Document, ItemKind, Label,
41    Location, Project, Repository, Status, StatusCategory, Task, TaskRef,
42};
43pub use write::{ItemWrite, WriteSupport, documentless, unwritable, unwritable_field};
onetaskgraph_plugin_api/lib.rs

onetaskgraph_plugin_api/
lib.rs
