-
Notifications
You must be signed in to change notification settings - Fork 242
/
Context.js
74 lines (64 loc) · 2.86 KB
/
Context.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
/**
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/
var path = require('path');
var events = require('cordova-common').events;
/**
* Creates hook script context
* @constructor
* @param {String} hook The hook type
* @param {Object} opts Hook options
* @returns {Object} */
function Context (hook, opts) {
this.hook = hook;
// create new object, to avoid affecting input opts in other places
// For example context.opts.plugin = Object is done, then it affects by reference
this.opts = Object.assign({}, opts);
this.cmdLine = process.argv.join(' ');
this.cordova = require('../cordova/cordova');
}
// As per CB-9834 we need to maintain backward compatibility and provide a compat layer
// for plugins that still require modules, factored to cordova-common.
var compatMap = {
'../configparser/ConfigParser': function () {
return require('cordova-common').ConfigParser;
},
'../util/xml-helpers': function () {
return require('cordova-common').xmlHelpers;
}
};
/**
* Returns a required module
* @param {String} modulePath Module path
* @returns {Object} */
Context.prototype.requireCordovaModule = function (modulePath) {
// There is a very common mistake, when hook requires some cordova functionality
// using 'cordova-lib/...' path.
// This path will be resolved only when running cordova from 'normal' installation
// (without symlinked modules). If cordova-lib linked to cordova-cli this path is
// never resolved, so hook fails with 'Error: Cannot find module 'cordova-lib''
var resolvedPath = path.resolve(__dirname, modulePath.replace(/^cordova-lib/, '../../../cordova-lib'));
var relativePath = path.relative(__dirname, resolvedPath).replace(/\\/g, '/');
events.emit('verbose', 'Resolving module name for ' + modulePath + ' => ' + relativePath);
var compatRequire = compatMap[relativePath];
if (compatRequire) {
events.emit('warn', 'The module "' + path.basename(relativePath) + '" has been factored ' +
'into "cordova-common". Consider update your plugin hooks.');
return compatRequire();
}
return require(relativePath);
};
module.exports = Context;