Registry / database / mongodb-ace-autocompleter

mongodb-ace-autocompleter

library1.1.1jsnpmunverified

Provides custom ACE Editor auto-completers for MongoDB queries and aggregation pipelines. Version 1.1.1 is the current stable release. It offers completions for aggregation pipeline stages and query fields based on server version and processed schema fields. Designed specifically for use with ACE Editor, it is part of the MongoDB-js ecosystem and requires external dependencies like ace-builds. Differentiates from general autocompleters by being MongoDB-aware, providing context-sensitive completions for $match, $group, etc., and schema-driven suggestions.

database

npm install mongodb-ace-autocompleter

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · MONGODB-ACE-AUTOCO

mongodb-ace-autocompleter

databasejavascriptv1.1.1

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

StageAutoCompleter

✓ import { StageAutoCompleter } from 'mongodb-ace-autocompleter'

✗ const StageAutoCompleter = require('mongodb-ace-autocompleter').StageAutoCompleter

Package is ESM-only. Use import statement or dynamic import(). CommonJS require will fail.

QueryAutoCompleter

✓ import { QueryAutoCompleter } from 'mongodb-ace-autocompleter'

✗ import QueryAutoCompleter from 'mongodb-ace-autocompleter'

Default export does not exist; must use named import.

the package itself

✓ import { StageAutoCompleter, QueryAutoCompleter } from 'mongodb-ace-autocompleter'

✗ import * as aceAutocompleter from 'mongodb-ace-autocompleter'

No namespace export. Only named exports. Avoid wildcard import.

Creates a StageAutoCompleter for aggregation pipelines using ACE Editor and sets it as the active completer.

import ace from 'ace-builds'; import tools from 'ace-builds/src-noconflict/ext-language_tools'; const textCompleter = tools.textCompleter; import { StageAutoCompleter } from 'mongodb-ace-autocompleter'; const fields = [{ name: 'name', value: 'name', score: 1, meta: 'field', version: '0.0.0' }]; const stageAutoCompleter = new StageAutoCompleter( '3.6.0', textCompleter, fields, '$match' ); tools.setCompleters([stageAutoCompleter]); // Now ACE Editor will suggest completions for $match stage.

Debug

Known issues

gotchaThe package does not ship TypeScript definitions; you need to install @types/ace separately.

fix

npm install --save-dev @types/ace

affects: >=1.0.0

breakingVersion 1.0.0 switched from CommonJS to ESM-only. require() will throw an error.

fix

Use import syntax or dynamic import(). If using CommonJS, stick to older versions.

affects: >=1.0.0

deprecatedThe method setCompleters from ace-builds/ext-language_tools is deprecated; prefer using editor.completers = [...].

fix

Assign directly: editor.completers = [stageAutoCompleter];

affects: *

gotchaServer version must be passed as a string (e.g., '3.6.0'); incorrect format may cause no completions.

fix

Ensure version is a valid MongoDB version string like '4.0.0'.

affects: *

Errors

Common errors & fixes

Cannot find module 'mongodb-ace-autocompleter'

Package not installed or import path incorrect.

fix

npm install mongodb-ace-autocompleter

StageAutoCompleter is not a constructor

Using require() in ESM-only package (version >=1.0.0).

fix

Use import { StageAutoCompleter } from 'mongodb-ace-autocompleter';

Property 'textCompleter' does not exist on type 'typeof import("ace-builds/src-noconflict/ext-language_tools")'

Missing TypeScript type definitions for ace-builds.

fix

Install @types/ace: npm install --save-dev @types/ace

TypeError: Cannot read properties of undefined (reading 'setCompleters')

tools is undefined if ace-builds/ext-language_tools not properly imported.

fix

Ensure import: import tools from 'ace-builds/src-noconflict/ext-language_tools';

Upgrade

Version history

1.1.1latest on npm

Audit

Dependencies

ace-buildsrequiredRequired peer dependency; provides ACE Editor instance and text completer.

@types/aceoptionalTypeScript definitions for ACE Editor classes, needed when using TypeScript.

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/mongodb-js/ace-autocompleter ↗

packagemongodb-ace-autocompleter ↗

homepagehttps://github.com/mongodb-js/ace-autocompleter#readme ↗