Init project

.JuliaFormatter.toml

@@ -0,0 +1,8 @@
+remove_extra_newlines=true
+join_lines_based_on_source=true
+whitespace_in_kwargs=false
+short_to_long_function_def=true
+always_for_in=true
+verbose=true
+margin=92
+annotate_untyped_fields_with_any=false

.github/dependabot.yml

@@ -0,0 +1,7 @@
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

.github/workflows/CI.yml

@@ -0,0 +1,40 @@
+name: CI
+on:
+  push:
+    branches:
+      - main
+    tags: ['*']
+  pull_request:
+  workflow_dispatch:
+concurrency:
+  # Skip intermediate builds: always.
+  # Cancel intermediate builds: only if it is a pull request build.
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+jobs:
+  test:
+    name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 60
+    permissions: # needed to allow julia-actions/cache to proactively delete old caches that it has created
+      actions: write
+      contents: read
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+          - 'lts'
+          - '1'
+        os:
+          - ubuntu-latest
+        arch:
+          - x64
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: ${{ matrix.version }}
+          arch: ${{ matrix.arch }}
+      - uses: julia-actions/cache@v2
+      - uses: julia-actions/julia-buildpkg@v1
+      - uses: julia-actions/julia-runtest@v1

.github/workflows/CompatHelper.yml

@@ -0,0 +1,19 @@
+name: CompatHelper
+on:
+  schedule:
+    - cron: 0 0 * * *
+  workflow_dispatch:
+jobs:
+  CompatHelper:
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+      contents: write
+    steps:
+      - name: Pkg.add("CompatHelper")
+        run: julia -e 'using Pkg; Pkg.add("CompatHelper")'
+      - name: CompatHelper.main()
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }}
+        run: julia -e 'using CompatHelper; CompatHelper.main()'

.github/workflows/TagBot.yml

@@ -0,0 +1,31 @@
+name: TagBot
+on:
+  issue_comment:
+    types:
+      - created
+  workflow_dispatch:
+    inputs:
+      lookback:
+        default: 3
+permissions:
+  actions: read
+  checks: read
+  contents: write
+  deployments: read
+  issues: read
+  discussions: read
+  packages: read
+  pages: read
+  pull-requests: read
+  repository-projects: read
+  security-events: read
+  statuses: read
+jobs:
+  TagBot:
+    if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: JuliaRegistries/TagBot@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          ssh: ${{ secrets.DOCUMENTER_KEY }}

.gitignore

@@ -0,0 +1,9 @@
+*.gif
+.CondaPkg
+.DS_Store
+/Manifest.toml
+/docs/Manifest.toml
+/docs/build/
+docs/build/
+docs/site/
+dev

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Satoshi Terasaki <[email protected]> and contributors
+
+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.

Project.toml

@@ -0,0 +1,28 @@
+name = "TerminalGat"
+uuid = "a8322826-ec82-40fc-90aa-583bcb5172ca"
+authors = ["Satoshi Terasaki <[email protected]> and contributors"]
+version = "0.1.0"
+
+[deps]
+IOCapture = "b5f81e59-6552-4d32-b1f0-c071b021bf89"
+Markdown = "d6f4376e-aef5-505a-96c1-9c027394607a"
+TerminalPager = "0c614874-6106-40ed-a7c2-2f1cd0bff883"
+gat_jll = "b88765aa-e0a2-5b02-b897-840ea4e6307e"
+
+[compat]
+Aqua = "0.8.9"
+IOCapture = "0.2"
+JET = "0.9.12"
+Markdown = "1"
+TerminalPager = "0.5"
+Test = "1"
+gat_jll = "0.19.1"
+julia = "1.10"
+
+[extras]
+Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
+JET = "c3a54625-cd67-489e-a8e7-0a5a0ff4e31b"
+Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+
+[targets]
+test = ["Aqua", "JET", "Test"]

README.md

@@ -1,8 +1,8 @@
-# TerminalGat [![Build Status](https://github.com/terasakisatoshi/TerminalGat.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/terasakisatoshi/TerminalGat.jl/actions/workflows/CI.yml?query=branch%3Amain) [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://terasakisatoshi.github.io/TerminalGat.jl/stable/) [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://terasakisatoshi.github.io/TerminalGat.jl/dev/)
+# [TerminalGat](https://github.com/AtelierArith/TerminalGat.jl) [![Build Status](https://github.com/AtelierArith/TerminalGat.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/AtelierArith/TerminalGat.jl/actions/workflows/CI.yml?query=branch%3Amain) [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://AtelierArith.github.io/TerminalGat.jl/stable/) [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://AtelierArith.github.io/TerminalGat.jl/dev/)
 
 ## Description
 
