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

Automatically add scss file and documentation when generating a component #40

Open
hdurix opened this issue Aug 4, 2022 · 5 comments
Open

Comments

@hdurix
Copy link
Member

hdurix commented Aug 4, 2022

For instance, when creating buttom in src/atom, is there any reason not to add:

  • include:componentDoc(height=55) button/button.md in src/atom/atom.pug
  • @import 'button/button'; in src/atom/_atom.scss
    ?

This would speed up development and help newbies :)

@Gnuk
Copy link
Member

Gnuk commented Aug 4, 2022

I understand but I'm not sure it's a good idea. First of all because with the linter, an empty file is not possible, that's why I used a comment in the tikui.scss file. And also because the CSS is the thing that people will make using the tool but the html is the thing used to document, so, it may not be a problem to have a structure for the documentation but not for the CSS. Don't hesitate to answer this ;)

@Gnuk
Copy link
Member

Gnuk commented Aug 4, 2022

Hum I answer on the bad issue for the previous comment. But I think it's not easy to understand the structure the users want to add the componentDoc or templateDoc.

@Gnuk Gnuk added question Further information is requested enhancement New feature or request and removed enhancement New feature or request question Further information is requested labels Aug 5, 2022
@hdurix
Copy link
Member Author

hdurix commented Aug 5, 2022

ideas:

  • componentDoc by default for all then the user can change
  • templateDoc by default for templates and componentDoc for other
  • componentDoc & templateDoc could be merge with a boolean for showing or not the code (could be more explicit for user)
  • option on tikui create to choose what you want (componentDoc or templateDoc or none)

Otherwise, I think using Tikui for the first time is a bit tricky

@Gnuk
Copy link
Member

Gnuk commented Aug 5, 2022

I let you suggest a PR for the simplest option you see (if you have an idea) . But you need to keep in mind that it's not because the generation is using an atomic design structure that people are forced to use this structure (if they don't want/need).

@hdurix
Copy link
Member Author

hdurix commented Aug 5, 2022

yes even if tikui-cli is already generating an atomic design structure 😛

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants