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.

Sign up for GitHub

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

Jump to bottom

feat: implement version-related APIs for GeneratorAPI #4000

Merged
merged 6 commits into from
Jun 26, 2019
Merged

feat: implement version-related APIs for GeneratorAPI #4000

merged 6 commits into from
Jun 26, 2019

Conversation

haoqunjiang
Copy link
Member

@haoqunjiang haoqunjiang commented May 15, 2019 •
edited
Loading

To discuss: is the name serviceVersion / assertServiceVersion ideal? Any other naming ideas?

@novbing
Copy link

novbing commented May 15, 2019

To discuss: is the name serviceVersion / assertServiceVersion ideal? Any other naming ideas?

serviceVersion / exactServiceVersion
serviceVersion / lockedServiceVersion
serviceVersion / workServiceVersion
...

@haoqunjiang
Copy link
Member Author

Well, I think the assert part is accurate. But is serviceVersion clear enough to indicate that it is actually a per-project version number, in contrast to the version field as a global version number?

@novbing
Copy link

novbing commented May 16, 2019

currentVersion
localVersion
?

@haoqunjiang
Copy link
Member Author

currentVersion does not distinguish it from the global version field.

localVersion may be a good alternative but I'm not sure…
While @vue/cli-service is local, it is not depended on by GeneratorAPI…

@pksunkara
Copy link
Contributor

I would name them as following:

  • cliVersion
  • requireCliVersion
  • cliServiceVersion
  • requireCliServiceVersion

IMO easier to understand what they mean

@haoqunjiang
Copy link
Member Author

🤔prefer assert because it's in line with PluginAPI and babel's API naming.

So,

  • cliVersion
  • assertCliVersion
  • cliServiceVersion
  • assertCliServiceVersion

WDYT?

@pksunkara
Copy link
Contributor

Sounds good. We should probably backport this to v3 and let assert* just return false.

@haoqunjiang
Copy link
Member Author

Yeah, all non-breaking changes would be backported to v3.

@haoqunjiang haoqunjiang merged commit 77092b2 into vuejs:dev Jun 26, 2019
haoqunjiang added a commit that referenced this pull request Jul 3, 2019
@haoqunjiang
feat: implement version-related APIs for GeneratorAPI (#4000)
818e5dd 
closes #2336

(cherry picked from commit 77092b2)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pksunkara pksunkara pksunkara approved these changes

Assignees
No one assigned
Labels
PR: New Feature
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@haoqunjiang @novbing @pksunkara