Struct RulePackDef 

pub struct RulePackDef {
    pub schema: Option<String>,
    pub version: u32,
    pub name: String,
    pub description: Option<String>,
    pub rules: Vec<RulePackRule>,
}

A declarative rule pack loaded from a standalone JSON or JSONC file listed in the rulePacks config key.

Rule packs are pure data: loading a pack never executes project code. They encode project-specific policy (banned calls, banned imports, and catalogue-backed banned effects) evaluated over fallow’s static extraction data, reporting as policy-violation findings.

{
  "$schema": "https://raw.githubusercontent.com/fallow-rs/fallow/main/rule-pack-schema.json",
  "version": 1,
  "name": "team-policy",
  "description": "House rules for the platform team",
  "rules": [
    {
      "id": "no-child-process",
      "kind": "banned-call",
      "callees": ["child_process.*"],
      "message": "Use the sandboxed runner instead.",
      "severity": "error"
    },
    {
      "id": "no-network",
      "kind": "banned-effect",
      "effects": ["network"],
      "message": "Keep this package side-effect free."
    },
    {
      "id": "no-moment",
      "kind": "banned-import",
      "specifiers": ["moment"],
      "message": "Use date-fns."
    }
  ]
}

Fields

schema: Option<String>

JSON Schema reference (ignored during deserialization).

version: u32

Pack format version. Must be 1; the field exists so future rule kinds can be added without breaking older fallow builds silently.

name: String

Pack name, unique across all loaded packs. Must use only ASCII letters, digits, ., _, and - so "<pack>/<id>" is unambiguous in output, baselines, and scoped suppression comments.

description: Option<String>

Optional human description of the pack’s intent.

rules: Vec<RulePackRule>

The policy rules this pack enforces. Must be non-empty: an empty pack would silently enforce nothing.

Implementations

impl RulePackDef

pub fn json_schema() -> Value

Generate JSON Schema for the rule-pack format (consumed by fallow rule-pack-schema for editor autocomplete).

Trait Implementations

impl Clone for RulePackDef

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RulePackDef

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RulePackDef

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for RulePackDef

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for RulePackDef

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.