Skip to content

Commit

Permalink
chore(release) v7.0.0
Browse files Browse the repository at this point in the history
BREAKING CHANGE: End of support for NodeJS 14.x. 
Dropping support for CommonJS.

* chore(deps): Update dependencies (minor versions)
* chore(deps): Update dependencies (major releases)
* chore(deps): Migrate to glob@9
* test: New baseline.
* bump version 6.3.3 -> 7.0.0
* docs
  • Loading branch information
about-code committed Apr 1, 2023
1 parent 04e5093 commit b077208
Show file tree
Hide file tree
Showing 63 changed files with 2,794 additions and 2,589 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/tests-functional.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
strategy:
matrix:
os: [ubuntu-latest, windows-latest, macOS-latest]
node-version: [14.x, 16.x, 17.x]
node-version: [16.x, 18.x, 19.x]
steps:
- uses: actions/checkout@v2
with:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/tests-latest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
strategy:
matrix:
os: [ubuntu-latest, windows-latest, macOS-latest]
node-version: [14.x, 16.x, 17.x]
node-version: [16.x, 18.x 19.x]
steps:
- uses: actions/checkout@v2
with:
Expand Down
30 changes: 30 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,36 @@

All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

## [7.0.0](https://github.com/about-code/glossarify-md/compare/v6.3.3...v7.0.0) (2023-03-26)


### ⚠ BREAKING CHANGES

