Page Menu
Home
c4science
Search
Configure Global Search
Log In
Files
F96156856
PhabricatorSyntaxHighlightingConfigOptions.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Mute Notifications
Award Token
Subscribers
None
File Metadata
Details
File Info
Storage
Attached
Created
Mon, Dec 23, 06:57
Size
5 KB
Mime Type
text/x-php
Expires
Wed, Dec 25, 06:57 (2 d)
Engine
blob
Format
Raw Data
Handle
23135206
Attached To
rPH Phabricator
PhabricatorSyntaxHighlightingConfigOptions.php
View Options
<?php
final
class
PhabricatorSyntaxHighlightingConfigOptions
extends
PhabricatorApplicationConfigOptions
{
public
function
getName
()
{
return
pht
(
'Syntax Highlighting'
);
}
public
function
getDescription
()
{
return
pht
(
'Options relating to syntax highlighting source code.'
);
}
public
function
getIcon
()
{
return
'fa-code'
;
}
public
function
getGroup
()
{
return
'core'
;
}
public
function
getOptions
()
{
$caches_href
=
PhabricatorEnv
::
getDoclink
(
'Managing Caches'
);
return
array
(
$this
->
newOption
(
'syntax-highlighter.engine'
,
'class'
,
'PhutilDefaultSyntaxHighlighterEngine'
)
->
setBaseClass
(
'PhutilSyntaxHighlighterEngine'
)
->
setSummary
(
pht
(
'Default non-pygments syntax highlighter engine.'
))
->
setDescription
(
pht
(
'Phabricator can highlight PHP by default and use Pygments for '
.
'other languages if enabled. You can provide a custom '
.
'highlighter engine by extending class %s.'
,
'PhutilSyntaxHighlighterEngine'
)),
$this
->
newOption
(
'pygments.enabled'
,
'bool'
,
false
)
->
setSummary
(
pht
(
'Should Phabricator use Pygments to highlight code?'
))
->
setBoolOptions
(
array
(
pht
(
'Use Pygments'
),
pht
(
'Do Not Use Pygments'
),
))
->
setDescription
(
pht
(
'Phabricator supports syntax highlighting a few languages by '
.
'default, but you can install Pygments (a third-party syntax '
.
'highlighting tool) to provide support for many more languages.'
.
"
\n\n
"
.
'To install Pygments, visit '
.
'[[ http://pygments.org | pygments.org ]] and follow the '
.
'download and install instructions.'
.
"
\n\n
"
.
'Once Pygments is installed, enable this option '
.
'(`pygments.enabled`) to make Phabricator use Pygments when '
.
'highlighting source code.'
.
"
\n\n
"
.
'After you install and enable Pygments, newly created source '
.
'code (like diffs and pastes) should highlight correctly. '
.
'You may need to clear Phabricator
\'
s caches to get previously '
.
'existing source code to highlight. For instructions on '
.
'managing caches, see [[ %s | Managing Caches ]].'
,
$caches_href
)),
$this
->
newOption
(
'pygments.dropdown-choices'
,
'wild'
,
array
(
'apacheconf'
=>
'Apache Configuration'
,
'bash'
=>
'Bash Scripting'
,
'brainfuck'
=>
'Brainf*ck'
,
'c'
=>
'C'
,
'coffee-script'
=>
'CoffeeScript'
,
'cpp'
=>
'C++'
,
'csharp'
=>
'C#'
,
'css'
=>
'CSS'
,
'd'
=>
'D'
,
'diff'
=>
'Diff'
,
'django'
=>
'Django Templating'
,
'docker'
=>
'Docker'
,
'erb'
=>
'Embedded Ruby/ERB'
,
'erlang'
=>
'Erlang'
,
'go'
=>
'Golang'
,
'groovy'
=>
'Groovy'
,
'haskell'
=>
'Haskell'
,
'html'
=>
'HTML'
,
'http'
=>
'HTTP'
,
'invisible'
=>
'Invisible'
,
'java'
=>
'Java'
,
'js'
=>
'Javascript'
,
'json'
=>
'JSON'
,
'make'
=>
'Makefile'
,
'mysql'
=>
'MySQL'
,
'nginx'
=>
'Nginx Configuration'
,
'objc'
=>
'Objective-C'
,
'perl'
=>
'Perl'
,
'php'
=>
'PHP'
,
'postgresql'
=>
'PostgreSQL'
,
'pot'
=>
'Gettext Catalog'
,
'puppet'
=>
'Puppet'
,
'python'
=>
'Python'
,
'rainbow'
=>
'Rainbow'
,
'remarkup'
=>
'Remarkup'
,
'rst'
=>
'reStructuredText'
,
'robotframework'
=>
'RobotFramework'
,
'ruby'
=>
'Ruby'
,
'sql'
=>
'SQL'
,
'tex'
=>
'LaTeX'
,
'text'
=>
'Plain Text'
,
'twig'
=>
'Twig'
,
'xml'
=>
'XML'
,
'yaml'
=>
'YAML'
,
))
->
setSummary
(
pht
(
'Set the language list which appears in dropdowns.'
))
->
setDescription
(
pht
(
'In places that we display a dropdown to syntax-highlight code, '
.
'this is where that list is defined.'
)),
$this
->
newOption
(
'syntax.filemap'
,
'wild'
,
array
(
'@
\.
arcconfig$@'
=>
'js'
,
'@
\.
arclint$@'
=>
'js'
,
'@
\.
divinerconfig$@'
=>
'js'
,
))
->
setSummary
(
pht
(
'Override what language files (based on filename) highlight as.'
))
->
setDescription
(
pht
(
'This is an override list of regular expressions which allows '
.
'you to choose what language files are highlighted as. If your '
.
'projects have certain rules about filenames or use unusual or '
.
'ambiguous language extensions, you can create a mapping here. '
.
'This is an ordered dictionary of regular expressions which will '
.
'be tested against the filename. They should map to either an '
.
'explicit language as a string value, or a numeric index into '
.
'the captured groups as an integer.'
))
->
addExample
(
'{"@
\\
.xyz$@": "php"}'
,
pht
(
'Highlight %s as PHP.'
,
'*.xyz'
))
->
addExample
(
'{"@/httpd
\\
.conf@": "apacheconf"}'
,
pht
(
'Highlight httpd.conf as "apacheconf".'
))
->
addExample
(
'{"@
\\
.([^.]+)
\\
.bak$@": 1}'
,
pht
(
"Treat all '*.x.bak' file as '.x'. NOTE: We map to capturing group "
.
"1 by specifying the mapping as '1'"
)),
);
}
}
Event Timeline
Log In to Comment