added readme

Author: Mykhailo Bodnarchuk

.gitignore

@@ -1,6 +1,8 @@
 # Logs
 logs
 *.log
+examples
+package-lock.json
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*

Readme.md

@@ -0,0 +1,48 @@
+# Create CodeceptJS 🚀
+
+Create CodeceptJS project easily, having all dependencies installed with one command.
+
+```
+ ____  ____  _____ ____  _____  _____   ____  ____  ____  _____ ____  _____ ____  _____   _  ____ 
+/   _\/  __\/  __//  _ \/__ __\/  __/  /   _\/  _ \/  _ \/  __//   _\/  __//  __\/__ __\ / |/ ___\
+|  /  |  \/||  \  | / \ | / \  |  \    |  /  | / \|| | \||  \  |  /  |  \  |  \/|  / \   | ||    \
+|  \__|    /|  /_ | |-| | | |  |  /_   |  \__| \_/|| |_/||  /_ |  \_ |  /_ |  __/  | |/\_| |\___ |
+\____/\_/\_\\____\\_/ \ | \_/  \____\  \____/\____/\____/\____\\____/\____\\_/     \_/\____/\____/
+                                                                                                  
+```
+
+## Installation
+
+No installation needed 🤗
+
+## Usage
+
+Install CodeceptJS + Playwright into current project
+
+```
+npx create-codeceptjs 
+```
+
+Install CodeceptJS into "tests" directory
+
+```
+npx create-codeceptjs tests
+```
+
+Install CodeceptJS + webdriverio:
+
+```
+npx create-codeceptjs --webdriverio
+```
+
+Install CodeceptJS + webdriverio into "tests" directory
+
+```
+npx create-codeceptjs tests --webdriverio
+```
+
+Other options:
+
+* `--puppeteer` - install puppeteer as default helper
+* `--testcafe` - install testcafe as default helper
+

index.js

