SCSS rules for universal ctags

scss.ctags

# Copyright 2019 Roy-Orbison
# 
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
# 
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
# 
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

--langdef=SCSS
--map-SCSS=.scss
--kinddef-SCSS=m,mixin,mixins
--kinddef-SCSS=f,function,functions
--kinddef-SCSS=v,variable,variables
--kinddef-SCSS=c,class,classes
--kinddef-SCSS=i,id,ids
--kinddef-SCSS=p,pseudo,pseudos
--_tabledef-SCSS=toplevel
--_tabledef-SCSS=comment
--_tabledef-SCSS=interp
--_tabledef-SCSS=args
--_tabledef-SCSS=map
--_tabledef-SCSS=strs
--_tabledef-SCSS=strd
--_mtable-regex-SCSS=toplevel/\/\/[^\n]*\n?//
--_mtable-regex-SCSS=toplevel/\/\*//{tenter=comment}
--_mtable-regex-SCSS=toplevel/#\{//{tenter=interp}
--_mtable-regex-SCSS=toplevel/'//{tenter=strs}
--_mtable-regex-SCSS=toplevel/"//{tenter=strd}
--_mtable-regex-SCSS=toplevel/[ \t]([A-Za-z0-9_-]+)[ \t]*:[^\n]*\n?//
--_mtable-regex-SCSS=toplevel/@mixin[ \t]+([A-Za-z0-9_-]+)/\1/m/{tenter=args}
--_mtable-regex-SCSS=toplevel/@function[ \t]+([A-Za-z0-9_-]+)/\1/f/{tenter=args}
--_mtable-regex-SCSS=toplevel/@[^\n]+\n?//
--_mtable-regex-SCSS=toplevel/:[^{;]+;\n?//
--_mtable-regex-SCSS=toplevel/:[^\n;{]+\n//
--_mtable-regex-SCSS=toplevel/::?([A-Za-z0-9_-]+)[ \t]*[,({]/\1/p/
--_mtable-regex-SCSS=toplevel/:[^\n{]+[;{]\n?//
--_mtable-regex-SCSS=toplevel/\$([A-Za-z0-9_-]+)[ \t]*:[ \t]*\(/\1/v/{tenter=map}
--_mtable-regex-SCSS=toplevel/\$([A-Za-z0-9_-]+)[ \t]*:[^\n]*\n?/\1/v/
--_mtable-regex-SCSS=toplevel/[.%]([A-Za-z0-9_-]+)/\1/c/
--_mtable-regex-SCSS=toplevel/#([A-Za-z0-9_-]+)/\1/i/
--_mtable-regex-SCSS=toplevel/.//
--_mtable-regex-SCSS=comment/\*\///{tleave}
--_mtable-regex-SCSS=comment/.//
--_mtable-regex-SCSS=interp/\}//{tleave}
--_mtable-regex-SCSS=interp/.//
--_mtable-regex-SCSS=args/\{//{tleave}
--_mtable-regex-SCSS=args/#\{//{tenter=interp}
--_mtable-regex-SCSS=args/\$([A-Za-z0-9_-]+)[ \t]*(:([ \t]*\$)?|[,)])/\1/v/
--_mtable-regex-SCSS=args/.//
--_mtable-regex-SCSS=map/\/\/[^\n]*\n?//
--_mtable-regex-SCSS=map/\/\*//{tenter=comment}
--_mtable-regex-SCSS=map/#\{//{tenter=interp}
--_mtable-regex-SCSS=map/\)//{tleave}
--_mtable-regex-SCSS=map/([A-Za-z0-9_-]+)[ \t]*:/\1/v/
--_mtable-regex-SCSS=map/'//{tenter=strs}
--_mtable-regex-SCSS=map/"//{tenter=strd}
--_mtable-regex-SCSS=map/.//
--_mtable-regex-SCSS=strs/'//{tleave}
--_mtable-regex-SCSS=strs/#\{//{tenter=interp}
--_mtable-regex-SCSS=strs/[^'#\\]+//
--_mtable-regex-SCSS=strs/\\?.//
--_mtable-regex-SCSS=strd/"//{tleave}
--_mtable-regex-SCSS=strd/#\{//{tenter=interp}
--_mtable-regex-SCSS=strd/[^"#\\]+//
--_mtable-regex-SCSS=strd/\\?.//

Drop in ~/.ctags.d/ and enable omnicompletion, e.g.:

autocmd FileType css,scss setlocal omnifunc=csscomplete#CompleteCSS  tags^=.scss.tags

Supports multi- and single-line comments. Ignores (HTML) element names, and invocations of @ language constructs that don't define anything. Has rudimentary matching of map keys as variables.

I recommend joonty/vim-taggatron to keep your tag files up-to-date.

Although forked from dreki/scss-rules-for-ctags, that was only to aid people searching for a solution. This file was written from scratch using the Universal CTags docs.

This has now been integrated into the Universal CTags core, so just update.