@dhis2/create-app 5.2.0-alpha.9 → 5.2.0

package/README.md

@@ -1,4 +1,23 @@
-# create-app
+# @dhis2/create-app
 
-> This package is part of the [@dhis2/cli](https://github.com/dhis2/cli)
-> commandline interface.
+This package publishes a package that follows the convention of [npm create](https://docs.npmjs.com/cli/v11/commands/npm-init#synopsis).
+
+This allows users to create a new DHIS2 web application by running the command:
+
+```sh
+# with pnpm
+pnpm create @dhis2/app project-name --yes
+#
+```
+
+```sh
+# with npm
+npx @dhis2/create-app --yes
+# npm create @dhis2/app -- --yes
+```
+
+By passing `--yes` argument, this will create a new DHIS2 web application using the default options without prompting (using `pnpm` as a package manager, and `TypeScript` as the language).
+
+If you omit the `--yes` argument `pnpm create @dhis2/app project-name` then you will be prompted and guided through a wizard to choose your options.
+
+You can run the commands in `debug` mode to get more verbose logs by passing the `--debug` option (`pnpm create @dhis2/app project-name --debug`).

package/bin/d2-create

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+const { makeEntryPoint } = require('@dhis2/cli-helpers-engine')
+
+const command = require(`..`)
+
+makeEntryPoint(command)

package/package.json

@@ -1,19 +1,23 @@
 {
     "name": "@dhis2/create-app",
-    "version": "5.2.0-alpha.9",
-    "description": "D2 frontend application bootstrapping inspired by create-react-app",
-    "main": "index.js",
-    "repository": "https://github.com/dhis2/cli",
-    "author": "Austin McGee <austin@dhis2.org>",
-    "license": "BSD-3-Clause",
-    "dependencies": {
-        "@dhis2/cli-create": "5.2.0-alpha.9",
-        "@dhis2/cli-helpers-engine": "^3.2.1"
+    "version": "5.2.0",
+    "description": "",
+    "main": "src/index.js",
+    "bin": {
+        "d2-create": "bin/d2-create"
+    },
+    "scripts": {
+        "test": "echo \"Error: no test specified\" && exit 1"
     },
-    "bin": "./bin/d2-create-app",
-    "engines": {
-        "node": ">=12"
+    "dependencies": {
+        "@dhis2/cli-app-scripts": "alpha",
+        "@dhis2/cli-helpers-engine": "^3.2.2",
+        "@inquirer/prompts": "^7.8.4"
     },
+    "private": false,
+    "keywords": [],
+    "author": "",
+    "license": "ISC",
     "publishConfig": {
         "access": "public"
     }

package/src/index.js

@@ -0,0 +1,104 @@
+const initCommand = require('@dhis2/cli-app-scripts/init')
+const { reporter, chalk } = require('@dhis2/cli-helpers-engine')
+const { input, select } = require('@inquirer/prompts')
+
+process.on('uncaughtException', (error) => {
+    if (error instanceof Error && error.name === 'ExitPromptError') {
+        console.log('👋 until next time!')
+    } else {
+        // Rethrow unknown errors
+        throw error
+    }
+})
+
+const commandHandler = {
+    command: '*', // default command
+    description: 'Initialize a new DHIS2 web application',
+    builder: {
+        yes: {
+            description:
+                'Skips interactive setup questions, accepting default options to create the new app (TypeScript, pnpm)',
+            type: 'boolean',
+            default: false,
+        },
+    },
+}
+
+const command = {
+    command: '[app]',
+    builder: (yargs) => {
+        yargs.command(commandHandler)
+    },
+    handler: async (argv) => {
+        let name = argv._[0] || argv.name
+
+        reporter.debug(
+            `running "npm create @dhis2/app" (or npx) command which is an alias to "d2 app scripts init"`
+        )
+        const useDefauls = argv.yes
+
+        if (!name) {
+            name = await input({
+                type: 'input',
+                name: 'name',
+                message: 'What is the name of the project?',
+                required: true,
+            })
+            reporter.log(`name of project: ${name}`)
+        }
+
+        let pnpm = true
+        let npm = false
+        let typeScript = argv.typescript || true
+        if (!useDefauls) {
+            const packageManager = await select({
+                message: 'Select a package manager',
+                default: 'pnpm',
+                choices: [
+                    { name: 'npm', value: 'npm' },
+                    { name: 'pnpm', value: 'pnpm' },
+                    { name: 'yarn 1 (legacy)', value: 'yarn' },
+                ],
+            })
+
+            pnpm = packageManager === 'pnpm'
+            npm = packageManager === 'npm'
+
+            const template = await select({
+                message: 'Select a template',
+                default: 'ts',
+                choices: [
+                    { name: 'JavaScript', value: 'js' },
+                    { name: 'TypeScript', value: 'ts' },
+                    {
+                        name: 'Custom (coming soon)',
+                        disabled: true,
+                        value: 'custom',
+                    },
+                ],
+            })
+
+            typeScript = template === 'ts'
+        }
+
+        if (useDefauls) {
+            reporter.info(
+                chalk.greenBright(
+                    `These default options will be used to create a new app: \n${chalk.greenBright(
+                        '- Language: TypeScript\n- Package manager: pnpm'
+                    )}`
+                )
+            )
+        }
+
+        await initCommand.handler({
+            ...argv,
+            pnpm,
+            npm,
+            typeScript,
+            name,
+        })
+    },
+}
+
+module.exports = command

package/bin/d2-create-app

@@ -1,8 +0,0 @@
-#!/usr/bin/env node
-const { makeEntryPoint, notifyOfUpdates } = require('@dhis2/cli-helpers-engine')
-
-const pkgJson = require('../package.json')
-const command = require(`..`)
-
-notifyOfUpdates(pkgJson)
-makeEntryPoint(command)

package/index.js

@@ -1,17 +0,0 @@
-const create = require('@dhis2/cli-create')
-const { groupGlobalOptions } = require('@dhis2/cli-helpers-engine')
-
-module.exports = {
-    command: 'create [type]',
-    desc: 'Create a new DHIS2 front-end app',
-    builder: yargs => {
-        groupGlobalOptions(yargs)
-        yargs.option('silent')
-    },
-    handler: argv => {
-        create.handler({
-            ...argv,
-            type: 'app',
-        })
-    },
-}