piclist 1.9.10 → 1.9.12

package/.github/workflows/alpha.yml

@@ -1,22 +1,22 @@
-name: publish
-on:
-  push:
-    branches:
-      - alpha
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Clone repo
-        uses: actions/checkout@v1
-      - name: Setup node
-        uses: actions/setup-node@v1
-        with:
-          node-version: '16.x'
-          registry-url: 'https://registry.npmjs.org'
-      - name: Install modules
-        run: yarn
-      - run: npm run build
-      - run: npm publish --tag alpha --access public
-        env:
+name: publish
+on:
+  push:
+    branches:
+      - alpha
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Clone repo
+        uses: actions/checkout@v1
+      - name: Setup node
+        uses: actions/setup-node@v1
+        with:
+          node-version: '16.x'
+          registry-url: 'https://registry.npmjs.org'
+      - name: Install modules
+        run: yarn
+      - run: npm run build
+      - run: npm publish --tag alpha --access public
+        env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/docker.yml

@@ -1,42 +1,42 @@
-name: Build and Push Docker Image
-
-on:
-  push:
-    tags:
-      - '*'
-  workflow_dispatch:
-
-jobs:
-  build-and-push:
-    runs-on: ubuntu-latest
-    steps:
-    - name: Checkout Repository
-      uses: actions/checkout@v2
-
-    - name: Set up Docker Buildx
-      uses: docker/setup-buildx-action@v1
-
-    - name: Login to Docker Hub
-      uses: docker/login-action@v1
-      with:
-        username: ${{ secrets.DOCKERHUB_USERNAME }}
-        password: ${{ secrets.DOCKERHUB_ACCESS_TOKEN }}
-
-    - name: Build and Push Docker Image
-      uses: docker/build-push-action@v2
-      with:
-        context: .
-        file: ./Dockerfile
-        push: true
-        tags: kuingsmile/piclist:latest
-        platforms: linux/amd64,linux/arm64
-
-    - name: Build and Push Docker Image with Tag
-      if: startsWith(github.ref, 'refs/tags/')
-      uses: docker/build-push-action@v2
-      with:
-        context: .
-        file: ./Dockerfile
-        push: true
-        tags: kuingsmile/piclist:${{ github.ref_name }}
-        platforms: linux/amd64,linux/arm64
+name: Build and Push Docker Image
+
+on:
+  push:
+    tags:
+      - '*'
+  workflow_dispatch:
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout Repository
+      uses: actions/checkout@v2
+
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v1
+
+    - name: Login to Docker Hub
+      uses: docker/login-action@v1
+      with:
+        username: ${{ secrets.DOCKERHUB_USERNAME }}
+        password: ${{ secrets.DOCKERHUB_ACCESS_TOKEN }}
+
+    - name: Build and Push Docker Image
+      uses: docker/build-push-action@v2
+      with:
+        context: .
+        file: ./Dockerfile
+        push: true
+        tags: kuingsmile/piclist:latest
+        platforms: linux/amd64,linux/arm64
+
+    - name: Build and Push Docker Image with Tag
+      if: startsWith(github.ref, 'refs/tags/')
+      uses: docker/build-push-action@v2
+      with:
+        context: .
+        file: ./Dockerfile
+        push: true
+        tags: kuingsmile/piclist:${{ github.ref_name }}
+        platforms: linux/amd64,linux/arm64

package/.github/workflows/main.yml

@@ -1,22 +1,22 @@
-name: publish
-on:
-  push:
-    branches:
-      - master
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Clone repo
-        uses: actions/checkout@v1
-      - name: Setup node
-        uses: actions/setup-node@v1
-        with:
-          node-version: '16.x'
-          registry-url: 'https://registry.npmjs.org'
-      - name: Install modules
-        run: yarn
-      - run: npm run build
-      - run: npm publish --access public
-        env:
+name: publish
+on:
+  push:
+    branches:
+      - master
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Clone repo
+        uses: actions/checkout@v1
+      - name: Setup node
+        uses: actions/setup-node@v1
+        with:
+          node-version: '16.x'
+          registry-url: 'https://registry.npmjs.org'
+      - name: Install modules
+        run: yarn
+      - run: npm run build
+      - run: npm publish --access public
+        env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/manually.yml

