├── index.js ├── .eslintrc.js ├── bin └── install-changed.js ├── package.json ├── .gitignore ├── README.md ├── lib └── main.js └── LICENSE /index.js: -------------------------------------------------------------------------------- 1 | exports.watchPackage = require('./lib/main.js') 2 | -------------------------------------------------------------------------------- /.eslintrc.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | 'env': { 3 | 'commonjs': true, 4 | 'es6': true, 5 | 'node': true 6 | }, 7 | 'extends': [ 8 | 'standard' 9 | ], 10 | 'globals': { 11 | 'Atomics': 'readonly', 12 | 'SharedArrayBuffer': 'readonly' 13 | }, 14 | 'parserOptions': { 15 | 'ecmaVersion': 2018 16 | }, 17 | 'rules': { 18 | "camelcase": ["error", { "properties": "always" }], 19 | "unicode-bom": ["off"], 20 | "brace-style": ["error", "stroustrup"], 21 | "no-unused-expressions": ["off"], 22 | "prefer-const": ["error"], 23 | "new-cap": ["off"] 24 | } 25 | } 26 | -------------------------------------------------------------------------------- /bin/install-changed.js: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | 3 | const { program } = require('commander') 4 | 5 | const watcher = require('../lib/main') 6 | 7 | program 8 | .option('--install-command [command]', 'The command to run when dependencies need to be installed/updated') 9 | .option('--hash-filename [filename]', 'Filename where hash of dependencies will be written to') 10 | .option('--hash-only', 'Only update the hash') 11 | 12 | program.parse(process.argv) 13 | 14 | watcher({ 15 | installCommand: program.installCommand, 16 | hashFilename: program.hashFilename, 17 | isHashOnly: program.hashOnly 18 | }) 19 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "install-changed", 3 | "version": "1.1.0", 4 | "description": "Only npm installs if package.json has been modified", 5 | "main": "index.js", 6 | "scripts": { 7 | "test": "echo \"Error: no test specified\" && exit 1", 8 | "lint": "eslint ." 9 | }, 10 | "bin": { 11 | "install-changed": "./bin/install-changed.js" 12 | }, 13 | "repository": { 14 | "type": "git", 15 | "url": "https://github.com/ninesalt/install-changed.git" 16 | }, 17 | "author": "Youssef Swailem (http://github.com/ninesalt)", 18 | "license": "ISC", 19 | "keywords": [ 20 | "npm", 21 | "install", 22 | "install-modified", 23 | "install-changed", 24 | "install-changes", 25 | "modified", 26 | "changed", 27 | "changes", 28 | "package" 29 | ], 30 | "devDependencies": { 31 | "eslint": "^6.0.1", 32 | "eslint-config-standard": "^12.0.0", 33 | "eslint-plugin-import": "^2.18.0", 34 | "eslint-plugin-node": "^9.1.0", 35 | "eslint-plugin-promise": "^4.2.1", 36 | "eslint-plugin-standard": "^4.0.0" 37 | }, 38 | "dependencies": { 39 | "commander": "^5.1.0" 40 | } 41 | } 42 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | 8 | # Runtime data 9 | pids 10 | *.pid 11 | *.seed 12 | *.pid.lock 13 | 14 | # Directory for instrumented libs generated by jscoverage/JSCover 15 | lib-cov 16 | 17 | # Coverage directory used by tools like istanbul 18 | coverage 19 | 20 | # nyc test coverage 21 | .nyc_output 22 | 23 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 24 | .grunt 25 | 26 | # Bower dependency directory (https://bower.io/) 27 | bower_components 28 | 29 | # node-waf configuration 30 | .lock-wscript 31 | 32 | # Compiled binary addons (https://nodejs.org/api/addons.html) 33 | build/Release 34 | 35 | # Dependency directories 36 | node_modules/ 37 | jspm_packages/ 38 | 39 | # TypeScript v1 declaration files 40 | typings/ 41 | 42 | # Optional npm cache directory 43 | .npm 44 | 45 | # Optional eslint cache 46 | .eslintcache 47 | 48 | # Optional REPL history 49 | .node_repl_history 50 | 51 | # Output of 'npm pack' 52 | *.tgz 53 | 54 | # Yarn Integrity file 55 | .yarn-integrity 56 | 57 | # dotenv environment variables file 58 | .env 59 | 60 | # next.js build output 61 | .next 62 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Install-changed 2 | 3 | This package is a quick and easy way of figuring out whether or not `package.json` has been modified. It executes `npm install` if the file has been modified, otherwise it does nothing. 4 | 5 | ## Install 6 | 7 | You can find this package on `npm` and can install it with `npm install install-changed` 8 | 9 | ## Usage 10 | You can use it as follows. In your `package.json`, add a new script to run: 11 | ``` 12 | "scripts": { 13 | "pre-run": "install-changed", 14 | "other-scripts: "whatever.js" 15 | }, 16 | ``` 17 | Then when you run `npm run pre-run` it will automatically figure out what needs to happen. 18 | 19 | 20 | **Programatically** 21 | 22 | ``` 23 | const installChanged = require('install-changed') 24 | 25 | const isModified = installChanged.watchPackage({ 26 | hashFilename: '.packagehash', 27 | installCommand: 'npm ci' 28 | }) 29 | ``` 30 | 31 | ### Options 32 | 33 | **CLI** 34 | 35 | install-changed --help 36 | ``` 37 | Usage: install-changed [options] 38 | 39 | Options: 40 | --install-command [command] The command to run when dependencies need to be installed/updated 41 | --hash-filename [filename] Filename where hash of dependencies will be written to 42 | --hash-only Only update the hash 43 | -h, --help display help for command 44 | ``` 45 | 46 | Example 47 | ``` 48 | install-changed --hash-filename .packagehash --install-command "npm ci" 49 | ``` 50 | This will use the file `.packagehash` to store a hash of the installed dependencies and run `npm ci` instead of `npm install` when packages need to be installed / updated. 51 | 52 | There may be some cases you just only want to update the hash. For example, when you are installing a new package you don't want the script to install the package again later. You can use the `---hash-only` for that. 53 | -------------------------------------------------------------------------------- /lib/main.js: -------------------------------------------------------------------------------- 1 | const fs = require('fs') 2 | const path = require('path') 3 | const crypto = require('crypto') 4 | const execSync = require('child_process').execSync 5 | 6 | // hashes a given file and returns the hex digest 7 | const hashFile = (filepath) => { 8 | const hashSum = crypto.createHash('md5') 9 | const contents = fs.readFileSync(filepath, 'utf-8') 10 | const packageBlob = JSON.parse(contents) 11 | 12 | const dependencies = { 13 | dependencies: packageBlob['dependencies'] || {}, 14 | devDependencies: packageBlob['devDependencies'] || {} 15 | } 16 | const depsJson = JSON.stringify(dependencies) 17 | hashSum.update(Buffer.from(depsJson)) 18 | return hashSum.digest('hex') 19 | } 20 | 21 | const findPackageJson = () => { 22 | let current = process.cwd() 23 | let last = current 24 | do { 25 | const search = path.join(current, 'package.json') 26 | if (fs.existsSync(search)) { 27 | return search 28 | } 29 | last = current 30 | current = path.dirname(current) 31 | } while (current !== last) 32 | } 33 | 34 | // returns whether or not npm install should be executed 35 | const watchFile = ({ 36 | hashFilename = 'packagehash.txt', 37 | installCommand = 'npm install', 38 | isHashOnly = false 39 | }) => { 40 | const packagePath = findPackageJson() 41 | 42 | if (!packagePath) { 43 | console.error('Cannot find package.json. Travelling up from current working directory') 44 | } 45 | 46 | const packageHashPath = path.join(path.dirname(packagePath), hashFilename) 47 | const recentDigest = hashFile(packagePath) 48 | 49 | // if the hash file doesn't exist 50 | // or if it does and the hash is different 51 | if (!fs.existsSync(packageHashPath) || fs.readFileSync(packageHashPath, 'utf-8') !== recentDigest) { 52 | console.log('package.json has been modified.') 53 | 54 | if (isHashOnly) { 55 | console.log('Updating hash only because --hash-only is true.') 56 | return true 57 | } 58 | 59 | console.log('Installing and updating hash.') 60 | 61 | try { 62 | execSync( 63 | installCommand, 64 | { 65 | stdio: 'inherit' 66 | } 67 | ) 68 | fs.writeFileSync(packageHashPath, recentDigest) // write to hash to file for future use 69 | } 70 | catch (error) { 71 | console.log(error) 72 | } 73 | return true 74 | } 75 | console.log('package.json has not been modified.') 76 | return false 77 | } 78 | 79 | module.exports = watchFile 80 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------