Ensure description for ExcludeSyncFolders is updated

Author: nicoverbruggen

tests/integration.spec.js

@@ -76,6 +76,9 @@ test.describe('NickelMenu', () => {
     // Download instructions should be visible, and include eReader.conf step for sample config
     await expect(page.locator('#nm-download-instructions')).not.toBeHidden();
     await expect(page.locator('#nm-download-conf-step')).not.toBeHidden();
+    // Verify the correct pattern and description are shown (exclude-calibre is enabled)
+    await expect(page.locator('#nm-download-conf-line')).toHaveText('ExcludeSyncFolders=(calibre|\\.(?!kobo|adobe|calibre).+|([^.][^/]*/)+\\..+)');
+    await expect(page.locator('#nm-download-conf-desc')).toHaveText('This prevents new books in the calibre folder from showing up in Kobo\'s list of books.');
 
     // Verify ZIP contents
     expect(download.suggestedFilename()).toBe('NickelMenu-install.zip');
@@ -342,18 +345,28 @@ test.describe('NickelMenu', () => {
 
     await page.click('#btn-nm-features-next');
 
-    // Review and write to device
+    // Review and download (not write) to test download instructions
     await expect(page.locator('#step-nm-review')).not.toBeHidden();
-    await page.click('#btn-nm-write');
+    const [download] = await Promise.all([
+      page.waitForEvent('download'),
+      page.click('#btn-nm-download'),
+    ]);
     await expect(page.locator('#step-nm-done')).toBeVisible({ timeout: 30_000 });
 
-    // Verify eReader.conf was written WITHOUT calibre in the pattern
+    // Download instructions should show the non-calibre pattern
+    await expect(page.locator('#nm-download-instructions')).not.toBeHidden();
+    await expect(page.locator('#nm-download-conf-step')).not.toBeHidden();
+    await expect(page.locator('#nm-download-conf-line')).toHaveText('ExcludeSyncFolders=(\\.(?!kobo|adobe).+|([^.][^/]*/)+\\..+)');
+    await expect(page.locator('#nm-download-conf-desc')).toHaveText('This prevents the Kobo from incorrectly identifying certain files as books in your library.');
+
+    // Verify ZIP does NOT contain eReader.conf
+    const zipData = fs.readFileSync(await download.path());
+    const zip = await JSZip.loadAsync(zipData);
+    expect(Object.keys(zip.files)).not.toContain('.kobo/Kobo/Kobo eReader.conf');
+
+    // Verify eReader.conf on device was NOT modified (download mode doesn't write to device)
     const conf = await readMockFile(page, '.kobo', 'Kobo', 'Kobo eReader.conf');
-    expect(conf, 'eReader.conf should contain ExcludeSyncFolders').toContain('ExcludeSyncFolders');
-    // Pattern should NOT start with calibre
-    expect(conf).not.toContain('ExcludeSyncFolders=(calibre|');
-    // But should still have the general hidden-folder exclusion
-    expect(conf).toContain('\\.(?!kobo|adobe).+');
+    expect(conf).not.toContain('ExcludeSyncFolders');
   });
 
   test('with device — replaces existing calibre exclusion when checkbox is unchecked', async ({ page }) => {

web/src/index.html

@@ -295,7 +295,7 @@ <h2>Connect your Kobo</h2>
                     <li id="nm-download-conf-step" hidden>Open <strong>.kobo/Kobo/Kobo eReader.conf</strong> in a text editor.<br>
                         Find the <code>[FeatureSettings]</code> section (or add it at the end of the file) and add the following line <strong>inside</strong> that section (do not replace the entire file):<br>
                         <code id="nm-download-conf-line"></code><br>
-                        This prevents new books in the <code>calibre</code> folder from showing up in Kobo's list of books.</li>
+                        <span id="nm-download-conf-desc"></span></li>
                     <li id="nm-download-reboot-step" hidden><strong>Safely eject</strong> the Kobo, then power it off by holding the power button until it says "Powered off". Press the power button again to boot it back up. The config change takes effect after reboot. Reconnect the Kobo via USB afterwards.</li>
                     <li>Extract the downloaded ZIP to the <strong>root</strong> of the Kobo drive, preserving the folder structure. Make sure hidden folders like <code>.kobo</code> and <code>.adds</code> are also copied.</li>
                     <li><strong>Safely eject</strong> the Kobo &mdash; do not just unplug the cable.</li>

web/src/js/flows/nickelmenu-flow.js

@@ -362,14 +362,17 @@ export function initNickelMenu(state) {
             nmDoneStatus.textContent = TL.STATUS.NM_DOWNLOAD_READY;
             triggerDownload(state.resultNmZip, 'NickelMenu-install.zip', 'application/zip');
             $('nm-download-instructions').hidden = false;
-            // Only show config/reboot steps when exclude-calibre feature is selected
+            // Show config step for preset installs (ExcludeSyncFolders is always written)
             const features = state.nickelMenuOption === 'preset' ? getSelectedFeatures() : [];
             const hasExcludeCalibre = features.some(f => f.id === 'exclude-calibre');
-            $('nm-download-conf-step').hidden = !hasExcludeCalibre;
-            $('nm-download-reboot-step').hidden = !hasExcludeCalibre;
-            if (hasExcludeCalibre) {
-                $('nm-download-conf-line').textContent = 'ExcludeSyncFolders=(calibre|\\.(?!kobo|adobe|calibre).+|([^.][^/]*/)+\\..+)';
-            }
+            $('nm-download-conf-step').hidden = state.nickelMenuOption !== 'preset';
+            $('nm-download-reboot-step').hidden = state.nickelMenuOption !== 'preset';
+            $('nm-download-conf-line').textContent = hasExcludeCalibre
+                ? 'ExcludeSyncFolders=(calibre|\\.(?!kobo|adobe|calibre).+|([^.][^/]*/)+\\..+)'
+                : 'ExcludeSyncFolders=(\\.(?!kobo|adobe).+|([^.][^/]*/)+\\..+)';
+            $('nm-download-conf-desc').textContent = hasExcludeCalibre
+                ? 'This prevents new books in the calibre folder from showing up in Kobo\'s list of books.'
+                : 'This prevents the Kobo from incorrectly identifying certain files as books in your library.';
             track('flow-end', { result: 'nm-download' });
         }