aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 267b226eca62c17117d63ab0dc0a5541f67a26e7 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# conf

Go библиотека для парсинга конфигурационных файлов `.conf`.

## Установка

```bash
go get go.neonxp.ru/conf
```

## Особенности формата

- **Присваивания**: `key = value;`
- **Типы значений**: строки (двойные/одинарные кавычки, backticks), числа (целые/дробные), булевы значения
- **Директивы**: `directive arg1 arg2;`
- **Блочные директивы**: `directive { ... }`
- **Комментарии**: `#` до конца строки
- **UTF-8**: включая кириллицу
- **Подстановка переменных окружения**: `$VAR`

## Быстрый старт

```go
package main

import (
    "fmt"
    "go.neonxp.ru/conf"
    "go.neonxp.ru/conf/model"
    "go.neonxp.ru/conf/visitor"
)

func main() {
    cfg := conf.New()
    if err := cfg.LoadFile("config.conf"); err != nil {
        panic(err)
    }

    v := visitor.NewDefault()
    if err := cfg.Process(v); err != nil {
        panic(err)
    }

    // Доступ по пути с точечной нотацией
    val, err := v.Get("server.host")
    if err != nil {
        panic(err)
    }
    fmt.Println(val.String())  // localhost

    port, err := v.Get("server.port")
    fmt.Println(port.Int())    // 8080
}
```

## Пример конфигурационного файла

```conf
# Переменная окружения: db_file = $HOME "/app/data.db";

# Простые присваивания
rss = "https://neonxp.ru/feed/";
host = "localhost";
port = 8080;
debug = true;

# Директивы с аргументами
telegram "bot123" "-1003888840756" {
    token = "token_value";
    admin_chat = "@admin";
}

# Вложенные блоки
server {
    host = "localhost";
    port = 8080;

    ssl {
        enabled = true;
        cert = "/etc/ssl/cert.pem";
    }

    middleware "auth" {
        enabled = true;
        secret = "$JWT_SECRET";
    }
}

# Многострочные строки
template = `
    <!DOCTYPE html>
    <html>
        <body>Hello</body>
    </html>
`;
```

## API

### Загрузка конфигурации

```go
cfg := conf.New()

// Из файла
cfg.LoadFile("config.conf")

// Из памяти
cfg.Load("inline", []byte("key = value;"))
```

### Обработка через Visitor

Библиотека использует паттерн Visitor для обхода конфигурации:

```go
type Visitor interface {
    VisitDirective(ident string, args Values, body Body) error
    VisitSetting(key string, values Values) error
}
```

### Get-методы на Values

| Метод | Описание |
|-------|----------|
| `String()` | Строковое представление через пробел |
| `Int()` | Преобразование в int (одно значение) |
| `BuildString(lookups...)` | Сборка строки с подстановками |

### Подстановка переменных окружения

```go
vals, _ := v.Get("db_file")
path := vals.BuildString(model.LookupEnv)
// $HOME → "/home/user", результат: "/home/user/app/data.db"
```

### Кастомные подстановки

```go
substitutions := map[model.Word]string{
    "APP_DIR":  "/opt/myapp",
    "LOG_LEVEL": "debug",
}

path := vals.BuildString(model.LookupSubst(substitutions), model.Origin)
```

## Реализация собственного Visitor

```go
type MyVisitor struct{}

func (m *MyVisitor) VisitDirective(ident string, args model.Values, body model.Body) error {
    fmt.Printf("Directive: %s, args: %s\n", ident, args.String())
    return body.Execute(m) // Рекурсивный обход тела
}

func (m *MyVisitor) VisitSetting(key string, values model.Values) error {
    fmt.Printf("Setting: %s = %s\n", key, values.String())
    return nil
}
```

## Грамматика (EBNF)

```
Config     = Doc .
Doc        = Stmt { Stmt } .
Stmt       = Word ( Assignment | Command ) .

Assignment = "=" Values br .
Command    = [Values] ( Body | br ) .

Values     = Value { Value } .
Value      = Word | String | Number | Boolean .
Body       = "{" [ Doc ] "}" .

Word       = word (alpha | "$" | "_") {alpha | number | "$" | "_"} .
String     = `"[^"]*"` | `'[^']*'` | '`' { `[^`]' } '`' .
Number     = `-?[0-9]+(\.[0-9]+)?` .
Boolean    = `true` | `false` .
br         = ";" .
```

## Требования

- Go 1.25+

## Лицензия

Этот проект лицензирован в соответствии с GNU General Public License версии 3
(GPLv3). Подробности смотрите в файле [LICENSE](LICENSE).

```
                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

 Copyright (C) 2026 Alexander NeonXP Kiryukhin <i@neonxp.ru>
 Everyone is permitted to copy and distribute verbatim copies
 of this license document, but changing it is not allowed.
```

## Автор

- Александр Кирюхин <i@neonxp.ru>