@hypersolid-dev/eslint-config 1.0.0 → 3.0.0

package/dist/react-native.js

@@ -1,11 +1,23 @@
 import globals from 'globals';
-import { CODE_FILES, NUMBER_GLOBAL_RESTRICTIONS, raiseWarnings, reactConfigs } from './shared.js';
+import noSecrets from 'eslint-plugin-no-secrets';
+import reactNativeA11y from './plugins/react-native-a11y/index.js';
+import { CODE_FILES, NUMBER_GLOBAL_RESTRICTIONS, raiseWarnings, REACT_BOOLEAN_NAME_OPTIONS, reactConfigs, TEST_FILES, } from './shared.js';
+const A11Y = '@hypersolid-dev/react-native-a11y';
 // Derived instead of hardcoded: the frozen `confusing-browser-globals` list (last released 2021) misses `document`,
 // `localStorage` and `getComputedStyle`, and bans `self`, which React Native defines. `globals` is maintained,
 // so new browser APIs are picked up without editing this file.
 // Globals Hermes provides that `globals['react-native']` does not list yet; remove a name once `globals` adds it.
 const HERMES_GLOBALS = new Set(['atob', 'btoa', 'TextEncoder']);
 const BROWSER_GLOBALS = Object.keys(globals.browser).filter((name) => !(name in globals['react-native']) && !HERMES_GLOBALS.has(name));
