{"_id":"@bastienmoulia/check-engine","_rev":"2-4441655ca60283c1f954876f44e22d92","name":"@bastienmoulia/check-engine","dist-tags":{"latest":"1.6.0"},"versions":{"1.6.0":{"name":"@bastienmoulia/check-engine","version":"1.6.0","description":"A system version checker in Node.js","main":"./lib/checkSystem.js","bin":{"check-engine":"./bin/check-engine.js"},"scripts":{"start":"node bin/check-engine.js","test":"tape **/*.spec.js | tap-min","lint":"eslint bin/**/*.js lib/**/*.js"},"repository":{"type":"git","url":"git+https://github.com/mohlsen/check-engine.git"},"keywords":["node"],"author":{"name":"Mike Ohlsen"},"license":"MIT","bugs":{"url":"https://github.com/mohlsen/check-engine/issues"},"homepage":"https://github.com/mohlsen/check-engine#readme","engines":{"node":"5.10.1","npm":"3.8.3","osx":"10.11.2","jx":"0.3.1.5","cordova":"6.2.0","appium":"1.5.3","gulp-cli":"1.2.1","ios-deploy":"1.8.6","ios-sim":"5.0.8","adb":"1.0.36","bower":"1.7.9","ios-webkit-debug-proxy":"1.4_2","ideviceinstaller":"1.1.0_1","java":"1.8.0_31","ant":"1.9.4","git":"2.10.0","xcodebuild":"8.2.1","cocoapods":"1.1.1","carthage":"0.18.1","xcpretty":"0.2.4","libimobiledevice":"1.2.0 HEAD-c7f24a9","deviceconsole":"1.0.1","check-engine":"1.2.0","yarn":"0.19.1","nsp":"2.6.2"},"dependencies":{"bluebird":"^3.4.6","colors":"^1.1.2","jsonfile":"^2.4.0","lodash":"^4.16.4","semver":"^5.5.0"},"devDependencies":{"proxyquire":"^1.7.10","tap-min":"^1.1.0","tape":"^4.6.2"},"gitHead":"bcaccacdb5c0eff1979069355e0cf8ad45100d37","_id":"@bastienmoulia/check-engine@1.6.0","_npmVersion":"5.4.2","_nodeVersion":"8.4.0","_npmUser":{"name":"bastienmoulia","email":"bmoulia@gmail.com"},"dist":{"integrity":"sha512-UzqSL8soj2xRQYcmcqEp+S60dK3D4iIKb5uOw+9oQ+jgZn2+pDAVdrkHbtbfdhebhxRvKo/rDRQ+UVvVPBSeTQ==","shasum":"8bff004ec21843b14670d709bb7eabdbbc0020c4","tarball":"https://registry.npmjs.org/@bastienmoulia/check-engine/-/check-engine-1.6.0.tgz","fileCount":11,"unpackedSize":33193,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIEUI4QvLgB/Yp5pZaMX3KkS0ery5nRiQPlNpOAhjU8H5AiBSvxmAQQoQyzFU6JvhDuTa1DMK79+iDqwa+ri1Yod9eA=="}]},"maintainers":[{"name":"bastienmoulia","email":"bmoulia@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/check-engine_1.6.0_1518388125441_0.6651534990518317"},"_hasShrinkwrap":false}},"time":{"created":"2018-02-11T22:28:45.116Z","1.6.0":"2018-02-11T22:28:46.085Z","modified":"2022-04-04T17:47:22.158Z"},"maintainers":[{"name":"bastienmoulia","email":"bmoulia@gmail.com"}],"description":"A system version checker in Node.js","homepage":"https://github.com/mohlsen/check-engine#readme","keywords":["node"],"repository":{"type":"git","url":"git+https://github.com/mohlsen/check-engine.git"},"author":{"name":"Mike Ohlsen"},"bugs":{"url":"https://github.com/mohlsen/check-engine/issues"},"license":"MIT","readme":"# check-engine  [![Build Status](https://travis-ci.org/mohlsen/check-engine.svg?branch=master)](https://travis-ci.org/mohlsen/check-engine)\nA utility to check your [package.json engines](https://docs.npmjs.com/files/package.json#engines) in Node.js projects. Inspired by the [Thali Project][thali] in [validateBuildEnvironment.js][thalicode]\n\n## About\n\n### Why\nFor projects of all sizes, but especially for mid to large size teams, evenironemts get out of sync.  Even slight variations in these build / development environments can kill productivity.  \n\n### What This Does\nValidates your system to make sure you have the correct system tools and dependencies installed.  Uses the [engine  object][engines] from a `package.json` located in the current or specified directory to determine what system dependencies\nor installed tools validate.\n\n### Supported Dependencies\nCurrently Supporting:\n- OS X (MacOS)\n- Node.js\n- npm\n- jx (JXCore)\n- cordova\n- appium\n- ios-deploy\n- ios-sim\n- bower\n- ios-webkit-debug-proxy\n- ideviceinstaller\n- java\n- ant\n- git\n- gulp-cli\n- [cocoapods](https://cocoapods.org/)\n- xcodebuild\n- [carthage](https://github.com/Carthage/Carthage)\n- [xcpretty](https://github.com/supermarin/xcpretty)\n- [libimobiledevice](http://www.libimobiledevice.org/)\n- [deviceconsole](https://github.com/rpetrich/deviceconsole)\n- [check-engine](https://github.com/mohlsen/check-engine)\n- [yarn](https://yarnpkg.com/)\n- [nsp](https://github.com/nodesecurity/nsp)\n\nSee the [validatorRules.js file][validator] file for the full list of things that are supported.\n\n## Install\ncheck-engine can be installed globally or in a local directory.\n\n- **Globally**: `npm install -g check-engine`\n- **Local**: `npm install check-engine`\n\n## Usage\n\n### CLI\n\nSimply run:\n\n`check-engine [path_to_package.json]`\n\nWhere:\n\n- `path_to_package.json` is an optional path to a package.json\n  file containing a list of [engines](https://docs.npmjs.com/files/package.json#engines)\n  to validate.  If omitted, a package.json file will be looked\n  for in the current working directory.\n\n**Note:** If check-engine is installed locally and you are not running it\nas part of an [npm script](https://docs.npmjs.com/misc/scripts), you will\nhave to specify the path to the check-engine executable, which will be\n`./node_modules/.bin/check-engine`.  Specifying this path is not necessary\nwithin npm scripts, because npm automatically puts the `./node_modules/.bin`\nfolder into the environment's `PATH`.\n\n\n### Programmatic\n```javascript\nvar checkEngine = require('check-engine');\n\ncheckEngine('<path to package.json>').then((result) => {\n    if (result.status !== 0) {\n        console.log('it failed!');\n    } else {\n        console.log('it worked!');\n    }\n}\n\n```\n\nThe result object contains higher level status, as well as information for individual packages that were validated.  The above example only shows the high level. The object structure for the result object is as follows:\n\n```javascript\n{\n    status: 0 if successful, -1 otherwise\n    message: {\n        text: 'overall error description'\n        type: 'error' or 'success'\n    },\n    packages: [\n        {\n            name: 'name of package',\n            type: 'error', 'success', or 'warn',\n            validatorFound: true or false,\n            expectedVersion: 'version listed in package.json for this package', // exists only if validatorFound is true\n            commandError: 'error result from validator process execution', // exists only if error occurred\n            foundVersion: 'version number found' // exists only if validatorFound is true and there was no commandError error\n        }\n    ]\n}\n```\nFor example usage of this, see [check-engine.js][check-engine-packages].\n\n## Developing check-engine\n\n### Building and Testing\n1. Fork and clone repo then `cd check-engine`.\n2. Install ESLint: `npm i -g eslint`.\n3. Make changes.\n4. Run `npm run lint`.\n5. Run `npm test`.\n6. Push and send a PR.\n\n### Publishing to NPM\n1. Update the version by calling `npm version [major, minor, or patch]`.\n2. Run `npm publish`.\n\n[thali]: http://thaliproject.org/\n[thalicode]: https://github.com/thaliproject/Thali_CordovaPlugin/blob/master/thali/install/validateBuildEnvironment.js\n[engines]: https://docs.npmjs.com/files/package.json#engines\n[validator]: lib/validatorRules.js\n[check-engine-packages]: https://github.com/mohlsen/check-engine/blob/master/bin/check-engine.js#L29\n","readmeFilename":"README.md"}