@@ -1,19 +1,19 @@
-name: manually-trigger
-on: workflow_dispatch
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Clone repo
-        uses: actions/checkout@v1
-      - name: Setup node
-        uses: actions/setup-node@v1
-        with:
-          node-version: '16.x'
-          registry-url: 'https://registry.npmjs.org'
-      - name: Install modules
-        run: yarn
-      - run: npm run build
-      - run: npm publish --access public
-        env:
+name: manually-trigger
+on: workflow_dispatch
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Clone repo
+        uses: actions/checkout@v1
+      - name: Setup node
+        uses: actions/setup-node@v1
+        with:
+          node-version: '16.x'
+          registry-url: 'https://registry.npmjs.org'
+      - name: Install modules
+        run: yarn
+      - run: npm run build
+      - run: npm publish --access public
+        env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/CHANGELOG.md

@@ -1,3 +1,48 @@
+## :tada: 1.9.12 (2025-06-03)
+
+
+### :sparkles: Features
+
+* **custom:** add error handling for missing SM.MS token in uploader plugin ([b229807](https://github.com/Kuingsmile/PicList-Core/commit/b229807))
+* **custom:** improve image upload handling and error notifications in uploader plugin ([50e8dc8](https://github.com/Kuingsmile/PicList-Core/commit/50e8dc8))
+
+
+### :bug: Bug Fixes
+
+* **custom:** fix typo ([a3dc79b](https://github.com/Kuingsmile/PicList-Core/commit/a3dc79b))
+
+
+### :package: Chore
+
+* **custom:** remove unused files ([0a6827f](https://github.com/Kuingsmile/PicList-Core/commit/0a6827f))
+
+
+### :pencil: Documentation
+
+* **custom:** add DeepWiki reference to English and Chinese README files ([50c4b09](https://github.com/Kuingsmile/PicList-Core/commit/50c4b09))
+* **custom:** update readme ([abc7986](https://github.com/Kuingsmile/PicList-Core/commit/abc7986))
+
+
+
+## :tada: 1.9.11 (2025-02-27)
+
+
+### :sparkles: Features
+
+* **custom:** optimize getconfig to hot-reload ([da65a05](https://github.com/Kuingsmile/PicList-Core/commit/da65a05))
+
+
+### :bug: Bug Fixes
+
+* **custom:** fix alist output url bug ([3270f67](https://github.com/Kuingsmile/PicList-Core/commit/3270f67))
+
+
+### :pencil: Documentation
+
+* **custom:** add chinease readme.md ([08386c3](https://github.com/Kuingsmile/PicList-Core/commit/08386c3))
+
+
+
 ## :tada: 1.9.10 (2024-12-27)
 
 

package/License

@@ -1,22 +1,22 @@
-MIT License
-
-Copyright (c) 2018 Molunerfinn
-Copyright (c) 2023-present Kuingsmile
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2018 Molunerfinn
+Copyright (c) 2023-present Kuingsmile
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,35 +1,47 @@
 # PicList-Core
 
+English | [简体中文](./README_cn.md)
+
 ![standard](https://img.shields.io/badge/code%20style-standard-green.svg?style=flat-square)
 ![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg?style=flat-square)
 ![node](https://img.shields.io/badge/node-%3E%3D16.0.0-blue?style=flat-square)
 
 ![picgo-core](https://cdn.jsdelivr.net/gh/Molunerfinn/test/picgo/picgo-core-fix.jpg)
 
-A tool for picture uploading. Both CLI & api supports. It also supports plugin system, please check [Awesome-PicGo](https://github.com/PicGo/Awesome-PicGo) to find powerful plugins.
+A powerful tool for image uploading with both CLI & API support. PicList-Core extends PicGo-Core with additional features while maintaining plugin compatibility. Check out [Awesome-PicGo](https://github.com/PicGo/Awesome-PicGo) for a collection of powerful plugins.
+
+You can refer to the [DeepWiki of PiclList-Core](https://deepwiki.com/Kuingsmile/PicList-Core/) for more information.
+
+**Natively supports Typora integration**.
 
-Based on Picgo-Core and add more features.
+## Enhanced Features
 
-**Typora support natively**.
+- **Image processing capabilities**:
+  - Add watermarks, compress images, and convert formats
+  - Configure via `picgo set buildin watermark` and `picgo set buildin compress` CLI commands
+  - Processing happens during beforeTransform phase, ensuring compatibility with all plugins
 
-## New Features
+- **Advanced renaming**:
+  - Set custom rename rules via `picgo set buildin rename`
 
-- Add watermark, compress and convert image format features
-  - Set watermark and compress parameters through `picgo set buildin watermark` and `picgo set buildin compress` under CLI command
-  - Image processing is beforeTransform, which does not conflict with any plugin
-- Add support for advanced rename, you can set the rename rule through `picgo set buildin rename` under the CLI command
-- Add new built-in picbed: WebDAV, SFTP, Local path
-- Adds support for imgur account uploads
-- Built-in server just like PicList-Desktop server, you can use `picgo-server` to start the server
-- Fix several bugs of PicGo-Core
+- **Additional built-in image hosting services**:
+  - WebDAV, SFTP, Local path, AWS S3
+  - Improved Imgur support with account-based uploads
+
+- **Built-in server**:
+  - Similar to PicList-Desktop server
+  - Launch with `picgo-server` command
+
+- **Bug fixes**:
+  - Addresses several issues from the original PicGo-Core
 
 ## Installation
 
-PicList should be installed with node.js >= 16
+PicList requires Node.js >= 16
 
-### before install
+### Prerequisites
 
-As PicList depends on [sharp](https://sharp.pixelplumbing.com/), you need to install sharp before install PicList.
+PicList depends on [sharp](https://sharp.pixelplumbing.com/). Install it first:
 
 ```bash
 npm config set sharp_binary_host "https://npmmirror.com/mirrors/sharp"
@@ -113,6 +125,15 @@ docker exec -it piclist sh
 picgo install picgo-plugin-xxx
 ```
 
+#### Change config in docker
+
+You can use `docker exec` to change config in docker.
+
+```bash
+docker exec -it piclist sh
+picgo set xxx
+```
+
 ### Server
 
 You can use `picgo-server` to start a server, default port is `36677`.

package/README_cn.md

@@ -0,0 +1,249 @@
+# PicList-Core
+
+[English](./README.md) | 简体中文
+
+![standard](https://img.shields.io/badge/code%20style-standard-green.svg?style=flat-square)
+![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg?style=flat-square)
+![node](https://img.shields.io/badge/node-%3E%3D16.0.0-blue?style=flat-square)
+
+![picgo-core](https://cdn.jsdelivr.net/gh/Molunerfinn/test/picgo/picgo-core-fix.jpg)
+
+PicList-Core 是一个功能强大的图片上传工具，提供 CLI 和 API 两种调用方式。它在 PicGo-Core 的基础上增强了功能，同时保持插件兼容性。查看 [Awesome-PicGo](https://github.com/PicGo/Awesome-PicGo) 获取丰富的插件资源。
+
+你可以查看 [PiclList-Core 的 DeepWiki](https://deepwiki.com/Kuingsmile/PicList-Core/) 获取更多信息。
+
+**原生支持 Typora 集成**。
+
+## 增强功能
+
+- **图像处理能力**：
+  - 添加水印、压缩图片和转换格式
+  - 通过 `picgo set buildin watermark` 和 `picgo set buildin compress` CLI 命令进行配置
+  - 处理过程发生在 beforeTransform 阶段，确保与所有插件兼容
+
+- **高级重命名**：
+  - 通过 `picgo set buildin rename` 设置自定义重命名规则
+
+- **额外内置图床**：
+  - WebDAV、SFTP、本地路径、AWS S3
+  - 改进的 Imgur 支持，支持账户上传
+
+- **内置服务器**：
+  - 类似于 PicList-Desktop 服务器
+  - 使用 `picgo-server` 命令启动
+
+- **错误修复**：
+  - 解决了原始 PicGo-Core 的多个问题
+
+## 安装
+
+PicList 需要 Node.js >= 16
+
+### 前置条件
+
+PicList 依赖 [sharp](https://sharp.pixelplumbing.com/)，请先安装它：
+
+```bash
+npm config set sharp_binary_host "https://npmmirror.com/mirrors/sharp"
+npm config set sharp_libvips_binary_host "https://npmmirror.com/mirrors/sharp-libvips"
+npm install sharp
+```
+
+### 全局安装
+
+```bash
+npm install piclist -g
+
+# 或者
+
+yarn global add piclist
+```
+
+### 本地安装
+
+```bash
+npm install piclist -D
+
+# 或者
+
+yarn add piclist -D
+```
+
+## 使用方法
+
+### Docker
+
+你可以使用Docker运行PicList-Core。
+
+#### docker run
+
+将`./piclist`更改为你自己的路径，该路径是放置`config.json`文件的位置，并将`piclist123456`更改为你自己的密钥。
+
+```bash
+docker run -d \
+  --name piclist \
+  --restart always \
+  -p 36677:36677 \
+  -v "./piclist:/root/.piclist" \
+  kuingsmile/piclist:latest \
+  node /usr/local/bin/picgo-server -k piclist123456
+```
+
+#### docker-compose
+
+从本仓库下载`docker-compose.yml`，或将以下内容复制到`docker-compose.yml`:
+
+```yaml
+version: '3.3'
+
+services:
+  node:
+    image: 'kuingsmile/piclist:latest'
+    container_name: piclist
+    restart: always
+    ports:
+      - 36677:36677
+    volumes:
+      - './piclist:/root/.piclist'
+    command: node /usr/local/bin/picgo-server -k piclist123456
+```
+
+你可以将`./piclist`更改为你自己的路径，该路径是放置`config.json`文件的位置，并在`command`中更改密钥。
+
+然后运行:
+
+```bash
+docker-compose up -d
+```
+
+#### 在Docker中安装插件
+
+你可以使用`docker exec`在Docker中安装插件。
+
+```bash
+docker exec -it piclist sh
+picgo install picgo-plugin-xxx
+```
+
+#### 在Docker中更新配置
+
+你可以使用`docker exec`在Docker中更新配置。
+
+```bash
+docker exec -it piclist sh
+picgo set xxx
+```
+
+### 服务器
+
+你可以使用`picgo-server`启动服务器，默认端口为`36677`。
+
+启动服务器:
+
+```bash
+picgo-server
+node ./bin/picgo-server
+```
+
+> 强烈建议添加`--key`参数以避免未经授权的访问。例如：`picgo-server --key 123456`
+
+显示帮助:
+
+```bash
+$ picgo-server -h
+
+  Usage: picgo-server [options]
+
+  Options:
+
+    -h, --help          显示帮助信息
+    -c, --config        设置配置路径
+    -p, --port          设置端口，默认端口为36677
+    --host              设置主机，默认主机为0.0.0.0
+    -k, --key           设置密钥以避免未经授权的访问
+    -v, --version       显示版本号
+
+  Examples:
+    picgo-server -c /path/to/config.json
+    picgo-server -k 123456
+    picgo-server -c /path/to/config.json -k 123456
+```
+
+#### 接口
+
+- `/upload?picbed=xxx&key=xxx` 上传图片，`picbed`用于设置图床，`key`用于设置密钥
+- `/heartbeat` 心跳检测
+
+### CLI使用
+
+> PicList-Core使用`SM.MS`作为默认上传图床。
+
+显示帮助:
+
+```bash
+$ picgo -h
+
+  Usage: picgo [options] [command]
+
+  Options:
+
+    -v, --version                 输出版本号
+    -d, --debug                   调试模式
+    -s, --silent                  静默模式
+    -c, --config <path>           设置配置路径
+    -h, --help                    输出使用信息
+
+  Commands:
+
+    install|add <plugins...>             安装picgo插件
+    uninstall|rm <plugins...>            卸载picgo插件
+    update <plugins...>                  更新picgo插件
+    set|config <module> [name]           配置picgo模块
+    upload|u [input...]                  上传，开始上传
+    use [module]                         使用picgo模块
+    init [options] <template> [project]  创建picgo插件的开发模板
+```
+
+#### 从路径上传图片
+
+```bash
+picgo upload /xxx/xx/xx.jpg
+```
+
+#### 从剪贴板上传图片
+
+> 从剪贴板获取的图片将被转换为`png`格式
+
+```bash
+picgo upload
+```
+
+### 在Node项目中使用
+
+#### CommonJS
+
+```js
+const { PicGo } = require('piclist')
+```
+
+#### ES模块
+
+```js
+import { PicGo } from 'piclist'
+```
+
+#### API使用示例
+
+```js
+const picgo = new PicGo()
+
+// 从路径上传图片
+picgo.upload(['/xxx/xxx.jpg'])
+
+// 从剪贴板上传图片
+picgo.upload()
+```
+
+## 文档
+
+获取更多详细信息，请查看[PicGo-Core文档](https://picgo.github.io/PicGo-Core-Doc/)。