README
- ::equalAppConfigError::equal
- ::messageAppConfigError::message
- ::not_equalAppConfigError::not_equal
- ::outputAppConfigError::output
- ::to_reprAppConfigError::to_repr
- ::to_stringAppConfigError::to_string
- ::AppConfigAppConfig::AppConfig
- ::copyAppConfig::copy
- ::decodeAppConfig::decode
- ::equalAppConfig::equal
- ::from_jsonAppConfig::from_json
- ::loadAppConfig::load
- ::not_equalAppConfig::not_equal
- ::parseAppConfig::parse
- ::to_jsonAppConfig::to_json
- ::to_reprAppConfig::to_repr
- ::validateAppConfig::validate
- ::BackendConfigBackendConfig::BackendConfig
- ::equalBackendConfig::equal
- ::from_jsonBackendConfig::from_json
- ::not_equalBackendConfig::not_equal
- ::to_jsonBackendConfig::to_json
- ::to_reprBackendConfig::to_repr
- ::DocumentTypeDocumentType::DocumentType
- ::equalDocumentType::equal
- ::from_jsonDocumentType::from_json
- ::not_equalDocumentType::not_equal
- ::to_jsonDocumentType::to_json
- ::to_reprDocumentType::to_repr
- ::FrontendConfigFrontendConfig::FrontendConfig
- ::equalFrontendConfig::equal
- ::from_jsonFrontendConfig::from_json
- ::not_equalFrontendConfig::not_equal
- ::to_jsonFrontendConfig::to_json
- ::to_reprFrontendConfig::to_repr
- ::PackageConfigPackageConfig::PackageConfig
- ::equalPackageConfig::equal
- ::from_jsonPackageConfig::from_json
- ::not_equalPackageConfig::not_equal
- ::to_jsonPackageConfig::to_json
- ::to_reprPackageConfig::to_repr
- ::PackagePlatformsPackagePlatforms::PackagePlatforms
- ::equalPackagePlatforms::equal
- ::from_jsonPackagePlatforms::from_json
- ::not_equalPackagePlatforms::not_equal
- ::to_jsonPackagePlatforms::to_json
- ::to_reprPackagePlatforms::to_repr
- ::PlatformPackageConfigPlatformPackageConfig::PlatformPackageConfig
- ::equalPlatformPackageConfig::equal
- ::from_jsonPlatformPackageConfig::from_json
- ::not_equalPlatformPackageConfig::not_equal
- ::to_jsonPlatformPackageConfig::to_json
- ::to_reprPlatformPackageConfig::to_repr
- ::SignConfigSignConfig::SignConfig
- ::equalSignConfig::equal
- ::from_jsonSignConfig::from_json
- ::not_equalSignConfig::not_equal
- ::to_jsonSignConfig::to_json
- ::to_reprSignConfig::to_repr
V
validate_application_identifier

proton_config

Typed application configuration shared by Proton and its CLI.

Download zip

Author

moonbit-community

Version

0.4.0

License

Apache-2.0

Repository

github.com/moonbit-community/proton

Last updated

5 days ago

Downloads

21K

Dependencies

moonbitlang/x0.5.5

moonbit-community/proton_config does not have a README file

AppConfigError

source

