feat: Hook profile into new-blueprint

Author: jezhiggins

lib/actions/init/index.js

@@ -1,15 +1,10 @@
 const c = require('ansi-colors')
-const path = require('path')
-const homedir = require('os').homedir()
 const { prompt } = require('enquirer')
 const loadProfile = require('../profile')
-const username = require('username')
 
 async function initAction (options) {
-  const workingDirectory = options.profile || path.join(homedir, '.tymly')
-
-  const profile = loadProfile(workingDirectory)
-  console.log(c.bold(`${profile.loaded ? 'Updating' : 'Creating'} Tymly profile in ${workingDirectory}`))
+  const profile = loadProfile(options.profile)
+  console.log(c.bold(`${profile.loaded ? 'Updating' : 'Creating'} Tymly profile in ${profile.directory}`))
 
   const updates = await gatherProfileDetails(profile)
 
@@ -25,26 +20,26 @@ async function gatherProfileDetails (profile) {
       type: 'input',
       name: 'author',
       message: 'Your name',
-      initial: profile.author || await username()
+      initial: () => profile.authorSuggestion()
     },
     {
       type: 'input',
       name: 'organisation',
       message: 'Your Organisation',
-      initial: profile.organisation || ''
+      initial: () => profile.organisationSuggestion()
     },
     {
       type: 'input',
       name: 'gitHubOwner',
       message: 'GitHub Owner',
-      initial: () => profile.gitHubOwner || gitHubGuess(profileInfo.organisation),
+      initial: () => profile.gitHubOwnerSuggestion(profileInfo.organisation),
       validate: v => v.match(' ') ? 'No spaces allowed in GitHub Owner name' : true
     },
     {
       type: 'input',
       name: 'npmOrg',
       message: 'NPM Organisation',
-      initial: () => profile.npmOrg || profileInfo.gitHubOwner,
+      initial: () => profile.npmOrgSuggestion(profileInfo.gitHubOwner),
       validate: v => v.match(' ') ? 'No spaces allowed in NPM Organisation name' : true
     }
   ]
@@ -56,10 +51,4 @@ async function gatherProfileDetails (profile) {
   return profileInfo
 } // gatherProfileDetails
 
-function gitHubGuess (org) {
-  return org.match(' ')
-    ? org.split(' ').map(s => `${s.toLowerCase()[0]}`).join('')
-    : org.toLowerCase()
-}
-
 module.exports = initAction

lib/actions/new-blueprint/index.js

@@ -2,6 +2,7 @@ const c = require('ansi-colors')
 const { prompt } = require('enquirer')
 const path = require('path')
 const fs = require('fs')
