@bobfrankston/npmglobalize 1.0.201 → 1.0.202

package/lib.js

@@ -219,6 +219,33 @@ export function readConfig(dir) {
         return {};
     }
 }
+/** Inline comments for boolean settings in .globalize.json5. Value-aware: a
+ *  negated setting must not read as though it still does the thing (a
+ *  `"quiet": false` line saying "Suppress npm warnings" describes the
+ *  opposite of what it does). */
+const BOOL_COMMENTS = {
+    install: { on: 'Auto-install globally after publish (from registry)', off: 'Do NOT auto-install globally after publish' },
+    link: { on: 'Install globally via symlink (npm install -g .)', off: 'Do NOT install globally via symlink' },
+    wsl: { on: 'Also install in WSL', off: 'Do NOT install in WSL' },
+    files: { on: 'Restore file: paths after publish', off: 'Leave npm versions in package.json after publish' },
+    force: { on: 'Continue despite git errors', off: 'Stop on git errors' },
+    quiet: { on: 'Suppress npm warnings', off: 'Show npm warnings' },
+    verbose: { on: 'Show detailed output', off: 'Normal output detail' },
+    fix: { on: 'Auto-run npm audit fix', off: 'Do NOT run npm audit fix' },
+    local: { on: 'Local install only (skip transform/publish)', off: 'Normal transform/publish flow' },
+    noPublish: { on: 'Transform but don\'t publish', off: 'Publish normally' },
+    freeze: { on: 'Freeze node_modules (replace symlinks with real copies)', off: 'Leave node_modules symlinks as-is' },
+    usePaths: { on: 'Resolve file: deps from sibling checkouts', off: 'Resolve file: deps from npm, not siblings (standalone package)' },
+    allowTs: { on: 'Keep .ts source (and *.map, tsconfig.json) in the published npm tarball', off: 'Strip .ts source from the published npm tarball' },
+    importgen: { on: 'Regenerate browser import maps', off: 'Never ask about importgen here' }
+};
+/** Inline comments for settings whose value isn't a plain boolean. */
+const VALUE_COMMENTS = {
+    gitVisibility: 'private (default) or public',
+    npmVisibility: 'private (default) or public',
+    bump: 'patch (default), minor, or major',
+    subProjects: 'Sub-dirs with their own tsconfig that build must compile (false = never ask)'
+};
 /** Write .globalize.json5 config file */
 export function writeConfig(dir, config, explicitKeys) {
     const configPath = path.join(dir, '.globalize.json5');
@@ -284,68 +311,51 @@ export function writeConfig(dir, config, explicitKeys) {
             }
             const jsonValue = typeof value === 'string' ? `"${value}"` : JSON.stringify(value);
             const comma = ','; // JSON5 allows trailing commas
-            // Add inline comment for clarity
+            // Add inline comment for clarity, keyed off the actual value so a
+            // negated boolean doesn't describe the behaviour it turns off.
             let comment = '';
-            if (key === 'install')
-                comment = '  // Auto-install globally after publish (from registry)';
-            else if (key === 'link')
-                comment = '  // Install globally via symlink (npm install -g .)';
-            else if (key === 'wsl')
-                comment = '  // Also install in WSL';
-            else if (key === 'files')
-                comment = '  // Keep file: paths after publish';
-            else if (key === 'force')
-                comment = '  // Continue despite git errors';
-            else if (key === 'quiet')
-                comment = '  // Suppress npm warnings';
-            else if (key === 'verbose')
-                comment = '  // Show detailed output';
-            else if (key === 'gitVisibility')
-                comment = '  // private (default) or public';
-            else if (key === 'npmVisibility')
-                comment = '  // private (default) or public';
-            else if (key === 'bump')
-                comment = '  // patch (default), minor, or major';
-            else if (key === 'fix')
-                comment = '  // Auto-run npm audit fix';
-            else if (key === 'local')
-                comment = '  // Local install only (skip transform/publish)';
-            else if (key === 'noPublish')
-                comment = '  // Transform but don\'t publish';
-            else if (key === 'freeze')
-                comment = '  // Freeze node_modules (replace symlinks with real copies)';
-            else if (key === 'usePaths')
-                comment = '  // Resolve file: deps from sibling checkouts (set false for standalone packages)';
-            else if (key === 'allowTs')
-                comment = '  // Keep .ts source (and *.map, tsconfig.json) in the published npm tarball';
-            else if (key === 'importgen')
-                comment = '  // Regenerate browser import maps (false = never ask about importgen here)';
-            else if (key === 'subProjects')
-                comment = '  // Sub-dirs with their own tsconfig that build must compile (false = never ask)';
+            const boolComment = BOOL_COMMENTS[key];
+            if (boolComment && typeof value === 'boolean') {
+                comment = `  // ${value ? boolComment.on : boolComment.off}`;
+            }
+            else if (VALUE_COMMENTS[key]) {
+                comment = `  // ${VALUE_COMMENTS[key]}`;
+            }
+            else if (boolComment) {
+                // Non-boolean value for a normally-boolean key (e.g. subProjects: ["Sw"])
+                comment = `  // ${boolComment.on}`;
+            }
             lines.push(`  "${key}": ${jsonValue}${comma}${comment}`);
         });
         lines.push('');
     }
