/
print.js
170 lines (158 loc) · 5.97 KB
/
print.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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
'use strict';
const os = require('os');
const _ = require('lodash');
const BbPromise = require('bluebird');
const getServerlessConfigFile = require('../../utils/getServerlessConfigFile')
.getServerlessConfigFile;
const jc = require('json-cycle');
const YAML = require('js-yaml');
class Print {
constructor(serverless, options) {
this.serverless = serverless;
this.options = options || {};
this.cache = {};
this.commands = {
print: {
usage: 'Print your compiled and resolved config file',
configDependent: true,
lifecycleEvents: ['print'],
options: {
format: {
usage: 'Print configuration in given format ("yaml", "json", "text"). Default: yaml',
},
path: {
usage: 'Optional period-separated path to print a sub-value (eg: "provider.name")',
},
transform: {
usage: 'Optional transform-function to apply to the value ("keys")',
},
},
},
};
this.hooks = {
'print:print': () => BbPromise.bind(this).then(this.print),
};
}
adorn(svc) {
const service = svc;
// service object treatment
this.cache.serviceService = service.service;
if (_.isObject(this.cache.serviceService)) {
service.service = service.service.name;
service.serviceObject = this.cache.serviceService;
}
// provider treatment and defaults
this.cache.serviceProvider = service.provider;
if (typeof this.cache.serviceProvider === 'string') {
service.provider = { name: this.cache.serviceProvider };
}
const serviceProvider = this.serverless.service.provider;
service.provider = _.merge(
{
stage: serviceProvider.stage,
region: serviceProvider.region,
variableSyntax: serviceProvider.variableSyntax,
},
service.provider
);
}
strip(svc) {
const service = svc;
if (_.isObject(this.cache.serviceService)) {
service.service = this.cache.serviceService;
delete service.serviceObject;
}
if (typeof this.cache.serviceProvider === 'string') {
service.provider = this.cache.serviceProvider;
} else {
// is object
if (!this.cache.serviceProvider.stage) {
delete service.provider.stage;
}
if (!this.cache.serviceProvider.region) {
delete service.provider.region;
}
if (this.cache.serviceProvider.variableSyntax) {
service.provider.variableSyntax = this.cache.serviceProvider.variableSyntax;
}
}
}
print() {
// #####################################################################
// ## KEEP SYNCHRONIZED WITH EQUIVALENT IN ~/lib/classes/Variables.js ##
// ## there, see `populateService` ##
// ## here, see below ##
// #####################################################################
// ###################################################################
// ## KEEP SYNCHRONIZED WITH EQUIVALENT IN ~/lib/classes/Service.js ##
// ## there, see `constructor` and `loadServiceFileParam` ##
// ## here, see `strip` and `adorn` ##
// ###################################################################
// The *already loaded* Service (i.e. serverless.yml) is adorned with extras for use by the
// framework and throughout its codebase. We could try using the populated service but that
// would require playing whack-a-mole on issues as changes are made to the service anywhere in
// the codebase. Avoiding that, this method must read the serverless.yml file itself, adorn it
// as the Service class would and then populate it, reversing the adornments thereafter in
// preparation for printing the service for the user.
return getServerlessConfigFile(this.serverless).then(svc => {
const service = svc;
this.adorn(service);
// Need to delete variableSyntax to avoid self-matching errors
this.serverless.variables.loadVariableSyntax();
delete service.provider.variableSyntax; // cached by adorn, restored by strip
this.serverless.variables.service = service;
return this.serverless.variables.populateObject(service).then(populated => {
let conf = populated;
this.strip(conf);
// dig into the object
if (this.options.path) {
const steps = this.options.path.split('.');
for (const step of steps) {
conf = conf[step];
if (!conf) {
return BbPromise.reject(
new this.serverless.classes.Error(`Path "${this.options.path}" not found`)
);
}
}
}
// apply an optional filter
if (this.options.transform) {
if (this.options.transform === 'keys') {
conf = Object.keys(conf);
} else {
return BbPromise.reject(
new this.serverless.classes.Error('Transform can only be "keys"')
);
}
}
// print configuration in the specified format
const format = this.options.format || 'yaml';
let out;
if (format === 'text') {
if (Array.isArray(conf)) {
out = conf.join(os.EOL);
} else {
if (_.isObject(conf)) {
return BbPromise.reject(
new this.serverless.classes.Error('Cannot print an object as "text"')
);
}
out = String(conf);
}
} else if (format === 'json') {
out = jc.stringify(conf, null, ' ');
} else if (format === 'yaml') {
out = YAML.dump(JSON.parse(jc.stringify(conf)), { noRefs: true });
} else {
return BbPromise.reject(
new this.serverless.classes.Error('Format must be "yaml", "json" or "text"')
);
}
this.serverless.cli.consoleLog(out);
return BbPromise.resolve();
});
});
}
}
module.exports = Print;