powershell.js 7.3 KB

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