From 827a7a1081244443cfa82b55fc61557e02693de4 Mon Sep 17 00:00:00 2001 From: Alena Khineika Date: Wed, 1 Jul 2020 18:19:43 +0200 Subject: [PATCH] fix: limit docs for out preview --- .github/ISSUE_TEMPLATE/bug_report.md | 14 ++++++++++---- .github/ISSUE_TEMPLATE/feature_request.md | 5 ++++- .github/ISSUE_TEMPLATE/question.md | 4 +++- package-lock.json | 6 +++--- package.json | 2 +- src/app/loading/loading.js | 1 + src/app/setup-plugin-manager.js | 5 +++++ src/app/setup-style-manager.js | 2 ++ src/main/index.js | 3 +++ src/main/window-manager.js | 2 +- 10 files changed, 33 insertions(+), 11 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index f3d5babfd74..bb1853aae61 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -13,25 +13,31 @@ https://jira.mongodb.org/projects/COMPASS/summary ## Bug Report #### Current Behavior + #### Code/Gist + +#### Expected Behavior/Code -#### Expected behavior/code #### Environment + + - node.js / npm versions: -- OS: +- OS: #### Possible Solution + -#### Additional context/Screenshots -> +#### Additional Context/Screenshots + + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index ae5352638f3..2323af0b96f 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -14,10 +14,13 @@ https://jira.mongodb.org/projects/COMPASS/summary ## Feature Request ## Detailed Description + ## Context + ## Possible Implementation -> + + diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md index 231c0c95266..fc3221e294c 100644 --- a/.github/ISSUE_TEMPLATE/question.md +++ b/.github/ISSUE_TEMPLATE/question.md @@ -1,5 +1,5 @@ --- -name: Bug Report +name: Question about: Create a report to help us improve title: Question --- @@ -7,7 +7,9 @@ title: Question ## Question + ## Additional context + diff --git a/package-lock.json b/package-lock.json index 639987114b1..69fe6f879dc 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1360,9 +1360,9 @@ "integrity": "sha512-Es6WcD0nO5l+2BOQS4uLfNPYQaNDfbot3X1XUoloz+x0mPDS3eeORZJl06HXjwBG1fOGwCRnzK88LMdxKRrd6Q==" }, "@mongodb-js/compass-aggregations": { - "version": "7.1.3", - "resolved": "https://registry.npmjs.org/@mongodb-js/compass-aggregations/-/compass-aggregations-7.1.3.tgz", - "integrity": "sha512-UmlmQFS+UZx2zzpjr5c+lYuJJ3n4sCel+V7+UumuIom/A9fbTA7jKWN+x3pxRFa9Rkx2ig6x2H6u09CMorurGg==", + "version": "7.1.4", + "resolved": "https://registry.npmjs.org/@mongodb-js/compass-aggregations/-/compass-aggregations-7.1.4.tgz", + "integrity": "sha512-dmfxnOHMD6y8bQ4SS6kAJJXbVNBNV8YHSL1gboDZ8Mh+QG6U4BneKSONUX482a3OaE6tXYtEyW6y8OcvhqHVoQ==", "requires": { "bson": "^4.0.2", "decomment": "^0.9.2", diff --git a/package.json b/package.json index 4f27749a2ab..674ae266718 100644 --- a/package.json +++ b/package.json @@ -290,7 +290,7 @@ "url": "git://github.com/mongodb-js/compass.git" }, "dependencies": { - "@mongodb-js/compass-aggregations": "^7.1.3", + "@mongodb-js/compass-aggregations": "^7.1.4", "@mongodb-js/compass-app-stores": "^4.0.2", "@mongodb-js/compass-auth-kerberos": "^4.0.1", "@mongodb-js/compass-auth-ldap": "^4.0.1", diff --git a/src/app/loading/loading.js b/src/app/loading/loading.js index d4a977fb621..e8827aca1e1 100644 --- a/src/app/loading/loading.js +++ b/src/app/loading/loading.js @@ -26,6 +26,7 @@ ipc.on(CHANGE_STATUS, (evt, meta) => { }); ipc.on('compass:error:fatal', (evt, meta) => { + // eslint-disable-next-line no-console console.error(meta.stack); }); diff --git a/src/app/setup-plugin-manager.js b/src/app/setup-plugin-manager.js index c607376d49b..31ec57b0cb4 100644 --- a/src/app/setup-plugin-manager.js +++ b/src/app/setup-plugin-manager.js @@ -67,6 +67,11 @@ const ILLEGAL_MODULES = ['fs', 'net', 'tls', 'child_process']; /** * Prevent loading of fs, net, tls, and child process for 3rd party plugins. + * + * @param {String} request - The request. + * @param {Object} loc - The location. + * + * @returns {Function} */ Module._load = function(request, loc) { if (ILLEGAL_MODULES.includes(request)) { diff --git a/src/app/setup-style-manager.js b/src/app/setup-style-manager.js index 1bcfab4b2f4..1aa73aeed29 100644 --- a/src/app/setup-style-manager.js +++ b/src/app/setup-style-manager.js @@ -67,6 +67,8 @@ const setup = (stylesheet, done) => { try { const styles = document.createElement(STYLE); const loc = path.join(DEV_PLUGINS, file, 'lib', 'styles', 'index.css'); + + // eslint-disable-next-line no-sync styles.textContent = fs.readFileSync(loc, { encoding: 'utf8' }); document.head.appendChild(styles); } catch (e) { diff --git a/src/main/index.js b/src/main/index.js index 960657a2db4..44727be237d 100644 --- a/src/main/index.js +++ b/src/main/index.js @@ -25,6 +25,7 @@ const cleanStack = require('clean-stack'); const ensureError = require('ensure-error'); process.on('uncaughtException', err => { + // eslint-disable-next-line no-console console.error('handling uncaughtException', err); err = ensureError(err); const stack = cleanStack(err.stack); @@ -32,6 +33,8 @@ process.on('uncaughtException', err => { var detail = '${app.getName()} version ${app.getVersion()}\n'; detail += `Stacktrace:\n${stack}`; const message = `${app.getName()} has encountered an unexpected error`; + + // eslint-disable-next-line no-console console.error(`${message}: ${detail}`); const btnIndex = dialog.showMessageBox({ diff --git a/src/main/window-manager.js b/src/main/window-manager.js index 6a4f0bda29b..9de8340963b 100644 --- a/src/main/window-manager.js +++ b/src/main/window-manager.js @@ -317,7 +317,7 @@ function showAboutDialog() { } /** - * @param {Object} bw - Current BrowserWindow + * @param {Object} _bw - Current BrowserWindow * @param {String} message - Message to be set by MessageBox * @param {String} detail - Details to be shown in MessageBox */