Introduce `deer` crate at v0.0.0 #1163

indietyp · 2022-10-05T12:13:09Z

🌟 What is the purpose of this PR?

deer is a new crate that implements fail-slow deserialization using multiple backends.

(currently planned: json via serde_json)

This is the first PR in many, which sets the initial project structure.

🔗 Related links

Slack (internal)

🐾 Next steps

Implementation of the code already in the prototype
derive macro
"branding" (preferably a logo)
CI & cargo-make setup Set up CI for deer #1164
GitHub setup (new tag?)

packages/libs/deer/LICENSE-MIT

packages/libs/deer/Cargo.toml

packages/libs/deer/README.md

packages/libs/deer/src/lib.rs

packages/libs/deer/derive/Cargo.toml

packages/libs/deer/rust-toolchain.toml

TimDiekmann · 2022-10-05T13:16:04Z

Very exciting 🎉

Modifies the appendix (excluded from the unmodifiable sections 1..9) to reflect HASH-specific guidance. Reformats the LICENSE as markdown.

Reformats the license as markdown.

Someone might want to lint this; sorry!

vilkinsons · 2022-10-05T14:28:33Z

Sorry for the direct LICENSE file commits there... thought it'd be easier than going backwards and forwards given we have a fairly rigid format.

Separately, I've added explicit reference to you in the README.md, @indietyp. We could also move this up earlier in the file, if we provide more context/narrative in the intro.

packages/libs/deer/LICENSE-MIT.md

Co-authored-by: Alfred Mountfield <am@hash.ai>

Changes requested implemented in 3de3e3d and bb95c16

packages/libs/deer/README.md

vilkinsons

🎉 This is good to merge!

packages/libs/deer/README.md

Alfred-Mountfield

Thanks @indietyp, I'm really excited for this! Just requesting changes because of quite a few nits, they're not super important but I'd like us to have consistency from the get go

.github/scripts/rust/setup.py

packages/libs/deer/Cargo.toml

packages/libs/deer/Makefile.toml

Alfred-Mountfield · 2022-10-07T14:30:14Z

packages/libs/deer/README.md

@@ -0,0 +1,113 @@
+# deer


Purposefully lower case?

Yes, to keep in line with error-stack and how Rust crate naming usually is.

I appreciate that the crate names are usually lower-case, but when referring to them in headings I haven't seen them left as lower-case before.

See:

Tokio

Tokio Tracing

Serde

Serde JSON

packages/libs/deer/README.md

Alfred-Mountfield · 2022-10-07T14:33:57Z

packages/libs/deer/README.md

+This in turn also means that deer can be used for custom validation while deserializing, while still being able to return all validation issues.
+
+<sub>
+deer might provide a way in the future to describe these constraints.


Not sure how it'll behave inside an HTML element but should we have deer code-styled like the rest of the doc?

fixed in 14cde13

packages/libs/deer/README.md

Alfred-Mountfield · 2022-10-07T14:38:43Z

packages/libs/deer/README.md

+```json
+{
+  "i8": "string"
+```


Would us picking something other than JSON avoid this?

Because I think we're going to have to deal with this on every PR for this text, not just this one.

I removed formatting for now as I wasn't able to find a way to display incomplete JSON otherwise (99538ec)

Dang that's quite annoying. Perhaps we can revisit later on

packages/libs/deer/macros/Cargo.toml

packages/libs/deer/rust-toolchain.toml

Co-authored-by: Alfred Mountfield <am@hash.ai>

TimDiekmann

LGTM 🎉

Alfred-Mountfield

Thanks for fixing those 🎉

indietyp added 5 commits October 5, 2022 13:38

feat: create new library

e2eaeb0

feat: add licenses

486a371

feat: populate first version of the README and changelog

09146de

feat: skeleton lib.rs

3a9bf58

feat: skeleton lib.rs for derive

9a919cc

vercel bot deployed to Preview – hash October 5, 2022 12:13 View deployment

indietyp requested review from Alfred-Mountfield, vilkinsons and TimDiekmann October 5, 2022 12:13

indietyp commented Oct 5, 2022

View reviewed changes

packages/libs/deer/LICENSE-MIT Outdated Show resolved Hide resolved

Update GitHub labeler to include deer crate

f48f3eb

github-actions bot added the area/infra Relates to version control, CI, CD or IaC (area) label Oct 5, 2022

vercel bot deployed to Preview – hash October 5, 2022 12:54 View deployment

TimDiekmann previously requested changes Oct 5, 2022

View reviewed changes

TimDiekmann added the meta/DO NOT MERGE DO NOT MERGE. May be used in combination with `state/blocked` label Oct 5, 2022

feat: apply suggestions from code review

bb95c16

indietyp added the area/libs > deer Affects the `deer` crate (library) label Oct 5, 2022

docs: augment preliminary example with serde_json vs deer::json

3de3e3d

indietyp mentioned this pull request Oct 5, 2022

Set up CI for deer #1164

Merged

vilkinsons added 3 commits October 5, 2022 15:05

