TROUBLESHOOTING.md

Troubleshooting

This document covers some common node-sass issues and how to resolve them. You should always follow these steps before opening a new issue.

TOC

• Installation problems
  • "Module did not self-register"
    • Windows
  • Assertion failed: (handle->flags & UV_CLOSING), function uv__finish_close
  • Cannot find module '/root/<...>/install.js'
    • Linux
• Glossary
  • Which node runtime am I using?
  • Which version of node am I using?
  • Debugging installation issues.
    • Windows
    • Linux/OSX

Installation problems

"Module did not self-register"

Windows

This can happen if you are using io.js rather than node. Unfortunately this issue is due to an issue with a library we depend on and such is currently out of our control. The problem is a side effect of iojs aliasing the node.exe binary to itself.

To work around this now be sure to execute your node commands using iojs instead of node i.e.

$ iojs ./node_modules/.bin/node-sass --version

If this didn't solve your problem please open an issue with the output from our debugging script.

Assertion failed: (handle->flags & UV_CLOSING), function uv__finish_close

This issue primarily affected early [email protected] alpha and beta releases, although it did occassionally happen in [email protected].

The only fix for this issue is to update to node-sass >= 3.0.0.

If this didn't solve your problem please open an issue with the output from our debugging script.

Cannot find module '/root/<...>/install.js'

Linux

This can happen if you are install node-sass as root, or globally with sudo. This is a security feature of npm. You should always avoid running npm as sudo because install scripts can be unintentionally malicious.

If you must however, you can work around this error by using the --unsafe-perm flag with npm install i.e.

$ sudo npm install --unsafe-perm -g node-sass

If this didn't solve your problem please open an issue with the output from our debugging script.

Glossary

Which node runtime am I using?

There are two primary node runtimes, Node.js and io.js, both of which are supported by node-sass. To determine which you are currenty using you first need to determine which node runtime you are running.

node -v

If the version reported begins with a 0, you are running Node.js, otherwise you are running io.js.

Which version of node am I using?

To determine which version of Node.js or io.js you are currenty using run the following command in a terminal.

node -v

The resulting value the version you are running.

Debugging installation issues.

Node sass runs some install scripts to make it as easy to use as possible, but some times there can be issues. Before opening a new issue please follow the instructions for Windows or Linux/OSX and provide their output in you GitHub issue.

Remember to always search before opening a new issue.

Windows

Firstly create a clean work space.

mkdir \temp1
cd \temp1

Gather some basic diagnostic information.

npm -v              
node -v
node -p process.versions
node -p process.platform
node -p process.arch

Install the latest node-sass

npm install node-sass

Note which version was installed by opening the package.json file with a text editor.

{
  "name": "node-sass",
  "version": "3.0.0",
  "libsass": "3.2.0",
}

If node-sass install successfully lets gather some basic installation infomation.

.\node_modules\.bin\node-sass --version
node -p "console.log(require('node-sass').info)"

If the node-sass installation process produced an error, open the vendor folder.

cd node_modules\node-sass\vendor

Then, using the version number we gather at the beginning, go to https://github.com/sass/node-sass-binaries/tree/v.

There you should see a folder with same name as the one in the vendor folder. Download the binding.node file from that folder and replace your own with it.

Test if that worked by gathering some basic installation infomation.

.\node_modules\.bin\node-sass --version
node -p "console.log(require('node-sass').info)"

If this still produces an error please open an issue with the output from these steps.

Linux/OSX

Firstly create a clean work space.

mkdir ~/temp1
cd ~/temp1

Gather some basic diagnostic information.

npm -v              
node -v
node -p process.versions
node -p process.platform
node -p process.arch

Install the latest node-sass

npm install node-sass

Note which version was installed by opening the package.json file with a text editor.

{
  "name": "node-sass",
  "version": "3.0.0",
  "libsass": "3.2.0",
}

If node-sass install successfully lets gather some basic installation infomation.

./node_modules/.bin/node-sass --version
node -p "console.log(require('node-sass').info)"

If the node-sass installation process produced an error, open the vendor folder.

cd node_modules/node-sass/vendor

Then, using the version number we gather at the beginning, go to https://github.com/sass/node-sass-binaries/tree/v.

There you should see a folder with same name as the one in the vendor folder. Download the binding.node file from that folder and replace your own with it.

Test if that worked by gathering some basic installation infomation.

.\node_modules\.bin\node-sass --version
node -p "console.log(require('node-sass').info)"

If this still produces an error please open an issue with the output from these steps.