mirrors/CC-Tweaked
1
0
Fork 0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-11-14 05:44:52 +00:00
Code Issues Releases Wiki Activity
9c202bd1c2
CC-Tweaked/illuaminate.sexp

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

118 lines
3.7 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;-*-
License CC:T according to the REUSE specification (#1351) This adds SPDX license headers to all source code files, following the REUSE[1] specification. This does not include any asset files (such as generated JSON files, or textures). While REUSE does support doing so with ".license" files, for now we define these licences using the .reuse/dep5 file. [1]: https://reuse.software/
2023-03-15 21:52:13 +00:00
; SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
;
Relicense a couple of more files We've got in touch with Brady, so can now do the last of the docs \o/! Also pick up a couple of stragglers that I'd missed from before.
2023-10-11 07:00:07 +00:00
; SPDX-License-Identifier: MPL-2.0
License CC:T according to the REUSE specification (#1351) This adds SPDX license headers to all source code files, following the REUSE[1] specification. This does not include any asset files (such as generated JSON files, or textures). While REUSE does support doing so with ".license" files, for now we define these licences using the .reuse/dep5 file. [1]: https://reuse.software/
2023-03-15 21:52:13 +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
(sources
Some minor documentation fixes - Add a TOC to the Local IPs page. - Increase the echo delay in our speaker audio page to 1.5s. This sounds much better and is less clashy than 1s. Also add a sleep(0) (eww, I know) to fix timeouts on some browsers/computers. - Move Lua feature compat to a new "reference" section. Still haven't figured out how to structure these docs - open to any ideas really. - Mention FFmpeg as an option for converting to DFPWM (closes #1075). - Allow data-mount to override built-in files. See my comment in #1069.
2022-05-05 12:24:02 +00:00
/doc/
Add abstract classes for our generic peripherals This commit adds abstract classes to describe the interface for our mod-loader-specific generic peripherals (inventories, fluid storage, item storage). This offers several advantages: - Javadoc to illuaminate conversion no longer needs the Forge project (just core and common). - Ensures we have a consistent interface between Forge and Fabric. Note, this does /not/ implement fluid or energy storage for Fabric. We probably could do fluid without issue, but not something worth doing right now.
2023-11-22 18:20:15 +00:00
/projects/common/build/docs/luaJavadoc/
Move dan200.computercraft.core into a separate module This is a very big diff in changed files, but very small in actual changes.
2022-11-04 22:31:56 +00:00
/projects/core/src/main/resources/data/computercraft/lua/bios.lua
/projects/core/src/main/resources/data/computercraft/lua/rom/
/projects/core/src/test/resources/test-rom
Relocate our existing web code to subdirectories - Move the frontend code into src/frontend - Move our custom element SSR system into src/htmlTransform. This is mostly in prep for merging in copy-cat's core, as that's a whole bunch of extra code.
2023-09-28 20:00:00 +00:00
/projects/web/src/frontend/mount)
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
Move website source/build logic to projects/web Mostly useful as it moves some of our build logic out of the main project, as that's already pretty noisy!
2022-11-06 13:37:07 +00:00
; Also defined in projects/web/build.gradle.kts
(destination /projects/web/build/illuaminate)
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
(index doc/index.md)
Update illuaminate again - Generate theme-color. Hopefully this time it works! - Specify a site url. Technically this is wrong (we should use the current git branch), but it's good enough for now. - Move some options into a sub-category.
2020-12-28 18:20:13 +00:00
(site
(title "CC: Tweaked")
Split CC:T into common and forge projects After several weeks of carefully arranging ribbons, we pull the string and end up with, ... a bit of a messy bow. There were still some things I'd missed. - Split the mod into a common (vanilla-only) project and Forge-specific project. This gives us room to add Fabric support later on. - Split the project into main/client source sets. This is not currently statically checked: we'll do that soon. - Rename block/item/tile entities to use suffixes rather than prefixes.
2022-11-09 23:58:56 +00:00
(logo projects/common/src/main/resources/pack.png)
Update illuaminate again - Generate theme-color. Hopefully this time it works! - Specify a site url. Technically this is wrong (we should use the current git branch), but it's good enough for now. - Move some options into a sub-category.
2020-12-28 18:20:13 +00:00
(url https://tweaked.cc/)
Move repo to cc-tweaked org Let's see how this goes. - Update references to the new repo - Use rrsync on the server, meaning make-doc.sh uploads relative to the website root. - Bump Gradle wrapper to 7.2. Not related to this change, but possibly fixes running under Java 16. Possibly.
2021-10-17 17:14:22 +00:00
(source-link https://github.com/cc-tweaked/CC-Tweaked/blob/${commit}/${path}#L${line})
Update illuaminate again - Generate theme-color. Hopefully this time it works! - Specify a site url. Technically this is wrong (we should use the current git branch), but it's good enough for now. - Move some options into a sub-category.
2020-12-28 18:20:13 +00:00
Build a web-based emulator for the documentation site (#1597) Historically we've used copy-cat to provide a web-based emulator for running example code on our documentation site. However, copy-cat is often out-of-date with CC:T, which means example snippets fail when you try to run them! This commit vendors in copy-cat (or rather an updated version of it) into CC:T itself, allowing us to ensure the emulator is always in sync with the mod. While the ARCHITECTURE.md documentation goes into a little bit more detail here, the general implementation is as follows - In project/src/main we implement the core of the emulator. This includes a basic reimplementation of some of CC's classes to work on the web (mostly the HTTP API and ComputerThread), and some additional code to expose the computers to Javascript. - This is all then compiled to Javascript using [TeaVM][1] (we actually use a [personal fork of it][2] as there's a couple of changes I've not upstreamed yet). - The Javascript side then pulls in the these compiled classes (and the CC ROM) and hooks them up to [cc-web-term][3] to display the actual computer. - As we're no longer pulling in copy-cat, we can simplify our bundling system a little - we now just compile to ESM modules directly. [1]: https://github.com/konsoletyper/teavm [2]: https://github.com/SquidDev/teavm/tree/squid-patches [3]: https://github.com/squiddev-cc/cc-web-term
2023-10-03 08:19:19 +00:00
(styles /projects/web/build/rollup/index.css)
Move website source/build logic to projects/web Mostly useful as it moves some of our build logic out of the main project, as that's already pretty noisy!
2022-11-06 13:37:07 +00:00
(scripts /projects/web/build/rollup/index.js)
Update illuaminate again - Generate theme-color. Hopefully this time it works! - Specify a site url. Technically this is wrong (we should use the current git branch), but it's good enough for now. - Move some options into a sub-category.
2020-12-28 18:20:13 +00:00
(head doc/head.html))
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
Add documentation for peripherals No clue how we're going to do this for the dynamic peripheral system if/when that ships, but this is a good first stage. Like the Java APIs, this relies on stub files, so we can't link to the implementation which is a bit of a shame. However, it's a good first step.
2020-06-24 11:10:54 +00:00
(module-kinds
Generate docs for generic peripherals This was the easy bit. Now I've got to write them!
2020-12-10 22:16:49 +00:00
(peripheral Peripherals)
Add some initial documentation for events Credit to @BradyFromDiscord for writing these. See #640 and #565. Co-authored-by: Brady <bradyakent@gmail.com
2021-01-14 18:19:22 +00:00
(generic_peripheral "Generic Peripherals")
Add arbitrary audio support to speakers (#982) Speakers can now play arbitrary PCM audio, sampled at 48kHz and with a resolution of 8 bits. Programs can build up buffers of audio locally, play it using `speaker.playAudio`, where it is encoded to DFPWM, sent across the network, decoded, and played on the client. `speaker.playAudio` may return false when a chunk of audio has been submitted but not yet sent to the client. In this case, the program should wait for a speaker_audio_empty event and try again, repeating until it works. While the API is a little odd, this gives us fantastic flexibility (we can play arbitrary streams of audio) while still being resilient in the presence of server lag (either TPS or on the computer thread). Some other notes: - There is a significant buffer on both the client and server, which means that sound take several seconds to finish after playing has started. One can force it to be stopped playing with the new `speaker.stop` call. - This also adds a `cc.audio.dfpwm` module, which allows encoding and decoding DFPWM1a audio files. - I spent so long writing the documentation for this. Who knows if it'll be helpful!
2021-12-13 22:56:59 +00:00
(event Events)
Some minor documentation fixes - Add a TOC to the Local IPs page. - Increase the echo delay in our speaker audio page to 1.5s. This sounds much better and is less clashy than 1s. Also add a sleep(0) (eww, I know) to fix timeouts on some browsers/computers. - Move Lua feature compat to a new "reference" section. Still haven't figured out how to structure these docs - open to any ideas really. - Mention FFmpeg as an option for converting to DFPWM (closes #1075). - Allow data-mount to override built-in files. See my comment in #1069.
2022-05-05 12:24:02 +00:00
(guide Guides)
(reference Reference))
Add documentation for peripherals No clue how we're going to do this for the dynamic peripheral system if/when that ships, but this is a good first stage. Like the Java APIs, this relies on stub files, so we can't link to the implementation which is a bit of a shame. However, it's a good first step.
2020-06-24 11:10:54 +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
(library-path
/doc/stub/
Add abstract classes for our generic peripherals This commit adds abstract classes to describe the interface for our mod-loader-specific generic peripherals (inventories, fluid storage, item storage). This offers several advantages: - Javadoc to illuaminate conversion no longer needs the Forge project (just core and common). - Ensures we have a consistent interface between Forge and Fabric. Note, this does /not/ implement fluid or energy storage for Fabric. We probably could do fluid without issue, but not something worth doing right now.
2023-11-22 18:20:15 +00:00
/projects/common/build/docs/luaJavadoc/
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
Move dan200.computercraft.core into a separate module This is a very big diff in changed files, but very small in actual changes.
2022-11-04 22:31:56 +00:00
/projects/core/src/main/resources/data/computercraft/lua/rom/apis/
/projects/core/src/main/resources/data/computercraft/lua/rom/apis/command/
/projects/core/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
Move dan200.computercraft.core into a separate module This is a very big diff in changed files, but very small in actual changes.
2022-11-04 22:31:56 +00:00
/projects/core/src/main/resources/data/computercraft/lua/rom/modules/main/
/projects/core/src/main/resources/data/computercraft/lua/rom/modules/command/
/projects/core/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
Switch to GitHub-style admonitions/alerts As these are just a custom syntax on top of blockquotes, these work much better with text editors.
2023-08-23 17:10:01 +00:00
doc:docusaurus-admonition
Use standard Markdown link syntax for references References are now written using normal links: You now use [`print`] or [print a string][`print`]) instead of @{print} or @{print|print a string}.
2023-08-24 09:48:30 +00:00
doc:ldoc-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
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.
Fix usages of global variables - Lint references to unknown fields of modules, excluding the keys and colours modules. This caught several silly errors in our stub files, but nothing else. - Lint on using unknown globals. This highlighted a couple of really silly mistakes. Fixes #427. - Add documentation for fs.attributes, fs.getCapacity and pocket, as they were not defined before. Co-authored-by: JackMacWindows <jackmacwindowslinux@gmail.com>
2020-04-28 08:42:34 +00:00
-var:unused-arg)
Update illuaminate config
2020-02-04 16:41:29 +00:00
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
(lint
(bracket-spaces
(call no-space)
(function-args no-space)
(parens no-space)
(table space)
Fix usages of global variables - Lint references to unknown fields of modules, excluding the keys and colours modules. This caught several silly errors in our stub files, but nothing else. - Lint on using unknown globals. This highlighted a couple of really silly mistakes. Fixes #427. - Add documentation for fs.attributes, fs.getCapacity and pocket, as they were not defined before. Co-authored-by: JackMacWindows <jackmacwindowslinux@gmail.com>
2020-04-28 08:42:34 +00:00
(index no-space))
Fix computer IDs greater than 65535 crashing Rednet (#900)
2021-09-26 16:13:26 +00:00
(allow-clarifying-parens true)
Fix usages of global variables - Lint references to unknown fields of modules, excluding the keys and colours modules. This caught several silly errors in our stub files, but nothing else. - Lint on using unknown globals. This highlighted a couple of really silly mistakes. Fixes #427. - Add documentation for fs.attributes, fs.getCapacity and pocket, as they were not defined before. Co-authored-by: JackMacWindows <jackmacwindowslinux@gmail.com>
2020-04-28 08:42:34 +00:00
;; colours imports from colors, and we don't handle that right now.
;; keys is entirely dynamic, so we skip it.
Document remaining OS functions (#554)
2020-10-11 21:38:18 +00:00
(dynamic-modules colours keys _G)
Fix usages of global variables - Lint references to unknown fields of modules, excluding the keys and colours modules. This caught several silly errors in our stub files, but nothing else. - Lint on using unknown globals. This highlighted a couple of really silly mistakes. Fixes #427. - Add documentation for fs.attributes, fs.getCapacity and pocket, as they were not defined before. Co-authored-by: JackMacWindows <jackmacwindowslinux@gmail.com>
2020-04-28 08:42:34 +00:00
(globals
:max
_CC_DEFAULT_SETTINGS
Add about program for easier version identification (#936)
2021-10-08 10:29:52 +00:00
_HOST
Fix usages of global variables - Lint references to unknown fields of modules, excluding the keys and colours modules. This caught several silly errors in our stub files, but nothing else. - Lint on using unknown globals. This highlighted a couple of really silly mistakes. Fixes #427. - Add documentation for fs.attributes, fs.getCapacity and pocket, as they were not defined before. Co-authored-by: JackMacWindows <jackmacwindowslinux@gmail.com>
2020-04-28 08:42:34 +00:00
;; Ideally we'd pick these up from bios.lua, but illuaminate currently
;; isn't smart enough.
sleep write printError read rs)))
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
Update Cobalt to 0.7.3 - Add support for Lua 5.2's %g. - Fix %p for the upper character ranges.
2023-08-27 14:35:36 +00:00
;; We disable the unused global linter in bios.lua, APIs and our documentation
;; stubs docs. In the future hopefully we'll get illuaminate to handle this.
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
Update Cobalt to 0.7.3 - Add support for Lua 5.2's %g. - Fix %p for the upper character ranges.
2023-08-27 14:35:36 +00:00
(/doc/stub/
/projects/core/src/main/resources/data/computercraft/lua/bios.lua
/projects/core/src/main/resources/data/computercraft/lua/rom/apis/
Add abstract classes for our generic peripherals This commit adds abstract classes to describe the interface for our mod-loader-specific generic peripherals (inventories, fluid storage, item storage). This offers several advantages: - Javadoc to illuaminate conversion no longer needs the Forge project (just core and common). - Ensures we have a consistent interface between Forge and Fabric. Note, this does /not/ implement fluid or energy storage for Fabric. We probably could do fluid without issue, but not something worth doing right now.
2023-11-22 18:20:15 +00:00
/projects/common/build/docs/luaJavadoc/)
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
(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
Add documentation for shell and multishell Heh, one place we're more complete than cc.cc :p.
2020-04-22 13:39:39 +00:00
;; Suppress warnings for currently undocumented modules.
Some tiny bits of documentation cleanup I'm really good at this English lark :D:.
2020-04-21 11:12:44 +00:00
(at
"Finish" documentation for several modules - Add remaining docs for the turtle API - Add documentation for the fluid storage peripheral. - Enforce undocumented warning for most modules (only io and window remaining). "Finish" in quotes, because these are clearly a long way from perfect. I'm bad at writing docs, OK!
2021-04-03 11:44:22 +00:00
(; Lua APIs
Move dan200.computercraft.core into a separate module This is a very big diff in changed files, but very small in actual changes.
2022-11-04 22:31:56 +00:00
/projects/core/src/main/resources/data/computercraft/lua/rom/apis/window.lua)
Add documentation for shell and multishell Heh, one place we're more complete than cc.cc :p.
2020-04-22 13:39:39 +00:00
Generate documentation stubs from Javadocs 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
2020-07-03 12:31:26 +00:00
(linters -doc:undocumented -doc:undocumented-arg -doc:undocumented-return))
Add documentation for shell and multishell Heh, one place we're more complete than cc.cc :p.
2020-04-22 13:39:39 +00:00
"Finish" documentation for several modules - Add remaining docs for the turtle API - Add documentation for the fluid storage peripheral. - Enforce undocumented warning for most modules (only io and window remaining). "Finish" in quotes, because these are clearly a long way from perfect. I'm bad at writing docs, OK!
2021-04-03 11:44:22 +00:00
;; Suppress warnings for various APIs using its own deprecated members.
(at
Move dan200.computercraft.core into a separate module This is a very big diff in changed files, but very small in actual changes.
2022-11-04 22:31:56 +00:00
(/projects/core/src/main/resources/data/computercraft/lua/bios.lua
/projects/core/src/main/resources/data/computercraft/lua/rom/apis/turtle/turtle.lua)
Document remaining OS functions (#554)
2020-10-11 21:38:18 +00:00
(linters -var:deprecated))
Move dan200.computercraft.core into a separate module This is a very big diff in changed files, but very small in actual changes.
2022-11-04 22:31:56 +00:00
(at /projects/core/src/test/resources/test-rom
Properly deprecate colors.rgb8
2020-08-04 18:50:36 +00:00
; We should still be able to test deprecated members.
(linters -var:deprecated)
Fix usages of global variables - Lint references to unknown fields of modules, excluding the keys and colours modules. This caught several silly errors in our stub files, but nothing else. - Lint on using unknown globals. This highlighted a couple of really silly mistakes. Fixes #427. - Add documentation for fs.attributes, fs.getCapacity and pocket, as they were not defined before. Co-authored-by: JackMacWindows <jackmacwindowslinux@gmail.com>
2020-04-28 08:42:34 +00:00
(lint
(globals
:max sleep write
Support renaming files directly without copying/deleting In classic squid tradition: 20% code, and 80% test logic. Closes #962. Alas, whoever reported this has deleted their account, so they can't even be happy about it :(.
2022-12-04 21:59:30 +00:00
cct_test describe expect howlci fail it pending stub before_each)))
Runnable examples (#576) Provides a basic interface for running examples on tweaked.cc. This is probably janky as anything, but it works on my machine. This is the culmination of 18 months of me building far too much infrastructure (copy-cat, illuaminate), so that's nice I guess. I should probably get out more.
2020-11-12 19:01:50 +00:00
Relocate our existing web code to subdirectories - Move the frontend code into src/frontend - Move our custom element SSR system into src/htmlTransform. This is mostly in prep for merging in copy-cat's core, as that's a whole bunch of extra code.
2023-09-28 20:00:00 +00:00
(at /projects/web/src/frontend/mount/expr_template.lua (lint (globals :max __expr__)))
Reference in New Issue Copy Permalink