https://github.com/zardoy/vscode-framework

Framework for fast VSCode extensions prototyping
https://github.com/zardoy/vscode-framework

typescript vscode vscode-extension vscode-extension-api vscode-extension-boilerplate vscode-plugin

Last synced: 3 days ago
JSON representation

Framework for fast VSCode extensions prototyping

• Host: GitHub
• URL: https://github.com/zardoy/vscode-framework
• Owner: zardoy
• License: mit
• Created: 2021-07-31T05:14:30.000Z (about 3 years ago)
• Default Branch: next
• Last Pushed: 2024-02-04T22:03:32.000Z (8 months ago)
• Last Synced: 2024-09-19T18:25:54.725Z (8 days ago)
• Topics: typescript, vscode, vscode-extension, vscode-extension-api, vscode-extension-boilerplate, vscode-plugin
• Language: TypeScript
• Homepage: https://www.npmjs.com/vscode-framework
• Size: 5.25 MB
• Stars: 5
• Watchers: 1
• Forks: 1
• Open Issues: 40
• Metadata Files:
  • Readme: README.MD
  • License: LICENSE

Awesome Lists containing this project

README

        
# VSCode Frameworkbeta

- 💡 Not Boilerplated

- ⚡️ Auto Reload

- 🔑 TypeScript Types from `package.json` Contribution Points

- ⚙️ Use TypeScript type for `configuration` instead of schema in *package.json*

- 📦 Publish Production-ready Build with zero config

- 🚀 Use `console` methods in production (creates extension output for you)

- 🛠️ Highly Configurable

> Stability note: Docs and some tests are still WIP. The `build` script also need some work.

## Ecosystem

| Package | Description | Version |

| --- | --- | --- |

| [vscode-extra](https://github.com/zardoy/vscode-framework/tree/main/packages/vscode-extra) | Contains additional useful methods extensions that aren't provided by vscode API | [![vscode-extra version](https://img.shields.io/npm/v/vscode-extra/next.svg?label=%20)](https://npmjs.com/package/vscode-extra/v/next) |

| [vscode-framework](https://github.com/zardoy/vscode-framework/tree/main/packages/vscode-framework) | undefined | [![vscode-framework version](https://img.shields.io/npm/v/vscode-framework/latest.svg?label=%20)](https://npmjs.com/package/vscode-framework/v/latest) |

| [vscode-manifest](https://github.com/zardoy/vscode-framework/tree/main/packages/vscode-manifest) | Contains TypeScript types, JSON schema and compiled validator for VSCode Extension Manifest | [![vscode-manifest version](https://img.shields.io/npm/v/vscode-manifest/next.svg?label=%20)](https://npmjs.com/package/vscode-manifest/v/next) |

| [typed-vscode](https://github.com/zardoy/vscode-framework/tree/main/packages/typed-vscode) | Contains TypeScript types, JSON schema and compiled validator for VSCode Extension Manifest | [![typed-vscode version](https://img.shields.io/npm/v/typed-vscode/latest.svg?label=%20)](https://npmjs.com/package/typed-vscode/v/latest) |

## Development

Please use pnpm for development, it is easy to install: `npm i -g pnpm`

When you clone this repo *for the first time* and run `pnpm i`, you need to wait before schema gets generated via postinstall script.

## TODO

Api for extensions:

- [ ] ensure extension work correctly in portable mode, use right TMP