@dry-software/cmake-js 7.3.0

package/bin/cmake-js

@@ -0,0 +1,343 @@
+#!/usr/bin/env node
+'use strict'
+
+const log = require('npmlog')
+const BuildSystem = require('../').BuildSystem
+const util = require('util')
+const version = require('../package').version
+const logLevels = ['silly', 'verbose', 'info', 'http', 'warn', 'error']
+
+const npmConfigData = require('rc')('npm')
+for (const [key, value] of Object.entries(npmConfigData)) {
+	if (key.startsWith('cmake_js_')) {
+		const option = key.substr(9)
+		if (option.length === 1) {
+			process.argv.push('-' + option)
+		} else {
+			process.argv.push('--' + option)
+		}
+		if (value) {
+			process.argv.push(value)
+		}
+	}
+}
+
+const yargs = require('yargs')
+	.usage('CMake.js ' + version + '\n\nUsage: $0 [<command>] [options]')
+	.version(version)
+	.command('install', 'Install Node.js distribution files if needed')
+	.command('configure', 'Configure CMake project')
+	.command('print-configure', 'Print the configuration command')
+	.command('print-cmakejs-src', 'Print the value of the CMAKE_JS_SRC variable')
+	.command('print-cmakejs-include', 'Print the value of the CMAKE_JS_INC variable')
+	.command('print-cmakejs-lib', 'Print the value of the CMAKE_JS_LIB variable')
+	.command('build', 'Build the project (will configure first if required)')
+	.command('print-build', 'Print the build command')
+	.command('clean', 'Clean the project directory')
+	.command('print-clean', 'Print the clean command')
+	.command('reconfigure', 'Clean the project directory then configure the project')
+	.command('rebuild', 'Clean the project directory then build the project')
+	.command('compile', 'Build the project, and if build fails, try a full rebuild')
+	.options({
+		h: {
+			alias: 'help',
+			demand: false,
+			describe: 'show this screen',
+			type: 'boolean',
+		},
+		l: {
+			alias: 'log-level',
+			demand: false,
+			describe: 'set log level (' + logLevels.join(', ') + '), default is info',
+			type: 'string',
+		},
+		d: {
+			alias: 'directory',
+			demand: false,
+			describe: "specify CMake project's directory (where CMakeLists.txt located)",
+			type: 'string',
+		},
+		D: {
+			alias: 'debug',
+			demand: false,
+			describe: 'build debug configuration',
+			type: 'boolean',
+		},
+		B: {
+			alias: 'config',
+			demand: false,
+			describe: "specify build configuration (Debug, RelWithDebInfo, Release), will ignore '--debug' if specified",
+			type: 'string',
+		},
+		c: {
+			alias: 'cmake-path',
+			demand: false,
+			describe: 'path of CMake executable',
+			type: 'string',
+		},
+		m: {
+			alias: 'prefer-make',
+			demand: false,
+			describe: 'use Unix Makefiles even if Ninja is available (Posix)',
+			type: 'boolean',
+		},
+		x: {
+			alias: 'prefer-xcode',
+			demand: false,
+			describe: 'use Xcode instead of Unix Makefiles',
+			type: 'boolean',
+		},
+		g: {
+			alias: 'prefer-gnu',
+			demand: false,
+			describe: 'use GNU compiler instead of default CMake compiler, if available (Posix)',
+			type: 'boolean',
+		},
+		G: {
+			alias: 'generator',
+			demand: false,
+			describe: 'use specified generator',
+			type: 'string',
+		},
+		t: {
+			alias: 'toolset',
+			demand: false,
+			describe: 'use specified toolset',
+			type: 'string',
+		},
+		A: {
+			alias: 'platform',
+			demand: false,
+			describe: 'use specified platform name',
+			type: 'string',
+		},
+		T: {
+			alias: 'target',
+			demand: false,
+			describe: 'only build the specified target',
+			type: 'string',
+		},
+		C: {
+			alias: 'prefer-clang',
+			demand: false,
+			describe: 'use Clang compiler instead of default CMake compiler, if available (Posix)',
+			type: 'boolean',
+		},
+		cc: {
+			demand: false,
+			describe: 'use the specified C compiler',
+			type: 'string',
+		},
+		cxx: {
+			demand: false,
+			describe: 'use the specified C++ compiler',
+			type: 'string',
+		},
+		r: {
+			alias: 'runtime',
+			demand: false,
+			describe: 'the runtime to use',
+			type: 'string',
+		},
+		v: {
+			alias: 'runtime-version',
+			demand: false,
+			describe: 'the runtime version to use',
+			type: 'string',
+		},
+		a: {
+			alias: 'arch',
+			demand: false,
+			describe: 'the architecture to build in',
+			type: 'string',
+		},
+		p: {
+			alias: 'parallel',
+			demand: false,
+			describe: 'the number of threads cmake can use',
+			type: 'number',
+		},
+		CD: {
+			demand: false,
+			describe: 'Custom argument passed to CMake in format: -D<your-arg-here>',
+			type: 'string',
+		},
+		i: {
+			alias: 'silent',
+			describe: 'Prevents CMake.js to print to the stdio',
+			type: 'boolean',
+		},
+		O: {
+			alias: 'out',
+			describe: 'Specify the output directory to compile to, default is projectRoot/build',
+			type: 'string',
+		},
+	})
+const argv = yargs.argv
+
+// If help, then print and exit:
+
+if (argv.h) {
+	console.info(yargs.help())
+	process.exit(0)
+}
+
+// Setup log level:
+
+if (argv.l && logLevels.includes(argv.l)) {
+	log.level = argv.l
+	log.resume()
+}
+
+log.silly('CON', 'argv:')
+log.silly('CON', util.inspect(argv))
+
+log.verbose('CON', 'Parsing arguments')
+
+// Extract custom cMake options
+const customOptions = {}
+for (const arg of process.argv) {
+	if (arg.startsWith('--CD')) {
+		const separator = arg.indexOf('=')
+		if (separator < 5) continue
+		const key = arg.substring(4, separator)
+		const value = arg.substring(separator + 1)
+		if (!value) continue
+		customOptions[key] = value
+	}
+}
+
+const options = {
+	directory: argv.directory || null,
+	debug: argv.debug,
+	cmakePath: argv.c || null,
+	generator: argv.G,
+	toolset: argv.t,
+	platform: argv.A,
+	target: argv.T,
+	preferMake: argv.m,
+	preferXcode: argv.x,
+	preferGnu: argv.g,
+	preferClang: argv.C,
+	cCompilerPath: argv.cc,
+	cppCompilerPath: argv.cxx,
+	runtime: argv.r,
+	runtimeVersion: argv.v,
+	arch: argv.a,
+	cMakeOptions: customOptions,
+	silent: argv.i,
+	out: argv.O,
+	config: argv.B,
+	parallel: argv.p,
+	extraCMakeArgs: argv._.slice(1),
+}
+
+log.verbose('CON', 'options:')
+log.verbose('CON', util.inspect(options))
+
+const command = argv._[0] || 'build'
+
+log.verbose('CON', 'Running command: ' + command)
+
+const buildSystem = new BuildSystem(options)
+
+function ifCommand(c, f) {
+	if (c === command) {
+		f()
+		return true
+	}
+	return false
+}
+
+function exitOnError(promise) {
+	promise.catch(function () {
+		process.exit(1)
+	})
+}
+
+function install() {
+	exitOnError(buildSystem.install())
+}
+function configure() {
+	exitOnError(buildSystem.configure())
+}
+function printConfigure() {
+	exitOnError(
+		buildSystem.getConfigureCommand().then(function (command) {
+			console.info(command)
+		}),
+	)
+}
+function printCmakeJsLib() {
+	exitOnError(
+		buildSystem.getCmakeJsLibString().then(function (command) {
+			console.info(command)
+		}),
+	)
+}
+function printCmakeJsInclude() {
+	exitOnError(
+		buildSystem.getCmakeJsIncludeString().then(function (command) {
+			console.info(command)
+		}),
+	)
+}
+function printCmakeJsSrc() {
+	exitOnError(
+		buildSystem.getCmakeJsSrcString().then(function (command) {
+			console.info(command)
+		}),
+	)
+}
+function build() {
+	exitOnError(buildSystem.build())
+}
+function printBuild() {
+	exitOnError(
+		buildSystem.getBuildCommand().then(function (command) {
+			console.info(command)
+		}),
+	)
+}
+function clean() {
+	exitOnError(buildSystem.clean())
+}
+function printClean() {
+	exitOnError(
+		buildSystem.getCleanCommand().then(function (command) {
+			console.info(command)
+		}),
+	)
+}
+function reconfigure() {
+	exitOnError(buildSystem.reconfigure())
+}
+function rebuild() {
+	exitOnError(buildSystem.rebuild())
+}
+function compile() {
+	exitOnError(buildSystem.compile())
+}
+
+let done = ifCommand('install', install)
+done = done || ifCommand('configure', configure)
+done = done || ifCommand('print-configure', printConfigure)
+done = done || ifCommand('print-cmakejs-src', printCmakeJsSrc)
+done = done || ifCommand('print-cmakejs-include', printCmakeJsInclude)
+done = done || ifCommand('print-cmakejs-lib', printCmakeJsLib)
+done = done || ifCommand('build', build)
+done = done || ifCommand('print-build', printBuild)
+done = done || ifCommand('clean', clean)
+done = done || ifCommand('print-clean', printClean)
+done = done || ifCommand('reconfigure', reconfigure)
+done = done || ifCommand('rebuild', rebuild)
+done = done || ifCommand('compile', compile)
+
+if (!done) {
+	if (command) {
+		log.error('COM', 'Unknown command: ' + command)
+		process.exit(1)
+	} else {
+		build()
+	}
+}

