@storm-software/cloudflare-tools v0.2.1
!IMPORTANT This repository, and the apps, libraries, and tools contained within, is still in it's initial development phase. As a result, bugs and issues are expected with it's usage. When the main development phase completes, a proper release will be performed, the packages will be availible through NPM (and other distributions), and this message will be removed. However, in the meantime, please feel free to report any issues you may come across.
Storm Cloudflare Tools
A package containing tools for managing a Storm workspace. It includes various Nx generators and executors for common development tasks.
This library was generated with Nx.
Installing
Using pnpm:
pnpm add -D @storm-software/cloudflare-toolsnpm install -D @storm-software/cloudflare-toolsyarn add -D @storm-software/cloudflare-toolsExecutors
The following executors are available in this package to invoke common tasks for the workspace's projects:
Cloudflare Worker - Publish Executor
Publish a Cloudflare worker using the Wrangler CLI
Example
This executor can be used by executing the following in a command line utility:
nx run my-project:cloudflare-publishPlease note: The cloudflare-publish executor should be included in the desired projects's project.json file.
Options
The following executor options are available:
| Option | Type | Description | Default |
|---|---|---|---|
| name | string | Name of the Worker. | |
| noBundle | boolean | Skip Wrangler’s build steps and directly deploy script without modification. Particularly useful when using custom builds. | |
| env | string | Perform on a specific environment. | |
| outdir | string | Path to directory where Wrangler will write the bundled Worker files. | |
| compatibilityDate | string | A date in the form yyyy-mm-dd, which will be used to determine which version of the Workers runtime is used. | |
| compatibilityFlags | string[] | Flags to use for compatibility checks. | |
| latest | boolean | Use the latest version of the Workers runtime. | true |
| assets | string | Root folder of static assets to be served. Unlike --site, --assets does not require a Worker script to serve your assets. | |
| site | string | Root folder of static assets for Workers Sites. | |
| siteInclude | string[] | Array of .gitignore-style patterns that match file or directory names from the sites directory. Only matched items will be uploaded. | |
| siteExclude | string[] | Array of .gitignore-style patterns that match file or directory names from the sites directory. Matched items will not be uploaded. | |
| var | string[] | Array of key:value pairs to inject as variables into your code. The value will always be passed as a string to your Worker. | |
| define | string[] | Array of key:value pairs to replace global identifiers in your code. | |
| triggers | string[] | Cron schedules to attach to the deployed Worker. Refer to Cron Trigger Examples. | |
| routes | string[] | Routes where this Worker will be deployed. | |
| tsConfig | string | Path to a custom tsconfig.json file. | |
| minify | boolean | Minify the bundled script before deploying. | |
| nodeCompat | boolean | Enable node.js compatibility. | |
| keepVars | boolean | It is recommended best practice to treat your Wrangler developer environment as a source of truth for your Worker configuration, and avoid making changes via the Cloudflare dashboard. If you change your environment variables or bindings in the Cloudflare dashboard, Wrangler will override them the next time you deploy. If you want to disable this behavior set keepVars to true. |
Generators
The following generators are available with this package to assist in workspace management:
Building
Run nx build cloudflare-tools to build the library.
Running unit tests
Run nx test cloudflare-tools to execute the unit tests via Jest.
Storm Workspaces
Storm workspaces are built using Nx, a set of extensible dev tools for monorepos, which helps you develop like Google, Facebook, and Microsoft. Building on top of Nx, the Open System provides a set of tools and patterns that help you scale your monorepo to many teams while keeping the codebase maintainable.
Roadmap
See the open issues for a list of proposed features (and known issues).
- Top Feature Requests (Add your votes using the 👍 reaction)
- Top Bugs (Add your votes using the 👍 reaction)
- Newest Bugs
Support
Reach out to the maintainer at one of the following places:
License
This project is licensed under the Apache License 2.0. Feel free to edit and distribute this template as you like.
See LICENSE for more information.
Changelog
This project adheres to Semantic Versioning. Every release, along with the migration instructions, is documented in the CHANGELOG file
Contributing
First off, thanks for taking the time to contribute! Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.
Please try to create bug reports that are:
- Reproducible. Include steps to reproduce the problem.
- Specific. Include as much detail as possible: which version, what environment, etc.
- Unique. Do not duplicate existing opened issues.
- Scoped to a Single Bug. One bug per report.
Please adhere to this project's code of conduct.
You can use markdownlint-cli to check for common markdown style inconsistency.
Contributors
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!
Storm Software is an open source software development organization and creator of Acidic, StormStack and StormCloud.
Our mission is to make software development more accessible. Our ideal future is one where anyone can create software without years of prior development experience serving as a barrier to entry. We hope to achieve this via LLMs, Generative AI, and intuitive, high-level data modeling/programming languages.
If this sounds interesting, and you would like to help us in creating the next generation of development tools, please reach out on our website!