Update and rename LICENSE-APACHE to LICENSE-APACHE.md

cbf9138

Modifies the appendix (excluded from the unmodifiable sections 1..9) to reflect HASH-specific guidance. Reformats the LICENSE as markdown.

Update and rename LICENSE-MIT to LICENSE-MIT.md

fa6d6e7

Reformats the license as markdown.

Update README.md

8eeed5d

Someone might want to lint this; sorry!

vilkinsons changed the title ~~Create new crate: deer~~ Introduce deer crate at v0.0.0 Oct 5, 2022

vercel bot deployed to Preview – hash October 5, 2022 14:39 View deployment

TimDiekmann removed the meta/DO NOT MERGE DO NOT MERGE. May be used in combination with `state/blocked` label Oct 5, 2022

TimDiekmann reviewed Oct 5, 2022

View reviewed changes

packages/libs/deer/LICENSE-MIT.md Show resolved Hide resolved

Set up CI for deer (#1164)

87e2dc8

Co-authored-by: Alfred Mountfield <am@hash.ai>

vilkinsons mentioned this pull request Oct 7, 2022

Dual-license error-stack and misc drive-by updates #1172

Merged

vilkinsons reviewed Oct 7, 2022

View reviewed changes

packages/libs/deer/README.md Outdated Show resolved Hide resolved

vilkinsons added 2 commits October 7, 2022 14:13

Update packages/libs/deer/README.md

7ad467d

Merge branch 'main' into bm/deer/init

972344b

vilkinsons self-requested a review October 7, 2022 13:14

vilkinsons previously approved these changes Oct 7, 2022

View reviewed changes

vercel bot deployed to Preview – hash October 7, 2022 13:22 View deployment

indietyp enabled auto-merge (squash) October 7, 2022 13:29

TimDiekmann reviewed Oct 7, 2022

View reviewed changes

packages/libs/deer/README.md Outdated Show resolved Hide resolved

Update packages/libs/deer/README.md

689a00c

TimDiekmann dismissed vilkinsons’s stale review via 689a00c October 7, 2022 13:44

TimDiekmann previously approved these changes Oct 7, 2022

View reviewed changes

vercel bot deployed to Preview – hash October 7, 2022 13:50 View deployment

Alfred-Mountfield disabled auto-merge October 7, 2022 14:27

Alfred-Mountfield suggested changes Oct 7, 2022

View reviewed changes

indietyp dismissed TimDiekmann’s stale review via c6d278d October 7, 2022 14:59

Apply suggestions from code review

c6d278d

Co-authored-by: Alfred Mountfield <am@hash.ai>

vercel bot deployed to Preview – hash October 7, 2022 15:04 View deployment

indietyp added 3 commits October 7, 2022 17:38

fix: apply suggestions

14cde13

fix: apply suggestions

99538ec

fix: whitespace

f04f021

vercel bot deployed to Preview – hash October 7, 2022 15:49 View deployment

Merge branch 'main' into bm/deer/init

fdfde42

vercel bot deployed to Preview – hashdev October 9, 2022 17:12 View deployment

vercel bot deployed to Preview – hash October 9, 2022 17:13 View deployment

TimDiekmann approved these changes Oct 10, 2022

View reviewed changes

TimDiekmann requested a review from Alfred-Mountfield October 10, 2022 08:42

Alfred-Mountfield approved these changes Oct 10, 2022

View reviewed changes

indietyp merged commit 4f14a1e into main Oct 10, 2022

indietyp deleted the bm/deer/init branch October 10, 2022 09:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce `deer` crate at v0.0.0 #1163

Introduce `deer` crate at v0.0.0 #1163

indietyp commented Oct 5, 2022 •

edited

Loading

TimDiekmann commented Oct 5, 2022

vilkinsons commented Oct 5, 2022

vilkinsons left a comment

Alfred-Mountfield left a comment

Alfred-Mountfield Oct 7, 2022

indietyp Oct 7, 2022

Alfred-Mountfield Oct 10, 2022

Alfred-Mountfield Oct 7, 2022

indietyp Oct 7, 2022

Alfred-Mountfield Oct 7, 2022

indietyp Oct 7, 2022

Alfred-Mountfield Oct 10, 2022

TimDiekmann left a comment

Alfred-Mountfield left a comment

Introduce deer crate at v0.0.0 #1163

Introduce deer crate at v0.0.0 #1163

Conversation

indietyp commented Oct 5, 2022 • edited Loading

🌟 What is the purpose of this PR?

🔗 Related links

🐾 Next steps

TimDiekmann commented Oct 5, 2022

vilkinsons commented Oct 5, 2022

vilkinsons left a comment

Choose a reason for hiding this comment

Alfred-Mountfield left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TimDiekmann left a comment

Choose a reason for hiding this comment

Alfred-Mountfield left a comment

Choose a reason for hiding this comment

Introduce `deer` crate at v0.0.0 #1163

Introduce `deer` crate at v0.0.0 #1163

indietyp commented Oct 5, 2022 •

edited

Loading