create-adonisjs 2.2.1 → 2.4.0

package/README.md

@@ -112,12 +112,10 @@ npm init adonisjs -- --kit="web" --db="mysql"
 
 ### Other options
 
-| Option         | Description                                                                             |
-| -------------- | --------------------------------------------------------------------------------------- |
-| `--install`    | Install dependencies. A prompt will be shown when the flag is not mentioned explicitly. |
-| `--git-init`   | Initialize git repository.                                                              |
-| `--no-install` | Explicitly opt out from installing dependencies and skip the prompt                     |
-| `--verbose`    | Enable verbose mode to display all logs                                                 |
+| Option       | Description                             |
+| ------------ | --------------------------------------- |
+| `--git-init` | Initialize git repository.              |
+| `--verbose`  | Enable verbose mode to display all logs |
 
 ## Debugging errors
 

package/build/commands/main.d.ts

@@ -23,11 +23,6 @@ export declare class CreateNewApp extends BaseCommand {
      * Authentication token to download private templates
      */
     token?: string;
-    /**
-     * Auto install packages after creating the project. Display prompt
-     * when flag is not mentioned.
-     */
-    install?: boolean;
     /**
      * Init git repository. Do not init when flag is not mentioned.
      */

package/build/commands/main.js

@@ -34,7 +34,7 @@ const INERTIA_STARTER_KIT = 'github:adonisjs/inertia-starter-kit';
  */
 export class CreateNewApp extends BaseCommand {
     static commandName = 'create-adonisjs';
-    static description = 'Create a new AdonisJS application using a starter kit';
+    static description = 'Create a new AdonisJS application';
     /**
      * Runs bash command using execa with shared defaults
      */
@@ -78,7 +78,7 @@ export class CreateNewApp extends BaseCommand {
      */
     async #promptForDestination() {
         if (!this.destination) {
-            this.destination = await this.prompt.ask('Where should we create your new project?', {
+            this.destination = await this.prompt.ask('Where should we create your new project', {
                 default: './my-adonisjs-app',
             });
         }
@@ -94,7 +94,7 @@ export class CreateNewApp extends BaseCommand {
             /**
              * Display prompt when "kit" flag is not used.
              */
-            const template = await this.prompt.choice('Which starter kit would you like to use?', templates);
+            const template = await this.prompt.choice('Which starter kit would you like to use', templates);
             this.kit = templates.find((t) => t.name === template).source;
         }
         else {
@@ -115,8 +115,8 @@ export class CreateNewApp extends BaseCommand {
             /**
              * 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;
+            const database = await this.prompt.choice('Which database driver you want to use', databases);
+            this.db = database;
         }
     }
     /**
@@ -127,8 +127,8 @@ export class CreateNewApp extends BaseCommand {
             /**
              * 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;
+            const guard = await this.prompt.choice('Which authentication guard you want to use', authGuards);
+            this.authGuard = guard;
         }
     }
     /**
@@ -136,8 +136,8 @@ export class CreateNewApp extends BaseCommand {
      */
     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;
+            const adapter = await this.prompt.choice('Which frontend adapter you want to use with Inertia', adapters);
+            this.adapter = adapter;
         }
     }
     /**
@@ -145,18 +145,7 @@ export class CreateNewApp extends BaseCommand {
      */
     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?
-     */
-    async #promptForInstallingDeps() {
-        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)",
-            });
+            this.ssr = await this.prompt.confirm('Do you want to setup server-side rendering with Inertia');
         }
     }
     /**
@@ -199,16 +188,12 @@ export class CreateNewApp extends BaseCommand {
      * Generate a fresh app key. Errors are ignored
      */
     async #generateFreshAppKey() {
-        if (this.install === false) {
-            return;
-        }
         await this.#runBashCommand('node', ['ace', 'generate:key']);
     }
     /**
      * Configures the Lucid package
      */
     async #configureLucid() {