-Unofficial Julia interface for [`gat`](https://github.com/koki-develop/gat)
+This package [TerminalGat.jl](https://github.com/AtelierArith/TerminalGat.jl) provides Julia interface for [`gat`](https://github.com/koki-develop/gat). It allows to display files and images in the Julia's REPL.
 
 ## Setup
 

docs/Project.toml

@@ -0,0 +1,3 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+TerminalGat = "a8322826-ec82-40fc-90aa-583bcb5172ca"

docs/make.jl

@@ -0,0 +1,23 @@
+using TerminalGat
+using Documenter
+
+DocMeta.setdocmeta!(TerminalGat, :DocTestSetup, :(using TerminalGat); recursive=true)
+
+makedocs(;
+    modules=[TerminalGat],
+    authors="Satoshi Terasaki <[email protected]> and contributors",
+    sitename="TerminalGat.jl",
+    format=Documenter.HTML(;
+        canonical="https://atelierarith.github.io/TerminalGat.jl",
+        edit_link="main",
+        assets=String[],
+    ),
+    pages=[
+        "Home" => "index.md",
+    ],
+)
+
+deploydocs(;
+    repo="github.com/AtelierArith/TerminalGat.jl",
+    devbranch="main",
+)

docs/src/index.md

@@ -0,0 +1,14 @@
+```@meta
+CurrentModule = TerminalGat
+```
+
+# TerminalGat
+
+Documentation for [TerminalGat](https://github.com/terasakisatoshi/TerminalGat.jl).
+
+```@index
+```
+
+```@autodocs
+Modules = [TerminalGat]
+```

src/TerminalGat.jl

@@ -0,0 +1,98 @@
+module TerminalGat
+
+using Markdown: Markdown
+
+using gat_jll: gat_jll
+export gat, gess
+
+using IOCapture: IOCapture
+using TerminalPager: pager
+
+"""
+    gat(filename::AbstractString)
+
+Hightlight text This is a thin wrapper for `gat` command written in Go.
+
+if `filename` is a Markdown, the `--render-markdown` option is added.
+
+# Example
+
+```julia-repl
+julia> using TerminalGat
+julia> gat("README.md")
+julia> gat("src/TerminalGat.jl")
+```
+
+If your terminal supports Sixel, you can display images in your terminal
+
+```julia-repl
+julia> using TerminalGat
+julia> using Plots; plot(sin); savefig("sin.png")
+julia> gat("sin.png")
+```
+"""
+function gat(filename::AbstractString)
+    if splitext(filename)[end] == ".md"
+        run(`$(gat_jll.gat()) --render-markdown $(filename) --force-color`)
+    else
+        run(`$(gat_jll.gat()) $(filename) --force-color`)
+    end
+    nothing
+end
+
+"""
+    gat(md::Markdown.MD)
+
+# Example
+
+Hightlight docstrings with monokai theme
+
+```julia-repl
+julia> gat(@doc sin)
+```
+"""
+function gat(md::Markdown.MD)
+    str = sprint(show, MIME"text/plain"(), md, context=:color => false)
+    io = IOBuffer()
+    open(pipeline(`$(gat_jll.gat()) --theme monokai --force-color --lang julia`), "w", io) do f
+        println(f, str)
+    end
+    # If docstring contains an example about REPL session, we color `julia` as red `38;5;197m` that is used in the original `gat` command.
+    colored_text = replace(String(take!(io)), "julia" => "\033[38;5;197mjulia\033[0m")
+    print(colored_text)
+end
+
+"""
+    gess(filename::AbstractString)
+
+`gess` works something like `gat` + `less`:
+
+```julia-repl
+julia> using TerminalGat
+julia> gess("Project.toml")
+```
+"""
+function gess(filename::AbstractString)
+    c = IOCapture.capture() do
+        gat(filename)
+    end
+    c.output |> pager
+end
+
+"""
+    gat(md::Markdown.MD)
+
+# Example
+
+```julia-repl
+julia> gess(@doc sin)
+```
+"""
+function gess(md::Markdown.MD)
+    c = IOCapture.capture() do
+        gat(md)
+    end
+    c.output |> pager
+end
+
+end # module

test/runtests.jl

@@ -0,0 +1,12 @@
+using Test
+using TerminalGat
+using Aqua
+using JET
+
+@testset "Aqua" begin
+    Aqua.test_all(TerminalGat)
+end
+
+@testset "JET" begin
+    JET.report_package(TerminalGat, target_defined_modules=true)
+end