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

feat: auto-generate file `web-types.json` for WebStorm, and files `vetur-tags.json` and `vetur-attributes.json` for Vetur (closes #4107) #4110

Merged
merged 343 commits into from Oct 15, 2019

Conversation

@tmorehouse
Copy link
Member

tmorehouse commented Sep 17, 2019

Describe the PR

Generate a dist/web-types.json file for IDE editors such as WebStorm, and generate Vetur dist-vetur/attributes.json and dist/vetur-tags.json files

Closes #4107

JetBrains has updated the spec for us via JetBrains/web-types#9

For release in v2.1.0

To Do:

PR checklist

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Enhancement
  • ARIA accessibility
  • Documentation update
  • Other (please describe)

Does this PR introduce a breaking change? (check one)

  • No
  • Yes (please describe)

The PR fulfills these requirements:

  • It's submitted to the dev branch, not the master branch
  • When resolving a specific issue, it's referenced in the PR's title (i.e. [...] (fixes #xxx[,#xxx]), where "xxx" is the issue number)
  • It should address only one issue or feature. If adding multiple features or fixing a bug and adding a new feature, break them into separate PRs if at all possible.
  • The title should follow the Conventional Commits naming convention (i.e. fix(alert): not alerting during SSR render, docs(badge): update pill examples, fix typos, chore: fix typo in README, etc). This is very important, as the CHANGELOG is generated from these messages.

If new features/enhancement/fixes are added or changed:

  • Includes documentation updates (including updating the component's package.json for slot and event changes)
  • Includes any needed TypeScript declaration file updates
  • New/updated tests are included and passing (if required)
  • Existing test suites are passing
  • The changes have not impacted the functionality of other components or directives
  • ARIA Accessibility has been taken into consideration (Does it affect screen reader users or keyboard only users? Clickable items should be in the tab index, etc.)

If adding a new feature, or changing the functionality of an existing feature, the PR's
description above includes:

  • A convincing reason for adding this feature (to avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it)
@tmorehouse tmorehouse changed the title chore(web-types): generate web-types.json for WebStorm etc chore(web-types): generate web-types.json for WebStorm etc. (closes #4107) Sep 17, 2019
@codecov

This comment has been minimized.

Copy link

codecov bot commented Sep 17, 2019

Codecov Report

Merging #4110 into dev will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##              dev    #4110   +/-   ##
=======================================
  Coverage   99.86%   99.86%           
=======================================
  Files         237      237           
  Lines        4539     4539           
  Branches     1281     1281           
=======================================
  Hits         4533     4533           
  Misses          5        5           
  Partials        1        1

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 25dacb5...b8e0389. Read the comment docs.

@tmorehouse tmorehouse changed the title chore(web-types): generate web-types.json for WebStorm etc. (closes #4107) chore(web-types): generate file `web-types.json` for WebStorm etc. (closes #4107) Sep 17, 2019
@tmorehouse tmorehouse requested review from jackmu95 and pi0 Sep 18, 2019
@tmorehouse tmorehouse marked this pull request as ready for review Sep 18, 2019
@tmorehouse tmorehouse changed the title chore(web-types): generate file `web-types.json` for WebStorm etc. (closes #4107) chore(web-types): generate file `web-types.json` for WebStorm, tags/attributes.json for Vetur. (closes #4107) Sep 19, 2019
@tmorehouse tmorehouse changed the title chore(web-types): generate file `web-types.json` for WebStorm, tags/attributes.json for Vetur. (closes #4107) feat: generate file `web-types.json` for WebStorm, tags/attributes.json for Vetur. (closes #4107) Sep 19, 2019
@tmorehouse tmorehouse added PR: Minor and removed PR: Patch labels Sep 19, 2019
@tmorehouse tmorehouse added this to In progress in 2.1.0 via automation Sep 19, 2019
tmorehouse added 15 commits Sep 19, 2019
@tmorehouse tmorehouse changed the title feat: auto-generate file `web-types.json` for WebStorm, `tags.json` and `attributes.json` for Vetur, + add descriptions to prop reference (closes #4107, #3647) feat: auto-generate file `web-types.json` for WebStorm, `tags.json` and `attributes.json` for Vetur (closes #4107) Sep 27, 2019
tmorehouse added 9 commits Sep 27, 2019
@tmorehouse tmorehouse removed the Status: WIP label Oct 11, 2019
@tmorehouse tmorehouse changed the title feat: auto-generate file `web-types.json` for WebStorm, `tags.json` and `attributes.json` for Vetur (closes #4107) feat: auto-generate file `web-types.json` for WebStorm, and files `tags.json` and `attributes.json` for Vetur (closes #4107) Oct 11, 2019
@tmorehouse tmorehouse changed the title feat: auto-generate file `web-types.json` for WebStorm, and files `tags.json` and `attributes.json` for Vetur (closes #4107) feat: auto-generate file `web-types.json` for WebStorm, and files `vetur-tags.json` and `vetur-attributes.json` for Vetur (closes #4107) Oct 11, 2019
tmorehouse added 3 commits Oct 11, 2019
@tmorehouse tmorehouse requested a review from mosinve Oct 15, 2019
tmorehouse and others added 6 commits Oct 15, 2019
@tmorehouse tmorehouse merged commit 1a3e6a5 into dev Oct 15, 2019
9 checks passed
9 checks passed
License Compliance All checks passed.
Details
ci/circleci: build Your tests passed on CircleCI!
Details
ci/circleci: lint Your tests passed on CircleCI!
Details
ci/circleci: setup Your tests passed on CircleCI!
Details
ci/circleci: test Your tests passed on CircleCI!
Details
codecov/patch Coverage not affected when comparing 25dacb5...b8e0389
Details
codecov/project 99.86% remains the same compared to 25dacb5
Details
deploy/netlify Deploy preview ready!
Details
security/snyk - package.json (pi0) No new issues
Details
2.1.0 automation moved this from In progress to Done Oct 15, 2019
@tmorehouse tmorehouse deleted the tmorehouse/web-types branch Oct 15, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
2.1.0
  
Done
2 participants
You can’t perform that action at this time.