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
- ::equalPlatform::equal
- ::not_equalPlatform::not_equal
- ::to_reprPlatform::to_repr
- ::SignConfigSignConfig::SignConfig
- ::equalSignConfig::equal
- ::from_jsonSignConfig::from_json
- ::not_equalSignConfig::not_equal
- ::to_jsonSignConfig::to_json
- ::to_reprSignConfig::to_repr
V
current_platform
V
validate_application_identifier

proton_config

Typed application configuration shared by Proton and its CLI.

Download zip

Author

moonbit-community

Version

0.7.0

License

Apache-2.0

Repository

github.com/moonbit-community/proton

Last updated

2 days ago

Downloads

27K

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, @moonbitlang/core/debug.Debug
Debug)

Effective host-platform configuration shared by tooling and applications. Loading resolves root platform overrides; relative paths remain unchanged.

impl ToJson for AppConfig

impl FromJson for AppConfig

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 effective configuration snapshot.

AppConfig::decode

source

fn AppConfig::decode(json : Json, platform? : Platform) -> AppConfig raise AppConfigError

Resolves a project into a typed configuration without changing path strings. All platform sections are checked, including those not selected by this host.

AppConfig::equal

source

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

AppConfig::from_json

source

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

AppConfig::load

source

fn AppConfig::load(path : String, platform? : Platform) -> AppConfig raise AppConfigError

Reads project configuration and resolves the selected host's overrides.

AppConfig::not_equal

source

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

AppConfig::parse

source

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

Decodes project configuration. Defaults are applied after platform overrides.

AppConfig::to_json

source

fn AppConfig::to_json(self : 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 on an effective configuration.

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
  minimum_system_version : String?
  nsis_install_mode : String?
} 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, minimum_system_version? : String?, nsis_install_mode? : String?) -> 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

Platform

source

pub(all) enum Platform {
  Macos
  Windows
  Linux
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Desktop host used to select project overrides, independently of build targets.

Platform::equal

source

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

Platform::not_equal

source

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

Platform::to_repr

source

fn Platform::to_repr(Platform) -> @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

current_platform

source

fn current_platform() -> Platform

Returns the operating system on which the configuration is being used.

validate_application_identifier

source

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

Validates and trims a canonical reverse-DNS application identifier.

Source Files

Install

Download zip

Typed application configuration shared by Proton and its CLI.

moonbit-community

Apache-2.0

github.com/moonbit-community/proton

Updated 2 days ago

27K downloads

Site source Report issue Modules Skills CLI Build queue 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

#Platform

#Platform::equal

#Platform::not_equal

#Platform::to_repr

#SignConfig

#SignConfig::SignConfig

#SignConfig::equal

#SignConfig::from_json

#SignConfig::not_equal

#SignConfig::to_json

#SignConfig::to_repr

#current_platform

#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

Platform

Platform::equal

Platform::not_equal

Platform::to_repr

SignConfig

SignConfig::SignConfig

SignConfig::equal

SignConfig::from_json

SignConfig::not_equal

SignConfig::to_json

SignConfig::to_repr

current_platform

validate_application_identifier