Skip to content

Add onEnterRule for SassDoc documentation#150599

Merged
aeschli merged 2 commits intomicrosoft:mainfrom
wkillerud:sassdoc-on-enter
May 30, 2022
Merged

Add onEnterRule for SassDoc documentation#150599
aeschli merged 2 commits intomicrosoft:mainfrom
wkillerud:sassdoc-on-enter

Conversation

@wkillerud
Copy link
Copy Markdown
Contributor

This PR fixes #150598

The proposed change extends the language configuration for SCSS with an onEnterRule to make the SassDoc editing experience closer to that of JSDoc.

An example test is shown in the second video attached to #150598.

This SCSS can be used to test the change.

/// Describe some-function, explaining what it does and how to use it. Try to add a new line after this.
@function some-function() {
    @return 2px;
}

.a {
    /// Confirm that SassDoc that is indented works as expected. Try to add a new line after this.
    $some-variable: 1px;  /// Try to add a new line after this. The rule should not kick in.
}

@wkillerud wkillerud changed the title Add onEnterRule for SassDoc documentation (fix #150598) Add onEnterRule for SassDoc documentation May 28, 2022
@aeschli aeschli requested a review from dbaeumer May 30, 2022 12:05
@aeschli aeschli added this to the May 2022 milestone May 30, 2022
@aeschli aeschli added the css-less-scss Issues and items concerning CSS,Less,SCSS styling label May 30, 2022
@aeschli aeschli self-requested a review May 30, 2022 12:06
@aeschli aeschli merged commit 869d707 into microsoft:main May 30, 2022
@github-actions github-actions bot locked and limited conversation to collaborators Jul 14, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

css-less-scss Issues and items concerning CSS,Less,SCSS styling

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add an onEnterRule to SCSS language config for SassDoc documentation blocks to append ///

3 participants