static/highlight/es/languages/powershell.js

   1 /*! `powershell` grammar compiled for Highlight.js 11.11.1 */
   2 var hljsGrammar = (function () {
   3   'use strict';
   4
   5   /*
   6   Language: PowerShell
   7   Description: PowerShell is a task-based command-line shell and scripting language built on .NET.
   8   Author: David Mohundro <david@mohundro.com>
   9   Contributors: Nicholas Blumhardt <nblumhardt@nblumhardt.com>, Victor Zhou <OiCMudkips@users.noreply.github.com>, Nicolas Le Gall <contact@nlegall.fr>
  10   Website: https://docs.microsoft.com/en-us/powershell/
  11   Category: scripting
  12   */
  13
  14   function powershell(hljs) {
  15     const TYPES = [
  16       "string",
  17       "char",
  18       "byte",
  19       "int",
  20       "long",
  21       "bool",
  22       "decimal",
  23       "single",
  24       "double",
  25       "DateTime",
  26       "xml",
  27       "array",
  28       "hashtable",
  29       "void"
  30     ];
  31
  32     // https://docs.microsoft.com/en-us/powershell/scripting/developer/cmdlet/approved-verbs-for-windows-powershell-commands
  33     const VALID_VERBS =
  34       'Add|Clear|Close|Copy|Enter|Exit|Find|Format|Get|Hide|Join|Lock|'
  35       + 'Move|New|Open|Optimize|Pop|Push|Redo|Remove|Rename|Reset|Resize|'
  36       + 'Search|Select|Set|Show|Skip|Split|Step|Switch|Undo|Unlock|'
  37       + 'Watch|Backup|Checkpoint|Compare|Compress|Convert|ConvertFrom|'
  38       + 'ConvertTo|Dismount|Edit|Expand|Export|Group|Import|Initialize|'
  39       + 'Limit|Merge|Mount|Out|Publish|Restore|Save|Sync|Unpublish|Update|'
  40       + 'Approve|Assert|Build|Complete|Confirm|Deny|Deploy|Disable|Enable|Install|Invoke|'
  41       + 'Register|Request|Restart|Resume|Start|Stop|Submit|Suspend|Uninstall|'
  42       + 'Unregister|Wait|Debug|Measure|Ping|Repair|Resolve|Test|Trace|Connect|'
  43       + 'Disconnect|Read|Receive|Send|Write|Block|Grant|Protect|Revoke|Unblock|'
  44       + 'Unprotect|Use|ForEach|Sort|Tee|Where';
  45
  46     const COMPARISON_OPERATORS =
  47       '-and|-as|-band|-bnot|-bor|-bxor|-casesensitive|-ccontains|-ceq|-cge|-cgt|'
  48       + '-cle|-clike|-clt|-cmatch|-cne|-cnotcontains|-cnotlike|-cnotmatch|-contains|'
  49       + '-creplace|-csplit|-eq|-exact|-f|-file|-ge|-gt|-icontains|-ieq|-ige|-igt|'
  50       + '-ile|-ilike|-ilt|-imatch|-in|-ine|-inotcontains|-inotlike|-inotmatch|'
  51       + '-ireplace|-is|-isnot|-isplit|-join|-le|-like|-lt|-match|-ne|-not|'
  52       + '-notcontains|-notin|-notlike|-notmatch|-or|-regex|-replace|-shl|-shr|'
  53       + '-split|-wildcard|-xor';
  54
  55     const KEYWORDS = {
  56       $pattern: /-?[A-z\.\-]+\b/,
  57       keyword:
  58         'if else foreach return do while until elseif begin for trap data dynamicparam '
  59         + 'end break throw param continue finally in switch exit filter try process catch '
  60         + 'hidden static parameter',
  61       // "echo" relevance has been set to 0 to avoid auto-detect conflicts with shell transcripts
  62       built_in:
  63         'ac asnp cat cd CFS chdir clc clear clhy cli clp cls clv cnsn compare copy cp '
  64         + 'cpi cpp curl cvpa dbp del diff dir dnsn ebp echo|0 epal epcsv epsn erase etsn exsn fc fhx '
  65         + 'fl ft fw gal gbp gc gcb gci gcm gcs gdr gerr ghy gi gin gjb gl gm gmo gp gps gpv group '
  66         + 'gsn gsnp gsv gtz gu gv gwmi h history icm iex ihy ii ipal ipcsv ipmo ipsn irm ise iwmi '
  67         + 'iwr kill lp ls man md measure mi mount move mp mv nal ndr ni nmo npssc nsn nv ogv oh '
  68         + 'popd ps pushd pwd r rbp rcjb rcsn rd rdr ren ri rjb rm rmdir rmo rni rnp rp rsn rsnp '
  69         + 'rujb rv rvpa rwmi sajb sal saps sasv sbp sc scb select set shcm si sl sleep sls sort sp '
  70         + 'spjb spps spsv start stz sujb sv swmi tee trcm type wget where wjb write'
  71       // TODO: 'validate[A-Z]+' can't work in keywords
  72     };
  73
  74     const TITLE_NAME_RE = /\w[\w\d]*((-)[\w\d]+)*/;
  75
  76     const BACKTICK_ESCAPE = {
  77       begin: '`[\\s\\S]',
  78       relevance: 0
  79     };
  80
  81     const VAR = {
  82       className: 'variable',
  83       variants: [
  84         { begin: /\$\B/ },
  85         {
  86           className: 'keyword',
  87           begin: /\$this/
  88         },
  89         { begin: /\$[\w\d][\w\d_:]*/ }
  90       ]
  91     };
  92
  93     const LITERAL = {
  94       className: 'literal',
  95       begin: /\$(null|true|false)\b/
  96     };
  97
  98     const QUOTE_STRING = {
  99       className: "string",
 100       variants: [
 101         {
 102           begin: /"/,
 103           end: /"/
 104         },
 105         {
 106           begin: /@"/,
 107           end: /^"@/
 108         }
 109       ],
 110       contains: [
 111         BACKTICK_ESCAPE,
 112         VAR,
 113         {
 114           className: 'variable',
 115           begin: /\$[A-z]/,
 116           end: /[^A-z]/
 117         }
 118       ]
 119     };
 120
 121     const APOS_STRING = {
 122       className: 'string',
 123       variants: [
 124         {
 125           begin: /'/,
 126           end: /'/
 127         },
 128         {
 129           begin: /@'/,
 130           end: /^'@/
 131         }
 132       ]
 133     };
 134
 135     const PS_HELPTAGS = {
 136       className: "doctag",
 137       variants: [
 138         /* no paramater help tags */
 139         { begin: /\.(synopsis|description|example|inputs|outputs|notes|link|component|role|functionality)/ },
 140         /* one parameter help tags */
 141         { begin: /\.(parameter|forwardhelptargetname|forwardhelpcategory|remotehelprunspace|externalhelp)\s+\S+/ }
 142       ]
 143     };
 144
 145     const PS_COMMENT = hljs.inherit(
 146       hljs.COMMENT(null, null),
 147       {
 148         variants: [
 149           /* single-line comment */
 150           {
 151             begin: /#/,
 152             end: /$/
 153           },
 154           /* multi-line comment */
 155           {
 156             begin: /<#/,
 157             end: /#>/
 158           }
 159         ],
 160         contains: [ PS_HELPTAGS ]
 161       }
 162     );
 163
 164     const CMDLETS = {
 165       className: 'built_in',
 166       variants: [ { begin: '('.concat(VALID_VERBS, ')+(-)[\\w\\d]+') } ]
 167     };
 168
 169     const PS_CLASS = {
 170       className: 'class',
 171       beginKeywords: 'class enum',
 172       end: /\s*[{]/,
 173       excludeEnd: true,
 174       relevance: 0,
 175       contains: [ hljs.TITLE_MODE ]
 176     };
 177
 178     const PS_FUNCTION = {
 179       className: 'function',
 180       begin: /function\s+/,
 181       end: /\s*\{|$/,
 182       excludeEnd: true,
 183       returnBegin: true,
 184       relevance: 0,
 185       contains: [
 186         {
 187           begin: "function",
 188           relevance: 0,
 189           className: "keyword"
 190         },
 191         {
 192           className: "title",
 193           begin: TITLE_NAME_RE,
 194           relevance: 0
 195         },
 196         {
 197           begin: /\(/,
 198           end: /\)/,
 199           className: "params",
 200           relevance: 0,
 201           contains: [ VAR ]
 202         }
 203         // CMDLETS
 204       ]
 205     };
 206
 207     // Using statment, plus type, plus assembly name.
 208     const PS_USING = {
 209       begin: /using\s/,
 210       end: /$/,
 211       returnBegin: true,
 212       contains: [
 213         QUOTE_STRING,
 214         APOS_STRING,
 215         {
 216           className: 'keyword',
 217           begin: /(using|assembly|command|module|namespace|type)/
 218         }
 219       ]
 220     };
 221
 222     // Comperison operators & function named parameters.
 223     const PS_ARGUMENTS = { variants: [
 224       // PS literals are pretty verbose so it's a good idea to accent them a bit.
 225       {
 226         className: 'operator',
 227         begin: '('.concat(COMPARISON_OPERATORS, ')\\b')
 228       },
 229       {
 230         className: 'literal',
 231         begin: /(-){1,2}[\w\d-]+/,
 232         relevance: 0
 233       }
 234     ] };
 235
 236     const HASH_SIGNS = {
 237       className: 'selector-tag',
 238       begin: /@\B/,
 239       relevance: 0
 240     };
 241
 242     // It's a very general rule so I'll narrow it a bit with some strict boundaries
 243     // to avoid any possible false-positive collisions!
 244     const PS_METHODS = {
 245       className: 'function',
 246       begin: /\[.*\]\s*[\w]+[ ]??\(/,
 247       end: /$/,
 248       returnBegin: true,
 249       relevance: 0,
 250       contains: [
 251         {
 252           className: 'keyword',
 253           begin: '('.concat(
 254             KEYWORDS.keyword.toString().replace(/\s/g, '|'
 255             ), ')\\b'),
 256           endsParent: true,
 257           relevance: 0
 258         },
 259         hljs.inherit(hljs.TITLE_MODE, { endsParent: true })
 260       ]
 261     };
 262
 263     const GENTLEMANS_SET = [
 264       // STATIC_MEMBER,
 265       PS_METHODS,
 266       PS_COMMENT,
 267       BACKTICK_ESCAPE,
 268       hljs.NUMBER_MODE,
 269       QUOTE_STRING,
 270       APOS_STRING,
 271       // PS_NEW_OBJECT_TYPE,
 272       CMDLETS,
 273       VAR,
 274       LITERAL,
 275       HASH_SIGNS
 276     ];
 277
 278     const PS_TYPE = {
 279       begin: /\[/,
 280       end: /\]/,
 281       excludeBegin: true,
 282       excludeEnd: true,
 283       relevance: 0,
 284       contains: [].concat(
 285         'self',
 286         GENTLEMANS_SET,
 287         {
 288           begin: "(" + TYPES.join("|") + ")",
 289           className: "built_in",
 290           relevance: 0
 291         },
 292         {
 293           className: 'type',
 294           begin: /[\.\w\d]+/,
 295           relevance: 0
 296         }
 297       )
 298     };
 299
 300     PS_METHODS.contains.unshift(PS_TYPE);
 301
 302     return {
 303       name: 'PowerShell',
 304       aliases: [
 305         "pwsh",
 306         "ps",
 307         "ps1"
 308       ],
 309       case_insensitive: true,
 310       keywords: KEYWORDS,
 311       contains: GENTLEMANS_SET.concat(
 312         PS_CLASS,
 313         PS_FUNCTION,
 314         PS_USING,
 315         PS_ARGUMENTS,
 316         PS_TYPE
 317       )
 318     };
 319   }
 320
 321   return powershell;
 322
 323 })();
 324 ;
 325 export default hljsGrammar;