main 🧊 add docs for reactuse json

Author: debabin

packages/cli/src/init.ts

@@ -40,7 +40,7 @@ export const init = async () => {
     const configPath = path.join(APP_PATH, 'reactuse.json');
     const config = {
       ts: fs.existsSync(path.join(APP_PATH, 'tsconfig.json')),
-      alias: {
+      aliases: {
         hooks: '@/shared/hooks',
         utils: '@/utils/lib'
       }

packages/core/src/bundle/hooks/index.js

@@ -8,7 +8,6 @@ export * from './useBrowserLanguage/useBrowserLanguage';
 export * from './useClickOutside/useClickOutside';
 export * from './useClipboard/useClipboard';
 export * from './useConst/useConst';
-export * from './useConst/useConst';
 export * from './useCookie/useCookie';
 export * from './useCookies/useCookies';
 export * from './useCounter/useCounter';

packages/core/src/hooks/index.ts

@@ -8,7 +8,6 @@ export * from './useBrowserLanguage/useBrowserLanguage';
 export * from './useClickOutside/useClickOutside';
 export * from './useClipboard/useClipboard';
 export * from './useConst/useConst';
-export * from './useConst/useConst';
 export * from './useCookie/useCookie';
 export * from './useCookies/useCookies';
 export * from './useCounter/useCounter';

packages/docs/app/.vitepress/config.mts

@@ -97,7 +97,7 @@ export default async () => {
               items: [
                 { text: 'Introduction', link: '/introduction' },
                 { text: 'Installation', link: '/installation' },
-                { text: 'Config', link: '/config' },
+                { text: 'reactuse.json', link: '/reactuse-json' },
                 { text: 'CLI', link: '/cli' }
               ]
             },

packages/docs/app/cli.md

@@ -6,7 +6,7 @@ Use the CLI to add hooks to your project with [useverse](https://www.npmjs.com/p
 
 Use the `init` command to initialize configuration and dependencies for a new project.
 
-The `init` command installs dependencies, adds configures [`reactuse.json`](./config.html).
+The `init` command installs dependencies, adds configures [`reactuse.json`](./reactuse-json.html).
 
 ```bash
 npx useverse@latest init

packages/docs/app/config.md

@@ -0,0 +1,68 @@
+# reactuse.json
+
+Configuration for your project.
+
+The `reactuse.json` file holds configuration for your project.
+
+We use it to understand how your project is set up and how to generate hooks customized for your project.
+
+::: info
+Note: The `reactuse.json` file is optional and **only required if you're
+using the CLI** to add hooks to your project. If you're using the copy
+and paste method, you don't need this file.
+:::
+
+You can create a `reactuse.json` file in your project by running the following command:
+
+```bash
+npx useverse@latest init
+```
+
+See the [CLI section](./cli.md) for more information.
+
+## ts
+
+Choose between TypeScript or JavaScript hooks.
+
+Setting this option to `false` allows hooks to be added as JavaScript with the `.jsx` file extension.
+
+```json title="reactuse.json"
+{
+  "ts": `true` | `false`
+}
+```
+
+## aliases
+
+The CLI uses these values and the `paths` config from your `tsconfig.json` or `jsconfig.json` file to place generated hooks in the correct location.
+
+Path aliases have to be set up in your `tsconfig.json` or `jsconfig.json` file.
+
+::: info
+**Important:** If you're using the `src` directory, make sure it is included
+under `paths` in your `tsconfig.json` or `jsconfig.json` file.
+:::
+
+### aliases.utils
+
+Import alias for your utility functions.
+
+```json title="reactuse.json"
+{
+  "aliases": {
+    "utils": "@/utils/lib"
+  }
+}
+```
+
+### aliases.hooks
+
+Import alias for your hooks.
+
+```json title="reactuse.json"
+{
+  "aliases": {
+    "hooks": "@/shared/hooks"
+  }
+}
+```