Taxi for Email - Email Design System syntax - validate and update
This Visual Studio Code extension enables you to work with Taxi for Email design system (EDS) files, directly from your editor. It can
Not yet supported: Create a new EDS.
A Taxi for Email account, with privileges to create an API key.
The Taxi for email API is used by this extension - follow these instructions to obtain your API key.
Validations and updates can take a few seconds on large files (~ 5 .. 10 seconds for a 4000 line file), and you need an Internet connection. For these reasons, unlike some language plugins, it doesn't run all the time in the background.
The status bar enables you to set the numeric EDS id of the project you're working on. This is held in workspace
When a current EDS id has not been set, the status bar shows as:
Click this area to set a numeric ID. This is needed to update the design system(s) held by Taxi.
While actions are running, the status bar shows an animated 'sync' icon.
Start validation from the Command Palette and select it.
For ease of running without going through the Command Palette each time, you can also assign the tool to a shortcut key binding of your choice.
Viewing the output
Results are displayed in the "Problems" window. You may need to bring this to the foreground on your "View" menu. Another way is to click on the bottom status bar area that shows a summary count of errors, warnings, and informational messages.
As with other language syntax checkers, the icon indicates if Taxi for Email considers an item to be:
Note the Informational line the end, showing how lines of code checked, error and warning counts, and the time taken to validate. This can be enabled/disabled in Extension Settings.
Updating an existing Email Design System
First, ensure you have set the correct Design System ID, by clicking on the status bar. A "quick pick" list of up to 20 recently-used design system IDs is shown. Type in the ID, or choose one from the list.
Trigger the update from the command palette, or map to a shortcut key. After the upload is complete, the "problems" window is updated with the errors/warnings report on your EDS.
Once you've updated, the name of the design system (set on the Taxi UI) will appear in this list, and on the status bar.
The eye icon on the toolbar is checked by default, each time you start VS Code. This indicates you want the design system to have accompanying images. These can be uploaded via ZIP file manually (outside of this extension).
This icon on the toolbar is unchecked by default. The Taxi UI will show:
Choose "Continue" to progress.
When "without_review" is checked, the upload will take longer to complete - approx. 1 minute for a 5000 line file - as it's doing the internal processing/checking before returning. The design system will progress to the "Ready to be used" stage on the Taxi UI without further interaction.
Display of error messages
For example, if you try to update an EDS without any actual file changes, Taxi returns an error message:
Requirements - API Key
To obtain an API key and key ID - in your Taxi for Email account, navigate to "Integrations" / "API Keys". Select "Add New" and follow the next steps there.
You can access these via VS Code Preferences, then type
This is a volunteer open-source project and is not directly supported by the Taxi for Email support service. If you find an issue, please open an issue in Github, or (even better) - contribute a pull request.
Telemetry (basic usage info)
This extension colllects basic usage info, to help the author make improvements. It honours the user's Telemetry disable setting.
This uses semantic versioning, in step with the actual version number which is in