工具分享：清理 Markdown 中沒有引用的圖片

HuStoking發表於2022-06-02

前言：
之前，我寫筆記的工具一直都是 notion，而且沒有寫部落格的習慣。但是一是由於 notion 的伺服器在國外，有時候很不穩定；二是由於 notion 的分享很不方便，把筆記分享給別人點開連結之後還要先登入才能檢視內容。於是我又在 掘金 平臺寫了幾篇隨筆，但是掘金的文章無法通過本地 Markdown 上傳直接發表，也無法下載之前上傳過的文章，這樣一來資料不儲存在本地，以後遷移文章到別的平臺的成本也更高。
後來在 Bilibili up主 TheCW 的推薦下學會使用了 Linux 和 vim，然後就喜歡上了使用 vim 寫 Markdown 這種雙手不需要離開鍵盤的感覺。而且部落格園也開放了 Metaweblog 介面，可以很方便的將本地的筆記發表到自己的部落格園。

靈感來源

使用 vim 寫筆記不像 notion 一樣，可以隨時將不需要的圖片刪除而不會在本地留下垃圾檔案，（typora 沒怎麼用過，不知道有沒有類似的功能）而刪除了本地筆記的圖片引用之後還是會在資料夾留下垃圾圖片殘留，之前的做法是每次刪除完圖片都在資料夾裡尋找名字相同的圖片之後刪除，這種方法低效費時，於是便萌生了寫一個自動清理無引用圖片小工具的想法。

Python

本著不重複造輪子的原則，我先在國內網際網路搜尋了一番（看不懂英語），只看到 CSDN 上有人用 java 寫了一個類似的工具，但是內容不太看得懂，而且沒有提供現成的工具包下載，只有原始碼。（本人比較懶...）
這種小工具當然還是用 Python 更友好啦~ 而且我是為了寫這麼一個東西才從頭看的 Python，可以說之前對這門語言一無所知，只知道很火...... 小工具只有一個 .py 檔案：

# utf-8

如何使用

因為只有一個檔案，所以大家花一分鐘看下原始碼大概就知道了，原理極其簡單。（一個學了一下午 python 的人能寫出什麼複雜的東西）

  1. 將 .py 檔案 拷貝/移動到自己喜歡的位置，將該路徑設定為 環境變數 路徑，或者使用軟連結到 /usr/bin 目錄下

  2. 因為能力有限且開發時間較短，工作目錄必須嚴格遵循以下形式（未來可能會優化）

  .
├── imgs
│   ├── a.jpg
│   ├── b.png
│   └── c.png
├── list.md
├── note.md
└── time.md

這裡的意思是說：所有的 Markdown 檔案需要位於當前目錄下，而所有的圖片檔案需要位於 ./imgs 路徑下 （圖片資料夾的名字可以是任意，不是必須叫 imgs ）

  1. 移動到你想要清理無引用圖片的上級目錄（該目錄下應該有 a.md b.md ...... imgs/）
    例如我這裡有一個從 Notion 上下載下來的 Vue 筆記，但是我不小心在裡面加了許多其他沒用的圖片，現在想刪掉這些圖片

該目錄下只有一個 Vue-notion.md 和一個放有圖片的資料夾 vuedir

  1. 使用
python $APP_HOME/img-cleaner.py
# 原諒我這種愚蠢的寫法
  1. 這裡會提示需要你輸入放置圖片資料夾的名稱：

輸入之後按回車

沒有引用過的圖片就會被移動到 ./_trash_bin 目錄下

注意點

  • 每行最多包含一個圖片標籤 ![]() ，因為沒有關閉正則的貪婪匹配，如果多個圖片寫在一行的話則會報錯

  • 2022-6-2 更新 ：所引用圖片的檔名可以帶 空格符 ，程式碼會自動將 Markdown 內引用路徑的檔名中的 %20 轉碼為 空格符，不過只允許在檔名中出現一次 空格符

原始碼

Gitee 倉庫

# -*-coding:utf-8 -*-
import re
import shutil
import os

# 獲取工作路徑
print("請輸入你放置圖片資料夾的名稱: ")
print("注意，如果路徑含有特殊符號需要用「\」轉義")
_input = input()



# 建立 replace _trash_bin資料夾
if os.path.exists('./replace') == False:
  os.mkdir('./replace')
  print("建立資料夾成功：replace")
else:
  raise Exception("請刪除當前目錄下的 replace 資料夾後重試")

if os.path.exists('./_trash_bin') == False:
  os.mkdir('./_trash_bin')
  print("建立資料夾成功：_trash_bin")
else:
  raise Exception("請刪除當前目錄下的 _trash_bin 資料夾後重試")

# 撰寫正規表示式
# pattern = re.compile('\(.*img\/.*\..*\)')
# pattern = re.compile('\(' + _input + '\/.*\..*\)')
pattern = re.compile('\!\[.*\]\(' + _input + '\/.*\)')


# 建立需要被移動的檔案列表
find_list = []

# 獲取當前路徑下的 .md 檔案
md_finder = os.listdir('./')
md_list = []
for item in md_finder:
  # 尋找 markdown 檔案
  if item.endswith('.md') == True:
    md_list.append(item)

# 逐個讀取 .md 檔案
for md_item in md_list:
  f = open(md_item)
  md_str = f.read()
  f.close()
  result = pattern.findall(md_str)
  for i in range(len(result)):
    # 將圖片路徑逐個新增至 find_list
    index = result[i].find("]")

    # 將拿到的原始圖片路徑加工成 ./<imgs_name>/xxx.png 的形式
    add_item = "./" + _input + "/" + result[i][index + 3 + len(_input): len(result[i]) - 1]

    space_index = add_item.find("%20")
    # 如果路徑中存在 空格符
    if space_index != -1:
      add_item = add_item[0: space_index] + " " + add_item[space_index + 3:]

    # 將圖片路徑新增至 find_list
    find_list.append(add_item)

# 將所有 markdown中 引用過路徑的圖片移動至 ./replace
for item in find_list:
  shutil.move(item, './replace')
  print(item + " 移動完成")

print("----------------------")

# 將沒有引用的圖片移至 _trash_bin
img_trashs = os.listdir('./' + _input)
trash_flag = 0
for item_trash in img_trashs:
  item_trash = "./" + _input + "/" + item_trash
  trash_flag = trash_flag + 1
  shutil.move(item_trash, './_trash_bin')
  print(item_trash + " in _trash_bin")

print("----------------------")

# 刪除原本的 img 資料夾，並更改資料夾名稱
os.removedirs('./' + _input + '/')

os.rename('./replace', _input)

print(str(trash_flag) + " 個 未引用")
print("移動成功！沒有引用的圖片已經移入至 _trash_bin")

相關文章