🥮 mooncakes.io

proton_config

Typed CLI project configuration and JSON decoding for Proton.

moon add moonbit-community/proton_config@0.2.1
Download zip
Version
0.2.1
License
Apache-2.0
Repository
Last updated
7 hours ago
Downloads
470

Dependencies

README

moonbit-community/proton_config does not have a README file

#
ProjectConfigError

source
pub(all) suberror ProjectConfigError {
  FileRead(path~ : String, detail~ : String)
  Syntax(name~ : String, diagnostics~ : String)
  InvalidRoot
  Validation(errors~ : Array[ProjectConfigError])
  MissingField(path~ : String)
  DuplicateValue(path~ : String, value~ : String)
  UnknownField(path~ : String)
  InvalidField(path~ : String, expectation~ : String)
  UnsupportedValue(path~ : String, value~ : String)
} derive(Eq, 
Debug)

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

#
ProjectConfigError::equal

source

#
ProjectConfigError::message

source
fn ProjectConfigError::message(self : ProjectConfigError) -> String

#
ProjectConfigError::not_equal

source

#
ProjectConfigError::output

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

#
ProjectConfigError::to_repr

source

#
ProjectConfigError::to_string

source
fn ProjectConfigError::to_string(self : ProjectConfigError) -> String

#
ProjectBackendConfig

source
pub(all) struct ProjectBackendConfig {
  path : String
  app_package : String
} derive(Eq, 
Debug)

The MoonBit backend that proton_cli builds and launches.

#
ProjectBackendConfig::app_package

source
fn ProjectBackendConfig::app_package(self : ProjectBackendConfig) -> String

#
ProjectBackendConfig::equal

source

#
ProjectBackendConfig::new

source
fn ProjectBackendConfig::new(path : String, app_package : String) -> ProjectBackendConfig

#
ProjectBackendConfig::not_equal

source

#
ProjectBackendConfig::path

source
fn ProjectBackendConfig::path(self : ProjectBackendConfig) -> String

#
ProjectBackendConfig::to_repr

source

#
ProjectConfig

source
pub(all) struct ProjectConfig {
  base_dir : String
  backend : ProjectBackendConfig?
  frontend : ProjectFrontendConfig?
  package_config : ProjectPackageConfig?
} derive(Eq, 
Debug)

CLI-only project description. Application runtime behavior belongs in MoonBit code and is intentionally absent from this type.

#
ProjectConfig::backend

source

#
ProjectConfig::base_dir

source
fn ProjectConfig::base_dir(self : ProjectConfig) -> String

#
ProjectConfig::equal

source

#
ProjectConfig::frontend

source

#
ProjectConfig::new

source
fn ProjectConfig::new(base_dir : String, backend? : ProjectBackendConfig?, frontend? : ProjectFrontendConfig?, package_config? : ProjectPackageConfig?) -> ProjectConfig

#
ProjectConfig::not_equal

source
fn ProjectConfig::not_equal(x : ProjectConfig, y : ProjectConfig) -> Bool

#
ProjectConfig::package_config

source
fn ProjectConfig::package_config(self : ProjectConfig) -> ProjectPackageConfig?

#
ProjectConfig::to_repr

source

#
ProjectDocumentType

source
pub(all) struct ProjectDocumentType {
  name : String
  extensions : Array[String]
  role : String
} derive(Eq, 
Debug)

#
ProjectDocumentType::equal

source

#
ProjectDocumentType::extensions

source
fn ProjectDocumentType::extensions(self : ProjectDocumentType) -> Array[String]

#
ProjectDocumentType::new

source
fn ProjectDocumentType::new(name : String, extensions : Array[String], role? : String) -> ProjectDocumentType

#
ProjectDocumentType::not_equal

source

#
ProjectDocumentType::to_repr

source

#
ProjectFrontendConfig

source
pub(all) struct ProjectFrontendConfig {
  dev_url : String?
  dist : String?
  before_dev : String?
  before_build : String?
  path : String?
} derive(Eq, 
Debug)

Frontend commands and paths needed before the application can run.

#
ProjectFrontendConfig::before_build

