Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(deps): update dependency dgeni-packages to v0.30.0 #4317

Closed
wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Sep 14, 2022

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
dgeni-packages 0.16.10 -> 0.30.0 age adoption passing confidence

Release Notes

angular/dgeni-packages

v0.30.0

Compare Source

Features
  • default to git binary in environment variable (acb4f75)

v0.29.5

Compare Source

Bug Fixes

  • base: incorrect usage of fs.mkdir which does not return a promise
    (be5539ece)

v0.29.4

Compare Source

Bug Fixes

  • typescript: account for breaking change in TypeScript 4.8
    (126014)
  • jsdoc: runtime error when jsdoc uses unknown tag definition
    (19e629)

v0.29.3

Compare Source

Bug Fixes

  • typescript: correctly handle absolute paths for imported modules
    (83eb73)

New Features

  • typescript: update typescript from v3.2.4 to v4.5.4
    (317363)

Breaking Changes

typescript due to:
  • 317363: update typescript from v3.2.4 to v4.5.4

Since each TypeScript version may change the shape of the generated AST,
this update may break 3rd-party packages that directly rely on the ASTs
(that are attached to dgeni API documents).

If you are using such a packages, you should manually verify that it
works correctly with the ASTs generated by the new TypeScript version.

v0.29.2

Compare Source

Bug Fixes

  • base:
    • improve layout of checkAnchorLinks messages
      4e5c3e4
    • display doc locations even if they are 0
      a390fbf
  • ngdoc: link filter - correctly handle missing title
    affb49e

New Features

  • jsdoc: add support for parsing ES2017 syntax
    974173d

v0.29.1

Compare Source

Bug Fixes

  • git: use the package version if no tag satisfies
    (c72834)

New Features

  • git: add getPreviousVersions.versionMatcher
    (571659)

v0.29.0

Compare Source

Bug Fixes

  • nunjucks: do not fail on undefined value by default
    (cefb9e)

New Features

  • jsdoc:
    • add support for version tag
      (0fe303)
    • add support for more jsdoc tags
      (169c41)
  • jsdoc,nunjucks: update espree and nunjucks packages
    (c2a463)

v0.28.4

Compare Source

Bug Fixes

v0.28.3

Compare Source

