Documentation

Installing Abasis

Old fashioned browser install, providing window.Abasis: 

<script src="http://abasis.richplastow.com/build/abasis.js"></script>
  <script>console.log( new window.Abasis().I ); // -> 'Abasis'</script>

Install as a CommonJS Module, eg for Node: 

var Abasis = require('abasis');
  console.log( new Abasis().I ); // -> 'Abasis'

Install using RequireJS inline-style, providing Abasis as an argument: 

<script src="lib/require.js"></script>
  <script>
    require(['path/to/abasis'], function(Abasis) {
      console.log( new Abasis().I ); // -> 'Abasis'
    })
  </script>

@todo more installation examples

Testing Abasis

Test with npm run-scripts on the command line: 

npm test

Test on the client:
Open test/run-test.html in a web browser

Installing Build Tools

The following modules are listed in the "devDependencies" field of ‘package.json’, so running npm install will install them in the local ‘node_modules’ directory. However, you may find it useful to install them globally on your machine, in which case the -g flag is your friend:

Install coffee 1.9.2 on the command line: 

npm install -g coffee-script

Install nodemon 1.3.7: 

npm install -g nodemon

The Build Process

Build Abasis on the command line

npm run build

@todo discussion of the limitations of file-watching.

Handy Scripts

v:list

Shows a list of files which contain the version string from ‘package.json’. Each filename is suffixed by a colon, followed by the line-number where the version string appears, eg README.md:1 package.json:4. 

npm run v:list

Which runs: 

grep -ron $npm_package_version {bin,src,*.json} | awk 1 ORS=' ' | sed "s@:$npm_package_version@@g"

Or verbosely: 

grep --recursive --only-matching --line-number $npm_package_version \\
  {bin,src,*.json} \\
  | \\
  awk 1 ORS=' ' \\
  | \\
  sed "s@:$npm_package_version@@g"

Which means:

  1. Use grep to get a newline-delimited list of files which contain the version string from ‘package.json’
    • --recursive search in subdirectories
    • --only-matching don’t show leading/trailing context in the results
    • --line-number included after a colon, eg bower.json:3
  2. Search in bin/, src/, package.json, bower.json, etc
  3. Pipe the list to awk
  4. Convert all newlines to spaces
  5. Pipe the list to sed
  6. Delete the trailing colon and version from each filename, eg :1.2.3-4

v:open

Opens a list of files which contain the version string from ‘package.json’ in Sublime Text. You will need Sublime Text installed, and a symlink to its subl binary added to your PATH. 

npm run v:open

Which runs: 

subl $(npm run v:list --loglevel silent)

Note --loglevel silent, which prevents subl from being sent the results-log which npm run usually outputs.

Abasis

Abasis provides an ideal base class for CoffeeScript classes to extend