Merge pull request #804 from readthedocs/agj/force-neat-19

Comment on why bourbon-neat is pinned

Author: agjohnson

.gitignore

@@ -9,7 +9,6 @@
 *.map
 .ropeproject/
 .ruby-version
-bin/
 dist/
 bower_components/
 include/

bin/preinstall.js

@@ -0,0 +1,20 @@
+#!/usr/bin/env node
+
+const package = require('../package.json');
+
+// Sorry everyone, this is the closest we can get to commenting on package.json
+// dependencies :(
+if (package.devDependencies['bourbon-neat'] !== '~1.9') {
+    // Wyrm is not compatible with Neat 2.0+, and Neat 1.9 at least pins a
+    // node-sass version that doesn't require Python 2. The changes to Wyrm to
+    // support Neat 2.0+ are all fairly minor changes, but it deeply affects the
+    // grid system and might be more of a liability than an old release of Neat.
+    // See: https://github.com/readthedocs/sphinx_rtd_theme/pull/771
+    console.error(
+        'bourbon-neat 1.9 is required, Wyrm is not compatible with Neat 2.0+.'
+    );
+    console.error(
+        'The expected selector for the bourbon-neat dependency in package.json is "~1.9".'
+    );
+    process.exit(1);
+}

package.json

@@ -5,7 +5,8 @@
   "private": true,
   "scripts": {
     "dev": "webpack-dev-server --open --config webpack.dev.js",
-    "build": "webpack --config webpack.prod.js"
+    "build": "webpack --config webpack.prod.js",
+    "preinstall": "bin/preinstall.js"
   },
   "dependencies": {},
   "devDependencies": {