test
docs
Go Reference
Mentioned in Awesome Go
Go Report Card
Coverage Status

xc

Docs | Getting Started | Github

xc is a task runner designed to maximise convenience, and minimise complexity.

Each xc task is defined in simple, human-readable Markdown. Meaning that for people without the xc tool installed there is a clear source of useful commands in the README.md file.

Installation instructions are defined at https://xcfile.dev/getting-started/#installation.

vscode demo

  • Markdown defined tasks.
  • Editor tools:
    • VSCode (list and run xc tasks)
    • Vim (recommended config for listing and running xc tasks)

Take the tag task in the README.md of the xc repository:

## tag

Deploys a new tag for the repo.

Requires: test

```
export VERSION=`git rev-list --count HEAD`
echo Adding git tag with version v0.0.${VERSION}
git tag v0.0.${VERSION}
git push origin v0.0.${VERSION}
```

The task could be run simply with xc tag, but a side-effect of it being an xc task is that the steps for pushing a tag without the use of xc are clearly documented too.

test

Test the project.

lint

Run linters.

build

Builds the xc binary.

tag

Deploys a new tag for the repo.

Requires: test

export VERSION=`git rev-list --count HEAD`
echo Adding git tag with version v0.0.${VERSION}
git tag v0.0.${VERSION}
git push origin v0.0.${VERSION}

update-nix

Updates nix flake.

install-hugo

Install hugo via go install.

go install github.com/gohugoio/hugo@latest

run-docs

Run the hugo development server.

Directory: doc

Read More

By |2023-02-23T19:15:22+00:00February 23rd, 2023|Education|0 Comments

Leave A Comment