Using Development Versions of SLIMA

Occasionally, it may be useful to run a version of SLIMA other than the currently published version. There are two ways you can install a developmental version of SLIMA, for Atom's dev mode and for Atom's regular mode. Atom's Flight Manual has more information on working with development packages in Atom. Note that you will need apm on your shell's PATH; apm should be located in the same directory as you Atom executable.

Dev Mode

Atom provides a dev mode to allow development of Atom packages while using Atom. There are two ways to run Atom in dev mode the "Application: Open Dev" (View > Developer > Open in Dev Mode...) in an existing Atom window, or running atom --dev from the command line.

To install the development version of SLIMA for dev mode, run apm develop SLIMA <clone directory> to clone and link SLIMA. If you have already cloned this repository, running apm link --dev from the package's directory will tell Atom to use that copy of SLIMA when in dev mode. If you wish to stop using a linked copy of SLIMA in dev mode, run apm unlink --dev in the package's directory.

If a development version of swank-client is also needed (which is more likely than not), you'll need to replace the node_modules/swank-client directory with your own copy. The recommended method is to delete the existing directory, clone the swank-client repository to a convenient directory, run apm install from within the newly cloned repository, then to make a hard/junction link pointing to the new repository where the original directory was.

For Unix-like operating systems, this entire process looks like

git clone https://github.com/neil-lindquist/slima path/to/slima
cd path/to/slima
apm install
apm link --dev

# Only continue if a development version of swank-client is needed
git clone https://github.com/neil-lindquist/swank-client/ path/to/swank-client
cd path/to/swank-client
apm install
cd path/to/slima
rm -r node_modules/swank-client
ln path/to/swank-client node_modules/swank-client

For Window's cmd, you will need to either install Git or manually download the source and place it in the desired directory. With Git, the process looks like

git clone https://github.com/neil-lindquist/slima path/to/slima
cd path/to/slima
apm install
apm link --dev

REM Only continue if a development version of swank-client is needed
git clone https://github.com/neil-lindquist/swank-client/ path/to/swank-client
cd path/to/swank-client
apm install
cd path/to/slima
rmdir node_modules/swank-client
mklink /J node_modules/swank-client path/to/swank-client

Regular Mode

You may want Atom to default to a development version of SLIMA, instead of needing to open Atom in dev mode. Note that Atom won't check for updates to SLIMA in this case, and you'll have to manually update the cloned repository.

To setup SLIMA for Atom's regular mode, first you will need to uninstall SLIMA (either through Atom's UI, or the apm utility). Then clone the SLIMA repository using git clone https://github.com/neil-lindquist/SLIMA.git <clone directory>. Next, you will need to run apm install in the repository's directory to install SLIMA's dependencies. Finally, run apm link from the repository's directory. Restart Atom, and the new session will use the version of SLIMA you have downloaded. You will need to restart Atom if you make changes to SLIMA, or checkout a different version of the repository. To switch back to Atom's automatic package management, run apm unlink in the package's directory and re-install SLIMA through Atom's UI or the apm utility.

The process to install a development version of swank-client is the same as when installing SLIMA for Dev Mode.