Releases: KatChaotic/sveltedoc-parser
Releases · KatChaotic/sveltedoc-parser
4.2.1
v4.2.0
[4.2.0] 14.12.2021
- 🔒 [Fixed] Upgrade all dependecies to latest version to solve known vulnarability issues.
- ✔ [Added] Add support ES6 default value assignment for method parameter Issue #75. Thanks for @ekhaled.
- ✔ [Added] Add support of method parsing when it assigned to identifier Issue #78. Thanks for @ekhaled.
- ✔ [Added] Extend typings to support
self
andtrusted
event modifiers [Issue #80]. - ✔ [Added] Introduce
JSDocTypeFunction
to support functions types in variable definitions and provide details about function parameters and methods. - ✔ [Added] Extend
JSDocType
to support newJSDocTypeFunction
- ✔ [Added] Improve type infering from assigned value. Currently support simple infering:
array
,object
,function
. - 🛠 [Fixed] Fix the Issue #67, Issue #69: specifier comments are not parsed properly; Thanks to @ekhaled
- 🛠 [Fixed] Fix the Issue #72: Module context scripts look for the wrong attribute
- 🛠 [Fixed] Fix the Issue #83: Default value and keywords of exported aliases not merged.
v4.1.0
[4.1.0] 19.02.2021
- 🎉 [Misc] Update the ReadMe by @soft-decay.
- ✔ [Added] Implement support of imported types parsing, f.ex.
@type {import('../typings.d.ts').ExternalTypeClass}
. In order to do this, new fieldimportPath
introduced toJSDocType
, in the name property now it returns imported class name, f.ex.:ExternalTypeClass
. - 🛠 [Fixed] Complete fix of Issue #1: Support parsing event names from top-level constant objects with accessing to their properties by naming strings. Introduce the new issue Issue #48 about supporting parse of event names by external references.
- 🛠 [Fixed] Fix the Issue #47, now all comments in markup are parsed correctly and attached to required items in document. Support JSDoc comment markup parsing in all places where comment can be used.
- 🛠 [Fixed] Fix the Issue #61, now slot parameter items enrich with all detailed information that was parsed from markup comment.
- 🛠 [Fixed] Spec: add the module definition typings to
typings.d.ts
file. - 🛠 [Fixed] Fix some edge-cases in script parsing logic.
- 🛠 [Tech] Refactor internal parser logic to make it easy to introduce new features, moves forward to TS support! ;)
- 🔥 [Breaking] Spec: change the
SvelteSlotParameter
definition, to supportname
,description
,type
fields, instead of many not relevant fields that was inherited fromISvelteItem
interface. - 🔥 [Breaking] Spec: change the
SvelteSlotItem
definition, to improve consistency:- Rename
parameters
property toparams
to be most likely the same asSvelteMethodItem
. Old field still available until 5.* release.
- Rename
Thanks a lot @soft-decay for contributing in this release!
v4.0.0
[4.0.0] 25.01.2021
- 🛠 [Fixed] Fix Issue #42
- 🛠 [Fixed] Partially fixed Issue #1. Now event name correcly parsed if it provided by top-level constant of the same file. Thanks for @soft-decay
- ✔ [Added] Support to complete parsing of component method arguments Issue #39. Thanks for @soft-decay
- ✔ [Added] Support to parse return types and description for methods in component Issue #37. Thanks for @soft-decay
- ✔ [Added] Options validation, thanks for @soft-decay
- 🔥 [Breaking] API rework for component methods description:
args
property was renamed toparams
;- Change the structure of
return
item for methods:desc
property was renamed todescription
;type
property now contains theJSDocType
object, instead ofstring
type with text representation of type. This can be gets fromtext
property ofJSDocType
object;
- [Svelte2]: method arguments was presented with plain array with names, now that replaced with objects of
SvelteMethodParamItem
type;
- 🔥 [Breaking] Cleanup depricated code:
loc
property was removed, please uselocations
instead, if you late with upgrade;value
property ofSvelteComponentItem
was removed, please useimportPath
instead
v3.0.4
v3.0.3
[3.0.3] 25.08.2020
- 🛠 [Fixed] Fix issue #28 (Inline event handlers in markup cause errors when used without quotes)
- Change dependency from
htmlparser2
to htmlparser2-svelte special fork of htmlparser2 to handle Svelte specific cases to parse markup
- Change dependency from
v3.0.2
[3.0.2] 24.08.2020
- 🛠 [Fixed] Fix issue #6 (Build a correct component name from a file name)
round.button.svelte -> RoundButton
- 🛠 [Fixed] Fix issue #27 (Events is not exposed from exported functions and arrow functions)
- 🛠 [Fixed] Fix issue #31 (Propogated events in markup should be parsed even it was before handled)
- 🛠 [Fixed] Fix issue #32 (Event is not registered when dispatched from functions used as a parameters of another functions)
v3.0.1
v 3.0.0
[3.0.0] 08.08.2020
- [Fixed] Solve vulnerability issues:
- Update
espree
to7.2.0
- Update
htmlparser2
to3.9.2
- Add dependency to
eslint
to fix issues after upgrading to new versions
- Update
- [Breaking] Increase requirement of Node.js to
10.0.0
, Node.js v8 now is not supported, this is related with security isssues above. Please let me know if it still required.