-        this.db = this.db || 'sqlite';
         const argv = ['ace', 'configure', '@adonisjs/lucid', '--db', this.db, '--install'];
         if (this.verbose) {
             argv.push('--verbose');
@@ -234,7 +219,6 @@ export class CreateNewApp extends BaseCommand {
      * Configures the Auth package
      */
     async #configureAuth() {
-        this.authGuard = this.authGuard || 'session';
         /**
          * Install the session package when using api starter kit with session
          * guard. This needs to be done, since the api starter kit does
@@ -256,7 +240,6 @@ export class CreateNewApp extends BaseCommand {
      * Configures the Inertia package
      */
     async #configureInertia() {
-        this.adapter = this.adapter || 'vue';
         const argv = [
             'ace',
             'configure',
@@ -264,7 +247,7 @@ export class CreateNewApp extends BaseCommand {
             '--adapter',
             this.adapter,
             this.ssr ? '--ssr' : '--no-ssr',
-            this.install ? '--install' : '--no-install',
+            '--install',
         ];
         if (this.verbose) {
             argv.push('--verbose');
@@ -295,7 +278,6 @@ export class CreateNewApp extends BaseCommand {
             await this.#promptForInertiaAdapter();
             await this.#promptForInertiaSsr();
         }
-        await this.#promptForInstallingDeps();
         /**
          * Create tasks instance for displaying
          * actions as tasks
@@ -306,19 +288,17 @@ export class CreateNewApp extends BaseCommand {
          * and installing dependencies
          */
         const configureLucid = [WEB_STARTER_KIT, API_STARTER_KIT, INERTIA_STARTER_KIT].includes(this.kit || '') &&
-            this.db !== undefined &&
-            this.install !== false;
+            this.db !== 'skip';
         /**
          * Configure auth when using our own starter kits
          * and installing dependencies
          */
         const configureAuth = [WEB_STARTER_KIT, API_STARTER_KIT, INERTIA_STARTER_KIT].includes(this.kit || '') &&
-            this.authGuard !== undefined &&
-            this.install !== false;
+            this.authGuard !== 'skip';
         /**
          * Configure inertia when using our inertia starter kit
          */
-        const configureInertia = this.kit === INERTIA_STARTER_KIT && this.db !== undefined && this.install !== false;
+        const configureInertia = this.kit === INERTIA_STARTER_KIT && this.adapter !== 'skip';
         tasks
             .add('Download starter kit', async (task) => {
             task.update(`Downloading "${this.kit}"`);
@@ -334,7 +314,7 @@ export class CreateNewApp extends BaseCommand {
             await this.#runBashCommand('git', ['init']);
             return 'Initialized git repository';
         })
-            .addIf(this.install !== false, 'Install packages', async (task) => {
+            .add('Install packages', async (task) => {
             const spinner = this.logger.await('installing dependencies', {
                 silent: this.verbose,
             });
@@ -440,19 +420,13 @@ __decorate([
 ], CreateNewApp.prototype, "kit", void 0);
 __decorate([
     flags.string({
-        description: 'Pass the authentication token to download private repositories',
+        description: 'Auth token to download private repositories',
         alias: 't',
     })
 ], CreateNewApp.prototype, "token", void 0);
 __decorate([
     flags.boolean({
-        description: 'Install packages after creating the project',
-        showNegatedVariantInHelp: true,
-    })
-], CreateNewApp.prototype, "install", void 0);
-__decorate([
-    flags.boolean({
-        description: 'Init Git repository using the "git init" command',
+        description: 'Init git repository',
     })
 ], CreateNewApp.prototype, "gitInit", void 0);
 __decorate([
@@ -468,17 +442,17 @@ __decorate([
 ], CreateNewApp.prototype, "db", void 0);
 __decorate([
     flags.string({
-        description: 'Define the authentication guard for the Auth package',
+        description: 'Define the authentication guard with the Auth package',
     })
 ], CreateNewApp.prototype, "authGuard", void 0);
 __decorate([
     flags.string({
-        description: 'Define the Inertia frontend adapter ( if using Inertia starter kit )',
+        description: 'Define the Inertia frontend adapter',
     })
 ], CreateNewApp.prototype, "adapter", void 0);
 __decorate([
     flags.boolean({
-        description: 'Define if SSR is needed ( if using Inertia starter kit )',
+        description: 'Enable SSR for Inertia',
     })
 ], CreateNewApp.prototype, "ssr", void 0);
 __decorate([

package/build/src/auth_guards.d.ts

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

package/build/src/auth_guards.js

@@ -6,23 +6,21 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+import { GUARDS } from '@adonisjs/presets/auth';
 /**
- * List of first party authentication guards
+ * List of known authentication guards
  */
 export const authGuards = [
+    ...Object.keys(GUARDS).map((guard) => {
+        return {
+            name: guard,
+            hint: GUARDS[guard].description,
+            message: GUARDS[guard].name,
+        };
+    }),
     {
-        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.',
+        name: 'skip',
+        message: 'Skip',
+        hint: 'I want to configure the Auth package manually',
     },
 ];

package/build/src/databases.d.ts

@@ -1,12 +1,11 @@
 /**
- * List of first party databases (lucid)
+ * List of known databases that can be used with Lucid
  */
 export declare const databases: ({
-    name: string;
-    alias: string;
-    hint?: undefined;
+    name: "sqlite" | "mysql" | "libsql" | "postgres" | "mssql";
+    message: string;
 } | {
     name: string;
+    message: string;
     hint: string;
-    alias: undefined;
 })[];

package/build/src/databases.js

@@ -6,29 +6,20 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+import { DIALECTS } from '@adonisjs/presets/lucid';
 /**
- * List of first party databases (lucid)
+ * List of known databases that can be used with Lucid
  */
 export const databases = [
+    ...Object.keys(DIALECTS).map((dialect) => {
+        return {
+            name: dialect,
+            message: DIALECTS[dialect].name,
+        };
+    }),
     {
-        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,
+        name: 'skip',
+        message: 'Skip',
+        hint: 'I want to configure Lucid manually',
     },
 ];

package/build/src/inertia_adapters.d.ts

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

package/build/src/inertia_adapters.js

@@ -11,24 +11,24 @@
  */
 export const adapters = [
     {
-        name: 'Vue 3',
-        alias: 'vue',
+        message: 'Vue 3',
+        name: 'vue',
     },
     {
-        name: 'React',
-        alias: 'react',
+        message: 'React',
+        name: 'react',
     },
     {
-        name: 'Svelte',
-        alias: 'svelte',
+        message: 'Svelte',
+        name: 'svelte',
     },
     {
-        name: 'Solid.js',
-        alias: 'solid',
+        message: 'Solid.js',
+        name: 'solid',
     },
     {
-        name: 'Skip',
-        hint: 'I want to configure Inertia by myself.',
-        alias: undefined,
+        name: 'skip',
+        message: 'Skip',
+        hint: 'I want to configure Interia manually',
     },
 ];

package/build/src/templates.js

@@ -31,7 +31,7 @@ export const templates = [
     {
         name: 'Inertia Starter Kit',
         alias: 'inertia',
-        hint: 'AdonisJS app with Inertia.JS and your favorite frontend framework',
+        hint: 'Inertia app with a frontend framework of your choice',
         source: 'github:adonisjs/inertia-starter-kit',
     },
 ];

package/package.json

@@ -1,7 +1,10 @@
 {
   "name": "create-adonisjs",
   "description": "Scaffold new AdonisJS applications using starter kits",
-  "version": "2.2.1",
+  "version": "2.4.0",
+  "engines": {
+    "node": ">=18.16.0"
+  },
   "main": "build/index.js",
   "type": "module",
   "files": [
@@ -17,9 +20,6 @@
   "exports": {
     ".": "./build/index.js"
   },
-  "engines": {
-    "node": ">=18.16.0"
-  },
   "scripts": {
     "clean": "del-cli build",
     "typecheck": "tsc --noEmit",
@@ -41,36 +41,31 @@
     "@japa/assert": "^3.0.0",
     "@japa/file-system": "^2.3.0",
     "@japa/runner": "^3.1.4",
-    "@swc/core": "^1.4.16",
+    "@swc/core": "^1.6.1",
     "@types/gradient-string": "^1.1.6",
-    "@types/node": "^20.12.7",
+    "@types/node": "^20.14.5",
     "@types/which-pm-runs": "^1.0.2",
-    "c8": "^9.1.0",
+    "c8": "^10.1.2",
     "copyfiles": "^2.4.1",
     "del-cli": "^5.0.0",
     "eslint": "^8.56.0",
-    "prettier": "^3.2.5",
-    "release-it": "^17.2.0",
+    "prettier": "^3.3.2",
+    "release-it": "^17.3.0",
     "ts-node": "^10.9.2",
     "typescript": "^5.4.5"
   },
   "dependencies": {
-    "@adonisjs/ace": "^13.0.0",
-    "@antfu/install-pkg": "^0.3.2",
-    "execa": "^8.0.1",
+    "@adonisjs/ace": "^13.1.0",
+    "@adonisjs/presets": "^2.6.1",
+    "@antfu/install-pkg": "^0.3.3",
+    "execa": "^9.2.0",
     "giget": "^1.2.3",
     "gradient-string": "^2.0.2",
     "which-pm-runs": "^1.1.0"
   },
   "author": "julien-r44,virk",
   "license": "MIT",
-  "keywords": [
-    "adonisjs",
-    "create-adonisjs-app"
-  ],
-  "directories": {
-    "test": "tests"
-  },
+  "homepage": "https://github.com/adonisjs/create-adonisjs#readme",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/adonisjs/create-adonisjs.git"
@@ -78,7 +73,13 @@
   "bugs": {
     "url": "https://github.com/adonisjs/create-adonisjs/issues"
   },
-  "homepage": "https://github.com/adonisjs/create-adonisjs#readme",
+  "keywords": [
+    "adonisjs",
+    "create-adonisjs-app"
+  ],
+  "directories": {
+    "test": "tests"
+  },
   "eslintConfig": {
     "extends": "@adonisjs/eslint-config/package"
   },
@@ -104,11 +105,6 @@
       "tagAnnotation": "v${version}",
       "tagName": "v${version}"
     },
-    "hooks": {
-      "before:init": [
-        "npm test"
-      ]
-    },
     "github": {
       "release": true,
       "releaseName": "v${version}",