Skip to content

Commit

Permalink
chore: make standardJS happy
Browse files Browse the repository at this point in the history
  • Loading branch information
@line-o
line-o committed Oct 31, 2020
1 parent a1a9a9f commit e71bbcd
Showing 1 changed file with 98 additions and 98 deletions.
196 changes: 98 additions & 98 deletions spec/examples/gulpfile.js
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
/**
* an example gulpfile to make ant-less existdb package builds a reality
*/
const fs = require("fs")
const fs = require('fs')
const { src, dest, watch, series, parallel, lastRun } = require('gulp')
const { createClient } = require('@existdb/gulp-exist')
const { connect } = require('@existdb/node-exist')
const zip = require("gulp-zip")
const zip = require('gulp-zip')
const sass = require('gulp-sass')
const uglify = require('gulp-uglify-es').default
const replace = require('gulp-replace')
Expand All @@ -20,166 +20,166 @@ const serverInfo = existJSON.servers.localhost

const target = serverInfo.root
const connectionOptions = {
basic_auth: {
user: serverInfo.user,
pass: serverInfo.password
},
secure: false,
port: 8080
}
const existClient = createClient(connectionOptions);
basic_auth: {
user: serverInfo.user,
pass: serverInfo.password
},
secure: false,
port: 8080
}
const existClient = createClient(connectionOptions)
const db = connect(connectionOptions)

/**
* Use the `delete` module directly, instead of using gulp-rimraf
*/
function clean (cb) {
del(['build'], cb);
del(['build'], cb)
}
exports.clean = clean

/**
* report problems in replacements in .tmpl files
* replaces the problematic values with an empty string
*
*
* @param {String} match
* @param {String} p1
* @param {String} p1
* @param {String} p2
* @param {Number} offset
* @param {String} string
* @param {Number} offset
* @param {String} string
* @returns {String} empty string
*/
function handleReplacementIssue (match, offset, string, path, message) {
const line = string.substring(0, offset).match(/\n/g).length + 1
const startIndex = Math.max(0, offset - 30)
const startEllipsis = Boolean(startIndex)
const start = string.substring(startIndex, offset)
const endIndex = (offset + match.length + Math.min(string.length, 30))
const endEllipsis = endIndex === string.length
const end = string.substr(offset + match.length, Math.min(string.length, 30))
console.warn(`\n\x1b[31m${match}\x1b[39m ${message}`)
console.warn(`Found at line ${line} in ${path}`)
console.warn(`${ellipsis(startEllipsis)}${start}\x1b[31m${match}\x1b[39m${end}${ellipsis(endEllipsis)}`)
return ""
const line = string.substring(0, offset).match(/\n/g).length + 1
const startIndex = Math.max(0, offset - 30)
const startEllipsis = Boolean(startIndex)
const start = string.substring(startIndex, offset)
const endIndex = (offset + match.length + Math.min(string.length, 30))
const endEllipsis = endIndex === string.length
const end = string.substr(offset + match.length, Math.min(string.length, 30))
console.warn(`\n\x1b[31m${match}\x1b[39m ${message}`)
console.warn(`Found at line ${line} in ${path}`)
console.warn(`${ellipsis(startEllipsis)}${start}\x1b[31m${match}\x1b[39m${end}${ellipsis(endEllipsis)}`)
return ''
}

/**
* replace placeholders in the form @something@
* similar to your normal .tmpl substitutions
*
* @param {String} match
* @param {String} p1
*
* @param {String} match
* @param {String} p1
* @param {String} p2
* @param {Number} offset
* @param {String} string
* @param {Number} offset
* @param {String} string
* @returns {String} replacement or empty string
*/
function tmplReplacement (match, p1, p2, offset, string) {
const path = this.file.relative
if (!p1) {
return handleReplacementIssue(match, offset, string, path, "replacement must start with 'package.'")
}
// search for replacement in .existdb.json "package"
if (existJSON.package && p2 in existJSON.package) {
return existJSON.package[p2]
}
// search for replacement in package.json
if (p2 in pkg) {
return pkg[p2]
}
// missing substitution handling
return handleReplacementIssue(match, offset, string, path, "is not set in package.json!")
const path = this.file.relative
if (!p1) {
return handleReplacementIssue(match, offset, string, path, "replacement must start with 'package.'")
}
// search for replacement in .existdb.json "package"
if (existJSON.package && p2 in existJSON.package) {
return existJSON.package[p2]
}
// search for replacement in package.json
if (p2 in pkg) {
return pkg[p2]
}
// missing substitution handling
return handleReplacementIssue(match, offset, string, path, 'is not set in package.json!')
}

/**
* show that the file contents were shortened
*
* @param {Boolean} display
*
* @param {Boolean} display
* @returns {String} '...' if display is true, '' otherwise
*/
function ellipsis (display) {
if (display) { return '...' }
return ''
if (display) { return '...' }
return ''
}

