Releases: trunk-rs/trunk
v0.8.0 | Asset inlining, watch enhancements & bug fixes
added
- Closed #93: The
watch
andserve
subcommands can now watch specific folder(s) or file(s) through the new--watch <path>...
option. Thanks to @malobre for all of the work on this one. - Inline the content of files directly into
index.html
with the newinline
asset. There are three content types that can be inlined:html
,css
, andjs
. The type can be specified with thetype
attribute or is inferred by the file extension. Thanks to @DzenanJupic for all of the work on this one.
fixed
- Closed #49: old artifacts in the dist dir are now being cleaned-up as new builds successfully complete. Thanks @philip-peterson & @hamza1311 for their work on this one.
- Fixed infinite rebuild loop on Windows started by
watch
command by path canonicalizing in the ignored paths resolver.
v0.7.4 | Fix Regression in CLI --help Output
fixed
- Fixed a regression in Trunk CLI help output, where incorrect help info was being displayed.
v0.7.3 | Fix Windows Path Issues
fixed
- Closed #82: Remove the hardcoded Unix (
/
) path separator from the code and convert Windows NT UNC path to its simplified alternative before passing tocargo metadata
command to prevent issues with Rust package collisions and writingindex.html
file. - Updated the
WatchSystem
to use{:?}
debug formatting for errors to ensure that full error chains are reported. This impacts thewatch
&serve
subcommands. Thebuild
command was already behaving as needed.
v0.7.2 | Bug Fixes
0.7.2
fixed
- Closed #78: Ensure all asset pipelines are properly rooted to the configured
public-url
, which defaults to/
.
v0.7.1 | Bug Fixes
v0.7.0 | Stable Pipeline API | Future Goals
Build, bundle & ship your Rust WASM application to the web.
We'll get to the nitty-gritty of this release shortly, but I wanted to take a moment to talk about where Trunk is at now and where myself and others in the community would like to take Trunk in the future.
First of all, and most importantly, I believe we have finally found a perfect pattern for declaring asset pipelines in the source HTML (typically a project's index.html
). The pattern which is now the standard as of the 0.7.0
release is as follows: <link data-trunk rel="{pipelineType}" data-other data-attrs data-here />
. Let's break this down.
- Every asset pipeline, everything Trunk does in relation assets, is now controlled by normal HTML
link
tags with the specialdata-trunk
attribute. This simple mechanism makes clear whichlink
s are intended for Trunk to process and which are not. - Trunk
link
s must have therel
attribute, a living standard HTML attribute which normally declares the relationship of the referenced resource to the HTML document. In our case, this represents the Trunk pipeline type. See the Trunk README #assets section for more details on supported assets and their attributes. - Speaking of attributes, all pipeline types will require some number of attributes. Most require the standard
href
attribute to reference some target file. Others take non-standard attributes which are always prefixed withdata-
. E.G., therel="rust"
pipeline type is an optional pipeline type, if omitted Trunk will use theCargo.toml
in the source HTML's directory; however, if your cargo project exposes multiple binaries, you will need to specify which binary Trunk should use. This pipeline type supports thedata-bin="bin-name"
attribute for exactly that reason. Check out the aforementioned assets section in the README for more details.
Awesome! I'm very excited about how much this pipeline API has evolved. It is VERY extensible (what can't you specify via data-*
attributes?), and my hope is that this pipeline API will ultimately become the 1.0 API for Trunk. However, Trunk is a young project, and still has a long way to go. Let's talk about the future.
Trunk's Future
There are lots of great features the Trunk community has been discussing, a few notable ones:
- support for automatic browser reloading via WebSockets or SSE. This is definitely par for the course as far as web bundlers are concerned.
- WASM HMR (hot module reloading). This is just an extension of the above, however there is a lot of awesome potential here. Building Rust WASM web applications is quite a lot of fun these days.
- inline CSS, JS and other applicable asset types. This will be an easy extension to the new pipelines API discussed above. For most of these asset types, it will be a simple
data-inline
attribute, and Trunk should be able to generate the necessary code to have the associated asset inlined. - CSS components pattern. This is something which I personally think would be pretty cool. For those of you that remember EmberJS from back in the day, they had a nice feature where one could just place their CSS right next to their components, and they would be concatenated and served for you. Easy lift for Trunk, and folks might find it quite useful.
- A BIG LIFT: a Trunk library which will allow folks to declare assets directly in their Rust code right next to their WASM components. Already lots of discussion on this feature, still some planning and design work to do.
I've said a lot, so I'll say one last thing here: Trunk is an excellent project to get involved with! The new pipeline API has come along with an awesome refactor of the internal layout of the code. Adding new asset pipelines and pipeline extensions is easy and enjoyable! This community would be even better with you involved! Cheers mate! Let's do this!
changed
- All assets which are to be processed by trunk must now be declared as HTML
link
elements as such:<link data-trunk rel="rust|sass|css|icon|copy-file|..." data-attr0 data-attr1/>
. The links may appear anywhere in the HTML and Trunk will process them and replace them or delete them based on the associated pipeline's output. If the link element does not have thedata-trunk
attribute, it will not be processed.
fixed
- Fixed #50: the ability to copy a file or an entire dir into the dist dir is now supported with two different pipeline types:
<link data-trunk rel="copy-file" href="target/file"/>
and<link data-trunk rel="copy-dir" href="target/dir"/>
respectively.
removed
- The
manifest-path
option has been removed from all Trunk subcommands. The path to theCargo.toml
is now specified in the source HTML as<link rel="rust" href="path/to/Cargo.toml"/>
. Thehref="..."
attribute may be omitted, in which case Trunk will look for aCargo.toml
within the same directory as the source HTML. If thehref
attribute points to a directory, Trunk will look for theCargo.toml
file in that directory.
v0.6.0
0.6.0
added
- Closed #59: Support for writing the public URL (
--public-url
) to the HTML output.
fixed
- Closed #62: Improved handling of file paths declared in the source
index.html
to avoid issues on Windows. - Closed #58: The output WASM file generated from the cargo build is now determined purely based on a JSON build plan provided from cargo itself. This will help to provide a more stable pattern for finding build artifacts. If you were running into issues where Trunk was not able to find the WASM file built from cargo due to hyphens or underscores in the name, that problem should now be a thing of the past.
- The default location of the
dist
dir has been slightly modified. Thedist
dir will now default to being generated in the parent dir of cargo'starget
dir. This helps to make behavior a bit more consistent when executing trunk for locations other than the CWD. - Fixed an issue where paths declared in a
Trunk.toml
file were not being treated as relative to the file itself.
Fix a regression in server index.html fallback
- Closes #55: Fixed a regression in the server where the middleware was declared after the handler, and was thus not working as needed. Putting the middleware first fixes the issue.
Proxy System
Trunk now ships with a built-in proxy which can be enabled when running trunk serve
. There are two ways to configure the proxy, each discussed below. All Trunk proxies will transparently pass along the request body, headers, and query parameters to the proxy backend.
proxy cli flags
The trunk serve
command accepts two proxy related flags.
--proxy-backend
specifies the URL of the backend server to which requests should be proxied. The URI segment of the given URL will be used as the path on the Trunk server to handle proxy requests. E.G., trunk serve --proxy-backend=http://localhost:9000/api/
will proxy any requests received on the path /api/
to the server listening at http://localhost:9000/api/
. Further path segments or query parameters will be seamlessly passed along.
--proxy-rewrite
specifies an alternative URI on which the Trunk server is to listen for proxy requests. Any requests received on the given URI will be rewritten to match the URI of the proxy backend, effectively stripping the rewrite prefix. E.G., trunk serve --proxy-backend=http://localhost:9000/ --proxy-rewrite=/api/
will proxy any requests received on /api/
over to http://localhost:9000/
with the /api/
prefix stripped from the request, while everything following the /api/
prefix will be left unchanged.
config file
The Trunk.toml
config file accepts multiple [[proxy]]
sections, which allows for multiple proxies to be configured. Each section requires at least the backend
field, and optionally accepts the rewrite
field, both corresponding to the --proxy-*
CLI flags discussed above.
As it is with other Trunk config, a proxy declared via CLI will take final precedence and will cause any config file proxies to be ignored, even if there are multiple proxies declared in the config file.
The following is a snippet from the Trunk.toml
file in this repo:
[[proxy]]
rewrite = "/api/v1/"
backend = "http://localhost:9000/"
Layered config (Trunk.toml), JS snippets & release binaries
added
- In addition to CLI arguments and options, Trunk now supports layered configuration via
Trunk.toml
& environment variables. - Added an example
Trunk.toml
to the root of the repository showing all possible config values along with their defaults.
changed
- README has been updated with details on how the config system works.
- Removed a fair amount of code duplication as part of the configuration changes.
- Added full release automation with optimized release binaries for Linux, MacOS & Windows (all x64). Brew packages for MacOS and Linux, and a Chocolatey package for Windows coming soon.