docs: scan for component default scss vars #1172
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for oruga-documentation-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
mlmoravek
added
the
enhancement
mlmoravek
changed the title
mlmoravek
reviewed
Feb 7, 2025
| @@ -3,6 +3,20 @@ import * as fs from "fs"; | |||
| import { type SafeDocgenCLIConfig } from "vue-docgen-cli/lib/config"; | |||
| import { getThemePath, Themes, type ThemeConfig } from "../themes-helper"; | |||
|
|
|||
| export const docsRegex = "/* @docs */"; | |||
|
|
|||
| export function getVariablesFromContent(content: string) { | |||
There was a problem hiding this comment.
Do we need to export this function and de docsRegex?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed Changes
In order to support oruga-ui/theme-bulma#154 we need to add a secondary mechanism for pulling scss variables from our files, as defaults can no longer be stored with the bulk of the scss for a given component after recent Bulma changes. This change allows the docs to scan
/scss/component-defaults/*in addition to/scss/components/*and merge the results together.I have tested this change with the current version of theme bulma and with the updated version of theme bulma. Both versions function as expected, so we should be able to merge this PR prior to the theme PR merging. Other themes are unaffected by this change, although they can opt-in to this pattern if needed.
This change only affects documentation and contains no changes to components etc.