Struct ExternalPluginDef 

pub struct ExternalPluginDef {
    pub schema: Option<String>,
    pub name: String,
    pub detection: Option<PluginDetection>,
    pub enablers: Vec<String>,
    pub entry_points: Vec<String>,
    pub entry_point_role: EntryPointRole,
    pub config_patterns: Vec<String>,
    pub always_used: Vec<String>,
    pub tooling_dependencies: Vec<String>,
    pub used_exports: Vec<ExternalUsedExport>,
}

A declarative plugin definition loaded from a standalone file or inline config.

External plugins provide the same static pattern capabilities as built-in plugins (entry points, always-used files, used exports, tooling dependencies), but are defined in standalone files or inline in the fallow config rather than compiled Rust code.

They cannot do AST-based config parsing (resolve_config()), but cover the vast majority of framework integration use cases.

Supports JSONC, JSON, and TOML formats. All use camelCase field names.

{
  "$schema": "https://raw.githubusercontent.com/fallow-rs/fallow/main/plugin-schema.json",
  "name": "my-framework",
  "enablers": ["my-framework", "@my-framework/core"],
  "entryPoints": ["src/routes/**/*.{ts,tsx}"],
  "configPatterns": ["my-framework.config.{ts,js}"],
  "alwaysUsed": ["src/setup.ts"],
  "toolingDependencies": ["my-framework-cli"],
  "usedExports": [
    { "pattern": "src/routes/**/*.{ts,tsx}", "exports": ["default", "loader", "action"] }
  ]
}

Fields

schema: Option<String>

JSON Schema reference (ignored during deserialization).

name: String

Unique name for this plugin.

detection: Option<PluginDetection>

Rich detection logic (dependency checks, file existence, boolean combinators). Takes priority over enablers when set.

enablers: Vec<String>

Package names that activate this plugin when found in package.json. Supports exact matches and prefix patterns (ending with /). Only used when detection is not set.

entry_points: Vec<String>

Glob patterns for entry point files.

entry_point_role: EntryPointRole

Coverage role for entryPoints.

Defaults to support. Set to runtime for application entry points or test for test framework entry points.

config_patterns: Vec<String>

Glob patterns for config files (marked as always-used when active).

always_used: Vec<String>

Files that are always considered “used” when this plugin is active.

tooling_dependencies: Vec<String>

Dependencies that are tooling (used via CLI/config, not source imports). These should not be flagged as unused devDependencies.

used_exports: Vec<ExternalUsedExport>

Exports that are always considered used for matching file patterns.

Implementations

impl ExternalPluginDef

pub fn json_schema() -> Value

Generate JSON Schema for the external plugin format.

Trait Implementations

impl Clone for ExternalPluginDef

fn clone(&self) -> ExternalPluginDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExternalPluginDef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ExternalPluginDef

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ExternalPluginDef

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 ExternalPluginDef

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

where __S: Serializer,

Serialize this value into the given Serde serializer.