Merge pull request #81 from bcaudan/typescript

Migrate codebase to typescript

Author: bcaudan

.gitignore

@@ -1,25 +1,6 @@
-# Logs
-logs
-*.log
-
-# Runtime data
-pids
-*.pid
-*.seed
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
 coverage
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Compiled binary addons (http://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directory
-# Deployed apps should consider commenting this line out:
-# see https://npmjs.org/doc/faq.html#Should-I-check-my-node_modules-folder-into-git
 node_modules
+built
+spec/**/*.js
+src/**/*.js
+*.log

.npmignore

@@ -0,0 +1,23 @@
+.idea
+coverage
+docs
+node_modules
+spec
+!examples/node/spec
+!examples/protractor/spec
+!examples/typescript/spec
+src
+typings
+!examples/typescript/typings
+
+.gitignore
+.istanbul.yml
+.travis.yml
+jasmine-spec-reporter.iml
+npm-debug.log
+screenshot.png
+tsconfig.json
+tslint.json
+typings.json
+
+*~

.travis.yml

@@ -1,6 +1,6 @@
 language: node_js
 node_js:
-  - '4.1'
-  - '0.10'
+  - '6.5'
+  - '4.5'
 script:
   -  npm run coveralls

README.md

@@ -15,58 +15,22 @@ Install `jasmine-spec-reporter` via npm:
 
     npm install jasmine-spec-reporter --save-dev
 
+## Examples
+* [Jasmine node tests](examples/node)
+* [Protractor tests](examples/protractor)
+* [TypeScript support](examples/typescript)
+
 ## Configuration
-* [Jasmine node tests](docs/jasmine-npm-configuration.md)
-* [Protractor tests](docs/protractor-configuration.md)
+See full configuration and features: [configuration.ts](src/configuration.ts)
 
 ## Custom output
 You can customize the output of the reporter yourself: [see how](docs/customize-output.md).
 
-# Default options
-
-```js
-{
-  displayStacktrace: 'none',      // display stacktrace for each failed assertion, values: (all|specs|summary|none)
-  displaySuccessesSummary: false, // display summary of all successes after execution
-  displayFailuresSummary: true,   // display summary of all failures after execution
-  displayPendingSummary: true,    // display summary of all pending specs after execution
-  displaySuccessfulSpec: true,    // display each successful spec
-  displayFailedSpec: true,        // display each failed spec
-  displayPendingSpec: false,      // display each pending spec
-  displaySpecDuration: false,     // display each spec duration
-  displaySuiteNumber: false,      // display each suite number (hierarchical)
-  colors: {
-    success: 'green',
-    failure: 'red',
-    pending: 'yellow'
-  },
-  prefixes: {
-    success: '✓ ',
-    failure: '✗ ',
-    pending: '* '
-  },
-  customProcessors: []
-}
-```
-
-Colors are displayed in the console via [colors](https://github.com/Marak/colors.js), you can see all available colors on the [project page](https://github.com/Marak/colors.js).
-You can also disable colors with the option: `colors: false`.
-
-# Compatibility with Jasmine 1.x
-
-To use Jasmine spec reporter with Jasmine 1.x, please see [jasmine1 branch](https://github.com/bcaudan/jasmine-spec-reporter/tree/jasmine1).
-
 # Developement
 
 * install dependencies: `npm install`
-* launch all unit tests: `npm test`
-* launch an output example: `npm run example`
-* launch a protractor example:
-```sh
-npm run webdriver-update # if needed
-npm run webdriver-start
-npm run protractor-example
-```
+* compile sources: `npm run tsc`
+* launch unit tests: `npm test`
 
 # Contribution
 

docs/customize-output.md

@@ -21,7 +21,7 @@ Let's say that you want to add the current time before each output of the report
 You need to require the display processor:
 
 ```node
-var DisplayProcessor = require('./node_modules/jasmine-spec-reporter/src/display-processor');
+var DisplayProcessor = require('jasmine-spec-reporter').DisplayProcessor;
 ```
 
 You can then customize the following methods:
@@ -37,9 +37,9 @@ The first argument is the jasmine object corresponding to the suite or the spec.
 For our example:
 
 ```node
-var DisplayProcessor = require('./node_modules/jasmine-spec-reporter/src/display-processor');
+var DisplayProcessor = require('jasmine-spec-reporter').DisplayProcessor;
 
-function TimeProcessor(options) {
+function TimeProcessor(configuration) {
 }
 
 function getTime() {
@@ -73,7 +73,7 @@ TimeProcessor.prototype.displayPendingSpec = function (spec, log) {
 Then you need to configure jasmine spec reporter to use your processor:
 
 ```node
-var SpecReporter = require('jasmine-spec-reporter');
+var SpecReporter = require('jasmine-spec-reporter').SpecReporter;
 
 var reporter = new SpecReporter({
     customProcessors: [TimeProcessor]

docs/jasmine-npm-configuration.md

@@ -0,0 +1,33 @@
+Use jasmine-spec-reporter with Node
+===================================
+The `jasmine-spec-reporter` can be used to enhance your [jasmine node](https://github.com/jasmine/jasmine-npm) tests execution report.
+
+## Configuration
+
+Create a `jasmine-runner.js` file with the following content:
+
+```node
+let Jasmine = require('jasmine');
+let SpecReporter = require('jasmine-spec-reporter').SpecReporter;
+
+let jrunner = new Jasmine();
+jrunner.env.clearReporters();           // remove default reporter logs
+jrunner.addReporter(new SpecReporter({  // add jasmine-spec-reporter
+  spec: {
+    displayPending: true
+  }
+}));
+jrunner.loadConfigFile();               // load jasmine.json configuration
+jrunner.execute();
+```
+
+Then run your tests with:
+
+    node jasmine-runner.js
+
+## Example
+
+You can find an example in this directory:
+
+    npm install
+    npm start

example/example-spec.coffee

@@ -0,0 +1,12 @@
+let Jasmine = require('jasmine');
+let SpecReporter = require('jasmine-spec-reporter').SpecReporter;
+
+let jrunner = new Jasmine();
+jrunner.env.clearReporters();           // remove default reporter logs
+jrunner.addReporter(new SpecReporter({  // add jasmine-spec-reporter
+  spec: {
+    displayPending: true
+  }
+}));
+jrunner.loadConfigFile();               // load jasmine.json configuration
+jrunner.execute();