Skip to content

Commit

Permalink
docs: refactor **OCRenkist**'s improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
daiyam committed Feb 16, 2022
1 parent 680e9b8 commit 585f8e3
Show file tree
Hide file tree
Showing 10 changed files with 296 additions and 220 deletions.
12 changes: 6 additions & 6 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@ root = true

[*]
indent_style = tab
tab_width = 4
end_of_line = lf
charset = utf-8
tab_width = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
insert_final_newline = true

[{*.yml,*.yaml}]
indent_style = space
indent_size = 2
indent_size = 2

[*.md]
indent_style = space
indent_size = 4
indent_size = 4
10 changes: 5 additions & 5 deletions .release-it.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
git:
commitMessage: v${version}
tagName: v${version}
tagAnnotation: Release version ${version}
requireCleanWorkingDir: false
commitMessage: v${version}
tagName: v${version}
tagAnnotation: Release version ${version}
requireCleanWorkingDir: false
npm:
publish: false
publish: false
disable-metrics: true
280 changes: 140 additions & 140 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,180 +1,180 @@
# Changelog

## v0.21.0 2022-02-09
- Refactored: `explicitFolding.wilcardExclusions` has been replaced with `explicitFolding.wildcardExclusions` (with a `d`).
- Improved documentation thanks to **@OCRenkist**.
## v0.21.0 | 2022-02-09
- `explicitFolding.wilcardExclusions` has been replaced with `explicitFolding.wildcardExclusions` (with a `d`)
- improved documentation thanks to **@OCRenkist**

## v0.20.0 2021-11-08
- It’s a web extension.
## v0.20.0 | 2021-11-08
- it’s a web extension

## v0.19.3 2021-10-26
- Correctly register languages whose settings are defined by another extension.
## v0.19.3 | 2021-10-26
- correctly register languages whose settings are defined by another extension

## v0.19.2 2021-08-27
- Improve activation events.
- Add more capabilities.
## v0.19.2 | 2021-08-27
- improve activation events
- add more capabilities

## v0.19.1 2021-08-24
- Fix renamed files after **linting** the project.
## v0.19.1 | 2021-08-24
- fix renamed files after **linting** the project

## v0.19.0 2021-08-24
- Add `additionalSchemes` property to support schemes created by extensions.
## v0.19.0 | 2021-08-24
- add `additionalSchemes` property to support schemes created by extensions

## v0.18.2 2021-07-22
- Add `bypassProtection` property to be able to match empty lines.
## v0.18.2 | 2021-07-22
- add `bypassProtection` property to be able to match empty lines

## v0.18.1 2021-07-21
- Fix non-nested rules with **capture groups**.
## v0.18.1 | 2021-07-21
- fix non-nested rules with **capture groups**

## v0.18.0 2021-07-20
- Fix **capture groups** in nested rules.
- Use `endRegex` with refs are generated on the run.
- Update icon.
## v0.18.0 | 2021-07-20
- fix **capture groups** in nested rules
- `endRegex` with refs are generated on the run
- update icon

## v0.17.0 2021-07-15
- Add API to support external rules.
## v0.17.0 | 2021-07-15
- add API to support external rules

## v0.16.0 2021-07-03
- Fix indented languages by avoiding defining the folding provider.
- Add the `explicitFolding.wilcardExclusions` configuration.
## v0.16.0 | 2021-07-03
- fix indented languages by avoiding to define the folding provider
- add the `explicitFolding.wilcardExclusions` configuration

## v0.15.0 2021-07-03
- Add the `explicitFolding.autoFold` configuration to automatically fold ranges when opening a file.
## v0.15.0 | 2021-07-03
- add the `explicitFolding.autoFold` configuration to automatically fold ranges when opening a file

## v0.14.8 2021-06-25
- Fix new conflict between rules when `foldLastLine` and `nested` are `false`.
- Better explanation of `consumeEnd` in the documentation.
## v0.14.8 | 2021-06-25
- fix new conflict between rules when `foldLastLine` and `nested` are `false`
- better explanation of `consumeEnd` in the documentation

## v0.14.7 2021-06-25
- Fix how the **next offset** is calculated.
- Fix `consumeEnd` with `begin` and `end` on same line.
- Exit secondary loop at the end of the match, not at the next line.
## v0.14.7 | 2021-06-25
- fix how the **next offset** is calculated
- fix `consumeEnd` with `begin` and `end` on same line
- exit secondary loop at the end of the match, not at the next line

## v0.14.6 2021-06-25
- Manually published on **Visual Studio Marketplace**.
## v0.14.6 | 2021-06-25
- manually published on **Visual Studio Marketplace**

## v0.14.5 2021-06-24
- Fix issue with repeated `"strict": "never"`.
- Change icon.
## v0.14.5 | 2021-06-24
- fix issue with repeated `"strict": "never"`
- change icon

