nuxt-capacitor 0.1.3 → 0.1.4

package/README.md

@@ -121,19 +121,37 @@ export default defineNuxtConfig({
 
 ## Config file
 
-On first run, if no `capacitor.config.ts` exists in your project root, the module creates one for you:
+The module uses `capacitor.config.json` by default (preferred, since it requires no transpiling or build step).
+
+On first run, if no config file exists in your project root, the module creates one for you:
+```json
+{
+  "appId": "com.example.app",
+  "appName": "Nuxt Capacitor",
+  "webDir": "<rootDir>/.output/public"
+}
+```
 
+This file is automatically kept in sync with your `nuxt.config.ts` capacitor settings on each build/run.
+
+If you prefer TypeScript, set `output: 'ts'` in your module config:
 ```ts
-import {defineCapacitorConfig} from './.nuxt/capacitor.mjs';
+export default defineNuxtConfig({
+  capacitor: {
+    output: 'ts',
+  },
+})
+```
+
+This will generate a `capacitor.config.ts` instead:
+```ts
+import { defineCapacitorConfig } from './.nuxt/capacitor.mjs';
 
 export default defineCapacitorConfig({
- // Add your overrides here, or configure via nuxt.config.ts > capacitor: {}
+  // Add your overrides here, or configure via nuxt.config.ts > capacitor: {}
 });
 ```
-
-This file is type-safe and merges your overrides over the defaults set in `nuxt.config.ts`.
-
----
+>NOTE: `output: 'ts'` might not work on other targets than `ios` and `android`.
 
 ## Setting Up Mobile Platforms
 

package/modules/config.ts

@@ -1,16 +1,23 @@
-import { createResolver, defineNuxtModule, addTemplate, addTypeTemplate } from '@nuxt/kit'
+import { createResolver, defineNuxtModule } from '@nuxt/kit'
 import { readPackageJSON, type PackageJson } from 'pkg-types'
 import { packageIsInstalled } from '../utils/meta'
 import type { CapacitorConfig } from '@capacitor/cli'
 import defu from 'defu'
 import { withLeadingSlash, withoutTrailingSlash } from 'ufo'
-import { existsSync, writeFileSync } from 'node:fs'
+import { existsSync } from 'node:fs'
 import { join } from 'node:path'
 import { consola } from 'consola'
 import { execSync } from 'node:child_process'
+import {
+  addCodeTemplates,
+  createCapacitorTsConfig,
+  hasAnyCapacitorConfigFile,
+  upsertCapacitorJsonConfig,
+} from '../utils/capacitor'
 
 interface NuxtCapacitorOptions {
   autoSync?: boolean
+  output?: 'json' | 'ts'
   config?: CapacitorConfig
 }
 
@@ -29,6 +36,7 @@ export default defineNuxtModule<NuxtCapacitorOptions>({
   },
   defaults: {
     autoSync: true,
+    output: 'json',
     config: {
       appId: 'com.example.app',
       appName: 'Nuxt Capacitor',
@@ -82,58 +90,20 @@ export default defineNuxtModule<NuxtCapacitorOptions>({
       webDir: withoutTrailingSlash(nuxt.options.rootDir) + withLeadingSlash(distPath),
     })
 
-    const userConfigPath = join(rootDir, 'capacitor.config.ts')
-    const userConfigExists = existsSync(userConfigPath)
-
-    if (!userConfigExists && thisModuleDir !== rootDir) {
-      const defaultUserConfig = [
-        `import { defineCapacitorConfig } from './.nuxt/capacitor.mjs';`,
-        ``,
-        `export default defineCapacitorConfig({`,
-        `  // Add your overrides here, or configure via nuxt.config.ts > capacitor: {}`,
-        `});`,
-      ].join('\n')
-
-      writeFileSync(userConfigPath, defaultUserConfig, 'utf-8')
-      logger.info(`Created default capacitor.config.ts in project root.`)
+    const capacitorConfigFile = hasAnyCapacitorConfigFile(nuxt)
+    if (thisModuleDir !== rootDir) {
+      if (nuxt.options.capacitor.output === 'json') {
+        await upsertCapacitorJsonConfig(nuxt)
+      }
+      else if (!existsSync(join(rootDir, 'capacitor.config.ts')) && nuxt.options.capacitor.output === 'ts' && capacitorConfigFile === 'capacitor.config.ts') {
+        await createCapacitorTsConfig(nuxt)
+      }
+      else {
+        logger.warn(`Unhandled capacitor config file "${capacitorConfigFile}"`)
+      }
     }
 
-    addTemplate({
-      filename: 'capacitor.mjs',
-      write: true,
-      options: {
-        config: nuxt.options?.capacitor?.config ?? {},
-      },
-      getContents: ({ options }) => {
-        const finalConfig = JSON.stringify(options.config, null, 2)
-        return [
-          `/* Auto generated by ${name}. Do not edit. */`,
-          `const _defaultConfig = ${finalConfig};`,
-          ``,
-          `/** @param {import('@capacitor/cli').CapacitorConfig} config */`,
-          `export const defineCapacitorConfig = (config) => Object.assign({}, _defaultConfig, config);`,
-        ].join('\n')
-      },
-    })
-
-    addTypeTemplate({
-      filename: 'capacitor.d.ts',
-      write: true,
-      getContents: () => {
-        return [
-          `import type { CapacitorConfig } from '@capacitor/cli';`,
-          ``,
-          `/**`,
-          ` * Define your Capacitor config with full type safety.`,
-          ` * Values are deeply merged over the defaults provided by ${name}.`,
-          ` *`,
-          ` * @param config - Partial CapacitorConfig overrides`,
-          ` * @returns Fully merged CapacitorConfig`,
-          ` */`,
-          `export declare function defineCapacitorConfig(config: CapacitorConfig): CapacitorConfig;`,
-        ].join('\n')
-      },
-    })
+    addCodeTemplates(nuxt)
 
     // Auto sync
     if (nuxt.options.capacitor.autoSync) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "nuxt-capacitor",
   "description": "A layer for building nuxt apps with capacitor",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "type": "module",
   "main": "./nuxt.config.ts",
   "repository": {

package/utils/capacitor.ts

@@ -0,0 +1,88 @@
+import { addTemplate, addTypeTemplate } from '@nuxt/kit'
+import type { Nuxt } from '@nuxt/schema'
+import type { CapacitorConfig } from '@capacitor/cli'
+import { join } from 'node:path'
+import { existsSync, writeFileSync, readFileSync } from 'node:fs'
+import { defu } from 'defu'
+
+const name = 'nuxt-capacitor'
+
+const capacitorConfigFiles = ['capacitor.config.json', 'capacitor.config.ts', 'capacitor.config.mjs'] as const
+
+export const hasAnyCapacitorConfigFile = (nuxt: Nuxt): typeof capacitorConfigFiles[number] | false => {
+  for (const file of capacitorConfigFiles) {
+    if (existsSync(join(nuxt.options.rootDir, file))) {
+      return file
+    }
+  }
+  return false
+}
+export const upsertCapacitorJsonConfig = async (nuxt: Nuxt) => {
+  // @ts-expect-error Not typed...
+  const config = (nuxt.options?.capacitor?.config || {}) as CapacitorConfig
+  const configFile = join(nuxt.options.rootDir, 'capacitor.config.json')
+  if (!existsSync(configFile)) {
+    writeFileSync(configFile, JSON.stringify(config, null, 2), 'utf-8')
+    return
+  }
+
+  const { server, ...oldContent } = JSON.parse(readFileSync(configFile, 'utf-8'))
+
+  const merged = defu(oldContent, config)
+
+  writeFileSync(configFile, JSON.stringify(merged, null, 2), 'utf-8')
+}
+
+export const createCapacitorTsConfig = async (nuxt: Nuxt) => {
+  const userConfigPath = join(nuxt.options.rootDir, 'capacitor.config.ts')
+
+  const defaultUserConfig = [
+    `import { defineCapacitorConfig } from './.nuxt/capacitor.mjs';`,
+    ``,
+    `export default defineCapacitorConfig({`,
+    `  // Add your overrides here, or configure via nuxt.config.ts > capacitor: {}`,
+    `});`,
+  ].join('\n')
+
+  writeFileSync(userConfigPath, defaultUserConfig, 'utf-8')
+}
+
+export const addCodeTemplates = (nuxt: Nuxt) => {
+  addTemplate({
+    filename: 'capacitor.mjs',
+    write: true,
+    options: {
+      // @ts-expect-error Not typed...
+      config: nuxt.options?.capacitor?.config ?? {},
+    },
+    getContents: ({ options }) => {
+      const finalConfig = JSON.stringify(options.config, null, 2)
+      return [
+        `/* Auto generated by ${name}. Do not edit. */`,
+        `const _defaultConfig = ${finalConfig};`,
+        ``,
+        `/** @param {import('@capacitor/cli').CapacitorConfig} config */`,
+        `export const defineCapacitorConfig = (config) => Object.assign({}, _defaultConfig, config);`,
+      ].join('\n')
+    },
+  })
+
+  addTypeTemplate({
+    filename: 'capacitor.d.ts',
+    write: true,
+    getContents: () => {
+      return [
+        `import type { CapacitorConfig } from '@capacitor/cli';`,
+        ``,
+        `/**`,
+        ` * Define your Capacitor config with full type safety.`,
+        ` * Values are deeply merged over the defaults provided by ${name}.`,
+        ` *`,
+        ` * @param config - Partial CapacitorConfig overrides`,
+        ` * @returns Fully merged CapacitorConfig`,
+        ` */`,
+        `export declare function defineCapacitorConfig(config: CapacitorConfig): CapacitorConfig;`,
+      ].join('\n')
+    },
+  })
+}