forked from andre-simon/highlight
-
Notifications
You must be signed in to change notification settings - Fork 4
/
highlight-langs2adoc.sh
executable file
·136 lines (119 loc) · 5.07 KB
/
highlight-langs2adoc.sh
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
#!/bin/bash
# "highlight-langs2adoc.sh" v1.1.0 2019/03/30 | by Tristano Ajmone | MIT License
# ******************************************************************************
# * *
# * Highlight Languages 2 AsciiDoc Page *
# * *
# ******************************************************************************
# The script queries Highlight for its version and the full list of packaged
# languages, it then creates a well formatted AsciiDoc file.
#
# Created for autoupdating the Highlight README_LANGLIST page that lists all the
# supported languages by the latest Highlight version:
#
# https://gitlab.com/saalen/highlight/README_LANGLIST.adoc
#
# You're free to adapt this script to your own needs, but please do honour its
# license terms and duely credit me!
# ------------------------------------------------------------------------------
echo "==========================================="
echo "Autogenerating Highlight langs list page..."
echo "==========================================="
# ===========================
# Setup Environment Variables
# ===========================
# The output AsciiDoc file:
OUT_FILE="./README_LANGLIST.adoc"
# =========================
# Retrieve Highlight Version
# =========================
HL_VER="$(highlight --version | grep -P -o -m1 '\d\.\d\d')"
echo "Highlight version found: ${HL_VER}"
# ================================
# Retrieve Current Date (Moth Year)
# ================================
CURR_DATE="$(LANG=en_US.utf8 date -u '+%B %Y')"
echo "Current date: ${CURR_DATE}"
# =================================
# Write Document Chunk #1 -- Header
# =================================
cat << EOF > $OUT_FILE
= HIGHLIGHT LANGUAGES LIST
André Simon
v${HL_VER}, ${CURR_DATE}
:lang: en
:experimental:
:icons: font
:linkattrs:
:toc!:
// GitHub Settings for Admonitions Icons:
ifdef::env-github[]
:caution-caption: :fire:
:important-caption: :heavy_exclamation_mark:
:note-caption: :information_source:
:tip-caption: :bulb:
:warning-caption: :warning:
endif::[]
////
*****************************************
* THIS IS AN AUTO-GENERATED DOCUMENT!!! *
*****************************************
Any manual changes to this document will be
overwritten by automated scripted updates!
////
// =====================================
// Custom Attributes for Reference Links
// =====================================
:README: pass:q[link:README.adoc[\`README\`]]
:filetypes_conf: pass:q[link:filetypes.conf[\`filetypes.conf\`^]]
:script: pass:q[link:highlight-langs2md.sh[script^,title="View source of 'highlight-langs2md.sh' script"]]
The table below lists all supported languages, their syntax definition filenames,
and the associated file extensions (configured in {filetypes_conf}).
By default, the \`*.lang\` files are located in \`/usr/share/highlight/langDefs/\`.
See the {README} for other user defined locations.
# Languages List
Packaged language definitions, obtained via \`highlight --list-scripts=langs\`
[cols="<4d,<1m,<5m"]
|==========================================
| Language | Filename | Extensions
EOF
# =====================================
# Write Document Chunk #2 -- Langs List
# =====================================
highlight --list-scripts=langs |\
grep -x -E '^(.*?)( *: )(.*?)$' |\
sed -E 's/^(.*?): *(\w+)(( +\()(.*?)( +\)))?/| \1 | link:.\/langDefs\/\2.lang[`\2.lang`,title="View source file"] | \5/g' |\
sort -\
>> $OUT_FILE
# =================================
# Write Document Chunk #3 -- Footer
# =================================
cat << EOF >> $OUT_FILE
|==========================================
[NOTE]
This page is autogenerated via a {script}.
Any manual edits to the page will be lost when the page is updated.
EOF
# ------------------------------------------------------------------------------
# MIT License
#
# Copyright (c) 2018 Tristano Ajmone <tajmone@gmail.com>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
# ------------------------------------------------------------------------------