Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(recipes/nestia): new library and new content #2571

Open
wants to merge 15 commits into
base: master
Choose a base branch
from

Conversation

samchon
Copy link

@samchon samchon commented Dec 24, 2022

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Docs
  • Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

To introduce new library nestia

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Re-challenge after 6 months. During the 6 months.

Hope my libraries to be helpful for NestJS developers.

Copy link
Member

@jmcdo29 jmcdo29 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got a couple of changes like removing extra whitespace, and some questions I want answered, but overall it looks good! Excited to find a side project to use this on to see how it goes 😄

content/recipes/nestia.md Outdated Show resolved Hide resolved
content/recipes/nestia.md Outdated Show resolved Hide resolved
content/recipes/nestia.md Outdated Show resolved Hide resolved
content/recipes/nestia.md Outdated Show resolved Hide resolved
content/recipes/nestia.md Outdated Show resolved Hide resolved
content/recipes/nestia.md Show resolved Hide resolved
content/recipes/nestia.md Outdated Show resolved Hide resolved
content/recipes/nestia.md Outdated Show resolved Hide resolved
content/recipes/nestia.md Show resolved Hide resolved
content/recipes/nestia.md Show resolved Hide resolved
Copy link
Author

@samchon samchon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed following your advices, but cannot sure how to resolve the "client code".

Would it better to remove the last example code and write like below?:


Demonstration

When you run npx nestia sdk command, @nestia/sdk will generate an SDK library interacting with your backend server, composed with codes like below. If you want to learn how to distribute the SDK library, visit and read Guide Documents - Distribution.

import { Fetcher, IConnection } from "@nestia/fetcher";
import { IBbsArticle } from "../../../structures/IBbsArticle";

/**
 * Store a new content.
 * 
 * @param input Content to store
 * @returns Newly archived article
 */
export function store(
    connection: api.IConnection, 
    input: IBbsArticle.IStore
): Promise<IBbsArticle> {
    return Fetcher.fetch(
        connection,
        store.ENCRYPTED,
        store.METHOD,
        store.path(),
        input
    );
}
export namespace store {
    export const METHOD = "POST" as const;
    export function path(): string {
        return "/bbs/articles";
    }
}

Copy link
Member

@jmcdo29 jmcdo29 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall addition looks good to me. I'll leave @kamilmysliwiec to review it as well when he has the time.

Copy link
Author

@samchon samchon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Erased the last client example code.

Thanks for your guide @jmcdo29

Copy link
Author

@samchon samchon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a break line after third party package and is not managed by the NestJS core team ~.

Copy link
Author

@samchon samchon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed guide documents (wiki) link (I'd revised contents of guide documents)

Copy link
Member

@micalevisk micalevisk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kamilmysliwiec will we bring this to the docs? looks good to me.

We already have that at https://github.com/nestjs/awesome-nestjs

@kamilmysliwiec
Copy link
Member

#2656 (comment)

Fantastic job anyway, Nestia looks really impressive!

@samchon
Copy link
Author

samchon commented Apr 4, 2023

#2656 (comment)

Fantastic job anyway, Nestia looks really impressive!

@kamilmysliwiec

Well, I have waited your review for one year, and during the year, I had saw lots of other libraries (had committed later than me, even now) are newly added in the recipes section. I can understand why are you saying such like that, but it sounds collapsed for me because of long time waiting.

Hope your mercy.

p.s) if hard to keep recipes section more, it is okay to creating new category and writing this content again to be suitable for the new category

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants