Skip to content
This repository has been archived by the owner on Apr 22, 2020. It is now read-only.

Add INI file syntax #593

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
94 changes: 94 additions & 0 deletions src/lang-ini.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
/**
* @license
* Copyright (C) 2019 Michael Newton
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

/**
* @fileoverview
* Registers a language handler for Windows-style "ini" configuration files
*
*
* To use, include prettify.js and this file in your HTML page.
* Then put your code in an HTML tag like
* <pre class="prettyprint lang-ini">(my ini file)</pre>
* This file supports the following extensions:
* lang-ini - Standard INI file syntax and Asterisk-style configuration files
*
* "Name" = 'INI'
* "Author" = 'Michael Newton'
* "Version" = '1.0'
* "About" = 'The INI file format is an informal standard for configuration'
* | 'files for some computing platforms or software. INI files are'
* | 'simple text files with a basic structure composed of sections,'
* | 'properties, and values.'
*
* @author https://github.com/miken32
*/

PR.registerLangHandler(
PR.createSimpleLexer(
// Patterns that always start with a known character. Must have a shortcut string.
[
[
// A line comment that starts with ;
PR.PR_COMMENT,
/^;[^\r\n]*/,
null,
';'
],
[
// key/value divider
PR.PR_PUNCTUATION,
/^=>?/,
null,
'='
],
[
// Whitespace
PR.PR_PLAIN,
/^[\t\n\r \xA0]+/,
null,
'\t\n\r \xA0'
],
[
// A double quoted string
PR.PR_STRING,
/^"(?:[^\\"]|\\.)*(?:"|$)/,
null,
'"'
],
[
// A section in square brackets
PR.PR_TYPE,
/^\[[^\]]+\]/,
null,
'['
]
],

// Patterns that will be tried in order if the shortcut ones fail. May have shortcuts.
[
[
PR.PR_KEYWORD,
/^[^=>;\r\n]+\s*=>?/
],
[
PR.PR_LITERAL,
/[!-~]+/
]
]
),
['ini']
);
26 changes: 25 additions & 1 deletion tests/prettify_test.html
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@
'lang-vb.js',
'lang-vhdl.js',
'lang-wiki.js',
'lang-yaml.js'
'lang-yaml.js',
'lang-ini.js'
];
var styles = [
'prettify.css'
Expand Down Expand Up @@ -1434,5 +1435,28 @@ <h1>Rust</h1>
}
</pre>

<h1>Ini</h1>
<pre class="prettyprint lang-ini" id="ini">
bare-key = value

[Section 1]
key1=value
key2=value
;comment
key3 = "another value"

[Section 2]
key1 = value
key2 = another value; but different
</pre>

<h1>Ini</h1>
<pre class="prettyprint lang-ini" id="ini_ast">
; asterisk-style configuration
[sub-conf-test]
exten => s,1,NoOp("testing syntax")
exten => s,2,Return()

</pre>
</body>
</html>
17 changes: 17 additions & 0 deletions tests/prettify_test.js
Original file line number Diff line number Diff line change
Expand Up @@ -1778,5 +1778,22 @@ var goldens = {
' "break" it (or the line),\n' +
' and beat it"#`END`PUN;`END`PLN\n' +
'`END`PUN}`END'
),
ini: (
'`KWDbare-key =`END`PLN `END`LITvalue`END`PLN\n\n`END' +
'`TYP[Section 1]`END`PLN\n`END' +
'`KWDkey1=`END`LITvalue`END`PLN\n`END' +
'`KWDkey2=`END`LITvalue`END`PLN\n`END' +
'`COM;comment`END`PLN\n`END' +
'`KWDkey3 =`END`PLN `END`STR"another value"`END`PLN\n\n`END' +
'`TYP[Section 2]`END`PLN\n`END' +
'`KWDkey1 =`END`PLN `END`LITvalue`END`PLN\n`END' +
'`KWDkey2 =`END`PLN `END`LITanother`END`PLN `END`LITvalue;`END`PLN `END`LITbut`END`PLN `END`LITdifferent`END'
),
ini_ast: (
'`COM; asterisk-style configuration`END`PLN\n`END' +
'`TYP[sub-conf-test]`END`PLN\n`END' +
'`KWDexten =&gt;`END`PLN `END`LITs,1,NoOp("testing`END`PLN `END`LITsyntax")`END`PLN\n`END' +
'`KWDexten =&gt;`END`PLN `END`LITs,2,Return()`END`PLN\n`END'
)
};