Move rsc contents to doc directory and updated gulp doc task.
This commit is contained in:
parent
01b0bc3fa3
commit
725edfb6ca
9 changed files with 32 additions and 31 deletions
7
.gitignore
vendored
7
.gitignore
vendored
|
@ -1,9 +1,10 @@
|
||||||
/*.zip
|
/*.zip
|
||||||
/.idea/
|
/.idea/
|
||||||
/.tmp-package/
|
/.tmp-package/
|
||||||
/doc/apigen/
|
/build/
|
||||||
/doc/jsdoc/
|
/doc/apigen/html
|
||||||
/doc/plato/
|
/doc/jsdoc/html
|
||||||
|
/doc/plato/html
|
||||||
/node_modules/
|
/node_modules/
|
||||||
/npm-debug.log
|
/npm-debug.log
|
||||||
/src/config.php
|
/src/config.php
|
||||||
|
|
0
doc/apigen/apigen.phar
Normal file
0
doc/apigen/apigen.phar
Normal file
Before Width: | Height: | Size: 41 KiB After Width: | Height: | Size: 41 KiB |
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
Before Width: | Height: | Size: 7 KiB After Width: | Height: | Size: 7 KiB |
0
doc/jsdoc/jsdoc.md
Normal file
0
doc/jsdoc/jsdoc.md
Normal file
0
doc/plato/plato.md
Normal file
0
doc/plato/plato.md
Normal file
56
gulpfile.js
56
gulpfile.js
|
@ -42,39 +42,39 @@ gulp.task('composer', function() {
|
||||||
*/
|
*/
|
||||||
gulp.task('build', function(done) {
|
gulp.task('build', function(done) {
|
||||||
del.sync([
|
del.sync([
|
||||||
'.tmp-package',
|
'build',
|
||||||
'easyappointments.zip'
|
'easyappointments-0.0.0.zip'
|
||||||
]);
|
]);
|
||||||
|
|
||||||
fs.copySync('src', '.tmp-package');
|
fs.copySync('src', 'build');
|
||||||
fs.removeSync('.tmp-package/config.php');
|
fs.removeSync('build/config.php');
|
||||||
fs.copySync('CHANGELOG.md', '.tmp-package/CHANGELOG.md');
|
fs.copySync('CHANGELOG.md', 'build/CHANGELOG.md');
|
||||||
fs.copySync('README.md', '.tmp-package/README.md');
|
fs.copySync('README.md', 'build/README.md');
|
||||||
fs.copySync('LICENSE', '.tmp-package/LICENSE');
|
fs.copySync('LICENSE', 'build/LICENSE');
|
||||||
|
|
||||||
del.sync([
|
del.sync([
|
||||||
'.tmp-package/storage/uploads/*',
|
'build/storage/uploads/*',
|
||||||
'!.tmp-package/storage/uploads/index.html'
|
'!build/storage/uploads/index.html'
|
||||||
]);
|
]);
|
||||||
|
|
||||||
del.sync([
|
del.sync([
|
||||||
'.tmp-package/storage/logs/*',
|
'build/storage/logs/*',
|
||||||
'!.tmp-package/storage/logs/index.html'
|
'!build/storage/logs/index.html'
|
||||||
]);
|
]);
|
||||||
|
|
||||||
del.sync([
|
del.sync([
|
||||||
'.tmp-package/storage/sessions/*',
|
'build/storage/sessions/*',
|
||||||
'!.tmp-package/storage/sessions/.htaccess',
|
'!build/storage/sessions/.htaccess',
|
||||||
'!.tmp-package/storage/sessions/index.html'
|
'!build/storage/sessions/index.html'
|
||||||
]);
|
]);
|
||||||
|
|
||||||
del.sync([
|
del.sync([
|
||||||
'.tmp-package/storage/cache/*',
|
'build/storage/cache/*',
|
||||||
'!.tmp-package/storage/cache/.htaccess',
|
'!build/storage/cache/.htaccess',
|
||||||
'!.tmp-package/storage/cache/index.html'
|
'!build/storage/cache/index.html'
|
||||||
]);
|
]);
|
||||||
|
|
||||||
zip('.tmp-package', { saveTo: 'easyappointments.zip' }, function (err, buffer) {
|
zip('build', { saveTo: 'easyappointments-0.0.0.zip' }, function (err, buffer) {
|
||||||
if (err)
|
if (err)
|
||||||
console.log('Zip Error', err);
|
console.log('Zip Error', err);
|
||||||
|
|
||||||
|
@ -86,21 +86,21 @@ gulp.task('build', function(done) {
|
||||||
* Generate code documentation.
|
* Generate code documentation.
|
||||||
*/
|
*/
|
||||||
gulp.task('doc', function(done) {
|
gulp.task('doc', function(done) {
|
||||||
fs.removeSync('doc/apigen');
|
fs.removeSync('doc/apigen/html');
|
||||||
fs.mkdirSync('doc/apigen');
|
fs.mkdirSync('doc/apigen/html');
|
||||||
fs.removeSync('doc/jsdoc');
|
fs.removeSync('doc/jsdoc/html');
|
||||||
fs.mkdirSync('doc/jsdoc');
|
fs.mkdirSync('doc/jsdoc/html');
|
||||||
fs.removeSync('doc/plato');
|
fs.removeSync('doc/plato/html');
|
||||||
fs.mkdirSync('doc/plato');
|
fs.mkdirSync('doc/plato/html');
|
||||||
|
|
||||||
const commands = [
|
const commands = [
|
||||||
'php rsc/apigen.phar generate ' +
|
'php doc/apigen/apigen.phar generate ' +
|
||||||
'-s "src/application/controllers,src/application/models,src/application/libraries" ' +
|
'-s "src/application/controllers,src/application/models,src/application/libraries" ' +
|
||||||
'-d "doc/apigen" --exclude "*external*" --tree --todo --template-theme "bootstrap"',
|
'-d "doc/apigen/html" --exclude "*external*" --tree --todo --template-theme "bootstrap"',
|
||||||
|
|
||||||
path.join('.', 'node_modules', '.bin', 'jsdoc') + ' "src/assets/js" -d "doc/jsdoc"',
|
path.join('.', 'node_modules', '.bin', 'jsdoc') + ' "src/assets/js" -d "doc/jsdoc/html"',
|
||||||
|
|
||||||
path.join('.', 'node_modules', '.bin', 'plato') + ' -r -d "doc/plato" "src/assets/js"'
|
path.join('.', 'node_modules', '.bin', 'plato') + ' -r -d "doc/plato/html" "src/assets/js"'
|
||||||
];
|
];
|
||||||
|
|
||||||
commands.forEach(function(command) {
|
commands.forEach(function(command) {
|
||||||
|
|
BIN
rsc/apigen.phar
BIN
rsc/apigen.phar
Binary file not shown.
Loading…
Reference in a new issue