diff --git a/CHANGELOG.md b/CHANGELOG.md index 76d6189..cd55ca7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 @@ -713,7 +712,7 @@ using binaryen version 78. This version had various issues on Unix/Linux and caused broken CI builds for many folks (we're so sorry!). - This PR updates the binaryen version to 90, which should fix the issues folks were having. + This PR updates the binaryen version to 90, which should fix the issues folks were having. Long-term, we'd like to create an auto-updating mechanism so that we can install and use the latest release of binaryen as we do for other binaries we orchestrate. @@ -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 @@ -782,7 +781,7 @@ [alexcrichton]: https://github.com/alexcrichton [pull/625]: https://github.com/rustwasm/wasm-pack/pull/625 - [issue/159]: https://github.com/rustwasm/wasm-pack/issues/159 + [issue/159]: https://github.com/rustwasm/wasm-pack/issues/159 - **Helpful error message when wasm-bindgen fails because of an old version - [gameldar], [ashleygwilliams], [issue/627] [pull/633]** @@ -839,7 +838,7 @@ - **Remove broken link from the README - [drager], [pull/635]** [drager]: https://github.com/drager - [pull/635]: https://github.com/rustwasm/wasm-pack/pull/635 + [pull/635]: https://github.com/rustwasm/wasm-pack/pull/635 - **Make `sideEffects` in generated `package.json` a boolean instead of a string - [rhysd], [pull/649]** @@ -905,7 +904,7 @@ [ashleygwilliams]: https://github.com/ashleygwilliams [pull/626]: https://github.com/rustwasm/wasm-pack/pull/626 - [issue/370]: https://github.com/rustwasm/wasm-pack/issues/370 + [issue/370]: https://github.com/rustwasm/wasm-pack/issues/370 - ### ๐Ÿ› ๏ธ Maintenance @@ -928,7 +927,7 @@ [data-pup]: https://github.com/data-pup [pull/664]: https://github.com/rustwasm/wasm-pack/pull/664 - [issue/639]: https://github.com/rustwasm/wasm-pack/issues/639 + [issue/639]: https://github.com/rustwasm/wasm-pack/issues/639 ## ๐Ÿ› ๏ธ 0.8.1 @@ -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` 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` 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 @@ -1083,7 +1082,7 @@ - **Add support for `--target web` - [alexcrichton], [pull/567]** Recently, `wasm-bindgen` add a new target- `web`. This new target is similar to the `no-modules` target, in that - it is designed to generate code that should be loaded directly in a browser, without the need of a bundler. As + it is designed to generate code that should be loaded directly in a browser, without the need of a bundler. As opposed to the `no-modules` target, which produces an IIFE (Immediately Invoked Function Expression), this target produces code that is an ES6 module. @@ -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! @@ -1182,7 +1181,7 @@ - **Correct look up location for `wasm-bindgen` when it's installed via `cargo install` - [fitzgen], [pull/504]** Sometimes, when a `wasm-bindgen` binary is not available, or if `wasm-pack` is being run on an architecture that - `wasm-bindgen` doesn't produce binaries for, instead of downloading a pre-built binary, `wasm-pack` will install + `wasm-bindgen` doesn't produce binaries for, instead of downloading a pre-built binary, `wasm-pack` will install `wasm-bindgen` using `cargo install`. This is a great and flexible back up! However, due to the last release's recent refactor to use a global cache, we overlooked the `cargo install` case @@ -1190,7 +1189,7 @@ would panic. We've fixed the lookup for the `cargo install`'d `wasm-bindgen` by moving the `cargo-install`'d version to global - cache location for `wasm-pack` once it's successfully built. We also eliminated the panic in favor of + cache location for `wasm-pack` once it's successfully built. We also eliminated the panic in favor of propagating an error. Thanks for your bug reports and sorry about the mistake! [pull/504]: https://github.com/rustwasm/wasm-pack/pull/504 @@ -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 @@ -1228,7 +1227,7 @@ [`assert_cmd`] is a great utility for testing CLI applications that is supported by the [CLI WG]. `wasm-pack` development began before this library existed- so we were using a much less pleasant and efficient strategy to test the CLI functionality of `wasm-pack`. Now we've ported over to using this great library! - + [CLI WG]: https://www.rust-lang.org/what/cli [`assert_cmd`]: https://crates.io/crates/assert_cmd [pull/522]: https://github.com/rustwasm/wasm-pack/pull/522 @@ -1259,21 +1258,21 @@ - **Flag gh-pages docs as unpublished - [alexcrichton] [pull/565]** - Recently, [DebugSteven] made a PR to merge all the documentation for the rustwasm toolchain into a + Recently, [DebugSteven] made a PR to merge all the documentation for the rustwasm toolchain into a [single location]. This is going to make discovering and using tools from the entire organization easier for new and seasoned folks alike. This also has the feature of displaying documentation that is related to the current published version of each tool- unlike before, where the only accessible documentation was for the tools at current master (which may or may not be currently published!) If you like reading the current master's documentation- fear not, each tool will still publish the - documentation generated from the master branch on their individual `gh-pages` + documentation generated from the master branch on their individual `gh-pages` ([See `wasm-pack's` master docs here]). To avoid confusion, we've added a flash message that let's you know which documentation you are reading- and provides a link to documentation of the published version- just in case that's what you're looking for! [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 @@ -1341,8 +1340,7 @@ [issue/513]: https://github.com/rustwasm/wasm-pack/issues/513 [pull/514]: https://github.com/rustwasm/wasm-pack/pull/514 - [pull/516]: https://github.com/rustwasm/wasm-pack/pull/516 - + [pull/516]: https://github.com/rustwasm/wasm-pack/pull/516 ## ๐ŸŒ… 0.6.0 @@ -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]. @@ -1374,7 +1372,7 @@ however, as our community and their projects mature alongside the tool, it became clear that allowing folks the ability to drop down and configure things was something we needed to do to meet their needs. - Currently, you can only configure things related to the above-mentioned build profiles. To learn more, + Currently, you can only configure things related to the above-mentioned build profiles. To learn more, [check out the documentation][profile-config-docs]. It leverages the `package.metadata.wasm-pack` key in your `Cargo.toml`, and looks like this: @@ -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 @@ -1418,15 +1416,14 @@ wasm-pack build examples/js-hello-world --mode no-install -- -Z offline ``` - In the above example, the flag `-Z offline` will be passed to `cargo build`. This feature is documented + 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`, @@ -1434,10 +1431,10 @@ out-directory containing a `package.json`. In this situation, you would hope that `wasm-pack` would build your package for you when you - ran `wasm-pack publish`. This is slightly complicated by the fact that not everyone wants to + 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: @@ -1471,7 +1468,7 @@ in a single cargo project. Because of how `wasm-pack` handled paths for `target` and out-directories, we did not support cargo workspaces out of the box. Now they should work well and the feature is well guarded by tests! - + [issue/252]: https://github.com/rustwasm/wasm-pack/issues/252 [issue/305]: https://github.com/rustwasm/wasm-pack/issues/305 [pull/430]: https://github.com/rustwasm/wasm-pack/pull/430 @@ -1516,7 +1513,7 @@ For a few releases now, `wasm-pack` has supported allowing users to specifying the target module system they'd like their package built for- `browser`, `nodejs`, and `no-modules`. We did not however, validate this input, and so if a user made even a slight mistake, e.g. `node`, `wasm-pack` would not catch the - error and would build your project using the default, `browser`. This is of course, surprising, and + error and would build your project using the default, `browser`. This is of course, surprising, and unpleasant behavior and so now we'll error out with a message containing the supported target names. [issue/483]: https://github.com/rustwasm/wasm-pack/issues/483 @@ -1536,7 +1533,7 @@ | :-) Your wasm pkg is ready to publish at "\\\\?\\C:\\Users\\Ferris\\tmp\\wasm-bug\\pkg". ``` - We've updated this to make sure the path to your project is well-formed, and most importantly, + We've updated this to make sure the path to your project is well-formed, and most importantly, human-readable. [issue/390]: https://github.com/rustwasm/wasm-pack/issues/390 @@ -1560,13 +1557,13 @@ - **Fix wasm-bindgen if lib is renamed via `lib.name` - [alexcrichton], [issue/339] [pull/435]** - In some circumstances, a library author may wish to specify a `name` in the `[package]` portion of their + In some circumstances, a library author may wish to specify a `name` in the `[package]` portion of their `Cargo.toml`, as well as a different `name` in the `[lib]` portion, e.g.: ```toml [package] name = "hello-wasm" - + [lib] name = "wasm-lib" ``` @@ -1590,7 +1587,7 @@ - **Add no-modules to --target flag's help text - [fitzgen], [issue/416] [pull/417]** - This is an interesting one! `fitzgen` very reasonably filed an issue asking to add `wasm-bindgen`'s + This is an interesting one! `fitzgen` very reasonably filed an issue asking to add `wasm-bindgen`'s `--target no-modules` feature to `wasm-pack`. This was confusing as this feature was indeed already implemented, and documented- BUT, notably missing from the `wasm-pack --help` text. We've fixed that now- and it was an omission so glaring we definitely considered it a bug! @@ -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 @@ -1612,7 +1609,7 @@ - **Move binary installation to its own crate - [drager], [issue/384] [pull/415]** In `wasm-pack 0.5.0`, we move away from `cargo install`ing many of the tools that `wasm-pack` orchestrates. Because - we used `cargo install`, this required an end user to sit through the compilation of each tool, which was a + we used `cargo install`, this required an end user to sit through the compilation of each tool, which was a prohibitively long time. We moved, instead, to building, and then installing, binaries of the tools. This sped up build times dramatically! @@ -1628,7 +1625,7 @@ The story of error message handling in `wasm-pack` has not been the prettiest. We originally were manually implementing errors, adding the [`failure` crate] at one point, but not fully updating the entire codebase. With this PR, we are - nearly completely handling errors with `failure`, bringing the code into a much more maintainable and + nearly completely handling errors with `failure`, bringing the code into a much more maintainable and pleasant-to-work-on place. [`failure` crate]: https://crates.io/crates/failure @@ -1641,7 +1638,7 @@ - **Read the `Cargo.toml` file only once - [fitzgen], [issue/25] [pull/431]** This is a very fun one since it fixes one of the original issues filed by `ag_dubs` at the very beginning of `wasm-pack` - development. In a rush to implement a POC tool, `ag_dubs` noted for posterity that the `Cargo.toml` was being read + development. In a rush to implement a POC tool, `ag_dubs` noted for posterity that the `Cargo.toml` was being read multiple times (twice), when it did not need to be. Thanks to `fitzgen` now it's read only once! A minor performance improvement in the scheme of things, but a nice one :) @@ -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. @@ -1707,7 +1704,7 @@ [issue/393]: https://github.com/rustwasm/wasm-pack/issues/393 [pull/394]: https://github.com/rustwasm/wasm-pack/pull/394 - + - **Add `exit_status` to CLI errors - [konstin], [issue/291] [pull/387]** We'd been hiding these- but we shouldn't have been! @@ -1719,7 +1716,7 @@ - **Remove lingering forced nightly usage - [alexcrichton], [pull/383]** In 0.5.0 we removed all forced nightly usage as we depend on `~1.30` which is now - available on both nightly and beta channels! We had a bit of a race condition with + available on both nightly and beta channels! We had a bit of a race condition with that PR and the `wasm-pack test` PR, and missed a few as a result! This removes all lingering forced nightly, which only affected the `wasm-pack test` command. @@ -1743,14 +1740,12 @@ - **Leverage `failure::Error` consistently - [drager], [issue/280] [pull/401]** This PR finally makes it so that `wasm-pack` is handling errors in a consistent - way across the codebase. + way across the codebase. [drager]: https://github.com/drager [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 @@ -1773,16 +1768,16 @@ are generated by the project. Previously, we generated a JavaScript file and placed it in the `main` key, regardless - of what you were targeting, ES6 and Node.js alike. + of what you were targeting, ES6 and Node.js alike. We have received a lot of requests for `wasm-pack` to generate "isomorphic" packages, - that contain assets that could work on both Node.js and ES6, and this led to us + that contain assets that could work on both Node.js and ES6, and this led to us looking more closely at how we are using `package.json`. With this release, we will do the following: - `--target browser`: By default, we generate JS that is an ES6 module. We used to put - this in the `main` field. Now we put it in the `module` field. We also add + this in the `main` field. Now we put it in the `module` field. We also add `sideEffects: false` so that bundlers that want to tree shake can. - `--target nodejs`: This target doesn't change. We put generated JS that is a @@ -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! @@ -1844,7 +1839,7 @@ - **`--access` flag for `wasm-pack` publish - [ashleygwilliams], [issue/297] [pull/299]** - Many of our tutorials use scopes to help prevent folks from attempting to publish + Many of our tutorials use scopes to help prevent folks from attempting to publish packages that will lead to npm Registry errors because the package name already exists. However, by default, scoped packages are assumed by the npm registry to be private, and @@ -1856,7 +1851,7 @@ [pull/299]: https://github.com/rustwasm/wasm-pack/pull/299 - #### โœ… New Checks - + - **rustc version check - [ashleygwilliams], [issue/351] [pull/353]** Now that we have a new fangled installer, there's a chance that folks might install `wasm-pack` @@ -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. @@ -2068,9 +2063,8 @@ The Rust 2018 edition marches on and we are seeing feature flags drop like flies :) Instead of a whole slew of feature flags, we now only need one, `#![feature(use_extern_macros)]`, and that one is also not long for this world :) - - [pull/226]: https://github.com/rustwasm/wasm-pack/pull/226 + [pull/226]: https://github.com/rustwasm/wasm-pack/pull/226 ## โญ 0.4.1 @@ -2078,7 +2072,7 @@ - **fix `files` key value for projects build for `nodejs` target - [ashleygwilliams], [issue/199] [pull/205]** - We became aware that the `files` key in `package.json` did not include the additional `_bg.js` file that + We became aware that the `files` key in `package.json` did not include the additional `_bg.js` file that `wasm-bindgen` generates for projects being built for the `nodejs` target. This resulted in the file not being included in the published package and resulted in a `Module Not Found` error for folks. @@ -2137,17 +2131,17 @@ to `wasm-pack`. Welcome ya'll! We're so glad to have you! - #### ๐ŸŽ New Flags - - **`--mode` flag for skipping steps when calling `init` - [ashleygwilliams], [pull/186]** + - **`--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,14 +2168,14 @@ 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 ``` Find yourself needing to compile your Rust in `development` mode? You can now - pass the `--debug` flag to do so! Thanks so much to [clanehin] for filing + pass the `--debug` flag to do so! Thanks so much to [clanehin] for filing [issue/126] for this feature... and then implementing it! [pull/127]: https://github.com/ashleygwilliams/wasm-pack/pull/127 @@ -2285,7 +2279,7 @@ to `wasm-pack`. Welcome ya'll! We're so glad to have you! - **cleaned up the README - [ashleygwilliams], [pull/155]** Our `README` was struggling with a common problem- doing too much at once. - More specifically, it wasn't clear who the audience was, contributers or + More specifically, it wasn't clear who the audience was, contributers or end users? We've cleaned up our README and created a document specifically to help contributors get up and running. @@ -2295,13 +2289,13 @@ to `wasm-pack`. Welcome ya'll! We're so glad to have you! Babby's first point release! Are we a real project now? -### ๐Ÿค• Fixes +### ๐Ÿค• Fixes - **fixed `init` `Is a Directory` error - [ashleygwilliams], [pull/139]** Our new logging feature accidentally introduced a regression into 0.3.0. When calling `wasm-pack init`, if a directory was not passed, a user would receive - a "Is a Directory" Error. Sorry about that! Thanks to [jbolila] for filing + a "Is a Directory" Error. Sorry about that! Thanks to [jbolila] for filing [issue/136]! [pull/139]: https://github.com/ashleygwilliams/wasm-pack/pull/139 @@ -2311,8 +2305,8 @@ Babby's first point release! Are we a real project now? - **typescript files were not included in published package - [danreeves], [pull/138]** Generating Typescript type files by default was a pretty rad feature in - 0.3.0 but we accidentally forgot to ensure they were included in the - published package. Thanks so much to [danreeves] for catching this issue + 0.3.0 but we accidentally forgot to ensure they were included in the + published package. Thanks so much to [danreeves] for catching this issue and fixing it for us! [danreeves]: https://github.com/danreeves @@ -2335,7 +2329,7 @@ Babby's first point release! Are we a real project now? `wasm-bindgen-cli` is able to generate a JS module wrapper for generated wasm files for both ES6 modules and CommonJS. Up until now, we only used wasm-bindgen's default - behavior, ES6 modules. You can now pass a `--target` flag with either `nodejs` or + behavior, ES6 modules. You can now pass a `--target` flag with either `nodejs` or `browser` to generate the type of module you want to use. Defaults to `browser` if not passed. @@ -2391,13 +2385,13 @@ Babby's first point release! Are we a real project now? tab of our GitHub repo. [Releases]: https://github.com/ashleygwilliams/wasm-pack/releases -[pull/135]: https://github.com/ashleygwilliams/wasm-pack/pull/135 +[pull/135]: https://github.com/ashleygwilliams/wasm-pack/pull/135 -### ๐Ÿ› ๏ธ Maintenance +### ๐Ÿ› ๏ธ Maintenance - **remove `quicli` dependency - [mgattozzi], [pull/131]** - While `quicli` is a great way to get started writing a CLI app in Rust- it's not meant for + While `quicli` is a great way to get started writing a CLI app in Rust- it's not meant for large, mature applications. Now that `wasm-pack` is bigger and has many active users, we've removed this dependency to unblock further development on the tool. @@ -2475,7 +2469,7 @@ handling for improved user experience! ### ๐Ÿ› ๏ธ Maintenance and ๐Ÿ“– Documentation -Thanks so much to [mgattozzi], [data-pup], [sendilkumarn], [Andy-Bell], +Thanks so much to [mgattozzi], [data-pup], [sendilkumarn], [Andy-Bell], [steveklabnik], [jasondavies], and [edsrzf] for all the awesome refactoring, documentation, typo-fixing, and testing work. We appreciate it so much! @@ -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! +- First release! diff --git a/Cargo.toml b/Cargo.toml index ed36f30..a6df069 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -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" diff --git a/README.md b/README.md index 56cbee4..f893a00 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/_installer/index.html b/docs/_installer/index.html index db6cd46..489f67e 100644 --- a/docs/_installer/index.html +++ b/docs/_installer/index.html @@ -1,21 +1,24 @@ - + wasm-pack - - + + - - - - - - - + + + + + + +
- +

Install wasm-pack

-
diff --git a/docs/src/introduction.md b/docs/src/introduction.md index 06b6456..fea2b7a 100644 --- a/docs/src/introduction.md +++ b/docs/src/introduction.md @@ -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)

