Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/PicGo/picgo-plugin-pic-migrater

:truck:A PicGo plugin for pictures in markdown files migrating from one picBed to another one.
https://github.com/PicGo/picgo-plugin-pic-migrater

picgo picgo-plugin

Last synced: about 2 months ago
JSON representation

:truck:A PicGo plugin for pictures in markdown files migrating from one picBed to another one.

Host: GitHub
URL: https://github.com/PicGo/picgo-plugin-pic-migrater
Owner: PicGo
License: mit
Created: 2019-01-20T15:49:13.000Z (almost 6 years ago)
Default Branch: dev
Last Pushed: 2023-08-03T06:33:14.000Z (over 1 year ago)
Last Synced: 2024-11-06T01:04:37.084Z (2 months ago)
Topics: picgo, picgo-plugin
Language: TypeScript
Homepage:
Size: 376 KB
Stars: 143
Watchers: 3
Forks: 16
Open Issues: 14
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: License

Awesome Lists containing this project

Awesome-PicGo - picgo-plugin-pic-migrater

README

        ## picgo-plugin-pic-migrater

[![PicGo Convention](https://img.shields.io/badge/picgo-convention-blue.svg?style=flat-square)](https://github.com/PicGo/bump-version)

A PicGo plugin for pictures in markdown files migrating from one picBed to another one.

[中文说明](https://github.com/PicGo/picgo-plugin-pic-migrater/blob/master/README_CN.md)

## Features

1. **This plugin can be used in [CLI](https://github.com/PicGo/PicGo-Core) & [GUI](https://github.com/Molunerfinn/PicGo) version of PicGo!**

2. It supports absolute and relative path of images, and the url path of images.

3. It supports both markdown format and html format image url in markdown file. (Since v1.3.0)

For example, a `test.md`:

```md

![](./js.jpg)

![](http://xxx.com/js.jpg)



```

if you choose `imgur` as your migrated picBed, after migrating:

```md

![](https://i.imgur.com/xxx.jpg)

![](https://i.imgur.com/xxxx.jpg)



```

## Version required

`picgo-plugin-pic-migrater <= 1.2.2` requires PicGo-GUI version `2.0.2 ~ 2.2.0`, PicGo-Cli version `1.4.0 ~ 1.5.0-`.

`picgo-plugin-pic-migrater > 1.2.2` requires PicGo-GUI version `2.3.0 ~ latest beta`, PicGo-Cli version `1.5.0-alpha.1 ~ latest alpha`.

## Installation

### CLI

```bash

picgo install pic-migrater

```

Then `pic-migrater` will registe a command named `migrate`.

### GUI

> search for pic-migrater

![](https://raw.githubusercontent.com/Molunerfinn/test/master/test/pic-migrater.png)

## Configuration

Please configurate this plugin first!

After migrating, a new markdown file will be written in the same folder. So you should configurate this new file name's suffix first.

### CLI

```bash

picgo set plugin pic-migrater

```

### GUI

Open the setting page in the menu of the plugin.

![](https://raw.githubusercontent.com/Molunerfinn/test/master/test/GUI-prefix.png)

### Details

#### newFileSuffix

![](https://raw.githubusercontent.com/Molunerfinn/test/master/test/CLI-prefix.png)

For example, if your origin file named `2019.md` & if you set the `newFileSuffix` to `_new`, then after migrating, a new file named `2019_new.md` will be created.

#### include

If you set the `include` configuration then migrator will only migrate the files' path or url which match the `include`.

For example, if your set the `include` to `sinaimg.cn`， then migrator will only migrate the url or path includes `sinaimg.cn`.

#### exclude

If you set the `exclude` configuration then migrator will only migrate the files' path or url which don't match the `exclude`.

For example, if your set the `exclude` to `sinaimg.cn`， then migrator will only migrate the url or path doesn't includes `sinaimg.cn`.

#### oldContentWriteToNewFile

> Since v1.3.0

If you set the `oldContentWriteToNewFile` to `true`, then the old content will be written to the new file and the migrated content will be written to the old file.

## Usage

### CLI

```bash

$ picgo migrate -h

Usage: migrate [options] 

migrating pictures url from markdown files

Options:

  -h, --help  output usage information

Note:

You should configurate this plugin first!

picgo set plugin pic-migrater

Examples:

  # migrate file or files

  $ picgo migrate ./test.md ./test1.md

  # migrate markdown files in folder

  $ picgo migrate ./test/

```

### GUI

![](https://raw.githubusercontent.com/Molunerfinn/test/master/test/pic-migrater-gui.png)

### Node.js Project（v1.2.3+）

```js

const { PicGo } = require('picgo')

const PluginMigrater = require('picgo-plugin-pic-migrater')

const picgo = new PicGo()

picgo.setConfig({

  'picgo-plugin-pic-migrater': {

    newFileSuffix: '_new',

    include: '',

    exclude: ''

  }

})

const plugin = PluginMigrater(picgo)

plugin.migrateFiles(['/xxx/yyy.md']) // { total: number, success: number }

```

## Thanks

Thanks to [@Moyf](https://github.com/Moyf) with the python version of this plugin.