Fix resolution of calling project package.json file (Fixes #532)

It appears that `process.env.PWD` is not consistent across platform as well
as across sub-directory invocations. Indeed, even if it is consistent on
Mac OS X (and probably Unix at the same time but untested), there is
inconsitencies problem on Windows when using a POSIX transformer platform
like Cygwin or MSYS2.

Indeed, in those cases, `PWD` is not the canonical Windows path but the
original POSIX path of the terminal. Furthermore, invoking from a
sub-directory also fiddles with the `PWD` adding subdirectory into it.

To fix that, it seems that Gulp is providing an environment variable that
points to the root directory of the project and which is constant across
platforms. See gulpjs/gulp@2bf23ba
for the actual INIT_CWD implementation.

So, to fix the problem everywhere, added a function `resolveRelativeToProject`
that does the correct resolving using `INIT_CWD` environment variable
instead of the previously used `PWD`.

To make stuff easier to use next time, a `projectPath` function was added
that does the resolving of paths relative to the project root directory.
All previous usages of `path.(resolve|join)(process.env.PWD, ...)` that were
used throughout the website are now using `projectPath(...)` instead.

Fixed bin script `blendid/gulpfile.js/index.js` resolution to use `__dirname`
instead of `require.resolve`. The `require.resolve` does not work when using
`yarn link` to development `blendid` features. Indeed, `require.resolve` does
the resolution from the linked project leading to `blendid` not being
resolvable (because not present in the linked `node_modules` directory). By
using `__dirname`, we achieve the same goal as before but being more robust
to linked project for development.

Author: maoueh

bin/blendid.js

@@ -1,10 +1,10 @@
 #!/usr/bin/env node
-const path = require('path');
+const path = require('path')
 
 const additionalArgs = require('minimist')(process.argv.slice(2))._
-const blendidEntryFile = require.resolve('blendid');
-const gulpModulePath = path.dirname(require.resolve('gulp'));
-const gulpBinaryFile = path.join(gulpModulePath, '/bin/gulp');
+const blendidEntryFile = path.resolve(__dirname, '../gulpfile.js/index.js')
+const gulpModulePath = path.dirname(require.resolve('gulp'))
+const gulpBinaryFile = path.join(gulpModulePath, '/bin/gulp')
 
 let args = ['--gulpfile', blendidEntryFile]
 

extras/tasks/iconFont/index.js

@@ -7,16 +7,17 @@ var generateIconSass = require('./generateIconSass')
 var handleErrors     = require('../../lib/handleErrors')
 var package          = require('../../../package.json')
 var path             = require('path')
+var projectPath      = require('../../lib/projectPath')
 var url              = require('url')
 
-var fontPath = path.resolve(process.env.PWD, config.root.dest, config.tasks.iconFont.dest)
-var cssPath = path.resolve(process.env.PWD, config.root.dest, config.tasks.css.dest)
+var fontPath = projectPath(config.root.dest, config.tasks.iconFont.dest)
+var cssPath = projectPath(config.root.dest, config.tasks.css.dest)
 
 var settings = {
   name: package.name + ' icons',
-  src: path.resolve(process.env.PWD, config.root.src, config.tasks.iconFont.src, '*.svg'),
-  dest: path.resolve(process.env.PWD, config.root.dest, config.tasks.iconFont.dest),
-  sassDest: path.resolve(process.env.PWD, config.root.src, config.tasks.css.src, config.tasks.iconFont.sassDest),
+  src: projectPath(config.root.src, config.tasks.iconFont.src, '*.svg'),
+  dest: projectPath(config.root.dest, config.tasks.iconFont.dest),
+  sassDest: projectPath(config.root.src, config.tasks.css.src, config.tasks.iconFont.sassDest),
   template: path.normalize('./gulpfile.js/tasks/iconFont/template.sass'),
   sassOutputName: '_icons.sass',
   fontPath: url.resolve('.',path.relative(cssPath, fontPath)),

extras/tasks/server.js

@@ -1,15 +1,16 @@
-var compress = require('compression')
-var config   = require('../config')
-var express  = require('express')
-var gulp     = require('gulp')
-var log      = require('fancy-log')
-var colors   = require('ansi-colors')
-var logger   = require('morgan')
-var open     = require('open')
-var path     = require('path')
+var compress    = require('compression')
+var config      = require('../config')
+var express     = require('express')
+var gulp        = require('gulp')
+var log         = require('fancy-log')
+var colors      = require('ansi-colors')
+var logger      = require('morgan')
+var open        = require('open')
+var projectPath = require('../lib/projectPath')
+
 
 var settings = {
-  root: path.resolve(process.env.PWD, config.root.dest),
+  root: projectPath(config.root.dest),
   port: process.env.PORT || 5000,
   logLevel: process.env.NODE_ENV ? 'combined' : 'dev',
   staticOptions: {

gulpfile.js/index.js

@@ -7,13 +7,9 @@
   automatically required below.
 */
 
-const path = require('path')
 const gulp = require('gulp')
 const requireDir = require('require-dir')
 
-// Fallback for windows backs out of node_modules folder to root of project
-process.env.PWD = process.env.PWD || path.resolve(process.cwd(), '../../')
-
 // Globally expose config objects
 global.PATH_CONFIG = require('./lib/get-path-config')
 global.TASK_CONFIG = require('./lib/get-task-config')

gulpfile.js/lib/get-path-config.js

@@ -1,13 +1,13 @@
-const path = require('path')
+const projectPath = require('./projectPath');
 const fs = require('fs')
 
 function getPathConfig() {
 
   if(process.env.BLENDID_CONFIG_PATH) {
-    return require(path.resolve(process.env.PWD, process.env.BLENDID_CONFIG_PATH, 'path-config.json'))
+    return require(projectPath(process.env.BLENDID_CONFIG_PATH, 'path-config.json'))
   }
 
-  const defaultConfigPath = path.resolve(process.env.PWD, 'config/path-config.json')
+  const defaultConfigPath = projectPath('config/path-config.json')
 
   if (fs.existsSync(defaultConfigPath)) {
     return require(defaultConfigPath)

gulpfile.js/lib/get-task-config.js

@@ -1,15 +1,15 @@
-const path         = require('path')
 const fs           = require('fs')
+const projectPath  = require('./projectPath')
 const taskDefaults = require('./task-defaults')
 const mergeWith    = require('lodash/mergeWith')
 
 function getTaskConfig () {
 
   if(process.env.BLENDID_CONFIG_PATH) {
-    return require(path.resolve(process.env.PWD, process.env.BLENDID_CONFIG_PATH, 'task-config.js'))
+    return require(projectPath(process.env.BLENDID_CONFIG_PATH, 'task-config.js'))
   }
 
-  const defaultConfigPath = path.resolve(process.env.PWD, 'config/task-config.js')
+  const defaultConfigPath = projectPath('config/task-config.js')
 
   if (fs.existsSync(defaultConfigPath)) {
     return require(defaultConfigPath)

gulpfile.js/lib/projectPath.js

@@ -0,0 +1,19 @@
+var path = require('path')
+
+/**
+ * A function that can be used to resolve a path relatively to the
+ * project directory.
+ *
+ * We often want to resolve paths relatively to the project root
+ * directory. To do that, we use the `INIT_CWD` environment variable
+ * provided by Gulp. This variable always resolves to the project
+ * root directory so we use it as the seed path and then add the
+ * remaining arguments passed and resolving everything using the
+ * `path.resolve` function.
+ *
+ * The returned path is a fully resolved absolute path relative to
+ * the project root directory.
+ */
+module.exports = function projectPath(...paths) {
+  return path.resolve(process.env.INIT_CWD, ...paths);
+}

gulpfile.js/lib/task-defaults.js

@@ -1,6 +1,7 @@
-const os   = require('os')
-const path = require('path')
-const pkg  = require(path.resolve(process.env.PWD, 'package.json'))
+const os          = require('os')
+const path        = require('path')
+const projectPath = require('./projectPath')
+const pkg         = require(projectPath('package.json'))
 
 module.exports = {
   javascripts: {

gulpfile.js/lib/webpack-multi-config.js

@@ -6,6 +6,7 @@ if (!TASK_CONFIG.javascripts) {
 
 const path            = require('path')
 const pathToUrl       = require('./pathToUrl')
+const projectPath     = require('./projectPath')
 const webpack         = require('webpack')
 const webpackManifest = require('./webpackManifest')
 const querystring     = require('querystring')
@@ -14,8 +15,8 @@ module.exports = function (env) {
 
   process.env['BABEL_ENV'] = process.env['BABEL_ENV'] || process.env['NODE_ENV'] || env
 
-  const jsSrc = path.resolve(process.env.PWD, PATH_CONFIG.src, PATH_CONFIG.javascripts.src)
-  const jsDest = path.resolve(process.env.PWD, PATH_CONFIG.dest, PATH_CONFIG.javascripts.dest)
+  const jsSrc = projectPath(PATH_CONFIG.src, PATH_CONFIG.javascripts.src)
+  const jsDest = projectPath(PATH_CONFIG.dest, PATH_CONFIG.javascripts.dest)
   const publicPath = pathToUrl(TASK_CONFIG.javascripts.publicPath || PATH_CONFIG.javascripts.dest, '/')
   const rev = TASK_CONFIG.production.rev && env === 'production'
 
@@ -39,7 +40,7 @@ module.exports = function (env) {
     resolve: {
       extensions: extensions,
       alias: TASK_CONFIG.javascripts.alias,
-      modules: [jsSrc, path.resolve(process.env.PWD, 'node_modules')],
+      modules: [jsSrc, projectPath('node_modules')],
     },
     module: {
       rules: [ TASK_CONFIG.javascripts.babelLoader ]

gulpfile.js/lib/webpackManifest.js

@@ -1,5 +1,6 @@
-const path = require('path')
-const fs   = require('fs')
+const path        = require('path')
+const projectPath = require('./projectPath')
+const fs          = require('fs')
 
 module.exports = function(jsDest, dest, filename) {
   filename = filename || 'rev-manifest.json'
@@ -18,7 +19,7 @@ module.exports = function(jsDest, dest, filename) {
       }
 
       fs.writeFileSync(
-        path.resolve(process.env.PWD, dest, filename),
+        projectPath(dest, filename),
         JSON.stringify(manifest)
       )
     })