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
190
191
192
|
import retry from "async-retry";
import chalk from "chalk";
import fs from "fs-extra";
import path from "path";
import {
downloadAndExtractExample,
downloadAndExtractRepo,
getRepoInfo,
existsInRepo,
hasRepo,
RepoInfo,
} from "../../utils/examples";
import { isFolderEmpty } from "../../utils/isFolderEmpty";
import { isWriteable } from "../../utils/isWriteable";
import { turboLoader, error } from "../../logger";
import { isDefaultExample } from "../../utils/isDefaultExample";
export class DownloadError extends Error {}
export async function createProject({
appPath,
example,
examplePath,
}: {
appPath: string;
example: string;
examplePath?: string;
}): Promise<{
cdPath: string;
hasPackageJson: boolean;
availableScripts: Array<string>;
repoInfo?: RepoInfo;
}> {
let repoInfo: RepoInfo | undefined;
let repoUrl: URL | undefined;
const defaultExample = isDefaultExample(example);
try {
repoUrl = new URL(example);
} catch (err: any) {
if (err.code !== "ERR_INVALID_URL") {
error(err);
process.exit(1);
}
}
if (repoUrl) {
if (repoUrl.origin !== "https://github.com") {
error(
`Invalid URL: ${chalk.red(
`"${example}"`
)}. Only GitHub repositories are supported. Please use a GitHub URL and try again.`
);
process.exit(1);
}
repoInfo = await getRepoInfo(repoUrl, examplePath);
if (!repoInfo) {
error(
`Unable to fetch repository information from: ${chalk.red(
`"${example}"`
)}. Please fix the URL and try again.`
);
process.exit(1);
}
const found = await hasRepo(repoInfo);
if (!found) {
error(
`Could not locate the repository for ${chalk.red(
`"${example}"`
)}. Please check that the repository exists and try again.`
);
process.exit(1);
}
} else {
const found = await existsInRepo(example);
if (!found) {
error(
`Could not locate an example named ${chalk.red(
`"${example}"`
)}. It could be due to the following:\n`,
`1. Your spelling of example ${chalk.red(
`"${example}"`
)} might be incorrect.\n`,
`2. You might not be connected to the internet or you are behind a proxy.`
);
process.exit(1);
}
}
const root = path.resolve(appPath);
if (!(await isWriteable(path.dirname(root)))) {
error(
"The application path is not writable, please check folder permissions and try again."
);
error("It is likely you do not have write permissions for this folder.");
process.exit(1);
}
const appName = path.basename(root);
try {
await fs.mkdir(root, { recursive: true });
} catch (err) {
error("Unable to create project directory");
console.error(err);
process.exit(1);
}
const { isEmpty, conflicts } = isFolderEmpty(root);
if (!isEmpty) {
error(
`${chalk.dim(root)} has ${conflicts.length} conflicting ${
conflicts.length === 1 ? "file" : "files"
} - please try a different location`
);
process.exit(1);
}
const originalDirectory = process.cwd();
process.chdir(root);
/**
* clone the example repository
*/
const loader = turboLoader("Downloading files...");
try {
if (repoInfo) {
console.log(
`\nDownloading files from repo ${chalk.cyan(
example
)}. This might take a moment.`
);
console.log();
loader.start();
await retry(() => downloadAndExtractRepo(root, repoInfo as RepoInfo), {
retries: 3,
});
} else {
console.log(
`\nDownloading files${
!defaultExample ? ` for example ${chalk.cyan(example)}` : ""
}. This might take a moment.`
);
console.log();
loader.start();
await retry(() => downloadAndExtractExample(root, example), {
retries: 3,
});
}
} catch (reason) {
function isErrorLike(err: unknown): err is { message: string } {
return (
typeof err === "object" &&
err !== null &&
typeof (err as { message?: unknown }).message === "string"
);
}
throw new DownloadError(isErrorLike(reason) ? reason.message : reason + "");
} finally {
loader.stop();
}
const rootPackageJsonPath = path.join(root, "package.json");
const hasPackageJson = fs.existsSync(rootPackageJsonPath);
const availableScripts = [];
if (hasPackageJson) {
let packageJsonContent;
try {
packageJsonContent = fs.readJsonSync(rootPackageJsonPath);
} catch {
// ignore
}
if (packageJsonContent) {
// read the scripts from the package.json
availableScripts.push(...Object.keys(packageJsonContent.scripts || {}));
}
}
let cdPath: string = appPath;
if (path.join(originalDirectory, appName) === appPath) {
cdPath = appName;
}
return { cdPath, hasPackageJson, availableScripts, repoInfo };
}
|