-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathvalidate.ts
More file actions
150 lines (130 loc) · 5.17 KB
/
Copy pathvalidate.ts
File metadata and controls
150 lines (130 loc) · 5.17 KB
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
import _ from 'lodash';
import chalk from 'chalk';
import { Config, ContentValidationError, loadConfig, loadContent } from '@stackbit/sdk';
import { track, EVENTS } from './telemetry';
import { trackValidateResultStats } from './utils';
const red = chalk.red;
const green = chalk.green;
const redCross = red('✘');
interface ValidateOptions {
inputDir: string;
configOnly: boolean;
quiet: boolean;
}
export async function validate({ inputDir, configOnly, quiet }: ValidateOptions) {
track(EVENTS.validate, { config_only: configOnly, quiet, inputDir });
const quietConsole = getQuietConsole({ quiet });
quietConsole.debug(`loading and validating Stackbit configuration from: ${inputDir}`);
const configResult = await loadConfig({
dirPath: inputDir
});
quietConsole.group();
const models = configResult.config?.models ?? [];
console.group(`loaded ${models.length} models:`);
(configResult.config?.models ?? []).forEach((model) => {
if (model.name === '__image_model') {
return;
}
if (model.__metadata?.invalid) {
console.log(red(`✘ ${model.name} - invalid model`));
} else {
console.log(green(`✔ ${model.name}`));
}
});
console.groupEnd();
if (configResult.errors.length === 0) {
console.log(green('✔ configuration is valid'));
} else {
console.group(red(`found ${configResult.errors.length} errors in stackbit.yaml:`));
configResult.errors.forEach((error) => {
console.log(`${redCross} ${error.message}`);
});
console.groupEnd();
}
quietConsole.groupEnd();
if (configOnly || !configResult.config) {
trackValidateResultStats(configResult, null, inputDir);
return;
}
// do not load or validate content if cmsName is not git
const cmsName = configResult.config.cmsName ?? 'git';
if (cmsName !== 'git') {
trackValidateResultStats(configResult, null, inputDir);
return;
}
const contentResult = await validateContent({
dirPath: inputDir,
config: configResult.config,
quiet: quiet,
skipUnmodeledContent: false
});
trackValidateResultStats(configResult, contentResult, inputDir);
if (configResult.errors.length === 0 && contentResult.errors.length === 0) {
console.log(green('✔ validation passed'));
} else {
console.log(red('✘ validation failed, see errors above'));
}
}
interface ValidateContentOptions {
dirPath: string;
config: Config;
quiet: boolean;
skipUnmodeledContent: boolean;
}
async function validateContent({ dirPath, config, quiet, skipUnmodeledContent }: ValidateContentOptions) {
const quietConsole = getQuietConsole({ quiet });
quietConsole.group(`loading and validating content from: ${dirPath}`);
const result = await loadContent({ dirPath, config, skipUnmodeledContent });
const { modeledItems, unmodeledItems } = _.groupBy(result.contentItems, (contentItem) =>
contentItem.__metadata.modelName !== null ? 'modeledItems' : 'unmodeledItems'
);
quietConsole.debug(
`loaded ${result.contentItems.length} files in total (${(modeledItems || []).length} matched, ${(unmodeledItems || []).length} unmatched)`
);
if (!quiet && typeof modeledItems !== 'undefined' && modeledItems.length > 0) {
const modeledItemsByModelName = _.groupBy(modeledItems, (contentItem) => contentItem.__metadata.modelName);
console.group(`${modeledItems.length} files matched to models:`);
_.forEach(modeledItemsByModelName, (contentItems, modelName) => {
console.group(`${modelName}: ${contentItems.length} files:`);
_.forEach(contentItems, (contentItem) => {
console.log(contentItem.__metadata.filePath);
});
console.groupEnd();
});
console.groupEnd();
}
if (!quiet && typeof unmodeledItems !== 'undefined' && unmodeledItems.length > 0) {
console.group(red(`${unmodeledItems.length} files could not be matched to models:`));
_.forEach(unmodeledItems, (contentItem) => {
console.log(contentItem.__metadata.filePath);
});
console.groupEnd();
}
if (result.errors.length === 0) {
console.log(green('✔ content files are valid'));
} else {
console.group(red(`found ${result.errors.length} errors in content files:`));
result.errors.forEach((error: Error) => {
if (error instanceof ContentValidationError) {
console.log(`${redCross} ${error.filePath} (${error.modelName}): ${error.message}`);
} else {
console.log(`${redCross} ${error.message}`);
}
});
console.groupEnd();
}
quietConsole.groupEnd();
return result;
}
function getQuietConsole({ quiet }: { quiet: boolean }) {
if (!quiet) {
return console;
}
const noop = () => {};
const quietConsole = new console.Console({ stdout: process.stdout, stderr: process.stderr });
quietConsole.debug = noop;
quietConsole.error = noop;
quietConsole.group = noop;
quietConsole.groupEnd = noop;
return quietConsole;
}