create-adonisjs 1.1.0 → 1.2.0

package/README.md

@@ -1,14 +1,13 @@
 # create-adonisjs
-
-![image](https://github.com/adonisjs/create-adonisjs/assets/8337858/97c07232-dd6b-415b-88e7-571941da21e3)
-
+Scaffold a new AdonisJS application using starter kits
 
 <br />
 
 [![gh-workflow-image]][gh-workflow-url] [![npm-image]][npm-url] ![][typescript-image] [![license-image]][license-url] [![snyk-image]][snyk-url]
 
-## Introduction
-Scaffolding tool for AdonisJS applications. You can choose between 3 different starter kits :
+## Starter kits
+
+You can use between one of the following official starter kits, or bring your own using the `--kit` flag.
 
 - `api` : AdonisJS application tailored for building HTTP APIs.
 - `web` : AdonisJS application tailored for building server-side rendered applications.
@@ -38,11 +37,12 @@ npm init adonisjs my-app
 ```
 
 This argument is optional and the command will prompt you to enter the directory name if not provided.
-Note that the directory must be empty otherwise the command will fail.  
+
+> **Note** - The directory must be empty otherwise the command will fail.
 
 ### `--kit`
 
-If you have your own starter kit hosted on Gitlab/Github/Bitbucket, then you can pass it as follows:
+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
 npm init adonisjs -- -K="github:github_user/repo"
@@ -72,34 +72,41 @@ If you are using a custom starter kit hosted on a private repository, then you c
 npm init adonisjs -- -K="github:github_user/repo" -t="github_token"
 ```
 
+### `--pkg`
+
+We are trying to detect the package manager used by your project. However, if you want to force a specific package manager, then you can pass it as follows:
+
+```sh
+npm init adonisjs -- --pkg="yarn"
+```
+
 ### Other options
 
-| Option | Description |
-|--------|-------------|
-| `--skip-install` | Skip installing dependencies. |
+| Option            | Description                       |
+| ----------------- | --------------------------------- |
+| `--skip-install`  | Skip installing dependencies.     |
 | `--skip-git-init` | Skip initializing git repository. |
 
 ## Contributing
+
 One of the primary goals of AdonisJS is to have a vibrant community of users and contributors who believes in the principles of the framework.
 
 We encourage you to read the [contribution guide](https://github.com/adonisjs/.github/blob/main/docs/CONTRIBUTING.md) before contributing to the framework.
 
 ## Code of Conduct
+
 In order to ensure that the AdonisJS community is welcoming to all, please review and abide by the [Code of Conduct](https://github.com/adonisjs/.github/blob/main/docs/CODE_OF_CONDUCT.md).
 
 ## License
+
 create-adonisjs is open-sourced software licensed under the [MIT license](LICENSE.md).
 
 [gh-workflow-image]: https://img.shields.io/github/actions/workflow/status/adonisjs/create-adonisjs/test.yml?style=for-the-badge
-[gh-workflow-url]: https://github.com/adonisjs/create-adonisjs/actions/workflows/test.yml "Github action"
-
+[gh-workflow-url]: https://github.com/adonisjs/create-adonisjs/actions/workflows/test.yml 'Github action'
 [npm-image]: https://img.shields.io/npm/v/@adonisjs/create-adonisjs/latest.svg?style=for-the-badge&logo=npm
-[npm-url]: https://www.npmjs.com/package/@adonisjs/create-adonisjs/v/latest "npm"
-
+[npm-url]: https://www.npmjs.com/package/@adonisjs/create-adonisjs/v/latest 'npm'
 [typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
-
 [license-url]: LICENSE.md
 [license-image]: https://img.shields.io/github/license/adonisjs/create-adonisjs?style=for-the-badge
-
 [snyk-image]: https://img.shields.io/snyk/vulnerabilities/github/adonisjs/create-adonisjs?label=Snyk%20Vulnerabilities&style=for-the-badge
-[snyk-url]: https://snyk.io/test/github/adonisjs/create-adonisjs?targetFile=package.json "snyk"
+[snyk-url]: https://snyk.io/test/github/adonisjs/create-adonisjs?targetFile=package.json 'snyk'

package/build/{src/install_adonis.d.ts → commands/main.d.ts}

@@ -1,5 +1,5 @@
 import { BaseCommand } from '@adonisjs/ace';
-export declare class InstallAdonis extends BaseCommand {
+export declare class CreateNewApp extends BaseCommand {
     #private;
     static commandName: string;
     static description: string;
@@ -17,11 +17,11 @@ export declare class InstallAdonis extends BaseCommand {
      */
     kit?: string;
     /**
-     * Authentication token to download private templates kit
+     * Authentication token to download private templates
      */
     token?: string;
     /**
-     * Skip dependencies installation
+     * Skip packages installation
      */
     skipInstall: boolean;
     /**

package/build/{src/install_adonis.js → commands/main.js}

@@ -12,61 +12,56 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
-import { copyFile, readFile, writeFile } from 'node:fs/promises';
-import { existsSync } from 'node:fs';
-import { join, relative } from 'node:path';
+import { execa } from 'execa';
 import { cwd } from 'node:process';
-import { BaseCommand, args, flags } from '@adonisjs/ace';
-import detectPackageManager from 'which-pm-runs';
-import { downloadTemplate } from 'giget';
+import { existsSync } from 'node:fs';
 import gradient from 'gradient-string';
-import { execa } from 'execa';
-import { templates } from './templates.js';
-export class InstallAdonis extends BaseCommand {
+import { downloadTemplate } from 'giget';
+import { isAbsolute, join, relative } from 'node:path';
+import detectPackageManager from 'which-pm-runs';
+import { BaseCommand, args, flags } from '@adonisjs/ace';
+import { copyFile, readFile, unlink, writeFile } from 'node:fs/promises';
+import { templates } from '../src/templates.js';
+export class CreateNewApp extends BaseCommand {
     static commandName = 'create-adonisjs';
-    static description = 'Install AdonisJS';
+    static description = 'Create a new AdonisJS application using a starter kit';
     /**
      * Whether or not dependencies were installed
      */
-    #hasInstalledDependencies;
+    #shouldInstallDependencies;
     /**
      * Print the title
      */
     #printTitle() {
-        const adonisGradient = gradient([
-            { color: '#5A45FF', pos: 0 },
-            { color: '#7c6dff', pos: 0.2 },
-        ]);
         const title = Buffer.from('CiAgICBfX18gICAgICAgX18gICAgICAgICAgICBfICAgICAgICAgIF8gICAgIAogICAvICAgfCBfX19fLyAvX19fICBfX19fICAoXylfX19fICAgIChfKV9fX18KICAvIC98IHwvIF9fICAvIF9fIFwvIF9fIFwvIC8gX19fLyAgIC8gLyBfX18vCiAvIF9fXyAvIC9fLyAvIC9fLyAvIC8gLyAvIChfXyAgKSAgIC8gKF9fICApIAovXy8gIHxfXF9fLF8vXF9fX18vXy8gL18vXy9fX19fKF8pXy8gL19fX18vICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAvX19fLyAgICAgICAg==', 'base64').toString();
         this.logger.log('');
-        this.logger.log(`${adonisGradient.multiline(title)}`);
-        this.logger.log('');
-        this.logger.log(this.colors.italic(`          A fully-featured web\n          framework for Node.js`));
-        this.logger.log('');
+        this.logger.log(`${gradient.mind(title)}`);
         this.logger.log('');
     }
     /**
      * Prompt for the destination directory
      */
-    async #promptDestination() {
-        if (this.destination)
-            return;
-        this.destination = await this.prompt.ask('Where should we create the project?', {
-            default: `./` + relative(cwd(), './my-adonisjs-app'),
-        });
+    async #setDestination() {
+        if (!this.destination) {
+            this.destination = await this.prompt.ask('Where should we create the project?', {
+                default: `./` + relative(cwd(), './my-adonisjs-app'),
+                result(dir) {
+                    return isAbsolute(dir) ? dir : join(cwd(), dir);
+                },
+            });
+        }
     }
     /**
      * Prompt and download the selected template
      */
     async #downloadTemplate() {
-        let templateSource = this.kit;
-        if (!templateSource) {
-            const template = await this.prompt.choice('Which template do you want to use?', templates);
-            templateSource = templates.find((t) => t.name === template).source;
+        if (!this.kit) {
+            const template = await this.prompt.choice('Select the template you want to use', templates);
+            this.kit = templates.find((t) => t.name === template).source;
         }
-        const spinner = this.logger.await(`Downloading ${templateSource} template`).start();
+        const spinner = this.logger.await(`Downloading ${this.kit} template`).start();
         try {
-            await downloadTemplate(templateSource, { dir: this.destination, auth: this.token });
+            await downloadTemplate(this.kit, { dir: this.destination, auth: this.token });
             spinner.update('Template downloaded successfully').stop();
         }
         catch (error) {
@@ -78,11 +73,13 @@ export class InstallAdonis extends BaseCommand {
      * Install dependencies with the detected package manager
      */
     async #installDependencies() {
-        if (this.skipInstall)
+        if (this.skipInstall) {
             return;
-        this.#hasInstalledDependencies = await this.prompt.confirm('Do you want to install dependencies?', { hint: this.packageManager + ' will be used', default: true });
-        if (!this.#hasInstalledDependencies)
+        }
+        this.#shouldInstallDependencies = await this.prompt.confirm('Do you want to install dependencies?', { hint: this.packageManager + ' will be used', default: true });
+        if (!this.#shouldInstallDependencies) {
             return;
+        }
         const spinner = this.logger
             .await(`Installing dependencies using ${this.packageManager}`)
             .start();
@@ -100,13 +97,15 @@ export class InstallAdonis extends BaseCommand {
      * Init git repository inside the destination directory
      */
     async #initGitRepo() {
-        if (this.skipGitInit)
+        if (this.skipGitInit) {
             return;
+        }
         const shouldInit = await this.prompt.confirm('Do you want to initialize a git repository?', {
             default: true,
         });
-        if (!shouldInit)
+        if (!shouldInit) {
             return;
+        }
         try {
             await execa('git', ['init'], { cwd: this.destination });
             this.logger.success('Git repository initialized successfully');
@@ -116,22 +115,6 @@ export class InstallAdonis extends BaseCommand {
             throw error;
         }
     }
-    /**
-     * Print the success message
-     */
-    #printSuccessMessage() {
-        this.logger.log('');
-        this.ui
-            .sticker()
-            .heading('Your AdonisJS project was created successfully !')
-            .add(`1. ${this.colors.magenta('cd ' + relative(cwd(), this.destination))}`)
-            .add(`2. ${this.colors.magenta(`${this.packageManager} run dev`)}`)
-            .add(`3. ${this.colors.magenta('Visit http://localhost:3333')}`)
-            .add('')
-            .add(`Have any questions?`)
-            .add(`Join our Discord server: ${this.colors.magenta('https://discord.gg/vDcEjq6')}`)
-            .render();
-    }
     /**
      * Replace the package.json name with the destination directory name
      */
@@ -147,8 +130,9 @@ export class InstallAdonis extends BaseCommand {
     async #copyEnvExampleFile() {
         const envExamplePath = join(this.destination, '.env.example');
         const hasEnvExample = existsSync(envExamplePath);
-        if (!hasEnvExample)
+        if (!hasEnvExample) {
             return;
+        }
         const envPath = join(this.destination, '.env');
         await copyFile(envExamplePath, envPath);
     }
@@ -156,8 +140,9 @@ export class InstallAdonis extends BaseCommand {
      * Generate a fresh app key
      */
     async #generateFreshAppKey() {
-        if (!this.#hasInstalledDependencies)
+        if (!this.#shouldInstallDependencies) {
             return;
+        }
         try {
             await execa('node', ['ace', 'generate:key'], { cwd: this.destination });
         }
@@ -165,6 +150,31 @@ export class InstallAdonis extends BaseCommand {
             this.logger.warning('Failed to generate app key : ' + error.stderr);
         }
     }
+    /**
+     * Optionally removes readme file
+     */
+    async #removeReadmeFile() {
+        try {
+            await unlink(join(this.destination, 'README.md'));
+        }
+        catch { }
+    }
+    /**
+     * Print the success message
+     */
+    #printSuccessMessage() {
+        this.logger.log('');
+        this.ui
+            .instructions()
+            .heading('Your AdonisJS project has been created successfully!')
+            .add(this.colors.cyan('cd ' + relative(cwd(), this.destination)))
+            .add(this.colors.cyan(`${this.packageManager} run dev`))
+            .add(this.colors.cyan('Open http://localhost:3333'))
+            .add('')
+            .add(`Have any questions?`)
+            .add(`Join our Discord server - ${this.colors.yellow('https://discord.gg/vDcEjq6')}`)
+            .render();
+    }
     /**
      * Execute the `run` method and catch errors
      */
@@ -186,31 +196,36 @@ export class InstallAdonis extends BaseCommand {
             this.packageManager = detectPackageManager()?.name || 'npm';
         }
         this.#printTitle();
-        await this.#promptDestination();
+        await this.#setDestination();
         await this.#downloadTemplate();
         await this.#installDependencies();
         await this.#initGitRepo();
         await this.#replacePackageJsonName();
         await this.#copyEnvExampleFile();
         await this.#generateFreshAppKey();
+        await this.#removeReadmeFile();
         this.#printSuccessMessage();
     }
 }
 __decorate([
     args.string({ description: 'Destination directory', name: 'destination', required: false })
-], InstallAdonis.prototype, "destination", void 0);
+], CreateNewApp.prototype, "destination", void 0);
 __decorate([
-    flags.string({ description: 'Starter kit to use', name: 'kit', alias: 'K' })
-], InstallAdonis.prototype, "kit", void 0);
+    flags.string({ description: 'Define path to a custom git repository', name: 'kit', alias: 'K' })
+], CreateNewApp.prototype, "kit", void 0);
 __decorate([
-    flags.string({ description: 'Authentication token', name: 'token', alias: 't' })
-], InstallAdonis.prototype, "token", void 0);
+    flags.string({
+        description: 'Pass the authentication token to download private repositories',
+        name: 'token',
+        alias: 't',
+    })
+], CreateNewApp.prototype, "token", void 0);
 __decorate([
-    flags.boolean({ description: 'Skip dependencies installation', name: 'skip-install' })
-], InstallAdonis.prototype, "skipInstall", void 0);
+    flags.boolean({ description: 'Skip packages installation', name: 'skip-install' })
+], CreateNewApp.prototype, "skipInstall", void 0);
 __decorate([
     flags.boolean({ description: 'Skip git initialization', name: 'skip-git-init' })
-], InstallAdonis.prototype, "skipGitInit", void 0);
+], CreateNewApp.prototype, "skipGitInit", void 0);
 __decorate([
-    flags.string({ description: 'Force a package manager to be used', name: 'package-manager' })
-], InstallAdonis.prototype, "packageManager", void 0);
+    flags.string({ description: 'Explicitly define the package manager to npm', name: 'pkg' })
+], CreateNewApp.prototype, "packageManager", void 0);

