prettier fmt - Githubissues

cwastche commented 2 weeks ago

PR Type

formatting

Description

Adjusted indentation for nested ternary operators across multiple TypeScript files for better readability.
Removed trailing whitespace in several TypeScript and CSS files.
Standardized string quotes from single to double in TypeScript and Markdown files.
Changed doctype declarations to lowercase in HTML files.
Added missing newlines at the end of Markdown files.
Removed extra newlines in Markdown files.

Changes walkthrough 📝

Relevant files

Formatting

21 files

resources.ts `Format nested ternary operators for readability.` sdk/packages/eternum/src/constants/resources.ts - Adjusted indentation for nested ternary operators.	+9/-9
BattleView.tsx `Format nested ternary operators for readability.` client/src/ui/modules/military/battle-view/BattleView.tsx - Adjusted indentation for nested ternary operators.	+4/-4
useRoads.tsx `Format reduce function for readability.` client/src/hooks/helpers/useRoads.tsx - Adjusted indentation for reduce function.	+9/-6
ExistingBuildings.tsx `Format nested ternary operators for readability.` client/src/ui/components/construction/ExistingBuildings.tsx - Adjusted indentation for nested ternary operators.	+6/-6
ListSelect.tsx `Format nested ternary operators for readability.` client/src/ui/elements/ListSelect.tsx - Adjusted indentation for nested ternary operators.	+2/-2
DirectOffersExplorerPopup.tsx `Format nested ternary operators for readability.` client/src/ui/components/cityview/realm/trade/DirectOffers/DirectOffersExplorerPopup.tsx - Adjusted indentation for nested ternary operators.	+4/-4
global.ts `Remove trailing whitespace.` sdk/packages/eternum/src/constants/global.ts - Removed trailing whitespace.	+1/-1
ArmyMenu.tsx `Remove trailing whitespace.` client/src/ui/components/worldmap/armies/ArmyMenu.tsx - Removed trailing whitespace.	+1/-1
vocs.config.ts `Standardize string quotes.` eternum-docs/vocs.config.ts - Changed single quotes to double quotes.	+7/-7
useEntities.tsx `Format nested ternary operators for readability.` client/src/hooks/helpers/useEntities.tsx - Adjusted indentation for nested ternary operators.	+2/-2
BattleActions.tsx `Remove trailing whitespace.` client/src/ui/modules/military/battle-view/BattleActions.tsx - Removed trailing whitespace.	+1/-1
index.html `Standardize doctype declaration.` client/hex/index.html - Changed doctype declaration to lowercase.	+1/-1
index.html `Standardize doctype declaration.` client/map/index.html - Changed doctype declaration to lowercase.	+1/-1
index.html `Standardize doctype declaration.` client/index.html - Changed doctype declaration to lowercase.	+1/-1
index.css `Format CSS for consistency.` client/src/index.css - Adjusted indentation and removed trailing whitespace.	+33/-20
contracts.mdx `Remove extra newline.` eternum-docs/docs/pages/development/contracts.mdx - Removed extra newline.	+2/-4
index.mdx `Standardize string quotes and add newline.` eternum-docs/docs/pages/index.mdx Changed single quotes to double quotes. Added missing newline at end of file.	+5/-3
client.mdx `Add missing newline.` eternum-docs/docs/pages/development/client.mdx - Added missing newline at end of file.	+6/-1
introduction.mdx `Remove extra newlines.` eternum-docs/docs/pages/game/introduction.mdx - Removed extra newlines.	+2/-6
example.mdx `Add missing newline.` eternum-docs/docs/pages/example.mdx - Added missing newline at end of file.	+1/-1
getting-started.mdx `Add missing newline.` eternum-docs/docs/pages/getting-started.mdx - Added missing newline at end of file.	+1/-1

💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

vercel[bot] commented 2 weeks ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
eternum	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 20, 2024 2:44pm

github-actions[bot] commented 2 weeks ago

PR Reviewer Guide 🔍

⏱️ Estimated effort to review [1-5]	2
🧪 Relevant tests	No
🔒 Security concerns	No
⚡ Key issues to review	None

github-actions[bot] commented 2 weeks ago

PR Code Suggestions ✨