pub(all) suberror AppConfigError {
  FileRead(path~ : String, detail~ : String)
  Syntax(name~ : String, diagnostics~ : String)
  InvalidRoot
  Validation(errors~ : Array[AppConfigError])
  MissingField(path~ : String)
  DuplicateValue(path~ : String, value~ : String)
  UnknownField(path~ : String)
  InvalidField(path~ : String, expectation~ : String)
  UnsupportedValue(path~ : String, value~ : String)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Failures produced while loading and validating proton.project.json.

AppConfigError::equal

source

fn AppConfigError::equal(AppConfigError, AppConfigError) -> Bool

AppConfigError::message

source

fn AppConfigError::message(self : AppConfigError) -> String

AppConfigError::not_equal

source

fn AppConfigError::not_equal(x : AppConfigError, y : AppConfigError) -> Bool

AppConfigError::output

source

fn AppConfigError::output(self : AppConfigError, logger : &Logger) -> Unit

AppConfigError::to_repr

source

fn AppConfigError::to_repr(AppConfigError) -> @moonbitlang/core/debug.Repr
Repr

AppConfigError::to_string

source

fn AppConfigError::to_string(self : AppConfigError) -> String

AppConfig

source

pub(all) struct AppConfig {
  identifier : String
  backend : BackendConfig?
  frontend : FrontendConfig?
  package_config : PackageConfig?
} derive(Eq, ToJson, @moonbitlang/core/debug.Debug
Debug, @moonbitlang/core/json.FromJson
FromJson)

Project description shared by Proton tooling and managed applications.

AppConfig::AppConfig

source

fn AppConfig::AppConfig(identifier : String, backend? : BackendConfig?, frontend? : FrontendConfig?, package_config? : PackageConfig?) -> AppConfig

AppConfig::copy

source

fn AppConfig::copy(self : AppConfig) -> AppConfig

Returns an independent configuration snapshot.

AppConfig::decode

source

fn AppConfig::decode(json : Json) -> AppConfig raise AppConfigError

Decodes a complete configuration. Relative paths remain relative.

AppConfig::equal

source

fn AppConfig::equal(AppConfig, AppConfig) -> Bool

AppConfig::from_json

source

fn AppConfig::from_json(Json, @moonbitlang/core/json.JsonPath
JsonPath) -> AppConfig raise @moonbitlang/core/json.JsonDecodeError
JsonDecodeError

AppConfig::load

source

fn AppConfig::load(path : String) -> AppConfig raise AppConfigError

Reads a complete application configuration without resolving its paths.

AppConfig::not_equal

source

fn AppConfig::not_equal(x : AppConfig, y : AppConfig) -> Bool

AppConfig::parse

source

fn AppConfig::parse(source : String, name? : String) -> AppConfig raise AppConfigError

Decodes the project JSON format, applying defaults and semantic validation.

AppConfig::to_json

source

fn AppConfig::to_json(AppConfig) -> Json

AppConfig::to_repr

source

fn AppConfig::to_repr(AppConfig) -> @moonbitlang/core/debug.Repr
Repr

AppConfig::validate

source

fn AppConfig::validate(self : AppConfig) -> Unit raise AppConfigError

Checks semantic constraints independently of JSON decoding.

BackendConfig

source

pub(all) struct BackendConfig {
  path : String
  app_package : String
} derive(Eq, ToJson, @moonbitlang/core/debug.Debug
Debug, @moonbitlang/core/json.FromJson
FromJson)

The MoonBit backend that proton_cli builds and launches.

BackendConfig::BackendConfig

source

fn BackendConfig::BackendConfig(path : String, app_package : String) -> BackendConfig

BackendConfig::equal

source

fn BackendConfig::equal(BackendConfig, BackendConfig) -> Bool

BackendConfig::from_json

source

fn BackendConfig::from_json(Json, @moonbitlang/core/json.JsonPath
JsonPath) -> BackendConfig raise @moonbitlang/core/json.JsonDecodeError
JsonDecodeError

BackendConfig::not_equal

source

fn BackendConfig::not_equal(x : BackendConfig, y : BackendConfig) -> Bool

BackendConfig::to_json

source

fn BackendConfig::to_json(BackendConfig) -> Json

BackendConfig::to_repr

source

fn BackendConfig::to_repr(BackendConfig) -> @moonbitlang/core/debug.Repr
Repr

DocumentType

source

pub(all) struct DocumentType {
  name : String
  extensions : Array[String]
  role : String
} derive(Eq, ToJson, @moonbitlang/core/debug.Debug
Debug, @moonbitlang/core/json.FromJson
FromJson)

DocumentType::DocumentType

source

fn DocumentType::DocumentType(name : String, extensions : Array[String], role? : String) -> DocumentType

DocumentType::equal

source

fn DocumentType::equal(DocumentType, DocumentType) -> Bool

DocumentType::from_json

source

fn DocumentType::from_json(Json, @moonbitlang/core/json.JsonPath
JsonPath) -> DocumentType raise @moonbitlang/core/json.JsonDecodeError
JsonDecodeError

DocumentType::not_equal

source

fn DocumentType::not_equal(x : DocumentType, y : DocumentType) -> Bool

DocumentType::to_json

source

fn DocumentType::to_json(DocumentType) -> Json

DocumentType::to_repr

source

fn DocumentType::to_repr(DocumentType) -> @moonbitlang/core/debug.Repr
Repr

FrontendConfig

source

pub(all) struct FrontendConfig {
  dev_url : String?
  dist : String?
  before_dev : String?
  before_build : String?
  path : String?
} derive(Eq, ToJson, @moonbitlang/core/debug.Debug
Debug, @moonbitlang/core/json.FromJson
FromJson)

Frontend commands and paths needed before the application can run.

FrontendConfig::FrontendConfig

source

fn FrontendConfig::FrontendConfig(dev_url? : String?, dist? : String?, before_dev? : String?, before_build? : String?, path? : String?) -> FrontendConfig

FrontendConfig::equal

source

fn FrontendConfig::equal(FrontendConfig, FrontendConfig) -> Bool

FrontendConfig::from_json

source

fn FrontendConfig::from_json(Json, @moonbitlang/core/json.JsonPath
JsonPath) -> FrontendConfig raise @moonbitlang/core/json.JsonDecodeError
JsonDecodeError

FrontendConfig::not_equal

source

fn FrontendConfig::not_equal(x : FrontendConfig, y : FrontendConfig) -> Bool

FrontendConfig::to_json

source

fn FrontendConfig::to_json(FrontendConfig) -> Json

FrontendConfig::to_repr

source

fn FrontendConfig::to_repr(FrontendConfig) -> @moonbitlang/core/debug.Repr
Repr

PackageConfig

source

pub(all) struct PackageConfig {
  product_name : String
  version : String
  formats : Array[String]
  icons : Array[String]
  prepare : String?
  resources : Array[String]
  sign : SignConfig?
  url_schemes : Array[String]
  document_types : Array[DocumentType]
  output : String
  platforms : PackagePlatforms
} derive(Eq, ToJson, @moonbitlang/core/debug.Debug
Debug, @moonbitlang/core/json.FromJson
FromJson)

Package metadata, input preparation, and payloads consumed by proton_cli package.

PackageConfig::PackageConfig

source

fn PackageConfig::PackageConfig(product_name : String, version : String, formats? : Array[String], icons? : Array[String], prepare? : String?, resources? : Array[String], sign? : SignConfig?, url_schemes? : Array[String], document_types? : Array[DocumentType], output? : String, platforms? : PackagePlatforms) -> PackageConfig

PackageConfig::equal

source

fn PackageConfig::equal(PackageConfig, PackageConfig) -> Bool

PackageConfig::from_json

source

fn PackageConfig::from_json(Json, @moonbitlang/core/json.JsonPath
JsonPath) -> PackageConfig raise @moonbitlang/core/json.JsonDecodeError
JsonDecodeError

PackageConfig::not_equal

source

fn PackageConfig::not_equal(x : PackageConfig, y : PackageConfig) -> Bool

PackageConfig::to_json

source

fn PackageConfig::to_json(PackageConfig) -> Json

PackageConfig::to_repr

source

fn PackageConfig::to_repr(PackageConfig) -> @moonbitlang/core/debug.Repr
Repr

PackagePlatforms

source

pub(all) struct PackagePlatforms {
  macos : PlatformPackageConfig?
  windows : PlatformPackageConfig?
  linux : PlatformPackageConfig?
} derive(Eq, ToJson, @moonbitlang/core/debug.Debug
Debug, @moonbitlang/core/json.FromJson
FromJson)

Optional package overrides for each supported desktop platform.

PackagePlatforms::PackagePlatforms

source

fn PackagePlatforms::PackagePlatforms(macos? : PlatformPackageConfig, windows? : PlatformPackageConfig, linux? : PlatformPackageConfig) -> PackagePlatforms

PackagePlatforms::equal

source

fn PackagePlatforms::equal(PackagePlatforms, PackagePlatforms) -> Bool

PackagePlatforms::from_json

source

fn PackagePlatforms::from_json(Json, @moonbitlang/core/json.JsonPath
JsonPath) -> PackagePlatforms raise @moonbitlang/core/json.JsonDecodeError
JsonDecodeError

PackagePlatforms::not_equal

source

fn PackagePlatforms::not_equal(x : PackagePlatforms, y : PackagePlatforms) -> Bool

PackagePlatforms::to_json

source

fn PackagePlatforms::to_json(PackagePlatforms) -> Json

PackagePlatforms::to_repr

source

fn PackagePlatforms::to_repr(PackagePlatforms) -> @moonbitlang/core/debug.Repr
Repr

PlatformPackageConfig

source

pub(all) struct PlatformPackageConfig {
  formats : Array[String]?
  resources : Array[String]
  sign : SignConfig?
  minimum_system_version : String?
  nsis_install_mode : String?
} derive(Eq, ToJson, @moonbitlang/core/debug.Debug
Debug, @moonbitlang/core/json.FromJson
FromJson)

Package inputs that apply only to one desktop platform. minimum_system_version is macOS-only and changes package metadata, not compiler deployment targets.

PlatformPackageConfig::PlatformPackageConfig

source

fn PlatformPackageConfig::PlatformPackageConfig(formats? : Array[String], resources? : Array[String], sign? : SignConfig, minimum_system_version? : String, nsis_install_mode? : String) -> PlatformPackageConfig

PlatformPackageConfig::equal

source

fn PlatformPackageConfig::equal(PlatformPackageConfig, PlatformPackageConfig) -> Bool

PlatformPackageConfig::from_json

source

fn PlatformPackageConfig::from_json(Json, @moonbitlang/core/json.JsonPath
JsonPath) -> PlatformPackageConfig raise @moonbitlang/core/json.JsonDecodeError
JsonDecodeError

PlatformPackageConfig::not_equal

source

fn PlatformPackageConfig::not_equal(x : PlatformPackageConfig, y : PlatformPackageConfig) -> Bool

PlatformPackageConfig::to_json

source

fn PlatformPackageConfig::to_json(PlatformPackageConfig) -> Json

PlatformPackageConfig::to_repr

source

fn PlatformPackageConfig::to_repr(PlatformPackageConfig) -> @moonbitlang/core/debug.Repr
Repr

SignConfig

source

pub(all) struct SignConfig {
  binaries : Array[String]
} derive(Eq, ToJson, @moonbitlang/core/debug.Debug
Debug, @moonbitlang/core/json.FromJson
FromJson)

SignConfig::SignConfig

source

fn SignConfig::SignConfig(binaries? : Array[String]) -> SignConfig

SignConfig::equal

source

fn SignConfig::equal(SignConfig, SignConfig) -> Bool

SignConfig::from_json

source

fn SignConfig::from_json(Json, @moonbitlang/core/json.JsonPath
JsonPath) -> SignConfig raise @moonbitlang/core/json.JsonDecodeError
JsonDecodeError

SignConfig::not_equal

source

fn SignConfig::not_equal(x : SignConfig, y : SignConfig) -> Bool

SignConfig::to_json

source

fn SignConfig::to_json(SignConfig) -> Json

SignConfig::to_repr

source

fn SignConfig::to_repr(SignConfig) -> @moonbitlang/core/debug.Repr
Repr

validate_application_identifier

source

fn validate_application_identifier(value : String) -> String raise AppConfigError

Validates and trims a canonical reverse-DNS application identifier.

Source Files

Site source Report issue Packages Build queue Skills Statistics

proton_config

#AppConfigError

#AppConfigError::equal

#AppConfigError::message

#AppConfigError::not_equal

#AppConfigError::output

#AppConfigError::to_repr

#AppConfigError::to_string

#AppConfig

#AppConfig::AppConfig

#AppConfig::copy

#AppConfig::decode

#AppConfig::equal

#AppConfig::from_json

#AppConfig::load

#AppConfig::not_equal

#AppConfig::parse

#AppConfig::to_json

#AppConfig::to_repr

#AppConfig::validate

#BackendConfig

#BackendConfig::BackendConfig

#BackendConfig::equal

#BackendConfig::from_json

#BackendConfig::not_equal

#BackendConfig::to_json

#BackendConfig::to_repr

#DocumentType

#DocumentType::DocumentType

#DocumentType::equal

#DocumentType::from_json

#DocumentType::not_equal

#DocumentType::to_json

#DocumentType::to_repr

#FrontendConfig

#FrontendConfig::FrontendConfig

#FrontendConfig::equal

#FrontendConfig::from_json

#FrontendConfig::not_equal

#FrontendConfig::to_json

#FrontendConfig::to_repr

#PackageConfig

#PackageConfig::PackageConfig

#PackageConfig::equal

#PackageConfig::from_json

#PackageConfig::not_equal

#PackageConfig::to_json

#PackageConfig::to_repr

#PackagePlatforms

#PackagePlatforms::PackagePlatforms

#PackagePlatforms::equal

#PackagePlatforms::from_json

#PackagePlatforms::not_equal

#PackagePlatforms::to_json

#PackagePlatforms::to_repr

#PlatformPackageConfig

#PlatformPackageConfig::PlatformPackageConfig

#PlatformPackageConfig::equal

#PlatformPackageConfig::from_json

#PlatformPackageConfig::not_equal

#PlatformPackageConfig::to_json

#PlatformPackageConfig::to_repr

#SignConfig

#SignConfig::SignConfig

#SignConfig::equal

#SignConfig::from_json

#SignConfig::not_equal

#SignConfig::to_json

#SignConfig::to_repr

#validate_application_identifier

Source Files

AppConfigError

AppConfigError::equal

AppConfigError::message

AppConfigError::not_equal

AppConfigError::output

AppConfigError::to_repr

AppConfigError::to_string

AppConfig

AppConfig::AppConfig

AppConfig::copy

AppConfig::decode

AppConfig::equal

AppConfig::from_json

AppConfig::load

AppConfig::not_equal

AppConfig::parse

AppConfig::to_json

AppConfig::to_repr

AppConfig::validate

BackendConfig

BackendConfig::BackendConfig

BackendConfig::equal

BackendConfig::from_json

BackendConfig::not_equal

BackendConfig::to_json

BackendConfig::to_repr

DocumentType

DocumentType::DocumentType

DocumentType::equal

DocumentType::from_json

DocumentType::not_equal

DocumentType::to_json

DocumentType::to_repr

FrontendConfig

FrontendConfig::FrontendConfig

FrontendConfig::equal

FrontendConfig::from_json

FrontendConfig::not_equal

FrontendConfig::to_json

FrontendConfig::to_repr

PackageConfig

PackageConfig::PackageConfig

PackageConfig::equal

PackageConfig::from_json

PackageConfig::not_equal

PackageConfig::to_json

PackageConfig::to_repr

PackagePlatforms

PackagePlatforms::PackagePlatforms

PackagePlatforms::equal

PackagePlatforms::from_json

PackagePlatforms::not_equal

PackagePlatforms::to_json

PackagePlatforms::to_repr

PlatformPackageConfig

PlatformPackageConfig::PlatformPackageConfig

PlatformPackageConfig::equal

PlatformPackageConfig::from_json

PlatformPackageConfig::not_equal

PlatformPackageConfig::to_json

PlatformPackageConfig::to_repr

SignConfig

SignConfig::SignConfig

SignConfig::equal

SignConfig::from_json

SignConfig::not_equal

SignConfig::to_json

SignConfig::to_repr

validate_application_identifier