Skip to content

Commit 8a2b588

Browse files
authored
Merge pull request #2 from joshraphael/docs
docs
2 parents e440cfa + 674c3a1 commit 8a2b588

File tree

18 files changed

+241
-1777
lines changed

18 files changed

+241
-1777
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
playground/
1+
playground/
2+
rascript-upstream.js

Makefile

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,20 @@
11
SHELL := /bin/bash
22
.PHONY: test
33

4-
run:
5-
echo "Starting at http://localhost:8000"
6-
python -m SimpleHTTPServer # Python2.7
7-
# python -m http.server 8000 # Python 3
8-
94
test:
105
bash ./scripts/test.sh
116

127
gen:
13-
bash ./scripts/gen.sh
8+
bash ./scripts/gen.sh
9+
10+
upgrade:
11+
bash ./scripts/upgrade.sh
12+
13+
clean:
14+
rm -rf plyground
15+
rm rascript-upstream.js
16+
17+
run: gen
18+
echo "Starting at http://localhost:8000"
19+
python -m SimpleHTTPServer # Python2.7
20+
# python -m http.server 8000 # Python 3

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,17 @@
1-
# highlightjs-rascript
1+
# highlightjs-rascript
2+
3+
[highlight.js](https://highlightjs.org/) syntax definition for [RATools](https://github.com/Jamiras/RATools) DSL, RAScript
4+
5+
[![GitHub License](https://img.shields.io/github/license/joshraphael/highlightjs-rascript)](https://github.com/joshraphael/highlightjs-rascript/blob/main/LICENSE)
6+
[![test](https://github.com/joshraphael/highlightjs-rascript/actions/workflows/test.yaml/badge.svg)](https://github.com/joshraphael/highlightjs-rascript/actions/workflows/test.yaml)
7+
[![GitHub Tag](https://img.shields.io/github/v/tag/joshraphael/highlightjs-rascript)](https://github.com/joshraphael/highlightjs-rascript/tags)
8+
[![GitHub repo size](https://img.shields.io/github/repo-size/joshraphael/highlightjs-rascript)](https://github.com/joshraphael/highlightjs-rascript/archive/main.zip)
9+
10+
## Commands:
11+
12+
|Title|Command|Parameters|Description|
13+
|-|-|-|-|
14+
|Test|`make test`|None|Test the rascript highlightjs module|
15+
|Generate|`make gen`|None|Generate the distribution Javascript of the rascript highlightjs pacakge|
16+
|Upgrade rascript-syntax|`make upgrade`|None|Upgrade the rascript-syntax version|
17+
|Run|`make run`|None|Build and start simple http webserver with example RAScript syntax (using auto-detection)|

dist/rascript.es.min.js

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
/*! `rascript` grammar compiled for Highlight.js 11.11.1 */
2-
var hljsGrammar=(()=>{"use strict";return e=>({case_insensitive:!1,
3-
contains:[e.C_LINE_COMMENT_MODE,e.QUOTE_STRING_MODE,e.C_NUMBER_MODE,e.COMMENT("/\\*","\\*/"),{
4-
className:"variable.language",begin:/\b(this)\b/},{className:"keyword",
5-
begin:/\b(function|class|else|for|if|in|return)\b/},{className:"literal",
6-
begin:/\b(true|false)\b/},{className:"operator",
7-
begin:/(\|\||\&\&|\=\=|\!\=|\>\=|\<\=|\=\>)/},{scope:"operator",
2+
var hljsGrammar=(()=>{"use strict";return e=>({case_insensitive:!1,contains:[{
3+
begin:[/\b(byte|word|tbyte|dword|bit0|bit1|bit2|bit3|bit4|bit5|bit6|bit7|bit|low4|high4|bitcount|word_be|tbyte_be|dword_be|float|float_be|mbf32|mbf32_le|double32|double32_be|prev|prior|bcd|identity_transform|ascii_string_equals|unicode_string_equals|repeated|once|tally|deduct|never|unless|measured|trigger_when|disable_when|always_true|always_false|format|substring|length|range|array_push|array_pop|array_map|array_contains|array_reduce|array_filter|dictionary_contains_key|any_of|all_of|none_of|sum_of|tally_of|max_of|assert|achievement|rich_presence_display|rich_presence_value|rich_presence_lookup|rich_presence_ascii_string_lookup|rich_presence_macro|rich_presence_conditional_display|leaderboard|__ornext)\b/,/\(/],
4+
beginScope:{1:"title.function.invoke"},relevance:10
5+
},e.C_LINE_COMMENT_MODE,e.QUOTE_STRING_MODE,e.C_NUMBER_MODE,e.COMMENT("/\\*","\\*/"),{
6+
scope:"variable.language",begin:/\b(this)\b/,relevance:0},{scope:"keyword",
7+
begin:/\b(else|for|if|in|return)\b/,relevance:0},{scope:"literal",
8+
begin:/\b(true|false)\b/,relevance:0},{scope:"operator",
9+
begin:/(\|\||\&\&|\=\=|\!\=|\>\=|\<\=|\=\>)/,relevance:0},{scope:"operator",
810
match:/[\+\-\*\/\%\^\&\^\~\>\<\!\|]/,relevance:0},{
9-
begin:[/function[\t ]+/,/[a-zA-Z_][\w]*/,/\(/],beginScope:{2:"title.function"}
10-
},{begin:[/class[\t ]+/,/[a-zA-Z_][\w]*/],beginScope:{2:"title.class"}},{
11-
begin:[/[a-zA-Z_][\w]*/,/\(/],beginScope:{1:"title.function.invoke"}},{
12-
className:"variable",begin:/[a-zA-Z_][\w]*/,relevance:0}]})})()
13-
;export default hljsGrammar;
11+
begin:[/\b(function)\b/,/[\t ]+/,/[a-zA-Z_][\w]*/,/\(/],beginScope:{1:"keyword",
12+
3:"title.function"},relevance:0},{
13+
begin:[/\b(class)\b/,/[\t ]+/,/[a-zA-Z_][\w]*/],beginScope:{1:"keyword",
14+
3:"title.class"},relevance:0},{begin:[/[a-zA-Z_][\w]*/,/\(/],beginScope:{
15+
1:"title.function.invoke"},relevance:0},{scope:"variable",
16+
begin:/[a-zA-Z_][\w]*/,relevance:0}]})})();export default hljsGrammar;

dist/rascript.min.js

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
/*! `rascript` grammar compiled for Highlight.js 11.11.1 */
2-
(()=>{var e=(()=>{"use strict";return e=>({case_insensitive:!1,
3-
contains:[e.C_LINE_COMMENT_MODE,e.QUOTE_STRING_MODE,e.C_NUMBER_MODE,e.COMMENT("/\\*","\\*/"),{
4-
className:"variable.language",begin:/\b(this)\b/},{className:"keyword",
5-
begin:/\b(function|class|else|for|if|in|return)\b/},{className:"literal",
6-
begin:/\b(true|false)\b/},{className:"operator",
7-
begin:/(\|\||\&\&|\=\=|\!\=|\>\=|\<\=|\=\>)/},{scope:"operator",
2+
(()=>{var e=(()=>{"use strict";return e=>({case_insensitive:!1,contains:[{
3+
begin:[/\b(byte|word|tbyte|dword|bit0|bit1|bit2|bit3|bit4|bit5|bit6|bit7|bit|low4|high4|bitcount|word_be|tbyte_be|dword_be|float|float_be|mbf32|mbf32_le|double32|double32_be|prev|prior|bcd|identity_transform|ascii_string_equals|unicode_string_equals|repeated|once|tally|deduct|never|unless|measured|trigger_when|disable_when|always_true|always_false|format|substring|length|range|array_push|array_pop|array_map|array_contains|array_reduce|array_filter|dictionary_contains_key|any_of|all_of|none_of|sum_of|tally_of|max_of|assert|achievement|rich_presence_display|rich_presence_value|rich_presence_lookup|rich_presence_ascii_string_lookup|rich_presence_macro|rich_presence_conditional_display|leaderboard|__ornext)\b/,/\(/],
4+
beginScope:{1:"title.function.invoke"},relevance:10
5+
},e.C_LINE_COMMENT_MODE,e.QUOTE_STRING_MODE,e.C_NUMBER_MODE,e.COMMENT("/\\*","\\*/"),{
6+
scope:"variable.language",begin:/\b(this)\b/,relevance:0},{scope:"keyword",
7+
begin:/\b(else|for|if|in|return)\b/,relevance:0},{scope:"literal",
8+
begin:/\b(true|false)\b/,relevance:0},{scope:"operator",
9+
begin:/(\|\||\&\&|\=\=|\!\=|\>\=|\<\=|\=\>)/,relevance:0},{scope:"operator",
810
match:/[\+\-\*\/\%\^\&\^\~\>\<\!\|]/,relevance:0},{
9-
begin:[/function[\t ]+/,/[a-zA-Z_][\w]*/,/\(/],beginScope:{2:"title.function"}
10-
},{begin:[/class[\t ]+/,/[a-zA-Z_][\w]*/],beginScope:{2:"title.class"}},{
11-
begin:[/[a-zA-Z_][\w]*/,/\(/],beginScope:{1:"title.function.invoke"}},{
12-
className:"variable",begin:/[a-zA-Z_][\w]*/,relevance:0}]})})()
13-
;hljs.registerLanguage("rascript",e)})();
11+
begin:[/\b(function)\b/,/[\t ]+/,/[a-zA-Z_][\w]*/,/\(/],beginScope:{1:"keyword",
12+
3:"title.function"},relevance:0},{
13+
begin:[/\b(class)\b/,/[\t ]+/,/[a-zA-Z_][\w]*/],beginScope:{1:"keyword",
14+
3:"title.class"},relevance:0},{begin:[/[a-zA-Z_][\w]*/,/\(/],beginScope:{
15+
1:"title.function.invoke"},relevance:0},{scope:"variable",
16+
begin:/[a-zA-Z_][\w]*/,relevance:0}]})})();hljs.registerLanguage("rascript",e)
17+
})();

package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,17 @@
22
"name": "highlightjs-rascript",
33
"version": "0.0.0",
44
"description": "highlight.js syntax definition for RATools DSL, RAScript",
5-
"main": "src/rascript.js",
5+
"main": "src/languages/rascript.js",
66
"scripts": {
77
"test": "echo \"Error: no test specified\" && exit 1"
88
},
99
"repository": {
1010
"type": "git",
11-
"url": "https://github.com/joshraphael/highlightjs-rascript.git"
11+
"url": "git+https://github.com/joshraphael/highlightjs-rascript.git"
1212
},
1313
"keywords": [
1414
"rascript",
15+
"hljs",
1516
"highlight.js",
1617
"highlightjs",
1718
"syntax"

scripts/gen.sh

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ bash ./scripts/setup.sh
55
export PLAYGROUND="playground"
66
export HIGHLIGHTJS_RASCRIPT="${PLAYGROUND}/extra/highlightjs-rascript"
77

8-
cp ${PLAYGROUND}/rascript.js src/languages
9-
108
rm -rf dist
119
mkdir -p dist
1210
cd ${PLAYGROUND}

scripts/setup.sh

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,19 @@
22

33
export PLAYGROUND="playground"
44
export HIGHLIGHTJS_RASCRIPT="${PLAYGROUND}/extra/highlightjs-rascript"
5-
export RASCRIPT_SYNTAX_VERSION="v0.2.0"
5+
export RASCRIPT_SYNTAX_VERSION="v0.3.0"
6+
export HIGHLIGHTJS_VERSION="11.11.1"
67

78
rm -rf ${PLAYGROUND}
89
mkdir -p ${PLAYGROUND}
910
git clone https://github.com/highlightjs/highlight.js ${PLAYGROUND}
10-
wget -O ${PLAYGROUND}/rascript.js "https://github.com/joshraphael/rascript-syntax/releases/download/${RASCRIPT_SYNTAX_VERSION}/rascript.js"
11+
cd ${PLAYGROUND}
12+
git checkout tags/${HIGHLIGHTJS_VERSION}
13+
cd ..
14+
wget -O rascript-upstream.js "https://github.com/joshraphael/rascript-syntax/releases/download/${RASCRIPT_SYNTAX_VERSION}/rascript.js"
1115
mkdir -p ${HIGHLIGHTJS_RASCRIPT}
1216
cp -r src ${HIGHLIGHTJS_RASCRIPT}
1317
cp -r test ${HIGHLIGHTJS_RASCRIPT}
1418
cd ${PLAYGROUND}
15-
npm ci
19+
npm ci
20+
node ./tools/build.js -t cdn

scripts/test.sh

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,12 @@ bash ./scripts/setup.sh
55
export PLAYGROUND="playground"
66
export HIGHLIGHTJS_RASCRIPT="${PLAYGROUND}/extra/highlightjs-rascript"
77

8-
diff -q "src/languages/rascript.js" "${PLAYGROUND}/rascript.js"
8+
diff -q "src/languages/rascript.js" "rascript-upstream.js"
99
if [ $? -ne 0 ]; then
1010
exit 1
1111
fi
1212

1313
cd ${PLAYGROUND}
14-
node ./tools/build.js -t cdn
1514
npm run build_and_test
1615
if [ $? -ne 0 ]; then
1716
exit 1

scripts/upgrade.sh

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
#!/bin/bash
2+
3+
bash ./scripts/setup.sh
4+
5+
cp rascript-upstream.js src/languages/rascript.js

0 commit comments

Comments
 (0)