feat: set up turbo gen hook (#4)

Author: clement-lta

.editorconfig

@@ -0,0 +1,10 @@
+# editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

.gitignore

@@ -26,6 +26,7 @@ coverage
 out/
 build
 dist
+generated
 
 
 # Debug

package.json

@@ -1,21 +1,26 @@
 {
   "name": "workspace",
   "private": true,
+  "module": "true",
+  "type": "module",
   "scripts": {
     "build": "turbo run build",
     "dev": "turbo run dev",
     "test": "turbo run test",
     "lint": "turbo run lint",
     "format": "prettier --write \"**/*.{ts,tsx,md}\"",
-    "check-types": "turbo run check-types"
+    "gen-hook": "turbo gen hook --config \"turbo/generators/config.cts\" && pnpm format"
   },
   "devDependencies": {
+    "@turbo/gen": "^2.5.0",
+    "date-fns": "^4.1.0",
     "prettier": "^3.5.3",
     "turbo": "^2.5.0",
     "typescript": "5.8.2"
   },
   "packageManager": "pnpm@9.0.0",
   "engines": {
-    "node": ">=18"
-  }
+    "node": ">=18.17"
+  },
+  "license": "MIT"
 }

pnpm-lock.yaml

@@ -0,0 +1,52 @@
+import type { PlopTypes } from '@turbo/gen'
+import { format } from 'date-fns'
+import path from 'path'
+
+export default function generator(plop: PlopTypes.NodePlopAPI): void {
+  const usehooksSrcPath = path.resolve('packages/usehooks-ts/src')
+  plop.setGenerator('hook', {
+    description: 'Create a post',
+    prompts: [
+      {
+        type: 'input',
+        name: 'name',
+        message: 'post name please (eg: "use test")',
+      },
+    ],
+    actions: [
+      {
+        type: 'add',
+        path: usehooksSrcPath + '/{{camelCase name}}/{{camelCase name}}.ts',
+        templateFile: 'templates/hook/hook.ts.hbs',
+      },
+      {
+        type: 'add',
+        path: usehooksSrcPath + '/{{camelCase name}}/{{camelCase name}}.test.ts',
+        templateFile: 'templates/hook/hook.test.ts.hbs',
+      },
+      {
+        data: {
+          date: format(new Date(), 'yyyy-MM-dd'),
+        },
+        type: 'add',
+        path: usehooksSrcPath + '/{{camelCase name}}/{{camelCase name}}.md',
+        templateFile: 'templates/hook/hook.mdx.hbs',
+      },
+      {
+        type: 'add',
+        path: usehooksSrcPath + '/{{camelCase name}}/{{camelCase name}}.demo.tsx',
+        templateFile: 'templates/hook/hook.demo.tsx.hbs',
+      },
+      {
+        type: 'add',
+        path: usehooksSrcPath + '/{{camelCase name}}/index.ts',
+        templateFile: 'templates/hook/index.ts.hbs',
+      },
+      {
+        type: 'append',
+        path: usehooksSrcPath + '/index.ts',
+        templateFile: 'templates/index.ts.hbs',
+      },
+    ],
+  })
+}

turbo/generators/config.cts

@@ -0,0 +1,7 @@
+import { {{camelCase name}} } from './{{camelCase name}}'
+
+export default function Component() {
+const [two] = {{camelCase name}}()
+
+return <div>Hello {two}</div>
+}

turbo/generators/templates/hook/hook.demo.tsx.hbs

@@ -0,0 +1 @@
+This hook description markdown text.

turbo/generators/templates/hook/hook.mdx.hbs

@@ -0,0 +1,13 @@
+import { renderHook } from '@testing-library/react'
+
+import { {{camelCase name}} } from './{{camelCase name}}'
+
+describe('{{camelCase name}}()', () => {
+  it('should {{name}} be ok', () => {
+    const { result } = renderHook(() => {{camelCase name}}())
+    const [value, setNumber] = result.current
+
+    expect(value).toBe(2)
+    expect(typeof setNumber).toBe('function')
+  })
+})

turbo/generators/templates/hook/hook.test.ts.hbs

@@ -0,0 +1,32 @@
+import { useState } from 'react'
+
+import type { Dispatch, SetStateAction } from 'react'
+
+/** Hook return type */
+type {{pascalCase name}}ReturnType = {
+  /** The value of ... */
+  value: number
+  /** A method to update the value of ... */
+  setValue: Dispatch<SetStateAction<number>>
+}
+
+/**
+ * Custom hook that ...
+ * @param {boolean} [defaultValue] - The initial value for ... (default is `0`).
+ * @returns {[number, Dispatch<SetStateAction<number>>]} A tuple containing ...
+ * @see [Documentation](https://usehooks-ts.com/react-hook/{{kebabCase name}})
+ * @public
+ * @example
+ * ```tsx
+ * const { value, setValue } = {{camelCase name}}(2);
+ *
+ * console.log(value); // 2
+ * ```
+ */
+export function {{camelCase name}}(
+  defaultValue?: number,
+): {{pascalCase name}}ReturnType {
+  const [value, setValue] = useState(defaultValue || 0)
+
+  return { value, setValue }
+}

turbo/generators/templates/hook/hook.ts.hbs

@@ -0,0 +1 @@
+export * from './{{camelCase name}}'