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
npm install vscode-extension-manifest -D
yarn add vscode-extension-manifest -D
pnpm add vscode-extension-manifest -D
Usage
import {
readExtensionManifest,
readExtensionManifestSync,
validateExtensionManifest,
} from 'vscode-extension-manifest'
console.log(await readExtensionManifest())
//=> VSCode extension manifest with types definition
console.log(validateExtensionManifest(readExtensionManifestSync()))
// => 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:
Parameters
manifest
- Type:
ExtensionManifest
- Required:
true
Read by readExtensionManifest or readExtensionManifestSync.
Links
License
MIT License © 2024-PRESENT ntnyq
