create-adonisjs 1.0.0

package/LICENSE.md

@@ -0,0 +1,9 @@
+# The MIT License
+
+Copyright (c) 2023
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,105 @@
+# create-adonisjs
+
+![image](https://github.com/adonisjs/create-adonisjs/assets/8337858/97c07232-dd6b-415b-88e7-571941da21e3)
+
+
+<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 :
+
+- `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.
+
+## Usage
+
+```sh
+# Using npm
+npm init adonisjs
+
+# Using yarn
+yarn create adonisjs
+
+# Using pnpm
+pnpm create adonisjs
+```
+
+## Options
+
+### `destination`
+
+You can pass the destination directory as the first argument to the command. For example:
+
+```sh
+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.  
+
+### `--kit`
+
+If you have your own starter kit hosted on Gitlab/Github/Bitbucket, then you can pass it as follows:
+
+```sh
+npm init adonisjs -- -K="github:github_user/repo"
+
+# Download from GitLab
+npm init adonisjs -- -K="gitlab:user/repo"
+
+# Download from BitBucket
+npm init adonisjs -- -K="bitbucket:user/repo"
+```
+
+You can also pass specify the branch or tag name as follows:
+
+```sh
+# Branch name
+npm init adonisjs -- -K="github:github_user/repo#branch-name"
+
+# Tag name
+npm init adonisjs -- -K="github:github_user/repo#v1.0.0"
+```
+
+### `--token`
+
+If you are using a custom starter kit hosted on a private repository, then you can pass the authentication token as follows:
+
+```sh
+npm init adonisjs -- -K="github:github_user/repo" -t="github_token"
+```
+
+### Other options
+
+| 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"
+
+[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"
+
+[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"

package/build/bin/run.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/build/bin/run.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+import { kernel } from '../index.js';
+kernel.handle(process.argv.slice(2)).catch(console.error);

package/build/bin/test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/bin/test.js

@@ -0,0 +1,31 @@
+import { assert } from '@japa/assert';
+import { processCLIArgs, configure, run } from '@japa/runner';
+import { fileSystem } from '@japa/file-system';
+/*
+|--------------------------------------------------------------------------
+| Configure tests
+|--------------------------------------------------------------------------
+|
+| The configure method accepts the configuration to configure the Japa
+| tests runner.
+|
+| The first method call "processCLIArgs" process the command line arguments
+| and turns them into a config object. Using this method is not mandatory.
+|
+| Please consult japa.dev/runner-config for the config docs.
+*/
+processCLIArgs(process.argv.slice(2));
+configure({
+    files: ['tests/**/*.spec.ts'],
+    plugins: [assert(), fileSystem({ basePath: 'tmp', autoClean: true })],
+    timeout: 30 * 1000,
+});
+/*
+|--------------------------------------------------------------------------
+| Run tests
+|--------------------------------------------------------------------------
+|
+| The following "run" method is required to execute all the tests.
+|
+*/
+run();

package/build/index.d.ts

@@ -0,0 +1,2 @@
+import { Kernel } from '@adonisjs/ace';
+export declare const kernel: Kernel<typeof import("@adonisjs/ace").BaseCommand>;

package/build/index.js

@@ -0,0 +1,12 @@
+/*
+ * create-adonisjs
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { Kernel } from '@adonisjs/ace';
+import { InstallAdonis } from './src/install_adonis.js';
+Kernel.defaultCommand = InstallAdonis;
+export const kernel = Kernel.create();

package/build/src/install_adonis.d.ts

@@ -0,0 +1,39 @@
+import { BaseCommand } from '@adonisjs/ace';
+export declare class InstallAdonis extends BaseCommand {
+    #private;
+    static commandName: string;
+    static description: string;
+    /**
+     * The directory where the project will be created
+     */
+    destination: string;
+    /**
+     * The starter kit to use
+     *
+     * @example
+     *   --kit github_user/repo
+     *   --kit gitlab_user/repo#develop
+     *   --kit bitbucket_user/repo#2.0.0
+     */
+    kit?: string;
+    /**
+     * Authentication token to download private templates kit
+     */
+    token?: string;
+    /**
+     * Skip dependencies installation
+     */
+    skipInstall: boolean;
+    /**
+     * Skip git initialization
+     */
+    skipGitInit: boolean;
+    /**
+     * Execute the `run` method and catch errors
+     */
+    exec(): Promise<void>;
+    /**
+     * Main method
+     */
+    run(): Promise<void>;
+}

package/build/src/install_adonis.js

@@ -0,0 +1,220 @@
+/*
+ * create-adonisjs
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    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 { cwd } from 'node:process';
+import { BaseCommand, args, flags } from '@adonisjs/ace';
+import detectPackageManager from 'which-pm-runs';
+import { downloadTemplate } from 'giget';
+import gradient from 'gradient-string';
+import { execa } from 'execa';
+import { templates } from './templates.js';
+export class InstallAdonis extends BaseCommand {
+    static commandName = 'install-adonisjs';
+    static description = 'Install AdonisJS';
+    /**
+     * The detected package manager ( based on agent )
+     */
+    #detectedPkgManager;
+    /**
+     * Whether or not dependencies were installed
+     */
+    #hasInstalledDependencies;
+    /**
+     * 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('');
+    }
+    /**
+     * 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'),
+        });
+    }
+    /**
+     * Prompt and download the selected template
+     */
+    async #downloadTemplate() {
+        this.logger.log('');
+        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;
+        }
+        const spinner = this.logger.await(`Downloading ${templateSource} template`).start();
+        try {
+            await downloadTemplate(templateSource, { dir: this.destination, auth: this.token });
+            spinner.update('Template downloaded successfully').stop();
+        }
+        catch (error) {
+            spinner.update('Failed to download template').stop();
+            throw error;
+        }
+    }
+    /**
+     * Install dependencies with the detected package manager
+     */
+    async #installDependencies() {
+        if (this.skipInstall)
+            return;
+        this.logger.log('');
+        const pkgManager = this.#detectedPkgManager;
+        this.#hasInstalledDependencies = await this.prompt.confirm('Do you want to install dependencies?', {
+            hint: pkgManager + ' will be used',
+            default: true,
+        });
+        if (!this.#hasInstalledDependencies)
+            return;
+        const spinner = this.logger.await(`Installing dependencies using ${pkgManager}`).start();
+        try {
+            await execa(pkgManager, ['install'], { cwd: this.destination });
+            spinner.update('Dependencies installed successfully').stop();
+        }
+        catch (error) {
+            spinner.stop();
+            this.error = `Failed to install dependencies :\n${error.stderr}`;
+            throw error;
+        }
+    }
+    /**
+     * Init git repository inside the destination directory
+     */
+    async #initGitRepo() {
+        if (this.skipGitInit)
+            return;
+        this.logger.log('');
+        const shouldInit = await this.prompt.confirm('Do you want to initialize a git repository?', {
+            default: true,
+        });
+        if (!shouldInit)
+            return;
+        try {
+            await execa('git', ['init'], { cwd: this.destination });
+            this.logger.success('Git repository initialized successfully');
+        }
+        catch (error) {
+            this.error = `Failed to initialize git repository :\n${error.stderr}`;
+            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.#detectedPkgManager} run dev`)}`)
+            .add(`3. ${this.colors.magenta('Visit http://localhost:3333')}`)
+            .add('')
+            .add(`Have any questions? Join our Discord server: ${this.colors.magenta('https://discord.gg/vDcEjq6')}`)
+            .render();
+        this.logger.log('');
+    }
+    /**
+     * Replace the package.json name with the destination directory name
+     */
+    async #replacePackageJsonName() {
+        const pkgJsonPath = join(this.destination, 'package.json');
+        const pkgJson = await readFile(pkgJsonPath, 'utf-8').then(JSON.parse);
+        pkgJson.name = relative(cwd(), this.destination);
+        await writeFile(pkgJsonPath, JSON.stringify(pkgJson, null, 2));
+    }
+    /**
+     * If starter template has an `.env.example` file, then copy it to `.env`
+     */
+    async #copyEnvExampleFile() {
+        const envExamplePath = join(this.destination, '.env.example');
+        const hasEnvExample = existsSync(envExamplePath);
+        if (!hasEnvExample)
+            return;
+        const envPath = join(this.destination, '.env');
+        await copyFile(envExamplePath, envPath);
+    }
+    /**
+     * Generate a fresh app key
+     */
+    async #generateFreshAppKey() {
+        if (!this.#hasInstalledDependencies)
+            return;
+        try {
+            await execa('node', ['ace', 'generate:key'], { cwd: this.destination });
+        }
+        catch (error) {
+            this.logger.warning('Failed to generate app key : ' + error.stderr);
+        }
+    }
+    /**
+     * Execute the `run` method and catch errors
+     */
+    async exec() {
+        this.hydrate();
+        try {
+            await this.run();
+        }
+        catch (error) {
+            this.logger.fatal(this.error || error.message);
+            this.exitCode = 1;
+        }
+    }
+    /**
+     * Main method
+     */
+    async run() {
+        this.#detectedPkgManager = detectPackageManager()?.name || 'npm';
+        this.#printTitle();
+        await this.#promptDestination();
+        await this.#downloadTemplate();
+        await this.#installDependencies();
+        await this.#initGitRepo();
+        await this.#replacePackageJsonName();
+        await this.#copyEnvExampleFile();
+        await this.#generateFreshAppKey();
+        this.#printSuccessMessage();
+    }
+}
+__decorate([
+    args.string({ description: 'Destination directory', name: 'destination', required: false })
+], InstallAdonis.prototype, "destination", void 0);
+__decorate([
+    flags.string({ description: 'Starter kit to use', name: 'kit', alias: 'K' })
+], InstallAdonis.prototype, "kit", void 0);
+__decorate([
+    flags.string({ description: 'Authentication token', name: 'token', alias: 't' })
+], InstallAdonis.prototype, "token", void 0);
+__decorate([
+    flags.boolean({ description: 'Skip dependencies installation', name: 'skip-install' })
+], InstallAdonis.prototype, "skipInstall", void 0);
+__decorate([
+    flags.boolean({ description: 'Skip git initialization', name: 'skip-git-init' })
+], InstallAdonis.prototype, "skipGitInit", void 0);

