wp-advads 1.0.7 → 1.0.9

package/src/commands/setup/create-plugin.js

@@ -4,181 +4,224 @@
 import fs from 'fs-extra'
 import chalk from 'chalk'
 import Handlebars from 'handlebars'
-import { series, eachSeries } from 'async'
+import { eachSeries, waterfall } from 'async'
+
+export const pluginData = {}
 
 /**
  * Internal dependencies
  */
-import { getCurrentFolder, runCommand, getTemplateFolder, heading } from '../../helpers.js'
-
-class CreatePlugin {
-    run(settings, callback) {
-        this.settings = settings
-        this.folder = getCurrentFolder()
-        this.template = getTemplateFolder()
-
-        this.dirs = [
-            // Root
-            this.folder + '/languages',
-            this.folder + '/templates',
-
-            // Includes
-            this.folder + '/includes',
-            this.folder + '/includes/abstracts',
-            this.folder + '/includes/admin',
-            this.folder + '/includes/database',
-            this.folder + '/includes/interfaces',
-            this.folder + '/includes/models',
-            this.folder + '/includes/traits',
-            this.folder + '/includes/utilities',
-        ]
-
-        series(
-            [
-                this.directories,
-                this.copyIndex,
-                this.copyConfigs,
-                this.copyTools,
-                this.prepareConfigs,
-                this.prepareFiles,
-                (next) => {
-                    heading( 'Installing Composer' )
-                    runCommand( 'composer', [ 'install' ], next )
-                },
-                (next) => {
-                    runCommand( 'composer', [ 'dump' ], next )
-                },
-                (next) => {
-                    heading( 'Checking GIT repo' )
-                    runCommand( 'git rev-parse --is-inside-work-tree && echo "OK" || git init', [], next )
-                },
-                this.installNpm,
-                (next) => {
-                    heading( 'Adding Pre-Commit' )
-                    runCommand( 'npm run prepare', [], next )
-                },
-                (next) => {
-                    runCommand( 'npx husky add .husky/pre-commit "npx lint-staged"', [], next )
-                }
-            ],
-            ( err, results ) => {
-                callback()
-            }
-        )
-    }
-
-    directories = ( next ) => {
-        heading( 'Creating directories!!' )
-
-        eachSeries( this.dirs, ( dir, nextDir ) => {
-            fs.ensureDir( dir ).then( nextDir )
-        }, () => {
-            next()
-        } )
-    }
-
-    copyIndex = ( next ) => {
-        heading( 'Copying golden silence!!' )
-        const indexFile = this.template + '/index.php'
-
-        eachSeries( this.dirs, ( dir, nextCopy ) => {
-            fs.copy( indexFile, dir + '/index.php' ).then( nextCopy )
-        }, next )
-    }
-
-    copyConfigs = ( next ) => {
-        heading( 'Copying configuration files!!' )
-        fs.copySync(
-            this.template + '/configs',
-            this.folder
-        )
-        fs.renameSync(
-            this.folder + '/gitattributes',
-            this.folder + '/.gitattributes',
-        )
-        fs.renameSync(
-            this.folder + '/gitignore',
-            this.folder + '/.gitignore',
-        )
-        next()
-    }
-
-    copyTools = ( next ) => {
-        heading( 'Copying tools files!!' )
-        fs.copySync(
-            this.template + '/tools',
-            this.folder + '/tools',
-        )
-        next()
-    }
-
-    prepareConfigs = ( next ) => {
-        heading( 'Preparing configuration files!!' )
-        const configs =[
-            this.folder + '/.phpcs.xml',
-            this.folder + '/composer.json',
-            this.folder + '/package.json',
-            this.folder + '/webpack.mix.js',
-            this.folder + '/webpack.mix.local.js',
-        ]
-
-        eachSeries( configs, ( file, nextConfig ) => {
-            this.renderFile( file, file, nextConfig )
-        }, next )
-    }
-
-    prepareFiles = ( next ) => {
-        heading( 'Preparing plugin files!!' )
-        const files =[
-            '/includes/interfaces/interface-integration.php',
-        ]
-
-        eachSeries( files, ( file, nextFile ) => {
-            this.renderFile( this.template + file, this.folder + file, nextFile )
-        }, () => {
-            next()
-        } )
-    }
-
-    installNpm = (next) => {
-        heading( 'Installing NPM Packages' )
-        const packages =[
-            '@wordpress/eslint-plugin',
-            '@wordpress/stylelint-config',
-            'async',
-            'browser-sync',
-            'browser-sync-webpack-plugin',
-            'chalk@4.1.2',
-            'eslint-plugin-prettier',
-            'husky',
-            'laravel-mix',
-            'lint-staged',
-            'prettier',
-            'resolve-url-loader',
-            'sass',
-            'sass-loader',
-            'shelljs',
-            'webpack',
-        ]
-
-        eachSeries( packages, ( pack, nextPackage ) => {
-            console.log( chalk.yellow( 'npm i -D ' + pack ) )
-            runCommand( 'npm', [ 'i -D ' + pack ], nextPackage )
-        }, () => {
-            next()
-        } )
-    }
-
-    renderFile = ( src, dest, next ) => {
-        const content = fs.readFileSync( src, 'utf8' )
-        const template = Handlebars.compile( content )
-        const rendered = template( this.settings )
-        fs.outputFileSync( dest, rendered )
-        next()
-    }
+import { getCurrentFolder, getTemplateFolder, heading, write, msgSuccessOnSameLine, execCommand } from '../../utilities/index.js'
+
+/**
+ * Helper functions
+ */
+function prepareFile( src, dest, next ) {
+	const content = fs.readFileSync( src, 'utf8' )
+	const template = Handlebars.compile( content )
+	const rendered = template( pluginData.settings )
+
+	fs.outputFile( dest, rendered ).then( next )
+}
+
+/**
+ * Flow functions
+ */
+function setPluginData(next) {
+	pluginData.folder = getCurrentFolder()
+	pluginData.template = getTemplateFolder()
+
+	pluginData.dirs = [
+		// Root
+		pluginData.folder,
+		pluginData.folder + '/languages',
+		pluginData.folder + '/templates',
+
+		// Assets
+		pluginData.folder + '/assets/css',
+		pluginData.folder + '/assets/scss',
+		pluginData.folder + '/assets/js',
+		pluginData.folder + '/assets/src',
+		pluginData.folder + '/assets/img',
+		pluginData.folder + '/assets/acf',
+
+		// Includes
+		pluginData.folder + '/includes',
+		pluginData.folder + '/includes/abstracts',
+		pluginData.folder + '/includes/admin',
+		pluginData.folder + '/includes/database',
+		pluginData.folder + '/includes/interfaces',
+		pluginData.folder + '/includes/models',
+		pluginData.folder + '/includes/traits',
+		pluginData.folder + '/includes/utilities',
+	]
+
+	next()
+}
+
+function createDirectories(next) {
+	const indexFile = pluginData.template + '/index.php'
+
+	write('Creating directory required for the plugin...')
+
+	eachSeries( pluginData.dirs, ( dir, nextDir ) => {
+		fs.ensureDir( dir ).then(() => {
+			fs.copy( indexFile, dir + '/index.php' ).then( nextDir )
+		})
+	}, () => {
+		msgSuccessOnSameLine(`${pluginData.dirs.length} directories created`)
+		next()
+	} )
+}
+
+function copyToolFiles(next) {
+	write('Copying tools files...')
+	fs.copySync(
+		pluginData.template + '/tools',
+		pluginData.folder + '/tools',
+	)
+
+	msgSuccessOnSameLine('Tool files copied')
+	next()
+}
+
+function prepareConfigFiles(next) {
+	const template = pluginData.template + '/configs'
+	const files =[
+		'/.editorconfig',
+		'/.eslintignore',
+		'/.eslintrc.js',
+		'/.gitattributes',
+		'/.gitignore',
+		'/.phpcs.xml.dist',
+		'/.prettierignore',
+		'/.prettierrc.js',
+		'/.stylelintrc',
+		'/composer.json',
+		'/package.json',
+		'/webpack.mix.js',
+	]
+
+	write('Preparing configuration files...')
+
+	eachSeries( files, ( file, nextConfig ) => {
+		prepareFile( template + file, pluginData.folder + file, nextConfig )
+	}, () => {
+		msgSuccessOnSameLine(`${files.length} Configuration files prepared`)
+		next()
+	} )
+}
+
+function preparePluginFiles(next) {
+	const template = pluginData.template + '/plugin'
+	const files =[
+		'/assets/src/app.js',
+		'/assets/scss/app.scss',
+		// '/includes/admin/class-admin.php',
+		// '/includes/interfaces/interface-integration.php',
+		// '/includes/class-assets.php',
+		// '/includes/class-frontend.php',
+		// '/includes/class-plugin.php',
+		// '/plugin.php',
+		// '/uninstall.php',
+	]
+
+	write('Preparing plugin files...')
+
+	eachSeries( files, ( file, nextFile ) => {
+		prepareFile( template + file, pluginData.folder + file, nextFile )
+	}, () => {
+		msgSuccessOnSameLine(`${files.length} plugin files created with settings`)
+		next()
+	} )
+}
+
+function prepareGitRepository(next) {
+	write( 'Checking GIT repo' )
+	execCommand('git rev-parse --is-inside-work-tree && echo "OK" || git init', function() {
+		msgSuccessOnSameLine('Git repository initiated successfully')
+		next()
+	})
+}
+
+function installComposer(next) {
+	heading('Composer')
+	write('Installing Composer...')
+	execCommand('composer install -q', function() {
+		msgSuccessOnSameLine('Composer installed successfully')
+		next()
+	})
+}
+
+function installNodePackages(next) {
+	const packages =[
+		'@wordpress/eslint-plugin',
+		'@wordpress/stylelint-config',
+		'async',
+		'browser-sync',
+		'browser-sync-webpack-plugin',
+		'chalk@4.1.2',
+		'eslint-plugin-prettier',
+		'husky',
+		'laravel-mix',
+		'lint-staged',
+		'prettier',
+		'resolve-url-loader',
+		'sass',
+		'sass-loader',
+		'shelljs',
+		'tailwindcss',
+		'webpack',
+	]
+
+	heading( 'Node Packages' )
+
+	eachSeries( packages, ( pkg, nextPackage ) => {
+		write( chalk.red( 'Installing ' + pkg ) )
+		execCommand(`npm install -D ${pkg}`, function() {
+			msgSuccessOnSameLine(`Package: ${pkg} installed successfully`)
+			nextPackage()
+		})
+	}, () => {
+		next()
+	} )
+}
+
+function prepareNodePackages(next) {
+	write( 'Adding Pre-Commit' )
+
+	execCommand('npm run prepare', function() {
+		execCommand('npx husky add .husky/pre-commit "npx lint-staged"', function() {
+			msgSuccessOnSameLine('Pre-Commit hooks added successfully')
+			next()
+		})
+	})
 }
 
 export default ( settings, next ) => {
-    const generator = new CreatePlugin()
-    generator.run( settings, next )
+	pluginData.settings = settings
+
+	console.log('');
+	heading('Scaffoling plugin...')
+
+	waterfall(
+		[
+			setPluginData,
+			createDirectories,
+			copyToolFiles,
+			prepareConfigFiles,
+			preparePluginFiles,
+			prepareGitRepository,
+			installComposer,
+			installNodePackages,
+			prepareNodePackages
+		],
+		(err) => {
+			if (err) {
+				return next(true)
+			}
+
+			next()
+		}
+	)
 }

package/src/commands/setup/index.js

@@ -8,11 +8,11 @@ import logSymbols from 'log-symbols'
 /**
  * Internal Dependencies
  */
-import { heading } from "../../helpers.js"
+import { heading } from "../../utilities/index.js"
 import prompts from './prompts.js'
 import createPlugin from './create-plugin.js'
 
-export function execute() {
+export default function() {
     heading('Setting up...')
     console.log('');
 

package/src/commands/setup/prompts.js

@@ -1,21 +1,19 @@
 /**
  * External dependencies
  */
-import inquirer from 'inquirer'
 import get from 'lodash/get.js'
+import inquirer from 'inquirer'
 import kebabCase from 'lodash/kebabCase.js'
 
 /**
  * Node dependencies
  */
-import { getCacheStore } from '../../helpers.js'
+import { getCacheStore, getSettings, heading } from '../../utilities/index.js'
 
 export default ( next ) => {
     const cache = getCacheStore()
-    let saved = cache.all()
-    saved = saved ? saved.answers : {}
-
-    const getCache = ( key, defaultVal = '' ) => get( saved, key, defaultVal )
+    const settings = getSettings()
+    const getAnswer = ( key, defaultVal = '' ) => get( settings, key, defaultVal )
 
     const questions = [
         // Company
@@ -23,13 +21,13 @@ export default ( next ) => {
             type: 'input',
             name: 'company.name',
             message: 'Enter company name',
-            default: getCache(  'company.name','Advanced Ads' ),
+            default: getAnswer(  'company.name','Advanced Ads' ),
         },
         {
             type: 'input',
             name: 'company.url',
             message: 'Enter company website url',
-            default: getCache( 'company.url', 'https://wpadvancedads.com/' ),
+            default: getAnswer( 'company.url', 'https://wpadvancedads.com/' ),
             filter: ( val ) => val.toLowerCase()
         },
 
@@ -38,20 +36,20 @@ export default ( next ) => {
             type: 'input',
             name: 'author.name',
             message: 'Enter author name',
-            default: getCache( 'author.name', 'Advanced Ads' ),
+            default: getAnswer( 'author.name', 'Advanced Ads' ),
         },
         {
             type: 'input',
             name: 'author.email',
             message: 'Enter author email',
-            default: getCache( 'author.email', 'info@wpadvancedads.com' ),
+            default: getAnswer( 'author.email', 'info@wpadvancedads.com' ),
             filter: ( val ) => val.toLowerCase()
         },
         {
             type: 'input',
             name: 'author.url',
             message: 'Enter author website url',
-            default: getCache( 'author.url', 'https://wpadvancedads.com' ),
+            default: getAnswer( 'author.url', 'https://wpadvancedads.com' ),
             filter: ( val ) => val.toLowerCase()
         },
 
@@ -60,33 +58,33 @@ export default ( next ) => {
             type: 'input',
             name: 'wp.textDomain',
             message: 'Enter text domain for i18n',
-            default: getCache( 'wp.textDomain' ),
+            default: getAnswer( 'wp.textDomain' ),
             filter: ( val ) => val.toLowerCase()
         },
         {
             type: 'input',
             name: 'wp.version',
             message: 'Enter plugin version',
-            default: getCache( 'version', '1.0.0' ),
+            default: getAnswer( 'version', '1.0.0' ),
             filter: ( val ) => val.toLowerCase()
         },
         {
             type: 'input',
             name: 'wp.name',
             message: 'Enter plugin name',
-            default: getCache( 'wp.name' ),
+            default: getAnswer( 'wp.name' ),
         },
         {
             type: 'input',
             name: 'wp.description',
             message: 'Enter plugin description',
-            default: getCache( 'wp.description' ),
+            default: getAnswer( 'wp.description' ),
         },
         {
             type: 'input',
             name: 'wp.proxy',
             message: 'Enter wordpress installation url',
-            default: getCache( 'wp.proxy' ),
+            default: getAnswer( 'wp.proxy' ),
         },
 
         // PHP
@@ -94,7 +92,7 @@ export default ( next ) => {
             type: 'input',
             name: 'php.package',
             message: 'Enter php package attribute',
-            default: getCache( 'php.package' ),
+            default: getAnswer( 'php.package' ),
             filter: ( val ) => val.replace( / /g, '' )
         },
     ]

package/src/utilities/cache.js

@@ -0,0 +1,23 @@
+/**
+ * External dependencies
+ */
+import flatCache from 'flat-cache'
+
+/**
+ * Internal Dependencies
+ */
+import { getRootFolder } from './folder.js'
+
+export const CACHE_FILE = 'adv-ads-scaffolding'
+
+export function getCacheStore() {
+    return flatCache.load( CACHE_FILE, getRootFolder() )
+}
+
+export function getSettings() {
+    const cache = getCacheStore()
+    let saved = cache.all()
+    saved = saved ? saved.answers : {}
+
+    return saved
+}

package/src/utilities/command.js

@@ -0,0 +1,29 @@
+/**
+ * External Dependencies
+ */
+import argv from 'yargs-parser'
+
+/**
+ * Get arguments
+ *
+ * @returns {Array} arguments
+ */
+export function getArguments() {
+    return argv( process.argv.slice( 2 ) )
+}
+
+/**
+ * Get command with arguments
+ *
+ * @returns {Object} command and arguments
+ */
+export function getCommand() {
+    const args = getArguments()
+    const { _, ...rest } = args
+    const command = _[0] || 'help'
+
+    return {
+        command,
+        args: rest || []
+    }
+}

package/src/utilities/file.js

@@ -0,0 +1,57 @@
+/**
+ * External dependencies
+ */
+import chalk from 'chalk'
+import logSymbols from 'log-symbols'
+
+/**
+ * Node dependencies
+ */
+import fs from 'fs'
+import { onSameLine } from './formatting.js'
+
+export function backupFile(name, file) {
+    if ( ! fs.existsSync(file) ) {
+        console.log( `${logSymbols.error} ${chalk.red(`${name} file not found!`)}` )
+        return
+    }
+
+    fs.renameSync(
+        file,
+        file + '.bak'
+    )
+    console.log( `${logSymbols.success} ${chalk.dim(`${name} backed up!`)}` )
+}
+
+export function deleteFile(name, file) {
+    if ( ! fs.existsSync(file) ) {
+        console.log( `${logSymbols.error} ${chalk.red(`${name} file not found!`)}` )
+        return
+    }
+
+    fs.rmSync(file)
+    console.log( `${logSymbols.success} ${chalk.dim(`${name} deleted!`)}` )
+}
+
+export function updateFileContent(fileName, messages, next, callback) {
+    process.stdout.write(messages.updating)
+
+    fs.readFile(fileName, (err, buffer) => {
+        if ( null !== err ) {
+            onSameLine(`${logSymbols.error} ${messages.failed}`)
+            return next(true)
+        }
+
+        const content = callback(buffer.toString())
+
+        fs.writeFile(fileName, content, (err) => {
+            if ( null !== err ) {
+                onSameLine(`${logSymbols.error} ${messages.failed}`)
+                return next(true)
+            }
+
+            onSameLine(`${logSymbols.success} ${messages.updated}`)
+            next()
+        })
+    })
+}