termly-cli/scripts/check-build-tools.js at main · termly-dev/termly-cli · GitHub

History

executable file

470 lines (399 loc) · 21.3 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

#!/usr/bin/env node

/**

* Pre-install check for required build tools

* Prevents cryptic node-gyp errors by checking for build dependencies upfront

const { execSync } = require('child_process');

const { platform } = require('os');

const COLORS = {

red: '\x1b[31m',

yellow: '\x1b[33m',

cyan: '\x1b[36m',

bold: '\x1b[1m',

reset: '\x1b[0m'

};

function colorize(text, color) {

return `${color}${text}${COLORS.reset}`;

}

function commandExists(command) {

try {

const checkCmd = platform() === 'win32' ? `where ${command}` : `which ${command}`;

execSync(checkCmd, { stdio: 'ignore' });

return true;

} catch {

return false;

}

function checkLinux(packageName) {

const hasMake = commandExists('make');

const hasGCC = commandExists('gcc') || commandExists('g++');

const hasPython = commandExists('python3') || commandExists('python');

if (!hasMake || !hasGCC || !hasPython) {

console.error('\n\n');

console.error(colorize('╔════════════════════════════════════════════════════════════════╗', COLORS.red));

console.error(colorize('║ ❌ INSTALLATION BLOCKED - Missing Build Tools ║', COLORS.red));

console.error(colorize('╚════════════════════════════════════════════════════════════════╝', COLORS.red));

console.error('\n' + colorize('Termly CLI cannot install without build tools.', COLORS.bold));

console.error('\nMissing:');

if (!hasMake) console.error(colorize(' ✗ make', COLORS.red));

if (!hasGCC) console.error(colorize(' ✗ gcc/g++', COLORS.red));

if (!hasPython) console.error(colorize(' ✗ python3', COLORS.red));

console.error('\n' + colorize('Install required tools:', COLORS.cyan));

// Detect Linux distribution

let distro = 'unknown';

try {

const osRelease = require('fs').readFileSync('/etc/os-release', 'utf8');

if (osRelease.includes('Ubuntu') || osRelease.includes('Debian')) {

distro = 'debian';

} else if (osRelease.includes('Amazon Linux') || osRelease.includes('Red Hat') || osRelease.includes('CentOS') || osRelease.includes('Fedora')) {

distro = 'rhel';

} else if (osRelease.includes('Alpine')) {

distro = 'alpine';

}

} catch {}

if (distro === 'debian') {

console.error('\n ' + colorize('sudo apt-get update', COLORS.yellow));

console.error(' ' + colorize('sudo apt-get install -y build-essential python3', COLORS.yellow));

} else if (distro === 'rhel') {

console.error('\n ' + colorize('sudo yum install -y gcc-c++ make python3', COLORS.yellow));

} else if (distro === 'alpine') {

console.error('\n ' + colorize('apk add --no-cache make gcc g++ python3', COLORS.yellow));

} else {

// Generic instructions

console.error('\n Ubuntu/Debian:');

console.error(' ' + colorize('sudo apt-get install -y build-essential python3', COLORS.yellow));

console.error('\n RHEL/CentOS/Fedora/Amazon Linux:');

console.error(' ' + colorize('sudo yum install -y gcc-c++ make python3', COLORS.yellow));

}

console.error('\n' + colorize('Then retry installation:', COLORS.cyan));

console.error(' ' + colorize(`npm install -g ${packageName}`, COLORS.yellow));

console.error('\n' + colorize('────────────────────────────────────────────────────────────────', COLORS.yellow));

console.error('');

process.exit(1);

} else {

console.error('\n' + colorize('✓ Linux Build Tools Check Passed', COLORS.cyan));

console.error(colorize(' ✓ make found', COLORS.cyan));

console.error(colorize(' ✓ gcc/g++ found', COLORS.cyan));

console.error(colorize(' ✓ python found', COLORS.cyan));

console.error('');

}

function checkMacOS() {

// macOS usually works out-of-the-box with Xcode CLI tools

// Only check if xcode-select exists

try {

execSync('xcode-select -p', { stdio: 'ignore' });

console.error('\n' + colorize('✓ macOS Build Tools Check Passed', COLORS.cyan));

console.error(colorize(' ✓ Xcode Command Line Tools found', COLORS.cyan));

console.error('');

} catch {

console.error('\n' + colorize('⚠️ Warning: Xcode Command Line Tools not detected', COLORS.yellow));

console.error('\nIf installation fails, run:');

console.error(' ' + colorize('xcode-select --install', COLORS.cyan));

console.error('\n' + colorize('Attempting installation anyway (prebuilt binaries may work)...', COLORS.yellow));

console.error('');

// Don't exit - let npm try, prebuilt binaries might work

}

function checkVSWorkloadInstalled() {

// Use vswhere.exe to check if C++ workload is properly installed

// This is what node-gyp actually checks, not just file existence

const fs = require('fs');

const path = require('path');

const vswherePath = 'C:\\Program Files (x86)\\Microsoft Visual Studio\\Installer\\vswhere.exe';

if (!fs.existsSync(vswherePath)) {

return { method: 'vswhere', found: false, reason: 'vswhere.exe not found' };

}

try {

// Check for C++ desktop development workload

// This is the official way node-gyp detects VS installations

const result = execSync(

`"${vswherePath}" -latest -requires Microsoft.VisualStudio.Workload.NativeDesktop -property installationPath`,

{ encoding: 'utf8', stdio: ['pipe', 'pipe', 'pipe'] }

).trim();

if (result && result.length > 0) {

// Verify MSVC toolset exists at this path

const msvcPath = path.join(result, 'VC', 'Tools', 'MSVC');

if (fs.existsSync(msvcPath)) {

const versions = fs.readdirSync(msvcPath);

for (const version of versions) {

const compilerPath = path.join(msvcPath, version, 'bin', 'Hostx64', 'x64', 'cl.exe');

if (fs.existsSync(compilerPath)) {

return { method: 'vswhere', found: true, path: result, version };

}

return { method: 'vswhere', found: false, reason: 'C++ workload not installed' };

} catch (err) {

return { method: 'vswhere', found: false, reason: `vswhere failed: ${err.message}` };

}

function checkVisualStudio() {

// Primary check: use vswhere (same as node-gyp)

const vswhereCheck = checkVSWorkloadInstalled();

if (vswhereCheck.found) {

return {

vsInstalled: true,

msvcInstalled: true,

method: 'vswhere',

workloadInstalled: true

};

}

// Fallback: file-based check (but warn if workload not properly registered)

const fs = require('fs');

const path = require('path');

const possiblePaths = [

'C:\\Program Files\\Microsoft Visual Studio\\2022',

'C:\\Program Files\\Microsoft Visual Studio\\2019',

'C:\\Program Files (x86)\\Microsoft Visual Studio\\2022',

'C:\\Program Files (x86)\\Microsoft Visual Studio\\2019'

];

let vsInstalled = false;

let msvcInstalled = false;

for (const basePath of possiblePaths) {

if (!fs.existsSync(basePath)) continue;

const editions = ['Community', 'Professional', 'Enterprise', 'BuildTools'];

for (const edition of editions) {

const editionPath = path.join(basePath, edition);

if (fs.existsSync(editionPath)) {

vsInstalled = true;

const msvcPath = path.join(editionPath, 'VC', 'Tools', 'MSVC');

if (fs.existsSync(msvcPath)) {

try {

const versions = fs.readdirSync(msvcPath);

for (const version of versions) {

const compilerPath = path.join(msvcPath, version, 'bin', 'Hostx64', 'x64', 'cl.exe');

const compilerPathX86 = path.join(msvcPath, version, 'bin', 'Hostx86', 'x86', 'cl.exe');

if (fs.existsSync(compilerPath) || fs.existsSync(compilerPathX86)) {

msvcInstalled = true;

break;

}

if (msvcInstalled) break;

} catch (err) {

// Ignore errors reading MSVC path

}

if (msvcInstalled) break;

}

// Files exist but workload not registered = will fail with node-gyp

return {

vsInstalled,

msvcInstalled,

method: 'filesystem',

workloadInstalled: false,

vswhereReason: vswhereCheck.reason

};

}

function checkSpectreLibs() {

// Check for Spectre-mitigated libraries in any VS version

const fs = require('fs');

const path = require('path');

// Determine which architecture to check

const arch = process.arch;

const spectreArchs = arch === 'arm64' ? ['arm64'] : ['x64', 'x86'];

const possiblePaths = [

'C:\\Program Files\\Microsoft Visual Studio\\2022\\Community\\VC\\Tools\\MSVC',

'C:\\Program Files\\Microsoft Visual Studio\\2022\\Professional\\VC\\Tools\\MSVC',

'C:\\Program Files\\Microsoft Visual Studio\\2022\\Enterprise\\VC\\Tools\\MSVC',

'C:\\Program Files (x86)\\Microsoft Visual Studio\\2022\\BuildTools\\VC\\Tools\\MSVC',

'C:\\Program Files\\Microsoft Visual Studio\\2019\\Community\\VC\\Tools\\MSVC',

'C:\\Program Files\\Microsoft Visual Studio\\2019\\Professional\\VC\\Tools\\MSVC',

'C:\\Program Files\\Microsoft Visual Studio\\2019\\Enterprise\\VC\\Tools\\MSVC',

'C:\\Program Files (x86)\\Microsoft Visual Studio\\2019\\BuildTools\\VC\\Tools\\MSVC'

];

for (const basePath of possiblePaths) {

if (!fs.existsSync(basePath)) continue;

try {

const versions = fs.readdirSync(basePath);

for (const version of versions) {

// Check for any of the required architectures

for (const spectreArch of spectreArchs) {

const spectrePath = path.join(basePath, version, 'lib', 'spectre', spectreArch);

if (fs.existsSync(spectrePath)) {

// Check if directory has files

const files = fs.readdirSync(spectrePath);

if (files.length > 0) {

return true;

}

} catch {}

}

return false;

}

function checkWindowsSDK() {

// Check for Windows SDK

const fs = require('fs');

const path = require('path');

const sdkPaths = [

'C:\\Program Files (x86)\\Windows Kits\\10',

'C:\\Program Files\\Windows Kits\\10'

];

for (const sdkBase of sdkPaths) {

if (!fs.existsSync(sdkBase)) continue;

const includePath = path.join(sdkBase, 'Include');

if (fs.existsSync(includePath)) {

try {

const versions = fs.readdirSync(includePath).filter(v => v.match(/^10\./));

if (versions.length > 0) {

return true; // Found Windows SDK

}

} catch {}

}

return false;

}

function getWindowsArch() {

// Detect Windows architecture

const arch = process.arch;

if (arch === 'arm64') return 'ARM64';

if (arch === 'x64' || arch === 'ia32') return 'x64/x86';

return 'x64/x86'; // default

}

function checkWindows(packageName) {

// Windows - check for Visual Studio or build tools

const vsCheck = checkVisualStudio();

const hasPython = commandExists('python') || commandExists('python3');

const hasSpectre = vsCheck.msvcInstalled ? checkSpectreLibs() : false;

const hasSDK = checkWindowsSDK();

const arch = getWindowsArch();

// Special case: files exist but workload not registered (node-gyp will fail)

if (vsCheck.msvcInstalled && !vsCheck.workloadInstalled) {

console.error('\n\n');

console.error(colorize('║ ❌ INSTALLATION WILL FAIL - Workload Not Properly Installed ║', COLORS.red));

console.error('\n' + colorize('WARNING: C++ compiler files exist, but the workload is not properly registered!', COLORS.bold));

console.error('\n' + colorize('This means node-gyp WILL FAIL even though files are present.', COLORS.bold));

console.error('\nDetection details:');

console.error(colorize(' ✓ Visual Studio installation: FOUND', COLORS.cyan));

console.error(colorize(' ✓ MSVC compiler files (cl.exe): FOUND', COLORS.cyan));

console.error(colorize(' ✗ C++ Desktop Development workload: NOT REGISTERED', COLORS.red));

if (vsCheck.vswhereReason) {

console.error(colorize(` Reason: ${vsCheck.vswhereReason}`, COLORS.yellow));

}

console.error('\n' + colorize('═══════════════════════════════════════════════════════════════', COLORS.cyan));

console.error(colorize('FIX: Reinstall the C++ workload via Visual Studio Installer', COLORS.bold));

console.error(colorize('═══════════════════════════════════════════════════════════════', COLORS.cyan));

console.error('\n' + colorize('STEP 1: Open Visual Studio Installer', COLORS.cyan));

console.error(' • Press Windows key, type: ' + colorize('Visual Studio Installer', COLORS.yellow));

console.error(' • Or run from Start Menu');

console.error('\n' + colorize('STEP 2: Modify your installation', COLORS.cyan));

console.error(' • Click ' + colorize('Modify', COLORS.yellow) + ' button on your VS installation');

console.error(' • Go to ' + colorize('Workloads', COLORS.yellow) + ' tab');

console.error(' • ' + colorize('UNCHECK', COLORS.bold) + ' "Desktop development with C++"');

console.error(' • Click ' + colorize('Modify', COLORS.yellow) + ' to REMOVE it');

console.error(' • Wait for uninstall to complete');

console.error('\n' + colorize('STEP 3: Reinstall the workload (IMPORTANT!)', COLORS.cyan));

console.error(' • Click ' + colorize('Modify', COLORS.yellow) + ' again');

console.error(' • Go to ' + colorize('Workloads', COLORS.yellow) + ' tab');

console.error(' • ' + colorize('CHECK', COLORS.bold) + ' "Desktop development with C++"');

console.error(' • Go to ' + colorize('Individual Components', COLORS.yellow) + ' tab');

console.error(' • Search: ' + colorize('"Spectre"', COLORS.yellow));

console.error(' • Check: ' + colorize(`MSVC C++ ${arch} Spectre-mitigated libs (Latest)`, COLORS.yellow));

console.error(' • Ensure Windows SDK is checked');

console.error(' • Click ' + colorize('Modify', COLORS.yellow) + ' to INSTALL');

console.error('\n' + colorize('STEP 4: Restart terminal and retry', COLORS.cyan));

console.error(' • Close this window completely');

console.error(' • Open NEW terminal');

console.error(' • Run: ' + colorize(`npm install -g ${packageName}`, COLORS.yellow));

console.error('');

process.exit(1);

}

// If ANY check fails - show full instructions and block

if (!vsCheck.msvcInstalled || !hasPython || !hasSpectre || !hasSDK) {

console.error('\n\n');

console.error(colorize('║ ❌ INSTALLATION BLOCKED - Missing Build Tools ║', COLORS.red));

console.error('\n' + colorize('Termly CLI cannot install without required components.', COLORS.bold));

console.error('\nMissing components:');

// More specific error messages

if (!vsCheck.vsInstalled) {

console.error(colorize(' ✗ Visual Studio 2019/2022', COLORS.red));

} else if (!vsCheck.msvcInstalled) {

console.error(colorize(' ✗ C++ build tools (Desktop development with C++ workload)', COLORS.red));

}

if (!hasPython) console.error(colorize(' ✗ Python 3.x', COLORS.red));

if (vsCheck.msvcInstalled && !hasSpectre) console.error(colorize(' ✗ Spectre-mitigated libraries', COLORS.red));

if (!hasSDK) console.error(colorize(' ✗ Windows SDK', COLORS.red));

console.error(colorize('SETUP INSTRUCTIONS:', COLORS.bold));

console.error('\n' + colorize('STEP 1: Install/Modify Visual Studio 2022', COLORS.cyan));

console.error('\n If you already have VS installed:');

console.error(' • Open ' + colorize('Visual Studio Installer', COLORS.yellow));

console.error(' • Click ' + colorize('Modify', COLORS.yellow) + ' on your installation');

console.error(' • Go to ' + colorize('Workloads', COLORS.yellow) + ' tab');

console.error(' • Check: ' + colorize('Desktop development with C++', COLORS.yellow));

console.error(' • Go to ' + colorize('Individual Components', COLORS.yellow) + ' tab');

console.error(' • Search: ' + colorize('"Spectre"', COLORS.yellow));

console.error(' • Check: ' + colorize(`MSVC C++ ${arch} Spectre-mitigated libs (Latest)`, COLORS.yellow));

console.error(' • Check: ' + colorize('Windows SDK (any recent version)', COLORS.yellow));

console.error(' • Click ' + colorize('Modify', COLORS.yellow));

console.error('\n If you don\'t have VS installed:');

console.error(' • Download: ' + colorize('https://visualstudio.microsoft.com/downloads/', COLORS.yellow));

console.error(' • Run installer');

console.error(' • Select: ' + colorize('Desktop development with C++', COLORS.yellow));

console.error(' • In Individual Components, ensure:');

console.error(' - ' + colorize(`MSVC C++ ${arch} build tools`, COLORS.yellow));

console.error(' - ' + colorize(`MSVC C++ ${arch} Spectre-mitigated libs`, COLORS.yellow));

console.error(' - ' + colorize('Windows SDK', COLORS.yellow));

console.error('\n' + colorize('STEP 2: Install Python (if missing)', COLORS.cyan));

console.error(' • Download: ' + colorize('https://www.python.org/downloads/', COLORS.yellow));

console.error(' • Install Python 3.x');

console.error(' • Check "Add to PATH" during installation');

console.error('\n' + colorize('STEP 3: Restart your terminal', COLORS.cyan));

console.error(' • Close this command prompt/PowerShell window');

console.error(' • Open a NEW window');

console.error('\n' + colorize('STEP 4: Retry installation', COLORS.cyan));

console.error(' ' + colorize(`npm install -g ${packageName}`, COLORS.yellow));

console.error('');

process.exit(1);

}

// All checks passed

console.error('\n' + colorize('✓ Windows Build Tools Check Passed', COLORS.cyan));

console.error(colorize(' ✓ Visual Studio found', COLORS.cyan));

console.error(colorize(' ✓ MSVC compiler found', COLORS.cyan));

if (vsCheck.workloadInstalled) {

console.error(colorize(' ✓ C++ workload properly registered (vswhere)', COLORS.cyan));

}

console.error(colorize(' ✓ Spectre-mitigated libraries found', COLORS.cyan));

console.error(colorize(' ✓ Windows SDK found', COLORS.cyan));

console.error(colorize(' ✓ Python found', COLORS.cyan));

console.error('');

}

// Detect package name from package.json

function getPackageName() {

try {

const fs = require('fs');

const path = require('path');

const packagePath = path.join(__dirname, '..', 'package.json');

const packageJson = JSON.parse(fs.readFileSync(packagePath, 'utf8'));

return packageJson.name || '@termly-dev/cli';

} catch {

return '@termly-dev/cli';

}

// Main

const currentPlatform = platform();

const packageName = getPackageName();

console.error(colorize('\n🔧 Checking build requirements...', COLORS.cyan));

if (currentPlatform === 'linux') {

checkLinux(packageName);

} else if (currentPlatform === 'darwin') {

checkMacOS();

} else if (currentPlatform === 'win32') {

checkWindows(packageName);

} else {

// Unknown platform - just pass through

console.error(colorize('⚠️ Unknown platform - skipping checks\n', COLORS.yellow));

}

process.exit(0);

termly-cli/scripts/check-build-tools.js at main · termly-dev/termly-cli · GitHub

Uh oh!

Uh oh!

termly-cli/scripts/check-build-tools.js at main · termly-dev/termly-cli · GitHub

Uh oh!

Uh oh!

Expand file tree

Breadcrumbs

check-build-tools.js

Latest commit

History

Breadcrumbs

check-build-tools.js

File metadata and controls