diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 0f3aac8dbd5e194994e56e4d99054b7707ae56f5..ea25f4e8e4962f5ba82153b7712c34fce86e2603 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -24,9 +24,10 @@ To effectively work on the project the following tools are required:
* Windows: Open a terminal and execute `cd C:\path\to\project\fc-pregmod`
* GNU/Linux: Open a terminal and execute `cd /path/to/project/fc-pregmod/`
3. Run `npm install` in your terminal
+ * On Windows, you may need to run `npm install --omit-optional` instead.
4. Open the directory in your preferred editor
-* Make sure you have an extension for ESlint installed to catch formatting errors
+* Make sure you have an extension for ESLint installed to catch formatting errors
Recommended extensions for VSCode:
@@ -148,7 +149,7 @@ check.
Contributions should generally not add any new sanity check errors, and it's especially important to check this if
you're making changes to `.tw` files.
-Use `./compile.sh --dry --sanity` or the short hand `./compile.sh -d -s` on Linux or macOS.
+Use `./compile.sh --dry --sanity` or the shorthand `./compile.sh -d -s` on Linux or macOS.
On Windows run `compile_debug+sanityCheck.bat`.
It searches for common spelling errors and syntax errors in the Twine files. Don't worry about preexisting
errors; it's not totally clean as is and there are a few false positives.
@@ -158,7 +159,7 @@ errors; it's not totally clean as is and there are a few false positives.
### Source files
* `src/` is the main directory for source code. It also contains the embedded art files. Since it is inside an `eval()` statement debugging and minification is more complicated than for `js/`.
-* `js/` is loaded before SugarCube and therefore outside SugarCube's eval which `src/` is contained in. This means accessing SugarCube features (like `SugarCube.Engine`) is more complicated however it other than `src/` it can be minified and is easier to debug. Currently contains mainly static data, however new code not relying on SC2 should be sorted in here too.
+* `js/` is loaded before SugarCube and therefore outside SugarCube's eval which `src/` is contained in. This means accessing SugarCube features (like `SugarCube.Engine`) is more complicated however it other than `src/` it can be minified and is easier to debug. Currently, contains mainly static data, however new code not relying on SC2 should be sorted in here too.
* `css/` contains all CSS files. The internal structure is explained [here](css/css.md).
* `themes/` contains [custom themes](themes/themes.md) which are built separately.
@@ -185,17 +186,16 @@ errors; it's not totally clean as is and there are a few false positives.
### Wiki Files
* Event Writing Guides
- * [Twine<sup>1</sup>](devNotes/scene-guide.txt)
+ * [Twine<sup>1</sup>](devNotes/sceneGuide.md)
* [JavaScript](devNotes/jsEventCreationGuide.md)
* [Exception handling](devNotes/exceptions.md)
* [Sanity check](devNotes/sanityCheck.md)
* [Slave List](devNotes/slaveListing.md)
* [Pronouns](devNotes/Pronouns.md)
* External function documentation
- * [Eyes](devNotes/eyefunctions.md)
- * [Limbs](devNotes/limbfunctions.md)
- * [Standalone functions](devNotes/standaloneFunctions.md)
- * [Some potentially useful JS functions](devNotes/usefulJSFunctionDocumentation.txt)
+ * [Eyes](devNotes/eyeFunctions.md)
+ * [Limbs](devNotes/limbFunctions.md)
+ * [Some potentially useful JS functions](devNotes/usefulJSFunctionDocumentation.md)
* [Content embedding chart](devNotes/contentEmbeddingChart.png) (for more details refer to [this issue](https://gitgud.io/pregmodfan/fc-pregmod/-/merge_requests/7453#note_118616))
<sup>1. Twine is being phased out of the project and should not be used in new code, but the basic concepts found here still apply.</sup>
diff --git a/devNotes/scene guide.md b/devNotes/sceneGuide.md
similarity index 100%
rename from devNotes/scene guide.md
rename to devNotes/sceneGuide.md
diff --git a/js/003-data/futureSocietyData.js b/js/003-data/futureSocietyData.js
index 4543bd9a7342fb39b45c19da0d6bc074f01fc531..68d4ab30e720bf409d84a7ba4d2be07fbc683363 100644
--- a/js/003-data/futureSocietyData.js
+++ b/js/003-data/futureSocietyData.js
@@ -17,12 +17,22 @@ App.Data.FutureSociety = {
FSSlimnessEnthusiast: {noun: "Slimness Enthusiasm", adj: "Slimness Enthusiast", deco: "Slimness Enthusiast"},
FSAssetExpansionist: {noun: "Asset Expansionism", adj: "Asset Expansionist", deco: "Asset Expansionist"},
FSPastoralist: {noun: "Pastoralism", adj: "Pastoralist", deco: "Pastoralist"},
- FSCummunism: {noun: "Cummunism", adj: "Cummunist", deco: undefined, NPCOnly: true},
+ FSCummunism: {
+ noun: "Cummunism",
+ adj: "Cummunist",
+ deco: undefined,
+ NPCOnly: true
+ },
FSPhysicalIdealist: {noun: "Physical Idealism", adj: "Physical Idealist", deco: "Physical Idealist"},
FSHedonisticDecadence: {noun: "Decadent Hedonism", adj: "Decadent Hedonist", deco: "Hedonistic"},
FSChattelReligionist: {noun: "Chattel Religionism", adj: "Chattel Religionist", deco: "Chattel Religionist"},
FSNull: {noun: "Multiculturalism", adj: "Multiculturalist", deco: undefined},
- FSIncestFetishist: {noun: "Incest Fetishism", adj: "Incest Fetishist", deco: undefined, NPCOnly: true},
+ FSIncestFetishist: {
+ noun: "Incest Fetishism",
+ adj: "Incest Fetishist",
+ deco: undefined,
+ NPCOnly: true
+ },
FSRomanRevivalist: {
noun: "Roman Revivalism",
adj: "Roman Revivalist",
diff --git a/js/003-data/slaveBody.js b/js/003-data/slaveBody.js
index 7739c26772281023fe09101af8746e3810d0baf0..553f2d295637a1306edf0eb8a245fee7ea3f76ef 100644
--- a/js/003-data/slaveBody.js
+++ b/js/003-data/slaveBody.js
@@ -1,5 +1,5 @@
/**
- * @typedef {Object} bodyPart
+ * @typedef {object} bodyPart
* @property {"head"|"torso"|"arms"|"legs"} category
* @property {function(App.Entity.SlaveState):boolean} [requirements]
* @property {boolean} [isPair]
diff --git a/js/003-data/slaveMods.js b/js/003-data/slaveMods.js
index 77f22fa08da7627b630f097433445a540c5573ac..8e1a5f7cb698fe53da13ac0f9f7e87e6f72ce0d6 100644
--- a/js/003-data/slaveMods.js
+++ b/js/003-data/slaveMods.js
@@ -266,7 +266,7 @@ App.Medicine.Modification.Color = {
],
};
/**
- * @typedef {Object} hairStyle
+ * @typedef {object} hairStyle
* @property {string} title
* @property {FC.HairStyle} value
* @property {number} [hLength]
diff --git a/package.json b/package.json
index 3afb616b61aeaa75f505af57a475c98ad05c3a2b..db57146c9d86039392d991606347e7143e86ca9f 100644
--- a/package.json
+++ b/package.json
@@ -8,7 +8,7 @@
"url": "https://gitgud.io/pregmodfan/fc-pregmod.git"
},
"scripts": {
- "lint": "eslint src/**/*.js",
+ "lint": "eslint src/**/*.js js/**/*.js",
"compile": "sh compile.sh"
},
"license": "GPL-3.0-only",
@@ -19,13 +19,12 @@
"@types/mousetrap": "^1.6.3",
"@types/twine-sugarcube": "^2.36.1",
"eslint": "^8.0.0",
- "eslint-plugin-jsdoc": "^37.0.0",
- "eslint-plugin-sonarjs": "^0.11.0",
+ "eslint-plugin-jsdoc": "^46.0.0",
+ "eslint-plugin-sonarjs": "^0.23.0",
"ts-essentials": "^9.1.1",
"typescript": "^4.4.0"
},
"dependencies": {
- "@tdewolff/minify": "^2.12.5",
"autoprefixer": "^10.0.0",
"chalk": "^5.2.0",
"fancy-log-levels": "^1.0.0",
@@ -41,5 +40,8 @@
"through2": "^4.0.2",
"which": "^3.0.0",
"yargs": "^17.7.1"
+ },
+ "optionalDependencies": {
+ "@tdewolff/minify": "^2.20.9"
}
}
diff --git a/src/endWeek/saServeThePublic.js b/src/endWeek/saServeThePublic.js
index 3737524d8de6c5fb1208dfb83382d889d6d57d20..b55f03bee4f2100745a72e61d2d46bd20424700c 100644
--- a/src/endWeek/saServeThePublic.js
+++ b/src/endWeek/saServeThePublic.js
@@ -51,7 +51,7 @@ App.SlaveAssignment.serveThePublic = function saServeThePublic(slave) {
/**
* @param {App.Entity.SlaveState} slave
- * @returns {Object}
+ * @returns {object}
*/
function gatherStatistics(slave) {
const facility = (slave.assignment === Job.CLUB || slave.assignment === Job.DJ) ? V.facility.club : undefined;
diff --git a/src/endWeek/saStayConfined.js b/src/endWeek/saStayConfined.js
index 02233b05d7d07b5193ccbe05811942994ed8fcfa..877bca104539f3678086aad675664be0cd1185b1 100644
--- a/src/endWeek/saStayConfined.js
+++ b/src/endWeek/saStayConfined.js
@@ -1,5 +1,5 @@
/**
- * @typedef {Object} confinedResults
+ * @typedef {object} confinedResults
* @property {string} text
* @property {boolean} broken
*/
diff --git a/src/endWeek/saWorkAGloryHole.js b/src/endWeek/saWorkAGloryHole.js
index 508d214c46bfdde9a8f98fa4b62ddbb54f0bb9ee..0aa6e1e0023be326cbdd512b1b6ce64d1437accb 100644
--- a/src/endWeek/saWorkAGloryHole.js
+++ b/src/endWeek/saWorkAGloryHole.js
@@ -24,7 +24,7 @@ App.SlaveAssignment.workAGloryHole = function saWorkAGloryHole(slave) {
/**
* @param {App.Entity.SlaveState} slave
- * @returns {Object}
+ * @returns {object}
*/
function gatherStatistics(slave) {
/* Statistics gathering */
diff --git a/src/events/eventUtils.js b/src/events/eventUtils.js
index 6c902c9e2bc6dc8c65a05d8766f2f4526bf401af..c829719e33e4f33bc3dbdc207a5bac69e56d2261 100644
--- a/src/events/eventUtils.js
+++ b/src/events/eventUtils.js
@@ -466,7 +466,7 @@ App.Events.auctionREFSArtifact = function(basePrice) {
/** Queue an event for scheduled execution on a later week. Queued events are executed automatically at the end of Nonrandom Event on the chosen week.
* @param {number} weeks - the number of weeks to wait before executing the event. 0 means execute this week, 1 execute next week, etc. Note that events generally cannot safely queue other events for the same week; they should always pass 1 or more in this parameter. Other parts of the game (Slave Interact, etc) can safely queue events for this week (i.e. the upcoming End Week cycle) by passing 0.
* @param {App.Events.BaseEvent} event - the event to execute. note that this event is serialized normally, so changes to the class name or parameter structure will break the event in saved games!
- * @param {Object} [params] - any parameters to serialize with the event. when the event executes, these will be accessible in "this.params".
+ * @param {object} [params] - any parameters to serialize with the event. when the event executes, these will be accessible in "this.params".
*/
App.Events.queueEvent = function(weeks, event, params = {}) {
Object.assign(event.params, params);
@@ -503,7 +503,7 @@ App.Events.runPassageEvent = function(event, node) {
event.execute(node);
} catch (ex) {
// add the event name to any exceptions thrown from events, without altering the stack or other error data
- const addEventName = (/** @type {Object} */e) => { e.event = eventName; };
+ const addEventName = (/** @type {object} */e) => { e.event = eventName; };
if (ex instanceof Error) {
addEventName(ex);
throw ex;
diff --git a/src/interaction/sellSlave.js b/src/interaction/sellSlave.js
index 8a4e8e9afc5d07332c1162a61d3046aa21eb3718..3b4609a1587d1cbf7a64805bee3d5798f01c2c48 100644
--- a/src/interaction/sellSlave.js
+++ b/src/interaction/sellSlave.js
@@ -836,7 +836,7 @@ App.Interact.sellSlave = function(slave) {
}
/**
- * @typedef {Object} slaveBuyerData
+ * @typedef {object} slaveBuyerData
* @property {number} cost
* @property {string} offerDesc
* @property {boolean} requirements
diff --git a/src/interaction/siRules.js b/src/interaction/siRules.js
index cc69840747c5a2b3ee0f73ed889fc0ce33ad3ce8..64657cc1588caf51a76aee2eb071d74d0f8b0351 100644
--- a/src/interaction/siRules.js
+++ b/src/interaction/siRules.js
@@ -265,7 +265,7 @@ App.UI.SlaveInteract.rules = function(slave, refresh) {
return frag;
/**
- * @typedef {Object} listChoice
+ * @typedef {object} listChoice
* @property {string} value
* @property {string} [title]
* @property {string|HTMLElement|DocumentFragment} [tooltip]
diff --git a/src/interaction/siWork.js b/src/interaction/siWork.js
index f6fc1fccdc6b6b682c92bea9441cf04d61931950..c1fc5105a99724557d8653cbd326586a3893b04d 100644
--- a/src/interaction/siWork.js
+++ b/src/interaction/siWork.js
@@ -298,12 +298,12 @@ App.UI.SlaveInteract.work = function(slave, refresh) {
let el = document.createElement('div');
/**
- * @typedef {Object} sexOption
+ * @typedef {object} sexOption
* @property {string} text "Link text"
* @property {string|App.Interact.BaseChoosePartnerRenderer|function():Node} [scene]
* @property {string} [goto] if another passage is needed
- * @property {Object} [updateSlave] update slave itself if needed, like {trust: 2},
- * @property {Object} [update] updates V.,
+ * @property {object} [updateSlave] update slave itself if needed, like {trust: 2},
+ * @property {object} [update] updates V.,
* @property {string} [note] if a note must appear after the link
* @property {string} [disabled]
*/
diff --git a/src/interaction/slaveInteract.js b/src/interaction/slaveInteract.js
index 1581d93861730eb8b86e318e2fa02902c26b9c0e..40efd6cd47b192345a5102083eab6c9dd60be3ef 100644
--- a/src/interaction/slaveInteract.js
+++ b/src/interaction/slaveInteract.js
@@ -68,7 +68,7 @@ App.UI.SlaveInteract.mainPage = function(slave) {
el.append(App.UI.SlaveInteract.navigation(slave));
/**
- * @typedef {Object} siCategory
+ * @typedef {object} siCategory
* @property {string} title
* @property {string} id
* @property {DocumentFragment|HTMLElement} node
diff --git a/src/js/makePurchase.js b/src/js/makePurchase.js
index 1a13728e694075b1e0df2586c357de2f627ebf73..00b63e13fcd20360b66860f04ea9c4f732e00858 100644
--- a/src/js/makePurchase.js
+++ b/src/js/makePurchase.js
@@ -3,7 +3,7 @@
* @param {string} text The text to display.
* @param {number} cost The amount of ¤ the purchase costs.
* @param {keyof App.Data.Records.LastWeeksCash} what What the purchase is for.
- * @param {Object} [args] Any additional arguments to pass.
+ * @param {object} [args] Any additional arguments to pass.
* @param {string[]} [args.notes] Any additional information to display. Must be lowercase and end in no punctuation.
* @param {function():void} args.handler Any custom handler to run upon purchase.
* @param {[boolean, string][]} [args.prereqs] Any prerequisites that must be met for the purchase to be available, with a note for when the prerequisites are not met.
diff --git a/src/js/reminder.js b/src/js/reminder.js
index adbe7cee2c5ffb96fc17cc5dad5bc1bd4b839a0f..667ff39ddb02a511f80dbb67076bf84b63fa60ed 100644
--- a/src/js/reminder.js
+++ b/src/js/reminder.js
@@ -41,7 +41,7 @@ App.Reminders = (function() {
}
/**
- * @param {Object} [obj]
+ * @param {object} [obj]
* @param {number} [obj.maxFuture] how far into the future should reminders be displayed.
* @param {function(FC.ReminderEntry):boolean} [obj.filter]
* @param {boolean} [obj.link] permit passage links
diff --git a/src/js/slaveCostJS.js b/src/js/slaveCostJS.js
index 278ab8cd01c85b28d24ec6ed7ee37f3ba804a7e6..4809016319f95f2f72971064c917bdaab0ea2625 100644
--- a/src/js/slaveCostJS.js
+++ b/src/js/slaveCostJS.js
@@ -2315,7 +2315,7 @@ globalThis.FResultTooltip = function(slave, forSale = 0) {
* @param {boolean} [isSpecial] is this slave a special/hero slave
* @param {boolean} [returnDOM]
* @param {Array<{factor: number, reason: string}>} [modifiers]
- * @returns {number|Object}
+ * @returns {number | object}
*/
globalThis.slaveCost = function(slave, isStartingSlave = false, followLaws = false, isSpecial = false, returnDOM = false, modifiers = []) {
const milked = App.SlaveAssignment.getMilked(slave, 1.0, true);
@@ -2437,7 +2437,7 @@ globalThis.slaveCost = function(slave, isStartingSlave = false, followLaws = fal
* @param {boolean} followLaws Apply cost variations from enacted Slave Market Regulations
* @param {boolean} isSpecial is this slave a special/hero slave
* @param {Array<{factor: number, reason: string}>} modifiers market discounts, etc
- * @returns {Object}
+ * @returns {object}
*/
globalThis.slaveCostBeauty = function(slave, isStartingSlave, followLaws, isSpecial, modifiers) {
const arcology = V.arcologies[0];
diff --git a/src/js/slaveSummaryHelpers.js b/src/js/slaveSummaryHelpers.js
index c535ee8a95f20e4a288f197a1d6d873192d637f3..5dfcc3fe444a2cb23cd25b28bb9006a96100c90f 100644
--- a/src/js/slaveSummaryHelpers.js
+++ b/src/js/slaveSummaryHelpers.js
@@ -170,7 +170,7 @@ App.UI.SlaveSummaryImpl = function() {
}
/**
- * @typedef {Object} FSDatum
+ * @typedef {object} FSDatum
* @property {number} active FS policy is active (0,1)
* @property {number} strength FS decoration level divided by 10
*/
diff --git a/src/js/upgrade.js b/src/js/upgrade.js
index 49ee68f797e1502d27ad914608b2bcf698909c28..c5ae3e582770b81d4a1e81fee38620aaceff44d6 100644
--- a/src/js/upgrade.js
+++ b/src/js/upgrade.js
@@ -3,7 +3,7 @@ App.Upgrade = class Upgrade {
/**
* @param {string} property The variable name of the property.
* @param {FC.IUpgradeTier[]} tiers A list of tiers available for the upgrade.
- * @param {Object} [object] Any object to attach the upgrade to, if not the default `V`.
+ * @param {object} [object] Any object to attach the upgrade to, if not the default `V`.
*/
constructor(property, tiers, object = V) {
/** @private */
@@ -112,7 +112,7 @@ App.Upgrade = class Upgrade {
/**
* The object the upgrade is attached to.
*
- * @returns {Object}
+ * @returns {object}
*/
get object() {
return this._object;
diff --git a/src/js/utilsArcology.js b/src/js/utilsArcology.js
index 50502a724d38776974081ac8c8add87ee02445d0..3ad6588c3a1e38cce6f70b9c5dcf9e3e02b7cae3 100644
--- a/src/js/utilsArcology.js
+++ b/src/js/utilsArcology.js
@@ -35,7 +35,7 @@ App.Utils.schoolCounter = function() {
};
/**
- * @typedef {Object} menialObject
+ * @typedef {object} menialObject
* @property {string} text
* @property {number} value
*/
diff --git a/src/js/utilsSlave.js b/src/js/utilsSlave.js
index 71b4e46dd8573225bb6e2be234de3115651fa58e..d66f556404ec158c62f7ea0aaea731ae4f35b461 100644
--- a/src/js/utilsSlave.js
+++ b/src/js/utilsSlave.js
@@ -2997,7 +2997,7 @@ globalThis.induceLactation = function(slave, induce = 0) {
/**
* @param {string} targetSkill - Skill to be checked.
- * @param {Object} slave - Slave to be checked.
+ * @param {object} slave - Slave to be checked.
* @param {number} [skillIncrease=1]
* @returns {string}
*/
@@ -3417,8 +3417,8 @@ globalThis.applyMindbroken = function(slave, oldIntelligence = -200) {
/**
* Compares two slaves and returns differences
- * @param {Object} edited
- * @param {Object} original
+ * @param {object} edited
+ * @param {object} original
* @param {function(string): void} dispatch
* @param {string} crumb
*/