Skip to content

recaptimedev-labs/workers-config-schema

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Nightly generated Cloudflare Workers config schema

nightly schema generator

Andrei Jiroh of Recap Time Squad is maintaining this repository (via a GitHub Actions workflow that runs nightly at midnight UTC) by generating the config schema for Cloudflare Workers against the Workers SDK repository's main branch, so that you can use the generated JSON schema on your TOML or JSON config without needing to run npm i wrangler locally, which is good for those editing via VS Code for Web without compute access.

Should I use this instead of the one shipped on wrangler npm package?

Depends on whether you edit your Wrangler configs via VS Code for Web, regardless of whether you use features that require compute (i.e. terminal and extensions that need local filesystem access and system binaries).

Note that this also works on other editors that support loading custom JSON schemas, although I have yet to find any plugins/support outside VS Code for custom TOML schemas, but please let me know in the issue tracker.

Just the stable release?

You can also access the config schema for Workers config via unpkg.com CDN endpoint below:

https://www.unpkg.com/wrangler/config-schema.json

Usage

Install Even Bettet TOML VS Code extension and add this line at the top of your wrangler.toml file:

"$schema" = "https://raw.githubusercontent.com/recaptimedev-labs/workers-config-schema/refs/heads/main/config-schema.json"
# rest of the config go here

Alternatively on your wrangler.json(c) file:

{
  "$schema": "https://raw.githubusercontent.com/recaptimedev-labs/workers-config-schema/refs/heads/main/config-schema.json"
  // rest of the config go here
}

License

Since the upstream project adopts a dual-licensing model under both MIT and Apache licenses, we chose to license this repository's contents under the former to simplify license compliance.

About

wrangler.[toml|jsonc] schema as generated straight from wrangler sources at https://github.com/cloudflare/workers-sdk

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •