whitespaceChecker.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315
  1. "use strict";
  2. Object.defineProperty(exports, "__esModule", {
  3. value: true
  4. });
  5. exports["default"] = _default;
  6. var _isWhitespace = _interopRequireDefault(require("./isWhitespace"));
  7. var _isSingleLineString = _interopRequireDefault(require("./isSingleLineString"));
  8. var _configurationError = _interopRequireDefault(require("./configurationError"));
  9. function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
  10. /**
  11. * Create a whitespaceChecker, which exposes the following functions:
  12. * - `before()`
  13. * - `beforeAllowingIndentation()`
  14. * - `after()`
  15. * - `afterOneOnly()`
  16. *
  17. * @param {"space"|"newline"} targetWhitespace - This is a keyword instead
  18. * of the actual character (e.g. " ") in order to accommodate
  19. * different styles of newline ("\n" vs "\r\n")
  20. * @param {
  21. * "always"|"never"
  22. * |"always-single-line"|"always-multi-line"
  23. * | "never-single-line"|"never-multi-line"
  24. * } expectation
  25. * @param {object} messages - An object of message functions;
  26. * calling `before*()` or `after*()` and the `expectation` that is passed
  27. * determines which message functions are required
  28. * @param {function} [messages.expectedBefore]
  29. * @param {function} [messages.rejectedBefore]
  30. * @param {function} [messages.expectedAfter]
  31. * @param {function} [messages.rejectedAfter]
  32. * @param {function} [messages.expectedBeforeSingleLine]
  33. * @param {function} [messages.rejectedBeforeSingleLine]
  34. * @param {function} [messages.expectedBeforeMultiLine]
  35. * @param {function} [messages.rejectedBeforeMultiLine]
  36. * @return {object} The checker, with its exposed checking functions
  37. */
  38. function _default(targetWhitespace, expectation, messages) {
  39. // Keep track of active arguments in order to avoid passing
  40. // too much stuff around, making signatures long and confusing.
  41. // This variable gets reset anytime a checking function is called.
  42. var activeArgs;
  43. /**
  44. * Check for whitespace *before* a character.
  45. *
  46. * @param {object} args - Named arguments object
  47. * @param {string} args.source - The source string
  48. * @param {number} args.index - The index of the character to check before
  49. * @param {function} args.err - If a violation is found, this callback
  50. * will be invoked with the relevant warning message.
  51. * Typically this callback will report() the violation.
  52. * @param {function} args.errTarget - If a violation is found, this string
  53. * will be sent to the relevant warning message.
  54. * @param {string} [args.lineCheckStr] - Single- and multi-line checkers
  55. * will use this string to determine whether they should proceed,
  56. * i.e. if this string is one line only, single-line checkers will check,
  57. * multi-line checkers will ignore.
  58. * If none is passed, they will use `source`.
  59. * @param {boolean} [args.onlyOneChar=false] - Only check *one* character before.
  60. * By default, "always-*" checks will look for the `targetWhitespace` one
  61. * before and then ensure there is no whitespace two before. This option
  62. * bypasses that second check.
  63. * @param {boolean} [args.allowIndentation=false] - Allow arbitrary indentation
  64. * between the `targetWhitespace` (almost definitely a newline) and the `index`.
  65. * With this option, the checker will see if a newline *begins* the whitespace before
  66. * the `index`.
  67. */
  68. function before(_ref) {
  69. var source = _ref.source,
  70. index = _ref.index,
  71. err = _ref.err,
  72. errTarget = _ref.errTarget,
  73. lineCheckStr = _ref.lineCheckStr,
  74. _ref$onlyOneChar = _ref.onlyOneChar,
  75. onlyOneChar = _ref$onlyOneChar === void 0 ? false : _ref$onlyOneChar,
  76. _ref$allowIndentation = _ref.allowIndentation,
  77. allowIndentation = _ref$allowIndentation === void 0 ? false : _ref$allowIndentation;
  78. activeArgs = {
  79. source: source,
  80. index: index,
  81. err: err,
  82. errTarget: errTarget,
  83. onlyOneChar: onlyOneChar,
  84. allowIndentation: allowIndentation
  85. };
  86. switch (expectation) {
  87. case "always":
  88. expectBefore();
  89. break;
  90. case "never":
  91. rejectBefore();
  92. break;
  93. case "always-single-line":
  94. if (!(0, _isSingleLineString["default"])(lineCheckStr || source)) {
  95. return;
  96. }
  97. expectBefore(messages.expectedBeforeSingleLine);
  98. break;
  99. case "never-single-line":
  100. if (!(0, _isSingleLineString["default"])(lineCheckStr || source)) {
  101. return;
  102. }
  103. rejectBefore(messages.rejectedBeforeSingleLine);
  104. break;
  105. case "always-multi-line":
  106. if ((0, _isSingleLineString["default"])(lineCheckStr || source)) {
  107. return;
  108. }
  109. expectBefore(messages.expectedBeforeMultiLine);
  110. break;
  111. case "never-multi-line":
  112. if ((0, _isSingleLineString["default"])(lineCheckStr || source)) {
  113. return;
  114. }
  115. rejectBefore(messages.rejectedBeforeMultiLine);
  116. break;
  117. default:
  118. throw (0, _configurationError["default"])("Unknown expectation \"".concat(expectation, "\""));
  119. }
  120. }
  121. /**
  122. * Check for whitespace *after* a character.
  123. *
  124. * Parameters are pretty much the same as for `before()`, above, just substitute
  125. * the word "after" for "before".
  126. */
  127. function after(_ref2) {
  128. var source = _ref2.source,
  129. index = _ref2.index,
  130. err = _ref2.err,
  131. errTarget = _ref2.errTarget,
  132. lineCheckStr = _ref2.lineCheckStr,
  133. _ref2$onlyOneChar = _ref2.onlyOneChar,
  134. onlyOneChar = _ref2$onlyOneChar === void 0 ? false : _ref2$onlyOneChar;
  135. activeArgs = {
  136. source: source,
  137. index: index,
  138. err: err,
  139. errTarget: errTarget,
  140. onlyOneChar: onlyOneChar
  141. };
  142. switch (expectation) {
  143. case "always":
  144. expectAfter();
  145. break;
  146. case "never":
  147. rejectAfter();
  148. break;
  149. case "always-single-line":
  150. if (!(0, _isSingleLineString["default"])(lineCheckStr || source)) {
  151. return;
  152. }
  153. expectAfter(messages.expectedAfterSingleLine);
  154. break;
  155. case "never-single-line":
  156. if (!(0, _isSingleLineString["default"])(lineCheckStr || source)) {
  157. return;
  158. }
  159. rejectAfter(messages.rejectedAfterSingleLine);
  160. break;
  161. case "always-multi-line":
  162. if ((0, _isSingleLineString["default"])(lineCheckStr || source)) {
  163. return;
  164. }
  165. expectAfter(messages.expectedAfterMultiLine);
  166. break;
  167. case "never-multi-line":
  168. if ((0, _isSingleLineString["default"])(lineCheckStr || source)) {
  169. return;
  170. }
  171. rejectAfter(messages.rejectedAfterMultiLine);
  172. break;
  173. case "at-least-one-space":
  174. expectAfter(messages.expectedAfterAtLeast);
  175. break;
  176. default:
  177. throw (0, _configurationError["default"])("Unknown expectation \"".concat(expectation, "\""));
  178. }
  179. }
  180. function beforeAllowingIndentation(obj) {
  181. before(Object.assign({}, obj, {
  182. allowIndentation: true
  183. }));
  184. }
  185. function expectBefore() {
  186. var messageFunc = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : messages.expectedBefore;
  187. if (activeArgs.allowIndentation) {
  188. expectBeforeAllowingIndentation(messageFunc);
  189. return;
  190. }
  191. var _activeArgs = activeArgs,
  192. source = _activeArgs.source,
  193. index = _activeArgs.index;
  194. var oneCharBefore = source[index - 1];
  195. var twoCharsBefore = source[index - 2];
  196. if (!isValue(oneCharBefore)) {
  197. return;
  198. }
  199. if (targetWhitespace === "newline") {
  200. // If index is preceeded by a Windows CR-LF ...
  201. if (oneCharBefore === "\n" && twoCharsBefore === "\r") {
  202. if (activeArgs.onlyOneChar || !(0, _isWhitespace["default"])(source[index - 3])) {
  203. return;
  204. }
  205. }
  206. // If index is followed by a Unix LF ...
  207. if (oneCharBefore === "\n" && twoCharsBefore !== "\r") {
  208. if (activeArgs.onlyOneChar || !(0, _isWhitespace["default"])(twoCharsBefore)) {
  209. return;
  210. }
  211. }
  212. }
  213. if (targetWhitespace === "space" && oneCharBefore === " ") {
  214. if (activeArgs.onlyOneChar || !(0, _isWhitespace["default"])(twoCharsBefore)) {
  215. return;
  216. }
  217. }
  218. activeArgs.err(messageFunc(activeArgs.errTarget ? activeArgs.errTarget : source[index]));
  219. }
  220. function expectBeforeAllowingIndentation() {
  221. var messageFunc = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : messages.expectedBefore;
  222. var _activeArgs2 = activeArgs,
  223. source = _activeArgs2.source,
  224. index = _activeArgs2.index,
  225. err = _activeArgs2.err;
  226. var expectedChar = function () {
  227. if (targetWhitespace === "newline") {
  228. return "\n";
  229. }
  230. if (targetWhitespace === "space") {
  231. return " ";
  232. }
  233. }();
  234. var i = index - 1;
  235. while (source[i] !== expectedChar) {
  236. if (source[i] === "\t" || source[i] === " ") {
  237. i--;
  238. continue;
  239. }
  240. err(messageFunc(activeArgs.errTarget ? activeArgs.errTarget : source[index]));
  241. return;
  242. }
  243. }
  244. function rejectBefore() {
  245. var messageFunc = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : messages.rejectedBefore;
  246. var _activeArgs3 = activeArgs,
  247. source = _activeArgs3.source,
  248. index = _activeArgs3.index;
  249. var oneCharBefore = source[index - 1];
  250. if (isValue(oneCharBefore) && (0, _isWhitespace["default"])(oneCharBefore)) {
  251. activeArgs.err(messageFunc(activeArgs.errTarget ? activeArgs.errTarget : source[index]));
  252. }
  253. }
  254. function afterOneOnly(obj) {
  255. after(Object.assign({}, obj, {
  256. onlyOneChar: true
  257. }));
  258. }
  259. function expectAfter() {
  260. var messageFunc = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : messages.expectedAfter;
  261. var _activeArgs4 = activeArgs,
  262. source = _activeArgs4.source,
  263. index = _activeArgs4.index;
  264. var oneCharAfter = index + 1 < source.length ? source[index + 1] : "";
  265. var twoCharsAfter = index + 2 < source.length ? source[index + 2] : "";
  266. if (!isValue(oneCharAfter)) {
  267. return;
  268. }
  269. if (targetWhitespace === "newline") {
  270. // If index is followed by a Windows CR-LF ...
  271. if (oneCharAfter === "\r" && twoCharsAfter === "\n") {
  272. var threeCharsAfter = index + 3 < source.length ? source[index + 3] : "";
  273. if (activeArgs.onlyOneChar || !(0, _isWhitespace["default"])(threeCharsAfter)) {
  274. return;
  275. }
  276. }
  277. // If index is followed by a Unix LF ...
  278. if (oneCharAfter === "\n") {
  279. if (activeArgs.onlyOneChar || !(0, _isWhitespace["default"])(twoCharsAfter)) {
  280. return;
  281. }
  282. }
  283. }
  284. if (targetWhitespace === "space" && oneCharAfter === " ") {
  285. if (expectation === "at-least-one-space" || activeArgs.onlyOneChar || !(0, _isWhitespace["default"])(twoCharsAfter)) {
  286. return;
  287. }
  288. }
  289. activeArgs.err(messageFunc(activeArgs.errTarget ? activeArgs.errTarget : source[index]));
  290. }
  291. function rejectAfter() {
  292. var messageFunc = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : messages.rejectedAfter;
  293. var _activeArgs5 = activeArgs,
  294. source = _activeArgs5.source,
  295. index = _activeArgs5.index;
  296. var oneCharAfter = index + 1 < source.length ? source[index + 1] : "";
  297. if (isValue(oneCharAfter) && (0, _isWhitespace["default"])(oneCharAfter)) {
  298. activeArgs.err(messageFunc(activeArgs.errTarget ? activeArgs.errTarget : source[index]));
  299. }
  300. }
  301. return {
  302. before: before,
  303. beforeAllowingIndentation: beforeAllowingIndentation,
  304. after: after,
  305. afterOneOnly: afterOneOnly
  306. };
  307. }
  308. function isValue(x) {
  309. return x !== undefined && x !== null;
  310. }