Skip to content

[docs] Improve schema.json #4139

@lorenzolewis

Description

@lorenzolewis

There are a few things in the schema that could be updated (based on tauri-apps/tauri-docs#604). File for reference: https://github.com/tauri-apps/tauri/blob/dev/tooling/cli/schema.json

We should also be aware of any down-stream impacts and keep in mind increasing quality there (such as the VS Code extension). I'm willing to do this myself once I have some spare time

  • "HttpAllowlistScope" description
  • Fix link in ShellAllowlistConfig.sidecar description
  • This should be marked as optional, not an array of types
    "type": [
    "string",
    "null"
  • Escape brackets in description
    "description": "Specifies the maximum number of values are for this argument. For example, if you had a -f <file> argument where you wanted up to 3 'files', you would set .max_values(3), and this argument would be satisfied if the user provided, 1, 2, or 3 values.",
  • These newlines cause an issue when rendering in a table, should be a break instead
    "description": "A shell command to run before `tauri build` kicks in.\n\nThe TAURI_PLATFORM, TAURI_ARCH, TAURI_FAMILY, TAURI_PLATFORM_VERSION, TAURI_PLATFORM_TYPE and TAURI_DEBUG environment variables are set if you perform conditional compilation.",
  • This link is broken
    "description": "The Content Security Policy that will be injected on all HTML files on the built application. If [`dev_csp`](SecurityConfig.dev_csp) is not specified, this value is also injected on dev.\n\nThis is a really important part of the configuration since it helps you ensure your WebView is secured. See <https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP>.",

Metadata

Metadata

Assignees

Labels

priority: 3 lowAccepted but likely won't be worked onscope: cliThe tauri-cli rust crate and @tauri-apps/cli npm package

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions