Skip to content

Commit a7bbdd3

Browse files
committed
docs: info about 1.4.0 version
1 parent 3e2dcd0 commit a7bbdd3

File tree

2 files changed

+51
-11
lines changed

2 files changed

+51
-11
lines changed

CHANGELOG.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,18 @@ All notable changes to the "PostgreSQL Hacker Helper" extension will be document
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [1.4.0]
9+
10+
### Added
11+
12+
- Support for custom PostgreSQL source code directories. It can be set using `postgresql-hacker-helper.srcPath` in settings.
13+
This setting is used to start searching for required files (i.e. default node tag files or `pg_bsd_indent`).
14+
NOTE: if custom NodeTag files are set with relative path - search start from *workspace* directory, not your custom `srcPath`.
15+
16+
### Fixed
17+
18+
- Invalid message formatting for VS Code greater than 1.74.0. Caused by incompatible (with extension's) formatting logic used.
19+
820
## [1.3.0]
921

1022
### Added

README.md

Lines changed: 39 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -143,17 +143,38 @@ For more info check [configuration file documentation](./docs/config_file.md).
143143

144144
## Extension Settings
145145

146-
There are 3 settings:
147-
148-
- Log level - set minimum level of log messages in Output channel.
149-
By default - `INFO` (if using VS Code 1.74.0 ang greater use `Output` channel
150-
logger settings)
151-
- Files with NodeTag files - list of paths points to files that contain NodeTags.
152-
By default - `src/include/nodes/nodes.h`, `src/include/nodes/nodetags.h`
153-
- Custom path to `pg_bsd_indent`. Use it if you have pg_bsd_indent installed
154-
globally. If not specified, it will be searched in `src/tools` directory.
155-
If required, it will be downloaded and installed (`wget` required to download
156-
sources)
146+
There are 4 settings:
147+
148+
- `postgresql-hacker-helper.logLevel` - Log level
149+
150+
Minimum level of log messages in Output channel.
151+
By default - `INFO`. If using VS Code 1.74.0 ang greater use `Output` channel
152+
logger settings.
153+
154+
- `postgresql-hacker-helper.srcPath` - Path to source code directory
155+
156+
*Relative* path to custom PostgreSQL source code directory. Use it, if source
157+
code files are not in your workspace root (i.e. in `${workspaceFolder}/postgresql`). Used for searching for
158+
required files (node tag files, `pg_bsd_indent` and so on). If not specified
159+
search starts from workspace root. (Next, this settings will be used as `*SrcPath*`).
160+
161+
- `postgresql-hacker-helper.nodeTagFiles` - Files with NodeTag files
162+
163+
List of paths points to files that contain NodeTags.
164+
165+
- If path is absolute - specified files will be used directly.
166+
- If path is relative, search starts from source files directory (see
167+
`postgresql-hacker-helper.srcPath`).
168+
- If not specified, `*SrcPath*/src/include/nodes/nodes.h`
169+
and `*SrcPath*/src/include/nodes/nodetags.h` will be used.
170+
171+
- `postgresql-hacker-helper.pg_bsd_indentPath` - Path to `pg_bsd_indent`
172+
173+
Path to `pg_bsd_indent` tool. Required for formatting support. Use it if you have `pg_bsd_indent` installed globally or want to use specific version.
174+
175+
- If not specified, it will be searched in `*SrcPath*/src/tools` directory.
176+
- If specified, and failed to run extension will try to build it.
177+
NOTE: If required, it will be downloaded (`wget` is required) and built.
157178

158179
## Compatibility
159180

@@ -190,6 +211,13 @@ Known issues:
190211

191212
## Release Notes
192213

214+
### 1.4.0
215+
216+
Add support for custom PostgreSQL source code directories. Custom directory can
217+
be specified using `postgresql-hacker-helper.srcPath` setting.
218+
219+
Fix invalid logging for VS Code with version greater 1.74.0.
220+
193221
### 1.3.0
194222

195223
Add formatting functionality using `pg_bsd_indent` integrated with VS Code:

0 commit comments

Comments
 (0)