extensions.js 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454
  1. /*!
  2. * node-sass: lib/extensions.js
  3. */
  4. var eol = require('os').EOL,
  5. fs = require('fs'),
  6. path = require('path'),
  7. trueCasePathSync = require('true-case-path'),
  8. pkg = require('../package.json'),
  9. defaultBinaryDir = path.join(__dirname, '..', 'vendor');
  10. /**
  11. * Get the human readable name of the Platform that is running
  12. *
  13. * @param {string} platform - An OS platform to match, or null to fallback to
  14. * the current process platform
  15. * @return {Object} The name of the platform if matched, false otherwise
  16. *
  17. * @api public
  18. */
  19. function getHumanPlatform(platform) {
  20. switch (platform || process.platform) {
  21. case 'darwin': return 'OS X';
  22. case 'freebsd': return 'FreeBSD';
  23. case 'linux': return 'Linux';
  24. case 'linux_musl': return 'Linux/musl';
  25. case 'win32': return 'Windows';
  26. default: return false;
  27. }
  28. }
  29. /**
  30. * Provides a more readable version of the architecture
  31. *
  32. * @param {string} arch - An instruction architecture name to match, or null to
  33. * lookup the current process architecture
  34. * @return {Object} The value of the process architecture, or false if unknown
  35. *
  36. * @api public
  37. */
  38. function getHumanArchitecture(arch) {
  39. switch (arch || process.arch) {
  40. case 'ia32': return '32-bit';
  41. case 'x86': return '32-bit';
  42. case 'x64': return '64-bit';
  43. default: return false;
  44. }
  45. }
  46. /**
  47. * Get the friendly name of the Node environment being run
  48. *
  49. * @param {Object} abi - A Node Application Binary Interface value, or null to
  50. * fallback to the current Node ABI
  51. * @return {Object} Returns a string name of the Node environment or false if
  52. * unmatched
  53. *
  54. * @api public
  55. */
  56. function getHumanNodeVersion(abi) {
  57. switch (parseInt(abi || process.versions.modules, 10)) {
  58. case 11: return 'Node 0.10.x';
  59. case 14: return 'Node 0.12.x';
  60. case 42: return 'io.js 1.x';
  61. case 43: return 'io.js 1.1.x';
  62. case 44: return 'io.js 2.x';
  63. case 45: return 'io.js 3.x';
  64. case 46: return 'Node.js 4.x';
  65. case 47: return 'Node.js 5.x';
  66. case 48: return 'Node.js 6.x';
  67. case 49: return 'Electron 1.3.x';
  68. case 50: return 'Electron 1.4.x';
  69. case 51: return 'Node.js 7.x';
  70. case 53: return 'Electron 1.6.x';
  71. case 57: return 'Node.js 8.x';
  72. case 59: return 'Node.js 9.x';
  73. case 64: return 'Node.js 10.x';
  74. case 67: return 'Node.js 11.x';
  75. case 72: return 'Node.js 12.x';
  76. case 79: return 'Node.js 13.x';
  77. case 83: return 'Node.js 14.x';
  78. case 88: return 'Node.js 15.x';
  79. case 93: return 'Node.js 16.x';
  80. case 102: return 'Node.js 17.x';
  81. default: return false;
  82. }
  83. }
  84. /**
  85. * Get a human readable description of where node-sass is running to support
  86. * user error reporting when something goes wrong
  87. *
  88. * @param {string} env - The name of the native bindings that is to be parsed
  89. * @return {string} A description of what os, architecture, and Node version
  90. * that is being run
  91. *
  92. * @api public
  93. */
  94. function getHumanEnvironment(env) {
  95. var binding = env.replace(/_binding\.node$/, ''),
  96. parts = binding.split('-'),
  97. platform = getHumanPlatform(parts[0]),
  98. arch = getHumanArchitecture(parts[1]),
  99. runtime = getHumanNodeVersion(parts[2]);
  100. if (parts.length !== 3) {
  101. return 'Unknown environment (' + binding + ')';
  102. }
  103. if (!platform) {
  104. platform = 'Unsupported platform (' + parts[0] + ')';
  105. }
  106. if (!arch) {
  107. arch = 'Unsupported architecture (' + parts[1] + ')';
  108. }
  109. if (!runtime) {
  110. runtime = 'Unsupported runtime (' + parts[2] + ')';
  111. }
  112. return [
  113. platform, arch, 'with', runtime,
  114. ].join(' ');
  115. }
  116. /**
  117. * Get the value of the binaries under the default path
  118. *
  119. * @return {Array} The currently installed node-sass bindings
  120. *
  121. * @api public
  122. */
  123. function getInstalledBinaries() {
  124. return fs.readdirSync(getBinaryDir());
  125. }
  126. /**
  127. * Check that an environment matches the allowlisted values or the current
  128. * environment if no parameters are passed
  129. *
  130. * @param {string} platform - The name of the OS platform(darwin, win32, etc...)
  131. * @param {string} arch - The instruction set architecture of the Node environment
  132. * @param {string} abi - The Node Application Binary Interface
  133. * @return {Boolean} True, if node-sass supports the current platform, false otherwise
  134. *
  135. * @api public
  136. */
  137. function isSupportedEnvironment(platform, arch, abi) {
  138. return (
  139. false !== getHumanPlatform(platform) &&
  140. false !== getHumanArchitecture(arch) &&
  141. false !== getHumanNodeVersion(abi)
  142. );
  143. }
  144. /**
  145. * Get the value of a CLI argument
  146. *
  147. * @param {String} name
  148. * @param {Array} args
  149. * @api private
  150. */
  151. function getArgument(name, args) {
  152. var flags = args || process.argv.slice(2),
  153. index = flags.lastIndexOf(name);
  154. if (index === -1 || index + 1 >= flags.length) {
  155. return null;
  156. }
  157. return flags[index + 1];
  158. }
  159. /**
  160. * Get binary name.
  161. * If environment variable SASS_BINARY_NAME,
  162. * .npmrc variable sass_binary_name or
  163. * process argument --binary-name is provided,
  164. * return it as is, otherwise make default binary
  165. * name: {platform}-{arch}-{v8 version}.node
  166. *
  167. * @api public
  168. */
  169. function getBinaryName() {
  170. var binaryName,
  171. variant,
  172. platform = process.platform;
  173. if (getArgument('--sass-binary-name')) {
  174. binaryName = getArgument('--sass-binary-name');
  175. } else if (process.env.SASS_BINARY_NAME) {
  176. binaryName = process.env.SASS_BINARY_NAME;
  177. } else if (process.env.npm_config_sass_binary_name) {
  178. binaryName = process.env.npm_config_sass_binary_name;
  179. } else if (pkg.nodeSassConfig && pkg.nodeSassConfig.binaryName) {
  180. binaryName = pkg.nodeSassConfig.binaryName;
  181. } else {
  182. variant = getPlatformVariant();
  183. if (variant) {
  184. platform += '_' + variant;
  185. }
  186. binaryName = [
  187. platform, '-',
  188. process.arch, '-',
  189. process.versions.modules
  190. ].join('');
  191. }
  192. return [binaryName, 'binding.node'].join('_');
  193. }
  194. /**
  195. * Determine the URL to fetch binary file from.
  196. * By default fetch from the node-sass distribution
  197. * site on GitHub.
  198. *
  199. * The default URL can be overridden using
  200. * the environment variable SASS_BINARY_SITE,
  201. * .npmrc variable sass_binary_site or
  202. * or a command line option --sass-binary-site:
  203. *
  204. * node scripts/install.js --sass-binary-site http://example.com/
  205. *
  206. * The URL should to the mirror of the repository
  207. * laid out as follows:
  208. *
  209. * SASS_BINARY_SITE/
  210. *
  211. * v3.0.0
  212. * v3.0.0/freebsd-x64-14_binding.node
  213. * ....
  214. * v3.0.0
  215. * v3.0.0/freebsd-ia32-11_binding.node
  216. * v3.0.0/freebsd-x64-42_binding.node
  217. * ... etc. for all supported versions and platforms
  218. *
  219. * @api public
  220. */
  221. function getBinaryUrl() {
  222. var site = getArgument('--sass-binary-site') ||
  223. process.env.SASS_BINARY_SITE ||
  224. process.env.npm_config_sass_binary_site ||
  225. (pkg.nodeSassConfig && pkg.nodeSassConfig.binarySite) ||
  226. 'https://github.com/sass/node-sass/releases/download';
  227. return [site, 'v' + pkg.version, getBinaryName()].join('/');
  228. }
  229. /**
  230. * Get binary dir.
  231. * If environment variable SASS_BINARY_DIR,
  232. * .npmrc variable sass_binary_dir or
  233. * process argument --sass-binary-dir is provided,
  234. * select it by appending binary name, otherwise
  235. * use default binary dir.
  236. * Once the primary selection is made, check if
  237. * callers wants to throw if file not exists before
  238. * returning.
  239. *
  240. * @api public
  241. */
  242. function getBinaryDir() {
  243. var binaryDir;
  244. if (getArgument('--sass-binary-dir')) {
  245. binaryDir = getArgument('--sass-binary-dir');
  246. } else if (process.env.SASS_BINARY_DIR) {
  247. binaryDir = process.env.SASS_BINARY_DIR;
  248. } else if (process.env.npm_config_sass_binary_dir) {
  249. binaryDir = process.env.npm_config_sass_binary_dir;
  250. } else if (pkg.nodeSassConfig && pkg.nodeSassConfig.binaryDir) {
  251. binaryDir = pkg.nodeSassConfig.binaryDir;
  252. } else {
  253. binaryDir = defaultBinaryDir;
  254. }
  255. return binaryDir;
  256. }
  257. /**
  258. * Get binary path.
  259. * If environment variable SASS_BINARY_PATH,
  260. * .npmrc variable sass_binary_path or
  261. * process argument --sass-binary-path is provided,
  262. * select it by appending binary name, otherwise
  263. * make default binary path using binary name.
  264. * Once the primary selection is made, check if
  265. * callers wants to throw if file not exists before
  266. * returning.
  267. *
  268. * @api public
  269. */
  270. function getBinaryPath() {
  271. var binaryPath;
  272. if (getArgument('--sass-binary-path')) {
  273. binaryPath = getArgument('--sass-binary-path');
  274. } else if (process.env.SASS_BINARY_PATH) {
  275. binaryPath = process.env.SASS_BINARY_PATH;
  276. } else if (process.env.npm_config_sass_binary_path) {
  277. binaryPath = process.env.npm_config_sass_binary_path;
  278. } else if (pkg.nodeSassConfig && pkg.nodeSassConfig.binaryPath) {
  279. binaryPath = pkg.nodeSassConfig.binaryPath;
  280. } else {
  281. binaryPath = path.join(getBinaryDir(), getBinaryName().replace(/_(?=binding\.node)/, '/'));
  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. fs.mkdirSync(cachePath, {recursive: true});
  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. if (contents.indexOf('libc.musl-x86_64.so.1') !== -1) {
  386. return 'musl';
  387. }
  388. } catch (err) { } // eslint-disable-line no-empty
  389. return '';
  390. }
  391. module.exports.hasBinary = hasBinary;
  392. module.exports.getBinaryUrl = getBinaryUrl;
  393. module.exports.getBinaryName = getBinaryName;
  394. module.exports.getBinaryDir = getBinaryDir;
  395. module.exports.getBinaryPath = getBinaryPath;
  396. module.exports.getBinaryCachePath = getBinaryCachePath;
  397. module.exports.getCachedBinary = getCachedBinary;
  398. module.exports.getCachePathCandidates = getCachePathCandidates;
  399. module.exports.getVersionInfo = getVersionInfo;
  400. module.exports.getHumanEnvironment = getHumanEnvironment;
  401. module.exports.getInstalledBinaries = getInstalledBinaries;
  402. module.exports.isSupportedEnvironment = isSupportedEnvironment;