Enum KnowledgeAction 

pub enum KnowledgeAction {
    List {
        json: bool,
    },
    Add {
        entry_type: String,
        id: Option<String>,
        scope: Option<String>,
        rule: Option<String>,
        module: Option<String>,
        owns: Option<String>,
        boundary: Option<String>,
        pattern: Option<String>,
        instead: Option<String>,
        stability: Option<String>,
        decided_in: Option<String>,
        learned_from: Option<String>,
    },
    Remove {
        id: String,
    },
}

Variants

List

List all knowledge entries

Fields

json: bool

Output as JSON

Add

Add a new knowledge entry

Fields

entry_type: String

Type of entry: convention, boundary, anti-pattern

id: Option<String>

Stable ID (auto-generated if omitted)

scope: Option<String>

File/directory scope (for conventions)

rule: Option<String>

The rule text (for conventions)

module: Option<String>

Module directory (for boundaries)

owns: Option<String>

What the module owns (for boundaries)

boundary: Option<String>

What must not cross the boundary (for boundaries)

pattern: Option<String>

The anti-pattern to avoid

instead: Option<String>

What to do instead (for anti-patterns)

stability: Option<String>

Stability level: permanent, provisional, experimental

decided_in: Option<String>

Commit SHA where this was decided

learned_from: Option<String>

Where this was learned (for anti-patterns)

Remove

Remove a knowledge entry by ID

Fields

id: String

ID of the entry to remove

Trait Implementations

impl FromArgMatches for KnowledgeAction

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for KnowledgeAction

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand