Skip to content

Commit 9e7c60a

Browse files
committed
Added Gulp
1 parent 7ec47ca commit 9e7c60a

19 files changed

Lines changed: 391 additions & 88 deletions

.gitignore

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@ config.rb
3939

4040
# Composer #
4141
############
42-
vendor/
4342
!assets/js/vendor/
4443
wpcs/
4544
composer.lock
@@ -62,6 +61,9 @@ assets/bower_components/*
6261
#######
6362
node_modules
6463

65-
# Development #
66-
###############
67-
dev/
64+
# Development - Remove if you want them included in your own plugin repo #
65+
##########################################################################
66+
vendor/
67+
assets/css/**/*.css
68+
assets/css/**/*.map
69+
assets/js/**/*.js

README.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,11 @@ It may also be used as the means of [separating custom code](http://www.billeric
1414

1515
* Namespaces & dependency autoloading
1616
* Version checking (PHP, Carbon Fields)
17+
* [Gulp](https://gulpjs.com/) for JavaScript/SASS processing & minification (documentation coming soon)
1718
* Object caching (where available) - [Usage Examples](https://github.com/dmhendricks/wordpress-base-plugin/wiki#caching)
1819
* Automatic translation file (`.pot`) creation. See [Translation](https://github.com/dmhendricks/wordpress-base-plugin/wiki#translation).
1920
* Shortcodes, widgets and custom post type (via [PostTypes](https://github.com/jjgrainger/PostTypes/)) examples
20-
* Optional configuration [Constants](https://github.com/dmhendricks/wordpress-base-plugin/wiki/Configuration-&-Constants)
21+
* Configuration registry (documentation coming soon) and optional `wp-config.php` [Constants](https://github.com/dmhendricks/wordpress-base-plugin/wiki/Configuration-&-Constants)
2122
* [More to come...](#planned-features)
2223

2324
## Requirements
@@ -40,23 +41,20 @@ It may also be used as the means of [separating custom code](http://www.billeric
4041

4142
### Next Steps
4243

43-
See the [Getting Started](https://github.com/dmhendricks/wordpress-base-plugin/wiki#getting-started) documentation.
44-
44+
See the [Getting Started](https://github.com/dmhendricks/wordpress-base-plugin/wiki#getting-started) documentation for further steps.
4545

4646
## Plugin Settings
4747

4848
This plugin loads many of its defaults & settings from `plugin.json`. See [Configuration & Constants](https://github.com/dmhendricks/wordpress-base-plugin/wiki/Configuration-&-Constants#pluginjson) for more information.
4949

5050
## Planned Features & TODO
5151

52-
* Add task runner, related documentation, update .gitignore and rearrange `./assets`
53-
* Add external class library for common features
54-
* Add ability to modify plugin meta in Plugins list
55-
* Move Cache class as separate dependency
56-
* Add Ajax call example
52+
* Update documentation to reflect recent changes
5753
* Add encrypt/decrypt example (`password` field with encrypted `hidden` field)
5854
* Add Customizer example
5955
* Add dynamically-created CSS/JS files based on settings
56+
* Use [Bower](https://bower.io/) to manage vendor scripts and move `./src/js/vendor` to `./src/components`
57+
* Use [TGMPA](http://tgmpluginactivation.com/) for Carbon Fields dependency checking
6058

6159
## Change Log
6260

@@ -65,6 +63,7 @@ Release changes are noted on the [Releases](https://github.com/dmhendricks/wordp
6563
#### Branch: `master`
6664

6765
* Bumped minimum PHP version check to 5.6
66+
* Added [Gulp](https://gulpjs.com/) for task automation (SASS, JS processing)
6867
* Drastically refactored configuration management
6968
* Split out settings pages, shortcodes, CPT & widgets into separate files/classes (thanks [obstschale](https://github.com/obstschale/wordpress-base-plugin))
7069
* Added `wp-pot-cli` to `package.json` to create `.pot` translation file
@@ -74,6 +73,7 @@ Release changes are noted on the [Releases](https://github.com/dmhendricks/wordp
7473
* Added `VERSION` constant ([info](https://github.com/dmhendricks/wordpress-base-plugin/wiki/Configuration-&-Constants#defined-by-plugin))
7574
* Added [wordpress-toolkit](https://github.com/dmhendricks/wordpress-toolkit) as dependency
7675
* Renamed `Utils` class to `Helpers`
76+
* Added "Clear Cache" link to admin bar dropdown
7777

7878
## Credits
7979

@@ -87,6 +87,14 @@ Please support [humans.txt](http://humanstxt.org/). It's an initiative for knowi
8787
Author URI: https://htmlburger.com/
8888
Location: London, England
8989

90+
**WPGulp**
91+
92+
URL: https://labs.ahmadawais.com/WPGulp/
93+
Author: Ahmad Awais
94+
Twitter: @mrahmadawais
95+
Author URI: https://ahmadawais.com/
96+
Location: Asal, Pakistan
97+
9098
**PostTypes**
9199

92100
URL: https://github.com/jjgrainger/PostTypes/

assets/css/.DO_NOT_EDIT.txt

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@ Do not edit the CSS files in the directory - they are automatically
22
generated/compiled with SASS. Doing so may result in your changes being
33
overwritten.
44

5-
To make changes to style, modify the appropriate file in the ../scss directory
6-
and use a SASS compiler to generate the CSS file(s).
5+
To make changes to style, modify the appropriate file in the src/scss directory
6+
and Gulp (recommended) or other SASS compiler to generate the CSS file(s).
77

8-
A good compiler is Koala (http://koala-app.com/). Just point it to the ../scss
9-
folder, make your changes to the SCSS file(s), and click compile. It will
10-
automatically generate the CSS file(s) here.
8+
If you don't want to use Gulp, Koala (http://koala-app.com/) is a good,
9+
cross-platform compiler. Just point it to the src/scss folder, make your
10+
changes to the SCSS file(s), and click compile. It will automatically generate
11+
the CSS file(s) here.
1112

12-
(This only applies if SASS is being used to manage and compile CSS output.)
13+
(This only applies if SASS is being used to generate style.)

assets/css/site.css

Lines changed: 0 additions & 30 deletions
This file was deleted.

assets/js/.gitkeep

Whitespace-only changes.

assets/js/wordpress-base-plugin-admin.js

Lines changed: 0 additions & 7 deletions
This file was deleted.

assets/js/wordpress-base-plugin.js

Lines changed: 0 additions & 5 deletions
This file was deleted.

assets/scss/_variables.scss

Lines changed: 0 additions & 10 deletions
This file was deleted.

assets/scss/config.rb

Lines changed: 0 additions & 11 deletions
This file was deleted.

0 commit comments

Comments
 (0)