NextGraph
/
wasm-pack
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
fork of https://github.com/rustwasm/wasm-pack for the needs of NextGraph.org
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
434 Commits
1 Branch
0 Tags
3.3 MiB
 
 
Tag: Branch: Tree: 99ea5d3a81
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '99ea5d3a81'
${ noResults }
wasm-pack/CHANGELOG.md

472 lines
20 KiB
Raw Blame History Escape

# Changelog
## ✨ 0.4.2
- #### 🤕 Fixes
- **recognize `[dependencies.wasm-bindgen]` during dep check in `init` - [ashleygwilliams], [issue/221] [pull/224]**
When we originally implemented the dependency check in `wasm-pack init` we naively only checked for the
"simple" dependency declaration, `[dependencies] wasm-bindgen="0.2"`. However! This is not the only way
to declare this dependency, and it's not the ideal way to do it if you want to specify features from the
crate. Now that a bunch of folks want to use `features = ["serde-serialize"]` we ran into a bunch of folks
having issues with our naive dependency checker! Thanks so much to [turboladen] for filing the very detailed
issue that helped us solve this quickly!
PSSSST! Curious what `features = ["serde-serialize"]` with `wasm-bindgen` actually does? It's awesome:
> It's possible to pass data from Rust to JS not explicitly supported in the [Feature Reference](./feature-reference.md) by serializing via [Serde](https://github.com/serde-rs/serde).
Read the [Passing arbitrary data to JS docs] to learn more!
[Passing arbitrary data to JS docs]: https://github.com/rustwasm/wasm-bindgen/blob/master/guide/src/reference/arbitrary-data-with-serde.md
[turboladen]: https://github.com/turboladen
[issue/221]: https://github.com/rustwasm/wasm-pack/issues/221
[pull/224]: https://github.com/rustwasm/wasm-pack/pull/224
- **improve UX of publish and pack commands - [Mackiovello], [pull/198]**
Previous to this fix, you would need to be in the parent directory of the `/pkg` dir to successfully run
`pack` or `publish`. This was pretty crummy! Thankfully, [Mackiovello] swooped in with a fix, that you can
find documented in the [pack and publish docs]!
[Mackiovello]: https://github.com/Mackiovello
[pull/198]: https://github.com/rustwasm/wasm-pack/pull/198
[pack and publish docs]: https://github.com/rustwasm/wasm-pack/blob/05e4743c22b57f4c4a1bfff1df1d2cc1a595f523/docs/pack-and-publish.md
- **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
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.
[pull/220]: https://github.com/rustwasm/wasm-pack/pull/220
- #### 📖 Documentation
- **update docs and tests to eliminate no longer necessary feature flags - [ashleygwilliams], [pull/226]**
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
## ⭐ 0.4.1
- #### 🤕 Fixes
- **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
`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.
This was a group effort from [mciantyre] with [pull/200] and [Brooooooklyn] with [pull/197]. Thank you so
much for your diligence and patience while we sorted through it.
[mciantyre]: https://github.com/mciantyre
[Brooooooklyn]: https://github.com/Brooooooklyn
[issue/199]: https://github.com/rustwasm/wasm-pack/issues/199
[pull/205]: https://github.com/rustwasm/wasm-pack/pull/205
[pull/197]: https://github.com/rustwasm/wasm-pack/pull/197
[pull/200]: https://github.com/rustwasm/wasm-pack/pull/200
- #### 🛠️ Maintenance
- **clean up `quicli` remnants - [SoryRawyer], [pull/193]**
In [v0.3.0] we removed the `quicli` dependency, however there were a few remnants
left behind. They are now removed!
[SoryRawyer]: https://github.com/SoryRawyer
[pull/193]: https://github.com/rustwasm/wasm-pack/pull/193
[v0.3.0]: https://github.com/rustwasm/wasm-pack/blob/master/CHANGELOG.md#-030
- #### 📖 Documentation
- **DOCUMENT EVERYTHING!! and deny missing docs for all future development - [fitzgen], [pull/208]**
The `wasm-pack` team has worked hard on tutorial documentation and keeping the codebase as self-explanatory
as possible, but we have been slowly accruing a documentation debt. This amazing PR, landed just moments
before this point release and was just too good not to include. Thank you so much, [fitzgen]!
[fitzgen]: https://github.com/fitzgen
[pull/208]: https://github.com/rustwasm/wasm-pack/pull/208
- **fix README code example - [steveklabnik], [pull/195]**
The code example in our `README.md` was missing a critical `pub`. It's there now!
[pull/195]: https://github.com/rustwasm/wasm-pack/pull/195/files
- **fix README markup - [Hywan], [pull/202]**
There was an errant `` ` `` - it's gone now!
[Hywan]: https://github.com/Hywan
[pull/202]: https://github.com/rustwasm/wasm-pack/pull/202
## 🌟 0.4.0
This release has a ton of awesome things in it, but the best thing is that
almost all of this awesome work is brought to you by a **new** contributor
to `wasm-pack`. Welcome ya'll! We're so glad to have you!
### ✨ Features
- #### 🎏 New Flags
- **`--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]!
[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]**
```
wasm-pack init --mode skip-build
```
Sometimes you want to run some of the shorter meta-data steps that
`wasm-pack init` does for you without all the longer build steps. Now
you can! Additionally, this PR was a fantastic refactor that allows even
more custom build configurations will be simple to implement!
[kohensu]: https://github.com/kohensu
[pull/151]: https://github.com/ashleygwilliams/wasm-pack/pull/151
- **`no-installs` mode - [ashleygwilliams], [pull/186]**
```
wasm-pack init --mode no-installs
```
Sometimes you want to run `wasm-pack` and not have it modify your global
env by installing stuff! Or maybe you are just in a hurry and trust your
env is set up correctly- now the `--mode no-install` option allows you to
do this.
- **`--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
[issue/126] for this feature... and then implementing it!
[pull/127]: https://github.com/ashleygwilliams/wasm-pack/pull/127
[issue/126]: https://github.com/ashleygwilliams/wasm-pack/issues/126
[clanehin]: https://github.com/clanehin
- #### ✅ New Checks
- **ensure you have `cdylib` crate type - [kendromelon], [pull/150]**
One of the biggest mistakes we've seen beginners make is forgetting to declare
the `cdylib` crate type in their `Cargo.toml` before running `wasm-pack init`.
This PR fixes that, and comes from someone who ran into this exact issue learning
about `wasm-pack` at [JSConfEU]! Love when it works out like this.
[JSConfEU]: https://2018.jsconf.eu/
[kendromelon]: https://github.com/kedromelon
[pull/150]: https://github.com/ashleygwilliams/wasm-pack/pull/150
- **ensure you have declared wasm-bindgen as a dep - [robertohuertasm], [pull/162]**
Another easy mistake to make is to forget to declare `wasm-bindgen` as a
dependency in your `Cargo.toml`. Now `wasm-pack` will check and make sure you
have it set before doing a bunch of long build steps :)
[robertohuertasm]: https://github.com/robertohuertasm
[pull/162]: https://github.com/ashleygwilliams/wasm-pack/pull/162
- **ensure you are running `nightly` - [FreeMasen], [pull/172]**
`wasm-pack` currently requires that you run it with `nightly` Rust. Now, `wasm-pack`
will make sure you have `nightly` installed and will ensure that `cargo build` is run
with `nightly`. Thanks so much to [FreeMasen] for filing [issue/171] and fixing it!
[FreeMasen]: https://github.com/FreeMasen
[issue/171]: https://github.com/ashleygwilliams/wasm-pack/issues/171
[pull/172]: https://github.com/ashleygwilliams/wasm-pack/pull/172
### 🤕 Fixes
- **fixed broken progress bar spinner - [migerh], [pull/164]**
Oh no! We broke the progress bar spinner in version 0.3.0. Thankfully, it's
fixed now- with a thoughtful refactor that also makes the underlying code
sounder overall.
[migerh]: https://github.com/migerh
[pull/164]: https://github.com/ashleygwilliams/wasm-pack/pull/164
### 🛠️ Maintenance
- **WIP bot - [ashleygwilliams] & [mgattozzi], [issue/170]**
We've got a lot of work happening on `wasm-pack` so it's good to have a bit
of protection from accidentally merging a Work In Progress. As a result, we
now have the [WIP Github App] set up on `wasm-pack`. Great suggestion [mgattozzi]!
[WIP Github App]: https://github.com/wip/app
[issue/170]: https://github.com/ashleygwilliams/wasm-pack/issues/170
- **modularize `command.rs` - [ashleygwilliams], [pull/182]**
Thanks to the growth of `wasm-pack`, `command.rs` was getting pretty long.
We've broken it out into per command modules now, to help make it easier to
read and maintain!
[pull/182]: https://github.com/ashleygwilliams/wasm-pack/pull/182
- **improve PoisonError conversion - [migerh], [pull/187]**
As part of the awesome progress bar spinner fix in [pull/164], [migerh] introduced
a small concern with an `unwrap` due to an outstanding need to convert `PoisonError`
into `wasm-pack`'s custom `Error`. Though not a critical concern, [migerh] mitigated
this right away by replacing `std::sync::RwLock` with the [`parking_lot` crate]!
This cleaned up the code even more than the previous patch!
[`parking_lot` crate]: https://github.com/Amanieu/parking_lot
[pull/187]: https://github.com/ashleygwilliams/wasm-pack/pull/187
- **wasm category for crates.io discovery- [TomasHubelbauer], [pull/149]**
[crates.io] has [categories] to help folks discover crates, be we weren't
leveraging it! Now- if you explore the [`wasm` category] on [crates.io]
you'll see `wasm-pack`!
[crates.io]: https://crates.io/
[categories]: https://crates.io/categories
[`wasm` category]: https://crates.io/categories/wasm
[TomasHubelbauer]: https://github.com/TomasHubelbauer
[pull/149]: https://github.com/ashleygwilliams/wasm-pack/pull/149
- **human panic is now 1.0.0 - [spacekookie], [pull/156]**
Congrats friends! We like what you do.
[pull/156]: https://github.com/ashleygwilliams/wasm-pack/pull/156
[spacekookie]: https://github.com/spacekookie
### 📖 Documentation
- **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
end users? We've cleaned up our README and created a document specifically
to help contributors get up and running.
[pull/155]: https://github.com/ashleygwilliams/wasm-pack/pull/155
## 🌠 0.3.1
Babby's first point release! Are we a real project now?
### 🤕 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
[issue/136]!
[pull/139]: https://github.com/ashleygwilliams/wasm-pack/pull/139
[issue/136]: https://github.com/ashleygwilliams/wasm-pack/issues/136
[jbolila]: https://github.com/jbolila
- **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
and fixing it for us!
[danreeves]: https://github.com/danreeves
[pull/138]: https://github.com/ashleygwilliams/wasm-pack/pull/138
## 💫 0.3.0
### ✨ Features
- **Logging - [mgattozzi], [pull/134]**
Up until now, we've forced folks to rely on emoji-jammed console output to debug
errors. While emojis are fun, this is often not the most pleasant experience. Now
we'll generate a `wasm-pack.log` file if `wasm-pack` errors on you, and you can
customize the log verbosity using the (previously unimplemented) verbosity flag.
[pull/134]: https://github.com/ashleygwilliams/wasm-pack/pull/134
- **`--target` flag - [djfarly], [pull/132]**
`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
`browser` to generate the type of module you want to use. Defaults to `browser` if not
passed.
[djfarly]: https://github.com/djfarly
[pull/132]: https://github.com/ashleygwilliams/wasm-pack/pull/132
- **human readable panics - [yoshuawuyts], [pull/118]**
Panics aren't always the most friendly situation ever. While we never want to panic on ya,
if we do- we'll do it in a way that's a little more readable now.
[pull/118]: https://github.com/ashleygwilliams/wasm-pack/pull/118
- **typescript support by default - [kwonoj], [pull/109]**
`wasm-bindgen` now generates typescript type files by default. To suppress generating
the type file you can pass the `--no-typescript` flag. The type file is useful for more
than just typescript folks- many IDEs use it for completion!
[kwonoj]: https://github.com/kwonoj
[pull/109]: https://github.com/ashleygwilliams/wasm-pack/pull/109
- **wrap `npm login` command - [djfarly], [pull/100]**
In order to publish a package to npm, you need to be logged in. You can now use
`wasm-pack login` to login to the npm (or any other) registry.
[pull/100]: https://github.com/ashleygwilliams/wasm-pack/pull/100
- **exit early on failure - [mgattozzi], [pull/90]**
Until now, `wasm-pack` would continue to run tasks, even if a task failed. Now- if something
fails, we'll exit so you don't have to wait to fix the error.
[pull/90]: https://github.com/ashleygwilliams/wasm-pack/pull/90
### 🤕 Fixes
- **force install wasm-bindgen - [ashleygwilliams], [pull/133]**
Using an out of date version of `wasm-bindgen` can run you into a bunch of trouble. This
very small change should fix the large number of bug reports we received from users using
an out of date `wasm-bindgen-cli` by force installing `wasm-bindgen-cli` to ensure the user
always has the latest version. We don't expect this to be a forever solution (it's a bit
slow!) but it should help those who are getting started have a less rough time.
[pull/133]: https://github.com/ashleygwilliams/wasm-pack/pull/133
- **fix CI release builds - [ashleygwilliams], [pull/135]**
This was not working! But now it is! You can always use `cargo install` to install
wasm-pack, but now you can find pre-built Linux and Mac binaries in the [Releases]
tab of our GitHub repo.
[Releases]: https://github.com/ashleygwilliams/wasm-pack/releases
[pull/135]: https://github.com/ashleygwilliams/wasm-pack/pull/135
### 🛠️ 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
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.
[pull/131]: https://github.com/ashleygwilliams/wasm-pack/pull/131
- **update rustfmt CI test - [djfarly], [pull/128]**
Since 0.2.0 how one should call `rustfmt` changed! We've kept it up to date so we can continue
to maintain conventional style in the codebase.
[pull/128]: https://github.com/ashleygwilliams/wasm-pack/pull/128
- **custom module for errors - [mgattozzi], [pull/120]**
Thanks to the `failure` crate, we've been playing fast and loose with errors for a bit. We're
finally getting serious about error handling - by organizing all of our specific errors in a
specific module. This will make it easier to communicate these errors out and handle new error
cases from future features.
[pull/120]: https://github.com/ashleygwilliams/wasm-pack/pull/120
### 📖 Documentation
Special thanks to [data-pup] who continues to be our documentation champion! In case you missed it,
check out the guides in the [docs directory!](docs)!
## 🌌 0.2.0
This release focuses on filling out all commands and improving stderr/out
handling for improved user experience!
### ✨ Features
- **`pack` and `publish` - [jamiebuilds], [pull/67]**
You can now run `wasm-pack pack` to generate a tarball of your generated package,
as well as run `wasm-pack publish` to publish your package to the npm registry.
Both commands require that you have npm installed, and the `publish` command requires
that you be logged in to the npm client. We're working on wrapping the `npm login`
command so that you can also login directly from `wasm-pack`, see [pull/100] for more
details.
[jamiebuilds]: https://github.com/jamiebuilds
[pull/67]: https://github.com/ashleygwilliams/wasm-pack/pull/67
[pull/100]: https://github.com/ashleygwilliams/wasm-pack/pull/100
- **`package.json` is pretty printed now - [yoshuawuyts], [pull/70]**
Previously, `package.json` was not very human readable. Now it is pretty printed!
- **`collaborators` - [yoshuawuyts], [pull/70]**
`wasm-pack` now will fill out the `collaborators` field in your `package.json` for
you based on your `Cargo.toml` `authors` data. For more discussion on how we decided
on this v.s. other types of `author` fields in `package.json`, see [issues/2].
[yoshuawuyts]: https://github.com/yoshuawuyts
[pull/70]: https://github.com/ashleygwilliams/wasm-pack/pull/70
[issues/2]: https://github.com/ashleygwilliams/wasm-pack/issues/2
- **Release binaries built with CI - [ashleygwilliams], [pull/103]**
[ashleygwilliams]: https://github.com/ashleygwilliams
[pull/103]: https://github.com/ashleygwilliams/wasm-pack/pull/103
### 🤕 Fixes
- **Optional `package.json` fields warn instead of failing - [mgattozzi], [pull/65]**
[pull/65]: https://github.com/ashleygwilliams/wasm-pack/pull/65
- **Program doesn't swallow stout and sterr - [mgattozzi], [pull/90]**
[mgattozzi]: https://github.com/mgattozzi
[pull/90]: https://github.com/ashleygwilliams/wasm-pack/pull/90
### 🛠️ Maintenance and 📖 Documentation
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!
[data-pup]: https://github.com/data-pup
[sendilkumarn]: https://github.com/sendilkumarn
[Andy-Bell]: https://github.com/Andy-Bell
[steveklabnik]: https://github.com/steveklabnik
[jasondavies]: https://github.com/jasondavies
[edsrzf]: https://github.com/edsrzf
## 💥 0.1.0
- First release!