Skip to content

Commit

Permalink
Update release date for v8.1 in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
molsonkiko committed Aug 23, 2024
1 parent 4407c42 commit 277e35a
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 17 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Change Log
All [notable changes](#800---2024-06-29) to this project will be documented in this file.
All [notable changes](#810---2024-08-23) to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).
Expand Down Expand Up @@ -51,7 +51,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
- Since v7.0, holding down `Enter` in a multiline textbox (like the [tree viewer query box](/docs/README.md#remespath)) only adds one newline when the key is lifted.
- Maybe use pre-7.1 (dictionary-based rather than indicator-based) [selection remembering](/docs/README.md#working-with-selections) for Notepad++ 8.5.5 and earlier? Indicators are risky with those older NPP's because of the lack of `NPPM_ALLOCATEINDICATOR`.

## [8.1.0] - (UNRELEASED) YYYY-MM-DD
## [8.1.0] - 2024-08-23

### Added

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,9 +168,9 @@ The following aspects of JsonTools __can__ be translated:
- Forms (including all controls and items in drop-down menus) (see the `forms` field of the translation `json5` file)
- Items in the JsonTools sub-menu of the Notepad++ Plugins menu (see the `menuItems` field)
- The descriptions of settings in the [`JsonTools.ini` config file](/docs/README.md#customizing-settings) (see the `settingsDescriptions` field)
- The descriptions of settings in the [settings form](/docs/README.md#customizing-settings) (*only for versions since [v8.1](/CHANGELOG.md#810---unreleased-yyyy-mm-dd)*) (also controlled by `settingsDescriptions`)
- [JSON syntax errors and JSON schema validation errors](/docs/README.md#error-form-and-status-bar) (*only for versions since [v8.1](/CHANGELOG.md#810---unreleased-yyyy-mm-dd)*) (see the `jsonLint` field)
- Message boxes (includes warnings, errors, requests for confirmation) (*only for versions since [v8.1](/CHANGELOG.md#810---unreleased-yyyy-mm-dd)*) (see the `messageBoxes` field)
- The descriptions of settings in the [settings form](/docs/README.md#customizing-settings) (*only for versions since [v8.1](/CHANGELOG.md#810---2024-08-23)*) (also controlled by `settingsDescriptions`)
- [JSON syntax errors and JSON schema validation errors](/docs/README.md#error-form-and-status-bar) (*only for versions since [v8.1](/CHANGELOG.md#810---2024-08-23)*) (see the `jsonLint` field)
- Message boxes (includes warnings, errors, requests for confirmation) (*only for versions since [v8.1](/CHANGELOG.md#810---2024-08-23)*) (see the `messageBoxes` field)

The following aspects of JsonTools __may eventually__ be translated:
- This documentation
Expand Down
24 changes: 12 additions & 12 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ __NOTES__
- `Ctrl+Down` while in the tree selects the last direct child of the currently selected node. *Added in [v6.0](/CHANGELOG.md#600---2023-12-13).*
- `Escape` takes focus from the tree view back to the editor.
5. Beginning in [v4.4.0](/CHANGELOG.md#440---2022-11-23), you can have multiple tree views open.
6. Beginning in [v8.1](/CHANGELOG.md#810---unreleased-yyyy-mm-dd), JsonTools will refuse to perform plugin commands on files with more than 2147483647 bytes. This is the same size restriction that 32-bit Notepad++ has for opening files.
6. Beginning in [v8.1](/CHANGELOG.md#810---2024-08-23), JsonTools will refuse to perform plugin commands on files with more than 2147483647 bytes. This is the same size restriction that 32-bit Notepad++ has for opening files.
- Prior to that release, JsonTools would cause Notepad++ to __crash__ if you attempted to execute plugin commands on files that large.

If a node has a `+` or `-` sign next to it, you can click on that button to expand the children of the node, as shown here.
Expand Down Expand Up @@ -256,9 +256,9 @@ Prior to [v6.1](/CHANGELOG.md#610---2023-12-28), this automatic validation force

Beginning in [v7.0](/CHANGELOG.md#700---2024-02-09), this automatic validation will only ever attempt to parse the entire document, not [a selection](#working-with-selections), and automatic validation is always disabled in selection-based mode. Prior to v7.0, automatic validation could change the user's selections unexpectedly.

Beginning in [v8.1](/CHANGELOG.md#810---unreleased-yyyy-mm-dd), only modifications that *change the text of the document* will trigger re-parsing.
Beginning in [v8.1](/CHANGELOG.md#810---2024-08-23), only modifications that *change the text of the document* will trigger re-parsing.

__WARNING:__ If this setting is turned on, versions of JsonTools older than [v8.1](/CHANGELOG.md#810---unreleased-yyyy-mm-dd) will cause Notepad++ to crash if you attempt to open *any* file with more than 2147483647 bytes.
__WARNING:__ If this setting is turned on, versions of JsonTools older than [v8.1](/CHANGELOG.md#810---2024-08-23) will cause Notepad++ to crash if you attempt to open *any* file with more than 2147483647 bytes.

## Path to current position ##

Expand All @@ -283,7 +283,7 @@ The `Path to current line` menu option lets you fill the clipboard with the path

### `key_style` and `path_separator` settings ###

If you are using JsonTools [v8](/CHANGELOG.md#800---2024-06-29) or older, you can ignore the below discussion of the `path_separator` setting, as it was added in [v8.1](/CHANGELOG.md#810---unreleased-yyyy-mm-dd).
If you are using JsonTools [v8](/CHANGELOG.md#800---2024-06-29) or older, you can ignore the below discussion of the `path_separator` setting, as it was added in [v8.1](/CHANGELOG.md#810---2024-08-23).

The `key_style` and `path_separator` settings control the formatting of the `Path to current position` command.

Expand Down Expand Up @@ -803,7 +803,7 @@ Of course, sometimes an API request will fail. You can click the [View errors bu

If you want to open up all the JSON files in a directory, here's how to do it:
1. Choose whether you want to search in subdirectories.
2. Choose what [filename search pattern(s)](https://docs.microsoft.com/en-us/dotnet/api/system.io.directoryinfo.enumeratefiles?view=net-6.0#system-io-directoryinfo-enumeratefiles) you want to use (by default files with the `.json` extension). Beginning in [v8.1](/CHANGELOG.md#810---unreleased-yyyy-mm-dd), these filename search patterns can include `\` and `/` characters, and `**` can be used to match any number of characters (including `\`).
2. Choose what [filename search pattern(s)](https://docs.microsoft.com/en-us/dotnet/api/system.io.directoryinfo.enumeratefiles?view=net-6.0#system-io-directoryinfo-enumeratefiles) you want to use (by default files with the `.json` extension). Beginning in [v8.1](/CHANGELOG.md#810---2024-08-23), these filename search patterns can include `\` and `/` characters, and `**` can be used to match any number of characters (including `\`).
3. Choose what directory you want to search. *If you are using a version of JsonTools __older than [v8.0](/CHANGELOG.md#800---2024-06-29)__*, you can do this in one of the following ways:
- Choose a directory using a GUI dialog. To do this, *make sure that the central list box has the default value of `Previously visited directories...`*, then click the `Choose directory...` button, and a dialog will pop up. Once you select a directory and click `OK`, JsonTools will search the chosen directory.
![Choose a directory using a modal dialog](/docs/json_from_files_and_apis%20get%20json%20in%20directory%20USING%20DIALOG.PNG)
Expand All @@ -819,7 +819,7 @@ If you want to open up all the JSON files in a directory, here's how to do it:

For every file that the JSON tries and fails to parse, the exception will be caught and saved so you can view it later with the [`View errors` button](#viewing-errors).

Beginning in version [v8.0](/CHANGELOG.md#800---2024-06-29), this tool will stop reading files and show an error message once the combined size of all the files to be parsed exceeds about 429 megabytes (215 megabytes for 32-bit Notepad++). This change was made to avoid out-of-memory errors that could cause Notepad++ to crash. In version [v8.1](/CHANGELOG.md#810---unreleased-yyyy-mm-dd), this was reduced to exactly 400MB for 64-bit Notepad++ and 70MB for 32-bit Notepad++.
Beginning in version [v8.0](/CHANGELOG.md#800---2024-06-29), this tool will stop reading files and show an error message once the combined size of all the files to be parsed exceeds about 429 megabytes (215 megabytes for 32-bit Notepad++). This change was made to avoid out-of-memory errors that could cause Notepad++ to crash. In version [v8.1](/CHANGELOG.md#810---2024-08-23), this was reduced to exactly 400MB for 64-bit Notepad++ and 70MB for 32-bit Notepad++.

### Viewing results in a buffer ###

Expand All @@ -843,11 +843,11 @@ For example, if you wanted to search only files with `foo` (case-sensitive) in t

When getting JSON from [directories](#getting-json-from-local-directories) or [APIs](#sending-rest-api-requests), it is possible that JsonTools will need to parse very large amounts of JSON. JsonTools can parse approximately 30 megabytes of JSON per second per thread, but its rate of parsing depends on many factors, chiefly the number of documents to be parsed.

Beginning in [v8.1](/CHANGELOG.md#810---unreleased-yyyy-mm-dd), the JSON from Files and APIs form will report progress while reading documents from the hard drive, and then report progress again when parsing documents. To report progress, JsonTools will open up a progress reporting form with a green progress bar and a short explanation of what is happening. If the progress form has a `Cancel` button, you can press it to try to cancel the current operation. In the unlikely event that the progress form becomes unresponsive, you should be able to close it by closing the JSON from Files and APIs form.
Beginning in [v8.1](/CHANGELOG.md#810---2024-08-23), the JSON from Files and APIs form will report progress while reading documents from the hard drive, and then report progress again when parsing documents. To report progress, JsonTools will open up a progress reporting form with a green progress bar and a short explanation of what is happening. If the progress form has a `Cancel` button, you can press it to try to cancel the current operation. In the unlikely event that the progress form becomes unresponsive, you should be able to close it by closing the JSON from Files and APIs form.

This progress reporting only takes place if the total amount of text to be parsed/read is at least 50 megabytes, or if there are at least 16 files (64 when reading from hard drive) with a combined total of 8 megabytes of text. Progress will not be reported until the number and combined size of files to be read is known, which could take a very long time if you attempt to do recursive search on a huge directory tree like `C:\Program Files`.

To be clear, __versions of JsonTools earlier than [v8.1](/CHANGELOG.md#810---unreleased-yyyy-mm-dd) did not have progress reporting for this form,__ but the underlying process was still very reliable, and *just because Notepad++ stopped responding doesn't mean that JsonTools had an error or went into an infinite loop.*
To be clear, __versions of JsonTools earlier than [v8.1](/CHANGELOG.md#810---2024-08-23) did not have progress reporting for this form,__ but the underlying process was still very reliable, and *just because Notepad++ stopped responding doesn't mean that JsonTools had an error or went into an infinite loop.*

## Clearing selected files ##

Expand All @@ -869,7 +869,7 @@ Click the `View errors` button to see if any errors happened. If any did, a new

As of version *4.6.0*, the plugin can validate JSON against a [JSON schema](https://json-schema.org/). If the schema is valid, a message box will tell you if your JSON validates. If it doesn't validate, the plugin will tell you the first location where validation failed.

Beginning in [v7.0](/CHANGELOG.md#700---2024-02-09), validators can catch multiple JSON schema validation problems, not just one. You can use the [error form](#error-form-and-status-bar) to see where all of the schema validation problems are. To avoid very slow performance on files that do not match the schema, the validator will exit after it encounters 64 problems (configurable by the `max_schema_validation_problems` setting). Note that, prior to [v8.1](/CHANGELOG.md#810---unreleased-yyyy-mm-dd), changes to the `max_schema_validation_problems` setting will only take effect after you restart Notepad++.
Beginning in [v7.0](/CHANGELOG.md#700---2024-02-09), validators can catch multiple JSON schema validation problems, not just one. You can use the [error form](#error-form-and-status-bar) to see where all of the schema validation problems are. To avoid very slow performance on files that do not match the schema, the validator will exit after it encounters 64 problems (configurable by the `max_schema_validation_problems` setting). Note that, prior to [v8.1](/CHANGELOG.md#810---2024-08-23), changes to the `max_schema_validation_problems` setting will only take effect after you restart Notepad++.

As of version [4.11.2](/CHANGELOG.md#4112---2023-03-21), the recursion limit for validation is currently 64. Deeper JSON than that can't be validated, period. Very deep or recursive schemas will still compile.

Expand Down Expand Up @@ -927,7 +927,7 @@ The following keywords are supported for random JSON generation:
* __Notes:__
* support added in version [4.11.2](/CHANGELOG.md#4112---2023-03-21)
* `definitions` and `$defs` keywords are equivalent.
* __Warning:__ Prior to [v8.1](/CHANGELOG.md#810---unreleased-yyyy-mm-dd), the random JSON generator did not count recursion depth, so recursive self-references in `$defs/definitions` could sometimes cause an unrecoverable Notepad++ crash. Beginning in v8.1, a recursion counter ensures that such unrecoverable crashes are extremely unlikely.
* __Warning:__ Prior to [v8.1](/CHANGELOG.md#810---2024-08-23), the random JSON generator did not count recursion depth, so recursive self-references in `$defs/definitions` could sometimes cause an unrecoverable Notepad++ crash. Beginning in v8.1, a recursion counter ensures that such unrecoverable crashes are extremely unlikely.

### Keywords for objects
* [properties](https://json-schema.org/draft/2020-12/json-schema-core.html#name-properties)
Expand All @@ -952,7 +952,7 @@ The following keywords are supported for random JSON generation:

### Random strings from regex (*added in v8.1*)

Beginning in [v8.1](/CHANGELOG.md#810---unreleased-yyyy-mm-dd), JsonTools can generate random strings from a limited subset of .NET regular expressions.
Beginning in [v8.1](/CHANGELOG.md#810---2024-08-23), JsonTools can generate random strings from a limited subset of .NET regular expressions.

If the `generate_random_patterns` setting is set to `true` (it is `false` by default), this new feature can be used to generate random strings using the `pattern` keyword, or random object properties using the `patternProperties` keyword. Random strings generated this way *ignore the `minLength` and `maxLength` keywords* of `string` schemas.

Expand Down Expand Up @@ -1034,7 +1034,7 @@ This JSON schema generator only produces schemas with the following keywords:

As of version [4.11.0](/CHANGELOG.md#4110---2023-03-15), you can set up this plugin to *automatically validate* JSON files with certain filenames whenever you open them. (*starting in version [4.11.2](/CHANGELOG.md#4112---2023-03-21), auto-validation also occurs when files are saved or renamed*)

Let's try out this feature! We can use the plugin command `Choose schemas to automatically validate filename patterns` (renamed in [v8.1](/CHANGELOG.md#810---unreleased-yyyy-mm-dd) to `Validate files with JSON schema if name matches pattern`), which will open up a file that looks like this.
Let's try out this feature! We can use the plugin command `Choose schemas to automatically validate filename patterns` (renamed in [v8.1](/CHANGELOG.md#810---2024-08-23) to `Validate files with JSON schema if name matches pattern`), which will open up a file that looks like this.

![schemas to filename patterns file new](/docs/schemasToFnamePatterns%20with%20no%20fname%20patterns.PNG)

Expand Down

0 comments on commit 277e35a

Please sign in to comment.