@ramathibodi/nuxt-commons 0.1.74 → 0.1.75

package/scripts/generate-composables-md.mjs

@@ -1,129 +1,129 @@
-import fs from 'node:fs'
-import path from 'node:path'
-
-const rootDir = process.cwd()
-const aiSummaryPath = path.join(rootDir, 'docs/ai-summary.json')
-const outDir = path.join(rootDir, 'docs/composables-md')
-
-if (!fs.existsSync(aiSummaryPath)) {
-  console.error('docs/ai-summary.json not found. Run: npm run docs:ai:summary')
-  process.exit(1)
-}
-
-const ai = JSON.parse(fs.readFileSync(aiSummaryPath, 'utf8'))
-const composables = ai.composables || []
-
-function safeName(filePath) {
-  return filePath
-    .replace(/^src\/runtime\/composables\//, '')
-    .replace(/\//g, '__')
-    .replace(/\.ts$/, '')
-}
-
-function mdEscape(str) {
-  return String(str ?? '').replace(/\|/g, '\\|')
-}
-
-fs.mkdirSync(outDir, { recursive: true })
-
-const index = []
-index.push('# Composables (Markdown)')
-index.push('')
-index.push(`Generated at: ${ai.generatedAt}`)
-index.push('')
-index.push('| Composable | Source |')
-index.push('| ---------- | ------ |')
-
-for (const c of composables) {
-  const fileBase = safeName(c.path)
-  const outFile = path.join(outDir, `${fileBase}.md`)
-  const content = []
-
-  content.push(`# ${fileBase}`)
-  content.push('')
-  content.push(`- Source: \`${c.path}\``)
-  content.push(`- Summary: ${c.summary || ''}`)
-  content.push('')
-
-  const exp = c.exports || {}
-  const functions = exp.functions || []
-  const interfaces = exp.interfaces || []
-  const types = exp.types || []
-  const consts = exp.constants || []
-  const enums = exp.enums || []
-
-  content.push('## Exported Functions')
-  content.push('')
-  if (functions.length) {
-    content.push('| Name | Signature | Returns |')
-    content.push('| ---- | --------- | ------- |')
-    for (const fn of functions) {
-      content.push(`| \`${mdEscape(fn.name)}\` | \`${mdEscape(fn.signature || '')}\` | \`${mdEscape(fn.returns || '')}\` |`)
-    }
-  } else {
-    content.push('No exported functions.')
-  }
-  content.push('')
-
-  content.push('## Exported Interfaces')
-  content.push('')
-  if (interfaces.length) {
-    for (const i of interfaces) {
-      content.push(`### \`${i.name}\``)
-      content.push('')
-      content.push('```ts')
-      content.push(i.shape || '')
-      content.push('```')
-      content.push('')
-    }
-  } else {
-    content.push('No exported interfaces.')
-    content.push('')
-  }
-
-  content.push('## Exported Types')
-  content.push('')
-  if (types.length) {
-    content.push('| Name | Definition |')
-    content.push('| ---- | ---------- |')
-    for (const t of types) {
-      content.push(`| \`${mdEscape(t.name)}\` | \`${mdEscape(t.definition || '')}\` |`)
-    }
-  } else {
-    content.push('No exported types.')
-  }
-  content.push('')
-
-  content.push('## Exported Constants')
-  content.push('')
-  if (consts.length) {
-    content.push('| Name | Type |')
-    content.push('| ---- | ---- |')
-    for (const k of consts) {
-      content.push(`| \`${mdEscape(k.name)}\` | \`${mdEscape(k.type || '')}\` |`)
-    }
-  } else {
-    content.push('No exported constants.')
-  }
-  content.push('')
-
-  content.push('## Exported Enums')
-  content.push('')
-  if (enums.length) {
-    for (const e of enums) {
-      content.push(`### \`${e.name}\``)
-      content.push('')
-      for (const m of e.members || []) content.push(`- \`${m}\``)
-      content.push('')
-    }
-  } else {
-    content.push('No exported enums.')
-    content.push('')
-  }
-
-  fs.writeFileSync(outFile, content.join('\n'))
-  index.push(`| [\`${fileBase}\`](${fileBase}.md) | \`${c.path}\` |`)
-}
-
-fs.writeFileSync(path.join(outDir, 'README.md'), index.join('\n'))
-console.log(`Generated markdown docs for ${composables.length} composables at docs/composables-md`)
+import fs from 'node:fs'
+import path from 'node:path'
+
+const rootDir = process.cwd()
+const aiSummaryPath = path.join(rootDir, 'docs/ai-summary.json')
+const outDir = path.join(rootDir, 'docs/composables-md')
+
+if (!fs.existsSync(aiSummaryPath)) {
+  console.error('docs/ai-summary.json not found. Run: npm run docs:ai:summary')
+  process.exit(1)
+}
+
+const ai = JSON.parse(fs.readFileSync(aiSummaryPath, 'utf8'))
+const composables = ai.composables || []
+
+function safeName(filePath) {
+  return filePath
+    .replace(/^src\/runtime\/composables\//, '')
+    .replace(/\//g, '__')
+    .replace(/\.ts$/, '')
+}
+
+function mdEscape(str) {
+  return String(str ?? '').replace(/\|/g, '\\|')
+}
+
+fs.mkdirSync(outDir, { recursive: true })
+
+const index = []
+index.push('# Composables (Markdown)')
+index.push('')
+index.push(`Generated at: ${ai.generatedAt}`)
+index.push('')
+index.push('| Composable | Source |')
+index.push('| ---------- | ------ |')
+
+for (const c of composables) {
+  const fileBase = safeName(c.path)
+  const outFile = path.join(outDir, `${fileBase}.md`)
+  const content = []
+
+  content.push(`# ${fileBase}`)
+  content.push('')
+  content.push(`- Source: \`${c.path}\``)
+  content.push(`- Summary: ${c.summary || ''}`)
+  content.push('')
+
+  const exp = c.exports || {}
+  const functions = exp.functions || []
+  const interfaces = exp.interfaces || []
+  const types = exp.types || []
+  const consts = exp.constants || []
+  const enums = exp.enums || []
+
+  content.push('## Exported Functions')
+  content.push('')
+  if (functions.length) {
+    content.push('| Name | Signature | Returns |')
+    content.push('| ---- | --------- | ------- |')
+    for (const fn of functions) {
+      content.push(`| \`${mdEscape(fn.name)}\` | \`${mdEscape(fn.signature || '')}\` | \`${mdEscape(fn.returns || '')}\` |`)
+    }
+  } else {
+    content.push('No exported functions.')
+  }
+  content.push('')
+
+  content.push('## Exported Interfaces')
+  content.push('')
+  if (interfaces.length) {
+    for (const i of interfaces) {
+      content.push(`### \`${i.name}\``)
+      content.push('')
+      content.push('```ts')
+      content.push(i.shape || '')
+      content.push('```')
+      content.push('')
+    }
+  } else {
+    content.push('No exported interfaces.')
+    content.push('')
+  }
+
+  content.push('## Exported Types')
+  content.push('')
+  if (types.length) {
+    content.push('| Name | Definition |')
+    content.push('| ---- | ---------- |')
+    for (const t of types) {
+      content.push(`| \`${mdEscape(t.name)}\` | \`${mdEscape(t.definition || '')}\` |`)
+    }
+  } else {
+    content.push('No exported types.')
+  }
+  content.push('')
+
+  content.push('## Exported Constants')
+  content.push('')
+  if (consts.length) {
+    content.push('| Name | Type |')
+    content.push('| ---- | ---- |')
+    for (const k of consts) {
+      content.push(`| \`${mdEscape(k.name)}\` | \`${mdEscape(k.type || '')}\` |`)
+    }
+  } else {
+    content.push('No exported constants.')
+  }
+  content.push('')
+
+  content.push('## Exported Enums')
+  content.push('')
+  if (enums.length) {
+    for (const e of enums) {
+      content.push(`### \`${e.name}\``)
+      content.push('')
+      for (const m of e.members || []) content.push(`- \`${m}\``)
+      content.push('')
+    }
+  } else {
+    content.push('No exported enums.')
+    content.push('')
+  }
+
+  fs.writeFileSync(outFile, content.join('\n'))
+  index.push(`| [\`${fileBase}\`](${fileBase}.md) | \`${c.path}\` |`)
+}
+
+fs.writeFileSync(path.join(outDir, 'README.md'), index.join('\n'))
+console.log(`Generated markdown docs for ${composables.length} composables at docs/composables-md`)

package/scripts/postInstall.cjs

@@ -1,70 +1,70 @@
-const fs = require('node:fs')
-const path = require('node:path')
-const { execSync } = require('node:child_process')
-
-// Function to copy a file from source to destination
-function copyFile(src, dest) {
-  fs.mkdirSync(path.dirname(dest), { recursive: true })
-  fs.copyFileSync(src, dest)
-  console.log(`Copied ${src} to ${dest}`)
-}
-
-// Function to copy all files in a directory recursively
-function copyDirectory(srcDir, destDir) {
-  const entries = fs.readdirSync(srcDir, { withFileTypes: true })
-
-  for (let entry of entries) {
-    const srcPath = path.join(srcDir, entry.name)
-    const destPath = path.join(destDir, entry.name)
-
-    if (entry.isDirectory()) {
-      copyDirectory(srcPath, destPath)
-    }
-    else {
-      copyFile(srcPath, destPath)
-    }
-  }
-}
-
-// Function to modify package.json to add a new script
-function addScriptToPackageJson(scriptName, scriptCommand) {
-  const packageJsonPath = path.join(process.env.INIT_CWD, 'package.json')
-  const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'))
-
-  packageJson.scripts = packageJson.scripts || {}
-  packageJson.scripts[scriptName] = scriptCommand
-
-  fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2))
-  console.log(`Added script "${scriptName}": "${scriptCommand}" to package.json`)
-}
-
-// Function to run npm run codegen safely
-function runCodegen(projectRoot) {
-  try {
-    execSync('npm run codegen', { cwd: projectRoot, stdio: 'inherit' })
-    console.log('Successfully ran npm run codegen')
-  }
-  catch (error) {
-    console.log('npm run codegen failed or script not found, continuing...')
-  }
-}
-
-if (process.env.INIT_CWD === process.cwd()) process.exit()
-
-// Define source and destination directories
-const srcDir = path.join(__dirname, '..', 'templates')
-const destDir = process.env.INIT_CWD // Project root
-
-// Copy all files from templates directory to project root
-copyDirectory(srcDir, destDir)
-
-// Add new script to package.json
-addScriptToPackageJson('codegen', 'graphql-codegen --require dotenv/config --config ./.codegen/codegen.ts dotenv_config_path=.env')
-
-// Run npm run codegen safely
-if (!fs.existsSync(path.join(destDir, 'types', 'graphql.ts')) || !fs.existsSync(path.join(destDir, 'composables', 'graphqlObject.ts'))) {
-  if (process.env.NUXT_PUBLIC_WS_GRAPHQL) runCodegen(destDir)
-}
-else {
-  console.log('Skipping codegen')
-}
+const fs = require('node:fs')
+const path = require('node:path')
+const { execSync } = require('node:child_process')
+
+// Function to copy a file from source to destination
+function copyFile(src, dest) {
+  fs.mkdirSync(path.dirname(dest), { recursive: true })
+  fs.copyFileSync(src, dest)
+  console.log(`Copied ${src} to ${dest}`)
+}
+
+// Function to copy all files in a directory recursively
+function copyDirectory(srcDir, destDir) {
+  const entries = fs.readdirSync(srcDir, { withFileTypes: true })
+
+  for (let entry of entries) {
+    const srcPath = path.join(srcDir, entry.name)
+    const destPath = path.join(destDir, entry.name)
+
+    if (entry.isDirectory()) {
+      copyDirectory(srcPath, destPath)
+    }
+    else {
+      copyFile(srcPath, destPath)
+    }
+  }
+}
+
+// Function to modify package.json to add a new script
+function addScriptToPackageJson(scriptName, scriptCommand) {
+  const packageJsonPath = path.join(process.env.INIT_CWD, 'package.json')
+  const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'))
+
+  packageJson.scripts = packageJson.scripts || {}
+  packageJson.scripts[scriptName] = scriptCommand
+
+  fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2))
+  console.log(`Added script "${scriptName}": "${scriptCommand}" to package.json`)
+}
+
+// Function to run npm run codegen safely
+function runCodegen(projectRoot) {
+  try {
+    execSync('npm run codegen', { cwd: projectRoot, stdio: 'inherit' })
+    console.log('Successfully ran npm run codegen')
+  }
+  catch (error) {
+    console.log('npm run codegen failed or script not found, continuing...')
+  }
+}
+
+if (process.env.INIT_CWD === process.cwd()) process.exit()
+
+// Define source and destination directories
+const srcDir = path.join(__dirname, '..', 'templates')
+const destDir = process.env.INIT_CWD // Project root
+
+// Copy all files from templates directory to project root
+copyDirectory(srcDir, destDir)
+
+// Add new script to package.json
+addScriptToPackageJson('codegen', 'graphql-codegen --require dotenv/config --config ./.codegen/codegen.ts dotenv_config_path=.env')
+
+// Run npm run codegen safely
+if (!fs.existsSync(path.join(destDir, 'types', 'graphql.ts')) || !fs.existsSync(path.join(destDir, 'composables', 'graphqlObject.ts'))) {
+  if (process.env.NUXT_PUBLIC_WS_GRAPHQL) runCodegen(destDir)
+}
+else {
+  console.log('Skipping codegen')
+}

