Add gulp pack

Author: ehmicky

.nycrc.json

@@ -1,5 +1,4 @@
 {
-  "include": ["build"],
-  "all": true,
+  "include": ["dist", "{index,register}.js"],
   "reporter": ["lcov", "text"]
 }

.travis.yml

@@ -6,7 +6,7 @@ os:
   - osx
   - linux
 dist: xenial
-script: npm run ci-test
+script: npm test
 # When pushing a tagged commit, Travis adds two builds: one with the tag, one
 # without. We only want to build the one with the tag, because it's the one
 # that runs the deployment stage

gulp/exec.js

@@ -31,7 +31,7 @@ const addStdio = function({ opts }) {
   return { ...opts, stdio: 'inherit' }
 }
 
-const STDIO_OPTIONS = ['stdio', 'stdin', 'stdout', 'stderr']
+const STDIO_OPTIONS = ['stdio', 'stdin', 'stdout', 'stderr', 'input']
 
 // Retrieve error message to print
 const getErrorMessage = function({

gulp/tasks/build.js

@@ -6,14 +6,12 @@ const { getWatchTask } = require('../utils')
 const { BUILD_SRC, BUILD_DIST } = require('../files')
 const gulpExeca = require('../exec')
 
-const { pack } = require('./pack')
-
 const babel = () =>
   gulpExeca(
     `babel ${BUILD_SRC} --out-dir ${BUILD_DIST} --copy-files --delete-dir-on-start --source-maps --no-comments --minified --retain-lines`,
   )
 
-const build = series(babel, pack)
+const build = series(babel)
 
 // eslint-disable-next-line fp/no-mutation
 build.description = 'Build source files'

gulp/tasks/index.js

@@ -6,6 +6,5 @@ module.exports = {
   ...require('./check'),
   ...require('./unit'),
   ...require('./build'),
-  ...require('./pack'),
   ...require('./emit'),
 }

gulp/tasks/pack.js

@@ -4,17 +4,50 @@ const { readFile } = require('fs')
 const { promisify } = require('util')
 
 const { load: loadYaml } = require('js-yaml')
+const isCi = require('is-ci')
 
-const { getWatchTask } = require('../utils')
+const { name } = require('../../package.json')
+const { getWatchTask, pack } = require('../utils')
 const gulpExeca = require('../exec')
 
 const TRAVIS_CONFIG = `${__dirname}/../../.travis.yml`
 
-const unit = () => gulpExeca('ava')
+const unit = async function() {
+  // In CI, we use `pack`, but not locally since it is slow.
+  // Also, in CI we do test coverage and send it to Coveralls.
+  if (!isCi) {
+    return gulpExeca('ava')
+  }
+
+  // When using `pack`, tested files will be inside `node_modules`
+  // By default `nyc` ignore those, so we need to add them to `--include``
+  // Even after this, `node_modules` are still ignored by `nyc` unless using
+  // a negated `--exclude`
+  await pack(`nyc --include ${NESTED_DIR} --exclude !${NESTED_DIR} ava`)
+
+  await sendToCoveralls()
+}
 
 // eslint-disable-next-line fp/no-mutation
 unit.description = 'Run unit tests'
 
+const sendToCoveralls = async function() {
+  // We strip `node_modules/PACKAGE/` from test coverage reports so it looks
+  // like source files were in the same directory (not inside `node_modules`).
+  const covMap = await promisify(readFile)(COVMAP_PATH, { encoding: 'utf-8' })
+  const covMapA = covMap.replace(NESTED_DIR_REGEXP, '')
+
+  await gulpExeca('coveralls', { input: covMapA })
+}
+
+const NESTED_DIR = `node_modules/${name}`
+// The RegExp needs to account for Windows having different separators.
+const NESTED_DIR_REGEXP = new RegExp(
+  `node_modules(\\/|\\\\)${name}(\\/|\\\\)`,
+  'gu',
+)
+const COVMAP_PATH = './coverage/lcov.info'
+
 // We have to use this to debug Ava test files with Chrome devtools
 const unitwatch = getWatchTask({ UNIT: unit }, unit)
 

gulp/tasks/unit.js

@@ -2,4 +2,5 @@
 
 module.exports = {
   ...require('./watch'),
+  ...require('./pack'),
 }

gulp/utils/index.js

@@ -0,0 +1,6 @@
+{
+  "ENV_VAR": {
+    "NAME": "GULP_PACK",
+    "VALUE": "1"
+  }
+}

gulp/utils/pack/constants.json

@@ -0,0 +1,28 @@
+'use strict'
+
+const { env } = require('process')
+
+const { getPackageRootSync, getManifest } = require('./root')
+const { ENV_VAR } = require('./constants')
+
+// Retrieve the package root directory.
+// When run with `pack`, the package will first be packed with `npm pack` so
+// that it is required the same way as on the npm repository.
+// This help detecting problems in the package due to:
+//  - missing files in the package (`.npmignore`, `files` field)
+//  - wrong entry point (`main` or `browser` field)
+//  - requiring `devDependencies` in production code
+const getPackage = function() {
+  const packageRoot = getPackageRootSync()
+
+  if (env[ENV_VAR.NAME] !== ENV_VAR.VALUE) {
+    return packageRoot
+  }
+
+  const { name } = getManifest({ packageRoot })
+  return name
+}
+
+module.exports = {
+  getPackage,
+}