jest-watch-typeahead 0.3.0 → 0.3.1

package/CHANGELOG.md

@@ -1,4 +1,10 @@
-## master
+## 0.3.1
+
+### Fixes
+
+- Helpful error message when attempting to use the package main file ([#29](https://github.com/jest-community/jest-watch-typeahead/pull/29))
+
+## 0.3.0
 
 ### Chore & Maintenance
 

package/build/file_name_pattern_prompt.js

@@ -0,0 +1,105 @@
+'use strict';
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+
+var _chalk = require('chalk');
+
+var _chalk2 = _interopRequireDefault(_chalk);
+
+var _stringLength = require('string-length');
+
+var _stringLength2 = _interopRequireDefault(_stringLength);
+
+var _jestWatcher = require('jest-watcher');
+
+var _utils = require('./lib/utils');
+
+var _pattern_mode_helpers = require('./shared/pattern_mode_helpers');
+
+var _scroll2 = require('./shared/scroll');
+
+var _scroll3 = _interopRequireDefault(_scroll2);
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+class FileNamePatternPrompt extends _jestWatcher.PatternPrompt {
+
+  constructor(pipe, prompt) {
+    super(pipe, prompt);
+    this._entityName = 'filenames';
+    this._searchSources = [];
+  }
+
+  _onChange(pattern, options) {
+    super._onChange(pattern, options);
+    this._printTypeahead(pattern, options);
+  }
+
+  _printTypeahead(pattern, options) {
+    const matchedTests = this._getMatchedTests(pattern);
+    const total = matchedTests.length;
+    const pipe = this._pipe;
+    const prompt = this._prompt;
+
+    (0, _jestWatcher.printPatternCaret)(pattern, pipe);
+
+    if (pattern) {
+      (0, _pattern_mode_helpers.printPatternMatches)(total, 'file', pipe);
+
+      const prefix = `  ${_chalk2.default.dim('\u203A')} `;
+      const padding = (0, _stringLength2.default)(prefix) + 2;
+      const width = (0, _utils.getTerminalWidth)();
+
+      var _scroll = (0, _scroll3.default)(total, options);
+
+      const start = _scroll.start,
+            end = _scroll.end,
+            index = _scroll.index;
+
+
+      prompt.setPromptLength(total);
+
+      matchedTests.slice(start, end).map(({ path, context }) => {
+        const filePath = (0, _utils.trimAndFormatPath)(padding, context.config, path, width);
+        return (0, _utils.highlight)(path, filePath, pattern, context.config.rootDir);
+      }).map((item, i) => (0, _pattern_mode_helpers.formatTypeaheadSelection)(item, i, index, prompt)).forEach(item => (0, _pattern_mode_helpers.printTypeaheadItem)(item, pipe));
+
+      if (total > end) {
+        (0, _pattern_mode_helpers.printMore)('file', pipe, total - end);
+      }
+    } else {
+      (0, _pattern_mode_helpers.printStartTyping)('filename', pipe);
+    }
+
+    (0, _jestWatcher.printRestoredPatternCaret)(pattern, this._currentUsageRows, pipe);
+  }
+
+  _getMatchedTests(pattern) {
+    let regex;
+
+    try {
+      regex = new RegExp(pattern, 'i');
+    } catch (e) {
+      regex = null;
+    }
+
+    let tests = [];
+    if (regex) {
+      this._searchSources.forEach(({ testPaths, config }) => {
+        tests = tests.concat(testPaths.filter(testPath => testPath.match(pattern)).map(path => ({
+          path,
+          context: { config }
+        })));
+      });
+    }
+
+    return tests;
+  }
+
+  updateSearchSources(searchSources) {
+    this._searchSources = searchSources;
+  }
+}
+exports.default = FileNamePatternPrompt;

package/build/file_name_plugin.js

@@ -0,0 +1,53 @@
+'use strict';
+
+var _jestWatcher = require('jest-watcher');
+
+var _file_name_pattern_prompt = require('./file_name_pattern_prompt');
+
+var _file_name_pattern_prompt2 = _interopRequireDefault(_file_name_pattern_prompt);
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+class FileNamePlugin {
+
+  constructor({
+    stdin,
+    stdout
+  }) {
+    this._stdin = stdin;
+    this._stdout = stdout;
+    this._prompt = new _jestWatcher.Prompt();
+    this._projects = [];
+  }
+
+  apply(jestHooks) {
+    jestHooks.onFileChange(({ projects }) => {
+      this._projects = projects;
+    });
+  }
+
+  onKey(key) {
+    this._prompt.put(key);
+  }
+
+  run(globalConfig, updateConfigAndRun) {
+    const p = new _file_name_pattern_prompt2.default(this._stdout, this._prompt);
+    p.updateSearchSources(this._projects);
+    return new Promise((res, rej) => {
+      p.run(value => {
+        updateConfigAndRun({ mode: 'watch', testPathPattern: value });
+        res();
+      }, rej);
+    });
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  getUsageInfo() {
+    return {
+      key: 'p',
+      prompt: 'filter by a filename regex pattern'
+    };
+  }
+}
+
+module.exports = FileNamePlugin;

package/build/index.js

@@ -0,0 +1,10 @@
+"use strict";
+
+throw new Error(`
+jest-watch-typeahead includes two watch plugins: The filename plugin and the testname plugin.
+Please configure Jest as follows:
+"watchPlugins": [
+  "jest-watch-typeahead/filename",
+  "jest-watch-typeahead/testname"
+]
+`);

package/build/shared/pattern_mode_helpers.js

@@ -0,0 +1,45 @@
+'use strict';
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.formatTypeaheadSelection = exports.printTypeaheadItem = exports.printMore = exports.printStartTyping = exports.printPatternMatches = undefined;
+
+var _chalk = require('chalk');
+
+var _chalk2 = _interopRequireDefault(_chalk);
+
+var _stripAnsi = require('strip-ansi');
+
+var _stripAnsi2 = _interopRequireDefault(_stripAnsi);
+
+var _jestWatcher = require('jest-watcher');
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const pluralize = (count, text) => count === 1 ? text : `${text}s`;
+
+const printPatternMatches = exports.printPatternMatches = (count, entity, pipe, extraText = '') => {
+  const pluralized = pluralize(count, entity);
+  const result = count ? `\n\n Pattern matches ${count} ${pluralized}` : `\n\n Pattern matches no ${pluralized}`;
+
+  pipe.write(result + extraText);
+};
+
+const printStartTyping = exports.printStartTyping = (entity, pipe) => {
+  pipe.write(`\n\n ${_chalk2.default.italic.yellow(`Start typing to filter by a ${entity} regex pattern.`)}`);
+};
+
+const printMore = exports.printMore = (entity, pipe, more) => {
+  pipe.write(`\n   ${_chalk2.default.dim(`...and ${more} more ${pluralize(more, entity)}`)}`);
+};
+
+const printTypeaheadItem = exports.printTypeaheadItem = (item, pipe) => pipe.write(`\n ${_chalk2.default.dim('\u203A')} ${item}`);
+
+const formatTypeaheadSelection = exports.formatTypeaheadSelection = (item, index, activeIndex, prompt) => {
+  if (index === activeIndex) {
+    prompt.setPromptSelection((0, _stripAnsi2.default)(item));
+    return _chalk2.default.black.bgYellow((0, _stripAnsi2.default)(item));
+  }
+  return item;
+};

package/build/shared/scroll.js

@@ -0,0 +1,30 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+
+
+const scroll = (size, { offset, max }) => {
+  let start = 0;
+  let index = Math.min(offset, size);
+
+  const halfScreen = max / 2;
+
+  if (index <= halfScreen) {
+    start = 0;
+  } else {
+    if (size >= max) {
+      start = Math.min(index - halfScreen - 1, size - max);
+    }
+    index = Math.min(index - start, size);
+  }
+
+  return {
+    end: Math.min(size, start + max),
+    index,
+    start
+  };
+};
+
+exports.default = scroll;

package/build/test_name_pattern_prompt.js

@@ -0,0 +1,91 @@
+'use strict';
+
+var _chalk = require('chalk');
+
+var _chalk2 = _interopRequireDefault(_chalk);
+
+var _jestWatcher = require('jest-watcher');
+
+var _scroll2 = require('./shared/scroll');
+
+var _scroll3 = _interopRequireDefault(_scroll2);
+
+var _utils = require('./lib/utils');
+
+var _pattern_mode_helpers = require('./shared/pattern_mode_helpers');
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+class TestNamePatternPrompt extends _jestWatcher.PatternPrompt {
+
+  constructor(pipe, prompt) {
+    super(pipe, prompt);
+    this._entityName = 'tests';
+    this._cachedTestResults = [];
+  }
+
+  _onChange(pattern, options) {
+    super._onChange(pattern, options);
+    this._printTypeahead(pattern, options);
+  }
+
+  _printTypeahead(pattern, options) {
+    const matchedTests = this._getMatchedTests(pattern);
+    const total = matchedTests.length;
+    const pipe = this._pipe;
+    const prompt = this._prompt;
+
+    (0, _jestWatcher.printPatternCaret)(pattern, pipe);
+
+    if (pattern) {
+      (0, _pattern_mode_helpers.printPatternMatches)(total, 'test', pipe, ` from ${_chalk2.default.yellow('cached')} test suites`);
+
+      const width = (0, _utils.getTerminalWidth)();
+
+      var _scroll = (0, _scroll3.default)(total, options);
+
+      const start = _scroll.start,
+            end = _scroll.end,
+            index = _scroll.index;
+
+
+      prompt.setPromptLength(total);
+
+      matchedTests.slice(start, end).map(name => (0, _utils.formatTestNameByPattern)(name, pattern, width - 4)).map((item, i) => (0, _pattern_mode_helpers.formatTypeaheadSelection)(item, i, index, prompt)).forEach(item => (0, _pattern_mode_helpers.printTypeaheadItem)(item, pipe));
+
+      if (total > end) {
+        (0, _pattern_mode_helpers.printMore)('test', pipe, total - end);
+      }
+    } else {
+      (0, _pattern_mode_helpers.printStartTyping)('test name', pipe);
+    }
+
+    (0, _jestWatcher.printRestoredPatternCaret)(pattern, this._currentUsageRows, pipe);
+  }
+
+  _getMatchedTests(pattern) {
+    let regex;
+
+    try {
+      regex = new RegExp(pattern, 'i');
+    } catch (e) {
+      return [];
+    }
+
+    const matchedTests = [];
+
+    this._cachedTestResults.forEach(({ testResults }) => testResults.forEach(({ title }) => {
+      if (regex.test(title)) {
+        matchedTests.push(title);
+      }
+    }));
+
+    return matchedTests;
+  }
+
+  updateCachedTestResults(testResults = []) {
+    this._cachedTestResults = testResults;
+  }
+}
+
+module.exports = TestNamePatternPrompt;

package/build/test_name_plugin.js

@@ -0,0 +1,53 @@
+'use strict';
+
+var _jestWatcher = require('jest-watcher');
+
+var _test_name_pattern_prompt = require('./test_name_pattern_prompt');
+
+var _test_name_pattern_prompt2 = _interopRequireDefault(_test_name_pattern_prompt);
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+class TestNamePlugin {
+
+  constructor({
+    stdin,
+    stdout
+  }) {
+    this._stdin = stdin;
+    this._stdout = stdout;
+    this._prompt = new _jestWatcher.Prompt();
+    this._testResults = [];
+  }
+
+  apply(jestHooks) {
+    jestHooks.onTestRunComplete(({ testResults }) => {
+      this._testResults = testResults;
+    });
+  }
+
+  onKey(key) {
+    this._prompt.put(key);
+  }
+
+  run(globalConfig, updateConfigAndRun) {
+    const p = new _test_name_pattern_prompt2.default(this._stdout, this._prompt);
+    p.updateCachedTestResults(this._testResults);
+    return new Promise((res, rej) => {
+      p.run(value => {
+        updateConfigAndRun({ mode: 'watch', testNamePattern: value });
+        res();
+      }, rej);
+    });
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  getUsageInfo() {
+    return {
+      key: 't',
+      prompt: 'filter by a test name regex pattern'
+    };
+  }
+}
+
+module.exports = TestNamePlugin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jest-watch-typeahead",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "main": "build/index.js",
   "author": "Rogelio Guzman <rogelioguzmanh@gmail.com>",
   "description": "Jest plugin for filtering by filename or test name",