16 |
20 |
17 | eXistDB
18 |
19 |
21 |
66 |
67 |
68 |
2 | <% if(apptype == 'plain'){ %>
3 |
4 | world ')
33 | next()
34 | }
35 |
36 | // respond with the result of running XQsuite test
37 | function runs (req, res, next) {
38 | res.setHeader('content-type', 'application/json')
39 | res.charSet('utf-8')
40 | res.send(200, body)
41 | next()
42 | }
43 |
44 | server.get('/exist/rest/db/', respond)
45 | server.head('/exist/rest/db/', respond)
46 |
47 | server.get('/exist/rest/db/my-app/modules/test-runner.xq', runs)
48 | server.head('/exist/rest/db/my-app/modules/test-runner.xq', runs)
49 |
50 | // do not use 8080!
51 | server.listen(3000, function () {
52 | console.log('%s listening at %s', server.name, server.url)
53 | })
54 |
55 | // server.close()
56 | }
57 |
--------------------------------------------------------------------------------
/generators/app/templates/build.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 | <%- desc %>
4 |
11 |
20 |
21 |
22 |
23 |
25 |
26 |
27 |
28 |
30 |
31 |
32 |
34 |
35 |
--------------------------------------------------------------------------------
/generators/app/templates/xq/view.xq:
--------------------------------------------------------------------------------
1 | (:~
2 | : This is the main XQuery which will (by default) be called by controller.xq
3 | : to process any URI ending with ".html". It receives the HTML from
4 | : the controller and passes it to the templating system.
5 | :
6 | : @version <%- version %>
7 | :)
8 | xquery version "3.1";
9 |
10 | import module namespace templates="http://exist-db.org/xquery/html-templating";
11 | import module namespace lib="http://exist-db.org/xquery/html-templating/lib";
12 |
13 | (:
14 | : The following modules provide functions which will be called by the
15 | : templating.
16 | :)
17 |
18 | import module namespace config="<%- defuri %>/<%- defcoll %>/<%- short %>/config" at "config.xqm";
19 | import module namespace app="<%- defuri %>/<%- defcoll %>/<%- short %>/templates" at "app.xqm";
20 |
21 |
22 | declare namespace output = "http://www.w3.org/2010/xslt-xquery-serialization";
23 |
24 | declare option output:method "html5";
25 | declare option output:media-type "text/html";
26 |
27 | let $config := map {
28 | $templates:CONFIG_APP_ROOT: $config:app-root,
29 | $templates:CONFIG_STOP_ON_ERROR: true()
30 | }
31 | (:
32 | : We have to provide a lookup function to templates:apply to help it
33 | : find functions in the imported application modules. The templates
34 | : module cannot see the application modules, but the inline function
35 | : below does see them.
36 | :)
37 | let $lookup := function ($functionName as xs:string, $arity as xs:integer) {
38 | try {
39 | function-lookup(xs:QName($functionName), $arity)
40 | } catch * {
41 | ()
42 | }
43 | }
44 | (:
45 | : The HTML is passed in the request from the controller.
46 | : Run it through the templating system and return the result.
47 | :)
48 | let $content := request:get-data()
49 | return
50 | templates:apply($content, $lookup, (), $config)
51 |
--------------------------------------------------------------------------------
/generators/app/templates/xq/controller.xq:
--------------------------------------------------------------------------------
1 | xquery version "3.1";
2 |
3 | (:~ The controller library contains URL routing functions.
4 | :
5 | : @see http://www.exist-db.org/exist/apps/doc/urlrewrite.xml
6 | :)
7 |
8 | <%_ if (mysec) { %>
9 | import module namespace login="http://exist-db.org/xquery/login" at "resource:org/exist/xquery/modules/persistentlogin/login.xql";
10 | <% } -%>
11 |
12 | declare variable $exist:path external;
13 | declare variable $exist:resource external;
14 | declare variable $exist:controller external;
15 | declare variable $exist:prefix external;
16 | declare variable $exist:root external;
17 |
18 | <%_ if (mysec) { %>
19 | declare variable $local:login_domain := "org.exist-db.mysec";
20 | declare variable $local:user := $local:login_domain || '.user';
21 |
22 | let $logout := request:get-parameter("logout", ())
23 | let $set-user := login:set-user($local:login_domain, (), false())
24 | return
25 | <% } %>
26 |
27 | if ($exist:path eq '') then
28 |
29 |
31 |
32 | else if ($exist:path eq "/") then
33 | (: forward root path to index.xql :)
34 |
35 |
37 |
38 | else if (ends-with($exist:resource, ".html")) then (
39 | (: the html page is run through view.xq to expand templates :)
40 |
41 |
42 |
44 |
45 |
48 | )
49 | else
50 | (: everything else is passed through :)
51 |
52 |
54 |
--------------------------------------------------------------------------------
/generators/app/templates/pages/mysec/templates/login-panel.html:
--------------------------------------------------------------------------------
1 |
2 |
39 |
--------------------------------------------------------------------------------
/test/generated-pkg/app-mysec.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 | const path = require('path')
3 | const assert = require('yeoman-assert')
4 | const helpers = require('yeoman-test')
5 | const fs = require('fs-extra')
6 |
7 | describe('eXide style …', function () {
8 | before(async function () {
9 | this.timeout(10000)
10 | await helpers.run(path.join(__dirname, '../../generators/app'))
11 | .withPrompts({
12 | title: 'foo',
13 | author: 'tester',
14 | email: 'te@st.er',
15 | apptype: ['exist-design', 'application'],
16 | mysec: true,
17 | pre: true,
18 | post: false,
19 | license: ['MIT', 'MIT', 'https://opensource.org/licenses/MIT'],
20 | github: false,
21 | setperm: false,
22 | atom: false
23 | })
24 | assert.noFile('readme.md')
25 | })
26 |
27 | describe('secure exist design has …', function () {
28 | it('default files and restricted area', function (done) {
29 | assert.file(['admin/controller.xq', 'admin/index.html', 'templates/login-panel.html', 'pre-install.xq', 'test/cypress/e2e/login-ok.cy.js'])
30 | done()
31 | })
32 |
33 | it('login section on index.html', function (done) {
34 | assert.fileContent('templates/page.html', 'org.exist-db.mysec.user')
35 | done()
36 | })
37 |
38 | it('expanded title in repo.xml', function (done) {
39 | assert.fileContent('repo.xml', /foo<\/target>/)
40 | done()
41 | })
42 | })
43 |
44 | describe('markup files are well-formed', function () {
45 | return require('../util/app').checkWellFormed()
46 | })
47 |
48 | // !! this should stay in yo's generator test only !!
49 | // Different editors use different settings
50 | describe('xml looks good', function () {
51 | return require('../util/gulp-ews').prettyDataEWS()
52 | })
53 |
54 | describe('app meta-data', function () {
55 | return require('../util/consistency').isConsistent()
56 | })
57 |
58 | describe('test_suite has …', function () {
59 | return require('../util/meta-test').metaTest()
60 | })
61 |
62 | after('teardown', function (done) {
63 | fs.emptyDirSync(process.cwd())
64 | done()
65 | })
66 | })
67 |
--------------------------------------------------------------------------------
/test/util/app.js:
--------------------------------------------------------------------------------
1 | exports.checkWellFormed = function () {
2 | const chai = require('chai')
3 | const chaiXml = require('chai-xml')
4 | const expect = require('chai').expect
5 | const fs = require('fs-extra')
6 | const glob = require('glob')
7 | const xmldoc = require('xmldoc')
8 |
9 | chai.use(chaiXml)
10 | it('*.html is xhtml', function (done) {
11 | glob('**/*.html', { ignore: ['node_modules/**', 'bower_components/**'] }, function (err, files) {
12 | if (err) throw err
13 | // console.log(files)
14 | files.forEach(function (html) {
15 | const xhtml = fs.readFileSync(html, 'utf8')
16 | const hParsed = new xmldoc.XmlDocument(xhtml).toString()
17 | expect(hParsed).xml.to.be.valid()
18 | })
19 | })
20 | done()
21 | })
22 |
23 | it('*.xml', function (done) {
24 | glob('**/*.xml', { ignore: ['node_modules/**', 'bower_components/**'] }, function (err, files) {
25 | if (err) throw err
26 | // console.log(files)
27 | files.forEach(function (xmls) {
28 | const xml = fs.readFileSync(xmls, 'utf8')
29 | const xParsed = new xmldoc.XmlDocument(xml).toString()
30 | expect(xParsed).xml.to.be.valid()
31 | })
32 | })
33 | done()
34 | })
35 |
36 | it('*.xconf', function (done) {
37 | glob('**/*.xconf', { ignore: ['node_modules/**', 'bower_components/**'] }, function (err, files) {
38 | if (err) throw err
39 | // console.log(files)
40 | files.forEach(function (xconfs) {
41 | const xconf = fs.readFileSync(xconfs, 'utf8')
42 | const cParsed = new xmldoc.XmlDocument(xconf).toString()
43 | expect(cParsed).xml.to.be.valid()
44 | })
45 | })
46 | done()
47 | })
48 | it('*.odd', function (done) {
49 | this.slow(1000)
50 | glob('**/*.odd', { ignore: ['node_modules/**', 'bower_components/**'] }, function (err, files) {
51 | if (err) throw err
52 | // console.log(files)
53 | files.forEach(function (odds) {
54 | const odd = fs.readFileSync(odds, 'utf8')
55 | const xParsed = new xmldoc.XmlDocument(odd).toString()
56 | expect(xParsed).xml.to.be.valid()
57 | })
58 | })
59 | done()
60 | })
61 | }
62 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/bug_report.md:
--------------------------------------------------------------------------------
1 | ---
2 | name: Bug report
3 | about: Create a report to help us improve
4 | title: "[BUG]"
5 | labels: ''
6 | assignees: ''
7 |
8 | ---
9 |
10 | :balloon: First off, thank you for contributing to eXist-db's yeoman generator. :balloon:
11 |
12 | **Describe the bug**
13 | > A clear and concise description of what the bug is.
14 |
15 | **Expected behavior**
16 | > A clear and concise description of what you expected to happen.
17 |
18 | **To Reproduce**
19 | > The *best* way is to provide an [SSCCE (Short, Self Contained, Correct (Compilable), Example)](http://sscce.org/). One type of SSCCE could be a small test which reproduces the issue and can be run without dependencies. Please locate the existing test-suite and follow the examples provided there:
20 |
21 | **Unit Test**
22 | The generator uses uses [mocha](https://mochajs.org) and the `yeoman-test` framework for for its unit and integration tests.
23 |
24 | You can find mock app configs inside `test/generated-pkg`. When a bug effects multiple app types, it is generally sufficient to add another test case for just one app type.
25 |
26 | ```javascript
27 | const assert = require('yeoman-assert')
28 | const helpers = require('yeoman-test')
29 | const fs = require('fs-extra')
30 |
31 | // this is a dummy test
32 | describe('exist design has …', function () {
33 | it('default files', function (done) {
34 | assert.file(['repo.xml', 'modules/app.xql'])
35 | done()
36 | })
37 |
38 | it('type specific files', function (done) {
39 | assert.file(['resources/css/exist-2.2.css'])
40 | done()
41 | })
42 | })
43 | ```
44 |
45 | If none of the above is working, please tell us the exact steps you took when you encountered the problem:
46 | 1. Go to '...'
47 | 2. Click on '....'
48 | 3. Scroll down to '....'
49 | 4. See error
50 |
51 | **Screenshots**
52 | If applicable, add screenshots to help explain your problem.
53 |
54 | **Logs, error messages**
55 | > Paste the contents of error messages or log files here (exist.log, stdout). What does `npm test` produce?
56 |
57 | **Context (please always complete the following information):**
58 | - node version: `x.x.x`
59 | - eXist-db version: `x.x.x`
60 | - generator version: `x.x.x`
61 | - install method: `npm / github`
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "@existdb/generator-exist",
3 | "version": "1.0.0",
4 | "description": "exist-db app boilerplate",
5 | "homepage": "https://github.com/eXist-db/generator-exist#readme",
6 | "bugs": "https://github.com/eXist-db/generator-exist/issues",
7 | "engines": {
8 | "node": ">=14.0.0"
9 | },
10 | "author": {
11 | "name": "Duncan Paterson",
12 | "email": "d.paterson@me.com",
13 | "url": "https://github.com/duncdrum"
14 | },
15 | "publishConfig": {
16 | "access": "public"
17 | },
18 | "license": "MIT",
19 | "files": [
20 | "generators"
21 | ],
22 | "main": "generators/app/index.js",
23 | "keywords": [
24 | "exist",
25 | "xml",
26 | "xql",
27 | "xquery",
28 | "exist-db",
29 | "prototype",
30 | "yeoman-generator"
31 | ],
32 | "devDependencies": {
33 | "@babel/core": "^7.23.2",
34 | "chai": "^4.3.10",
35 | "chai-xml": "^0.4.1",
36 | "eslint": "^8.52.0",
37 | "eslint-config-standard": "^17.1.0",
38 | "eslint-config-xo-space": "^0.34.0",
39 | "eslint-plugin-import": "^2.29.0",
40 | "eslint-plugin-mocha": "^10.2.0",
41 | "eslint-plugin-n": "^16.2.0",
42 | "eslint-plugin-promise": "^6.1.1",
43 | "fs-extra": "^11.2.0",
44 | "glob": "^10.3.10",
45 | "mocha": "^10.2.0",
46 | "restify": "^11.1.0",
47 | "semantic-release": "^22.0.5",
48 | "stylelint": "^16.0.1",
49 | "stylelint-config-standard": "^35.0.0",
50 | "supertest": "^6.3.3",
51 | "xmldoc": "^1.3.0",
52 | "yeoman-assert": "^3.1.1",
53 | "yeoman-test": "^6.3.0"
54 | },
55 | "dependencies": {
56 | "chalk": "^4.1.2",
57 | "generator-license": "^5.6.0",
58 | "gulp-pretty-data": "^0.1.2",
59 | "gulp-stripbom": "^1.0.5",
60 | "yeoman-environment": "^3.19.3",
61 | "yeoman-generator": "^5.9.0",
62 | "yosay": "^2.0.2"
63 | },
64 | "scripts": {
65 | "test": "mocha --recursive --exit && eslint --fix generators/app/**/*.js test/*.js *.js && stylelint --fix 'generators/app/templates/styles/exist-2.2.css'"
66 | },
67 | "eslintConfig": {
68 | "plugins": [
69 | "mocha"
70 | ],
71 | "extends": "standard",
72 | "env": {
73 | "mocha": true,
74 | "node": true
75 | }
76 | },
77 | "release": {
78 | "branches": "main"
79 | },
80 | "repository": {
81 | "type": "git",
82 | "url": "https://github.com/eXist-db/generator-exist.git",
83 | "license": "MIT"
84 | }
85 | }
86 |
--------------------------------------------------------------------------------
/test/generated-pkg/app-empty.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 | const path = require('path')
3 | const assert = require('yeoman-assert')
4 | const helpers = require('yeoman-test')
5 | const fs = require('fs-extra')
6 |
7 | describe('empty package', function () {
8 | this.timeout(15000)
9 | before(async function () {
10 | await helpers.run(path.join(__dirname, '../../generators/app'))
11 | .withPrompts({
12 | title: 'foo',
13 | author: 'tester',
14 | email: 'te@st.er',
15 | apptype: ['empty', 'application'],
16 | pre: false,
17 | post: false,
18 | license: ['MIT', 'MIT', 'https://opensource.org/licenses/MIT'],
19 | github: false,
20 | atom: false
21 | })
22 | assert.noFile(['modules/app.xqm', 'templates/page.html', 'test/cypress/e2e/login-ok.cy.js', 'index.html'])
23 | })
24 |
25 | describe('empty has', function () {
26 | it('recommended files', function (done) {
27 | assert.file(['repo.xml', 'test/mocha/app_spec.js', 'test/xqs/test-runner.xq'])
28 | done()
29 | })
30 |
31 | it('selected license', function (done) {
32 | assert.fileContent('LICENSE', 'MIT License')
33 | done()
34 | })
35 |
36 | it('a repo.xml with expanded target URL', function (done) {
37 | assert.fileContent('repo.xml', /foo<\/target>/)
38 | done()
39 | })
40 |
41 | it('no dependency on shared-resources or templating', function (done) {
42 | assert.noFileContent('expath-pkg.xml', 'http://exist-db.org/apps/shared')
43 | assert.noFileContent('expath-pkg.xml', 'http://exist-db.org/html-templating')
44 | done()
45 | })
46 |
47 | it('no default node dependencies', function (done) {
48 | assert.noFileContent('build.xml', 'bootstrap')
49 | done()
50 | })
51 |
52 | it('xqs does not import app module', function (done) {
53 | assert.noFileContent('test/xqs/test-runner.xq', 'import module namespace app')
54 | done()
55 | })
56 | })
57 |
58 | describe('markup files are well-formed', function () {
59 | return require('../util/app').checkWellFormed()
60 | })
61 |
62 | describe('app meta-data', function () {
63 | return require('../util/consistency').isConsistent()
64 | })
65 |
66 | describe('test_suite has …', function () {
67 | return require('../util/meta-test').metaTest()
68 | })
69 |
70 | after('teardown', function (done) {
71 | fs.emptyDirSync(process.cwd())
72 | done()
73 | })
74 | })
75 |
--------------------------------------------------------------------------------
/test/generated-pkg/app-eXide-plain.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 | const path = require('path')
3 | const assert = require('yeoman-assert')
4 | const helpers = require('yeoman-test')
5 | const fs = require('fs-extra')
6 |
7 | describe('eXide plain app', function () {
8 | before(async function () {
9 | this.timeout(10000)
10 | await helpers.run(path.join(__dirname, '../../generators/app'))
11 | .withPrompts({
12 | title: 'foo',
13 | author: 'tester',
14 | email: 'te@st.er',
15 | apptype: ['plain', 'application'],
16 | pre: false,
17 | post: false,
18 | license: ['MIT', 'MIT', 'https://opensource.org/licenses/MIT'],
19 | setperm: false,
20 | github: false,
21 | ci: 'GitHub Action',
22 | docker: true,
23 | dockertag: '5.0.0',
24 | atom: true,
25 | instance: 'http://localhost:8080/exist',
26 | admin: 'admin',
27 | adminpw: 'pw123'
28 | })
29 | assert.noFile(['resources/images/bold.gif', 'pre-install.xq', 'test/cypress/e2e/secure.cy.js', '.travis.yml', 'resources/css/exist-2.2.css'])
30 | })
31 |
32 | describe('plain package has', function () {
33 | it('recommended files', function (done) {
34 | assert.file(['expath-pkg.xml', 'modules/config.xqm', 'test/xqs/test-runner.xq', 'controller.xq', '.dockerignore', 'resources/images/powered-by.svg'])
35 | done()
36 | })
37 |
38 | it('default node dependencies', function (done) {
39 | assert.fileContent('build.xml', 'bootstrap')
40 | done()
41 | })
42 |
43 | it('atom file with proper uri', function (done) {
44 | assert.fileContent('.existdb.json', 'http://localhost:8080/exist')
45 | assert.fileContent('.existdb.json', 'pw123')
46 | done()
47 | })
48 |
49 | it('dockerfile with expanded package name', function (done) {
50 | assert.fileContent('Dockerfile', 'foo-1.0.0.xar')
51 | done()
52 | })
53 |
54 | it('GitHub Action Workflow', function (done) {
55 | assert.fileContent('.github/workflows/exist.yml', 'cypress')
56 | done()
57 | })
58 |
59 | it('expanded title on index.html', function (done) {
60 | assert.fileContent('templates/page.html', 'foo')
61 | done()
62 | })
63 | })
64 | describe('markup files are well-formed', function () {
65 | return require('../util/app').checkWellFormed()
66 | })
67 |
68 | describe('app meta-data', function () {
69 | return require('../util/consistency').isConsistent()
70 | })
71 |
72 | describe('test_suite has …', function () {
73 | return require('../util/meta-test').metaTest()
74 | })
75 |
76 | after('teardown', function (done) {
77 | fs.emptyDirSync(process.cwd())
78 | done()
79 | })
80 | })
81 |
--------------------------------------------------------------------------------
/test/generated-pkg/app-lib.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 | const path = require('path')
3 | const assert = require('yeoman-assert')
4 | const helpers = require('yeoman-test')
5 | const fs = require('fs-extra')
6 |
7 | describe('library package', function () {
8 | this.timeout(10000)
9 | before(async function () {
10 | await helpers.run(path.join(__dirname, '../../generators/app'))
11 | .withPrompts({
12 | title: 'foo',
13 | author: 'tester',
14 | email: 'te@st.er',
15 | apptype: ['empty', 'library'],
16 | pre: false,
17 | post: false,
18 | license: ['LGPL-3.0', 'LGPL%20v3', 'https://www.gnu.org/licenses/lgpl-3.0'],
19 | // TODO: #572
20 | github: true,
21 | atom: false,
22 | ci: 'travis'
23 | })
24 | assert.noFile(['modules/app.xqm', 'modules/test-suite.xqm', 'templates/page.html', 'reports/screenshots/.gitkeep', 'controller.xq', 'collection.xconf'])
25 | })
26 |
27 | describe('library has', function () {
28 | it('only recommended files', function (done) {
29 | assert.file(['repo.xml', 'README.md', '.git/config', '.gitignore', 'test/xqs/test-suite.xqm'])
30 | done()
31 | })
32 |
33 | it('no integration test on ci', function (done) {
34 | assert.noFileContent('.travis.yml', 'cypress')
35 | done()
36 | })
37 |
38 | it('selected license', function (done) {
39 | assert.fileContent('LICENSE', 'GNU LESSER GENERAL PUBLIC LICENSE')
40 | done()
41 | })
42 |
43 | it('no target URL in repo.xml', function (done) {
44 | assert.noFileContent('repo.xml', //)
45 | done()
46 | })
47 |
48 | it('no dependency on shared-resources or templating', function (done) {
49 | assert.noFileContent('expath-pkg.xml', 'http://exist-db.org/apps/shared')
50 | assert.noFileContent('expath-pkg.xml', 'http://exist-db.org/html-templating')
51 | done()
52 | })
53 |
54 | it('xqs does not call app module', function (done) {
55 | assert.noFileContent('test/xqs/test-suite.xqm', 'import module namespace app')
56 | done()
57 | })
58 |
59 | it('pkgJson with repo info', function (done) {
60 | assert.fileContent('package.json', 'git')
61 | done()
62 | })
63 |
64 | it('pkgJson without cypress script', function (done) {
65 | assert.noFileContent('package.json', 'cypress')
66 | done()
67 | })
68 | })
69 |
70 | describe('markup files are well-formed', function () {
71 | return require('../util/app').checkWellFormed()
72 | })
73 |
74 | describe('app meta-data', function () {
75 | return require('../util/consistency').isConsistent()
76 | })
77 |
78 | after('teardown', function (done) {
79 | fs.emptyDirSync(process.cwd())
80 | done()
81 | })
82 | })
83 |
--------------------------------------------------------------------------------
/test/generated-pkg/app-eXide-default.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 | const path = require('path')
3 | const assert = require('yeoman-assert')
4 | const helpers = require('yeoman-test')
5 | const fs = require('fs-extra')
6 |
7 | describe('eXide style …', function () {
8 | before(async function () {
9 | this.timeout(20000)
10 | await helpers.run(path.join(__dirname, '../../generators/app'))
11 | .withPrompts({
12 | title: 'foo',
13 | author: 'tester',
14 | email: 'te@st.er',
15 | apptype: ['exist-design', 'application'],
16 | pre: true,
17 | post: true,
18 | license: ['MIT', 'MIT', 'https://opensource.org/licenses/MIT'],
19 | github: false,
20 | setperm: false,
21 | ci: 'travis',
22 | docker: false,
23 | atom: false
24 | })
25 | assert.noFile('readme.md', 'Dockerfile')
26 | })
27 |
28 | describe('exist design has …', function () {
29 | it('default files', function (done) {
30 | assert.file(['repo.xml', 'modules/app.xqm', 'post-install.xq', 'pre-install.xq', 'test/xqs/test-suite.xqm'])
31 | done()
32 | })
33 |
34 | it('type specific files', function (done) {
35 | assert.file(['resources/css/exist-2.2.css'])
36 | done()
37 | })
38 |
39 | it('declared dependency on templating library', function (done) {
40 | assert.fileContent('expath-pkg.xml', 'http://exist-db.org/html-templating')
41 | done()
42 | })
43 |
44 | it('expanded title on index.html', function (done) {
45 | assert.fileContent('templates/page.html', 'foo')
46 | done()
47 | })
48 |
49 | it('integration tests for travis', function (done) {
50 | assert.fileContent('.travis.yml', 'cypress')
51 | done()
52 | })
53 |
54 | it('expanded title in repo.xml', function (done) {
55 | assert.fileContent('repo.xml', /foo<\/target>/)
56 | done()
57 | })
58 | })
59 |
60 | describe('markup files are well-formed', function () {
61 | return require('../util/app').checkWellFormed()
62 | })
63 |
64 | // !! this should stay in yo's generator test only !!
65 | // Different editors use different settings
66 | describe('xml looks good', function () {
67 | return require('../util/gulp-ews').prettyDataEWS()
68 | })
69 |
70 | describe('app meta-data', function () {
71 | return require('../util/consistency').isConsistent()
72 | })
73 |
74 | describe('test_suite has …', function () {
75 | return require('../util/meta-test').metaTest()
76 | })
77 |
78 | // Checking Xquery files requires updates to xqlint
79 | // it('linted XQuery', function () {
80 | // let xq = fs.readFileSync('modules/app.xqm')
81 | // let xql = new xmldoc.XmlDocument(xq).toString()
82 | // expect(doc).xml.to.be.valid()
83 | // })
84 |
85 | after('teardown', function (done) {
86 | fs.emptyDirSync(process.cwd())
87 | done()
88 | })
89 | })
90 |
--------------------------------------------------------------------------------
/generators/app/templates/xq/app.xqm:
--------------------------------------------------------------------------------
1 | xquery version "3.1";
2 |
3 | (:~ This is the default application library module of the <%- title %> app.
4 | :
5 | : @author <%- author %>
6 | : @version <%- version %>
7 | : @see <%- website %>
8 | :)
9 |
10 | (: Module for app-specific template functions :)
11 | module namespace app="<%- defuri %>/<%- defcoll %>/<%- short %>/templates";
12 | import module namespace templates="http://exist-db.org/xquery/html-templating";
13 | import module namespace lib="http://exist-db.org/xquery/html-templating/lib";
14 | import module namespace config="<%- defuri %>/<%- defcoll %>/<%- short %>/config" at "config.xqm";
15 |
16 |
17 | (:~
18 | : This is a sample templating function. It will be called by the templating module if
19 | : it encounters an HTML element with an attribute: data-template="app:test" or class="app:test" (deprecated).
20 | : The function has to take 2 default parameters. Additional parameters are automatically mapped to
21 | : any matching request or function parameter.
22 | :
23 | : @param $node the HTML node with the attribute which triggered this call
24 | : @param $model a map containing arbitrary data - used to pass information between template calls
25 | :)
26 |
27 | declare
28 | %templates:wrap
29 | function app:foo($node as node(), $model as map(*)) {
30 | <%- title %>
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
24 |
26 | else if (($exist:path eq "/") or ($logout)) then
27 | (: forward root path to index.xql :)
28 |
29 |
31 |
32 | else if (ends-with($exist:resource, ".html")) then
33 | (: the html page is run through view.xq to expand templates :)
34 | if (request:get-attribute("org.exist-db.mysec.user")) then
35 | (: secured area checks user status :)
36 |
37 |
38 |
39 |
43 |
44 |
45 |
48 |
49 | else
50 |
51 |
52 |
55 |
56 |
59 |
60 |
61 |
64 |
65 | else if (starts-with($exist:path, "/resources")) then
66 | (: images, css are contained in the top /resources/ collection. :)
67 | (: Relative path requests from sub-collections are redirected there :)
68 |
69 |
71 | else
72 | (: everything else is passed through :)
73 |
74 |
76 |
--------------------------------------------------------------------------------
/generators/app/templates/ci/exist.yml:
--------------------------------------------------------------------------------
1 | # This workflow builds a xar archive, deploys it into exist and execute its test suites.
2 | # It also includes code for using semantic-release to upload packages as part of GitHub releases
3 | # For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
4 |
5 | name: exist-db CI
6 |
7 | on: [push, pull_request]
8 |
9 | jobs:
10 | build:
11 | runs-on: ubuntu-latest
12 | strategy:
13 | fail-fast: false
14 | matrix:
15 | exist-version: [latest, release]
16 | java-version: [8, 17]
17 | node-version: ['18', '20']
18 | exclude:
19 | - exist-version: release
20 | java-version: 17
21 | - exist-version: latest
22 | java-version: 8
23 | # TODO: see #563 could still be usefull for gulp builds
24 | # services:
25 | # # Label used to access the service container
26 | # exist:
27 | # image: existdb/existdb:${{ matrix.exist-version}}
28 | # ports:
29 | # - 8080:8080
30 |
31 | steps:
32 | # Checkout code
33 | - uses: actions/checkout@v3
34 | - name: Cache Docker layers
35 | uses: actions/cache@v3
36 | with:
37 | path: /tmp/.buildx-cache
38 | key: ${{ runner.os }}-buildx-${{ github.sha }}
39 | restore-keys: |
40 | ${{ runner.os }}-buildx-
41 |
42 | # Build Frontend
43 | - name: Build Frontend Using Node.js ${{ matrix.node-version }}
44 | uses: actions/setup-node@v3
45 | with:
46 | node-version: ${{ matrix.node-version }}
47 | cache: 'npm'
48 | - run: npm ci
49 |
50 | # Build Expath Package
51 | # TODO: #563 make optional for gulp builds
52 | - name: Build Expath Package
53 | uses: actions/setup-java@v3
54 | with:
55 | distribution: 'temurin'
56 | java-version: ${{ matrix.java-version }}
57 | - run: ant
58 |
59 | # Deploy Package in Container
60 | - name: Pull Base Image
61 | run: docker pull existdb/existdb:${{ matrix.exist-version }}
62 |
63 | - name: Create CI Container
64 | run: docker create --name exist-ci -p 8080:8080 existdb/existdb:${{ matrix.exist-version }}
65 |
66 | - name: Prep CI Container
67 | run: docker cp ./build/*-dev.xar exist-ci:exist/autodeploy
68 |
69 | - name: Start Exist Container
70 | run: docker start exist-ci && sleep 30
71 |
72 | # Testing
73 | - name: Run Unit Tests
74 | run: npm test
75 | <%_ if (apptype != 'library') { %>
76 | - name: Run Integration Tests
77 | run: npm run cypress
78 | <% } -%>
79 | # TODO: Add upload to dockerhub
80 | # release:
81 | # name: Release
82 | # runs-on: ubuntu-latest
83 | # needs: build
84 | # if: github.ref == 'refs/heads/main'
85 | # steps:
86 | # - name: Checkout
87 | # uses: actions/checkout@v2
88 | # with:
89 | # fetch-depth: 0
90 | # - name: Setup Node.js
91 | # uses: actions/setup-node@v2
92 | # with:
93 | # node-version: 18
94 | # cache: 'npm'
95 | # - name: Install dependencies
96 | # run: npm ci
97 | # - name: Create package
98 | # run: npm run build
99 | # - name: Release
100 | # env:
101 | # GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
102 | # run: npx semantic-release
103 |
104 |
105 |
--------------------------------------------------------------------------------
/generators/app/templates/github/readme.md:
--------------------------------------------------------------------------------
1 | # <%- title %>
2 |
3 | [![License][license-img]][license-url]
4 | [![GitHub release][release-img]][release-url]
5 | <%_ if (ci == 'travis') { -%>
6 | [![Build Status][travis-image]][travis-url]
7 | <%_ } else { _%>
8 | 
9 | <% } -%>
10 |
11 | 
12 |
13 | <%- desc %>
14 |
15 | ## Requirements
16 |
17 | * [exist-db](http://exist-db.org/exist/apps/homepage/index.html) version: `6.2` or greater
18 |
19 | * [ant](http://ant.apache.org) version: `1.10.12` \(for building from source\)
20 | <% if (apptype == 'exist-design' || 'plain') { %>
21 | * [node](http://nodejs.org) version: `18.x` \(for building from source\)
22 | <% } %>
23 |
24 | ## Installation
25 |
26 | 1. Download the `<%- title %>-<%- version %>.xar` file from GitHub [releases](https://github.com/<%- ghuser %>/<%- title %>/releases) page.
27 |
28 | 2. Open the [dashboard](http://localhost:8080/exist/apps/dashboard/index.html) of your eXist-db instance and click on `package manager`.
29 |
30 | 1. Click on the `add package` symbol in the upper left corner and select the `.xar` file you just downloaded.
31 |
32 | 3. You have successfully installed <%- title %> into exist.
33 |
34 | ### Building from source
35 |
36 | 1. Download, fork or clone this GitHub repository
37 | 2. There are two default build targets in `build.xml`:
38 | * `dev` including *all* files from the source folder including those with potentially sensitive information.
39 |
40 | * `deploy` is the official release. It excludes files necessary for development but that have no effect upon deployment.
41 |
42 | 3. Calling `ant`in your CLI will build both files:
43 |
44 | ```bash
45 | cd <%- title %>
46 | ant
47 | ```
48 |
49 | 1. to only build a specific target call either `dev` or `deploy` like this:
50 | ```bash
51 | ant dev
52 | ```
53 |
54 | If you see `BUILD SUCCESSFUL` ant has generated a `<%- title %>-<%- version %>.xar` file in the `build/` folder. To install it, follow the instructions [above](#installation).
55 |
56 | <%_ if (apptype == 'exist-design' || 'plain') { %>
57 |
58 | ## Running Tests
59 |
60 | To run tests locally your app needs to be installed in a running exist-db instance at the default port `8080` and with the default dba user `admin` with the default empty password.
61 |
62 | A quick way to set this up for docker users is to simply issue:
63 |
64 | ```bash
65 | docker run -dit -p 8080:8080 existdb/existdb:release
66 | ```
67 |
68 | After you finished installing the application, you can run the full testsuite locally.
69 |
70 | ### Unit-tests
71 |
72 | This app uses [mochajs](https://mochajs.org) as a test-runner. To run both xquery and javascript unit-tests type:
73 |
74 | ```bash
75 | npm test
76 | ```
77 |
78 | ### Integration-tests
79 |
80 | This app uses [cypress](https://www.cypress.io) for integration tests, just type:
81 |
82 | ```bash
83 | npm run cypress
84 | ```
85 |
86 | Alternatively, use npx:
87 |
88 | ```bash
89 | npx cypress open
90 | ```
91 |
92 | <% } -%>
93 |
94 | ## Contributing
95 |
96 | You can take a look at the [Contribution guidelines for this project](.github/CONTRIBUTING.md)
97 |
98 | ## License
99 |
100 | <%- license %> © [<%- author %>](<%- website %>)
101 |
102 | [license-img]: https://img.shields.io/badge/license-<%- badge %>-blue.svg
103 | [license-url]: <%- badgelink %>
104 | [release-img]: https://img.shields.io/badge/release-<%- version %>-green.svg
105 | [release-url]: https://github.com/<%- ghuser %>/<%- title %>/releases/latest
106 | <%_ if (ci == 'travis') { %>
107 | [travis-image]: https://travis-ci.com/<%- ghuser %>/<%- title %>.svg?branch=main
108 | [travis-url]: https://travis-ci.com/<%- ghuser %>/<%- title %>
109 | <% } -%>
--------------------------------------------------------------------------------
/test/mock_xqs.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 |
3 | const Mocha = require('mocha')
4 | const expect = require('chai').expect
5 |
6 | const monoCase = require('./fixtures/mono-case.json')
7 | const multiCase = require('./fixtures/multi-case.json')
8 | const multiSuite = require('./fixtures/multi-suite.json')
9 |
10 | describe('mock xqs runs', function () {
11 | it('should pass the mono test', function (done) {
12 | /* eslint-disable-next-line */
13 | expect(xqsMock(monoCase)).to.not.throw
14 | done()
15 | })
16 |
17 | it('should fail the multi case', function (done) {
18 | /* eslint-disable-next-line */
19 | expect(xqsMock(multiCase)).to.throw
20 | done()
21 | })
22 |
23 | it('should pass the mutli suite', function (done) {
24 | /* eslint-disable-next-line */
25 | expect(xqsMock(multiSuite)).to.not.throw
26 | done()
27 | })
28 | })
29 |
30 | function xqsMock (mockRun) {
31 | // Dynamically generate a mocha testsuite for xqsuite tests. Requires its own process, hence && in package.json
32 | const Test = Mocha.Test
33 |
34 | const xqsReport = mockRun
35 | const xqsPkg = xqsReport.testsuite.package
36 | const xqstCount = xqsReport.testsuite.tests
37 | const xqstCase = xqsReport.testsuite.testcase
38 |
39 | // TODO: get rid of first "0 passing message"
40 |
41 | const mochaInstance = new Mocha()
42 |
43 | if (Array.isArray(xqsReport.testsuite)) {
44 | const xqsSuites = xqsReport.testsuite
45 | console.warn('support for multiple testsuites per run is experimental')
46 | xqsSuites.forEach((entry) => {
47 | xqsTests(mochaInstance, entry.package, entry.tests, entry.testcase)
48 | })
49 | } else {
50 | xqsTests(mochaInstance, xqsPkg, xqstCount, xqstCase)
51 | }
52 | // enable repeated runs
53 | // see https://github.com/mochajs/mocha/issues/995
54 | // see https://mochajs.org/api/mocha#unloadFiles
55 | const suiteRun = mochaInstance.cleanReferencesAfterRun(true).run()
56 | process.on('exit', () => {
57 | if (suiteRun.stats.failures > 0) { process.exit(1) } else { process.exit(0) }
58 | })
59 |
60 | // TODO: mark %pending xqstests as pending in mocha report
61 | function xqsTests (mochaInstance, xqsPkg, xqstCount, xqstCase) {
62 | const suiteInstance = Mocha.Suite.create(mochaInstance.suite, 'Xqsuite tests for ' + xqsPkg)
63 |
64 | if (xqstCase === undefined) {
65 | // if xqs contains 0 tests close open mocha instance
66 | mochaInstance.unloadFiles()
67 | suiteInstance.dispose()
68 | console.log('no test cases defined by suite ' + xqsPkg)
69 | } else if (Array.isArray(xqstCase)) {
70 | for (let i = 0; i < xqstCount; i++) {
71 | xqsResult(suiteInstance, xqstCase[i])
72 | }
73 | } else {
74 | xqsResult(suiteInstance, xqstCase)
75 | }
76 | }
77 |
78 | function xqsResult (suiteInstance, xqstCase) {
79 | suiteInstance.addTest(new Test('Test: ' + xqstCase.name, () => {
80 | switch (Object.prototype.hasOwnProperty.call(xqstCase, '')
81 |
82 | ) {
83 | // Red xqs test: filter to dynamically ouput messages only when record contains them
84 | case 'failure':
85 | expect(xqstCase, 'Function ' + xqstCase.class + ' ' + xqstCase.failure.message).to.not.have.own.property('failure')
86 | break
87 | case 'error':
88 | expect(xqstCase, 'Function ' + xqstCase.class + ' ' + xqstCase.error.message).to.not.have.own.property('error')
89 | break
90 | // TODO: Blue xqs tests: pending not yet implemented
91 | case 'pending':
92 | Test.isPending(true)
93 | break
94 | // Green xqs tests: pass passing tests
95 | default:
96 | /* eslint-disable-next-line */
97 | expect(xqstCase.failure).to.not.exist
98 | /* eslint-disable-next-line */
99 | expect(xqstCase.error).to.not.exist
100 | break
101 | }
102 | }
103 | ))
104 | }
105 | }
106 |
--------------------------------------------------------------------------------
/generators/app/templates/xq/config.xqm:
--------------------------------------------------------------------------------
1 | xquery version "3.1";
2 |
3 | (:~
4 | : A set of helper functions to access the application context from
5 | : within a module.
6 | :)
7 |
8 | module namespace config="<%- defuri %>/<%- defcoll %>/<%- short %>/config";
9 |
10 | import module namespace templates="http://exist-db.org/xquery/html-templating";
11 | import module namespace lib="http://exist-db.org/xquery/html-templating/lib";
12 |
13 | declare namespace repo="http://exist-db.org/xquery/repo";
14 | declare namespace expath="http://expath.org/ns/pkg";
15 | (:
16 | Determine the application root collection from the current module load path.
17 | :)
18 | declare variable $config:app-root :=
19 | let $rawPath := system:get-module-load-path()
20 | let $modulePath :=
21 | (: strip the xmldb: part :)
22 | if (starts-with($rawPath, "xmldb:exist://")) then
23 | if (starts-with($rawPath, "xmldb:exist://embedded-eXist-server")) then
24 | substring($rawPath, 36)
25 | else
26 | substring($rawPath, 15)
27 | else
28 | $rawPath
29 | return
30 | substring-before($modulePath, "/modules")
31 | ;
32 |
33 | declare variable $config:repo-descriptor := doc(concat($config:app-root, "/repo.xml"))/repo:meta;
34 |
35 | declare variable $config:expath-descriptor := doc(concat($config:app-root, "/expath-pkg.xml"))/expath:package;
36 |
37 | declare variable $config:data-root := $config:app-root || "/data";
38 |
39 | (:~
40 | : Resolve the given path using the current application context.
41 | : If the app resides in the file system,
42 | :)
43 | declare function config:resolve($relPath as xs:string) {
44 | if (starts-with($config:app-root, "/db")) then
45 | doc(concat($config:app-root, "/", $relPath))
46 | else
47 | doc(concat("file://", $config:app-root, "/", $relPath))
48 | };
49 |
50 | (:~
51 | : Returns the repo.xml descriptor for the current application.
52 | :)
53 | declare function config:repo-descriptor() as element(repo:meta) {
54 | $config:repo-descriptor
55 | };
56 |
57 | (:~
58 | : Returns the expath-pkg.xml descriptor for the current application.
59 | :)
60 | declare function config:expath-descriptor() as element(expath:package) {
61 | $config:expath-descriptor
62 | };
63 |
64 | declare %templates:wrap function config:app-title($node as node(), $model as map(*)) as text() {
65 | $config:expath-descriptor/expath:title/text()
66 | };
67 |
68 | declare function config:app-meta($node as node(), $model as map(*)) as element()* {
69 | ,
70 | for $author in $config:repo-descriptor/repo:author
71 | return
72 |
73 | };
74 |
75 | (:~
76 | : For debugging: generates a table showing all properties defined
77 | : in the application descriptors.
78 | :)
79 | declare function config:app-info($node as node(), $model as map(*)) {
80 | let $expath := config:expath-descriptor()
81 | let $repo := config:repo-descriptor()
82 | return
83 |
84 |
107 | };
108 |
--------------------------------------------------------------------------------
/generators/app/templates/specs/xqs/xqSuite.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 |
3 | const Mocha = require('mocha')
4 | const http = require('http')
5 | const expect = require('chai').expect
6 | const xmldoc = require('xmldoc')
7 |
8 |
9 | // Dynamically generate a mocha testsuite for xqsuite tests. Requires its own process, hence && in package.json
10 | let Test = Mocha.Test
11 | <%_ if (apptype == 'library') { %>
12 | let url = 'http://localhost:8080/exist/rest/db/system/repo/<%- short %>-<%- version %>/test/xqs/test-runner.xq'
13 | <% } else { %>
14 | let url = 'http://localhost:8080/exist/rest/db/<%- defcoll %>/<%- short %>/test/xqs/test-runner.xq'
15 | <% } -%>
16 |
17 | http.get(url, (res) => {
18 | let data = ''
19 |
20 | // called when a data chunk is received.
21 | res.on('data', (chunk) => {
22 | data += chunk
23 | })
24 |
25 | // called when the complete response is received.
26 | res.on('end', () => {
27 | // NOTE(DP): XQTS errors on testsuite, will be returned as application/xml
28 | // The initial check will display the XQTS error, and run the test suite otherwise
29 | // see #800
30 | if (res.headers['content-type'].includes("application/json")) {
31 | let xqsReport = JSON.parse(data)
32 | let xqsPkg = xqsReport.testsuite.package
33 | let xqstCount = xqsReport.testsuite.tests
34 | let xqstCase = xqsReport.testsuite.testcase
35 |
36 | // TODO(DP): get rid of first "0 passing message"
37 |
38 | let mochaInstance = new Mocha()
39 |
40 | if (Array.isArray(xqsReport.testsuite)) {
41 | let xqsSuites = xqsReport.testsuite
42 | console.warn('support for multiple testsuites per run is experimental')
43 | xqsSuites.forEach((entry) => {
44 | xqsTests(mochaInstance, entry.package, entry.tests, entry.testcase)
45 | })
46 | } else {
47 | xqsTests(mochaInstance, xqsPkg, xqstCount, xqstCase)
48 | }
49 | // enable repeated runs
50 | // see https://github.com/mochajs/mocha/issues/995
51 | // see https://mochajs.org/api/mocha#unloadFiles
52 | let suiteRun = mochaInstance.cleanReferencesAfterRun(true).run()
53 | process.on('exit', () => {
54 | if (suiteRun.stats.failures > 0) { process.exit(1) } else { process.exit(0) }
55 | })
56 | }
57 | else {
58 | try { let doc = new xmldoc.XmlDocument(data)
59 | throw new Error(doc.childNamed("message").val) }
60 | catch (e) { console.log(e.message) }
61 | }
62 | })
63 | }).on('error', (err) => {
64 | console.log('Error: ', err.message)
65 | })
66 |
67 | // TODO: mark %pending xqstests as pending in mocha report
68 | function xqsTests (mochaInstance, xqsPkg, xqstCount, xqstCase) {
69 | let suiteInstance = Mocha.Suite.create(mochaInstance.suite, 'Xqsuite tests for ' + xqsPkg)
70 |
71 | if (xqstCase === undefined) {
72 | // if xqs contains 0 tests close open mocha instance
73 | mochaInstance.unloadFiles()
74 | suiteInstance.dispose()
75 | console.log('no test cases defined by suite ' + xqsPkg)
76 | } else if (Array.isArray(xqstCase)) {
77 | for (let i = 0; i < xqstCount; i++) {
78 | xqsResult(suiteInstance, xqstCase[i])
79 | }
80 | } else {
81 | xqsResult(suiteInstance, xqstCase)
82 | }
83 | }
84 |
85 | function xqsResult (suiteInstance, xqstCase) {
86 | suiteInstance.addTest(new Test('Test: ' + xqstCase.name, () => {
87 | switch (Object.prototype.hasOwnProperty.call(xqstCase, '') ){
88 | // Red xqs test: filter to dynamically ouput messages only when record contains them
89 | case 'failure':
90 | expect(xqstCase, 'Function ' + xqstCase.class + ' ' + xqstCase.failure.message).to.not.have.own.property('failure')
91 | break
92 | case 'error':
93 | expect(xqstCase, 'Function ' + xqstCase.class + ' ' + xqstCase.error.message).to.not.have.own.property('error')
94 | break
95 | // TODO: Blue xqs tests: pending not yet implemented
96 | case 'pending':
97 | Test.isPending(true)
98 | break
99 | // Green xqs tests: pass passing tests
100 | default:
101 | expect(xqstCase.failure).to.not.exist
102 | expect(xqstCase.error).to.not.exist
103 | break
104 | }
105 | }
106 | ))
107 | }
108 |
--------------------------------------------------------------------------------
/generators/app/templates/pages/exist-design/page.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | <%- title %>
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
`BREAKING CHANGE: The graphiteWidth option has been removed.`
`The default graphite width of 10mm is always used for performance reasons.` | ~~Major~~ Breaking Release | 301 | 302 | ## License 303 | 304 | MIT © [Duncan Paterson](https://github.com/duncdrum) 305 | 306 | [npm-image]: https://badge.fury.io/js/%40existdb%2Fgenerator-exist.svg 307 | [npm-url]: https://www.npmjs.com/package/@existdb/generator-exist 308 | [sem-rel-img]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg 309 | [sem-rel-url]: https://github.com/semantic-release/semantic-release 310 | [codacy-image]: https://api.codacy.com/project/badge/Grade/340ad1d77d624bcf8edf036c181d4459 311 | [codacy-url]: https://app.codacy.com/gh/eXist-db/generator-exist?utm_source=github.com&utm_medium=referral&utm_content=eXist-db/generator-exist&utm_campaign=Badge_Grade_Settings 312 | -------------------------------------------------------------------------------- /generators/app/templates/img/powered-by.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | -------------------------------------------------------------------------------- /generators/app/templates/styles/exist-2.2.css: -------------------------------------------------------------------------------- 1 | @charset "utf-8"; 2 | 3 | @import url("bootstrap.min.css"); 4 | 5 | /* ---------------------------------------- FONTS ---------------------------------------- */ 6 | @font-face { 7 | font-family: "Quicksand Book"; 8 | src: url("//db.onlinewebfonts.com/t/ac220d2014e7b9231118917e7d2449b8.eot"); 9 | src: url("//db.onlinewebfonts.com/t/ac220d2014e7b9231118917e7d2449b8.eot?#iefix") format("embedded-opentype"), url("//db.onlinewebfonts.com/t/ac220d2014e7b9231118917e7d2449b8.woff2") format("woff2"), url("//db.onlinewebfonts.com/t/ac220d2014e7b9231118917e7d2449b8.woff") format("woff"), url("//db.onlinewebfonts.com/t/ac220d2014e7b9231118917e7d2449b8.ttf") format("truetype"), url("//db.onlinewebfonts.com/t/ac220d2014e7b9231118917e7d2449b8.svg#Quicksand Book") format("svg"); 10 | font-weight: normal; 11 | font-style: normal; 12 | } 13 | 14 | /* ---------------------------------------- VARIABLES ---------------------------------------- */ 15 | 16 | /* ------------------------------------ Documentation styles ---------------------------------- */ 17 | .content { 18 | font: 16px/24px Georgia, "Times New Roman", Times, serif; 19 | color: #555; 20 | } 21 | 22 | .content section { 23 | clear: both; 24 | } 25 | 26 | .content h1 { 27 | font-family: QuicksandBook, Arial, Helvetica, sans-serif; 28 | font-size: 1.75em; 29 | font-weight: bold; 30 | margin: 0.8em 0 0; 31 | } 32 | 33 | .content h2 { 34 | color: #0083cb; 35 | font-family: QuicksandBook, Arial, Helvetica, sans-serif; 36 | font-size: 1.33em; 37 | font-weight: bold; 38 | margin: 0.3em 0 0; 39 | padding: 10px 0 5px; 40 | } 41 | 42 | .content h3 { 43 | font-size: 1em; 44 | font-weight: bold; 45 | } 46 | 47 | .content table { 48 | margin: 0.5em 1em; 49 | } 50 | 51 | .content td, 52 | .entry th { 53 | padding: 6px 4px; 54 | } 55 | 56 | .content .strong { 57 | font-weight: bold; 58 | } 59 | 60 | .content em { 61 | font-style: italic; 62 | } 63 | 64 | .content code { 65 | font-size: 0.92em; 66 | background-color: transparent; 67 | border: 0; 68 | color: inherit; 69 | } 70 | 71 | .content .option { 72 | font-weight: bold; 73 | font-style: italic; 74 | } 75 | 76 | .content blockquote { 77 | font-style: italic; 78 | text-align: justify; 79 | padding: 10px 15px 0; 80 | border: 1px solid #abe1ff; 81 | background: #fff; 82 | margin: 5px 0 10px; 83 | } 84 | 85 | .content blockquote h3 { 86 | padding: 0; 87 | border: 0; 88 | margin: 0; 89 | font-size: 12px; 90 | color: #0083cb; 91 | } 92 | 93 | .content blockquote p { 94 | padding: 0 0 10px; 95 | } 96 | 97 | .content ul, 98 | .content ol { 99 | margin: 0 1.5em; 100 | } 101 | 102 | .content ul li { 103 | list-style: disc; 104 | margin-bottom: 0.4em; 105 | } 106 | 107 | .content ol li { 108 | list-style: decimal; 109 | margin-bottom: 0.4em; 110 | } 111 | 112 | .content dl.wide dt { 113 | width: 260px; 114 | word-wrap: break-word; 115 | } 116 | 117 | .content dl.wide dd { 118 | margin-left: 270px; 119 | } 120 | 121 | #content .content dt { 122 | font-weight: bold; 123 | word-wrap: break-word; 124 | } 125 | 126 | .content img { 127 | margin: 8px auto; 128 | max-width: 100%; 129 | } 130 | 131 | .content td img { 132 | max-width: inherit; 133 | } 134 | 135 | .content figure { 136 | margin: 0 1em 1em; 137 | } 138 | 139 | .content figure.float-left { 140 | float: left; 141 | margin-right: 1em; 142 | width: 50%; 143 | display: inline-block; 144 | } 145 | 146 | .content figure.float-right { 147 | float: right; 148 | margin-left: 1em; 149 | width: 50%; 150 | display: inline-block; 151 | } 152 | 153 | .content .img-float-left { 154 | float: left; 155 | margin-right: 10px; 156 | } 157 | 158 | .content .img-float-right { 159 | float: right; 160 | width: inherit; 161 | margin-left: 10px; 162 | } 163 | 164 | .content pre.prettyprint { 165 | padding: 10px 16px; 166 | margin-bottom: 0.85em; 167 | } 168 | 169 | .content .guimenuitem { 170 | background: #fef8c4; 171 | } 172 | 173 | .content .example { 174 | margin: 0.25em 0 0.25em 1em; 175 | padding: 10px; 176 | border: 1px solid #707070; 177 | } 178 | 179 | /* stylelint-disable-next-line no-descending-specificity */ 180 | .content .dl-horizontal dd { 181 | margin-left: 150px; 182 | } 183 | 184 | /* stylelint-disable-next-line no-descending-specificity */ 185 | .content .dl-horizontal dt { 186 | text-align: left; 187 | width: 140px; 188 | word-wrap: break-word; 189 | } 190 | 191 | /* ---------------------------------------- LAYOUT ---------------------------------------- */ 192 | body { 193 | color: #222; 194 | background: url("../images/body.gif") repeat 50% 100%; 195 | } 196 | 197 | .grey-bot { 198 | /* background: url("../images/body-base.gif") repeat-x 50% 100%; */ 199 | padding-bottom: 2em; 200 | } 201 | 202 | #container { 203 | margin: 0 auto 30px; 204 | } 205 | 206 | @media (width >= 767px) { 207 | #grey-top { 208 | background: #f3f3f3; 209 | height: 100%; 210 | position: relative; 211 | } 212 | 213 | #header { 214 | background: #f3f3f3 url("../images/header.gif") top right no-repeat; 215 | width: 100%; 216 | } 217 | 218 | #header a#logo { 219 | background: url("../images/existdb.png") center left no-repeat; 220 | display: block; 221 | width: 220px; 222 | height: 100px; 223 | text-indent: -999em; 224 | outline: 0; 225 | margin: 10px 0; 226 | } 227 | } 228 | 229 | @media (width <= 767px) { 230 | #grey-top { 231 | background: #f3f3f3; 232 | height: 100%; 233 | } 234 | 235 | #header { 236 | display: none; 237 | } 238 | } 239 | 240 | .navbar .container { 241 | padding-left: 0; 242 | padding-right: 0; 243 | } 244 | 245 | #content { 246 | min-height: 600px; 247 | } 248 | 249 | #footer { 250 | display: flex; 251 | align-items: center; 252 | justify-content: space-between; 253 | height: 50px; 254 | color: #222; 255 | background-color: #212529; 256 | padding-right: 1rem; 257 | padding-left: 1rem; 258 | } 259 | 260 | #footer .container { 261 | padding-left: 0; 262 | padding-right: 0; 263 | } 264 | 265 | #footer ul { 266 | padding: 0; 267 | margin: 0; 268 | } 269 | 270 | #footer ul li { 271 | display: inline-block; 272 | } 273 | 274 | #footer ul li a { 275 | padding: 2px 4px; 276 | color: #0083cb; 277 | } 278 | 279 | #footer ul li a:hover { 280 | background: #333; 281 | } 282 | 283 | #copyright { 284 | text-align: right; 285 | } 286 | 287 | #copyright p { 288 | margin: 0; 289 | color: #f3f3f3; 290 | } 291 | 292 | #poweredby { 293 | width: 120px; 294 | height: 56px; 295 | margin-bottom: 10px; 296 | display: inline-block; 297 | background: url("../images/powered-by.svg") no-repeat 50%; 298 | background-size: 100% 100%; 299 | } 300 | 301 | /* ---------------------------------------- NAVBAR ---------------------------------------- */ 302 | .navbar-default { 303 | height: 60px; 304 | background: transparent; 305 | border: 0; 306 | box-shadow: none; 307 | } 308 | 309 | /* stylelint-disable-next-line no-descending-specificity */ 310 | .navbar .nav > li > a { 311 | color: #fff; 312 | text-align: center; 313 | font: 1.2em/1em QuicksandBook, Arial, Helvetica, sans-serif; 314 | padding: 18px 0; 315 | text-shadow: none; 316 | } 317 | 318 | /* stylelint-disable-next-line no-descending-specificity */ 319 | .navbar .nav > li > a:hover { 320 | color: #ffcb05; 321 | } 322 | 323 | .navbar .nav > li > .dropdown-menu::before, 324 | .navbar .nav > li > .dropdown-menu::after { 325 | display: none; 326 | } 327 | 328 | @media (width <= 767px) { 329 | .navbar-default { 330 | height: auto; 331 | margin-bottom: 20px; 332 | background: url("../images/existdb-web.svg") center left no-repeat; 333 | border-bottom: 10px solid #2e2e2e; 334 | } 335 | 336 | .navbar-collapse.in { 337 | z-index: 1000; 338 | position: absolute; 339 | left: 10px; 340 | right: 10px; 341 | background-color: #fafafa; 342 | background-image: linear-gradient(to bottom, #fff, #f2f2f2); 343 | background-repeat: repeat-x; 344 | border: 1px solid #d4d4d4; 345 | border-radius: 4px; 346 | box-shadow: 0 1px 4px rgb(0 0 0 / 10%); 347 | } 348 | 349 | .navbar .nav > li > a { 350 | padding: 9px 15px; 351 | color: #777; 352 | } 353 | 354 | #sidebar { 355 | display: none; 356 | } 357 | 358 | #about { 359 | display: none; 360 | } 361 | } 362 | 363 | @media (width >= 767px) { 364 | .navbar .nav li.dropdown.open > .dropdown-toggle { 365 | background-color: transparent; 366 | color: #ffcb05; 367 | } 368 | 369 | .navbar-nav > li > .dropdown-menu { 370 | border-top-right-radius: 10px; 371 | border-top-left-radius: 10px; 372 | } 373 | 374 | .nav > li { 375 | height: 52px; 376 | min-width: 150px; 377 | vertical-align: middle; 378 | background: url("../images/bgmenu.gif") no-repeat top center; 379 | } 380 | 381 | .nav .open { 382 | background: url("../images/bgmenuhi.gif") no-repeat top center; 383 | } 384 | 385 | /* stylelint-disable-next-line no-descending-specificity */ 386 | .dropdown-menu { 387 | background: #0083cb; 388 | border-radius: 10px; 389 | color: #fff; 390 | margin: 0; 391 | border: 0; 392 | } 393 | 394 | .dropdown-menu > li > a { 395 | color: #fff; 396 | font-size: 0.92em; 397 | text-align: center; 398 | } 399 | 400 | .dropdown-menu > li > a:hover { 401 | background: #222; 402 | color: #ffcb05; 403 | } 404 | } 405 | 406 | .navbar li#about { 407 | display: none; 408 | } 409 | 410 | @media (width >= 992px) { 411 | .navbar li#about { 412 | display: inline-block; 413 | } 414 | } 415 | 416 | .navbar-search input { 417 | margin-top: 4px; 418 | } 419 | 420 | .navbar-right, 421 | .navbar-right .search-query { 422 | float: right; 423 | } 424 | 425 | #navigation .actions { 426 | float: right; 427 | margin: 8px 0; 428 | } 429 | 430 | /* ---------------------------------------- GENERAL STYLES ---------------------------------------- */ 431 | /* stylelint-disable-next-line no-descending-specificity */ 432 | h1 { 433 | font-size: 1.75em; 434 | font-weight: bold; 435 | padding: 0 0 5px; 436 | font-family: QuicksandBook, Arial, Helvetica, sans-serif; 437 | color: #0083cb; 438 | } 439 | 440 | /* stylelint-disable-next-line no-descending-specificity */ 441 | h2 { 442 | font-size: 1.2em; 443 | padding: 10px 0; 444 | font-weight: bold; 445 | font-family: QuicksandBook, Arial, Helvetica, sans-serif; 446 | letter-spacing: 1px; 447 | } 448 | 449 | /* stylelint-disable-next-line no-descending-specificity */ 450 | h3 { 451 | font-size: 1.2em; 452 | padding: 10px 0 5px; 453 | margin: 0 0 5px; 454 | font-weight: bold; 455 | } 456 | 457 | h4 { 458 | font-size: 1em; 459 | padding: 10px 0; 460 | font-style: italic; 461 | font-weight: normal; 462 | } 463 | 464 | h5 { 465 | font-size: 1em; 466 | padding: 10px 0; 467 | font-weight: normal; 468 | } 469 | 470 | /* stylelint-disable-next-line no-descending-specificity */ 471 | a { 472 | color: #0083cb; 473 | text-decoration: none; 474 | } 475 | 476 | /* stylelint-disable-next-line no-descending-specificity */ 477 | a:hover { 478 | color: #ffcb05; 479 | } 480 | 481 | .clear { 482 | clear: both; 483 | } 484 | 485 | .imgborder { 486 | border: 1px solid #ccc; 487 | padding: 3px; 488 | margin: 3px; 489 | } 490 | 491 | .code { 492 | font: 14px/20px "Ubuntu Mono", Menlo, Consolas, "Courier New", Courier, monospace; 493 | background: #444 url("../images/noise.png"); 494 | padding: 8.5px; 495 | width: 100%; 496 | margin: 18px 0; 497 | overflow-x: auto; 498 | } 499 | 500 | /* stylelint-disable-next-line no-descending-specificity */ 501 | .code a { 502 | padding: 4px; 503 | border: 1px solid #c7c7c7; 504 | } 505 | 506 | /* stylelint-disable-next-line no-descending-specificity */ 507 | figure img { 508 | display: block; 509 | } 510 | 511 | figcaption { 512 | font-size: 0.85em; 513 | text-align: center; 514 | } 515 | 516 | form { 517 | margin: 20px 0; 518 | } 519 | 520 | input:required:invalid, 521 | fieldset input:focus:invalid { 522 | background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAMAAAAoLQ9TAAAABGdBTUEAALGPC/xhBQAAAwBQTFRFvy8atzQfvzEWvDEXuzEZujIbuzEdvzAZvTAbvjAcvDAdvTIdrzcnszQisTQltTIitzQgtjUhsTssuDEguTIgujQgvD0nqkAutkM2tko5u0c4ul5Qwi8Zwy8awC8bxS4ZxiwcwTEZwDEawTAbwDAcwDEdwzIexjAaxTIZyDAbyjAcyTMdzzEazjEbzzAe0TIb0zMd0zQb1DIc1TQb1TQc1jYc1jYd1zgc2jQb2DUd2TQe2zYc3DUc3jgbxzYh1j4m4DYZ5jcZ5zYb5jYc5Dga5Dgd6TYf7Dcd7zce6zgZ6Dga7Dse7j0e8jcd8zYe8DYf8Tkb8zgd8joc8Toe8Dwf9jkb9Doc4zki5j4n6T0h7jghxkIsx0MuzUUt00Ep2kIt1kg13VE97EEm6Ugu4E064FQ98UIn8kMo80Mp90Ep9UMq3VpD3F1KxmdZw2haw2hbxGhaxGhbwW1hwHdpxndp2H1u4FlH4mVT63Jb9mZO92ZP9WhN+GVN+2RQ4HVlvIB13odx4oNv5IZy54h29o55+4p6+4t7+Y14/Yl6yI+Ew5aPxpuTxqCXyaWe3baq5JSI65CB7pKC9JKK66WX6rGb57ut6rOo7res5b6767yz+62i+q6j/qug/a2i87Cl9rGh9rOq8b+19L+z+L2x48G48MO68sa/8ci96tDK8sbB/crE/crF/srG+87K/svJ/M3I99bR99fS+9bV+93Z8ebe+OHd+eXd/OTd8ebh9e3m9u3r+ufl/eXj/ubg/ufh/efi/ufj/uXk+ujj++nl+uvl+urm/ejh++7q+u/r+vDu+vLt/PDv/fPv/vTy+/j3/Pj0//j2//n3/vv0/vr1/vv2/fr3+/39+/79/vr4/vv6/v37/f77/v38/v39/f78/f79AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAOe7jtQAAABl0RVh0U29mdHdhcmUAUGFpbnQuTkVUIHYzLjUuODc7gF0AAAEbSURBVChTARAB7/4A1rmNdG5xb3BwcG5tc4y43QC6isjT0NDR1djY1NLTzIu4AImVvL/Gxsa+vr7BwL29qX8AGp6rqrPDsqyurbu8r6ujFwALg5ybotjLoJqw37GfnZEOAAlsiIaEp9qmk8/FkoWHdw8AIj98eX14tc601ZB7eXpfEQAjNGJoaWd+z9uWY2pmZjYQACEzQlJUVWvK149MVlNKORUAIzFDSFBYodnJx3ZRTkEzAQAkLUBHS4HYmXXVpVhPPS8NAAInNUVkwsRlWZfVgEQ6KA8AFh0uN5TNgk1aYba3YCwHDAByAyArW11XRklGXlw+HwAbAKgSBRwpMDo8OzgyKh4EFaQA3pgZEwYIJCYmJQgKFBiO3JMVcr8Z+l4TAAAAAElFTkSuQmCC"); 523 | background-position: right; 524 | background-repeat: no-repeat; 525 | box-shadow: none; 526 | } 527 | 528 | /* stylelint-disable-next-line no-descending-specificity */ 529 | input:required:valid { 530 | background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAMAAAAoLQ9TAAAABGdBTUEAALGPC/xhBQAAAwBQTFRFU6E8UqA9U6A+U6A/VaA+VqA/V6I+WKM7WKA/WaI8WqI9WaQ+XaQ6XKQ8Zac9Z6w2Y6k6Z6w6aKo8bK45bq46d7M5fbU6fLY6frY8f7k5U59AU59BVJ9AU6BAUaBBVaBAVKFBVKBCX6JNXqZOYalRZqhSa6pfbapcb6pdbKpfcalbc6pbdKpccqdieKxofK9vf69xgLc5gLY9hrw3gLg4gLg5g7o4g7o5hLs4hLo5hLo6hbs8iL46jb1Ti7d+kMM0k8UwksU0lsQ2nskwnsgynsgzpswvqc8voMc8oMkyocozo8wzpMowpcs7rM8wrtEwrtA1ss8+sNIvtNMtttUuttYtt9Yvu9cuutgrvdkqvdksvNgtvdkvv9svsNM1ttI2utY0vdkxvtowvtsyv9ozvtg1vdwzv9k4vtg6lMRTrs5HtNNMps53rNN+wdhJwtlNw9hWyNxVx9tszd9iyuJPxeBRxuJQyuFTyuJQyuNRyuBW0eNz1OR91eR/1ut31+p41+p62Ot22Op42Op6lb6InsKRnsSUocKVrseir82mr82nrc6kr82oscWltMeusMiisM2msMyoss6r2+mNw+KgyueiyeSy1eq34/Gd4/Ce4/Cf4vKe4+2l5e6j4Oys5u+44/Cg5fCr5vGt6PC16fO26vO87ve/7fi87vi97vi/0uHO2+jW2unX6/TD7vfA7/jH8PbB8vbH8PbK9/rT9vrY9vrc9/vd+/3c+P7c+f7d+P7e6PDk6fTm6/Xo7/fr9ffh+vvl+P3g+f3h+fzi/f7m+/zq/f7s8vrx+f3x+v7w/f7x/v7y/v/z/v/0/v73/v75/v38/f7+AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAnz0KZQAAABl0RVh0U29mdHdhcmUAUGFpbnQuTkVUIHYzLjUuODc7gF0AAAEbSURBVChTARAB7/4A0aqNkImJioyMjImLkY6r0QCsj8nLzMzMzMzMzczLyIi7AD6Xwbe5urq6urq4wsHAlocAIpWwp6apqa6urqiyw6+ULgAhbZibmpqZmqCgorakmWwmAARpf4B/f4OBg5O0oYJ+PScACjt2eXR4eHhzsaN6d3UyKgALOF5mYl1jZ5yzb2JkUDUsAAs3RmBxZVx7xnxhWVZMMSsABhdKcsSdcLWyaFpYUkQVKAAgFEJrn8q/zn1aW1RHPxEpAB8MNklRns/FbldVT0U0BykAJQISPEVqraVfU05DMw4AMACFGwUPOkBITUtEQRkQHBqSAL0tHQEMFBg5NxYTDQEeL8cA0LyEIx4DCAoJHxwdJIa+0S+PbKi6PdJ5AAAAAElFTkSuQmCC"); 531 | background-position: right; 532 | background-repeat: no-repeat; 533 | box-shadow: none; 534 | } 535 | 536 | .error { 537 | font-family: "Ubuntu Mono", Menlo, Consolas, "Courier New", Courier, monospace; 538 | font-size: 112%; 539 | white-space: pre-wrap; 540 | width: 100%; 541 | overflow: auto; 542 | } 543 | 544 | .warning { 545 | border: 1px dotted red; 546 | padding: 0 10px; 547 | margin: 10px 0; 548 | } 549 | 550 | .hi { 551 | background: #ffed3d; 552 | } 553 | 554 | .hidden { 555 | display: none; 556 | } 557 | -------------------------------------------------------------------------------- /generators/app/index.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | const Generator = require('yeoman-generator') 3 | const chalk = require('chalk') 4 | const yosay = require('yosay') 5 | const prettyData = require('gulp-pretty-data') 6 | const stripBom = require('gulp-stripbom') 7 | 8 | module.exports = class extends Generator { 9 | initializing () { 10 | this.props = {} 11 | } 12 | 13 | prompting () { 14 | // Have Yeoman greet the user. 15 | this.log(yosay( 16 | 'Welcome to the stupendous ' + chalk.blue('exist-app') + ' generator!' 17 | )) 18 | 19 | const prompts = [{ 20 | type: 'input', 21 | name: 'title', 22 | message: 'What would you like to call your exist-db application?', 23 | default: this.appname.toLowerCase(), // Defaults to current folder name 24 | validate: value => { 25 | const invalid = value.includes(' ') 26 | if (invalid) { 27 | return 'Please avoid spaces' 28 | } 29 | return true 30 | }, 31 | required: true 32 | }, 33 | { 34 | type: 'input', 35 | name: 'short', 36 | message: 'How should I abbreviate that?', 37 | default: response => { 38 | const short = response.title 39 | 40 | if (short.length > 6) { 41 | return short.substring(0, 6) 42 | } 43 | return short 44 | }, 45 | required: true 46 | }, 47 | { 48 | type: 'input', 49 | name: 'desc', 50 | message: 'Please add a short description?', 51 | default: response => { return 'My amazing ' + response.title + ' application' }, 52 | required: true 53 | }, 54 | { 55 | type: 'list', 56 | name: 'apptype', 57 | message: 'Pick an app template:', 58 | default: 0, // Aka 'exist-design' 59 | choices: [{ 60 | name: 'exist-design', 61 | value: ['exist-design', 'application'] 62 | }, 63 | { 64 | name: 'plain', 65 | value: ['plain', 'application'] 66 | }, 67 | { 68 | name: 'empty', 69 | value: ['empty', 'application'] 70 | }, 71 | { 72 | name: 'library', 73 | value: ['empty', 'library'] 74 | }] 75 | }, 76 | // TODO: [yo] Make these options meaningful 77 | // { 78 | // type: 'checkbox', 79 | // choices: ['ant', 'gulp', 'maven', 'gradle'], 80 | // name: 'builder', 81 | // message: 'How would you like to build your app?', 82 | // default: 'ant' 83 | // }, 84 | { 85 | when: response => { 86 | return response.apptype[1] === 'application' 87 | }, 88 | type: 'confirm', 89 | name: 'mysec', 90 | message: 'should your app have a secure area?', 91 | default: false, 92 | store: true 93 | }, 94 | 95 | // Path related 96 | { 97 | when: response => { 98 | return response.apptype[1] === 'application' 99 | }, 100 | type: 'input', 101 | name: 'defcoll', 102 | message: 'Will your application be deployed in the apps collection? (hit return for yes)', 103 | default: 'apps', 104 | required: true 105 | }, 106 | { 107 | type: 'input', 108 | name: 'defuri', 109 | message: 'What should your module namespace begin with?', 110 | default: 'http://exist-db.org', 111 | validate: value => { 112 | if (encodeURI(value) === value) { 113 | return true 114 | } 115 | return 'Please select a valid URI' 116 | } 117 | }, 118 | { 119 | type: 'input', 120 | name: 'version', 121 | message: 'Pick a version number?', 122 | default: '1.0.0' 123 | }, 124 | { 125 | type: 'list', 126 | choices: ['alpha', 'beta', 'stable', 'SNAPSHOT'], 127 | name: 'status', 128 | message: 'Pick the release status', 129 | default: 'SNAPSHOT' 130 | }, 131 | // TODO: [teipup] autoanswer pre,post, setperm, (license?) see# 132 | { 133 | type: 'confirm', 134 | name: 'pre', 135 | message: 'Would you like to generate a pre-install script?', 136 | default: true 137 | }, 138 | { 139 | type: 'confirm', 140 | name: 'post', 141 | message: 'Would you like to generate a post-install script?', 142 | default: 'post-install.xq' 143 | }, 144 | // TODO multi authors see #41 145 | { 146 | type: 'input', 147 | name: 'author', 148 | message: 'Who is the author of the application?', 149 | default: this.appauthor, 150 | store: true 151 | }, 152 | { 153 | type: 'input', 154 | name: 'email', 155 | message: 'What is your email address?', 156 | default: this.appemail, 157 | validate: value => { 158 | const pass = value.match(/^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i) 159 | if (pass) { 160 | return true 161 | } 162 | return 'Please provide a valid email address' 163 | }, 164 | store: true 165 | }, 166 | { 167 | type: 'input', 168 | name: 'website', 169 | message: 'What is the author\'s website?', 170 | default: 'http://exist-db.org', 171 | store: true 172 | }, 173 | { 174 | type: 'list', 175 | name: 'license', 176 | message: 'Please pick a license', 177 | default: 2, // Aka AGPL-3.0 178 | choices: [{ 179 | name: 'Apache-2.0', 180 | value: ['Apache-2.0', 'Apache%202.0', 'https://opensource.org/licenses/Apache-2.0'] 181 | }, { 182 | name: 'MIT', 183 | value: ['MIT', 'MIT', 'https://opensource.org/licenses/MIT'] 184 | }, { 185 | name: 'AGPL-3.0', 186 | value: ['AGPL-3.0', 'AGPL%20v3', 'https://www.gnu.org/licenses/agpl-3.0'] 187 | }, { 188 | name: 'LGPL-3.0', 189 | value: ['LGPL-3.0', 'LGPL%20v3', 'https://www.gnu.org/licenses/lgpl-3.0'] 190 | }, { 191 | name: 'GPL-3.0', 192 | value: ['GPL-3.0', 'GPL%20v3', 'https://www.gnu.org/licenses/gpl-3.0'] 193 | }, { 194 | name: 'unlicense', 195 | value: ['unlicense', 'unlicense', 'https://choosealicense.com/licenses/unlicense/'] 196 | }] 197 | }, 198 | // See #601 199 | { 200 | type: 'confirm', 201 | name: 'github', 202 | message: 'Will you host the code on GitHub?', 203 | default: true, 204 | store: true 205 | }, 206 | { 207 | when: response => { 208 | return response.github 209 | }, 210 | type: 'input', 211 | name: 'ghuser', 212 | message: 'What is the GitHub username?', 213 | default: this.appuser, 214 | store: true 215 | }, 216 | { 217 | type: 'confirm', 218 | name: 'setperm', 219 | message: 'Would you like to assign db user roles and permissions for your app?', 220 | default: false 221 | }, 222 | { 223 | when: response => { 224 | return response.setperm 225 | }, 226 | type: 'input', 227 | name: 'owner', 228 | message: 'What is the owner\'s username?', 229 | default: 'tei' 230 | }, 231 | { 232 | when: response => { 233 | return response.setperm 234 | }, 235 | type: 'password', 236 | name: 'userpw', 237 | message: 'Please type the user\'s password', 238 | default: 'simple' 239 | }, 240 | { 241 | when: response => { 242 | return response.setperm 243 | }, 244 | type: 'input', 245 | name: 'group', 246 | message: 'What is the app owner\'s usergroup?', 247 | default: response => { return response.owner } 248 | }, 249 | { 250 | when: response => { 251 | return response.setperm 252 | }, 253 | type: 'input', 254 | name: 'mode', 255 | message: 'Please select the user\'s permissions', 256 | default: 'rw-rw-r--', 257 | validate: value => { 258 | const pass = value.match(/^[rwx-]{9}$/g) 259 | if (pass) { 260 | return true 261 | } 262 | return 'Must be a string of 9 unix permission flags (rwx-)' 263 | } 264 | }, 265 | { 266 | type: 'list', 267 | choices: ['travis', 'GitHub Action'], 268 | name: 'ci', 269 | message: 'Whats your CI service', 270 | default: 'GitHub Action', 271 | store: true 272 | }, 273 | { 274 | type: 'confirm', 275 | name: 'docker', 276 | message: 'Would you like to use docker for your app?', 277 | default: true, 278 | store: true 279 | }, 280 | { 281 | when: response => { 282 | return response.docker 283 | }, 284 | type: 'input', 285 | name: 'dockertag', 286 | message: 'Please type the docker tag you wish to use for your container.', 287 | default: 'release', 288 | store: true 289 | }, 290 | // TODO add multi-stage option 291 | { 292 | type: 'confirm', 293 | name: 'atom', 294 | message: 'Would you like to add a' + chalk.grey('.existdb.json') + 'IDE config file for:' + chalk.green('atom') + ' or ' + chalk.magenta('vs-code') + '?', 295 | default: true, 296 | store: true 297 | }, 298 | { 299 | when: response => { 300 | return response.atom 301 | }, 302 | type: 'input', 303 | name: 'instance', 304 | message: 'What is the ' + chalk.blue('eXist') + ' instance\'s URI?', 305 | default: 'http://localhost:8080/exist', 306 | store: true 307 | }, 308 | { 309 | when: response => { 310 | return response.atom 311 | }, 312 | type: 'input', 313 | name: 'admin', 314 | message: 'What is user-name of the admin user?', 315 | default: 'admin', 316 | store: true 317 | }, 318 | { 319 | when: response => { 320 | return response.atom 321 | }, 322 | type: 'password', 323 | name: 'adminpw', 324 | message: 'What is the admin user\'s password', 325 | store: true 326 | }] 327 | 328 | // TODO: [yo]: js, css, gulp, funcdoc, 329 | // TODO: [gulp] https://github.com/bnjjj/generator-gulpfile-advanced 330 | 331 | return this.prompt(prompts).then(props => { 332 | // To access props later use this.props.someAnswer; 333 | this.props = props 334 | this.composeWith(require.resolve('generator-license'), { 335 | name: this.props.author, // (optional) Owner's name 336 | email: this.props.email, // (optional) Owner's email 337 | website: this.props.website, // (optional) Owner's website 338 | year: (new Date()).getFullYear(), // (optional) License year (defaults to current year) 339 | licensePrompt: 'Pick a license, default (AGPL-3.0)', // (optional) customize license prompt text 340 | defaultLicense: 'AGPL-3.0', // (optional) Select a default license 341 | license: this.props.license[0] // (optional) Select a license, so no license prompt will happen, in case you want to handle it outside of this generator 342 | }) 343 | if (this.props.name) { 344 | this.props.elementClassName = this.props.name.replace(/(^|-)(\w)/g, (_match, _p0, p1) => p1.toUpperCase()) 345 | } 346 | }) 347 | } 348 | 349 | writing () { 350 | // try to clean invalid xml from streams 351 | this.registerTransformStream( 352 | stripBom({ 353 | ext: ['xml', 'odd', 'xconf'], 354 | showLog: false 355 | })) 356 | // minify xml first … 357 | this.registerTransformStream(prettyData({ 358 | type: 'minify', 359 | preserveComments: true, 360 | extensions: { 361 | xconf: 'xml', 362 | odd: 'xml' 363 | } 364 | })) 365 | // … then pretty print xml 366 | this.registerTransformStream(prettyData({ 367 | type: 'prettify', 368 | extensions: { 369 | xconf: 'xml', 370 | odd: 'xml' 371 | } 372 | })) 373 | // global pkgJson 374 | const pkgJson = { 375 | name: this.props.title.toLowerCase(), 376 | version: this.props.version, 377 | description: this.props.desc, 378 | homepage: '', 379 | bugs: '', 380 | engines: { 381 | node: '>=14.0.0' 382 | }, 383 | keywords: ['exist', 'exist-db', 'xml', 'xql', 'xquery'], 384 | author: { 385 | name: this.props.author, 386 | email: this.props.email 387 | }, 388 | license: this.props.license[0], 389 | scripts: { 390 | test: 'mocha test/mocha/ --recursive --exit && mocha test/xqs/*.js' 391 | }, 392 | repository: '' 393 | } 394 | this.env.options.nodePackageManager = 'npm' 395 | // see https://github.com/yeoman/generator/issues/1294 396 | this.npmInstall(['chai'], { 'save-dev': true }) 397 | this.npmInstall(['chai-xml'], { 'save-dev': true }) 398 | this.npmInstall(['fs-extra'], { 'save-dev': true }) 399 | this.npmInstall(['mocha'], { 'save-dev': true }) 400 | this.npmInstall(['supertest'], { 'save-dev': true }) 401 | this.npmInstall(['xmldoc'], { 'save-dev': true }) 402 | this.npmInstall(['yeoman-assert'], { 'save-dev': true }) 403 | // Applies to all (without prompts) 404 | // TODO #56 html -> xhtml 405 | 406 | // EXPATH 407 | this.fs.copyTpl( 408 | this.templatePath('build.xml'), 409 | this.destinationPath('build.xml'), { 410 | apptype: this.props.apptype[0], 411 | title: this.props.title, 412 | github: this.props.github, 413 | desc: this.props.desc, 414 | docker: this.props.docker, 415 | dockerfiles: ', Dockerfile, .dockerignore', 416 | gitfiles: ', README.md, **/.git*/**' 417 | }) 418 | 419 | this.fs.copyTpl( 420 | this.templatePath('repo.xml'), 421 | this.destinationPath('repo.xml'), { 422 | desc: this.props.desc, 423 | short: this.props.short, 424 | author: this.props.author, 425 | apptype: this.props.apptype[1], 426 | status: this.props.status, 427 | pre: this.props.pre, 428 | prexq: 'pre-install.xq', 429 | post: this.props.post, 430 | postxq: 'post-install.xq', 431 | setperm: this.props.setperm, 432 | website: this.props.website, 433 | license: this.props.license[0], 434 | owner: this.props.owner, 435 | userpw: this.props.userpw, 436 | group: this.props.group, 437 | mode: this.props.mode 438 | }) 439 | 440 | this.fs.copyTpl( 441 | this.templatePath('expath-pkg.xml'), 442 | this.destinationPath('expath-pkg.xml'), { 443 | short: this.props.short, 444 | defcoll: this.props.defcoll, 445 | defuri: this.props.defuri, 446 | version: this.props.version, 447 | desc: this.props.desc, 448 | apptype: this.props.apptype[0] 449 | }) 450 | 451 | // Unit Test 452 | this.fs.copyTpl( 453 | this.templatePath('specs/xqs/test-suite.xqm'), 454 | this.destinationPath('test/xqs/test-suite.xqm'), { 455 | apptype: this.props.apptype[0], 456 | short: this.props.short, 457 | defcoll: this.props.defcoll, 458 | defuri: this.props.defuri, 459 | version: this.props.version, 460 | author: this.props.author, 461 | website: this.props.website, 462 | title: this.props.title 463 | }) 464 | this.fs.copyTpl( 465 | this.templatePath('specs/xqs/test-runner.xq'), 466 | this.destinationPath('test/xqs/test-runner.xq'), { 467 | short: this.props.short, 468 | defcoll: this.props.defcoll, 469 | defuri: this.props.defuri, 470 | version: this.props.version, 471 | author: this.props.author, 472 | title: this.props.title 473 | }) 474 | 475 | this.fs.copy( 476 | this.templatePath('specs/mocha/app_spec.js'), 477 | this.destinationPath('test/mocha/app_spec.js') 478 | ) 479 | 480 | this.fs.copyTpl( 481 | this.templatePath('specs/mocha/rest_spec.js'), 482 | this.destinationPath('test/mocha/rest_spec.js'), { 483 | apptype: this.props.apptype[0], 484 | short: this.props.short, 485 | defcoll: this.props.defcoll 486 | }) 487 | 488 | this.fs.copyTpl( 489 | this.templatePath('specs/xqs/xqSuite.js'), 490 | this.destinationPath('test/xqs/xqSuite.js'), { 491 | apptype: this.props.apptype[1], 492 | short: this.props.short, 493 | defcoll: this.props.defcoll, 494 | version: this.props.version 495 | }) 496 | 497 | // all application packages, … 498 | if (this.props.apptype[1] === 'application') { 499 | this.fs.copy( 500 | this.templatePath('img/icon.png'), 501 | this.destinationPath('icon.png') 502 | ) 503 | this.fs.copy( 504 | this.templatePath('specs/cypress/'), 505 | this.destinationPath('test/cypress/') 506 | ) 507 | 508 | this.fs.copy( 509 | this.templatePath('specs/cypress.config.js'), 510 | this.destinationPath('cypress.config.js') 511 | ) 512 | 513 | this.fs.copy( 514 | this.templatePath('github/.gitkeep'), 515 | this.destinationPath('reports/screenshots/.gitkeep') 516 | ) 517 | 518 | this.fs.copy( 519 | this.templatePath('github/.gitkeep'), 520 | this.destinationPath('reports/videos/.gitkeep') 521 | ) 522 | 523 | this.fs.copyTpl( 524 | this.templatePath('specs/e2e/landing.cy.js'), 525 | this.destinationPath('test/cypress/e2e/landing.cy.js'), { 526 | apptype: this.props.apptype[0], 527 | short: this.props.short, 528 | defcoll: this.props.defcoll, 529 | desc: this.props.desc, 530 | mysec: this.props.mysec 531 | }) 532 | 533 | this.npmInstall(['cypress'], { 'save-dev': true }) 534 | 535 | Object.assign(pkgJson.scripts, { 536 | cypress: 'cypress run' 537 | }) 538 | } 539 | // … except empty (flexible) 540 | if (this.props.apptype[0] !== 'empty') { 541 | this.fs.copyTpl( 542 | this.templatePath('pages/error-page.html'), 543 | this.destinationPath('error-page.html'), { 544 | apptype: this.props.apptype[0] 545 | }) 546 | 547 | this.fs.copyTpl( 548 | this.templatePath('pages/index.html'), 549 | this.destinationPath('index.html'), { 550 | apptype: this.props.apptype[0] 551 | }) 552 | this.fs.copyTpl( 553 | this.templatePath('styles/style.css'), 554 | this.destinationPath('resources/css/style.css'), { 555 | apptype: this.props.apptype[0] 556 | }) 557 | 558 | this.fs.copyTpl( 559 | this.templatePath('collection.xconf'), 560 | this.destinationPath('collection.xconf'), { 561 | apptype: this.props.apptype[0], 562 | index: this.props.index 563 | }) 564 | 565 | // XQuery 566 | this.fs.copyTpl( 567 | this.templatePath('xq/controller.xq'), 568 | this.destinationPath('controller.xq'), { 569 | apptype: this.props.apptype[0], 570 | mysec: this.props.mysec 571 | }) 572 | 573 | this.fs.copyTpl( 574 | this.templatePath('xq/view.xq'), 575 | this.destinationPath('modules/view.xq'), { 576 | short: this.props.short, 577 | defcoll: this.props.defcoll, 578 | defuri: this.props.defuri, 579 | apptype: this.props.apptype[0], 580 | version: this.props.version 581 | }) 582 | this.fs.copyTpl( 583 | this.templatePath('xq/app.xqm'), 584 | this.destinationPath('modules/app.xqm'), { 585 | short: this.props.short, 586 | defcoll: this.props.defcoll, 587 | defuri: this.props.defuri, 588 | apptype: this.props.apptype[0], 589 | version: this.props.version, 590 | author: this.props.author, 591 | website: this.props.website, 592 | title: this.props.title, 593 | mysec: this.props.mysec 594 | }) 595 | this.fs.copyTpl( 596 | this.templatePath('xq/config.xqm'), 597 | this.destinationPath('modules/config.xqm'), { 598 | short: this.props.short, 599 | defcoll: this.props.defcoll, 600 | defuri: this.props.defuri, 601 | apptype: this.props.apptype[0], 602 | defview: this.props.defview, 603 | index: this.props.index, 604 | dataloc: this.props.dataloc, 605 | datasrc: this.props.datasrc, 606 | odd: this.props.odd 607 | }) 608 | 609 | // #36 shared-resources 610 | this.fs.copy( 611 | this.templatePath('img/exist_icon_16x16.ico'), 612 | this.destinationPath('resources/images/exist_icon_16x16.ico') 613 | ) 614 | this.fs.copy( 615 | this.templatePath('img/powered-by.svg'), 616 | this.destinationPath('resources/images/powered-by.svg') 617 | ) 618 | 619 | this.npmInstall(['bootstrap@5']) 620 | 621 | // distinct contents (flexible) 622 | // see #28 623 | switch (this.props.apptype[0]) { 624 | case 'exist-design': 625 | this.fs.copyTpl( 626 | this.templatePath('pages/exist-design/page.html'), 627 | this.destinationPath('templates/page.html'), { 628 | title: this.props.title, 629 | mysec: this.props.mysec 630 | }) 631 | this.fs.copy( 632 | this.templatePath('img/exist-design/**'), 633 | this.destinationPath('resources/images/') 634 | ) 635 | // #36 636 | this.fs.copy( 637 | this.templatePath('styles/exist-2.2.css'), 638 | this.destinationPath('resources/css/exist-2.2.css') 639 | ) 640 | break 641 | case 'plain': 642 | this.fs.copyTpl( 643 | this.templatePath('pages/plain/page.html'), 644 | this.destinationPath('templates/page.html'), { 645 | title: this.props.title, 646 | mysec: this.props.mysec 647 | }) 648 | break 649 | default: 650 | } 651 | } 652 | 653 | // Prompt based 654 | // Pre-install 655 | if (this.props.pre) { 656 | this.fs.copyTpl( 657 | this.templatePath('xq/pre-install.xq'), 658 | this.destinationPath('pre-install.xq'), { 659 | version: this.props.version, 660 | author: this.props.author, 661 | website: this.props.website 662 | } 663 | ) 664 | } 665 | // Post-install 666 | if (this.props.post) { 667 | this.fs.copyTpl( 668 | this.templatePath('xq/post-install.xq'), 669 | this.destinationPath('post-install.xq'), { 670 | apptype: this.props.apptype[0], 671 | version: this.props.version, 672 | author: this.props.author, 673 | website: this.props.website 674 | }) 675 | } 676 | 677 | // Secure area (mysec) 678 | if (this.props.mysec) { 679 | this.fs.copy( 680 | this.templatePath('pages/mysec/admin/*.html'), 681 | this.destinationPath('admin/') 682 | ) 683 | this.fs.copy( 684 | this.templatePath('xq/admin/**'), 685 | this.destinationPath('admin/') 686 | ) 687 | this.fs.copy( 688 | this.templatePath('pages/mysec/templates/*.html'), 689 | this.destinationPath('templates/') 690 | ) 691 | this.fs.copyTpl( 692 | this.templatePath('specs/e2e/login-*.cy.js'), 693 | this.destinationPath('test/cypress/e2e/'), { 694 | defcoll: this.props.defcoll, 695 | short: this.props.short 696 | }) 697 | } 698 | 699 | // Github 700 | // TODO #601 701 | if (this.props.github) { 702 | this.fs.copy( 703 | this.templatePath('github/__gitignore__'), 704 | this.destinationPath('.gitignore') 705 | ) 706 | // Is this needed how so? 707 | this.fs.copy( 708 | this.templatePath('github/.gitattributes'), 709 | this.destinationPath('.gitattributes') 710 | ) 711 | this.fs.copy( 712 | this.templatePath('github/feature_request.md'), 713 | this.destinationPath('.github/ISSUE_TEMPLATE/feature_request.md') 714 | ) 715 | this.fs.copy( 716 | this.templatePath('github/PULL_REQUEST_TEMPLATE.md'), 717 | this.destinationPath('.github/pull_request_template.md') 718 | ) 719 | // Git-flex 720 | this.fs.copyTpl( 721 | this.templatePath('github/readme.md'), 722 | this.destinationPath('README.md'), { 723 | apptype: this.props.apptype[0], 724 | title: this.props.title, 725 | desc: this.props.desc, 726 | version: this.props.version, 727 | ghuser: this.props.ghuser, 728 | website: this.props.website, 729 | author: this.props.author, 730 | license: this.props.license[0], 731 | badge: this.props.license[1], 732 | badgelink: this.props.license[2], 733 | ci: this.props.ci 734 | }) 735 | this.fs.copyTpl( 736 | this.templatePath('github/contributing.md'), 737 | this.destinationPath('.github/CONTRIBUTING.md'), { 738 | title: this.props.title 739 | }) 740 | this.fs.copyTpl( 741 | this.templatePath('github/ISSUE_TEMPLATE.md'), 742 | this.destinationPath('.github/ISSUE_TEMPLATE/bug_report.md'), { 743 | title: this.props.title 744 | }) 745 | // insert responses into pkgJson 746 | Object.assign(pkgJson, { 747 | homepage: 'https://github.com/' + this.props.ghuser + '/' + this.props.title.toLowerCase() + '#readme' 748 | }, { 749 | bugs: 'https://github.com/' + this.props.ghuser + '/' + this.props.title.toLowerCase() + '/issues' 750 | }, { 751 | repository: { 752 | type: 'git', 753 | url: 'https://github.com/' + this.props.ghuser + '/' + this.props.title.toLowerCase(), 754 | license: this.props.license[0] 755 | } 756 | }) 757 | } 758 | 759 | // DOCKER 760 | if (this.props.docker) { 761 | this.fs.copy( 762 | this.templatePath('.dockerignore'), 763 | this.destinationPath('.dockerignore') 764 | ) 765 | this.fs.copyTpl( 766 | this.templatePath('Dockerfile'), 767 | this.destinationPath('Dockerfile'), { 768 | dockertag: this.props.dockertag, 769 | title: this.props.title, 770 | version: this.props.version 771 | }) 772 | } 773 | 774 | // Atom 775 | if (this.props.atom) { 776 | this.fs.copyTpl( 777 | this.templatePath('.existdb.json'), 778 | this.destinationPath('.existdb.json'), { 779 | short: this.props.short, 780 | defcoll: this.props.defcoll, 781 | instance: this.props.instance, 782 | admin: this.props.admin, 783 | adminpw: this.props.adminpw 784 | }) 785 | } 786 | 787 | // CI 788 | switch (this.props.ci) { 789 | case 'travis': 790 | this.fs.copyTpl( 791 | this.templatePath('ci/.travis.yml'), 792 | this.destinationPath('.travis.yml'), { 793 | apptype: this.props.apptype[1] 794 | }) 795 | break 796 | default: 797 | this.fs.copyTpl( 798 | this.templatePath('ci/exist.yml'), 799 | this.destinationPath('.github/workflows/exist.yml'), { 800 | apptype: this.props.apptype[1] 801 | } 802 | ) 803 | this.fs.copy( 804 | this.templatePath('ci/dependabot.yml'), 805 | this.destinationPath('.github/dependabot.yml') 806 | ) 807 | } 808 | 809 | // Write the constructed pkgJson 810 | this.fs.writeJSON(this.destinationPath('package.json'), pkgJson) 811 | } 812 | 813 | install () { 814 | this.npmInstall() 815 | } 816 | 817 | end () { 818 | if (this.props.github) { 819 | this.spawnCommandSync('git', ['init']) 820 | this.spawnCommandSync('git', ['add', '--all']) 821 | this.spawnCommandSync('git', ['commit', '-q', '-m', '\'chore(init): scaffolding by Yeoman\'']) 822 | } 823 | this.spawnCommandSync('ant', '-q') 824 | 825 | console.log(yosay('I believe we\'re done here.')) 826 | } 827 | } 828 | --------------------------------------------------------------------------------
5 |
37 |
--------------------------------------------------------------------------------
/test/mock_rest.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 | const supertest = require('supertest')
3 | const expect = require('chai').expect
4 |
5 | // The client listening to the mock rest server
6 | const client = supertest.agent('http://localhost:3000')
7 |
8 | // mock test report
9 |
10 | describe('mocking xqSuite rest responses', function () {
11 | before(function (done) {
12 | require('../server').StartServer()
13 | done()
14 | })
15 |
16 | describe('mock-exist returns', function () {
17 | it('404 from random page', function (done) {
18 | client
19 | .get('/random')
20 | .expect(404)
21 | .end(function (err, res) {
22 | if (err) return done(err)
23 | expect(res.status).to.equal(404)
24 | done()
25 | })
26 | })
27 |
28 | it('200 from default rest endpoint', function (done) {
29 | client
30 | .get('/exist/rest/db/')
31 | .expect(200)
32 | .end(function (err, res) {
33 | if (err) return done(err)
34 | expect(res.status).to.equal(200)
35 | done()
36 | })
37 | })
38 |
39 | it.skip('200 from startpage (index.html)', function (done) {
40 | client
41 | .get('/exist/rest/db/<%- defcoll %>/<%- short %>/index.html')
42 | .expect(200)
43 | .end(function (err, res) {
44 | expect(res.status).to.equal(200)
45 | if (err) return done(err)
46 | done()
47 | })
48 | })
49 | })
50 |
51 | // see http://www.marcusoft.net/2015/10/eaddrinuse-when-watching-tests-with-mocha-and-supertest.html
52 | after('shutdown mock server', function (done) {
53 | done()
54 | })
55 | })
56 |
--------------------------------------------------------------------------------
/generators/app/templates/github/contributing.md:
--------------------------------------------------------------------------------
1 | # Contributing
2 |
3 | :balloon: First off, thank you for considering contributing to <%- title %>. :balloon:
4 |
5 | All pull-requests are welcome. File a bug report, fix a typo, improve the documentation, or add a new feature. All are helpful, and make <%- title %> better.
6 |
7 | Please have a quick look at these guidelines to help both you and the developers to keep things moving smoothly.
8 |
9 | ## Basic Conduct
10 |
11 | * Please be respectful when discussing changes and issues. Consider that not everyone's first language is english.
12 | * Create an issue for any major changes and enhancements that you wish to make.
13 |
14 | If this is your first time contributing to a project you might want to take a look [here](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github).
15 |
16 | ## Getting started
17 | 1. Create your own fork of the code.
18 |
19 | 2. Do the changes in your fork.
20 | * Minor changes that don't impact code functionality (typos, inline comments, … ) can be done in the master branch.
21 | * Functional changes should be collected in their own branch.
22 |
23 | 3. If you like the change and think the project could use it:
24 | * Open a pull request referencing the issue describing the new feature in the comment section \([how-to](https://github.com/blog/1506-closing-issues-via-pull-requests)\).
25 |
26 | Once your pull request has been reviewed it will be merged. You can greatly help the reviewer by:
27 | * sticking to one feature per pull request.
28 | * use [meaningful](https://chris.beams.io/posts/git-commit/) commit messages inside your feature branch.
29 | * filling out the pull request & issue templates.
30 |
--------------------------------------------------------------------------------
/server.js:
--------------------------------------------------------------------------------
1 | exports.StartServer = function () {
2 | const restify = require('restify')
3 |
4 | const body = {
5 | testsuite: {
6 | package: 'http://exist-db.org/apps/my-app/tests',
7 | timestamp: '2018-07-12T15:25:38.227Z',
8 | tests: '1',
9 | failures: '0',
10 | errors: '0',
11 | pending: '0',
12 | time: 'PT0.02S',
13 | testcase: [{
14 | name: 'templating-foo',
15 | class: 'tests:templating-foo'
16 | }]
17 | }
18 | }
19 |
20 | // this rest server mocks the reponses of exist-db's rest api for unit testing without a running eXist instance.
21 | const server = restify.createServer({
22 | // server.use(restify.plugins.bodyParser())
23 | // server.use(restify.plugins.authorizationParser());
24 | name: 'mock-exist',
25 | version: '1.0.0'
26 | })
27 |
28 | // can be reached at eXist api's URI
29 | function respond (req, res, next) {
30 | res.setHeader('content-type', 'application/xml')
31 | res.charSet('UTF-8')
32 | res.send('
6 | <% } else { %>
7 |
29 | <% if(apptype == 'plain'){ %>
30 |
8 |
<% } %>
14 |
9 | <% } %>
10 |
<% } else { %>
13 | Generated page
11 | <% if(apptype == 'plain'){ %> 12 |
15 |
20 | 16 | This is the entry page into your application and was generated by yeoman. It uses HTML templates for a clean separation of HTML views and application logic.
17 |To add your own template functions, start by editing the XQuery module: 18 |
app.xqm. 19 |
21 |
28 |
22 |
24 | The page template uses the Bootstrap CSS library for the page layout.
23 |
25 |
26 |
27 | <% } else { %>
<% } else { %><% } %>
36 | <% } %>
31 |
34 | <% if(apptype == 'plain'){ %>
35 | Application Info
32 | 33 |Dummy templating function.
31 | }; 32 | 33 | declare function app:test($node as node(), $model as map(*)) { 34 |Dummy template output generated by function app:test at {current-dateTime()}. The templating
35 | function was triggered by the class attribute class="app:test".
14 |
57 |
58 |
59 |
66 | <%_ if (mysec) { %>
67 |
68 |
69 |
70 | <% } -%>
71 |
72 |
73 |
--------------------------------------------------------------------------------
/generators/app/templates/xq/admin/controller.xq:
--------------------------------------------------------------------------------
1 | xquery version "3.0";
2 |
3 | (:~ The controller library contains URL routing functions.
4 | :
5 | : @see http://www.exist-db.org/exist/apps/doc/urlrewrite.xml
6 | :)
7 |
8 | import module namespace login="http://exist-db.org/xquery/login" at "resource:org/exist/xquery/modules/persistentlogin/login.xql";
9 |
10 | declare variable $exist:path external;
11 | declare variable $exist:resource external;
12 | declare variable $exist:controller external;
13 | declare variable $exist:prefix external;
14 | declare variable $exist:root external;
15 |
16 | declare variable $local:login_domain := "org.exist-db.mysec";
17 | declare variable $local:user := $local:login_domain || '.user';
18 |
19 | let $logout := request:get-parameter("logout", ())
20 | let $set-user := login:set-user($local:login_domain, (), false())
21 | return
22 | if ($exist:path eq '') then
23 |
12 |
13 | <%- desc %>
14 |
15 | ## Requirements
16 |
17 | * [exist-db](http://exist-db.org/exist/apps/homepage/index.html) version: `6.2` or greater
18 |
19 | * [ant](http://ant.apache.org) version: `1.10.12` \(for building from source\)
20 | <% if (apptype == 'exist-design' || 'plain') { %>
21 | * [node](http://nodejs.org) version: `18.x` \(for building from source\)
22 | <% } %>
23 |
24 | ## Installation
25 |
26 | 1. Download the `<%- title %>-<%- version %>.xar` file from GitHub [releases](https://github.com/<%- ghuser %>/<%- title %>/releases) page.
27 |
28 | 2. Open the [dashboard](http://localhost:8080/exist/apps/dashboard/index.html) of your eXist-db instance and click on `package manager`.
29 |
30 | 1. Click on the `add package` symbol in the upper left corner and select the `.xar` file you just downloaded.
31 |
32 | 3. You have successfully installed <%- title %> into exist.
33 |
34 | ### Building from source
35 |
36 | 1. Download, fork or clone this GitHub repository
37 | 2. There are two default build targets in `build.xml`:
38 | * `dev` including *all* files from the source folder including those with potentially sensitive information.
39 |
40 | * `deploy` is the official release. It excludes files necessary for development but that have no effect upon deployment.
41 |
42 | 3. Calling `ant`in your CLI will build both files:
43 |
44 | ```bash
45 | cd <%- title %>
46 | ant
47 | ```
48 |
49 | 1. to only build a specific target call either `dev` or `deploy` like this:
50 | ```bash
51 | ant dev
52 | ```
53 |
54 | If you see `BUILD SUCCESSFUL` ant has generated a `<%- title %>-<%- version %>.xar` file in the `build/` folder. To install it, follow the instructions [above](#installation).
55 |
56 | <%_ if (apptype == 'exist-design' || 'plain') { %>
57 |
58 | ## Running Tests
59 |
60 | To run tests locally your app needs to be installed in a running exist-db instance at the default port `8080` and with the default dba user `admin` with the default empty password.
61 |
62 | A quick way to set this up for docker users is to simply issue:
63 |
64 | ```bash
65 | docker run -dit -p 8080:8080 existdb/existdb:release
66 | ```
67 |
68 | After you finished installing the application, you can run the full testsuite locally.
69 |
70 | ### Unit-tests
71 |
72 | This app uses [mochajs](https://mochajs.org) as a test-runner. To run both xquery and javascript unit-tests type:
73 |
74 | ```bash
75 | npm test
76 | ```
77 |
78 | ### Integration-tests
79 |
80 | This app uses [cypress](https://www.cypress.io) for integration tests, just type:
81 |
82 | ```bash
83 | npm run cypress
84 | ```
85 |
86 | Alternatively, use npx:
87 |
88 | ```bash
89 | npx cypress open
90 | ```
91 |
92 | <% } -%>
93 |
94 | ## Contributing
95 |
96 | You can take a look at the [Contribution guidelines for this project](.github/CONTRIBUTING.md)
97 |
98 | ## License
99 |
100 | <%- license %> © [<%- author %>](<%- website %>)
101 |
102 | [license-img]: https://img.shields.io/badge/license-<%- badge %>-blue.svg
103 | [license-url]: <%- badgelink %>
104 | [release-img]: https://img.shields.io/badge/release-<%- version %>-green.svg
105 | [release-url]: https://github.com/<%- ghuser %>/<%- title %>/releases/latest
106 | <%_ if (ci == 'travis') { %>
107 | [travis-image]: https://travis-ci.com/<%- ghuser %>/<%- title %>.svg?branch=main
108 | [travis-url]: https://travis-ci.com/<%- ghuser %>/<%- title %>
109 | <% } -%>
--------------------------------------------------------------------------------
/test/mock_xqs.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 |
3 | const Mocha = require('mocha')
4 | const expect = require('chai').expect
5 |
6 | const monoCase = require('./fixtures/mono-case.json')
7 | const multiCase = require('./fixtures/multi-case.json')
8 | const multiSuite = require('./fixtures/multi-suite.json')
9 |
10 | describe('mock xqs runs', function () {
11 | it('should pass the mono test', function (done) {
12 | /* eslint-disable-next-line */
13 | expect(xqsMock(monoCase)).to.not.throw
14 | done()
15 | })
16 |
17 | it('should fail the multi case', function (done) {
18 | /* eslint-disable-next-line */
19 | expect(xqsMock(multiCase)).to.throw
20 | done()
21 | })
22 |
23 | it('should pass the mutli suite', function (done) {
24 | /* eslint-disable-next-line */
25 | expect(xqsMock(multiSuite)).to.not.throw
26 | done()
27 | })
28 | })
29 |
30 | function xqsMock (mockRun) {
31 | // Dynamically generate a mocha testsuite for xqsuite tests. Requires its own process, hence && in package.json
32 | const Test = Mocha.Test
33 |
34 | const xqsReport = mockRun
35 | const xqsPkg = xqsReport.testsuite.package
36 | const xqstCount = xqsReport.testsuite.tests
37 | const xqstCase = xqsReport.testsuite.testcase
38 |
39 | // TODO: get rid of first "0 passing message"
40 |
41 | const mochaInstance = new Mocha()
42 |
43 | if (Array.isArray(xqsReport.testsuite)) {
44 | const xqsSuites = xqsReport.testsuite
45 | console.warn('support for multiple testsuites per run is experimental')
46 | xqsSuites.forEach((entry) => {
47 | xqsTests(mochaInstance, entry.package, entry.tests, entry.testcase)
48 | })
49 | } else {
50 | xqsTests(mochaInstance, xqsPkg, xqstCount, xqstCase)
51 | }
52 | // enable repeated runs
53 | // see https://github.com/mochajs/mocha/issues/995
54 | // see https://mochajs.org/api/mocha#unloadFiles
55 | const suiteRun = mochaInstance.cleanReferencesAfterRun(true).run()
56 | process.on('exit', () => {
57 | if (suiteRun.stats.failures > 0) { process.exit(1) } else { process.exit(0) }
58 | })
59 |
60 | // TODO: mark %pending xqstests as pending in mocha report
61 | function xqsTests (mochaInstance, xqsPkg, xqstCount, xqstCase) {
62 | const suiteInstance = Mocha.Suite.create(mochaInstance.suite, 'Xqsuite tests for ' + xqsPkg)
63 |
64 | if (xqstCase === undefined) {
65 | // if xqs contains 0 tests close open mocha instance
66 | mochaInstance.unloadFiles()
67 | suiteInstance.dispose()
68 | console.log('no test cases defined by suite ' + xqsPkg)
69 | } else if (Array.isArray(xqstCase)) {
70 | for (let i = 0; i < xqstCount; i++) {
71 | xqsResult(suiteInstance, xqstCase[i])
72 | }
73 | } else {
74 | xqsResult(suiteInstance, xqstCase)
75 | }
76 | }
77 |
78 | function xqsResult (suiteInstance, xqstCase) {
79 | suiteInstance.addTest(new Test('Test: ' + xqstCase.name, () => {
80 | switch (Object.prototype.hasOwnProperty.call(xqstCase, '')
81 |
82 | ) {
83 | // Red xqs test: filter to dynamically ouput messages only when record contains them
84 | case 'failure':
85 | expect(xqstCase, 'Function ' + xqstCase.class + ' ' + xqstCase.failure.message).to.not.have.own.property('failure')
86 | break
87 | case 'error':
88 | expect(xqstCase, 'Function ' + xqstCase.class + ' ' + xqstCase.error.message).to.not.have.own.property('error')
89 | break
90 | // TODO: Blue xqs tests: pending not yet implemented
91 | case 'pending':
92 | Test.isPending(true)
93 | break
94 | // Green xqs tests: pass passing tests
95 | default:
96 | /* eslint-disable-next-line */
97 | expect(xqstCase.failure).to.not.exist
98 | /* eslint-disable-next-line */
99 | expect(xqstCase.error).to.not.exist
100 | break
101 | }
102 | }
103 | ))
104 | }
105 | }
106 |
--------------------------------------------------------------------------------
/generators/app/templates/xq/config.xqm:
--------------------------------------------------------------------------------
1 | xquery version "3.1";
2 |
3 | (:~
4 | : A set of helper functions to access the application context from
5 | : within a module.
6 | :)
7 |
8 | module namespace config="<%- defuri %>/<%- defcoll %>/<%- short %>/config";
9 |
10 | import module namespace templates="http://exist-db.org/xquery/html-templating";
11 | import module namespace lib="http://exist-db.org/xquery/html-templating/lib";
12 |
13 | declare namespace repo="http://exist-db.org/xquery/repo";
14 | declare namespace expath="http://expath.org/ns/pkg";
15 | (:
16 | Determine the application root collection from the current module load path.
17 | :)
18 | declare variable $config:app-root :=
19 | let $rawPath := system:get-module-load-path()
20 | let $modulePath :=
21 | (: strip the xmldb: part :)
22 | if (starts-with($rawPath, "xmldb:exist://")) then
23 | if (starts-with($rawPath, "xmldb:exist://embedded-eXist-server")) then
24 | substring($rawPath, 36)
25 | else
26 | substring($rawPath, 15)
27 | else
28 | $rawPath
29 | return
30 | substring-before($modulePath, "/modules")
31 | ;
32 |
33 | declare variable $config:repo-descriptor := doc(concat($config:app-root, "/repo.xml"))/repo:meta;
34 |
35 | declare variable $config:expath-descriptor := doc(concat($config:app-root, "/expath-pkg.xml"))/expath:package;
36 |
37 | declare variable $config:data-root := $config:app-root || "/data";
38 |
39 | (:~
40 | : Resolve the given path using the current application context.
41 | : If the app resides in the file system,
42 | :)
43 | declare function config:resolve($relPath as xs:string) {
44 | if (starts-with($config:app-root, "/db")) then
45 | doc(concat($config:app-root, "/", $relPath))
46 | else
47 | doc(concat("file://", $config:app-root, "/", $relPath))
48 | };
49 |
50 | (:~
51 | : Returns the repo.xml descriptor for the current application.
52 | :)
53 | declare function config:repo-descriptor() as element(repo:meta) {
54 | $config:repo-descriptor
55 | };
56 |
57 | (:~
58 | : Returns the expath-pkg.xml descriptor for the current application.
59 | :)
60 | declare function config:expath-descriptor() as element(expath:package) {
61 | $config:expath-descriptor
62 | };
63 |
64 | declare %templates:wrap function config:app-title($node as node(), $model as map(*)) as text() {
65 | $config:expath-descriptor/expath:title/text()
66 | };
67 |
68 | declare function config:app-meta($node as node(), $model as map(*)) as element()* {
69 | ,
70 | for $author in $config:repo-descriptor/repo:author
71 | return
72 |
73 | };
74 |
75 | (:~
76 | : For debugging: generates a table showing all properties defined
77 | : in the application descriptors.
78 | :)
79 | declare function config:app-info($node as node(), $model as map(*)) {
80 | let $expath := config:expath-descriptor()
81 | let $repo := config:repo-descriptor()
82 | return
83 | | app collection: | 87 |{$config:app-root} | 88 |
| {node-name($attr)}: | 95 |{$attr/@*/string()} | 96 |
| {node-name($attr)}: | 99 |{$attr/string()} | 100 |
| Controller: | 104 |{ request:get-attribute("$exist:controller") } | 105 |
14 |
70 |
71 |
72 |
73 |
88 | <%_ if (mysec) { %>
89 |
15 |
69 |
90 |
91 |
92 | <% } -%>
93 |
94 |
95 |
--------------------------------------------------------------------------------
/test/util/consistency.js:
--------------------------------------------------------------------------------
1 | exports.isConsistent = function () {
2 | const chai = require('chai')
3 | const chaiXml = require('chai-xml')
4 | const expect = require('chai').expect
5 | const fs = require('fs-extra')
6 | const xmldoc = require('xmldoc')
7 | const assert = require('yeoman-assert')
8 |
9 | chai.use(chaiXml)
10 |
11 | it('description is consistent', function (done) {
12 | if (fs.existsSync('build.xml')) {
13 | const build = fs.readFileSync('build.xml', 'utf8')
14 | const parsed = new xmldoc.XmlDocument(build)
15 | var buildDesc = parsed.childNamed('description').val
16 | }
17 |
18 | if (fs.existsSync('package.json')) {
19 | const pkg = fs.readFileSync('package.json', 'utf8')
20 | const parsed = JSON.parse(pkg)
21 | var pkgDesc = parsed.description
22 | }
23 |
24 | if (fs.existsSync('repo.xml')) {
25 | const repo = fs.readFileSync('repo.xml', 'utf8')
26 | const parsed = new xmldoc.XmlDocument(repo)
27 | var repoDesc = parsed.childNamed('description').val
28 | }
29 |
30 | if (fs.existsSync('expath-pkg.xml')) {
31 | const exPkg = fs.readFileSync('expath-pkg.xml', 'utf8')
32 | const parsed = new xmldoc.XmlDocument(exPkg)
33 | var exPkgDesc = parsed.childNamed('title').val
34 | }
35 |
36 | const desc = [exPkgDesc, buildDesc, pkgDesc, repoDesc, buildDesc].filter(Boolean)
37 | let i = 0
38 | // console.log(desc)
39 | desc.forEach(function () {
40 | expect(desc[i]).to.equal(exPkgDesc)
41 | i++
42 | })
43 | done()
44 | })
45 |
46 | it('version string is consistent', function (done) {
47 | if (fs.existsSync('package.json')) {
48 | const pkg = fs.readFileSync('package.json', 'utf8')
49 | const parsed = JSON.parse(pkg)
50 | var pkgVer = parsed.version
51 | }
52 |
53 | if (fs.existsSync('expath-pkg.xml')) {
54 | const exPkg = fs.readFileSync('expath-pkg.xml', 'utf8')
55 | const parsed = new xmldoc.XmlDocument(exPkg)
56 | var exPkgVer = parsed.attr.version
57 | }
58 |
59 | const vers = [exPkgVer, pkgVer].filter(Boolean)
60 | let i = 0
61 | // console.log(vers)
62 | vers.forEach(function () {
63 | expect(vers[i]).to.equal(exPkgVer)
64 | i++
65 | })
66 | done()
67 | })
68 |
69 | it('should contain identical licenses', function (done) {
70 | if (fs.existsSync('package.json')) {
71 | const pkg = fs.readFileSync('package.json', 'utf8')
72 | const parsed = JSON.parse(pkg)
73 | var pkgLic = parsed.license
74 | }
75 |
76 | if (fs.existsSync('repo.xml')) {
77 | const exRepo = fs.readFileSync('repo.xml', 'utf8')
78 | const parsed = new xmldoc.XmlDocument(exRepo)
79 | var repoLic = parsed.childNamed('license').val
80 | }
81 |
82 | const lic = [repoLic, pkgLic].filter(Boolean)
83 | let i = 0
84 | // console.log(lic)
85 | lic.forEach(function () {
86 | expect(lic[i]).to.equal(pkgLic)
87 | i++
88 | })
89 | done()
90 | })
91 |
92 | it('title is consistent', function (done) {
93 | if (fs.existsSync('build.xml')) {
94 | const build = fs.readFileSync('build.xml', 'utf8')
95 | const parsed = new xmldoc.XmlDocument(build)
96 | var buildTit = parsed.attr.name.toLowerCase()
97 | }
98 |
99 | if (fs.existsSync('package.json')) {
100 | const pkg = fs.readFileSync('package.json', 'utf8')
101 | const parsed = JSON.parse(pkg)
102 | var pkgTitle = parsed.name
103 | }
104 |
105 | if (fs.existsSync('templates/page.html')) {
106 | const page = fs.readFileSync('templates/page.html', 'utf8')
107 | const parsed = new xmldoc.XmlDocument(page)
108 | var pageTitle = parsed.descendantWithPath('head.title').val
109 | }
110 |
111 | const titles = [buildTit, pkgTitle, pageTitle].filter(Boolean)
112 | let i = 0
113 |
114 | // console.log(titles)
115 | titles.forEach(function () {
116 | expect(titles[i]).to.equal(pkgTitle)
117 | i++
118 | })
119 | done()
120 | })
121 |
122 | it('Readme is consistent with meta-data', function (done) {
123 | const pkg = fs.readFileSync('package.json', 'utf8')
124 | const parsed = JSON.parse(pkg)
125 |
126 | if (fs.existsSync('README.md')) {
127 | assert.fileContent('README.md', '# ' + parsed.name)
128 | assert.fileContent('README.md', parsed.version)
129 | assert.fileContent('README.md', parsed.description)
130 | } else {
131 | // skip checks for non existing files
132 | this.skip()
133 | }
134 | done()
135 | })
136 | }
137 |
--------------------------------------------------------------------------------
/generators/app/templates/img/icon.svg:
--------------------------------------------------------------------------------
1 |
2 |
124 |
--------------------------------------------------------------------------------
/generators/app/templates/img/existdb-web.svg:
--------------------------------------------------------------------------------
1 |
2 |
--------------------------------------------------------------------------------
/generators/app/templates/specs/mocha/app_spec.js:
--------------------------------------------------------------------------------
1 | /* eslint-disable no-var */
2 | 'use strict'
3 |
4 | const chai = require('chai')
5 | const chaiXml = require('chai-xml')
6 | const expect = require('chai').expect
7 | const fs = require('fs-extra')
8 | const glob = require('glob')
9 | const xmldoc = require('xmldoc')
10 | const assert = require('yeoman-assert')
11 |
12 | // this is not equivalent to using a real xml parser
13 | describe('file system checks', function () {
14 | describe('markup files are well-formed', function () {
15 | chai.use(chaiXml)
16 | it('*.html is xhtml', function (done) {
17 | glob('**/*.html', { ignore: 'node_modules/**' }, function (err, files) {
18 | if (err) throw err
19 | // console.log(files)
20 | files.forEach(function (html) {
21 | const xhtml = fs.readFileSync(html, 'utf8')
22 | const hParsed = new xmldoc.XmlDocument(xhtml).toString()
23 | expect(hParsed).xml.to.be.valid()
24 | })
25 | })
26 | done()
27 | })
28 |
29 | it('*.xml', function (done) {
30 | glob('**/*.xml', { ignore: 'node_modules/**' }, function (err, files) {
31 | if (err) throw err
32 | // console.log(files)
33 | files.forEach(function (xmls) {
34 | const xml = fs.readFileSync(xmls, 'utf8')
35 | const xParsed = new xmldoc.XmlDocument(xml).toString()
36 | expect(xParsed).xml.to.be.valid()
37 | })
38 | })
39 | done()
40 | })
41 |
42 | it('*.xconf', function (done) {
43 | glob('**/*.xconf', { ignore: 'node_modules/**' }, function (err, files) {
44 | if (err) throw err
45 | // console.log(files)
46 | files.forEach(function (xconfs) {
47 | const xconf = fs.readFileSync(xconfs, 'utf8')
48 | const cParsed = new xmldoc.XmlDocument(xconf).toString()
49 | expect(cParsed).xml.to.be.valid()
50 | })
51 | })
52 | done()
53 | })
54 | it('*.odd', function (done) {
55 | this.slow(1000)
56 | glob('**/*.odd', { ignore: 'node_modules/**' }, function (err, files) {
57 | if (err) throw err
58 | // console.log(files)
59 | files.forEach(function (odds) {
60 | const odd = fs.readFileSync(odds, 'utf8')
61 | const xParsed = new xmldoc.XmlDocument(odd).toString()
62 | expect(xParsed).xml.to.be.valid()
63 | })
64 | })
65 | done()
66 | })
67 | })
68 |
69 | describe('Consistent data in aux files', function () {
70 | it('should contain identical descriptions', function (done) {
71 | if (fs.existsSync('build.xml')) {
72 | const build = fs.readFileSync('build.xml', 'utf8')
73 | const parsed = new xmldoc.XmlDocument(build)
74 | var buildDesc = parsed.childNamed('description').val
75 | }
76 |
77 | if (fs.existsSync('package.json')) {
78 | const pkg = fs.readFileSync('package.json', 'utf8')
79 | const parsed = JSON.parse(pkg)
80 | var pkgDesc = parsed.description
81 | }
82 |
83 | if (fs.existsSync('repo.xml')) {
84 | const repo = fs.readFileSync('repo.xml', 'utf8')
85 | const parsed = new xmldoc.XmlDocument(repo)
86 | var repoDesc = parsed.childNamed('description').val
87 | }
88 |
89 | if (fs.existsSync('expath-pkg.xml')) {
90 | const exPkg = fs.readFileSync('expath-pkg.xml', 'utf8')
91 | const parsed = new xmldoc.XmlDocument(exPkg)
92 | var exPkgDesc = parsed.childNamed('title').val
93 | }
94 |
95 | const desc = [exPkgDesc, buildDesc, pkgDesc, repoDesc, buildDesc].filter(Boolean)
96 | let i = 0
97 | // console.log(desc)
98 | desc.forEach(function () {
99 | expect(desc[i]).to.equal(exPkgDesc)
100 | i++
101 | })
102 | done()
103 | })
104 |
105 | it('should contain identical versions', function (done) {
106 | if (fs.existsSync('package.json')) {
107 | const pkg = fs.readFileSync('package.json', 'utf8')
108 | const parsed = JSON.parse(pkg)
109 | var pkgVer = parsed.version
110 | }
111 |
112 | if (fs.existsSync('expath-pkg.xml')) {
113 | const exPkg = fs.readFileSync('expath-pkg.xml', 'utf8')
114 | const parsed = new xmldoc.XmlDocument(exPkg)
115 | var exPkgVer = parsed.attr.version
116 | }
117 |
118 | const vers = [exPkgVer, pkgVer].filter(Boolean)
119 | let i = 0
120 | // console.log(vers)
121 | vers.forEach(function () {
122 | expect(vers[i]).to.equal(exPkgVer)
123 | i++
124 | })
125 | done()
126 | })
127 |
128 | it('should contain identical licenses', function (done) {
129 | if (fs.existsSync('package.json')) {
130 | const pkg = fs.readFileSync('package.json', 'utf8')
131 | const parsed = JSON.parse(pkg)
132 | var pkgLic = parsed.license
133 | }
134 |
135 | if (fs.existsSync('repo.xml')) {
136 | const exRepo = fs.readFileSync('repo.xml', 'utf8')
137 | const parsed = new xmldoc.XmlDocument(exRepo)
138 | var repoLic = parsed.childNamed('license').val
139 | }
140 |
141 | const lic = [repoLic, pkgLic].filter(Boolean)
142 | let i = 0
143 | // console.log(lic)
144 | lic.forEach(function () {
145 | expect(lic[i]).to.equal(pkgLic)
146 | i++
147 | })
148 | done()
149 | })
150 |
151 | it('should contain identical titles', function (done) {
152 | if (fs.existsSync('build.xml')) {
153 | const build = fs.readFileSync('build.xml', 'utf8')
154 | const parsed = new xmldoc.XmlDocument(build)
155 | var buildTit = parsed.attr.name.toLowerCase()
156 | }
157 |
158 | if (fs.existsSync('package.json')) {
159 | const pkg = fs.readFileSync('package.json', 'utf8')
160 | const parsed = JSON.parse(pkg)
161 | var pkgTitle = parsed.name
162 | }
163 |
164 | if (fs.existsSync('templates/page.html')) {
165 | const page = fs.readFileSync('templates/page.html', 'utf8')
166 | const parsed = new xmldoc.XmlDocument(page)
167 | var pageTitle = parsed.descendantWithPath('head.title').val
168 | }
169 |
170 | const titles = [buildTit, pkgTitle, pageTitle].filter(Boolean)
171 | let i = 0
172 |
173 | // console.log(titles)
174 | titles.forEach(function () {
175 | expect(titles[i]).to.equal(pkgTitle)
176 | i++
177 | })
178 | done()
179 | })
180 |
181 | it('Readme should have latest meta-data', function (done) {
182 | const pkg = fs.readFileSync('package.json', 'utf8')
183 | const parsed = JSON.parse(pkg)
184 |
185 | if (fs.existsSync('README.md')) {
186 | assert.fileContent('README.md', '# ' + parsed.name)
187 | assert.fileContent('README.md', parsed.version)
188 | assert.fileContent('README.md', parsed.description)
189 | } else { this.skip() }
190 | done()
191 | })
192 | })
193 | })
194 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # generator-exist
2 |
3 | [![NPM version][npm-image]][npm-url]  [![semantic-release][sem-rel-img]][sem-rel-url] [![Codacy Badge][codacy-image]][codacy-url]
4 |
5 | > exist app scaffolding
6 |
7 | Let [Yeoman](http://yeoman.io) take care of creating directory and file scaffolds for different types of [exist-db](https://exist-db.org) EXpath packages. Just answer the prompts about what you want to build, and a sensible directory structure with fully configured readmes, buildfiles, etc will be set up for you.
8 |
9 | No more manual closing of html5 tags, inserting app names into config files, or wondering if you actually increase the version number in all the places.
10 |
11 | ## Installation
12 |
13 | First, install [Yeoman](http://yeoman.io) and generator-exist using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).
14 |
15 | ### From GitHub
16 |
17 | To install a pre-release version:
18 |
19 | ```bash
20 | npm i -g yo@4
21 | npm i -g git://github.com/eXist-db/generator-exist.git
22 | ```
23 |
24 | ### Official release
25 |
26 | To install a version published to npm:
27 |
28 | ```bash
29 | npm i -g yo@4
30 | npm i -g @existdb/generator-exist
31 | ```
32 |
33 | ### From Source
34 |
35 | Alternatively, if you have cloned this repo from GitHub. You can symlink your local clone into your global node environment. This is particularly useful during development. From inside the folder with the cloned repo:
36 |
37 | ```bash
38 | npm install -g yo@4
39 | npm i
40 | npm link
41 | ```
42 |
43 | In case the above doesn't work use:
44 |
45 | ```shell
46 | yo PATH/TO/generator-exist
47 | ```
48 |
49 | from inside the directory where you want to run the local copy of the generator.
50 |
51 | ## Using the Generator
52 |
53 | Then generate your new project: Create a new project folder and navigate to it in you CLI.
54 |
55 | ```bash
56 | mkdir myApp
57 | cd myApp
58 | ```
59 |
60 | Then run the generator:
61 | - If you installed from a fork or from GitHub.
62 |
63 | ```bash
64 | yo exist
65 | ```
66 |
67 | - If you installed from npm or from a clone of this repo.
68 |
69 | ```bash
70 | yo @existdb/exist
71 | ```
72 |
73 | If you are unsure about which command is right simply run `yo` to see the list of currently installed generators.
74 |
75 | [](https://asciinema.org/a/MqB6TyzdyBJImItHLsfC99Ufj)
76 |
77 | Note: If you told yeoman to use Github for your new project, your project will start initialized with all files added, out of the box.
78 |
79 | Some of the answers, such as username will be stored after the initial run of the generator. So you only have to type them once.
80 |
81 | ### The Scaffold
82 |
83 | The generator creates sensible default structures for `expath` packages for exist-db, which includes default folders for `xquery` code, meta-data files, `html`, etc. modelled on eXide's package generation scripts. In addition there are optional features such as `dockerfile`, CI scripts, github templates, secure area, … depending on the options selected by the user. The idea is that if you select e.g. to include a secure area in your application from the start, the files will contain the necessary parts, after the intial run of the generator. Saving you from having to manualy add sections, or repeatedly providing the same information over and over agian. There are 4 basic app types.
84 |
85 | - exist-design
86 | - plain
87 | - empty
88 | - xquery library
89 |
90 | Since if would be impractical to go through all possible combinations of option here are some sample scaffolds created with the generator.
91 |
92 | #### exist-design (with. secure area selected)
93 |
94 | ```shell
95 | ├── Dockerfile
96 | ├── LICENSE
97 | ├── README.md
98 | ├── admin
99 | │ ├── controller.xq
100 | │ ├── index.html
101 | │ └── security.html
102 | ├── build
103 | │ ├── exide_demo-1.0.0-dev.xar
104 | │ └── exide_demo-1.0.0.xar
105 | ├── build.xml
106 | ├── collection.xconf
107 | ├── controller.xq
108 | ├── cypress.config.js
109 | ├── error-page.html
110 | ├── expath-pkg.xml
111 | ├── icon.png
112 | ├── index.html
113 | ├── modules
114 | │ ├── app.xqm
115 | │ ├── config.xqm
116 | │ └── view.xql
117 | ├── node_modules
118 | │ └── pruned …
119 | ├── package-lock.json
120 | ├── package.json
121 | ├── post-install.xq
122 | ├── pre-install.xq
123 | ├── repo.xml
124 | ├── reports
125 | │ ├── screenshots
126 | │ └── videos
127 | ├── resources
128 | │ ├── css
129 | │ │ └── style.css
130 | │ └── images
131 | │ ├── bgmenu.gif
132 | │ ├── bgmenuhi.gif
133 | │ ├── body-base.gif
134 | │ ├── body.gif
135 | │ ├── bold.gif
136 | │ ├── code.gif
137 | │ ├── delete-icon.png
138 | │ ├── existdb.png
139 | │ ├── glyphicons-halflings.png
140 | │ ├── grey-box-bot.gif
141 | │ ├── grey-box-rpt.gif
142 | │ ├── grey-box-top.gif
143 | │ ├── header.gif
144 | │ ├── horizontal.gif
145 | │ ├── italic.gif
146 | │ ├── nav-dropdown.gif
147 | │ ├── nav-dropdown.png
148 | │ ├── nav.gif
149 | │ └── page-edit-icon.png
150 | ├── templates
151 | │ ├── login-panel.html
152 | │ └── page.html
153 | └── test
154 | ├── cypress
155 | │ ├── fixtures
156 | │ │ └── example.json
157 | │ ├── e2e
158 | │ │ ├── landing.cy.js
159 | │ │ ├── login-fail_spec.js
160 | │ │ └── login-ok_spec.js
161 | │ └── support
162 | │ ├── commands.js
163 | │ └── e2e.js
164 | ├── mocha
165 | │ ├── app_spec.js
166 | │ └── rest_spec.js
167 | └── xqs
168 | ├── test-runner.xq
169 | ├── test-suite.xqm
170 | └── xqSuite.js
171 | ```
172 |
173 | #### plain (with most options)
174 |
175 | ```shell
176 | ├── LICENSE
177 | ├── README.md
178 | ├── build
179 | │ ├── plain_demo-1.0.0-dev.xar
180 | │ └── plain_demo-1.0.0.xar
181 | ├── build.xml
182 | ├── collection.xconf
183 | ├── controller.xq
184 | ├── cypress.config.js
185 | ├── error-page.html
186 | ├── expath-pkg.xml
187 | ├── icon.png
188 | ├── index.html
189 | ├── modules
190 | │ ├── app.xqm
191 | │ ├── config.xqm
192 | │ └── view.xql
193 | ├── node_modules
194 | │ └── pruned …
195 | ├── package-lock.json
196 | ├── package.json
197 | ├── post-install.xq
198 | ├── pre-install.xq
199 | ├── repo.xml
200 | ├── reports
201 | │ ├── screenshots
202 | │ └── videos
203 | ├── resources
204 | │ └── css
205 | │ └── style.css
206 | ├── templates
207 | │ └── page.html
208 | └── test
209 | ├── cypress
210 | │ ├── fixtures
211 | │ │ └── example.json
212 | │ ├── e2e
213 | │ │ └── landing.cy.js
214 | │ └── support
215 | │ ├── commands.js
216 | │ └── e2e.js
217 | ├── mocha
218 | │ ├── app_spec.js
219 | │ └── rest_spec.js
220 | └── xqs
221 | ├── test-runner.xq
222 | ├── test-suite.xqm
223 | └── xqSuite.js
224 | ```
225 |
226 | #### empty (without extras)
227 |
228 | ```shell
229 | ├── LICENSE
230 | ├── build
231 | │ ├── empty_demo-1.0.0-dev.xar
232 | │ └── empty_demo-1.0.0.xar
233 | ├── build.xml
234 | ├── cypress.config.js
235 | ├── expath-pkg.xml
236 | ├── icon.png
237 | ├── node_modules
238 | │ └── pruned …
239 | ├── package-lock.json
240 | ├── package.json
241 | ├── repo.xml
242 | ├── reports
243 | │ ├── screenshots
244 | │ └── videos
245 | └── test
246 | ├── cypress
247 | │ ├── fixtures
248 | │ │ └── example.json
249 | │ ├── e2e
250 | │ │ └── landing.cy.js
251 | │ └── support
252 | │ ├── commands.js
253 | │ └── e2e.js
254 | ├── mocha
255 | │ ├── app_spec.js
256 | │ └── rest_spec.js
257 | └── xqs
258 | ├── test-runner.xq
259 | ├── test-suite.xqm
260 | └── xqSuite.js
261 | ```
262 |
263 | #### xquery library
264 |
265 | ```shell
266 | ├── LICENSE
267 | ├── README.md
268 | ├── build
269 | │ ├── lib_demo-1.0.0-dev.xar
270 | │ └── lib_demo-1.0.0.xar
271 | ├── build.xml
272 | ├── expath-pkg.xml
273 | ├── node_modules
274 | │ └── pruned …
275 | ├── package-lock.json
276 | ├── package.json
277 | ├── post-install.xq
278 | ├── pre-install.xq
279 | ├── repo.xml
280 | └── test
281 | ├── mocha
282 | │ ├── app_spec.js
283 | │ └── rest_spec.js
284 | └── xqs
285 | ├── test-runner.xq
286 | ├── test-suite.xqm
287 | └── xqSuite.js
288 | ```
289 |
290 | ## Development
291 |
292 | If you want to contribute another template or option, please take a look at the issue tracker. Pull request are always welcome. This generator uses `mocha` for unit testing. Please make sure to add tests when opening a PR.
293 |
294 | This application uses [Angular Commit Message Conventions](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines) to determine semantic versioning of releases, please adhere to these conventions, like so:
295 |
296 | | Commit message | Release type |
297 | |-----------------|--------------|
298 | | `fix(pencil): stop graphite breaking when too much pressure applied` | Patch Release |
299 | | `feat(pencil): add 'graphiteWidth' option` | ~~Minor~~ Feature Release |
300 | | `perf(pencil): remove graphiteWidth option``BREAKING CHANGE: The graphiteWidth option has been removed.`
`The default graphite width of 10mm is always used for performance reasons.` | ~~Major~~ Breaking Release | 301 | 302 | ## License 303 | 304 | MIT © [Duncan Paterson](https://github.com/duncdrum) 305 | 306 | [npm-image]: https://badge.fury.io/js/%40existdb%2Fgenerator-exist.svg 307 | [npm-url]: https://www.npmjs.com/package/@existdb/generator-exist 308 | [sem-rel-img]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg 309 | [sem-rel-url]: https://github.com/semantic-release/semantic-release 310 | [codacy-image]: https://api.codacy.com/project/badge/Grade/340ad1d77d624bcf8edf036c181d4459 311 | [codacy-url]: https://app.codacy.com/gh/eXist-db/generator-exist?utm_source=github.com&utm_medium=referral&utm_content=eXist-db/generator-exist&utm_campaign=Badge_Grade_Settings 312 | -------------------------------------------------------------------------------- /generators/app/templates/img/powered-by.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | -------------------------------------------------------------------------------- /generators/app/templates/styles/exist-2.2.css: -------------------------------------------------------------------------------- 1 | @charset "utf-8"; 2 | 3 | @import url("bootstrap.min.css"); 4 | 5 | /* ---------------------------------------- FONTS ---------------------------------------- */ 6 | @font-face { 7 | font-family: "Quicksand Book"; 8 | src: url("//db.onlinewebfonts.com/t/ac220d2014e7b9231118917e7d2449b8.eot"); 9 | src: url("//db.onlinewebfonts.com/t/ac220d2014e7b9231118917e7d2449b8.eot?#iefix") format("embedded-opentype"), url("//db.onlinewebfonts.com/t/ac220d2014e7b9231118917e7d2449b8.woff2") format("woff2"), url("//db.onlinewebfonts.com/t/ac220d2014e7b9231118917e7d2449b8.woff") format("woff"), url("//db.onlinewebfonts.com/t/ac220d2014e7b9231118917e7d2449b8.ttf") format("truetype"), url("//db.onlinewebfonts.com/t/ac220d2014e7b9231118917e7d2449b8.svg#Quicksand Book") format("svg"); 10 | font-weight: normal; 11 | font-style: normal; 12 | } 13 | 14 | /* ---------------------------------------- VARIABLES ---------------------------------------- */ 15 | 16 | /* ------------------------------------ Documentation styles ---------------------------------- */ 17 | .content { 18 | font: 16px/24px Georgia, "Times New Roman", Times, serif; 19 | color: #555; 20 | } 21 | 22 | .content section { 23 | clear: both; 24 | } 25 | 26 | .content h1 { 27 | font-family: QuicksandBook, Arial, Helvetica, sans-serif; 28 | font-size: 1.75em; 29 | font-weight: bold; 30 | margin: 0.8em 0 0; 31 | } 32 | 33 | .content h2 { 34 | color: #0083cb; 35 | font-family: QuicksandBook, Arial, Helvetica, sans-serif; 36 | font-size: 1.33em; 37 | font-weight: bold; 38 | margin: 0.3em 0 0; 39 | padding: 10px 0 5px; 40 | } 41 | 42 | .content h3 { 43 | font-size: 1em; 44 | font-weight: bold; 45 | } 46 | 47 | .content table { 48 | margin: 0.5em 1em; 49 | } 50 | 51 | .content td, 52 | .entry th { 53 | padding: 6px 4px; 54 | } 55 | 56 | .content .strong { 57 | font-weight: bold; 58 | } 59 | 60 | .content em { 61 | font-style: italic; 62 | } 63 | 64 | .content code { 65 | font-size: 0.92em; 66 | background-color: transparent; 67 | border: 0; 68 | color: inherit; 69 | } 70 | 71 | .content .option { 72 | font-weight: bold; 73 | font-style: italic; 74 | } 75 | 76 | .content blockquote { 77 | font-style: italic; 78 | text-align: justify; 79 | padding: 10px 15px 0; 80 | border: 1px solid #abe1ff; 81 | background: #fff; 82 | margin: 5px 0 10px; 83 | } 84 | 85 | .content blockquote h3 { 86 | padding: 0; 87 | border: 0; 88 | margin: 0; 89 | font-size: 12px; 90 | color: #0083cb; 91 | } 92 | 93 | .content blockquote p { 94 | padding: 0 0 10px; 95 | } 96 | 97 | .content ul, 98 | .content ol { 99 | margin: 0 1.5em; 100 | } 101 | 102 | .content ul li { 103 | list-style: disc; 104 | margin-bottom: 0.4em; 105 | } 106 | 107 | .content ol li { 108 | list-style: decimal; 109 | margin-bottom: 0.4em; 110 | } 111 | 112 | .content dl.wide dt { 113 | width: 260px; 114 | word-wrap: break-word; 115 | } 116 | 117 | .content dl.wide dd { 118 | margin-left: 270px; 119 | } 120 | 121 | #content .content dt { 122 | font-weight: bold; 123 | word-wrap: break-word; 124 | } 125 | 126 | .content img { 127 | margin: 8px auto; 128 | max-width: 100%; 129 | } 130 | 131 | .content td img { 132 | max-width: inherit; 133 | } 134 | 135 | .content figure { 136 | margin: 0 1em 1em; 137 | } 138 | 139 | .content figure.float-left { 140 | float: left; 141 | margin-right: 1em; 142 | width: 50%; 143 | display: inline-block; 144 | } 145 | 146 | .content figure.float-right { 147 | float: right; 148 | margin-left: 1em; 149 | width: 50%; 150 | display: inline-block; 151 | } 152 | 153 | .content .img-float-left { 154 | float: left; 155 | margin-right: 10px; 156 | } 157 | 158 | .content .img-float-right { 159 | float: right; 160 | width: inherit; 161 | margin-left: 10px; 162 | } 163 | 164 | .content pre.prettyprint { 165 | padding: 10px 16px; 166 | margin-bottom: 0.85em; 167 | } 168 | 169 | .content .guimenuitem { 170 | background: #fef8c4; 171 | } 172 | 173 | .content .example { 174 | margin: 0.25em 0 0.25em 1em; 175 | padding: 10px; 176 | border: 1px solid #707070; 177 | } 178 | 179 | /* stylelint-disable-next-line no-descending-specificity */ 180 | .content .dl-horizontal dd { 181 | margin-left: 150px; 182 | } 183 | 184 | /* stylelint-disable-next-line no-descending-specificity */ 185 | .content .dl-horizontal dt { 186 | text-align: left; 187 | width: 140px; 188 | word-wrap: break-word; 189 | } 190 | 191 | /* ---------------------------------------- LAYOUT ---------------------------------------- */ 192 | body { 193 | color: #222; 194 | background: url("../images/body.gif") repeat 50% 100%; 195 | } 196 | 197 | .grey-bot { 198 | /* background: url("../images/body-base.gif") repeat-x 50% 100%; */ 199 | padding-bottom: 2em; 200 | } 201 | 202 | #container { 203 | margin: 0 auto 30px; 204 | } 205 | 206 | @media (width >= 767px) { 207 | #grey-top { 208 | background: #f3f3f3; 209 | height: 100%; 210 | position: relative; 211 | } 212 | 213 | #header { 214 | background: #f3f3f3 url("../images/header.gif") top right no-repeat; 215 | width: 100%; 216 | } 217 | 218 | #header a#logo { 219 | background: url("../images/existdb.png") center left no-repeat; 220 | display: block; 221 | width: 220px; 222 | height: 100px; 223 | text-indent: -999em; 224 | outline: 0; 225 | margin: 10px 0; 226 | } 227 | } 228 | 229 | @media (width <= 767px) { 230 | #grey-top { 231 | background: #f3f3f3; 232 | height: 100%; 233 | } 234 | 235 | #header { 236 | display: none; 237 | } 238 | } 239 | 240 | .navbar .container { 241 | padding-left: 0; 242 | padding-right: 0; 243 | } 244 | 245 | #content { 246 | min-height: 600px; 247 | } 248 | 249 | #footer { 250 | display: flex; 251 | align-items: center; 252 | justify-content: space-between; 253 | height: 50px; 254 | color: #222; 255 | background-color: #212529; 256 | padding-right: 1rem; 257 | padding-left: 1rem; 258 | } 259 | 260 | #footer .container { 261 | padding-left: 0; 262 | padding-right: 0; 263 | } 264 | 265 | #footer ul { 266 | padding: 0; 267 | margin: 0; 268 | } 269 | 270 | #footer ul li { 271 | display: inline-block; 272 | } 273 | 274 | #footer ul li a { 275 | padding: 2px 4px; 276 | color: #0083cb; 277 | } 278 | 279 | #footer ul li a:hover { 280 | background: #333; 281 | } 282 | 283 | #copyright { 284 | text-align: right; 285 | } 286 | 287 | #copyright p { 288 | margin: 0; 289 | color: #f3f3f3; 290 | } 291 | 292 | #poweredby { 293 | width: 120px; 294 | height: 56px; 295 | margin-bottom: 10px; 296 | display: inline-block; 297 | background: url("../images/powered-by.svg") no-repeat 50%; 298 | background-size: 100% 100%; 299 | } 300 | 301 | /* ---------------------------------------- NAVBAR ---------------------------------------- */ 302 | .navbar-default { 303 | height: 60px; 304 | background: transparent; 305 | border: 0; 306 | box-shadow: none; 307 | } 308 | 309 | /* stylelint-disable-next-line no-descending-specificity */ 310 | .navbar .nav > li > a { 311 | color: #fff; 312 | text-align: center; 313 | font: 1.2em/1em QuicksandBook, Arial, Helvetica, sans-serif; 314 | padding: 18px 0; 315 | text-shadow: none; 316 | } 317 | 318 | /* stylelint-disable-next-line no-descending-specificity */ 319 | .navbar .nav > li > a:hover { 320 | color: #ffcb05; 321 | } 322 | 323 | .navbar .nav > li > .dropdown-menu::before, 324 | .navbar .nav > li > .dropdown-menu::after { 325 | display: none; 326 | } 327 | 328 | @media (width <= 767px) { 329 | .navbar-default { 330 | height: auto; 331 | margin-bottom: 20px; 332 | background: url("../images/existdb-web.svg") center left no-repeat; 333 | border-bottom: 10px solid #2e2e2e; 334 | } 335 | 336 | .navbar-collapse.in { 337 | z-index: 1000; 338 | position: absolute; 339 | left: 10px; 340 | right: 10px; 341 | background-color: #fafafa; 342 | background-image: linear-gradient(to bottom, #fff, #f2f2f2); 343 | background-repeat: repeat-x; 344 | border: 1px solid #d4d4d4; 345 | border-radius: 4px; 346 | box-shadow: 0 1px 4px rgb(0 0 0 / 10%); 347 | } 348 | 349 | .navbar .nav > li > a { 350 | padding: 9px 15px; 351 | color: #777; 352 | } 353 | 354 | #sidebar { 355 | display: none; 356 | } 357 | 358 | #about { 359 | display: none; 360 | } 361 | } 362 | 363 | @media (width >= 767px) { 364 | .navbar .nav li.dropdown.open > .dropdown-toggle { 365 | background-color: transparent; 366 | color: #ffcb05; 367 | } 368 | 369 | .navbar-nav > li > .dropdown-menu { 370 | border-top-right-radius: 10px; 371 | border-top-left-radius: 10px; 372 | } 373 | 374 | .nav > li { 375 | height: 52px; 376 | min-width: 150px; 377 | vertical-align: middle; 378 | background: url("../images/bgmenu.gif") no-repeat top center; 379 | } 380 | 381 | .nav .open { 382 | background: url("../images/bgmenuhi.gif") no-repeat top center; 383 | } 384 | 385 | /* stylelint-disable-next-line no-descending-specificity */ 386 | .dropdown-menu { 387 | background: #0083cb; 388 | border-radius: 10px; 389 | color: #fff; 390 | margin: 0; 391 | border: 0; 392 | } 393 | 394 | .dropdown-menu > li > a { 395 | color: #fff; 396 | font-size: 0.92em; 397 | text-align: center; 398 | } 399 | 400 | .dropdown-menu > li > a:hover { 401 | background: #222; 402 | color: #ffcb05; 403 | } 404 | } 405 | 406 | .navbar li#about { 407 | display: none; 408 | } 409 | 410 | @media (width >= 992px) { 411 | .navbar li#about { 412 | display: inline-block; 413 | } 414 | } 415 | 416 | .navbar-search input { 417 | margin-top: 4px; 418 | } 419 | 420 | .navbar-right, 421 | .navbar-right .search-query { 422 | float: right; 423 | } 424 | 425 | #navigation .actions { 426 | float: right; 427 | margin: 8px 0; 428 | } 429 | 430 | /* ---------------------------------------- GENERAL STYLES ---------------------------------------- */ 431 | /* stylelint-disable-next-line no-descending-specificity */ 432 | h1 { 433 | font-size: 1.75em; 434 | font-weight: bold; 435 | padding: 0 0 5px; 436 | font-family: QuicksandBook, Arial, Helvetica, sans-serif; 437 | color: #0083cb; 438 | } 439 | 440 | /* stylelint-disable-next-line no-descending-specificity */ 441 | h2 { 442 | font-size: 1.2em; 443 | padding: 10px 0; 444 | font-weight: bold; 445 | font-family: QuicksandBook, Arial, Helvetica, sans-serif; 446 | letter-spacing: 1px; 447 | } 448 | 449 | /* stylelint-disable-next-line no-descending-specificity */ 450 | h3 { 451 | font-size: 1.2em; 452 | padding: 10px 0 5px; 453 | margin: 0 0 5px; 454 | font-weight: bold; 455 | } 456 | 457 | h4 { 458 | font-size: 1em; 459 | padding: 10px 0; 460 | font-style: italic; 461 | font-weight: normal; 462 | } 463 | 464 | h5 { 465 | font-size: 1em; 466 | padding: 10px 0; 467 | font-weight: normal; 468 | } 469 | 470 | /* stylelint-disable-next-line no-descending-specificity */ 471 | a { 472 | color: #0083cb; 473 | text-decoration: none; 474 | } 475 | 476 | /* stylelint-disable-next-line no-descending-specificity */ 477 | a:hover { 478 | color: #ffcb05; 479 | } 480 | 481 | .clear { 482 | clear: both; 483 | } 484 | 485 | .imgborder { 486 | border: 1px solid #ccc; 487 | padding: 3px; 488 | margin: 3px; 489 | } 490 | 491 | .code { 492 | font: 14px/20px "Ubuntu Mono", Menlo, Consolas, "Courier New", Courier, monospace; 493 | background: #444 url("../images/noise.png"); 494 | padding: 8.5px; 495 | width: 100%; 496 | margin: 18px 0; 497 | overflow-x: auto; 498 | } 499 | 500 | /* stylelint-disable-next-line no-descending-specificity */ 501 | .code a { 502 | padding: 4px; 503 | border: 1px solid #c7c7c7; 504 | } 505 | 506 | /* stylelint-disable-next-line no-descending-specificity */ 507 | figure img { 508 | display: block; 509 | } 510 | 511 | figcaption { 512 | font-size: 0.85em; 513 | text-align: center; 514 | } 515 | 516 | form { 517 | margin: 20px 0; 518 | } 519 | 520 | input:required:invalid, 521 | fieldset input:focus:invalid { 522 | background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAMAAAAoLQ9TAAAABGdBTUEAALGPC/xhBQAAAwBQTFRFvy8atzQfvzEWvDEXuzEZujIbuzEdvzAZvTAbvjAcvDAdvTIdrzcnszQisTQltTIitzQgtjUhsTssuDEguTIgujQgvD0nqkAutkM2tko5u0c4ul5Qwi8Zwy8awC8bxS4ZxiwcwTEZwDEawTAbwDAcwDEdwzIexjAaxTIZyDAbyjAcyTMdzzEazjEbzzAe0TIb0zMd0zQb1DIc1TQb1TQc1jYc1jYd1zgc2jQb2DUd2TQe2zYc3DUc3jgbxzYh1j4m4DYZ5jcZ5zYb5jYc5Dga5Dgd6TYf7Dcd7zce6zgZ6Dga7Dse7j0e8jcd8zYe8DYf8Tkb8zgd8joc8Toe8Dwf9jkb9Doc4zki5j4n6T0h7jghxkIsx0MuzUUt00Ep2kIt1kg13VE97EEm6Ugu4E064FQ98UIn8kMo80Mp90Ep9UMq3VpD3F1KxmdZw2haw2hbxGhaxGhbwW1hwHdpxndp2H1u4FlH4mVT63Jb9mZO92ZP9WhN+GVN+2RQ4HVlvIB13odx4oNv5IZy54h29o55+4p6+4t7+Y14/Yl6yI+Ew5aPxpuTxqCXyaWe3baq5JSI65CB7pKC9JKK66WX6rGb57ut6rOo7res5b6767yz+62i+q6j/qug/a2i87Cl9rGh9rOq8b+19L+z+L2x48G48MO68sa/8ci96tDK8sbB/crE/crF/srG+87K/svJ/M3I99bR99fS+9bV+93Z8ebe+OHd+eXd/OTd8ebh9e3m9u3r+ufl/eXj/ubg/ufh/efi/ufj/uXk+ujj++nl+uvl+urm/ejh++7q+u/r+vDu+vLt/PDv/fPv/vTy+/j3/Pj0//j2//n3/vv0/vr1/vv2/fr3+/39+/79/vr4/vv6/v37/f77/v38/v39/f78/f79AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAOe7jtQAAABl0RVh0U29mdHdhcmUAUGFpbnQuTkVUIHYzLjUuODc7gF0AAAEbSURBVChTARAB7/4A1rmNdG5xb3BwcG5tc4y43QC6isjT0NDR1djY1NLTzIu4AImVvL/Gxsa+vr7BwL29qX8AGp6rqrPDsqyurbu8r6ujFwALg5ybotjLoJqw37GfnZEOAAlsiIaEp9qmk8/FkoWHdw8AIj98eX14tc601ZB7eXpfEQAjNGJoaWd+z9uWY2pmZjYQACEzQlJUVWvK149MVlNKORUAIzFDSFBYodnJx3ZRTkEzAQAkLUBHS4HYmXXVpVhPPS8NAAInNUVkwsRlWZfVgEQ6KA8AFh0uN5TNgk1aYba3YCwHDAByAyArW11XRklGXlw+HwAbAKgSBRwpMDo8OzgyKh4EFaQA3pgZEwYIJCYmJQgKFBiO3JMVcr8Z+l4TAAAAAElFTkSuQmCC"); 523 | background-position: right; 524 | background-repeat: no-repeat; 525 | box-shadow: none; 526 | } 527 | 528 | /* stylelint-disable-next-line no-descending-specificity */ 529 | input:required:valid { 530 | background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAMAAAAoLQ9TAAAABGdBTUEAALGPC/xhBQAAAwBQTFRFU6E8UqA9U6A+U6A/VaA+VqA/V6I+WKM7WKA/WaI8WqI9WaQ+XaQ6XKQ8Zac9Z6w2Y6k6Z6w6aKo8bK45bq46d7M5fbU6fLY6frY8f7k5U59AU59BVJ9AU6BAUaBBVaBAVKFBVKBCX6JNXqZOYalRZqhSa6pfbapcb6pdbKpfcalbc6pbdKpccqdieKxofK9vf69xgLc5gLY9hrw3gLg4gLg5g7o4g7o5hLs4hLo5hLo6hbs8iL46jb1Ti7d+kMM0k8UwksU0lsQ2nskwnsgynsgzpswvqc8voMc8oMkyocozo8wzpMowpcs7rM8wrtEwrtA1ss8+sNIvtNMtttUuttYtt9Yvu9cuutgrvdkqvdksvNgtvdkvv9svsNM1ttI2utY0vdkxvtowvtsyv9ozvtg1vdwzv9k4vtg6lMRTrs5HtNNMps53rNN+wdhJwtlNw9hWyNxVx9tszd9iyuJPxeBRxuJQyuFTyuJQyuNRyuBW0eNz1OR91eR/1ut31+p41+p62Ot22Op42Op6lb6InsKRnsSUocKVrseir82mr82nrc6kr82oscWltMeusMiisM2msMyoss6r2+mNw+KgyueiyeSy1eq34/Gd4/Ce4/Cf4vKe4+2l5e6j4Oys5u+44/Cg5fCr5vGt6PC16fO26vO87ve/7fi87vi97vi/0uHO2+jW2unX6/TD7vfA7/jH8PbB8vbH8PbK9/rT9vrY9vrc9/vd+/3c+P7c+f7d+P7e6PDk6fTm6/Xo7/fr9ffh+vvl+P3g+f3h+fzi/f7m+/zq/f7s8vrx+f3x+v7w/f7x/v7y/v/z/v/0/v73/v75/v38/f7+AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAnz0KZQAAABl0RVh0U29mdHdhcmUAUGFpbnQuTkVUIHYzLjUuODc7gF0AAAEbSURBVChTARAB7/4A0aqNkImJioyMjImLkY6r0QCsj8nLzMzMzMzMzczLyIi7AD6Xwbe5urq6urq4wsHAlocAIpWwp6apqa6urqiyw6+ULgAhbZibmpqZmqCgorakmWwmAARpf4B/f4OBg5O0oYJ+PScACjt2eXR4eHhzsaN6d3UyKgALOF5mYl1jZ5yzb2JkUDUsAAs3RmBxZVx7xnxhWVZMMSsABhdKcsSdcLWyaFpYUkQVKAAgFEJrn8q/zn1aW1RHPxEpAB8MNklRns/FbldVT0U0BykAJQISPEVqraVfU05DMw4AMACFGwUPOkBITUtEQRkQHBqSAL0tHQEMFBg5NxYTDQEeL8cA0LyEIx4DCAoJHxwdJIa+0S+PbKi6PdJ5AAAAAElFTkSuQmCC"); 531 | background-position: right; 532 | background-repeat: no-repeat; 533 | box-shadow: none; 534 | } 535 | 536 | .error { 537 | font-family: "Ubuntu Mono", Menlo, Consolas, "Courier New", Courier, monospace; 538 | font-size: 112%; 539 | white-space: pre-wrap; 540 | width: 100%; 541 | overflow: auto; 542 | } 543 | 544 | .warning { 545 | border: 1px dotted red; 546 | padding: 0 10px; 547 | margin: 10px 0; 548 | } 549 | 550 | .hi { 551 | background: #ffed3d; 552 | } 553 | 554 | .hidden { 555 | display: none; 556 | } 557 | -------------------------------------------------------------------------------- /generators/app/index.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | const Generator = require('yeoman-generator') 3 | const chalk = require('chalk') 4 | const yosay = require('yosay') 5 | const prettyData = require('gulp-pretty-data') 6 | const stripBom = require('gulp-stripbom') 7 | 8 | module.exports = class extends Generator { 9 | initializing () { 10 | this.props = {} 11 | } 12 | 13 | prompting () { 14 | // Have Yeoman greet the user. 15 | this.log(yosay( 16 | 'Welcome to the stupendous ' + chalk.blue('exist-app') + ' generator!' 17 | )) 18 | 19 | const prompts = [{ 20 | type: 'input', 21 | name: 'title', 22 | message: 'What would you like to call your exist-db application?', 23 | default: this.appname.toLowerCase(), // Defaults to current folder name 24 | validate: value => { 25 | const invalid = value.includes(' ') 26 | if (invalid) { 27 | return 'Please avoid spaces' 28 | } 29 | return true 30 | }, 31 | required: true 32 | }, 33 | { 34 | type: 'input', 35 | name: 'short', 36 | message: 'How should I abbreviate that?', 37 | default: response => { 38 | const short = response.title 39 | 40 | if (short.length > 6) { 41 | return short.substring(0, 6) 42 | } 43 | return short 44 | }, 45 | required: true 46 | }, 47 | { 48 | type: 'input', 49 | name: 'desc', 50 | message: 'Please add a short description?', 51 | default: response => { return 'My amazing ' + response.title + ' application' }, 52 | required: true 53 | }, 54 | { 55 | type: 'list', 56 | name: 'apptype', 57 | message: 'Pick an app template:', 58 | default: 0, // Aka 'exist-design' 59 | choices: [{ 60 | name: 'exist-design', 61 | value: ['exist-design', 'application'] 62 | }, 63 | { 64 | name: 'plain', 65 | value: ['plain', 'application'] 66 | }, 67 | { 68 | name: 'empty', 69 | value: ['empty', 'application'] 70 | }, 71 | { 72 | name: 'library', 73 | value: ['empty', 'library'] 74 | }] 75 | }, 76 | // TODO: [yo] Make these options meaningful 77 | // { 78 | // type: 'checkbox', 79 | // choices: ['ant', 'gulp', 'maven', 'gradle'], 80 | // name: 'builder', 81 | // message: 'How would you like to build your app?', 82 | // default: 'ant' 83 | // }, 84 | { 85 | when: response => { 86 | return response.apptype[1] === 'application' 87 | }, 88 | type: 'confirm', 89 | name: 'mysec', 90 | message: 'should your app have a secure area?', 91 | default: false, 92 | store: true 93 | }, 94 | 95 | // Path related 96 | { 97 | when: response => { 98 | return response.apptype[1] === 'application' 99 | }, 100 | type: 'input', 101 | name: 'defcoll', 102 | message: 'Will your application be deployed in the apps collection? (hit return for yes)', 103 | default: 'apps', 104 | required: true 105 | }, 106 | { 107 | type: 'input', 108 | name: 'defuri', 109 | message: 'What should your module namespace begin with?', 110 | default: 'http://exist-db.org', 111 | validate: value => { 112 | if (encodeURI(value) === value) { 113 | return true 114 | } 115 | return 'Please select a valid URI' 116 | } 117 | }, 118 | { 119 | type: 'input', 120 | name: 'version', 121 | message: 'Pick a version number?', 122 | default: '1.0.0' 123 | }, 124 | { 125 | type: 'list', 126 | choices: ['alpha', 'beta', 'stable', 'SNAPSHOT'], 127 | name: 'status', 128 | message: 'Pick the release status', 129 | default: 'SNAPSHOT' 130 | }, 131 | // TODO: [teipup] autoanswer pre,post, setperm, (license?) see# 132 | { 133 | type: 'confirm', 134 | name: 'pre', 135 | message: 'Would you like to generate a pre-install script?', 136 | default: true 137 | }, 138 | { 139 | type: 'confirm', 140 | name: 'post', 141 | message: 'Would you like to generate a post-install script?', 142 | default: 'post-install.xq' 143 | }, 144 | // TODO multi authors see #41 145 | { 146 | type: 'input', 147 | name: 'author', 148 | message: 'Who is the author of the application?', 149 | default: this.appauthor, 150 | store: true 151 | }, 152 | { 153 | type: 'input', 154 | name: 'email', 155 | message: 'What is your email address?', 156 | default: this.appemail, 157 | validate: value => { 158 | const pass = value.match(/^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i) 159 | if (pass) { 160 | return true 161 | } 162 | return 'Please provide a valid email address' 163 | }, 164 | store: true 165 | }, 166 | { 167 | type: 'input', 168 | name: 'website', 169 | message: 'What is the author\'s website?', 170 | default: 'http://exist-db.org', 171 | store: true 172 | }, 173 | { 174 | type: 'list', 175 | name: 'license', 176 | message: 'Please pick a license', 177 | default: 2, // Aka AGPL-3.0 178 | choices: [{ 179 | name: 'Apache-2.0', 180 | value: ['Apache-2.0', 'Apache%202.0', 'https://opensource.org/licenses/Apache-2.0'] 181 | }, { 182 | name: 'MIT', 183 | value: ['MIT', 'MIT', 'https://opensource.org/licenses/MIT'] 184 | }, { 185 | name: 'AGPL-3.0', 186 | value: ['AGPL-3.0', 'AGPL%20v3', 'https://www.gnu.org/licenses/agpl-3.0'] 187 | }, { 188 | name: 'LGPL-3.0', 189 | value: ['LGPL-3.0', 'LGPL%20v3', 'https://www.gnu.org/licenses/lgpl-3.0'] 190 | }, { 191 | name: 'GPL-3.0', 192 | value: ['GPL-3.0', 'GPL%20v3', 'https://www.gnu.org/licenses/gpl-3.0'] 193 | }, { 194 | name: 'unlicense', 195 | value: ['unlicense', 'unlicense', 'https://choosealicense.com/licenses/unlicense/'] 196 | }] 197 | }, 198 | // See #601 199 | { 200 | type: 'confirm', 201 | name: 'github', 202 | message: 'Will you host the code on GitHub?', 203 | default: true, 204 | store: true 205 | }, 206 | { 207 | when: response => { 208 | return response.github 209 | }, 210 | type: 'input', 211 | name: 'ghuser', 212 | message: 'What is the GitHub username?', 213 | default: this.appuser, 214 | store: true 215 | }, 216 | { 217 | type: 'confirm', 218 | name: 'setperm', 219 | message: 'Would you like to assign db user roles and permissions for your app?', 220 | default: false 221 | }, 222 | { 223 | when: response => { 224 | return response.setperm 225 | }, 226 | type: 'input', 227 | name: 'owner', 228 | message: 'What is the owner\'s username?', 229 | default: 'tei' 230 | }, 231 | { 232 | when: response => { 233 | return response.setperm 234 | }, 235 | type: 'password', 236 | name: 'userpw', 237 | message: 'Please type the user\'s password', 238 | default: 'simple' 239 | }, 240 | { 241 | when: response => { 242 | return response.setperm 243 | }, 244 | type: 'input', 245 | name: 'group', 246 | message: 'What is the app owner\'s usergroup?', 247 | default: response => { return response.owner } 248 | }, 249 | { 250 | when: response => { 251 | return response.setperm 252 | }, 253 | type: 'input', 254 | name: 'mode', 255 | message: 'Please select the user\'s permissions', 256 | default: 'rw-rw-r--', 257 | validate: value => { 258 | const pass = value.match(/^[rwx-]{9}$/g) 259 | if (pass) { 260 | return true 261 | } 262 | return 'Must be a string of 9 unix permission flags (rwx-)' 263 | } 264 | }, 265 | { 266 | type: 'list', 267 | choices: ['travis', 'GitHub Action'], 268 | name: 'ci', 269 | message: 'Whats your CI service', 270 | default: 'GitHub Action', 271 | store: true 272 | }, 273 | { 274 | type: 'confirm', 275 | name: 'docker', 276 | message: 'Would you like to use docker for your app?', 277 | default: true, 278 | store: true 279 | }, 280 | { 281 | when: response => { 282 | return response.docker 283 | }, 284 | type: 'input', 285 | name: 'dockertag', 286 | message: 'Please type the docker tag you wish to use for your container.', 287 | default: 'release', 288 | store: true 289 | }, 290 | // TODO add multi-stage option 291 | { 292 | type: 'confirm', 293 | name: 'atom', 294 | message: 'Would you like to add a' + chalk.grey('.existdb.json') + 'IDE config file for:' + chalk.green('atom') + ' or ' + chalk.magenta('vs-code') + '?', 295 | default: true, 296 | store: true 297 | }, 298 | { 299 | when: response => { 300 | return response.atom 301 | }, 302 | type: 'input', 303 | name: 'instance', 304 | message: 'What is the ' + chalk.blue('eXist') + ' instance\'s URI?', 305 | default: 'http://localhost:8080/exist', 306 | store: true 307 | }, 308 | { 309 | when: response => { 310 | return response.atom 311 | }, 312 | type: 'input', 313 | name: 'admin', 314 | message: 'What is user-name of the admin user?', 315 | default: 'admin', 316 | store: true 317 | }, 318 | { 319 | when: response => { 320 | return response.atom 321 | }, 322 | type: 'password', 323 | name: 'adminpw', 324 | message: 'What is the admin user\'s password', 325 | store: true 326 | }] 327 | 328 | // TODO: [yo]: js, css, gulp, funcdoc, 329 | // TODO: [gulp] https://github.com/bnjjj/generator-gulpfile-advanced 330 | 331 | return this.prompt(prompts).then(props => { 332 | // To access props later use this.props.someAnswer; 333 | this.props = props 334 | this.composeWith(require.resolve('generator-license'), { 335 | name: this.props.author, // (optional) Owner's name 336 | email: this.props.email, // (optional) Owner's email 337 | website: this.props.website, // (optional) Owner's website 338 | year: (new Date()).getFullYear(), // (optional) License year (defaults to current year) 339 | licensePrompt: 'Pick a license, default (AGPL-3.0)', // (optional) customize license prompt text 340 | defaultLicense: 'AGPL-3.0', // (optional) Select a default license 341 | license: this.props.license[0] // (optional) Select a license, so no license prompt will happen, in case you want to handle it outside of this generator 342 | }) 343 | if (this.props.name) { 344 | this.props.elementClassName = this.props.name.replace(/(^|-)(\w)/g, (_match, _p0, p1) => p1.toUpperCase()) 345 | } 346 | }) 347 | } 348 | 349 | writing () { 350 | // try to clean invalid xml from streams 351 | this.registerTransformStream( 352 | stripBom({ 353 | ext: ['xml', 'odd', 'xconf'], 354 | showLog: false 355 | })) 356 | // minify xml first … 357 | this.registerTransformStream(prettyData({ 358 | type: 'minify', 359 | preserveComments: true, 360 | extensions: { 361 | xconf: 'xml', 362 | odd: 'xml' 363 | } 364 | })) 365 | // … then pretty print xml 366 | this.registerTransformStream(prettyData({ 367 | type: 'prettify', 368 | extensions: { 369 | xconf: 'xml', 370 | odd: 'xml' 371 | } 372 | })) 373 | // global pkgJson 374 | const pkgJson = { 375 | name: this.props.title.toLowerCase(), 376 | version: this.props.version, 377 | description: this.props.desc, 378 | homepage: '', 379 | bugs: '', 380 | engines: { 381 | node: '>=14.0.0' 382 | }, 383 | keywords: ['exist', 'exist-db', 'xml', 'xql', 'xquery'], 384 | author: { 385 | name: this.props.author, 386 | email: this.props.email 387 | }, 388 | license: this.props.license[0], 389 | scripts: { 390 | test: 'mocha test/mocha/ --recursive --exit && mocha test/xqs/*.js' 391 | }, 392 | repository: '' 393 | } 394 | this.env.options.nodePackageManager = 'npm' 395 | // see https://github.com/yeoman/generator/issues/1294 396 | this.npmInstall(['chai'], { 'save-dev': true }) 397 | this.npmInstall(['chai-xml'], { 'save-dev': true }) 398 | this.npmInstall(['fs-extra'], { 'save-dev': true }) 399 | this.npmInstall(['mocha'], { 'save-dev': true }) 400 | this.npmInstall(['supertest'], { 'save-dev': true }) 401 | this.npmInstall(['xmldoc'], { 'save-dev': true }) 402 | this.npmInstall(['yeoman-assert'], { 'save-dev': true }) 403 | // Applies to all (without prompts) 404 | // TODO #56 html -> xhtml 405 | 406 | // EXPATH 407 | this.fs.copyTpl( 408 | this.templatePath('build.xml'), 409 | this.destinationPath('build.xml'), { 410 | apptype: this.props.apptype[0], 411 | title: this.props.title, 412 | github: this.props.github, 413 | desc: this.props.desc, 414 | docker: this.props.docker, 415 | dockerfiles: ', Dockerfile, .dockerignore', 416 | gitfiles: ', README.md, **/.git*/**' 417 | }) 418 | 419 | this.fs.copyTpl( 420 | this.templatePath('repo.xml'), 421 | this.destinationPath('repo.xml'), { 422 | desc: this.props.desc, 423 | short: this.props.short, 424 | author: this.props.author, 425 | apptype: this.props.apptype[1], 426 | status: this.props.status, 427 | pre: this.props.pre, 428 | prexq: 'pre-install.xq', 429 | post: this.props.post, 430 | postxq: 'post-install.xq', 431 | setperm: this.props.setperm, 432 | website: this.props.website, 433 | license: this.props.license[0], 434 | owner: this.props.owner, 435 | userpw: this.props.userpw, 436 | group: this.props.group, 437 | mode: this.props.mode 438 | }) 439 | 440 | this.fs.copyTpl( 441 | this.templatePath('expath-pkg.xml'), 442 | this.destinationPath('expath-pkg.xml'), { 443 | short: this.props.short, 444 | defcoll: this.props.defcoll, 445 | defuri: this.props.defuri, 446 | version: this.props.version, 447 | desc: this.props.desc, 448 | apptype: this.props.apptype[0] 449 | }) 450 | 451 | // Unit Test 452 | this.fs.copyTpl( 453 | this.templatePath('specs/xqs/test-suite.xqm'), 454 | this.destinationPath('test/xqs/test-suite.xqm'), { 455 | apptype: this.props.apptype[0], 456 | short: this.props.short, 457 | defcoll: this.props.defcoll, 458 | defuri: this.props.defuri, 459 | version: this.props.version, 460 | author: this.props.author, 461 | website: this.props.website, 462 | title: this.props.title 463 | }) 464 | this.fs.copyTpl( 465 | this.templatePath('specs/xqs/test-runner.xq'), 466 | this.destinationPath('test/xqs/test-runner.xq'), { 467 | short: this.props.short, 468 | defcoll: this.props.defcoll, 469 | defuri: this.props.defuri, 470 | version: this.props.version, 471 | author: this.props.author, 472 | title: this.props.title 473 | }) 474 | 475 | this.fs.copy( 476 | this.templatePath('specs/mocha/app_spec.js'), 477 | this.destinationPath('test/mocha/app_spec.js') 478 | ) 479 | 480 | this.fs.copyTpl( 481 | this.templatePath('specs/mocha/rest_spec.js'), 482 | this.destinationPath('test/mocha/rest_spec.js'), { 483 | apptype: this.props.apptype[0], 484 | short: this.props.short, 485 | defcoll: this.props.defcoll 486 | }) 487 | 488 | this.fs.copyTpl( 489 | this.templatePath('specs/xqs/xqSuite.js'), 490 | this.destinationPath('test/xqs/xqSuite.js'), { 491 | apptype: this.props.apptype[1], 492 | short: this.props.short, 493 | defcoll: this.props.defcoll, 494 | version: this.props.version 495 | }) 496 | 497 | // all application packages, … 498 | if (this.props.apptype[1] === 'application') { 499 | this.fs.copy( 500 | this.templatePath('img/icon.png'), 501 | this.destinationPath('icon.png') 502 | ) 503 | this.fs.copy( 504 | this.templatePath('specs/cypress/'), 505 | this.destinationPath('test/cypress/') 506 | ) 507 | 508 | this.fs.copy( 509 | this.templatePath('specs/cypress.config.js'), 510 | this.destinationPath('cypress.config.js') 511 | ) 512 | 513 | this.fs.copy( 514 | this.templatePath('github/.gitkeep'), 515 | this.destinationPath('reports/screenshots/.gitkeep') 516 | ) 517 | 518 | this.fs.copy( 519 | this.templatePath('github/.gitkeep'), 520 | this.destinationPath('reports/videos/.gitkeep') 521 | ) 522 | 523 | this.fs.copyTpl( 524 | this.templatePath('specs/e2e/landing.cy.js'), 525 | this.destinationPath('test/cypress/e2e/landing.cy.js'), { 526 | apptype: this.props.apptype[0], 527 | short: this.props.short, 528 | defcoll: this.props.defcoll, 529 | desc: this.props.desc, 530 | mysec: this.props.mysec 531 | }) 532 | 533 | this.npmInstall(['cypress'], { 'save-dev': true }) 534 | 535 | Object.assign(pkgJson.scripts, { 536 | cypress: 'cypress run' 537 | }) 538 | } 539 | // … except empty (flexible) 540 | if (this.props.apptype[0] !== 'empty') { 541 | this.fs.copyTpl( 542 | this.templatePath('pages/error-page.html'), 543 | this.destinationPath('error-page.html'), { 544 | apptype: this.props.apptype[0] 545 | }) 546 | 547 | this.fs.copyTpl( 548 | this.templatePath('pages/index.html'), 549 | this.destinationPath('index.html'), { 550 | apptype: this.props.apptype[0] 551 | }) 552 | this.fs.copyTpl( 553 | this.templatePath('styles/style.css'), 554 | this.destinationPath('resources/css/style.css'), { 555 | apptype: this.props.apptype[0] 556 | }) 557 | 558 | this.fs.copyTpl( 559 | this.templatePath('collection.xconf'), 560 | this.destinationPath('collection.xconf'), { 561 | apptype: this.props.apptype[0], 562 | index: this.props.index 563 | }) 564 | 565 | // XQuery 566 | this.fs.copyTpl( 567 | this.templatePath('xq/controller.xq'), 568 | this.destinationPath('controller.xq'), { 569 | apptype: this.props.apptype[0], 570 | mysec: this.props.mysec 571 | }) 572 | 573 | this.fs.copyTpl( 574 | this.templatePath('xq/view.xq'), 575 | this.destinationPath('modules/view.xq'), { 576 | short: this.props.short, 577 | defcoll: this.props.defcoll, 578 | defuri: this.props.defuri, 579 | apptype: this.props.apptype[0], 580 | version: this.props.version 581 | }) 582 | this.fs.copyTpl( 583 | this.templatePath('xq/app.xqm'), 584 | this.destinationPath('modules/app.xqm'), { 585 | short: this.props.short, 586 | defcoll: this.props.defcoll, 587 | defuri: this.props.defuri, 588 | apptype: this.props.apptype[0], 589 | version: this.props.version, 590 | author: this.props.author, 591 | website: this.props.website, 592 | title: this.props.title, 593 | mysec: this.props.mysec 594 | }) 595 | this.fs.copyTpl( 596 | this.templatePath('xq/config.xqm'), 597 | this.destinationPath('modules/config.xqm'), { 598 | short: this.props.short, 599 | defcoll: this.props.defcoll, 600 | defuri: this.props.defuri, 601 | apptype: this.props.apptype[0], 602 | defview: this.props.defview, 603 | index: this.props.index, 604 | dataloc: this.props.dataloc, 605 | datasrc: this.props.datasrc, 606 | odd: this.props.odd 607 | }) 608 | 609 | // #36 shared-resources 610 | this.fs.copy( 611 | this.templatePath('img/exist_icon_16x16.ico'), 612 | this.destinationPath('resources/images/exist_icon_16x16.ico') 613 | ) 614 | this.fs.copy( 615 | this.templatePath('img/powered-by.svg'), 616 | this.destinationPath('resources/images/powered-by.svg') 617 | ) 618 | 619 | this.npmInstall(['bootstrap@5']) 620 | 621 | // distinct contents (flexible) 622 | // see #28 623 | switch (this.props.apptype[0]) { 624 | case 'exist-design': 625 | this.fs.copyTpl( 626 | this.templatePath('pages/exist-design/page.html'), 627 | this.destinationPath('templates/page.html'), { 628 | title: this.props.title, 629 | mysec: this.props.mysec 630 | }) 631 | this.fs.copy( 632 | this.templatePath('img/exist-design/**'), 633 | this.destinationPath('resources/images/') 634 | ) 635 | // #36 636 | this.fs.copy( 637 | this.templatePath('styles/exist-2.2.css'), 638 | this.destinationPath('resources/css/exist-2.2.css') 639 | ) 640 | break 641 | case 'plain': 642 | this.fs.copyTpl( 643 | this.templatePath('pages/plain/page.html'), 644 | this.destinationPath('templates/page.html'), { 645 | title: this.props.title, 646 | mysec: this.props.mysec 647 | }) 648 | break 649 | default: 650 | } 651 | } 652 | 653 | // Prompt based 654 | // Pre-install 655 | if (this.props.pre) { 656 | this.fs.copyTpl( 657 | this.templatePath('xq/pre-install.xq'), 658 | this.destinationPath('pre-install.xq'), { 659 | version: this.props.version, 660 | author: this.props.author, 661 | website: this.props.website 662 | } 663 | ) 664 | } 665 | // Post-install 666 | if (this.props.post) { 667 | this.fs.copyTpl( 668 | this.templatePath('xq/post-install.xq'), 669 | this.destinationPath('post-install.xq'), { 670 | apptype: this.props.apptype[0], 671 | version: this.props.version, 672 | author: this.props.author, 673 | website: this.props.website 674 | }) 675 | } 676 | 677 | // Secure area (mysec) 678 | if (this.props.mysec) { 679 | this.fs.copy( 680 | this.templatePath('pages/mysec/admin/*.html'), 681 | this.destinationPath('admin/') 682 | ) 683 | this.fs.copy( 684 | this.templatePath('xq/admin/**'), 685 | this.destinationPath('admin/') 686 | ) 687 | this.fs.copy( 688 | this.templatePath('pages/mysec/templates/*.html'), 689 | this.destinationPath('templates/') 690 | ) 691 | this.fs.copyTpl( 692 | this.templatePath('specs/e2e/login-*.cy.js'), 693 | this.destinationPath('test/cypress/e2e/'), { 694 | defcoll: this.props.defcoll, 695 | short: this.props.short 696 | }) 697 | } 698 | 699 | // Github 700 | // TODO #601 701 | if (this.props.github) { 702 | this.fs.copy( 703 | this.templatePath('github/__gitignore__'), 704 | this.destinationPath('.gitignore') 705 | ) 706 | // Is this needed how so? 707 | this.fs.copy( 708 | this.templatePath('github/.gitattributes'), 709 | this.destinationPath('.gitattributes') 710 | ) 711 | this.fs.copy( 712 | this.templatePath('github/feature_request.md'), 713 | this.destinationPath('.github/ISSUE_TEMPLATE/feature_request.md') 714 | ) 715 | this.fs.copy( 716 | this.templatePath('github/PULL_REQUEST_TEMPLATE.md'), 717 | this.destinationPath('.github/pull_request_template.md') 718 | ) 719 | // Git-flex 720 | this.fs.copyTpl( 721 | this.templatePath('github/readme.md'), 722 | this.destinationPath('README.md'), { 723 | apptype: this.props.apptype[0], 724 | title: this.props.title, 725 | desc: this.props.desc, 726 | version: this.props.version, 727 | ghuser: this.props.ghuser, 728 | website: this.props.website, 729 | author: this.props.author, 730 | license: this.props.license[0], 731 | badge: this.props.license[1], 732 | badgelink: this.props.license[2], 733 | ci: this.props.ci 734 | }) 735 | this.fs.copyTpl( 736 | this.templatePath('github/contributing.md'), 737 | this.destinationPath('.github/CONTRIBUTING.md'), { 738 | title: this.props.title 739 | }) 740 | this.fs.copyTpl( 741 | this.templatePath('github/ISSUE_TEMPLATE.md'), 742 | this.destinationPath('.github/ISSUE_TEMPLATE/bug_report.md'), { 743 | title: this.props.title 744 | }) 745 | // insert responses into pkgJson 746 | Object.assign(pkgJson, { 747 | homepage: 'https://github.com/' + this.props.ghuser + '/' + this.props.title.toLowerCase() + '#readme' 748 | }, { 749 | bugs: 'https://github.com/' + this.props.ghuser + '/' + this.props.title.toLowerCase() + '/issues' 750 | }, { 751 | repository: { 752 | type: 'git', 753 | url: 'https://github.com/' + this.props.ghuser + '/' + this.props.title.toLowerCase(), 754 | license: this.props.license[0] 755 | } 756 | }) 757 | } 758 | 759 | // DOCKER 760 | if (this.props.docker) { 761 | this.fs.copy( 762 | this.templatePath('.dockerignore'), 763 | this.destinationPath('.dockerignore') 764 | ) 765 | this.fs.copyTpl( 766 | this.templatePath('Dockerfile'), 767 | this.destinationPath('Dockerfile'), { 768 | dockertag: this.props.dockertag, 769 | title: this.props.title, 770 | version: this.props.version 771 | }) 772 | } 773 | 774 | // Atom 775 | if (this.props.atom) { 776 | this.fs.copyTpl( 777 | this.templatePath('.existdb.json'), 778 | this.destinationPath('.existdb.json'), { 779 | short: this.props.short, 780 | defcoll: this.props.defcoll, 781 | instance: this.props.instance, 782 | admin: this.props.admin, 783 | adminpw: this.props.adminpw 784 | }) 785 | } 786 | 787 | // CI 788 | switch (this.props.ci) { 789 | case 'travis': 790 | this.fs.copyTpl( 791 | this.templatePath('ci/.travis.yml'), 792 | this.destinationPath('.travis.yml'), { 793 | apptype: this.props.apptype[1] 794 | }) 795 | break 796 | default: 797 | this.fs.copyTpl( 798 | this.templatePath('ci/exist.yml'), 799 | this.destinationPath('.github/workflows/exist.yml'), { 800 | apptype: this.props.apptype[1] 801 | } 802 | ) 803 | this.fs.copy( 804 | this.templatePath('ci/dependabot.yml'), 805 | this.destinationPath('.github/dependabot.yml') 806 | ) 807 | } 808 | 809 | // Write the constructed pkgJson 810 | this.fs.writeJSON(this.destinationPath('package.json'), pkgJson) 811 | } 812 | 813 | install () { 814 | this.npmInstall() 815 | } 816 | 817 | end () { 818 | if (this.props.github) { 819 | this.spawnCommandSync('git', ['init']) 820 | this.spawnCommandSync('git', ['add', '--all']) 821 | this.spawnCommandSync('git', ['commit', '-q', '-m', '\'chore(init): scaffolding by Yeoman\'']) 822 | } 823 | this.spawnCommandSync('ant', '-q') 824 | 825 | console.log(yosay('I believe we\'re done here.')) 826 | } 827 | } 828 | --------------------------------------------------------------------------------