Skip to content

Conversation

@Kocal
Copy link
Owner

@Kocal Kocal commented Jun 14, 2018

The automatic behavior is removed because evaluate Vue files created too many problems: #41, #49, #47, #19, #13, #12, #4, #7.

Now you will need to explicitly declare each props/data/computed your component has.

Tags

Tag @vue is removed in favor of following tags:

  • @vue-prop
  • @vue-data
  • @vue-computed

Each of those tags have the same behaviour than @param.
You can specify a name, a description, a type, and a default value.

<script>
/**
 * @vue-prop {Number} [initialCounter=1] - Initial counter value 
 */
export default {
  props: {
    initialCounter: {
      type: Number,
      default: 1
    }
  }
}
</script>

Renderer

The renderer system will be rewritten to be more flexible, and allow support for every JSDoc templates.

For each JSDoc templates which exists, we need to write a special renderer that will be used for this template only.

Actually, there is only a default renderer, that works with... the default JSDoc template.

@Kocal Kocal added the V2 label Jun 14, 2018
@Kocal Kocal changed the title WIP: add more tags, add default renderer WIP: rewrite tags and renderer system Jun 15, 2018
@Kocal Kocal changed the title WIP: rewrite tags and renderer system WIP: rewrite tags and rendering system Jun 16, 2018
@Kocal Kocal force-pushed the refactor/tags-and-renderers branch from db54162 to cd1da3f Compare June 16, 2018 18:00
@Kocal Kocal force-pushed the refactor/tags-and-renderers branch 2 times, most recently from 64e6440 to 06554e9 Compare June 16, 2018 18:52
@Kocal Kocal force-pushed the refactor/tags-and-renderers branch from 06554e9 to 452e2a7 Compare June 16, 2018 18:57
@Kocal Kocal force-pushed the refactor/tags-and-renderers branch 2 times, most recently from af2f7fb to 7b5272c Compare June 16, 2018 19:35
@Kocal Kocal force-pushed the refactor/tags-and-renderers branch from 7b5272c to d0d1149 Compare June 16, 2018 19:46
@Kocal Kocal changed the title WIP: rewrite tags and rendering system Rewrite tags and rendering system Jun 16, 2018
@Kocal Kocal force-pushed the refactor/tags-and-renderers branch from 8e75830 to 5c88840 Compare June 16, 2018 20:45
@Kocal Kocal merged commit 3b8da99 into v2 Jun 16, 2018
@Kocal Kocal deleted the refactor/tags-and-renderers branch June 16, 2018 20:46
@Kocal Kocal changed the title Rewrite tags and rendering system refactor: rewrite tags and rendering system Jun 17, 2018
Kocal added a commit that referenced this pull request Jun 17, 2018
chore: remove useless files

chore: prepare new JSDoc tags

chore: update example tags

chore: prepare default renderer

chore: replace vue tag by three tags for prop, data, and computed

chore: work on default renderer

chore: remove out dated tests

feat: add guessRenderer

feat: add config file

fix(tag): use good name for vue-computed tag

chore: remove require hook for vue

refactor: move vue component script extractor into file

feat: remove source from doclet

chore: clean some deps and jest config

chore(test): prepare fixtures

chore: prepare renderers

chore: write unit test for renderer, but I will use Cypress for that instead

chore: prepare e2e tests

chore: tweak travis

chore: prepare cypress

chore: prepare renderers for next pr

fix tests

chore: remove pixi renderer because template is bugged

chore: try to improve tarvis speed

chore: update CHANGELOG and UPGRADE

chore(test): remove tests for renderers, because Cypress will test them

chore: move « guessRenderer » into core folder
@Kocal Kocal mentioned this pull request Jul 30, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants