Gathering detailed insights and metrics for monaco-editor
Gathering detailed insights and metrics for monaco-editor
Installations
npm install monaco-editorScore
68.2
Supply Chain
95.5
Quality
91.1
Maintenance
100
Vulnerability
99.6
License
Developer
Developer Guide
BETA
Module System
Unable to determine the module system for this package.
Min. Node Version
Typescript Support
No
Node Version
20.17.0
NPM Version
10.8.2
Statistics
40,598 Stars
3,430 Commits
3,608 Forks
525 Watching
22 Branches
296 Contributors
Updated on 27 Nov 2024
Bundle Size
125.75 kB
Minified
19.88 kB
Minified + Gzipped
Languages
JavaScript (61.25%)
TypeScript (37.2%)
HTML (1.49%)
CSS (0.04%)
Shell (0.02%)
SCSS (0.01%)
Total Downloads
Cumulative downloads
Total Downloads
158,193,061
Last day
-5.2%
286,219
Compared to previous day
Last week
0.5%
1,469,619
Compared to previous week
Last month
16.9%
6,229,607
Compared to previous month
Last year
53.2%
61,235,331
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dev Dependencies
36
@types/mocha@types/shelljs@typescript/vfschaiclean-csscss-loaderesbuildesbuild-plugin-aliasfile-loaderglobhttp-serverhuskyjsdomjsonc-parsermochamonaco-editor-coreparcelpin-github-actionplaywrightprettierpretty-quickrequirejsshelljsstyle-loaderterserts-nodetypescriptvitevscode-css-languageservicevscode-html-languageservicevscode-json-languageservicevscode-languageserver-textdocumentvscode-languageserver-typesvscode-uriwebpackyaserver
Versions
Monaco Editor
The Monaco Editor is the fully featured code editor from VS Code. Check out the VS Code docs to see some of the supported features.
Try it out
Try out the editor and see various examples in our interactive playground.
The playground is the best way to learn about how to use the editor, which features is supports, to try out different versions and to create minimal reproducible examples for bug reports.
Installing
> npm install monaco-editor
You will get:
- inside
/esm: ESM version of the editor (compatible with e.g. webpack) - inside
/dev: AMD bundled, not minified - inside
/min: AMD bundled, and minified - inside
/min-maps: source maps formin monaco.d.ts: this specifies the API of the editor (this is what is actually versioned, everything else is considered private and might break with any release).
It is recommended to develop against the dev version, and in production to use the min version.
Concepts
Monaco editor is best known for being the text editor that powers VS Code. However, it's a bit more nuanced. Some basic understanding about the underlying concepts is needed to use Monaco editor effectively.
Models
Models are at the heart of Monaco editor. It's what you interact with when managing content. A model represents a file that has been opened. This could represent a file that exists on a file system, but it doesn't have to. For example, the model holds the text content, determines the language of the content, and tracks the edit history of the content.
URIs
Each model is identified by a URI. This is why it's not possible for two models to have the same URI. Ideally when you represent content in Monaco editor, you should think of a virtual file system that matches the files your users are editing. For example, you could use file:/// as a base path. If a model is created without a URI, its URI will be inmemory://model/1. The number increases as more models are created.
Editors
An editor is a user facing view of the model. This is what gets attached to the DOM and what your users see visually. Typical editor operations are displaying a model, managing the view state, or executing actions or commands.
Providers
Providers provide smart editor features. For example, this includes completion and hover information. It is not the same as, but often maps to language server protocol features.
Providers work on models. Some smart features depends on the file URI. For example, for TypeScript to resolve imports, or for JSON IntelliSense to determine which JSON schema to apply to which model. So it's important to choose proper model URIs.
Disposables
Many Monaco related objects often implement the .dispose() method. This method is intended to perform cleanups when a resource is no longer needed. For example, calling model.dispose() will unregister it, freeing up the URI for a new model. Editors should be disposed to free up resources and remove their model listeners.
Documentation
- Learn how to integrate the editor with these complete samples.
- Learn how to use the editor API and try out your own customizations in the playground.
- Explore the API docs or read them straight from
monaco.d.ts. - Read this guide to ensure the editor is accessible to all your users!
- Create a Monarch tokenizer for a new programming language in the Monarch playground.
- Ask questions on StackOverflow! Search open and closed issues, there are a lot of tips in there!
Issues
Create issues in this repository for anything related to the Monaco Editor. Please search for existing issues to avoid duplicates.
FAQ
❓ What is the relationship between VS Code and the Monaco Editor?
The Monaco Editor is generated straight from VS Code's sources with some shims around services the code needs to make it run in a web browser outside of its home.
❓ What is the relationship between VS Code's version and the Monaco Editor's version?
None. The Monaco Editor is a library and it reflects directly the source code.
❓ I've written an extension for VS Code, will it work on the Monaco Editor in a browser?
No.
Note: If the extension is fully based on the LSP and if the language server is authored in JavaScript, then it would be possible.
❓ Why all these web workers and why should I care?
Language services create web workers to compute heavy stuff outside of the UI thread. They cost hardly anything in terms of resource overhead and you shouldn't worry too much about them, as long as you get them to work (see above the cross-domain case).
❓ What is this loader.js? Can I use require.js?
It is an AMD loader that we use in VS Code. Yes.
❓ I see the warning "Could not create web worker". What should I do?
HTML5 does not allow pages loaded on file:// to create web workers. Please load the editor with a web server on http:// or https:// schemes.
❓ Is the editor supported in mobile browsers or mobile web app frameworks?
No.
❓ Why doesn't the editor support TextMate grammars?
- Please see https://github.com/bolinfest/monaco-tm which puts together
monaco-editor,vscode-onigurumaandvscode-textmateto get TM grammar support in the editor.
Contributing / Local Development
We are welcoming contributions from the community! Please see CONTRIBUTING for details how you can contribute effectively, how you can run the editor from sources and how you can debug and fix issues.
Code of Conduct
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
License
Licensed under the MIT License.
No vulnerabilities found.
Reason
30 commit(s) out of 30 and 1 issue activity out of 30 found in the last 90 days -- score normalized to 10
Reason
all last 30 commits are reviewed through GitHub
Reason
no vulnerabilities detected
Reason
security policy file detected
Details
- Info: security policy detected in current repo: SECURITY.md:1
Reason
license file detected
Details
- Info: : LICENSE.txt:1
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
update tool detected
Details
- Info: Dependabot detected
Reason
branch protection is not maximal on development and all release branches
Details
- Info: 'force pushes' disabled on branch 'main'
- Info: 'allow deletion' disabled on branch 'main'
- Info: status check found to merge onto on branch 'main'
- Warn: number of required reviewers is only 1 on branch 'main'
Reason
dependency not pinned by hash detected -- score normalized to 7
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/kamil1b/git-taxbreak/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/kamil1b/git-taxbreak/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/kamil1b/git-taxbreak/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/locker.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/kamil1b/git-taxbreak/locker.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/needs-more-info-closer.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/kamil1b/git-taxbreak/needs-more-info-closer.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pr-chat.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/kamil1b/git-taxbreak/pr-chat.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/kamil1b/git-taxbreak/publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/kamil1b/git-taxbreak/publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/kamil1b/git-taxbreak/publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/kamil1b/git-taxbreak/publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/website.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/kamil1b/git-taxbreak/website.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/website.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/kamil1b/git-taxbreak/website.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/website.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/kamil1b/git-taxbreak/website.yml/master?enable=pin
- Warn: containerImage not pinned by hash: website/index/samples/sample.dockerfile.txt:1: pin your Docker image by updating mono to mono@sha256:b6bd136c233c60037a45d15b37d593a4a40d822ebe35090d492144b997476dff
- Warn: npmCommand not pinned by hash: .github/workflows/locker.yml:21
- Warn: npmCommand not pinned by hash: .github/workflows/needs-more-info-closer.yml:21
- Warn: npmCommand not pinned by hash: .github/workflows/pr-chat.yml:19
- Warn: npmCommand not pinned by hash: .github/workflows/publish.yml:177
- Info: Third-party GitHubActions are pinned
- Info: no insecure (not pinned by hash) dependency downloads found in Dockerfiles
- Info: no insecure (not pinned by hash) dependency downloads found in shell scripts
Reason
no badge detected
Reason
non read-only tokens detected in GitHub workflows
Details
- Warn: no topLevel permission defined: .github/workflows/ci.yml:1: update your workflow using https://app.stepsecurity.io/secureworkflow/kamil1b/git-taxbreak/ci.yml/master?enable=permissions
- Warn: no topLevel permission defined: .github/workflows/locker.yml:1: update your workflow using https://app.stepsecurity.io/secureworkflow/kamil1b/git-taxbreak/locker.yml/master?enable=permissions
- Warn: no topLevel permission defined: .github/workflows/needs-more-info-closer.yml:1: update your workflow using https://app.stepsecurity.io/secureworkflow/kamil1b/git-taxbreak/needs-more-info-closer.yml/master?enable=permissions
- Warn: no topLevel permission defined: .github/workflows/pr-chat.yml:1: update your workflow using https://app.stepsecurity.io/secureworkflow/kamil1b/git-taxbreak/pr-chat.yml/master?enable=permissions
- Warn: no topLevel permission defined: .github/workflows/publish.yml:1: update your workflow using https://app.stepsecurity.io/secureworkflow/kamil1b/git-taxbreak/publish.yml/master?enable=permissions
- Warn: no topLevel permission defined: .github/workflows/website.yml:1: update your workflow using https://app.stepsecurity.io/secureworkflow/kamil1b/git-taxbreak/website.yml/master?enable=permissions
Reason
project is not fuzzed
Score
7.8
/10
Last Scanned on 2022-08-15
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More