Skip to content

Improve single- and multi-line comment support #31

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.

Sign up for GitHub

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

Open
jacksonrayhamilton wants to merge 3 commits into
base: master
Choose a base branch
from
+65 −0
Open

Improve single- and multi-line comment support #31

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eacccc3
Improve single- and multi-line comment support
jacksonrayhamilton Mar 21, 2015
f151d0e
Add require for `c-fill-paragraph'.
jacksonrayhamilton Apr 6, 2015
bd30b17
Break comments correctly with M-j.
jacksonrayhamilton Apr 6, 2015
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
65 changes: 65 additions & 0 deletions scss-mode.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,12 @@
(require 'derived)
(require 'compile)
(require 'flymake)
(require 'css-mode) ; For `css-mode-syntax-table'.
(require 'cc-cmds) ; For `c-fill-paragraph', `c-indent-new-comment-line'.

(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 +75,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,11 +126,44 @@ 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 comment-line-break-function 'c-indent-new-comment-line)
(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))

(define-key scss-mode-map "\C-c\C-c" 'scss-compile)

;; Weirdly this is still needed when `comment-line-break-function' is bound.
(define-key scss-mode-map (kbd "M-j") 'c-indent-new-comment-line)

(defun flymake-scss-init ()
"Flymake support for SCSS files"
(let* ((temp-file (flymake-init-create-temp-buffer-copy
Expand Down