🥮 mooncakes.io
    Sign in

    proton_config

    Typed project configuration models and JSON decoding for Proton.

    Download zip
    Version
    0.1.17
    License
    Apache-2.0
    Repository
    Last updated
    2 months ago
    Downloads
    26K

    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)
      UnsupportedField(path~ : String, reason~ : 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

    LoadedProjectConfig

    source
    pub(all) struct LoadedProjectConfig {
      config : ProjectConfig
      warnings : Array[String]
    } derive(Eq, 
    Debug    )

    LoadedProjectConfig::config

    source

    LoadedProjectConfig::equal

    source

    LoadedProjectConfig::new

    source
    fn LoadedProjectConfig::new(config : ProjectConfig, warnings? : Array[String]) -> LoadedProjectConfig

    LoadedProjectConfig::not_equal

    source

    LoadedProjectConfig::to_repr

    source

    LoadedProjectConfig::warnings

    source
    fn LoadedProjectConfig::warnings(self : LoadedProjectConfig) -> Array[String]

    MoonModMetadata

    source
    pub(all) struct MoonModMetadata {
      root_dir : String?
      name : String?
      version : String?
      description : String?
      license : String?
      repository : String?
      readme : String?
      keywords : Array[String]
    } derive(Eq, 
    Debug    )

    Metadata read from a moon.mod file.

    MoonModMetadata::equal

    source

    MoonModMetadata::not_equal

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

    MoonModMetadata::to_repr

    source

    ProjectAppWindowConfig

    source
    pub(all) struct ProjectAppWindowConfig {
      id : String
      window : ProjectWindowConfig
      entry : ProjectEntry
      open_on_start : Bool
    } derive(Eq, 
    Debug    )

    ProjectAppWindowConfig::equal

    source

    ProjectAppWindowConfig::new

    source
    fn ProjectAppWindowConfig::new(id : String, window : ProjectWindowConfig, entry : ProjectEntry, open_on_start? : Bool) -> ProjectAppWindowConfig

    ProjectAppWindowConfig::not_equal

    source

    ProjectAppWindowConfig::to_repr

    source

    ProjectBackendConfig

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

    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

    ProjectBundleConfig

    source
    pub(all) struct ProjectBundleConfig {
      active : Bool
      targets : Array[String]
      icon : Array[String]
      resources : Array[String]
      sign : ProjectSignConfig?
      url_schemes : Array[String]
      document_types : Array[ProjectDocumentType]
      output : String
    } derive(Eq, 
    Debug    )

    ProjectBundleConfig::active

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

    ProjectBundleConfig::equal

    source

    ProjectBundleConfig::new

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

    ProjectBundleConfig::not_equal

    source

    ProjectBundleConfig::output

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

    ProjectBundleConfig::to_repr

    source

    ProjectConfig

    source
    pub(all) struct ProjectConfig {
      base_dir : String
      window : ProjectWindowConfig
      entry : ProjectEntry
      windows : Array[ProjectAppWindowConfig]
      metadata : ProjectMetadata
      backend : ProjectBackendConfig?
      frontend : ProjectFrontendConfig?
      bundle : ProjectBundleConfig?
      updater : ProjectUpdaterConfig?
      permissions : Array[ProjectPermissionGrant]
      debug : Int
      single_instance : Bool
    } derive(Eq, 
    Debug    )

    ProjectConfig::backend

    source

    ProjectConfig::base_dir

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

    ProjectConfig::bundle

    source

    ProjectConfig::debug

    source
    fn ProjectConfig::debug(self : ProjectConfig) -> Int

    ProjectConfig::entries

    source

    Returns the primary entry followed by each secondary window entry in declaration order.

    ProjectConfig::entry

    source

    ProjectConfig::equal

    source

    ProjectConfig::frontend

    source

    ProjectConfig::metadata

    source

    ProjectConfig::new

    source
    fn ProjectConfig::new(base_dir : String, window : ProjectWindowConfig, entry : ProjectEntry, metadata : ProjectMetadata, windows? : Array[ProjectAppWindowConfig], backend? : ProjectBackendConfig?, frontend? : ProjectFrontendConfig?, bundle? : ProjectBundleConfig?, updater? : ProjectUpdaterConfig?, permissions? : Array[ProjectPermissionGrant], debug? : Int, single_instance? : Bool) -> ProjectConfig

    ProjectConfig::not_equal

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

    ProjectConfig::permissions

    source

    ProjectConfig::single_instance

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

    ProjectConfig::to_repr

    source

    ProjectConfig::updater

    source

    ProjectConfig::window

    source

    ProjectConfig::windows

    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

    ProjectEntry

    source
    pub(all) enum ProjectEntry {
      Html(String)
      Url(String)
      File(String)
      Asset(String)
    } derive(Eq, 
    Debug    )

    ProjectEntry::equal

    source

    ProjectEntry::not_equal

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

    ProjectEntry::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    )

    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

    ProjectMetadata

    source
    pub(all) struct ProjectMetadata {
      product_name : String
      identifier : String?
      version : String?
      description : String?
      license : String?
    } derive(Eq, 
    Debug    )

    ProjectMetadata::equal

    source

    ProjectMetadata::new

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

    ProjectMetadata::not_equal

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

    ProjectMetadata::to_repr

    source

    ProjectPermissionGrant

    source
    pub(all) struct ProjectPermissionGrant {
      window : String
      origin : String
      extension : String
      scope : Json
    } derive(Eq, 
    Debug    )

    One renderer capability grant from proton.project.json.

    window is main or a declared secondary window id. origin is app for bundled Proton pages or entry for the configured window entry. Extension-specific restrictions live in scope.

    ProjectPermissionGrant::equal

    source

    ProjectPermissionGrant::new

    source
    fn ProjectPermissionGrant::new(window : String, origin : String, extension : String, scope? : Json) -> ProjectPermissionGrant

    ProjectPermissionGrant::not_equal

    source

    ProjectPermissionGrant::to_repr

    source

    ProjectSignConfig

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

    Signing settings for files copied through bundle.resources.

    ProjectSignConfig::binaries

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

    Returns the project paths whose packaged copies must be signed.

    ProjectSignConfig::equal

    source

    ProjectSignConfig::new

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

    Creates signing settings for package-relative resource binaries.

    ProjectSignConfig::not_equal

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

    ProjectSignConfig::to_repr

    source

    ProjectTitlebarStyle

    source
    pub(all) enum ProjectTitlebarStyle {
      TitlebarDefault
      TitlebarOverlay
    } derive(Eq, 
    Debug    )

    ProjectTitlebarStyle::equal

    source

    ProjectTitlebarStyle::not_equal

    source

    ProjectTitlebarStyle::to_repr

    source

    ProjectUpdaterConfig

    source
    pub(all) struct ProjectUpdaterConfig {
      active : Bool
      endpoint : String
      public_keys : Array[String]
      check_on_launch : Bool
      freshness_days : Int
    } derive(Eq, 
    Debug    )

    The application's update channel, as declared in proton.project.json.

    This carries only what the runtime needs in order to decide whether to check, and whom to trust when it does. No private key material appears here, or anywhere else the framework can reach.

    ProjectUpdaterConfig::checks_on_launch

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

    ProjectUpdaterConfig::endpoint

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

    ProjectUpdaterConfig::equal

    source

    ProjectUpdaterConfig::freshness_days

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

    ProjectUpdaterConfig::is_active

    source
    fn ProjectUpdaterConfig::is_active(self : ProjectUpdaterConfig) -> Bool

    ProjectUpdaterConfig::new

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

    ProjectUpdaterConfig::not_equal

    source

    ProjectUpdaterConfig::public_keys

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

    ProjectUpdaterConfig::to_repr

    source

    ProjectWindowConfig

    source
    pub(all) struct ProjectWindowConfig {
      title : String
      width : Int
      height : Int
      size_hint : ProjectWindowSizeHint
      titlebar_style : ProjectTitlebarStyle
    } derive(Eq, 
    Debug    )

    ProjectWindowConfig::equal

    source

    ProjectWindowConfig::new

    source
    fn ProjectWindowConfig::new(title : String, width : Int, height : Int, size_hint? : ProjectWindowSizeHint, titlebar_style? : ProjectTitlebarStyle) -> ProjectWindowConfig

    ProjectWindowConfig::not_equal

    source

    ProjectWindowConfig::to_repr

    source

    ProjectWindowSizeHint

    source
    pub(all) enum ProjectWindowSizeHint {
      WindowSizeNone
      WindowSizeMin
      WindowSizeMax
      WindowSizeFixed
    } derive(Eq, 
    Debug    )

    ProjectWindowSizeHint::equal

    source

    ProjectWindowSizeHint::not_equal

    source

    ProjectWindowSizeHint::to_repr

    source

    load_project_config_from_file

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

    load_project_config_from_json

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

    Validates an already parsed Proton project JSON document without serializing it through an intermediate string.

    load_project_config_from_text

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

    Parses project JSON text at an I/O boundary, then validates the resulting native Json value.

    read_moon_mod_metadata

    source
    fn read_moon_mod_metadata(root_dir : String) -> MoonModMetadata

    Reads metadata from moon.mod in exactly the specified module root. Missing, unreadable, and malformed manifests produce empty metadata.

    read_nearest_moon_mod_metadata

    source
    fn read_nearest_moon_mod_metadata(start_dir : String) -> MoonModMetadata

    Reads metadata from the nearest enclosing moon.mod file. Missing, unreadable, and malformed manifests produce empty metadata.

    Source Files

    Powered by MoonBit

    Site sourceReport issuePackagesBuild queueSkillsStatistics

    © 2026 mooncakes.io