chore(deps): update dependency dgeni-packages to v0.30.0 #4317
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
0.16.10
->0.30.0
Release Notes
angular/dgeni-packages
v0.30.0
Compare Source
Features
v0.29.5
Compare Source
Bug Fixes
fs.mkdir
which does not return a promise(be5539ece)
v0.29.4
Compare Source
Bug Fixes
(126014)
(19e629)
v0.29.3
Compare Source
Bug Fixes
(83eb73)
New Features
typescript
from v3.2.4 to v4.5.4(317363)
Breaking Changes
typescript due to:
typescript
from v3.2.4 to v4.5.4Since 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
4e5c3e4
a390fbf
affb49e
New Features
974173d
v0.29.1
Compare Source
Bug Fixes
(c72834)
New Features
getPreviousVersions.versionMatcher
(571659)
v0.29.0
Compare Source
Bug Fixes
(cefb9e)
New Features
(0fe303)
(169c41)
(c2a463)
v0.28.4
Compare Source
Bug Fixes
(abfdf5,
#290)
v0.28.3
Compare Source
Bug Fixes
(eda95f,
#287)
v0.28.2
Compare Source
Bug Fixes
(ed275635a)
v0.28.1
Compare Source
node-html-encoder
tohtmlencode
v0.28.0
Compare Source
Bug Fixes
shelljs
dependency(18a1c0)
marked
to avoid vulnerability(16ceb9,
#280)
Breaking Changes
nunjucks due to:
marked
to avoid vulnerabilityThere are a few relevant breaking changes with this latest version of
marked
.This only affects usage of the
renderMarkdown()
service and themarked
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
v0.27.2
Compare Source
v0.27.1
Compare Source
Fixes
398f35d
v0.27.0
Compare Source
Dependencies
c84134b
610d19b
2b8e51e
BREAKING CHANGES
The upgrade to TypeScript 3.2.2 has brought a couple of minor breaking changes:
Types are now truncated at the AST node level, so are more syntactically
accurate. Also some long types are no longer truncated.
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
148bc94
v0.26.11
Compare Source
Features
5d90fd9
v0.26.10
Compare Source
Fixes
067f74c
v0.26.9
Compare Source
Fixes
5c8c4ac
v0.26.8
Compare Source
Features
da3323f
v0.26.7
Compare Source
Fixes
8f6cb87
v0.26.6
Compare Source
Features
bd748bb
v0.26.5
Compare Source
Fixes
2407ee6
v0.26.4
Compare Source
Fixes
9964b0a
v0.26.3
Compare Source
Fixes
b22dab5
v0.26.2
Compare Source
Features
1d952fd
v0.26.1
Compare Source
Fixes
148bc94
v0.26.0
Compare Source
Features
isAbstract
properties to classes and members315b6ce
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 newtype
__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 tryingto 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
namespacesToInclude
feature6a893df
path
andoutputPath
initial valuesc5f3049
Breaking Change
The
namespacesToInclude
service has been removed fromthe 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
defaultValue
information on ParameterDocsba8f57f
v0.24.2
Compare Source
Features
isOptional
information on ParameterDocs39ad2fe
BaseApiDoc
class9586f88
Fixes
ParameterDoc
is a type ofBaseApiDoc
, notExportDoc
d00b3ed
ef1f83c
v0.24.1
Compare Source
Fixes
35763aa
3a4e568
5db8fc9
v0.24.0
Compare Source
Fixes
0ff52e2
7cad978
f7f6f58
BREAKING CHANGE
Anchors to member API docs, whch are accessed via
doc.anchor
are nolonger URL encoded. You should do this in your template if that is required.
<a href="{$ doc.anchor $}">...</a>
<a href="{$ doc.anchor | urlencode $}">...</a>
v0.23.0
Compare Source
Fixes
f703414
Features
45c28b6
@param
descriptions intoParameterDoc
saf7f521
4d04d8f
a776355
BREAKING CHANGE
The constructor signatures for API API docs have changed. You no longer need to pass
the
basePath
,namespacesToInclude
ortypeChecker
to any API doc constructorexcept for the
ModuleDoc
. All API docs now get hold of these values from theircontaining
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
0be17b9
v0.22.0
Compare Source
Fixes
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
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
75fafcf
v0.21.4
Compare Source
Features
62bc533
51d8149
Fixes
d677e72
v0.21.3
Compare Source
Features
b64e851
v0.21.2
Compare Source
Fixes
7cfd802
Chores
1d64fcc
v0.21.1
Compare Source
Features
ca69213
Bug Fixes
463ef5c
v0.21.0
Compare Source
Features
extands
andimplements
ancestor infod7c2960
## BREAKING CHANGES:
Previously, the
doc.implementsClauses
anddoc.extendsClauses
were arraysof strings, describing the text of the clause.
Now, these properties are of type
HeritageInfo
: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:
to:
v0.20.1
Compare Source
Features
6712e54
Fixes
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
eee3e7b
2155b5a
realFilePath
/realProjectRelativePath
toFileInfo
c7d1b54
Performance Improvements
Bug Fixes
fe98a84
Nick Horvathc2c2927
f2c481d
32698f3
dbe99f7
e41a392
4d667ff
b7b1116
ee10b83
5238302
_
are privateBreaking 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 itspurpose. 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:
_
are no longer considered private. You should filter them out in acustom processor if you do not want them to appear in the docs.
returnType
but that did not make sense for non-functions. This property is renamed totype
.heritage
,which was a string representation containing both "implements" and "extends" clauses. These have now
been split into two properties
implementsClauses
andextendsClauses
, which each contain an arrayof strings.
v0.19.1
Compare Source
0e41fae
v0.19.0
Compare Source
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
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 ofsome/folder/index
.v0.17.2
Compare Source
Bug Fixes
(a82ea9ab)
v0.17.1
Compare Source
Bug Fixes
(434233)
v0.17.0
Compare Source
Bug Fixes
(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: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.
This PR has been generated by Mend Renovate. View repository job log here.