add docs (#20)

* add docs
* add yaspeller-ci and documendation

.gitignore

@@ -1,3 +1,4 @@
 node_modules
 coverage
+api.md
 *.log

.lintstagedrc

@@ -1,3 +1,4 @@
 {
-  "*.js": "nrun lint"
+  "*.js": "nrun lint",
+  "*.md": "nrun spellcheck",
 }

.npmignore

@@ -1,10 +1,12 @@
 node_modules
 coverage
+api.md
 test
 
 .editorconfig
 .eslintrc.json
 .huskyrc
 .lintstagedrc
 .travis.yml
+.yaspellerrc
 jest.config.js

.travis.yml

@@ -9,4 +9,5 @@ node_js:
 script:
   - npm run lint
   - npm run size
+  - npm run spellcheck
   - npm run test -- --coverage --coverageReporters=text-lcov | coveralls

.yaspellerrc

@@ -0,0 +1,9 @@
+{
+  "lang": "en",
+  "dictionary": [
+    "getFirstSets",
+    "getFollowSets",
+    "getPredictSets",
+    "gzipped"
+  ]
+}

lib/Grammar.js

@@ -12,7 +12,14 @@ const {
 module.exports = class Grammar {
   /**
    * Create a Grammar.
-   * @param {array} rules -- The array of rules.
+   * @param {Array.<object>} rules The array of rules.
+   *
+   * @example
+   * const { Grammar } = require('first-follow');
+   * const grammar = new Grammar([{
+   *   left: 'S',
+   *   right: ['a']
+   * }]);
    */
   constructor(rules) {
     this.rules = rules;
@@ -25,14 +32,56 @@ module.exports = class Grammar {
     this.predictSets = this._makePredictSets();
   }
 
+  /**
+   * Get first sets for the grammar.
+   *
+   * @return {Object.<string, Array.<string>>} The object that represents the first sets.
+   *
+   * @example
+   * const { Grammar } = require('first-follow');
+   * const grammar = new Grammar([{
+   *   left: 'S',
+   *   right: ['a']
+   * }]);
+   *
+   * grammar.getFirstSets(); //=> { S: ['a'] }
+   */
   getFirstSets() {
     return this.firstSets;
   }
 
+  /**
+   * Get follow sets for the grammar.
+   *
+   * @return {Object.<string, Array.<string>>} The object that represents the follow sets.
+   *
+   * @example
+   * const { Grammar } = require('first-follow');
+   * const grammar = new Grammar([{
+   *   left: 'S',
+   *   right: ['a']
+   * }]);
+   *
+   * grammar.getFollowSets(); //=> { S: ['\u0000'] }
+   */
   getFollowSets() {
     return this.followSets;
   }
 
+  /**
+   * Get predict sets for the grammar.
+   *
+   * @return {Object.<string, Array.<string>>} The object that represents the predict sets.
+   *
+   * @example
+   * const { Grammar } = require('first-follow');
+   * const grammar = new Grammar([{
+   *   left: 'S',
+   *   right: ['a']
+   * }]);
+   *
+   * grammar.getPredictSets(); //=> { '1': ['a'] }
+   */
   getPredictSets() {
     return this.predictSets;
   }