@contentful/create-contentful-app 1.1.0-alpha.6 → 1.1.0-alpha.9

package/README.md

@@ -1,19 +1,89 @@
+<!-- Don't forget to also update the corresponding README.md of the create-contentful-app package -->
+
 # Create Contentful App
 
-This project makes it easy to bootstrap [Contentful Apps](https://www.contentful.com/developers/docs/extensibility/app-framework/) with [React](https://reactjs.org/) and [Forma 36](https://f36.contentful.com/) (Contentful's design system).
+`create-contentful-app` is a command line interface to easily bootstrap [Contentful Apps](https://www.contentful.com/developers/docs/extensibility/app-framework/).
 
-## Requirements
+# Requirements
 
 - Node.js v14.15 or v16
-- NPM v6
+- npm v6 or later
+
+# Usage
+
+To start developing your first app, run:
+
+```bash
+npx create-contentful-app my-first-app
+```
+
+![Screenshot of `npx create-contentful-app my-app`](./docs/screenshot.png)
+
+## Bootstrap
+
+You can run `create-contentful-app` using one of the following commands:
+
+```bash
+# npx
+npx create-contentful-app <app-name>
+
+# npm
+npm init contentful-app <app-name>
+
+# Yarn
+yarn create contentful-app <app-name>
+```
+
+## CLI Options
+
+### Package Manager
 
+`--npm` or `--yarn`
 
-# Quick Overview
+Use npm or Yarn to manage dependencies. If omitted, defaults to the manager used to run `create-contentful-app`.
 
-To start developing your app:
+Both flags are mutually exclusive.
+
+### Template
+
+Select between predefined and custom templates:
+
+- `-ts, --typescript`: Use TypeScript template (default)
+- `-js, --javascript`: Use JavaScript template
+- `-e, --example <example-name>`: Select a predefined template from https://github.com/contentful/apps/tree/master/examples
+- `-s, --source <url>`: Use a custom template. Format: URL (HTTPS or SSH) or vendor:user/repo (e.g., github:user/repo)
+
+These flags are mutually exclusive. If no flag is provided, the TypeScript template is used.
+
+### Help
+
+`--help`
+
+Shows all available CLI options:
 
 ```
-npx @contentful/create-contentful-app my-first-app
-cd my-first-app
-npm start
+Usage: npx create-contentful-app [options] [app-name]
+
+Bootstrap your app inside a new folder `my-app`
+
+  create-contentful-app my-app
+
+or specify your own template
+
+  create-contentful-app my-app --source "github:user/repo"
+
+Official Contentful templates are hosted at https://github.com/contentful/apps/tree/master/examples.
+
+Arguments:
+  app-name                      app name
+
+Options:
+  --npm                         use npm
+  --yarn                        use Yarn
+  -js, --javascript             use default JavaScript template
+  -ts, --typescript             use default TypeScript template
+  -e, --example <example-name>  bootstrap an example app from https://github.com/contentful/apps/tree/master/examples
+  -s, --source <url>            provide a template by its source repository.
+                                format: URL (HTTPS or SSH) or vendor:user/repo (e.g., github:user/repo)
+  -h, --help                    shows all available CLI options
 ```

package/lib/index.js

@@ -103,7 +103,7 @@ function initProject(appName, options) {
     return __awaiter(this, void 0, void 0, function* () {
         commander_1.program
             .name(`npx ${(0, logger_1.code)('create-contentful-app')}`)
-            .helpOption(true)
+            .helpOption(true, 'shows all available CLI options')
             .description([
             'Bootstrap your app inside a new folder `my-app`',
             '',
@@ -118,13 +118,13 @@ function initProject(appName, options) {
             .argument('[app-name]', 'app name')
             .option('--npm', 'use npm')
             .option('--yarn', 'use Yarn')
-            .option('--javascript, -js', 'use default JavaScript template')
-            .option('--typescript, -ts', 'use default TypeScript template')
+            .option('-ts, --typescript', 'use TypeScript template (default)')
+            .option('-js, --javascript', 'use JavaScript template')
+            .option('-e, --example <example-name>', 'bootstrap an example app from https://github.com/contentful/apps/tree/master/examples')
             .option('-s, --source <url>', [
             `provide a template by its source repository.`,
             `format: URL (HTTPS or SSH) or ${(0, logger_1.code)('vendor:user/repo')} (e.g., ${(0, logger_1.code)('github:user/repo')})`,
         ].join('\n'))
-            .option('-e, --example <example-name>', 'bootstrap an example app from https://github.com/contentful/apps/tree/master/examples')
             .action(initProject);
         yield commander_1.program.parseAsync();
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/create-contentful-app",
-  "version": "1.1.0-alpha.6",
+  "version": "1.1.0-alpha.9",
   "description": "A template for building Contentful Apps",
   "keywords": [
     "contentful",
@@ -36,12 +36,11 @@
     "build": "tsc"
   },
   "dependencies": {
-    "@contentful/app-scripts": "^0.16.0-alpha.1",
+    "@contentful/app-scripts": "^0.16.0-alpha.2",
     "chalk": "^4.1.0",
     "commander": "^9.0.0",
-    "contentful-management": "^8.0.0",
     "degit": "2.8.4",
-    "inquirer": "^8.2.0",
+    "inquirer": "^8.2.1",
     "rimraf": "^3.0.2",
     "tildify": "^2.0.0",
     "validate-npm-package-name": "^3.0.0"
@@ -61,10 +60,10 @@
     "@types/chalk": "^2.2.0",
     "@types/degit": "^2.8.3",
     "@types/inquirer": "^8.2.0",
-    "@types/node": "^17.0.17",
+    "@types/node": "^14.14.31",
     "@types/rimraf": "^3.0.2",
     "@types/tildify": "^2.0.2",
     "@types/validate-npm-package-name": "^3.0.3"
   },
-  "gitHead": "fece2547470b044ec0dcb2aba26dd1f88da62796"
+  "gitHead": "c2e26ece746ca718b1fe38bf7c933ed8b1cd102a"
 }