npmpackage.info

vscode-uri

The URI implementation that is used in VS Code and its extensions.

3.1.0

212

MIT

TypeScript

4.35 kB

614,468,183 6.4

Installations

npm install vscode-uri

Developer Guide

BETA

Typescript

No

Module System

CommonJS, ESM

Node Version

18.5.0 Score

91.8

Supply Chain

90.2

Quality

87.4

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

43

Closed

8

Merged

35

Issues

Open

0

Total

0

Closed

0

Releases

v3.1.0

Updated on Feb 04, 2025

View All 1 releases

Contributors

View All 68 Contributors

Languages

TypeScript

JavaScript

TypeScript (95.25%)

JavaScript (4.75%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

microsoft

Download Statistics

Total Downloads

614,468,183

Last Day

1,107,891

Last Week

5,888,140

Last Month

23,875,833

Last Year

215,819,686

GitHub Statistics

MIT License

212 Stars

117 Commits

30 Forks

25 Watchers

11 Branches

68 Contributors

Updated on Feb 05, 2025

Bundle Size

11.48 kB

Minified

4.35 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

3.1.0

Package Id

vscode-uri@3.1.0

Unpacked Size

199.68 kB

Size

58.37 kB

File Count

Node Version

18.5.0

Published on

Feb 04, 2025

Total Downloads

Cumulative downloads

Total Downloads

614,468,183

Last Day

7.9%

1,107,891

Compared to previous day

Last Week

6.8%

5,888,140

Compared to previous week

Last Month

41.4%

23,875,833

Compared to previous month

Last Year

74.8%

215,819,686

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@types/mocha @types/node mocha path-browserify rimraf ts-loader typescript webpack webpack-cli

vscode-uri

This module contains the URI implementation that is used by VS Code and its extensions. It has support for parsing a string into scheme, authority, path, query, and fragment URI components as defined in: http://tools.ietf.org/html/rfc3986

  foo://example.com:8042/over/there?name=ferret#nose
  \_/   \______________/\_________/ \_________/ \__/
   |           |            |            |        |
scheme     authority       path        query   fragment
   |   _____________________|__
  / \ /                        \
  urn:example:animal:ferret:nose

Usage

1import { URI } from 'vscode-uri'
2
3// parse an URI from string
4
5let uri = URI.parse('https://code.visualstudio.com/docs/extensions/overview#frag')
6
7assert.ok(uri.scheme === 'https');
8assert.ok(uri.authority === 'code.visualstudio.com');
9assert.ok(uri.path === '/docs/extensions/overview');
10assert.ok(uri.query === '');
11assert.ok(uri.fragment === 'frag');
12assert.ok(uri.toString() === 'https://code.visualstudio.com/docs/extensions/overview#frag')
13
14
15// create an URI from a fs path
16
17let uri = URI.file('/users/me/c#-projects/');
18
19assert.ok(uri.scheme === 'file');
20assert.ok(uri.authority === '');
21assert.ok(uri.path === '/users/me/c#-projects/');
22assert.ok(uri.query === '');
23assert.ok(uri.fragment === '');
24assert.ok(uri.toString() === 'file:///users/me/c%23-projects/')

Usage: Util

This module also exports a Utils package which is an extension, not part of vscode.Uri, and useful for path-math. There is:

Utils.joinPath(URI, paths): URI
Utils.resolvePath(URI, paths): URI
Utils.dirname(URI): string
Utils.basename(URI): string
Utils.extname(URI): string

All util use posix path-math as defined by the node.js path module.

Contributing

The source of this module is taken straight from the vscode-sources and because of that issues and pull request should be created in that repository. Thanks and Happy Coding!

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.

No vulnerabilities found.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Security-Policy

Determines if the project has published a security policy.

7

Pinned-Dependencies

Determines if the project has declared and pinned its dependencies.

6

Code-Review

Determines if the project requires code review before pull requests (aka merge requests) are merged.

6

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has a CII Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

Score

6.4

/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

Other packages similar to vscode-uri

@types-zh-cn/vscode-uri

1.0.3

The URI implementation that is used by VS Code and its extensions

sussudio

0.5.0

An unofficial VS Code Internal API

@sussudio/base

0.2.0

Internal APIs for VS Code's utilities and user interface building blocks.

vscode-url

0.0.2

A library to create urls for the `vscode-remote://` URI scheme.