create-adonisjs 2.1.0 → 2.2.0

package/README.md

@@ -13,6 +13,7 @@ You can use between one of the following official starter kits, or bring your ow
 - `api` : AdonisJS application tailored for building HTTP APIs.
 - `web` : AdonisJS application tailored for building server-side rendered applications.
 - `slim` : Smallest possible AdonisJS application. Still way more powerful and batteries included than a express application.
+- `inertia`: AdonisJS application tailored for building applications using InertiaJS and your favorite frontend framework (Vue, React, Svelte, Solid).
 
 ## Usage
 
@@ -46,8 +47,12 @@ This argument is optional and the command will prompt you to enter the directory
 If you want to use your own starter kit hosted on Github, Gitlab, or Bitbucket, you can use the `--kit` flag to define the repo URL.
 
 ```sh
+# Download from GitHub
 npm init adonisjs -- --kit="github:github_user/repo"
 
+# Github is the default provider, so if not specified, it will be assumed as github
+npm init adonisjs -- --kit="github_user/repo"
+
 # Download from GitLab
 npm init adonisjs -- --kit="gitlab:user/repo"
 
@@ -81,22 +86,22 @@ We are trying to detect the package manager used by your project. However, if yo
 npm init adonisjs -- --pkg="yarn"
 ```
 
-### `--auth-guard` (Default: session)
+### `--auth-guard` (Default: Triggers prompt for selection)
 
 Specify a custom auth guard to use when using the `api` stater kit. One of the following options are allowed
 
-- `session` (Default)
+- `session`
 - `access_tokens`
 
 ```sh
 npm init adonisjs -- --kit="api" --auth-guard="access_tokens"
 ```
 
-### `--db` (Default: sqlite)
+### `--db` (Default: Triggers prompt for selection)
 
 Specify the database dialect to configure with Lucid. One of the following options are allowd.
 
-- `sqlite` (Default)
+- `sqlite`
 - `mysql`
 - `mssql`
 - `postgres`

package/build/commands/main.d.ts

@@ -42,9 +42,17 @@ export declare class CreateNewApp extends BaseCommand {
      */
     db?: string;
     /**
-     * Auth guard for auth package. Defaults to "session"
+     * Auth guard for auth package.
      */
     authGuard?: string;
+    /**
+     * Inertia adapter to use
+     */
+    adapter?: string;
+    /**
+     * Inertia adapter to use
+     */
+    ssr?: boolean;
     /**
      * Execute tasks in verbose mode. Defaults to false.
      */

package/build/commands/main.js

@@ -23,6 +23,12 @@ import { BaseCommand, args, flags } from '@adonisjs/ace';
 import { basename, isAbsolute, join, relative } from 'node:path';
 import { copyFile, readFile, unlink, writeFile } from 'node:fs/promises';
 import { templates } from '../src/templates.js';
+import { databases } from '../src/databases.js';
+import { authGuards } from '../src/auth_guards.js';
+import { adapters } from '../src/inertia_adapters.js';
+const API_STARTER_KIT = 'github:adonisjs/api-starter-kit';
+const WEB_STARTER_KIT = 'github:adonisjs/web-starter-kit';
+const INERTIA_STARTER_KIT = 'github:adonisjs/inertia-starter-kit';
 /**
  * Creates a new AdonisJS application and configures it
  */
@@ -101,6 +107,47 @@ export class CreateNewApp extends BaseCommand {
             }
         }
     }
+    /**
+     * Prompt to select a database driver
+     */
+    async #promptForDatabaseDriver() {
+        if (!this.db) {
+            /**
+             * Display prompt when "db" flag is not used.
+             */
+            const database = await this.prompt.choice('Select the database driver you want to use', databases);
+            this.db = databases.find((t) => t.name === database).alias;
+        }
+    }
+    /**
+     * Prompt to select a auth guard
+     */
+    async #promptForAuthGuard() {
+        if (!this.authGuard) {
+            /**
+             * Display prompt when "authGuard" flag is not used.
+             */
+            const guard = await this.prompt.choice('Select the authentication guard you want to use', authGuards);
+            this.authGuard = authGuards.find((t) => t.name === guard).alias;
+        }
+    }
+    /**
+     * Prompt to select the Inertia adapter
+     */
+    async #promptForInertiaAdapter() {
+        if (!this.adapter) {
+            const adapter = await this.prompt.choice('Select the Inertia frontend adapter you want to use', adapters);
+            this.adapter = adapters.find((t) => t.name === adapter).alias;
+        }
+    }
+    /**
+     * Prompt to select the Inertia adapter
+     */
+    async #promptForInertiaSsr() {
+        if (this.ssr === undefined) {
+            this.ssr = await this.prompt.confirm('Do you want to setup server-side rendering with Inertia?');
+        }
+    }
     /**
      * Prompt to check if we should install dependencies?
      */
