Skip to content

Commit 850bae2

Browse files
committed
Use HEAD as default branch rather than master
1 parent 7d96666 commit 850bae2

File tree

5 files changed

+55
-7
lines changed

5 files changed

+55
-7
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
> _The Visual Studio Code Extension Manager_
44
5-
[![Build Status](https://dev.azure.com/vscode/VSCE/_apis/build/status/VSCE?branchName=master)](https://dev.azure.com/vscode/VSCE/_build/latest?definitionId=16&branchName=master) [![npm version](https://badge.fury.io/js/vsce.svg)](https://badge.fury.io/js/vsce)
5+
[![Build Status](https://dev.azure.com/vscode/VSCE/_apis/build/status/VSCE?branchName=main)](https://dev.azure.com/vscode/VSCE/_build/latest?definitionId=16&branchName=main) [![npm version](https://badge.fury.io/js/vsce.svg)](https://badge.fury.io/js/vsce)
66

77
## Requirements
88

99
- [Node.js](https://nodejs.org/en/) at least `10.x.x`
1010

1111
## Usage
1212

13-
`vsce` is meant to be mainly used as a command line tool. It can also be used a library since it exposes a small [API](https://github.com/microsoft/vscode-vsce/blob/master/src/api.ts).
13+
`vsce` is meant to be mainly used as a command line tool. It can also be used a library since it exposes a small [API](https://github.com/microsoft/vscode-vsce/blob/main/src/api.ts).
1414

1515
> **Warning:** When using vsce as a library be sure to sanitize any user input used in API calls, as a security measure.
1616

src/package.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -592,7 +592,7 @@ export class MarkdownProcessor extends BaseProcessor {
592592

593593
const account = match[1];
594594
const repositoryName = match[2].replace(/\.git$/i, '');
595-
const branchName = githubBranch ? githubBranch : 'master';
595+
const branchName = githubBranch ? githubBranch : 'HEAD';
596596

597597
return {
598598
content: `https://github.com/${account}/${repositoryName}/blob/${branchName}`,
+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# README
2+
3+
>**Important:** Once installed the checker will only update if you add the setting `"spellMD.enable": true` to your `.vscode\settings.json` file.
4+
5+
This README covers off:
6+
* [Functionality](#functionality)
7+
* [Install](#install)
8+
* [Run and Configure](#run-and-configure)
9+
* [Known Issues/Bugs](#known-issuesbugs)
10+
* [Backlog](#backlog)
11+
* [How to Debug](#how-to-debug)
12+
13+
# Functionality
14+
15+
Load up a Markdown file and get highlights and hovers for existing issues. Checking will occur as you type in the document.
16+
17+
![Underscores and hovers](https://github.com/username/repository/raw/HEAD/images/SpellMDDemo1.gif)
18+
19+
The status bar lets you quickly navigate to any issue and you can see all positions in the gutter.
20+
21+
[![Jump to issues](https://github.com/username/repository/raw/HEAD/images/SpellMDDemo2.gif)](http://shouldnottouchthis/)
22+
[![Jump to issues](https://github.com/username/repository/raw/HEAD/images/SpellMDDemo2.gif)](https://github.com/username/repository/blob/HEAD/monkey)
23+
![](https://github.com/username/repository/raw/HEAD/images/SpellMDDemo2.gif)
24+
<img src="https://github.com/username/repository/raw/HEAD/images/myImage.gif">
25+
26+
The `spellMD.json` config file is watched so you can add more ignores or change mappings at will.
27+
28+
![Add to dictionary](https://github.com/username/repository/raw/HEAD/images/SpellMDDemo3.gif)
29+
30+
![issue](https://github.com/username/repository/raw/HEAD/issue)
31+
32+
[mono](https://github.com/username/repository/blob/HEAD/monkey)
33+
[not](http://shouldnottouchthis/)
34+
[Email me](mailto:[email protected])
35+
36+
# Install
37+
This extension is published in the VS Code Gallery. So simply hit 'F1' and type 'ext inst' from there select `SpellMD` and follow instructions.
38+
39+
40+
To clone the extension and load locally...
41+
42+
```
43+
git clone https://github.com/Microsoft/vscode-SpellMD.git
44+
npm install
45+
tsc
46+
```
47+
48+
>**Note:** TypeScript 1.6 or higher is required you can check with `tsc -v` and if you need to upgrade then run `npm install -g typescript`.

src/test/fixtures/readme/readme.images.expected.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Load up a Markdown file and get highlights and hovers for existing issues. Chec
1919
The status bar lets you quickly navigate to any issue and you can see all positions in the gutter.
2020

2121
[![Jump to issues](https://github.com/username/repository/path/to/images/SpellMDDemo2.gif)](http://shouldnottouchthis/)
22-
[![Jump to issues](https://github.com/username/repository/path/to/images/SpellMDDemo2.gif)](https://github.com/username/repository/blob/master/monkey)
22+
[![Jump to issues](https://github.com/username/repository/path/to/images/SpellMDDemo2.gif)](https://github.com/username/repository/blob/HEAD/monkey)
2323
![](https://github.com/username/repository/path/to/images/SpellMDDemo2.gif)
2424
<img src="https://github.com/username/repository/path/to/images/myImage.gif">
2525

@@ -29,7 +29,7 @@ The `spellMD.json` config file is watched so you can add more ignores or change
2929

3030
![issue](https://github.com/username/repository/path/to/issue)
3131

32-
[mono](https://github.com/username/repository/blob/master/monkey)
32+
[mono](https://github.com/username/repository/blob/HEAD/monkey)
3333
[not](http://shouldnottouchthis/)
3434
[Email me](mailto:[email protected])
3535

src/test/package.test.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1807,7 +1807,7 @@ describe('MarkdownProcessor', () => {
18071807
.onFile(readme)
18081808
.then(file => read(file))
18091809
.then(actual => {
1810-
return readFile(path.join(root, 'readme.expected.md'), 'utf8').then(expected => {
1810+
return readFile(path.join(root, 'readme.default.md'), 'utf8').then(expected => {
18111811
assert.equal(actual, expected);
18121812
});
18131813
});
@@ -1924,7 +1924,7 @@ describe('MarkdownProcessor', () => {
19241924
.onFile(readme)
19251925
.then(file => read(file))
19261926
.then(actual => {
1927-
return readFile(path.join(root, 'readme.expected.md'), 'utf8').then(expected => {
1927+
return readFile(path.join(root, 'readme.default.md'), 'utf8').then(expected => {
19281928
assert.equal(actual, expected);
19291929
});
19301930
});

0 commit comments

Comments
 (0)