Skip to content

/ vuepress

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

Jump to bottom

Rename palette.styl #2108

Open
billyyyyy3320 opened this issue Jan 4, 2020 · 6 comments
Open

Rename palette.styl #2108

billyyyyy3320 opened this issue Jan 4, 2020 · 6 comments
Assignees
@billyyyyy3320
Labels
complexity: easy contribution welcome good first issue type: feature request version: 2.x

Comments

@billyyyyy3320
Copy link
Collaborator

@billyyyyy3320 billyyyyy3320 commented Jan 4, 2020 •
edited

Feature request

palette.style should be renamed since it's not only relevant to colors.

See config.styl.

What problem does this feature solve?

The name may confuse developers. See #2086.

What does the proposed API look like?

rename palette.styl to variables.styl or something else.

How should this be implemented in your opinion?

Rename it and update documentation. Add deprecated badge to palette.styl since it'll be a breaking change.

Are you willing to work on this yourself?

Yes.
@billyyyyy3320 billyyyyy3320 self-assigned this Jan 4, 2020
@meteorlxy
Copy link
Collaborator

@meteorlxy meteorlxy commented Jan 6, 2020

Breaking change
@meteorlxy
Copy link
Collaborator

@meteorlxy meteorlxy commented Jan 6, 2020 •
edited

To avoid a major version release, we can keep the palette.styl and display a deprecation notice if palette.styl exists, and totally remove it in next major version.
@billyyyyy3320
Copy link
Collaborator Author

@billyyyyy3320 billyyyyy3320 commented Jan 6, 2020

Sounds good.👌
@billyyyyy3320 billyyyyy3320 added this to To do in Maintenance via automation Mar 15, 2020
@billyyyyy3320 billyyyyy3320 removed this from To do in Maintenance Mar 15, 2020
@Mister-Hope
Copy link
Contributor

@Mister-Hope Mister-Hope commented Apr 14, 2020 •
edited

To avoid a major version release, we can keep the palette.styl and display a deprecation notice if palette.styl exists, and totally remove it in next major version.

Yes, we can support both while giving a warning in the console screen. So when can we have this feature?
@billyyyyy3320
Copy link
Collaborator Author

@billyyyyy3320 billyyyyy3320 commented Apr 14, 2020

@Mister-Hope I'm a bit busy these days. If you'd like to take it, go ahead ~
@Mister-Hope
Copy link
Contributor

@Mister-Hope Mister-Hope commented Apr 14, 2020 •
edited

@Mister-Hope I'm a bit busy these days. If you'd like to take it, go ahead ~

But a rfc here, what shall we rename it? variables? I agreed with this one, but a shorter file name cound be better. Any ideas with a shorter one?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@billyyyyy3320 billyyyyy3320

Labels
complexity: easy contribution welcome good first issue type: feature request version: 2.x
Projects
None yet
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
5 participants
@bencodezen @kefranabg @meteorlxy @Mister-Hope @billyyyyy3320
You can’t perform that action at this time.