Add ts-prune (#4772)

<!-- Thanks for submitting a pull request! We appreciate you spending
the time to work on these changes. Please follow the template so that
the reviewers can easily understand what the code changes affect. -->

## Summary

* Ts-prune allows us to detect unused typescript code. 
* Advantages:
* We can remove exports of all the functions and interfaces exported for
no reason. This makes importing with cmd+enter shortcut easier, since
you are less likely to get wrong suggestions from vscode.
* We can see all the “forgotten” areas of code, and think about reasons
to have them.
<!-- Explain the motivation for this PR. Include "Fixes #<number>" if
applicable. -->

> **Note**
>I've removed the file `MapperRegistry.ts` which seems unnecessary since
this PR:
[#3722](#3722)


## Test plan

Just CI
<!-- Provide a minimal but complete code snippet that can be used to
test out this change along with instructions how to run it and a
description of the expected behavior. -->

---------

Co-authored-by: Aleksandra Cynk <aleksandracynk@swmansion.com>

.github/workflows/static-root-checks.yml

@@ -27,7 +27,6 @@ jobs:
           cache: 'yarn'
       - name: Clear annotations
         run: scripts/clear-annotations.sh
-
       - name: Install node dependencies
         run: yarn
       - name: Check types
@@ -36,7 +35,9 @@ jobs:
         run: yarn type:check-api
       - name: Lint
         run: yarn lint:js
-      - name: Finding circular dependencies
+      - name: Find unused code
+        run: yarn find-unused-code:js
+      - name: Find circular dependencies
         run: yarn circular_dependency_check
-      - name: Jest test:unit
+      - name: Run jest unit tests
         run: yarn test:unit

package.json

@@ -20,6 +20,7 @@
     "format:ios": "find ios/ -iname *.h -o -iname *.m -o -iname *.mm -o -iname *.cpp | xargs clang-format -i --Werror",
     "format:android": "find android/src/ -iname *.h -o -iname *.cpp | xargs clang-format -i",
     "format:common": "find Common/ -iname *.h -o -iname *.cpp | xargs clang-format -i",
+    "find-unused-code:js": "yarn ts-prune --ignore \"index|.web.\" --error  ",
     "type:check": "yarn tsc --noEmit && cd plugin && yarn type:check && cd ..",
     "type:check-api": "yarn tsc --noEmit --target es6 --module ESNext --jsx react-native --skipLibCheck true --allowSyntheticDefaultImports true --moduleResolution node --esModuleInterop true --strict true --forceConsistentCasingInFileNames true --resolveJsonModule true app/src/App.tsx",
     "prepare": "yarn plugin && bob build && husky install && yarn app",
@@ -147,6 +148,7 @@
     "react-native-web": "~0.18.12",
     "react-test-renderer": "17.0.2",
     "shelljs": "^0.8.5",
+    "ts-prune": "^0.10.3",
     "typescript": "^4.1.3"
   },
   "lint-staged": {

src/createAnimatedComponent.tsx

@@ -214,7 +214,7 @@ interface AnimatedProps extends Record<string, unknown> {
   initial?: SharedValue<StyleProps>;
 }
 
-export type AnimatedComponentProps<P extends Record<string, unknown>> = P & {
+type AnimatedComponentProps<P extends Record<string, unknown>> = P & {
   forwardedRef?: Ref<Component>;
   style?: NestedArray<StyleProps>;
   animatedProps?: Partial<AnimatedComponentProps<AnimatedProps>>;
@@ -247,7 +247,7 @@ interface ComponentRef extends Component {
   getAnimatableRef?: () => ComponentRef;
 }
 
-export interface InitialComponentProps extends Record<string, unknown> {
+interface InitialComponentProps extends Record<string, unknown> {
   ref?: Ref<Component>;
   collapsable?: boolean;
 }

src/reanimated2/UpdateProps.ts

@@ -10,7 +10,7 @@ import type { ViewRefSet } from './ViewDescriptorsSet';
 import { runOnUIImmediately } from './threads';
 
 // copied from react-native/Libraries/Components/View/ReactNativeStyleAttributes
-export const colorProps = [
+const colorProps = [
   'backgroundColor',
   'borderBottomColor',
   'borderColor',
@@ -29,7 +29,7 @@ export const colorProps = [
 
 export const ColorProperties = makeShareable(colorProps);
 
-export let updateProps: (
+let updateProps: (
   viewDescriptor: SharedValue<Descriptor[]>,
   updates: StyleProps | AnimatedStyle<any>,
   maybeViewRef: ViewRefSet<any> | undefined

src/reanimated2/animation/decay.ts

@@ -34,7 +34,7 @@ export interface DecayAnimation extends Animation<DecayAnimation> {
   current: AnimatableValue;
 }
 
-export interface InnerDecayAnimation
+interface InnerDecayAnimation
   extends Omit<DecayAnimation, 'current'>,
     AnimationObject {
   current: number;

src/reanimated2/animation/styleAnimation.ts

@@ -15,7 +15,7 @@ import { processColor } from '../Colors';
 
 // resolves path to value for nested objects
 // if path cannot be resolved returns undefined
-export function resolvePath<T>(
+function resolvePath<T>(
   obj: NestedObject<T>,
   path: AnimatableValue[] | AnimatableValue
 ): NestedObjectValues<T> | undefined {
@@ -39,7 +39,7 @@ export function resolvePath<T>(
 
 // set value at given path
 type Path = Array<string | number> | string | number;
-export function setPath<T>(
+function setPath<T>(
   obj: NestedObject<T>,
   path: Path,
   value: NestedObjectValues<T>

src/reanimated2/animation/timing.ts

@@ -25,7 +25,7 @@ export interface TimingAnimation extends Animation<TimingAnimation> {
   current: AnimatableValue;
 }
 
-export interface InnerTimingAnimation
+interface InnerTimingAnimation
   extends Omit<TimingAnimation, 'toValue' | 'current'> {
   toValue: number;
   current: number;

src/reanimated2/animation/transformationMatrix/matrixUtils.tsx

@@ -11,7 +11,7 @@ export type AffineMatrix = FixedLengthArray<FixedLengthArray<number, 4>, 4>;
 
 export type AffineMatrixFlat = FixedLengthArray<number, 16>;
 
-export type TransformMatrixDecomposition = Record<
+type TransformMatrixDecomposition = Record<
   'translationMatrix' | 'scaleMatrix' | 'rotationMatrix' | 'skewMatrix',
   AffineMatrix
 >;

src/reanimated2/animation/util.ts

@@ -1,8 +1,4 @@
-import type {
-  HigherOrderAnimation,
-  NextAnimation,
-  StyleLayoutAnimation,
-} from './commonTypes';
+import type { HigherOrderAnimation, StyleLayoutAnimation } from './commonTypes';
 import type { ParsedColorArray } from '../Colors';
 import {
   isColor,
@@ -11,9 +7,7 @@ import {
   toGammaSpace,
   toLinearSpace,
 } from '../Colors';
-
 import type {
-  AnimatedStyle,
   SharedValue,
   AnimatableValue,
   Animation,
@@ -37,8 +31,6 @@ import {
 
 let IN_STYLE_UPDATER = false;
 
-export type UserUpdater = () => AnimatedStyle;
-
 export function initialUpdaterRun<T>(updater: () => T): T {
   IN_STYLE_UPDATER = true;
   const result = updater();
@@ -449,19 +441,3 @@ export function cancelAnimation<T>(sharedValue: SharedValue<T>): void {
   // setting the current value cancels the animation if one is currently running
   sharedValue.value = sharedValue.value; // eslint-disable-line no-self-assign
 }
-
-// TODO it should work only if there was no animation before.
-export function withStartValue(
-  startValue: AnimatableValue,
-  animation: NextAnimation<AnimationObject>
-): Animation<AnimationObject> {
-  'worklet';
-  return defineAnimation(startValue, () => {
-    'worklet';
-    if (!_WORKLET && typeof animation === 'function') {
-      animation = animation();
-    }
-    (animation as Animation<AnimationObject>).current = startValue;
-    return animation as Animation<AnimationObject>;
-  });
-}

src/reanimated2/component/FlatList.tsx

@@ -50,7 +50,7 @@ declare class ReanimatedFlatListClass<T> extends Component<
   getNode(): FlatList;
 }
 
-export interface ReanimatedFlatListProps<ItemT> extends FlatListProps<ItemT> {
+interface ReanimatedFlatListProps<ItemT> extends FlatListProps<ItemT> {
   itemLayoutAnimation?: ILayoutAnimationBuilder;
 }
 

src/reanimated2/helperTypes.ts

@@ -132,6 +132,7 @@ export type AnimateProps<P extends object> = NonStyleAnimatedProps<P> &
     animatedProps?: Partial<AnimatedPropsProp<P>>;
   };
 
+// ts-prune-ignore-next This will be used soon
 export type AnimatedProps<P extends object> = AnimateProps<P>;
 
 export type AnimatedPropsAdapterFunction = (

src/reanimated2/hook/useAnimatedGestureHandler.ts

@@ -16,7 +16,7 @@ export interface GestureHandlers<T, TContext extends Context> {
   onFinish?: Handler<T, TContext>;
 }
 
-export const EventType = {
+const EventType = {
   UNDETERMINED: 0,
   FAILED: 1,
   BEGAN: 2,
@@ -25,7 +25,7 @@ export const EventType = {
   END: 5,
 };
 
-export interface GestureHandlerNativeEvent {
+interface GestureHandlerNativeEvent {
   handlerTag: number;
   numberOfPointers: number;
   state: (typeof EventType)[keyof typeof EventType];

src/reanimated2/hook/utils.ts

@@ -1,6 +1,5 @@
 import type { MutableRefObject } from 'react';
 import { useEffect, useRef } from 'react';
-import { processColor } from '../Colors';
 import type {
   Context,
   NativeEvent,
@@ -11,7 +10,6 @@ import type {
 import type { AnimatedStyle } from '../helperTypes';
 import { makeRemote } from '../core';
 import { isWeb, isJest } from '../PlatformChecker';
-import { colorProps } from '../UpdateProps';
 import WorkletEventHandler from '../WorkletEventHandler';
 import type { ContextWithDependencies, DependencyList } from './commonTypes';
 import type { NativeSyntheticEvent } from 'react-native';
@@ -23,7 +21,7 @@ interface Handlers<T, TContext extends Context> {
   [key: string]: Handler<T, TContext> | undefined;
 }
 
-export interface UseHandlerContext<TContext extends Context> {
+interface UseHandlerContext<TContext extends Context> {
   context: TContext;
   doDependenciesDiffer: boolean;
   useWeb: boolean;
@@ -104,7 +102,7 @@ export function buildWorkletsHash(
 }
 
 // builds dependencies array for gesture handlers
-export function buildDependencies(
+function buildDependencies(
   dependencies: DependencyList,
   handlers: Record<string, WorkletFunction | undefined>
 ): Array<unknown> {
@@ -126,7 +124,7 @@ export function buildDependencies(
 }
 
 // this is supposed to work as useEffect comparison
-export function areDependenciesEqual(
+function areDependenciesEqual(
   nextDeps: DependencyList,
   prevDeps: DependencyList
 ): boolean {
@@ -156,30 +154,6 @@ export function areDependenciesEqual(
   return areHookInputsEqual(nextDeps, prevDeps);
 }
 
-export function hasColorProps(updates: AnimatedStyle): boolean {
-  const colorPropsSet = new Set(colorProps);
-  for (const key in updates) {
-    if (colorPropsSet.has(key)) {
-      return true;
-    }
-  }
-  return false;
-}
-
-export function parseColors(updates: AnimatedStyle): void {
-  'worklet';
-  for (const key in updates) {
-    if (colorProps.indexOf(key) !== -1) {
-      // value could be an animation in which case processColor will recognize it and will return undefined
-      // -> in such a case we don't want to override style of that key
-      const processedColor = processColor(updates[key]);
-      if (processedColor !== undefined) {
-        updates[key] = processedColor;
-      }
-    }
-  }
-}
-
 export function isAnimated(prop: NestedObjectValues<AnimationObject>): boolean {
   'worklet';
   if (Array.isArray(prop)) {