From 850bae2aeb7450c4441afe851f2a0eb9fbc54a2f Mon Sep 17 00:00:00 2001 From: Felipe Santos Date: Thu, 4 Mar 2021 10:32:46 -0300 Subject: [PATCH] Use HEAD as default branch rather than master --- README.md | 4 +- src/package.ts | 2 +- src/test/fixtures/readme/readme.default.md | 48 +++++++++++++++++++ .../fixtures/readme/readme.images.expected.md | 4 +- src/test/package.test.ts | 4 +- 5 files changed, 55 insertions(+), 7 deletions(-) create mode 100644 src/test/fixtures/readme/readme.default.md diff --git a/README.md b/README.md index b287d73a..11378aa7 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ > _The Visual Studio Code Extension Manager_ -[![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) +[![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) ## Requirements @@ -10,7 +10,7 @@ ## Usage -`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). +`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). > **Warning:** When using vsce as a library be sure to sanitize any user input used in API calls, as a security measure. diff --git a/src/package.ts b/src/package.ts index 75e51ff2..2e825c99 100644 --- a/src/package.ts +++ b/src/package.ts @@ -592,7 +592,7 @@ export class MarkdownProcessor extends BaseProcessor { const account = match[1]; const repositoryName = match[2].replace(/\.git$/i, ''); - const branchName = githubBranch ? githubBranch : 'master'; + const branchName = githubBranch ? githubBranch : 'HEAD'; return { content: `https://github.com/${account}/${repositoryName}/blob/${branchName}`, diff --git a/src/test/fixtures/readme/readme.default.md b/src/test/fixtures/readme/readme.default.md new file mode 100644 index 00000000..311ed321 --- /dev/null +++ b/src/test/fixtures/readme/readme.default.md @@ -0,0 +1,48 @@ +# README + +>**Important:** Once installed the checker will only update if you add the setting `"spellMD.enable": true` to your `.vscode\settings.json` file. + +This README covers off: +* [Functionality](#functionality) +* [Install](#install) +* [Run and Configure](#run-and-configure) +* [Known Issues/Bugs](#known-issuesbugs) +* [Backlog](#backlog) +* [How to Debug](#how-to-debug) + +# Functionality + +Load up a Markdown file and get highlights and hovers for existing issues. Checking will occur as you type in the document. + +![Underscores and hovers](https://github.com/username/repository/raw/HEAD/images/SpellMDDemo1.gif) + +The status bar lets you quickly navigate to any issue and you can see all positions in the gutter. + +[![Jump to issues](https://github.com/username/repository/raw/HEAD/images/SpellMDDemo2.gif)](http://shouldnottouchthis/) +[![Jump to issues](https://github.com/username/repository/raw/HEAD/images/SpellMDDemo2.gif)](https://github.com/username/repository/blob/HEAD/monkey) +![](https://github.com/username/repository/raw/HEAD/images/SpellMDDemo2.gif) + + +The `spellMD.json` config file is watched so you can add more ignores or change mappings at will. + +![Add to dictionary](https://github.com/username/repository/raw/HEAD/images/SpellMDDemo3.gif) + +![issue](https://github.com/username/repository/raw/HEAD/issue) + +[mono](https://github.com/username/repository/blob/HEAD/monkey) +[not](http://shouldnottouchthis/) +[Email me](mailto:example@example.com) + +# Install +This extension is published in the VS Code Gallery. So simply hit 'F1' and type 'ext inst' from there select `SpellMD` and follow instructions. + + +To clone the extension and load locally... + +``` +git clone https://github.com/Microsoft/vscode-SpellMD.git +npm install +tsc +``` + +>**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`. diff --git a/src/test/fixtures/readme/readme.images.expected.md b/src/test/fixtures/readme/readme.images.expected.md index 19dc6d7f..c0f6ec21 100644 --- a/src/test/fixtures/readme/readme.images.expected.md +++ b/src/test/fixtures/readme/readme.images.expected.md @@ -19,7 +19,7 @@ Load up a Markdown file and get highlights and hovers for existing issues. Chec The status bar lets you quickly navigate to any issue and you can see all positions in the gutter. [![Jump to issues](https://github.com/username/repository/path/to/images/SpellMDDemo2.gif)](http://shouldnottouchthis/) -[![Jump to issues](https://github.com/username/repository/path/to/images/SpellMDDemo2.gif)](https://github.com/username/repository/blob/master/monkey) +[![Jump to issues](https://github.com/username/repository/path/to/images/SpellMDDemo2.gif)](https://github.com/username/repository/blob/HEAD/monkey) ![](https://github.com/username/repository/path/to/images/SpellMDDemo2.gif) @@ -29,7 +29,7 @@ The `spellMD.json` config file is watched so you can add more ignores or change ![issue](https://github.com/username/repository/path/to/issue) -[mono](https://github.com/username/repository/blob/master/monkey) +[mono](https://github.com/username/repository/blob/HEAD/monkey) [not](http://shouldnottouchthis/) [Email me](mailto:example@example.com) diff --git a/src/test/package.test.ts b/src/test/package.test.ts index e86d5a5f..1e10ebed 100644 --- a/src/test/package.test.ts +++ b/src/test/package.test.ts @@ -1807,7 +1807,7 @@ describe('MarkdownProcessor', () => { .onFile(readme) .then(file => read(file)) .then(actual => { - return readFile(path.join(root, 'readme.expected.md'), 'utf8').then(expected => { + return readFile(path.join(root, 'readme.default.md'), 'utf8').then(expected => { assert.equal(actual, expected); }); }); @@ -1924,7 +1924,7 @@ describe('MarkdownProcessor', () => { .onFile(readme) .then(file => read(file)) .then(actual => { - return readFile(path.join(root, 'readme.expected.md'), 'utf8').then(expected => { + return readFile(path.join(root, 'readme.default.md'), 'utf8').then(expected => { assert.equal(actual, expected); }); });