Skip to content
This repository has been archived by the owner on Apr 12, 2022. It is now read-only.

Remove grouparoo generate command #2963

Merged
merged 11 commits into from Feb 15, 2022
Merged

Conversation

teallarson
Copy link
Contributor

@teallarson teallarson commented Feb 10, 2022

Change description

Gone:

  • the generate command and all references/implementations of it
  • templates used by the generate command (Config UI generates files based on the config object, not the template)
  • all plugin references to templates
  • all tests related to templates or the generate command, including the CLISpechelper (which was only used to generate or validate the empty generated files)
  • methods used to generate/fill in the templates generated
  • 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

  • Application changes have been tested appropriately

Impact

  • Code follows company security practices and guidelines
  • Security impact of change has been considered
  • Performance impact of change has been considered
  • Possible migration needs considered (model migrations, config migrations, etc.)

Please explain any security, performance, migration, or other impacts if relevant:
Users will not be able to use grouparoo generate anymore.

Code review

  • Pull request has a descriptive title and context useful to a reviewer. Screenshots or screencasts are attached where applicable.
  • Relevant tags have been added to the PR (bug, enhancement, internal, etc.)

@evantahler
Copy link
Member

Screen Shot 2022-02-10 at 2 39 54 PM

This is the best kind of PR

@@ -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

/**
Copy link
Contributor Author

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.

@teallarson teallarson force-pushed the 180837970-remove-grouparoo-generate branch from ff228fe to 023cdce Compare February 11, 2022 15:57
@teallarson teallarson marked this pull request as ready for review February 11, 2022 22:30
@teallarson teallarson requested review from evantahler and pedroslopez and removed request for evantahler February 11, 2022 22:31
Copy link
Member

@evantahler evantahler left a 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
Copy link
Member

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

Copy link
Member

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

Copy link
Contributor Author

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";
Copy link
Member

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?

Copy link
Contributor Author

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.
Copy link
Member

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?

Copy link
Contributor Author

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
Copy link
Member

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

@teallarson teallarson added the enhancement New feature or request label Feb 14, 2022
@teallarson teallarson force-pushed the 180837970-remove-grouparoo-generate branch from 237a88b to 3c0a4d5 Compare February 15, 2022 19:59
@teallarson teallarson enabled auto-merge (squash) February 15, 2022 20:00
@teallarson teallarson merged commit eb40f33 into main Feb 15, 2022
@teallarson teallarson deleted the 180837970-remove-grouparoo-generate branch February 15, 2022 21:11
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants