@qp-mongosh/types 0.0.0-dev.3 → 0.0.0-dev.8

package/.eslintignore

@@ -1,2 +1,2 @@
-node_modules
-lib
+node_modules
+lib

package/.eslintrc.js

@@ -1 +1 @@
-module.exports = require('../../config/eslintrc.base');
+module.exports = require('../../config/eslintrc.base');

package/AUTHORS

@@ -1,6 +1,6 @@
-Anna Henningsen <anna@addaleax.net>
-Maurizio Casimirri <maurizio.cas@gmail.com>
-github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
-Michael Rose <michael_rose@gmx.de>
-Alena Khineika <alena.khineika@gmail.com>
-Sergey Petushkov <petushkov.sergey@gmail.com>
+Anna Henningsen <anna@addaleax.net>
+Maurizio Casimirri <maurizio.cas@gmail.com>
+github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
+Michael Rose <michael_rose@gmx.de>
+Alena Khineika <alena.khineika@gmail.com>
+Sergey Petushkov <petushkov.sergey@gmail.com>

package/README.md

@@ -1,11 +1,11 @@
-# `@qp-mongosh/types`
-
-> TODO: description
-
-## Usage
-
-```
-const types = require('@qp-mongosh/types');
-
-// TODO: DEMONSTRATE API
-```
+# `@qp-mongosh/types`
+
+> TODO: description
+
+## Usage
+
+```
+const types = require('@qp-mongosh/types');
+
+// TODO: DEMONSTRATE API
+```

package/package.json

@@ -1,38 +1,38 @@
-{
-  "name": "@qp-mongosh/types",
-  "version": "0.0.0-dev.3",
-  "description": "Types for mongosh internals",
-  "author": "Anna Henningsen <anna.henningsen@mongodb.com>",
-  "homepage": "https://github.com/mongodb-js/mongosh/tree/main/packages/types#readme",
-  "license": "Apache-2.0",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
-  "publishConfig": {
-    "access": "public"
-  },
-  "engines": {
-    "node": ">=12.4.0"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/mongodb-js/mongosh.git"
-  },
-  "scripts": {
-    "check": "npm run lint",
-    "compile-ts": "tsc -p tsconfig.json",
-    "lint": "eslint --report-unused-disable-directives \"./{src,test}/**/*.{js,ts,tsx}\"",
-    "prepublish": "npm run compile-ts",
-    "test": "mocha --timeout 15000 -r ts-node/register \"./src/*.spec.ts\"",
-    "test-ci": "node ../../scripts/run-if-package-requested.js npm test"
-  },
-  "bugs": {
-    "url": "https://github.com/mongodb-js/mongosh/issues"
-  },
-  "mongosh": {
-    "unitTestsOnly": true
-  },
-  "dependencies": {
-    "@mongodb-js/devtools-connect": "^1.2.4",
-    "qp-mongodb": "0.0.0-dev.3"
-  }
-}
+{
+  "name": "@qp-mongosh/types",
+  "version": "0.0.0-dev.8",
+  "description": "Types for mongosh internals",
+  "author": "Anna Henningsen <anna.henningsen@mongodb.com>",
+  "homepage": "https://github.com/mongodb-js/mongosh/tree/main/packages/types#readme",
+  "license": "Apache-2.0",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=12.4.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mongodb-js/mongosh.git"
+  },
+  "scripts": {
+    "check": "npm run lint",
+    "compile-ts": "tsc -p tsconfig.json",
+    "lint": "eslint --report-unused-disable-directives \"./{src,test}/**/*.{js,ts,tsx}\"",
+    "prepublish": "npm run compile-ts",
+    "test": "mocha --timeout 15000 -r ts-node/register \"./src/*.spec.ts\"",
+    "test-ci": "node ../../scripts/run-if-package-requested.js npm test"
+  },
+  "bugs": {
+    "url": "https://github.com/mongodb-js/mongosh/issues"
+  },
+  "mongosh": {
+    "unitTestsOnly": true
+  },
+  "dependencies": {
+    "@mongodb-js/devtools-connect": "^1.2.4",
+    "qp-mongodb": "0.0.0-dev.8"
+  }
+}

