diff --git a/package-lock.json b/package-lock.json index 76588448..8bff90a7 100644 --- a/package-lock.json +++ b/package-lock.json @@ -5907,6 +5907,10 @@ "node": ">=0.10.0" } }, + "node_modules/@mongodb-js/ts-autocomplete": { + "resolved": "packages/ts-autocomplete", + "link": true + }, "node_modules/@mongodb-js/tsconfig-devtools": { "resolved": "configs/tsconfig-devtools", "link": true @@ -27918,6 +27922,44 @@ "node": ">=14.17" } }, + "packages/ts-autocomplete": { + "name": "@mongodb-js/ts-autocomplete", + "version": "0.1.0", + "license": "Apache-2.0", + "devDependencies": { + "@mongodb-js/eslint-config-devtools": "0.9.10", + "@mongodb-js/mocha-config-devtools": "^1.0.4", + "@mongodb-js/prettier-config-devtools": "^1.0.1", + "@mongodb-js/tsconfig-devtools": "^1.0.2", + "@types/chai": "^4.2.21", + "@types/mocha": "^9.1.1", + "@types/sinon-chai": "^3.2.5", + "chai": "^4.3.6", + "debug": "^4.3.6", + "depcheck": "^1.4.1", + "eslint": "^7.25.0", + "gen-esm-wrapper": "^1.1.1", + "mocha": "^8.4.0", + "nyc": "^15.1.0", + "prettier": "^2.3.2", + "sinon": "^9.2.3", + "typescript": "^5.0.4" + } + }, + "packages/ts-autocomplete/node_modules/typescript": { + "version": "5.8.2", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.8.2.tgz", + "integrity": "sha512-aJn6wq13/afZp/jT9QZmwEjDqqvSGp1VT5GVg+f/t6/oVyrgXM6BY1h9BRh/O5p3PlUPAe+WuiEZOmb/49RqoQ==", + "dev": true, + "license": "Apache-2.0", + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=14.17" + } + }, "scripts": { "name": "@mongodb-js/devtools-scripts", "version": "0.2.16", @@ -33944,6 +33986,36 @@ "ip-address": "^9.0.5" } }, + "@mongodb-js/ts-autocomplete": { + "version": "file:packages/ts-autocomplete", + "requires": { + "@mongodb-js/eslint-config-devtools": "0.9.10", + "@mongodb-js/mocha-config-devtools": "^1.0.4", + "@mongodb-js/prettier-config-devtools": "^1.0.1", + "@mongodb-js/tsconfig-devtools": "^1.0.2", + "@types/chai": "^4.2.21", + "@types/mocha": "^9.1.1", + "@types/sinon-chai": "^3.2.5", + "chai": "^4.3.6", + "debug": "^4.3.6", + "depcheck": "^1.4.1", + "eslint": "^7.25.0", + "gen-esm-wrapper": "^1.1.1", + "mocha": "^8.4.0", + "nyc": "^15.1.0", + "prettier": "^2.3.2", + "sinon": "^9.2.3", + "typescript": "^5.0.4" + }, + "dependencies": { + "typescript": { + "version": "5.8.2", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.8.2.tgz", + "integrity": "sha512-aJn6wq13/afZp/jT9QZmwEjDqqvSGp1VT5GVg+f/t6/oVyrgXM6BY1h9BRh/O5p3PlUPAe+WuiEZOmb/49RqoQ==", + "dev": true + } + } + }, "@mongodb-js/tsconfig-devtools": { "version": "file:configs/tsconfig-devtools", "requires": { diff --git a/packages/ts-autocomplete/.depcheckrc b/packages/ts-autocomplete/.depcheckrc new file mode 100644 index 00000000..48bf9af6 --- /dev/null +++ b/packages/ts-autocomplete/.depcheckrc @@ -0,0 +1,8 @@ +ignores: + - '@mongodb-js/prettier-config-devtools' + - '@mongodb-js/tsconfig-devtools' + - '@types/chai' + - '@types/sinon-chai' + - 'sinon' +ignore-patterns: + - 'dist' diff --git a/packages/ts-autocomplete/.eslintignore b/packages/ts-autocomplete/.eslintignore new file mode 100644 index 00000000..85a8a75e --- /dev/null +++ b/packages/ts-autocomplete/.eslintignore @@ -0,0 +1,2 @@ +.nyc-output +dist diff --git a/packages/ts-autocomplete/.eslintrc.js b/packages/ts-autocomplete/.eslintrc.js new file mode 100644 index 00000000..83296d73 --- /dev/null +++ b/packages/ts-autocomplete/.eslintrc.js @@ -0,0 +1,8 @@ +module.exports = { + root: true, + extends: ['@mongodb-js/eslint-config-devtools'], + parserOptions: { + tsconfigRootDir: __dirname, + project: ['./tsconfig-lint.json'], + }, +}; diff --git a/packages/ts-autocomplete/.mocharc.js b/packages/ts-autocomplete/.mocharc.js new file mode 100644 index 00000000..64afeb1f --- /dev/null +++ b/packages/ts-autocomplete/.mocharc.js @@ -0,0 +1 @@ +module.exports = require('@mongodb-js/mocha-config-devtools'); diff --git a/packages/ts-autocomplete/.prettierignore b/packages/ts-autocomplete/.prettierignore new file mode 100644 index 00000000..4d28df66 --- /dev/null +++ b/packages/ts-autocomplete/.prettierignore @@ -0,0 +1,3 @@ +.nyc_output +dist +coverage diff --git a/packages/ts-autocomplete/.prettierrc.json b/packages/ts-autocomplete/.prettierrc.json new file mode 100644 index 00000000..dfae21d0 --- /dev/null +++ b/packages/ts-autocomplete/.prettierrc.json @@ -0,0 +1 @@ +"@mongodb-js/prettier-config-devtools" diff --git a/packages/ts-autocomplete/LICENSE b/packages/ts-autocomplete/LICENSE new file mode 100644 index 00000000..5e0fd33c --- /dev/null +++ b/packages/ts-autocomplete/LICENSE @@ -0,0 +1,201 @@ +Apache License +Version 2.0, January 2004 +http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + +"License" shall mean the terms and conditions for use, reproduction, +and distribution as defined by Sections 1 through 9 of this document. + +"Licensor" shall mean the copyright owner or entity authorized by +the copyright owner that is granting the License. + +"Legal Entity" shall mean the union of the acting entity and all +other entities that control, are controlled by, or are under common +control with that entity. For the purposes of this definition, +"control" means (i) the power, direct or indirect, to cause the +direction or management of such entity, whether by contract or +otherwise, or (ii) ownership of fifty percent (50%) or more of the +outstanding shares, or (iii) beneficial ownership of such entity. + +"You" (or "Your") shall mean an individual or Legal Entity +exercising permissions granted by this License. + +"Source" form shall mean the preferred form for making modifications, +including but not limited to software source code, documentation +source, and configuration files. + +"Object" form shall mean any form resulting from mechanical +transformation or translation of a Source form, including but +not limited to compiled object code, generated documentation, +and conversions to other media types. + +"Work" shall mean the work of authorship, whether in Source or +Object form, made available under the License, as indicated by a +copyright notice that is included in or attached to the work +(an example is provided in the Appendix below). + +"Derivative Works" shall mean any work, whether in Source or Object +form, that is based on (or derived from) the Work and for which the +editorial revisions, annotations, elaborations, or other modifications +represent, as a whole, an original work of authorship. For the purposes +of this License, Derivative Works shall not include works that remain +separable from, or merely link (or bind by name) to the interfaces of, +the Work and Derivative Works thereof. + +"Contribution" shall mean any work of authorship, including +the original version of the Work and any modifications or additions +to that Work or Derivative Works thereof, that is intentionally +submitted to Licensor for inclusion in the Work by the copyright owner +or by an individual or Legal Entity authorized to submit on behalf of +the copyright owner. For the purposes of this definition, "submitted" +means any form of electronic, verbal, or written communication sent +to the Licensor or its representatives, including but not limited to +communication on electronic mailing lists, source code control systems, +and issue tracking systems that are managed by, or on behalf of, the +Licensor for the purpose of discussing and improving the Work, but +excluding communication that is conspicuously marked or otherwise +designated in writing by the copyright owner as "Not a Contribution." + +"Contributor" shall mean Licensor and any individual or Legal Entity +on behalf of whom a Contribution has been received by Licensor and +subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of +this License, each Contributor hereby grants to You a perpetual, +worldwide, non-exclusive, no-charge, royalty-free, irrevocable +copyright license to reproduce, prepare Derivative Works of, +publicly display, publicly perform, sublicense, and distribute the +Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of +this License, each Contributor hereby grants to You a perpetual, +worldwide, non-exclusive, no-charge, royalty-free, irrevocable +(except as stated in this section) patent license to make, have made, +use, offer to sell, sell, import, and otherwise transfer the Work, +where such license applies only to those patent claims licensable +by such Contributor that are necessarily infringed by their +Contribution(s) alone or by combination of their Contribution(s) +with the Work to which such Contribution(s) was submitted. If You +institute patent litigation against any entity (including a +cross-claim or counterclaim in a lawsuit) alleging that the Work +or a Contribution incorporated within the Work constitutes direct +or contributory patent infringement, then any patent licenses +granted to You under this License for that Work shall terminate +as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the +Work or Derivative Works thereof in any medium, with or without +modifications, and in Source or Object form, provided that You +meet the following conditions: + +(a) You must give any other recipients of the Work or +Derivative Works a copy of this License; and + +(b) You must cause any modified files to carry prominent notices +stating that You changed the files; and + +(c) You must retain, in the Source form of any Derivative Works +that You distribute, all copyright, patent, trademark, and +attribution notices from the Source form of the Work, +excluding those notices that do not pertain to any part of +the Derivative Works; and + +(d) If the Work includes a "NOTICE" text file as part of its +distribution, then any Derivative Works that You distribute must +include a readable copy of the attribution notices contained +within such NOTICE file, excluding those notices that do not +pertain to any part of the Derivative Works, in at least one +of the following places: within a NOTICE text file distributed +as part of the Derivative Works; within the Source form or +documentation, if provided along with the Derivative Works; or, +within a display generated by the Derivative Works, if and +wherever such third-party notices normally appear. The contents +of the NOTICE file are for informational purposes only and +do not modify the License. You may add Your own attribution +notices within Derivative Works that You distribute, alongside +or as an addendum to the NOTICE text from the Work, provided +that such additional attribution notices cannot be construed +as modifying the License. + +You may add Your own copyright statement to Your modifications and +may provide additional or different license terms and conditions +for use, reproduction, or distribution of Your modifications, or +for any such Derivative Works as a whole, provided Your use, +reproduction, and distribution of the Work otherwise complies with +the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, +any Contribution intentionally submitted for inclusion in the Work +by You to the Licensor shall be under the terms and conditions of +this License, without any additional terms or conditions. +Notwithstanding the above, nothing herein shall supersede or modify +the terms of any separate license agreement you may have executed +with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade +names, trademarks, service marks, or product names of the Licensor, +except as required for reasonable and customary use in describing the +origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or +agreed to in writing, Licensor provides the Work (and each +Contributor provides its Contributions) on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +implied, including, without limitation, any warranties or conditions +of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A +PARTICULAR PURPOSE. You are solely responsible for determining the +appropriateness of using or redistributing the Work and assume any +risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, +whether in tort (including negligence), contract, or otherwise, +unless required by applicable law (such as deliberate and grossly +negligent acts) or agreed to in writing, shall any Contributor be +liable to You for damages, including any direct, indirect, special, +incidental, or consequential damages of any character arising as a +result of this License or out of the use or inability to use the +Work (including but not limited to damages for loss of goodwill, +work stoppage, computer failure or malfunction, or any and all +other commercial damages or losses), even if such Contributor +has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing +the Work or Derivative Works thereof, You may choose to offer, +and charge a fee for, acceptance of support, warranty, indemnity, +or other liability obligations and/or rights consistent with this +License. However, in accepting such obligations, You may act only +on Your own behalf and on Your sole responsibility, not on behalf +of any other Contributor, and only if You agree to indemnify, +defend, and hold each Contributor harmless for any liability +incurred by, or claims asserted against, such Contributor by reason +of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + +To apply the Apache License to your work, attach the following +boilerplate notice, with the fields enclosed by brackets "{}" +replaced with your own identifying information. (Don't include +the brackets!) The text should be enclosed in the appropriate +comment syntax for the file format. We also recommend that a +file or class name and description of purpose be included on the +same "printed page" as the copyright notice for easier +identification within third-party archives. + +Copyright {yyyy} {name of copyright owner} + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/packages/ts-autocomplete/package.json b/packages/ts-autocomplete/package.json new file mode 100644 index 00000000..049e3490 --- /dev/null +++ b/packages/ts-autocomplete/package.json @@ -0,0 +1,67 @@ +{ + "name": "@mongodb-js/ts-autocomplete", + "description": "Provide auto-completion for a string using typescript types", + "author": { + "name": "MongoDB Inc", + "email": "compass@mongodb.com" + }, + "publishConfig": { + "access": "public" + }, + "bugs": { + "url": "https://jira.mongodb.org/projects/COMPASS/issues", + "email": "compass@mongodb.com" + }, + "homepage": "https://github.com/mongodb-js/devtools-shared", + "version": "0.1.0", + "repository": { + "type": "git", + "url": "https://github.com/mongodb-js/devtools-shared.git" + }, + "files": [ + "dist" + ], + "license": "Apache-2.0", + "main": "dist/index.js", + "exports": { + "require": "./dist/index.js", + "import": "./dist/.esm-wrapper.mjs" + }, + "types": "./dist/index.d.ts", + "scripts": { + "bootstrap": "npm run compile", + "prepublishOnly": "npm run compile", + "compile": "tsc -p tsconfig.json && gen-esm-wrapper . ./dist/.esm-wrapper.mjs", + "typecheck": "tsc --noEmit", + "eslint": "eslint", + "prettier": "prettier", + "lint": "npm run eslint . && npm run prettier -- --check .", + "depcheck": "depcheck", + "check": "npm run typecheck && npm run lint && npm run depcheck", + "check-ci": "npm run check", + "test": "mocha", + "test-cov": "nyc -x \"**/*.spec.*\" --reporter=lcov --reporter=text --reporter=html npm run test", + "test-watch": "npm run test -- --watch", + "test-ci": "npm run test-cov", + "reformat": "npm run prettier -- --write ." + }, + "devDependencies": { + "@mongodb-js/eslint-config-devtools": "0.9.10", + "@mongodb-js/mocha-config-devtools": "^1.0.4", + "@mongodb-js/prettier-config-devtools": "^1.0.1", + "@mongodb-js/tsconfig-devtools": "^1.0.2", + "@types/chai": "^4.2.21", + "@types/mocha": "^9.1.1", + "@types/sinon-chai": "^3.2.5", + "chai": "^4.3.6", + "debug": "^4.3.6", + "depcheck": "^1.4.1", + "eslint": "^7.25.0", + "gen-esm-wrapper": "^1.1.1", + "mocha": "^8.4.0", + "nyc": "^15.1.0", + "prettier": "^2.3.2", + "sinon": "^9.2.3", + "typescript": "^5.0.4" + } +} diff --git a/packages/ts-autocomplete/src/index.spec.ts b/packages/ts-autocomplete/src/index.spec.ts new file mode 100644 index 00000000..d5a5018b --- /dev/null +++ b/packages/ts-autocomplete/src/index.spec.ts @@ -0,0 +1,289 @@ +import path from 'path'; +import { promises as fs } from 'fs'; +import Autocompleter from './index'; +import { expect } from 'chai'; + +function filterStartingWith({ + name, + trigger, +}: { + name: string; + trigger: string; +}): boolean { + name = name.toLocaleLowerCase(); + trigger = trigger.toLocaleLowerCase(); + + return name !== trigger && name.startsWith(trigger); +} + +describe('Autocompleter', function () { + let CODE_TS: string; + + before(async function () { + CODE_TS = await fs.readFile( + path.resolve(__dirname, '..', 'test', 'fixtures', 'code.ts'), + 'utf8' + ); + }); + + describe('without filter', function () { + let autoCompleter: Autocompleter; + + beforeEach(function () { + autoCompleter = new Autocompleter(); + }); + + it('returns the global scope for a global variable that does not exist', function () { + autoCompleter.updateCode({ + '/code.d.ts': CODE_TS, + }); + + const completions = autoCompleter.autocomplete('doesNotExist'); + expect(completions.length).to.be.gt(100); + }); + + it('returns completions for global variables', function () { + autoCompleter.updateCode({ + '/code.d.ts': CODE_TS, + }); + + // this is just the entire global scope + const completions = autoCompleter.autocomplete('myGlobalFunct'); + + expect(completions.length).to.be.gt(100); + + // one of them is the myGlobalFunction() function + expect(completions).to.deep.include({ + kind: 'function', + name: 'myGlobalFunction', + type: 'myGlobalFunction', + }); + }); + + it('returns nothing for a member of a variable that does not exist', function () { + autoCompleter.updateCode({ + '/code.d.ts': CODE_TS, + }); + + expect( + autoCompleter.autocomplete('doesNotExist.somethingElse') + ).to.deep.equal([]); + }); + + it('returns matches for a member of a variable that exists', function () { + autoCompleter.updateCode({ + '/code.d.ts': CODE_TS, + }); + + expect(autoCompleter.autocomplete('myGlobalObject.')).to.deep.equal([ + { + kind: 'property', + name: 'functionProp', + type: '(p1: number) => void', + }, + { kind: 'property', name: 'stringProp', type: 'string' }, + ]); + }); + + it('returns matches for part of a member of a variable that exists', function () { + autoCompleter.updateCode({ + '/code.d.ts': CODE_TS, + }); + + expect(autoCompleter.autocomplete('myGlobalObject.str')).to.deep.equal([ + { + kind: 'property', + name: 'functionProp', + type: '(p1: number) => void', + }, + { kind: 'property', name: 'stringProp', type: 'string' }, + ]); + }); + + it('returns matches for an unknown member of a variable that exists', function () { + autoCompleter.updateCode({ + '/code.d.ts': CODE_TS, + }); + + expect( + autoCompleter.autocomplete('myGlobalObject.doesNotExist') + ).to.deep.equal([ + { + kind: 'property', + name: 'functionProp', + type: '(p1: number) => void', + }, + { kind: 'property', name: 'stringProp', type: 'string' }, + ]); + }); + + it('returns the global scope for object parameters of a function that does not exist', function () { + autoCompleter.updateCode({ + '/code.d.ts': CODE_TS, + }); + + const completions = autoCompleter.autocomplete('doesNotExist({'); + + expect(completions.length).to.be.gt(100); + }); + + it('returns matches for object parameters of a function that exists', function () { + autoCompleter.updateCode({ + '/code.d.ts': CODE_TS, + }); + + const completions = autoCompleter.autocomplete('myGlobalFunction({ p'); + + expect(completions).to.deep.equal([ + { + kind: 'property', + name: 'param1', + type: 'string', + }, + { + kind: 'property', + name: 'param2', + type: 'string', + }, + ]); + }); + + it('returns matches for part of an object parameter of a function that exists', function () { + autoCompleter.updateCode({ + '/code.d.ts': CODE_TS, + }); + + const completions = autoCompleter.autocomplete('myGlobalFunction({ p'); + + expect(completions).to.deep.equal([ + { + kind: 'property', + name: 'param1', + type: 'string', + }, + { + kind: 'property', + name: 'param2', + type: 'string', + }, + ]); + }); + + it('returns matches for an unknown object parameter of a function that exists', function () { + autoCompleter.updateCode({ + '/code.d.ts': CODE_TS, + }); + + const completions = autoCompleter.autocomplete( + 'myGlobalFunction({ doesNotExist' + ); + expect(completions).to.deep.equal([ + { + kind: 'property', + name: 'param1', + type: 'string', + }, + { + kind: 'property', + name: 'param2', + type: 'string', + }, + ]); + }); + }); + + describe('with filter', function () { + let autoCompleter: Autocompleter; + + beforeEach(function () { + autoCompleter = new Autocompleter({ filter: filterStartingWith }); + }); + + it('returns nothing when it has no code', function () { + expect(autoCompleter.autocomplete('myGlobalOb')).to.deep.equal([]); + expect(autoCompleter.autocomplete('myGlobalObject')).to.deep.equal([]); + expect(autoCompleter.autocomplete('myGlobalObject', 0)).to.deep.equal([]); + expect(autoCompleter.autocomplete('myGlobalObject', 1)).to.deep.equal([]); + expect(autoCompleter.autocomplete('myGlobalObject.')).to.deep.equal([]); + }); + + it('returns completions for global variables', function () { + autoCompleter.updateCode({ + '/code.d.ts': CODE_TS, + }); + + // it finds the entire global scope and then filters it + expect(autoCompleter.autocomplete('myGlobalFunct')).to.deep.equal([ + { + kind: 'function', + name: 'myGlobalFunction', + type: 'myGlobalFunction', + }, + ]); + }); + + it('returns completions for members of global variables', function () { + autoCompleter.updateCode({ + '/code.d.ts': CODE_TS, + }); + + expect(autoCompleter.autocomplete('myGlobalObject')).to.deep.equal([]); + expect(autoCompleter.autocomplete('myGlobalObject.')).to.deep.equal([ + { + kind: 'property', + name: 'functionProp', + type: '(p1: number) => void', + }, + { kind: 'property', name: 'stringProp', type: 'string' }, + ]); + + expect(autoCompleter.autocomplete('myGlobalObject.', 0)).to.deep.equal( + [] + ); + expect(autoCompleter.autocomplete('myGlobalObject.', 1)).to.deep.equal( + [] + ); + expect(autoCompleter.autocomplete('myGlobalObject.', 2)).to.deep.equal( + [] + ); + expect(autoCompleter.autocomplete('myGlobalObject.', 3)).to.deep.equal( + [] + ); + + expect( + autoCompleter.autocomplete('myGlobalObject.functionPr') + ).to.deep.equal([ + { + kind: 'property', + name: 'functionProp', + type: '(p1: number) => void', + }, + ]); + + expect( + autoCompleter.autocomplete('myGlobalObject.typo', 4) + ).to.deep.equal([]); + }); + + it('returns completions for the fields of object function parameters', function () { + autoCompleter.updateCode({ + '/code.d.ts': CODE_TS, + }); + + expect( + autoCompleter.autocomplete('myGlobalFunction({ par') + ).to.deep.equal([ + { + kind: 'property', + name: 'param1', + type: 'string', + }, + { + kind: 'property', + name: 'param2', + type: 'string', + }, + ]); + }); + }); +}); diff --git a/packages/ts-autocomplete/src/index.ts b/packages/ts-autocomplete/src/index.ts new file mode 100644 index 00000000..81253541 --- /dev/null +++ b/packages/ts-autocomplete/src/index.ts @@ -0,0 +1,188 @@ +import * as ts from 'typescript'; +import createDebug from 'debug'; + +const debugLog = createDebug('ts-autocomplete:log'); +const debugTrace = createDebug('ts-autocomplete:trace'); +const debugError = createDebug('ts-autocomplete:error'); + +type TypeFilename = string; + +type UpdateDefinitionFunction = (newDef: Record) => void; + +function getVirtualLanguageService(): [ + ts.LanguageService, + UpdateDefinitionFunction +] { + const codeHolder: Record = Object.create(null); + const versions: Record = Object.create(null); + const options: ts.CompilerOptions = { + target: ts.ScriptTarget.ES2022, + allowJs: true, + }; + + const updateCode = (newDef: Record): void => { + for (const [key, value] of Object.entries(newDef)) { + codeHolder[key] = value; + versions[key] = (versions[key] ?? 0) + 1; + } + }; + + const servicesHost: ts.LanguageServiceHost = { + getScriptFileNames: () => { + return Object.keys(codeHolder); + }, + getScriptVersion: (fileName) => { + return (versions[fileName] ?? 1).toString(); + }, + getScriptSnapshot: (fileName) => { + if (fileName in codeHolder) { + return ts.ScriptSnapshot.fromString(codeHolder[fileName]); + } + + return ts.ScriptSnapshot.fromString(ts.sys.readFile(fileName) || ''); + }, + getCurrentDirectory: () => process.cwd(), + getCompilationSettings: () => options, + getDefaultLibFileName: (options) => ts.getDefaultLibFilePath(options), + fileExists: (fileName) => { + return fileName in codeHolder || ts.sys.fileExists(fileName); + }, + readFile: (fileName) => { + if (fileName in codeHolder) { + return codeHolder[fileName]; + } + return ts.sys.readFile(fileName); + }, + readDirectory: (...args) => ts.sys.readDirectory(...args), + directoryExists: (...args) => ts.sys.directoryExists(...args), + getDirectories: (...args) => ts.sys.getDirectories(...args), + + log: (...args) => debugLog(args), + trace: (...args) => debugTrace(args), + error: (...args) => debugError(args), + }; + + return [ + ts.createLanguageService(servicesHost, ts.createDocumentRegistry()), + updateCode, + ]; +} + +function compileSourceFile(code: string): ts.SourceFile { + return ts.createSourceFile( + '_initial_parsing.ts', + code, + ts.ScriptTarget.Latest, + true + ); +} + +function getSymbolAtPosition( + sourceFile: ts.SourceFile, + position: number +): string | null { + function findNodeAtPosition(node: ts.Node): ts.Node | undefined { + if (position >= node.getStart(sourceFile) && position <= node.getEnd()) { + return ts.forEachChild(node, findNodeAtPosition) || node; + } + + return undefined; + } + + let node = findNodeAtPosition(sourceFile); + + while (node && !ts.isIdentifier(node)) { + if (node.parent) { + node = node.parent; + } else { + break; + } + } + + return node && ts.isIdentifier(node) ? node.getText(sourceFile) : null; +} + +type AutoCompletion = { + name: string; + kind: ts.ScriptElementKind; + type: string; +}; + +function mapCompletions( + filter: AutocompleteFilterFunction, + trigger: string, + completions: ts.CompletionInfo +): AutoCompletion[] { + return completions.entries + .filter((entry) => filter({ trigger, name: entry.name })) + .map((entry) => { + // entry.symbol is included because we specify includeSymbol when calling + // getCompletionsAtPosition + const declarations = entry.symbol?.getDeclarations(); + let type = 'any'; + const decl = declarations?.[0]; + if (decl) { + // decl's children are things like ['a', ':', 'string'] or ['bb', ':', + // '(p1: number) => void']. So the one at position 2 (zero indexed) is the + // type. + type = decl.getChildAt(2)?.getFullText()?.trim() ?? 'any'; + } + + return { + name: entry.name, + kind: entry.kind, + type, + }; + }); +} + +type AutocompleteFilterOptions = { + trigger: string; + name: string; +}; + +type AutocompleteFilterFunction = ( + filterOptions: AutocompleteFilterOptions +) => boolean; + +type AutocompleterOptions = { + filter?: AutocompleteFilterFunction; +}; + +export default class Autocompleter { + private readonly filter: AutocompleteFilterFunction; + private readonly languageService: ts.LanguageService; + readonly updateCode: UpdateDefinitionFunction; + + constructor({ filter }: AutocompleterOptions = {}) { + this.filter = filter ?? (() => true); + [this.languageService, this.updateCode] = getVirtualLanguageService(); + } + + autocomplete(code: string, position?: number): AutoCompletion[] { + if (typeof position === 'undefined') { + position = code.length; + } + + this.updateCode({ + 'main.ts': code, + }); + + const completions = this.languageService.getCompletionsAtPosition( + 'main.ts', + position, + { + allowIncompleteCompletions: true, + includeSymbol: true, + } + ); + + if (completions) { + const tsAst = compileSourceFile(code); + const symbolAtPosition = getSymbolAtPosition(tsAst, position) ?? ''; + return mapCompletions(this.filter, symbolAtPosition, completions); + } + + return []; + } +} diff --git a/packages/ts-autocomplete/test/fixtures/code.ts b/packages/ts-autocomplete/test/fixtures/code.ts new file mode 100644 index 00000000..80180bc6 --- /dev/null +++ b/packages/ts-autocomplete/test/fixtures/code.ts @@ -0,0 +1,12 @@ +/* eslint-disable @typescript-eslint/no-empty-function */ +export type MyObject = { + stringProp: string; + functionProp: (p1: number) => void; +}; + +export type MyFunctionParams = { param1: string; param2: string }; + +declare global { + export const myGlobalObject: MyObject; + export function myGlobalFunction(params: MyFunctionParams): void; +} diff --git a/packages/ts-autocomplete/tsconfig-lint.json b/packages/ts-autocomplete/tsconfig-lint.json new file mode 100644 index 00000000..6bdef84f --- /dev/null +++ b/packages/ts-autocomplete/tsconfig-lint.json @@ -0,0 +1,5 @@ +{ + "extends": "./tsconfig.json", + "include": ["**/*"], + "exclude": ["node_modules", "dist"] +} diff --git a/packages/ts-autocomplete/tsconfig.json b/packages/ts-autocomplete/tsconfig.json new file mode 100644 index 00000000..156674a5 --- /dev/null +++ b/packages/ts-autocomplete/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json", + "compilerOptions": { + "outDir": "dist", + "allowJs": true, + "strict": true + }, + "include": ["src/**/*"], + "exclude": ["./src/**/*.spec.*"] +}