BREAKING CHANGE(cli): new `zapier init` with up-to-date templates #206

eliangcs · 2020-04-29T07:27:19Z

Rewrites zapier init and updates all the project templates.

The new zapier init command is powered by Yeoman, so it has the interactive goodies like the Yeoman CLI yo.

This is a breaking change because:

--template no longer defaults to minimal. If a user doesn't specify --template, zapier init will prompt the user to choose a template.
Some templates aren't available anymore. These are what we currently have. And these are the ones we're going to keep:
- basic-auth
- custom-auth
- digest-auth
- oauth1-trello
- oauth2
- session-auth
- dynamic-dropdown
- files
- minimal
- search-or-create
- typescript

eliangcs · 2020-04-29T07:35:04Z

packages/cli/src/generators/index.js

+  }
+
+  async prompting() {
+    if (!this.options.authType) {


So this means we only ask for the auth type interactively when the user didn't provide --auth in the CLI.

eliangcs · 2020-04-29T07:37:34Z

packages/cli/src/generators/index.js

+class ProjectGenerator extends Generator {
+  initializing() {
+    this.sourceRoot(path.resolve(__dirname, 'templates'));
+    this.destinationRoot(path.resolve(this.options.path));


These calls are parts of the Yeomen Generator API: https://yeoman.io/authoring/file-system.html

sourceRoot is where we keep the templates. We set it to packages/cli/generators/templates.

destinationRoot is the directory of the new project.

eliangcs · 2020-04-29T07:44:30Z

packages/cli/src/generators/index.js

+  }
+];
+
+class ProjectGenerator extends Generator {


Notice this class ProjectGenerator is in the generators directory. I use plural "generators" on purpose because I think we might want to add more sub-generators to power the scaffold command. For example, we could have a TriggerGenerator that powers zapier scaffold trigger foo.

eliangcs · 2020-04-29T07:45:04Z

packages/cli/src/generators/index.js

+    this.sourceRoot(path.resolve(__dirname, 'templates'));
+    this.destinationRoot(path.resolve(this.options.path));
+
+    this.registerTransformStream(prettier({ singleQuote: true }));


This is where we register prettier to format .js and .json files.

xavdid

nice, this looks great!

Do we think we'll want to have other types besides auth? Or will those be the only template options? I think typescript will still be fair game.

xavdid · 2020-04-30T02:20:57Z

packages/cli/package.json

@@ -48,6 +48,7 @@
    "colors": "1.3.3",
    "debug": "4.1.1",
    "fs-extra": "8.1.0",
+    "gulp-prettier": "3.0.0",


why is this included? the regular prettier has a format we should be able to use.

Good question! It's because Yeoman generator's registerTransformStream requires a vinyl object stream (like gulp) rather than a simple function: https://yeoman.io/authoring/file-system.html#transform-output-files-through-streams

ah, makes sense.

maybe a dumb question, but it doesn't look like we'll actually be feeding prettier in the generator any un-pretty files. the generated auth stuff is run through prettier, and presumably any templates we ship will have also been prettyified already. so i'm not sure this will actually do anything here.

We'll still need to run prettier for non-auth files, such as package.json and index.js. Since here this Yeoman generator runs prettier before writing any files, maybe we don't need to do any code formatting when generating auth stuff?

this comment was previously misplaced from an email, so i'm reposting it

That's true. It looks like the index file is already pretty as it's stored here and package.json is easy to pretty print, but it's nbd either way. An extra dep doesn't hurt much.

xavdid · 2020-04-30T02:23:30Z

packages/cli/src/generators/index.js

+      },
+      devDependencies: {
+        mocha: '^5.2.0',
+        should: '^13.2.0'


I think i'm going to try to swap at least should in the new templates - it's also been a long-held frustration with me. I find it very backwards.

jest has expect included so we could use that as a runner. I've been super impressed with the guard rails and suggestions they provide (for instance, suggesting to use different or better assertion functions when you'll get unexpected behavior). I think we could also use that separate though if you want.

Yeah, I'm not a fan of should either. I'll give jest a test today.

eliangcs · 2020-04-30T03:16:12Z

Do we think we'll want to have other types besides auth? Or will those be the only template options? I think typescript will still be fair game.

The CLI will get complicated if it has both --auth and --template options. If we do that, I imagine we'll have to deal with num_of_auth_options * num_of_template_options combinations. For example, we'll need to prepare a typescript template for all six auth types.

A more practical way is to provide either --auth or --template, but not both. So if we only provide --template, what templates you think we should offer? So if we have:

basic
custom
digest
oauth1
oauth2
session
typescript

The last one typescript looks awkward to me because it's not an auth type like the rest.

I don't have a good solution yet, but I'm wondering do you any thoughts? @xavdid

xavdid · 2020-04-30T17:41:36Z

this comment was previously misplaced from an email, so i'm reposting it

Yeah, that's fair. I would think typescript would just be a TS version of a single other template (maybe the basic one) but maybe we drop it for now and do it in docs instead of a full template. If we wanted to include it, the auth and typescript flags could be mutually exclusive. You can get either the specific auth or a basic typescript template? I could go either way.

xavdid

nice! This template work can be so tedious.

Left a couple of minor things that aren't blockers.

We're at the end of the week, so depending on how much else we've got going on, we should estimate remaining workload and timeframe to get this out the door. We can touch base on that next week!

xavdid · 2020-05-01T22:41:12Z

packages/cli/src/generators/index.js

+    },
+    engines: {
+      node: `>=${NODE_VERSION}`,
+      npm: '>=5.6.0'


i'm not sure we need this anymore.

I don't think we need this either. I'll remove the entire engines property.

xavdid · 2020-05-01T22:43:37Z

packages/cli/src/generators/index.js

+      test: 'jest'
+    },
+    engines: {
+      node: `>=${NODE_VERSION}`,


honestly probably don't need this either - it mostly causes confusion. We enforce the node version w/ the CLI and their core version sets it for runtime. Plus it's not even enforced.

xavdid · 2020-05-01T22:45:09Z

packages/cli/src/generators/index.js

+};
+
+const writeGenericAuthTest = gen => {
+  gen.fs.write(path.join('test', 'authentication.js'), '// TODO\n');


we're going to copy these from the examples directory; there's not enough work to bother templating them.

xavdid · 2020-05-01T22:46:26Z

packages/cli/src/generators/index.js

+};
+
+const writeGenericAuth = gen => {
+  gen.fs.write('authentication.js', '// TODO\n');


once you import the new utils/auth-files-codegen, this will be authFileFuncs[authType](). They don't go through prettier on that end

xavdid and others added 5 commits April 27, 2020 20:52

generate working basic auth

4b68e12

tried a template based approach

c9f91a0

try a composable approach

efe8c3a

Add yeoman dependencies

fda8fdf

POC: zapier yo command

9fa2eda

eliangcs changed the title ~~improvement(cli): init with yeoman~~ improvement(cli): zapier yo, init with yeoman Apr 29, 2020

eliangcs commented Apr 29, 2020

View reviewed changes

eliangcs requested a review from xavdid April 29, 2020 07:46

xavdid approved these changes Apr 30, 2020

View reviewed changes

Add more templates for zapier yo

f944b25

eliangcs and others added 2 commits May 1, 2020 17:36

Revise dynamic-dropdown template

cc5185d

add new codegen files and remove static auth files

667a429

xavdid approved these changes May 1, 2020

View reviewed changes

eliangcs added 4 commits May 4, 2020 15:27

"files" template WIP

ffde000

Merge branch 'master' into init-with-yeoman

b335733

Remove 'engines' from template package.json

7236432

Merge branch 'auth-codegen' into init-with-yeoman

8cffbe4

eliangcs mentioned this pull request May 6, 2020

improvement(cli) Simplify and improve auth file generation #205

Closed

FokkeZB mentioned this pull request May 6, 2020

BREAKING CHANGE(core): Make throwForStatus an opt-out, also for code/function operations #210

Merged

5 tasks

eliangcs and others added 6 commits May 7, 2020 17:46

Rewrite "files" template

7fa6538

Hook up with auth files codegen

109efdb

Rewrite "search-or-create" template

a7cbacd

Inject env for tests, run prettier

ec8b60e

Upgrade prettier for workspace and run it

96163d8

rig up generated templates and test files

a2a19cb

xavdid and others added 16 commits May 7, 2020 23:41

add single slow working smoke test

5da9211

fix a couple of tests

1abf7ad

remove change to func

9e73dae

Rewrite "typescript" template

fc0c8ac

Add "minimal" template

a02f01a

Exclude *.template.js from eslint

3f65963

remove throwForStatus for scaffolded auth

59bc4c4

add a comment formatter

6df4fcc

Split uploadFile into v10 and v9

684f0d5

Merge branch 'master' into init-with-yeoman

edb8cdc

Refactor "files" template tests

fa22e1c

Merge branch 'master' into init-with-yeoman

7f0498a

fix smoke tests

4c70428

Edit comments in "files" template

311e8ff

Add all templates to smoke tests

f0c2502

Replace init with yo

5e9fb3b

eliangcs changed the title ~~improvement(cli): zapier yo, init with yeoman~~ improve(cli): new zapier init with up-to-date templates May 13, 2020

eliangcs changed the title ~~improve(cli): new zapier init with up-to-date templates~~ BREAKING CHANGE(cli): new zapier init with up-to-date templates May 13, 2020

eliangcs marked this pull request as ready for review May 13, 2020 07:05

Update README

0f9e62a

eliangcs merged commit 6b73b2c into master May 13, 2020

eliangcs deleted the init-with-yeoman branch May 13, 2020 08:31

xavdid mentioned this pull request May 13, 2020

BREAKING CHANGE(core): Introduce response.data with support for form-urlencoded and custom parsing #211

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

BREAKING CHANGE(cli): new `zapier init` with up-to-date templates #206

BREAKING CHANGE(cli): new `zapier init` with up-to-date templates #206

eliangcs commented Apr 29, 2020 •

edited

Loading

eliangcs Apr 29, 2020 •

edited

Loading

eliangcs Apr 29, 2020 •

edited

Loading

eliangcs Apr 29, 2020

eliangcs Apr 29, 2020 •

edited

Loading

xavdid left a comment

xavdid Apr 30, 2020

eliangcs Apr 30, 2020 •

edited

Loading

xavdid Apr 30, 2020

eliangcs Apr 30, 2020 •

edited

Loading

xavdid Apr 30, 2020

xavdid Apr 30, 2020

eliangcs Apr 30, 2020

eliangcs commented Apr 30, 2020

xavdid commented Apr 30, 2020 •

edited

Loading

xavdid left a comment

xavdid May 1, 2020

eliangcs May 6, 2020

xavdid May 1, 2020

xavdid May 1, 2020

xavdid May 1, 2020

BREAKING CHANGE(cli): new zapier init with up-to-date templates #206

BREAKING CHANGE(cli): new zapier init with up-to-date templates #206

Conversation

eliangcs commented Apr 29, 2020 • edited Loading

eliangcs Apr 29, 2020 • edited Loading

Choose a reason for hiding this comment

eliangcs Apr 29, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eliangcs Apr 29, 2020 • edited Loading

Choose a reason for hiding this comment

xavdid left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eliangcs Apr 30, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eliangcs Apr 30, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eliangcs commented Apr 30, 2020

xavdid commented Apr 30, 2020 • edited Loading

xavdid left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BREAKING CHANGE(cli): new `zapier init` with up-to-date templates #206

BREAKING CHANGE(cli): new `zapier init` with up-to-date templates #206

eliangcs commented Apr 29, 2020 •

edited

Loading

eliangcs Apr 29, 2020 •

edited

Loading

eliangcs Apr 29, 2020 •

edited

Loading

eliangcs Apr 29, 2020 •

edited

Loading

eliangcs Apr 30, 2020 •

edited

Loading

eliangcs Apr 30, 2020 •

edited

Loading

xavdid commented Apr 30, 2020 •

edited

Loading