vscode-extension-manifest

VSCode extension manifest type definitions, validators, and utilities.

[!NOTE] This package only provide types for VSCode extension manifest related fields listed in Extension Manifest.

If you need types support NodeJs package.json file, please check type-fest - package-json.d.ts.

Install

1npm install vscode-extension-manifest -D

1yarn add vscode-extension-manifest -D

1pnpm add vscode-extension-manifest -D

Usage

1import {
2  readExtensionManifest,
3  readExtensionManifestSync,
4  validateExtensionManifest,
5} from 'vscode-extension-manifest'
6
7console.log(await readExtensionManifest())
8//=> VSCode extension manifest with types definition
9
10console.log(validateExtensionManifest(readExtensionManifestSync()))
11// => true if valid, false otherwise

API

readExtensionManifest

• Type: (options?: Options) => Promise<ExtensionManifest>

Returns a Promise for VSCode extension manifest with type definition.

Options

for readExtensionManifest and readExtensionManifestSync

filename

• Type: string
• Default: package.json
• Required: false

The filename of the extension manifest.

cwd

• Type: string | URL
• Default: process.cwd()
• Required: false

The current working directory of the extension manifest.

readExtensionManifestSync

• Type: (options?: Options) => ExtensionManifest

Returns VSCode extension manifest with type definition.

Options

Same as readExtensionManifest

validateExtensionManifest

• Type: (manifest: ExtensionManifest) => boolean

Returns true if the extension manifest is valid, false otherwise.

By checking the following properties:

• publisher

Parameters

manifest

• Type: ExtensionManifest
• Required: true

Read by readExtensionManifest or readExtensionManifestSync.

Links

• Extension Manifest
• Contribution Points

License

MIT License © 2024-PRESENT ntnyq