Fix frontmatter issues by saswatamcode · Pull Request #16 · bwplotka/mdox

saswatamcode · 2021-03-06T10:03:01Z

This PR fixes the frontmatter issue, where frontmatter in md being formatted led to maps showing up. Now, mdformatter.go correctly processes nested fields. Fixes issue #13

---
title: 'Build a gRPC microservice in Go'
excerpt: "If you've dealt with microservices before, you've probably heard about gRPC. In this blog, we'll be exploring the awesome world of gRPC and write our very own microservice with it. We'll also delve into why gRPC might be better than our traditional REST architectures as well the caveats associated with it."
coverImage: '/assets/blog/build-a-grpc-microservice/cover.jpg'
date: '2020-12-06T05:35:07.322Z'
author:
  name: Saswata Mukherjee
  picture: '/assets/blog/authors/saswatamcode.jpeg'
ogImage:
  url: '/assets/blog/build-a-grpc-microservice/cover.jpg'
---

The above frontmatter generated before fix.

---
title: Build a gRPC microservice in Go
ogImage: map[url:/assets/blog/build-a-grpc-microservice/cover.jpg]
excerpt: If you've dealt with microservices before, you've probably heard about gRPC. In this blog, we'll be exploring the awesome world of gRPC and write our very own microservice with it. We'll also delve into why gRPC might be better than our traditional REST architectures as well the caveats associated with it.
date: 2020-12-06T05:35:07.322Z
coverImage: /assets/blog/build-a-grpc-microservice/cover.jpg
author: map[name:Saswata Mukherjee picture:/assets/blog/authors/saswatamcode.jpeg]
---

The above frontmatter generated after fix.

---
title: Build a gRPC microservice in Go
ogImage:
  url: /assets/blog/build-a-grpc-microservice/cover.jpg
excerpt: If you've dealt with microservices before, you've probably heard about gRPC. In this blog, we'll be exploring the awesome world of gRPC and write our very own microservice with it. We'll also delve into why gRPC might be better than our traditional REST architectures as well the caveats associated with it.
date: 2020-12-06T05:35:07.322Z
coverImage: /assets/blog/build-a-grpc-microservice/cover.jpg
author:
  name: Saswata Mukherjee
  picture: /assets/blog/authors/saswatamcode.jpeg
---

Signed-off-by: Saswata Mukherjee <saswataminsta@yahoo.com>

bwplotka

Thank you for fixing this issue 🤗

Good work, some early suggestions 💪🏽

pkg/mdformatter/mdformatter.go

bwplotka · 2021-03-06T10:16:07Z

pkg/mdformatter/mdformatter.go

 	for _, k := range keys {
-		_, _ = fmt.Fprintf(b, "%v: %v\n", k, frontMatter[k])
+		// check if frontMatter[k] is a map
+		frontMatterStr := fmt.Sprintf("%s", frontMatter[k])


This is nice tricky, but wonder if we could add some type safety (: Would _, isMap := frontMatter[k].(map[string]interface{}) work? 🤔

Will check it out!

Looks like it worked! Do we need frontMatterStr then? 🤗

bwplotka · 2021-03-06T10:43:02Z

It happens usually when you put value to variable and never used later (e.g you replace it with another value later on)

Signed-off-by: Saswata Mukherjee <saswataminsta@yahoo.com>

saswatamcode · 2021-03-06T11:12:03Z

Linting issues have been fixed @bwplotka.

bwplotka

Amazing, almost perfect (:

bwplotka · 2021-03-09T12:58:28Z

pkg/mdformatter/mdformatter.go

 	for _, k := range keys {
-		_, _ = fmt.Fprintf(b, "%v: %v\n", k, frontMatter[k])
+		// check if frontMatter[k] is a map
+		frontMatterStr := fmt.Sprintf("%s", frontMatter[k])


Looks like it worked! Do we need frontMatterStr then? 🤗

bwplotka · 2021-03-09T13:00:03Z

pkg/mdformatter/mdformatter.go

-		_, _ = fmt.Fprintf(b, "%v: %v\n", k, frontMatter[k])
+		// Check if frontMatter[k] is a map.
+		frontMatterStr := fmt.Sprintf("%s", frontMatter[k])
+		_, isMap := frontMatter[k].(map[string]interface{})


Actually we can do better. Since you are casting to map we could use this map directly, no need to use frontMatterStr, no? (:

Oh yes. Will make the changes!

Used the casted map. Code looks better now!

Signed-off-by: Saswata Mukherjee <saswataminsta@yahoo.com>

bwplotka

Amazing, thank you!

bwplotka · 2021-03-09T15:53:26Z

pkg/mdformatter/mdformatter.go

+	b := bytes.NewBuffer([]byte("---"))
 	for _, k := range keys {
-		_, _ = fmt.Fprintf(b, "%v: %v\n", k, frontMatter[k])
+		// Check if frontMatter[k] is a map.


For the next time, this comment might be not needed - the code is now nicely self-explanatory (:

Fix frontmatter issues

92d712c

Signed-off-by: Saswata Mukherjee <saswataminsta@yahoo.com>

saswatamcode force-pushed the frontmatter-fix branch from 7fd04ad to 92d712c Compare March 6, 2021 10:09

bwplotka reviewed Mar 6, 2021

View reviewed changes

saswatamcode requested a review from bwplotka March 6, 2021 10:43

Implement requested changes

bb3e604

Signed-off-by: Saswata Mukherjee <saswataminsta@yahoo.com>

saswatamcode force-pushed the frontmatter-fix branch from 6a56309 to bb3e604 Compare March 6, 2021 11:09

bwplotka reviewed Mar 9, 2021

View reviewed changes

Use map instead of string

ef7e80f

Signed-off-by: Saswata Mukherjee <saswataminsta@yahoo.com>

saswatamcode requested a review from bwplotka March 9, 2021 13:28

bwplotka approved these changes Mar 9, 2021

View reviewed changes

bwplotka merged commit 16d9ba0 into bwplotka:master Mar 9, 2021

Conversation

saswatamcode commented Mar 6, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bwplotka left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bwplotka commented Mar 6, 2021

Uh oh!

saswatamcode commented Mar 6, 2021

Uh oh!

bwplotka left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bwplotka left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

saswatamcode commented Mar 6, 2021 •

edited

Loading