Commit dd887ab4dff2f47110b7f584e357e86826b76369 Parent: 2b5e93377bab6ebf38f5e06cebdd49418093d9de Author: mcol <mcol@posteo.net> Date: 2022-06-04 23:32:18 +0100 Committer: mcol <mcol@posteo.net> Committed: 2022-06-04 23:32:18 +0100 Rename project to gitja
test/test.sh Modified
@@ -1,13 +1,13 @@ #!/usr/bin/env bash : ' -Testing gitserve -================ +Testing gitja +============= Running `make test` or `./test/test.sh` from the root project folder will run -this script, which tests gitserve. +this script, which tests gitja. -Beside this file is the config file that gitserve uses. It runs using the +Beside this file is the config file that gitja uses. It runs using the templates in this folder and outputs into this folder. Then the output is compared with expected results. @@ -17,9 +17,9 @@ set -u -if [[ $(basename "$PWD") != gitserve ]] +if [[ $(basename "$PWD") != gitja ]] then - echo "The test script should be run from the gitserve root project folder." + echo "The test script should be run from the gitja root project folder." exit 1 fi @@ -34,14 +34,14 @@ "link.html" # Symbolic link at top level "style.css" # Static file at top level "static/a_nice_file" # Static folder at top level - "gitserve/index.html" # Repo scope - "gitserve/commit/0292014748caae952bbc8dd6225680d83c0a5135.html" # A commit - "gitserve/file/test.templates.style.css.html" # A plain text file + "gitja/index.html" # Repo scope + "gitja/commit/0292014748caae952bbc8dd6225680d83c0a5135.html" # A commit + "gitja/file/test.templates.style.css.html" # A plain text file "so_called_binary_file" # Static file at top level that git considers binary - "gitserve/file/test.templates.so_called_binary_file.html" # The binary file - "gitserve/file/github.FUNDING.yml.html" # HREF drops leading period - "gitserve/log.html" # Symbolic link inside repo/ - "gitserve/static/another_file" # Static folder inside repo/ + "gitja/file/test.templates.so_called_binary_file.html" # The binary file + "gitja/file/github.FUNDING.yml.html" # HREF drops leading period + "gitja/log.html" # Symbolic link inside repo/ + "gitja/static/another_file" # Static folder inside repo/ ) stack run -- -c test/config.dhall -q || exit 1
test/templates/link.html Modified
@@ -1 +1 @@ -gitserve/index.html \ No newline at end of file +gitja/index.html \ No newline at end of file
test/expected/link.html Modified
@@ -1 +1 @@ -gitserve/index.html \ No newline at end of file +gitja/index.html \ No newline at end of file
test/expected/index.html Modified
@@ -1,7 +1,7 @@ -https://github.com/m-col/gitserve +https://github.com/m-col/gitja scope: index -host: https://github.com/m-col/gitserve -repositories: gitserve - repositories[0]: gitserve - repositories[0].name: gitserve +host: https://github.com/m-col/gitja +repositories: gitja + repositories[0]: gitja + repositories[0].name: gitja repositories[0].description: 🐙 Templated web page generator for your git repositories
test/expected/gitserve/static/another_file Deleted
@@ -1 +0,0 @@
-this one is in repo/
test/expected/gitserve/log.html Deleted
@@ -1 +0,0 @@ -index.html \ No newline at end of file
test/expected/gitserve/index.html Deleted
@@ -1,12 +0,0 @@ -gitserve -scope: repository -host: https://github.com/m-col/gitserve -repos: gitserve -name: gitserve -description: 🐙 Templated web page generator for your git repositories -commits: (skipped) -tree: (skipped) -tags: 1 -branches: 1 -readme.path: README.rst -license.path: LICENSE
test/expected/gitserve/file/test.templates.style.css.html Deleted
@@ -1,22 +0,0 @@ -test/templates/style.css -scope: file -file: test/templates/style.css -file.path: test/templates/style.css -file.href: test.templates.style.css.html -file.contents: html -file.mode: Plain -file.mode_octal: 00644 -file.mode_symbolic: -rw-r--r-- -if file.is_directory then "directory" else "file": "file" - -file scope also should have data from repo scope available: -host: https://github.com/m-col/gitserve -repos: gitserve -name: gitserve -description: 🐙 Templated web page generator for your git repositories -commits: (skipped) -tree: (skipped) -tags: 1 -branches: 1 -readme.path: README.rst -license.path: LICENSE
test/expected/gitserve/file/test.templates.so_called_binary_file.html Deleted
@@ -1,22 +0,0 @@ -test/templates/so_called_binary_file -scope: file -file: test/templates/so_called_binary_file -file.path: test/templates/so_called_binary_file -file.href: test.templates.so_called_binary_file.html -file.contents: (binary) -file.mode: Plain -file.mode_octal: 00644 -file.mode_symbolic: -rw-r--r-- -if file.is_directory then "directory" else "file": "file" - -file scope also should have data from repo scope available: -host: https://github.com/m-col/gitserve -repos: gitserve -name: gitserve -description: 🐙 Templated web page generator for your git repositories -commits: (skipped) -tree: (skipped) -tags: 1 -branches: 1 -readme.path: README.rst -license.path: LICENSE
test/expected/gitserve/file/github.FUNDING.yml.html Deleted
@@ -1,23 +0,0 @@ -.github/FUNDING.yml -scope: file -file: .github/FUNDING.yml -file.path: .github/FUNDING.yml -file.href: github.FUNDING.yml.html -file.contents: github: ["m-col"] -custom: ["https://liberapay.com/mcol"] -file.mode: Plain -file.mode_octal: 00644 -file.mode_symbolic: -rw-r--r-- -if file.is_directory then "directory" else "file": "file" - -file scope also should have data from repo scope available: -host: https://github.com/m-col/gitserve -repos: gitserve -name: gitserve -description: 🐙 Templated web page generator for your git repositories -commits: (skipped) -tree: (skipped) -tags: 1 -branches: 1 -readme.path: README.rst -license.path: LICENSE
test/expected/gitserve/commit/0292014748caae952bbc8dd6225680d83c0a5135.html Deleted
@@ -1,15 +0,0 @@ -Printy print template error messages -scope: commit -commit: Printy print template error messages -commit.id: 0292014748caae952bbc8dd6225680d83c0a5135 -commit.title: Printy print template error messages -commit.body: -commit.message: Printy print template error messages -commit.author: mcol -commit.committer: mcol -commit.author_email: mcol@posteo.net -commit.committer_email: mcol@posteo.net -commit.authored: 2021-11-25 00:05:26 +0000 -commit.committed: 2021-11-25 00:05:26 +0000 -commit.encoding: utf-8 -commit.parent: 143fdb3b66c85512696406fab8d3ba525bffc675
test/expected/gitja/static/another_file Added
@@ -0,0 +1 @@
+this one is in repo/
test/expected/gitja/log.html Added
@@ -0,0 +1 @@ +index.html \ No newline at end of file
test/expected/gitja/index.html Added
@@ -0,0 +1,12 @@ +gitja +scope: repository +host: https://github.com/m-col/gitja +repos: gitja +name: gitja +description: 🐙 Templated web page generator for your git repositories +commits: (skipped) +tree: (skipped) +tags: 1 +branches: 1 +readme.path: README.rst +license.path: LICENSE
test/expected/gitja/file/test.templates.style.css.html Added
@@ -0,0 +1,22 @@ +test/templates/style.css +scope: file +file: test/templates/style.css +file.path: test/templates/style.css +file.href: test.templates.style.css.html +file.contents: html +file.mode: Plain +file.mode_octal: 00644 +file.mode_symbolic: -rw-r--r-- +if file.is_directory then "directory" else "file": "file" + +file scope also should have data from repo scope available: +host: https://github.com/m-col/gitja +repos: gitja +name: gitja +description: 🐙 Templated web page generator for your git repositories +commits: (skipped) +tree: (skipped) +tags: 1 +branches: 1 +readme.path: README.rst +license.path: LICENSE
test/expected/gitja/file/test.templates.so_called_binary_file.html Added
@@ -0,0 +1,22 @@ +test/templates/so_called_binary_file +scope: file +file: test/templates/so_called_binary_file +file.path: test/templates/so_called_binary_file +file.href: test.templates.so_called_binary_file.html +file.contents: (binary) +file.mode: Plain +file.mode_octal: 00644 +file.mode_symbolic: -rw-r--r-- +if file.is_directory then "directory" else "file": "file" + +file scope also should have data from repo scope available: +host: https://github.com/m-col/gitja +repos: gitja +name: gitja +description: 🐙 Templated web page generator for your git repositories +commits: (skipped) +tree: (skipped) +tags: 1 +branches: 1 +readme.path: README.rst +license.path: LICENSE
test/expected/gitja/file/github.FUNDING.yml.html Added
@@ -0,0 +1,23 @@ +.github/FUNDING.yml +scope: file +file: .github/FUNDING.yml +file.path: .github/FUNDING.yml +file.href: github.FUNDING.yml.html +file.contents: github: ["m-col"] +custom: ["https://liberapay.com/mcol"] +file.mode: Plain +file.mode_octal: 00644 +file.mode_symbolic: -rw-r--r-- +if file.is_directory then "directory" else "file": "file" + +file scope also should have data from repo scope available: +host: https://github.com/m-col/gitja +repos: gitja +name: gitja +description: 🐙 Templated web page generator for your git repositories +commits: (skipped) +tree: (skipped) +tags: 1 +branches: 1 +readme.path: README.rst +license.path: LICENSE
test/expected/gitja/commit/0292014748caae952bbc8dd6225680d83c0a5135.html Added
@@ -0,0 +1,15 @@ +Printy print template error messages +scope: commit +commit: Printy print template error messages +commit.id: 0292014748caae952bbc8dd6225680d83c0a5135 +commit.title: Printy print template error messages +commit.body: +commit.message: Printy print template error messages +commit.author: mcol +commit.committer: mcol +commit.author_email: mcol@posteo.net +commit.committer_email: mcol@posteo.net +commit.authored: 2021-11-25 00:05:26 +0000 +commit.committed: 2021-11-25 00:05:26 +0000 +commit.encoding: utf-8 +commit.parent: 143fdb3b66c85512696406fab8d3ba525bffc675
test/config.dhall Modified
@@ -3,7 +3,7 @@ , scan = False , template = "./test/templates" , output = "./test/result" - , host = "https://github.com/m-col/gitserve" + , host = "https://github.com/m-col/gitja" } in config
templates/stagit/index.html Modified
@@ -1,7 +1,7 @@ {% extends "template.html.include" %} {%- block title -%} -gitserve - Index +gitja - Index {%- endblock -%} {% block body %}
templates/docs/template.html.include Modified
@@ -30,7 +30,7 @@ </span> <p id="tag"> - Docs built @ <a href="{{ host }}/gitserve/commit/{{ commits[0].href }}">{{ commits[0].id[:7] }}</a> + Docs built @ <a href="{{ host }}/gitja/commit/{{ commits[0].href }}">{{ commits[0].id[:7] }}</a> </p> </div>
templates/base/index.html Modified
@@ -6,13 +6,13 @@ <h1>My git repositories</h1> <p> -This is the base template for <code>gitserve</code>. +This is the base template for <code>gitja</code>. </p> <p> -The full documentation for <code>gitserve</code>, including how templates need +The full documentation for <code>gitja</code>, including how templates need to be organised and what variables are available within them, see <a -href="https://gitserve.mcol.xyz">https://gitserve.mcol.xyz</a>. +href="https://gitja.mcol.xyz">https://gitja.mcol.xyz</a>. </p> {% endblock %}
templates/README.rst Modified
@@ -1,5 +1,5 @@ -gitserve templates -================== +gitja templates +=============== This folder contains some example templates for demonstration purposes. @@ -14,8 +14,8 @@ ============= ========================================== Template name Description ============= ========================================== -base This is placed into the current folder via ``gitserve -t``. -docs This is used for generating gitserve's docs website. +base This is placed into the current folder via ``gitja -t``. +docs This is used for generating gitja's docs website. stagit This replicates much of stagit_'s style. ============= ==========================================
stack.yaml Modified
@@ -8,7 +8,7 @@ - gitlib-libgit2 ghc-options: - "gitserve": -Wall -Wcompat -Widentities -Wincomplete-uni-patterns + "gitja": -Wall -Wcompat -Widentities -Wincomplete-uni-patterns -Wincomplete-record-updates -Wredundant-constraints -Wpartial-fields -Wmissing-deriving-strategies -Wunused-packages -fno-warn-unused-do-bind -fno-warn-orphans
src/config.dhall Modified
@@ -1,4 +1,4 @@ --- This is an example configuration file for gitserve. +-- This is an example configuration file for gitja. -- It uses the Dhall configuration language: dhall-lang.org -- You can list the git repositories here. @@ -6,10 +6,10 @@ let repos = ".." let folders = - [ "${repos}/gitserve" + [ "${repos}/gitja" ] --- These are the configurable options that are used by gitserve. +-- These are the configurable options that are used by gitja. -- You may want to replace the relative paths for absolute paths. let config = { repos = folders @@ -19,7 +19,7 @@ , host = "http://localhost:8000" } --- If `scan` is True, then gitserve will look for git repositories in folders +-- If `scan` is True, then gitja will look for git repositories in folders -- nested within those listed in `repos`. Otherwise, the folders in `repos` are -- assumed to be repositories themselves.
src/Repositories.hs Modified
@@ -112,7 +112,7 @@ Git.resolveReference "HEAD" >>= \case Nothing -> do - liftIO . unless (envQuiet env) . putStrLn $ "gitserve: " <> show name <> ": Failed to resolve HEAD." + liftIO . unless (envQuiet env) . putStrLn $ "gitja: " <> show name <> ": Failed to resolve HEAD." return repo Just commitID -> do let gitHead = Tagged commitID
src/Main.hs Modified
@@ -6,7 +6,7 @@ main, ) where -import Paths_gitserve (version) +import Paths_gitja (version) import Control.Monad (when) import qualified Data.ByteString as B @@ -60,7 +60,7 @@ <*> O.switch ( O.long "version" <> O.short 'v' - <> O.help "Print the gitserve's version." + <> O.help "Print gitja's version." ) parser :: IO Options @@ -79,7 +79,7 @@ options <- parser if | optVersion options -> - putStrLn $ "Your gitserve version is: " <> showVersion version + putStrLn $ "Your gitja version is: " <> showVersion version | optTemplate options -> makeTemplate | otherwise -> do @@ -103,7 +103,7 @@ putStrLn "A base template as been put at ./template." putStrLn "A plain config has been put at ./config.dhall" putStrLn "Add a local git repository to 'repos' in the config" - putStrLn "and run gitserve to generate HTML in ./output." + putStrLn "and run gitja to generate HTML in ./output." oExists <- D.doesPathExist "./output" when oExists . putStrLn $ "WARNING: ./output ALREADY EXISTS AND WILL BE OVERWRITTEN\n"
src/Env.hs Modified
@@ -163,9 +163,9 @@ - it does not end in ".html" or ".include". Symbolic links are not followed and are copied as is. This means that a symbolic link -from `confTemplate/link.html` to `gitserve/index.html` will be copied, keeping the -link intact, resulting in a symbolic link at `output/link.html` essentially -pointing to `output/gitserve/index.html`. +from `confTemplate/link.html` to `gitja/index.html` will be copied, keeping the link +intact, resulting in a symbolic link at `output/link.html` essentially pointing to +`output/gitja/index.html`. -} copyStaticDirs :: [Path Abs Dir] -> Path Abs Dir -> IO () copyStaticDirs dirs output = mapM_ copy dirs
gitserve.cabal Deleted
@@ -1,44 +0,0 @@ -name: gitserve -version: 0.3.0.0 -synopsis: 🐙 Templated web page generator for your git repositories -description: 🐙 Templated web page generator for your git repositories -homepage: https://github.com/m-col/gitserve#readme -bug-reports: https://github.com/m-col/gitserve/issues -license: BSD3 -license-file: LICENSE -author: Matt Colligan -maintainer: mcol@posteo.net -copyright: 2021 Matt Colligan -category: Web, Git -build-type: Simple -cabal-version: >=1.10 -extra-source-files: README.rst - -executable gitserve - hs-source-dirs: src - main-is: Main.hs - other-modules: Index, Env, Repositories, Templates, Types, Paths_gitserve - default-language: Haskell2010 - build-depends: base >= 4.7 && < 5 - , conduit - , bytestring - , data-default - , dhall - , directory - , exceptions - , extra - , file-embed - , filepath - , ginger >= 0.10.4.0 - , gitlib - , gitlib-libgit2 - , hlibgit2 - , optparse-applicative - , path - , path-io >= 1.3.0 - , tagged - , text - , transformers - , unliftio-core - , unordered-containers - , utf8-string
gitja.cabal Added
@@ -0,0 +1,44 @@ +name: gitja +version: 0.3.0.0 +synopsis: 🐙 Templated web page generator for your git repositories +description: 🐙 Templated web page generator for your git repositories +homepage: https://github.com/m-col/gitja#readme +bug-reports: https://github.com/m-col/gitja/issues +license: BSD3 +license-file: LICENSE +author: Matt Colligan +maintainer: mcol@posteo.net +copyright: 2021 Matt Colligan +category: Web, Git +build-type: Simple +cabal-version: >=1.10 +extra-source-files: README.rst + +executable gitja + hs-source-dirs: src + main-is: Main.hs + other-modules: Index, Env, Repositories, Templates, Types, Paths_gitja + default-language: Haskell2010 + build-depends: base >= 4.7 && < 5 + , conduit + , bytestring + , data-default + , dhall + , directory + , exceptions + , extra + , file-embed + , filepath + , ginger >= 0.10.4.0 + , gitlib + , gitlib-libgit2 + , hlibgit2 + , optparse-applicative + , path + , path-io >= 1.3.0 + , tagged + , text + , transformers + , unliftio-core + , unordered-containers + , utf8-string
config.dhall Modified
@@ -1,4 +1,4 @@ --- This is an example configuration file for gitserve. +-- This is an example configuration file for gitja. -- It uses the Dhall configuration language: dhall-lang.org -- This is a folder containing repositories. @@ -6,10 +6,10 @@ -- And these are relative paths from 'repos' to those repositories. let folders = - [ "${repos}/gitserve" + [ "${repos}/gitja" ] --- These are the configurable options that are used by gitserve. +-- These are the configurable options that are used by gitja. -- If copying, you may want to replace the relative paths for absolute paths. let config = { repos = folders @@ -19,7 +19,7 @@ , host = "http://localhost:8000" } --- If `scan` is True, then gitserve will look for git repositories in folders +-- If `scan` is True, then gitja will look for git repositories in folders -- nested within those listed in `repos`. Otherwise, the folders in `repos` are -- assumed to be repositories themselves.
README.rst Modified
@@ -1,16 +1,15 @@ -gitserve -======== +gitja +===== -.. image:: https://img.shields.io/github/v/release/m-col/gitserve?color=904ff0 +.. image:: https://img.shields.io/github/v/release/m-col/gitja?color=904ff0 :alt: GitHub release (latest SemVer) -``gitserve`` generates pretty web pages from your git repositories using custom +``gitja`` generates pretty web pages from your git repositories using custom Jinja_\* HTML templates. -``gitserve`` complements your static site generator so that you can display -your code however you want, in a style consistent with the rest of your -website! +``gitja`` complements your static site generator so that you can display your +code however you want, in a style consistent with the rest of your website! This was inspired by stagit_, which generates content with a hard-coded style, so if you like that style and don't want to edit templates, you may prefer to @@ -24,14 +23,14 @@ Currently installation is only possible via source:: - git clone https://github.com/m-col/gitserve - cd gitserve + git clone https://github.com/m-col/gitja + cd gitja stack install -Documentation and a preview of the kind of pages ``gitserve`` can generate is +Documentation and a preview of the kind of pages ``gitja`` can generate is available here_. -If you like skipping the manual, running ``gitserve --template`` will create a +If you like skipping the manual, running ``gitja --template`` will create a base template and config in the current folder from which you can create your own. @@ -46,13 +45,13 @@ Meta ---- -Development hosted @ https://github.com/m-col/gitserve. Written by Matt +Development hosted @ https://github.com/m-col/gitja. Written by Matt Colligan and `licensed MIT <LICENSE>`_. .. _Jinja: https://jinja.palletsprojects.com .. _stagit: https://codemadness.org/git/stagit .. _ginger: https://ginger.tobiasdammers.nl -.. _`open an issue`: https://github.com/m-col/gitserve/issues/new +.. _`open an issue`: https://github.com/m-col/gitja/issues/new .. _fourmolu: https://github.com/fourmolu/fourmolu .. _hlint: https://github.com/ndmitchell/hlint -.. _here: https://gitserve.mcol.xyz +.. _here: https://gitja.mcol.xyz
Makefile Modified
@@ -30,7 +30,7 @@ @stack build .PHONY: run -run: ## Run gitserve on this repository into ./output/ +run: ## Run gitja on this repository into ./output/ rm -rf output stack run -- -q @@ -46,8 +46,8 @@ prof: ## Build with profiling enabled @stack build --profile @rm -r output - @stack exec --profile -- gitserve -q +RTS -p - @head -n 6 gitserve.prof + @stack exec --profile -- gitja -q +RTS -p + @head -n 6 gitja.prof .PHONY: all all: format lint rebuild run test ## Lint, format, rebuild, run, test
DOCUMENTATION.md Modified
@@ -1,18 +1,19 @@ Documentation ============= -`gitserve` is a tool that reads from locally hosted or cloned git repositories -and generates static HTML pages using their data. +`gitja` is a tool that reads from locally hosted or cloned git repositories and +generates static HTML pages using their data and +[Jinja](https://jinja.palletsprojects.com) templates. Usage ----- ### Configuration file -gitserve is configured using a [dhall](https://dhall-lang.org) config file. The -[example config](https://github.com/m-col/gitserve/blob/master/config.dhall) is -a good place to start, or alternatively create one in the current folder by -running `gitserve -t`. +gitja is configured using a [dhall](https://dhall-lang.org) config file. The +[example config](https://github.com/m-col/gitja/blob/master/config.dhall) is a +good place to start, or alternatively create one in the current folder by +running `gitja -t`. It requires the following settings: @@ -24,17 +25,17 @@ | `output` | Where to put the generated files. | | `host` | The host URL, which is needed for creating links. | -If `scan` is `True`, then gitserve will look for git repositories in folders +If `scan` is `True`, then gitja will look for git repositories in folders nested within those listed in `repos`. Otherwise, the folders in `repos` are assumed to be repositories themselves. -Then, pass the config file to gitserve. +Then, pass the config file to gitja. ### CLI See the CLI help message for usage: - Usage: gitserve [-c|--config CONFIG] [-q|--quiet] [-f|--force] [-t|--template] + Usage: gitja [-c|--config CONFIG] [-q|--quiet] [-f|--force] [-t|--template] [-v|--version] 🐙 Templated web page generator for your git repositories @@ -43,26 +44,26 @@ -q,--quiet Suppress non-error output. -f,--force Force regeneration of all files. -t,--template Create a template and config in the current folder. - -v,--version Print the gitserve's version. + -v,--version Print the gitja's version. -h,--help Show this help text -Note the `force` flag. By default, gitserve will not generate new output for +Note the `force` flag. By default, gitja will not generate new output for commits to save time. This flag will force regeneration of all files, which would be needed if changes have been made to the template. Templates --------- -A base template can be created in the current folder by running `gitserve -t`. +A base template can be created in the current folder by running `gitja -t`. This can be used as a starting point to creating your own template. ### Folder structure -The files that gitserve outputs are generated using +The files that gitja outputs are generated using [ginger](https://ginger.tobiasdammers.nl) template files, which use the [Jinja](https://jinja.palletsprojects.com) templating language. If these are new to you, it may be enough to skim through some of the examples in the -[templates](https://github.com/m-col/gitserve/tree/master/templates) folder, +[templates](https://github.com/m-col/gitja/tree/master/templates) folder, otherwise the ginger docs can be very helpful to see what is supported. Templates are a folder containing a number of ginger template files. There are @@ -102,13 +103,13 @@ *commit scope* respectively, and are parsed and output once per file or commit. The resulting folder structure found in `output` will look like this (if -`repos` only contains gitserve): +`repos` only contains gitja): output/ i_can_have_any_name.html and_there_can_be_any_number.html non_html_is_fine.css - gitserve/ + gitja/ inside_this_folder.html two_names_are_special.html file/