feat: create ionic.config.json if it doesn't already exist

Author: danielroe

README.md

@@ -7,7 +7,9 @@
 
 > [Ionic](https://ionicframework.com/docs/) integration for [Nuxt](https://nuxtjs.org)
 
-[▶️  Online playground](https://stackblitz.com/github/danielroe/nuxt-ionic/tree/main/playground)
+- [✨  Changelog](https://github.com/danielroe/nuxt-ionic/blob/main/CHANGELOG.md)
+- [📖  Read the documentation](https://ionic.roe.dev)
+- [▶️  Online playground](https://stackblitz.com/github/danielroe/nuxt-ionic/tree/main/playground)
 
 ## Features
 
@@ -25,38 +27,9 @@
 
 - [ ] PWA Elements
 
-## Quick setup
-
-1. Add `nuxt-ionic` dependency to your project
-
-```bash
-yarn add --dev nuxt-ionic
-# npm install -D nuxt-ionic
-# pnpm i -D nuxt-ionic
-```
-
-1. Add `nuxt-ionic` to the `modules` section of `nuxt.config.ts`
-
-```js
-import { defineNuxtConfig } from 'nuxt'
-
-export default defineNuxtConfig({
-  modules: ['nuxt-ionic'],
-  ionic: {
-    // default options - no configuration is required
-    integrations: {
-      meta: true,
-      pwa: true,
-      router: true,
-    },
-    css: {
-      core: true,
-      basic: true,
-      utilities: false,
-    },
-  },
-})
-```
+## Usage
+
+👉 Check out https://ionic.roe.dev.
 
 ## 💻 Development
 

docs/content/2.getting-started.md

@@ -37,6 +37,10 @@ Finally, either remove your `app.vue` file or replace it with a custom one (star
 
 You're good to go!
 
+::alert{type=info}
+The first time you start a Nuxt project with `nuxt-ionic` enabled, a `ionic.config.json` file will be created if it doesn't already exist.
+::
+
 ## Options
 
 While not required, you can configure the features that are enabled:

package.json

@@ -53,11 +53,13 @@
     "postpublish": "pinst --enable"
   },
   "dependencies": {
+    "@ionic/cli": "^6.20.0",
     "@ionic/vue": "^6.1.10",
     "@ionic/vue-router": "^6.1.10",
     "@kevinmarrec/nuxt-pwa": "^0.3.0",
     "@nuxt/kit": "^3.0.0-rc.4",
     "pathe": "^0.3.0",
+    "pkg-types": "^0.3.3",
     "std-env": "^3.1.1",
     "ufo": "^0.8.4",
     "unimport": "^0.2.9"

src/module.ts

@@ -1,5 +1,7 @@
-import { fileURLToPath } from 'url'
+import { existsSync, promises as fsp } from 'node:fs'
+import { fileURLToPath } from 'node:url'
 import { join, resolve } from 'pathe'
+import { readPackageJSON } from 'pkg-types'
 import { defineUnimportPreset } from 'unimport'
 import {
   defineNuxtModule,
@@ -46,6 +48,25 @@ export default defineNuxtModule<ModuleOptions>({
     nuxt.options.build.transpile.push(runtimeDir)
     nuxt.options.build.transpile.push(/@ionic/)
 
+    // Set up Ionic config
+    const ionicConfigPath = join(nuxt.options.rootDir, 'ionic.config.json')
+    if (!existsSync(ionicConfigPath)) {
+      await fsp.writeFile(
+        ionicConfigPath,
+        JSON.stringify(
+          {
+            name: await readPackageJSON(nuxt.options.rootDir).then(
+              ({ name }) => name || 'nuxt-ionic-project'
+            ),
+            integrations: {},
+            type: 'vue',
+          },
+          null,
+          2
+        )
+      )
+    }
+
     // Set up Ionic Core
     addPlugin(resolve(runtimeDir, 'ionic'))