js-build-tools 1.2.2 → 1.2.3

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.
@@ -1,22 +1,22 @@
1
- 'use strict'
2
-
3
- const fs = require('fs')
4
- const gulpConfig = require('../gulp.config.js')
5
- const jsdoc2md = require('jsdoc-to-markdown')
6
- const {
7
- globSync
8
- } = require('glob')
9
-
10
- /**
11
- * Appends all the jsdoc comments to the readme file. Assumes empty or templated file.
12
- * @returns {string|Uint8Array}
13
- */
14
- const addToReadme = done => {
15
- const files = globSync(gulpConfig.srcSearch)
16
- const readme = jsdoc2md.renderSync({
17
- files: files
18
- })
19
- fs.appendFileSync('README.md', readme, 'utf8')
20
- done()
21
- }
22
- module.exports = addToReadme
1
+ 'use strict'
2
+
3
+ const fs = require('fs')
4
+ const gulpConfig = require('../gulp.config.js')
5
+ const jsdoc2md = require('jsdoc-to-markdown')
6
+ const {
7
+ globSync
8
+ } = require('glob')
9
+
10
+ /**
11
+ * Appends all the jsdoc comments to the readme file. Assumes empty or templated file.
12
+ * @returns {string|Uint8Array}
13
+ */
14
+ const addToReadme = done => {
15
+ const files = globSync(gulpConfig.srcSearch)
16
+ const readme = jsdoc2md.renderSync({
17
+ files: files
18
+ })
19
+ fs.appendFileSync('README.md', readme, 'utf8')
20
+ done()
21
+ }
22
+ module.exports = addToReadme
package/dist/build.js CHANGED
@@ -1,23 +1,23 @@
1
- 'use strict'
2
-
3
- const bundle = require('./bundle')
4
- const bundleLint = require('./bundleLint')
5
- const bundleMinify = require('./bundleMinify')
6
- const clean = require('./clean')
7
- const compileReadme = require('./compileReadme')
8
- const dist = require('./dist')
9
- const distLint = require('./distLint')
10
- const distMinify = require('./distMinify')
11
- const {
12
- parallel,
13
- series
14
- } = require('gulp')
15
- const gulpConfig = require('../gulp.config.js')
16
- const testFull = require('./testFull')
17
-
18
- /**
19
- * Runs several processes to build and validate the project.
20
- * Cleans, distributes (lint and minify), bundles (lint and minify), creates the readme, then runs the tests.
21
- */
22
- const build = parallel(gulpConfig.nodeOnly ? series(clean, dist, parallel(distLint, distMinify)) : series(clean, dist, parallel(distLint, distMinify), bundle, parallel(bundleLint, bundleMinify)), compileReadme, testFull)
23
- module.exports = build
1
+ 'use strict'
2
+
3
+ const bundle = require('./bundle')
4
+ const bundleLint = require('./bundleLint')
5
+ const bundleMinify = require('./bundleMinify')
6
+ const clean = require('./clean')
7
+ const compileReadme = require('./compileReadme')
8
+ const dist = require('./dist')
9
+ const distLint = require('./distLint')
10
+ const distMinify = require('./distMinify')
11
+ const {
12
+ parallel,
13
+ series
14
+ } = require('gulp')
15
+ const gulpConfig = require('../gulp.config.js')
16
+ const testFull = require('./testFull')
17
+
18
+ /**
19
+ * Runs several processes to build and validate the project.
20
+ * Cleans, distributes (lint and minify), bundles (lint and minify), creates the readme, then runs the tests.
21
+ */
22
+ const build = parallel(gulpConfig.nodeOnly ? series(clean, dist, parallel(distLint, distMinify)) : series(clean, dist, parallel(distLint, distMinify), bundle, parallel(bundleLint, bundleMinify)), compileReadme, testFull)
23
+ module.exports = build
package/dist/bundle.js CHANGED
@@ -1,15 +1,15 @@
1
- 'use strict'
2
-
3
- const browserify = require('browserify')
4
- const {
5
- dest
6
- } = require('gulp')
7
- const gulpConfig = require('../gulp.config.js')
8
- const source = require('vinyl-source-stream')
9
-
10
- /**
11
- * Starting at the distribution entry point, bundle all the files into a single file and store them in the specified output directory.
12
- * @returns {*}
13
- */
14
- const bundle = () => browserify(gulpConfig.distMain).bundle().pipe(source(''.concat(gulpConfig.browserName, '.js'))).pipe(dest(gulpConfig.browserPath))
15
- module.exports = bundle
1
+ 'use strict'
2
+
3
+ const browserify = require('browserify')
4
+ const {
5
+ dest
6
+ } = require('gulp')
7
+ const gulpConfig = require('../gulp.config.js')
8
+ const source = require('vinyl-source-stream')
9
+
10
+ /**
11
+ * Starting at the distribution entry point, bundle all the files into a single file and store them in the specified output directory.
12
+ * @returns {*}
13
+ */
14
+ const bundle = () => browserify(gulpConfig.distMain).bundle().pipe(source(''.concat(gulpConfig.browserName, '.js'))).pipe(dest(gulpConfig.browserPath))
15
+ module.exports = bundle
@@ -1,20 +1,20 @@
1
- 'use strict'
2
-
3
- const {
4
- dest,
5
- src
6
- } = require('gulp')
7
- const gulpConfig = require('../gulp.config.js')
8
- const standard = require('gulp-standard')
9
-
10
- /**
11
- * Applies Standard code style linting to bundled file.
12
- * @returns {*}
13
- */
14
- const bundleLint = () => src(''.concat(gulpConfig.browserPath, '/').concat(gulpConfig.browserName, '.js')).pipe(standard({
15
- fix: true
16
- })).pipe(standard.reporter('default', {
17
- fix: true,
18
- quiet: true
19
- })).pipe(dest(gulpConfig.browserPath))
20
- module.exports = bundleLint
1
+ 'use strict'
2
+
3
+ const {
4
+ dest,
5
+ src
6
+ } = require('gulp')
7
+ const gulpConfig = require('../gulp.config.js')
8
+ const standard = require('gulp-standard')
9
+
10
+ /**
11
+ * Applies Standard code style linting to bundled file.
12
+ * @returns {*}
13
+ */
14
+ const bundleLint = () => src(''.concat(gulpConfig.browserPath, '/').concat(gulpConfig.browserName, '.js')).pipe(standard({
15
+ fix: true
16
+ })).pipe(standard.reporter('default', {
17
+ fix: true,
18
+ quiet: true
19
+ })).pipe(dest(gulpConfig.browserPath))
20
+ module.exports = bundleLint
@@ -1,20 +1,20 @@
1
- 'use strict'
2
-
3
- const {
4
- dest,
5
- src
6
- } = require('gulp')
7
- const gulpConfig = require('../gulp.config.js')
8
- const {
9
- default: uglify
10
- } = require('gulp-uglify-es')
11
- const rename = require('gulp-rename')
12
-
13
- /**
14
- * Creates the minified bundle file.
15
- * @returns {*}
16
- */
17
- const bundleMinify = () => src(''.concat(gulpConfig.browserPath, '/').concat(gulpConfig.browserName, '.js')).pipe(uglify()).pipe(rename({
18
- extname: '.min.js'
19
- })).pipe(dest(gulpConfig.browserPath))
20
- module.exports = bundleMinify
1
+ 'use strict'
2
+
3
+ const {
4
+ dest,
5
+ src
6
+ } = require('gulp')
7
+ const gulpConfig = require('../gulp.config.js')
8
+ const {
9
+ default: uglify
10
+ } = require('gulp-uglify-es')
11
+ const rename = require('gulp-rename')
12
+
13
+ /**
14
+ * Creates the minified bundle file.
15
+ * @returns {*}
16
+ */
17
+ const bundleMinify = () => src(''.concat(gulpConfig.browserPath, '/').concat(gulpConfig.browserName, '.js')).pipe(uglify()).pipe(rename({
18
+ extname: '.min.js'
19
+ })).pipe(dest(gulpConfig.browserPath))
20
+ module.exports = bundleMinify
package/dist/clean.js CHANGED
@@ -1,11 +1,11 @@
1
- 'use strict'
2
-
3
- const del = require('del')
4
- const gulpConfig = require('../gulp.config.js')
5
-
1
+ 'use strict'
2
+
3
+ const del = require('del')
4
+ const gulpConfig = require('../gulp.config.js')
5
+
6
6
  /**
7
7
  * Deletes all the distribution and browser files (used before create a new build).
8
8
  * @returns {Promise<string[]> | *}
9
- */
10
- const clean = () => del([gulpConfig.distPath, gulpConfig.browserPath])
11
- module.exports = clean
9
+ */
10
+ const clean = () => del([gulpConfig.distPath, gulpConfig.browserPath])
11
+ module.exports = clean
@@ -1,13 +1,13 @@
1
- 'use strict'
2
-
3
- const addToReadme = require('./addToReadme')
4
- const readmeTemplate = require('./readmeTemplate')
5
- const {
6
- series
7
- } = require('gulp')
8
-
9
- /**
10
- * Generate the README.md file based off of the template, then append the generated documentation.
11
- */
12
- const compileReadme = series(readmeTemplate, addToReadme)
13
- module.exports = compileReadme
1
+ 'use strict'
2
+
3
+ const addToReadme = require('./addToReadme')
4
+ const readmeTemplate = require('./readmeTemplate')
5
+ const {
6
+ series
7
+ } = require('gulp')
8
+
9
+ /**
10
+ * Generate the README.md file based off of the template, then append the generated documentation.
11
+ */
12
+ const compileReadme = series(readmeTemplate, addToReadme)
13
+ module.exports = compileReadme
package/dist/default.js CHANGED
@@ -1,14 +1,14 @@
1
- 'use strict'
2
-
3
- const {
4
- series
5
- } = require('gulp')
6
- const dist = require('./dist')
7
- const bundle = require('./bundle')
8
- const gulpConfig = require('../gulp.config')
9
-
10
- /**
11
- * Recommended as the default task, runs the simple dist and bundle tasks.
12
- */
13
- const defaultCmd = gulpConfig.nodeOnly ? series(dist) : series(dist, bundle)
14
- module.exports = defaultCmd
1
+ 'use strict'
2
+
3
+ const {
4
+ series
5
+ } = require('gulp')
6
+ const dist = require('./dist')
7
+ const bundle = require('./bundle')
8
+ const gulpConfig = require('../gulp.config')
9
+
10
+ /**
11
+ * Recommended as the default task, runs the simple dist and bundle tasks.
12
+ */
13
+ const defaultCmd = gulpConfig.nodeOnly ? series(dist) : series(dist, bundle)
14
+ module.exports = defaultCmd
package/dist/dist.js CHANGED
@@ -1,10 +1,10 @@
1
- 'use strict'
2
-
3
- const distFor = require('./distFor.js')
4
-
5
- /**
6
- * Simplified distribution tasks which will use arguments from distFor.
7
- * @returns {*}
8
- */
9
- const dist = () => distFor()
10
- module.exports = dist
1
+ 'use strict'
2
+
3
+ const distFor = require('./distFor.js')
4
+
5
+ /**
6
+ * Simplified distribution tasks which will use arguments from distFor.
7
+ * @returns {*}
8
+ */
9
+ const dist = () => distFor()
10
+ module.exports = dist
package/dist/distFor.js CHANGED
@@ -1,21 +1,21 @@
1
- 'use strict'
2
-
3
- const babel = require('gulp-babel')
4
- const {
5
- dest,
6
- src
7
- } = require('gulp')
8
- const gulpConfig = require('../gulp.config.js')
9
-
10
- /**
11
- * Build the distribution for a given source pattern.
12
- * @param {string|array} srcPath
13
- * @param {string} destPath
14
- * @returns {*}
15
- */
16
- const distFor = function () {
17
- const srcPath = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : gulpConfig.srcSearch
18
- const destPath = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : gulpConfig.distPath
19
- return src(srcPath).pipe(babel()).pipe(dest(destPath))
20
- }
21
- module.exports = distFor
1
+ 'use strict'
2
+
3
+ const babel = require('gulp-babel')
4
+ const {
5
+ dest,
6
+ src
7
+ } = require('gulp')
8
+ const gulpConfig = require('../gulp.config.js')
9
+
10
+ /**
11
+ * Build the distribution for a given source pattern.
12
+ * @param {string|array} srcPath
13
+ * @param {string} destPath
14
+ * @returns {*}
15
+ */
16
+ const distFor = function () {
17
+ const srcPath = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : gulpConfig.srcSearch
18
+ const destPath = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : gulpConfig.distPath
19
+ return src(srcPath).pipe(babel()).pipe(dest(destPath))
20
+ }
21
+ module.exports = distFor
package/dist/distLint.js CHANGED
@@ -1,20 +1,20 @@
1
- 'use strict'
2
-
3
- const gulpConfig = require('../gulp.config.js')
4
- const {
5
- dest,
6
- src
7
- } = require('gulp')
8
- const standard = require('gulp-standard')
9
-
10
- /**
11
- * Applies Standard code style linting to distribution files.
12
- * @returns {*}
13
- */
14
- const distLint = () => src(gulpConfig.distSearch).pipe(standard({
15
- fix: true
16
- })).pipe(standard.reporter('default', {
17
- fix: true,
18
- quiet: true
19
- })).pipe(dest(gulpConfig.distPath))
20
- module.exports = distLint
1
+ 'use strict'
2
+
3
+ const gulpConfig = require('../gulp.config.js')
4
+ const {
5
+ dest,
6
+ src
7
+ } = require('gulp')
8
+ const standard = require('gulp-standard')
9
+
10
+ /**
11
+ * Applies Standard code style linting to distribution files.
12
+ * @returns {*}
13
+ */
14
+ const distLint = () => src(gulpConfig.distSearch).pipe(standard({
15
+ fix: true
16
+ })).pipe(standard.reporter('default', {
17
+ fix: true,
18
+ quiet: true
19
+ })).pipe(dest(gulpConfig.distPath))
20
+ module.exports = distLint
@@ -1,20 +1,20 @@
1
- 'use strict'
2
-
3
- const {
4
- dest,
5
- src
6
- } = require('gulp')
7
- const gulpConfig = require('../gulp.config.js')
8
- const {
9
- default: uglify
10
- } = require('gulp-uglify-es')
11
- const rename = require('gulp-rename')
12
-
13
- /**
14
- * Creates minified versions of the dist files.
15
- * @returns {*}
16
- */
17
- const distMinify = () => src(gulpConfig.distSearch).pipe(uglify()).pipe(rename({
18
- extname: '.min.js'
19
- })).pipe(dest(gulpConfig.distPath))
20
- module.exports = distMinify
1
+ 'use strict'
2
+
3
+ const {
4
+ dest,
5
+ src
6
+ } = require('gulp')
7
+ const gulpConfig = require('../gulp.config.js')
8
+ const {
9
+ default: uglify
10
+ } = require('gulp-uglify-es')
11
+ const rename = require('gulp-rename')
12
+
13
+ /**
14
+ * Creates minified versions of the dist files.
15
+ * @returns {*}
16
+ */
17
+ const distMinify = () => src(gulpConfig.distSearch).pipe(uglify()).pipe(rename({
18
+ extname: '.min.js'
19
+ })).pipe(dest(gulpConfig.distPath))
20
+ module.exports = distMinify
@@ -1,15 +1,15 @@
1
- 'use strict'
2
-
3
- const {
4
- dest,
5
- src
6
- } = require('gulp')
7
- const gulpConfig = require('../gulp.config.js')
8
- const rename = require('gulp-rename')
9
-
10
- /**
11
- * Copy a readme template into the README.md file.
12
- * @returns {*}
13
- */
14
- const readmeTemplate = () => src(gulpConfig.readmeTemplate).pipe(rename('README.md')).pipe(dest('.'))
15
- module.exports = readmeTemplate
1
+ 'use strict'
2
+
3
+ const {
4
+ dest,
5
+ src
6
+ } = require('gulp')
7
+ const gulpConfig = require('../gulp.config.js')
8
+ const rename = require('gulp-rename')
9
+
10
+ /**
11
+ * Copy a readme template into the README.md file.
12
+ * @returns {*}
13
+ */
14
+ const readmeTemplate = () => src(gulpConfig.readmeTemplate).pipe(rename('README.md')).pipe(dest('.'))
15
+ module.exports = readmeTemplate
package/dist/testFull.js CHANGED
@@ -1,13 +1,13 @@
1
- 'use strict'
2
-
3
- const gulpConfig = require('../gulp.config.js')
4
- const {
5
- runCLI: jest
6
- } = require('jest')
7
-
8
- /**
9
- * Run all tests with jest.
10
- * @returns {Promise<*>}
11
- */
12
- const testFull = async () => await jest({}, gulpConfig.testPath)
13
- module.exports = testFull
1
+ 'use strict'
2
+
3
+ const gulpConfig = require('../gulp.config.js')
4
+ const {
5
+ runCLI: jest
6
+ } = require('jest')
7
+
8
+ /**
9
+ * Run all tests with jest.
10
+ * @returns {Promise<*>}
11
+ */
12
+ const testFull = async () => await jest({}, gulpConfig.testPath)
13
+ module.exports = testFull