package/build/index.js

@@ -7,8 +7,8 @@
  * file that was distributed with this source code.
  */
 import { HelpCommand, Kernel } from '@adonisjs/ace';
-import { InstallAdonis } from './src/install_adonis.js';
-Kernel.defaultCommand = InstallAdonis;
+import { CreateNewApp } from './commands/main.js';
+Kernel.defaultCommand = CreateNewApp;
 export const kernel = Kernel.create();
 kernel.defineFlag('help', {
     type: 'boolean',

package/build/src/templates.js

@@ -12,17 +12,17 @@
 export const templates = [
     {
         name: 'Slim Starter Kit',
-        hint: 'Smallest possible AdonisJS application with just the core and Japa',
+        hint: 'A lean AdonisJS application with just the framework core',
         source: 'github:adonisjs/slim-starter-kit',
     },
-    {
-        name: 'Web Starter Kit',
-        hint: 'for building web applications',
-        source: 'github:adonisjs/web-starter-kit',
-    },
-    {
-        name: 'API Starter Kit',
-        hint: 'for building APIs',
-        source: 'github:adonisjs/api-starter-kit',
-    },
+    // {
+    //   name: 'Web Starter Kit',
+    //   hint: 'Everything you need to build a server render app',
+    //   source: 'github:adonisjs/web-starter-kit',
+    // },
+    // {
+    //   name: 'API Starter Kit',
+    //   hint: 'AdonisJS app tailored for creating JSON APIs',
+    //   source: 'github:adonisjs/api-starter-kit',
+    // },
 ];

package/package.json

@@ -1,14 +1,12 @@
 {
   "name": "create-adonisjs",
-  "description": "Scaffolding tool to create AdonisJS 6 projects",
-  "version": "1.1.0",
-  "engines": {
-    "node": ">=18.16.0"
-  },
+  "description": "Scaffold new AdonisJS applications using starter kits",
+  "version": "1.2.0",
   "main": "build/index.js",
   "type": "module",
   "files": [
     "build/bin",
+    "build/commands",
     "build/src",
     "build/index.d.ts",
     "build/index.js"
@@ -19,6 +17,9 @@
   "exports": {
     ".": "./build/index.js"
   },
+  "engines": {
+    "node": ">=18.16.0"
+  },
   "scripts": {
     "clean": "del-cli build",
     "typecheck": "tsc --noEmit",
@@ -34,9 +35,9 @@
     "prepublishOnly": "npm run build"
   },
   "devDependencies": {
-    "@adonisjs/eslint-config": "^1.1.7",
-    "@adonisjs/prettier-config": "^1.1.7",
-    "@adonisjs/tsconfig": "^1.1.7",
+    "@adonisjs/eslint-config": "^1.1.8",
+    "@adonisjs/prettier-config": "^1.1.8",
+    "@adonisjs/tsconfig": "^1.1.8",
     "@japa/assert": "^2.0.0-1",
     "@japa/file-system": "^2.0.0-1",
     "@japa/runner": "^3.0.0-5",
@@ -47,9 +48,9 @@
     "c8": "^8.0.0",
     "copyfiles": "^2.4.1",
     "del-cli": "^5.0.0",
-    "eslint": "^8.44.0",
+    "eslint": "^8.45.0",
     "np": "^8.0.4",
-    "prettier": "^2.8.8",
+    "prettier": "^3.0.0",
     "ts-node": "^10.9.1",
     "typescript": "^5.1.6"
   },
@@ -62,7 +63,10 @@
   },
   "author": "julien-r44,virk",
   "license": "MIT",
-  "keywords": [],
+  "keywords": [
+    "adonisjs",
+    "create-adonisjs-app"
+  ],
   "eslintConfig": {
     "extends": "@adonisjs/eslint-config/package"
   },
@@ -83,7 +87,9 @@
       "html"
     ],
     "exclude": [
-      "tests/**"
+      "tests/**",
+      "tmp/**",
+      "bin/**"
     ]
   }
 }