generate-sub-package.js

#!/usr/bin/env node
/**
 * This script generates new sub package with initial structure and files
 */

const fs = require('fs')
const path = require('path')
const shell = require('shelljs')
const inquirer = require('inquirer')
const packageType = ['reporter', 'service', 'runner', 'framework']
const questions = [{
    type: 'list',
    name: 'packageType',
    message: 'Select sub package type:',
    choices: packageType,
    default: 'reporter'
}, {
    type: 'input',
    name: 'packageName',
    message: 'Provide sub package name:'
}]

inquirer.prompt(questions).then(answers => {
    const {packageName, packageType} = answers
    const packagesDir = path.join(__dirname, '..', 'packages')
    const fullPackageName = `wdio-${packageName}-${packageType}`
    const fullScopedPackageName = `@wdio/${packageName}-${packageType}`

    const mainPackageFolder = path.join(packagesDir, fullPackageName)
    const mainPackageFolderFiles = [
        {
            name: '.npmignore',
            content: 'src\ntests'
        },
        {
            name: '.npmrc',
            content: `message = "${fullPackageName}: bump version %s"`
        },
        {
            name: 'package.json',
            content: `{
  "name": "${fullScopedPackageName}",
  "version": "0.0.0",
  "description": "A WebdriverIO ${packageType} that <provide ${packageType} description>",
  "author": "Christian Bromann <christian@saucelabs.com>",
  "homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/${fullPackageName}",
  "license": "MIT",
  "main": "./build/index",
  "engines": {
    "node": ">= 4.8.5"
  },
  "scripts": {
    "build": "run-s clean compile",
    "clean": "rimraf ./build",
    "compile": "babel src/ -d build/ --config-file ../../babel.config.js",
    "test": "run-s test:*",
    "test:eslint": "eslint src test",
    "test:unit": "jest"
  },
  "repository": {
    "type": "git",
    "url": "git://github.com/webdriverio/webdriverio.git"
  },
  "keywords": [
    "webdriver",
    "wdio",
    "wdio-${packageType}"
  ],
  "bugs": {
    "url": "https://github.com/webdriverio/webdriverio/issues"
  },
  "dependencies": {
  },
  "publishConfig": {
    "access": "public"
  }
}`
        },
        {
            name: 'README.md',
            content: `WebdriverIO ${packageName.toUpperCase()} ${packageType.charAt(0).toUpperCase()}${packageType.substr(1)}\n========================`
        }
    ]

    const srcPackageFolder = path.join(mainPackageFolder, 'src')
    const srcPackageFolderFiles = [
        {
            name: 'index.js',
            content: 'export default {}'
        }
    ]

    const testsPackageFolder = path.join(mainPackageFolder, 'tests')
    const testsPackageFolderFiles = [
        {
            name: '.eslintrc',
            content: `{
  "env": {
    "jest": true
  }
}`
        },
        {
            name: 'example.test.js',
            content: `describe('Unit test example', () => {
    it('Test #1', () => {
        expect(1).toBe(1)
    })
})`
        }
    ]

    const existingPackages = fs.readdirSync(packagesDir)
        .map(name => path.join(packagesDir, name))
        .filter(source => fs.lstatSync(source).isDirectory())

    const createFile = (file, content) => {
        shell.touch(file)
        shell.ShellString(content).to(file)
    }

    if (packageName === '') {
        throw new Error('Package name can not be empty')
    }

    if (existingPackages.includes(mainPackageFolder)) {
        throw new Error(`Package '${fullPackageName}' already exists. Please choose another name.`)
    }

    // create package structure
    [mainPackageFolder, srcPackageFolder, testsPackageFolder].map(folder => shell.mkdir(folder))

    // create main folder files
    mainPackageFolderFiles.map(file => createFile(path.join(mainPackageFolder, file.name), file.content))

    // create src folder files
    srcPackageFolderFiles.map(file => createFile(path.join(srcPackageFolder, file.name), file.content))

    // create tests folder files
    testsPackageFolderFiles.map(file => createFile(path.join(testsPackageFolder, file.name), file.content))
// eslint-disable-next-line no-console
}).catch(err => console.error(err))