bootstrapPath configurable via query string #255

CHANGELOG.md

@@ -3,6 +3,10 @@ All notable changes to this project will be documented in this file. Items under
 
 Contributors: please follow the recommendations outlined at [keepachangelog.com](http://keepachangelog.com/). Please use the existing headings and styling as a guide, and add a link for the version diff at the bottom of the file. Also, please update the `Unreleased` link to compare to the latest release version.
 
+## Unreleased
+##### Added
+- Make `bootstrap`/`bootstrap-sass` path configurable so that it can be found when `bootstrap-loader` is symlinked in development. [#255](https://github.com/shakacode/bootstrap-loader/pull/255) by [vjpr](https://github.com/vjpr).
+
 ## [2.0.0.beta.21] - 2017-02-16
 ##### Updates
 - Update Example Dependencies [#261](https://github.com/shakacode/bootstrap-loader/pull/261) and [#259](https://github.com/shakacode/bootstrap-loader/pull/259)  by [judahmeek](https://github.com/judahmeek)
@@ -15,7 +19,6 @@ Contributors: please follow the recommendations outlined at [keepachangelog.com]
 ##### Fixed
 - Allow `styleLoaders` config with only `env` config. [#227](https://github.com/shakacode/bootstrap-loader/pull/227) by [bertho-zero](https://github.com/bertho-zero).
 
-
 ## [2.0.0.beta.17] - 2016-12-04
 ##### Added
 - Allow `styleLoaders` to depend on the environment variable `NODE_ENV` [#222](https://github.com/shakacode/bootstrap-loader/pull/222) by [bertho-zero](https://github.com/bertho-zero).

README.md

@@ -532,6 +532,18 @@ And in your `./config/sass-resources.scss`:
 
 You can then use mixins and variables from Bootstrap in your own code.
 
+### Using a custom location for bootstrap module
+
+By default, `bootstrap-loader` will try to resolve `bootstrap` from where `bootstrap-loader` has been installed. In [certain situations](https://github.com/shakacode/bootstrap-loader/issues/254) (e.g. npm linking, using a custom package installer) it may not be resolvable. In this case, you can pass in the location manually.
+
+```js
+require('bootstrap-loader?bootstrapPath=/path/to/bootstrap');
+
+// or
+
+entry: [ 'bootstrap-loader?bootstrapPath=/path/to/bootstrap', './app' ]
+```
+
 ## Contributing
 See [Contributing](CONTRIBUTING.md) to get started.
 

node_package/tests/utils/buildExtractStylesLoader.test.js

@@ -1,5 +1,6 @@
 import test from 'tape';
 import path from 'path';
+import fs from 'fs';
 import buildExtractStylesLoader from '../../../src/utils/buildExtractStylesLoader';
 
 test('buildExtractStylesLoader throws error if ary doesnt have "style-" at ary[0]', (assert) => {
@@ -12,18 +13,10 @@ your 'styleLoaders' array starts with 'style' or 'isomorphic-style' at index 0.
 
 test('buildExtractStylesLoader runs as expected', (assert) => {
   assert.equals(buildExtractStylesLoader(['style-loader', 'url-loader', 'css-loader']),
-    path.join(
-      `${__dirname}`,
-      '../../../node_modules/extract-text-webpack-plugin' +
-      '/loader.js?{"omit":1,"remove":true}!style-loader!url-loader!css-loader!',
-    ),
+    `${fs.realpathSync(path.join(__dirname, '../../../node_modules/extract-text-webpack-plugin'))}/loader.js?{"omit":1,"remove":true}!style-loader!url-loader!css-loader!`,
   );
   assert.equals(buildExtractStylesLoader(['isomorphic-style-loader', 'url-loader', 'css-loader']),
-    path.join(
-      `${__dirname}`,
-      '../../../node_modules/extract-text-webpack-plugin' +
-      '/loader.js?{"omit":1,"remove":true}!isomorphic-style-loader!url-loader!css-loader!',
-    ),
+    `${fs.realpathSync(path.join(__dirname, '../../../node_modules/extract-text-webpack-plugin'))}/loader.js?{"omit":1,"remove":true}!isomorphic-style-loader!url-loader!css-loader!`,
   );
   assert.end();
 });

src/bootstrap.loader.js

@@ -55,7 +55,7 @@ module.exports = function() {};
 module.exports.pitch = function(source) {
   if (this.cacheable) this.cacheable();
 
-  const { extractStyles, configFilePath } = loaderUtils.getOptions(this) || {};
+  const { extractStyles, configFilePath, bootstrapPath } = loaderUtils.getOptions(this) || {};
 
   if (configFilePath) {
     const fullPathToUserConfig = path.resolve(__dirname, configFilePath);
@@ -107,13 +107,14 @@ module.exports.pitch = function(source) {
 
   logger.debug('Using Bootstrap module:', bootstrapNPMModule);
 
-  config.bootstrapPath = resolveModule(bootstrapNPMModule);
+  config.bootstrapPath = bootstrapPath || resolveModule(bootstrapNPMModule);
   logger.debug(`Bootstrap module location (abs): ${config.bootstrapPath}`);
   if (!config.bootstrapPath) {
-    throw new Error(`
-Could not find bootstrap version: '${bootstrapVersion}'. Did you install it?
-The package is 'bootstrap' for bootstrap v4 and 'bootstrap-sass' for v3.
-`);
+    let msg = `Could not resolve module '${bootstrapNPMModule}' which must be installed when bootstrap version is configured to v${bootstrapVersion}.
+You must install 'bootstrap' for bootstrap v4 or 'bootstrap-sass' for bootstrap v3.
+You can also specify the location manually by specifying 'bootstrapPath' in bootstrap-loader's query string.
+See https://github.com/shakacode/bootstrap-loader/blob/master/README.md#usage.`;
+    throw new Error(msg);
   }
 
   config.bootstrapRelPath = path.relative(this.context, config.bootstrapPath);