Final polish round

README.md

@@ -1,13 +1,22 @@
 # Stracciatella Toolset
 
-This is a prototye desktop application with the goal of being an editor for mods for JA2 Stracciatella.
+A desktop application to create mods for JA2 Straccatella.
+
+![Screenshow](docs/screenshot.jpg)
 
 ## Features
 
-This app currently allows editing json data for JA2 Stracciatella only. Some JSONs might still be missing or broken.
+This app currently allows editing json data for JA2 Stracciatella. Most json files are supported, although some might still be missing. Known missing files are:
+
+- Dealer Inventories
+- Translations
 
 ## Install
 
+The best way to install the app is to download the latest release from the [releases page](https://github.com/ja2-stracciatella/stracciatella-toolset/releases).
+
+## Development Setup
+
 Install build dependencies:
 
 - [NodeJS / NPM](https://nodejs.org/)
@@ -19,26 +28,34 @@ Clone the repo and install node dependencies:
 npm install
 ```
 
-## Starting Development
+## Starting the App for Development
 
 Start the app in the `dev` environment:
 
 ```bash
 npm start
 ```
 
-## Linting & Formatting
+## Testing
 
-Linting:
+You can run the following commands:
+
+Typechecking:
 
+```bash
+npm run tsc:check
 ```
+
+Linting:
+
+```bash
 npm run lint
 ```
 
-Auto-fix:
+Tests (in watch mode):
 
-```
-npm run lint -- --fix
+```bash
+npm run test:watch
 ```
 
 ## Packaging the App

package.json

@@ -1,5 +1,5 @@
 {
-  "description": "A foundation for scalable desktop apps",
+  "description": "A desktop application to create mods for JA2 Straccatella.",
   "license": "MIT",
   "version": "0.22.0",
   "main": "./.erb/dll/main.bundle.dev.js",
@@ -19,7 +19,8 @@
     "start:main": "concurrently -k \"cross-env NODE_ENV=development webpack --watch --config ./.erb/configs/webpack.config.main.dev.mts\" \"electronmon .\"",
     "start:preload": "cross-env NODE_ENV=development webpack --config ./.erb/configs/webpack.config.preload.dev.mts",
     "start:renderer": "cross-env NODE_ENV=development webpack serve --config ./.erb/configs/webpack.config.renderer.dev.mts",
-    "test": "cross-env NODE_ENV=development vitest --run"
+    "test": "cross-env NODE_ENV=development vitest run",
+    "test:watch": "cross-env NODE_ENV=development vitest watch"
   },
   "browserslist": [],
   "prettier": {

release/app/package.json

@@ -1,12 +1,11 @@
 {
-  "name": "electron-react-boilerplate",
-  "version": "4.6.0",
-  "description": "A foundation for scalable desktop apps",
+  "name": "stracciatella-toolset",
+  "version": "0.22.0",
+  "description": "A desktop application to create mods for JA2 Straccatella.",
   "license": "MIT",
   "author": {
-    "name": "Electron React Boilerplate Maintainers",
-    "email": "electronreactboilerplate@gmail.com",
-    "url": "https://github.com/electron-react-boilerplate"
+    "name": "JA2 Stracciatella Team",
+    "url": "https://github.com/ja2-stracciatella"
   },
   "main": "./dist/main/main.js",
   "scripts": {

src-rust/src/invokables/resources.rs

@@ -13,8 +13,10 @@ pub enum ResourceEntry {
 }
 
 #[derive(Debug, Clone, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
 pub struct List {
     path: String,
+    mod_only: Option<bool>,
 }
 
 impl Invokable for List {
@@ -36,26 +38,28 @@ impl Invokable for List {
         let selected_mod = state.try_selected_mod()?;
         let mut result = HashSet::new();
 
-        let candidates = selected_mod.vfs.read_dir(&Nfc::caseless(&self.path)).ok();
-        for candidate in candidates.iter().flatten() {
-            let path = if self.path.is_empty() {
-                candidate.clone()
-            } else {
-                Nfc::caseless(&format!("{}/{}", self.path, candidate))
-            };
-            // Workaround to determine whether the candidate is a file
-            let is_file = selected_mod.vfs.open(&path).is_ok();
-            let entry = if is_file {
-                ResourceEntry::File {
-                    path: candidate.to_string().to_lowercase(),
-                }
-            } else {
-                ResourceEntry::Dir {
-                    path: candidate.to_string().to_lowercase(),
-                }
-            };
+        if !self.mod_only.unwrap_or(true) {
+            let candidates = selected_mod.vfs.read_dir(&Nfc::caseless(&self.path)).ok();
+            for candidate in candidates.iter().flatten() {
+                let path = if self.path.is_empty() {
+                    candidate.clone()
+                } else {
+                    Nfc::caseless(&format!("{}/{}", self.path, candidate))
+                };
+                // Workaround to determine whether the candidate is a file
+                let is_file = selected_mod.vfs.open(&path).is_ok();
+                let entry = if is_file {
+                    ResourceEntry::File {
+                        path: candidate.to_string().to_lowercase(),
+                    }
+                } else {
+                    ResourceEntry::Dir {
+                        path: candidate.to_string().to_lowercase(),
+                    }
+                };
 
-            result.insert(entry);
+                result.insert(entry);
+            }
         }
 
         let dir = selected_mod.data_path(&self.path);

src/__tests__/renderer/App.test.tsx

@@ -4,7 +4,7 @@ import { renderWithTestProviders } from './test-utils/render';
 import { it, describe, expect } from 'vitest';
 
 describe('App', () => {
-  it('should render the configuration dialog when toolset is not configured', async () => {
+  it('should render loading as the default', async () => {
     const { getByLabelText } = renderWithTestProviders(<AppWithoutProviders />);
 
     await waitFor(() => {