Conversation
@@ -62,22 +62,6 @@ export default async function Initialize( | |||
|
|||
safelyCreateFile("gitignore", ".gitignore"); // we need to call the source file something other than `.gitignore` so it's not ignored by NPM | |||
|
|||
/** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since Config UI generates the directories it needs, we don't need this skeleton structure anymore. The init
command directs folks to the Config docs, so the READMEs that were housed in the empty folders aren't needed either.
ff228fe
to
023cdce
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Woo!
- This will start the Grouparoo Config UI and launch a browser for you to configure your instance. | ||
- For more information on Config UI, see http://www.grouparoo.com/docs/config | ||
|
||
### Init |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe init should be first
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree- it looks like the old docs were potentially referring to an older version of the generate
command that could set up the project itself like init
does now
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep! Pedro pointed out that config
isn't there until someone runs init
anyways, so I've pulled that out entirely.
@@ -2,26 +2,15 @@ import fs from "fs-extra"; | |||
import path from "path"; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's possible this whole file can be removed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The remaining pieces in this file are for setting up the structure for and replacing the placeholders in the package.json
, .env
, etc. when running grouparoo init
. Open to moving or renaming these, but I do think they're still necessary!
cli/README.md
Outdated
generate [path] generate a new Grouparoo project | ||
upgrade [path] upgrade an existing Grouparoo project | ||
help [command] display help for command | ||
config [options] Interactively configure Grouparoo. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, this command isn't part of the initial set of commands available, and only shows up when within a Grouparoo project (as the next "Commands" section indicates". Could having config
here cause confusion?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed, I'll take that out. I'm somewhat surprised that install
and uninstall
are in there before init
. Axing config
here.
- This will start the Grouparoo Config UI and launch a browser for you to configure your instance. | ||
- For more information on Config UI, see http://www.grouparoo.com/docs/config | ||
|
||
### Init |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree- it looks like the old docs were potentially referring to an older version of the generate
command that could set up the project itself like init
does now
237a88b
to
3c0a4d5
Compare
Change description
Gone:
generate
command and all references/implementations of itgenerate
command, including the CLISpechelper (which was only used togenerate
or validate the empty generated files)roo init
no longer generates a config dir full of dirs and READMEs. (roo config
generates the directories needed on the fly).roo init
directs folks to the Config UI docs.Updated the CLI docs a bit as well.
Checklists
Development
Impact
Please explain any security, performance, migration, or other impacts if relevant:
Users will not be able to use
grouparoo generate
anymore.Code review