typed-config-plugins 0.5.1 → 0.5.3

package/README.md

@@ -1,64 +1,68 @@
 # typed-config-plugins [![npm][npm-image]][npm-url] ![npm][npm-dl-stats]
 
-**Type Safety for Your Expo Config Plugins.**
+Type-safe helpers for Expo config plugins in `app.config.ts`.
 
-Expo config plugins are incredibly powerful, but their configuration lacks the safety net of type checking. `typed-config-plugins` bridges this gap, bringing the full power of TypeScript to your Expo project's configuration.
+`typed-config-plugins` gives you autocomplete and option validation for Expo config plugins so you can stop guessing the shape of plugin options in your config.
 
-## ✨ Features
+## What It Does
 
--   **Enhanced Developer Experience:** Get autocomplete and type validation directly in your `app.config.ts` files, making plugin configuration less error-prone and more efficient.
--   **Pre-built Types:** Includes ready-to-use TypeScript definitions for many popular Expo config plugins, generated by analyzing their source code.
--   **Extensible:** Easily add custom types for your own or third-party plugins using TypeScript module augmentation.
--   **Seamless Integration:** Designed to work smoothly with your existing `app.config.ts` setup. **Note: JSON config files are not supported.**
+- Adds typed plugin helpers for Expo config authoring
+- Ships generated typings for many common third-party plugins
+- Lets you extend missing plugin types with module augmentation
+- Works with normal Expo config output and only changes authoring ergonomics
 
-## 📦 Installation
+> JSON config files cannot be type-checked. Use `app.config.ts` if you want the full benefit of this package.
+
+## Install
 
 ```bash
-npm i typed-config-plugins
+npm install typed-config-plugins
 ```
 
-## 🚀 Usage
-
-Update your `app.config.ts` file to use the `plugin` helper from `typed-config-plugins`.
+## Quick Start
 
-```typescript
+```ts
 import { type ConfigContext, type ExpoConfig } from "expo/config";
 import { plugin } from "typed-config-plugins";
 
 export default ({ config }: ConfigContext): ExpoConfig => ({
-    ...config,
-    // ... other config
-    plugins: [
-        // typed syntax by this package (with type checking/autocompletion):
-        plugin("expo-build-properties", { android: { minSdkVersion: 26 } }),
-        
-        // normal syntax (no type checking/autocompletion):
-        ["expo-build-properties", { android: { minSdkVersion: 26 } }],
-    ],
+  ...config,
+  plugins: [
+    plugin("expo-build-properties", {
+      android: { minSdkVersion: 26 }
+    }),
+
+    // Regular Expo syntax still works too:
+    ["expo-build-properties", { android: { minSdkVersion: 26 } }]
+  ]
 });
 ```
 
-## 🤝 Adding Custom Plugin Types
-
-To extend `typed-config-plugins` with types for your own plugins or plugins not yet covered, you can use TypeScript's module augmentation feature.
+## Extend Missing Plugin Types
 
-Create a new declaration file (e.g., `config-plugins.d.ts`) in your project's root or `src` directory with the following content:
+If a plugin is not covered yet, add your own typings with module augmentation:
 
-```typescript
-// config-plugins.d.ts
-import "typed-config-plugins"; // Import the original type declarations
+```ts
+import "typed-config-plugins";
 
 declare module "typed-config-plugins" {
-    // Extend the `ThirdPartyPlugins` interface with your custom plugin types
-    interface ThirdPartyPlugins {
-        // Define options for "demo-package" (as used in the example)
-        "demo-package": { bar: string, baz?: number };
-        // more packages here...
-    }
+  interface ThirdPartyPlugins {
+    "demo-package": {
+      bar: string;
+      baz?: number;
+    };
+  }
 }
 ```
 
-Now, when you use `plugin("my-custom-plugin", { /* ... */ })` in your `app.config.ts`, TypeScript will provide autocompletion and validate the options against the types you've defined.
+Now `plugin("demo-package", { ... })` will be type-checked in `app.config.ts`.
+
+## Good Fit
+
+- You already use `app.config.ts`
+- You want autocomplete for plugin options
+- You maintain custom or third-party config plugins
+- You want TypeScript errors before `expo prebuild`
 
 [npm-image]: https://img.shields.io/npm/v/typed-config-plugins
 [npm-url]: https://www.npmjs.com/package/typed-config-plugins