+const loadProfile = require('../profile')
 const Scaffold = require('@wmfs/tymly-scaffold')
 
 async function newBlueprint (blueprintName, options) {
@@ -18,7 +19,8 @@ async function newBlueprint (blueprintName, options) {
     return
   }
 
-  const blueprintInfo = await solicitDetails()
+  const profile = loadProfile(options.profile)
+  const blueprintInfo = await solicitDetails(profile)
 
   const scaffold = new Scaffold({
     basePath: workingDirectory
@@ -46,7 +48,7 @@ function canCreate (blueprintPath) {
   }
 }
 
-async function solicitDetails () {
+async function solicitDetails (profile) {
   let blueprintInfo = { }
 
   const questions = [
@@ -59,12 +61,13 @@ async function solicitDetails () {
       type: 'input',
       name: 'author',
       message: 'Author',
-      initial: process.env.user
+      initial: () => profile.authorSuggestion()
     },
     {
       type: 'input',
       name: 'organisation',
-      message: 'Organisation'
+      message: 'Organisation',
+      initial: () => profile.organisationSuggestion()
     },
     {
       type: 'input',
@@ -76,16 +79,14 @@ async function solicitDetails () {
       type: 'input',
       name: 'gitHubOwner',
       message: 'GitHub Owner',
-      initial: () => blueprintInfo.organisation.match(' ')
-        ? blueprintInfo.organisation.split(' ').map(s => `${s.toLowerCase()[0]}`).join('')
-        : blueprintInfo.organisation.toLowerCase(),
+      initial: () => profile.gitHubOwnerSuggestion(blueprintInfo.organisation),
       validate: v => v.match(' ') ? 'No spaces allowed in GitHub Owner name' : true
     },
     {
       type: 'input',
       name: 'npmOrg',
       message: 'NPM Organisation',
-      initial: () => blueprintInfo.gitHubOwner,
+      initial: () => profile.npmOrgSuggestion(blueprintInfo.gitHubOwner),
       validate: v => v.match(' ') ? 'No spaces allowed in NPM Organisation name' : true
     },
     {

lib/actions/profile.js

@@ -1,5 +1,7 @@
 const fs = require('fs-extra')
 const path = require('path')
+const homedir = require('os').homedir()
+const username = require('username')
 
 const Properties = [
   'author',
@@ -10,11 +12,17 @@ const Properties = [
 
 class Profile {
   constructor (profileFileName, initial = null) {
+    this.directory = path.dirname(profileFileName)
     this.profileFileName = profileFileName
     this.loaded = !!initial
     this.update(initial || { })
   }
 
+  authorSuggestion () { return this.author || username.sync() }
+  organisationSuggestion () { return this.organisation || '' }
+  gitHubOwnerSuggestion (org) { return this.gitHubOwner || gitHubGuess(org) }
+  npmOrgSuggestion (org) { return this.npmOrg || org }
+
   update (props) {
     Properties.forEach(p => { this[p] = props[p] })
   }
@@ -40,12 +48,20 @@ function load (profileFileName) {
 }
 
 function loadProfile (profileDir) {
-  const profileFileName = path.join(profileDir, 'tymly-profile.json')
+  const workingDir = profileDir || path.join(homedir, '.tymly')
+
+  const profileFileName = path.join(workingDir, 'tymly-profile.json')
 
   return new Profile(
     profileFileName,
     load(profileFileName)
   )
 }
 
+function gitHubGuess (org) {
+  return org.match(' ')
+    ? org.split(' ').map(s => `${s.toLowerCase()[0]}`).join('')
+    : org.toLowerCase()
+}
+
 module.exports = loadProfile

lib/index.js

@@ -21,6 +21,7 @@ function tymlyCli (argv) {
     .command('new-blueprint  <blueprint-name>')
     .description('Create a new Tymly blueprint')
     .option('-p, --path <path>', 'working directory - defaults to "."')
+    .option('--profile <path>', 'alternative profile path - defaults to your home directory')
     .action((blueprintName, options) => {
       actions.newBlueprintAction(blueprintName, options)
     })

test/fixtures/new-blueprint/expected/use-profile-details/tymly-pizza-blueprint/.gitignore

@@ -0,0 +1,179 @@
+# Compiled source #
+###################
+*.com
+*.class
+*.dll
+*.exe
+*.o
+*.so
+
+# Packages #
+############
+# it's better to unpack these files and commit the raw source
+# git has its own built in compression methods
+*.7z
+*.dmg
+*.gz
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+
+# Logs and databases #
+######################
+*.log
+
+*.sqlite
+
+## Node ###
+~*
+.~*
+\#*
+
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules
+jspm_packages
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+
+## IDE things ##
+
+# Webstorm
+.idea
+
+# Eclipse:
+
+.project
+.metadata
+bin/
+tmp/
+*.tmp
+*.bak
+*.swp
+*~.nib
+local.properties
+.settings/
+.loadpath
+.recommenders
+
+
+scratch.txt
+package-lock.json
+
+output/
+
+# Ignore Rush temporary files
+/common/temp/**
+
+package-deps.json
+
+.yo-rc.json
+
+lerna-debug.log
+
+TEST-result.xml
+.gradle/
+.embedpostgresql/
+build/
+
+# Windows thumbnail cache files
+Thumbs.db
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# OS generated files #
+######################
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk