@contentful/create-contentful-app 1.1.0-alpha.7 → 1.2.0

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/lib/template.js

@@ -28,7 +28,7 @@ function makeContentfulExampleSource(options) {
     if (options.example) {
         return EXAMPLES_PATH + options.example;
     }
-    if (options.Js) {
+    if (options.javascript) {
         return EXAMPLES_PATH + types_1.ContentfulExample.Javascript;
     }
     return EXAMPLES_PATH + types_1.ContentfulExample.Typescript;

package/lib/utils.js

@@ -5,7 +5,7 @@ const child_process_1 = require("child_process");
 const fs_1 = require("fs");
 const path_1 = require("path");
 const logger_1 = require("./logger");
-const MUTUALLY_EXCLUSIVE_OPTIONS = ['source', 'example', 'Js', 'Ts'];
+const MUTUALLY_EXCLUSIVE_OPTIONS = ['source', 'example', 'javascript', 'typescript'];
 function exec(command, args, options) {
     return new Promise((resolve, reject) => {
         const process = (0, child_process_1.spawn)(command, args, Object.assign({ stdio: 'inherit' }, options));
@@ -47,25 +47,24 @@ function normalizeOptions(options) {
         normalizedOptions.npm = true;
     }
     let fallbackOption = '--typescript';
-    const currentMutuallyExclusiveOptions = MUTUALLY_EXCLUSIVE_OPTIONS
-        .filter((option) => normalizedOptions[option]);
+    const currentMutuallyExclusiveOptions = MUTUALLY_EXCLUSIVE_OPTIONS.filter((option) => normalizedOptions[option]);
     if (normalizedOptions.source) {
         fallbackOption = '--source';
         delete normalizedOptions.example;
-        delete normalizedOptions.Ts;
-        delete normalizedOptions.Js;
+        delete normalizedOptions.typescript;
+        delete normalizedOptions.javascript;
     }
     if (normalizedOptions.example) {
         fallbackOption = '--example';
-        delete normalizedOptions.Ts;
-        delete normalizedOptions.Js;
+        delete normalizedOptions.typescript;
+        delete normalizedOptions.javascript;
     }
-    if (normalizedOptions.Ts) {
+    if (normalizedOptions.typescript) {
         fallbackOption = '--typescript';
-        delete normalizedOptions.Js;
+        delete normalizedOptions.javascript;
     }
-    if (!normalizedOptions.Js) {
-        normalizedOptions.Ts = true;
+    if (!normalizedOptions.javascript) {
+        normalizedOptions.typescript = true;
     }
     if (currentMutuallyExclusiveOptions.length > 1) {
         (0, logger_1.warn)(`Options ${(0, logger_1.highlight)('--source')}, ${(0, logger_1.highlight)('--example')}, ${(0, logger_1.highlight)('--typescript')} and ${(0, logger_1.highlight)('--javascript')} are mutually exclusive, using ${(0, logger_1.choice)(fallbackOption)}.`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/create-contentful-app",
-  "version": "1.1.0-alpha.7",
+  "version": "1.2.0",
   "description": "A template for building Contentful Apps",
   "keywords": [
     "contentful",
@@ -32,11 +32,10 @@
     "lint": "eslint ./src",
     "lint:fix": "npm run lint -- --fix",
     "pre-commit": "lint-staged",
-    "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
     "build": "tsc"
   },
   "dependencies": {
-    "@contentful/app-scripts": "^0.16.0-alpha.2",
+    "@contentful/app-scripts": "file:../contentful--app-scripts",
     "chalk": "^4.1.0",
     "commander": "^9.0.0",
     "degit": "2.8.4",
@@ -64,6 +63,5 @@
     "@types/rimraf": "^3.0.2",
     "@types/tildify": "^2.0.2",
     "@types/validate-npm-package-name": "^3.0.3"
-  },
-  "gitHead": "a66c3394d79d19a999d6509ec967b8b85eca41cc"
+  }
 }

package/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2020 Contentful
-
-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.