broken links

Pemeriksa tautan rusak

Alat ini menggosok semua halaman dalam URL tertentu dan memeriksa apakah tautan tujuan ada. Ini melaporkan halaman asli, teks jangkar, URL tujuan, dan apakah tautannya berfungsi atau tidak. Jika salah satu tautan tidak berfungsi, alat keluar dengan kode kesalahan. Ini juga memberikan ringkasan analisis.

Ini dapat dijalankan sebagai tindakan GitHub , sebagai alat baris perintah dan sebagai wadah Docker .

• Penggunaan Tindakan GitHub
• Penggunaan Alat Baris Perintah (PYPI)
• Penggunaan gambar Docker

Penggunaan Tindakan GitHub

Alat ini juga dapat digunakan sebagai tindakan GitHub untuk secara otomatis memeriksa tautan di repositori Anda.

Input

• url (Opsional): URL dasar untuk mulai mengikis. Default adalah http://localhost:4444/ .
• only-errors (opsional): Jika diatur ke true, hanya kesalahan tampilan. Default false .
• ignore-file (opsional): Path ke file abaikan. Default adalah ./check-ignore . Jika parameter diatur dan file tidak ada, tindakan keluar dengan kesalahan. Lihat Abaikan bagian Format File di atas untuk informasi lebih lanjut.

Abaikan format file

File abaikan harus berisi satu pola URL per baris. Pola dapat mencakup wildcard (*) untuk mencocokkan beberapa URL. Berikut beberapa contoh:

• http://example.com/ignore-this-page url khusus ini.
• http://example.com/ignore/* - mengabaikan semua url yang dimulai dengan http://example.com/ignore/ .
• */ignore-this-path/* -mengabaikan semua URL yang berisi /ignore-this-path/ .
• https://*.domain.com* - mengabaikan semua subdomain dari domain.com seperti https://sub.domain.com atau https://sub2.domain.com/page , dll.

Output

Tindakan ini tidak menghasilkan output apa pun. Namun, pada akhir analisis, ia mencetak ringkasan hasil dengan:

• Jumlah halaman yang dianalisis
• Jumlah tautan yang dianalisis
• Jumlah total tautan yang berfungsi
• Jumlah total tautan yang tidak berfungsi
• Jumlah tautan eksternal yang berfungsi
• Jumlah tautan eksternal yang tidak berfungsi
• Jumlah tautan internal yang berfungsi
• Jumlah tautan internal yang tidak berfungsi

Contoh Penggunaan

Penggunaan Dasar (URL Eksternal)

 name : Broken-links Checker

on : [push]

jobs :
  check-links :
    runs-on : ubuntu-latest
    steps :
      - name : Checkout repository
        uses : actions/checkout@v2

      - name : Run Link Checker
        uses : merlos/[email protected]
        with :
          url : ' http://example.com '
          only-errors : ' true ' 

Periksa tautan dengan mkdocs

 name : MkDocs Preview and Link Check

on :
  push :
    branches :
      - main

jobs :
  preview_and_check :
    runs-on : ubuntu-latest

    steps :
      - name : Checkout repository
        uses : actions/checkout@v2

      - name : Set up Python
        uses : actions/setup-python@v2
        with :
          python-version : ' 3.x '

      - name : Install dependencies
        run : |
          python -m pip install --upgrade pip
          pip install mkdocs mkdocs-material

      - name : Run MkDocs server
        run : mkdocs serve -a 0.0.0.0:4444 &
        continue-on-error : true

      - name : Wait for server to start
        run : sleep 10

      - name : Run Link Checker
        uses : merlos/[email protected]
        with :
          url : ' http://localhost:4444 '
          only-errors : ' true '
          ignore-file : ' ./check-ignore ' 

Periksa tautan dengan kuarto

 name : Quarto Preview and Link Check

on :
  push :
    branches :
      - main

jobs :
  preview_and_check :
    runs-on : ubuntu-latest

    steps :
      - name : Checkout repository
        uses : actions/checkout@v2

      - name : Set up Quarto
        uses : quarto-dev/quarto-actions/setup@v2

      - name : Render Quarto project
        run : quarto preview --port 444 &
        continue-on-error : true

      - name : Wait for server to start
        run : sleep 10

      - name : Run Link Checker
        uses : merlos/[email protected]
        with :
          url : ' http://localhost:444 '
          only-errors : ' true '
          ignore-file : ' ./check-ignore ' 

Penggunaan alat baris perintah

Instalasi

1. Instal paket:

   pip install broken-links

2. Gunakan perintah broken-links :

broken-links http://example.com --only-error --ignore-file ./check-ignore

Argumen baris perintah:

• url (Opsional): URL dasar untuk mulai mengikis. Default adalah http://localhost:4444/ .
• --only-error atau -o (opsional): Jika diatur, hanya tampilan kesalahan. Default false .
• --ignore-file atau -i (Opsional): Path to the Abaikan file. Default adalah ./check-ignore . Jika parameter tidak diatur dan file tidak ada, ia memeriksa semua tautan. Jika parameter diatur dan file tidak ada, alat keluar dengan kesalahan.

Format file abaikan dijelaskan di bagian [abaikan file format (#abaikan file-format) di atas.

Penggunaan gambar Docker

Gambar Docker telah dibangun untuk arsitektur ini: arm64 , amd64 , dan arm7 dan telah dirilis di Docker-Hub dan Github Container Registy

1. Dapatkan gambarnya

docker pull merlos/broken-links:latest
# or from GitHub Container Registry
docker pull ghcr.io/merlos/broken-links:latest

2. Jalankan wadah

docker run -ti merlos/broken-links https://www.example.com

Argumennya sama dengan baris perintah ( url , --only-error , --ignore-file ) seperti yang dijelaskan di atas. Opsi -ti yang digunakan dengan docker Run menampilkan output perintah saat dihasilkan.

Untuk menggunakan argumen --ignore-file Anda perlu memasang volume. Misalnya:

docker run -ti -v /path/on/host/to/ignore-file:/ignore-file merlos/broken-links https://www.example.com --ignore-file /ignore-file

Perkembangan

Telah dikembangkan menggunakan Python. Jadi, Anda harus menginstal python di sistem Anda.

Klon Repositori:

git clone https://github.com/merlos/broken-links
cd broken-links

Tetapkan lingkungan virtual:

python -m venv venv
source venv/bin/activate

Instal Paket dalam Mode Edit ( -e )

pip install -e .

Mulai Coding!

Bangun gambar Docker

docker build -t broken-links . 

docker run --rm broken-links http://example.com --only-error 

Tes

Untuk menjalankan tes, gunakan perintah berikut:

python -m unittest discover tests

Berkontribusi

Garpu dan kirim permintaan tarik. Harap perbarui/tambahkan tes unit.

Lisensi

Proyek ini dilisensikan berdasarkan ketentuan Lisensi Publik Umum GNU v3.0 oleh Merlos.