1
import { execSync } from 'node:child_process';
2
import { readFile, writeFile, rm } from 'node:fs/promises';
3
import readline from 'node:readline/promises';
4

5
/** This array contains the arguments that can be passed in for this script. */
6
const args = process.argv.slice(2);
7

8
/** This records user input in the terminal so users can choose options as they progress through the function. */
9
const rl = readline.createInterface({
10
    input: process.stdin,
11
    output: process.stdout
12
});
13

14
/**
15
 * This function runs an NPM Command.
16
 * @param {String} command The NPM command to run.
17
 */
18
function runCommand(command) {
19
    console.log("Running Command \"" + command + "\"...");
20
    execSync(command, { stdio: 'inherit' });
21
    console.log("\n\n");
22
}
23

24
/**
25
 * This function checks to see if an argument exists in the "args" array and returns the result.
26
 * @param {String} mainArg The argument passed into the command.
27
 */
28
function checkForArg(mainArg = "") {
29
    return (args.findIndex(item => item === mainArg) != -1)
30
}
31

32
/**
33
 * This function returns a spinner to show while the script is running to mimic loading.
34
 * @param {String} text The text to display while the spinner is running.
35
 */
36
function createSpinner(text) {
37
    const frames = ["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"];
38
    let i = 0;
39
    process.stdout.write("\u001B[?25l");
40

41
    const timer = setInterval(() => {
42
        const frame = frames[i = ++i % frames.length];
43
        process.stdout.write(`\r${frame} ${text}`);
44
    }, 80);
45

46
    return { succeed(endText) {
47
        clearInterval(timer);
48
        process.stdout.write(`\r✅ ${endText}\n`);
49
        process.stdout.write("\u001B[?25h");
50
    }}
51
}
52

53
/**
54
 * This function removes a file or directory from this project.
55
 * @param {String} path The path to the file or directory.
56
 * @param {Boolean} directory If true, the path leads to a directory.
57
 */
58
async function removeFileOrDirectory(path = "", directory = false) {
59
    const innerRmMessage = (directory ? ("the \"" + path + "\" folder") : ("\"" + path + "\""));
60
    const removeSpinner = createSpinner("Deleting " + innerRmMessage + "...");
61
    await rm(path, { recursive: true, force: true });
62
    removeSpinner.succeed("Deleted " + innerRmMessage + "!");
63
}
64

