Restore ability to put generated files in a directory relative to source

[mike-marcacci]

Fixes #469. Before the change from apollo-codegen to apollo cli, flow type definitions were output into a __generated__ directory, next to their respective source files.

This adds a localDirectory flag that accepts a name to use locally for generated types. For example:

apollo generate:flow **/*.graphql --localDirectory=__generated__

This flag is ignored if --output is specified.

[mike-marcacci]

Please note that the format changes are the result of a fixed precommit hook, which was incorrectly defined and failing; this was updated and the formatter was applied to the to-be-changed files in the first commit.

[mike-marcacci]

Please also note that something in your test on travis fails nondeterministically. I force-pushed the exact same code a couple times with amended commits (separating out the formatting changes from the meaningful ones) and sometimes it would fail (with messages about using a custom engine key), other times it would succeed. This (obviously) has nothing to do with my PR, but I figured you should be aware.

[martijnwalraven]

I definitely think this behavior is worth supporting, maybe even as a default. But if we want to keep it under an option, I'm wondering if we can find a more descriptive alternative to --localDirectory. Are there any examples of other CLIs that have flags for similar options?

[mike-marcacci]

Hmm, personally my preference would be to reuse the --output flag, and add a boolean --output-relative-to-source but I was looking to make as few ripples as possible (just to get it working again, since maintaining forks of a monorepo is a big nuisance).

Would that be a workable solution, and default to --output=__generated__ --output-relative-to-source for Flow/TypeScript generators? I think this would be my ideal solution.

[martijnwalraven]

@mike-marcacci That makes sense to me, but curious to hear what @shadaj and @jbaxleyiii think.

[mike-marcacci]

Placing Flow and TypeScript files in directories relative to their source files is now the default behavior. By default, the directory name used is __generated__, which can be overridden by setting the output (first) cli arg.

To use the output to specify a single locaation the new --outputRelativeToCWD flag can be set.

To continue placing generated files immediately adjacent their source files (which is the current behavior, albiet only for a couple days and arguably undesireable) output can be set to an empty string. While available, I suspect this feature will never be used, due to the problems outlined in #468 and #469.

---

Side note: for consistency with the other flags, I used outputRelativeToCWD instead of output-relative-to-source since dash separations are part of oclif boolean flags, such as the no- prefix but apollo CLI had chosen to use a lowerCamelCase convention. I don't really care either way, but I'm curious why this switch was made, since apollo-codegen had used dash separations up until now.

[mike-marcacci]

Also, to reiterate my comment about problems with the travis setup, the difference between these builds is a newline in the commit message:

• Failure
• Success

[shadaj]

Hi @mike-marcacci this looks great! outputRelativeToCWD seems a bit hard to understand for me, would something like outputFlat work to express the idea of not placing types next to sources?

[mike-marcacci]

@shadaj good idea. The PR's been updated with your suggestion.