Description

Format the table under the cursor in Markdown editor

Additional Information

Table Formatter

What this plugin does

This plugin aligns the columns in the markdown version of your table. It will turn something like this

| city | capital of which state | Notes |
|----------|-----------|--|
| London | United Kingdom | very expensive |
| Dublin | Ireland | just as expensive, without any of the perks |
| Edinburgh | Scotland | -- |
| Oslo | Norway | You can't afford to travel there |

into this

| city      | capital of     | Notes                                       |
| --------- | -------------- | ------------------------------------------- |
| London    | United Kingdom | very expensive                              |
| Dublin    | Ireland        | just as expensive, without any of the perks |
| Edinburgh | Scotland       | --                                          |
| Oslo      | Norway         | You can't afford to travel there            |

To use, just select the table in the markdown, and right click to bring a context menu with the 'Format Table' command

Developer notes

The main two files you will want to look at are:

• /src/index.ts, which contains the entry point for the plugin source code.
• /src/manifest.json, which is the plugin manifest. It contains information such as the plugin a name, version, etc.

Building the plugin

The plugin is built using Webpack, which creates the compiled code in /dist. A JPL archive will also be created at the root, which can use to distribute the plugin.

To build the plugin, simply run npm run dist.

The project is setup to use TypeScript, although you can change the configuration to use plain JavaScript.

Updating the plugin framework

To update the plugin framework, run npm run update.

In general this command tries to do the right thing - in particular it's going to merge the changes in package.json and .gitignore instead of overwriting. It will also leave "/src" as well as README.md untouched.

The file that may cause problem is "webpack.config.js" because it's going to be overwritten. For that reason, if you want to change it, consider creating a separate JavaScript file and include it in webpack.config.js. That way, when you update, you only have to restore the line that include your file.