Merge pull request #446 from drager/catch-types-in-cargo-toml

feat: Catch typos in Cargo.toml and warn about them

Cargo.lock

@@ -770,6 +770,14 @@ dependencies = [
  "syn 0.15.18 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
+[[package]]
+name = "serde_ignored"
+version = "0.0.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+dependencies = [
+ "serde 1.0.80 (registry+https://github.com/rust-lang/crates.io-index)",
+]
+
 [[package]]
 name = "serde_json"
 version = "1.0.32"
@@ -841,6 +849,11 @@ name = "strsim"
 version = "0.7.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 
+[[package]]
+name = "strsim"
+version = "0.8.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+
 [[package]]
 name = "structopt"
 version = "0.2.13"
@@ -1071,11 +1084,13 @@ dependencies = [
  "parking_lot 0.6.4 (registry+https://github.com/rust-lang/crates.io-index)",
  "serde 1.0.80 (registry+https://github.com/rust-lang/crates.io-index)",
  "serde_derive 1.0.80 (registry+https://github.com/rust-lang/crates.io-index)",
+ "serde_ignored 0.0.4 (registry+https://github.com/rust-lang/crates.io-index)",
  "serde_json 1.0.32 (registry+https://github.com/rust-lang/crates.io-index)",
  "siphasher 0.2.3 (registry+https://github.com/rust-lang/crates.io-index)",
  "slog 2.4.1 (registry+https://github.com/rust-lang/crates.io-index)",
  "slog-async 2.3.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "slog-term 2.4.0 (registry+https://github.com/rust-lang/crates.io-index)",
+ "strsim 0.8.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "structopt 0.2.13 (registry+https://github.com/rust-lang/crates.io-index)",
  "tar 0.4.18 (registry+https://github.com/rust-lang/crates.io-index)",
  "tempfile 3.0.4 (registry+https://github.com/rust-lang/crates.io-index)",
@@ -1243,6 +1258,7 @@ dependencies = [
 "checksum semver-parser 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)" = "388a1df253eca08550bef6c72392cfe7c30914bf41df5269b68cbd6ff8f570a3"
 "checksum serde 1.0.80 (registry+https://github.com/rust-lang/crates.io-index)" = "15c141fc7027dd265a47c090bf864cf62b42c4d228bbcf4e51a0c9e2b0d3f7ef"
 "checksum serde_derive 1.0.80 (registry+https://github.com/rust-lang/crates.io-index)" = "225de307c6302bec3898c51ca302fc94a7a1697ef0845fcee6448f33c032249c"
+"checksum serde_ignored 0.0.4 (registry+https://github.com/rust-lang/crates.io-index)" = "190e9765dcedb56be63b6e0993a006c7e3b071a016a304736e4a315dc01fb142"
 "checksum serde_json 1.0.32 (registry+https://github.com/rust-lang/crates.io-index)" = "43344e7ce05d0d8280c5940cabb4964bea626aa58b1ec0e8c73fa2a8512a38ce"
 "checksum siphasher 0.2.3 (registry+https://github.com/rust-lang/crates.io-index)" = "0b8de496cf83d4ed58b6be86c3a275b8602f6ffe98d3024a869e124147a9a3ac"
 "checksum slog 2.4.1 (registry+https://github.com/rust-lang/crates.io-index)" = "1e1a2eec401952cd7b12a84ea120e2d57281329940c3f93c2bf04f462539508e"
@@ -1252,6 +1268,7 @@ dependencies = [
 "checksum socket2 0.3.8 (registry+https://github.com/rust-lang/crates.io-index)" = "c4d11a52082057d87cb5caa31ad812f4504b97ab44732cd8359df2e9ff9f48e7"
 "checksum stable_deref_trait 1.1.1 (registry+https://github.com/rust-lang/crates.io-index)" = "dba1a27d3efae4351c8051072d619e3ade2820635c3958d826bfea39d59b54c8"
 "checksum strsim 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)" = "bb4f380125926a99e52bc279241539c018323fab05ad6368b56f93d9369ff550"
+"checksum strsim 0.8.0 (registry+https://github.com/rust-lang/crates.io-index)" = "8ea5119cdb4c55b55d432abb513a0429384878c15dde60cc77b1c99de1a95a6a"
 "checksum structopt 0.2.13 (registry+https://github.com/rust-lang/crates.io-index)" = "41c4a2479a078509940d82773d90ff824a8c89533ab3b59cd3ce8b0c0e369c02"
 "checksum structopt-derive 0.2.13 (registry+https://github.com/rust-lang/crates.io-index)" = "5352090cfae7a2c85e1a31146268b53396106c88ca5d6ccee2e3fae83b6e35c2"
 "checksum syn 0.15.18 (registry+https://github.com/rust-lang/crates.io-index)" = "90c39a061e2f412a9f869540471ab679e85e50c6b05604daf28bc3060f75c430"

Cargo.toml

@@ -26,11 +26,13 @@ openssl = { version = '0.10.11', optional = true }
 parking_lot = "0.6"
 serde = "1.0.74"
 serde_derive = "1.0.74"
+serde_ignored = "0.0.4"
 serde_json = "1.0.26"
 siphasher = "0.2.3"
 slog = "2.3"
 slog-term = "2.4"
 slog-async = "2.3"
+strsim = "0.8.0"
 structopt = "0.2"
 tar = "0.4.16"
 toml = "0.4"

src/lib.rs

@@ -6,6 +6,7 @@ extern crate cargo_metadata;
 extern crate console;
 extern crate curl;
 extern crate dirs;
+extern crate strsim;
 #[macro_use]
 extern crate failure;
 extern crate flate2;
@@ -18,6 +19,7 @@ extern crate parking_lot;
 extern crate serde;
 #[macro_use]
 extern crate serde_derive;
+extern crate serde_ignored;
 extern crate serde_json;
 extern crate siphasher;
 #[macro_use]

src/manifest/mod.rs

@@ -15,9 +15,13 @@ use failure::{Error, ResultExt};
 use progressbar::Step;
 use serde::{self, Deserialize};
 use serde_json;
+use std::collections::BTreeSet;
+use strsim::levenshtein;
 use toml;
 use PBAR;
 
+const WASM_PACK_METADATA_KEY: &'static str = "package.metadata.wasm-pack";
+
 /// Store for metadata learned about a crate
 pub struct CrateData {
     data: Metadata,
@@ -25,8 +29,9 @@ pub struct CrateData {
     manifest: CargoManifest,
 }
 
+#[doc(hidden)]
 #[derive(Deserialize)]
-struct CargoManifest {
+pub struct CargoManifest {
     package: CargoPackage,
 }
 
@@ -196,6 +201,12 @@ struct NpmData {
     main: String,
 }
 
+#[doc(hidden)]
+pub struct ManifestAndUnsedKeys {
+    pub manifest: CargoManifest,
+    pub unused_keys: BTreeSet<String>,
+}
+
 impl CrateData {
     /// Reads all metadata for the crate whose manifest is inside the directory
     /// specified by `path`.
@@ -208,14 +219,14 @@ impl CrateData {
                 crate_path.display()
             )
         }
-        let manifest = fs::read_to_string(&manifest_path)
-            .with_context(|_| format!("failed to read: {}", manifest_path.display()))?;
-        let manifest: CargoManifest = toml::from_str(&manifest)
-            .with_context(|_| format!("failed to parse manifest: {}", manifest_path.display()))?;
 
         let data =
             cargo_metadata::metadata(Some(&manifest_path)).map_err(error_chain_to_failure)?;
 
+        let manifest_and_keys = CrateData::parse_crate_data(&manifest_path)?;
+        CrateData::warn_for_unused_keys(&manifest_and_keys);
+
+        let manifest = manifest_and_keys.manifest;
         let current_idx = data
             .packages
             .iter()
@@ -241,6 +252,50 @@ impl CrateData {
         }
     }
 
+    /// Read the `manifest_path` file and deserializes it using the toml Deserializer.
+    /// Returns a Result containing `ManifestAndUnsedKeys` which contains `CargoManifest`
+    /// and a `BTreeSet<String>` containing the unused keys from the parsed file.
+    ///
+    /// # Errors
+    /// Will return Err if the file (manifest_path) couldn't be read or
+    /// if deserialize to `CargoManifest` fails.
+    pub fn parse_crate_data(manifest_path: &Path) -> Result<ManifestAndUnsedKeys, Error> {
+        let manifest = fs::read_to_string(&manifest_path)
+            .with_context(|_| format!("failed to read: {}", manifest_path.display()))?;
+        let manifest = &mut toml::Deserializer::new(&manifest);
+
+        let mut unused_keys = BTreeSet::new();
+        let levenshtein_threshold = 1;
+
+        let manifest: CargoManifest = serde_ignored::deserialize(manifest, |path| {
+            let path_string = path.to_string();
+
+            if path_string.starts_with("package.metadata")
+                && (path_string.contains("wasm-pack")
+                    || levenshtein(WASM_PACK_METADATA_KEY, &path_string) <= levenshtein_threshold)
+            {
+                unused_keys.insert(path_string);
+            }
+        })
+        .with_context(|_| format!("failed to parse manifest: {}", manifest_path.display()))?;
+
+        Ok(ManifestAndUnsedKeys {
+            manifest,
+            unused_keys,
+        })
+    }
+
+    /// Iterating through all the passed `unused_keys` and output
+    /// a warning for each unknown key.
+    pub fn warn_for_unused_keys(manifest_and_keys: &ManifestAndUnsedKeys) {
+        manifest_and_keys.unused_keys.iter().for_each(|path| {
+            PBAR.warn(&format!(
+                "\"{}\" is a unknown key and will be ignored. Please check your Cargo.toml.",
+                path
+            ));
+        });
+    }
+
     /// Get the configured profile.
     pub fn configured_profile(&self, profile: BuildProfile) -> &CargoWasmPackProfile {
         match profile {

tests/all/manifest.rs

@@ -292,9 +292,7 @@ fn it_does_not_error_when_wasm_bindgen_is_declared() {
 #[test]
 fn configure_wasm_bindgen_debug_incorrectly_is_error() {
     let fixture = utils::fixture::Fixture::new();
-    fixture
+    fixture.readme().hello_world_src_lib().file(
-        .readme()
-        .file(
         "Cargo.toml",
         r#"
             [package]
@@ -314,8 +312,7 @@ fn configure_wasm_bindgen_debug_incorrectly_is_error() {
             [package.metadata.wasm-pack.profile.dev.wasm-bindgen]
             debug-js-glue = "not a boolean"
             "#,
-        )
+    );
-        .hello_world_src_lib();
 
     let cli = Cli::from_iter_safe(vec![
         "wasm-pack",
@@ -333,3 +330,41 @@ fn configure_wasm_bindgen_debug_incorrectly_is_error() {
         .to_string()
         .contains("package.metadata.wasm-pack.profile.dev.wasm-bindgen.debug")));
 }
+
+#[test]
+fn parse_crate_data_returns_unused_keys_in_cargo_toml() {
+    let fixture = utils::fixture::Fixture::new();
+    fixture
+        .readme()
+        .file(
+            "Cargo.toml",
+            r#"
+            [package]
+            authors = ["The wasm-pack developers"]
+            description = "so awesome rust+wasm package"
+            license = "WTFPL"
+            name = "whatever"
+            repository = "https://github.com/rustwasm/wasm-pack.git"
+            version = "0.1.0"
+
+            [lib]
+            crate-type = ["cdylib"]
+
+            [dependencies]
+            wasm-bindgen = "0.2"
+
+            # Note: production is not valid.
+            [package.metadata.wasm-pack.profile.production.wasm-bindgen]
+            debug-js-glue = true
+            "#,
+        )
+        .hello_world_src_lib();
+
+    let result = manifest::CrateData::parse_crate_data(&fixture.path.join("Cargo.toml"));
+
+    assert!(result.is_ok());
+
+    let manifest::ManifestAndUnsedKeys { unused_keys, .. } = result.unwrap();
+
+    assert!(unused_keys.contains("package.metadata.wasm-pack.profile.production"));
+}