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

Change the behavior of lb4 CLI #6239

Closed
2 tasks
hacksparrow opened this issue Sep 1, 2020 · 2 comments
Closed
2 tasks

Change the behavior of lb4 CLI #6239

hacksparrow opened this issue Sep 1, 2020 · 2 comments
Labels
breaking-change CLI developer-experience Issues affecting ease of use and overall experience of LB users stale

Comments

@hacksparrow
Copy link
Contributor

hacksparrow commented Sep 1, 2020

The fact that lb4 scaffolds a REST app by default implies LoopBack 4 (lb4) is a REST framework, when it is not. Users now assume LB4 is a REST framework and go to the website expecting to find the docs of a REST framework, instead they find the documentation of a super-framework.

We should start using --rest for scaffolding REST apps, --graphql for GraphQL app, --grpc for gRPC app etc.

If one has to do lb4 --rest, they will naturally be curious, "Why do we have to add --rest", "What else is there?", "I needed a gRPC app, can LB4 do it?", etc. This sets a better context about what LB4 really is.

I brought it up on #5551 and repeat it again, our documentation problem is more of an identity problem than organization problem; the docs re-organization exercise can fix it only to a certain extent. Unless we decide on a clear cut identity of LB4 and back it up with docs and tooling, the core of the problem will still remain.

Acceptance Criteria

  • lb4 should print help message.
  • lb4 --rest [name] should scaffold a REST app with the optional name parameter.
@hacksparrow hacksparrow added developer-experience Issues affecting ease of use and overall experience of LB users breaking-change CLI labels Sep 1, 2020
@stale
Copy link

stale bot commented Jul 14, 2021

This issue has been marked stale because it has not seen activity within six months. If you believe this to be in error, please contact one of the code owners, listed in the CODEOWNERS file at the top-level of this repository. This issue will be closed within 30 days of being stale.

@stale stale bot added the stale label Jul 14, 2021
@stale
Copy link

stale bot commented Aug 13, 2021

This issue has been closed due to continued inactivity. Thank you for your understanding. If you believe this to be in error, please contact one of the code owners, listed in the CODEOWNERS file at the top-level of this repository.

@stale stale bot closed this as completed Aug 13, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking-change CLI developer-experience Issues affecting ease of use and overall experience of LB users stale
Projects
None yet
Development

No branches or pull requests

1 participant