🥮 mooncakes.io
README

#proton/bootstrap

moonbit-community/proton/bootstrap loads Proton app configuration.

It decodes proton.project.json into runtime manifests and project tooling metadata. It does not install extensions or create windows.

Primary entry points:

  • load_config_manifest_from_file(...)
  • load_proton_project_config_from_file(...)
  • load_proton_project_summary_from_file(...)
  • load_runtime_manifest_from_json(...)

#
BootstrapError

source
pub(all) suberror BootstrapError {
  ProjectConfig(
ProjectConfigError)
  ManifestRead(path~ : String, detail~ : String)
  InvalidJson(context~ : String, detail~ : String)
  MissingField(path~ : String)
  InvalidField(path~ : String, expectation~ : String)
  UnsupportedField(path~ : String, reason~ : String)
  UnsupportedValue(path~ : String, value~ : String)
} derive(Eq, 
Debug)

Failures while loading user configuration or internal runtime manifests.

#
BootstrapError::message

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

#
LoadedAppManifest

source
type LoadedAppManifest

Loaded manifest plus the base directory used to resolve relative file paths.

#
LoadedAppManifest::base_dir

source
fn LoadedAppManifest::base_dir(self : LoadedAppManifest) -> String?

Returns the manifest base directory, if the manifest came from disk. Relative file entries should be interpreted against this directory when it is present.

#
LoadedAppManifest::manifest

source

Returns the loaded manifest value. This is a cheap accessor over the normalized manifest captured at load time.

#
LoadedAppManifest::new

source

Creates a loaded manifest wrapper. This is primarily used by bootstrap helpers that need to carry both the typed manifest value and its optional base directory.

#
ProtonAppMetadata

source
type ProtonAppMetadata

Release metadata resolved from proton.project.json and the nearest moon.mod.

#
ProtonAppMetadata::description

source
fn ProtonAppMetadata::description(self : ProtonAppMetadata) -> String?

#
ProtonAppMetadata::identifier

source
fn ProtonAppMetadata::identifier(self : ProtonAppMetadata) -> String?

#
ProtonAppMetadata::license

source
fn ProtonAppMetadata::license(self : ProtonAppMetadata) -> String?

#
ProtonAppMetadata::new

source
fn ProtonAppMetadata::new(product_name : String, identifier? : String?, version? : String?, description? : String?, license? : String?) -> ProtonAppMetadata

#
ProtonAppMetadata::product_name

source
fn ProtonAppMetadata::product_name(self : ProtonAppMetadata) -> String

#
ProtonAppMetadata::version

source
fn ProtonAppMetadata::version(self : ProtonAppMetadata) -> String?

#
ProtonBackendConfig

source
type ProtonBackendConfig

Backend module settings from proton.project.json.

#
ProtonBackendConfig::app_package

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

#
ProtonBackendConfig::new

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

#
ProtonBackendConfig::path

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

#
ProtonBundleConfig

source
type ProtonBundleConfig

Bundle input settings from proton.project.json.

#
ProtonBundleConfig::active

source
fn ProtonBundleConfig::active(self : ProtonBundleConfig) -> Bool

#
ProtonBundleConfig::document_extensions

source
fn ProtonBundleConfig::document_extensions(self : ProtonBundleConfig) -> Array[String]

#
ProtonBundleConfig::document_types

source

#
ProtonBundleConfig::icon

source
fn ProtonBundleConfig::icon(self : ProtonBundleConfig) -> Array[String]

#
ProtonBundleConfig::new

source
fn ProtonBundleConfig::new(active? : Bool, targets? : Array[String], icon? : Array[String], resources? : Array[String], sign? : ProtonSignConfig?, url_schemes? : Array[String], document_types? : Array[
ProjectDocumentType], output? : String) -> ProtonBundleConfig

#
ProtonBundleConfig::output

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

#
ProtonBundleConfig::resources

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

#
ProtonBundleConfig::sign

source

#
ProtonBundleConfig::targets

source
fn ProtonBundleConfig::targets(self : ProtonBundleConfig) -> Array[String]

#
ProtonBundleConfig::url_schemes

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

#
ProtonFrontendConfig

source
type ProtonFrontendConfig

Frontend dev/build settings from proton.project.json.

#
ProtonFrontendConfig::before_build

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

#
ProtonFrontendConfig::before_dev

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

#
ProtonFrontendConfig::dev_url

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

#
ProtonFrontendConfig::dist

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

#
ProtonFrontendConfig::new

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

#
ProtonFrontendConfig::path

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

#
ProtonProjectConfig

source
type ProtonProjectConfig

#
ProtonProjectConfig::backend

source

#
ProtonProjectConfig::bundle

source

#
ProtonProjectConfig::dev_manifest

source

Returns the runtime manifest that proton dev should start.

When frontend.dev_url is present, the entry is replaced in memory with that URL. The source proton.project.json file is not rewritten.

#
ProtonProjectConfig::frontend

source

#
ProtonProjectConfig::manifest

source

#
ProtonProjectConfig::metadata

source

#
ProtonProjectConfig::new

source
fn ProtonProjectConfig::new(manifest : LoadedAppManifest, metadata : ProtonAppMetadata, single_instance? : Bool, backend? : ProtonBackendConfig?, frontend? : ProtonFrontendConfig?, bundle? : ProtonBundleConfig?, updater? : ProtonUpdaterConfig?) -> ProtonProjectConfig

#
ProtonProjectConfig::single_instance

source
fn ProtonProjectConfig::single_instance(self : ProtonProjectConfig) -> Bool

#
ProtonProjectConfig::to_summary_json

source
fn ProtonProjectConfig::to_summary_json(self : ProtonProjectConfig) -> Json

Returns a normalized JSON summary suitable for proton inspect config.

#
ProtonProjectConfig::updater

source

Returns the update channel, when one is declared and active.

An inactive channel is reported as absent rather than as a channel that happens to be switched off: nothing downstream should have to remember to check a flag before trusting an endpoint.

#
ProtonSignConfig

source
type ProtonSignConfig

Signing settings from bundle.sign in proton.project.json.

#
ProtonSignConfig::binaries

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

Returns the project paths whose packaged copies must be signed.

#
ProtonSignConfig::new

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

Creates signing settings for packaged resource binaries.

#
ProtonUpdaterConfig

source
type ProtonUpdaterConfig

Complete proton.project.json document for developer tooling. The application's update channel, as declared in proton.project.json.

Only what the runtime needs to decide whether to check, and whom to trust when it does. No private key material reaches here, because none of it is anywhere the framework can see.

#
ProtonUpdaterConfig::checks_on_launch

source
fn ProtonUpdaterConfig::checks_on_launch(self : ProtonUpdaterConfig) -> Bool

#
ProtonUpdaterConfig::endpoint

source
fn ProtonUpdaterConfig::endpoint(self : ProtonUpdaterConfig) -> String

#
ProtonUpdaterConfig::freshness_days

source
fn ProtonUpdaterConfig::freshness_days(self : ProtonUpdaterConfig) -> Int

#
ProtonUpdaterConfig::new

source
fn ProtonUpdaterConfig::new(endpoint : String, public_keys : Array[String], check_on_launch? : Bool, freshness_days? : Int) -> ProtonUpdaterConfig

#
ProtonUpdaterConfig::public_keys

source
fn ProtonUpdaterConfig::public_keys(self : ProtonUpdaterConfig) -> Array[String]

#
app_manifest_to_json

source

Converts a typed runtime manifest into JSON for native runtime handoff.

#
load_config_manifest_from_file

source
fn load_config_manifest_from_file(path : String) -> LoadedAppManifest raise BootstrapError

#
load_proton_project_config_from_file

source
fn load_proton_project_config_from_file(path : String) -> ProtonProjectConfig raise BootstrapError

#
load_proton_project_summary_from_file

source
fn load_proton_project_summary_from_file(path : String) -> Json raise BootstrapError

#
load_runtime_manifest_from_json

source
fn load_runtime_manifest_from_json(text : String) -> LoadedAppManifest raise BootstrapError

Parses an internal runtime manifest from JSON text.

User-facing app config is proton.project.json. Runtime manifests are only used for native runtime bootstrap and may carry code-declared extension settings.

Source Files

Powered by MoonBit

Site sourceReport issuePackagesBuild queueSkillsStatistics

© 2026 mooncakes.io