chore: preparing release

CHANGELOG.md

@@ -1,3 +1,18 @@
+## 1.0.0 (2020-09-06)
+
+### Features
+
+* Enabled parsing local part, and domain on instantiation ([92b2af9](https://github.com/Sayan751/email-address-parser/commit/92b2af9)). `EmailAddress::new` (in Rust) or `new EmailAddress(...)` (in JS) throws error if either local part or domain is invalid.
+* Added `EmailAddress::is_valid` (in Rust), and `EmailAddress.isValid()` (in JS) to simply validates a given string. This parses like the `parse` method, but does not instantiates an `EmailAddress` object, and return `true`/`false` instead ([3988d98](https://github.com/Sayan751/email-address-parser/commit/3988d98)).
+* Adding unicode support RFC 6532 ([5d1f60e](https://github.com/Sayan751/email-address-parser/commit/5d1f60e)).
+
+### Breaking Changes
+
+* The methods `localPart()`, and `domain()` exposed to JS, has been converted to ES6 getters. This means `email.localPart()` or `email.domain()` can simply be converted to `email.localPart` and `email.domain` respectively.
+* In JS, the static method `EmailAddress.new` has been converted to a constructor. Use simply `new EmailAddress(...)` to instantiate `EmailAddress`.
+* The signature of `parse` and `new` has been changed. Instead of an optional boolean as the lat parameter, they now expect an optional `ParsingOptions` instance.
+* The constructor function (`new`) not returns `Result<EmailAddress, String>` in Rust instead of `Option<EmailAddress>`. Semantically, this makes more sense. In JS side, the core `new` function has been wrapped with a constructor function that panics (throws error in JS). The later function is not meant to be used from Rust, and strictly for JS users.
+
 ## 0.3.0-rc2 (2020-08-30)
 
 Initial release of an RFC 5233 compliant email parser.

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-rc2",
+  "description": "An RFC 5322, and RFC 6532 compliant email address parser.",
+  "version": "1.0.0",
   "license": "MIT",
   "author": {
     "name": "Sayan751"
@@ -10,7 +10,8 @@
     "email-address",
     "parser",
     "wasm",
-    "rfc 5322"
+    "rfc 5322",
+    "rfc 6532"
   ],
   "private": false,
   "repository": {

rust-lib/Cargo.toml

@@ -1,14 +1,14 @@
 [package]
 name = "email-address-parser"
-version = "0.3.0-rc2"
+version = "1.0.0"
 authors = ["Sayan751"]
 edition = "2018"
-description = "An RFC 5322 compliant email address parser."
+description = "An RFC 5322, and RFC 6532 compliant email address parser."
 license = "MIT"
 repository = "https://github.com/Sayan751/email-address-parser"
 homepage = "https://github.com/Sayan751/email-address-parser"
 readme = "README.md"
-keywords = ["email-address", "parser", "rfc-5322"]
+keywords = ["email-address", "parser", "rfc-5322", "rfc-6532"]
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

rust-lib/Development.md

@@ -35,7 +35,9 @@ cargo doc --no-deps --open
 
 ### Publishing checklist
 
-- [ ] Update crate version and commit.
+- [ ] Update crate version and build (that will change the cargo-lock).
+- [ ] Update npm pkg version with `npm version {VERSION}`
 - [ ] Generate changelog with `npx conventional-changelog-cli -i CHANGELOG.md -s`, and edit accordingly the version.
+- [ ] Commit.
 - [ ] Add git tag with `git tag -a v{TAG} -m "{MSG}"`.
 - [ ] Push tag `git push --follow-tags`.