-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.js
118 lines (106 loc) · 2.82 KB
/
index.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
/*
* Fetch Bezel Data Script
* -----------------------
* This script extracts bezel data from simulators and merges it into a device database.
*
* Author: Mark Battistella
* Version: 2.0.0
* Licence: MIT
* Contact: @markbattistella
* Website: https://markbattistella.com
* Copyright (c) 2023 Mark Battistella
*
* Description:
* This script automates the process of extracting bezel data from iOS simulators
* and merging it into a device database. It requires Node.js and Xcode to be installed.
*/
/**
* Importing internal modules required for the operation.
*/
import * as logger from './modules/logger.mjs';
import * as util from './modules/utilities.mjs';
import * as defaults from './modules/defaults.mjs';
/**
* Get the default variables or those provided via command line arguments.
* @constant
* @type {Object}
*/
const VARIABLE = defaults.getVariables(process.argv);
/**
* Set up the logging mechanism based on whether 'debug' mode is active or not.
*/
logger.setup(VARIABLE.debug);
/**
* Initializes the process of data extraction.
*
* The flow involves:
* 1. Displaying onscreen help.
* 2. Reading and processing device data from a JSON database.
* 3. Identifying simulators based on the data.
* 4. Generating related data for these simulators.
* 5. Saving the updated information to a database.
*
* @async
* @function
*/
const init = async () => {
try {
/* Display the onscreen help menu. */
defaults.displayHelp();
/**
* Extract device data from the provided JSON database.
* @constant
* @type {Object}
*/
const {
pendingDevices,
originalDatabase
} = await util.extractDeviceDataFromFile(VARIABLE.databaseJson);
/**
* Derive simulator-specific information based on the extracted devices.
* @constant
* @type {Object}
*/
const {
foundDevices,
unfoundDevices
} = util.getSimulatorObjectData(pendingDevices);
/**
* Get simulator details, especially the bezel radius data.
* @constant
* @type {Array}
*/
const bezelSimulators = await util.generateData(
foundDevices,
VARIABLE.xCodeData.project,
VARIABLE.xCodeData.scheme,
VARIABLE.xCodeData.bundleId,
VARIABLE.appOutput
);
/**
* Save the newly derived information to a database,
* while also making necessary updates and removals.
*/
await util.saveNewDatabase(
originalDatabase,
bezelSimulators,
unfoundDevices,
VARIABLE.databaseJson,
VARIABLE.jsonOutput
);
/**
* Delete the output directory with the compiled app
*/
await util.deleteDirectory(
VARIABLE.appOutput
);
} catch (error) {
/** Log the error and halt the process if any unexpected issues arise. */
logger.error('An error occurred during the init process', error);
process.exit(1);
}
};
/**
* Start the data extraction process by initializing the script.
*/
await init();