ci: lint TypeScript output script

Author: DimitarNestorov

.circleci/config.yml

@@ -34,19 +34,19 @@ jobs:
             yarn install --frozen-lockfile
       - save_cache:
           key: dependencies-{{ checksum "package.json" }}
-          paths: 
+          paths:
             - node_modules
       - save_cache:
           key: dependencies-docs-{{ checksum "docs/package.json" }}
-          paths: 
+          paths:
             - docs/node_modules
       - save_cache:
           key: dependencies-example-{{ checksum "example/package.json" }}
-          paths: 
+          paths:
             - example/node_modules
       - persist_to_workspace:
           root: .
-          paths: 
+          paths:
             - .
   lint:
     executor: default
@@ -65,6 +65,7 @@ jobs:
           name: Typecheck files
           command: |
             yarn typescript
+            node ./scripts/typescript-output-lint
 
   unit-tests:
     executor: default
@@ -83,7 +84,7 @@ jobs:
           path: coverage
           destination: coverage
       - save_cache:
-          paths: 
+          paths:
             - ./cache/jest
           key: jest-cache-{{ .Branch }}
 

scripts/typescript-output-lint.js

@@ -0,0 +1,113 @@
+const { promises: fs } = require('fs');
+const path = require('path');
+
+const root = path.resolve(__dirname, '..');
+const output = path.join(root, 'lib', 'typescript');
+
+/**
+ * List of React Native props not used by React Native Paper.
+ * Feel free to delete props from this list when
+ * React Native Paper has defined/uses one with the same name.
+ * This script was originally created to detect if TypeScript
+ * has exported a large union of props from ViewProps.
+ * More info: https://github.com/callstack/react-native-paper/pull/3603
+ */
+const unusedViewProps = [
+  'nativeID',
+  'accessibilityActions',
+  'accessibilityRole',
+  'accessibilityValue',
+  'onAccessibilityAction',
+  'accessibilityLabelledBy',
+  'accessibilityLiveRegion',
+  'accessibilityLanguage',
+  'accessibilityViewIsModal',
+  'onAccessibilityEscape',
+  'onAccessibilityTap',
+  'onMagicTap',
+  'accessibilityIgnoresInvertColors',
+  'hitSlop',
+  'removeClippedSubviews',
+  'collapsable',
+  'needsOffscreenAlphaCompositing',
+  'renderToHardwareTextureAndroid',
+  'shouldRasterizeIOS',
+  'isTVSelectable',
+  'hasTVPreferredFocus',
+  'tvParallaxProperties',
+  'tvParallaxShiftDistanceX',
+  'tvParallaxShiftDistanceY',
+  'tvParallaxTiltAngle',
+  'tvParallaxMagnification',
+  'onStartShouldSetResponder',
+  'onMoveShouldSetResponder',
+  'onResponderEnd',
+  'onResponderGrant',
+  'onResponderReject',
+  'onResponderMove',
+  'onResponderRelease',
+  'onResponderStart',
+  'onResponderTerminationRequest',
+  'onResponderTerminate',
+  'onStartShouldSetResponderCapture',
+  'onMoveShouldSetResponderCapture',
+  'onTouchStart',
+  'onTouchMove',
+  'onTouchEnd',
+  'onTouchCancel',
+  'onTouchEndCapture',
+  'onPointerEnter',
+  'onPointerEnterCapture',
+  'onPointerLeave',
+  'onPointerLeaveCapture',
+  'onPointerMove',
+  'onPointerMoveCapture',
+  'onPointerCancel',
+  'onPointerCancelCapture',
+  'onPointerDown',
+  'onPointerDownCapture',
+  'onPointerUp',
+  'onPointerUpCapture',
+  'onHoverIn',
+  'onHoverOut',
+  'cancelable',
+  'delayHoverIn',
+  'delayHoverOut',
+  'pressRetentionOffset',
+  'android_disableSound',
+  'android_ripple',
+  'testOnly_pressed',
+  'unstable_pressDelay',
+];
+
+async function* getFiles(directory) {
+  const entries = await fs.readdir(directory, { withFileTypes: true });
+  for (const entry of entries) {
+    const res = path.resolve(directory, entry.name);
+    if (entry.isDirectory()) {
+      yield* getFiles(res);
+    } else {
+      yield res;
+    }
+  }
+}
+
+async function main() {
+  for await (const file of getFiles(output)) {
+    const content = await fs.readFile(file);
+    for (const prop of unusedViewProps) {
+      if (content.includes(prop)) {
+        throw new Error(
+          `Found text '${prop}' in '${file}'. Please use the wrapped 'forwardRef' in 'src/utils/forwardRef.ts', export some return types, or modify 'scripts/typescript-output-lint.js'`
+        );
+      }
+    }
+  }
+
+  console.log('✅ No React Native props mentioned in TypeScript files');
+}
+
+main().catch((reason) => {
+  console.error(reason);
+  process.exit(1);
+});