Noved 'rename' from script to Gulp task

Author: dmhendricks

.gitignore

@@ -39,7 +39,7 @@ config.rb
 
 # Composer #
 ############
-!assets/js/vendor/
+!src/js/vendor/
 wpcs/
 composer.lock
 
@@ -63,6 +63,9 @@ node_modules
 
 # Development - Remove if you want them included in your own plugin repo #
 ##########################################################################
+languages/*.pot
+languages/*.po
+languages/*.mo
 vendor/
 assets/css/**/*.css
 assets/css/**/*.map

README.md

@@ -21,6 +21,9 @@ It may also be used as the means of [separating custom code](http://www.billeric
 * Configuration registry ([docs](https://github.com/dmhendricks/wordpress-toolkit/wiki/ConfigRegistry)) and optional `wp-config.php` [Constants](https://github.com/dmhendricks/wordpress-base-plugin/wiki/Configuration-&-Constants)
 * [More to come...](#planned-features)
 
+**Note:** Gulp and Bower are optional, but handy. If you do not wish to use them, you can delete the references.
+
+
 ## Requirements
 
 * WordPress 4.0 or higher
@@ -57,10 +60,9 @@ This plugin loads many of its defaults & settings from `plugin.json`. See [Confi
 
 ## Planned Features & TODO
 
-#### Before 0.3.0 Pre-Release
+#### 0.3.0 Pre-Release
 
 * Add gulp task to package plugin as ZIP file
-* Move NPM scripts to gulp tasks
 
 #### Future Releases
 
@@ -75,6 +77,7 @@ Release changes are noted on the [Releases](https://github.com/dmhendricks/wordp
 
 * Bumped minimum PHP version check to 5.6
 * Added [Gulp](https://gulpjs.com/) for task automation (SASS, JS processing)
+	* Added `gulp rename` task ([notes](https://github.com/dmhendricks/wordpress-base-plugin/wiki#rename-files-and-strings))
 * Added [Bower](https://bower.io/) to (optionally) load third-party scripts
 * Drastically refactored configuration management
 * Split out settings pages, shortcodes, CPT & widgets into separate files/classes (thanks [obstschale](https://github.com/obstschale/wordpress-base-plugin))

gulpfile.js

@@ -11,12 +11,14 @@
  * @version 1.0.3
  */
 
+var pkg = require('./package.json');
+
 /**
  * Configuration
  *
  * In paths you can add <<glob or array of globs>>. Edit the variables as per your project requirements.
  */
-var project             = 'wordpress-base-plugin'; // Project slug
+var project             = pkg.name; // Project slug
 var cssOutputStyle      = 'expanded'; // Values: compact, compressed, nested, expanded
 var cssOutputCoumments  = false; // Output SASS source/line numbers in compiled CSS files
 
@@ -57,9 +59,15 @@ var jsTasks = [
   }
 ];
 
-// Arrays to hold created task info
-var tasks_css = [];
-var tasks_js = [];
+
+/* Define strings to replace using 'gelp rename', defined in the config section of package.json */
+var renameStrings = [
+  [ 'dmhendricks\/wordpress-base-plugin', pkg.config.username + '/' + pkg.name ], // Git/Composer identifier
+	[ 'wordpress-base-plugin', pkg.name ], // Plugin slug
+	[ 'VendorName\\PluginName', pkg.config.php_namespace ], // PHP namespace for your plugin
+  [ 'VendorName\\\\PluginName', pkg.config.php_namespace.replace(/\\/g, '\\\\') ], // Rename Composer namespace
+	[ 'WPBP_NS', pkg.config.javascript_object ] // Unique JavaScript object for your plugin
+];
 
 /**
  * Browsers for which you want to enable autoprefixing.
@@ -84,6 +92,7 @@ const AUTOPREFIXER_BROWSERS = [
  * Load gulp plugins and pass them semantic names.
  */
 var gulp         = require('gulp');
+var pkg          = require('./package.json');
 
 // CSS-related plugins
 var sass         = require('gulp-sass'); // Gulp pluign for Sass compilation.
@@ -96,11 +105,19 @@ var concat       = require('gulp-concat'); // Concatenates JS files
 var uglify       = require('gulp-uglify'); // Minifies JS files
 
 // Utility related plugins.
-var rename       = require('gulp-rename'); // Renames files E.g. style.css -> style.min.css
+var rename       = require('gulp-rename'); // Renames files (ex: style.css -> style.min.css)
+var replace      = require('gulp-batch-replace'); // Replace strings inside files
 var lineec       = require('gulp-line-ending-corrector'); // Consistent Line Endings for non UNIX systems. Gulp Plugin for Line Ending Corrector (A utility that makes sure your files have consistent line endings)
 var filter       = require('gulp-filter'); // Enables you to work on a subset of the original files by filtering them using globbing.
 var sourcemaps   = require('gulp-sourcemaps'); // Maps code in a compressed file (E.g. style.css) back to it’s original position in a source file (E.g. structure.scss, which was later combined with other css files to generate style.css)
-var notify       = require('gulp-notify'); // Sends message notification to you
+var notify       = require('gulp-notify'); // Displays notification message
+var batchRename  = require('gulp-simple-rename'); // Rename files with wildcard
+var vinylPaths   = require('vinyl-paths');
+var del          = require('del'); // Delete files that are renamed
+
+/* Arrays to hold created task info */
+var tasks_css = [];
+var tasks_js = [];
 
 /**
  * Style tasks
@@ -210,6 +227,22 @@ gulp.task( 'default', object_property_to_array( tasks_js, 'id', tasks_css ), fun
 
 });
 
+/**
+ * Task to rename files and variables
+ */
+gulp.task( 'rename', function () {
+
+  return gulp.src( [ './**/*.php', './*.json', './**/*.js', './**/*.scss', './*.txt', '!./node_modules/**', '!./vendor/**', '!./.git/**', '!./languages/**', '!./*lock*', '!./gulpfile.js' ] )
+    .pipe( replace( renameStrings ) )
+    .pipe( vinylPaths( del ) )
+    .pipe( batchRename( function (path) {
+      return path.replace( /wordpress-base-plugin/, pkg.name );
+    } ) )
+    .pipe( gulp.dest( './' ) )
+    .pipe( notify( { message: 'TASK: "rename" completed.', onLast: true } ) );
+
+});
+
 /**
  * Helper functions
  */

package.json

@@ -3,13 +3,12 @@
   "author": "Daniel M. Hendricks",
   "license": "GPL-2.0",
   "config": {
-    "slug": "wordpress-base-plugin",
-    "namespace": "VendorName\\PluginName",
+    "username": "dmhendricks",
+    "php_namespace": "VendorName\\PluginName",
     "javascript_object": "WPBP_NS"
   },
   "scripts": {
-    "translate": "wp-pot -s 'app/**/*.php' -o ./languages/$npm_package_config_slug.pot -p $npm_package_config_slug",
-    "rename": "replace $npm_package_name $npm_package_config_slug . -r --exclude='node_modules,vendor,package.json'; replace 'VendorName\\\\PluginName' $npm_package_config_namespace . -r --exclude='node_modules,vendor,package.json'; replace 'WPBP_NS' $npm_package_config_javascript_object . -r --include='assets,src'; renamer -v --find $npm_package_name --replace $npm_package_config_slug *.*; renamer -v --find $npm_package_name --replace $npm_package_config_slug ./assets/js/**;"
+    "translate": "wp-pot -s 'app/**/*.php' -o ./languages/$npm_package_name.pot -p $npm_package_config_slug"
   },
   "devDependencies": {
     "gulp": "^3.9.1",
@@ -24,9 +23,14 @@
     "gulp-sourcemaps": "^1.5.2",
     "gulp-uglify": "^1.5.3",
     "gulp-uglifycss": "^1.0.6",
-    "gulp-sort": "^2.0.0",
+    "gulp-batch-replace": "*",
+    "gulp-simple-rename": "^0.1.3",
+    "vinyl-paths": "^2.1.0",
     "wp-pot-cli": "^1.0",
-    "replace": "^0.3.0",
-    "renamer": "^0.6.0"
+    "del": "^3.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/dmhendricks/my-plugin.git"
   }
 }