Skip to content

Improve the '.xdc' file format specification  #80

@sambacha

Description

@sambacha

Looking at the specification https://webxdc.org/docs/spec/format.html I find some potential issues / questions regarding the format:

XDC Format

  • ZIP settings such as compression, etc, are not defined explicitly

  • Make the zipping process reproducible: Last-modified timestamps & File-system permissions (mode) for the archive files.

  • Specify a max file size. (I belive this is already the case as see here https://github.com/webxdc/hello/blob/d648febd18ec809ecbd5681f1fc6d4b5273b3e52/create-xdc.sh#L23 )

  • manifest toml file does not define if additional properties are allowed

  • clarify where it says that manifest toml says if manifest.toml exists it MUST read source_code_url however this is stated as an optional field.

Suggestions

  • define a 'scope' for which html pages can be loaded besides index.html for the user. E.g. a 'debug' page may be scoped for development purposes but disabled for normal installs
  • an "integrity hash" or SRI hash, which is basically a checksum over the source file inputs. it is intended to let consumers easily validate

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions