Realize 项目使用教程-优快云博客

Realize 项目使用教程

realize Realize is the #1 Golang Task Runner which enhance your workflow by automating the most common tasks and using the best performing Golang live reloading. 项目地址: https://gitcode.com/gh_mirrors/re/realize

1. 项目的目录结构及介绍

Realize 项目是一个用 Go 语言编写的任务运行器和实时重新加载工具，旨在自动化日常任务并提高工作效率。以下是项目的目录结构：

realize/
├── .gitignore
├── .realize.yaml
├── Dockerfile
├── LICENSE
├── README.md
├── docker-compose.yml
├── go.mod
├── go.sum
├── realize.go
├── realize_test.go
└── travis.yml

.gitignore：Git 忽略文件，用于指定 Git 忽略跟踪的文件和目录。
.realize.yaml：Realize 的配置文件，用于定义项目的配置和任务。
Dockerfile：用于创建 Realize 容器的 Docker 文件。
LICENSE：项目使用的许可证文件，本项目使用 GPL-3.0 许可证。
README.md：项目的自述文件，包含项目的介绍和使用说明。
docker-compose.yml：Docker Compose 文件，用于定义多容器应用程序。
go.mod 和 go.sum：Go 项目的依赖管理文件。
realize.go：Realize 主程序文件。
realize_test.go：Realize 的单元测试文件。
travis.yml：用于配置 Travis CI 持续集成服务。

2. 项目的启动文件介绍

Realize 项目的启动文件是 realize.go，它包含了 Realize 主程序的实现。你可以通过以下命令启动项目：

go get github.com/oxequa/realize

启动 Realize 的基本命令是：

realize start

该命令会检查当前目录下是否存在 .realize.yaml 配置文件，如果不存在，则创建一个新的配置文件，并添加当前工作目录为项目，然后运行你的工作流。

3. 项目的配置文件介绍

Realize 项目的配置文件是 .realize.yaml，它用于定义项目的各种配置项，包括：

settings：设置部分，可以定义一些全局设置，例如监听器类型、轮询间隔、资源文件、日志输出等。
server：服务器设置，可以定义 Web 服务器是否启用、是否在启动时打开浏览器、服务器地址和端口等。
schema：项目架构定义，可以定义项目的路径、环境变量、支持的 Go 命令等。
watcher：文件监视器设置，可以定义要监视的路径、忽略的路径、支持的文件扩展名等。
scripts：脚本定义，可以定义在文件更改之前和之后运行的脚本。

配置文件的一个基本示例如下：

settings:
  legacy:
    force: true
  interval: 100ms
  resources:
  outputs: outputs.log
  logs: logs.log
  errors: errors.log
server:
  status: false
  open: false
  host: localhost
  port: 5001
schema:
  - name: coin
    path: coin
    env:
      test: test
      myvar: value
    commands:
      vet:
        status: true
      fmt:
        status: true
      test:
        status: true
      generate:
        status: true
      install:
        status: true
      build:
        status: false
      run:
        status: true
watcher:
  paths:
    - /
  ignore_paths:
    - vendor
  extensions:
    - go
    - html
scripts:
  - type: before
    command: echo before global
    global: true
    output: true
  - type: before
    command: echo before change
    output: true
  - type: after
    command: echo after change
    output: true
  - type: after
    command: echo after global
    global: true
    output: true

通过配置文件，你可以定制 Realize 的行为，以适应你的项目需求。

创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考