create-vscode-editor
Advanced tools
create-vscode-editor - npm Package Compare versions
Comparing version 0.0.1 to 0.0.2
| { | ||
| "name": "create-vscode-editor", | ||
| "version": "0.0.1", | ||
| "version": "0.0.2", | ||
| "description": "A custom editor for VS Code", | ||
| "author": "@seflless", | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "git+https://github.com/seflless/create-vscode-editor.git" | ||
| }, | ||
| "bugs": { | ||
| "url": "https://github.com/seflless/create-vscode-editor/issues" | ||
| }, | ||
| "homepage": "https://github.com/seflless/create-vscode-editor", | ||
| "license": "MIT", | ||
| "keywords": [ | ||
| ], | ||
| "keywords": [], | ||
| "bin": "./bin/generate.mjs", | ||
| "scripts": { | ||
@@ -16,3 +24,6 @@ "start": "yarn start:editor && yarn start:extension", | ||
| }, | ||
| "dependencies": {}, | ||
| "dependencies": { | ||
| "chalk": "^4.1.2", | ||
| "fs-extra": "^10.0.0" | ||
| }, | ||
| "devDependencies": { | ||
@@ -19,0 +30,0 @@ "@tldraw/tldraw": "^0.1.11", |
@@ -1,9 +0,16 @@ | ||
| # Create Custom VS Code Editors | ||
| A module/template to make it super easy to make custom VS Code editors, using React for the UI. Think of it like a create-react-app, it's very opinionated in order work out of the box. | ||
| ## Create VS Code Editors | ||
| Easily create custom VS Code editors, using React for the UI. | ||
| While working on the Tldraw extension I couldn't find any projects that uses React for the editor UI. Also none of the example editors supported web VS Code like GitHub.dev, vscode.dev, and GitHub Codespaces. This project generated an app that has all of these types of things working out of the box. Also a better dev workflow than the VS Code team's example code. | ||
| https://github.com/microsoft/vscode-extension-samples/tree/main/custom-editor-sample | ||
| Like create-react-app, this is a project generator that is very opinionated in order work out of the box. | ||
| Checkout the [Tldraw VS Code editor](https://marketplace.visualstudio.com/items?itemName=tldraw-org.tldraw-vscode), that this module was spun out from. | ||
| **Todos** | ||
| ### Todos | ||
| - Register create-vscode-editor. Running it would be | ||
| - `yarn create vscode-editor custom-editor` | ||
| - `yarn create vscode-editor my-editor` | ||
| - Make it follow the `yarn create` / create-react-app approach for easily quickly creating a new project | ||
@@ -20,3 +27,6 @@ - https://classic.yarnpkg.com/en/docs/cli/create | ||
| **Future Work** | ||
| ### Future Work | ||
| - Add tests | ||
| - For the generator | ||
| - To the template to provide ready to go VS Code extension testing for editors | ||
| - Add instructions and scripts for publishing automatically to the Marketplace | ||
@@ -33,2 +43,3 @@ - Add hot reloading to both the extension and editor app. Switch from esbuild to Vite (uses esbuild anyway) | ||
| - An app data model | ||
| - Multiplayer framework or Live Share integration | ||
| - Utilities for maintaining file formats with best practices for being easily evolvable/serializable. | ||
@@ -78,2 +89,4 @@ - Add CLI support for flags for language `ts`/`js` and UI frameworks other than `react` like `vue` | ||
| - [yarn create](https://classic.yarnpkg.com/en/docs/cli/create) | ||
| - [Yarn Create & Yarn 1.0](https://classic.yarnpkg.com/blog/2017/05/12/introducing-yarn/) | ||
| - [VS Code Marketplace Manager](https://marketplace.visualstudio.com/manage/) | ||
@@ -80,0 +93,0 @@ - [Web Extensions Guide](https://code.visualstudio.com/api/extension-guides/web-extensions) |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Filesystem access
Supply chain riskAccesses the file system, and could potentially read sensitive data.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No bug tracker
MaintenancePackage does not have a linked bug tracker in package.json.
Found 1 instance in 1 package
No repository
Supply chain riskPackage does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.
Found 1 instance in 1 package
No website
QualityPackage does not have a website.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.22%
1371486
- Number of package files
- increased by2.56%
40
- Lines of code
- increased by0.25%
23144
- Number of low maintenance alerts
- decreased by-100%
0
- Number of low quality alerts
- decreased by-50%
1
- Number of lines in readme file
- increased by14.44%
103
Worsened metrics
- Dependency count
- increased byInfinity%
2
Dependency changes
+ Addedchalk@^4.1.2
+ Addedfs-extra@^10.0.0
+ Addedansi-styles@4.3.0(transitive)
+ Addedchalk@4.1.2(transitive)
+ Addedcolor-convert@2.0.1(transitive)
+ Addedcolor-name@1.1.4(transitive)
+ Addedfs-extra@10.1.0(transitive)
+ Addedgraceful-fs@4.2.11(transitive)
+ Addedhas-flag@4.0.0(transitive)
+ Addedjsonfile@6.1.0(transitive)
+ Addedsupports-color@7.2.0(transitive)
+ Addeduniversalify@2.0.1(transitive)