source
fn ProjectFrontendConfig::before_build(self : ProjectFrontendConfig) -> String?

#
ProjectFrontendConfig::before_dev

source
fn ProjectFrontendConfig::before_dev(self : ProjectFrontendConfig) -> String?

#
ProjectFrontendConfig::dev_url

source
fn ProjectFrontendConfig::dev_url(self : ProjectFrontendConfig) -> String?

#
ProjectFrontendConfig::dist

source
fn ProjectFrontendConfig::dist(self : ProjectFrontendConfig) -> String?

#
ProjectFrontendConfig::equal

source

#
ProjectFrontendConfig::new

source
fn ProjectFrontendConfig::new(dev_url? : String?, dist? : String?, before_dev? : String?, before_build? : String?, path? : String?) -> ProjectFrontendConfig

#
ProjectFrontendConfig::not_equal

source

#
ProjectFrontendConfig::path

source
fn ProjectFrontendConfig::path(self : ProjectFrontendConfig) -> String?

#
ProjectFrontendConfig::to_repr

source

#
ProjectPackageConfig

source
pub(all) struct ProjectPackageConfig {
  product_name : String
  identifier : String
  version : String
  formats : Array[String]
  icons : Array[String]
  resources : Array[String]
  sign : ProjectSignConfig?
  url_schemes : Array[String]
  document_types : Array[ProjectDocumentType]
  output : String
} derive(Eq, 
Debug)

Static metadata and payload inputs consumed by proton_cli package.

#
ProjectPackageConfig::document_types

source

#
ProjectPackageConfig::equal

source

#
ProjectPackageConfig::formats

source
fn ProjectPackageConfig::formats(self : ProjectPackageConfig) -> Array[String]

#
ProjectPackageConfig::icons

source
fn ProjectPackageConfig::icons(self : ProjectPackageConfig) -> Array[String]

#
ProjectPackageConfig::new

source
fn ProjectPackageConfig::new(product_name : String, identifier : String, version : String, formats? : Array[String], icons? : Array[String], resources? : Array[String], sign? : ProjectSignConfig?, url_schemes? : Array[String], document_types? : Array[ProjectDocumentType], output? : String) -> ProjectPackageConfig

#
ProjectPackageConfig::not_equal

source

#
ProjectPackageConfig::output

source
fn ProjectPackageConfig::output(self : ProjectPackageConfig) -> String

#
ProjectPackageConfig::resources

source
fn ProjectPackageConfig::resources(self : ProjectPackageConfig) -> Array[String]

#
ProjectPackageConfig::sign

source

#
ProjectPackageConfig::to_repr

source

#
ProjectPackageConfig::url_schemes

source
fn ProjectPackageConfig::url_schemes(self : ProjectPackageConfig) -> Array[String]

#
ProjectPackageConfig::version

source
fn ProjectPackageConfig::version(self : ProjectPackageConfig) -> String

#
ProjectSignConfig

source
pub(all) struct ProjectSignConfig {
  binaries : Array[String]
} derive(Eq, 
Debug)

#
ProjectSignConfig::binaries

source
fn ProjectSignConfig::binaries(self : ProjectSignConfig) -> Array[String]

#
ProjectSignConfig::equal

source

#
ProjectSignConfig::new

source
fn ProjectSignConfig::new(binaries? : Array[String]) -> ProjectSignConfig

#
ProjectSignConfig::not_equal

source
fn ProjectSignConfig::not_equal(x : ProjectSignConfig, y : ProjectSignConfig) -> Bool

#
ProjectSignConfig::to_repr

source

#
load_project_config_from_file

source
fn load_project_config_from_file(path : String) -> ProjectConfig raise ProjectConfigError

#
load_project_config_from_json

source
fn load_project_config_from_json(json : Json, base_dir : String) -> ProjectConfig raise ProjectConfigError

#
load_project_config_from_text

source
fn load_project_config_from_text(source : String, base_dir : String, name? : String) -> ProjectConfig raise ProjectConfigError

Source Files

Powered by MoonBit

Site sourceReport issuePackagesBuild queueSkillsStatistics

© 2026 mooncakes.io