search

canonical / vanilla-framework

From community websites to web applications, this CSS framework will help you achieve a consistent look and feel.
https://vanillaframework.io
GNU Lesser General Public License v3.0
842 stars 167 forks source link

Investigate SCSS comments parser for class reference #4350

Open bartaz opened 2 years ago

bartaz commented 2 years ago

During hackaton we discovered scss-comment-parser and CDocParser

scss-comment-parser: https://github.com/SassDoc/scss-comment-parser CDocParser: https://github.com/FWeinb/CDocParser

We could look into using one of them to parse custom annotations from the SCSS code to build class reference.

bartaz commented 2 years ago

Branch with POC after hackaton: https://github.com/canonical-web-and-design/vanilla-framework/tree/classreference-scss-docs-parsing

bartaz commented 2 years ago

Some notes from the code for reference:

https://github.com/canonical-web-and-design/vanilla-framework/blob/def0c74b0fb22779531d09a8b1286ff03cfdd762/scripts/create-class-references.js#L4-L23

bartaz commented 1 month ago

Triage: Effort high, impact high.

Something to consider in new architecture. Some kind of automated code reference (for styles? React components?).

syncronize-issues-to-jira[bot] commented 1 month ago

Thank you for reporting us your feedback!

The internal ticket has been created: https://warthogs.atlassian.net/browse/WD-15177.

This message was autogenerated