Category	Suggestion	Score
Enhancement	Provide examples for better clarity on best practices mentioned ___ The documentation mentions using `super::IBuildingContract` to minimize imports, which is a good practice. However, it would be beneficial to provide a brief example or snippet showing this usage directly in the context for clearer understanding. [eternum-docs/docs/pages/development/contracts.mdx [36]](https://github.com/BibliothecaDAO/eternum/pull/968/files#diff-303816324aed144bd3565f9b334d183140a2ee95bb61fc7f106fbffd09379efdR36-R36) ```diff -- use of `super::IBuildingContract` to minimise imports and make it clear where the interface is defined. +- use of `super::IBuildingContract` to minimise imports. For example, `use super::IBuildingContract;` at the beginning of your module. ``` Suggestion importance[1-10]: 9 Why: Adding examples to documentation significantly enhances understanding and practical application of the best practices mentioned, making this a valuable improvement.	9
	Expand on broad statements to provide clarity and context ___ The addition of the line "Everything is fungible until it's not." could be expanded to provide more context or explanation. This statement is quite broad and might confuse readers without additional information. [eternum-docs/docs/pages/game/introduction.mdx [15]](https://github.com/BibliothecaDAO/eternum/pull/968/files#diff-e24a7c2b045bcbf98876bc5ba114a1b483034b0b63af186c553672ef1472320fR15-R15) ```diff -Everything is fungible until it's not. +Everything in the game is considered fungible until specific conditions or rules apply. ``` Suggestion importance[1-10]: 8 Why: Providing more context to broad statements enhances the clarity and understanding for readers, making the documentation more informative and user-friendly.	8
	Add a description to the "Layouts" section for consistency and clarity ___ Consider adding a brief description for the "Layouts" section to maintain consistency with other sections, which all include descriptive text. [eternum-docs/docs/pages/development/client.mdx [21]](https://github.com/BibliothecaDAO/eternum/pull/968/files#diff-a0a27d15f8da90d9daacecf2d3de7c2246c139edad29c0327c7bcd2e63fd5956R21-R21) ```diff -- Collection of containers composed into a full layout +- Collection of containers composed into a full layout. This section should outline the overall page structure and flow. ``` Suggestion importance[1-10]: 7 Why: The suggestion improves consistency and clarity by adding a description to the "Layouts" section, aligning it with other sections that include descriptive text. However, it is a minor enhancement and not crucial.	7
Best practice	Use nullish coalescing to handle falsy values more accurately ___ Consider using nullish coalescing (`??`) instead of logical OR (`\|\|`) to handle cases where `structure.category` might be an empty string or other falsy values that are valid. This ensures that only `null` or `undefined` values are replaced by the empty string, preserving other falsy values like `0` or `false` which might be valid in some contexts. [client/src/hooks/helpers/useEntities.tsx [124-128]](https://github.com/BibliothecaDAO/eternum/pull/968/files#diff-655bd94eaba19bfcec06d7b736d2e64944c31d55f2b38819201a2b0b612787e4R124-R128) ```diff const name = realm ? getRealmNameById(realm.realm_id) : structureName - ? `${structure?.category} ${structureName}` - : structure?.category; + ? `${structure?.category ?? ''} ${structureName}` + : structure?.category ?? ''; ``` Suggestion importance[1-10]: 8 Why: This suggestion improves the handling of falsy values by using nullish coalescing, which is a best practice for ensuring that only null or undefined values are replaced. This can prevent potential bugs where valid falsy values like 0 or false might be incorrectly handled.	8
	Use a switch statement to replace nested ternary operators for clarity ___ Replace the nested ternary operators with a switch statement for better readability and maintainability when determining the `modelIndex` based on `hexType`. [client/src/ui/components/construction/ExistingBuildings.tsx [134-142]](https://github.com/BibliothecaDAO/eternum/pull/968/files#diff-b8b13d61f7fc906dae1ff3473650c5893b1d3971d1b65e062a1fb4c6ed5e749bR134-R142) ```diff -hexType === HexType.BANK - ? ModelsIndexes.Bank - : hexType === HexType.SHARDSMINE - ? ModelsIndexes.ShardsMine - : hexType === HexType.HYPERSTRUCTURE - ? ModelsIndexes.Hyperstructure - : hexType === HexType.UNFINISHEDHYPERSTRUCTURE - ? ModelsIndexes.UnfinishedHyperstructure - : ModelsIndexes.Castle; +let modelIndex; +switch (hexType) { + case HexType.BANK: + modelIndex = ModelsIndexes.Bank; + break; + case HexType.SHARDSMINE: + modelIndex = ModelsIndexes.ShardsMine; + break; + case HexType.HYPERSTRUCTURE: + modelIndex = ModelsIndexes.Hyperstructure; + break; + case HexType.UNFINISHEDHYPERSTRUCTURE: + modelIndex = ModelsIndexes.UnfinishedHyperstructure; + break; + default: + modelIndex = ModelsIndexes.Castle; +} ``` Suggestion importance[1-10]: 8 Why: Replacing nested ternary operators with a switch statement enhances readability and maintainability. This is a best practice for handling multiple conditions and makes the code more understandable.	8
	Standardize the file naming convention to improve consistency ___ Consider using consistent naming conventions for files in the documentation. The naming of 'system_name.cairo' should follow the same pattern as 'tests.cairo', which uses all lowercase. This will help maintain consistency and readability in the documentation structure. [eternum-docs/docs/pages/development/contracts.mdx [28]](https://github.com/BibliothecaDAO/eternum/pull/968/files#diff-303816324aed144bd3565f9b334d183140a2ee95bb61fc7f106fbffd09379efdR28-R28) ```diff -- system_name.cairo +- systemname.cairo ``` Suggestion importance[1-10]: 7 Why: The suggestion to standardize file naming conventions is valid and improves consistency and readability. However, it is a minor enhancement and not crucial for functionality.	7
Maintainability	Extract reducer function to improve code readability and maintainability ___ To improve readability and maintainability, consider extracting the reducer function used in the `reduce` method into a separate named function. This helps in isolating logic, making the code easier to test and understand. [client/src/hooks/helpers/useRoads.tsx [130-137]](https://github.com/BibliothecaDAO/eternum/pull/968/files#diff-f2f204c5b7d8065573c295320644cc3ddd7413354c9aef7db93258e226a5f094R130-R137) ```diff -roads.reduce( - (acc, road) => { - if (!acc[road.destinationRealmName] \|\| acc[road.destinationRealmName].usageLeft < road.usageLeft) { - acc[road.destinationRealmName] = road; - } - return acc; - }, - {} as { [key: string]: RoadInterface }, -) +function selectRoadWithHighestUsage(acc, road) { + if (!acc[road.destinationRealmName] \|\| acc[road.destinationRealmName].usageLeft < road.usageLeft) { + acc[road.destinationRealmName] = road; + } + return acc; +} +const uniqueRoads = roads.reduce(selectRoadWithHighestUsage, {} as { [key: string]: RoadInterface }); ``` Suggestion importance[1-10]: 7 Why: Extracting the reducer function into a separate named function enhances readability and maintainability by isolating the logic, making the code easier to test and understand. However, it does not address any critical issues.	7
Maintainability	Refactor nested ternary operators into a function for better clarity ___ Refactor the nested ternary operators into a separate function to improve code clarity and maintainability. This function can then be used to determine the user status based on `latestActivity`. [client/src/ui/components/cityview/realm/trade/DirectOffers/DirectOffersExplorerPopup.tsx [233-239]](https://github.com/BibliothecaDAO/eternum/pull/968/files#diff-52423cdc998d716ffb1c594ce96c9cd9e72a60d85f2df80c1d5d57ee1feff7f6R233-R239) ```diff -latestActivity === undefined - ? "offline" - : latestActivity < 86400 - ? "online" - : latestActivity < 259200 - ? "recently" - : "offline"; +function getUserStatus(latestActivity) { + if (latestActivity === undefined) return "offline"; + if (latestActivity < 86400) return "online"; + if (latestActivity < 259200) return "recently"; + return "offline"; +} +const userStatus = getUserStatus(latestActivity); ``` Suggestion importance[1-10]: 7 Why: Refactoring the nested ternary operators into a separate function improves code clarity and maintainability. This makes the logic easier to follow and reduces the complexity of the component.	7

Category	Suggestion	Score
Enhancement	Provide examples for better clarity on best practices mentioned ___ The documentation mentions using `super::IBuildingContract` to minimize imports, which is a good practice. However, it would be beneficial to provide a brief example or snippet showing this usage directly in the context for clearer understanding. [eternum-docs/docs/pages/development/contracts.mdx [36]](https://github.com/BibliothecaDAO/eternum/pull/968/files#diff-303816324aed144bd3565f9b334d183140a2ee95bb61fc7f106fbffd09379efdR36-R36) ```diff -- use of `super::IBuildingContract` to minimise imports and make it clear where the interface is defined. +- use of `super::IBuildingContract` to minimise imports. For example, `use super::IBuildingContract;` at the beginning of your module. ``` Suggestion importance[1-10]: 9 Why: Adding examples to documentation significantly enhances understanding and practical application of the best practices mentioned, making this a valuable improvement.	9
	Expand on broad statements to provide clarity and context ___ The addition of the line "Everything is fungible until it's not." could be expanded to provide more context or explanation. This statement is quite broad and might confuse readers without additional information. [eternum-docs/docs/pages/game/introduction.mdx [15]](https://github.com/BibliothecaDAO/eternum/pull/968/files#diff-e24a7c2b045bcbf98876bc5ba114a1b483034b0b63af186c553672ef1472320fR15-R15) ```diff -Everything is fungible until it's not. +Everything in the game is considered fungible until specific conditions or rules apply. ``` Suggestion importance[1-10]: 8 Why: Providing more context to broad statements enhances the clarity and understanding for readers, making the documentation more informative and user-friendly.	8
	Add a description to the "Layouts" section for consistency and clarity ___ Consider adding a brief description for the "Layouts" section to maintain consistency with other sections, which all include descriptive text. [eternum-docs/docs/pages/development/client.mdx [21]](https://github.com/BibliothecaDAO/eternum/pull/968/files#diff-a0a27d15f8da90d9daacecf2d3de7c2246c139edad29c0327c7bcd2e63fd5956R21-R21) ```diff -- Collection of containers composed into a full layout +- Collection of containers composed into a full layout. This section should outline the overall page structure and flow. ``` Suggestion importance[1-10]: 7 Why: The suggestion improves consistency and clarity by adding a description to the "Layouts" section, aligning it with other sections that include descriptive text. However, it is a minor enhancement and not crucial.	7
Best practice	Use nullish coalescing to handle falsy values more accurately ___ Consider using nullish coalescing (`??`) instead of logical OR (`\|\|`) to handle cases where `structure.category` might be an empty string or other falsy values that are valid. This ensures that only `null` or `undefined` values are replaced by the empty string, preserving other falsy values like `0` or `false` which might be valid in some contexts. [client/src/hooks/helpers/useEntities.tsx [124-128]](https://github.com/BibliothecaDAO/eternum/pull/968/files#diff-655bd94eaba19bfcec06d7b736d2e64944c31d55f2b38819201a2b0b612787e4R124-R128) ```diff const name = realm ? getRealmNameById(realm.realm_id) : structureName - ? `${structure?.category} ${structureName}` - : structure?.category; + ? `${structure?.category ?? ''} ${structureName}` + : structure?.category ?? ''; ``` Suggestion importance[1-10]: 8 Why: This suggestion improves the handling of falsy values by using nullish coalescing, which is a best practice for ensuring that only null or undefined values are replaced. This can prevent potential bugs where valid falsy values like 0 or false might be incorrectly handled.	8
	Use a switch statement to replace nested ternary operators for clarity ___ Replace the nested ternary operators with a switch statement for better readability and maintainability when determining the `modelIndex` based on `hexType`. [client/src/ui/components/construction/ExistingBuildings.tsx [134-142]](https://github.com/BibliothecaDAO/eternum/pull/968/files#diff-b8b13d61f7fc906dae1ff3473650c5893b1d3971d1b65e062a1fb4c6ed5e749bR134-R142) ```diff -hexType === HexType.BANK - ? ModelsIndexes.Bank - : hexType === HexType.SHARDSMINE - ? ModelsIndexes.ShardsMine - : hexType === HexType.HYPERSTRUCTURE - ? ModelsIndexes.Hyperstructure - : hexType === HexType.UNFINISHEDHYPERSTRUCTURE - ? ModelsIndexes.UnfinishedHyperstructure - : ModelsIndexes.Castle; +let modelIndex; +switch (hexType) { + case HexType.BANK: + modelIndex = ModelsIndexes.Bank; + break; + case HexType.SHARDSMINE: + modelIndex = ModelsIndexes.ShardsMine; + break; + case HexType.HYPERSTRUCTURE: + modelIndex = ModelsIndexes.Hyperstructure; + break; + case HexType.UNFINISHEDHYPERSTRUCTURE: + modelIndex = ModelsIndexes.UnfinishedHyperstructure; + break; + default: + modelIndex = ModelsIndexes.Castle; +} ``` Suggestion importance[1-10]: 8 Why: Replacing nested ternary operators with a switch statement enhances readability and maintainability. This is a best practice for handling multiple conditions and makes the code more understandable.	8
	Standardize the file naming convention to improve consistency ___ Consider using consistent naming conventions for files in the documentation. The naming of 'system_name.cairo' should follow the same pattern as 'tests.cairo', which uses all lowercase. This will help maintain consistency and readability in the documentation structure. [eternum-docs/docs/pages/development/contracts.mdx [28]](https://github.com/BibliothecaDAO/eternum/pull/968/files#diff-303816324aed144bd3565f9b334d183140a2ee95bb61fc7f106fbffd09379efdR28-R28) ```diff -- system_name.cairo +- systemname.cairo ``` Suggestion importance[1-10]: 7 Why: The suggestion to standardize file naming conventions is valid and improves consistency and readability. However, it is a minor enhancement and not crucial for functionality.	7
Maintainability	Extract reducer function to improve code readability and maintainability ___ To improve readability and maintainability, consider extracting the reducer function used in the `reduce` method into a separate named function. This helps in isolating logic, making the code easier to test and understand. [client/src/hooks/helpers/useRoads.tsx [130-137]](https://github.com/BibliothecaDAO/eternum/pull/968/files#diff-f2f204c5b7d8065573c295320644cc3ddd7413354c9aef7db93258e226a5f094R130-R137) ```diff -roads.reduce( - (acc, road) => { - if (!acc[road.destinationRealmName] \|\| acc[road.destinationRealmName].usageLeft < road.usageLeft) { - acc[road.destinationRealmName] = road; - } - return acc; - }, - {} as { [key: string]: RoadInterface }, -) +function selectRoadWithHighestUsage(acc, road) { + if (!acc[road.destinationRealmName] \|\| acc[road.destinationRealmName].usageLeft < road.usageLeft) { + acc[road.destinationRealmName] = road; + } + return acc; +} +const uniqueRoads = roads.reduce(selectRoadWithHighestUsage, {} as { [key: string]: RoadInterface }); ``` Suggestion importance[1-10]: 7 Why: Extracting the reducer function into a separate named function enhances readability and maintainability by isolating the logic, making the code easier to test and understand. However, it does not address any critical issues.	7
Maintainability	Refactor nested ternary operators into a function for better clarity ___ Refactor the nested ternary operators into a separate function to improve code clarity and maintainability. This function can then be used to determine the user status based on `latestActivity`. [client/src/ui/components/cityview/realm/trade/DirectOffers/DirectOffersExplorerPopup.tsx [233-239]](https://github.com/BibliothecaDAO/eternum/pull/968/files#diff-52423cdc998d716ffb1c594ce96c9cd9e72a60d85f2df80c1d5d57ee1feff7f6R233-R239) ```diff -latestActivity === undefined - ? "offline" - : latestActivity < 86400 - ? "online" - : latestActivity < 259200 - ? "recently" - : "offline"; +function getUserStatus(latestActivity) { + if (latestActivity === undefined) return "offline"; + if (latestActivity < 86400) return "online"; + if (latestActivity < 259200) return "recently"; + return "offline"; +} +const userStatus = getUserStatus(latestActivity); ``` Suggestion importance[1-10]: 7 Why: Refactoring the nested ternary operators into a separate function improves code clarity and maintainability. This makes the logic easier to follow and reduces the complexity of the component.	7

BibliothecaDAO / eternum

prettier fmt #968

PR Type

Description

Changes walkthrough 📝

PR Reviewer Guide 🔍

PR Code Suggestions ✨