Variational Editor Atom

Install

1. Get the Variation Editor Atom plugin

Clone it!

2. Requirements

Install the following software:

• npm
• Atom

3. Build the Variational Editor Backend

Follow the instructions in the variational-editor-backend repository which can be found here to build the variational-parser.

4. Install the Variational Editor Backend in the Variational Editor Atom plugin

The parser from the backend needs to be copied under the lib/ directory in this package. From the variational-editor-backend directory run cp -v `stack exec which variational-parser` /path/to/variational-editor-atom/lib where /path/to/variational-editor-atom/lib is the path to the lib/ directory of this project.

5. Linking to Atom

---

Note

This step will not work if npm and Atom are not installed.

---

Run the atominstall command.

npm install
npm run atominstall

The atominstall command creates a link to Atoms package directory (typically under ~/.atom/packages) using Atoms built in command line utility. Any changes made to this package will propogate to Atom (after Atom is restarted).

Developing

Run the command:

npm run develop

to watch the TypeScript files for changes and open the editor in development mode. To reload Atom in development mode, use the key binding ALT+CTRL+R. Since Atom is built on the Chrome browser, the developer console can be accessed with the key binding CTRL+SHIFT+I.

Session State

When developing, there may be instances where the state of the plugin is saved across Atom sessions. To delete this state run the command:

atom --clear-window-state

---

WARNING

This will delete all saved state for Atom, including unsaved files and other package state.

---

Testing

Tests can be run on the command line with npm run test or when this project is open in Atom with the key binding CTRL+SHIFT+Y.

---

Note

These tests may be out of date. They were put in place in Summer 2018 to make sure functionality did not break during major refactoring.

---

Contributing

Adding dependencies from DefinitelyTyped

DefinitelyTyped publishes type definition files for thousands of existing JS packages to allow compatibility with TypeScript. Most of these packages have a procedurally generated package.json file that does not specify versions for their dependencies. This results in inconsistent builds and can break the dependencies this package relies on.

In order to avoid this issue, all @types packages, including dependencies of dependencies and so on, should be specified in the package.json file for the Variational Editor Atom plugin. To find all @types packages installed by npm run npm list.

Resources

The following resources are a good place to start for getting up and running with TypeScript and Atom.

• TypeScript Deep Dive
• Atom Flight Manual (Especially chapter 3)