Express CLI

[waleedtariq109]

First of all, a huge appreciation to the Express team for coming together and reviving Express.

My suggestion is:
Express should release its CLI, which scaffolds the project boilerplate. While Express itself is a framework, the current setup process requires starting from scratch, leading to a less-than-ideal experience. Let's discuss the need for a cleaner, more robust, and modern version of the Express CLI, going beyond the capabilities of express-generator.

[wesleytodd]

Hey! I agree. We have the generator package but it is quite old and doesn't follow the create-* pattern which the package managers support either. I think it would be awesome change the name of that, but that likely might mean a full rewrite. Maybe the next best steps here are to list the requirements?

[waleedtariq109]

@wesleytodd I completely agree, and I would also like to join the Express team in creating and maintaining the brand-new CLI package. In the meantime, I am preparing some initial requirements and would like to share them with you here when it's done.

[jonchurch]

I previously was excited about the idea of having the cli generator, but see the value less now. Id be interested to see your ideas about what it should do.

Express is so lean that Im not certain what we would need to scaffold for folks. Previously the generator focused on scaffolding a server side rendered static html site using view engines. That's not as relevant today.

Call it a lack of imagination on my part, but before you begin work @waleedtariq109 can you give an idea of what your vision is for a cli package?

[UlisesGascon]

Express is so lean that Im not certain what we would need to scaffold for folks. Previously the generator focused on scaffolding a server side rendered static html site using view engines. That's not as relevant today.

AFAIK, with the current roadmap, I share this vision too. But here's a random idea from my side: what if we just offer a CLI that lists all the projects in the current example folder and allows you to choose one of them to start a project? This way, you actually have tons of options out of the box. Maybe I'm going too far; it's just an idea.

[waleedtariq109]

@jonchurch I've been preparing the initial proposal, and when it's ready, I'd be happy to share it here as it also reflects my vision for the CLI.

[wesleytodd]

Even if we get the most simple setup, I think the value of a generator for new users cannot be over stated. It is much different to say "create a file and copy this" vs npm init express.

[waleedtariq109]

@wesleytodd @jonchurch
Just to provide a brief overview of my thoughts: Instead of installing Express using npm i express, it's recommended to use the Express CLI for scaffolding the project. The official way to do this is by executing the command npx express init my-app. This command will initialize an Express app. Additionally, it will prompt you with a few questions before initializing the app, such as whether you want to set up a Git repository and which package manager you prefer to use, among other things etc.

This has to be the Offical way of express

[ctcpip]

follow the create-* pattern which the package managers support

what is this referring to?

[wesleytodd]

The official way to do this is by executing the command npx express init my-app

I would prefer we document both that and npm init express

[wesleytodd]

what is this referring to?

package managers have a feature to download and execute packages with the naming pattern create-. For example:

$ npm init express

Will find the package create-express or @express/create and will run the properly named bin script just like npx would.

The most famous example of this is create-react-app.

[wesleytodd]

such as whether you want to set up a Git repository and which package manager you prefer to use, among other things etc.

And then for this part, I think we should use the pattern I have been working out here: pkgjs/create-pkg#7

[jonchurch]

@ctcpip see the npm init docs: https://docs.npmjs.com/cli/v8/commands/npm-init

[waleedtariq109]

such as whether you want to set up a Git repository and which package manager you prefer to use, among other things etc.

And then for this part, I think we should use the pattern I have been working out here: pkgjs/create-pkg#7

Exactly, I also think the same way. We should use this pattern to provide a better DX, and I am also willing and passionate to contribute as a member. 😊

[waleedtariq109]

@wesleytodd I think we have to start working on gathering the requirements, or is it too early?