docs(README): add documentation

README.md

@@ -5,3 +5,86 @@ These presets are a collection of functions you can execute to configure an Adon
 For example: When you create a new AdonisJS application, you can configure Lucid and also you can create a new app without Lucid and configure it later.
 
 So, instead of duplicating the code in multiple places, we create re-usable presets and use them with individual packages and the [create-adonisjs](https://npm.im/create-adonisjs) initializer.
+
+> [!NOTE]
+> Presets do not trigger any prompts and exposes a coding interface.
+
+## Auth preset
+
+The `auth` presets configures the `@adonisjs/auth` package. The package must be installed to run this preset.
+
+```ts
+import { Kernel } from '@adonisjs/core/ace'
+import { Application } from '@adonisjs/core/app'
+import { presetAuth } from '@adonisjs/presets/auth'
+import { Codemods } from '@adonisjs/core/ace/codemods'
+
+/**
+ * Create application instance. Inside an Ace command, you
+ * get access to it using `this.app` property.
+ */
+const app = new Application(baseURL, {
+  importer: () => {},
+})
+
+/**
+ * Create Ace kernel instance to get CLI logger reference.
+ * Inside an Ace command you can access it using this.logger
+ * property.
+ */
+const cliLogger = new Kernel(app).ui.logger
+
+/**
+ * Create codemods instance. Codemods are needed to modify
+ * source files.
+ */
+const codemods = new Codemods(app, cliLogger)
+
+/**
+ * Apply preset
+ */
+await presetAuth(codemods, {
+  guard: 'session',
+  userProvider: 'lucid',
+})
+```
+
+## Lucid preset
+
+The `auth` presets configures the `@adonisjs/lucid` package. The package must be installed to run this preset.
+
+```ts
+import { Kernel } from '@adonisjs/core/ace'
+import { Application } from '@adonisjs/core/app'
+import { presetLucid } from '@adonisjs/presets/lucid'
+import { Codemods } from '@adonisjs/core/ace/codemods'
+
+/**
+ * Create application instance. Inside an Ace command, you
+ * get access to it using `this.app` property.
+ */
+const app = new Application(baseURL, {
+  importer: () => {},
+})
+
+/**
+ * Create Ace kernel instance to get CLI logger reference.
+ * Inside an Ace command you can access it using this.logger
+ * property.
+ */
+const cliLogger = new Kernel(app).ui.logger
+
+/**
+ * Create codemods instance. Codemods are needed to modify
+ * source files.
+ */
+const codemods = new Codemods(app, cliLogger)
+
+/**
+ * Apply preset
+ */
+await presetLucid(codemods, app, {
+  dialect: 'sqlite',
+  installPackages: true,
+})
+```

package.json

@@ -12,8 +12,8 @@
     "quick:test": "node --loader ts-node/esm --enable-source-maps bin/test.ts"
   },
   "exports": {
-    "./lucid": "./lucid/main.js",
-    "./auth": "./auth/main.js"
+    "./lucid": "./src/lucid/main.js",
+    "./auth": "./src/auth/main.js"
   },
   "keywords": [
     "adonisjs",

tests/auth/preset.spec.ts

@@ -9,9 +9,9 @@
 
 import dedent from 'dedent'
 import { test } from '@japa/runner'
-import { cliui } from '@poppinss/cliui'
+import { Kernel } from '@adonisjs/core/ace'
 import { presetAuth } from '../../src/auth/main.js'
-import { createKernelFile, createSetupFiles, createCodeMods } from '../helpers.js'
+import { createKernelFile, createSetupFiles, createCodeMods, createApp } from '../helpers.js'
 
 test.group('Preset | Auth', (group) => {
   group.each.disableTimeout()
@@ -20,8 +20,9 @@ test.group('Preset | Auth', (group) => {
     await createSetupFiles(fs)
     await createKernelFile(fs)
 
-    const logger = cliui({ mode: 'normal' }).logger
-    const codemods = await createCodeMods(fs, logger)
+    const app = await createApp(fs)
+    const logger = new Kernel(app).ui.logger
+    const codemods = await createCodeMods(fs, logger, app)
 
     await presetAuth(codemods, { guard: 'session', userProvider: 'lucid' })
     await assert.fileContains('adonisrc.ts', ['@adonisjs/auth/auth_provider'])
@@ -36,8 +37,9 @@ test.group('Preset | Auth', (group) => {
     await createSetupFiles(fs)
     await createKernelFile(fs)
 
-    const logger = cliui({ mode: 'normal' }).logger
-    const codemods = await createCodeMods(fs, logger)
+    const app = await createApp(fs)
+    const logger = new Kernel(app).ui.logger
+    const codemods = await createCodeMods(fs, logger, app)
 
     await presetAuth(codemods, { guard: 'session', userProvider: 'lucid' })
     await assert.fileEquals(
@@ -79,8 +81,9 @@ test.group('Preset | Auth', (group) => {
     await createSetupFiles(fs)
     await createKernelFile(fs)
 
-    const logger = cliui({ mode: 'normal' }).logger
-    const codemods = await createCodeMods(fs, logger)
+    const app = await createApp(fs)
+    const logger = new Kernel(app).ui.logger
+    const codemods = await createCodeMods(fs, logger, app)
 
     await presetAuth(codemods, { guard: 'session', userProvider: 'database' })
     await assert.fileEquals(

tests/lucid/preset.spec.ts

@@ -9,7 +9,7 @@
 
 import dedent from 'dedent'
 import { test } from '@japa/runner'
-import { cliui } from '@poppinss/cliui'
+import { Kernel } from '@adonisjs/core/ace'
 import { presetLucid } from '../../src/lucid/main.js'
 import { createEnvFile, createSetupFiles, createCodeMods, createApp } from '../helpers.js'
 
@@ -20,8 +20,8 @@ test.group('Preset | Lucid', (group) => {
     await createSetupFiles(fs)
     await createEnvFile(fs)
 
-    const logger = cliui({ mode: 'normal' }).logger
     const app = await createApp(fs)
+    const logger = new Kernel(app).ui.logger
     const codemods = await createCodeMods(fs, logger, app)
 
     await presetLucid(codemods, app, { dialect: 'postgres', installPackages: false })
@@ -75,8 +75,8 @@ test.group('Preset | Lucid', (group) => {
     await createSetupFiles(fs)
     await createEnvFile(fs)
 
-    const logger = cliui({ mode: 'normal' }).logger
     const app = await createApp(fs)
+    const logger = new Kernel(app).ui.logger
     const codemods = await createCodeMods(fs, logger, app)
 
     await presetLucid(codemods, app, { dialect: 'mysql', installPackages: false })
@@ -130,8 +130,8 @@ test.group('Preset | Lucid', (group) => {
     await createSetupFiles(fs)
     await createEnvFile(fs)
 
-    const logger = cliui({ mode: 'normal' }).logger
     const app = await createApp(fs)
+    const logger = new Kernel(app).ui.logger
     const codemods = await createCodeMods(fs, logger, app)
 
     await presetLucid(codemods, app, { dialect: 'mssql', installPackages: false })
@@ -185,8 +185,8 @@ test.group('Preset | Lucid', (group) => {
     await createSetupFiles(fs)
     await createEnvFile(fs)
 
-    const logger = cliui({ mode: 'normal' }).logger
     const app = await createApp(fs)
+    const logger = new Kernel(app).ui.logger
     const codemods = await createCodeMods(fs, logger, app)
 
     await presetLucid(codemods, app, { dialect: 'sqlite', installPackages: false })
@@ -225,8 +225,8 @@ test.group('Preset | Lucid', (group) => {
     await createSetupFiles(fs)
     await createEnvFile(fs)
 
-    const logger = cliui({ mode: 'normal' }).logger
     const app = await createApp(fs)
+    const logger = new Kernel(app).ui.logger
     const codemods = await createCodeMods(fs, logger, app)
 
     await presetLucid(codemods, app, { dialect: 'postgres', installPackages: true })