TheRealSyler / vscode-sass-indented

Sass indented syntax support for VSCode
https://marketplace.visualstudio.com/items?itemName=Syler.sass-indented
Other
46 stars 8 forks source link

struggling with JSDoc style comment blocks indentation #47

Closed mesqueeb closed 4 years ago

mesqueeb commented 4 years ago

IMPORTANT: if the bug is related to the formatter please open the issue in the formatter repo

I'm not sure!

Describe the bug I use JSDoc syntax to document a lot of parts throughout all my apps.

I often need to make some minimal documentation for SASS variables as well.

However, while any JS/TS/Vue file works really well with JSDoc style comment blocks in VSCode, Sass files seem to try and work against me when trying to type a JSDoc comment...

I know it's possible by just adding some sort of snippet that expands into a JSDoc comment block, but the problem is when pressing ENTER, in JS/TS/Vue files it automatically adds the proper indentation and * in front of the new line inside the comments.

In Sass files, not only is the indentation is consistently wrong when pressing ENTER in a comment block and it's not helping me at all by adding or the closing / tag...

To Reproduce Steps to reproduce the behavior:

See GIF: 2020-05-01 14 51 29

Expected behavior A clear and concise description of what you expected to happen.

I expect it to automatically

TheRealSyler commented 4 years ago

@mesqueeb i will put it on my todo list.

mesqueeb commented 4 years ago

@TheRealSyler Wow thank you so much!! 😍

Here is an example of a color.sass file I'm maintaining for a project:

/**
 * There is no pure black in this interface, instead there is the awesomeness that is Blue-Zodiac.
 * Use blue-zodiac instead of black, and use it’s opacity variants for text and icon colors.
 * /
$c-blue-zodiac: #0E2348
$c-primary: rgba($c-blue-zodiac, 0.96)
$c-secondary: rgba($c-blue-zodiac, 0.72)
$c-hint: rgba($c-blue-zodiac, 0.56)
$c-disabled: rgba($c-blue-zodiac, 0.28)

PS: I'm working on a SASS file parser that can extract these variables & JSDoc style comments, and automatically create a style guide exposé. So both designer and programmer have the same source of truth.

TheRealSyler commented 4 years ago

@mesqueeb i might have a parser that already can do what you want with no or little changes, im currently working on version 2 of the extension and part of that is creating a parser that parses a file into nodes, just download the lsp-branch of this extension and look into the server/src/abstactSyntaxTree folder, you can run tests by running yarn test:watch in the server folder, just keep in mind that its finished.

mesqueeb commented 4 years ago

😅 I’m not so advanced with these things as you i think.......

But thanks so much for sharing this is the first thing i’ll look at this weekend!!!

mesqueeb commented 4 years ago

@TheRealSyler I starter working on my sass parser, and I tried your branch!

however,

"dependencies": {
    "sass-lsp-server": "/home/syler/Documents/GitHub/sass-lsp-server",
    "vscode-languageclient": "^6.1.3"
  }

your dependency is not hosted on github? :D

image
TheRealSyler commented 4 years ago

you have to download this repo and link it manually, im currently not actively working on that project, but if you run into any issues feel free to let me know.

TheRealSyler commented 4 years ago

and i think you only need the sass-lsp-server, at the time i had the server and the extension in the same repo but now its in two separate repos.

TheRealSyler commented 4 years ago

@mesqueeb i think i can close this reopen if you feel that it should stay open.

mesqueeb commented 4 years ago

@TheRealSyler thanks again for all your help so far!