-
Notifications
You must be signed in to change notification settings - Fork 1
/
illuaminate.sexp
153 lines (122 loc) · 4.48 KB
/
illuaminate.sexp
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
; -*- mode: Lisp;-*-
;; Folders, files, or patterns to include.
(sources /unicorn)
;; Overrides for a specific pattern, file or directory. These are matched
;; in order, so later `at` blocks overwrite earlier ones.
(at /
;; Modifications to make to the linter set. For instance, `+all -var:unused`
;; will enable all warnings but var:unused.
(linters all)
;; Control how the illuaminate linter works.
(lint
;; Modules which may have members which are not documented. Modules within this list are skipped by the `var:unresolved-member` warning.
(dynamic-modules)
;; List of global variables
(globals
:max
_CC_DEFAULT_SETTINGS
_CC_DISABLE_LUA51_FEATURES
sleep
write
printError
read
rs
colors
colours
commands
disk
fs
gps
help
http
io
keys
multishell
os
paintutils
parallel
peripheral
pocket
rednet
redstone
settings
shell
term
textutils
turtle
vector
window
_HOST
)
;; Whether tables entries should be separated by a comma (',') or semicolon (';').
(table-separator comma)
;; The preferred quote mark (' or ").
(quote double)
;; Allow setting globals on the top-level of the module.
(allow-toplevel-global false)
;; Allow parenthesis which clarify syntactic ambiguities.
(allow-clarifying-parens false)
;; Allow empty if or elseif blocks.
(allow-empty-if false)
;; Spaces within bracketed terms, such as tables or function calls.
(bracket-spaces
;; Spaces within call arguments.
(call consistent)
;; Spaces within function arguments.
(function-args consistent)
;; Spaces within parenthesised expressions.
(parens consistent)
;; Spaces within tables.
(table consistent)
;; Spaces within table indexes.
(index consistent))))
;; Controls documentation generation.
(doc
;; The path(s) where modules are located. This is used for guessing the module name of files, it is ignored when an explicit @module annotation is provided.
(library-path)
;; A list of custom module kinds and their display names.
(module-kinds)
;; A title to display for the site
(title :none)
;; The path to a logo to display for this site.
(logo :none)
;; A JavaScript file which should be included in the generated docs. This is appended to the default scripts.
(scripts :none)
;; A JavaScript file which should be included in the generated docs. This is appended to the default styles.
(styles :none)
;; A link to an website containing hosting code. The URL is a templated string, where `${foo}` is replaced by the contents of `foo` variable.
;;
;; This accepts the following variables:
;; - path: The documented source's path, relative to the project root.
;; - sline/eline: The start and end line of the variable's definition.
;; - commit: The current commit hash, as returned by git rev-parse HEAD.
(source-link :none)
;; HTML-specific properties
(site
;; A title to display for the site
(title "unicornpkg documentation")
;; The path to a logo to display for this site.
(logo :none)
;; A JavaScript file which should be included in the generated docs. This is appended to the default scripts.
(scripts :none)
;; A JavaScript file which should be included in the generated docs. This is appended to the default styles.
(styles :none)
;; A link to an website containing hosting code. The URL is a templated string, where `${foo}` is replaced by the contents of `foo` variable.
;;
;; This accepts the following variables:
;; - path: The documented source's path, relative to the project root.
;; - sline/eline: The start and end line of the variable's definition.
;; - commit: The current commit hash, as returned by git rev-parse HEAD.
(source-link :none)
;; The full URL the site is hosted on (e.g. https://example.com/docs).
(url :none)
;; Additional content to be included in the <head> of the generated pages.
(head :none))
;; A path to an index file.
(index :none)
;; The folder to write to
(destination doc)
;; Whether to create an index.json file, with a dump of all terms. This may be useful for querying externally.
(json-index true))
(at /unicorn/semver.lua(linters -all))
(at /unicorn/provider/dev.devbin.lua(linters -var:deprecated))