chore: migrate jest-validate to TypeScript #7991

SimenB · 2019-02-26T12:17:06Z

Summary

This is not good enough for external consumers of jest-validate, but it works for our internal usage, which is better than nothing 🙂 Help making it better is greatly appreciated!

Built diff:

diff --git c/packages/jest-validate/build/condition.js w/packages/jest-validate/build/condition.js
index e9ae48a46..0cd6b4aca 100644
--- c/packages/jest-validate/build/condition.js
+++ w/packages/jest-validate/build/condition.js
@@ -12,8 +12,6 @@ exports.multipleValidOptions = multipleValidOptions;
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- *
  */
 const toString = Object.prototype.toString;
 const MULTIPLE_VALID_OPTIONS_SYMBOL = Symbol('JEST_MULTIPLE_VALID_OPTIONS');
@@ -29,7 +27,7 @@ function validationConditionSingle(option, validOption) {
 
 function getValues(validOption) {
   if (
-    Array.isArray(validOption) &&
+    Array.isArray(validOption) && // @ts-ignore
     validOption[MULTIPLE_VALID_OPTIONS_SYMBOL]
   ) {
     return validOption;
@@ -40,10 +38,11 @@ function getValues(validOption) {
 
 function validationCondition(option, validOption) {
   return getValues(validOption).some(e => validationConditionSingle(option, e));
-}
+} // TODO: This should infer the types of its arguments, and return a union type of the types
+// See https://github.com/Microsoft/TypeScript/issues/5453
 
 function multipleValidOptions(...args) {
-  const options = [...args]; // $FlowFixMe
+  const options = [...args]; // @ts-ignore
 
   options[MULTIPLE_VALID_OPTIONS_SYMBOL] = true;
   return options;
diff --git c/packages/jest-validate/build/defaultConfig.js w/packages/jest-validate/build/defaultConfig.js
index 8cae136e7..7700033b8 100644
--- c/packages/jest-validate/build/defaultConfig.js
+++ w/packages/jest-validate/build/defaultConfig.js
@@ -20,10 +20,8 @@ var _utils = require('./utils');
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- *
  */
-var _default = {
+const validationOptions = {
   comment: '',
   condition: _condition.validationCondition,
   deprecate: _deprecated.deprecationWarning,
@@ -40,4 +38,5 @@ var _default = {
   },
   unknown: _warnings.unknownOptionWarning
 };
+var _default = validationOptions;
 exports.default = _default;
diff --git c/packages/jest-validate/build/deprecated.js w/packages/jest-validate/build/deprecated.js
index 437530f3d..08be871ed 100644
--- c/packages/jest-validate/build/deprecated.js
+++ w/packages/jest-validate/build/deprecated.js
@@ -12,8 +12,6 @@ var _utils = require('./utils');
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- *
  */
 const deprecationMessage = (message, options) => {
   const comment = options.comment;
diff --git c/packages/jest-validate/build/errors.js w/packages/jest-validate/build/errors.js
index 1996cf8cf..03851fa81 100644
--- c/packages/jest-validate/build/errors.js
+++ w/packages/jest-validate/build/errors.js
@@ -38,8 +38,6 @@ function _interopRequireDefault(obj) {
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- *
  */
 const errorMessage = (option, received, defaultValue, options, path) => {
   const conditions = (0, _condition.getValues)(defaultValue);
diff --git c/packages/jest-validate/build/exampleConfig.js w/packages/jest-validate/build/exampleConfig.js
index 09c3b796b..c4eda4d06 100644
--- c/packages/jest-validate/build/exampleConfig.js
+++ w/packages/jest-validate/build/exampleConfig.js
@@ -10,17 +10,15 @@ exports.default = void 0;
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- *
  */
 const config = {
   comment: '  A comment',
-  condition: (option, validOption) => true,
-  deprecate: (config, option, deprecatedOptions, options) => false,
+  condition: () => true,
+  deprecate: () => false,
   deprecatedConfig: {
-    key: config => {}
+    key: () => {}
   },
-  error: (option, received, defaultValue, options) => {},
+  error: () => {},
   exampleConfig: {
     key: 'value',
     test: 'case'
@@ -32,7 +30,7 @@ const config = {
     error: 'Validation Error',
     warning: 'Validation Warning'
   },
-  unknown: (config, option, options) => {}
+  unknown: () => {}
 };
 var _default = config;
 exports.default = _default;
diff --git c/packages/jest-validate/build/index.js w/packages/jest-validate/build/index.js
index a1ee651fd..b0a84cb45 100644
--- c/packages/jest-validate/build/index.js
+++ w/packages/jest-validate/build/index.js
@@ -19,8 +19,6 @@ function _interopRequireDefault(obj) {
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- *
  */
 module.exports = {
   ValidationError: _utils.ValidationError,
diff --git c/packages/jest-validate/build/utils.js w/packages/jest-validate/build/utils.js
index 5997be60d..a5b102fd9 100644
--- c/packages/jest-validate/build/utils.js
+++ w/packages/jest-validate/build/utils.js
@@ -44,8 +44,6 @@ function _interopRequireDefault(obj) {
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- *
  */
 const BULLET = _chalk().default.bold('\u25cf');
 
diff --git c/packages/jest-validate/build/validate.js w/packages/jest-validate/build/validate.js
index ad903f6ce..553f6445d 100644
--- c/packages/jest-validate/build/validate.js
+++ w/packages/jest-validate/build/validate.js
@@ -73,7 +73,7 @@ const _validate = (config, exampleConfig, options, path = []) => {
         options
       );
       hasDeprecationWarnings = hasDeprecationWarnings || isDeprecatedKey;
-    } else if (hasOwnProperty.call(exampleConfig, key)) {
+    } else if (Object.hasOwnProperty.call(exampleConfig, key)) {
       if (
         typeof options.condition === 'function' &&
         typeof options.error === 'function' &&
@@ -108,10 +108,10 @@ const _validate = (config, exampleConfig, options, path = []) => {
 const validate = (config, options) => {
   hasDeprecationWarnings = false; // Preserve default blacklist entries even with user-supplied blacklist
 
-  const combinedBlacklist = [].concat(
-    _defaultConfig.default.recursiveBlacklist || [],
-    options.recursiveBlacklist || []
-  );
+  const combinedBlacklist = [
+    ...(_defaultConfig.default.recursiveBlacklist || []),
+    ...(options.recursiveBlacklist || [])
+  ];
   const defaultedOptions = Object.assign(
     _objectSpread({}, _defaultConfig.default, options, {
       recursiveBlacklist: combinedBlacklist,
diff --git c/packages/jest-validate/build/validateCLIOptions.js w/packages/jest-validate/build/validateCLIOptions.js
index 761a24cd3..236f69069 100644
--- c/packages/jest-validate/build/validateCLIOptions.js
+++ w/packages/jest-validate/build/validateCLIOptions.js
@@ -139,9 +139,10 @@ function validateCLIOptions(argv, options, rawArgv = []) {
     (acc, entry) => {
       if (options[entry]) {
         acc[entry] = deprecationEntries[entry];
+        const alias = options[entry].alias;
 
-        if (options[entry].alias) {
-          acc[options[entry].alias] = deprecationEntries[entry];
+        if (alias) {
+          acc[alias] = deprecationEntries[entry];
         }
       }
 
diff --git c/packages/jest-validate/build/warnings.js w/packages/jest-validate/build/warnings.js
index 26f445057..d69f7f296 100644
--- c/packages/jest-validate/build/warnings.js
+++ w/packages/jest-validate/build/warnings.js
@@ -26,8 +26,6 @@ function _interopRequireDefault(obj) {
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- *
  */
 const unknownOptionWarning = (config, exampleConfig, option, options, path) => {
   const didYouMean = (0, _utils.createDidYouMeanMessage)(

Test plan

Green CI

SimenB · 2019-02-28T21:53:19Z

packages/jest-config/src/ValidConfig.ts

 import {multipleValidOptions} from 'jest-validate';
 import {NODE_MODULES} from './constants';

 const NODE_MODULES_REGEXP = replacePathSepForRegex(NODE_MODULES);

 const initialOptions: Config.InitialOptions = {
  automock: false,
+  // @ts-ignore TODO: type this properly


@jeysal do you know how to type this? Essentially, the return-type should be one a union of the types of all arguments

Not sure I understand, wouldn't that typing be a lie? multipleValidOptions doesn't return one of the argument (in that case the return type would be the union of them), but an array of all of them.

thymikee · 2019-02-28T21:57:05Z

packages/jest-repl/src/cli/index.ts


-  // @ts-ignore: not the same arguments
+  // @ts-ignore: fix this at some point
  validateCLIOptions(argv, {...args.options, deprecationEntries});


This error here is nuts, I gave up :p

github-actions · 2021-05-11T23:07:15Z

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.

SimenB requested a review from thymikee February 26, 2019 12:17

facebook-github-bot added the cla signed label Feb 26, 2019

SimenB added this to the TypeScript Migration milestone Feb 26, 2019

SimenB mentioned this pull request Feb 26, 2019

☂️TypeScript migration tracking issue #7807

Closed

SimenB force-pushed the ts-jest-validate branch 2 times, most recently from 6624022 to 1cbc3fd Compare February 27, 2019 17:45

chore: migrate jest-validate to TypeScript

55e7ed8

SimenB force-pushed the ts-jest-validate branch from 1cbc3fd to 55e7ed8 Compare February 28, 2019 19:26

SimenB commented Feb 28, 2019

View reviewed changes

type yargs a bit

f84fe87

thymikee approved these changes Feb 28, 2019

View reviewed changes

thymikee reviewed Feb 28, 2019

View reviewed changes

SimenB merged commit 52224ba into jestjs:master Feb 28, 2019

SimenB deleted the ts-jest-validate branch February 28, 2019 22:35

snyk-bot mentioned this pull request Dec 15, 2019

[Snyk] Upgrade babel-jest from 24.0.0 to 24.9.0 jakeherp/burger-builder#14

Open

This was referenced Mar 21, 2020

[Snyk] Upgrade: jest, jest-cli lwojcik/sc2pte-panel-frontend#88

Closed

[Snyk] Upgrade jest from 24.0.0 to 24.9.0 DavidKindler/burger-builder#47

Merged

github-actions bot locked as resolved and limited conversation to collaborators May 11, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: migrate jest-validate to TypeScript #7991

chore: migrate jest-validate to TypeScript #7991

SimenB commented Feb 26, 2019

SimenB Feb 28, 2019

jeysal Feb 28, 2019

thymikee Feb 28, 2019

github-actions bot commented May 11, 2021

chore: migrate jest-validate to TypeScript #7991

chore: migrate jest-validate to TypeScript #7991

Conversation

SimenB commented Feb 26, 2019

Summary

Test plan

SimenB Feb 28, 2019

Choose a reason for hiding this comment

jeysal Feb 28, 2019

Choose a reason for hiding this comment

thymikee Feb 28, 2019

Choose a reason for hiding this comment

github-actions bot commented May 11, 2021