v1.5.0

Features

• feat: add support for field and type annotations by @mikaello in #350
  

What's Changed

• ci: add TypeScript type checking with JSDoc annotations by @mikaello in #347
• refactor(cli): replace arg and debug with node builtins by @mikaello in #348
• ci: create preview in review by @mikaello in #351

Full Changelog: v1.4.2...v1.5.0

v1.4.3

Fixes

• removed arg and debug dependencies and use native Node tools (#348)

v1.4.2

Enhancements

• Link to main frame (#16, pr: #346)

  

Other changes

• chore(deps): bump @babel/traverse from 7.18.2 to 7.23.2 by @dependabot[bot] in #172
• chore(deps): update dependency eslint-plugin-jest to v27.4.3 by @renovate[bot] in #173
• chore(deps): update dependency eslint to v8.52.0 by @renovate[bot] in #174
• chore(deps): update dependency eslint-plugin-jest to v27.6.0 by @renovate[bot] in #175
• chore(deps): update actions/setup-node action to v4 by @renovate[bot] in #176
• chore(deps): update dependency eslint to v8.53.0 by @renovate[bot] in #177
• fix(deps): update dependency esbuild to v0.19.6 by @renovate[bot] in #178
• chore(deps): update dependency eslint to v8.54.0 by @renovate[bot] in #179
• fix(deps): update dependency esbuild to v0.19.8 by @renovate[bot] in #180
• chore(deps): update dependency prettier to v3.1.0 by @renovate[bot] in #181
• chore(deps): update dependency eslint to v8.55.0 by @renovate[bot] in #182
• chore(deps): update dependency eslint-config-prettier to v9.1.0 by @renovate[bot] in #183
• fix(deps): update dependency esbuild to v0.19.9 by @renovate[bot] in #185
• chore(deps): update dependency prettier to v3.1.1 by @renovate[bot] in #184
• chore(deps): update dependency eslint to v8.56.0 by @renovate[bot] in #186
• fix(deps): update dependency esbuild to v0.19.10 by @renovate[bot] in #187
• fix(deps): update dependency esbuild to v0.19.11 by @renovate[bot] in #188
• chore(deps): update dependency eslint-plugin-jest to v27.6.1 by @renovate[bot] in #189
• chore(deps): update dependency eslint-plugin-jest to v27.6.3 by @renovate[bot] in #190
• chore(deps): update dependency prettier to v3.2.2 by @renovate[bot] in #191
• chore(deps): update dependency prettier to v3.2.4 by @renovate[bot] in #192
• fix(deps): update dependency esbuild to v0.20.0 by @renovate[bot] in #193
• chore(deps): update dependency prettier to v3.2.5 by @renovate[bot] in #194
• chore(deps): update dependency eslint-plugin-jest to v27.9.0 by @renovate[bot] in #195
• fix(deps): update dependency esbuild to v0.20.1 by @renovate[bot] in #196
• chore(deps): update dependency eslint to v8.57.0 by @renovate[bot] in #197
• chore(deps): update dependency express to v4.18.3 by @renovate[bot] in #198
• fix(deps): update dependency esbuild to v0.20.2 by @renovate[bot] in #199
• chore(deps): update dependency express to v4.19.1 by @renovate[bot] in #200
• chore(deps-dev): bump express from 4.19.1 to 4.19.2 by @dependabot[bot] in #201
• chore(deps): update dependency eslint to v9 by @renovate[bot] in #203
• chore(deps): update dependency eslint-plugin-jest to v28 by @renovate[bot] in #204
• chore(deps): update dependency eslint to v9.1.0 by @renovate[bot] in #205
• chore(deps): update dependency eslint to v9.1.1 by @renovate[bot] in #206
• chore(deps): update dependency eslint-plugin-jest to v28.3.0 by @renovate[bot] in #207
• chore(deps): update dependency eslint-plugin-jest to v28.5.0 by @renovate[bot] in #209
• chore(deps): update dependency eslint to v9.2.0 by @renovate[bot] in #208
• fix(deps): update dependency esbuild to v0.21.2 by @renovate[bot] in #210
• chore(deps): update dependency eslint to v9.3.0 by @renovate[bot] in #212
• fix(deps): update dependency esbuild to v0.21.3 by @renovate[bot] in #211
• fix(deps): update dependency esbuild to v0.21.4 by @renovate[bot] in #213
• chore(deps): update dependency eslint to v9.4.0 by @renovate[bot] in #215
• ci: disable eslint flat config by @mikaello in #216
• chore(deps): bump semver from 6.3.0 to 6.3.1 by @dependabot[bot] in #145
• fix(deps): update dependency debug to v4.3.5 by @renovate[bot] in #214
• fix(deps): update dependency esbuild to v0.21.5 by @renovate[bot] in #218
• chore(deps): update dependency eslint-plugin-jest to v28.6.0 by @renovate[bot] in #219
• chore(deps): update dependency eslint to v9.5.0 by @renovate[bot] in #220
• chore(deps): update dependency prettier to v3.3.2 by @renovate[bot] in #221
• chore(deps): update dependency eslint to v9.6.0 by @renovate[bot] in #222
• fix(deps): update dependency esbuild to v0.22.0 by @renovate[bot] in #223
• chore(deps): update dependency prettier to v3.3.3 by @renovate[bot] in #224
• chore(deps): update dependency eslint to v9.7.0 by @renovate[bot] in #225
• fix(deps): update dependency esbuild to v0.23.0 by @renovate[bot] in #226
• chore(deps): update dependency eslint to v9.8.0 by @renovate[bot] in #229
• fix(deps): update dependency debug to v4.3.6 by @renovate[bot] in #228
• chore(deps): update dependency eslint-plugin-jest to v28.7.0 by @renovate[bot] in #230
• chore(deps): update dependency eslint to v9.9.0 by @renovate[bot] in #231
• chore(deps): update dependency eslint-plugin-jest to v28.8.0 by @renovate[bot] in #232
• fix(deps): update dependency esbuild to v0.23.1 by @renovate[bot] in #233
• chore(deps): update dependency eslint to v9.9.1 by @renovate[bot] in #234
• chore(deps): update dependency eslint-plugin-jest to v28.8.1 by @renovate[bot] in #235
• chore(deps): update dependency eslint-plugin-jest to v28.8.3 by @renovate[bot] in #236
• chore(deps): update dependency eslint to v9.10.0 by @renovate[bot] in #238
• chore(deps): update dependency express to v4.20.0 [security] by @renovate[bot] in #241
• chore(deps): update dependency express to v4.21.0 by @renovate[bot] in #239
• fix(deps): update dependency debug to v4.3.7 by @renovate[bot] in #237
• chore(deps): update dependency eslint to v9.11.0 by @renovate[bot] in #242
• fix(deps): update dependency esbuild to v0.24.0 by @renovate[bot] in #243
• chore(deps): update dependency eslint to v9.11.1 by @renovate[bot] in #244
• chore(deps): update dependency eslint to v9.12.0 by @renovate[bot] in #245
• chore(deps): update dependency express to v4.21.1 by @renovate[bot] in #246
• chore(deps): update dependency eslint to v9.13.0 by @renovate[bot] in #247
• chore(deps): update dependency eslint to v9.14.0 by @renovate[bot] in #248
• chore(deps): update dependency eslint-plugin-jest to v28.9.0 by @renovate[bot] in #249
• chore(deps): bump @eslint/plugin-kit from 0.2.0 to 0.2.3 by @dependabot[bot] in #250
• chore(deps): update dependency eslint to v9.15.0 by @renovate[bot] in #252
• chore(deps): update dependency eslint to v9.16.0 by @re...

v1.4.1

• fix: lookup shared schemas by fully qualified name (#132)

v1.4.0 - `--title` option

Added CLI option --title for specifying page title in the generated HTML.

Example:

npx @mikaello/avrodoc-plus --input schemata/ --output avrodoc.html --title "My precious title"

v1.3.0 - Pretty printing

Add stylesheet for printing, hiding the left menu and making a more clean printout.

Previously:

After this release:

v1.2.0

Added partial support for referencing types in other schemata. This is partial because it only works if the schema to be referenced is parsed first. I.e. if you have a schema A that reference a type in B, B has to be parsed first. In practice this means that you have to be careful when ordering the schemata on the command line when you run this tool. This may be fixed in the future.

Responsible commit: 3b3dc94

Minimal example:

Schemata that reference type in external schema:

{
  "name": "TheReferrer",
  "doc": "A complex object referencing object from another schema",
  "namespace": "com.example_referrer",
  "type": "record",
  "fields": [
    {
      "name": "externalObject",
      "type": "com.example_referent.ToBeReferred",
      "doc": "An object from another schema"
    }
  ]
}

Schema that is referenced:

{
  "name": "ToBeReferred",
  "type": "record",
  "namespace": "com.example_referent",
  "doc": "A simple object provided as a building block",
  "fields": [
    {
      "name": "value",
      "type": "boolean",
      "doc": "The value of the object to be referenced"
    }
  ]
}

Result:

v1.1.0

Added option --ignore-invalid, when set avrodoc-plus will ignore schemas that can not be parsed as JSON.

v1.0.2

Upgrade bootstrap-popover and bootstrap-tooltip to v3.4.1 from v2.1.1

v1.0.0

Changes

• Upgraded almost all dependencies with major versions.
• Changed minifier from UglifyJS to ESBuild, which made compile time go from 4 seconds to less than 100ms (and about same minified file size)
• Removed Underscore dependency, using ES6 or later instead
• Added test (checking if able to build and that output contains expected content)

Breaking changes

• No IE support (in favor of removing Underscore dependency)
• CLI requires NodeJS v14 or higher