Merge pull request #81 from metafates/dev

mangal 3.5.0

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -1,6 +1,6 @@
 name: Bug Report
 description: File a bug report
-labels: ["bug"]
+labels: [ "bug" ]
 body:
   - type: textarea
     attributes:

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -1,6 +1,6 @@
 name: Feature request
 description: Suggest an idea for this project
-labels: ["feature"]
+labels: [ "feature" ]
 body:
   - type: textarea
     attributes:

.github/workflows/release.yml

@@ -3,8 +3,8 @@ name: goreleaser
 on:
   workflow_dispatch:
   push:
-      tags:
-        - '*'
+    tags:
+      - '*'
 
 permissions:
   contents: write
@@ -15,30 +15,24 @@ jobs:
   goreleaser:
     runs-on: ubuntu-latest
     steps:
-      -
-        name: Checkout
+      - name: Checkout
         uses: actions/checkout@v2
         with:
           fetch-depth: 0
-      -
-        name: Fetch all tags
+      - name: Fetch all tags
         run: git fetch --force --tags
-      -
-        name: Set up Go
+      - name: Set up Go
         uses: actions/setup-go@v2
         with:
           go-version: 1.18
-      -
-        name: Login to Docker Hub
+      - name: Login to Docker Hub
         uses: docker/login-action@v1
         with:
           username: ${{ secrets.DOCKER_HUB_USERNAME }}
           password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
-      -
-        name: Set up Docker Buildx
+      - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v1
-      -
-        name: Run GoReleaser
+      - name: Run GoReleaser
         uses: goreleaser/goreleaser-action@v2
         with:
           distribution: goreleaser

.github/workflows/test.yml

@@ -2,26 +2,35 @@ name: Test
 
 on:
   push:
-    branches: 
-      - main
-    tags:
-      - '*'
-
-  pull_request:
     branches:
       - main
+  pull_request:
 
 jobs:
+  test:
+    name: Test
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ ubuntu-latest, macos-latest, windows-latest ]
+
+    env:
+      GOFLAGS: -mod=readonly
 
-  build:
-    runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+      - uses: actions/checkout@v3
+
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: 1.18
+
+      - name: Test
+        run: go test -race -v ./...
+        if: runner.os != 'Windows'
 
-    - name: Set up Go
-      uses: actions/setup-go@v3
-      with:
-        go-version: 1.18
+      - name: Test (without race detector)
+        run: go test -v ./...
+        if: runner.os == 'Windows'
 
-    - name: Test
-      run: go test -v ./...

.goreleaser.yaml

@@ -2,20 +2,36 @@ before:
   hooks:
     - go mod tidy
     - go generate ./...
+
 builds:
   - env:
       - CGO_ENABLED=0
     goos:
       - linux
       - windows
       - darwin
+    goarch:
+      - "386"
+      - amd64
+      - arm
+      - arm64
+    flags:
+      - -trimpath
+
 archives:
   - replacements:
       darwin: Darwin
       linux: Linux
       windows: Windows
       386: i386
       amd64: x86_64
