├── .gitignore ├── LICENSE ├── LICENSE.md ├── README.md ├── index.js └── package.json /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | 3 | coverage 4 | lib-cov 5 | *.seed 6 | *.log 7 | *.csv 8 | *.dat 9 | *.out 10 | *.pid 11 | *.gz 12 | *.tgz 13 | *.tmp 14 | *.sublime-workspace 15 | 16 | pids 17 | logs 18 | results 19 | scratch/ 20 | .idea/ 21 | .settings/ 22 | .vscode/ 23 | test-reports.xml 24 | 25 | npm-debug.log 26 | node_modules 27 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Copyright (c) 2015 Telerik AD 2 | 3 | Licensed under the Apache License, Version 2.0 (the "License"); 4 | you may not use this file except in compliance with the License. 5 | You may obtain a copy of the License at 6 | 7 | http://www.apache.org/licenses/LICENSE-2.0 8 | 9 | Unless required by applicable law or agreed to in writing, software 10 | distributed under the License is distributed on an "AS IS" BASIS, 11 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | See the License for the specific language governing permissions and 13 | limitations under the License. -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 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 2015 Telerik 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 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | @nativescript/hook 2 | ======================================= 3 | 4 | This module gives you an easier way to install hooks into NativeScript projects when using the `tns install ` command. A project hook is some sort of script that is configured to be executed when the NativeScript CLI executes some action. 5 | 6 | Hooks go into the `hooks/` folder of a project. For example, when `tns prepare ...` is executed, all script files in the `hooks/before-prepare/` and `hooks/after-prepare/` folders are executed, as well. 7 | 8 | This module simplifies the process of installing the scripts into the right project folder. 9 | 10 | How to use 11 | ---------- 12 | 13 | ### Describe the hooks 14 | First, add a description of your hooks to the module's `package.json`. Here's an example: 15 | ```json 16 | { 17 | "nativescript": { 18 | "hooks": [ 19 | { 20 | "type": "before-prepare", 21 | "script": "lib/before-prepare.js" 22 | } 23 | ] 24 | }, 25 | } 26 | ``` 27 | The above specifies that the script `lib/before-prepare.js` should be executed when the `tns prepare ...` command is executed. the `"type"` property specifies the type of the hook to install. The `"script"` property specifies the path to the script to execute. You can add more hooks by extending the `"hooks"` array. 28 | 29 | ### Install the hooks 30 | Add a post-install and pre-uninstall script to your `package.json`, if you haven't done so already: 31 | ``` 32 | "scripts": { 33 | ... 34 | "postinstall": "node postinstall.js", 35 | "preuninstall": "node preuninstall.js" 36 | }, 37 | ``` 38 | 39 | The post-install script (`postinstall.js` in the example) should contain the following line: 40 | ``` 41 | require('@nativescript/hook')(__dirname).postinstall(); 42 | ``` 43 | 44 | The pre-uninstall script (`preuninstall.js` in the example) should contain the following line: 45 | ``` 46 | require('@nativescript/hook')(__dirname).preuninstall(); 47 | ``` 48 | 49 | These two hooks will take care of installing and removing the hooks from the NativeScript project, when your module is installed or uninstalled. 50 | 51 | `tns install ` 52 | ---------------------- 53 | NativeScript modules that install hooks are intended to be installed using the `tns install ` command, not through npm directly. During module installation the NativeScript CLI provides information to the post-install script where to put the hooks. The following environment variables are defined when installing through `tns install `: 54 | * `TNS_HOOKS_DIR` - the directory where the hooks should be installed. It may or may not exist. 55 | * `TNS_PROJECT_DIR` - the current project directory. 56 | 57 | Modules installed this way can be uninstalled simply by running `npm rm --save-dev`. 58 | 59 | In-process hooks 60 | ---------------- 61 | By default, hooks are executed in a child process and execution continues when the child process dies. This gives you flexibility when writing your hooks, but doesn't allow you to use any of the services of the CLI. 62 | 63 | To that end, in-process hooks allow you to execute your hooks in such a way so that you can use any of the services available from the injector. In-process hooks work only for JavaScript hooks. To enable in-process execution, all you need to have is a `module.exports = ...` statement in the hook. For example, if the hook script is: 64 | ```javascript 65 | module.exports = function($logger) { 66 | }; 67 | ``` 68 | Then, the hook script will be require'd by the CLI and the exported function will be called through the injector. 69 | 70 | Hooks can take a special injected argument named `hookArgs`: 71 | ```javascript 72 | module.exports = function(hookArgs) { 73 | }; 74 | ``` 75 | `hookArgs` is a hash containing all the arguments passed to the hooked method. For example, the `prepare` hook is activated by the CLI method `preparePlatform(platform: string)`. Here, the hook will get the value of the `platform` argument in the `hookArgs.platform` property. 76 | 77 | If you execute asynchronous code in your hook, you need to return a promise, otherwise execution will continue before your hook completes: 78 | ```javascript 79 | var mkdirp = require('mkdirp'); 80 | module.exports = function($logger) { 81 | return new Promise(function(resolve, reject) { 82 | mkdirp('somedir', function(err) { 83 | if (err) { 84 | reject(err); 85 | else { 86 | resolve(); 87 | } 88 | }) 89 | }); 90 | } 91 | ``` 92 | 93 | And finally, when installing in-process hooks through this module, you need to explicitly specify that using the `inject` property of the script descriptor in the `package.json`: 94 | ```json 95 | { 96 | "nativescript": { 97 | "hooks": [ 98 | { 99 | "type": "after-prepare", 100 | "script": "lib/after-prepare.js", 101 | "inject": true 102 | } 103 | ] 104 | }, 105 | } 106 | ``` 107 | 108 | You have the ability to define a custom name to your hook in `package.json`, this attribute is optional and defaults to the plugin package name: 109 | ```json 110 | { 111 | "nativescript": { 112 | "hooks": [ 113 | { 114 | "type": "after-prepare", 115 | "script": "lib/after-prepare.js", 116 | "name": "my-custom-hook" 117 | } 118 | ] 119 | }, 120 | } 121 | ``` 122 | 123 | 124 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | module.exports = function (__dirname) { 2 | return { 3 | findProjectDir: function () { 4 | return findProjectDir(__dirname); 5 | }, 6 | postinstall: function () { 7 | return postinstall(__dirname); 8 | }, 9 | preuninstall: function () { 10 | return preuninstall(__dirname); 11 | } 12 | }; 13 | }; 14 | 15 | var fs = require('fs'); 16 | var os = require('os'); 17 | var path = require('path'); 18 | var util = require('util'); 19 | var mkdirp = require('mkdirp'); 20 | var glob = require('glob'); 21 | 22 | function generateHookName(pkg, hook) { 23 | // flatten scoped packages to names 24 | return ((hook.name || pkg.name).replace(/@/ig, '').replace(/\//ig, '-')) + '.js'; 25 | } 26 | 27 | function findProjectDir(pkgdir) { 28 | if (process.env.INIT_CWD && _isNativeScriptAppRoot(process.env.INIT_CWD)) { 29 | return process.env.INIT_CWD; 30 | } 31 | 32 | var candidateDir = pkgdir; 33 | var oldCandidateDir = null; 34 | 35 | while (true) { 36 | candidateDir = path.dirname(candidateDir); 37 | if (oldCandidateDir === candidateDir) { 38 | return; 39 | } 40 | 41 | if (path.basename(candidateDir) === 'node_modules') { 42 | continue; 43 | } 44 | 45 | if (_isNativeScriptAppRoot(candidateDir)) { 46 | return candidateDir; 47 | } 48 | 49 | oldCandidateDir = candidateDir; 50 | } 51 | } 52 | 53 | function _isNativeScriptAppRoot(dir) { 54 | var isNativeScriptAppRoot = false; 55 | var packageJsonFile = path.join(dir, 'package.json'); 56 | if (fs.existsSync(packageJsonFile)) { 57 | var packageJsonContent = require(packageJsonFile); 58 | isNativeScriptAppRoot = !!packageJsonContent.nativescript && !!packageJsonContent.nativescript.id; 59 | } 60 | 61 | return isNativeScriptAppRoot; 62 | } 63 | 64 | function forEachHook(pkgdir, callback) { 65 | var pkg = require(path.join(pkgdir, 'package.json')); 66 | var ns = pkg.nativescript; 67 | if (!ns) { 68 | throw Error('Not a NativeScript development module.'); 69 | } 70 | 71 | var projectDir = findProjectDir(pkgdir); 72 | if (!projectDir) { 73 | return; 74 | } 75 | var hooksDir = path.join(projectDir, 'hooks'); 76 | 77 | if (ns.hooks) { 78 | ns.hooks.forEach(function (hook) { 79 | callback(hooksDir, pkg, hook); 80 | }); 81 | } 82 | } 83 | 84 | function hookInstalled(hookDir, pkg, hook) { 85 | var hookBaseName = pkg.name; 86 | var hookGlob = path.join(hookDir, "*" + hookBaseName + "*"); 87 | var files = glob.sync(hookGlob); 88 | return files.length > 0; 89 | } 90 | 91 | function postinstall(pkgdir) { 92 | forEachHook(pkgdir, function (hooksDir, pkg, hook) { 93 | var hookDir = path.join(hooksDir, hook.type); 94 | if (!fs.existsSync(hookDir)) { 95 | mkdirp.sync(hookDir); 96 | } 97 | if (hookInstalled(hookDir, pkg, hook)) { 98 | console.log(`Hook already installed: ${pkg.name} at location: ${hookDir}`); 99 | return; 100 | } 101 | var hookFileName = generateHookName(pkg, hook); 102 | var hookPath = path.join(hookDir, hookFileName); 103 | 104 | var trampoline = util.format('%srequire("%s/%s");', hook.inject ? 'module.exports = ' : '', pkg.name, hook.script); 105 | 106 | fs.writeFileSync(hookPath, trampoline + os.EOL); 107 | }); 108 | } 109 | 110 | function preuninstall(pkgdir) { 111 | forEachHook(pkgdir, function (hooksDir, pkg, hook) { 112 | var hookDir = path.join(hooksDir, hook.type); 113 | var hookFileName = generateHookName(pkg, hook); 114 | var hookPath = path.join(hookDir, hookFileName); 115 | 116 | try { 117 | if (fs.existsSync(hookPath)) { 118 | fs.unlinkSync(hookPath); 119 | } 120 | } catch (err) { 121 | console.warn('@nativescript/hook: ' + err.toString()); 122 | } 123 | }); 124 | } 125 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@nativescript/hook", 3 | "version": "1.0.0", 4 | "description": "Helper module for installing hooks into NativeScript projects", 5 | "main": "index.js", 6 | "scripts": { 7 | "test": "exit 0" 8 | }, 9 | "author": "NativeScript", 10 | "license": "Apache-2.0", 11 | "repository": { 12 | "type": "git", 13 | "url": "https://github.com/NativeScript/nativescript-hook.git" 14 | }, 15 | "dependencies": { 16 | "glob": "^7.1.0", 17 | "mkdirp": "^1.0.4" 18 | } 19 | } 20 | --------------------------------------------------------------------------------