@@ -108,6 +155,7 @@ export class CreateNewApp extends BaseCommand {
         if (this.install === undefined) {
             this.install = await this.prompt.confirm(`Do you want us to install dependencies using "${this.packageManager}"?`, {
                 default: true,
+                hint: "(If not, you'll need to configure guards and database manually)",
             });
         }
     }
@@ -192,7 +240,7 @@ export class CreateNewApp extends BaseCommand {
          * guard. This needs to be done, since the api starter kit does
          * not install the session package by default.
          */
-        if (this.authGuard === 'session' && this.kit === 'github:adonisjs/api-starter-kit') {
+        if (this.authGuard === 'session' && this.kit === API_STARTER_KIT) {
             await this.#configureSession();
         }
         /**
@@ -204,6 +252,25 @@ export class CreateNewApp extends BaseCommand {
         }
         await this.#runBashCommand('node', argv);
     }
+    /**
+     * Configures the Inertia package
+     */
+    async #configureInertia() {
+        this.adapter = this.adapter || 'vue';
+        const argv = [
+            'ace',
+            'configure',
+            '@adonisjs/inertia',
+            '--adapter',
+            this.adapter,
+            this.ssr ? '--ssr' : '--no-ssr',
+            this.install ? '--install' : '--no-install',
+        ];
+        if (this.verbose) {
+            argv.push('--verbose');
+        }
+        await this.#runBashCommand('node', argv);
+    }
     /**
      * Main method
      */
@@ -218,6 +285,16 @@ export class CreateNewApp extends BaseCommand {
          */
         await this.#promptForDestination();
         await this.#promptForStarterKit();
+        if (this.kit === WEB_STARTER_KIT ||
+            this.kit === API_STARTER_KIT ||
+            this.kit === INERTIA_STARTER_KIT) {
+            await this.#promptForAuthGuard();
+            await this.#promptForDatabaseDriver();
+        }
+        if (this.kit === INERTIA_STARTER_KIT) {
+            await this.#promptForInertiaAdapter();
+            await this.#promptForInertiaSsr();
+        }
         await this.#promptForInstallingDeps();
         /**
          * Create tasks instance for displaying
@@ -225,23 +302,31 @@ export class CreateNewApp extends BaseCommand {
          */
         const tasks = this.ui.tasks({ verbose: this.verbose === true });
         /**
-         * Configure lucid when using web or api starter kits
+         * Configure lucid when using our own starter kits
          * and installing dependencies
          */
-        const configureLucid = (this.kit === 'github:adonisjs/web-starter-kit' ||
-            this.kit === 'github:adonisjs/api-starter-kit') &&
+        const configureLucid = [WEB_STARTER_KIT, API_STARTER_KIT, INERTIA_STARTER_KIT].includes(this.kit || '') &&
+            this.db !== undefined &&
             this.install !== false;
         /**
-         * Configure auth when using web or api starter kits
+         * Configure auth when using our own starter kits
          * and installing dependencies
          */
-        const configureAuth = (this.kit === 'github:adonisjs/web-starter-kit' ||
-            this.kit === 'github:adonisjs/api-starter-kit') &&
+        const configureAuth = [WEB_STARTER_KIT, API_STARTER_KIT, INERTIA_STARTER_KIT].includes(this.kit || '') &&
+            this.authGuard !== undefined &&
             this.install !== false;
+        /**
+         * Configure inertia when using our inertia starter kit
+         */
+        const configureInertia = this.kit === INERTIA_STARTER_KIT && this.db !== undefined && this.install !== false;
         tasks
             .add('Download starter kit', async (task) => {
             task.update(`Downloading "${this.kit}"`);
-            await downloadTemplate(this.kit, { dir: this.destination, auth: this.token });
+            await downloadTemplate(this.kit, {
+                dir: this.destination,
+                auth: this.token,
+                registry: false,
+            });
             await this.#removeLockFile();
             return `Downloaded "${this.kit}"`;
         })
@@ -315,6 +400,25 @@ export class CreateNewApp extends BaseCommand {
                 }
                 return `Unable to configure "@adonisjs/auth"`;
             }
+        })
+            .addIf(configureInertia, 'Configure Inertia', async (task) => {
+            const spinner = this.logger.await('configuring @adonisjs/inertia', {
+                silent: this.verbose,
+            });
+            spinner.tap((line) => task.update(line));
+            spinner.start();
+            try {
+                await this.#configureInertia();
+                spinner.stop();
+                return 'Inertia configured';
+            }
+            catch (error) {
+                spinner.stop();
+                if (this.verbose) {
+                    this.logger.fatal(error);
+                }
+                return `Unable to configure "@adonisjs/inertia"`;
+            }
         });
         await tasks.run();
         if (tasks.getState() === 'succeeded') {
@@ -360,15 +464,23 @@ __decorate([
 __decorate([
     flags.string({
         description: 'Define the database dialect to use with Lucid',
-        default: 'sqlite',
     })
 ], CreateNewApp.prototype, "db", void 0);
 __decorate([
     flags.string({
         description: 'Define the authentication guard for the Auth package',
-        default: 'session',
     })
 ], CreateNewApp.prototype, "authGuard", void 0);
+__decorate([
+    flags.string({
+        description: 'Define the Inertia frontend adapter ( if using Inertia starter kit )',
+    })
+], CreateNewApp.prototype, "adapter", void 0);
+__decorate([
+    flags.boolean({
+        description: 'Define if SSR is needed ( if using Inertia starter kit )',
+    })
+], CreateNewApp.prototype, "ssr", void 0);
 __decorate([
     flags.boolean({
         description: 'Execute tasks in verbose mode',

package/build/src/auth_guards.d.ts

@@ -0,0 +1,12 @@
+/**
+ * List of first party authentication guards
+ */
+export declare const authGuards: ({
+    name: string;
+    alias: string;
+    hint: string;
+} | {
+    name: string;
+    alias: undefined;
+    hint: string;
+})[];

package/build/src/auth_guards.js

@@ -0,0 +1,28 @@
+/*
+ * create-adonisjs
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+/**
+ * List of first party authentication guards
+ */
+export const authGuards = [
+    {
+        name: 'Session',
+        alias: 'session',
+        hint: 'Authenticate users using cookies and session.',
+    },
+    {
+        name: 'Access Token',
+        alias: 'access_tokens',
+        hint: 'Authenticate clients using tokens.',
+    },
+    {
+        name: 'Skip',
+        alias: undefined,
+        hint: 'I want to configures guards by myself.',
+    },
+];

package/build/src/databases.d.ts

@@ -0,0 +1,12 @@
+/**
+ * List of first party databases (lucid)
+ */
+export declare const databases: ({
+    name: string;
+    alias: string;
+    hint?: undefined;
+} | {
+    name: string;
+    hint: string;
+    alias: undefined;
+})[];

package/build/src/databases.js

@@ -0,0 +1,34 @@
+/*
+ * create-adonisjs
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+/**
+ * List of first party databases (lucid)
+ */
+export const databases = [
+    {
+        name: 'SQLite',
+        alias: 'sqlite',
+    },
+    {
+        name: 'MySQL / MariaDB',
+        alias: 'mysql',
+    },
+    {
+        name: 'PostgreSQL',
+        alias: 'postgres',
+    },
+    {
+        name: 'Microsoft SQL Server',
+        alias: 'mssql',
+    },
+    {
+        name: 'Skip',
+        hint: 'I want to configures the Lucid package by myself.',
+        alias: undefined,
+    },
+];

package/build/src/inertia_adapters.d.ts

@@ -0,0 +1,12 @@
+/**
+ * List of adapters for configuring Inertia
+ */
+export declare const adapters: ({
+    name: string;
+    alias: string;
+    hint?: undefined;
+} | {
+    name: string;
+    hint: string;
+    alias: undefined;
+})[];

package/build/src/inertia_adapters.js

@@ -0,0 +1,34 @@
+/*
+ * create-adonisjs
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+/**
+ * List of adapters for configuring Inertia
+ */
+export const adapters = [
+    {
+        name: 'Vue 3',
+        alias: 'vue',
+    },
+    {
+        name: 'React',
+        alias: 'react',
+    },
+    {
+        name: 'Svelte',
+        alias: 'svelte',
+    },
+    {
+        name: 'Solid.js',
+        alias: 'solid',
+    },
+    {
+        name: 'Skip',
+        hint: 'I want to configure Inertia by myself.',
+        alias: undefined,
+    },
+];

package/build/src/templates.js

@@ -28,4 +28,10 @@ export const templates = [
         hint: 'AdonisJS app tailored for creating JSON APIs',
         source: 'github:adonisjs/api-starter-kit',
     },
+    {
+        name: 'Inertia Starter Kit',
+        alias: 'inertia',
+        hint: 'AdonisJS app with Inertia.JS and your favorite frontend framework',
+        source: 'github:adonisjs/inertia-starter-kit',
+    },
 ];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "create-adonisjs",
   "description": "Scaffold new AdonisJS applications using starter kits",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "main": "build/index.js",
   "type": "module",
   "files": [