/**
* replace placeholders
* in src/repo.xml.tmpl and
* replace placeholders
* in src/repo.xml.tmpl and
* output to build/repo.xml
*/
function templates () {
return src('src/*.tmpl')
.pipe(replace(/@(package\.)?([^@]+)@/g, tmplReplacement))
.pipe(rename(path => { path.extname = "" }))
.pipe(rename(path => { path.extname = '' }))
.pipe(dest('build/'))
}
exports.templates = templates

function watchTemplates () {
watch('src/*.tmpl', series(templates))
watch('src/*.tmpl', series(templates))
}
exports["watch:tmpl"] = watchTemplates
exports['watch:tmpl'] = watchTemplates

/**
* compile SCSS styles and put them into 'build/app/css'
*/
function styles () {
return src('src/scss/**/*.scss')
.pipe(sass().on('error', sass.logError))
.pipe(dest('build/css'));
return src('src/scss/**/*.scss')
.pipe(sass().on('error', sass.logError))
.pipe(dest('build/css'))
}
exports.styles = styles

function watchStyles () {
watch('src/scss/**/*.scss', series(styles))
watch('src/scss/**/*.scss', series(styles))
}
exports["watch:styles"] = watchStyles
exports['watch:styles'] = watchStyles

/**
* minify EcmaSript files and put them into 'build/app/js'
*/
function minifyEs () {
return src('src/js/**/*.js')
.pipe(uglify())
.pipe(dest('build/js'))
return src('src/js/**/*.js')
.pipe(uglify())
.pipe(dest('build/js'))
}
exports.minify = minifyEs

function watchEs () {
watch('src/js/**/*.js', series(minifyEs))
watch('src/js/**/*.js', series(minifyEs))
}
exports["watch:es"] = watchEs
exports['watch:es'] = watchEs

const staticGlob = 'src/**/*.{xml,html,xq,xquery,xql,xqm,xsl,xconf}'

/**
* copy html templates, XSL stylesheet, XMLs and XQueries to 'build'
*/
function copyStatic () {
return src(staticGlob).pipe(dest('build'))
return src(staticGlob).pipe(dest('build'))
}
exports.copy = copyStatic

function watchStatic () {
watch(staticGlob, series(copyStatic));
watch(staticGlob, series(copyStatic))
}
exports["watch:static"] = watchStatic
exports['watch:static'] = watchStatic

/**
* Upload all files in the build folder to existdb.
* This function will only upload what was changed
* This function will only upload what was changed
* since the last run (see gulp documentation for lastRun).
*/
function deploy () {
return src('build/**/*', {
base: 'build',
since: lastRun(deploy)
})
.pipe(existClient.dest({target}))
return src('build/**/*', {
base: 'build',
since: lastRun(deploy)
})
.pipe(existClient.dest({ target }))
}

function watchBuild () {
watch('build/**/*', series(deploy))
watch('build/**/*', series(deploy))
}

// construct the current xar name from available data
Expand All @@ -189,42 +189,42 @@ const packageName = () => `${existJSON.package.target}-${pkg.version}.xar`
* create XAR package in repo root
*/
function xar () {
return src('build/**/*', {base: 'build'})
.pipe(zip(packageName()))
.pipe(dest('.'))
return src('build/**/*', { base: 'build' })
.pipe(zip(packageName()))
.pipe(dest('.'))
}

/**
* upload and install the latest built XAR
*/
async function installXar () {
const file = packageName()
const remotePath = `/db/system/repo/${file}`
const buff = fs.readFileSync(file)
console.log("uploading...", file)
const uploadResult = await db.app.upload(buff, remotePath)
if (uploadResult !== true) {
return console.error('uploading failed with: ', uploadResult)
}
console.log("installing...", file)
const installationResult = await db.app.install(remotePath)
console.log(installationResult)
const file = packageName()
const remotePath = `/db/system/repo/${file}`
const buff = fs.readFileSync(file)
console.log('uploading...', file)
const uploadResult = await db.app.upload(buff, remotePath)
if (uploadResult !== true) {
return console.error('uploading failed with: ', uploadResult)
}
console.log('installing...', file)
const installationResult = await db.app.install(remotePath)
console.log(installationResult)
}

// composed tasks
const build = series(
clean,
styles,
minifyEs,
templates,
copyStatic
clean,
styles,
minifyEs,
templates,
copyStatic
)
const watchAll = parallel(
watchStyles,
watchEs,
watchStatic,
watchTemplates,
watchBuild
watchStyles,
watchEs,
watchStatic,
watchTemplates,
watchBuild
)

exports.build = build
Expand Down

0 comments on commit e71bbcd

Please sign in to comment.