Comment on why bourbon-neat is pinned

This will actually fail `npm install` if you try upgrading the version.
This commit is contained in:
Anthony Johnson
2019-07-25 19:12:34 -06:00
parent 7e0d7933ad
commit 35320c29f6
3 changed files with 19 additions and 2 deletions

1
.gitignore vendored
View File

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

17
bin/preinstall.js Executable file
View File

@@ -0,0 +1,17 @@
#!/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+'
);
process.exit(1);
}

View File

@@ -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": {