mirrors/CC-Tweaked
1
0
Fork 0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-11-05 17:46:21 +00:00
Code Issues Releases Wiki Activity
e5cc345f49
CC-Tweaked/illuaminate.sexp

78 lines
2.8 KiB
Plaintext
Raw Normal View History

Lint bios and the rom (#321) We now use illuaminate[1]'s linting facilities to check the rom and bios.lua for a couple of common bugs and other problems. Right now this doesn't detect any especially important bugs, though it has caught lots of small things (unused variables, some noisy code). In the future, the linter will grow in scope and features, which should allow us to be stricter and catch most issues. As a fun aside, we started off with ~150 bugs, and illuaminate was able to fix all but 30 of them, which is pretty neat. [1]: https://github.com/SquidDev/illuaminate
2019-12-03 23:26:13 +00:00
; -*- mode: Lisp;-*-
(sources
An initial stab at documentation generation (#360) This adds documentation comments to many of CC's Lua APIs, and a couple of the Java ones, through the use of stubs. We then export these to HTML using illuaminate [1] and upload them to our documentation site [2]. Uploads currently occur on pushes to master and any release/tag. The site is entirely static - there is no way to switch between versions, etc... but hopefully we can improve this in the future. [1]: github.com/SquidDev/illuaminate/ [2]: https://tweaked.cc/
2020-04-10 09:27:53 +00:00
/doc/stub/
Some cleanup to the Lua programs
2020-04-22 09:00:43 +00:00
/src/main/resources/data/computercraft/lua/bios.lua
/src/main/resources/data/computercraft/lua/rom/
Fix spacing on all of the rom (#323)
2019-12-07 10:33:47 +00:00
/src/test/resources/test-rom)
Lint bios and the rom (#321) We now use illuaminate[1]'s linting facilities to check the rom and bios.lua for a couple of common bugs and other problems. Right now this doesn't detect any especially important bugs, though it has caught lots of small things (unused variables, some noisy code). In the future, the linter will grow in scope and features, which should allow us to be stricter and catch most issues. As a fun aside, we started off with ~150 bugs, and illuaminate was able to fix all but 30 of them, which is pretty neat. [1]: https://github.com/SquidDev/illuaminate
2019-12-03 23:26:13 +00:00
An initial stab at documentation generation (#360) This adds documentation comments to many of CC's Lua APIs, and a couple of the Java ones, through the use of stubs. We then export these to HTML using illuaminate [1] and upload them to our documentation site [2]. Uploads currently occur on pushes to master and any release/tag. The site is entirely static - there is no way to switch between versions, etc... but hopefully we can improve this in the future. [1]: github.com/SquidDev/illuaminate/ [2]: https://tweaked.cc/
2020-04-10 09:27:53 +00:00
(doc
(title "CC: Tweaked")
(index doc/index.md)
(source-link https://github.com/SquidDev-CC/CC-Tweaked/blob/${commit}/${path}#L${line})
(library-path
/doc/stub/
Some cleanup to the Lua programs
2020-04-22 09:00:43 +00:00
/src/main/resources/data/computercraft/lua/rom/apis
/src/main/resources/data/computercraft/lua/rom/apis/command
/src/main/resources/data/computercraft/lua/rom/apis/turtle
An initial stab at documentation generation (#360) This adds documentation comments to many of CC's Lua APIs, and a couple of the Java ones, through the use of stubs. We then export these to HTML using illuaminate [1] and upload them to our documentation site [2]. Uploads currently occur on pushes to master and any release/tag. The site is entirely static - there is no way to switch between versions, etc... but hopefully we can improve this in the future. [1]: github.com/SquidDev/illuaminate/ [2]: https://tweaked.cc/
2020-04-10 09:27:53 +00:00
Some cleanup to the Lua programs
2020-04-22 09:00:43 +00:00
/src/main/resources/data/computercraft/lua/rom/modules/main
/src/main/resources/data/computercraft/lua/rom/modules/command
/src/main/resources/data/computercraft/lua/rom/modules/turtle))
An initial stab at documentation generation (#360) This adds documentation comments to many of CC's Lua APIs, and a couple of the Java ones, through the use of stubs. We then export these to HTML using illuaminate [1] and upload them to our documentation site [2]. Uploads currently occur on pushes to master and any release/tag. The site is entirely static - there is no way to switch between versions, etc... but hopefully we can improve this in the future. [1]: github.com/SquidDev/illuaminate/ [2]: https://tweaked.cc/
2020-04-10 09:27:53 +00:00
Lint bios and the rom (#321) We now use illuaminate[1]'s linting facilities to check the rom and bios.lua for a couple of common bugs and other problems. Right now this doesn't detect any especially important bugs, though it has caught lots of small things (unused variables, some noisy code). In the future, the linter will grow in scope and features, which should allow us to be stricter and catch most issues. As a fun aside, we started off with ~150 bugs, and illuaminate was able to fix all but 30 of them, which is pretty neat. [1]: https://github.com/SquidDev/illuaminate
2019-12-03 23:26:13 +00:00
(at /
(linters
Reformat bracketed expressions in Lua - Parenthesised expressions (function calls, arguments, etc...) should never have spaces in them. - Tables always will have spaces inside.
2020-04-18 09:09:40 +00:00
syntax:string-index
Replace string.len with #
2019-12-10 18:54:43 +00:00
;; It'd be nice to avoid this, but right now there's a lot of instances of
;; it.
Lint bios and the rom (#321) We now use illuaminate[1]'s linting facilities to check the rom and bios.lua for a couple of common bugs and other problems. Right now this doesn't detect any especially important bugs, though it has caught lots of small things (unused variables, some noisy code). In the future, the linter will grow in scope and features, which should allow us to be stricter and catch most issues. As a fun aside, we started off with ~150 bugs, and illuaminate was able to fix all but 30 of them, which is pretty neat. [1]: https://github.com/SquidDev/illuaminate
2019-12-03 23:26:13 +00:00
-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.
Update illuaminate config
2020-02-04 16:41:29 +00:00
-var:unused-arg
;; Suppress a couple of documentation comments warnings for now. We'll
An initial stab at documentation generation (#360) This adds documentation comments to many of CC's Lua APIs, and a couple of the Java ones, through the use of stubs. We then export these to HTML using illuaminate [1] and upload them to our documentation site [2]. Uploads currently occur on pushes to master and any release/tag. The site is entirely static - there is no way to switch between versions, etc... but hopefully we can improve this in the future. [1]: github.com/SquidDev/illuaminate/ [2]: https://tweaked.cc/
2020-04-10 09:27:53 +00:00
;; hopefully be able to remove them in the future.
-doc:undocumented -doc:undocumented-arg -doc:unresolved-reference
Reformat bracketed expressions in Lua - Parenthesised expressions (function calls, arguments, etc...) should never have spaces in them. - Tables always will have spaces inside.
2020-04-18 09:09:40 +00:00
-var:unresolved-member)
(lint
(bracket-spaces
(call no-space)
(function-args no-space)
(parens no-space)
(table space)
(index no-space))))
Lint bios and the rom (#321) We now use illuaminate[1]'s linting facilities to check the rom and bios.lua for a couple of common bugs and other problems. Right now this doesn't detect any especially important bugs, though it has caught lots of small things (unused variables, some noisy code). In the future, the linter will grow in scope and features, which should allow us to be stricter and catch most issues. As a fun aside, we started off with ~150 bugs, and illuaminate was able to fix all but 30 of them, which is pretty neat. [1]: https://github.com/SquidDev/illuaminate
2019-12-03 23:26:13 +00:00
Replace string.len with #
2019-12-10 18:54:43 +00:00
;; We disable the unused global linter in bios.lua and the APIs. In the future
Lint bios and the rom (#321) We now use illuaminate[1]'s linting facilities to check the rom and bios.lua for a couple of common bugs and other problems. Right now this doesn't detect any especially important bugs, though it has caught lots of small things (unused variables, some noisy code). In the future, the linter will grow in scope and features, which should allow us to be stricter and catch most issues. As a fun aside, we started off with ~150 bugs, and illuaminate was able to fix all but 30 of them, which is pretty neat. [1]: https://github.com/SquidDev/illuaminate
2019-12-03 23:26:13 +00:00
;; hopefully we'll get illuaminate to handle this.
(at
Some cleanup to the Lua programs
2020-04-22 09:00:43 +00:00
(/src/main/resources/data/computercraft/lua/bios.lua
/src/main/resources/data/computercraft/lua/rom/apis/)
Replace string.len with #
2019-12-10 18:54:43 +00:00
(linters -var:unused-global)
An initial stab at documentation generation (#360) This adds documentation comments to many of CC's Lua APIs, and a couple of the Java ones, through the use of stubs. We then export these to HTML using illuaminate [1] and upload them to our documentation site [2]. Uploads currently occur on pushes to master and any release/tag. The site is entirely static - there is no way to switch between versions, etc... but hopefully we can improve this in the future. [1]: github.com/SquidDev/illuaminate/ [2]: https://tweaked.cc/
2020-04-10 09:27:53 +00:00
(lint (allow-toplevel-global true)))
;; Silence some variable warnings in documentation stubs.
(at /doc/stub
(linters -var:unused-global)
(lint (allow-toplevel-global true)))
Some tiny bits of documentation cleanup I'm really good at this English lark :D:.
2020-04-21 11:12:44 +00:00
;; Ensure any fully documented modules stay fully documented.
(at
Some cleanup to the Lua programs
2020-04-22 09:00:43 +00:00
(/src/main/resources/data/computercraft/lua/rom/apis/colors.lua
/src/main/resources/data/computercraft/lua/rom/apis/colours.lua
/src/main/resources/data/computercraft/lua/rom/apis/disk.lua
/src/main/resources/data/computercraft/lua/rom/apis/gps.lua
/src/main/resources/data/computercraft/lua/rom/apis/help.lua
/src/main/resources/data/computercraft/lua/rom/apis/keys.lua
/src/main/resources/data/computercraft/lua/rom/apis/paintutils.lua
/src/main/resources/data/computercraft/lua/rom/apis/parallel.lua
/src/main/resources/data/computercraft/lua/rom/apis/peripheral.lua
/src/main/resources/data/computercraft/lua/rom/apis/rednet.lua
/src/main/resources/data/computercraft/lua/rom/apis/settings.lua
/src/main/resources/data/computercraft/lua/rom/apis/texutils.lua
/src/main/resources/data/computercraft/lua/rom/apis/vector.lua)
Some tiny bits of documentation cleanup I'm really good at this English lark :D:.
2020-04-21 11:12:44 +00:00
(linters doc:undocumented doc:undocumented-arg))
Reference in New Issue Copy Permalink