highlight-ts/src/languages/bash.ts

Highlight.JS in TypeScript (and ES6).

/*
Language: Bash
Author: vah <vahtenberg@gmail.com>
Contributrors: Benjamin Pannell <contact@sierrasoftworks.com>
Category: common
*/

import { LanguageDef } from '../types';
import { BACKSLASH_ESCAPE, TITLE_MODE, HASH_COMMENT_MODE } from '../common';

const VAR = {
    className: 'variable',
    variants: [
        { begin: /\$[\w\d#@][\w\d_]*/ },
        { begin: /\$\{(.*?)}/ }
    ]
};

const QUOTE_STRING = {
    className: 'string',
    begin: /"/, end: /"/,
    contains: [
        BACKSLASH_ESCAPE,
        VAR,
        {
            className: 'variable',
            begin: /\$\(/, end: /\)/,
            contains: [BACKSLASH_ESCAPE]
        }
    ]
};

const APOS_STRING = {
    className: 'string',
    begin: /'/, end: /'/
};

export const Bash: LanguageDef = {
    name: 'bash',
    aliases: ['sh', 'zsh'],
    lexemes: /\b-?[a-z\._]+\b/,
    keywords: {
        keyword:
            'if then else elif fi for while in do done case esac function',
        literal:
            'true false',
        built_in:
            // Shell built-ins
            // http://www.gnu.org/software/bash/manual/html_node/Shell-Builtin-Commands.html
            'break cd continue eval exec exit export getopts hash pwd readonly return shift test times ' +
            'trap umask unset ' +
            // Bash built-ins
            'alias bind builtin caller command declare echo enable help let local logout mapfile printf ' +
            'read readarray source type typeset ulimit unalias ' +
            // Shell modifiers
            'set shopt ' +
            // Zsh built-ins
            'autoload bg bindkey bye cap chdir clone comparguments compcall compctl compdescribe compfiles ' +
            'compgroups compquote comptags comptry compvalues dirs disable disown echotc echoti emulate ' +
            'fc fg float functions getcap getln history integer jobs kill limit log noglob popd print ' +
            'pushd pushln rehash sched setcap setopt stat suspend ttyctl unfunction unhash unlimit ' +
            'unsetopt vared wait whence where which zcompile zformat zftp zle zmodload zparseopts zprof ' +
            'zpty zregexparse zsocket zstyle ztcp',
        _:
            '-ne -eq -lt -gt -f -d -e -s -l -a' // relevance booster
    },
    contains: [
        {
            className: 'meta',
            begin: /^#![^\n]+sh\s*$/,
            relevance: 10
        },
        {
            className: 'function',
            begin: /\w[\w\d_]*\s*\(\s*\)\s*\{/,
            returnBegin: true,
            contains: [{ ...TITLE_MODE, begin: /\w[\w\d_]*/ }],
            relevance: 0
        },
        HASH_COMMENT_MODE,
        QUOTE_STRING,
        APOS_STRING,
        VAR
    ]
};