V3 (#192)

Co-authored-by: Alex Nicholson <alex.n@clove.kitchen>

Author: a16n-dev

.gitattributes

@@ -2,11 +2,8 @@ name: Run Tests
 on:
   pull_request:
     types: [opened, synchronize]
-    paths:
-      - packages/**
   push:
-    paths:
-      - packages/**
+    branches: ["main"]
 jobs:
   run-tests:
     runs-on: ubuntu-latest
@@ -32,5 +29,11 @@ jobs:
       - name: Install dependencies
         run: pnpm i
 
+      - name: Lint
+        run: pnpm lint
+
+      - name: Typecheck
+        run: pnpm check
+
       - name: Run tests
         run: pnpm test

.github/workflows/run-tests.yml

@@ -1,12 +1,8 @@
 node_modules
 .idea
-dist/
+.claude
 
-.yarn/*
-!.yarn/patches
-!.yarn/plugins
-!.yarn/releases
-!.yarn/sdks
-!.yarn/versions
+dist/
 
 .docusaurus
+

.gitignore

@@ -4,57 +4,46 @@
 [![Types](https://img.shields.io/npm/types/react-dialog-async.svg)](https://www.npmjs.com/package/react-dialog-async)
 [![Downloads](https://img.shields.io/npm/dt/react-dialog-async.svg)](https://www.npmjs.com/package/react-dialog-async)
 
-React Dialog Async provides a simple hook-based API for managing dialog state in React apps.
-
-* ✅ CSS Framework agnostic - works with any component library or CSS setup
-* ✅ Lightweight with zero dependencies
-* ✅ Written in Typescript
-* ✅ Supports both React and React Native
+React Dialog Async provides a hook-based API for managing dialog state in React apps, with a focus on performance and developer ergonomics.
 
 [✨ Read the docs here ✨](https://react-dialog-async.a16n.dev)
 
-# Quick Start
-This example demonstrates how to create a simple dialog that asks the user a question and logs their response to the console:
-```js
-// 1. Wrap your app with DialogProvider
-<DialogProvider>
-  <App />
-</DialogProvider>
+# Installation
 
-// 2. Create a dialog component
-const QuestionDialog = ({ data, open, handleClose }) => {
-  if (!open) return null; // Don't render if the dialog is closed
+Install the package into your project:
+```bash
+pnpm add react-dialog-async
+```
 
-  return (
-    <div className={'dialog'}>
-        <p>{data.question}</p>
-        <button onClick={() => handleClose("No")}>No</button>
-        <button onClick={() => handleClose("Yes")}>Yes</button>
-    </div>
-  )
-};
-
-// 3. Use the useDialog hook to show the dialog
-const App = () => {
-  const questionDialog = useDialog(QuestionDialog);
-
-  const handleClick = async () => {
-    const response = await questionDialog.open({
-      // pass data to the dialog 
-      question: "Do you like apples?" 
-    }); 
-    
-    console.log(response) // Will be either "Yes" or "No"
-  };
+## Why use React Dialog Async?
+
+Here's an example of how you might use it to show a confirmation dialog in response to a user action:
+
+```tsx
+import { useDialog } from 'react-dialog-async';
+
+const DeleteItemButton = () => {
+  const dialog = useDialog(ConfirmationDialog);
+
+  const handleDelete = async () => {
+     const result = await dialog.open({
+       message: "Are you sure you want to delete this item?"
+     });
+
+     if(result?.confirmed) {
+       deleteItem();
+     }
+  }
 
   return (
-      <button onClick={handleClick}>
-        Ask me a question
-      </button>
+    <Button onClick={handleDelete}>
+      Delete item
+    </Button>
   );
-};
+}
 ```
 
+
 # Contributing
 Contributions are more than welcome!
 

.yarn/releases/yarn-4.6.0.cjs

@@ -0,0 +1,29 @@
+import js from '@eslint/js';
+import tseslint from 'typescript-eslint';
+import { importX } from 'eslint-plugin-import-x';
+import { createTypeScriptImportResolver } from 'eslint-import-resolver-typescript';
+
+export default tseslint.config(
+  {
+    settings: {
+      'import-x/resolver-next': [
+        createTypeScriptImportResolver({
+          project: 'packages/*/tsconfig.json',
+        }),
+      ],
+    },
+  },
+  { ignores: ['**/dist/**', '**/node_modules/**'] },
+  {
+    files: [''],
+    plugins: { js },
+  },
+  importX.flatConfigs.recommended,
+  tseslint.configs.recommended,
+  {
+    rules: {
+      '@typescript-eslint/no-explicit-any': 'off',
+      'import-x/order': 'error',
+    },
+  },
+);