Merge branch 'release/7.2.0'

Author: furey

.gitignore

@@ -3,4 +3,4 @@ node_modules/
 repomix*
 CLAUDE.md
 ROADMAP.md
-.mongodb-lens.json*
+.mongodb-lens*.json*

README.md

@@ -319,8 +319,10 @@ MongoDB Lens is now installed and ready to accept MCP requests.
 
 - [MongoDB Connection String](#configuration-mongodb-connection-string)
 - [Config File](#configuration-config-file)
+- [Config File Generation](#configuration-config-file-generation)
 - [Multiple MongoDB Connections](#configuration-multiple-mongodb-connections)
 - [Environment Variable Overrides](#configuration-environment-variable-overrides)
+- [Cross-Platform Environment Variables](#configuration-cross-platform-environment-variables)
 
 ### Configuration: MongoDB Connection String
 
@@ -357,7 +359,10 @@ MongoDB Lens supports extensive customization via JSON configuration file.
 > The config file is optional. MongoDB Lens will run with default settings if no config file is provided.
 
 > [!TIP]<br>
-> MongoDB Lens supports both `.json` and `.jsonc` (JSON with comments) file formats.
+> You only need to include the settings you want to customize in the config file. MongoDB Lens will use default settings for any omitted values.
+
+> [!TIP]<br>
+> MongoDB Lens supports both `.json` and `.jsonc` (JSON with comments) config file formats.
 
 <details>
   <summary><strong>Example configuration file</strong></summary>
@@ -449,7 +454,10 @@ MongoDB Lens supports extensive customization via JSON configuration file.
 
 </details>
 
-By default, MongoDB Lens looks for the config file at: `~/.mongodb-lens.json`
+By default, MongoDB Lens looks for the config file at:
+
+- `~/.mongodb-lens.jsonc` first, then falls back to
+- `~/.mongodb-lens.json` if the former doesn't exist
 
 To customize the config file path, set the environment variable `CONFIG_PATH` to the desired file path.
 
@@ -465,6 +473,66 @@ Example Docker Hub usage:
 docker run --rm -i --network=host --pull=always -v /path/to/config.json:/root/.mongodb-lens.json furey/mongodb-lens
 ```
 
+### Configuration: Config File Generation
+
+You can generate a configuration file automatically using the `config:create` script:
+
+```console
+# Create config file
+npm run config:create
+
+# Create config file (force overwrite existing)
+npm run config:create -- --force
+```
+
+This script extracts the [example configuration file](#configuration-config-file) above and saves it to: `~/.mongodb-lens.jsonc`
+
+#### Config File Generation: Custom Path
+
+You can specify a custom configuration file output location using the `CONFIG_PATH` environment variable:
+
+```console
+# Save to a specific file path
+CONFIG_PATH=/path/to/config.jsonc npm run config:create
+
+# Save to a specific directory (will append .mongodb-lens.jsonc to the path)
+CONFIG_PATH=/path/to/directory npm run config:create
+
+# Save as JSON without comments
+CONFIG_PATH=/path/to/config.json npm run config:create
+```
+
+The script handles paths intelligently:
+
+- If `CONFIG_PATH` has no file extension, it's treated as a directory and `.mongodb-lens.jsonc` is appended
+- If `CONFIG_PATH` ends with `.json` (not `.jsonc`), comments are automatically stripped from the output
+
+### Configuration: Multiple MongoDB Connections
+
+MongoDB Lens supports multiple MongoDB URIs with aliases in your [config file](#configuration-config-file), allowing you to easily switch between different MongoDB instances using simple names.
+
+To configure multiple connections, set the `mongoUri` config setting to an object with alias-URI pairs:
+
+```json
+{
+  "mongoUri": {
+    "main": "mongodb://localhost:27017",
+    "backup": "mongodb://localhost:27018",
+    "atlas": "mongodb+srv://username:password@cluster.mongodb.net/mydb"
+  }
+}
+```
+
+With this configuration:
+
+- The first URI in the list (e.g. `main`) becomes the default connection at startup
+- You can switch connections using natural language: `"Connect to backup"` or `"Connect to atlas"`
+- The original syntax still works: `"Connect to mongodb://localhost:27018"`
+- The `list-connections` tool shows all available connection aliases
+
+> [!NOTE]<br>
+> When using the command-line argument to specify a connection, you can use either a full MongoDB URI or an alias defined in your configuration file.
+
 ### Configuration: Environment Variable Overrides
 
 MongoDB Lens supports environment variable overrides for configuration settings.
@@ -507,31 +575,26 @@ Example Docker Hub usage:
 docker run --rm -i --network=host --pull=always -e CONFIG_DEFAULTS_QUERY_LIMIT='25' furey/mongodb-lens
 ```
 
-### Configuration: Multiple MongoDB Connections
+### Configuration: Cross-Platform Environment Variables
 
-MongoDB Lens supports defining multiple MongoDB URIs with aliases in your [config file](#configuration-config-file), allowing you to easily switch between different MongoDB instances using simple names.
+For consistent environment variable usage across Windows, macOS, and Linux, consider using `cross-env`:
 
-To configure multiple connections, set the `mongoUri` setting to an object with alias-URI pairs:
+1. Install cross-env globally:<br>
+   ```console
+   # Using NPM
+   npm install -g cross-env
 
-```json
-{
-  "mongoUri": {
-    "main": "mongodb://localhost:27017",
-    "backup": "mongodb://localhost:27018",
-    "atlas": "mongodb+srv://username:password@cluster.mongodb.net/mydb"
-  }
-}
-```
-
-With this configuration:
+   # Using Volta (see: https://volta.sh)
+   volta install cross-env
+   ```
+1. Prefix any NPX or Node.js environment variables in this document's examples:<br>
+   ```console
+   # Example NPX usage with cross-env
+   cross-env CONFIG_DEFAULTS_QUERY_LIMIT='25' npx -y mongodb-lens@latest
 
-- The first URI in the list (e.g. `main`) becomes the default connection at startup
-- You can switch connections using natural language: `"Connect to backup"` or `"Connect to atlas"`
-- The original syntax still works: `"Connect to mongodb://localhost:27018"`
-- The `list-connections` tool shows all available connection aliases
-
-> [!NOTE]<br>
-> When using the command-line argument to specify a connection, you can use either a full MongoDB URI or an alias defined in your configuration file.
+   # Example Node.js usage with cross-env
+   cross-env CONFIG_DEFAULTS_QUERY_LIMIT='25' node mongodb-lens.js
+   ```
 
 ## Client Setup
 
@@ -563,7 +626,7 @@ For each option:
 - Replace `mongodb://your-connection-string` with your MongoDB connection string or omit it to use the default `mongodb://localhost:27017`.
 - To use a custom config file, set [`CONFIG_PATH`](#configuration-config-file) environment variable.
 - To include environment variables:
-  - For NPX or Node add `"env": {}` with key-value pairs, for example:<br>
+  - For NPX or Node.js add `"env": {}` with key-value pairs, for example:<br>
     ```json
     "command": "/path/to/npx",
     "args": [

config-create.js

@@ -0,0 +1,87 @@
+#!/usr/bin/env node
+
+import { join, dirname, extname, resolve } from 'path'
+import stripJsonComments from 'strip-json-comments'
+import { readFile, writeFile } from 'fs/promises'
+import { fileURLToPath } from 'url'
+import { existsSync } from 'fs'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = dirname(__filename)
+
+const run = async () => {
+  const homeDir = process.env.HOME || process.env.USERPROFILE
+
+  let configPath = process.env.CONFIG_PATH || join(homeDir, '.mongodb-lens.jsonc')
+
+  if (!extname(configPath)) configPath = join(configPath, '.mongodb-lens.jsonc')
+
+  if (!configPath.endsWith('.json') && !configPath.endsWith('.jsonc')) {
+    console.error('Error: Configuration file must have .json or .jsonc extension')
+    process.exit(1)
+  }
+
+  configPath = resolve(configPath)
+
+  try {
+    const configContent = await extractConfigFromReadme()
+
+    if (existsSync(configPath)) {
+      const overwrite = process.argv.includes('--force')
+      if (!overwrite) {
+        console.log(`Configuration file already exists at: ${configPath}`)
+        console.log('Use --force to overwrite it.')
+        return
+      }
+      console.log(`Overwriting existing configuration file at: ${configPath}`)
+    }
+
+    let finalContent = configContent
+    if (configPath.endsWith('.json')) finalContent = stripJsonComments(configContent)
+
+    finalContent = finalContent
+      .split('\n')
+      .map(line => line.trimEnd())
+      .join('\n')
+
+    await writeFile(configPath, finalContent, 'utf8')
+    console.log(`Configuration file created successfully at: ${configPath}`)
+  } catch (error) {
+    console.error('Error creating configuration file:', error.message)
+    process.exit(1)
+  }
+}
+
+const extractConfigFromReadme = async () => {
+  try {
+    const possiblePaths = [
+      join(__dirname, 'README.md'),
+      join(__dirname, '..', 'README.md'),
+      join(process.cwd(), 'README.md')
+    ]
+
+    let readmeContent = null
+
+    for (const path of possiblePaths) {
+      if (existsSync(path)) {
+        readmeContent = await readFile(path, 'utf8')
+        console.log(`Found README at: ${path}`)
+        break
+      }
+    }
+
+    if (!readmeContent) throw new Error('README.md not found in expected locations')
+
+    const configRegex = /Example configuration file[\s\S]*?```jsonc\s*([\s\S]*?)```/
+    const match = readmeContent.match(configRegex)
+
+    if (!match || !match[1]) throw new Error('Could not find example configuration in README.md')
+
+    return match[1].trim()
+  } catch (error) {
+    console.error('Error extracting configuration from README:', error.message)
+    throw error
+  }
+}
+
+run()

mongodb-lens.js

@@ -5698,9 +5698,25 @@ const validateDropIndexToken = (collectionName, indexName, token) => {
 const loadConfig = () => {
   let config = { ...defaultConfig }
 
-  const configPath = process.env.CONFIG_PATH || join(process.env.HOME || __dirname, '.mongodb-lens.json')
+  const configPathEnv = process.env.CONFIG_PATH
 
-  if (existsSync(configPath)) {
+  let configPath = null
+  if (configPathEnv) {
+    configPath = configPathEnv
+  } else {
+    const homeDir = process.env.HOME || process.env.USERPROFILE || __dirname
+
+    const jsoncPath = join(homeDir, '.mongodb-lens.jsonc')
+    const jsonPath = join(homeDir, '.mongodb-lens.json')
+
+    if (existsSync(jsoncPath)) {
+      configPath = jsoncPath
+    } else if (existsSync(jsonPath)) {
+      configPath = jsonPath
+    }
+  }
+
+  if (configPath && existsSync(configPath)) {
     try {
       log(`Loading config file: ${configPath}`)
       const fileContent = readFileSync(configPath, 'utf8')