Welcome to the wasm-pack docs!

diff --git a/docs/src/prerequisites/index.md b/docs/src/prerequisites/index.md index 0de6a4f..619c2b2 100644 --- a/docs/src/prerequisites/index.md +++ b/docs/src/prerequisites/index.md @@ -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. diff --git a/docs/src/quickstart.md b/docs/src/quickstart.md index c249123..b15f77d 100644 --- a/docs/src/quickstart.md +++ b/docs/src/quickstart.md @@ -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/ diff --git a/docs/src/tutorials/npm-browser-packages/index.md b/docs/src/tutorials/npm-browser-packages/index.md index 614851d..747e2a9 100644 --- a/docs/src/tutorials/npm-browser-packages/index.md +++ b/docs/src/tutorials/npm-browser-packages/index.md @@ -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). diff --git a/npm/README.md b/npm/README.md index 56cbee4..f893a00 100644 --- a/npm/README.md +++ b/npm/README.md @@ -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 diff --git a/src/build/wasm_target.rs b/src/build/wasm_target.rs index 609669c..51380bc 100644 --- a/src/build/wasm_target.rs +++ b/src/build/wasm_target.rs @@ -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!( diff --git a/src/main.rs b/src/main.rs index 1fe1f58..46555f2 100644 --- a/src/main.rs +++ b/src/main.rs @@ -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)) } } diff --git a/tests/all/manifest.rs b/tests/all/manifest.rs index 8d4af2d..1b09e5b 100644 --- a/tests/all/manifest.rs +++ b/tests/all/manifest.rs @@ -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();