+// High-entropy strings in Expo and native config that are identifiers, not credentials.
+const NO_SECRETS_IGNORE = [
+    '^android\\.settings\\.', // Android intent actions
+    '^EXPO_', // env var names
+    '^@xml', // Android resource references
+    '^NSPrivacy[A-Za-z]+$', // iOS privacy manifest keys
+    '^[A-Z][A-Za-z0-9]*\\/[A-Z][A-Za-z0-9]*$', // i18n `Namespace/Key` paths
+    '^data:', // Lottie and embedded images
+];
 export default function reactNative() {
     return raiseWarnings([
         {
@@ -16,6 +28,7 @@ export default function reactNative() {
         {
             name: '@hypersolid-dev/react-native',
             files: CODE_FILES,
+            plugins: { 'no-secrets': noSecrets },
             rules: {
                 // Browser globals React Native lacks, and the coercing number globals. Bad: `document.title`, `isNaN(value)`.
                 'no-restricted-globals': [
@@ -48,6 +61,77 @@ export default function reactNative() {
                 'unicorn/prefer-event-target': 'off',
                 // Metro emits CommonJS, so top-level await does not bundle. Bad: `await init();` at module scope.
                 'unicorn/prefer-top-level-await': 'off',
+                // A boolean reads as a claim; Reanimated's `SharedValue<boolean>` is read through `.value`. Bad: `const visible = useSharedValue(true)`.
+                'unicorn/consistent-boolean-name': [
+                    'error',
+                    { ...REACT_BOOLEAN_NAME_OPTIONS, wrappers: { SharedValue: 'value' } },
+                ],
+                // High-entropy strings that look like credentials, minus Expo and native identifiers. Bad: `const token = 'ghp_Zx8kQ2vLm9…'`.
+                'no-secrets/no-secrets': ['error', { ignoreContent: NO_SECRETS_IGNORE }],
+            },
+        },
+        {
+            name: '@hypersolid-dev/react-native/json',
+            files: ['**/*.json'],
+            plugins: { 'no-secrets': noSecrets },
+            rules: {
+                // Credentials in JSON, minus letters-only words and Expo and native identifiers. Bad: `{ "token": "ghp_Zx8kQ2vLm9…" }`.
+                'no-secrets/no-secrets': ['error', { ignoreContent: ['^[A-Za-z]+$', ...NO_SECRETS_IGNORE] }],
+            },
+        },
+        {
+            name: '@hypersolid-dev/react-native/tests',
+            files: TEST_FILES,
+            rules: {
+                // Off: tests stub browser globals. Bad: `document.title = 'x'` in a jsdom test reported.
+                'no-restricted-globals': 'off',
+            },
+        },
+        {
+            // React Native accessibility, each rule citing its WCAG criterion. Docs: src/plugins/react-native-a11y/docs.
+            name: '@hypersolid-dev/react-native/a11y',
+            files: CODE_FILES,
+            plugins: { [A11Y]: reactNativeA11y },
+            rules: {
+                // Custom accessibility actions need an `onAccessibilityAction`. Bad: `<ListItem accessibilityActions={[{ name: 'delete' }]} />`.
+                [`${A11Y}/accessibility-actions-need-handler`]: 'error',
+                // A hint describes the outcome, never the only name. Bad: `<TouchableOpacity accessibilityHint="Go to the next page"><Icon /></TouchableOpacity>`.
+                [`${A11Y}/accessibility-hint`]: 'error',
+                // Controls without visible text need a label, and a label contains any visible text. Bad: `<Pressable onPress={onPress}><Icon /></Pressable>`.
+                [`${A11Y}/accessibility-label`]: 'error',
+                // Interactive elements declare a role. Bad: `<Pressable onPress={onPress} />`.
+                [`${A11Y}/accessibility-role`]: 'error',
+                // A numeric `accessibilityValue` needs `min` and `max`. Bad: `<View accessibilityRole="adjustable" accessibilityValue={{ now: 5 }} />`.
+                [`${A11Y}/accessibility-value-needs-range`]: 'error',
+                // An adjustable element announces its value. Bad: `<View accessibilityRole="adjustable" />`.
+                [`${A11Y}/adjustable-needs-value`]: 'error',
+                // `announceForAccessibility` next to an Android live region needs a `Platform.OS` check, or TalkBack hears it twice. Bad: an unguarded `AccessibilityInfo.announceForAccessibility(message)` in a file with `accessibilityLiveRegion`.
+                [`${A11Y}/gate-announce-for-accessibility`]: 'error',
+                // Inputs declare their autofill purpose with `autoComplete`, which covers both platforms. Bad: `<TextInput textContentType="emailAddress" />`.
+                [`${A11Y}/input-purpose`]: 'error',
+                // Don't set both the ARIA and the legacy spelling of a prop. Bad: `<Pressable role="button" accessibilityRole="button" />`.
+                [`${A11Y}/no-aria-legacy-mix`]: 'error',
+                // `setAccessibilityFocus` is deprecated in favour of `sendAccessibilityEvent`. Bad: `AccessibilityInfo.setAccessibilityFocus(findNodeHandle(ref.current))`.
+                [`${A11Y}/no-deprecated-accessibility-focus`]: 'error',
+                // `Text` silently drops some ARIA props. Bad: `<Text aria-live="polite">{status}</Text>`.
+                [`${A11Y}/no-dropped-aria-on-text`]: 'error',
+                // Text keeps scaling with the user's font size. Bad: `allowFontScaling={false}` on a `Text`.
+                [`${A11Y}/no-font-scaling-disabled`]: 'error',
+                // Accessibility props on an element that never becomes an accessibility element do nothing. Bad: `<View role="listitem" />`.
+                [`${A11Y}/no-ineffective-accessibility-props`]: 'error',
+                // A state object built outside the JSX holds only supported keys. Bad: `const state = { invalid: true }; <Pressable accessibilityState={state} />`.
+                [`${A11Y}/no-invalid-accessibility-state`]: 'error',
+                // A focus stop inside another one is unreachable for screen readers. Bad: `<View accessible accessibilityLabel="Card"><Pressable accessibilityLabel="Save" /></View>`.
+                [`${A11Y}/no-nested-focus-stops`]: 'error',
+                // Activate on release so a press can be cancelled. Bad: `<Pressable accessibilityLabel="Save" onPressIn={submit} />`.
+                [`${A11Y}/no-press-in-activation`]: 'error',
+                // An element made accessible needs a name. Bad: `<View accessible accessibilityRole="button" />`.
+                [`${A11Y}/no-unnamed-interactive`]: 'error',
+                // Images opt out of iOS Smart Invert or render as a negative. Bad: `<Image source={source} accessibilityLabel="A cat" />`.
+                [`${A11Y}/require-invert-colors-opt-out`]: 'error',
+                // Off: a sheet is whatever a project calls one, so the rule has no defaults. Enable it with the project's sheet components:
+                // `['error', { additionalComponents: ['BottomSheet'] }]`. Bad then: `<BottomSheet><Text>Body</Text></BottomSheet>`.
+                [`${A11Y}/require-modal-a11y-on-sheets`]: 'off',
             },
         },
     ]);

package/dist/shared.d.ts

@@ -1,5 +1,13 @@
 import type { Linter } from 'eslint';
 export declare const CODE_FILES: string[];
+export declare const TEST_FILES: string[];
+export declare const BOOLEAN_NAME_OPTIONS: {
+    checkFunctions: string;
+};
+export declare const REACT_BOOLEAN_NAME_OPTIONS: {
+    ignore: string[];
+    checkFunctions: string;
+};
 export declare const NUMBER_GLOBAL_RESTRICTIONS: {
     name: string;
     message: string;

package/dist/shared.js

@@ -1,7 +1,18 @@
 import eslintReact from '@eslint-react/eslint-plugin';
 import reactHooks from 'eslint-plugin-react-hooks';
+import unicorn from 'eslint-plugin-unicorn';
 import hypersolid from './plugins/props-destructuring.js';
 export const CODE_FILES = ['**/*.{js,mjs,cjs,jsx,ts,mts,cts,tsx}'];
+// Tests, stories, mocks and test setup: each preset relaxes a few rules here that test doubles break by design.
+export const TEST_FILES = [
+    '**/*.{test,spec,stories}.{js,mjs,cjs,jsx,ts,mts,cts,tsx}',
+    '**/__mocks__/**',
+    '**/{jest,vitest}.setup.*',
+];
+// `unicorn/consistent-boolean-name` options per preset; a later config replaces options, so each preset states them all.
+export const BOOLEAN_NAME_OPTIONS = { checkFunctions: 'never' };
+// Hooks (`useIsOpen`) and jest mock factories (`mockIsReady`) are named by convention, not as claims.
+export const REACT_BOOLEAN_NAME_OPTIONS = { ...BOOLEAN_NAME_OPTIONS, ignore: ['^use[A-Z]', '^mock'] };
 // Shared by every preset that sets `no-restricted-globals`: a later config replaces the rule's options, not merges them.
 export const NUMBER_GLOBAL_RESTRICTIONS = ['isFinite', 'isNaN'].map((name) => ({
     name,
@@ -39,7 +50,7 @@ export function reactConfigs() {
         {
             name: '@hypersolid-dev/react',
             files: CODE_FILES,
-            plugins: { '@hypersolid-dev': hypersolid },
+            plugins: { '@hypersolid-dev': hypersolid, unicorn },
             languageOptions: { parserOptions: { ecmaFeatures: { jsx: true } } },
             rules: {
                 // Off: react-hooks/exhaustive-deps reports it. Bad: `useEffect(() => log(id), [])` reported twice.
@@ -72,6 +83,16 @@ export function reactConfigs() {
                 '@eslint-react/no-unstable-context-value': 'error',
                 // Props are readable from the component's signature; a union props type may keep `props`. Bad: `const Card = (props: Props) => <h1>{props.title}</h1>`.
                 '@hypersolid-dev/props-destructuring': 'error',
+                // A boolean reads as a claim; hook and mock names are exempt. Bad: `const visible = true` (use `isVisible`).
+                'unicorn/consistent-boolean-name': ['error', REACT_BOOLEAN_NAME_OPTIONS],
+            },
+        },
+        {
+            name: '@hypersolid-dev/react/tests',
+            files: TEST_FILES,
+            rules: {
+                // Off: a mocked hook keeps the `use` name of the hook it replaces. Bad: `const useUser = () => fakeUser` in a mock.
+                '@eslint-react/no-unnecessary-use-prefix': 'off',
             },
         },
     ];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hypersolid-dev/eslint-config",
-  "version": "1.0.0",
+  "version": "3.0.0",
   "description": "Shared ESLint flat config for Hypersolid TypeScript projects",
   "license": "MIT",
   "keywords": [
@@ -48,7 +48,7 @@
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
     "lint": "pnpm build && eslint .",
-    "test": "pnpm build && node --test 'test/*.test.ts'",
+    "test": "pnpm build && node --test 'test/*.test.ts' 'test/rules/**/*.test.ts'",
     "prepublishOnly": "pnpm test"
   },
   "peerDependencies": {
@@ -70,6 +70,8 @@
     "@eslint/js": "^10.0.1",
     "@eslint/json": "^2.1.1",
     "@next/eslint-plugin-next": "^16.4.3",
+    "@typescript-eslint/types": "^8.72.1",
+    "@typescript-eslint/utils": "^8.72.1",
     "eslint-import-resolver-typescript": "^4.4.5",
     "eslint-plugin-import-x": "^4.17.1",
     "eslint-plugin-jsx-a11y": "^6.10.2",