frint-cli: Introduce "new" command

[discosultan]

About

Closes https://github.com/Travix-International/frint/issues/220

Introduces the frint new command which will replace frint init in the future. For more information, see the issue above.

frint new <directory> --example <example>

where:

• <directory> (optional) - name of the app folder to create. If not specified, will populate current working dir
• <path> (optional, default=frintjs/frint/tree/master/examples) - GitHub repository path for example apps
• <example> (optional, default=i.) - has two different shapes:
  1. <name> (default=counter) - name of the example to fetch from FrintJS official repository
  2. <organization>/<repository>/tree/<branch>/** - full path to arbitrary GitHub repository to fetch an example from

---

Testing

Can be tested running the following script:

mkdir test1
cd test1
frint new
cd ..
frint new test2
frint new test3 --example router
frint new test4 --example frintjs/frint/tree/frint-router/examples/router

The script will generate four test folders in the current working dir for various frint new scenarios.

[coveralls]

Coverage remained the same at 97.277% when pulling 4377d24d2d8b676e7862fb5995b3ebb9c2cdad42 on impl-new-cmd into 0123345c85a38174aadb0aef1d6744dfcafeaadc on master.

[fahad19]

please also update the README of frint-cli.

and also the root README of the repo under Quickstart.

[discosultan]

@fahad19 Before updating all the docs, is the command interface final? I mean mostly naming for params: path & example and using the structure --<param>=<value>.

[fahad19]

if --path is already present in the command, do we need an additional --example too?

[fahad19]

The <name> option can be renamed as <directory> or something more descriptive to avoid any confusion. I first thought <name> is for example's name :)

[alexmiranda]

I think both --name and --example are confusing flags in this context. If you're creating a new project, I suppose you want to determine the --template instead of the location/name of the example project it will download. Just my opinion but I'm ok with the current flags if you've had discussions on it already.

[discosultan]

if --path is already present in the command, do we need an additional --example too?

Currently they are separated in order not to always have to specify the full path with <example>. If you don't specify <path>, it will default to the official repo. Alternative would be to make <example> "smarter" to figure out itself whether it is defined as a full path or only an example name.

The option can be renamed as or something more descriptive to avoid any confusion. I first thought is for example's name :)

I agree only because all it currently does is create and name a directory. If it were to also transform package.json, for example, to name the application, then <name> would feel better. But this is something that can be changed in the future without compat issues. Therefore, I'll rename it to <directory> 😁.

[discosultan]

I think both --name and --example are confusing flags in this context. If you're creating a new project, I suppose you want to determine the --template instead of the location/name of the example project it will download. Just my opinion but I'm ok with the current flags if you've had discussions on it already.

Yeah, it's a bit confusing, because the intents of scaffolding a template vs setting up an example are sort of mixed. But previous frint init worked the same way, so I'm happy with keeping it the way it is.

[markvincze]

I kinda like the way dotnet new works:

• it always scaffolds in the current directory, but can be overwritten with --output
• the name by default is the name of the directory, but can be overwritten with --name
• the template to use is the only non-flag argument of the command
• (and it has some additional flags, like --language, --auth, etc.)

So you can do:

• dotnet new mvc: scaffolds an MVC app in the current directory with the default name. I like that this command looks really intuitive, and usually this is what you want.
• dotnet new console --output ~/myapp --name foo --language f#: scaffolds an F# Console app in the folder ~/myapp, but uses the name foo

Not saying that we should do the same, just wanted to mention as an example.

[fahad19]

this is the guide from Ember CLI for example: https://ember-cli.com/user-guide/#using-ember-cli

Angular: https://github.com/angular/angular-cli#generating-and-serving-an-angular-project-via-a-development-server

[markvincze]

Also with Yeoman, the name of the template (which I think is the most important thing) is a non-flag argument.

[discosultan]

@markvincze Yeah, that's the difficult part - there are so many different CLI schemes out there. This particular impl is based on a scheme used by Node Express framework CLI.

[coveralls]

Coverage remained the same at 97.277% when pulling 10c5dba71f59c0cfc3a031039e3972689f9cb9e0 on impl-new-cmd into 0123345c85a38174aadb0aef1d6744dfcafeaadc on master.

[coveralls]

Coverage remained the same at 97.277% when pulling 61a527eab62a243de2de4d7f9ff5a335b73c8249 on impl-new-cmd into 0123345c85a38174aadb0aef1d6744dfcafeaadc on master.

[coveralls]

Coverage remained the same at 97.277% when pulling 61a527eab62a243de2de4d7f9ff5a335b73c8249 on impl-new-cmd into 0123345c85a38174aadb0aef1d6744dfcafeaadc on master.

[coveralls]

Coverage remained the same at 97.277% when pulling 0380698041d71c0fdc8b552245de9053607ec0d9 on impl-new-cmd into 0123345c85a38174aadb0aef1d6744dfcafeaadc on master.

[coveralls]

Coverage remained the same at 97.277% when pulling 96363e5d6b669ac8c3f01614ef0ba9045e9aea02 on impl-new-cmd into 0123345c85a38174aadb0aef1d6744dfcafeaadc on master.

[coveralls]

Coverage remained the same at 97.277% when pulling edd992b6d7680e9b16aa3a5ee21fb5942c7ebc0b on impl-new-cmd into 0123345c85a38174aadb0aef1d6744dfcafeaadc on master.

[discosultan]

Very good point, @jackTheRipper ! We should definitely make both tools "feel" the same. We still have frint init, but I'm not aware of how appix CLI works. We might want to review both of them and make necessary adjustments before this PR gets merged.

[coveralls]

Coverage increased (+0.2%) to 97.432% when pulling b98f46d15a1bbf0934a933495467f8e4eaf30b9a on impl-new-cmd into 0123345c85a38174aadb0aef1d6744dfcafeaadc on master.

[coveralls]

Coverage increased (+0.2%) to 97.432% when pulling 7e8ce3a65fb6acfc959edfa74a34a7d448db4283 on impl-new-cmd into 0123345c85a38174aadb0aef1d6744dfcafeaadc on master.

[fahad19]

@discosultan: any update on this? :)

[discosultan]

I need to compare it to appix to ensure interface similarity. Hopefully will get to it soon :)

[discosultan]

@fahad19 I think this one is good to go now.

• Merged master
• Included the requested changes regarding flattening functions
• Improved the completion text shown to users
• Tested new'ing in current dir, specified dir and from custom repo

[coveralls]

Coverage increased (+0.009%) to 97.272% when pulling db97d2fcf9ff6daeb1a1c8ffc1024d8628202b34 on impl-new-cmd into 8e8622405ac4e1f0a5ca5c856bd0ae6c6d136f51 on master.

[fahad19]

@discosultan: awesome work! 🎉

this PR is gonna be highly impactful for beginners!

do you think it is wise to wait until we move to frintjs org before we merge this? the download URL can then point to the correct URL then.

let me know what you think.

[discosultan]

@fahad19 Sure, I don't see any reason to rush it. Let's make the switch to new org, then I will update the init and new commands and then we can merge it.

[fahad19]

cool! 👍

Refs #355

[fahad19]

@discosultan: can merge as soon as the URL is updated.

[discosultan]

@fahad19: will update after lunch

[coveralls]

Coverage remained the same at 97.272% when pulling 4da40f0fdb44c557b997bfacfc8547ea48224758 on impl-new-cmd into f8cd1bdad3050c3f1d39b3cb0d3a43ac02bb54f8 on master.

[coveralls]

Coverage remained the same at 97.272% when pulling 8618ab5f2fb3529308834bab1cf2f4be4ddd49b9 on impl-new-cmd into f8cd1bdad3050c3f1d39b3cb0d3a43ac02bb54f8 on master.

[discosultan]

All should be done now

[coveralls]

Coverage remained the same at 97.272% when pulling 8618ab5f2fb3529308834bab1cf2f4be4ddd49b9 on impl-new-cmd into f8cd1bdad3050c3f1d39b3cb0d3a43ac02bb54f8 on master.