Skip to content

Commit

Permalink
Prepare package for publish
Browse files Browse the repository at this point in the history
  • Loading branch information
alexprey committed Aug 24, 2020
1 parent 2844cb3 commit 2d295a9
Show file tree
Hide file tree
Showing 6 changed files with 49 additions and 12 deletions.
4 changes: 3 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,15 @@ All notable changes to the "svelte-intellisense" extension will be documented in

Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.

## UNRELEASED
## [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)

## [3.0.1] 17.08.2020

Expand Down
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,28 @@ Generate a JSON documentation for a Svelte file

## Changelog

### [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)

### [3.0.1] 17.08.2020

- [Fixed] Solve issue #26, support `export { variables as var }` statement.
- [Added] now interface `SvelteDataItem` provides a new property `localName` with information about internal name of component property.
- 🛠 **[Fixed]** Solve issue #26, support `export { variables as var }` statement.
- **[Added]** now interface `SvelteDataItem` provides a new property `localName` with information about internal name of component property.

### [3.0.0] 08.08.2020

- [Fixed] Solve vulnerability issues:
- 🛠 **[Fixed]** Solve vulnerability issues:
- Update `espree` to `7.2.0`
- Update `htmlparser2` to `3.9.2`
- Add dependency to `eslint` to fix issues after upgrading to new versions
- [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.
- 🔥 **[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.

Full changelog of release versions can be found [here](/CHANGELOG.md)

Expand Down
15 changes: 12 additions & 3 deletions examples/Alert.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"version": 3,
"name": "alert",
"name": "Alert",
"data": [
{
"visibility": "private",
Expand Down Expand Up @@ -51,8 +51,17 @@
"computed": [],
"methods": [],
"components": [],
"description": null,
"keywords": [],
"description": "Simple box with constrast styling to notify users.",
"keywords": [
{
"name": "component",
"description": ""
},
{
"name": "example",
"description": "<Alert closable={true} on:close={() => ...}>\nUser-defined content\n</Alert>"
}
],
"events": [
{
"visibility": "public",
Expand Down
17 changes: 16 additions & 1 deletion examples/Alert.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
<script>
/**
* Simple box with constrast styling to notify users.
*
* @component
*
* @example
* <Alert closable={true} on:close={() => ...}>
* User-defined content
* </Alert>
*/
import { createEventDispatcher } from 'svelte';
const dispatch = createEventDispatcher();
Expand All @@ -12,7 +23,11 @@
</div>
{#if closable}
<div>
<button on:click="{e => dispatch('close')}"></button>
<!--
The `close` event fired when user click to X button in the panel.
@event CloseEvent#close
-->
<button on:click="{e => dispatch('close')}">&times;</button>
</div>
{/if}
</div>
2 changes: 1 addition & 1 deletion examples/Button.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"version": 3,
"name": "button",
"name": "Button",
"data": [
{
"keywords": [
Expand Down
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "sveltedoc-parser",
"version": "3.0.1",
"version": "3.0.2",
"description": "Generate a JSON documentation for a Svelte file",
"main": "index.js",
"scripts": {
Expand Down Expand Up @@ -50,7 +50,8 @@
"eslint-plugin-node": "10.0.0",
"eslint-plugin-promise": "4.2.1",
"eslint-plugin-standard": "4.0.1",
"mocha": "8.1.1"
"mocha": "8.1.1",
"glob": "7.1.6"
},
"engines": {
"node": ">=10.0.0"
Expand Down

0 comments on commit 2d295a9

Please sign in to comment.