markdown-proofing/lib/analyzers/write-good.js

A markdown proofing platform for individuals, teams, and organizations.

'use strict';

Object.defineProperty(exports, "__esModule", {
  value: true
});

var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();

var _analyzerResult = require('../analyzer-result');

var _analyzerResult2 = _interopRequireDefault(_analyzerResult);

var _location = require('../location');

var _location2 = _interopRequireDefault(_location);

var _writeGood = require('write-good');

var _writeGood2 = _interopRequireDefault(_writeGood);

function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }

var WriteGoodAnalyzer = function () {
  function WriteGoodAnalyzer() {
    _classCallCheck(this, WriteGoodAnalyzer);
  }

  _createClass(WriteGoodAnalyzer, [{
    key: 'analyze',
    value: function analyze(str) {
      var result = new _analyzerResult2.default();

      // Based on https://github.com/btford/write-good/blob/master/README.md#cli
      // removing any markdown elements may be unnecessary.
      var suggestions = (0, _writeGood2.default)(str);

      suggestions.forEach(function (x) {
        result.addMessage('write-good-suggestion', x.reason, _location2.default.getLine(str, x.index), _location2.default.getLineColumn(str, x.index));
      });

      return result;
    }
  }]);

  return WriteGoodAnalyzer;
}();

exports.default = WriteGoodAnalyzer;
module.exports = exports['default'];