extensions.js 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461
  1. /*!
  2. * node-sass: lib/extensions.js
  3. */
  4. var eol = require('os').EOL,
  5. fs = require('fs'),
  6. pkg = require('../package.json'),
  7. mkdir = require('mkdirp'),
  8. path = require('path'),
  9. defaultBinaryDir = path.join(__dirname, '..', 'vendor'),
  10. trueCasePathSync = require('true-case-path');
  11. /**
  12. * Get the human readable name of the Platform that is running
  13. *
  14. * @param {string} platform - An OS platform to match, or null to fallback to
  15. * the current process platform
  16. * @return {Object} The name of the platform if matched, false otherwise
  17. *
  18. * @api public
  19. */
  20. function getHumanPlatform(platform) {
  21. switch (platform || process.platform) {
  22. case 'darwin': return 'OS X';
  23. case 'freebsd': return 'FreeBSD';
  24. case 'linux': return 'Linux';
  25. case 'linux_musl': return 'Linux/musl';
  26. case 'win32': return 'Windows';
  27. default: return false;
  28. }
  29. }
  30. /**
  31. * Provides a more readable version of the architecture
  32. *
  33. * @param {string} arch - An instruction architecture name to match, or null to
  34. * lookup the current process architecture
  35. * @return {Object} The value of the process architecture, or false if unknown
  36. *
  37. * @api public
  38. */
  39. function getHumanArchitecture(arch) {
  40. switch (arch || process.arch) {
  41. case 'ia32': return '32-bit';
  42. case 'x86': return '32-bit';
  43. case 'x64': return '64-bit';
  44. default: return false;
  45. }
  46. }
  47. /**
  48. * Get the friendly name of the Node environment being run
  49. *
  50. * @param {Object} abi - A Node Application Binary Interface value, or null to
  51. * fallback to the current Node ABI
  52. * @return {Object} Returns a string name of the Node environment or false if
  53. * unmatched
  54. *
  55. * @api public
  56. */
  57. function getHumanNodeVersion(abi) {
  58. switch (parseInt(abi || process.versions.modules, 10)) {
  59. case 11: return 'Node 0.10.x';
  60. case 14: return 'Node 0.12.x';
  61. case 42: return 'io.js 1.x';
  62. case 43: return 'io.js 1.1.x';
  63. case 44: return 'io.js 2.x';
  64. case 45: return 'io.js 3.x';
  65. case 46: return 'Node.js 4.x';
  66. case 47: return 'Node.js 5.x';
  67. case 48: return 'Node.js 6.x';
  68. case 49: return 'Electron 1.3.x';
  69. case 50: return 'Electron 1.4.x';
  70. case 51: return 'Node.js 7.x';
  71. case 53: return 'Electron 1.6.x';
  72. case 57: return 'Node.js 8.x';
  73. case 59: return 'Node.js 9.x';
  74. case 64: return 'Node.js 10.x';
  75. case 67: return 'Node.js 11.x';
  76. case 72: return 'Node.js 12.x';
  77. case 79: return 'Node.js 13.x';
  78. default: return false;
  79. }
  80. }
  81. /**
  82. * Get a human readable description of where node-sass is running to support
  83. * user error reporting when something goes wrong
  84. *
  85. * @param {string} env - The name of the native bindings that is to be parsed
  86. * @return {string} A description of what os, architecture, and Node version
  87. * that is being run
  88. *
  89. * @api public
  90. */
  91. function getHumanEnvironment(env) {
  92. var binding = env.replace(/_binding\.node$/, ''),
  93. parts = binding.split('-'),
  94. platform = getHumanPlatform(parts[0]),
  95. arch = getHumanArchitecture(parts[1]),
  96. runtime = getHumanNodeVersion(parts[2]);
  97. if (parts.length !== 3) {
  98. return 'Unknown environment (' + binding + ')';
  99. }
  100. if (!platform) {
  101. platform = 'Unsupported platform (' + parts[0] + ')';
  102. }
  103. if (!arch) {
  104. arch = 'Unsupported architecture (' + parts[1] + ')';
  105. }
  106. if (!runtime) {
  107. runtime = 'Unsupported runtime (' + parts[2] + ')';
  108. }
  109. return [
  110. platform, arch, 'with', runtime,
  111. ].join(' ');
  112. }
  113. /**
  114. * Get the value of the binaries under the default path
  115. *
  116. * @return {Array} The currently installed node-sass bindings
  117. *
  118. * @api public
  119. */
  120. function getInstalledBinaries() {
  121. return fs.readdirSync(getBinaryDir());
  122. }
  123. /**
  124. * Check that an environment matches the whitelisted values or the current
  125. * environment if no parameters are passed
  126. *
  127. * @param {string} platform - The name of the OS platform(darwin, win32, etc...)
  128. * @param {string} arch - The instruction set architecture of the Node environment
  129. * @param {string} abi - The Node Application Binary Interface
  130. * @return {Boolean} True, if node-sass supports the current platform, false otherwise
  131. *
  132. * @api public
  133. */
  134. function isSupportedEnvironment(platform, arch, abi) {
  135. return (
  136. false !== getHumanPlatform(platform) &&
  137. false !== getHumanArchitecture(arch) &&
  138. false !== getHumanNodeVersion(abi)
  139. );
  140. }
  141. /**
  142. * Get the value of a CLI argument
  143. *
  144. * @param {String} name
  145. * @param {Array} args
  146. * @api private
  147. */
  148. function getArgument(name, args) {
  149. var flags = args || process.argv.slice(2),
  150. index = flags.lastIndexOf(name);
  151. if (index === -1 || index + 1 >= flags.length) {
  152. return null;
  153. }
  154. return flags[index + 1];
  155. }
  156. /**
  157. * Get binary name.
  158. * If environment variable SASS_BINARY_NAME,
  159. * .npmrc variable sass_binary_name or
  160. * process argument --binary-name is provided,
  161. * return it as is, otherwise make default binary
  162. * name: {platform}-{arch}-{v8 version}.node
  163. *
  164. * @api public
  165. */
  166. function getBinaryName() {
  167. var binaryName,
  168. variant,
  169. platform = process.platform;
  170. if (getArgument('--sass-binary-name')) {
  171. binaryName = getArgument('--sass-binary-name');
  172. } else if (process.env.SASS_BINARY_NAME) {
  173. binaryName = process.env.SASS_BINARY_NAME;
  174. } else if (process.env.npm_config_sass_binary_name) {
  175. binaryName = process.env.npm_config_sass_binary_name;
  176. } else if (pkg.nodeSassConfig && pkg.nodeSassConfig.binaryName) {
  177. binaryName = pkg.nodeSassConfig.binaryName;
  178. } else {
  179. variant = getPlatformVariant();
  180. if (variant) {
  181. platform += '_' + variant;
  182. }
  183. binaryName = [
  184. platform, '-',
  185. process.arch, '-',
  186. process.versions.modules
  187. ].join('');
  188. }
  189. return [binaryName, 'binding.node'].join('_');
  190. }
  191. /**
  192. * Determine the URL to fetch binary file from.
  193. * By default fetch from the node-sass distribution
  194. * site on GitHub.
  195. *
  196. * The default URL can be overridden using
  197. * the environment variable SASS_BINARY_SITE,
  198. * .npmrc variable sass_binary_site or
  199. * or a command line option --sass-binary-site:
  200. *
  201. * node scripts/install.js --sass-binary-site http://example.com/
  202. *
  203. * The URL should to the mirror of the repository
  204. * laid out as follows:
  205. *
  206. * SASS_BINARY_SITE/
  207. *
  208. * v3.0.0
  209. * v3.0.0/freebsd-x64-14_binding.node
  210. * ....
  211. * v3.0.0
  212. * v3.0.0/freebsd-ia32-11_binding.node
  213. * v3.0.0/freebsd-x64-42_binding.node
  214. * ... etc. for all supported versions and platforms
  215. *
  216. * @api public
  217. */
  218. function getBinaryUrl() {
  219. var site = getArgument('--sass-binary-site') ||
  220. process.env.SASS_BINARY_SITE ||
  221. process.env.npm_config_sass_binary_site ||
  222. (pkg.nodeSassConfig && pkg.nodeSassConfig.binarySite) ||
  223. 'https://github.com/sass/node-sass/releases/download';
  224. return [site, 'v' + pkg.version, getBinaryName()].join('/');
  225. }
  226. /**
  227. * Get binary dir.
  228. * If environment variable SASS_BINARY_DIR,
  229. * .npmrc variable sass_binary_dir or
  230. * process argument --sass-binary-dir is provided,
  231. * select it by appending binary name, otherwise
  232. * use default binary dir.
  233. * Once the primary selection is made, check if
  234. * callers wants to throw if file not exists before
  235. * returning.
  236. *
  237. * @api public
  238. */
  239. function getBinaryDir() {
  240. var binaryDir;
  241. if (getArgument('--sass-binary-dir')) {
  242. binaryDir = getArgument('--sass-binary-dir');
  243. } else if (process.env.SASS_BINARY_DIR) {
  244. binaryDir = process.env.SASS_BINARY_DIR;
  245. } else if (process.env.npm_config_sass_binary_dir) {
  246. binaryDir = process.env.npm_config_sass_binary_dir;
  247. } else if (pkg.nodeSassConfig && pkg.nodeSassConfig.binaryDir) {
  248. binaryDir = pkg.nodeSassConfig.binaryDir;
  249. } else {
  250. binaryDir = defaultBinaryDir;
  251. }
  252. return binaryDir;
  253. }
  254. /**
  255. * Get binary path.
  256. * If environment variable SASS_BINARY_PATH,
  257. * .npmrc variable sass_binary_path or
  258. * process argument --sass-binary-path is provided,
  259. * select it by appending binary name, otherwise
  260. * make default binary path using binary name.
  261. * Once the primary selection is made, check if
  262. * callers wants to throw if file not exists before
  263. * returning.
  264. *
  265. * @api public
  266. */
  267. function getBinaryPath() {
  268. var binaryPath;
  269. if (getArgument('--sass-binary-path')) {
  270. binaryPath = getArgument('--sass-binary-path');
  271. } else if (process.env.SASS_BINARY_PATH) {
  272. binaryPath = process.env.SASS_BINARY_PATH;
  273. } else if (process.env.npm_config_sass_binary_path) {
  274. binaryPath = process.env.npm_config_sass_binary_path;
  275. } else if (pkg.nodeSassConfig && pkg.nodeSassConfig.binaryPath) {
  276. binaryPath = pkg.nodeSassConfig.binaryPath;
  277. } else {
  278. binaryPath = path.join(getBinaryDir(), getBinaryName().replace(/_(?=binding\.node)/, '/'));
  279. }
  280. if (process.versions.modules < 46) {
  281. return binaryPath;
  282. }
  283. try {
  284. return trueCasePathSync(binaryPath) || binaryPath;
  285. } catch (e) {
  286. return binaryPath;
  287. }
  288. }
  289. /**
  290. * An array of paths suitable for use as a local disk cache of the binding.
  291. *
  292. * @return {[]String} an array of paths
  293. * @api public
  294. */
  295. function getCachePathCandidates() {
  296. return [
  297. process.env.npm_config_sass_binary_cache,
  298. process.env.npm_config_cache,
  299. ].filter(function(_) { return _; });
  300. }
  301. /**
  302. * The most suitable location for caching the binding on disk.
  303. *
  304. * Given the candidates directories provided by `getCachePathCandidates()` this
  305. * returns the first writable directory. By treating the candidate directories
  306. * as a prioritised list this method is deterministic, assuming no change to the
  307. * local environment.
  308. *
  309. * @return {String} directory to cache binding
  310. * @api public
  311. */
  312. function getBinaryCachePath() {
  313. var i,
  314. cachePath,
  315. cachePathCandidates = getCachePathCandidates();
  316. for (i = 0; i < cachePathCandidates.length; i++) {
  317. cachePath = path.join(cachePathCandidates[i], pkg.name, pkg.version);
  318. try {
  319. mkdir.sync(cachePath);
  320. return cachePath;
  321. } catch (e) {
  322. // Directory is not writable, try another
  323. }
  324. }
  325. return '';
  326. }
  327. /**
  328. * The cached binding
  329. *
  330. * Check the candidates directories provided by `getCachePathCandidates()` for
  331. * the binding file, if it exists. By treating the candidate directories
  332. * as a prioritised list this method is deterministic, assuming no change to the
  333. * local environment.
  334. *
  335. * @return {String} path to cached binary
  336. * @api public
  337. */
  338. function getCachedBinary() {
  339. var i,
  340. cachePath,
  341. cacheBinary,
  342. cachePathCandidates = getCachePathCandidates(),
  343. binaryName = getBinaryName();
  344. for (i = 0; i < cachePathCandidates.length; i++) {
  345. cachePath = path.join(cachePathCandidates[i], pkg.name, pkg.version);
  346. cacheBinary = path.join(cachePath, binaryName);
  347. if (fs.existsSync(cacheBinary)) {
  348. return cacheBinary;
  349. }
  350. }
  351. return '';
  352. }
  353. /**
  354. * Does the supplied binary path exist
  355. *
  356. * @param {String} binaryPath
  357. * @api public
  358. */
  359. function hasBinary(binaryPath) {
  360. return fs.existsSync(binaryPath);
  361. }
  362. /**
  363. * Get Sass version information
  364. *
  365. * @api public
  366. */
  367. function getVersionInfo(binding) {
  368. return [
  369. ['node-sass', pkg.version, '(Wrapper)', '[JavaScript]'].join('\t'),
  370. ['libsass ', binding.libsassVersion(), '(Sass Compiler)', '[C/C++]'].join('\t'),
  371. ].join(eol);
  372. }
  373. /**
  374. * Gets the platform variant, currently either an empty string or 'musl' for Linux/musl platforms.
  375. *
  376. * @api public
  377. */
  378. function getPlatformVariant() {
  379. var contents = '';
  380. if (process.platform !== 'linux') {
  381. return '';
  382. }
  383. try {
  384. contents = fs.readFileSync(process.execPath);
  385. // Buffer.indexOf was added in v1.5.0 so cast to string for old node
  386. // Delay contents.toStrings because it's expensive
  387. if (!contents.indexOf) {
  388. contents = contents.toString();
  389. }
  390. if (contents.indexOf('libc.musl-x86_64.so.1') !== -1) {
  391. return 'musl';
  392. }
  393. } catch (err) { } // eslint-disable-line no-empty
  394. return '';
  395. }
  396. module.exports.hasBinary = hasBinary;
  397. module.exports.getBinaryUrl = getBinaryUrl;
  398. module.exports.getBinaryName = getBinaryName;
  399. module.exports.getBinaryDir = getBinaryDir;
  400. module.exports.getBinaryPath = getBinaryPath;
  401. module.exports.getBinaryCachePath = getBinaryCachePath;
  402. module.exports.getCachedBinary = getCachedBinary;
  403. module.exports.getCachePathCandidates = getCachePathCandidates;
  404. module.exports.getVersionInfo = getVersionInfo;
  405. module.exports.getHumanEnvironment = getHumanEnvironment;
  406. module.exports.getInstalledBinaries = getInstalledBinaries;
  407. module.exports.isSupportedEnvironment = isSupportedEnvironment;