From 2b42d9692e30d9964cad2fcc6c849041e718adbc Mon Sep 17 00:00:00 2001 From: Sayan751 Date: Sun, 30 Aug 2020 22:37:35 +0200 Subject: [PATCH] version bump + development.md --- npm-pkg/package.json | 2 +- rust-lib/Cargo.lock | 2 +- rust-lib/Cargo.toml | 2 +- rust-lib/Development.md | 33 +++++++++++++++++++++++++++++++++ rust-lib/README.md | 38 +------------------------------------- 5 files changed, 37 insertions(+), 40 deletions(-) create mode 100644 rust-lib/Development.md diff --git a/npm-pkg/package.json b/npm-pkg/package.json index 2d20000..a6d4f6e 100644 --- a/npm-pkg/package.json +++ b/npm-pkg/package.json @@ -1,7 +1,7 @@ { "name": "@sparser/email-address-parser", "description": "An RFC 5322 compliant email address parser.", - "version": "0.3.0-rc1", + "version": "0.3.0-rc2", "license": "MIT", "author": { "name": "Sayan751" diff --git a/rust-lib/Cargo.lock b/rust-lib/Cargo.lock index e382f2f..a73870f 100644 --- a/rust-lib/Cargo.lock +++ b/rust-lib/Cargo.lock @@ -66,7 +66,7 @@ dependencies = [ [[package]] name = "email-address-parser" -version = "0.3.0-rc1" +version = "0.3.0-rc2" dependencies = [ "pest", "pest_derive", diff --git a/rust-lib/Cargo.toml b/rust-lib/Cargo.toml index 288815f..1d5bdb2 100644 --- a/rust-lib/Cargo.toml +++ b/rust-lib/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "email-address-parser" -version = "0.3.0-rc1" +version = "0.3.0-rc2" authors = ["Sayan751"] edition = "2018" description = "An RFC 5322 compliant email address parser." diff --git a/rust-lib/Development.md b/rust-lib/Development.md new file mode 100644 index 0000000..3b96cd1 --- /dev/null +++ b/rust-lib/Development.md @@ -0,0 +1,33 @@ +### Build +- Only Rust + ```shell + cargo build + ``` +- WASM + ```shell + wasm-pack build --out-dir ../npm-pkg/dist/bundler + wasm-pack build --target nodejs --out-dir ../npm-pkg/dist/cjs + ``` + +### Test + +- Only Rust + ```shell + cargo test + ``` + +- WASM + ```shell + wasm-pack test --node + ``` + +### Doc generation + +```shell +cargo doc --no-deps --open +``` + +### Publishing checklist +[] Update crate version and commit. +[] Add git tag with `git tag -a v{TAG} -m "{MSG}"`. +[] Push tag `git push --follow-tags`. \ No newline at end of file diff --git a/rust-lib/README.md b/rust-lib/README.md index f9c3558..85cdf7c 100644 --- a/rust-lib/README.md +++ b/rust-lib/README.md @@ -25,40 +25,4 @@ To parse an email address with obsolete parts (as per RFC 5322) in it, pass `Non ```rust let email = EmailAddress::parse("\u{0d}\u{0a} \u{0d}\u{0a} test@iana.org", None); assert!(email.is_some()); -``` - -## Development - -### Build -- Only Rust - ```shell - cargo build - ``` -- WASM - ```shell - wasm-pack build --out-dir ../npm-pkg/dist/bundler - wasm-pack build --target nodejs --out-dir ../npm-pkg/dist/cjs - ``` - -### Test - -- Only Rust - ```shell - cargo test - ``` - -- WASM - ```shell - wasm-pack test --node - ``` - -### Doc generation - -```shell -cargo doc --no-deps --open -``` - -### Publishing checklist -[] Update crate version and commit. -[] Add git tag with `git tag -a v{TAG} -m "{MSG}"`. -[] Push tag `git push --follow-tags`. \ No newline at end of file +``` \ No newline at end of file