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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
|
/**
* Package all recipes
*/
const targz = require('targz');
const fs = require('fs-extra');
const path = require('path');
const sizeOf = require('image-size');
const simpleGit = require('simple-git');
const pkgVersionChangedMatcher = new RegExp(/\n\+.*version.*/);
// Publicly availible link to this repository's recipe folder
// Used for generating public icon URLs
const repo = 'https://cdn.jsdelivr.net/gh/getferdi/recipes/recipes/';
// Helper: Compress src folder into dest file
const compress = (src, dest) => new Promise((resolve, reject) => {
targz.compress({
src,
dest,
tar: {
// Don't package .DS_Store files
ignore: function(name) {
return path.basename(name) === '.DS_Store'
}
},
}, (err) => {
if (err) {
reject(err);
} else {
resolve(dest);
}
});
});
// Let us work in an async environment
(async () => {
// Create paths to important files
const repoRoot = path.join(__dirname, '..');
const recipesFolder = path.join(repoRoot, 'recipes');
const outputFolder = path.join(repoRoot, 'archives');
const allJson = path.join(repoRoot, 'all.json');
const featuredFile = path.join(repoRoot, 'featured.json');
const featuredRecipes = await fs.readJSON(featuredFile);
let recipeList = [];
let unsuccessful = 0;
await fs.ensureDir(outputFolder);
await fs.emptyDir(outputFolder);
await fs.remove(allJson);
const git = await simpleGit(repoRoot);
const isGitRepo = await git.checkIsRepo();
if (!isGitRepo) {
console.debug("NOT A git repo: will bypass dirty state checks");
}
const availableRecipes = fs.readdirSync(recipesFolder, { withFileTypes: true })
.filter(dir => dir.isDirectory())
.map(dir => dir.name);
for(let recipe of availableRecipes) {
const recipeSrc = path.join(recipesFolder, recipe);
const packageJson = path.join(recipeSrc, 'package.json');
const svgIcon = path.join(recipeSrc, 'icon.svg');
// Check that package.json exists
if (!await fs.pathExists(packageJson)) {
console.log(`⚠️ Couldn't package "${recipe}": Folder doesn't contain a "package.json".`);
unsuccessful++;
continue;
}
// Check that icons exist
const hasSvg = await fs.pathExists(svgIcon);
if (!hasSvg) {
console.log(`⚠️ Couldn't package "${recipe}": Recipe doesn't contain an icon SVG`);
unsuccessful++;
continue;
}
// Check icons sizes
const svgSize = sizeOf(svgIcon);
const svgHasRightSize = svgSize.width === svgSize.height;
if (!svgHasRightSize) {
console.log(`⚠️ Couldn't package "${recipe}": Recipe SVG icon isn't a square`);
unsuccessful++;
continue;
}
// Read package.json
const config = await fs.readJson(packageJson)
// Make sure it contains all required fields
if (!config) {
console.log(`⚠️ Couldn't package "${recipe}": Could not read or parse "package.json"`);
unsuccessful++;
continue;
}
let configErrors = [];
if (!config.id) {
configErrors.push("The recipe's package.json contains no 'id' field. This field should contain a unique ID made of lowercase letters (a-z), numbers (0-9), hyphens (-), periods (.), and underscores (_)");
} else if (!/^[a-zA-Z0-9._\-]+$/.test(config.id)) {
configErrors.push("The recipe's package.json defines an invalid recipe ID. Please make sure the 'id' field only contains lowercase letters (a-z), numbers (0-9), hyphens (-), periods (.), and underscores (_)");
}
if (!config.name) {
configErrors.push("The recipe's package.json contains no 'name' field. This field should contain the name of the service (e.g. 'Google Keep')");
}
if (!config.version) {
configErrors.push("The recipe's package.json contains no 'version' field. This field should contain the a semver-compatible version number for your recipe (e.g. '1.0.0')");
}
if (!config.config || typeof config.config !== "object") {
configErrors.push("The recipe's package.json contains no 'config' object. This field should contain a configuration for your service.");
}
if (isGitRepo) {
const relativeRepoSrc = path.relative(repoRoot, recipeSrc);
// Check for changes in recipe's directory, and if changes are present, then the changes should contain a version bump
await git.diffSummary(relativeRepoSrc, (err, result) => {
if (err) {
configErrors.push(`Got the following error while checking for git changes: ${err}`);
} else if (result && (result.changed !== 0 || result.insertions !== 0 || result.deletions !== 0)) {
const pkgJsonRelative = path.relative(repoRoot, packageJson);
if (!result.files.find(({file}) => file === pkgJsonRelative)) {
configErrors.push(`Found changes in '${relativeRepoSrc}' without the corresponding version bump in '${pkgJsonRelative}'`);
} else {
git.diff(pkgJsonRelative, (_diffErr, diffResult) => {
if (diffResult && !pkgVersionChangedMatcher.test(diffResult)) {
configErrors.push(`Found changes in '${relativeRepoSrc}' without the corresponding version bump in '${pkgJsonRelative}' (found other changes though)`);
}
});
}
}
});
};
if (configErrors.length > 0) {
console.log(`⚠️ Couldn't package "${recipe}": There were errors in the recipe's package.json:
${configErrors.reduce((str, err) => `${str}\n${err}`)}`);
unsuccessful++;
continue;
}
if (!await fs.exists(path.join(recipeSrc, 'webview.js'))) {
console.log(`⚠️ Couldn't package "${recipe}": The recipe doesn't contain a "webview.js"`);
unsuccessful++;
continue;
}
if (!await fs.exists(path.join(recipeSrc, 'index.js'))) {
console.log(`⚠️ Couldn't package "${recipe}": The recipe doesn't contain a "index.js"`);
unsuccessful++;
continue;
}
// Package to .tar.gz
compress(recipeSrc, path.join(outputFolder, `${config.id}.tar.gz`));
// Add recipe to all.json
const isFeatured = featuredRecipes.includes(config.id);
const packageInfo = {
"author": config.author || '',
"featured": isFeatured,
"id": config.id,
"name": config.name,
"version": config.version,
"icons": {
"svg": `${repo}${config.id}/icon.svg`,
},
};
recipeList.push(packageInfo);
}
// Sort package list alphabetically
recipeList = recipeList.sort((a, b) => {
var textA = a.id.toLowerCase();
var textB = b.id.toLowerCase();
return (textA < textB) ? -1 : (textA > textB) ? 1 : 0;
});
await fs.writeJson(allJson, recipeList, {
spaces: 2,
EOL: '\n',
});
console.log(`✅ Successfully packaged and added ${recipeList.length} recipes (${unsuccessful} unsuccessful recipes)`);
if (unsuccessful > 0) {
process.exit(1);
}
})();
|