-    // Add commented reference for all options
+    // Add commented reference for all options. Booleans are phrased "true = ..."
+    // so the description reads correctly next to a default of false.
     lines.push('  // Defaults (omitted above):');
-    lines.push('  // "bump": "patch"              // Version bump: patch, minor, major');
-    lines.push('  // "install": false             // Auto-install globally after publish (from registry)');
-    lines.push('  // "link": false               // Install globally via symlink (npm install -g .)');
-    lines.push('  // "wsl": false                 // Also install in WSL');
-    lines.push('  // "files": true                // Keep file: paths after publish');
-    lines.push('  // "force": false               // Continue despite git errors');
-    lines.push('  // "quiet": true                // Suppress npm warnings');
-    lines.push('  // "verbose": false             // Show detailed output');
-    lines.push('  // "gitVisibility": "private"   // Git repo: private or public');
-    lines.push('  // "npmVisibility": "private"   // npm package: private or public');
-    lines.push('  // "fix": false                 // Auto-run npm audit fix');
-    lines.push('  // "local": false              // Local install only (skip transform/publish)');
-    lines.push('  // "noPublish": false          // Transform but don\'t publish');
-    lines.push('  // "freeze": false              // Freeze node_modules (replace symlinks with real copies)');
-    lines.push('  // "usePaths": true              // Resolve file: deps from siblings; false = use latest npm version (standalone)');
-    lines.push('  // "allowTs": false              // Include .ts source in npm tarball (auto-true for noEmit projects)');
-    lines.push('  // "importgen": auto             // Detected from .vscode/tasks.json / import map in HTML; false = never ask');
-    lines.push('  // "subProjects": auto           // Sub-dirs with their own tsconfig (e.g. ["Sw"]); detected from .vscode/tasks.json; false = never ask');
+    const reference = [
+        ['"bump": "patch"', 'Version bump: patch, minor, major'],
+        ['"install": false', 'true = auto-install globally after publish (from registry)'],
+        ['"link": false', 'true = install globally via symlink (npm install -g .)'],
+        ['"wsl": false', 'true = also install in WSL'],
+        ['"files": true', 'true = restore file: paths after publish; false = leave npm versions in package.json'],
+        ['"force": false', 'true = continue despite git errors'],
+        ['"quiet": true', 'true = suppress npm warnings'],
+        ['"verbose": false', 'true = show detailed output'],
+        ['"gitVisibility": "private"', 'Git repo: private or public'],
+        ['"npmVisibility": "private"', 'npm package: private or public'],
+        ['"fix": false', 'true = auto-run npm audit fix'],
+        ['"local": false', 'true = local install only (skip transform/publish)'],
+        ['"noPublish": false', 'true = transform but don\'t publish'],
+        ['"freeze": false', 'true = freeze node_modules (replace symlinks with real copies)'],
+        ['"usePaths": true', 'true = resolve file: deps from siblings; false = use latest npm version (standalone)'],
+        ['"allowTs": false', 'true = include .ts source in npm tarball (auto-true for noEmit projects)'],
+        ['"importgen": auto', 'Detected from .vscode/tasks.json / import map in HTML; false = never ask'],
+        ['"subProjects": auto', 'Sub-dirs with their own tsconfig (e.g. ["Sw"]); detected from .vscode/tasks.json; false = never ask']
+    ];
+    const refWidth = Math.max(...reference.map(([decl]) => decl.length));
+    for (const [decl, note] of reference) {
+        lines.push(`  // ${decl.padEnd(refWidth)}  // ${note}`);
+    }
     lines.push('}');
     fs.writeFileSync(configPath, lines.join('\n') + '\n');
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bobfrankston/npmglobalize",
-  "version": "1.0.201",
+  "version": "1.0.202",
   "description": "Transform file: dependencies to npm versions for publishing",
   "main": "index.js",
   "type": "module",