package
Easily add auto-import to the Monaco editor, with Javascript & Typescript support.
npm install @blitz/monaco-auto-importGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Estimated unpacked size across 1 packages.
21.9 MB
Includes dependencies.
Easily add auto-import to the Monaco editor, with Javascript & Typescript support.

import AutoImport, { regexTokeniser } from '@blitz/monaco-auto-import'
const editor = monaco.editor.create(document.getElementById('demo'), {
value: `
PAD
leftPad
rightPad
`,
language: 'typescript'
})
const completor = new AutoImport({ monaco, editor })
completor.imports.saveFiles([
{
path: './node_modules/left-pad/index.js',
aliases: ['left-pad'],
imports: regexTokeniser(`
export const PAD = ''
export function leftPad() {}
export function rightPad() {}
yarn add @blitz/monaco-auto-import
# or
npm i @blitz/monaco-auto-import --saveSimply create a new Monaco editor instance and pass it to AutoImport. This will register custom completion providers for Monaco's javascript and typescript language services.
import AutoImport from '@blitz/monaco-auto-import'
const editor = monaco.editor.create(document.getElementById('demo'), {
language: 'typescript'
})
const completor = new AutoImport({ monaco, editor })To make the auto-importer aware of a file with exports, simply call completor.imports.saveFile.
completor.imports.saveFile({
path: './src/my-app.js',
imports: [
{
type: 'const',
name: 'Testing'
}
]
})
This package includes a built-in regexTokeniser, which uses a simple Regex to extracts exports from Javascript / Typescript code
import { regexTokeniser } from '@blitz/monaco-auto-import'
const imports = regexTokeniser(`
export const a = 1
export class Test {}
`)
// [{ type: 'const', name: 'a'}, { type: 'class', name: 'Test' }]
completor.imports.saveFile({
path: './src/my-app.js',
imports: imports
})imports.saveFile(file: File): voidSaves a file to the internal store, making it available for completion
imports.saveFiles(files: File[]): voidBulk-saves files to the internal store from an Array of files
imports.getFile(path: string): FileFetches a file from the internal store by it's path name (or one of it's aliases).
imports.getImports(name: string): ImportObject[]Returns all the imports that exactly match a given string.
imports.addImport(path: string, name: string, type?: Expression): booleanAdds an import to a given file, with an optional type paramater. Returns true if the file existed
imports.removeImport(path: string, name: string): booleanRemoves an import from a given file. Returns true if the file existed
stackblitz-devops
devops@stackblitz.com
d3lm
elmdominic@gmx.net
kwintenp
kwinten.pisman@gmail.com
samverschueren
sam.verschueren@gmail.com
tsulkowski
tomek@stackblitz.com
_rvidal
roberto.vidal@ikumene.com
ivannovo
ivan.novosad@gmail.com
nemikolh
nemikolh@gmail.com
_alexpate
npm@alexpate.com
petergrace
usual.tree6721@gfpd.us
alexkalderimis
alexkalderimis@gmail.com
kirjava
snkenjoi@gmail.com
jsphkeyes
joseph.keyes@stackblitz.com
achiurizostackblitz
arthur@stackblitz.com
ashleybolt
ashley@stackblitz.com
keenanpayne
contact@keenanpayne.com
inkko
do@inkko.ca
calvein
calvein@gmail.com
kasper.mikiewicz
ideredpl@gmail.com
george-sb
george@stackblitz.com
sohnofgod
jsohn000@gmail.com
shawnaukstak
Salvitin@gmail.com
mfolgs
mike.folgner@stackblitz.com
derekxbolt
derek@stackblitz.com
thejarx
gerard@akude.org
sb-mikec
mike@stackblitz.com
aslemammad
zorofight94@gmail.com
selfcommit
oboyledk@gmail.com
tmickleydoyle
tmickleydoyle@gmail.com
kevmcgivern
kevin@stackblitz.com
tahul
yael.guilloux@gmail.com
juliobolt
julio@stackblitz.com
conormcgee
conor@stackblitz.com