Merged v1.0.0 into master

.babelrc

@@ -0,0 +1,9 @@
+{
+  "presets": [
+    ["env", {
+      "targets": {
+        "node": 6
+      }
+    }]
+  ]
+}

.eslintrc

@@ -1,172 +1,7 @@
 ---
-ecmaFeatures:
-  jsx: false
-  modules: true
-
-env:
-  es6: true
-
-globals:
-  require: false
-  module: false
-  process: false
+extends:
+  airbnb
 
 rules:
-  no-alert: 2
-  no-array-constructor: 2
-  no-bitwise: 2
-  no-caller: 2
-  no-catch-shadow: 2
-  no-cond-assign: 2
-  no-console: 2
-  no-constant-condition: 2
-  no-continue: 0
-  no-control-regex: 2
-  no-debugger: 2
-  no-delete-var: 2
-  no-div-regex: 0
-  no-dupe-keys: 2
-  no-dupe-args: 2
-  no-duplicate-case: 2
-  no-else-return: 0
-  no-empty: 2
-  no-empty-character-class: 2
-  no-eq-null: 0
-  no-eval: 2
-  no-ex-assign: 2
-  no-extend-native: 2
-  no-extra-bind: 2
-  no-extra-boolean-cast: 2
-  no-extra-parens: 2
-  no-extra-semi: 2
-  no-fallthrough: 2
-  no-floating-decimal: 0
-  no-func-assign: 2
-  no-implied-eval: 2
-  no-inline-comments: 0
-  no-inner-declarations: [2, "functions"]
-  no-invalid-regexp: 2
-  no-irregular-whitespace: 2
-  no-iterator: 2
-  no-label-var: 2
-  no-labels: 2
-  no-lone-blocks: 2
-  no-lonely-if: 2
-  no-loop-func: 2
-  no-mixed-requires: 2
-  no-mixed-spaces-and-tabs: 2
-  no-multi-spaces: 2
-  no-multi-str: 2
-  no-multiple-empty-lines: [2, { max: 2 }]
-  no-native-reassign: 2
-  no-negated-in-lhs: 2
-  no-nested-ternary: 2
-  no-new: 2
-  no-new-func: 2
-  no-new-object: 2
-  no-new-require: 2
-  no-new-wrappers: 2
-  no-obj-calls: 2
-  no-octal: 2
-  no-octal-escape: 2
-  no-param-reassign: 0
-  no-path-concat: 0
-  no-plusplus: 0
-  no-process-env: 0
-  no-process-exit: 2
-  no-proto: 2
-  no-redeclare: 2
-  no-regex-spaces: 2
-  no-reserved-keys: 0
-  no-restricted-modules: 0
-  no-return-assign: 2
-  no-script-url: 2
-  no-self-compare: 2
-  no-sequences: 2
-  no-shadow: 2
-  no-shadow-restricted-names: 2
-  no-space-before-semi: 0
-  no-spaced-func: 2
-  no-sparse-arrays: 2
-  no-sync: 0
-  no-ternary: 0
-  no-trailing-spaces: 2
-  no-throw-literal: 0
-  no-undef: 2
-  no-undef-init: 2
-  no-undefined: 0
-  no-underscore-dangle: 0
-  no-unreachable: 2
-  no-unused-expressions: 2
-  no-unused-vars: [2, {
-    vars: "all",
-    args: "none" }]
-  no-use-before-define: 2
-  no-void: 0
-  no-var: 0
-  no-warning-comments: 0
-  no-with: 2
-  block-scoped-var: 0
-  brace-style: [2, "1tbs"]
-  camelcase: 2
-  comma-dangle: [2, "never"]
-  comma-spacing: 2
-  comma-style: [2, "last"]
-  complexity: [2, 11]
-  consistent-return: 2
-  consistent-this: [2, "self"]
-  curly: [2, "all"]
-  default-case: 0
-  dot-notation: [2, { allowKeywords: true }]
-  eol-last: 2
-  eqeqeq: 2
-  func-names: 0
-  func-style: [2, "expression"]
-  generator-star: 0
-  generator-star-spacing: 0
-  strict: [2, "never"]
-  guard-for-in: 0
-  handle-callback-err: 0
-  indent: [2, 2]
-  key-spacing: [2, {
-    beforeColon: false,
-    afterColon: true }]
-  max-depth: [2, 4]
-  max-len: [2, 100, 2]
-  max-nested-callbacks: [2, 3]
-  max-params: [1, 4]
-  max-statements: [2, 20]
-  new-cap: 2
-  new-parens: 2
-  newline-after-var: 0
-  object-shorthand: 0
-  one-var: [2, "never"]
-  operator-assignment: [2, "always"]
-  operator-linebreak: 0
-  padded-blocks: 0
-  quote-props: 0
-  quotes: [2, "double"]
-  radix: 0
-  semi: 2
-  semi-spacing: [2, { before : false, after: true}]
-  sort-vars: 0
-  space-before-blocks: [2, "always"]
-  space-before-function-paren: [2, {
-    anonymous: "always",
-    named: "never" }]
-  space-in-brackets: [0, "always"]
-  space-in-parens: [2, "never"]
-  space-infix-ops: 2
-  keyword-spacing: 2
-  space-unary-ops: [2, {
-    words: true,
-    nonwords: false }]
-  spaced-comment: [2, "always"]
-
-  use-isnan: 2
-  valid-jsdoc: 2
-  valid-typeof: 2
-  vars-on-top: 0
-  wrap-iife: 0
-  wrap-regex: 0
-  yoda: [2, "never"]
+  no-plusplus: [2, { allowForLoopAfterthoughts: true }]
+  handle-callback-err: [2, "^(err|error)$" ]

