Layout support

[derekrushforth]

Hey @ibalosh and @matt-west,

This pull request adds layout support to our templates pull and templates push commands. Looking for whatever feedback you guys have about the code and changes to the workflow. I'd love to release this by EOD Thursday (6/27).

templates pull

The folder structure downloaded from this command is a little different now. Templates and layouts are now organized into separate folders:

my-emails
├── layouts
│   └── plain
│       ├── content.html
│       ├── content.txt
│       └── meta.json
└── templates
    ├── password-reset
    │   ├── content.html
    │   ├── content.txt
    │   └── meta.json
    └── welcome
        ├── content.html
        └── meta.json

Changes to meta.json There are a couple minor differences between the meta.json files for templates versus layouts.

• templates - Has a new field called LayoutTemplate that lets people specify the layout alias being used for that particular standard template. It's not required. If users don't include this in the push command, we simply insert LayoutTemplate: null into the API request. This ensures that the layout is not changed at all. If you want to remove the layout being used on a template completely, pass an empty string to LayoutTemplate. This is how our public API works.
• layouts - Only the Name and Alias are required. Does not include the Subject field.

templates push

This command now requires that the directory structure matches what you see above. Since this is a breaking change for anybody using the old version, I've bumped the major to 2.0.0.

Here's what pushing a template looks like now:

• Two separate lists for templates and layouts. I kept it similar to the push screen in our UI.
• You can see if a template is now using a different layout than what's on the server (see the welcome alias in the screenshot)
• Minor tweaks to the copy to account for layouts

Tests

I've modified the tests a bit so they work with the new folders. The tests for the pull command also now check for an empty layout directory. This was only so I could get the tests to pass for now.

@ibalosh, can you tweak these so that we account for layouts on the test server?

cc @rianvdm

[ibalosh]

@derekrushforth added base tests which should be good for release, for stuff like pulling layouts, pushing them with changes, etc

[derekrushforth]

Hey folks,

I've updated the workflow based on the feedback. Here's a rundown:

• TemplateType is now determined by what's specified in meta.json, instead of assuming based on the folder structure
• Pushing no longer requires a strict folder structure. The command will traverse the folders so that you can organize templates and layouts however you want. As long as a single meta.json file and either HTML or Text content files are present in the same folder, it's good.
• Pulling templates adds the layouts to a _layouts folder and standard templates will remain in the root directory. This is so that we do not introduce breaking changes. The only caveat is that we are not doing anything to detect whether the user has a custom folder structure. If you pull, then make major changes to your structure, then pull again, it's going to use our default structure. I'll look into introducing this as a separate feature release.

  my-emails
  ├── _layouts
  │   └── plain
  │       ├── content.html
  │       ├── content.txt
  │       └── meta.json
  └── password-reset
  │   ├── content.html
  │   ├── content.txt
  │   └── meta.json
  └── welcome
  ├── content.html
  └── meta.json

• Version changed to 1.1.0
• @ibalosh I also tweaked the tests so that they work with the new folder structure. Feel free to make any changes there.

Let me know what you guys think. If we're good, please approve the PR.