Bug Fixes

  • base: ensure writeFile() actually writes files to disk
    (eda95f,
    #​287)

v0.28.2

Compare Source

Bug Fixes

  • git: use correct shell execution status property
    (ed275635a)

v0.28.1

Compare Source

  • Chore release - updating dependencies and switching from node-html-encoder to htmlencode

v0.28.0

Compare Source

Bug Fixes

  • git: remove shelljs dependency
    (18a1c0)
  • nunjucks: upgrade marked to avoid vulnerability
    (16ceb9,
    #​280)

Breaking Changes

nunjucks due to:
  • 16ceb9: upgrade marked to avoid vulnerability

There are a few relevant breaking changes with this latest version of marked.
This only affects usage of the renderMarkdown() service and the marked
nunjucks filter. Take a look through the
marked release notes and
check if this affects you.

v0.27.5

Compare Source

v0.27.4

Compare Source

Fixes

fix(post-process-html): ensure files are correctly published to npm 15ecab0

v0.27.3

Compare Source

  • Chore release - updating dependencies

v0.27.2

Compare Source

  • Chore release - updating dependencies

v0.27.1

Compare Source

Fixes

  • typescript: implemented method overload should have simple id and aliases 398f35d

v0.27.0

Compare Source

Dependencies

  • update to latest nunjucks package c84134b
  • update to latest TS version (3.2) 610d19b
  • update to latest canonical-path 2b8e51e

BREAKING CHANGES

The upgrade to TypeScript 3.2.2 has brought a couple of minor breaking changes:

  • the algorithm that truncates long types has changed.
    Types are now truncated at the AST node level, so are more syntactically
    accurate. Also some long types are no longer truncated.
  • the order of exports from a module has changed.
    Previously the exports were listed in the order that they appear in the sourcefile.
    Now classes appear to be listed before functions.

v0.26.12

Compare Source

Fixes

  • typescript: use correct optional parameter type 148bc94

v0.26.11

Compare Source

Features

  • typescript: allow specifying type format flags for api-doc-types 5d90fd9

v0.26.10

Compare Source

Fixes

  • nunjucks: disable autoescape for marked tag 067f74c

v0.26.9

Compare Source

Fixes

  • typescript: empty node description if first leading comment is single line trivia 5c8c4ac

v0.26.8

Compare Source

Features

  • typescript: improve declaration type text rendering da3323f

v0.26.7

Compare Source

Fixes

  • typescript: do not throw if node does not have any comment 8f6cb87

v0.26.6

Compare Source

Features

  • typescript: add option to disable leading comment concatenation bd748bb

v0.26.5

Compare Source

Fixes

  • jsdoc: support void/self-closing/custom HTML tags 2407ee6

v0.26.4

Compare Source

Fixes

  • typescript: invalid path delimiter for triple slash type directives in windows 9964b0a

v0.26.3

Compare Source

Fixes

  • typescript:
  • handle special case for triple slash reference types directives b22dab5

v0.26.2

Compare Source

Features

  • typescript:
  • include simple name in aliases of members 1d952fd

v0.26.1

Compare Source

Fixes

  • typescript: use correct optional parameter type 148bc94

v0.26.0

Compare Source

Features

  • typescript:
  • add isAbstract properties to classes and members 315b6ce
  • use TypeScript v2.7 to parse the TS source files 85ffe3a

BREAKING CHANGES:

The new version of TypeScript has better handling for specially named members such
as __constructor and __call. To support this the TypeScript API introduced a new
type __String for holding escaped versions of these strings.

This makes is much safer in case a member name collided, but it also introduces a
breaking change to the TypeScript AST public interface.

This will not affect developers using the typescript package unless they are trying
to interact with the TS AST directly, or they were expected to interact with escaped forms
of special names, such as __esModule, which is ___esModule in its escaped form.

v0.25.0

Compare Source

Fixes

  • typescript:
    • remove namespacesToInclude feature 6a893df
    • give path and outputPath initial values c5f3049

Breaking Change

The namespacesToInclude service has been removed from
the package. Now when rendering types full qualified names are
always rendered and no namespaces are stripped.

If you relied on this then you should implement a processor to
search for these rendered types and strip them.

v0.24.3

Compare Source

Features

  • typescript: expose defaultValue information on ParameterDocs ba8f57f

v0.24.2

Compare Source

Features

  • typescript:
    • expose isOptional information on ParameterDocs 39ad2fe
    • create BaseApiDoc class 9586f88

Fixes

  • typescript:
    • ParameterDoc is a type of BaseApiDoc, not ExportDoc d00b3ed
    • only use unix style line endings when rendering code ef1f83c

v0.24.1

Compare Source

Fixes

  • jsdoc: braces in the description are not jsdoc types 35763aa
  • typescript: fallback to decorators from set accessor 3a4e568
  • jsdoc: handle import statements in code name matching 5db8fc9

v0.24.0

Compare Source

Fixes

  • typescript: align default path and id templates 0ff52e2
  • typescript: do not encode anchors for member API docs 7cad978
  • base: checkAnchorLinksProcessor now copes with encoded chars f7f6f58

BREAKING CHANGE

Anchors to member API docs, whch are accessed via doc.anchor are no
longer URL encoded. You should do this in your template if that is required.

  • Before: <a href="{$ doc.anchor $}">...</a>
  • After: <a href="{$ doc.anchor | urlencode $}">...</a>

v0.23.0

Compare Source

Fixes

  • typescript:
    • show proper name for aliased exports f703414

Features

  • jsdoc:
    • improve support for named exports in the codeName service 45c28b6
  • typescript:
    • merge @param descriptions into ParameterDocs af7f521
    • process parameters as docs 4d04d8f
    • move helpers to ModuleDoc to simplify API doc constructors a776355

BREAKING CHANGE

The constructor signatures for API API docs have changed. You no longer need to pass
the basePath, namespacesToInclude or typeChecker to any API doc constructor
except for the ModuleDoc. All API docs now get hold of these values from their
containing ModuleDoc.

Generally this should not affect users of dgeni-packages since it is not expected
that API doc classes should be instantiated directly.

v0.22.1

Compare Source

Fixes

  • typescript: remove comments from re-rendered code 0be17b9

v0.22.0

Compare Source

Fixes

  • typescript: handle property accessors correctly f72b69e

BREAKING CHANGE

To support the handling of get and set accessors, there are new docTypes
"get-accessor-info" and "set-accessor-info", which need templates.

v0.21.6

Compare Source

Reverts

  • typescript: handle property accessors correctly a4be78a

This change introduced a breaking change, which is that there are new docTypes
"get-accessor-info" and "set-accessor-info", which need templates.

v0.21.5

Compare Source

Fixes

  • typescript: handle property accessors correctly 75fafcf

v0.21.4

Compare Source

Features

  • typescript:
    • add isReadonly flag to member docs 62bc533
    • include typeParameters in type-alias docs 51d8149

Fixes

  • typescript: show both type and initializer on parameters d677e72

v0.21.3

Compare Source

Features

  • typescript: track descendants of inherited classes b64e851

v0.21.2

Compare Source

Fixes

  • typescript: do not render comments in decorator arguments 7cfd802

Chores

  • upgrade to TypeScript 2.4 1d64fcc

v0.21.1

Compare Source

Features

  • typescript: support overloaded constructors ca69213

Bug Fixes

  • typescript: fix possibly null references 463ef5c

v0.21.0

Compare Source

Features

  • typescript: reference extands and implements ancestor info d7c2960

## BREAKING CHANGES:

Previously, the doc.implementsClauses and doc.extendsClauses were arrays
of strings, describing the text of the clause.

Now, these properties are of type HeritageInfo:

class HeritageInfo {
  symbol: Symbol | undefined;
  doc: ClassLikeExportDoc | undefined;
  type: ExpressionWithTypeArguments;
  text: string;
}

where the text property holds the value that was previously provided.

You need to change your code/templates to access the text of the heritage
clause from:

{% for clause in doc.extendsClauses %}{$ clause $}{% endfor %}

to:

{% for clause in doc.extendsClauses %}{$ clause.text $}{% endfor %}

v0.20.1

Compare Source

Features

  • jsdoc: add propertyof jsdoc tag 6712e54

Fixes

  • dgeni: ensure that dgeni self documenting config works 8052e9e

v0.20.0

Compare Source

This is the full release of 0.20.0 - the list of changes below includes all the beta and release candidate changes.

Features

  • base: allow checkAnchorLinks to abort processing eee3e7b
  • typescript:
    • group function/method overloads together 2155b5a
    • provide isCallMember and isNewMember options
    • split out heritage into extendsClauses and implementsClauses
    • add realFilePath/realProjectRelativePath to FileInfo c7d1b54

Performance Improvements

  • nunjucks: upgrade to v3 and enable caching of templates

Bug Fixes

  • ngdoc: pass doc object to createDocMessage fe98a84 Nick Horvath
  • typescript:
    • add type parameters to function export docs c2c2927
    • remove duplicate overload from abstract API doc members f2c481d
    • support startingLine and endingLine properties 32698f3
    • include specified namespaces in types dbe99f7
    • allow decorators to not be call expressions e41a392
    • implement the CompilerHost.readFile method 4d667ff
    • CustomCompilerHost.fileExists should not second guess extensions and base dir b7b1116
    • compile files in folders that have file-like names ee10b83
    • paths should be case sensitive 5238302
    • compile files in folders that have file-like names
    • paths to imports are case sensitive
    • group overloaded exported functions in a single doc
    • do not assume that members prefixed with _ are private
  • base: checkAnchorLinks should match URL encoded chars

Breaking Changes

Previously to 0.20.0 the service where you registered namespaces not to strip
was called ignoreTypeScriptNamespaces and took an array of regular expressions.

Now this service is called namespacesToInclude, which better reflects its
purpose. Also it is now an array of strings, since there was little benefit in it
being a regular expression.


The typescript package has been completely rewritten in TypeScript. One benefit of this is that
typings should be available for the API doc types in your own projects.

Along the way there are some changes to the properties that are attached to the API docs that are
generated. Here is a list of the things that might affect you:

  • Members starting with _ are no longer considered private. You should filter them out in a
    custom processor if you do not want them to appear in the docs.
  • API docs that have a type, e.g. functions, constants, type aliases, etc used to have a property called
    returnType but that did not make sense for non-functions. This property is renamed to type.
  • API docs that have heritage, e.g. classes and interfaces, used to have a property called heritage,
    which was a string representation containing both "implements" and "extends" clauses. These have now
    been split into two properties implementsClauses and extendsClauses, which each contain an array
    of strings.

v0.19.1

Compare Source

  • fix(typescript): capture static members correctly 0e41fae

v0.19.0

Compare Source

  • feat(typescript): upgrade to TypeScript 2.2.1 0f48e86

Breaking Changes

The upgrade to TypeScript v2 may well break projects that are generating docs
based on a TypeScript v1 application.

v0.18.0

Compare Source

  • fix(typescript): remove index from the end of module ids and names
    (e6109f57)

Breaking Changes

This has a possible breaking change if users were depending upon a module at /some/folder/index.ts
having a name of index and an id of some/folder/index.

v0.17.2

Compare Source

Bug Fixes

  • jsdoc: reset backTickParserAdapter correctly
    (a82ea9ab)

v0.17.1

Compare Source

Bug Fixes

  • typescript: ensure all modules have relative filepaths
    (434233)

v0.17.0

Compare Source

Bug Fixes

  • jsdoc: do not parse for tags within HTML blocks
    (451d84)

Breaking Changes

jsdoc due to:
  • 451d84: do not parse for tags within HTML blocks

    Tags inside HTML blocks are no longer parsed by default.
    If you wish this to enable this then you can modify the
    parseTagsProcessor.parserAdapters array from a config block:

    somePackage.config(function(parseTagsProcessor, backtickParserAdapter) {
      parseTagsProcessor.parserAdapters = [backtickParserAdapter];
    });
    

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

@renovate renovate bot force-pushed the renovate/dgeni-packages-0.x branch from 27fd629 to da27a94 Compare September 14, 2022 09:14
@renovate renovate bot force-pushed the renovate/dgeni-packages-0.x branch from da27a94 to a6bf753 Compare September 26, 2022 08:11
@renovate renovate bot force-pushed the renovate/dgeni-packages-0.x branch 6 times, most recently from 6000813 to c8c352c Compare October 16, 2022 12:32
@renovate renovate bot force-pushed the renovate/dgeni-packages-0.x branch 3 times, most recently from adfcbb2 to cdc1b6d Compare October 22, 2022 17:04
@renovate renovate bot force-pushed the renovate/dgeni-packages-0.x branch from cdc1b6d to 9480853 Compare October 26, 2022 16:44
@renovate renovate bot force-pushed the renovate/dgeni-packages-0.x branch from 9480853 to e3a383a Compare November 6, 2022 15:39
@renovate renovate bot changed the title chore(deps): update dependency dgeni-packages to v0.30.0 Update dependency dgeni-packages to v0.30.0 Dec 17, 2022
@renovate renovate bot changed the title Update dependency dgeni-packages to v0.30.0 chore(deps): update dependency dgeni-packages to v0.30.0 Dec 17, 2022
@danielsogl danielsogl closed this Dec 31, 2022
@renovate
Copy link
Contributor Author

renovate bot commented Dec 31, 2022

Renovate Ignore Notification

Because you closed this PR without merging, Renovate will ignore this update (0.30.0). You will get a PR once a newer version is released. To ignore this dependency forever, add it to the ignoreDeps array of your Renovate config.

If you accidentally closed this PR, or if you changed your mind: rename this PR to get a fresh replacement PR.

@renovate renovate bot deleted the renovate/dgeni-packages-0.x branch December 31, 2022 08:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant