refactor: De-nesting

Author: mvsde

bin/pangolin.js

@@ -10,7 +10,7 @@ program
   .command('create <name>')
   .description('Create a new Pangolin.js project')
   .action(name => {
-    require('../lib/commands/create')(name)
+    require('../commands/create')(name)
   })
 
 program

lib/commands/create.js commands/create.jslib/commands/create.js renamed to commands/create.js

@@ -3,18 +3,18 @@ const fs = require('fs')
 const path = require('path')
 const prompts = require('prompts')
 
-const copyDir = require('../utils/copy-dir')
-const generateGitignore = require('../utils/generate-gitignore')
-const generatePackage = require('../utils/generate-package')
-const generatePangolinConfig = require('../utils/generate-pangolin-config')
-const installDependencies = require('../utils/install-dependencies')
-const version = require('../../package.json').version
+const copyDir = require('../lib/copy-dir.js')
+const generateGitignore = require('../lib/generate-gitignore.js')
+const generatePackage = require('../lib/generate-package.js')
+const generatePangolinConfig = require('../lib/generate-pangolin-config.js')
+const installDependencies = require('../lib/install-dependencies.js')
+const version = require('../package.json').version
 
 /**
  * Create a new project
  * @param {string} name Project name
  */
-async function create (name) {
+module.exports = async function create (name) {
   const context = process.cwd()
   const dir = path.join(context, name)
 
@@ -40,13 +40,16 @@ async function create (name) {
   }
 
   // Write package.json
-  const packageName = path.basename(name) === '.'
+  const defaultPackageName = path.basename(name) === '.'
     ? path.basename(context)
     : path.basename(name)
-  const packageData = await generatePackage(packageName)
+
+  const packageData = await generatePackage({ name: defaultPackageName })
+
   if (!packageData.license) {
     return
   }
+
   const packagePath = path.join(dir, 'package.json')
   fs.writeFileSync(packagePath, JSON.stringify(packageData, null, 2))
 
@@ -56,16 +59,14 @@ async function create (name) {
   fs.writeFileSync(gitignorePath, gitignoreData)
 
   // Write Pangolin.js config
-  const pangolinConfigData = generatePangolinConfig(packageData.name)
+  const pangolinConfigData = generatePangolinConfig({ name: packageData.name })
   const pangolinConfigPath = path.join(dir, 'pangolin.config.js')
   fs.writeFileSync(pangolinConfigPath, pangolinConfigData)
 
   // Copy template files
-  const templatePath = path.join(__dirname, '../../template')
+  const templatePath = path.join(__dirname, '../template')
   copyDir(templatePath, dir)
 
   // Install dependencies
-  await installDependencies(dir)
+  installDependencies(dir)
 }
-
-module.exports = create

lib/utils/copy-dir.js lib/copy-dir.jslib/utils/copy-dir.js renamed to lib/copy-dir.js

@@ -6,7 +6,7 @@ const path = require('path')
  * @param {string} src Source path
  * @param {string} dest Destination path
  */
-function copyDir (src, dest) {
+module.exports = function copyDir (src, dest) {
   fs.readdirSync(src).forEach(file => {
     const filePath = path.join(src, file)
     const fileDest = path.join(dest, file)
@@ -21,5 +21,3 @@ function copyDir (src, dest) {
     }
   })
 }
-
-module.exports = copyDir

lib/utils/exec.js lib/exec.jslib/utils/exec.js renamed to lib/exec.js

@@ -4,7 +4,7 @@ const childProcess = require('child_process')
  * Primisified child process execution
  * @param {string} command Command to execute
  */
-function exec (command) {
+module.exports = function exec (command) {
   return new Promise((resolve, reject) => {
     childProcess.exec(command, (error, stdout, stderr) => {
       if (error) {
@@ -19,5 +19,3 @@ function exec (command) {
     })
   })
 }
-
-module.exports = exec

lib/utils/generate-gitignore.js lib/generate-gitignore.jslib/utils/generate-gitignore.js renamed to lib/generate-gitignore.js

@@ -2,7 +2,7 @@
  * Generate .gitignore contents
  * @returns {string} .gitignore contents
  */
-function generateGitignore () {
+module.exports = function generateGitignore () {
   return `# OS specific stuff
 Thumbs.db
 Desktop.ini
@@ -17,10 +17,6 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 
-# Cache
-.eslintcache
-.stylelintcache
-
 # Dependencies
 node_modules
 
@@ -30,5 +26,3 @@ node_modules
 /dist
 `
 }
-
-module.exports = generateGitignore

lib/utils/generate-package.js lib/generate-package.jslib/utils/generate-package.js renamed to lib/generate-package.js

@@ -1,13 +1,15 @@
 const { blue } = require('kleur')
-const getGitUser = require('../utils/get-git-user')
 const prompts = require('prompts')
 
+const getGitUser = require('./get-git-user.js')
+
 /**
  * Generate base data for package.json
- * @param {string} name Project name
+ * @param {Object} options Options
+ * @param {string} options.name Project name
  * @returns {Object} package.json-style object
  */
-async function generatePackage (name) {
+module.exports = async function generatePackage ({ name }) {
   const gitUser = await getGitUser()
 
   const response = await prompts([
@@ -114,10 +116,8 @@ async function generatePackage (name) {
       dev: 'pangolin-core dev',
       build: 'pangolin-core build',
       'build:dev': 'pangolin-core build --dev',
-      'lint:css': 'pangolin-core lint css --cache',
-      'lint:js': 'pangolin-core lint js --cache'
+      'lint:css': 'pangolin-core lint css',
+      'lint:js': 'pangolin-core lint js'
     }
   }
 }
-
-module.exports = generatePackage

lib/generate-pangolin-config.js

@@ -0,0 +1,14 @@
+/**
+ * Generate Pangolin.js config
+ * @param {Object} options Options
+ * @param {string} options.name Project name
+ * @returns {string} Contents of the config file
+ */
+module.exports = function generatePangolinConfig ({ name }) {
+  return `module.exports = {
+  project: {
+    name: '${name}'
+  }
+}
+`
+}

lib/utils/get-git-user.js lib/get-git-user.jslib/utils/get-git-user.js renamed to lib/get-git-user.js

@@ -5,19 +5,17 @@ const exec = require('./exec')
  *
  * Based on:
  * https://github.com/vuejs/vue-cli/blob/230314c980fb901095b9e18656c018be514aa1bf/lib/git-user.js
+ *
+ * @returns {{name: string, email: string}} Git user config
  */
-function getGitUser () {
+module.exports = async function getGitUser () {
   const getName = exec('git config --get user.name')
   const getEmail = exec('git config --get user.email')
 
-  return Promise
-    .all([getName, getEmail])
-    .then(([name, email]) => {
-      return {
-        name: (name && name.trim()) || '',
-        email: (email && email.trim()) || ''
-      }
-    })
-}
+  const [name, email] = await Promise.all([getName, getEmail])
 
-module.exports = getGitUser
+  return {
+    name: (name && name.trim()) || '',
+    email: (email && email.trim()) || ''
+  }
+}

lib/utils/install-dependencies.js lib/install-dependencies.jslib/utils/install-dependencies.js renamed to lib/install-dependencies.js

@@ -5,7 +5,7 @@ const spawnSync = require('child_process').spawnSync
  * Install dependencies
  * @param {string} dir Install in this folder
  */
-async function installDependencies (dir) {
+module.exports = function installDependencies (dir) {
   const oldDir = process.cwd()
   process.chdir(dir)
 
@@ -42,5 +42,3 @@ async function installDependencies (dir) {
 
   process.chdir(oldDir)
 }
-
-module.exports = installDependencies