@@ -15,8 +15,7 @@ const enginePackages = {
 };
 
 const codeceptPackages = [
-  'codeceptjs',
-  '@codeceptjs/configure',
+  '[email protected]',
   '@codeceptjs/ui',
   '@codeceptjs/examples',
   '@codeceptjs/configure'
@@ -105,6 +104,7 @@ async function createCodecept(opts) {
   const root = path.join(process.cwd(), projectName || '');
   fs.ensureDirSync(root);
 
+  const currentDir = process.cwd();
   process.chdir(root);
 
 
@@ -157,7 +157,8 @@ async function createCodecept(opts) {
   fs.writeJsonSync('package.json', packageJson);
 
 
-  // await install(deps.flat());
+  await install(deps.flat());
+  await chdir();
 
   console.log('Finished installing packages.');
 
@@ -171,22 +172,36 @@ async function createCodecept(opts) {
   console.log('➕', chalk.cyan('npm run codecept:demo:server'), '- starts codeceptjs UI as a webserver for a demo project');
   console.log();
   console.log('Initialize CodeceptJS for your project:');
-  console.log('🔨', chalk.yellow('npx codeceptjs init'), '- initialize codeceptjs for current project', chalk.bold('required'));
+  console.log('🔨', chalk.yellow('npx codeceptjs init'), '- initialize codeceptjs for current project', chalk.bold('(required)'));
   console.log('➕', chalk.cyan('npm run codecept'), '- runs codeceptjs tests for current project');
   console.log('➕', chalk.cyan('npm run codecept:headless'), '- executes codeceptjs tests headlessly (no window shown)');
   console.log('➕', chalk.cyan('npm run codecept:app'), '- starts codeceptjs UI application for current project');
   console.log('➕', chalk.cyan('npm run codecept:server'), '- starts codeceptJS UI as webserver');
-  // if (opts)
-  // npx create-codeceptjs <> --playwright 
-  // npx create-codeceptjs <> --puppeteer
-  // npx create-codeceptjs <> --testcafe
-  // npx create-codeceptjs <> 
+
+  console.log();
+  if (root != currentDir) {
+    console.log('⚠', 'Change directory to', chalk.yellow(root), 'to run these commands');
+  }
 }
 
 // npx create-codeceptjs codecept-tests --playwright && cd codecept-tests && npx codeceptjs init
 
+async function chdir() {
+  return new Promise((resolve, reject) => {
+    const child = spawn('cd', process.cwd(), { stdio: 'inherit' });
+    child.on('close', code => {
+      if (code !== 0) {
+        reject({
+          command: `cd ${process.cwd()}`,
+        });
+        return;
+      }
+      resolve();
+    });
+  })
+}
 
-function install(dependencies, verbose) {
+async function install(dependencies, verbose) {
     return new Promise((resolve, reject) => {
       let command;
       let args;
@@ -195,7 +210,7 @@ function install(dependencies, verbose) {
 
       if (useYarn) {
         command = 'yarnpkg';
-        args = ['add', '--exact'];
+        args = ['add','-D', '--exact'];
         [].push.apply(args, dependencies);
 
         // Explicitly set cwd() to work around issues like

package.json

@@ -1 +1,51 @@
-{"name":"create-codeceptjs","version":"0.1.0","description":"Install CodeceptJS with all its dependencies in a single run","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1","codecept":"codeceptjs run --steps","codecept:app":"codecept-ui --app","codecept:server":"codecept-ui","codecept:example":"codeceptjs run --steps -c node_modules/@codeceptjs/examples","codecept:example:app":"codecept-ui --app  -c node_modules/@codeceptjs/examples","codecept:example:server":"codecept-ui -c node_modules/@codeceptjs/examples","codecept:headless":"HEADLESS=true codeceptjs run --steps","codecept:demo":"codeceptjs run --steps -c node_modules/@codeceptjs/examples","codecept:demo:headless":"HEADLESS=true codeceptjs run --steps -c node_modules/@codeceptjs/examples","codecept:demo:app":"codecept-ui --app  -c node_modules/@codeceptjs/examples","codecept:demo:server":"codecept-ui -c node_modules/@codeceptjs/examples"},"repository":{"type":"git","url":"git+https://github.com/codecept-js/create-codeceptjs.git"},"keywords":["codeceptjs","bdd","installer","e2e"],"author":"Michael Bodnarchuk","license":"ISC","bugs":{"url":"https://github.com/codecept-js/create-codeceptjs/issues"},"homepage":"https://github.com/codecept-js/create-codeceptjs#readme","dependencies":{"cfonts":"^2.8.5","chalk":"^4.1.0","commander":"^5.1.0","cross-spawn":"^7.0.3","fs-extra":"^9.0.1","semver":"^7.3.2"},"devDependencies":{"@codeceptjs/configure":"^0.5.2","@codeceptjs/examples":"^1.2.1","@codeceptjs/ui":"^0.3.8","codeceptjs":"^2.6.6","playwright":"^1.2.1"}}
+{
+    "name": "create-codeceptjs",
+    "version": "0.1.0",
+    "description": "Install CodeceptJS with all its dependencies in a single run",
+    "main": "index.js",
+    "scripts": {
+        "test": "echo \"Error: no test specified\" && exit 1",
+        "codecept": "codeceptjs run --steps",
+        "codecept:app": "codecept-ui --app",
+        "codecept:server": "codecept-ui",
+        "codecept:example": "codeceptjs run --steps -c node_modules/@codeceptjs/examples",
+        "codecept:example:app": "codecept-ui --app  -c node_modules/@codeceptjs/examples",
+        "codecept:example:server": "codecept-ui -c node_modules/@codeceptjs/examples",
+        "codecept:headless": "HEADLESS=true codeceptjs run --steps",
+        "codecept:demo": "codeceptjs run --steps -c node_modules/@codeceptjs/examples",
+        "codecept:demo:headless": "HEADLESS=true codeceptjs run --steps -c node_modules/@codeceptjs/examples",
+        "codecept:demo:app": "codecept-ui --app  -c node_modules/@codeceptjs/examples",
+        "codecept:demo:server": "codecept-ui -c node_modules/@codeceptjs/examples"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/codecept-js/create-codeceptjs.git"
+    },
+    "keywords": [
+        "codeceptjs",
+        "bdd",
+        "installer",
+        "e2e"
+    ],
+    "author": "Michael Bodnarchuk",
+    "license": "ISC",
+    "bugs": {
+        "url": "https://github.com/codecept-js/create-codeceptjs/issues"
+    },
+    "homepage": "https://github.com/codecept-js/create-codeceptjs#readme",
+    "dependencies": {
+        "cfonts": "^2.8.5",
+        "chalk": "^4.1.0",
+        "commander": "^5.1.0",
+        "cross-spawn": "^7.0.3",
+        "fs-extra": "^9.0.1",
+        "semver": "^7.3.2"
+    },
+    "devDependencies": {
+        "@codeceptjs/configure": "^0.5.2",
+        "@codeceptjs/examples": "^1.2.1",
+        "@codeceptjs/ui": "^0.3.8",
+        "codeceptjs": "^2.6.6",
+        "playwright": "^1.2.1"
+    }
+}