## v0.14.4 2021-06-21
- Fix conflict between rules when both `foldLastLine` and `nested` are `false`.
- Add icon.
## v0.14.4 | 2021-06-21
- fix conflict between rules when both `foldLastLine` and `nested` are `false`
- add icon

## v0.14.3 2021-06-20
- Fix infinite loop with single-line and non-nested regions.
## v0.14.3 | 2021-06-20
- fix infinite loop with single-line and non-nested regions

## v0.14.2 2021-06-18
- Fix global `explicitFolding.rules`.
## v0.14.2 | 2021-06-18
- fix global `explicitFolding.rules`

## v0.14.1 2021-06-18
- Fix how to determine that the `folding` configuration isnt used.
## v0.14.1 | 2021-06-18
- fix how to determine that the `folding` configuration isn't used

## v0.14.0 2021-06-18
- Rename the `folding` configuration to `explicitFolding.rules` (`folding` is supported until July 1st, 2022).
- Rename the `startupDelay` configuration to `explicitFolding.delay`.
- The configurations `explicitFolding.rules`, `explicitFolding.debug`, or `explicitFolding.delay` now can be placed in a languages section.
- The `descendants` property is regrouped with the `nested` property.
- The `begin/end` rule now fully supports the `nested` property as an array of rules.
- Add `begin/while` rule.
- Add `while` rule.
- Add documentation for each rule and its applicable properties.
## v0.14.0 | 2021-06-18
- rename the `folding` configuration to `explicitFolding.rules` (`folding` is supported until July 1st, 2022)
- rename the `startupDelay` configuration to `explicitFolding.delay`
- the configurations `explicitFolding.rules`, `explicitFolding.debug`, or `explicitFolding.delay` now can be placed in a language's section
- the `descendants` property is regrouped with the `nested` property
- the `begin/end` rule now fully supports the `nested` property as an array of rules
- add `begin/while` rule
- add `while` rule
- add documentation for each rule and its applicable properties

## v0.13.1 2021-05-18
- Fix `^` in the alternate loop for non-nested blocks.
- Improve debug messages.
## v0.13.1 | 2021-05-18
- fix `^` in the alternate loop for non-nested blocks
- improve debug messages

## v0.13.0 2021-05-14
- Use the **deferred provider** so that the real **folding provider** is loaded after the language’s unmodified folding provider. By doing so, the **folding ranges** provided by this extension are given a higher priority, such that **VSCode** is using ours instead of those from the languages folding provider (lest there be any conflict).
## v0.13.0 | 2021-05-14
- use the **deferred provider** so that the real **folding provider** is loaded after the language's folding provider. By doing so, the **folding ranges** provided by this extension are given a higher priority, such that **VSCode** is using ours instead of those from the language's folding provider.

## v0.12.1 2021-05-12
- Fix need to reload **VSCode** when changing `explicitFolding.debug`.
## v0.12.1 | 2021-05-12
- fix need to reload **VSCode** when changing `explicitFolding.debug`

## v0.12.0 2021-05-12
- Add the `explicitFolding.debug` configuration to print out debug information into the `Folding` channel of the `Output` panel.
- Add `foldEOF` property, which will close any unresolved folding at the end of the file.
- Add `foldBOF` property, only for separators.
- Add `descendants` property, only for separators.
- Add `strict` property, only for separators.
- Now `^` correctly matches the beginning of a line.
- Use new **regex** parser to support `(?<=y)x`, `(?<!y)x`, `(?i)x` and `(?i:x)`.
- Add unit tests.
## v0.12.0 | 2021-05-12
- add the `explicitFolding.debug` configuration to print out debug information into the `Folding` channel of the `Output` panel
- add `foldEOF` property, which will close any unresolved folding at the end of the file
- add `foldBOF` property, only for separators
- add `descendants` property, only for separators
- add `strict` property, only for separators
- now `^` correctly matches the beginning of a line
- use new **regex** parser to support `(?<=y)x`, `(?<!y)x`, `(?i)x` and `(?i:x)`
- add unit tests