package/build/src/templates.d.ts

@@ -0,0 +1,8 @@
+/**
+ * List of first party templates
+ */
+export declare const templates: {
+    name: string;
+    hint: string;
+    source: string;
+}[];

package/build/src/templates.js

@@ -0,0 +1,23 @@
+/*
+ * 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 templates
+ */
+export const templates = [
+    {
+        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',
+    },
+];

package/package.json

@@ -0,0 +1,90 @@
+{
+  "name": "create-adonisjs",
+  "description": "Scaffolding tool to create AdonisJS 6 projects",
+  "version": "1.0.0",
+  "engines": {
+    "node": ">=18.16.0"
+  },
+  "main": "build/index.js",
+  "type": "module",
+  "files": [
+    "build/bin",
+    "build/src",
+    "build/index.d.ts",
+    "build/index.js"
+  ],
+  "bin": {
+    "create-adonisjs": "./build/bin/run.js"
+  },
+  "exports": {
+    ".": "./build/index.js"
+  },
+  "scripts": {
+    "clean": "del-cli build",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint . --ext=.ts",
+    "format": "prettier --write .",
+    "quick:test": "node --enable-source-maps --loader=ts-node/esm bin/test.ts",
+    "pretest": "npm run lint",
+    "test": "c8 npm run quick:test",
+    "prebuild": "npm run lint && npm run clean",
+    "build": "tsc",
+    "release": "np",
+    "version": "npm run build",
+    "prepublishOnly": "npm run build"
+  },
+  "devDependencies": {
+    "@adonisjs/core": "^6.1.5-5",
+    "@adonisjs/eslint-config": "^1.1.7",
+    "@adonisjs/prettier-config": "^1.1.7",
+    "@adonisjs/tsconfig": "^1.1.7",
+    "@japa/assert": "2.0.0-1",
+    "@japa/file-system": "2.0.0-1",
+    "@japa/runner": "3.0.0-3",
+    "@swc/core": "^1.3.68",
+    "@types/gradient-string": "^1.1.2",
+    "@types/node": "^20.3.3",
+    "@types/which-pm-runs": "^1.0.0",
+    "c8": "^8.0.0",
+    "copyfiles": "^2.4.1",
+    "del-cli": "^5.0.0",
+    "eslint": "^8.44.0",
+    "np": "^8.0.4",
+    "prettier": "^2.8.8",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.1.6"
+  },
+  "dependencies": {
+    "@adonisjs/ace": "12.3.1-8",
+    "execa": "^7.1.1",
+    "giget": "^1.1.2",
+    "gradient-string": "^2.0.2",
+    "which-pm-runs": "^1.1.0"
+  },
+  "author": "julien-r44,virk",
+  "license": "MIT",
+  "keywords": [],
+  "eslintConfig": {
+    "extends": "@adonisjs/eslint-config/package"
+  },
+  "prettier": "@adonisjs/prettier-config",
+  "publishConfig": {
+    "access": "public",
+    "tag": "latest"
+  },
+  "np": {
+    "message": "chore(release): %s",
+    "tag": "latest",
+    "branch": "main",
+    "anyBranch": false
+  },
+  "c8": {
+    "reporter": [
+      "text",
+      "html"
+    ],
+    "exclude": [
+      "tests/**"
+    ]
+  }
+}