js-build-tools 1.2.3 → 2.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +573 -250
- package/dist/build.js +27 -20
- package/dist/build.min.js +1 -1
- package/dist/bundle.js +16 -13
- package/dist/bundle.min.js +1 -1
- package/dist/bundleLint.js +22 -18
- package/dist/bundleLint.min.js +1 -1
- package/dist/bundleMinify.js +13 -17
- package/dist/bundleMinify.min.js +1 -1
- package/dist/compileReadme.js +13 -11
- package/dist/compileReadme.min.js +1 -1
- package/dist/default.js +17 -12
- package/dist/default.min.js +1 -1
- package/dist/dist.js +11 -7
- package/dist/dist.min.js +1 -1
- package/dist/distLint.js +20 -17
- package/dist/distLint.min.js +1 -1
- package/dist/distMinify.js +12 -17
- package/dist/distMinify.min.js +1 -1
- package/dist/partials/addToReadme.js +25 -0
- package/dist/partials/beginWatcher.js +16 -0
- package/dist/partials/clean.js +21 -0
- package/dist/partials/distFor.js +23 -0
- package/dist/partials/distForSrc.js +16 -0
- package/dist/partials/distSeries.js +31 -0
- package/dist/partials/minifyFor.js +21 -0
- package/dist/partials/readmeTemplate.js +18 -0
- package/dist/partials/runOnChange.js +63 -0
- package/dist/partials/tsFor.js +24 -0
- package/dist/partials.js +33 -0
- package/dist/partials.min.js +1 -0
- package/dist/test-helpers/circularObject.js +50 -0
- package/dist/test-helpers/countMatches.js +16 -0
- package/dist/test-helpers/deepReferenceObject.js +20 -0
- package/dist/test-helpers/domItem.js +33 -0
- package/dist/test-helpers/jsonDom.js +20 -0
- package/dist/test-helpers/linkedList.js +23 -0
- package/dist/test-helpers/logObject.js +24 -0
- package/dist/test-helpers/multiReferenceObject.js +20 -0
- package/dist/test-helpers/nodeTree.js +28 -0
- package/dist/test-helpers/setUp.js +127 -0
- package/dist/testFull.js +21 -10
- package/dist/testFull.min.js +1 -1
- package/dist/testHelpers.js +33 -198
- package/dist/testHelpers.min.js +1 -1
- package/dist/testQuick.js +23 -12
- package/dist/testQuick.min.js +1 -1
- package/dist/typeScript.js +14 -0
- package/dist/typeScript.min.js +1 -0
- package/dist/watchFull.js +14 -21
- package/dist/watchFull.min.js +1 -1
- package/dist/watchTest.js +16 -14
- package/dist/watchTest.min.js +1 -1
- package/functions/build.js +8 -5
- package/functions/build.test.js +59 -0
- package/functions/bundle.js +6 -4
- package/functions/bundle.test.js +68 -0
- package/functions/bundleLint.js +5 -3
- package/functions/bundleLint.test.js +61 -0
- package/functions/bundleMinify.js +4 -7
- package/functions/bundleMinify.test.js +14 -0
- package/functions/compileReadme.js +3 -2
- package/functions/compileReadme.test.js +18 -0
- package/functions/default.js +5 -2
- package/functions/default.test.js +32 -0
- package/functions/dist.js +3 -1
- package/functions/dist.test.js +43 -0
- package/functions/distLint.js +4 -2
- package/functions/distLint.test.js +58 -0
- package/functions/distMinify.js +4 -7
- package/functions/distMinify.test.js +14 -0
- package/functions/partials/addToReadme.js +20 -0
- package/functions/partials/addToReadme.test.js +28 -0
- package/functions/partials/beginWatcher.js +12 -0
- package/functions/partials/beginWatcher.test.js +18 -0
- package/functions/partials/clean.js +14 -0
- package/functions/partials/clean.test.js +20 -0
- package/functions/partials/distFor.js +18 -0
- package/functions/partials/distFor.test.js +125 -0
- package/functions/partials/distForSrc.js +14 -0
- package/functions/partials/distForSrc.test.js +17 -0
- package/functions/partials/distSeries.js +21 -0
- package/functions/partials/distSeries.test.js +33 -0
- package/functions/partials/minifyFor.js +16 -0
- package/functions/partials/minifyFor.test.js +48 -0
- package/functions/partials/readmeTemplate.js +15 -0
- package/functions/partials/readmeTemplate.test.js +33 -0
- package/functions/partials/runOnChange.js +57 -0
- package/functions/partials/runOnChange.test.js +93 -0
- package/functions/partials/tsFor.js +21 -0
- package/functions/partials/tsFor.test.js +44 -0
- package/functions/partials.js +32 -0
- package/functions/partials.test.js +7 -0
- package/functions/test-helpers/circularObject.js +28 -0
- package/functions/test-helpers/circularObject.test.js +14 -0
- package/functions/test-helpers/countMatches.js +11 -0
- package/functions/test-helpers/countMatches.test.js +9 -0
- package/functions/test-helpers/deepReferenceObject.js +25 -0
- package/functions/test-helpers/deepReferenceObject.test.js +7 -0
- package/functions/test-helpers/domItem.js +31 -0
- package/functions/test-helpers/domItem.test.js +12 -0
- package/functions/test-helpers/jsonDom.js +16 -0
- package/functions/test-helpers/jsonDom.test.js +12 -0
- package/functions/test-helpers/linkedList.js +10 -0
- package/functions/test-helpers/linkedList.test.js +22 -0
- package/functions/test-helpers/logObject.js +18 -0
- package/functions/test-helpers/logObject.test.js +20 -0
- package/functions/test-helpers/multiReferenceObject.js +25 -0
- package/functions/test-helpers/multiReferenceObject.test.js +14 -0
- package/functions/test-helpers/nodeTree.js +11 -0
- package/functions/test-helpers/nodeTree.test.js +18 -0
- package/functions/test-helpers/setUp.js +67 -0
- package/functions/test-helpers/setUp.test.js +18 -0
- package/functions/testFull.js +13 -3
- package/functions/testFull.test.js +16 -0
- package/functions/testHelpers.js +27 -137
- package/functions/testHelpers.test.js +3 -96
- package/functions/testQuick.js +12 -2
- package/functions/testQuick.test.js +16 -0
- package/functions/typeScript.js +11 -0
- package/functions/typeScript.test.js +10 -0
- package/functions/watchFull.js +6 -12
- package/functions/watchFull.test.js +40 -0
- package/functions/watchTest.js +4 -2
- package/functions/watchTest.test.js +48 -0
- package/gulp.config.js +161 -16
- package/gulpfile.base.js +9 -0
- package/package.json +2 -1
- package/dist/addToReadme.js +0 -22
- package/dist/addToReadme.min.js +0 -1
- package/dist/clean.js +0 -11
- package/dist/clean.min.js +0 -1
- package/dist/distFor.js +0 -21
- package/dist/distFor.min.js +0 -1
- package/dist/readmeTemplate.js +0 -15
- package/dist/readmeTemplate.min.js +0 -1
- package/functions/addToReadme.js +0 -17
- package/functions/clean.js +0 -10
- package/functions/distFor.js +0 -15
- package/functions/readmeTemplate.js +0 -13
|
@@ -1,15 +1,12 @@
|
|
|
1
|
-
const { dest, src } = require('gulp')
|
|
2
1
|
const gulpConfig = require('../gulp.config.js')
|
|
3
|
-
const
|
|
4
|
-
const rename = require('gulp-rename')
|
|
2
|
+
const minifyFor = require('./partials/minifyFor')
|
|
5
3
|
|
|
6
4
|
/**
|
|
7
5
|
* Creates the minified bundle file.
|
|
6
|
+
* @function
|
|
7
|
+
* @memberOf module:js-build-tools
|
|
8
8
|
* @returns {*}
|
|
9
9
|
*/
|
|
10
|
-
const bundleMinify = () =>
|
|
11
|
-
.pipe(uglify())
|
|
12
|
-
.pipe(rename({ extname: '.min.js' }))
|
|
13
|
-
.pipe(dest(gulpConfig.browserPath))
|
|
10
|
+
const bundleMinify = () => minifyFor(`${gulpConfig.get('browserPath')}/${gulpConfig.get('browserName')}.js`, gulpConfig.get('browserPath'))
|
|
14
11
|
|
|
15
12
|
module.exports = bundleMinify
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
const { setUp } = require('./testHelpers')
|
|
2
|
+
const gulpConfig = setUp.gulpConfig
|
|
3
|
+
const bundleMinify = require('./bundleMinify')
|
|
4
|
+
const minifyFor = require('./partials/minifyFor')
|
|
5
|
+
|
|
6
|
+
jest.mock('./partials/minifyFor', () => jest.fn(() => Promise.resolve(true)))
|
|
7
|
+
|
|
8
|
+
describe('bundleMinify', () => {
|
|
9
|
+
test('calls minifyFor with configurations', () => {
|
|
10
|
+
expect.assertions(1)
|
|
11
|
+
bundleMinify()
|
|
12
|
+
expect(minifyFor).toHaveBeenCalledWith(`${gulpConfig.get('browserPath')}/${gulpConfig.get('browserName')}.js`, gulpConfig.get('browserPath'))
|
|
13
|
+
})
|
|
14
|
+
})
|
|
@@ -1,9 +1,10 @@
|
|
|
1
|
-
const addToReadme = require('./
|
|
2
|
-
const readmeTemplate = require('./readmeTemplate')
|
|
1
|
+
const { addToReadme, readmeTemplate } = require('./partials')
|
|
3
2
|
const { series } = require('gulp')
|
|
4
3
|
|
|
5
4
|
/**
|
|
6
5
|
* Generate the README.md file based off of the template, then append the generated documentation.
|
|
6
|
+
* @memberOf module:js-build-tools
|
|
7
|
+
* @returns {stream.Stream}
|
|
7
8
|
*/
|
|
8
9
|
const compileReadme = series(readmeTemplate, addToReadme)
|
|
9
10
|
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
const compileReadme = require('./compileReadme')
|
|
2
|
+
const { addToReadme, readmeTemplate} = require('./partials')
|
|
3
|
+
|
|
4
|
+
const genericFunction = () => Promise.resolve(true)
|
|
5
|
+
jest.mock('./partials/addToReadme', () => jest.fn(genericFunction))
|
|
6
|
+
jest.mock('./partials/readmeTemplate', () => jest.fn(genericFunction))
|
|
7
|
+
|
|
8
|
+
describe('compileReadme', () => {
|
|
9
|
+
test('calls readmeTemplate and addToReadme', done => {
|
|
10
|
+
expect.assertions(2)
|
|
11
|
+
compileReadme()
|
|
12
|
+
setTimeout(() => {
|
|
13
|
+
expect(readmeTemplate).toHaveBeenCalled()
|
|
14
|
+
expect(addToReadme).toHaveBeenCalled()
|
|
15
|
+
done()
|
|
16
|
+
}, 500)
|
|
17
|
+
})
|
|
18
|
+
})
|
package/functions/default.js
CHANGED
|
@@ -1,11 +1,14 @@
|
|
|
1
|
-
const { series } = require('gulp')
|
|
2
1
|
const dist = require('./dist')
|
|
3
2
|
const bundle = require('./bundle')
|
|
4
3
|
const gulpConfig = require('../gulp.config')
|
|
4
|
+
const { series } = require('gulp')
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
7
|
* Recommended as the default task, runs the simple dist and bundle tasks.
|
|
8
|
+
* @memberOf module:js-build-tools
|
|
9
|
+
* @param {function} [done=null]
|
|
10
|
+
* @returns {stream.Stream}
|
|
8
11
|
*/
|
|
9
|
-
const defaultCmd = gulpConfig.nodeOnly ? series(dist) : series(dist, bundle)
|
|
12
|
+
const defaultCmd = (done = null) => gulpConfig.get('nodeOnly') ? series(dist)(done) : series(dist, bundle)(done)
|
|
10
13
|
|
|
11
14
|
module.exports = defaultCmd
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
const { setUp } = require('./testHelpers')
|
|
2
|
+
const gulpConfig = setUp.gulpConfig
|
|
3
|
+
const bundle = require('./bundle')
|
|
4
|
+
const dist = require('./dist')
|
|
5
|
+
const defaultCmd = require('./default')
|
|
6
|
+
|
|
7
|
+
const genericFunction = () => Promise.resolve(true)
|
|
8
|
+
jest.mock('./bundle', () => jest.fn(genericFunction))
|
|
9
|
+
jest.mock('./dist', () => jest.fn(genericFunction))
|
|
10
|
+
|
|
11
|
+
describe('distMinify', () => {
|
|
12
|
+
test('calls dist for nodeOnly true', done => {
|
|
13
|
+
gulpConfig.set('nodeOnly', true)
|
|
14
|
+
expect.assertions(1)
|
|
15
|
+
defaultCmd()
|
|
16
|
+
setTimeout(() => {
|
|
17
|
+
expect(dist).toHaveBeenCalled()
|
|
18
|
+
done()
|
|
19
|
+
}, 500)
|
|
20
|
+
})
|
|
21
|
+
|
|
22
|
+
test('calls dist and bundle for nodeOnly false', done => {
|
|
23
|
+
gulpConfig.set('nodeOnly', false)
|
|
24
|
+
expect.assertions(2)
|
|
25
|
+
defaultCmd()
|
|
26
|
+
setTimeout(() => {
|
|
27
|
+
expect(dist).toHaveBeenCalled()
|
|
28
|
+
expect(bundle).toHaveBeenCalled()
|
|
29
|
+
done()
|
|
30
|
+
}, 500)
|
|
31
|
+
})
|
|
32
|
+
})
|
package/functions/dist.js
CHANGED
|
@@ -1,7 +1,9 @@
|
|
|
1
|
-
const distFor = require('./distFor.js')
|
|
1
|
+
const distFor = require('./partials/distFor.js')
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
4
|
* Simplified distribution tasks which will use arguments from distFor.
|
|
5
|
+
* @function
|
|
6
|
+
* @memberOf module:js-build-tools
|
|
5
7
|
* @returns {*}
|
|
6
8
|
*/
|
|
7
9
|
const dist = () => distFor()
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
const fs = require('fs')
|
|
2
|
+
const setUp = require('./test-helpers/setUp')
|
|
3
|
+
setUp.setDefaults('test-dist')
|
|
4
|
+
const gulpConfig = setUp.gulpConfig
|
|
5
|
+
const dist = require('./dist')
|
|
6
|
+
|
|
7
|
+
const rawContents = 'const distFor = require(\'./distFor.js\')\n' +
|
|
8
|
+
'\n' +
|
|
9
|
+
'/**\n' +
|
|
10
|
+
' * Simplified distribution tasks which will use arguments from distFor.\n' +
|
|
11
|
+
' * @returns {*}\n' +
|
|
12
|
+
' */\n' +
|
|
13
|
+
'const dist = () => distFor()\n' +
|
|
14
|
+
'\n' +
|
|
15
|
+
'module.exports = dist\n'
|
|
16
|
+
|
|
17
|
+
beforeEach(
|
|
18
|
+
() => setUp.beforeEach()
|
|
19
|
+
.then(
|
|
20
|
+
async () => {
|
|
21
|
+
const srcPath = gulpConfig.get('srcPath')
|
|
22
|
+
return fs.writeFileSync(`${srcPath}/dist.js`, rawContents)
|
|
23
|
+
}
|
|
24
|
+
)
|
|
25
|
+
)
|
|
26
|
+
|
|
27
|
+
afterEach(setUp.afterEach)
|
|
28
|
+
|
|
29
|
+
describe('dist', () => {
|
|
30
|
+
test('uses the configured paths', done => {
|
|
31
|
+
const distPath = gulpConfig.get('distPath')
|
|
32
|
+
expect.assertions(1)
|
|
33
|
+
dist()
|
|
34
|
+
.on('finish', () => {
|
|
35
|
+
expect(fs.existsSync(distPath)).toBeTruthy()
|
|
36
|
+
done()
|
|
37
|
+
})
|
|
38
|
+
.on('error', error => {
|
|
39
|
+
console.error('Encountered error', error)
|
|
40
|
+
done()
|
|
41
|
+
})
|
|
42
|
+
}, 10000)
|
|
43
|
+
})
|
package/functions/distLint.js
CHANGED
|
@@ -4,14 +4,16 @@ const standard = require('gulp-standard')
|
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
6
|
* Applies Standard code style linting to distribution files.
|
|
7
|
+
* @function
|
|
8
|
+
* @memberOf module:js-build-tools
|
|
7
9
|
* @returns {*}
|
|
8
10
|
*/
|
|
9
|
-
const distLint = () => src(gulpConfig.distSearch)
|
|
11
|
+
const distLint = () => src(gulpConfig.get('distSearch'))
|
|
10
12
|
.pipe(standard({ fix: true }))
|
|
11
13
|
.pipe(standard.reporter('default', {
|
|
12
14
|
fix: true,
|
|
13
15
|
quiet: true
|
|
14
16
|
}))
|
|
15
|
-
.pipe(dest(gulpConfig.distPath))
|
|
17
|
+
.pipe(dest(gulpConfig.get('distPath')))
|
|
16
18
|
|
|
17
19
|
module.exports = distLint
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
const fs = require('fs')
|
|
2
|
+
const setUp = require('./test-helpers/setUp')
|
|
3
|
+
setUp.setDefaults('test-dist-lint')
|
|
4
|
+
const gulpConfig = setUp.gulpConfig
|
|
5
|
+
const distLint = require('./distLint')
|
|
6
|
+
const { countMatches } = require('./testHelpers')
|
|
7
|
+
|
|
8
|
+
const lintableContents = 'const gulpConfig = require("../gulp.config.js");\n' +
|
|
9
|
+
'const { dest, src } = require("gulp");\n' +
|
|
10
|
+
'const standard = require("gulp-standard");\n' +
|
|
11
|
+
'\n' +
|
|
12
|
+
'/**\n' +
|
|
13
|
+
' * Applies Standard code style linting to distribution files.\n' +
|
|
14
|
+
' * @returns {*}\n' +
|
|
15
|
+
' */\n' +
|
|
16
|
+
'const distLint = () => src(gulpConfig.get("distSearch"))\n' +
|
|
17
|
+
' .pipe(standard({ fix: true }))\n' +
|
|
18
|
+
' .pipe(standard.reporter("default", {\n' +
|
|
19
|
+
' fix: true,\n' +
|
|
20
|
+
' quiet: true\n' +
|
|
21
|
+
' }))\n' +
|
|
22
|
+
' .pipe(dest(gulpConfig.get("distPath")));\n' +
|
|
23
|
+
'\n' +
|
|
24
|
+
'module.exports = distLint;'
|
|
25
|
+
|
|
26
|
+
beforeEach(
|
|
27
|
+
() => setUp.beforeEach()
|
|
28
|
+
.then(
|
|
29
|
+
async () => {
|
|
30
|
+
const distPath = gulpConfig.get('distPath')
|
|
31
|
+
await fs.mkdirSync(distPath)
|
|
32
|
+
return fs.writeFileSync(`${distPath}/distLint.js`, lintableContents)
|
|
33
|
+
}
|
|
34
|
+
)
|
|
35
|
+
)
|
|
36
|
+
|
|
37
|
+
afterEach(setUp.afterEach)
|
|
38
|
+
|
|
39
|
+
describe('distLint', () => {
|
|
40
|
+
test('copies the src directory and babelifies it into the dist directory', done => {
|
|
41
|
+
const distPath = gulpConfig.get('distPath')
|
|
42
|
+
const oldContents = fs.readFileSync(`${distPath}/distLint.js`).toString()
|
|
43
|
+
expect.assertions(4)
|
|
44
|
+
expect(countMatches(oldContents, '"')).toEqual(12)
|
|
45
|
+
expect(countMatches(oldContents, ';')).toEqual(5)
|
|
46
|
+
distLint()
|
|
47
|
+
.on('finish', () => {
|
|
48
|
+
const lintedContents = fs.readFileSync(`${distPath}/distLint.js`).toString()
|
|
49
|
+
expect(countMatches(lintedContents, '"')).toEqual(0)
|
|
50
|
+
expect(countMatches(lintedContents, ';')).toEqual(0)
|
|
51
|
+
done()
|
|
52
|
+
})
|
|
53
|
+
.on('error', error => {
|
|
54
|
+
console.error('Encountered error', error)
|
|
55
|
+
done()
|
|
56
|
+
})
|
|
57
|
+
}, 10000)
|
|
58
|
+
})
|
package/functions/distMinify.js
CHANGED
|
@@ -1,15 +1,12 @@
|
|
|
1
|
-
const { dest, src } = require('gulp')
|
|
2
1
|
const gulpConfig = require('../gulp.config.js')
|
|
3
|
-
const
|
|
4
|
-
const rename = require('gulp-rename')
|
|
2
|
+
const minifyFor = require('./partials/minifyFor')
|
|
5
3
|
|
|
6
4
|
/**
|
|
7
5
|
* Creates minified versions of the dist files.
|
|
6
|
+
* @function
|
|
7
|
+
* @memberOf module:js-build-tools
|
|
8
8
|
* @returns {*}
|
|
9
9
|
*/
|
|
10
|
-
const distMinify = () =>
|
|
11
|
-
.pipe(uglify())
|
|
12
|
-
.pipe(rename({ extname: '.min.js' }))
|
|
13
|
-
.pipe(dest(gulpConfig.distPath))
|
|
10
|
+
const distMinify = () => minifyFor(gulpConfig.get('distSearch'), gulpConfig.get('distPath'))
|
|
14
11
|
|
|
15
12
|
module.exports = distMinify
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
const { setUp } = require('./testHelpers')
|
|
2
|
+
const gulpConfig = setUp.gulpConfig
|
|
3
|
+
const distMinify = require('./distMinify')
|
|
4
|
+
const minifyFor = require('./partials/minifyFor')
|
|
5
|
+
|
|
6
|
+
jest.mock('./partials/minifyFor', () => jest.fn(() => Promise.resolve(true)))
|
|
7
|
+
|
|
8
|
+
describe('distMinify', () => {
|
|
9
|
+
test('calls minifyFor with configurations', () => {
|
|
10
|
+
expect.assertions(1)
|
|
11
|
+
distMinify()
|
|
12
|
+
expect(minifyFor).toHaveBeenCalledWith(gulpConfig.get('distSearch'), gulpConfig.get('distPath'))
|
|
13
|
+
})
|
|
14
|
+
})
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
const fs = require('fs')
|
|
2
|
+
const gulpConfig = require('../../gulp.config.js')
|
|
3
|
+
const jsdoc2md = require('jsdoc-to-markdown')
|
|
4
|
+
const { globSync } = require('glob')
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* Appends all the jsdoc comments to the readme file. Assumes empty or templated file.
|
|
8
|
+
* @function
|
|
9
|
+
* @memberOf module:partials
|
|
10
|
+
* @param {function|null} [done=null]
|
|
11
|
+
* @returns {string|Uint8Array}
|
|
12
|
+
*/
|
|
13
|
+
const addToReadme = (done = null) => {
|
|
14
|
+
const files = globSync(gulpConfig.get('readmeSearch'))
|
|
15
|
+
const readme = jsdoc2md.renderSync({ files: files })
|
|
16
|
+
fs.appendFileSync(gulpConfig.get('readmePath') + gulpConfig.get('readmeFile'), readme, gulpConfig.get('readmeOptions'))
|
|
17
|
+
return done && done()
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
module.exports = addToReadme
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
const fs = require('fs')
|
|
2
|
+
const setUp = require('../test-helpers/setUp')
|
|
3
|
+
setUp.setDefaults('test-add-to-readme')
|
|
4
|
+
const gulpConfig = setUp.gulpConfig
|
|
5
|
+
gulpConfig.set('srcSearch', 'test-temp/src/addToReadme.js')
|
|
6
|
+
const addToReadme = require('./addToReadme')
|
|
7
|
+
|
|
8
|
+
const rawContents = 'export function sayHello(name: string) {\n' +
|
|
9
|
+
' return `Hello from ${name}`;\n' +
|
|
10
|
+
'}'
|
|
11
|
+
|
|
12
|
+
beforeEach(() => setUp.beforeEach()
|
|
13
|
+
.then(() => fs.writeFileSync(gulpConfig.get('srcPath') + '/addToReadme.js', rawContents)))
|
|
14
|
+
|
|
15
|
+
afterEach(setUp.afterEach)
|
|
16
|
+
|
|
17
|
+
describe('addToReadme', () => {
|
|
18
|
+
test('generates the documentation', () => {
|
|
19
|
+
const readmeFilePath = gulpConfig.get('readmePath') + gulpConfig.get('readmeFile')
|
|
20
|
+
expect.assertions(2)
|
|
21
|
+
addToReadme(async () => {
|
|
22
|
+
await expect(fs.existsSync(readmeFilePath)).toBeTruthy()
|
|
23
|
+
const readme = await fs.readFileSync(readmeFilePath)
|
|
24
|
+
// At least the documentation will have the addToReadme documentation
|
|
25
|
+
await expect(readme.includes('addToReadme')).toBeTruthy()
|
|
26
|
+
})
|
|
27
|
+
})
|
|
28
|
+
})
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
const gulpConfig = require('../../gulp.config.js')
|
|
2
|
+
const { watch } = require('gulp')
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* Create a chokidar instance which watches and triggers change when the globed files are modified.
|
|
6
|
+
* @function
|
|
7
|
+
* @memberOf module:partials
|
|
8
|
+
* @returns {FSWatcher}
|
|
9
|
+
*/
|
|
10
|
+
const beginWatcher = () => watch(gulpConfig.get('watchSearch'))
|
|
11
|
+
|
|
12
|
+
module.exports = beginWatcher
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
const setUp = require('../test-helpers/setUp')
|
|
2
|
+
setUp.setDefaults('test-begin-watcher')
|
|
3
|
+
const gulpConfig = setUp.gulpConfig
|
|
4
|
+
const beginWatcher = require('./beginWatcher')
|
|
5
|
+
const { EventEmitter } = require('node:events')
|
|
6
|
+
|
|
7
|
+
beforeEach(setUp.beforeEach)
|
|
8
|
+
|
|
9
|
+
afterEach(setUp.afterEach)
|
|
10
|
+
|
|
11
|
+
describe('beginWatcher', () => {
|
|
12
|
+
test('returns instance of EventEmitter / FSWatcher', () => {
|
|
13
|
+
gulpConfig.set('watchSearch', 'test-begin-watcher/*.js')
|
|
14
|
+
const fsWatcher = beginWatcher()
|
|
15
|
+
expect(fsWatcher).toBeInstanceOf(EventEmitter)
|
|
16
|
+
fsWatcher.close()
|
|
17
|
+
})
|
|
18
|
+
})
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
const del = require('del')
|
|
2
|
+
const gulpConfig = require('../../gulp.config.js')
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* Deletes all the distribution and browser files (used before create a new build).
|
|
6
|
+
* @function
|
|
7
|
+
* @memberOf module:partials
|
|
8
|
+
* @param {function} [done=null]
|
|
9
|
+
* @param {string[]} [paths=['dist/config/path', 'browser/config/path']]
|
|
10
|
+
* @returns {Promise<string[]> | *}
|
|
11
|
+
*/
|
|
12
|
+
const clean = (done = null, paths = [gulpConfig.get('distPath'), gulpConfig.get('browserPath')]) => del(paths).then(() => done && done())
|
|
13
|
+
|
|
14
|
+
module.exports = clean
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
const fs = require('fs')
|
|
2
|
+
const setUp = require('../test-helpers/setUp')
|
|
3
|
+
setUp.setDefaults('test-clean')
|
|
4
|
+
const gulpConfig = setUp.gulpConfig
|
|
5
|
+
const clean = require('./clean')
|
|
6
|
+
|
|
7
|
+
beforeEach(setUp.beforeEach)
|
|
8
|
+
|
|
9
|
+
afterEach(setUp.afterEach)
|
|
10
|
+
|
|
11
|
+
describe('clean', () => {
|
|
12
|
+
test('removes all contents of directories specified', async () => {
|
|
13
|
+
expect.assertions(2)
|
|
14
|
+
const srcPath = gulpConfig.get('srcPath')
|
|
15
|
+
expect(fs.readdirSync(srcPath)).toBeTruthy()
|
|
16
|
+
// Run the clean script to empty the directories
|
|
17
|
+
await clean(null, [srcPath])
|
|
18
|
+
expect(fs.existsSync(srcPath)).toBeFalsy()
|
|
19
|
+
})
|
|
20
|
+
})
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
const babel = require('gulp-babel')
|
|
2
|
+
const { dest, src } = require('gulp')
|
|
3
|
+
const distForSrc = require('./distForSrc')
|
|
4
|
+
const gulpConfig = require('../../gulp.config.js')
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* Build the distribution for a given source pattern.
|
|
8
|
+
* @function
|
|
9
|
+
* @memberOf module:partials
|
|
10
|
+
* @param {string|array} [srcPath='src/config/path/dist/for']
|
|
11
|
+
* @param {string} [destPath='dist/config/path']
|
|
12
|
+
* @returns {*}
|
|
13
|
+
*/
|
|
14
|
+
const distFor = (srcPath = distForSrc(), destPath = gulpConfig.get('distPath')) => src(srcPath)
|
|
15
|
+
.pipe(babel())
|
|
16
|
+
.pipe(dest(destPath))
|
|
17
|
+
|
|
18
|
+
module.exports = distFor
|
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
const fs = require('fs')
|
|
2
|
+
const setUp = require('../test-helpers/setUp')
|
|
3
|
+
setUp.setDefaults('test-dist-for')
|
|
4
|
+
const gulpConfig = setUp.gulpConfig
|
|
5
|
+
const distFor = require('./distFor')
|
|
6
|
+
const { countMatches } = require('../testHelpers')
|
|
7
|
+
const typeScript = require('../typeScript')
|
|
8
|
+
|
|
9
|
+
const rawContents = 'const babel = require(\'gulp-babel\')\n' +
|
|
10
|
+
'const { dest, src } = require(\'gulp\')\n' +
|
|
11
|
+
'const typeScript = require(\'./typeScript\')\n' +
|
|
12
|
+
'const gulpConfig = require(\'../gulp.config.js\')\n' +
|
|
13
|
+
'\n' +
|
|
14
|
+
'const useTsConfig = gulpConfig.get(\'useTsConfig\')\n' +
|
|
15
|
+
'\n' +
|
|
16
|
+
'const defaultSrc = useTsConfig\n' +
|
|
17
|
+
' ? gulpConfig.get(\'distSearch\')\n' +
|
|
18
|
+
' : gulpConfig.get(\'srcSearch\')\n' +
|
|
19
|
+
'\n' +
|
|
20
|
+
'const distFor = (srcPath = defaultSrc, destPath = gulpConfig.get(\'distPath\')) => {\n' +
|
|
21
|
+
' let pipedSrc = src(srcPath)\n' +
|
|
22
|
+
' if (useTsConfig) {\n' +
|
|
23
|
+
' // Add the typescript so we can compile then apply babel to those files\n' +
|
|
24
|
+
' pipedSrc = typeScript(pipedSrc)\n' +
|
|
25
|
+
' }\n' +
|
|
26
|
+
' return pipedSrc\n' +
|
|
27
|
+
' .pipe(babel())\n' +
|
|
28
|
+
' .pipe(dest(destPath))\n' +
|
|
29
|
+
'}\n' +
|
|
30
|
+
'\n' +
|
|
31
|
+
'module.exports = distFor\n'
|
|
32
|
+
|
|
33
|
+
const rawTsContents = '// @ts-ignore\n' +
|
|
34
|
+
'import gulpConfig from \'../gulp.config.js\'\n' +
|
|
35
|
+
'// @ts-ignore\n' +
|
|
36
|
+
'import typeScript from \'./typeScript.js\'\n' +
|
|
37
|
+
'// @ts-ignore\n' +
|
|
38
|
+
'import {dest, src} from \'gulp\'\n' +
|
|
39
|
+
'// @ts-ignore\n' +
|
|
40
|
+
'import babel from \'gulp-babel\'\n' +
|
|
41
|
+
'\n' +
|
|
42
|
+
'const useTsConfig = gulpConfig.get(\'useTsConfig\')\n' +
|
|
43
|
+
'\n' +
|
|
44
|
+
'const defaultSrc: string | Array<any> = useTsConfig\n' +
|
|
45
|
+
' ? gulpConfig.get(\'distSearch\')\n' +
|
|
46
|
+
' : gulpConfig.get(\'srcSearch\')\n' +
|
|
47
|
+
'\n' +
|
|
48
|
+
'// @ts-ignore\n' +
|
|
49
|
+
'const distFor = (srcPath: string | Array<any> = defaultSrc, destPath: string = gulpConfig.get(\'distPath\')): import(\'readable-stream\').Stream => {\n' +
|
|
50
|
+
' let pipedSrc = src(srcPath)\n' +
|
|
51
|
+
' if (useTsConfig) {\n' +
|
|
52
|
+
' // Add the typescript so we can compile then apply babel to those files\n' +
|
|
53
|
+
' pipedSrc = typeScript(pipedSrc)\n' +
|
|
54
|
+
' }\n' +
|
|
55
|
+
' return pipedSrc\n' +
|
|
56
|
+
' .pipe(babel())\n' +
|
|
57
|
+
' .pipe(dest(destPath))\n' +
|
|
58
|
+
'}\n' +
|
|
59
|
+
'\n' +
|
|
60
|
+
'export default distFor\n'
|
|
61
|
+
|
|
62
|
+
beforeEach(setUp.beforeEach)
|
|
63
|
+
|
|
64
|
+
afterEach(setUp.afterEach)
|
|
65
|
+
|
|
66
|
+
describe('distFor', () => {
|
|
67
|
+
test('copies the src directory and babelifies it into the dist directory', done => {
|
|
68
|
+
const srcPath = gulpConfig.get('srcPath')
|
|
69
|
+
const srcFile = `${srcPath}/distFor.js`
|
|
70
|
+
fs.writeFileSync(srcFile, rawContents)
|
|
71
|
+
expect.assertions(7)
|
|
72
|
+
const oldContents = fs.readFileSync(srcFile).toString()
|
|
73
|
+
expect(countMatches(oldContents, 'const ')).toEqual(7)
|
|
74
|
+
const distPath = gulpConfig.get('distPath')
|
|
75
|
+
distFor(srcFile)
|
|
76
|
+
.on('finish', () => {
|
|
77
|
+
expect(fs.existsSync(distPath)).toBeTruthy()
|
|
78
|
+
const babelifiedContents = fs.readFileSync(`${distPath}/distFor.js`).toString()
|
|
79
|
+
expect(countMatches(babelifiedContents, '"use strict"')).toEqual(1)
|
|
80
|
+
// If the below assertion fails it is because 'const' no longer is replaced with 'var'
|
|
81
|
+
// To fix, change `.browserslistrc` set `> 0.21%` to a lower number. For example, last fix changed from `> 0.24%`
|
|
82
|
+
expect(countMatches(babelifiedContents, 'const ')).toEqual(0)
|
|
83
|
+
expect(countMatches(babelifiedContents, 'var ')).toEqual(10)
|
|
84
|
+
expect(countMatches(babelifiedContents, 'function')).toEqual(1)
|
|
85
|
+
expect(countMatches(babelifiedContents, 'arguments')).toEqual(6)
|
|
86
|
+
done()
|
|
87
|
+
})
|
|
88
|
+
.on('error', error => {
|
|
89
|
+
console.error('Encountered error', error)
|
|
90
|
+
done()
|
|
91
|
+
})
|
|
92
|
+
})
|
|
93
|
+
|
|
94
|
+
test('can process typescript before babel', done => {
|
|
95
|
+
const srcPath = gulpConfig.get('srcPath')
|
|
96
|
+
const srcFile = `${srcPath}/distFor.ts`
|
|
97
|
+
fs.writeFileSync(srcFile, rawTsContents)
|
|
98
|
+
expect.assertions(7)
|
|
99
|
+
const oldContents = fs.readFileSync(srcFile).toString()
|
|
100
|
+
expect(countMatches(oldContents, 'const ')).toEqual(3)
|
|
101
|
+
const distPath = gulpConfig.get('distPath')
|
|
102
|
+
typeScript()
|
|
103
|
+
.on('finish', () => {
|
|
104
|
+
distFor()
|
|
105
|
+
.on('finish', () => {
|
|
106
|
+
expect(fs.existsSync(distPath)).toBeTruthy()
|
|
107
|
+
const babelifiedContents = fs.readFileSync(`${distPath}/distFor.js`).toString()
|
|
108
|
+
expect(countMatches(babelifiedContents, '"use strict"')).toEqual(1)
|
|
109
|
+
expect(countMatches(babelifiedContents, 'const ')).toEqual(0)
|
|
110
|
+
expect(countMatches(babelifiedContents, 'var ')).toEqual(8)
|
|
111
|
+
expect(countMatches(babelifiedContents, 'function')).toEqual(1)
|
|
112
|
+
expect(countMatches(babelifiedContents, 'Object.defineProperty(exports, "__esModule", { value: true })')).toEqual(1)
|
|
113
|
+
done()
|
|
114
|
+
})
|
|
115
|
+
.on('error', error => {
|
|
116
|
+
console.error('Encountered error with distFor', error)
|
|
117
|
+
done()
|
|
118
|
+
})
|
|
119
|
+
})
|
|
120
|
+
.on('error', error => {
|
|
121
|
+
console.error('Encountered error with typeScript', error)
|
|
122
|
+
done()
|
|
123
|
+
})
|
|
124
|
+
}, 30000)
|
|
125
|
+
})
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
const gulpConfig = require('../../gulp.config')
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Retrieve the correct distFor search path based on TS Config.
|
|
5
|
+
* @function
|
|
6
|
+
* @memberOf module:partials
|
|
7
|
+
* @param {module:gulpConfig~FlagStringSetting} [useTs='config/for/ts']
|
|
8
|
+
* @returns {string}
|
|
9
|
+
*/
|
|
10
|
+
const distForSrc = (useTs = gulpConfig.get('useTsConfig')) => useTs
|
|
11
|
+
? gulpConfig.get('distSearch')
|
|
12
|
+
: gulpConfig.get('srcSearch')
|
|
13
|
+
|
|
14
|
+
module.exports = distForSrc
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
const setUp = require('../test-helpers/setUp')
|
|
2
|
+
const gulpConfig = setUp.gulpConfig
|
|
3
|
+
const distForSrc = require('./distForSrc')
|
|
4
|
+
|
|
5
|
+
describe('distForSrc', () => {
|
|
6
|
+
test('useTsConfig as false returns srcSearch', () => {
|
|
7
|
+
expect.assertions(1)
|
|
8
|
+
gulpConfig.set('useTsConfig', false)
|
|
9
|
+
expect(distForSrc()).toBe(gulpConfig.get('srcSearch'))
|
|
10
|
+
})
|
|
11
|
+
|
|
12
|
+
test('useTsConfig as true returns distSearch', () => {
|
|
13
|
+
expect.assertions(1)
|
|
14
|
+
gulpConfig.set('useTsConfig', true)
|
|
15
|
+
expect(distForSrc()).toBe(gulpConfig.get('distSearch'))
|
|
16
|
+
})
|
|
17
|
+
})
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
const gulpConfig = require('../../gulp.config')
|
|
2
|
+
const distFor = require('./distFor')
|
|
3
|
+
const distForSrc = require('./distForSrc')
|
|
4
|
+
const { series } = require('gulp')
|
|
5
|
+
const tsFor = require('./tsFor')
|
|
6
|
+
|
|
7
|
+
/**
|
|
8
|
+
* When using TypeScript, ensure that we process the ts first then run babel (dist)
|
|
9
|
+
* @function
|
|
10
|
+
* @memberOf module:partials
|
|
11
|
+
* @param {string} [srcPath='src/config/path/dist/for']
|
|
12
|
+
* @param {string} [distFinalPath='dist/config/path']
|
|
13
|
+
* @param {string} [tsSearch='ts/search/config/path']
|
|
14
|
+
* @returns {Function}
|
|
15
|
+
*/
|
|
16
|
+
const distSeries = (srcPath = distForSrc(), distFinalPath = gulpConfig.get('distPath'), tsSearch = gulpConfig.get('tsSearch')) =>
|
|
17
|
+
gulpConfig.get('useTsConfig')
|
|
18
|
+
? series(() => tsFor(tsSearch, distFinalPath), () => distFor(srcPath, distFinalPath))
|
|
19
|
+
: () => distFor(srcPath, distFinalPath)
|
|
20
|
+
|
|
21
|
+
module.exports = distSeries
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
const setUp = require('../test-helpers/setUp')
|
|
2
|
+
const gulpConfig = setUp.gulpConfig
|
|
3
|
+
const distSeries = require('./distSeries')
|
|
4
|
+
const tsFor = require('./tsFor')
|
|
5
|
+
const distFor = require('./distFor')
|
|
6
|
+
|
|
7
|
+
const genericFunction = () => Promise.resolve(true)
|
|
8
|
+
|
|
9
|
+
jest.mock('./distFor', () => jest.fn(genericFunction))
|
|
10
|
+
jest.mock('./tsFor', () => jest.fn(genericFunction))
|
|
11
|
+
|
|
12
|
+
describe('distSeries', () => {
|
|
13
|
+
test('when not using ts config only returns runnable distFor', done => {
|
|
14
|
+
gulpConfig.set('useTsConfig', false)
|
|
15
|
+
expect.assertions(1)
|
|
16
|
+
distSeries()()
|
|
17
|
+
setTimeout(() => {
|
|
18
|
+
expect(distFor).toHaveBeenCalledWith(gulpConfig.get('srcSearch'), gulpConfig.get('distPath'))
|
|
19
|
+
done()
|
|
20
|
+
}, 500)
|
|
21
|
+
})
|
|
22
|
+
|
|
23
|
+
test('when using ts config returns runnable series of tsFor and distFor', done => {
|
|
24
|
+
gulpConfig.set('useTsConfig', true)
|
|
25
|
+
expect.assertions(2)
|
|
26
|
+
distSeries()()
|
|
27
|
+
setTimeout(() => {
|
|
28
|
+
expect(tsFor).toHaveBeenCalledWith(gulpConfig.get('tsSearch'), gulpConfig.get('distPath'))
|
|
29
|
+
expect(distFor).toHaveBeenCalledWith(gulpConfig.get('distSearch'), gulpConfig.get('distPath'))
|
|
30
|
+
done()
|
|
31
|
+
}, 500)
|
|
32
|
+
})
|
|
33
|
+
})
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
const { dest, src } = require('gulp')
|
|
2
|
+
const { default: uglify } = require('gulp-uglify-es')
|
|
3
|
+
const rename = require('gulp-rename')
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Minify files and rename the output with '.min' extension.
|
|
7
|
+
* @function
|
|
8
|
+
* @memberOf module:partials
|
|
9
|
+
* @returns {*}
|
|
10
|
+
*/
|
|
11
|
+
const minifyFor = (srcSearch, destination) => src(srcSearch)
|
|
12
|
+
.pipe(uglify())
|
|
13
|
+
.pipe(rename({ extname: '.min.js' }))
|
|
14
|
+
.pipe(dest(destination))
|
|
15
|
+
|
|
16
|
+
module.exports = minifyFor
|