Skip to content

add rules to prefer Error objects to be thrown and rejected #54229

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
vzaidman wants to merge 2 commits into from
Closed

add rules to prefer Error objects to be thrown and rejected #54229

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6968151
add meaningful error reported from functions (#54230)
vzaidman Oct 23, 2025
4301880
add rules to prefer Error objects to be thrown and rejected (#54229)
vzaidman Oct 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .eslintrc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ module.exports = {
// Flow handles these checks for us, so they aren't required
'no-undef': 'off',
'no-unreachable': 'off',
// Throwing from function or rejecting promises with non-error values could result in unclear error stack traces and lead to harder debugging
'prefer-promise-reject-errors': 'error',
'no-throw-literal': 'error',
},
},
{
Expand Down
58 changes: 43 additions & 15 deletions packages/react-native/Libraries/Components/AccessibilityInfo/AccessibilityInfo.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ const AccessibilityInfo = {
reject,
);
} else {
reject(null);
reject(new Error('NativeAccessibilityManagerIOS is not available'));
}
});
}
Expand All @@ -119,7 +119,11 @@ const AccessibilityInfo = {
if (NativeAccessibilityInfoAndroid?.isGrayscaleEnabled != null) {
NativeAccessibilityInfoAndroid.isGrayscaleEnabled(resolve);
} else {
reject(null);
reject(
new Error(
'NativeAccessibilityInfoAndroid.isGrayscaleEnabled is not available',
),
);
}
});
} else {
Expand All @@ -130,7 +134,7 @@ const AccessibilityInfo = {
reject,
);
} else {
reject(null);
reject(new Error('AccessibilityInfo native module is not available'));
}
});
}
Expand All @@ -150,7 +154,11 @@ const AccessibilityInfo = {
if (NativeAccessibilityInfoAndroid?.isInvertColorsEnabled != null) {
NativeAccessibilityInfoAndroid.isInvertColorsEnabled(resolve);
} else {
reject(null);
reject(
new Error(
'NativeAccessibilityInfoAndroid.isInvertColorsEnabled is not available',
),
);
}
});
} else {
Expand All @@ -161,7 +169,7 @@ const AccessibilityInfo = {
reject,
);
} else {
reject(null);
reject(new Error('AccessibilityInfo native module is not available'));
}
});
}
Expand All @@ -181,7 +189,7 @@ const AccessibilityInfo = {
if (NativeAccessibilityInfoAndroid != null) {
NativeAccessibilityInfoAndroid.isReduceMotionEnabled(resolve);
} else {
reject(null);
reject(new Error('AccessibilityInfo native module is not available'));
}
} else {
if (NativeAccessibilityManagerIOS != null) {
Expand All @@ -190,7 +198,7 @@ const AccessibilityInfo = {
reject,
);
} else {
reject(null);
reject(new Error('NativeAccessibilityManagerIOS is not available'));
}
}
});
Expand All @@ -208,7 +216,11 @@ const AccessibilityInfo = {
if (NativeAccessibilityInfoAndroid?.isHighTextContrastEnabled != null) {
NativeAccessibilityInfoAndroid.isHighTextContrastEnabled(resolve);
} else {
reject(null);
reject(
new Error(
'NativeAccessibilityInfoAndroid.isHighTextContrastEnabled is not available',
),
);
}
} else {
return Promise.resolve(false);
Expand Down Expand Up @@ -236,7 +248,11 @@ const AccessibilityInfo = {
reject,
);
} else {
reject(null);
reject(
new Error(
'NativeAccessibilityManagerIOS.getCurrentDarkerSystemColorsState is not available',
),
);
}
}
});
Expand Down Expand Up @@ -264,7 +280,11 @@ const AccessibilityInfo = {
reject,
);
} else {
reject(null);
reject(
new Error(
'NativeAccessibilityManagerIOS.getCurrentPrefersCrossFadeTransitionsState is not available',
),
);
}
}
});
Expand All @@ -289,7 +309,7 @@ const AccessibilityInfo = {
reject,
);
} else {
reject(null);
reject(new Error('NativeAccessibilityManagerIOS is not available'));
}
});
}
Expand All @@ -309,7 +329,7 @@ const AccessibilityInfo = {
if (NativeAccessibilityInfoAndroid != null) {
NativeAccessibilityInfoAndroid.isTouchExplorationEnabled(resolve);
} else {
reject(null);
reject(new Error('NativeAccessibilityInfoAndroid is not available'));
}
} else {
if (NativeAccessibilityManagerIOS != null) {
Expand All @@ -318,7 +338,7 @@ const AccessibilityInfo = {
reject,
);
} else {
reject(null);
reject(new Error('NativeAccessibilityManagerIOS is not available'));
}
}
});
Expand All @@ -343,10 +363,18 @@ const AccessibilityInfo = {
) {
NativeAccessibilityInfoAndroid.isAccessibilityServiceEnabled(resolve);
} else {
reject(null);
reject(
new Error(
'NativeAccessibilityInfoAndroid.isAccessibilityServiceEnabled is not available',
),
);
}
} else {
reject(null);
reject(
new Error(
'isAccessibilityServiceEnabled is only available on Android',
),
);
}
});
},
Expand Down
10 changes: 8 additions & 2 deletions packages/react-native/Libraries/Debugging/DebuggingOverlayRegistry.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,9 @@ class DebuggingOverlayRegistry {
instance.measure((x, y, width, height, left, top) => {
// measure can execute callback without any values provided to signal error.
if (left == null || top == null || width == null || height == null) {
reject('Unexpectedly failed to call measure on an instance.');
reject(
new Error('Unexpectedly failed to call measure on an instance.'),
);
}

resolve({
Expand Down Expand Up @@ -480,7 +482,11 @@ class DebuggingOverlayRegistry {
width == null ||
height == null
) {
reject('Unexpectedly failed to call measure on an instance.');
reject(
new Error(
'Unexpectedly failed to call measure on an instance.',
),
);
}

resolve({x: left, y: top, width, height});
Expand Down
4 changes: 3 additions & 1 deletion packages/react-native/Libraries/NativeComponent/NativeComponentRegistryUnstable.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@ export function unstable_hasComponent(name: string): boolean {
hasNativeComponent = global.__nativeComponentRegistry__hasComponent(name);
componentNameToExists.set(name, hasNativeComponent);
} else {
throw `unstable_hasComponent('${name}'): Global function is not registered`;
throw new Error(
`unstable_hasComponent('${name}'): Global function is not registered`,
);
}
}
return hasNativeComponent;
Expand Down
4 changes: 2 additions & 2 deletions packages/react-native/scripts/codegen/codegen-utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ function getCodegen() /*: $FlowFixMe */ {
RNCodegen = require('@react-native/codegen/lib/generators/RNCodegen.js');
}
if (!RNCodegen) {
throw 'RNCodegen not found.';
throw new Error('RNCodegen not found.');
}
return RNCodegen;
}
Expand All @@ -45,7 +45,7 @@ function getCombineJSToSchema() /*: $FlowFixMe */ {
combineJSToSchema = require('@react-native/codegen/lib/cli/combine/combine-js-to-schema.js');
}
if (!combineJSToSchema) {
throw 'combine-js-to-schema not found.';
throw new Error('combine-js-to-schema not found.');
}
return combineJSToSchema;
}
Expand Down
4 changes: 2 additions & 2 deletions packages/react-native/scripts/codegen/generate-artifacts-executor/utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ const codegenLog = (text /*: string */, info /*: boolean */ = false) => {
function readPkgJsonInDirectory(dir /*: string */) /*: $FlowFixMe */ {
const pkgJsonPath = path.join(dir, 'package.json');
if (!fs.existsSync(pkgJsonPath)) {
throw `[Codegen] Error: ${pkgJsonPath} does not exist.`;
throw new Error(`[Codegen] Error: ${pkgJsonPath} does not exist.`);
}
return JSON.parse(fs.readFileSync(pkgJsonPath, 'utf8'));
}
Expand Down Expand Up @@ -174,7 +174,7 @@ function findProjectRootLibraries(
}

if (typeof pkgJson.codegenConfig !== 'object') {
throw 'The "codegenConfig" field must be an Object.';
throw new Error('The "codegenConfig" field must be an Object.');
}

return extractLibrariesFromJSON(pkgJson, projectRoot);
Expand Down
2 changes: 1 addition & 1 deletion packages/rn-tester/NativeModuleExample/NativeScreenshotManager.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,5 @@ export function takeScreenshot(
if (NativeModule != null) {
return NativeModule.takeScreenshot(id, options);
}
return Promise.reject();
return Promise.reject(new Error('ScreenshotManager is not defined.'));
}
2 changes: 1 addition & 1 deletion packages/rn-tester/js/examples/ContentURLAndroid/ContentURLAndroid.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ function blobToBase64(blob: Blob) {
if (typeof result === 'string') {
resolve(result);
} else {
reject('error: incompatible types');
reject(new Error('error: incompatible types'));
}
};
reader.readAsDataURL(blob);
Expand Down
Loading