Script

Run code in Atom!

Run scripts based on file name, a selection of code, or by line number.

Currently supported grammars are:

• AppleScript
• Bash
• Behat Feature
• C ^*‡
• C++ ^*‡
• C# Script ^*
• Coffeescript
• CoffeeScript (Literate) ^{^}
• Crystal
• Cucumber (Gherkin) ^*
• D ^*
• DOT (Graphviz)
• Elixir
• Erlang ^†
• F# ^*
• Forth (via GForth)
• Go ^*
• Groovy
• Haskell
• Java
• Javascript
• JavaScript for Automation (JXA)
• Julia
• Kotlin
• LaTeX (via latexmk)
• LilyPond
• Lisp (via SBCL) ^⍵
• Literate Haskell ^*
• LiveScript
• Lua
• Makefile
• MoonScript
• MongoDB
• NCL^#
• newLISP
• Nim (and NimScript)
• NSIS
• Objective-C ^*‡
• Objective-C++ ^*‡
• OCaml ^*
• Pandoc Markdown ^††
• Perl
• Perl 6
• PHP
• PostgreSQL ^§
• Python
• RSpec
• Racket
• RANT
• Ruby
• Ruby on Rails
• Rust
• Sass/SCSS ^*
• Scala
• Swift
• TypeScript
• Dart
• Octave

NOTE: Some grammars may require you to install a custom language package.

You only have to add a few lines in a PR to support another.

Limitations

^{^} Running selections of code for CoffeeScript (Literate) only works when selecting just the code blocks

^† Erlang uses erl for limited selection based runs (see #70)

^* Cucumber (Gherkin), D, Go, F#, Literate Haskell, OCaml, PowerShell, and Swift do not support selection based runs

^⍵ Lisp selection based runs are limited to single line

^‡ C, C++, Objective-C, and Objective-C++ are currently only available for Mac OS X (where process.platform is 'darwin'). This is possible due to the commands xcrun clang and xcrun clang++. NOTE: Xcode and the Xcode command line tools are required to ensure xcrun and the correct compilers on your system.

^# NCL scripts must end with exit command for file based runs

^†† Requires the panzer pandoc wrapper https://github.com/msprev/panzer and the pandoc-flavored-markdown language package in Atom https://atom.io/packages/language-pfm

^§ Requires the atom-language-pgsql package in Atom https://atom.io/packages/language-pgsql. Connects as user $PGUSER to database $PGDATABASE. Both default to the operating system's user name and both can be set in the process environment or in Atom's init.coffee script: process.env.PGUSER = ⟨username⟩ and process.env.PGDATABASE = ⟨database name⟩.

Installation

apm install script

or

Search for script within package search in the Settings View.

Atom can't find node | ruby | python | my socks

Make sure to launch Atom from the console/terminal. This gives atom all your useful environment variables. Additionally, make sure to run it with the project path you need. For example, use

atom .

to get it to run with the current directory as the default place to run scripts from.

If you really wish to open atom from a launcher/icon, see this issue for a variety of workarounds that have been suggested.

Usage

Make sure to run atom from the command line to get full access to your environment variables. Running Atom from the icon will launch using launchctl's environment.

Script: Run will perform a "File Based" run when no text is selected (default).

Script: Run while text is selected will perform a "Selection Based" run executing just the highlighted code.

Script: Run by Line Number to run using the specified line number. Note that if you select an entire line this number could be off by one due to the way Atom detects numbers while text is selected.

Script: Run Options should be used to configure command options, program arguments, and environment variables overrides. Environment variables may be input into the options view in the form VARIABLE_NAME_ONE=value;VARIABLE_NAME_TWO="other value";VARIABLE_NAME_3='test'

Script: Kill Process will kill the process but leaves the pane open.

Script: Close View closes the pane and kills the process.

To kill everything, click the close icon in the upper right and just go back to coding.

Script: Copy Run Results copies everything written to the output pane to the clipboard, allowing you to paste it into the editor.

Command and shortcut reference

Command	Mac OS X	Linux/Windows	Notes
Script: Run	cmd-i	shift-ctrl-b	If text is selected a "Selection Based" is used instead of a "File Based" run
Script: Run by Line Number	shift-cmd-j	shift-ctrl-j	If text is selected the line number will be the last
Script: Run Options	shift-cmd-i	shift-ctrl-alt-o	Runs the selection or whole file with the given options
Script: Close View	esc or ctrl-w	esc	Closes the script view window
Script: Kill Process	ctrl-c	ctrl-q	Kills the current script process

Development

Use the atom contributing guidelines. They're pretty sane.

Quick and dirty setup

apm develop script

This will clone the script repository to ~/github unless you set the ATOM_REPOS_HOME environment variable.

I already cloned it!

If you cloned it somewhere else, you'll want to use apm link --dev within the package directory, followed by apm install to get dependencies.

Workflow

After pulling upstream changes, make sure to run apm update.

To start hacking, make sure to run atom --dev from the package directory. Cut a branch while you're working then either submit a Pull Request when done or when you want some feedback!