Complete overhaul of code structure and relevant files (#639)

src/Disp/BeautifyAndFormatting/BeautifyFormatting.js

@@ -0,0 +1,122 @@
+/** General functions to format or beautify strings */
+
+import { CMOptions } from '../../Config/VariablesAndData';
+import { metric, shortScale, shortScaleAbbreviated } from '../../Data/Scales';
+import { BackupFunctions } from '../../Main/VariablesAndData';
+import {
+	ColorGreen, ColorOrange, ColorRed, ColorYellow,
+} from '../VariablesAndData';
+
+/**
+ * This function returns formats number based on the Scale setting
+ * @param	{number}	num		Number to be beautified
+ * @param 	{any}		floats 	Used in some scenario's by CM.Backup.Beautify (Game's original function)
+ * @param	{number}	forced	Used to force (type 3) in certains cases
+ * @returns	{string}			Formatted number
+ */
+export function Beautify(num, floats, forced) {
+	const decimals = CMOptions.ScaleDecimals + 1;
+	if (num === Infinity) {
+		return 'Infinity';
+	} if (typeof num === 'undefined') {
+		return '0';
+	} if (CMOptions.Scale === 0) {
+		return BackupFunctions.Beautify(num, floats);
+	} if (Number.isFinite(num)) {
+		let answer = '';
+		if (num === 0) {
+			return num.toString();
+		} if (num > 0.001 && num < CMOptions.ScaleCutoff) {
+			answer = num.toFixed(2);
+			if (CMOptions.ScaleSeparator) answer = answer.toLocaleString('nl');
+			for (let i = 0; i < 3; i++) {
+				if (answer[answer.length - 1] === '0' || answer[answer.length - 1] === '.') answer = answer.slice(0, -1);
+			}
+			return answer;
+		} if (CMOptions.Scale === 4 && !forced || forced === 4) { // Scientific notation, 123456789 => 1.235E+8
+			answer = num.toExponential(decimals).toString().replace('e', 'E');
+		} else {
+			const exponential = num.toExponential().toString();
+			const AmountOfTenPowerThree = Math.floor(exponential.slice(exponential.indexOf('e') + 1) / 3);
+			answer = (num / Number(`1e${AmountOfTenPowerThree * 3}`)).toFixed(decimals);
+			// answer is now "xxx.xx" (e.g., 123456789 would be 123.46)
+			if (CMOptions.Scale === 1 && !forced || forced === 1) { // Metric scale, 123456789 => 123.457 M
+				if (num >= 0.01 && num < Number(`1e${metric.length * 3}`)) {
+					answer += ` ${metric[AmountOfTenPowerThree]}`;
+				} else answer = Beautify(num, 0, 4); // If number is too large or little, revert to scientific notation
+			} else if (CMOptions.Scale === 2 && !forced || forced === 2) { // Short scale, 123456789 => 123.457 M
+				if (num >= 0.01 && num < Number(`1e${shortScale.length * 3}`)) {
+					answer += ` ${shortScale[AmountOfTenPowerThree]}`;
+				} else answer = Beautify(num, 0, 4); // If number is too large or little, revert to scientific notation
+			} else if (CMOptions.Scale === 3 && !forced || forced === 3) { // Short scale, 123456789 => 123.457 M
+				if (num >= 0.01 && num < Number(`1e${shortScaleAbbreviated.length * 3}`)) {
+					answer += ` ${shortScaleAbbreviated[AmountOfTenPowerThree]}`;
+				} else answer = Beautify(num, 0, 4); // If number is too large or little, revert to scientific notation
+			} else if (CMOptions.Scale === 5 && !forced || forced === 5) { // Engineering notation, 123456789 => 123.457E+6
+				answer += `E${AmountOfTenPowerThree * 3}`;
+			}
+		}
+		if (answer === '') {
+			console.log(`Could not beautify number with CM.Disp.Beautify: ${num}`);
+			answer = BackupFunctions.Beautify(num, floats);
+		}
+		if (CMOptions.ScaleSeparator) answer = answer.replace('.', ',');
+		return answer;
+	}
+	console.log(`Could not beautify number with CM.Disp.Beautify: ${num}`);
+	return BackupFunctions.Beautify(num, floats);
+}
+
+/**
+ * This function returns time as a string depending on TimeFormat setting
+ * @param  	{number} 	time		Time to be formatted
+ * @param  	{number}	longFormat 	1 or 0
+ * @returns	{string}				Formatted time
+ */
+export function FormatTime(time, longFormat) {
+	if (time === Infinity) return time;
+	time = Math.ceil(time);
+	const y = Math.floor(time / 31557600);
+	const d = Math.floor(time % 31557600 / 86400);
+	const h = Math.floor(time % 86400 / 3600);
+	const m = Math.floor(time % 3600 / 60);
+	const s = Math.floor(time % 60);
+	let str = '';
+	if (CMOptions.TimeFormat) {
+		if (time > 3155760000) return 'XX:XX:XX:XX:XX';
+		str += `${(y < 10 ? '0' : '') + y}:`;
+		str += `${(d < 10 ? '0' : '') + d}:`;
+		str += `${(h < 10 ? '0' : '') + h}:`;
+		str += `${(m < 10 ? '0' : '') + m}:`;
+		str += (s < 10 ? '0' : '') + s;
+	} else {
+		if (time > 777600000) return longFormat ? 'Over 9000 days!' : '>9000d';
+		str += (y > 0 ? `${y + (longFormat ? (y === 1 ? ' year' : ' years') : 'y')}, ` : '');
+		str += (d > 0 ? `${d + (longFormat ? (d === 1 ? ' day' : ' days') : 'd')}, ` : '');
+		if (str.length > 0 || h > 0) str += `${h + (longFormat ? (h === 1 ? ' hour' : ' hours') : 'h')}, `;
+		if (str.length > 0 || m > 0) str += `${m + (longFormat ? (m === 1 ? ' minute' : ' minutes') : 'm')}, `;
+		str += s + (longFormat ? (s === 1 ? ' second' : ' seconds') : 's');
+	}
+	return str;
+}
+
+/**
+ * This function returns the color to be used for time-strings
+ * @param	{number}			time			Time to be coloured
+ * @returns {{string, string}}	{text, color}	Both the formatted time and color as strings in an array
+ */
+export function GetTimeColor(time) {
+	let color;
+	let text;
+	if (time <= 0) {
+		if (CMOptions.TimeFormat) text = '00:00:00:00:00';
+		else text = 'Done!';
+		color = ColorGreen;
+	} else {
+		text = FormatTime(time);
+		if (time > 300) color = ColorRed;
+		else if (time > 60) color = ColorOrange;
+		else color = ColorYellow;
+	}
+	return { text, color };
+}