package/templates/.codegen/codegen.ts

@@ -1,32 +1,32 @@
-import type {CodegenConfig} from '@graphql-codegen/cli'
-
-const config: CodegenConfig = {
-  overwrite: true,
-  schema: process.env.NUXT_PUBLIC_WS_GRAPHQL,
-  generates: {
-    './types/graphql.ts': {
-      plugins: [{
-        add: {
-          content: '//Auto-generated file, do not make any change. Content could be overwritten.',
-        },
-      }, 'typescript'],
-      config: {
-        maybeValue: 'T | null | undefined',
-        inputMaybeValue: 'T | null | undefined',
-        declarationKind: 'class',
-        enumsAsTypes: true,
-        skipTypename: true,
-      },
-    },
-    './composables/graphqlObject.ts': {
-      plugins: [{
-        add: {
-          content: '//Auto-generated file, do not make any change. Content could be overwritten.',
-        },
-      }, './.codegen/plugin-schema-object.js'],
-    },
-  },
-  hooks: { afterAllFileWrite: ['prettier --parser typescript --tab-width 4 --write'] },
-}
-
-export default config
+import type {CodegenConfig} from '@graphql-codegen/cli'
+
+const config: CodegenConfig = {
+  overwrite: true,
+  schema: process.env.NUXT_PUBLIC_WS_GRAPHQL,
+  generates: {
+    './types/graphql.ts': {
+      plugins: [{
+        add: {
+          content: '//Auto-generated file, do not make any change. Content could be overwritten.',
+        },
+      }, 'typescript'],
+      config: {
+        maybeValue: 'T | null | undefined',
+        inputMaybeValue: 'T | null | undefined',
+        declarationKind: 'class',
+        enumsAsTypes: true,
+        skipTypename: true,
+      },
+    },
+    './composables/graphqlObject.ts': {
+      plugins: [{
+        add: {
+          content: '//Auto-generated file, do not make any change. Content could be overwritten.',
+        },
+      }, './.codegen/plugin-schema-object.js'],
+    },
+  },
+  hooks: { afterAllFileWrite: ['prettier --parser typescript --tab-width 4 --write'] },
+}
+
+export default config