hugo-preproc

KO | EN

gitlite — search

#ai #llm #machine-learning #deep-learning #linux #nodejs #macos #windows #awesome #kubernetes #vue #awesome-list #ios #openai

(★ 12)

Helper for Hugo to provide for pre-processing of files.

hugo-preproc 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# hugo-preproc

Helper for Hugo to provide for pre-processing of files.

## Installation

You can either directly download binaries from the Releases page, build from
source, or use `brew` on MacOS and Linux.

### Brew

```bash
brew tap jason-dour/tap
brew trust jason-dour/tap # Optional; allows for easier updates.
brew install git-wt
```

## Purpose

Provide for a flexible pre-processor for Hugo. Intended to assist with any sort
of pre-processing desired for publishing files, such as:

* Diagrams converted to SVG.
  * Mermaid
  * Draw.io
  * Graphviz
  * etc.
* Generate Markdown or data files for Hugo from Git history.

## Use

A configuration file is used to define processing.  By default, the config
filename is `.hugo-preproc.yaml` (or `.toml`, or `.json`).

You can specify a config file on command line with the `-c`/`--config` option.

Execute the command and processing occurs based on the configuration.

The Git processors can run a Go Template, and the Exec processors can run
a command or a [Tengo](https://github.com/d5/tengo) script.

## Configuration Syntax

The file has two primary keys: `git` and `processors`, such as this example:

``` yaml
git:
  - path: path/to/repo
    processors:
      - mode: head | each | all
        file: path/to/output/{{ .Commit.Hash }}
        template: Entry {{ .<field> }}
exec:
  - path: path/to/top/directory
    pattern: "*.md"
    mode: each | all
    command: echo {{ . }}
    script: |
      // Tengo script...
```

The `git` key  is an array object, with each array element defined as follows:

* `path` - Defines the path to the git repo (default: ".")
* `processors` - Array of git log handlers.
  * `mode` - Values of `head` (only the head commit), `each` (each log entry passed through the processor, consecutively), or `all` (all entries passed through the processor).
  * `file` - The file to output; processed as a template.
  * `template` - The template through which the git log entry/entries will be processed and then written to `file`.

The `exec` key is an array object, with each array element defined as follows:

* `path` - The top-level path that will be walked and scanned for matching filenames.
* `pattern` - The pattern used to match the filenames while walking the `path` contents recursively.
* `mode` - Values of `each` (each file passed through the processor, consecutively), or `all` (all files passed through the processor).
* `command` - The command to run on matching files; this value is processed as a Go template. (Exclusive of `script`; use one or the other.)
* `script` - The Tengo script to run on matching files. (Exclusive of `command`; use one or the other.)

The array entries will be executed serially, in the order in which they are defined.

![Configuration Data Structure](https://raw.githubusercontent.com/jason-dour/hugo-preproc/main/config-data-model.drawio.svg)

## Go Templates

We are using Go Templates to process the `file` and `template` keys in each `git` handler, as well as the `command` key in each `processors` object.

We've now mapped the full library of [Masterminds/sprig](https://github.com/Masterminds/sprig) template functions.
As of `2.x` releases, all prior custom functions are deprecated.

## Go Template Input

We provide the following input for the configured handlers.

* `git` handlers
  * `head` and `each`

``` go
    . {
      Commit {
        Hash         string   // Hash of the commit object.
        Author       {        // Author is the original author of the commit.
          Name  string    // Name of the Author.
          Email string    // Email address of the Author.
          When  time.Time // Date/time of the commit. 
        }
        Committer    {        // Committer is the one performing the commit,
                              // might be different from Author.
          Name  string    // Name of the Committer.
          Email string    // Email address of the Committer.
          When  time.Time // Date/time of the commit. 
        }
        Message      string   // Message is the commit message, contains arbitrary text.
        TreeHash     string   // TreeHash is the hash of the root tree of the commit.
        ParentHashes []string // ParentHashes are the hashes of the parent commits of the commit.
        PGPSignature string   // PGPSignature is the PGP signature of the commit.
      }
      Stats []string // Array of strings for files changed and their stats.
    }
    ```

* `all`

``` go
    . {
      // Array of Commits
      Commits []{
        Commit {
          Hash         string   // Hash of the commit object.
          Author       string   // Author is the original author of the commit.
            Name  string    // Name of the Author.
            Email string    // Email address of the Author.
            When  time.Time // Date/time of the commit. 
          }
          Committer    {        // Committer is the one performing the commit,
                                // might be different from Author.
            Name  string    // Name of the Committer.
            Email string    // Email address of the Committer.
            When  time.Time // Date/time of the commit. 
          }
          Message      string   // Message is the commit message, contains arbitrary text.
          TreeHash     string   // TreeHash is the hash of the root tree of the commit.
          ParentHashes []string // ParentHashes are the hashes of the parent commits of the commit.
          PGPSignature string   // PGPSignature is the PGP signature of the commit.
        }
        Stats []string // Array of strings for files changed and their stats.
      }
      // Head Commit
      Head {
        Commit {
          Hash         string   // Hash of the commit object.
          Author       string   // Author is the original author of the commit.
            Name  string    // Name of the Author.
            Email string    // Email address of the Author.
            When  time.Time // Date/time of the commit. 
          }
          Committer    {        // Committer is the one performing the commit,
                                // might be different from Author.
            Name  string    // Name of the Committer.
            Email string    // Email address of the Committer.
            When  time.Time // Date/time of the commit. 
          }
          Message      string   // Message is the commit message, contains arbitrary text.
          TreeHash     string   // TreeHash is the hash of the root tree of the commit.
          ParentHashes []string // ParentHashes are the hashes of the parent commits of the commit.
          PGPSignature string   // PGPSignature is the PGP signature of the commit.
        }
        Stats []string // Array of strings for files changed and their stats.
      }
    }
    ```

* `exec` handlers
  * `template`
    * `each`

``` go
        . string // String representing the matched filename,
                 // including its full path (handler top search path + sub-path to file).
        ```

* `all`

``` go
        . []string // Array or strings representing the matched filenames,
                   // including its full path (handler top search path + sub-path to file).
        ```

* `script`
    * `each`
      * Variable named `file` is available to the script as a string.
    * `all`
      * Variable named `files` is available to the script as an array of strings.

hugo-preproc

hugo-preproc 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

hugo-preproc

hugo-preproc 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README