@bobfrankston/npmglobalize 1.0.200 → 1.0.202

package/cli.js

@@ -112,6 +112,7 @@ Other Options:
   -force          Continue despite git errors
   -dry-run        Preview what would happen
   -quiet          Suppress npm warnings (default)
+  -noquiet        Show npm warnings (without -verbose's extra detail)
   -verbose        Show detailed output
   -conform        Update .gitignore/.npmignore to best practices
                   (noEmit projects: removes TS ignores from .npmignore)
@@ -268,6 +269,10 @@ function parseArgs(args) {
             case '-quiet':
                 options.quiet = true;
                 break;
+            case '-noquiet':
+                options.quiet = false;
+                options.explicitKeys.add('quiet');
+                break;
             case '-verbose':
                 options.verbose = true;
                 options.quiet = false;

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');
 }
@@ -5334,9 +5344,9 @@ export async function globalize(cwd, options = {}, configOptions = {}) {
         if (configOptions.link)
             settings.push('--link');
         if (configOptions.npmVisibility)
-            settings.push(`--npm-visibility ${configOptions.npmVisibility}`);
+            settings.push(`-npm ${configOptions.npmVisibility}`);
         if (configOptions.gitVisibility)
-            settings.push(`--git-visibility ${configOptions.gitVisibility}`);
+            settings.push(`-git ${configOptions.gitVisibility}`);
         if (configOptions.conform)
             settings.push('--conform');
         if (configOptions.asis)
@@ -5358,15 +5368,15 @@ export async function globalize(cwd, options = {}, configOptions = {}) {
         if (configOptions.dryRun)
             settings.push('--dry-run');
         if (configOptions.bump)
-            settings.push(`--bump ${configOptions.bump}`);
+            settings.push(`-${configOptions.bump}`);
         if (configOptions.cleanup)
             settings.push('--cleanup');
         if (configOptions.wsl)
             settings.push('--wsl');
         if (configOptions.files === false)
-            settings.push('--no-files');
+            settings.push('-nofiles');
         if (configOptions.quiet === false)
-            settings.push('--no-quiet');
+            settings.push('-noquiet');
         if (configOptions.publishDeps === false)
             settings.push('--no-publish-deps');
         if (configOptions.forcePublish)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bobfrankston/npmglobalize",
-  "version": "1.0.200",
+  "version": "1.0.202",
   "description": "Transform file: dependencies to npm versions for publishing",
   "main": "index.js",
   "type": "module",
@@ -32,7 +32,7 @@
   },
   "dependencies": {
     "@bobfrankston/freezepak": "^0.1.9",
-    "@bobfrankston/importgen": "^0.1.39",
+    "@bobfrankston/importgen": "^0.1.40",
     "@bobfrankston/themecolors": "^0.1.8",
     "@bobfrankston/userconfig": "^1.0.10",
     "@npmcli/package-json": "^7.0.4",
@@ -60,7 +60,7 @@
   ".transformedSnapshot": {
     "dependencies": {
       "@bobfrankston/freezepak": "^0.1.9",
-      "@bobfrankston/importgen": "^0.1.39",
+      "@bobfrankston/importgen": "^0.1.40",
       "@bobfrankston/themecolors": "^0.1.8",
       "@bobfrankston/userconfig": "^1.0.10",
       "@npmcli/package-json": "^7.0.4",

package/lib/config.d.ts

@@ -1,23 +0,0 @@
-import { type NpmCommonConfig } from '@bobfrankston/userconfig';
-import { type GlobalizeOptions } from './types.js';
-/** Read and parse package.json from a directory */
-export declare function readPackageJson(dir: string): any;
-/** Global npm config from %USERPROFILE%\.userconfig\npm.json5 — via @bobfrankston/userconfig */
-export type UserNpmConfig = NpmCommonConfig;
-/** Get the .userconfig directory path (%USERPROFILE%\.userconfig) */
-export declare function getUserConfigDir(): string;
-/** Read global npm config from %USERPROFILE%\.userconfig\npm.json5 */
-export declare function readUserNpmConfig(): UserNpmConfig;
-/** Write global npm config to %USERPROFILE%\.userconfig\npm.json5 */
-export declare function writeUserNpmConfig(config: UserNpmConfig): void;
-/** Read .globalize.json5 config file */
-export declare function readConfig(dir: string): Partial<GlobalizeOptions>;
-/** Write .globalize.json5 config file */
-export declare function writeConfig(dir: string, config: Partial<GlobalizeOptions>, explicitKeys?: Set<string>): void;
-/** Write package.json to a directory */
-export declare function writePackageJson(dir: string, pkg: any): void;
-/** Resolve a file: path to absolute path */
-export declare function resolveFilePath(fileRef: string, baseDir: string): string;
-/** Check if a dependency value is a file: reference */
-export declare function isFileRef(value: string): boolean;
-//# sourceMappingURL=config.d.ts.map

package/lib/config.js

@@ -1,163 +0,0 @@
-import fs from 'fs';
-import path from 'path';
-import JSON5 from 'json5';
-import { readConfig as readUserConfig, writeConfig as writeUserConfig, configDir } from '@bobfrankston/userconfig';
-/** Read and parse package.json from a directory */
-export function readPackageJson(dir) {
-    const pkgPath = path.join(dir, 'package.json');
-    if (!fs.existsSync(pkgPath)) {
-        throw new Error(`package.json not found: ${pkgPath}`);
-    }
-    try {
-        return JSON.parse(fs.readFileSync(pkgPath, 'utf-8'));
-    }
-    catch (error) {
-        throw new Error(`Failed to parse ${pkgPath}: ${error.message}`);
-    }
-}
-/** Get the .userconfig directory path (%USERPROFILE%\.userconfig) */
-export function getUserConfigDir() {
-    return configDir;
-}
-/** Read global npm config from %USERPROFILE%\.userconfig\npm.json5 */
-export function readUserNpmConfig() {
-    return readUserConfig();
-}
-/** Write global npm config to %USERPROFILE%\.userconfig\npm.json5 */
-export function writeUserNpmConfig(config) {
-    const existing = readUserConfig();
-    const merged = { ...existing, ...config };
-    writeUserConfig(merged);
-}
-/** Read .globalize.json5 config file */
-export function readConfig(dir) {
-    const configPath = path.join(dir, '.globalize.json5');
-    if (!fs.existsSync(configPath)) {
-        return {};
-    }
-    try {
-        const content = fs.readFileSync(configPath, 'utf-8');
-        return JSON5.parse(content);
-    }
-    catch (error) {
-        console.warn(`Warning: Could not parse .globalize.json5 config: ${error.message}`);
-        return {};
-    }
-}
-/** Write .globalize.json5 config file */
-export function writeConfig(dir, config, explicitKeys) {
-    const configPath = path.join(dir, '.globalize.json5');
-    // Define defaults to omit
-    const defaults = {
-        bump: 'patch',
-        files: true,
-        quiet: true,
-        gitVisibility: 'private',
-        npmVisibility: 'private',
-        install: false,
-        wsl: false,
-        force: false,
-        verbose: false,
-        freeze: false,
-        usePaths: true
-    };
-    // Read existing config to preserve values
-    const existing = readConfig(dir);
-    // Filter out temporary flags and default values (unless explicitly set)
-    const filtered = {};
-    const omitKeys = new Set(['cleanup', 'init', 'dryRun', 'message', 'conform', 'asis', 'help', 'error', 'updateDeps', 'updateMajor', 'publishDeps', 'publicDeps', 'forcePublish', 'once', 'cleanNestedModules']);
-    for (const [key, value] of Object.entries(config)) {
-        if (omitKeys.has(key))
-            continue;
-        // Keep if: already in config, explicitly set via CLI, or differs from default
-        const isExplicit = explicitKeys?.has(key);
-        const wasInConfig = key in existing;
-        const differsFromDefault = defaults[key] !== value;
-        if (isExplicit || wasInConfig || differsFromDefault) {
-            filtered[key] = value;
-        }
-    }
-    // Build content with comments
-    const lines = [
-        '{',
-        '  // npmglobalize configuration (JSON5 format - trailing commas OK)',
-        '  // Explicitly set values are preserved here',
-        ''
-    ];
-    // Add configured values
-    const entries = Object.entries(filtered);
-    if (entries.length > 0) {
-        entries.forEach(([key, value]) => {
-            const jsonValue = typeof value === 'string' ? `"${value}"` : JSON.stringify(value);
-            const comma = ','; // JSON5 allows trailing commas
-            // Add inline comment for clarity
-            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)';
-            lines.push(`  "${key}": ${jsonValue}${comma}${comment}`);
-        });
-        lines.push('');
-    }
-    // Add commented reference for all options
-    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('}');
-    fs.writeFileSync(configPath, lines.join('\n') + '\n');
-}
-/** Write package.json to a directory */
-export function writePackageJson(dir, pkg) {
-    const pkgPath = path.join(dir, 'package.json');
-    fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + '\n');
-}
-/** Resolve a file: path to absolute path */
-export function resolveFilePath(fileRef, baseDir) {
-    const relativePath = fileRef.replace(/^file:/, '');
-    return path.resolve(baseDir, relativePath);
-}
-/** Check if a dependency value is a file: reference */
-export function isFileRef(value) {
-    return typeof value === 'string' && value.startsWith('file:');
-}
-//# sourceMappingURL=config.js.map

package/lib/deps.d.ts

@@ -1,42 +0,0 @@
-/**
- * npmglobalize dependency analysis, transformation, and restoration.
- * Handles file: ref discovery, workspace graphs, topological sorting,
- * and transforming file: deps to npm versions for publishing.
- */
-/** Get all file: dependencies from package.json */
-export declare function getFileRefs(pkg: any): Map<string, {
-    key: string;
-    name: string;
-    value: string;
-}>;
-/** Resolve workspace entries to package info. Skips dirs without package.json or with private:true. */
-export declare function resolveWorkspacePackages(rootDir: string): Array<{
-    name: string;
-    dir: string;
-    pkg: any;
-}>;
-/** Build a dependency graph among workspace packages. Returns Map<name, Set<depName>>. */
-export declare function buildDependencyGraph(packages: Array<{
-    name: string;
-    dir: string;
-    pkg: any;
-}>): Map<string, Set<string>>;
-/** Topological sort with cycle detection. Returns package names in dependency order. */
-export declare function topologicalSort(graph: Map<string, Set<string>>): string[];
-/** Transform file: dependencies to npm versions */
-export declare function transformDeps(pkg: any, baseDir: string, verbose?: boolean, forcePublish?: boolean): {
-    transformed: boolean;
-    unpublished: Array<{
-        name: string;
-        version: string;
-        path: string;
-    }>;
-};
-/** Build and print a dependency tree of file: references.
- *  Recursively walks file: deps showing the full hierarchy with indentation. */
-export declare function printDepTree(baseDir: string, indent?: number, visited?: Set<string>): void;
-/** Restore file: dependencies from .dependencies */
-export declare function restoreDeps(pkg: any, verbose?: boolean): boolean;
-/** Check if .dependencies exist (already transformed) */
-export declare function hasBackup(pkg: any): boolean;
-//# sourceMappingURL=deps.d.ts.map