.gitignore

@@ -1,4 +1,5 @@
 node_modules/*
 systemDB
 *.log
-coverage/*
+coverage/*
+lib/*

.npmignore

@@ -0,0 +1,10 @@
+.DS_Store
+node_modules/*
+npm-debug.log
+src/*
+test/*
+.babelrc
+.eslintrc
+.travis.yml
+readme.md
+.github/*

.travis.yml

@@ -1,8 +1,7 @@
 language: node_js
 node_js:
-  - "0.12"
-services:
-  - mongodb
+  - "6"
+  - "7"
 script: "npm run-script test-travis"
 # Send coverage data to Coveralls
-after_script: "cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js"
+after_script: "cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js"

README.md

@@ -3,6 +3,25 @@
 [![Code Climate](https://codeclimate.com/github/superscriptjs/ss-parser/badges/gpa.svg)](https://codeclimate.com/github/superscriptjs/ss-parser)
 
 # ss-parser
-SuperScript Parser is the interface for reading ss files and creating a internal representation for the superscript dialogue engine.
+
+SuperScript parser is the interface for reading `*.ss` files and creating a internal representation for the SuperScript dialogue engine.
 
 More information can be found at [superscriptjs.com](http://superscriptjs.com)
+
+# API
+
+* `parseDirectory(path, options, callback)`
+
+Takes a directory path and parses all the `*.ss` files in the directory, creating a JSON structure which is passed into callback as `callback(err, results)`. The `options` parameter is an object that can accept a factSystem for use in trigger and reply expansion, and a cache to skip previously parsed files in a directory.
+
+* `parseFile(path, factSystem, callback)`
+
+Like `loadDirectory`, but parses a single `*.ss` file.
+
+* `parseContents(path, factSystem, callback)`
+
+Like `parseFile`, but parses a string (i.e. the contents of a single file).
+
+* `normalizeTrigger(trigger, factSystem, callback)`
+
+Takes a trigger string (for example, 'I like * and *~1, but not [cats|dogs].') and generates the regex for the trigger, which is passed into callback as `callback(err, cleanedTrigger)`.