A Tern plugin for Phaser
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
demos Add JSDoc tern plugin. Fix Sep 18, 2015
generator Remove simple <anonymous>. See Sep 18, 2015
scripts Add git-tag Sep 16, 2015
test Don't guess completion for tests. Sep 20, 2015
.gitignore Add demo Sep 12, 2015
.travis.yml Add test Sep 16, 2015
INSTALL.md Add link to User tern-phaser with Atom Oct 3, 2015
README.md Fix typo Sep 20, 2015
package.json Next version Sep 18, 2015
phaser.js Remove simple <anonymous>. See Sep 18, 2015

README.md

tern-phaser

Build Status NPM version

tern-phaser is a plugin which adds support for Phaser to the JavaScript code intelligence system Tern.

Demo

You can play with online demo which uses CodeMirror ((inside Web Browser).

Here a screenshot with completion with CodeMorror Phaser completion :

CodeMirror & TernPhaser

Here a screenshot with completion with Eclipse IDE Phaser completion :

Eclipse & TernPhaser

If you wish to use Eclipse as IDE, see Eclipse support for Phaser.

Installation

tern-phaser works with the NodeJS Tern Server, and within a browser.

Short version

After installing Tern according the setup instructions of your desired editor plugin, go to the place where the Tern package was installed (or the Tern repo was cloned) and run

$ npm install tern-phaser

Or, if you're not sure where Tern was installed, you can try

$ npm install -g tern-phaser

Long version

See INSTALL.md for instructions tailored to each editor.

Configuration

In order for Tern to load the tern-phaser plugin once it is installed, you must include phaser in the plugins section of your Tern configuration file. The configuration file can be either a file named .tern-project in your project's root directory, or .tern-config in your home directory.

Here is a minimal example .tern-project configuration file:

{
  "ecmaVersion": 5,
  "libs": ["browser"],
  "plugins": {
    "phaser": {}
  }
}

"Project directory" and .tern-project vs .tern-config

Tern looks for .tern-project first, walking up the directory tree, and uses its location as the "project directory". If no .tern-project is found, your .tern-config is loaded instead, and the working directory of the Tern server process is used as the "project directory".

Structure

The basic structure of the project is given in the following way:

  • phaser.js the tern plugin.
  • demos/ demos with Phaser tern plugin which use CodeMirror.
  • test test of the tern plugin.