create-adonisjs 2.1.1 → 2.2.1

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
 
@@ -85,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,19 +302,23 @@ 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}"`);
@@ -319,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') {
@@ -364,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.1",
+  "version": "2.2.1",
   "main": "build/index.js",
   "type": "module",
   "files": [
@@ -30,35 +30,35 @@
     "test": "c8 npm run quick:test",
     "prebuild": "npm run lint && npm run clean",
     "build": "tsc",
-    "release": "np",
+    "release": "release-it",
     "version": "npm run build",
     "prepublishOnly": "npm run build"
   },
   "devDependencies": {
-    "@adonisjs/eslint-config": "^1.2.1",
-    "@adonisjs/prettier-config": "^1.2.1",
-    "@adonisjs/tsconfig": "^1.2.1",
-    "@japa/assert": "^2.1.0",
-    "@japa/file-system": "^2.2.0",
-    "@japa/runner": "^3.1.1",
-    "@swc/core": "^1.3.104",
-    "@types/gradient-string": "^1.1.5",
-    "@types/node": "^20.11.5",
+    "@adonisjs/eslint-config": "^1.3.0",
+    "@adonisjs/prettier-config": "^1.3.0",
+    "@adonisjs/tsconfig": "^1.3.0",
+    "@japa/assert": "^3.0.0",
+    "@japa/file-system": "^2.3.0",
+    "@japa/runner": "^3.1.4",
+    "@swc/core": "^1.4.16",
+    "@types/gradient-string": "^1.1.6",
+    "@types/node": "^20.12.7",
     "@types/which-pm-runs": "^1.0.2",
     "c8": "^9.1.0",
     "copyfiles": "^2.4.1",
     "del-cli": "^5.0.0",
     "eslint": "^8.56.0",
-    "np": "^9.2.0",
-    "prettier": "^3.2.4",
+    "prettier": "^3.2.5",
+    "release-it": "^17.2.0",
     "ts-node": "^10.9.2",
-    "typescript": "^5.3.3"
+    "typescript": "^5.4.5"
   },
   "dependencies": {
     "@adonisjs/ace": "^13.0.0",
-    "@antfu/install-pkg": "^0.3.1",
+    "@antfu/install-pkg": "^0.3.2",
     "execa": "^8.0.1",
-    "giget": "^1.2.1",
+    "giget": "^1.2.3",
     "gradient-string": "^2.0.2",
     "which-pm-runs": "^1.1.0"
   },
@@ -87,12 +87,6 @@
     "access": "public",
     "tag": "latest"
   },
-  "np": {
-    "message": "chore(release): %s",
-    "tag": "latest",
-    "branch": "main",
-    "anyBranch": false
-  },
   "c8": {
     "reporter": [
       "text",
@@ -103,5 +97,22 @@
       "tmp/**",
       "bin/**"
     ]
+  },
+  "release-it": {
+    "git": {
+      "commitMessage": "chore(release): ${version}",
+      "tagAnnotation": "v${version}",
+      "tagName": "v${version}"
+    },
+    "hooks": {
+      "before:init": [
+        "npm test"
+      ]
+    },
+    "github": {
+      "release": true,
+      "releaseName": "v${version}",
+      "web": true
+    }
   }
 }