Skip to content

Commit 4ec0218

Browse files
upupmingMolunerfinn
authored andcommitted
📦 Chore: add bump version (#32)
* 📦 Chore: add picgo bump version * 📦 Chore: substitute npm with yarn * 📦 Chore: move pre-commit to husky for using by `git cz` * 📦 Chore: finish azure pipeline & remove appveyor * 🔙 Revert: fix mistake in test script * 📝 Docs: make readme tidier * 📝 Docs: revert to details/summary tags * 📝 Docs: update license * 📝 Docs: add upupming to license
1 parent 1b6de45 commit 4ec0218

10 files changed

+1665
-3645
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@ node_modules
55
.imgs
66
.vscode
77
yarn-error.log
8+
package-lock.json

CODE_OF_CONDUCT.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Code of Conduct
2+
3+
This project has adopted the [PicGo BumpVersion convention](https://github.com/PicGo/bump-version). For more information, go to the repository and open an issue there if you have any additional questions or comments.

CONTRIBUTING.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Contributing to vs-picgo
2+
3+
We encourage and appreciate community feedback and contributions. Thank you for your interest in making `vs-picgo` better! There are several ways you can get involved.
4+
5+
## Reporting issues and suggesting new features
6+
7+
If `vs-picgo` is not working properly, please file a report in the [GitHub issue](https://github.com/PicGo/vs-picgo/issues). You should provide adequate and clean diagnostic data, such as the version of `vs-picgo` you're using, log file, etc.
8+
9+
We are happy to hear your ideas for the future of `vs-picgo`. Check the GitHub issues and see if others have
10+
submitted similar feedback. You can upvote existing feedback or submit a new suggestion.
11+
12+
We always look at upvoted items in GitHub issue when we decide what to work on next. We read all the
13+
comments as soon as possible, and we look forward to hearing your input. Remember that
14+
all community interactions must abide by the [Code of Conduct](CODE_OF_CONDUCT.md).
15+
16+
## Finding issues you can help with
17+
18+
Looking for something to work on?
19+
Issues marked [``good first issue``](https://github.com/PicGo/vs-picgo/labels/good%20first%20issue)
20+
are a good place to start.
21+
22+
You can also check the [``help wanted``](https://github.com/PicGo/vs-picgo/labels/help%20wanted) tag to find
23+
other issues to help with. If you're interested in working on a fix, leave a comment to let everyone know and to help
24+
avoid duplicated effort from others.

License renamed to LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2018 Molunerfinn & Spades
3+
Copyright (c) 2018-2019 Molunerfinn & Spades & upupming
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

+27-20
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
# vs-picgo (VSCode Plugin of PicGo)
1+
# vs-picgo
22

3-
**Guide book can also be found on [PicGo/vs-picgo](https://github.com/PicGo/vs-picgo#vs-picgo-vscode-plugin-of-picgo).**
3+
> The VSCode extension of [PicGo](https://github.com/PicGo).
44
55
[![version](https://img.shields.io/vscode-marketplace/v/Spades.vs-picgo.svg?style=flat-square&label=vscode%20marketplace)](https://marketplace.visualstudio.com/items?itemName=Spades.vs-picgo)
66
[![installs](https://img.shields.io/vscode-marketplace/d/Spades.vs-picgo.svg?style=flat-square)](https://marketplace.visualstudio.com/items?itemName=Spades.vs-picgo)
7-
[![AppVeyor](https://img.shields.io/appveyor/ci/upupming/vs-picgo.svg?style=flat-square&label=appveyor%20build)](https://ci.appveyor.com/project/PicGo/vs-picgo)
7+
[![Azure DevOps builds (branch)](https://img.shields.io/azure-devops/build/PicGo/9bbe4cd2-a9fe-4547-b13a-60ee81f12932/1/dev.svg?label=azure%20pipeline&style=flat-square)](https://dev.azure.com/PicGo/vs-picgo/_build?definitionId=1)
88
[![GitHub stars](https://img.shields.io/github/stars/PicGo/vs-picgo.svg?style=flat-square&label=github%20stars)](https://github.com/PicGo/vs-picgo)
9-
10-
> The VSCode extension of [PicGo](https://github.com/PicGo).
9+
[![PicGo Convention](https://img.shields.io/badge/picgo-convention-blue.svg?style=flat-square)](https://github.com/PicGo/bump-version)
1110

1211
## Overview
1312

14-
`vs-picgo` is a VSCode extension for uploading images to a remote image hosting service and insert the url into current active MarkDown file. It's much more efficient than other tools. And it can give us better experience of uploading images. `vs-picgo` supports 8 kinds of image hosting services, [weibo](https://picgo.github.io/PicGo-Doc/zh/guide/config.html#%E5%BE%AE%E5%8D%9A%E5%9B%BE%E5%BA%8A), [qiniu](https://picgo.github.io/PicGo-Doc/zh/guide/config.html#%E4%B8%83%E7%89%9B%E5%9B%BE%E5%BA%8A), [tcyun](https://picgo.github.io/PicGo-Doc/zh/guide/config.html#%E8%85%BE%E8%AE%AF%E4%BA%91cos), [upyun](https://picgo.github.io/PicGo-Doc/zh/guide/config.html#%E5%8F%88%E6%8B%8D%E4%BA%91), [github](https://picgo.github.io/PicGo-Doc/zh/guide/config.html#github%E5%9B%BE%E5%BA%8A), [aliyun](https://picgo.github.io/PicGo-Doc/zh/guide/config.html#%E9%98%BF%E9%87%8C%E4%BA%91oss), [imgur](https://picgo.github.io/PicGo-Doc/zh/guide/config.html#imgur%E5%9B%BE%E5%BA%8A), [SM.MS](https://sm.ms/), supported by [PicGo-Core](https://github.com/PicGo/PicGo-Core).
13+
`vs-picgo` is a VSCode extension for uploading images to a remote image hosting service and insert the url into the current editing file. It's much more efficient than other tools. And it can give us the better experience of uploading images. `vs-picgo` supports 8 kinds of image hosting services: [weibo](https://picgo.github.io/PicGo-Doc/zh/guide/config.html#%E5%BE%AE%E5%8D%9A%E5%9B%BE%E5%BA%8A), [qiniu](https://picgo.github.io/PicGo-Doc/zh/guide/config.html#%E4%B8%83%E7%89%9B%E5%9B%BE%E5%BA%8A), [tcyun](https://picgo.github.io/PicGo-Doc/zh/guide/config.html#%E8%85%BE%E8%AE%AF%E4%BA%91cos), [upyun](https://picgo.github.io/PicGo-Doc/zh/guide/config.html#%E5%8F%88%E6%8B%8D%E4%BA%91), [github](https://picgo.github.io/PicGo-Doc/zh/guide/config.html#github%E5%9B%BE%E5%BA%8A), [aliyun](https://picgo.github.io/PicGo-Doc/zh/guide/config.html#%E9%98%BF%E9%87%8C%E4%BA%91oss), [imgur](https://picgo.github.io/PicGo-Doc/zh/guide/config.html#imgur%E5%9B%BE%E5%BA%8A) and [SM.MS](https://sm.ms/), which are supported by [PicGo-Core](https://github.com/PicGo/PicGo-Core). And the plugin feature of PicGo-Core is working in progress.
1514

15+
## Features
1616

1717
<details>
1818
<summary>Uploading an image from clipboard</summary>
@@ -30,16 +30,24 @@
3030
</details>
3131

3232
<details>
33-
<summary>Selection as image name</summary>
33+
<summary>Use selection text as the uploaded `fileName`</summary>
3434
<img src="https://i.loli.net/2019/04/09/5cac180fb1dc7.gif" alt="selection.gif">
3535
<b>Notice: These characters: <code>\$</code>, <code>:</code>, <code>/</code>, <code>?</code> and newline will be ignored in the image name. </b>(Because they are invalid for file names.)
3636
</details>
3737

38+
## Keyboard shortcuts
39+
40+
**You can change all the shortcuts below as you wish.**
41+
42+
| OS | Uploading an image from clipboard | Uploading images from explorer | Uploading an image from input box |
43+
| ------------ | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
44+
| Windows/Unix | <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>U</kbd> | <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>E</kbd> | <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>O</kbd> |
45+
| OsX | <kbd>Cmd</kbd> + <kbd>Opt</kbd> + <kbd>U</kbd> | <kbd>Cmd</kbd> + <kbd>Opt</kbd> + <kbd>E</kbd> | <kbd>Cmd</kbd> + <kbd>Opt</kbd> + <kbd>O</kbd> |
3846

3947
## Settings
4048

4149
- out of box
42-
- We could use `vs-picgo` without any setting.
50+
- We could use `vs-picgo` without any settings.
4351
- The default image hosting is [SM.MS](https://sm.ms/).
4452
- custom
4553

@@ -80,7 +88,9 @@
8088

8189
Suggested settings for [`PicGo-electron`](https://github.com/Molunerfinn/PicGo) users (See [PicGo configuration path](https://picgo.github.io/PicGo-Doc/zh/guide/config.html#%E9%85%8D%E7%BD%AE%E6%89%8B%E5%86%8C) for more information):
8290

83-
**Notice: `YOUR_HOME_DIR` should be replaced by the path of current user path.**
91+
<details>
92+
93+
**Notice: `YOUR_HOME_DIR` should be replaced by the path of your current user path.**
8494

8595
```json
8696
// Windows
@@ -112,23 +122,20 @@
112122
1. `vs-picgo` will use the same configuration as `PicGo-electron`.
113123
2. `PicGo-electron` will display all the uploaded images by `vs-picgo` in its gallery.
114124

115-
## Keyboard shortcuts
116-
117-
**You can change all the shortcuts below as you wish.**
118-
119-
| OS | Uploading an image from clipboard | Uploading images from explorer | Uploading an image from input box |
120-
| ------------ | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
121-
| Windows/Unix | <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>U</kbd> | <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>E</kbd> | <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>O</kbd> |
122-
| OsX | <kbd>Cmd</kbd> + <kbd>Opt</kbd> + <kbd>U</kbd> | <kbd>Cmd</kbd> + <kbd>Opt</kbd> + <kbd>E</kbd> | <kbd>Cmd</kbd> + <kbd>Opt</kbd> + <kbd>O</kbd> |
125+
</details>
123126

124127
## Migration
125128

126-
- From ^1.0.0
129+
- From ^1.0.0 to ^2.x
127130
- External configuration file property has changed, from `picgo.path` to `picgo.configPath`.
128131

129-
## Usage
132+
## Versioning
133+
134+
For the versions available, see the [tags on PicGo/vs-picgo](https://github.com/PicGo/vs-picgo/tags). ChangeLogs can be found at [CHANGELOG.md](CHANGELOG.md). All the dev builds can be found on [Azure](https://dev.azure.com/upupming/vs-picgo/_build?definitionId=1), and you can just open the build of a specific commit, and go to the Summary tab to download the artifacts.
135+
136+
## Contributing
130137

131-
- Find `vs-picgo` in the extension store, and install `vs-picgo`. You can use `vs-picgo` on installation finished.
138+
Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
132139

133140
## Contributors
134141

appveyor.yml

-12
This file was deleted.

azure-pipelines.yml

+5-4
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,8 @@ jobs:
103103
pathtoPublish: '$(Build.ArtifactStagingDirectory)'
104104
artifactName: vs-picgo-dev-build-Linux
105105
trigger:
106-
- master
107-
- dev
108-
- dev-dora
109-
- dev-spades
106+
branches:
107+
include:
108+
- '*' # must quote since "*" is a YAML reserved character; we want a string
109+
pr:
110+
- dev*

0 commit comments

Comments
 (0)