65
/** This function is the core of the file and handles all the upgrade requirements. */
66
async function main() {
67
    try {
68
        // This section handles asking for and dependencies to reject for the next step.
69
        var rejectDepsBool = (checkForArg("--exclude-deps") ? true : (checkForArg("--skip-exclude-deps") ? false : null));
70
        const rejectDepsQuestion = 'Do you want to exclude any dependencies from being updated? (y/n): ';
71

72
        if(rejectDepsBool == null) {
73
            runCommand('npx npm-check-updates');
74
            const rejectDeps = await rl.question(rejectDepsQuestion);
75
            rejectDepsBool = (rejectDeps.toLowerCase() === "y" || rejectDeps.toLowerCase() === "yes");
76
        } else {
77
            console.log(rejectDepsQuestion + (rejectDepsBool ? 'yes' : 'no'));
78
        }
79

80
        /** @type {Array<String>} An array that stores all the dependencies to not update. */
81
        const rejectDepsArray = [];
82

83
        if(rejectDepsBool) {
84
            var rejectDepsInput = "";
85
            while(rejectDepsInput != "_stop_" && rejectDepsInput != "_no_") {
86
                rejectDepsInput = await rl.question('Type in the name of a package, or the string \"_stop_\" if you would like to stop: ');
87
                if(rejectDepsInput != "_stop_" && rejectDepsInput != "_no_") { rejectDepsArray.push(rejectDepsInput.toLowerCase()); }
88
            }
89
            console.log("✅ Packages Recorded.\n\n")
90
        } else {
91
            console.log("🛑 Will Not Ignore Any Dependencies.\n\n");
92
        }
93

94
        var rejectDepsCommandOption = "";
95
        if(rejectDepsArray.length > 0) {
96
            rejectDepsCommandOption = " --reject ";
97
            rejectDepsArray.forEach((item) => { rejectDepsCommandOption += (item + ","); });
98
            rejectDepsCommandOption = rejectDepsCommandOption.substring(0, rejectDepsCommandOption.length - 1);
99
        }
100

101
        // This section handles updating the current dependencies on the Vue.js project.
102
        var updateDepsBool = (checkForArg("--update-deps") ? true : checkForArg("--skip-update-deps") ? false : null);
103
        const updateDepsQuestion = 'Do you want to update the dependencies? (y/n): ';
104

105
        if(updateDepsBool == null) {
106
            if(rejectDepsCommandOption !== "") { runCommand('npx npm-check-updates' + rejectDepsCommandOption); }
107
            const updateDeps = await rl.question(updateDepsQuestion);
108
            updateDepsBool = (updateDeps.toLowerCase() === "y" || updateDeps.toLowerCase() === "yes");
109
        } else {
110
            console.log(updateDepsQuestion + (updateDepsBool ? 'yes' : 'no'));
111
        }
112

113
        if(updateDepsBool) {
114
            runCommand('npx npm-check-updates --upgrade' + rejectDepsCommandOption);
115
            console.log("✅ Dependencies Ready To Install!\n\n")
116
        } else {
117
            console.log("🛑 Will Not Update Dependencies.\n\n");
118
        }
119

120
        // This section handles updating the Version Number.
121
        var updateVersionBool = (checkForArg("--update-version") ? true : (checkForArg("--skip-update-version") ? false : null));
122
        const updateVersionQuestion = 'Do you want to update Your Website\'s version number? (y/n): ';
123

124
        if(updateVersionBool == null) {
125
            const updateVersion = await rl.question(updateVersionQuestion);
126
            updateVersionBool = (updateVersion.toLowerCase() === "y" || updateVersion.toLowerCase() === "yes");
127
        } else {
128
            console.log(updateVersionQuestion + (updateVersionBool ? 'yes' : 'no'));
129
        }
130

131
        if(updateVersionBool) {
132
            const versionPattern = /^\d+\.\d+\.\d+$/;
133
            var versionType = await rl.question('Please Enter the Version Number Here (M.m.p): ');
134

135
            while(!versionPattern.test(versionType) && versionType != "patch" && versionType != "minor" && versionType != "major" && versionType != "same") {
136
                versionType = await rl.question('Invalid Input. Please Try Again (M.m.p): ');
137
            }
138
            if(versionType === "same") {
139
                versionType = JSON.parse(await readFile('./package.json', 'utf-8')).version;
140
            }
141

142
            // This uses the "npm version" command to update the project version.
143
            runCommand(`npm version ${versionType} --no-git-tag-version --allow-same-version`);
144
            const packageData = JSON.parse(await readFile('./package.json', 'utf-8'));
145

146
            // Updates the version.json file.
147
            const versionJsonSpinner = createSpinner("Updating version.json...");
148
            const newVersion = packageData.version;
149

150
            await writeFile("./public/version.json", JSON.stringify({ version: newVersion }), 'utf8');
151
            versionJsonSpinner.succeed("Updated version.json!!");
152

153
            // Updates the vite.config.js file.
154
            const viteConfigSpinner = createSpinner("Updating pwa.config.ts...");
155
            const content = await readFile("./pwa.config.ts", 'utf8');
156
            const updatedContent = content.replace(/v\d+\.\d+\.\d+-\$\{Date\.now\(\)\}/, `v${newVersion}-\${Date.now()}`);
157

158
            await writeFile("./pwa.config.ts", updatedContent, 'utf8');
159
            viteConfigSpinner.succeed("Updated PWA Config File!!");
160
            console.log("\n\n");
161
        } else {
162
            // A message to show if the user declined.
163
            console.log("🛑 Will Not Update Version Number.\n\n");
164
        }
165

166
        // This section handles recreating node_modules and package-lock.json with a fresh dependency install.
167
        var confirmInstallBool = (checkForArg("--install-deps") ? true : (checkForArg("--skip-install-deps") ? false : null));
168
        const confirmInstallQuestion = 'Confirm Install Dependencies? (y/n): ';
169

170
        if(confirmInstallBool == null) {
171
            const confirmInstall = await rl.question(confirmInstallQuestion);
172
            confirmInstallBool = (confirmInstall.toLowerCase() === "y" || confirmInstall.toLowerCase() === "yes");
173
        } else {
174
            console.log(confirmInstallQuestion + (confirmInstallBool ? 'yes' : 'no'));
175
        }
176
        
177
        if(confirmInstallBool) {
178
            const TO_BE_REMOVED = [
179
                { path: "./package-lock.json", directory: false },
180
                { path: "./build-info.json", directory: false },
181
                { path: "./.data", directory: true },
182
                { path: "./.nuxt", directory: true },
183
                { path: "./.output", directory: true },
184
                { path: "./dist", directory: true },
185
                { path: "./node_modules", directory: true },
186
            ];
187

188
            for(let i = 0; i < TO_BE_REMOVED.length; i++) {
189
                const itemToBeRemoved = TO_BE_REMOVED[i];
190
                await removeFileOrDirectory(itemToBeRemoved.path, itemToBeRemoved.directory);
191
            }
192

193
            // Installs all dependencies again.
194
            console.log("\n\n");
195
            runCommand("npm install");
196
        } else {
197
            console.log("🛑 Will Not Reinstall dependencies.\n\n");
198
        }
199

200
        // This section handles updating the Git Hooks.
201
        var updateGitHooksBool = (checkForArg("--update-git-hooks") ? true : (checkForArg("--skip-update-git-hooks") ? false : null));
202
        const updateGitHooksQuestion = 'Update Git Hooks (y/n): ';
203

204
        if(updateGitHooksBool == null) {
205
            const updateGitHooks = await rl.question(updateGitHooksQuestion);
206
            updateGitHooksBool = (updateGitHooks.toLowerCase() === "y" || updateGitHooks.toLowerCase() === "yes");
207
        } else {
208
            console.log(updateGitHooksQuestion + (updateGitHooksBool ? 'yes' : 'no'));
209
        }
210

211
        if(updateGitHooksBool) {
212
            runCommand('npm run update-git-hooks');
213
            console.log("✅ Updated Git Hooks!")
214
        } else {
215
            console.log("🛑 Will Not Update Git Hooks.\n\n");
216
        }
217

218
        // This section marks the end of the upgrade script and ends the process.
219
        console.log("🏁 Processes Ended Successfully.");
220
        process.exit(0);
221
    } catch(error) {
222
        console.error(error);
223
        console.error('\n❌ Update failed. Check the errors above.');
224
        process.exit(1);
225
    }
226
}
227

228
// Runs the main function.
229
await main();