* End of support for NodeJS 14.x.
* No longer supporting CommonJS module system, see [using with vuepress 1.x](https://github.com/about-code/glossarify-md/blob/v7.0.0/docuse-with-vuepress.md)
* Bumped `glob` dependency from `v7` to `v9`. **This *might* affect you** when using glob patterns in a glossarify-md config, e.g.:
- `glossaries` with `[{ "file": "./some/**/glob/**/pattern*.md" }]`
- `includeFiles`
- `excludeFiles`
- `keepRawFiles`

Notable changes:

- `\` is now only used as an escape character, and never as a path separator in glob patterns, so that **Windows users** have a way to match against filenames containing literal glob pattern characters.
- **Glob pattern paths must use forward-slashes as path separators**, since `\` is an escape character to match literal glob pattern characters.
- further changes see [glob/changelog.md](https://github.com/isaacs/node-glob/blob/main/changelog.md)
* bumped `fs-extra` from `v10` to `v11`

### Features

* **CSV Import** ([#255](https://github.com/about-code/glossarify-md/issues/255)) ([410c7f0](https://github.com/about-code/glossarify-md/commit/410c7f03cebed95c7c6cba2324a02adb244003dc))
* Updating node support matrix. ([a805581](https://github.com/about-code/glossarify-md/commit/a805581a1ee0ac5d0c08f4f95e975f67f6fafc3d))


### Bug Fixes

* Aliases after term description ([#266](https://github.com/about-code/glossarify-md/issues/266)) ([04e5093](https://github.com/about-code/glossarify-md/commit/04e5093dd81810e93de822e575c26d69aaf9dfdd))

### [6.3.3](https://github.com/about-code/glossarify-md/compare/v6.3.2...v6.3.3) (2023-01-27)


Expand Down
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -345,9 +345,10 @@ The term *support* refers to *runs on the given platform* and is subject to the

| NodeJS | glossarify-md | Current Test Matrix |
| ------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Current | v6+ | Tested. Should node.js introduce breaking changes which affect [glossarify-md], then we may choose to step back from supporting *Current* until it becomes the next LTS. |
| 16 LTS | v5, v6+ | Tested + Supported |
| 14 LTS | v4, v5, v6+ | Tested + Supported |
| Current | v7 | Tested. Should node.js introduce breaking changes which affect [glossarify-md], then we may choose to step back from supporting *Current* until it becomes the next LTS. |
| 18 LTS | v6, v7 | Tested + Supported
| 16 LTS | v5, v6, v7 | Tested + Supported |
| 14 LTS | v4, v5, v6 | |
| 12 LTS | v3, v4, v5 | |
| 10 LTS | v2, v3, v4 | |

Expand Down
23 changes: 0 additions & 23 deletions cjs/main.js

This file was deleted.

5 changes: 0 additions & 5 deletions cjs/package.json

This file was deleted.

12 changes: 1 addition & 11 deletions conf/v5/doc/schema-defs-csvdialect.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,4 @@
## dialect Default Value

The default value is:

```json
{
"delimiter": ";"
}
```

# dialect Properties
# csvDialect Properties



Expand Down
2 changes: 1 addition & 1 deletion conf/v5/doc/schema-defs-csvtableschema.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# schema Properties
# csvTableSchema Properties



Expand Down
2 changes: 1 addition & 1 deletion conf/v5/doc/schema-defs-csvtableschemafield.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# items Properties
# csvTableSchemaField Properties



Expand Down
2 changes: 1 addition & 1 deletion conf/v5/doc/schema-defs-csvtableschemafieldname.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## name Default Value
## csvTableSchemaFieldName Default Value

The default value is:

Expand Down
4 changes: 2 additions & 2 deletions conf/v5/doc/schema-defs-dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Print the AST of scanned markdown documents prior to linkification. May be a Reg

* is optional

* Type: any of the folllowing: `boolean` or `string` ([Details](schema-defs-dev-properties-printinputast.md))
* Type: any of the following: `boolean` or `string` ([Details](schema-defs-dev-properties-printinputast.md))

## printOutputAst

Expand All @@ -20,7 +20,7 @@ Print the AST of scanned markdown documents after linkification. May be a Regex

* is optional

* Type: any of the folllowing: `boolean` or `string` ([Details](schema-defs-dev-properties-printoutputast.md))
* Type: any of the following: `boolean` or `string` ([Details](schema-defs-dev-properties-printoutputast.md))

## reportsFile

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
## file Constraints

**pattern**: the string must match the following regular expression:
**pattern**: the string must match the following regular expression: 

```regexp
^(.*).csv$
```

[try pattern](https://regexr.com/?expression=%5E\(.\*\).csv%24 "try regular expression with regexr.com")
[try pattern](https://regexr.com/?expression=%5E\(.*\).csv%24 "try regular expression with regexr.com")
4 changes: 2 additions & 2 deletions conf/v5/doc/schema-defs-glossaryfileimport-if.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@

### file Constraints

**pattern**: the string must match the following regular expression:
**pattern**: the string must match the following regular expression: 

```regexp
^(.*).csv$
```

[try pattern](https://regexr.com/?expression=%5E\(.\*\).csv%24 "try regular expression with regexr.com")
[try pattern](https://regexr.com/?expression=%5E\(.*\).csv%24 "try regular expression with regexr.com")
4 changes: 2 additions & 2 deletions conf/v5/doc/schema-defs-glossaryfileimport-then.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ A CSV dialect descriptor. Similar to dialect in a <https://frictionlessdata.io>

* is optional

* Type: `object` ([Details](schema-defs-csvdialect.md))
* Type: `object` ([Details](schema-defs-glossaryfileimport-then-properties-dialect.md))

### dialect Default Value

Expand All @@ -45,7 +45,7 @@ The default value is:
A mapping of CSV table fields onto SKOS terms, e.g.
"fields": \[
{ "rdfType": "<http://www.w3.org/2004/02/skos/core#Concept> "},
{ "rdfType": "http\://www\.w3.org/2004/02/skos/core#prefLabel "}
{ "rdfType": "<http://www.w3.org/2004/02/skos/core#prefLabel> "}
]. Aims to be compatible with <https://frictionlessdata.io> Tabular Data Resource schema.

`schema`
Expand Down
4 changes: 2 additions & 2 deletions conf/v5/doc/schema-defs-linking.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Control the link density and whether every occurrence of a term in your document

## headingDepths

An array of numerical values each in a range of 1-6 denoting the depths of headings that should participate in term-based link creation ("linkification"). Note the dependency on `indexing.headingDepths`: The latter controls which headings to index as "terms" *at all* so only indexed headings can be linkified at all. As you likely guess this means that configuring `indexing.headingDepths: [1]` but `linking.headingDepths:[1,2]` would *not* linkify term headings at depth `2` because they haven't been indexed, before. Instead with `indexing.headingDepths: [1,2,3]` *they would* because then headings at depth 1 to 3 would be indexed which includes headings at depth `2`, of course. Or long story short: `linking.headingDepths` is expected to be a fully enclosed subset of `indexing.headingDepths`.
An array of numerical values each in a range of 1-6 denoting the headings level that should participate in term-based auto linking. Note that indexing the given levels is a prerequisite (see `indexing.headingDepths`). So configuring `indexing.headingDepths: [1]` but `linking.headingDepths:[1,2]` would *not* linkify term headings at depth `2`. Instead with `indexing.headingDepths: [1,2,3]` *would*.

`headingDepths`

Expand Down Expand Up @@ -135,7 +135,7 @@ When true appends pandoc-style {#...} heading identifiers where necessary. Note

This option can be used to deal with ambiguities and limit the number of links in case of multiple definitions of a term. For example, a value of
5: makes the system link to *at most 5* alternative definitions per term
\-5: makes the system *stop linking a term* once there are *at least 5* alternative definitions
-5: makes the system *stop linking a term* once there are *at least 5* alternative definitions
0: links the term to a single definition but provides 0 indication of alternative definitions (even if there are any).
Negative values may also be helpful when using 'glossaries' option with a glob pattern and there are multiple documents that follow a certain heading template such that the same heading appears more than once.

Expand Down
4 changes: 2 additions & 2 deletions conf/v5/doc/schema-properties-dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Print the AST of scanned markdown documents prior to linkification. May be a Reg

* is optional

* Type: any of the folllowing: `boolean` or `string` ([Details](schema-defs-dev-properties-printinputast.md))
* Type: any of the following: `boolean` or `string` ([Details](schema-defs-dev-properties-printinputast.md))

## printOutputAst

Expand All @@ -28,7 +28,7 @@ Print the AST of scanned markdown documents after linkification. May be a Regex

* is optional

* Type: any of the folllowing: `boolean` or `string` ([Details](schema-defs-dev-properties-printoutputast.md))
* Type: any of the following: `boolean` or `string` ([Details](schema-defs-dev-properties-printoutputast.md))

## reportsFile

Expand Down
4 changes: 2 additions & 2 deletions conf/v5/doc/schema-properties-linking.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ Control the link density and whether every occurrence of a term in your document

## headingDepths

An array of numerical values each in a range of 1-6 denoting the depths of headings that should participate in term-based link creation ("linkification"). Note the dependency on `indexing.headingDepths`: The latter controls which headings to index as "terms" *at all* so only indexed headings can be linkified at all. As you likely guess this means that configuring `indexing.headingDepths: [1]` but `linking.headingDepths:[1,2]` would *not* linkify term headings at depth `2` because they haven't been indexed, before. Instead with `indexing.headingDepths: [1,2,3]` *they would* because then headings at depth 1 to 3 would be indexed which includes headings at depth `2`, of course. Or long story short: `linking.headingDepths` is expected to be a fully enclosed subset of `indexing.headingDepths`.
An array of numerical values each in a range of 1-6 denoting the headings level that should participate in term-based auto linking. Note that indexing the given levels is a prerequisite (see `indexing.headingDepths`). So configuring `indexing.headingDepths: [1]` but `linking.headingDepths:[1,2]` would *not* linkify term headings at depth `2`. Instead with `indexing.headingDepths: [1,2,3]` *would*.

`headingDepths`

Expand Down Expand Up @@ -166,7 +166,7 @@ When true appends pandoc-style {#...} heading identifiers where necessary. Note

This option can be used to deal with ambiguities and limit the number of links in case of multiple definitions of a term. For example, a value of
5: makes the system link to *at most 5* alternative definitions per term
\-5: makes the system *stop linking a term* once there are *at least 5* alternative definitions
-5: makes the system *stop linking a term* once there are *at least 5* alternative definitions
0: links the term to a single definition but provides 0 indication of alternative definitions (even if there are any).
Negative values may also be helpful when using 'glossaries' option with a glob pattern and there are multiple documents that follow a certain heading template such that the same heading appears more than once.

Expand Down
Loading

0 comments on commit b077208

Please sign in to comment.