archive-gh-me/wasm-pack
1
0
Fork 0
mirror of https://github.com/rustwasm/wasm-pack.git synced 2025-12-08 18:23:30 +00:00
Code Issues Projects Releases Wiki Activity

Update URL of the document website

Browse Source
This commit is contained in:
Hiroaki Yutani 2025-08-02 19:01:34 +09:00
parent 1a0a851f92
commit d7d2b8ad27
12 changed files with 274 additions and 260 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

302
CHANGELOG.md
View File

@ -35,6 +35,7 @@
[net]: https://github.com/net
- ### 🛠️ Maintenance
- ** Remove unmaintained dependency atty in favor of stdlib - [mariusvniekerk], [pull/1436]**
[pull/1436]: https://github.com/rustwasm/wasm-pack/pull/1436
@ -110,7 +111,7 @@
- **Add mingw support to npm package - [nathaniel-daniel], [issue/1354], [issue/1359], [pull/1363]**
Fixes the NPM package's platform detection for mingw.
Fixes the NPM package's platform detection for mingw.
[issue/1354]: https://github.com/rustwasm/wasm-pack/issues/1354
[issue/1359]: https://github.com/rustwasm/wasm-pack/issues/1359
@ -137,12 +138,12 @@
`[INFO]: 📦 Your wasm pkg is ready to publish at /root/code/fib-wasm/fib-wasm/wasm.`
[issue/1395]: https://github.com/rustwasm/wasm-pack/issues/1395
[pull/1396]: https://github.com/rustwasm/wasm-pack/pull/1396
[ahaoboy]: https://github.com/ahaoboy
- ### 🛠️ Maintenance
- **Fix error and warnings in install script - [lucashorward], [issue/1159], [issue/1217], [issue/1283], [pull/1320]**
[issue/1159]: https://github.com/rustwasm/wasm-pack/issues/1159
@ -488,7 +489,7 @@
- **Use bash to create release tarballs - [nasso], [issue/1097] [pull/1144]**
Fixes Windows installer failure due to malformatted tar.
Fixes Windows installer failure due to malformatted tar.
[pull/1144]: https://github.com/rustwasm/wasm-pack/pull/1144
[issue/1097]: https://github.com/rustwasm/wasm-pack/issues/1097
@ -496,7 +497,7 @@
- **Clean up package.json from previous runs - [main--], [issue/1110-comment] [pull/1119]**
Remove the package.json file from previous runs to avoid crashes.
Remove the package.json file from previous runs to avoid crashes.
[pull/1119]: https://github.com/rustwasm/wasm-pack/pull/1119
[issue/1110-comment]: https://github.com/rustwasm/wasm-pack/pull/1110#issuecomment-1059008962
@ -504,10 +505,10 @@
- **Do not remove the pkg directory - [huntc], [issue/1099] [pull/1110]**
A recent change ensured that the pkg directory was removed as the first step of attempting to create it.
Unfortunately, this caused a problem for webpack when watching the pkg directory.
Webpack was unable to recover its watching and so any watch server must be restarted,
which is a blocker when using it. This PR and release fixes this.
A recent change ensured that the pkg directory was removed as the first step of attempting to create it.
Unfortunately, this caused a problem for webpack when watching the pkg directory.
Webpack was unable to recover its watching and so any watch server must be restarted,
which is a blocker when using it. This PR and release fixes this.
[pull/1110]: https://github.com/rustwasm/wasm-pack/pull/1110
[issue/1099]: https://github.com/rustwasm/wasm-pack/issues/1099
@ -526,7 +527,6 @@
[pull/1146]: https://github.com/rustwasm/wasm-pack/pull/1146
[dependabot]: https://github.com/apps/dependabot
## 🌦️ 0.10.2
- ### ✨ Features
@ -541,7 +541,7 @@
- **Add support for macos aarch64 - [d3lm], [issue/913] [pull/1088]**
This fixes aarch64 for MacOS and will download x86_64-apple-darwin.
This fixes aarch64 for MacOS and will download x86_64-apple-darwin.
[pull/1088]: https://github.com/rustwasm/wasm-pack/pull/1088
[issue/913]: https://github.com/rustwasm/wasm-pack/issues/913
@ -568,7 +568,6 @@
[pull/1073]: https://github.com/rustwasm/wasm-pack/pull/1073
[issue/1059]: https://github.com/rustwasm/wasm-pack/issues/1059
## 🌦️ 0.10.1
- ### 🤕 Fixes
@ -703,7 +702,7 @@
[pull/841]: https://github.com/rustwasm/wasm-pack/pull/841
## ☁️ 0.9.1
## ☁️ 0.9.1
- ### 🤕 Fixes
@ -737,20 +736,20 @@
- **Adding in `--quiet` and `--log-level` flags to control the console output - [Pauan], [pull/694]**
The `--verbose` flag has long existed as a way to get more console output, but now there are two flags to get *less* console output:
The `--verbose` flag has long existed as a way to get more console output, but now there are two flags to get _less_ console output:
* `--quiet` will silence *all* stdout, so only errors will be displayed.
* `--log-level` can be used to silence `[INFO]` or `[WARN]` output from wasm-pack.
- `--quiet` will silence _all_ stdout, so only errors will be displayed.
- `--log-level` can be used to silence `[INFO]` or `[WARN]` output from wasm-pack.
You can cause it to display even *more* information by using `--verbose`, or you can silence *all* stdout by using `--quiet`.
You can cause it to display even _more_ information by using `--verbose`, or you can silence _all_ stdout by using `--quiet`.
You can also use `--log-level` to have fine-grained control over wasm-pack's log output:
* `--log-level info` is the default, it causes all messages to be logged.
* `--log-level warn` causes warnings and errors to be displayed, but not info.
* `--log-level error` causes only errors to be displayed.
- `--log-level info` is the default, it causes all messages to be logged.
- `--log-level warn` causes warnings and errors to be displayed, but not info.
- `--log-level error` causes only errors to be displayed.
These flags are global flags, so they can be used with every command, and they must come *before* the command:
These flags are global flags, so they can be used with every command, and they must come _before_ the command:
```sh
wasm-pack --log-level error build
@ -936,119 +935,119 @@
- **Check for "rustup" rather than ".rustup" when checking for wasm32 - [drager], [issue/613][pull/616]**
When we introduced support for non-rustup setups we did a check if the user was
using rustup or not. However, this check was too constrained and only covered
the most common cases, but it did not work for Docker setups.
When we introduced support for non-rustup setups we did a check if the user was
using rustup or not. However, this check was too constrained and only covered
the most common cases, but it did not work for Docker setups.
This PR addresses that and it now covers Docker setups as well!
When doing this fix we also found two other small issues which this PR also addresses.
The first is that we did not print the helpful error message when the wasm32 target
was not found and the other one was that it linked to the wrong section of the documentation.
This PR addresses that and it now covers Docker setups as well!
When doing this fix we also found two other small issues which this PR also addresses.
The first is that we did not print the helpful error message when the wasm32 target
was not found and the other one was that it linked to the wrong section of the documentation.
[issue/613]: https://github.com/rustwasm/wasm-pack/issues/613
[pull/616]: https://github.com/rustwasm/wasm-pack/pull/616
[issue/613]: https://github.com/rustwasm/wasm-pack/issues/613
[pull/616]: https://github.com/rustwasm/wasm-pack/pull/616
## 🌤️ 0.8.0
- ### ✨ Features
- **Give user's ability to customize generated filenames with `--out-name` flag - [ibaryshnikov], [issue/596] [pull/599]**
- **Give user's ability to customize generated filenames with `--out-name` flag - [ibaryshnikov], [issue/596] [pull/599]**
When running `wasm-pack build`, several files are generated. These files
are named based on the name of the crate, as per your `Cargo.toml` file.
Sometimes- that's not the name you'd like your files to have!
When running `wasm-pack build`, several files are generated. These files
are named based on the name of the crate, as per your `Cargo.toml` file.
Sometimes- that's not the name you'd like your files to have!
You can now specify a custom name for the generated files using a new
flag, `--out-name`. Given a project called `dom`, here's a comparison of
the default and custom generated filenames:
You can now specify a custom name for the generated files using a new
flag, `--out-name`. Given a project called `dom`, here's a comparison of
the default and custom generated filenames:
```
wasm-pack build
# will produce files
# dom.d.ts dom.js dom_bg.d.ts dom_bg.wasm package.json README.md
```
wasm-pack build
# will produce files
# dom.d.ts dom.js dom_bg.d.ts dom_bg.wasm package.json README.md
wasm-pack build --out-name index
# will produce files
# index.d.ts index.js index_bg.d.ts index_bg.wasm package.json README.md
```
wasm-pack build --out-name index
# will produce files
# index.d.ts index.js index_bg.d.ts index_bg.wasm package.json README.md
```
[ibaryshnikov]: https://github.com/ibaryshnikov
[issue/596]: https://github.com/rustwasm/wasm-pack/issues/596
[pull/599]: https://github.com/rustwasm/wasm-pack/pull/599
[ibaryshnikov]: https://github.com/ibaryshnikov
[issue/596]: https://github.com/rustwasm/wasm-pack/issues/596
[pull/599]: https://github.com/rustwasm/wasm-pack/pull/599
- ### 🤕 Fixes
- **Fix panics in `build mode --no-install` - [alexcrichton], [pull/598]**
- **Fix panics in `build mode --no-install` - [alexcrichton], [pull/598]**
This commit fixes the `wasm-pack build --mode no-install` command from
unconditionally panicking as well as `--mode force`. These steps were
calling an `unwrap()` on an internal `Option<T>` which was supposed to
be set during `step_install_wasm_bindgen`, but that step wasn't run in
these modes. The mode configuration of steps has been refactored
slightly to ensure that more steps are shared between these modes to
reduce duplication.
This commit fixes the `wasm-pack build --mode no-install` command from
unconditionally panicking as well as `--mode force`. These steps were
calling an `unwrap()` on an internal `Option<T>` which was supposed to
be set during `step_install_wasm_bindgen`, but that step wasn't run in
these modes. The mode configuration of steps has been refactored
slightly to ensure that more steps are shared between these modes to
reduce duplication.
[pull/598]: https://github.com/rustwasm/wasm-pack/pull/598
[pull/598]: https://github.com/rustwasm/wasm-pack/pull/598
- **Print unexpected panics to standard error - [drager], [issue/562] [pull/601]**
- **Print unexpected panics to standard error - [drager], [issue/562] [pull/601]**
Unexpected panics are unfortunate but they're currently covered up and written
out to an auxiliary file. This makes panics in CI difficult to debug,
especially at a glance, as CI builders are likely not uploading those files.
Unexpected panics are unfortunate but they're currently covered up and written
out to an auxiliary file. This makes panics in CI difficult to debug,
especially at a glance, as CI builders are likely not uploading those files.
This PR will print to standard error for unexpected panics and then let
`human_panic` handle panics, just like before.
This PR will print to standard error for unexpected panics and then let
`human_panic` handle panics, just like before.
[issue/562]: https://github.com/rustwasm/wasm-pack/issues/562
[pull/601]: https://github.com/rustwasm/wasm-pack/pull/601
[issue/562]: https://github.com/rustwasm/wasm-pack/issues/562
[pull/601]: https://github.com/rustwasm/wasm-pack/pull/601
- **Improve error message when `wasm32-unknown-unknown` is missing - [drager], [issue/579] [pull/602]**
- **Improve error message when `wasm32-unknown-unknown` is missing - [drager], [issue/579] [pull/602]**
For folks with non-rustup environments (which we only started supporting in
0.7.0!), we were giving a missing target error that was not helpful!
For folks with non-rustup environments (which we only started supporting in
0.7.0!), we were giving a missing target error that was not helpful!
We've updated the error message to include more information, and we've added
some documentation to help explain how you can remedy the error by manually
installing the target on your specific rust setup- including the fact that
it may *not* be possible to add the target to some setups.
We've updated the error message to include more information, and we've added
some documentation to help explain how you can remedy the error by manually
installing the target on your specific rust setup- including the fact that
it may _not_ be possible to add the target to some setups.
Check out the docs [here](https://rustwasm.github.io/wasm-pack/book/prerequisites/non-rustup-setups.html).
Check out the docs [here](https://drager.github.io/wasm-pack/book/prerequisites/non-rustup-setups.html).
[issue/579]: https://github.com/rustwasm/wasm-pack/issues/579
[pull/602]: https://github.com/rustwasm/wasm-pack/pull/602
[issue/579]: https://github.com/rustwasm/wasm-pack/issues/579
[pull/602]: https://github.com/rustwasm/wasm-pack/pull/602
- ### 📖 Documentation
- **Document `--out-dir` flag - [ashleygwilliams], [issue/592] [pull/593]**
- **Document `--out-dir` flag - [ashleygwilliams], [issue/592] [pull/593]**
Recently, someone asked on Discord about customizing the name of the directory
that contains the assets built by `wasm-pack`. We've had the `out-dir` flag for
a while, but it wasn't documented! Now it is.
Recently, someone asked on Discord about customizing the name of the directory
that contains the assets built by `wasm-pack`. We've had the `out-dir` flag for
a while, but it wasn't documented! Now it is.
[issue/592]: https://github.com/rustwasm/wasm-pack/issues/592
[pull/593]: https://github.com/rustwasm/wasm-pack/pull/593
[issue/592]: https://github.com/rustwasm/wasm-pack/issues/592
[pull/593]: https://github.com/rustwasm/wasm-pack/pull/593
- **Fix broken links in docs and update for template changes - [drager], [ashleygwilliams], [issue/609] [pull/612] [pull/614]**
- **Fix broken links in docs and update for template changes - [drager], [ashleygwilliams], [issue/609] [pull/612] [pull/614]**
Recently, some improvements were made to the [`wasmpack-template`]. Additionally,
there were some broken links in the documentation. We've updated the docs for the
new template and fixed the broken links!
Recently, some improvements were made to the [`wasmpack-template`]. Additionally,
there were some broken links in the documentation. We've updated the docs for the
new template and fixed the broken links!
[issue/609]: https://github.com/rustwasm/wasm-pack/issues/609
[pull/612]: https://github.com/rustwasm/wasm-pack/pull/612
[pull/614]: https://github.com/rustwasm/wasm-pack/pull/614
[issue/609]: https://github.com/rustwasm/wasm-pack/issues/609
[pull/612]: https://github.com/rustwasm/wasm-pack/pull/612
[pull/614]: https://github.com/rustwasm/wasm-pack/pull/614
- ### 🛠️ Maintenance
- **Move `binary-install` to its own repo - [drager], [issue/500] [pull/600]**
- **Move `binary-install` to its own repo - [drager], [issue/500] [pull/600]**
`binary-install` is a crate that holds the abstractions for how `wasm-pack` downloads
and caches pre-built binaries for the tools it wraps. It was originally part of the
`wasm-pack` code, then moved into a workspace as an independent crate. Now that we
believe it's stable, we've moved it into its own [repo](https://github.com/rustwasm/binary-install)!
`binary-install` is a crate that holds the abstractions for how `wasm-pack` downloads
and caches pre-built binaries for the tools it wraps. It was originally part of the
`wasm-pack` code, then moved into a workspace as an independent crate. Now that we
believe it's stable, we've moved it into its own [repo](https://github.com/rustwasm/binary-install)!
[issue/500]: https://github.com/rustwasm/wasm-pack/issues/500
[pull/600]: https://github.com/rustwasm/wasm-pack/pull/600
[issue/500]: https://github.com/rustwasm/wasm-pack/issues/500
[pull/600]: https://github.com/rustwasm/wasm-pack/pull/600
## 🌤️ 0.7.0
@ -1093,7 +1092,7 @@
wasm-pack build --target web
```
Learn more about how to use this target by [checking out the docs!](https://rustwasm.github.io/wasm-pack/book/commands/build.html#target)
Learn more about how to use this target by [checking out the docs!](https://drager.github.io/wasm-pack/book/commands/build.html#target)
[pull/567]: https://github.com/rustwasm/wasm-pack/pull/567
@ -1157,7 +1156,7 @@
Several users noted that when downloading a new version of `wasm-pack` their browser named the executable
file `wasm-pack-init (1).exe`. When named this way, the file didn't show the init instructions on execution.
This happened because the installation logic was requiring an exact match on filename. We've loosened that
restriction so that the filename must *start* with `wasm-pack-init` and will still execute files with these
restriction so that the filename must _start_ with `wasm-pack-init` and will still execute files with these
additional, extraneous charaters in the filename. Thanks so much to [Mblkolo] and [danwilhelm] for filing the
issue and the excellent discussion!
@ -1209,7 +1208,7 @@
[`clippy`] is an awesome utilty that helps lint your Rust code for common optimizations and idioms. at the
beginning of `wasm-pack` development, `clippy` had not yet stablized, but it has since 1.0'd and it was
high time we leveraged it in `wasm-pack`. We still aren't *completely* fixed, but we're working on it, and
high time we leveraged it in `wasm-pack`. We still aren't _completely_ fixed, but we're working on it, and
we've already dervived a ton of value from the tool!
[`clippy`]: https://github.com/rust-lang/rust-clippy
@ -1273,7 +1272,7 @@
[DebugSteve]: https://github.com/DebugSteven
[single location]: https://rustwasm.github.io/docs.html
[See `wasm-pack's` master docs here]: https://rustwasm.github.io/wasm-pack/book/
[See `wasm-pack's` master docs here]: https://drager.github.io/wasm-pack/book/
[pull/565]: https://github.com/rustwasm/wasm-pack/pull/565
- **Add new QuickStart guide for "Hybrid Applications with Webpack" - [DebugSteven] [pull/536]**
@ -1282,13 +1281,13 @@
publishes it to npm, where anyone can use it like any npm package in their JavaScript or Node.js application.
Shortly after `wasm-pack` appeared, some RustWASM teammates created a template for a similar workflow- building
a RustWASM package *alongside* an application. They did this by leveraging Webpack plugins, and it's a really
a RustWASM package _alongside_ an application. They did this by leveraging Webpack plugins, and it's a really
lovely user experience!
[This template] hasn't gotten as much attention because we've lacked a quickstart guide for folks to discover
and follow- now we've got one!
Check out the guide [here](https://rustwasm.github.io/wasm-pack/book/tutorials/hybrid-applications-with-webpack/index.html)!
Check out the guide [here](https://drager.github.io/wasm-pack/book/tutorials/hybrid-applications-with-webpack/index.html)!
[This temaplte]: https://github.com/rustwasm/rust-webpack-template
[DebugSteven]: https://github.com/DebugSteven
@ -1301,7 +1300,7 @@
However, for folks who don't use the template, `wee_alloc` is something important to know about- so now we have
given it its own section!
Check out the deepdive [here](https://rustwasm.github.io/wasm-pack/book/tutorials/npm-browser-packages/template-deep-dive/wee_alloc.html)!
Check out the deepdive [here](https://drager.github.io/wasm-pack/book/tutorials/npm-browser-packages/template-deep-dive/wee_alloc.html)!
[surma]: https://github.com/surma
[pull/542]: https://github.com/rustwasm/wasm-pack/pull/542
@ -1327,11 +1326,11 @@
- **Wasm is a contraction, not an acronym - [fitzgen], [pull/555]**
Ever wonder how you're *actually* supposed to refer to WebAssembly in short-form? WASM? wasm? For the pedants
out there, the correct usage is "Wasm" because Wasm is a *contraction* of the words Web and Assembly. We've
Ever wonder how you're _actually_ supposed to refer to WebAssembly in short-form? WASM? wasm? For the pedants
out there, the correct usage is "Wasm" because Wasm is a _contraction_ of the words Web and Assembly. We've
updated our doucmentation to consistently refer to WebAssembly as Wasm in the shortform.
*The more you know!*
_The more you know!_
[pull/555]: https://github.com/rustwasm/wasm-pack/pull/555
@ -1343,7 +1342,6 @@
[pull/514]: https://github.com/rustwasm/wasm-pack/pull/514
[pull/516]: https://github.com/rustwasm/wasm-pack/pull/516
## 🌅 0.6.0
- ### ✨ Features
@ -1360,11 +1358,11 @@
and added an additional flag, representing a third, intermediary, build profile, called `--profiling` which
is useful for investigating performance issues. You can see all three flags and their uses in the table below:
| Profile | Debug Assertions | Debug Info | Optimizations | Notes |
|---------------|------------------|------------|---------------|---------------------------------------|
| `--dev` | Yes | Yes | No | Useful for development and debugging. |
| Profile | Debug Assertions | Debug Info | Optimizations | Notes |
| ------------- | ---------------- | ---------- | ------------- | ----------------------------------------------------------- |
| `--dev` | Yes | Yes | No | Useful for development and debugging. |
| `--profiling` | No | Yes | Yes | Useful when profiling and investigating performance issues. |
| `--release` | No | No | Yes | Useful for shipping to production. |
| `--release` | No | No | Yes | Useful for shipping to production. |
The meaning of these flags will evolve as the platform grows, and always be tied to the behavior of these flags
in `cargo`. You can learn more about these in the [`cargo profile` documentation].
@ -1393,7 +1391,7 @@
As always- there are defaults for you to use, but if you love to configure (or have a project that requires it),
get excited, as your options have grown now and will continue to!
[profile-config-docs]: https://rustwasm.github.io/wasm-pack/book/cargo-toml-configuration.html
[profile-config-docs]: https://drager.github.io/wasm-pack/book/cargo-toml-configuration.html
[`cargo profile` documentation]: https://doc.rust-lang.org/cargo/reference/manifest.html#the-profile-sections
[issue/153]: https://github.com/rustwasm/wasm-pack/issues/153
[issue/160]: https://github.com/rustwasm/wasm-pack/issues/160
@ -1421,12 +1419,11 @@
In the above example, the flag `-Z offline` will be passed to `cargo build`. This feature is documented
[here][cargo opts docs].
[cargo opts docs]: https://rustwasm.github.io/wasm-pack/book/commands/build.html#extra-options
[cargo opts docs]: https://drager.github.io/wasm-pack/book/commands/build.html#extra-options
[torkve]: https://github.com/torkve
[issue/455]: https://github.com/rustwasm/wasm-pack/issues/455
[pull/461]: https://github.com/rustwasm/wasm-pack/pull/461
- **Pre-build before wasm-pack publish - [csmoe], [issue/438] [pull/444]**
Previously, if you ran `wasm-pack publish` before you had successfully run `wasm-pack build`,
@ -1437,7 +1434,7 @@
ran `wasm-pack publish`. This is slightly complicated by the fact that not everyone wants to
build their package to the default target or to a directory named `pkg`.
To solve this, running `wasm-pack publish` before a successful build will give you an interactive
To solve this, running `wasm-pack publish` before a successful build will give you an interactive
prompt to build your package- allowing you to specify your out directory as well as the target you'd
like to build to. Check it out in the gif below:
@ -1604,7 +1601,7 @@
For internal maintenance reasons, as well as several end-user ones, we've migrated away from the `slog` family
of crates, and are now using the `log` crate plus `env_logger`. Now, `wasm-pack` won't create a `wasm-pack.log`.
Additionally, enabling logging will now be done through `RUST_LOG=wasm_pack` instead of `-v` flags.
Additionally, enabling logging will now be done through `RUST_LOG=wasm_pack` instead of `-v` flags.
[issue/425]: https://github.com/rustwasm/wasm-pack/issues/425
[pull/434]: https://github.com/rustwasm/wasm-pack/pull/434
@ -1698,7 +1695,7 @@
[issue/287]: https://github.com/rustwasm/wasm-pack/issues/287
[pull/392]: https://github.com/rustwasm/wasm-pack/pull/392
- **Less scary missing field messages - [mstallmo], [issue/393] [pull/394]**
- **Less scary missing field messages - [mstallmo], [issue/393] [pull/394]**
After watching a livestream of someone using `wasm-pack`, [fitzgen] noted that folks
seemed pretty alarmed by the loud warning about missing optional manifest fields.
@ -1749,8 +1746,6 @@
[issue/280]: https://github.com/rustwasm/wasm-pack/issues/280
[pull/401]: https://github.com/rustwasm/wasm-pack/pull/401
## ☀️ 0.5.0
- ### ✨ Features
@ -1763,7 +1758,7 @@
This PR also has a complete rework of our documentation.
Check it out [here](https://rustwasm.github.io/wasm-pack/)!
Check it out [here](https://drager.github.io/wasm-pack/)!
- #### 🍱 Module Support
@ -1834,7 +1829,7 @@
- #### 🎏 New Flags
- **New target, bare JavaScript: `--target no-modules` - [ashleygwilliams], [issue/317] [pull/327]**
- **New target, bare JavaScript: `--target no-modules` - [ashleygwilliams], [issue/317] [pull/327]**
`wasm-bindgen` offers a `no-modules` flag that until now, we didn't support. This flag
produces bare, no modules JavaScript. So if that's your thing, this target is for you!
@ -1970,54 +1965,54 @@
moment they just want to hurry up and use it already.
Say hello to the new `wasm-pack` installer- we have an executable for Windows
and a `curl` script for *nix users. Not pleased with that? File an issue for your
and a `curl` script for \*nix users. Not pleased with that? File an issue for your
preferred distribution method and we'll do our best to get it working!
This is experimental- so please try it out and file issues as you run into things!
You'll always be able to use `cargo install` as a backup.
Checkout the new installer [here](https://rustwasm.github.io/wasm-pack/installer/)!
Checkout the new installer [here](https://drager.github.io/wasm-pack/installer/)!
[pull/307]: https://github.com/rustwasm/wasm-pack/pull/307
- ### 🛠️ Maintenance
- **testing fixture strategy improvements - [fitzgen], [pull/211] [pull/323]**
- **testing fixture strategy improvements - [fitzgen], [pull/211] [pull/323]**
[pull/211]: https://github.com/rustwasm/wasm-pack/pull/211
[pull/323]: https://github.com/rustwasm/wasm-pack/pull/323
[pull/211]: https://github.com/rustwasm/wasm-pack/pull/211
[pull/323]: https://github.com/rustwasm/wasm-pack/pull/323
- **split testing utils into separate files - [csmoe], [issue/231] [pull/216]**
- **split testing utils into separate files - [csmoe], [issue/231] [pull/216]**
[issue/231]: https://github.com/rustwasm/wasm-pack/issues/231
[pull/216]: https://github.com/rustwasm/wasm-pack/pull/216
[issue/231]: https://github.com/rustwasm/wasm-pack/issues/231
[pull/216]: https://github.com/rustwasm/wasm-pack/pull/216
- **update dependencies - [ashleygwilliams], [issue/319] [pull/320]**
- **update dependencies - [ashleygwilliams], [issue/319] [pull/320]**
[issue/319]: https://github.com/rustwasm/wasm-pack/issues/319
[pull/320]: https://github.com/rustwasm/wasm-pack/pull/320
[issue/319]: https://github.com/rustwasm/wasm-pack/issues/319
[pull/320]: https://github.com/rustwasm/wasm-pack/pull/320
- ### 📖 Documentation
- **improve readability of warnings about missing optional fields - [twilco], [pull/296]**
- **improve readability of warnings about missing optional fields - [twilco], [pull/296]**
A little punctuation goes a long way. Error message improvement PRs are the best.
A little punctuation goes a long way. Error message improvement PRs are the best.
[twilco]: https://github.com/twilco
[pull/296]: https://github.com/rustwasm/wasm-pack/pull/296
[twilco]: https://github.com/twilco
[pull/296]: https://github.com/rustwasm/wasm-pack/pull/296
- **update links in README - [alexcrichton], [pull/300]**
- **update links in README - [alexcrichton], [pull/300]**
We had a real dicey documentation situation for a while. Sorry about that, and thank
you SO MUCH to all the folks who filed PRs to fix it.
We had a real dicey documentation situation for a while. Sorry about that, and thank
you SO MUCH to all the folks who filed PRs to fix it.
[pull/300]: https://github.com/rustwasm/wasm-pack/pull/300
[pull/300]: https://github.com/rustwasm/wasm-pack/pull/300
- **fix broken links in book by using relative paths - [mstallmo], [issue/325] [pull/328]**
- **fix broken links in book by using relative paths - [mstallmo], [issue/325] [pull/328]**
[mstallmo]: https://github.com/mstallmo
[issue/325]: https://github.com/rustwasm/wasm-pack/issues/325
[pull/328]: https://github.com/rustwasm/wasm-pack/pull/328
[mstallmo]: https://github.com/mstallmo
[issue/325]: https://github.com/rustwasm/wasm-pack/issues/325
[pull/328]: https://github.com/rustwasm/wasm-pack/pull/328
## ✨ 0.4.2
@ -2055,7 +2050,7 @@
- **use `PathBuf` instead of `String` for paths - [Mackiovello], [pull/220]**
This is mostly a maintenance PR but does fix one very small bug- depending on if you add a trailing slash to
This is mostly a maintenance PR but does fix one very small bug- depending on if you add a trailing slash to
a path that you pass to `init`, you might have seen an extra `/`! Now that we're using a proper Type to
handle this, that's much better, and in general, all the operations using paths are more robust now.
@ -2071,7 +2066,6 @@
[pull/226]: https://github.com/rustwasm/wasm-pack/pull/226
## ⭐ 0.4.1
- #### 🤕 Fixes
@ -2139,15 +2133,15 @@ to `wasm-pack`. Welcome ya'll! We're so glad to have you!
- **`--mode` flag for skipping steps when calling `init` - [ashleygwilliams], [pull/186]**
After teaching and working with `wasm-pack` for some time, it's clear that people would
like the flexibility to run some of the steps included in the `init` command and not others.
This release introduces a `--mode` flag that you can pass to `init`. The two modes currently
available are `skip-build` and `no-installs` and they are explained below. In the future,
we are looking to change the `init` interface, and potentially to split it into two commands.
If you have thoughts or opinions on this, please weigh in on [issue/188]!
After teaching and working with `wasm-pack` for some time, it's clear that people would
like the flexibility to run some of the steps included in the `init` command and not others.
This release introduces a `--mode` flag that you can pass to `init`. The two modes currently
available are `skip-build` and `no-installs` and they are explained below. In the future,
we are looking to change the `init` interface, and potentially to split it into two commands.
If you have thoughts or opinions on this, please weigh in on [issue/188]!
[issue/188]: https://github.com/ashleygwilliams/wasm-pack/issues/188
[pull/186]: https://github.com/ashleygwilliams/wasm-pack/pull/186
[issue/188]: https://github.com/ashleygwilliams/wasm-pack/issues/188
[pull/186]: https://github.com/ashleygwilliams/wasm-pack/pull/186
- **`skip-build` mode - [kohensu], [pull/151]**
@ -2174,7 +2168,7 @@ to `wasm-pack`. Welcome ya'll! We're so glad to have you!
env is set up correctly- now the `--mode no-install` option allows you to
do this.
- **`--debug` - [clanehin], [pull/127]**
- **`--debug` - [clanehin], [pull/127]**
```
wasm-pack init --debug
@ -2486,6 +2480,6 @@ documentation, typo-fixing, and testing work. We appreciate it so much!
[jasondavies]: https://github.com/jasondavies
[edsrzf]: https://github.com/edsrzf
## 💥 0.1.0
## 💥 0.1.0
- First release!

2
Cargo.toml
View File

@ -8,7 +8,7 @@ license = "MIT OR Apache-2.0"
edition = "2021"
readme = "README.md"
categories = ["wasm"]
documentation = "https://rustwasm.github.io/wasm-pack/"
documentation = "https://drager.github.io/wasm-pack/"
[dependencies]
anyhow = "1.0.68"

16
README.md
View File

@ -45,21 +45,21 @@ visiting that repo!
This project requires Rust 1.30.0 or later.
- [Development Environment](https://rustwasm.github.io/wasm-pack/book/prerequisites/index.html)
- [Installation](https://rustwasm.github.io/wasm-pack/installer)
- [Development Environment](https://drager.github.io/wasm-pack/book/prerequisites/index.html)
- [Installation](https://drager.github.io/wasm-pack/installer)
## ⚡ Quickstart Guide
Visit the [quickstart guide] in our documentation.
[quickstart guide]: https://rustwasm.github.io/wasm-pack/book/quickstart.html
[quickstart guide]: https://drager.github.io/wasm-pack/book/quickstart.html
## 🎙️ Commands
- [`new`](https://rustwasm.github.io/wasm-pack/book/commands/new.html): Generate a new RustWasm project using a template
- [`build`](https://rustwasm.github.io/wasm-pack/book/commands/build.html): Generate an npm wasm pkg from a rustwasm crate
- [`test`](https://rustwasm.github.io/wasm-pack/book/commands/test.html): Run browser tests
- [`pack` and `publish`](https://rustwasm.github.io/wasm-pack/book/commands/pack-and-publish.html): Create a tarball of your rustwasm pkg and/or publish to a registry
- [`new`](https://drager.github.io/wasm-pack/book/commands/new.html): Generate a new RustWasm project using a template
- [`build`](https://drager.github.io/wasm-pack/book/commands/build.html): Generate an npm wasm pkg from a rustwasm crate
- [`test`](https://drager.github.io/wasm-pack/book/commands/test.html): Run browser tests
- [`pack` and `publish`](https://drager.github.io/wasm-pack/book/commands/pack-and-publish.html): Create a tarball of your rustwasm pkg and/or publish to a registry
## 📝 Logging
@ -78,7 +78,7 @@ RUST_LOG=info wasm-pack build
Read our [guide] on getting up and running for developing `wasm-pack`, and
check out our [contribution policy].
[guide]: https://rustwasm.github.io/wasm-pack/book/contributing.html
[guide]: https://drager.github.io/wasm-pack/book/contributing.html
[contribution policy]: CONTRIBUTING.md
## 🤹‍♀️ Governance

84
docs/_installer/index.html
View File

@ -1,21 +1,24 @@
<!DOCTYPE html>
<head>
<meta charset="utf-8">
<meta charset="utf-8" />
<title>wasm-pack</title>
<link href="https://cdnjs.cloudflare.com/ajax/libs/skeleton/2.0.4/skeleton.min.css" rel="stylesheet">
<link rel="stylesheet" href="../public/custom.css"/>
<link
href="https://cdnjs.cloudflare.com/ajax/libs/skeleton/2.0.4/skeleton.min.css"
rel="stylesheet"
/>
<link rel="stylesheet" href="../public/custom.css" />
<style>
.winlink {
display: block;
}
</style>
<link rel="apple-touch-icon" sizes="180x180" href="../apple-touch-icon.png">
<link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png">
<link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png">
<link rel="manifest" href="../site.webmanifest">
<link rel="mask-icon" href="../safari-pinned-tab.svg" color="#5bbad5">
<meta name="msapplication-TileColor" content="#00aba9">
<meta name="theme-color" content="#ffffff">
<link rel="apple-touch-icon" sizes="180x180" href="../apple-touch-icon.png" />
<link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png" />
<link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png" />
<link rel="manifest" href="../site.webmanifest" />
<link rel="mask-icon" href="../safari-pinned-tab.svg" color="#5bbad5" />
<meta name="msapplication-TileColor" content="#00aba9" />
<meta name="theme-color" content="#ffffff" />
</head>
<body>
<nav class="navbar">
@ -23,11 +26,13 @@
<ul class="navbar-list">
<li class="navbar-logo">
<a href="/wasm-pack">
<img src="../public/img/rustwasm.png">
<img src="../public/img/rustwasm.png" />
</a>
</li>
<li class="navbar-item">
<a href="https://github.com/rustwasm/wasm-pack/issues/new/choose">File an Issue</a>
<a href="https://github.com/rustwasm/wasm-pack/issues/new/choose"
>File an Issue</a
>
</li>
<li class="navbar-item">
<a href="/wasm-pack/book">Documentation</a>
@ -39,42 +44,55 @@
</div>
</nav>
<section id="installer">
<img src="../public/img/wasm-ferris.png">
<img src="../public/img/wasm-ferris.png" />
<h1>Install <code>wasm-pack</code></h1>
<div class="container">
<div id="platform-instructions-unix" style="display: none;">
<div id="platform-instructions-unix" style="display: none">
<p>
You appear to be running a *nix system (Unix, Linux, MacOS).
Install by running:
You appear to be running a *nix system (Unix, Linux, MacOS). Install
by running:
</p>
<pre class="primary">curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh</pre>
<pre class="primary">
curl https://drager.github.io/wasm-pack/installer/init.sh -sSf | sh</pre
>
<p>
If you're not on *nix, or you don't like installing from <b>curl</b>,
follow the alternate instructions below.
</p>
</div>
<div id="platform-instructions-win64" style="display: none;">
<div id="platform-instructions-win64" style="display: none">
<p>
You appear to be running Windows 64-bit. Download and run
<a class="winlink" href="https://github.com/rustwasm/wasm-pack/releases/download/$VERSION/wasm-pack-init.exe">wasm-pack-init.exe</a>
<a
class="winlink"
href="https://github.com/rustwasm/wasm-pack/releases/download/$VERSION/wasm-pack-init.exe"
>wasm-pack-init.exe</a
>
then follow the onscreen instructions.
</p>
<hr/>
<hr />
<p>
If you're a Windows Subsystem for Linux user, run the following in your
terminal, then follow the onscreen instructions to install wasm-pack.
If you're a Windows Subsystem for Linux user, run the following in
your terminal, then follow the onscreen instructions to install
wasm-pack.
</p>
<pre class="primary">
curl https://drager.github.io/wasm-pack/installer/init.sh -sSf | sh</pre
>
<p>
If you're not on Windows 64-bit, follow the alternate instructions
below.
</p>
<pre class="primary">curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh</pre>
<p>If you're not on Windows 64-bit, follow the alternate instructions below.</p>
</div>
<div id="platform-instructions-unknown" style="display: none;">
<div id="platform-instructions-unknown" style="display: none">
<p>I don't recognize your platform.</p>
<p>
We would appreciate it if you
<a href="https://github.com/rustwasm/wasm-pack/issues/new">reported an issue</a>,
along with the following values:
<a href="https://github.com/rustwasm/wasm-pack/issues/new"
>reported an issue</a
>, along with the following values:
</p>
<div>
<div>navigator.platform:</div>
@ -87,14 +105,16 @@
<hr />
<div id="generic-instructions">
<p>
To install from source on any platform:
</p>
<p>To install from source on any platform:</p>
<p><code>cargo install wasm-pack</code></p>
<p>
On supported platforms, you can also use <b>npm</b> or <b>yarn</b> to download a precompiled binary:
On supported platforms, you can also use <b>npm</b> or <b>yarn</b> to
download a precompiled binary:
</p>
<p>
<code>npm install -g wasm-pack</code> or
<code>yarn global add wasm-pack</code>
</p>
<p><code>npm install -g wasm-pack</code> or <code>yarn global add wasm-pack</code></p>
</div>
</div>
</section>

2
docs/src/introduction.md
View File

@ -1,4 +1,4 @@
![wasm ferris](https://rustwasm.github.io/wasm-pack/public/img/wasm-ferris.png)
![wasm ferris](https://drager.github.io/wasm-pack/public/img/wasm-ferris.png)
<h1 style="text-align: center;">Welcome to the <code>wasm-pack</code> docs!</h1>

2
docs/src/prerequisites/index.md
View File

@ -3,7 +3,7 @@
First you'll want to [install the `wasm-pack` CLI][wasm-pack], and `wasm-pack
-V` should print the version that you just installed.
[wasm-pack]: https://rustwasm.github.io/wasm-pack/installer/
[wasm-pack]: https://drager.github.io/wasm-pack/installer/
Next, since `wasm-pack` is a build tool, you'll want to make sure you have
[Rust][rust] installed. Make sure `rustc -V` prints out at least 1.30.0.

2
docs/src/quickstart.md
View File

@ -11,4 +11,4 @@
registry you want to publish to. You can login using `wasm-pack login`.
[`rustup`]: https://rustup.rs/
[Install this tool.]: https://rustwasm.github.io/wasm-pack/installer/
[Install this tool.]: https://drager.github.io/wasm-pack/installer/

2
docs/src/tutorials/npm-browser-packages/index.md
View File

@ -8,7 +8,7 @@ much Rust knowledge to complete this tutorial.
Be sure to have done the following before starting:
1. [Install `wasm-pack`](https://rustwasm.github.io/wasm-pack/installer/)
1. [Install `wasm-pack`](https://drager.github.io/wasm-pack/installer/)
1. Read and install the [Prerequisites](../../prerequisites/index.html).
⚠️ We strongly recommend that you install [Node.js] using a version manager. You can learn more [here](https://npmjs.com/get-npm).

16
npm/README.md
View File

@ -45,21 +45,21 @@ visiting that repo!
This project requires Rust 1.30.0 or later.
- [Development Environment](https://rustwasm.github.io/wasm-pack/book/prerequisites/index.html)
- [Installation](https://rustwasm.github.io/wasm-pack/installer)
- [Development Environment](https://drager.github.io/wasm-pack/book/prerequisites/index.html)
- [Installation](https://drager.github.io/wasm-pack/installer)
## ⚡ Quickstart Guide
Visit the [quickstart guide] in our documentation.
[quickstart guide]: https://rustwasm.github.io/wasm-pack/book/quickstart.html
[quickstart guide]: https://drager.github.io/wasm-pack/book/quickstart.html
## 🎙️ Commands
- [`new`](https://rustwasm.github.io/wasm-pack/book/commands/new.html): Generate a new RustWasm project using a template
- [`build`](https://rustwasm.github.io/wasm-pack/book/commands/build.html): Generate an npm wasm pkg from a rustwasm crate
- [`test`](https://rustwasm.github.io/wasm-pack/book/commands/test.html): Run browser tests
- [`pack` and `publish`](https://rustwasm.github.io/wasm-pack/book/commands/pack-and-publish.html): Create a tarball of your rustwasm pkg and/or publish to a registry
- [`new`](https://drager.github.io/wasm-pack/book/commands/new.html): Generate a new RustWasm project using a template
- [`build`](https://drager.github.io/wasm-pack/book/commands/build.html): Generate an npm wasm pkg from a rustwasm crate
- [`test`](https://drager.github.io/wasm-pack/book/commands/test.html): Run browser tests
- [`pack` and `publish`](https://drager.github.io/wasm-pack/book/commands/pack-and-publish.html): Create a tarball of your rustwasm pkg and/or publish to a registry
## 📝 Logging
@ -78,7 +78,7 @@ RUST_LOG=info wasm-pack build
Read our [guide] on getting up and running for developing `wasm-pack`, and
check out our [contribution policy].
[guide]: https://rustwasm.github.io/wasm-pack/book/contributing.html
[guide]: https://drager.github.io/wasm-pack/book/contributing.html
[contribution policy]: CONTRIBUTING.md
## 🤹‍♀️ Governance

2
src/build/wasm_target.rs
View File

@ -25,7 +25,7 @@ impl fmt::Display for Wasm32Check {
let rustup_string = if self.is_rustup {
"It looks like Rustup is being used.".to_owned()
} else {
format!("It looks like Rustup is not being used. For non-Rustup setups, the {} target needs to be installed manually. See https://rustwasm.github.io/wasm-pack/book/prerequisites/non-rustup-setups.html on how to do this.", target)
format!("It looks like Rustup is not being used. For non-Rustup setups, the {} target needs to be installed manually. See https://drager.github.io/wasm-pack/book/prerequisites/non-rustup-setups.html on how to do this.", target)
};
writeln!(

2
src/main.rs
View File

@ -92,7 +92,7 @@ fn run() -> Result<()> {
match wasm_pack_version {
Ok(wasm_pack_version) =>
PBAR.warn(&format!("There's a newer version of wasm-pack available, the new version is: {}, you are using: {}. \
To update, navigate to: https://rustwasm.github.io/wasm-pack/installer/", wasm_pack_version.latest, wasm_pack_version.local)),
To update, navigate to: https://drager.github.io/wasm-pack/installer/", wasm_pack_version.latest, wasm_pack_version.local)),
Err(err) => PBAR.warn(&format!("{}", err))
}
}

8
tests/all/manifest.rs
View File

@ -391,7 +391,7 @@ fn it_sets_homepage_field_if_available_in_cargo_toml() {
name = "homepage-field-test"
repository = "https://github.com/rustwasm/wasm-pack.git"
version = "0.1.0"
homepage = "https://rustwasm.github.io/wasm-pack/"
homepage = "https://drager.github.io/wasm-pack/"
[lib]
crate-type = ["cdylib"]
@ -415,7 +415,7 @@ fn it_sets_homepage_field_if_available_in_cargo_toml() {
let pkg = utils::manifest::read_package_json(&fixture.path, &out_dir).unwrap();
assert_eq!(
pkg.homepage,
Some("https://rustwasm.github.io/wasm-pack/".to_string()),
Some("https://drager.github.io/wasm-pack/".to_string()),
);
// When 'homepage' is unavailable
@ -614,7 +614,7 @@ fn it_recurses_up_the_path_to_find_cargo_toml() {
name = "recurse-for-manifest-test"
repository = "https://github.com/rustwasm/wasm-pack.git"
version = "0.1.0"
homepage = "https://rustwasm.github.io/wasm-pack/"
homepage = "https://drager.github.io/wasm-pack/"
"#,
);
let path = get_crate_path(None).unwrap();
@ -636,7 +636,7 @@ fn it_doesnt_recurse_up_the_path_to_find_cargo_toml_when_default() {
name = "recurse-for-manifest-test"
repository = "https://github.com/rustwasm/wasm-pack.git"
version = "0.1.0"
homepage = "https://rustwasm.github.io/wasm-pack/"
homepage = "https://drager.github.io/wasm-pack/"
"#,
);
let path = get_crate_path(Some(PathBuf::from("src"))).unwrap();