package/src/index.spec.ts

@@ -1,69 +1,69 @@
-import { CliUserConfig, CliUserConfigValidator } from './';
-import { expect } from 'chai';
-
-describe('config validation', () => {
-  it('validates config option values', async() => {
-    const { validate } = CliUserConfigValidator as any;
-    expect(await validate('userId', 'foo')).to.equal(null);
-    expect(await validate('telemetryAnonymousId', 'foo')).to.equal(null);
-    expect(await validate('disableGreetingMessage', 'foo')).to.equal(null);
-    expect(await validate('inspectDepth', 'foo')).to.equal('inspectDepth must be a positive integer');
-    expect(await validate('inspectDepth', -1)).to.equal('inspectDepth must be a positive integer');
-    expect(await validate('inspectDepth', 0)).to.equal(null);
-    expect(await validate('inspectDepth', 1)).to.equal(null);
-    expect(await validate('inspectDepth', Infinity)).to.equal(null);
-    expect(await validate('historyLength', 'foo')).to.equal('historyLength must be a positive integer');
-    expect(await validate('historyLength', -1)).to.equal('historyLength must be a positive integer');
-    expect(await validate('historyLength', 0)).to.equal(null);
-    expect(await validate('historyLength', 1)).to.equal(null);
-    expect(await validate('historyLength', Infinity)).to.equal(null);
-    expect(await validate('showStackTraces', 'foo')).to.equal('showStackTraces must be a boolean');
-    expect(await validate('showStackTraces', -1)).to.equal('showStackTraces must be a boolean');
-    expect(await validate('showStackTraces', false)).to.equal(null);
-    expect(await validate('showStackTraces', true)).to.equal(null);
-    expect(await validate('redactHistory', 'foo')).to.equal("redactHistory must be one of 'keep', 'remove', or 'remove-redact'");
-    expect(await validate('redactHistory', -1)).to.equal("redactHistory must be one of 'keep', 'remove', or 'remove-redact'");
-    expect(await validate('redactHistory', false)).to.equal("redactHistory must be one of 'keep', 'remove', or 'remove-redact'");
-    expect(await validate('redactHistory', 'keep')).to.equal(null);
-    expect(await validate('redactHistory', 'remove')).to.equal(null);
-    expect(await validate('redactHistory', 'remove-redact')).to.equal(null);
-    expect(await validate('displayBatchSize', 'foo')).to.equal('displayBatchSize must be a positive integer');
-    expect(await validate('displayBatchSize', -1)).to.equal('displayBatchSize must be a positive integer');
-    expect(await validate('displayBatchSize', 0)).to.equal('displayBatchSize must be a positive integer');
-    expect(await validate('displayBatchSize', 1)).to.equal(null);
-    expect(await validate('displayBatchSize', Infinity)).to.equal(null);
-    expect(await validate('maxTimeMS', 'foo')).to.equal('maxTimeMS must be null or a positive integer');
-    expect(await validate('maxTimeMS', -1)).to.equal('maxTimeMS must be null or a positive integer');
-    expect(await validate('maxTimeMS', 0)).to.equal('maxTimeMS must be null or a positive integer');
-    expect(await validate('maxTimeMS', 1)).to.equal(null);
-    expect(await validate('maxTimeMS', null)).to.equal(null);
-    expect(await validate('enableTelemetry', 'foo')).to.equal('enableTelemetry must be a boolean');
-    expect(await validate('enableTelemetry', -1)).to.equal('enableTelemetry must be a boolean');
-    expect(await validate('enableTelemetry', false)).to.equal(null);
-    expect(await validate('enableTelemetry', true)).to.equal(null);
-    expect(await validate('inspectCompact', 'foo')).to.equal('inspectCompact must be a boolean or a positive integer');
-    expect(await validate('inspectCompact', -1)).to.equal('inspectCompact must be a boolean or a positive integer');
-    expect(await validate('inspectCompact', false)).to.equal(null);
-    expect(await validate('inspectCompact', true)).to.equal(null);
-    expect(await validate('inspectCompact', 32)).to.equal(null);
-    expect(await validate('snippetIndexSourceURLs', 'https://example.com/')).to.equal(null);
-    expect(await validate('snippetIndexSourceURLs', 'foo')).to.equal('snippetIndexSourceURLs must be a ;-separated list of valid URLs');
-    expect(await validate('snippetIndexSourceURLs', 'https://xyz/;foo')).to.equal('snippetIndexSourceURLs must be a ;-separated list of valid URLs');
-    expect(await validate('snippetIndexSourceURLs', ';')).to.equal(null);
-    expect(await validate('snippetIndexSourceURLs', 0)).to.equal('snippetIndexSourceURLs must be a ;-separated list of valid URLs');
-    expect(await validate('snippetRegistryURL', ';')).to.equal('snippetRegistryURL must be a valid URL');
-    expect(await validate('snippetRegistryURL', 'https://registry.npmjs.org')).to.equal(null);
-    expect(await validate('snippetRegistryURL', 0)).to.equal('snippetRegistryURL must be a valid URL');
-    expect(await validate('snippetAutoload', 'foo')).to.equal('snippetAutoload must be a boolean');
-    expect(await validate('snippetAutoload', -1)).to.equal('snippetAutoload must be a boolean');
-    expect(await validate('snippetAutoload', false)).to.equal(null);
-    expect(await validate('snippetAutoload', true)).to.equal(null);
-  });
-
-  it('allows default CliUserConfig values', async() => {
-    const userConfig = new CliUserConfig();
-    for (const key of Object.keys(userConfig) as (keyof CliUserConfig)[]) {
-      expect(await CliUserConfigValidator.validate(key, userConfig[key])).to.equal(null);
-    }
-  });
-});
+import { CliUserConfig, CliUserConfigValidator } from './';
+import { expect } from 'chai';
+
+describe('config validation', () => {
+  it('validates config option values', async() => {
+    const { validate } = CliUserConfigValidator as any;
+    expect(await validate('userId', 'foo')).to.equal(null);
+    expect(await validate('telemetryAnonymousId', 'foo')).to.equal(null);
+    expect(await validate('disableGreetingMessage', 'foo')).to.equal(null);
+    expect(await validate('inspectDepth', 'foo')).to.equal('inspectDepth must be a positive integer');
+    expect(await validate('inspectDepth', -1)).to.equal('inspectDepth must be a positive integer');
+    expect(await validate('inspectDepth', 0)).to.equal(null);
+    expect(await validate('inspectDepth', 1)).to.equal(null);
+    expect(await validate('inspectDepth', Infinity)).to.equal(null);
+    expect(await validate('historyLength', 'foo')).to.equal('historyLength must be a positive integer');
+    expect(await validate('historyLength', -1)).to.equal('historyLength must be a positive integer');
+    expect(await validate('historyLength', 0)).to.equal(null);
+    expect(await validate('historyLength', 1)).to.equal(null);
+    expect(await validate('historyLength', Infinity)).to.equal(null);
+    expect(await validate('showStackTraces', 'foo')).to.equal('showStackTraces must be a boolean');
+    expect(await validate('showStackTraces', -1)).to.equal('showStackTraces must be a boolean');
+    expect(await validate('showStackTraces', false)).to.equal(null);
+    expect(await validate('showStackTraces', true)).to.equal(null);
+    expect(await validate('redactHistory', 'foo')).to.equal("redactHistory must be one of 'keep', 'remove', or 'remove-redact'");
+    expect(await validate('redactHistory', -1)).to.equal("redactHistory must be one of 'keep', 'remove', or 'remove-redact'");
+    expect(await validate('redactHistory', false)).to.equal("redactHistory must be one of 'keep', 'remove', or 'remove-redact'");
+    expect(await validate('redactHistory', 'keep')).to.equal(null);
+    expect(await validate('redactHistory', 'remove')).to.equal(null);
+    expect(await validate('redactHistory', 'remove-redact')).to.equal(null);
+    expect(await validate('displayBatchSize', 'foo')).to.equal('displayBatchSize must be a positive integer');
+    expect(await validate('displayBatchSize', -1)).to.equal('displayBatchSize must be a positive integer');
+    expect(await validate('displayBatchSize', 0)).to.equal('displayBatchSize must be a positive integer');
+    expect(await validate('displayBatchSize', 1)).to.equal(null);
+    expect(await validate('displayBatchSize', Infinity)).to.equal(null);
+    expect(await validate('maxTimeMS', 'foo')).to.equal('maxTimeMS must be null or a positive integer');
+    expect(await validate('maxTimeMS', -1)).to.equal('maxTimeMS must be null or a positive integer');
+    expect(await validate('maxTimeMS', 0)).to.equal('maxTimeMS must be null or a positive integer');
+    expect(await validate('maxTimeMS', 1)).to.equal(null);
+    expect(await validate('maxTimeMS', null)).to.equal(null);
+    expect(await validate('enableTelemetry', 'foo')).to.equal('enableTelemetry must be a boolean');
+    expect(await validate('enableTelemetry', -1)).to.equal('enableTelemetry must be a boolean');
+    expect(await validate('enableTelemetry', false)).to.equal(null);
+    expect(await validate('enableTelemetry', true)).to.equal(null);
+    expect(await validate('inspectCompact', 'foo')).to.equal('inspectCompact must be a boolean or a positive integer');
+    expect(await validate('inspectCompact', -1)).to.equal('inspectCompact must be a boolean or a positive integer');
+    expect(await validate('inspectCompact', false)).to.equal(null);
+    expect(await validate('inspectCompact', true)).to.equal(null);
+    expect(await validate('inspectCompact', 32)).to.equal(null);
+    expect(await validate('snippetIndexSourceURLs', 'https://example.com/')).to.equal(null);
+    expect(await validate('snippetIndexSourceURLs', 'foo')).to.equal('snippetIndexSourceURLs must be a ;-separated list of valid URLs');
+    expect(await validate('snippetIndexSourceURLs', 'https://xyz/;foo')).to.equal('snippetIndexSourceURLs must be a ;-separated list of valid URLs');
+    expect(await validate('snippetIndexSourceURLs', ';')).to.equal(null);
+    expect(await validate('snippetIndexSourceURLs', 0)).to.equal('snippetIndexSourceURLs must be a ;-separated list of valid URLs');
+    expect(await validate('snippetRegistryURL', ';')).to.equal('snippetRegistryURL must be a valid URL');
+    expect(await validate('snippetRegistryURL', 'https://registry.npmjs.org')).to.equal(null);
+    expect(await validate('snippetRegistryURL', 0)).to.equal('snippetRegistryURL must be a valid URL');
+    expect(await validate('snippetAutoload', 'foo')).to.equal('snippetAutoload must be a boolean');
+    expect(await validate('snippetAutoload', -1)).to.equal('snippetAutoload must be a boolean');
+    expect(await validate('snippetAutoload', false)).to.equal(null);
+    expect(await validate('snippetAutoload', true)).to.equal(null);
+  });
+
+  it('allows default CliUserConfig values', async() => {
+    const userConfig = new CliUserConfig();
+    for (const key of Object.keys(userConfig) as (keyof CliUserConfig)[]) {
+      expect(await CliUserConfigValidator.validate(key, userConfig[key])).to.equal(null);
+    }
+  });
+});