Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve UX for pack and publish path expectations #198

Merged
merged 12 commits into from
Jul 19, 2018
Merged

Improve UX for pack and publish path expectations #198

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
840c7bd
Return custom error if pkg directory is not found
Mackiovello Jul 4, 2018
035bcbe
Simplify match expression
Mackiovello Jul 5, 2018
ec17b8a
Use custom error message for publish
Mackiovello Jul 5, 2018
8efabfa
Make error more specific
Mackiovello Jul 5, 2018
b57d68f
Search for path in entered directory and the parent of entered
Mackiovello Jul 7, 2018
a67762a
Use 'find_pkg_directory' for pack
Mackiovello Jul 7, 2018
63c91ca
Check child directories instead of parent directory
Mackiovello Jul 7, 2018
ac34e7b
Write as more ideomatic rust
Mackiovello Jul 7, 2018
e6cd7bb
Simplify iteration even more
Mackiovello Jul 7, 2018
ce77e5c
Fix npm-pack command to use correct path
Mackiovello Jul 10, 2018
28d5bb5
Merge branch 'master' of https://github.com/rustwasm/wasm-pack into i…
Mackiovello Jul 14, 2018
88fdbc5
Add documentation for pack and publish
Mackiovello Jul 16, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion src/command/pack.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,15 @@ pub fn pack(path: Option<String>, log: &Logger) -> result::Result<(), Error> {
let crate_path = set_crate_path(path);

info!(&log, "Packing up the npm package...");
npm::npm_pack(&crate_path)?;
match npm::npm_pack(&crate_path) {
Ok(r) => r,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should probably just be Ok(r) => (),

Err(Error::Io { .. }) => {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this match is too broad. I only want to catch os error 2: directory not found. I don't want to swallow other IO errors. Investigate how to do that.

return Err(Error::DirNotFound {
message: "Unable to find the pkg directory".to_owned(),
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be more specific? Should it also print the path that the user entered? Not sure yet.

});
}
Err(e) => return Err(e),
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These explicit return statements feel like code smells. Maybe I can use the ? operator here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I should try something like this instead:

my_function_call().map_err(|e| match {
  interesting_error => something_else,
  stuff => stuff,
})?

};
#[cfg(not(target_os = "windows"))]
info!(&log, "Your package is located at {}/pkg", &crate_path);
#[cfg(target_os = "windows")]
Expand Down
3 changes: 3 additions & 0 deletions src/error.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ pub enum Error {
Cli { message: String, stderr: String },
#[fail(display = "{}", message)]
CrateConfig { message: String },
#[fail(display = "{}", message)]
DirNotFound { message: String },
}

impl Error {
Expand Down Expand Up @@ -45,6 +47,7 @@ impl Error {
Error::CrateConfig { message: _ } => {
"There was a crate configuration error. Details:\n\n"
}
Error::DirNotFound { message: _ } => "Unable to find the directory\n\n",
}.to_string()
}
}
Expand Down