licence_audit/config

Types

Error

pub type Error {
  InvalidToml(String)
  MissingPolicy
  MissingPolicySection(path: String)
  InvalidField(field: String, expected: String)
  UnknownField(String)
  InvalidLicenceIdentifier
  InvalidException(String)
  FileReadError(String)
}

Constructors

```
InvalidToml(String)
```
```
MissingPolicy
```
```
MissingPolicySection(path: String)
```

InvalidField(field: String, expected: String)

```
UnknownField(String)
```
```
InvalidLicenceIdentifier
```
```
InvalidException(String)
```
```
FileReadError(String)
```

LoadOptions

</>

pub type LoadOptions {
  LoadOptions(
    config_path: option.Option(String),
    project_root: String,
    allow_licences: List(String),
    deny_licences: List(String),
    vuln_severity: option.Option(String),
    vuln_block_unknown: Bool,
    ignore_config: Bool,
    check: Bool,
  )
}

Constructors

LoadOptions(
  config_path: option.Option(String),
  project_root: String,
  allow_licences: List(String),
  deny_licences: List(String),
  vuln_severity: option.Option(String),
  vuln_block_unknown: Bool,
  ignore_config: Bool,
  check: Bool,
)

Notices

</>

pub type Notices {
  Notices(include: List(String), exclude: List(String))
}

Constructors

Notices(include: List(String), exclude: List(String))

Policy

</>

pub type Policy {
  Policy(
    allow: List(String),
    deny: List(String),
    vuln_severity: option.Option(String),
    vuln_block_unknown: Bool,
    exceptions: List(exception.Exception),
  )
}

Constructors

Policy(
  allow: List(String),
  deny: List(String),
  vuln_severity: option.Option(String),
  vuln_block_unknown: Bool,
  exceptions: List(exception.Exception),
)

Values

load

</>

pub fn load(options: LoadOptions) -> Result(Policy, Error)

load_notices

</>

pub fn load_notices(
  project_root: String,
  config_path: option.Option(String),
  ignore_config: Bool,
) -> Result(Notices, Error)

merge

</>

pub fn merge(
  file_policy: Policy,
  cli_policy: Policy,
) -> Result(Policy, Error)

parse

</>

pub fn parse(input: String) -> Result(Policy, Error)

parse_notices

</>

pub fn parse_notices(input: String) -> Result(Notices, Error)