package/changelog.md

@@ -0,0 +1,225 @@
+# v7.3.0 - 15/01/23
+
+- feat(windows): replace custom libnode.def generation with version from node-api-headers
+- fix: support for vs2015 with nodejs 18 and older (#317)
+- fix(windows): always remove Path if PATH is also defined (#319)
+- fix: Cmake arguments got converted to numbers (#314)
+- fix: update node-api-headers
+- chore: update dependencies
+
+# v7.2.1 - 14/02/23
+
+- fix: support Windows11SDK
+
+# v7.2.0 - 12/02/23
+
+- fix: `-DCMAKE_JS_VERSION=undefined` (#298)
+- fix: Only add build type to `CMAKE_LIBRARY_OUTPUT_DIRECTORY` if needed (#299)
+- feat: Forward extra arguments to CMake commands (#297)
+
+# v7.1.1 - 15/12/22
+
+- fix build errors on windows
+
+# v7.1.0 - 14/12/22
+
+- add commands for retrieving cmake-js include and lib directories
+- fix win delay hook issues with electron
+- fix missing js_native_api_symbols in windows node.lib
+
+# v7.0.0 - 08/10/22
+
+- update dependencies
+- replace some dependencies with modern language features
+- follow node-gyp behaviour for visual-studio version detection and selection
+- automatically locate node-addon-api and add to include paths
+- avoid downloads when building for node-api
+- encourage use of MT builds with MSVC, rather than MD
+
+# v6.3.1 - 05/06/22
+
+- add missing bluebird dependency
+- fix platform detection for visual studio 2019 and newer
+- fix platform detection for macos
+
+# v6.3.0 - 26/11/21
+
+- add offline mode: https://github.com/cmake-js/cmake-js/pull/260
+- handle missing buildSystem.log: https://github.com/cmake-js/cmake-js/pull/259
+- Add config flag: https://github.com/cmake-js/cmake-js/pull/251
+- Remove escaped quotes from windows registry queries: https://github.com/cmake-js/cmake-js/pull/250
+
+# v6.2.1 - 20/07/21
+
+- EOL hotfix (Thx Windows!)
+
+# v6.2.0 - 19/07/21
+
+- various fixes
+
+# v6.1.0 - 27/02/20
+
+- Add support for "-A/--platform" option to make target platform selectable for Visual Studio 2019 generator: https://github.com/cmake-js/cmake-js/pull/201
+
+# v6.0.0 - 30/09/19
+
+- Dropped compatibility of old Node.js runtimes (<10.0.0)
+- --cc and --cxx flags for overriding compiler detection: https://github.com/cmake-js/cmake-js/pull/191
+
+# v5.3.2 - 21/08/19
+
+- Visual Studio detection fixes
+
+# v5.3.1 - 18/07/19
+
+- VS 2019 Support fix: https://github.com/cmake-js/cmake-js/pull/187
+
+# v5.3.0 - 09/07/19
+
+- VS 2019 Support: https://github.com/cmake-js/cmake-js/pull/178/, https://github.com/cmake-js/cmake-js/pull/184/
+
+# v5.2.1 - 10/04/19
+
+- Win delay load hook: https://github.com/cmake-js/cmake-js/pull/165/
+
+# v5.1.1 - 02/04/19
+
+- CMake 3.14 support fixed - https://github.com/cmake-js/cmake-js/pull/161
+
+# v5.1.0 - 14/02/19
+
+- CMake 3.14 support - https://github.com/cmake-js/cmake-js/pull/159
+
+# v5.0.1 - 24/01/19
+
+- Linux line ending hotfix (I hate Windows!)
+
+# v5.0.0 - 24/01/19
+
+- [semver major] Add case sensitive NPM config integration https://github.com/cmake-js/cmake-js/pull/151
+- better npm config integration, all CMake.js commandline argument could be set by using npm config: https://github.com/cmake-js/cmake-js#npm-config-integration
+- support for Electron v4+ https://github.com/cmake-js/cmake-js/pull/152
+
+# v4.0.1 - 03/10/18
+
+- log argument hotfix https://github.com/cmake-js/cmake-js/pull/145
+
+# v4.0.0 - 14/09/18
+
+BREAKING CHANGES:
+
+- -s/--std (along with -o/--prec11 option removed, you have to specify compiler standard in CMakeLists.txt files https://github.com/cmake-js/cmake-js/issues/72
+- Implicit -w compiler flag doesn't get added on OSX https://github.com/cmake-js/cmake-js/pull/133
+
+# v3.7.3 - 16/05/18
+
+- npm config hotfix https://github.com/cmake-js/cmake-js/pull/123
+
+# v3.7.2 - 16/05/18
+
+- do not use, breaks ES5 compatibility
+
+# v3.7.1 - 07/05/18
+
+- Linux line ending hotfix (wat)
+
+# v3.7.0 - 07/05/18
+
+- PR: replace unzip with unzipper https://github.com/cmake-js/cmake-js/pull/120
+- PR: replace npmconf with rc https://github.com/cmake-js/cmake-js/pull/119
+- PR: update to modern fs-extras https://github.com/cmake-js/cmake-js/pull/118
+- PR: Adds toolset command line flag https://github.com/cmake-js/cmake-js/pull/115
+
+# v3.6.2 - 17/02/18
+
+- use https distribution download urls
+- custom cmake options made case sensitive
+
+# v3.6.1 - 11/01/18
+
+- Detect 2017 Windows Build Tools
+
+# v3.6.0 - 11/27/17
+
+- "T" option for building specified target: https://github.com/cmake-js/cmake-js/pull/98
+
+# v3.5.0 - 06/21/17
+
+- Added Visual Studio 2017 compatibility: https://github.com/cmake-js/cmake-js/pull/78
+
+# v3.4.1 - 02/4/17
+
+- FIX: test output instead of guessing by platform: https://github.com/cmake-js/cmake-js/pull/77
+
+# v3.4.0 - 01/12/17
+
+- "G" option to set custom generators: https://github.com/cmake-js/cmake-js/pull/64
+
+# v3.3.1 - 09/13/16
+
+- fix of default parameters: https://github.com/cmake-js/cmake-js/pull/57
+
+# v3.3.0 - 09/02/16
+
+- silent option (https://github.com/cmake-js/cmake-js/pull/54)
+- out option (https://github.com/cmake-js/cmake-js/pull/53)
+
+# v3.2.3 - 08/17/16
+
+- Line endings
+
+# v3.2.2 - 12/08/16
+
+- Multi directory support for Windows/MSVC build
+
+# v3.2.1 - 25/04/16
+
+- Linux line ending hotfix
+
+# v3.2.0 - 25/04/16
+
+- Added NW.js 0.13+ compatibility
+- Node v0.10.x support fixed (https://github.com/cmake-js/cmake-js/pull/45, https://github.com/cmake-js/cmake-js/issues/50)
+- CMAKE_JS_VERSION defined (https://github.com/cmake-js/cmake-js/issues/48)
+
+# v3.1.2 - 03/02/16
+
+- Fixed cmake-js binary ES5 compatibility.
+
+# v3.1.1 - 03/02/16
+
+- Fixed line endings
+
+# v3.1.0 - 03/02/16
+
+- Custom CMake parameter support (https://github.com/gerhardberger)
+
+# v3.0.0 - 20/11/15
+
+- Visual C++ Build Tools support
+- std option introduced
+- better unit test coverage
+
+# v2.1.0 - 29/10/15
+
+- explicit options for use GNU or Clang compiler instead of CMake's default (see --help for details)
+
+# v2.0.2 - 22/10/15
+
+- Fix: print-\* commands report "undefined"
+
+# v2.0.0 - 17/10/15
+
+- Fix: distribution files only gets downloaded if needed (4.0.0+)
+- option to generate Xcode project (-x, --prefer-xcode) - by https://github.com/javedulu
+- compile command for fast module compilation during npm updates (instead of rebuild)
+- codebase switched to ECMAScript 2015
+
+# v1.1.1 - 06/10/15
+
+- Hotfix for build NW.js correctly.
+
+# v1.1.0 - 05/10/15
+
+- Node.js 4.0.0+ support
+- Downloads the small, header only tarball for Node.js 4+

package/lib/appCMakeJSConfig.js

@@ -0,0 +1,58 @@
+'use strict'
+const path = require('path')
+
+function getConfig(lookPath, log) {
+	const pjsonPath = path.join(lookPath, 'package.json')
+	log.silly('CFG', "Looking for package.json in: '" + pjsonPath + "'.")
+	try {
+		const json = require(pjsonPath)
+		log.silly('CFG', 'Loaded:\n' + JSON.stringify(json))
+		if (json && json['cmake-js'] && typeof json['cmake-js'] === 'object') {
+			log.silly('CFG', 'Config found.')
+			return json['cmake-js']
+		} else {
+			log.silly('CFG', 'Config not found.')
+			return null
+		}
+	} catch (e) {
+		log.silly('CFG', "'package.json' not found.")
+		return null
+	}
+}
+
+module.exports = function (projectPath, log) {
+	log.verbose('CFG', "Looking for application level CMake.js config in '" + projectPath + '.')
+	let currPath = projectPath
+	let lastConfig = null
+	let currConfig
+	for (;;) {
+		currConfig = getConfig(currPath, log)
+		if (currConfig) {
+			lastConfig = currConfig
+		}
+		try {
+			log.silly('CFG', 'Looking for parent path.')
+			const lastPath = currPath
+			currPath = path.normalize(path.join(currPath, '..'))
+			if (lastPath === currPath) {
+				currPath = null // root
+			}
+			if (currPath) {
+				log.silly('CFG', "Parent path: '" + currPath + "'.")
+			}
+		} catch (e) {
+			log.silly('CFG', 'Exception:\n' + e.stack)
+			break
+		}
+		if (currPath === null) {
+			log.silly('CFG', "Parent path with package.json file doesn't exists. Done.")
+			break
+		}
+	}
+	if (lastConfig) {
+		log.verbose('CFG', 'Application level CMake.js config found:\n' + JSON.stringify(lastConfig))
+	} else {
+		log.verbose('CFG', "Application level CMake.js config doesn't exists.")
+	}
+	return lastConfig
+}