+    format_overrides:
+      - goos: windows
+        format: zip
+    files:
+      - completions/*
+      - README.md
+      - LICENSE
 
 checksum:
   name_template: 'checksums.txt'
@@ -43,26 +59,26 @@ changelog:
       order: 9999
   filters:
     exclude:
-      - '^test:'
+      - '^test'
       - '^chore'
+      - '^refactor'
+      - '^build'
       - 'merge conflict'
       - Merge pull request
       - Merge remote-tracking branch
       - Merge branch
       - go mod tidy
 
 dockers:
-  -
-    goos: linux
+  - goos: linux
     goarch: amd64
     image_templates:
-    - "metafates/mangal:latest"
+      - "metafates/mangal:latest"
     skip_push: false
     use: docker
 
 brews:
-  -
-    name: mangal
+  - name: mangal
 
     tap:
       owner: metafates
@@ -85,6 +101,9 @@ brews:
 
     install: |-
       bin.install "mangal"
+      bash_completion.install "completions/mangal.bash" => "mangal"
+      zsh_completion.install "completions/mangal.zsh" => "_mangal"
+      fish_completion.install "completions/mangal.fish"
 
 scoop:
   bucket:
@@ -113,10 +132,15 @@ release:
 
   draft: false
   name_template: "{{.ProjectName}} v{{.Version}}"
+  footer: |
+    **Full Changelog**: https://github.com/metafates/mangal/compare/{{ .PreviousTag }}...{{ .Tag }}
+
+    ---
+
+    Bugs? Suggestions? [Open an issue](https://github.com/metafates/mangal/issues/new/choose)
 
 nfpms:
-  -
-    file_name_template: "{{ .ConventionalFileName }}"
+  - file_name_template: "{{ .ConventionalFileName }}"
     homepage: https://github.com/metafates/mangal
     maintainer: metafates <[email protected]>
     description: |-
@@ -127,10 +151,28 @@ nfpms:
       - deb
       - rpm
 
-    bindir: /usr/bin
+    bindir: /usr/local/bin
     section: utils
 
     deb:
       lintian_overrides:
         - statically-linked-binary
         - changelog-file-missing-in-native-package
+
+    contents:
+      - src: ./completions/mangal.bash
+        dst: /usr/share/bash-completion/completions/mangal
+        file_info:
+          mode: 0644
+      - src: ./completions/mangal.fish
+        dst: /usr/share/fish/completions/mangal.fish
+        file_info:
+          mode: 0644
+      - src: ./completions/mangal.zsh
+        dst: /usr/share/zsh/vendor-completions/_mangal
+        file_info:
+          mode: 0644
+      - src: ./LICENSE
+        dst: /usr/share/doc/mangal/copyright
+        file_info:
+          mode: 0644

CHANGELOG.md

@@ -0,0 +1,147 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com), and this project adheres to
+[Semantic Versioning](https://semver.org).
+
+## 3.5.0
+
+- `mangal update` command added to update itself
+- `mangal gen` command added to generate a template for custom source
+- Added `--raw` flag for the `sources` command to print without headers
+- Added `--downloads` flag for the `where` command to print location of the downloads directory
+- Option to show all languages in mangadex by setting `mangadex.language = 'any'` in the config.
+- Show chapter index in the TUI history list
+- Fixed bug where pressing <kbd>confirm</kbd> button with empty history would cause mangal to crash
+- Fixed bug where error message would not fit the screen
+- Fixed bug when `mangal config init --force` would ignore `--force` flag
+- Internal performance improvements
+
+## 3.4.1
+
+- Option to continue downloading chapters after fail
+- Option to redownload failed chapters
+- Option to select custom reader app for each format
+- Option to skip images with unsupported formats by converter (e.g. pdf converter will skip .gif images) (#77)
+- Option to specify custom repository for `mangal install` command
+- Fixed error when using custom readers was not possible
+- Highlight <kbd>read</kbd> button in the chapters list
+- Make `mangal env` more compact, add `--filter` argument to filter out unset variables
+- Show `MANGAL_CONFIG_PATH` in the `env` command
+- Show better error when chapter could not be opened by reader
+- Fix chapters range selector in inline mode (#76)
+- Show progress when initializing source from history
+- Show size of a downloading chapter
+
+## 3.3.0
+
+- Inline mode added. See `mangal help inline`
+- Option to choose default source added
+- Show `read` button in help menu
+- Bug fixes and improvements
+
+## 3.2.1
+
+- Fix home variable in config
+
+## 3.2.0
+
+- New command added mangal install to install scrapers from mangal-scrapers repo
+- Added an option to remove a single entry from history by pressing d
+- Added an option to download chapters without creating manga directory
+- Dependencies updated
+- Bug fixes and improvements
+
+## 3.1.0
+
+- `where` command now prints to stdout. It can be used like that: `cd $(mangal where --config)`
+- Mini mode was completely rewritten to look exactly like [ani-cli](https://github.com/pystardust/ani-cli)
+- PDF is a default export format now (was plain)
+- Plain icons are default now (were emoji)
+- New icons added - "squares"
+- New command `mangal config remove` to... well... remove config
+- Minor bug fixes and improvements
+
+## 3.0.3
+
+- Better path handling
+- Use pdf a default format
+
+## 3.0.2
+
+- Fix bug where empty config would case errors
+
+## 3.0.1
+
+- Bug fixes...
+
+## 3.0.0
+
+- Full rewrite of the mangal
+- Add support for Lua scrapers
+- Better TUI
+- Mini mode
+
+## 2.2.0
+
+- History mode added. Now you can resume your readings by launching mangal with `mangal --resume` flag (`-r` for short)
+- Support for new environment variables added
+- `mangal env` command added to list all env variables and their values (if any set)
+- ComicInfo.xml file fixed #53
+
+## 2.1.1
+
+- `doctor` command now shows more information about errors
+- minor bug fixes and performance improvements
+
+## 2.1.0
+
+- Significant performance improvements! 🚀
+- Reduced disk usage
+- Add support for env variables `MANGAL_CONFIG_PATH` and `MANGAL_DOWNLOAD_PATH`
+- Improved config structure (breaking change, reinitialize your config if you have one)
+- ComicInfo.xml support added for CBZ format #27
+- `config init --clean` flag added that creates config without additional comments
+- `config remove` command added to delete user config
+
+## 2.0.1
+
+- Fixed #36
+- Small shell completion improvements
+
+## 2.0.0
+
+- Anilist integration BETA
+- Diagnostics command `mangal doctor`
+- `mangal check-update` renamed to `mangal latest`
+- Custom naming templates for chapters (like this `[%d] %s`)
+- Bug fixes
+- Faster config parser (up to 5x faster!)
+- Minor improvements
+
+## 1.5.2
+
+- Command to check for update added `mangal check-update` #26
+- Scraper system improved
+- Fixed bug where chapters with colon in title would not open for read on windows #24
+- Various bug fixes
+
+## 1.5.1
+
+- Fixes #21, #20
+
+## 1.5.0
+
+- Epub format added
+- Move UI related configurations to [ui] section in the config file
+- New command `formats` added to show available formats and their description
+- Minor improvements
+
+## 1.4.2
+
+- Fixes #15
+
+## 1.4.1
+
+- Multiple formats support