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

dartdev: Add empty project template #56120

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

felixwoestmann
Copy link

@felixwoestmann felixwoestmann commented Jul 2, 2024

As I am currently working on an OpenAPI code generator I was looking for a way to create a barebones dart project without any boilerplate. Therefore I propose to add an empty template only adding a minimal configuration.


  • I’ve reviewed the contributor guide and applied the relevant portions to this PR.

Copy link

Thank you for your contribution! This project uses Gerrit for code reviews. Your pull request has automatically been converted into a code review at:

https://dart-review.googlesource.com/c/sdk/+/374020

Please wait for a developer to review your code review at the above link; you can speed up the review if you sign into Gerrit and manually add a reviewer that has recently worked on the relevant code. See CONTRIBUTING.md to learn how to upload changes to Gerrit directly.

Additional commits pushed to this PR will update both the PR and the corresponding Gerrit CL. After the review is complete on the CL, your reviewer will merge the CL (automatically closing this PR).

Copy link

Thank you for your contribution! This project uses Gerrit for code reviews. Your pull request has automatically been converted into a code review at:

https://dart-review.googlesource.com/c/sdk/+/374021

Please wait for a developer to review your code review at the above link; you can speed up the review if you sign into Gerrit and manually add a reviewer that has recently worked on the relevant code. See CONTRIBUTING.md to learn how to upload changes to Gerrit directly.

Additional commits pushed to this PR will update both the PR and the corresponding Gerrit CL. After the review is complete on the CL, your reviewer will merge the CL (automatically closing this PR).

@devoncarew
Copy link
Member

cc @kevmoo @mit-mit @bkonyi

It looks like we currently have:

          [cli]                  A command-line application with basic argument parsing.
          [console] (default)    A command-line application.
          [package]              A package containing shared Dart libraries.
          [server-shelf]         A server app using package:shelf.
          [web]                  A web app that uses only core Dart libraries.

When thinking about the project templates we offer, one of the main things that I would consider would be reducing new user confusion; reducing the questions we ask them that they don't yet have good context to answer. I think having fewer template options here is strictly better (even if each additional template would add some value in its own right). Above, I would actually strip out one (possibly two) options, and wouldn't add any new ones without an overwhelming value add.

(For the existing options above, we definitely don't need two command line starter templates, and its not clear that we need both a command-line and a package template).

@alestiago
Copy link

alestiago commented Jul 8, 2024

Just wanted to bring up that there are community solutions for templates (might help support @devoncarew point). For example, Very Good CLI already provides eight templates for users (those in Very Good Templates). It also has initiatives for creating a minimal templates.

In addition, there is also a whole ecosystem for templates available in BrickHub (with Dart support).

Overall, I'm not sure how many templates would the Dart Dev tool aim to support and maintain, and where to trace the line between what templates get in or not.

@mit-mit
Copy link
Member

mit-mit commented Aug 2, 2024

@devoncarew cleanup of the existing templates could be orthogonal to having minimal template that tools could build on top of? Especially if we tweak this proposal so that the minimal template is hidden from --help given it's intended for tools, and not end users?

@mraleph
Copy link
Member

mraleph commented Sep 11, 2024

What is the status of this PR?

Copy link

https://dart-review.googlesource.com/c/sdk/+/374021 has been updated with the latest commits from this pull request.

@bkonyi
Copy link
Contributor

bkonyi commented Oct 15, 2024

I think adding this particular template is reasonable, but moving forward we should avoid adding more templates without investigating our options in this area for the Dart and Flutter CLI tooling.

@mit-mit
Copy link
Member

mit-mit commented Nov 4, 2024

Hi @felixwoestmann there is one tiny change requested here; are you able to get that done?

@felixwoestmann
Copy link
Author

Hello @mit-mit I fixed the copyright notice. Thanks for the reminder.

Copy link

https://dart-review.googlesource.com/c/sdk/+/374021 has been updated with the latest commits from this pull request.

1 similar comment
Copy link

https://dart-review.googlesource.com/c/sdk/+/374021 has been updated with the latest commits from this pull request.

Co-authored-by: Alejandro Santiago <dev@alestiago.com>
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.

6 participants