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

Improve single- and multi-line comment support #31

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Improve single- and multi-line comment support
Use single-line comments for `comment-region' and respect them for
`fill-paragraph'.  Make `fill-paragraph' behave like `js2-mode', which
is pretty good at handling "//" and "/**/" comments.
  • Loading branch information
jacksonrayhamilton committed Mar 21, 2015
commit eacccc307d263bd0d1eb2b387d47fe6efa6c9c76
60 changes: 60 additions & 0 deletions scss-mode.el
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,11 @@
(require 'derived)
(require 'compile)
(require 'flymake)
(require 'css-mode) ; For `css-mode-syntax-table'.

(eval-and-compile
(require 'cc-styles) ; For `c-setup-paragraph-variables'.
(require 'cc-engine)) ; For `c-paragraph-start' et. al.

(defgroup scss nil
"Scss mode"
Expand Down Expand Up @@ -69,6 +74,32 @@ HYPERLINK HIGHLIGHT)"
;; Variables
'(("$[a-z_-][a-z-_0-9]*" . font-lock-constant-face)))

(defconst scss-comment-start-skip
"\\(//+\\|/\\*+\\)\\s *")

(defconst scss-comment-prefix-regexp
"//+\\|\\**")

(defconst scss-comment-start-regexp
"/[*/]\\|\\s|")

(defconst scss-paragraph-start
"\\(@[[:alpha:]]+\\>\\|$\\)")

(defconst scss-syntactic-ws-start
"\\s \\|/[*/]\\|[\n\r]\\|\\\\[\n\r]\\|\\s!\\|<!--\\|^\\s-*-->")

(defconst scss-syntactic-ws-end
"\\s \\|[\n\r/]\\|\\s!")

(defconst scss-syntactic-eol
(concat "\\s *\\(/\\*[^*\n\r]*"
"\\(\\*+[^*\n\r/][^*\n\r]*\\)*"
"\\*+/\\s *\\)*"
"\\(//\\|/\\*[^*\n\r]*"
"\\(\\*+[^*\n\r/][^*\n\r]*\\)*$"
"\\|\\\\$\\|$\\)"))

(defun scss-compile-maybe()
"Runs `scss-compile' on if `scss-compile-at-save' is t"
(if scss-compile-at-save
Expand All @@ -94,6 +125,35 @@ Special commands:
(modify-syntax-entry ?/ ". 124" css-mode-syntax-table)
(modify-syntax-entry ?* ". 23b" css-mode-syntax-table)
(modify-syntax-entry ?\n ">" css-mode-syntax-table)

;; Prefer single-line comments for `comment-region'. These variables are also
;; used by `fill-paragraph' for single-line comments.
(setq-local comment-start "//")
(setq-local comment-end "")
(setq-local comment-start-skip scss-comment-start-skip)
(setq-local comment-end-skip nil) ; Override `css-mode'.

;; Some variables needed by `cc-engine' for `fill-paragraph', etc. Copied
;; from `js2-mode'.
(setq-local fill-paragraph-function 'c-fill-paragraph)
(setq-local c-comment-prefix-regexp scss-comment-prefix-regexp)
(setq c-comment-start-regexp scss-comment-start-regexp)
(setq c-line-comment-starter "//")
(setq c-paragraph-start scss-paragraph-start)
(setq c-paragraph-separate "$")
(setq c-syntactic-ws-start scss-syntactic-ws-start)
(setq c-syntactic-ws-end scss-syntactic-ws-end)
(setq c-syntactic-eol scss-syntactic-eol)

(let ((c-buffer-is-cc-mode t))
;; Copied from `js-mode'. Also see Bug#6071.
(make-local-variable 'paragraph-start)
(make-local-variable 'paragraph-separate)
(make-local-variable 'paragraph-ignore-fill-prefix)
(make-local-variable 'adaptive-fill-mode)
(make-local-variable 'adaptive-fill-regexp)
(c-setup-paragraph-variables))

(add-to-list 'compilation-error-regexp-alist scss-compile-error-regex)
(add-hook 'after-save-hook 'scss-compile-maybe nil t))

Expand Down