Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ignore(index,gulpfile): scaffolding and todos #582

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 18 additions & 8 deletions generators/app/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ const stripBom = require('gulp-stripbom')
const validateElementName = require('validate-element-name')
const pjson = require('../../package.json')

// Var isodate = (new Date()).toISOString();

// Potential location for teipub defaults. see https://github.com/enquirer/enquirer/issues/15
module.exports = class extends Generator {
initializing () {
Expand Down Expand Up @@ -122,10 +120,10 @@ module.exports = class extends Generator {
return nameValidation.isValid
}
},
// TODO: [yo] Make these options meaningful
// TODO: line-o [gulp] Promp user for build system
// {
// type: 'checkbox',
// choices: ['ant', 'gulp', 'maven', 'gradle'],
// choices: ['ant', 'gulp'],
// name: 'builder',
// message: 'How would you like to build your app?',
// default: 'ant'
Expand Down Expand Up @@ -366,7 +364,7 @@ module.exports = class extends Generator {
}]

// TODO: [yo]: js, css, gulp, funcdoc,
// TODO: [gulp] https://github.com/bnjjj/generator-gulpfile-advanced
// TODO: [gulp] line-o we could also extend this module https://github.com/bnjjj/generator-gulpfile-advanced

return this.prompt(prompts).then(props => {
// To access props later use this.props.someAnswer;
Expand Down Expand Up @@ -447,6 +445,7 @@ module.exports = class extends Generator {
}
// TODO html -> xhtml
// Applies to all (build, expath-pkg, repo, xqs)
// TODO: [gulp] line-o here build.xml is copied for all outputs by default needs to become conditional
this.fs.copyTpl(
this.templatePath('build.xml'),
this.destinationPath('build.xml'), {
Expand Down Expand Up @@ -519,6 +518,13 @@ module.exports = class extends Generator {
this.destinationPath('icon.png')
)
}
// TODO: [gulp] line-o here we could add another if for libraries
// if (this.props.apptype[1] === 'library') {
// this.fs.copyTpl(
// this.templatePath('gulpfile.js'),
// this.destinationPath('gulpfile.js'), { someprop: this.props.something}
// )
// }
// not polymer (flexible)
if (this.props.apptype[0] !== 'empty' && this.props.apptype[0] !== 'polymer') {
this.fs.copyTpl(
Expand Down Expand Up @@ -571,6 +577,7 @@ module.exports = class extends Generator {
apptype: this.props.apptype[0]
})
// Poly2 template is deprecated
// TODO: line-o potential template for how to expand package.json with devDeps
Object.assign(pkgJson.devDependencies, {
'brace-expansion': '^1.1.4',
del: '^2.2.0',
Expand Down Expand Up @@ -829,6 +836,7 @@ module.exports = class extends Generator {
}

// no prompt
// TODO: see #562
// CI, mocha, cypress testing (no prompts)
this.fs.copyTpl(
this.templatePath('ci/.travis.yml'),
Expand All @@ -837,7 +845,7 @@ module.exports = class extends Generator {
}
)

// TODO these will need to be adapted for polymer apps
// TODO these will need to be adapted for publisher apps
// Mocha
this.fs.copy(
this.templatePath('tests/mocha/app_spec.js'),
Expand Down Expand Up @@ -922,6 +930,7 @@ module.exports = class extends Generator {
this.bowerInstall()
}

// TODO: [gulp] line-o this is how i used to run Gulp for tei-pub apps back in the day
// this will start the default polymer cli
// if (this.props.apptype[0] === 'polymer') {
// this.spawnCommandSync('polymer', ['init', this.props.polytempl[1]])
Expand All @@ -934,9 +943,10 @@ module.exports = class extends Generator {
this.spawnCommandSync('git', ['add', '--all'])
this.spawnCommandSync('git', ['commit', '-q', '-m', '\'initial scaffolding by Yeoman\''])
}
this.spawnCommandSync('ant', '-q')
// TODO: [gulp] line-o make conditional on selected build tool
this.spawnCommandSync('ant', '-q')

// conditional gulp watch
// TODO: [gulp] line-o conditional gulp watch
// if (this.props.apptype[0] === 'polymer') {
// this.spawnCommandSync('gulp', ['watch'])
// }
Expand Down
5 changes: 5 additions & 0 deletions generators/app/templates/gulpfile.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// TODO: line-o tell me what you want what you really really …
// see https://docs.google.com/document/d/1UdSWERC9rCSYIYjTGgCr3avce47h5OeLFR4tGKYXZlM/edit#heading=h.ei4sqy3ojpkl
// see https://github.com/line-o/gulp-exist-example/blob/main/gulpfile.js
// see https://github.com/eXist-db/documentation/blob/master/Gulpfile.js
// see #563
3 changes: 3 additions & 0 deletions test/generated-pkg/app-empty.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ const fs = require('fs-extra')

describe('empty package', function () {
this.timeout(15000)
// TODO: #563 [gulp] line-o let's make this the test application for pure gulp build
// we should also add a second app-lib-gulp bringing some of the old polymer file checks
// over and testing the proper gulpfile contents for libs vs apps
before(async function () {
await helpers.run(path.join(__dirname, '../../generators/app'))
.withPrompts({
Expand Down