mirror of
https://github.com/SquidDev-CC/CC-Tweaked
synced 2024-06-27 23:53:21 +00:00
9f8774960f
illuaminate does not handle Java files, for obvious reasons. In order to get around that, we have a series of stub files within /doc/stub which mirrored the Java ones. While this works, it has a few problems: - The link to source code does not work - it just links to the stub file. - There's no guarantee that documentation remains consistent with the Java code. This change found several methods which were incorrectly documented beforehand. We now replace this with a custom Java doclet[1], which extracts doc comments from @LuaFunction annotated methods and generates stub-files from them. These also contain a @source annotation, which allows us to correctly link them back to the original Java code. There's some issues with this which have yet to be fixed. However, I don't think any of them are major blockers right now: - The custom doclet relies on Java 9 - I think it's /technically/ possible to do this on Java 8, but the API is significantly uglier. This means that we need to run javadoc on a separate JVM. This is possible, and it works locally and on CI, but is definitely not a nice approach. - illuaminate now requires the doc stubs to be generated in order for the linter to pass, which does make running the linter locally much harder (especially given the above bullet point). We could notionally include the generated stubs (or at least a cut down version of them) in the repo, but I'm not 100% sure about that. [1]: https://docs.oracle.com/javase/9/docs/api/jdk/javadoc/doclet/package-summary.html
112 lines
3.2 KiB
Common Lisp
112 lines
3.2 KiB
Common Lisp
; -*- mode: Lisp;-*-
|
|
|
|
(sources
|
|
/doc/stub/
|
|
/doc/javadoc/
|
|
/src/main/resources/*/computercraft/lua/bios.lua
|
|
/src/main/resources/*/computercraft/lua/rom/
|
|
/src/test/resources/test-rom)
|
|
|
|
|
|
(doc
|
|
(title "CC: Tweaked")
|
|
(index doc/index.md)
|
|
(source-link https://github.com/SquidDev-CC/CC-Tweaked/blob/${commit}/${path}#L${line})
|
|
|
|
(module-kinds
|
|
(peripheral Peripherals))
|
|
|
|
(library-path
|
|
/doc/stub/
|
|
/doc/javadoc/
|
|
|
|
/src/main/resources/*/computercraft/lua/rom/apis
|
|
/src/main/resources/*/computercraft/lua/rom/apis/command
|
|
/src/main/resources/*/computercraft/lua/rom/apis/turtle
|
|
|
|
/src/main/resources/*/computercraft/lua/rom/modules/main
|
|
/src/main/resources/*/computercraft/lua/rom/modules/command
|
|
/src/main/resources/*/computercraft/lua/rom/modules/turtle))
|
|
|
|
(at /
|
|
(linters
|
|
syntax:string-index
|
|
|
|
;; It'd be nice to avoid this, but right now there's a lot of instances of
|
|
;; it.
|
|
-var:set-loop
|
|
|
|
;; It's useful to name arguments for documentation, so we allow this. It'd
|
|
;; be good to find a compromise in the future, but this works for now.
|
|
-var:unused-arg)
|
|
|
|
(lint
|
|
(bracket-spaces
|
|
(call no-space)
|
|
(function-args no-space)
|
|
(parens no-space)
|
|
(table space)
|
|
(index no-space))
|
|
|
|
;; colours imports from colors, and we don't handle that right now.
|
|
;; keys is entirely dynamic, so we skip it.
|
|
(dynamic-modules colours keys)
|
|
|
|
(globals
|
|
:max
|
|
_CC_DEFAULT_SETTINGS
|
|
_CC_DISABLE_LUA51_FEATURES
|
|
;; Ideally we'd pick these up from bios.lua, but illuaminate currently
|
|
;; isn't smart enough.
|
|
sleep write printError read rs)))
|
|
|
|
;; We disable the unused global linter in bios.lua and the APIs. In the future
|
|
;; hopefully we'll get illuaminate to handle this.
|
|
(at
|
|
(/src/main/resources/*/computercraft/lua/bios.lua
|
|
/src/main/resources/*/computercraft/lua/rom/apis/)
|
|
(linters -var:unused-global)
|
|
(lint (allow-toplevel-global true)))
|
|
|
|
;; Silence some variable warnings in documentation stubs.
|
|
(at (/doc/stub/ /doc/javadoc/)
|
|
(linters -var:unused-global)
|
|
(lint (allow-toplevel-global true)))
|
|
|
|
;; Suppress warnings for currently undocumented modules.
|
|
(at
|
|
(; Java APIs
|
|
/doc/stub/fs.lua
|
|
/doc/stub/http.lua
|
|
/doc/stub/os.lua
|
|
/doc/stub/term.lua
|
|
/doc/stub/turtle.lua
|
|
; Java generated APIs
|
|
/doc/javadoc/fs.lua
|
|
/doc/javadoc/http.lua
|
|
/doc/javadoc/os.lua
|
|
/doc/javadoc/turtle.lua
|
|
; Peripherals
|
|
/doc/javadoc/drive.lua
|
|
/doc/javadoc/speaker.lua
|
|
/doc/javadoc/printer.lua
|
|
; Lua APIs
|
|
/src/main/resources/*/computercraft/lua/rom/apis/io.lua
|
|
/src/main/resources/*/computercraft/lua/rom/apis/window.lua)
|
|
|
|
(linters -doc:undocumented -doc:undocumented-arg -doc:undocumented-return))
|
|
|
|
;; These currently rely on unknown references.
|
|
(at
|
|
(/src/main/resources/*/computercraft/lua/rom/apis/textutils.lua
|
|
/src/main/resources/*/computercraft/lua/rom/modules/main/cc/completion.lua
|
|
/src/main/resources/*/computercraft/lua/rom/modules/main/cc/shell/completion.lua
|
|
/src/main/resources/*/computercraft/lua/rom/programs/shell.lua)
|
|
(linters -doc:unresolved-reference))
|
|
|
|
(at /src/test/resources/test-rom
|
|
(lint
|
|
(globals
|
|
:max sleep write
|
|
cct_test describe expect howlci fail it pending stub)))
|