Merge branch 'master' of https://github.com/have-fun-was-taken/yafc-ce

Author: craig-johnston

.editorconfig

@@ -47,7 +47,7 @@ dotnet_style_predefined_type_for_member_access = true:suggestion
 dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:suggestion
 dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:suggestion
 dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:suggestion
-dotnet_style_parentheses_in_other_operators = never_if_unnecessary:suggestion
+dotnet_style_parentheses_in_other_operators = always_for_clarity:suggestion
 # Modifier preferences
 dotnet_style_require_accessibility_modifiers = for_non_interface_members:suggestion
 dotnet_style_readonly_field = true:suggestion
@@ -61,8 +61,12 @@ dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggesti
 dotnet_style_prefer_inferred_tuple_names = true:suggestion
 dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
 dotnet_style_prefer_auto_properties = true:suggestion
-dotnet_style_prefer_conditional_expression_over_assignment = true:suggestion
-dotnet_style_prefer_conditional_expression_over_return = true:suggestion
+# If true, the settings below make one-liners out of every conditional statement, 
+# which reduces the readability. It varies depending on the situation, so we set 
+# these warnings to none.
+dotnet_style_prefer_conditional_expression_over_assignment = false:none
+dotnet_style_prefer_conditional_expression_over_return = false:none
+
 ###############################
 # Naming Conventions          #
 ###############################
@@ -82,7 +86,8 @@ dotnet_naming_symbols.constant_fields.required_modifiers          = const
 # var preferences
 csharp_style_var_for_built_in_types = false:suggestion
 csharp_style_var_when_type_is_apparent = false:suggestion
-csharp_style_var_elsewhere = false:suggestion
+# For all else, we prefer non-var but don't enforce it 
+csharp_style_var_elsewhere = false:none
 # Expression-bodied members
 csharp_style_expression_bodied_methods = false:suggestion
 csharp_style_expression_bodied_constructors = false:suggestion
@@ -138,3 +143,8 @@ csharp_preserve_single_line_blocks = true
 # YAFC-CE Code Style          #
 ###############################
 dotnet_diagnostic.IDE0055.severity = error
+# Disable "IDE0130: Namespace does not match folder structure" because VS Code Cleanup applies it automatically and breaks things.
+dotnet_style_namespace_match_folder = false
+
+# Suppress IDE0047: Remove unnecessary parentheses. Parentheses improve readability.
+dotnet_diagnostic.IDE0047.severity = none

.github/ISSUE_TEMPLATE/error-while-loading-mods.md

@@ -1,7 +1,7 @@
 ---
 name: Error while loading mods
 about: Error while loading mods
-title: "[Loading error]"
+title: ""
 labels: bug
 assignees: ''
 

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,7 +1,7 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: "[Feature request]"
+title: ""
 labels: enhancement
 assignees: ''
 

.github/ISSUE_TEMPLATE/generic-bug-report.md

@@ -1,7 +1,7 @@
 ---
 name: Generic bug report
 about: Bug report
-title: "[Bug summary]"
+title: ""
 labels: bug
 assignees: ''
 
@@ -15,4 +15,4 @@ assignees: ''
 - If the bug is about mods, attach a new-game save-file so we can sync the mods with yours.
 - If the bug is about your .yafc project, such as errors in calculations, then attach your .yafc file.
 - Describe the steps to reproduce the issue, the expected result, and the actual result.
-- If possible, please provide a minimal example to reproduce the issue.
+- If possible, please provide a minimal example to reproduce the issue. For example, check if the bug can be reproduced on a fresh project instead of the usual one. Try to use as few mods as possible.

CommandLineToolExample/CommandLineToolExample.csproj

@@ -5,10 +5,12 @@
         <RootNamespace>YafcCommandLineToolExample</RootNamespace>
         <LangVersion>8</LangVersion>
         <OutputType>Exe</OutputType>
+        <PlatformTarget>x64</PlatformTarget>
     </PropertyGroup>
 
     <ItemGroup>
       <ProjectReference Include="..\YAFCmodel\YAFCmodel.csproj" />
+      <ProjectReference Include="..\YAFCparser\YAFCparser.csproj" />
       <ProjectReference Include="..\YAFC\YAFC.csproj" />
     </ItemGroup>
 

CommandLineToolExample/Program.cs

@@ -14,8 +14,8 @@ public static void Main(string[] args) {
             }
             YafcLib.Init();
             YafcLib.RegisterDefaultAnalysis(); // Register analysis to get cost, milestones, accessibility, etc information. Skip if you just need data. 
