Merge branch 'main' of github.com:software-mansion/react-native-gesture-handler into @relextm19/docs-examples

Author: relextm19

.eslintrc.json

@@ -43,6 +43,8 @@
     "@typescript-eslint/no-unsafe-return": "warn",
     "@typescript-eslint/no-non-null-assertion": "warn",
     "@typescript-eslint/ban-types": "warn",
+    "@typescript-eslint/consistent-type-imports": "error",
+    "@typescript-eslint/consistent-type-exports": "error",
 
     // common
     "@typescript-eslint/explicit-module-boundary-types": "off",
@@ -85,6 +87,7 @@
     ],
     "curly": "error",
     "spaced-comment": "error",
-    "no-alert": "warn"
+    "no-alert": "warn",
+    "sort-imports": "error"
   }
 }

AGENTS.md

@@ -0,0 +1,39 @@
+# react-native-gesture-handler library
+
+## Project structure
+
+- This project has monorepo structure.
+- It contains both, library (`/packages/react-native-gesture-handler`) and documentation (/packages/docs-gesture-handler).
+- It is multiplatform. Library supports android, iOS, web and macos.
+- Android codebase is located in `/packages/react-native-gesture-handler/android` directory. iOS and macos in `/packages/react-native-gesture-handler/apple`. Web can be found in `/packages/react-native-gesture-handler/src/web`.
+- Some files are platform specific. Those have platform in the file extension, e.g. `RNGestureHandlerModule.web.ts`
+
+### Example apps
+
+- Example apps are located in `/apps` directory
+- `basic-example` is mostly used to check that android and iOS build correctly.
+- `expo-example` is used to test more advanced examples. Sources are located in `apps/common-app`.
+- `macos-example` is used to check if library works on macos. Sources are located in `apps/common-app`.
+
+### Packages
+
+- `/packages` contains documentation and main library package
+- This project contains 3 versions of API. The newest is located in `packages/react-native-gesture-handler/src/v3` directory. Most of the logic is shared, but make sure that your changes do not break older APIs.
+- When writing code, you can use `usesNativeOrVirtualDetector` function to either include only, or exclude new API v3. It is available on all platforms.
+
+## Build checks
+
+- To check Android build go to `apps/basic-example` and run `yarn android` command.
+- To check iOS build, go to `apps/basic-example` and run `yarn ios`.
+- To check macos build, go to `apps/macos-example` and run `yarn macos`.
+- After any build on macOS/Linux stop the Metro server with `for pid in $(lsof -ti :8081); do kill "$pid"; done` (this no-ops cleanly when nothing is listening on port 8081; `pkill -f "metro"` is not sufficient)
+
+## JavaScript checks
+
+- To run TypeScript checks use `yarn ts-check` command. You can run it directly in `packages/react-native-gesture-handler` if working on package, or from root of the repository.
+- To run Jest tests, use `yarn test` command in `packages/react-native-gesture-handler`. You can also pass filename to run tests from specific file.
+- To run eslint check, use `yarn lint:js`
+
+## Formatting
+
+- To format code use use `yarn format:{apple | android | js}`. `apple` works for both, iOS and macos.

CLAUDE.md

@@ -0,0 +1 @@
+AGENTS.md

apps/basic-example/src/App.tsx

@@ -1,13 +1,11 @@
 import * as React from 'react';
-import { SafeAreaView, Platform } from 'react-native';
+import { Platform, SafeAreaView } from 'react-native';
+import ContentsButton from './ContentsButton';
 import { GestureHandlerRootView } from 'react-native-gesture-handler';
-
-import Navigator from './Navigator';
-
-import Text from './Text';
 import NativeDetector from './NativeDetector';
+import Navigator from './Navigator';
 import RuntimeDecoration from './RuntimeDecoration';
-import ContentsButton from './ContentsButton';
+import Text from './Text';
 
 const EXAMPLES = [
   {

apps/basic-example/src/ContentsButton.tsx

@@ -1,10 +1,10 @@
-import React from 'react';
-import { View, StyleSheet, Text, SafeAreaView } from 'react-native';
 import {
   GestureHandlerRootView,
-  ScrollView,
   RectButton,
+  ScrollView,
 } from 'react-native-gesture-handler';
+import { SafeAreaView, StyleSheet, Text, View } from 'react-native';
+import React from 'react';
 
 export default function ComplexUI() {
   return (

apps/basic-example/src/NativeDetector.tsx

@@ -1,8 +1,8 @@
 import * as React from 'react';
 import { Animated, Button, useAnimatedValue } from 'react-native';
 import {
-  GestureHandlerRootView,
   GestureDetector,
+  GestureHandlerRootView,
   usePanGesture,
 } from 'react-native-gesture-handler';
 

apps/basic-example/src/Navigator.tsx

@@ -1,5 +1,5 @@
+import { BackHandler, Pressable, Text, View } from 'react-native';
 import React, { useEffect, useState } from 'react';
-import { View, Text, Pressable, BackHandler } from 'react-native';
 
 export interface RouteInfo {
   component: React.ComponentType;

apps/basic-example/src/RuntimeDecoration.tsx

@@ -1,13 +1,12 @@
 import * as React from 'react';
-import { StyleSheet, Text, View } from 'react-native';
-import { Gesture, GestureDetector } from 'react-native-gesture-handler';
-
-import { COLORS } from './colors';
 import Animated, {
   runOnJS,
   useAnimatedStyle,
   useSharedValue,
 } from 'react-native-reanimated';
+import { Gesture, GestureDetector } from 'react-native-gesture-handler';
+import { StyleSheet, Text, View } from 'react-native';
+import { COLORS } from './colors';
 import { useState } from 'react';
 
 export function RuntimeChecker({

apps/basic-example/src/Text.tsx

@@ -1,13 +1,12 @@
 import * as React from 'react';
-import { StyleSheet, Text, View } from 'react-native';
 import {
   Gesture,
   GestureDetector,
   InterceptingGestureDetector,
   VirtualGestureDetector,
   useTapGesture,
 } from 'react-native-gesture-handler';
-
+import { StyleSheet, Text, View } from 'react-native';
 import { COLORS } from './colors';
 
 function NativeDetectorExample() {

apps/common-app/package.json

@@ -32,7 +32,7 @@
     "@babel/core": "^7.25.2",
     "@babel/preset-env": "^7.25.3",
     "@babel/runtime": "^7.25.0",
-    "@react-native-community/cli": "18.0.0",
+    "@react-native-community/cli": "18.0.1",
     "@react-native-community/cli-platform-android": "18.0.0",
     "@react-native-community/cli-platform-ios": "18.0.0",
     "@react-native-community/viewpager": "5.0.11",