From ee3321429e8f1769defda83b3b1008a1203e7fb4 Mon Sep 17 00:00:00 2001 From: takunomi-build-bot Date: Thu, 17 Apr 2025 16:23:56 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=A4=96=20Repository=20layout=20updated=20?= =?UTF-8?q?to=20latest=20version?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This commit was automatically generated by [a script](https://gitfub.space/Jmaa/repo-manager) 🤖 Repository layout updated to latest version This commit was automatically generated by [a script](https://gitfub.space/Jmaa/repo-manager) --- .gitea/workflows/lua-library.yml | 29 ++++++++++++++--- .gitignore | 20 +++++++++++- .luacheckrc | 4 +++ LICENSE | 24 +++++++++++--- README.md | 54 +++++++++++++++++++++++--------- init.lua | 16 +++------- 6 files changed, 111 insertions(+), 36 deletions(-) diff --git a/.gitea/workflows/lua-library.yml b/.gitea/workflows/lua-library.yml index ae19cc0..363ae97 100644 --- a/.gitea/workflows/lua-library.yml +++ b/.gitea/workflows/lua-library.yml @@ -1,8 +1,29 @@ +# WARNING! +# THIS IS AN AUTOGENERATED FILE! +# MANUAL CHANGES CAN AND WILL BE OVERWRITTEN! + name: LÖVE/Lua Library -on: [push] + +on: + push: + paths-ignore: ['README.md', '.gitignore', 'LICENSE', 'CONVENTIONS.md'] jobs: - Test: - uses: jmaa/workflows/.gitea/workflows/lua-testing.yaml@v6.21 + Lua-Testing: + runs-on: ubuntu-latest + steps: + - name: Install Lua + run: | + apt-get update + apt-get install -y luajit + - name: Check out repository code + uses: actions/checkout@v3 + - name: Run testing library + run: luajit test/init.lua Static-Analysis: - uses: jmaa/workflows/.gitea/workflows/lua-static-analysis.yaml@v6.21 + runs-on: ubuntu-latest + steps: + - name: Check out repository code + uses: actions/checkout@v3 + - name: Luacheck linter + uses: https://github.com/lunarmodules/luacheck@v1.1.1 diff --git a/.gitignore b/.gitignore index a01ee28..451354e 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,19 @@ -.*.swp +# WARNING! +# THIS IS AN AUTOGENERATED FILE! +# MANUAL CHANGES CAN AND WILL BE OVERWRITTEN! + +# Löve: Exclude build items +/bin/ +/lib/ +.love-cache/ + +# Compiled Lua sources +luac.out + +# Misc (Image, MacOS, Backups) files +*.psd +*~ +.DS_Store + +# Tools +*.tiled-session diff --git a/.luacheckrc b/.luacheckrc index 277f930..6149112 100644 --- a/.luacheckrc +++ b/.luacheckrc @@ -1,3 +1,7 @@ +-- WARNING! +-- THIS IS AN AUTOGENERATED FILE! +-- MANUAL CHANGES CAN AND WILL BE OVERWRITTEN! + std = "love+max" cache = true include_files = {"**.lua", "*.luacheckrc"} diff --git a/LICENSE b/LICENSE index 02515fe..d992298 100644 --- a/LICENSE +++ b/LICENSE @@ -1,7 +1,21 @@ -"THE BEER-WARE LICENSE" (Revision 42): +MIT License - wrote this program. As long as you retain this notice you -can do whatever you want with this stuff. If we meet some day, and you think -this stuff is worth it, you can buy me a beer in return. +Copyright (c) 2016-2025 Jon Michael Aanes - Jon Michael Aanes +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. diff --git a/README.md b/README.md index f4cf344..044f910 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ - - - + + + # Pretty @@ -78,19 +78,19 @@ available. - The format and structure of output changes depending upon the input. Maps appear differently to deeply nested tables to long sequences with short strings to short lists. -- Uses the standard [debug](https://www.lua.org/manual/5.1/manual.html#5.9) library to gain information about functions and +- Uses the standard [debug](https://www.lua.org/manual/5.4/manual.html#6.10) library to gain information about functions and other advanced structures. ## Installation -[pretty](index.html#) is loadable directly with [require](https://www.lua.org/manual/5.1/manual.html#pdf-require). Either clone or download this +[pretty](index.html#) is loadable directly with [require](https://www.lua.org/manual/5.4/manual.html#pdf-require). Either clone or download this repository. Where you place it, depends upon what you want to do: 1. **You want [pretty](index.html#) in a specific project**: Place the [pretty](index.html#) folder - somewhere in your project, and [require](https://www.lua.org/manual/5.1/manual.html#pdf-require) it from one of your project files. + somewhere in your project, and [require](https://www.lua.org/manual/5.4/manual.html#pdf-require) it from one of your project files. 1. **You want [pretty](index.html#) on your system**: Place the [pretty](index.html#) folder such that it's visible from your Lua-path. On my system this might be - `/usr/local/share/lua/5.1/`. Now you can [require](https://www.lua.org/manual/5.1/manual.html#pdf-require) it from anywhere. + `/usr/local/share/lua/5.1/`. Now you can [require](https://www.lua.org/manual/5.4/manual.html#pdf-require) it from anywhere. ## API Documentation @@ -112,7 +112,7 @@ priority: character escaping issues. [pretty](index.html#) should escape all malformed unicode sequences. - [ ] Align numbers towards right for tabular views. -- [ ] Add support for [setmetatable](https://www.lua.org/manual/5.1/manual.html#pdf-setmetatable), and exploring values in metatables. +- [ ] Add support for [setmetatable](https://www.lua.org/manual/5.4/manual.html#pdf-setmetatable), and exploring values in metatables. - [ ] Provide nice formatting for `cdata` datatype in LuaJIT. - [ ] Find a better name than [pretty](index.html#). - [ ] Enhance internal structure some amount. See `TODO` markers in files. @@ -123,7 +123,7 @@ It would be nice to have the following, but these are secondary: [BlueJ-style](www.bluej.org/about.html) scope highlighting, with some faint background colors. - [ ] Expand on the comment output in output, for `__tostring` methods, and - global namespaces like [io](https://www.lua.org/manual/5.1/manual.html#5.7) or [math](https://www.lua.org/manual/5.1/manual.html#5.6). + global namespaces like [io](https://www.lua.org/manual/5.4/manual.html#6.8) or [math](https://www.lua.org/manual/5.4/manual.html#6.7). - [ ] Fit output within a predefined width limit. Default to 80. - [ ] Look into tool for understanding complex structures with recursive definitions. Whatever modes are thought up, they should be automatic modes, not @@ -195,14 +195,38 @@ by side. unjustified, abandoning it's eye-guiding attributes. 1. Special cases: (Array-tree, Table-Tree, Linked-List, Predictive Sequences) TODO -# License +## Dependencies + +This project requires [PUC Lua 5.1](https://www.tecgraf.puc-rio.br/lua/mirror/versions.html#5.1) or [LuaJIT](https://luajit.org/luajit.html). Newer versions of PUC Lua are not supported. + +This project does not have any library requirements 😎 + +## Contributing + +Feel free to submit pull requests. Please follow the [Code Conventions](CONVENTIONS.md) when doing so. + +## License ``` -"THE BEER-WARE LICENSE" (Revision 42): +MIT License - wrote this program. As long as you retain this notice you -can do whatever you want with this stuff. If we meet some day, and you think -this stuff is worth it, you can buy me a beer in return. +Copyright (c) 2016-2025 Jon Michael Aanes - Jon Michael Aanes +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. ``` diff --git a/init.lua b/init.lua index 5a4f1a2..6b6769d 100644 --- a/init.lua +++ b/init.lua @@ -1,12 +1,6 @@ --- pretty.init --- In case somebody loads `init.lua`. Just redirects to `pretty.lua`. +-- WARNING! +-- THIS IS AN AUTOGENERATED FILE! +-- MANUAL CHANGES CAN AND WILL BE OVERWRITTEN! -local _VERSION = '0.5.5' - --------------------------------------------------------------------------------- - -local premodule = (...) -if premodule == 'init' then premodule = '' end -local pretty = require (premodule .. (premodule ~= '' and '.' or '') .. 'pretty') ---pretty._VERSION = _VERSION -- TODO -return pretty +-- This file automatically redirects to "pretty.lua" +return require (((...) ~= 'init' and (...) .. '.' or '') .. 'pretty')