chore: add full flatOptions snapshot test (#6508)

Author: lukekarrys

tap-snapshots/test/lib/docs.js.test.cjs

@@ -2027,6 +2027,128 @@ Array [
 ]
 `
 
+exports[`test/lib/docs.js TAP flat options > full flat options object 1`] = `
+Object {
+  "_auth": null,
+  "access": null,
+  "all": false,
+  "allowSameVersion": false,
+  "audit": true,
+  "auditLevel": null,
+  "authType": "web",
+  "before": null,
+  "binLinks": true,
+  "browser": null,
+  "ca": null,
+  "cache": "{CWD}/cache/_cacache",
+  "call": "",
+  "cert": null,
+  "cidr": null,
+  "ciName": "{ci}",
+  "color": false,
+  "commitHooks": true,
+  "defaultTag": "latest",
+  "depth": null,
+  "diff": Array [],
+  "diffDstPrefix": "b/",
+  "diffIgnoreAllSpace": false,
+  "diffNameOnly": false,
+  "diffNoPrefix": false,
+  "diffSrcPrefix": "a/",
+  "diffText": false,
+  "diffUnified": 3,
+  "dryRun": false,
+  "editor": "{EDITOR}",
+  "engineStrict": false,
+  "force": false,
+  "foregroundScripts": false,
+  "formatPackageLock": true,
+  "fund": true,
+  "git": "git",
+  "gitTagVersion": true,
+  "global": false,
+  "globalconfig": "{CWD}/global/etc/npmrc",
+  "hashAlgorithm": "sha1",
+  "heading": "npm",
+  "httpsProxy": null,
+  "ifPresent": false,
+  "ignoreScripts": false,
+  "includeStaged": false,
+  "includeWorkspaceRoot": false,
+  "installLinks": false,
+  "installStrategy": "hoisted",
+  "json": false,
+  "key": null,
+  "legacyPeerDeps": false,
+  "localAddress": null,
+  "location": "user",
+  "lockfileVersion": null,
+  "logColor": false,
+  "maxSockets": 15,
+  "message": "%s",
+  "nodeBin": "{NODE}",
+  "nodeVersion": "2.2.2",
+  "noProxy": "",
+  "npmBin": "{CWD}/{TESTDIR}/docs.js",
+  "npmCommand": "version",
+  "npmVersion": "1.1.1",
+  "npxCache": "{CWD}/cache/_npx",
+  "offline": false,
+  "omit": Array [],
+  "omitLockfileRegistryResolved": false,
+  "otp": null,
+  "package": Array [],
+  "packageLock": true,
+  "packageLockOnly": false,
+  "packDestination": ".",
+  "parseable": false,
+  "preferDedupe": false,
+  "preferOffline": false,
+  "preferOnline": false,
+  "preid": "",
+  "progress": false,
+  "projectScope": "",
+  "provenance": false,
+  "proxy": null,
+  "readOnly": false,
+  "rebuildBundle": true,
+  "registry": "https://registry.npmjs.org/",
+  "replaceRegistryHost": "npmjs",
+  "retry": Object {
+    "factor": 10,
+    "maxTimeout": 60000,
+    "minTimeout": 10000,
+    "retries": 0,
+  },
+  "save": true,
+  "saveBundle": false,
+  "savePrefix": "^",
+  "scope": "",
+  "scriptShell": undefined,
+  "search": Object {
+    "description": true,
+    "exclude": "",
+    "limit": 20,
+    "opts": Null Object {},
+    "staleness": 900,
+  },
+  "shell": "{SHELL}",
+  "signGitCommit": false,
+  "signGitTag": false,
+  "silent": false,
+  "strictPeerDeps": false,
+  "strictSSL": true,
+  "tagVersionPrefix": "v",
+  "timeout": 300000,
+  "tufCache": "{CWD}/cache/_tuf",
+  "umask": 0,
+  "unicode": false,
+  "userAgent": "npm/1.1.1 node/2.2.2 {PLATFORM} {ARCH} workspaces/false ci/{ci}",
+  "workspacesEnabled": true,
+  "workspacesUpdate": true,
+}
+`
+
 exports[`test/lib/docs.js TAP shorthands > docs 1`] = `
 * \`-a\`: \`--all\`
 * \`--enjoy-by\`: \`--before\`

test/lib/docs.js

@@ -8,6 +8,7 @@ const { load: loadMockNpm } = require('../fixtures/mock-npm.js')
 const { definitions } = require('../../lib/utils/config/index.js')
 const cmdList = require('../../lib/utils/cmd-list.js')
 const pkg = require('../../package.json')
+const { cleanCwd } = require('../fixtures/clean-snapshot.js')
 
 t.test('command list', async t => {
   for (const [key, value] of Object.entries(cmdList)) {
@@ -29,6 +30,31 @@ t.test('config', async t => {
   t.matchSnapshot(docs.config(docs.TAGS.CONFIG, {}), 'all definitions')
 })
 
+t.test('flat options', async t => {
+  t.cleanSnapshot = (s) => cleanCwd(s)
+    .split(cleanCwd(process.execPath)).join('{NODE}')
+
+  const { npm } = await loadMockNpm(t, {
+    command: 'version',
+    exec: true,
+    globals: {
+      'process.env': {
+        EDITOR: '{EDITOR}',
+        SHELL: '{SHELL}',
+      },
+      'process.version': '2.2.2',
+      'process.platform': '{PLATFORM}',
+      'process.arch': '{ARCH}',
+    },
+    mocks: {
+      'ci-info': { name: '{CI}' },
+      '{ROOT}/package.json': { version: '1.1.1' },
+    },
+  })
+
+  t.matchSnapshot(npm.flatOptions, 'full flat options object')
+})
+
 t.test('basic usage', async t => {
   // snapshot basic usage without commands since all the command snapshots
   // are generated in the following test