Skip to content

Commit a787304

Browse files
lerouxblerouxb
authored
feat: add mongodb-ts-autocomplete package MONGOSH-2034 (#520)
* add mongodb-ts-autocomplete * comment * unnecessary slashes * undo the typescript bump, do it separately * simplify partially * smaller package-lock * lint * flatten some dirs for now * I think the bson expressions would just be global and not namespaced * add missing lodash dep * comment * at least structure the files as they will end up * the simplest aggregation test * formatting * remove the aggregation support for now * include the real bson types * fixes to debugging * don't use namespaces, remove hacks, just allow import * wip * combine the types into one module that just exports strings * stale comment * use the bson types in the generated typescript * we'll also need a way to load the databases for the connection * export types * we'll always want the whole new line, not just the name that was autocompleted * changes that become obvious once I tried to plug this in * remove use * remove the ability to autocomplete in the middle of text * remove type from the result - we won't use it * unused * better types * readonly * object, not tuple * formatting * switch, remove pointless functions * switch statement * nit * cleaner * remove unnecessary databaseNames and collectionNames * prettier * use type-export from mongodb-schema * have index.ts only re-export * unused dep * format schema and construct the db object to work the way the shell-api expects * more tests * bson expressions are part of shell-api.ts, not separate * don't include DOM and other types * remove unused stubs * remove some TODOs * move the autocompletion filtering to the mongodb-ts-autocomplete package * add the other globals * import a file with the giant string * update package-lock.json * fixes for changes in shell-api * change import to api, not default * use the real @mongosh/shell-api * escape database and collection names, test it * re-package * don't check formatting of the generated file * don't include shell-api.ts twice * no need to check it in * extract types before compiling
1 parent 378ad8b commit a787304

22 files changed

+23165
-18147
lines changed

‎.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,5 @@ coverage
2828
env-vars.sh
2929
mongocryptd.pid
3030
mongodb-csfle
31-
.esm-wrapper.mjs
31+
.esm-wrapper.mjs
32+
packages/mongodb-ts-autocomplete/src/fixtures/autocomplete-types.ts

‎package-lock.json

Lines changed: 22026 additions & 18066 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎packages/mongodb-ts-autocomplete/.depcheckrc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
ignores:
2+
- '@mongodb-js/prettier-config-devtools'
3+
- '@mongodb-js/tsconfig-devtools'
4+
- '@types/chai'
5+
- '@types/sinon-chai'
6+
- 'sinon'
7+
ignore-patterns:
8+
- 'dist'

‎packages/mongodb-ts-autocomplete/.eslintignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.nyc-output
2+
dist

‎packages/mongodb-ts-autocomplete/.eslintrc.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
module.exports = {
2+
root: true,
3+
extends: ['@mongodb-js/eslint-config-devtools'],
4+
parserOptions: {
5+
tsconfigRootDir: __dirname,
6+
project: ['./tsconfig-lint.json'],
7+
},
8+
};

‎packages/mongodb-ts-autocomplete/.mocharc.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
module.exports = require('@mongodb-js/mocha-config-devtools');

‎packages/mongodb-ts-autocomplete/.prettierignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
.nyc_output
2+
dist
3+
coverage
4+
src/fixtures/autocomplete-types.ts

‎packages/mongodb-ts-autocomplete/.prettierrc.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"@mongodb-js/prettier-config-devtools"

‎packages/mongodb-ts-autocomplete/LICENSE

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright {yyyy} {name of copyright owner}
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎packages/mongodb-ts-autocomplete/package.json

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
{
2+
"name": "@mongodb-js/mongodb-ts-autocomplete",
3+
"description": "Provide MongoDB-specific autocompletion support",
4+
"author": {
5+
"name": "MongoDB Inc",
6+
"email": "[email protected]"
7+
},
8+
"publishConfig": {
9+
"access": "public"
10+
},
11+
"bugs": {
12+
"url": "https://jira.mongodb.org/projects/COMPASS/issues",
13+
"email": "[email protected]"
14+
},
15+
"homepage": "https://github.com/mongodb-js/devtools-shared",
16+
"version": "0.1.0",
17+
"repository": {
18+
"type": "git",
19+
"url": "https://github.com/mongodb-js/devtools-shared.git"
20+
},
21+
"files": [
22+
"dist"
23+
],
24+
"license": "Apache-2.0",
25+
"main": "dist/index.js",
26+
"exports": {
27+
"require": "./dist/index.js",
28+
"import": "./dist/.esm-wrapper.mjs"
29+
},
30+
"types": "./dist/index.d.ts",
31+
"scripts": {
32+
"bootstrap": "npm run compile",
33+
"prepublishOnly": "npm run compile",
34+
"compile": "npm run extract-types && tsc -p tsconfig.json && gen-esm-wrapper . ./dist/.esm-wrapper.mjs",
35+
"typecheck": "tsc --noEmit",
36+
"eslint": "eslint",
37+
"prettier": "prettier",
38+
"lint": "npm run eslint . && npm run prettier -- --check .",
39+
"depcheck": "depcheck",
40+
"check": "npm run typecheck && npm run lint && npm run depcheck",
41+
"check-ci": "npm run check",
42+
"test": "mocha",
43+
"test-cov": "nyc -x \"**/*.spec.*\" --reporter=lcov --reporter=text --reporter=html npm run test",
44+
"test-watch": "npm run test -- --watch",
45+
"test-ci": "npm run test-cov",
46+
"reformat": "npm run prettier -- --write .",
47+
"extract-types": "ts-node scripts/extract-types.ts"
48+
},
49+
"devDependencies": {
50+
"@mongodb-js/eslint-config-devtools": "0.9.11",
51+
"@mongodb-js/mocha-config-devtools": "^1.0.4",
52+
"@mongodb-js/prettier-config-devtools": "^1.0.1",
53+
"@mongodb-js/tsconfig-devtools": "^1.0.2",
54+
"@mongodb-js/ts-autocomplete": "^0.2.0",
55+
"@mongosh/shell-api": "^3.11.0",
56+
"@types/chai": "^4.2.21",
57+
"@types/mocha": "^9.1.1",
58+
"@types/node": "^17.0.35",
59+
"@types/sinon-chai": "^3.2.5",
60+
"bson": "^6.8.0",
61+
"chai": "^4.3.6",
62+
"depcheck": "^1.4.1",
63+
"eslint": "^7.25.0",
64+
"gen-esm-wrapper": "^1.1.1",
65+
"mocha": "^8.4.0",
66+
"mongodb-schema": "^12.6.2",
67+
"node-cache": "^5.1.2",
68+
"nyc": "^15.1.0",
69+
"prettier": "^3.5.3",
70+
"sinon": "^9.2.3",
71+
"ts-node": "^10.9.2",
72+
"typescript": "^5.0.4"
73+
}
74+
}

‎packages/mongodb-ts-autocomplete/scripts/extract-types.ts

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
/* eslint-disable no-console */
2+
import { promises as fs } from 'fs';
3+
import path from 'path';
4+
import { api as ShellApiText } from '@mongosh/shell-api/api';
5+
6+
function replaceImports(code: string) {
7+
// This just makes it possible to work on mql.ts because then the
8+
// IDE finds the import.
9+
return code.replace(/'bson'/g, "'/bson.ts'");
10+
}
11+
12+
async function loadSources(sources: Record<string, string>) {
13+
const result: Record<string, string> = {};
14+
15+
for (const [key, filepath] of Object.entries(sources)) {
16+
result[key] = replaceImports(await fs.readFile(filepath, 'utf8'));
17+
}
18+
19+
return result;
20+
}
21+
22+
async function run() {
23+
const input: Record<string, string> = {
24+
'/bson.ts': path.join(require.resolve('bson'), '..', '..', 'bson.d.ts'),
25+
'/mql.ts': path.join(__dirname, '..', 'src', 'fixtures', 'mql.ts'),
26+
};
27+
const files = await loadSources(input);
28+
files['/shell-api.ts'] = replaceImports(ShellApiText);
29+
const code = `
30+
const files = ${JSON.stringify(files)};
31+
export default files;
32+
`;
33+
34+
const filepath = path.join(
35+
__dirname,
36+
'..',
37+
'src',
38+
'fixtures',
39+
'autocomplete-types.ts',
40+
);
41+
await fs.writeFile(filepath, code, 'utf-8');
42+
}
43+
44+
run()
45+
.then(() => {
46+
console.log('done');
47+
})
48+
.catch((err: Error) => {
49+
console.error(err.stack);
50+
process.exitCode = 1;
51+
});

0 commit comments

Comments
 (0)