-            var factorioPath = args[0];
-            var errorCollector = new ErrorCollector();
+            string factorioPath = args[0];
+            ErrorCollector errorCollector = new ErrorCollector();
             Project project;
             try {
                 // Load YAFC project.

Docs/ContributorsGuide.md

@@ -1,17 +1,18 @@
 # Contributor's Guide
 
-To make your experience better, there are a couple of things to keep in mind when working on a Pull Request: 
+Here are a couple of things to make your experience in the community more enjoyable. 
 
-Coding phase:
-* Please use the same code style as the rest of the codebase. 
+## Coding
+* Please use the same code style as the rest of the codebase. Visual Studio should pick up most of it from `.editorconfig`. 
 * Please prioritize maintainability. Aim for understandable code without dirty hacks.
 * Please separate refactoring and the change of behavior into different commits, so it is easier to review the PR.
-* Please document the code. If you can also document the existing code, we would be thankful. Better documentation allows others to understand the code faster and thus to contribute more.
-* In a programmers' haven, there's a spot for devs who write tests.
+* Please document the code. If you also can document the existing code, that would be awesome. More documentation helps others to understand the code faster and make the work on YAFC more enjoyable.
+* Feel free to put [prefixes](https://www.conventionalcommits.org/en/v1.0.0-beta.2/#summary) in the subjects of your commits -- they might help to browse them later.
+* In the programmers-haven, there is always a free spot for those who write tests.
 
-PR preparation phase:
-* When making a Pull Request, give as much context as possible. 
-* If there's no corresponding issue, then describe what the problem was and how your PR fixes it. For instance, context, state without the fix, state with the fix. 
-* Make meaningful commit messages. The easier it is to understand your PR, the faster it will be merged.
-* If you feel fancy, reorganize your commits - separate and squash them into logical steps, so they are understood even better.
+## Pull Request
+* When making a Pull Request, please give some context. For instance, if the PR solves an issue, then you can put a short description of the issue in the PR.
+* If there's no corresponding issue, then describe what the problem was and how your PR fixes it. The context, the state without the fix, and with the fix.
 * Please provide a short description of your change in the [changelog](https://github.com/have-fun-was-taken/yafc-ce/blob/master/changelog.txt).
+* Make meaningful commit messages. The easier it is to understand your PR, the faster it will be merged.
+* It would be appreciated if you reorganize your commits before the merge -- separate and squash them into logical steps, so they are easier to review and understand. For instance, the fixes to the commits can be squashed into them. The reordering of the commits can be done with the interactive rebase: `git rebase -i head~n`, but please read beforehand on how to do it, so you don't accidentally delete your efforts. If you want to go godlike, feel free to read on `git commit --fixup=` and `git rebase -i --autosquash` ([example](https://stackoverflow.com/questions/3103589/how-can-i-easily-fixup-a-past-commit)). However, it can be the case that the reordering requires very tricky merges, so it's okay to leave them as-is in this case.

Docs/MoreLanguagesSupport.md

@@ -1,6 +1,6 @@
 # YAFC support for more languages
 
-YAFC language support is exprimental. If your language is missing, that is probably because of one of two reasons:
+YAFC language support is experimental. If your language is missing, that is probably because of one of two reasons:
 
 - It has less than 90% support in official Factorio translation
 - It uses non-european glyphs (such as Chinese or Japanese languages)

Docs/TipsAndTricks.md

@@ -2,6 +2,12 @@
 
 The tips are ordered by the progression through the game.
 
+### Electricity generation
+
+When trying to calculate how much electricity a certain amount of fuel would generate, there is no consumption recipe in the list that would take this fuel and convert it into the electirity. 
+That's because the electricity recipe is special, so you need to add it by either clicking on the Electricity icon and selecting the sole production recipe there is, or through the dropdown menu on the top left: 
+Recipe > Add Recipe > Electricity.
+
 ### Desired expenditure
 
 Sometimes it's more convenient to set up ore expenditure rather than the amount of the final product. You can do it by putting the ore into Desired Products and assigning it a negative number.

README.md

@@ -12,7 +12,7 @@ Yes, we have their approval.
 </details>
 
 ## What is YAFC?
-Yet Another Factorio Calculator or YAFC is a planner and analyser. The main goal of YAFC is to help with heavily modded Factorio games.
+Yet Another Factorio Calculator or YAFC is a planner and analyzer. The main goal of YAFC is to help with heavily modded Factorio games.
 
 <details>
 <summary>Expand to see what YAFC can do</summary>
@@ -48,7 +48,7 @@ For tricky use cases, please refer to the [Tips and Tricks](/Docs/TipsAndTricks.
     - Nested sheets: You can attach a nested sheet to any recipe. When a sheet is collapsed, you will see a summary for all recipes in it. Nested sheets have their own set of links. For example, you can create a nested sheet for electronic circuits, and put copper cables inside that sheet. If you add an internal link for copper cables, it will be separate, so you can calculate copper cables just for electronic circuits.
     - Auto modules: You can add modules to recipes by using a single slider. Based on your milestones, it will automatically add modules you have access to. It will prioritize putting modules into buildings that benefit the most from them. <details><summary>Expand to see it in action</summary><IMG src="/Docs/Media/AutoModules.gif"  alt="AutoModules.gif"/></details>
     - Fluid temperatures, although without mixing them, allow to calculate energy generation.
-    - Fuel, including electricity. You can even add energy generation exactly enough for your sheet. Howerver, inserters are not included.
+    - Fuel, including electricity. You can even add energy generation exactly enough for your sheet. However, inserters are not included.
 - Multiple analyses:
     - Accessibility analysis: Shows inaccessible objects. Mods often hide objects, and Factorio has a bunch of hidden ones too. However, it is impossible to find objects that are spawned by mods or map scripts. This analysis may fail for modpacks like Seablock, but you can mark some objects as accessible manually.
     - Milestone analysis: You can add anything as a milestone. YAFC will display that milestone icon on every object that is locked behind it, directly or indirectly. Science packs are natural milestones, and so they are added by default.