🤖 Repository layout updated to latest version
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)
This commit is contained in:
parent
bdcd58956c
commit
ee3321429e
|
|
@ -1,8 +1,29 @@
|
||||||
|
# WARNING!
|
||||||
|
# THIS IS AN AUTOGENERATED FILE!
|
||||||
|
# MANUAL CHANGES CAN AND WILL BE OVERWRITTEN!
|
||||||
|
|
||||||
name: LÖVE/Lua Library
|
name: LÖVE/Lua Library
|
||||||
on: [push]
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
paths-ignore: ['README.md', '.gitignore', 'LICENSE', 'CONVENTIONS.md']
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
Test:
|
Lua-Testing:
|
||||||
uses: jmaa/workflows/.gitea/workflows/lua-testing.yaml@v6.21
|
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:
|
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
|
||||||
|
|
|
||||||
20
.gitignore
vendored
20
.gitignore
vendored
|
|
@ -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
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,7 @@
|
||||||
|
-- WARNING!
|
||||||
|
-- THIS IS AN AUTOGENERATED FILE!
|
||||||
|
-- MANUAL CHANGES CAN AND WILL BE OVERWRITTEN!
|
||||||
|
|
||||||
std = "love+max"
|
std = "love+max"
|
||||||
cache = true
|
cache = true
|
||||||
include_files = {"**.lua", "*.luacheckrc"}
|
include_files = {"**.lua", "*.luacheckrc"}
|
||||||
|
|
|
||||||
24
LICENSE
24
LICENSE
|
|
@ -1,7 +1,21 @@
|
||||||
"THE BEER-WARE LICENSE" (Revision 42):
|
MIT License
|
||||||
|
|
||||||
<jonjmaa@gmail.com> wrote this program. As long as you retain this notice you
|
Copyright (c) 2016-2025 Jon Michael Aanes
|
||||||
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.
|
|
||||||
|
|
||||||
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.
|
||||||
|
|
|
||||||
54
README.md
54
README.md
|
|
@ -1,6 +1,6 @@
|
||||||
<!--- WARNING --->
|
<!-- WARNING! -->
|
||||||
<!--- THIS IS AN AUTO-GENERATED FILE --->
|
<!-- THIS IS AN AUTOGENERATED FILE! -->
|
||||||
<!--- MANUAL CHANGES CAN AND WILL BE OVERWRITTEN --->
|
<!-- MANUAL CHANGES CAN AND WILL BE OVERWRITTEN! -->
|
||||||
|
|
||||||
# Pretty
|
# Pretty
|
||||||
|
|
||||||
|
|
@ -78,19 +78,19 @@ available.
|
||||||
- The format and structure of output changes depending upon the input. Maps
|
- The format and structure of output changes depending upon the input. Maps
|
||||||
appear differently to deeply nested tables to long sequences with short
|
appear differently to deeply nested tables to long sequences with short
|
||||||
strings to short lists.
|
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.
|
other advanced structures.
|
||||||
|
|
||||||
## Installation
|
## 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:
|
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
|
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
|
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
|
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
|
## API Documentation
|
||||||
|
|
||||||
|
|
@ -112,7 +112,7 @@ priority:
|
||||||
character escaping issues. [pretty](index.html#) should escape all malformed unicode
|
character escaping issues. [pretty](index.html#) should escape all malformed unicode
|
||||||
sequences.
|
sequences.
|
||||||
- [ ] Align numbers towards right for tabular views.
|
- [ ] 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.
|
- [ ] Provide nice formatting for `cdata` datatype in LuaJIT.
|
||||||
- [ ] Find a better name than [pretty](index.html#).
|
- [ ] Find a better name than [pretty](index.html#).
|
||||||
- [ ] Enhance internal structure some amount. See `TODO` markers in files.
|
- [ ] 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
|
[BlueJ-style](www.bluej.org/about.html) scope highlighting, with some faint
|
||||||
background colors.
|
background colors.
|
||||||
- [ ] Expand on the comment output in output, for `__tostring` methods, and
|
- [ ] 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.
|
- [ ] Fit output within a predefined width limit. Default to 80.
|
||||||
- [ ] Look into tool for understanding complex structures with recursive
|
- [ ] Look into tool for understanding complex structures with recursive
|
||||||
definitions. Whatever modes are thought up, they should be automatic modes, not
|
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.
|
unjustified, abandoning it's eye-guiding attributes.
|
||||||
1. Special cases: (Array-tree, Table-Tree, Linked-List, Predictive Sequences) TODO
|
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
|
||||||
|
|
||||||
<jonjmaa@gmail.com> wrote this program. As long as you retain this notice you
|
Copyright (c) 2016-2025 Jon Michael Aanes
|
||||||
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.
|
|
||||||
|
|
||||||
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.
|
||||||
```
|
```
|
||||||
|
|
|
||||||
16
init.lua
16
init.lua
|
|
@ -1,12 +1,6 @@
|
||||||
-- pretty.init
|
-- WARNING!
|
||||||
-- In case somebody loads `init.lua`. Just redirects to `pretty.lua`.
|
-- THIS IS AN AUTOGENERATED FILE!
|
||||||
|
-- MANUAL CHANGES CAN AND WILL BE OVERWRITTEN!
|
||||||
|
|
||||||
local _VERSION = '0.5.5'
|
-- This file automatically redirects to "pretty.lua"
|
||||||
|
return require (((...) ~= 'init' and (...) .. '.' or '') .. 'pretty')
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
local premodule = (...)
|
|
||||||
if premodule == 'init' then premodule = '' end
|
|
||||||
local pretty = require (premodule .. (premodule ~= '' and '.' or '') .. 'pretty')
|
|
||||||
--pretty._VERSION = _VERSION -- TODO
|
|
||||||
return pretty
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue
Block a user