## v0.11.0 2021-02-20
- Add `indentation` property.
- Add **flag** indicating that the extension is managing how to fold the last line (only for [MrCode](https://github.com/zokugun/MrCode)).
## v0.11.0 | 2021-02-20
- add `indentation` property
- add **flag** indicating that the extension is managing how to fold the last line (only for [MrCode](https://github.com/zokugun/MrCode))

## v0.10.0 2021-02-16
- Add dynamic `foldLastLine`.
## v0.10.0 | 2021-02-16
- add dynamic `foldLastLine`

## v0.9.2 2021-02-12
- Register **provider** to all applicable **scheme**s.
## v0.9.2 | 2021-02-12
- register **provider** to all applicable **scheme**s

## v0.9.1 2020-12-24
- Allow **provider** on all **scheme**s.
- Fix `README.md`.
## v0.9.1 | 2020-12-24
- allow **provider** on all **scheme**s
- fix `README.md`

## v0.9.0 2020-08-20
- Add the configuration `explicitFolding.startupDelay`, which will delay the registration of the **folding provider**s when starting up **VSCode** (set to `1000 ms` by default). This fixes the issue where the editor wasnt using the correct folding providers at startup.
- Add the configuration `explicitFolding.notification` to manage update notifications. By default, the notifications will be shown only for minor revisions.
## v0.9.0 | 2020-08-20
- add the configuration `explicitFolding.startupDelay`, which will delay the registration of the **folding provider**s when starting up **VSCode** (set to `1000 ms` by default). This fixes the issue where the editor wasn't using the correct folding providers at startup.
- add the configuration `explicitFolding.notification` to manage update notifications. By default, the notifications will be shown only for minor revisions.

## v0.8.2 2020-05-27
- Fix `continuation` marker when the first match doesnt include the line-continuation character.
- Fix infinite loop on configuration.
## v0.8.2 | 2020-05-27
- fix `continuation` marker when the first match doesn't include the line-continuation character
- fix infinite loop on configuration

## v0.8.1 2020-05-26
- Improve handling of non-nested rules to test only necessary **regular expression**s (**regex**).
## v0.8.1 | 2020-05-26
- improve handling of non-nested rules to test only necessary **regular expression**s (**regex**)

## v0.8.0 2020-05-26
- Add `continuation` marker.
- Fix infinite loop due to zero-length **regular expression**s.
- Fix capturing groups.
## v0.8.0 | 2020-05-26
- add `continuation` marker
- fix infinite loop due to zero-length **regular expression**s
- fix capturing groups

## v0.7.1 2020-05-22
- Add `nested` property.
## v0.7.1 | 2020-05-22
- add `nested` property

## v0.7.0 2020-05-12
- Support `docstring` blocks.
## v0.7.0 | 2020-05-12
- support **docstring** blocks

## v0.6.0 2020-04-14
- Add `separator` property.

## v0.5.1 2020-03-20
- Fix missing dependency.

## v0.5.0 2020-03-20
- Support capturing groups.
- Fix known issue only present for [MrCode](https://github.com/zokugun/MrCode).

## v0.4.0 2020-03-18
- Fix bug when `begin` and `end` markers are on the same line.
- Add `middle` marker.
- Add `foldLastLine` property.
- Add `kind` property to indicate if the range is a `comment` or a `region`.
## v0.6.0 | 2020-04-14
- add `separator` property

## v0.5.1 | 2020-03-20
- fix missing dependency

## v0.5.0 | 2020-03-20
- support capturing groups
- fix known issue only present for [MrCode](https://github.com/zokugun/MrCode)

## v0.4.0 | 2020-03-18
- fix bug when `begin` and `end` markers are on the same line
- add `middle` marker
- add `foldLastLine` property
- add `kind` property to indicate if the range is a `comment` or a `region`

## v0.3.2 2019-06-08
- Show a message when the extension is updated.
- Update dependencies due to a security issue.
## v0.3.2 | 2019-06-08
- show a message when the extension is updated
- update dependencies due to a security issue

## v0.3.1 2019-04-04
- Catch error due to bad **regex**.

## v0.3.0 2019-04-03
- Change configurations properties `begin` and `end` as regular string (not **regex**).
- Add configurations properties `beginRegex` and `endRegex` to be able to use **regex**.

## v0.2.1 2018-07-18
- Rename repository.

## v0.2.0 2018-07-18
- Rename extension.
- Support multiple markers for a language.
- Rename configurations property `start` to `begin`.

## v0.1.1 2018-07-16
- Fix an error in the settings.
- Update folding controls upon changes in the configuration.
- Fix formatting.
## v0.3.1 | 2019-04-04
- catch error due to bad **regex**

## v0.3.0 | 2019-04-03
- change configuration's properties `begin` and `end` as regular string (not **regex**)
- add configuration's properties `beginRegex` and `endRegex` to be able to use **regex**

## v0.2.1 | 2018-07-18
- rename repository

## v0.2.0 | 2018-07-18
- rename extension
- support multiple markers for a language
- rename configuration's property `start` to `begin`

## v0.1.1 | 2018-07-16
- fix an error in the settings
- update folding controls upon changes in the configuration
- fix formatting

## v0.1.0 2018-07-09
- Initial release.
## v0.1.0 | 2018-07-09
- initial release
5 changes: 2 additions & 3 deletions docs/properties/auto-fold.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# `autoFold`

The property `explicitFolding.autoFold` is an **enum** (`none` by default).
The property `explicitFolding.autoFold` is an **enum** (set to `none` by default).

It’s defining which folding ranges that are going to be folded when a document is opened.

Here is a list of the possible values and their descriptions:
Here is the list of the possible values and their descriptions:

| Value | Description |
|:--------:|:---------------------------------- |
Expand All @@ -18,4 +18,3 @@ Here is a list of the possible values and their descriptions:
| all | All folding ranges |
| comments | Comment blocks |
| none | No folding ranges |

Loading

0 comments on commit 585f8e3

Please sign in to comment.