Add support for plugin config

README.md

@@ -51,6 +51,22 @@ module.exports = {
 };
 ```
 
+### Configuring your key and prompt name
+
+```js
+module.exports = {
+  watchPlugins: [
+    [
+      'jest-watch-typeahead/filename',
+      {
+        key: 'k',
+        prompt: 'do something with my custom prompt',
+      },
+    ],
+  ],
+};
+```
+
 ### Run Jest in watch mode
 
 ```bash

src/__tests__/file_name_pattern_prompt.test.js

@@ -79,3 +79,15 @@ it('can select a pattern that matches multiple files', async () => {
     testPathPattern: 'fi',
   });
 });
+
+it('can configure the key and prompt', async () => {
+  const { plugin } = pluginTester(FileNamePlugin, {
+    key: 'l',
+    prompt: 'have a custom prompt',
+  });
+
+  expect(plugin.getUsageInfo()).toEqual({
+    key: 'l',
+    prompt: 'have a custom prompt',
+  });
+});

src/__tests__/pluginTester.js

@@ -16,10 +16,10 @@ jest.mock('ansi-escapes', () => ({
   cursorTo: (x, y) => `[MOCK - cursorTo(${x}, ${y})]`,
 }));
 
-const pluginTester = Plugin => {
+const pluginTester = (Plugin, config = {}) => {
   const stdout = { columns: 80, write: jest.fn() };
   const jestHooks = new JestHook();
-  const plugin = new Plugin({ stdout });
+  const plugin = new Plugin({ stdout, config });
   plugin.apply(jestHooks.getSubscriber());
 
   const type = (...keys) => keys.forEach(key => plugin.onKey(key));

src/__tests__/test_name_pattern_prompt.test.js

@@ -80,3 +80,15 @@ it('can select a pattern that matches multiple tests', async () => {
     testNamePattern: 'fo',
   });
 });
+
+it('can configure the key and prompt', async () => {
+  const { plugin } = pluginTester(TestNamePlugin, {
+    key: 'l',
+    prompt: 'have a custom prompt',
+  });
+
+  expect(plugin.getUsageInfo()).toEqual({
+    key: 'l',
+    prompt: 'have a custom prompt',
+  });
+});

src/file_name_plugin.js

@@ -5,23 +5,35 @@ import FileNamePatternPrompt, {
   type SearchSources,
 } from './file_name_pattern_prompt';
 
+type PluginConfig = {
+  key?: string,
+  prompt?: string,
+};
+
 class FileNamePlugin {
   _stdin: stream$Readable | tty$ReadStream;
   _stdout: stream$Writable | tty$WriteStream;
   _prompt: Prompt;
   _projects: SearchSources;
+  _usageInfo: { key: string, prompt: string };
 
   constructor({
     stdin,
     stdout,
+    config = {},
   }: {
     stdin: stream$Readable | tty$ReadStream,
     stdout: stream$Writable | tty$WriteStream,
+    config: PluginConfig,
   }) {
     this._stdin = stdin;
     this._stdout = stdout;
     this._prompt = new Prompt();
     this._projects = [];
+    this._usageInfo = {
+      key: config.key || 'p',
+      prompt: config.prompt || 'filter by a filename regex pattern',
+    };
   }
 
   apply(jestHooks: Object) {
@@ -45,12 +57,8 @@ class FileNamePlugin {
     });
   }
 
-  // eslint-disable-next-line class-methods-use-this
   getUsageInfo() {
-    return {
-      key: 'p',
-      prompt: 'filter by a filename regex pattern',
-    };
+    return this._usageInfo;
   }
 }
 

src/test_name_plugin.js

@@ -5,23 +5,35 @@ import TestNamePatternPrompt, {
   type TestResult,
 } from './test_name_pattern_prompt';
 
+type PluginConfig = {
+  key?: string,
+  prompt?: string,
+};
+
 class TestNamePlugin {
   _stdin: stream$Readable | tty$ReadStream;
   _stdout: stream$Writable | tty$WriteStream;
   _prompt: Prompt;
   _testResults: Array<TestResult>;
+  _usageInfo: { key: string, prompt: string };
 
   constructor({
     stdin,
     stdout,
+    config = {},
   }: {
     stdin: stream$Readable | tty$ReadStream,
     stdout: stream$Writable | tty$WriteStream,
+    config: PluginConfig,
   }) {
     this._stdin = stdin;
     this._stdout = stdout;
     this._prompt = new Prompt();
     this._testResults = [];
+    this._usageInfo = {
+      key: config.key || 't',
+      prompt: config.prompt || 'filter by a test name regex pattern',
+    };
   }
 
   apply(jestHooks: Object) {
@@ -45,12 +57,8 @@ class TestNamePlugin {
     });
   }
 
-  // eslint-disable-next-line class-methods-use-this
   getUsageInfo() {
-    return {
-      key: 't',
-      prompt: 'filter by a test name regex pattern',
-    };
+    return this._usageInfo;
   }
 }