From 8e144e06f5cc22e84cf32f5db7e8a0ff1e4b9b3f Mon Sep 17 00:00:00 2001 From: Aire-One Date: Sun, 3 Sep 2023 18:38:11 +0200 Subject: [PATCH 01/16] chore: rockspec, structure and entry point --- .editorconfig | 2 +- .gitignore | 8 +- LICENSE.md | 361 ++++++++++++++++++ README.MD => README.md | 0 awesomewm-d-tl-dev-1.rockspec | 61 +++ bin/awesomewm-d-tl | 3 + justfile | 6 +- rockspecs/awesomewm.d.tl-dev-1.rockspec | 24 -- set_paths.lua | 15 - set_paths.tl | 2 +- src/{awesomewm.d.tl => awesomewm-d-tl}/ast.tl | 2 +- .../crawler/init.tl | 8 +- src/{awesomewm.d.tl => awesomewm-d-tl}/dag.tl | 6 +- .../entity/Function_Info.tl | 10 +- .../entity/Module_Doc.tl | 8 +- .../entity/Module_Info.tl | 0 .../entity/Type_Info.tl | 0 .../entity/Variable_Info.tl | 4 +- .../filesystem/file_writer.tl | 8 +- src/awesomewm-d-tl/filesystem/init.tl | 3 + .../init.tl | 32 +- .../logger/init.tl | 8 +- .../printer/global_env_def.tl | 10 +- src/awesomewm-d-tl/printer/init.tl | 6 + .../printer/module_init_definition.tl | 8 +- .../printer/snippets.tl | 16 +- .../printer/teal_type_definition.tl | 8 +- .../property.tl | 0 src/awesomewm-d-tl/scraper/init.tl | 5 + .../scraper/module_doc.tl | 14 +- .../scraper/module_info_list.tl | 8 +- .../scraper/utils.tl | 12 +- .../types/Dag.tl | 2 +- .../types/Node.tl | 0 .../utils.tl | 2 +- .../visitors/module_dependencies.tl | 6 +- .../visitors/type_mapping.tl | 2 +- src/awesomewm.d.tl/filesystem/init.tl | 3 - src/awesomewm.d.tl/printer/init.tl | 6 - src/awesomewm.d.tl/scraper/init.tl | 5 - tlconfig.lua | 2 +- 41 files changed, 536 insertions(+), 150 deletions(-) create mode 100644 LICENSE.md rename README.MD => README.md (100%) create mode 100644 awesomewm-d-tl-dev-1.rockspec create mode 100755 bin/awesomewm-d-tl delete mode 100644 rockspecs/awesomewm.d.tl-dev-1.rockspec delete mode 100644 set_paths.lua rename src/{awesomewm.d.tl => awesomewm-d-tl}/ast.tl (97%) rename src/{awesomewm.d.tl => awesomewm-d-tl}/crawler/init.tl (88%) rename src/{awesomewm.d.tl => awesomewm-d-tl}/dag.tl (78%) rename src/{awesomewm.d.tl => awesomewm-d-tl}/entity/Function_Info.tl (90%) rename src/{awesomewm.d.tl => awesomewm-d-tl}/entity/Module_Doc.tl (94%) rename src/{awesomewm.d.tl => awesomewm-d-tl}/entity/Module_Info.tl (100%) rename src/{awesomewm.d.tl => awesomewm-d-tl}/entity/Type_Info.tl (100%) rename src/{awesomewm.d.tl => awesomewm-d-tl}/entity/Variable_Info.tl (87%) rename src/{awesomewm.d.tl => awesomewm-d-tl}/filesystem/file_writer.tl (89%) create mode 100644 src/awesomewm-d-tl/filesystem/init.tl rename src/{awesomewm.d.tl => awesomewm-d-tl}/init.tl (83%) rename src/{awesomewm.d.tl => awesomewm-d-tl}/logger/init.tl (89%) rename src/{awesomewm.d.tl => awesomewm-d-tl}/printer/global_env_def.tl (82%) create mode 100644 src/awesomewm-d-tl/printer/init.tl rename src/{awesomewm.d.tl => awesomewm-d-tl}/printer/module_init_definition.tl (74%) rename src/{awesomewm.d.tl => awesomewm-d-tl}/printer/snippets.tl (92%) rename src/{awesomewm.d.tl => awesomewm-d-tl}/printer/teal_type_definition.tl (96%) rename src/{awesomewm.d.tl => awesomewm-d-tl}/property.tl (100%) create mode 100644 src/awesomewm-d-tl/scraper/init.tl rename src/{awesomewm.d.tl => awesomewm-d-tl}/scraper/module_doc.tl (96%) rename src/{awesomewm.d.tl => awesomewm-d-tl}/scraper/module_info_list.tl (70%) rename src/{awesomewm.d.tl => awesomewm-d-tl}/scraper/utils.tl (90%) rename src/{awesomewm.d.tl => awesomewm-d-tl}/types/Dag.tl (76%) rename src/{awesomewm.d.tl => awesomewm-d-tl}/types/Node.tl (100%) rename src/{awesomewm.d.tl => awesomewm-d-tl}/utils.tl (97%) rename src/{awesomewm.d.tl => awesomewm-d-tl}/visitors/module_dependencies.tl (91%) rename src/{awesomewm.d.tl => awesomewm-d-tl}/visitors/type_mapping.tl (96%) delete mode 100644 src/awesomewm.d.tl/filesystem/init.tl delete mode 100644 src/awesomewm.d.tl/printer/init.tl delete mode 100644 src/awesomewm.d.tl/scraper/init.tl diff --git a/.editorconfig b/.editorconfig index 2ff1b1a..c926217 100644 --- a/.editorconfig +++ b/.editorconfig @@ -8,7 +8,7 @@ charset = utf-8 trim_trailing_whitespace = true insert_final_newline = true -[*.{lua,tl,d.tl,busted,luacheckrc,luacov}] +[*.{lua,tl,d.tl,busted,luacheckrc,luacov,rockspec}] indent_size = 3 [justfile] diff --git a/.gitignore b/.gitignore index 97ac9ea..e8da5cd 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,4 @@ -lua_modules -generated -build -luacov +lua_modules/ +generated/ +build/ +luacov/ diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..d141248 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,361 @@ +# GNU GENERAL PUBLIC LICENSE + +Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA + + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +## Preamble + +The licenses for most software are designed to take away your freedom +to share and change it. By contrast, the GNU General Public License is +intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + +To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if +you distribute copies of the software, or if you modify it. + +For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + +We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + +Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, +we want its recipients to know that what they have is not the +original, so that any problems introduced by others will not reflect +on the original authors' reputations. + +Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at +all. + +The precise terms and conditions for copying, distribution and +modification follow. + +## TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + +**0.** This License applies to any program or other work which +contains a notice placed by the copyright holder saying it may be +distributed under the terms of this General Public License. The +"Program", below, refers to any such program or work, and a "work +based on the Program" means either the Program or any derivative work +under copyright law: that is to say, a work containing the Program or +a portion of it, either verbatim or with modifications and/or +translated into another language. (Hereinafter, translation is +included without limitation in the term "modification".) Each licensee +is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the Program +(independent of having been made by running the Program). Whether that +is true depends on what the Program does. + +**1.** You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a +fee. + +**2.** You may modify your copy or copies of the Program or any +portion of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + +**a)** You must cause the modified files to carry prominent notices +stating that you changed the files and the date of any change. + + +**b)** You must cause any work that you distribute or publish, that in +whole or in part contains or is derived from the Program or any part +thereof, to be licensed as a whole at no charge to all third parties +under the terms of this License. + + +**c)** If the modified program normally reads commands interactively +when run, you must cause it, when started running for such interactive +use in the most ordinary way, to print or display an announcement +including an appropriate copyright notice and a notice that there is +no warranty (or else, saying that you provide a warranty) and that +users may redistribute the program under these conditions, and telling +the user how to view a copy of this License. (Exception: if the +Program itself is interactive but does not normally print such an +announcement, your work based on the Program is not required to print +an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + +**3.** You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + +**a)** Accompany it with the complete corresponding machine-readable +source code, which must be distributed under the terms of Sections 1 +and 2 above on a medium customarily used for software interchange; or, + + +**b)** Accompany it with a written offer, valid for at least three +years, to give any third party, for a charge no more than your cost of +physically performing source distribution, a complete machine-readable +copy of the corresponding source code, to be distributed under the +terms of Sections 1 and 2 above on a medium customarily used for +software interchange; or, + + +**c)** Accompany it with the information you received as to the offer +to distribute corresponding source code. (This alternative is allowed +only for noncommercial distribution and only if you received the +program in object code or executable form with such an offer, in +accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + +**4.** You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt otherwise +to copy, modify, sublicense or distribute the Program is void, and +will automatically terminate your rights under this License. However, +parties who have received copies, or rights, from you under this +License will not have their licenses terminated so long as such +parties remain in full compliance. + +**5.** You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + +**6.** Each time you redistribute the Program (or any work based on +the Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + +**7.** If, as a consequence of a court judgment or allegation of +patent infringement or for any other reason (not limited to patent +issues), conditions are imposed on you (whether by court order, +agreement or otherwise) that contradict the conditions of this +License, they do not excuse you from the conditions of this License. +If you cannot distribute so as to satisfy simultaneously your +obligations under this License and any other pertinent obligations, +then as a consequence you may not distribute the Program at all. For +example, if a patent license would not permit royalty-free +redistribution of the Program by all those who receive copies directly +or indirectly through you, then the only way you could satisfy both it +and this License would be to refrain entirely from distribution of the +Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + +**8.** If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + +**9.** The Free Software Foundation may publish revised and/or new +versions of the General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Program does not specify a +version number of this License, you may choose any version ever +published by the Free Software Foundation. + +**10.** If you wish to incorporate parts of the Program into other +free programs whose distribution conditions are different, write to +the author to ask for permission. For software which is copyrighted by +the Free Software Foundation, write to the Free Software Foundation; +we sometimes make exceptions for this. Our decision will be guided by +the two goals of preserving the free status of all derivatives of our +free software and of promoting the sharing and reuse of software +generally. + +**NO WARRANTY** + +**11.** BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +**12.** IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + +END OF TERMS AND CONDITIONS + +## How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + +To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + one line to give the program's name and an idea of what it does. + Copyright (C) yyyy name of author + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + +Also add information on how to contact you by electronic and paper +mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details + type `show w'. This is free software, and you are welcome + to redistribute it under certain conditions; type `show c' + for details. + +The hypothetical commands \`show w' and \`show c' should show the +appropriate parts of the General Public License. Of course, the +commands you use may be called something other than \`show w' and +\`show c'; they could even be mouse-clicks or menu items--whatever +suits your program. + +You should also get your employer (if you work as a programmer) or +your school, if any, to sign a "copyright disclaimer" for the program, +if necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright + interest in the program `Gnomovision' + (which makes passes at compilers) written + by James Hacker. + + signature of Ty Coon, 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, +you may consider it more useful to permit linking proprietary +applications with the library. If this is what you want to do, use the +[GNU Lesser General Public +License](https://www.gnu.org/licenses/lgpl.html) instead of this +License. diff --git a/README.MD b/README.md similarity index 100% rename from README.MD rename to README.md diff --git a/awesomewm-d-tl-dev-1.rockspec b/awesomewm-d-tl-dev-1.rockspec new file mode 100644 index 0000000..cd656f7 --- /dev/null +++ b/awesomewm-d-tl-dev-1.rockspec @@ -0,0 +1,61 @@ +rockspec_format = "3.0" +package = "awesomewm-d-tl" +version = "dev-1" +source = { + url = "git+https://gitea.aireone.xyz/Aire-One/awesomewm.d.tl.git", +} +description = { + homepage = "https://gitea.aireone.xyz/Aire-One/awesomewm.d.tl/src/branch/master/README.MD", + license = "GPLv2", +} +dependencies = { + "lualogging 1.6.0", + "inspect 3.1.3", + "ansicolors 1.0.2", + "web_sanitize 1.3.0", + "penlight 1.13.1", + "luasocket 3.1.0-1", + "luasec 1.2.0-1", + "luafilesystem 1.8.0-1", +} +build_dependencies = { + "cyan", +} +build = { + type = "command", + build_command = "cyan build", + install = { + bin = { + "bin/awesomewm-d-tl", + }, + lua = { + ["awesomewm-d-tl.crawler.init"] = "build/awesomewm-d-tl/crawler/init.lua", + ["awesomewm-d-tl.entity.Function_Info"] = "build/awesomewm-d-tl/entity/Function_Info.lua", + ["awesomewm-d-tl.entity.Module_Doc"] = "build/awesomewm-d-tl/entity/Module_Doc.lua", + ["awesomewm-d-tl.entity.Module_Info"] = "build/awesomewm-d-tl/entity/Module_Info.lua", + ["awesomewm-d-tl.entity.Type_Info"] = "build/awesomewm-d-tl/entity/Type_Info.lua", + ["awesomewm-d-tl.entity.Variable_Info"] = "build/awesomewm-d-tl/entity/Variable_Info.lua", + ["awesomewm-d-tl.filesystem.file_writer"] = "build/awesomewm-d-tl/filesystem/file_writer.lua", + ["awesomewm-d-tl.filesystem.init"] = "build/awesomewm-d-tl/filesystem/init.lua", + ["awesomewm-d-tl.logger.init"] = "build/awesomewm-d-tl/logger/init.lua", + ["awesomewm-d-tl.printer.global_env_def"] = "build/awesomewm-d-tl/printer/global_env_def.lua", + ["awesomewm-d-tl.printer.init"] = "build/awesomewm-d-tl/printer/init.lua", + ["awesomewm-d-tl.printer.module_init_definition"] = "build/awesomewm-d-tl/printer/module_init_definition.lua", + ["awesomewm-d-tl.printer.snippets"] = "build/awesomewm-d-tl/printer/snippets.lua", + ["awesomewm-d-tl.printer.teal_type_definition"] = "build/awesomewm-d-tl/printer/teal_type_definition.lua", + ["awesomewm-d-tl.scraper.init"] = "build/awesomewm-d-tl/scraper/init.lua", + ["awesomewm-d-tl.scraper.module_doc"] = "build/awesomewm-d-tl/scraper/module_doc.lua", + ["awesomewm-d-tl.scraper.module_info_list"] = "build/awesomewm-d-tl/scraper/module_info_list.lua", + ["awesomewm-d-tl.scraper.utils"] = "build/awesomewm-d-tl/scraper/utils.lua", + ["awesomewm-d-tl.types.Dag"] = "build/awesomewm-d-tl/types/Dag.lua", + ["awesomewm-d-tl.types.Node"] = "build/awesomewm-d-tl/types/Node.lua", + ["awesomewm-d-tl.visitors.module_dependencies"] = "build/awesomewm-d-tl/visitors/module_dependencies.lua", + ["awesomewm-d-tl.visitors.type_mapping"] = "build/awesomewm-d-tl/visitors/type_mapping.lua", + ["awesomewm-d-tl.ast"] = "build/awesomewm-d-tl/ast.lua", + ["awesomewm-d-tl.dag"] = "build/awesomewm-d-tl/dag.lua", + ["awesomewm-d-tl.init"] = "build/awesomewm-d-tl/init.lua", + ["awesomewm-d-tl.property"] = "build/awesomewm-d-tl/property.lua", + ["awesomewm-d-tl.utils"] = "build/awesomewm-d-tl/utils.lua", + }, + }, +} diff --git a/bin/awesomewm-d-tl b/bin/awesomewm-d-tl new file mode 100755 index 0000000..65c0b70 --- /dev/null +++ b/bin/awesomewm-d-tl @@ -0,0 +1,3 @@ +#!/usr/bin/env lua + +local a = require("awesomewm-d-tl") diff --git a/justfile b/justfile index d35a481..9cae98d 100644 --- a/justfile +++ b/justfile @@ -9,7 +9,7 @@ rockspec_file := "rockspecs/awesomewm.d.tl-dev-1.rockspec" lua_targets := `find src/ -type f -iname '*.lua' | xargs` + " " + `ls *.lua | xargs` teal_targets := `find src/ types/ -type f -iname '*.tl' | xargs` -install: +local-install-dependencies: luarocks \ --lua-version {{ lua_version }} \ install \ @@ -17,7 +17,7 @@ install: --only-deps \ {{ rockspec_file }} -uninstall: +local-uninstall-dependencies: rm -rf {{ rocks_tree }} check-lua *FLAGS: @@ -38,7 +38,7 @@ clean: rm -rf build run: - {{ tl }} src/awesomewm.d.tl/init.tl + {{ tl }} src/awesomewm-d-tl/init.tl validate: cd generated && cyan \ diff --git a/rockspecs/awesomewm.d.tl-dev-1.rockspec b/rockspecs/awesomewm.d.tl-dev-1.rockspec deleted file mode 100644 index 0e9fdc1..0000000 --- a/rockspecs/awesomewm.d.tl-dev-1.rockspec +++ /dev/null @@ -1,24 +0,0 @@ -package = "awesomewm.d.tl" -version = "dev-1" -source = { - url = "*** please add URL for source tarball, zip or repository here ***", -} -description = { - homepage = "*** please enter a project homepage ***", - license = "*** please specify a license ***", -} -dependencies = { - "lua ~> 5.4", - "lualogging 1.6.0", - "inspect 3.1.3", - "ansicolors 1.0.2", - "web_sanitize 1.3.0", - "penlight 1.13.1", - "luasocket 3.1.0-1", - "luasec 1.2.0-1", - "luafilesystem 1.8.0-1", -} -build = { - type = "builtin", - modules = {}, -} diff --git a/set_paths.lua b/set_paths.lua deleted file mode 100644 index 0238a0c..0000000 --- a/set_paths.lua +++ /dev/null @@ -1,15 +0,0 @@ -local version = _VERSION:match "%d+%.%d+" - -local function lua_module_paths(module_base_path) - local paths = (module_base_path .. "/?.lua;") - .. (module_base_path .. "/?/init.lua;") - - return paths -end - -package.path = lua_module_paths("lua_modules/share/lua/" .. version) - .. lua_module_paths "types" - .. lua_module_paths "build/awesomewm.d.tl" - .. package.path - -package.cpath = "lua_modules/lib/lua/" .. version .. "/?.so;" .. package.cpath diff --git a/set_paths.tl b/set_paths.tl index 0899575..76a7eb2 100644 --- a/set_paths.tl +++ b/set_paths.tl @@ -10,7 +10,7 @@ end package.path = lua_module_paths("lua_modules/share/lua/" .. version) .. lua_module_paths "types" - .. lua_module_paths "src/awesomewm.d.tl" + .. lua_module_paths "src" .. package.path package.cpath = "lua_modules/lib/lua/" .. version .. "/?.so;" .. package.cpath diff --git a/src/awesomewm.d.tl/ast.tl b/src/awesomewm-d-tl/ast.tl similarity index 97% rename from src/awesomewm.d.tl/ast.tl rename to src/awesomewm-d-tl/ast.tl index 6f5dae8..9abe5e4 100644 --- a/src/awesomewm.d.tl/ast.tl +++ b/src/awesomewm-d-tl/ast.tl @@ -1,4 +1,4 @@ -local type Node = require("types.Node") +local type Node = require("awesomewm-d-tl.types.Node") local basic_nodes : { Node.Token : function(name: string, ...: any): Node } = { module = function(name: string, module_path: string): Node diff --git a/src/awesomewm.d.tl/crawler/init.tl b/src/awesomewm-d-tl/crawler/init.tl similarity index 88% rename from src/awesomewm.d.tl/crawler/init.tl rename to src/awesomewm-d-tl/crawler/init.tl index cc11c3d..c5905a9 100644 --- a/src/awesomewm.d.tl/crawler/init.tl +++ b/src/awesomewm-d-tl/crawler/init.tl @@ -1,7 +1,7 @@ -local file = require "pl.file" -local http = require "socket.http" -local logger = require "logger" -local tablex = require "pl.tablex" +local file = require("pl.file") +local http = require("socket.http") +local logger = require("awesomewm-d-tl.logger") +local tablex = require("pl.tablex") local log = logger.log("crawler") diff --git a/src/awesomewm.d.tl/dag.tl b/src/awesomewm-d-tl/dag.tl similarity index 78% rename from src/awesomewm.d.tl/dag.tl rename to src/awesomewm-d-tl/dag.tl index 9953a87..3211675 100644 --- a/src/awesomewm.d.tl/dag.tl +++ b/src/awesomewm-d-tl/dag.tl @@ -1,6 +1,6 @@ -local type Dag = require("types.Dag") -local type Node = require("types.Node") -local utils = require("utils") +local type Dag = require("awesomewm-d-tl.types.Dag") +local type Node = require("awesomewm-d-tl.types.Node") +local utils = require("awesomewm-d-tl.utils") local function new(): Dag local dag : Dag = { diff --git a/src/awesomewm.d.tl/entity/Function_Info.tl b/src/awesomewm-d-tl/entity/Function_Info.tl similarity index 90% rename from src/awesomewm.d.tl/entity/Function_Info.tl rename to src/awesomewm-d-tl/entity/Function_Info.tl index 534da92..24029a9 100644 --- a/src/awesomewm.d.tl/entity/Function_Info.tl +++ b/src/awesomewm-d-tl/entity/Function_Info.tl @@ -1,8 +1,8 @@ -local List = require "pl.List" -local Map = require "pl.Map" -local Type_Info = require "entity.Type_Info" -local Variable_Info = require "entity.Variable_Info" -local utils = require "utils" +local List = require("pl.List") +local Map = require("pl.Map") +local Type_Info = require("awesomewm-d-tl.entity.Type_Info") +local Variable_Info = require("awesomewm-d-tl.entity.Variable_Info") +local utils = require("awesomewm-d-tl.utils") local record Function_Info metamethod __call: function( diff --git a/src/awesomewm.d.tl/entity/Module_Doc.tl b/src/awesomewm-d-tl/entity/Module_Doc.tl similarity index 94% rename from src/awesomewm.d.tl/entity/Module_Doc.tl rename to src/awesomewm-d-tl/entity/Module_Doc.tl index 0e2dfd5..4c627fb 100644 --- a/src/awesomewm.d.tl/entity/Module_Doc.tl +++ b/src/awesomewm-d-tl/entity/Module_Doc.tl @@ -1,7 +1,7 @@ -local Function_Info = require "entity.Function_Info" -local List = require "pl.List" -local Map = require "pl.Map" -local Variable_Info = require "entity.Variable_Info" +local Function_Info = require("awesomewm-d-tl.entity.Function_Info") +local List = require("pl.List") +local Map = require("pl.Map") +local Variable_Info = require("awesomewm-d-tl.entity.Variable_Info") local module_to_require : Map = Map({ Shape = "gears.shape", diff --git a/src/awesomewm.d.tl/entity/Module_Info.tl b/src/awesomewm-d-tl/entity/Module_Info.tl similarity index 100% rename from src/awesomewm.d.tl/entity/Module_Info.tl rename to src/awesomewm-d-tl/entity/Module_Info.tl diff --git a/src/awesomewm.d.tl/entity/Type_Info.tl b/src/awesomewm-d-tl/entity/Type_Info.tl similarity index 100% rename from src/awesomewm.d.tl/entity/Type_Info.tl rename to src/awesomewm-d-tl/entity/Type_Info.tl diff --git a/src/awesomewm.d.tl/entity/Variable_Info.tl b/src/awesomewm-d-tl/entity/Variable_Info.tl similarity index 87% rename from src/awesomewm.d.tl/entity/Variable_Info.tl rename to src/awesomewm-d-tl/entity/Variable_Info.tl index c0c5fea..742af51 100644 --- a/src/awesomewm.d.tl/entity/Variable_Info.tl +++ b/src/awesomewm-d-tl/entity/Variable_Info.tl @@ -1,5 +1,5 @@ -local List = require "pl.List" -local Type_Info = require "entity.Type_Info" +local List = require("pl.List") +local Type_Info = require("awesomewm-d-tl.entity.Type_Info") local record Variable_Info metamethod __call: function(self: Variable_Info, name: string | nil, types: List | nil): Variable_Info diff --git a/src/awesomewm.d.tl/filesystem/file_writer.tl b/src/awesomewm-d-tl/filesystem/file_writer.tl similarity index 89% rename from src/awesomewm.d.tl/filesystem/file_writer.tl rename to src/awesomewm-d-tl/filesystem/file_writer.tl index de44d8a..b61c865 100644 --- a/src/awesomewm.d.tl/filesystem/file_writer.tl +++ b/src/awesomewm-d-tl/filesystem/file_writer.tl @@ -1,7 +1,7 @@ -local file = require "pl.file" -local lfs = require "lfs" -local logger = require "logger" -local path = require "pl.path" +local file = require("pl.file") +local lfs = require("lfs") +local logger = require("awesomewm-d-tl.logger") +local path = require("pl.path") local log = logger.log("file_writer") diff --git a/src/awesomewm-d-tl/filesystem/init.tl b/src/awesomewm-d-tl/filesystem/init.tl new file mode 100644 index 0000000..bb44825 --- /dev/null +++ b/src/awesomewm-d-tl/filesystem/init.tl @@ -0,0 +1,3 @@ +return { + file_writer = require("awesomewm-d-tl.filesystem.file_writer"), +} diff --git a/src/awesomewm.d.tl/init.tl b/src/awesomewm-d-tl/init.tl similarity index 83% rename from src/awesomewm.d.tl/init.tl rename to src/awesomewm-d-tl/init.tl index fd99f4c..8d08a1d 100644 --- a/src/awesomewm.d.tl/init.tl +++ b/src/awesomewm-d-tl/init.tl @@ -2,22 +2,22 @@ if os.getenv("LOCAL_LUA_DEBUGGER_VSCODE") == "1" then require("lldebugger").start() end -local ast = require "ast" -local crawler = require "crawler" -local dag = require "dag" -local filesystem = require "filesystem" -local printer = require "printer" -local List = require "pl.List" -local logger = require "logger" -local Map = require "pl.Map" -local Module_Info = require "entity.Module_Info" -local module_dependencies = require "visitors.module_dependencies" -local type Node = require "types.Node" -local property = require "property" -local scraper = require "scraper" -local stringx = require "pl.stringx" -local type_mapping = require "visitors.type_mapping" -local utils = require "utils" +local ast = require("awesomewm-d-tl.ast") +local crawler = require("awesomewm-d-tl.crawler") +local dag = require("awesomewm-d-tl.dag") +local filesystem = require("awesomewm-d-tl.filesystem") +local printer = require("awesomewm-d-tl.printer") +local List = require("pl.List") +local logger = require("awesomewm-d-tl.logger") +local Map = require("pl.Map") +local Module_Info = require("awesomewm-d-tl.entity.Module_Info") +local module_dependencies = require("awesomewm-d-tl.visitors.module_dependencies") +local type Node = require("awesomewm-d-tl.types.Node") +local property = require("awesomewm-d-tl.property") +local scraper = require("awesomewm-d-tl.scraper") +local stringx = require("pl.stringx") +local type_mapping = require("awesomewm-d-tl.visitors.type_mapping") +local utils = require("awesomewm-d-tl.utils") local log = logger.log("main") diff --git a/src/awesomewm.d.tl/logger/init.tl b/src/awesomewm-d-tl/logger/init.tl similarity index 89% rename from src/awesomewm.d.tl/logger/init.tl rename to src/awesomewm-d-tl/logger/init.tl index 4b2a168..9cd74e4 100644 --- a/src/awesomewm.d.tl/logger/init.tl +++ b/src/awesomewm-d-tl/logger/init.tl @@ -1,7 +1,7 @@ -local ansicolors = require "ansicolors" -local inspect = require "inspect" -local Logging = require "logging" -local logging_console = require "logging.console" +local ansicolors = require("ansicolors") +local inspect = require("inspect") +local Logging = require("logging") +local logging_console = require("logging.console") local function colorize(level: Logging.Level, message: string): string if level == "DEBUG" then diff --git a/src/awesomewm.d.tl/printer/global_env_def.tl b/src/awesomewm-d-tl/printer/global_env_def.tl similarity index 82% rename from src/awesomewm.d.tl/printer/global_env_def.tl rename to src/awesomewm-d-tl/printer/global_env_def.tl index 79b9250..8e54ca8 100644 --- a/src/awesomewm.d.tl/printer/global_env_def.tl +++ b/src/awesomewm-d-tl/printer/global_env_def.tl @@ -1,8 +1,8 @@ -local List = require "pl.List" -local Module_Doc = require "entity.Module_Doc" -local template = require "pl.template" -local utils = require "utils" -local snippets = require "printer.snippets" +local List = require("pl.List") +local Module_Doc = require("awesomewm-d-tl.entity.Module_Doc") +local template = require("pl.template") +local utils = require("awesomewm-d-tl.utils") +local snippets = require("awesomewm-d-tl.printer.snippets") -- The long therm goal is to have so many `snippets.render_*` functions that -- we can render the whole file with the smallest template possible. diff --git a/src/awesomewm-d-tl/printer/init.tl b/src/awesomewm-d-tl/printer/init.tl new file mode 100644 index 0000000..60e7bd5 --- /dev/null +++ b/src/awesomewm-d-tl/printer/init.tl @@ -0,0 +1,6 @@ +return { + global_env_def = require("awesomewm-d-tl.printer.global_env_def"), + module_init_definition = require("awesomewm-d-tl.printer.module_init_definition"), + snippets = require("awesomewm-d-tl.printer.snippets"), + teal_type_definition = require("awesomewm-d-tl.printer.teal_type_definition"), +} diff --git a/src/awesomewm.d.tl/printer/module_init_definition.tl b/src/awesomewm-d-tl/printer/module_init_definition.tl similarity index 74% rename from src/awesomewm.d.tl/printer/module_init_definition.tl rename to src/awesomewm-d-tl/printer/module_init_definition.tl index dca48f5..88c324a 100644 --- a/src/awesomewm.d.tl/printer/module_init_definition.tl +++ b/src/awesomewm-d-tl/printer/module_init_definition.tl @@ -1,7 +1,7 @@ -local Map = require "pl.Map" -local template = require "pl.template" -local utils = require "utils" -local snippets = require "printer.snippets" +local Map = require("pl.Map") +local template = require("pl.template") +local utils = require("awesomewm-d-tl.utils") +local snippets = require("awesomewm-d-tl.printer.snippets") -- The long therm goal is to have so many `snippets.render_*` functions that -- we can render the whole file with the smallest template possible. diff --git a/src/awesomewm.d.tl/printer/snippets.tl b/src/awesomewm-d-tl/printer/snippets.tl similarity index 92% rename from src/awesomewm.d.tl/printer/snippets.tl rename to src/awesomewm-d-tl/printer/snippets.tl index 5060836..6460d0b 100644 --- a/src/awesomewm.d.tl/printer/snippets.tl +++ b/src/awesomewm-d-tl/printer/snippets.tl @@ -1,11 +1,11 @@ -local Function_Info = require "entity.Function_Info" -local List = require "pl.List" -local Map = require "pl.Map" -local stringx = require "pl.stringx" -local template = require "pl.template" -local Type_Info = require "entity.Type_Info" -local utils = require "utils" -local Variable_Info = require "entity.Variable_Info" +local Function_Info = require("awesomewm-d-tl.entity.Function_Info") +local List = require("pl.List") +local Map = require("pl.Map") +local stringx = require("pl.stringx") +local template = require("pl.template") +local Type_Info = require("awesomewm-d-tl.entity.Type_Info") +local utils = require("awesomewm-d-tl.utils") +local Variable_Info = require("awesomewm-d-tl.entity.Variable_Info") local record Module indent: function(str: string, level: number): string diff --git a/src/awesomewm.d.tl/printer/teal_type_definition.tl b/src/awesomewm-d-tl/printer/teal_type_definition.tl similarity index 96% rename from src/awesomewm.d.tl/printer/teal_type_definition.tl rename to src/awesomewm-d-tl/printer/teal_type_definition.tl index fbfab82..bb5c4bf 100644 --- a/src/awesomewm.d.tl/printer/teal_type_definition.tl +++ b/src/awesomewm-d-tl/printer/teal_type_definition.tl @@ -1,8 +1,8 @@ -local ast = require("ast") -local logger = require("logger") -local type Node = require("types.Node") +local ast = require("awesomewm-d-tl.ast") +local logger = require("awesomewm-d-tl.logger") +local type Node = require("awesomewm-d-tl.types.Node") local stringx = require("pl.stringx") -local utils = require("utils") +local utils = require("awesomewm-d-tl.utils") local log = logger.log("scraper") diff --git a/src/awesomewm.d.tl/property.tl b/src/awesomewm-d-tl/property.tl similarity index 100% rename from src/awesomewm.d.tl/property.tl rename to src/awesomewm-d-tl/property.tl diff --git a/src/awesomewm-d-tl/scraper/init.tl b/src/awesomewm-d-tl/scraper/init.tl new file mode 100644 index 0000000..c5b0555 --- /dev/null +++ b/src/awesomewm-d-tl/scraper/init.tl @@ -0,0 +1,5 @@ +return { + module_doc = require("awesomewm-d-tl.scraper.module_doc"), + module_info_list = require("awesomewm-d-tl.scraper.module_info_list"), + utils = require("awesomewm-d-tl.scraper.utils"), +} diff --git a/src/awesomewm.d.tl/scraper/module_doc.tl b/src/awesomewm-d-tl/scraper/module_doc.tl similarity index 96% rename from src/awesomewm.d.tl/scraper/module_doc.tl rename to src/awesomewm-d-tl/scraper/module_doc.tl index 0eb0f66..d48e217 100644 --- a/src/awesomewm.d.tl/scraper/module_doc.tl +++ b/src/awesomewm-d-tl/scraper/module_doc.tl @@ -1,10 +1,10 @@ -local ast = require("ast") -local type Node = require("types.Node") -local logger = require "logger" -local scan = require "web_sanitize.query.scan_html" -local scraper_utils = require "scraper.utils" -local stringx = require "pl.stringx" -local utils = require "utils" +local ast = require("awesomewm-d-tl.ast") +local type Node = require("awesomewm-d-tl.types.Node") +local logger = require("awesomewm-d-tl.logger") +local scan = require("web_sanitize.query.scan_html") +local scraper_utils = require("awesomewm-d-tl.scraper.utils") +local stringx = require("pl.stringx") +local utils = require("awesomewm-d-tl.utils") local log = logger.log("scraper") diff --git a/src/awesomewm.d.tl/scraper/module_info_list.tl b/src/awesomewm-d-tl/scraper/module_info_list.tl similarity index 70% rename from src/awesomewm.d.tl/scraper/module_info_list.tl rename to src/awesomewm-d-tl/scraper/module_info_list.tl index 70448e0..4137ec3 100644 --- a/src/awesomewm.d.tl/scraper/module_info_list.tl +++ b/src/awesomewm-d-tl/scraper/module_info_list.tl @@ -1,7 +1,7 @@ -local Module_Info = require "entity.Module_Info" -local scan = require "web_sanitize.query.scan_html" -local scraper_utils = require "scraper.utils" -local utils = require "utils" +local Module_Info = require("awesomewm-d-tl.entity.Module_Info") +local scan = require("web_sanitize.query.scan_html") +local scraper_utils = require("awesomewm-d-tl.scraper.utils") +local utils = require("awesomewm-d-tl.utils") local module = {} diff --git a/src/awesomewm.d.tl/scraper/utils.tl b/src/awesomewm-d-tl/scraper/utils.tl similarity index 90% rename from src/awesomewm.d.tl/scraper/utils.tl rename to src/awesomewm-d-tl/scraper/utils.tl index 271ed0d..858246c 100644 --- a/src/awesomewm.d.tl/scraper/utils.tl +++ b/src/awesomewm-d-tl/scraper/utils.tl @@ -1,9 +1,9 @@ -local List = require "pl.List" -local logger = require "logger" -local Map = require "pl.Map" -local scan = require "web_sanitize.query.scan_html" -local scanner = require "web_sanitize.query.scan_html" -local tablex = require "pl.tablex" +local List = require("pl.List") +local logger = require("awesomewm-d-tl.logger") +local Map = require("pl.Map") +local scan = require("web_sanitize.query.scan_html") +local scanner = require("web_sanitize.query.scan_html") +local tablex = require("pl.tablex") local log = logger.log("scrapper") diff --git a/src/awesomewm.d.tl/types/Dag.tl b/src/awesomewm-d-tl/types/Dag.tl similarity index 76% rename from src/awesomewm.d.tl/types/Dag.tl rename to src/awesomewm-d-tl/types/Dag.tl index 0f52f13..3ae193a 100644 --- a/src/awesomewm.d.tl/types/Dag.tl +++ b/src/awesomewm-d-tl/types/Dag.tl @@ -1,4 +1,4 @@ -local type Node = require("types.Node") +local type Node = require("awesomewm-d-tl.types.Node") local record Dag modules: { string : Node } -- module_path (AKA "full name" `package.module.name`) -> root_node (token = "module") diff --git a/src/awesomewm.d.tl/types/Node.tl b/src/awesomewm-d-tl/types/Node.tl similarity index 100% rename from src/awesomewm.d.tl/types/Node.tl rename to src/awesomewm-d-tl/types/Node.tl diff --git a/src/awesomewm.d.tl/utils.tl b/src/awesomewm-d-tl/utils.tl similarity index 97% rename from src/awesomewm.d.tl/utils.tl rename to src/awesomewm-d-tl/utils.tl index d1e1019..4387fd7 100644 --- a/src/awesomewm.d.tl/utils.tl +++ b/src/awesomewm-d-tl/utils.tl @@ -63,7 +63,7 @@ end -- At some point, we should probably write a wrapper to make penlight's function work with pcalls. function utils.do_or_fail(func: function(...: any): (T | nil, string), ...: any): T - local logger = require "logger" + local logger = require("awesomewm-d-tl.logger") local log = logger.log("utils") local ok, res, err = pcall(func, ...) diff --git a/src/awesomewm.d.tl/visitors/module_dependencies.tl b/src/awesomewm-d-tl/visitors/module_dependencies.tl similarity index 91% rename from src/awesomewm.d.tl/visitors/module_dependencies.tl rename to src/awesomewm-d-tl/visitors/module_dependencies.tl index 94cc701..c8cd170 100644 --- a/src/awesomewm.d.tl/visitors/module_dependencies.tl +++ b/src/awesomewm-d-tl/visitors/module_dependencies.tl @@ -1,6 +1,6 @@ -local type Dag = require("types.Dag") -local type Node = require("types.Node") -local utils = require("utils") +local type Dag = require("awesomewm-d-tl.types.Dag") +local type Node = require("awesomewm-d-tl.types.Node") +local utils = require("awesomewm-d-tl.utils") local spread = utils.spread diff --git a/src/awesomewm.d.tl/visitors/type_mapping.tl b/src/awesomewm-d-tl/visitors/type_mapping.tl similarity index 96% rename from src/awesomewm.d.tl/visitors/type_mapping.tl rename to src/awesomewm-d-tl/visitors/type_mapping.tl index 9c6e74a..c901c94 100644 --- a/src/awesomewm.d.tl/visitors/type_mapping.tl +++ b/src/awesomewm-d-tl/visitors/type_mapping.tl @@ -1,4 +1,4 @@ -local type Node = require("types.Node") +local type Node = require("awesomewm-d-tl.types.Node") -- Special types I don't want to deal with for now local gears_shape_function = "function(cr: any, width: integer, height: integer)" diff --git a/src/awesomewm.d.tl/filesystem/init.tl b/src/awesomewm.d.tl/filesystem/init.tl deleted file mode 100644 index 5a74251..0000000 --- a/src/awesomewm.d.tl/filesystem/init.tl +++ /dev/null @@ -1,3 +0,0 @@ -return { - file_writer = require "filesystem.file_writer", -} diff --git a/src/awesomewm.d.tl/printer/init.tl b/src/awesomewm.d.tl/printer/init.tl deleted file mode 100644 index 1787676..0000000 --- a/src/awesomewm.d.tl/printer/init.tl +++ /dev/null @@ -1,6 +0,0 @@ -return { - global_env_def = require("printer.global_env_def"), - module_init_definition = require("printer.module_init_definition"), - snippets = require("printer.snippets"), - teal_type_definition = require("printer.teal_type_definition"), -} diff --git a/src/awesomewm.d.tl/scraper/init.tl b/src/awesomewm.d.tl/scraper/init.tl deleted file mode 100644 index 77155e4..0000000 --- a/src/awesomewm.d.tl/scraper/init.tl +++ /dev/null @@ -1,5 +0,0 @@ -return { - module_doc = require "scraper.module_doc", - module_info_list = require "scraper.module_info_list", - utils = require "scraper.utils", -} diff --git a/tlconfig.lua b/tlconfig.lua index aafa9c4..c80d256 100644 --- a/tlconfig.lua +++ b/tlconfig.lua @@ -2,7 +2,7 @@ return { build_dir = "build", source_dir = "src", include_dir = { - "src/awesomewm.d.tl", + "src", "types", }, } From 85702797fe25337dbcdf10c0a82cd23290383dc9 Mon Sep 17 00:00:00 2001 From: Aire-One Date: Sun, 3 Sep 2023 19:41:40 +0200 Subject: [PATCH 02/16] chore: ci fixes --- .woodpecker/build.yml | 2 +- .woodpecker/lint.yml | 2 +- .woodpecker/test.yml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.woodpecker/build.yml b/.woodpecker/build.yml index 0d0a370..e6515f2 100644 --- a/.woodpecker/build.yml +++ b/.woodpecker/build.yml @@ -5,7 +5,7 @@ pipeline: prepare: image: *cyan commands: - - just install + - luarocks install --only-deps awesomewm-d-tl-dev-1.rockspec build: image: *cyan commands: diff --git a/.woodpecker/lint.yml b/.woodpecker/lint.yml index 4cb03c2..39e0f42 100644 --- a/.woodpecker/lint.yml +++ b/.woodpecker/lint.yml @@ -10,7 +10,7 @@ variables: pipeline: lint-pipeline: - image: woodpeckerci/woodpecker-cli:next-alpine + image: woodpeckerci/woodpecker-cli:v0.15.11-alpine group: lint commands: - woodpecker-cli lint .woodpecker/*.yml diff --git a/.woodpecker/test.yml b/.woodpecker/test.yml index 4fa84e1..1cf8865 100644 --- a/.woodpecker/test.yml +++ b/.woodpecker/test.yml @@ -5,7 +5,7 @@ pipeline: prepare: image: *busted commands: - - just install + - luarocks install --only-deps awesomewm-d-tl-dev-1.rockspec test: image: *busted commands: From 6ee57456b9ae5dd15c4ac0a6b3052638aeb64018 Mon Sep 17 00:00:00 2001 From: Aire-One Date: Sun, 3 Sep 2023 20:08:30 +0200 Subject: [PATCH 03/16] chore(ci): disable woodpecker lint The woodpecker-cli version used has moved, and the current woodpecker server installed is too old to have configuration that passes the newer lint rules. We'll need to first update the woodpecker server, then port the config, and finally enable back this lint step. --- .woodpecker/lint.yml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/.woodpecker/lint.yml b/.woodpecker/lint.yml index 39e0f42..12c6e34 100644 --- a/.woodpecker/lint.yml +++ b/.woodpecker/lint.yml @@ -9,14 +9,14 @@ variables: - "**/*.tl" pipeline: - lint-pipeline: - image: woodpeckerci/woodpecker-cli:v0.15.11-alpine - group: lint - commands: - - woodpecker-cli lint .woodpecker/*.yml - when: - path: - - ".woodpecker/**" + # lint-pipeline: + # image: woodpeckerci/woodpecker-cli:v0.15.11-alpine + # group: lint + # commands: + # - woodpecker-cli lint .woodpecker/*.yml + # when: + # path: + # - ".woodpecker/**" lint-lua: image: gitea.aireone.xyz/aire-one/awesomewm.d.tl/luacheck_just:latest From 8d7ba519c495d6c9e22227963c4b94a87ec55e07 Mon Sep 17 00:00:00 2001 From: Aire-One Date: Sun, 3 Sep 2023 20:33:47 +0200 Subject: [PATCH 04/16] chore: fix specs --- spec/global_env_def.tl | 6 ++++++ spec/printer/teal_type_definition_spec.tl | 8 ++++---- spec/scraper/module_doc_spec.tl | 6 +++--- spec/tlconfig.lua | 4 ++-- 4 files changed, 15 insertions(+), 9 deletions(-) create mode 100644 spec/global_env_def.tl diff --git a/spec/global_env_def.tl b/spec/global_env_def.tl new file mode 100644 index 0000000..638a7c9 --- /dev/null +++ b/spec/global_env_def.tl @@ -0,0 +1,6 @@ +require("busted") + +-- We still can't do that with teal 0.15.2+dev. +-- The fix for now is to redeclare assert in every test file, +-- tl throws a warning but it's non-blocking, so it'll do for now. +-- global assert = require("luassert") diff --git a/spec/printer/teal_type_definition_spec.tl b/spec/printer/teal_type_definition_spec.tl index f6367ac..56d7c2c 100644 --- a/spec/printer/teal_type_definition_spec.tl +++ b/spec/printer/teal_type_definition_spec.tl @@ -1,7 +1,7 @@ -local assert = require("luassert") -local type Node = require("types.Node") -local stringx = require("pl.stringx") -local teal_type_definition_printer = require("printer.teal_type_definition") +local assert = require("luassert") +local type Node = require("awesomewm-d-tl.types.Node") +local stringx = require("pl.stringx") +local teal_type_definition_printer = require("awesomewm-d-tl.printer.teal_type_definition") local printer = teal_type_definition_printer.printer diff --git a/spec/scraper/module_doc_spec.tl b/spec/scraper/module_doc_spec.tl index d563fd4..97e5920 100644 --- a/spec/scraper/module_doc_spec.tl +++ b/spec/scraper/module_doc_spec.tl @@ -1,6 +1,6 @@ -local assert = require("luassert") -local type Node = require("types.Node") -local scraper = require("scraper.module_doc") +local assert = require("luassert") +local type Node = require("awesomewm-d-tl.types.Node") +local scraper = require("awesomewm-d-tl.scraper.module_doc") local get_doc_from_page = scraper.get_doc_from_page diff --git a/spec/tlconfig.lua b/spec/tlconfig.lua index 33aee75..8adbe5c 100644 --- a/spec/tlconfig.lua +++ b/spec/tlconfig.lua @@ -1,7 +1,7 @@ return { include_dir = { - "../src/awesomewm.d.tl", + "../src", "../types", }, - global_env_def = "busted", + global_env_def = "global_env_def", } From 39d3d09cb9170a9309731a789f37c696c8862bf7 Mon Sep 17 00:00:00 2001 From: Aire-One Date: Mon, 4 Sep 2023 00:27:50 +0200 Subject: [PATCH 05/16] chore: fix busted config --- .busted | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.busted b/.busted index 1d410d2..fb60538 100644 --- a/.busted +++ b/.busted @@ -17,7 +17,7 @@ return { _all = { lpath = lua_module_paths("lua_modules/share/lua/" .. version) .. lua_module_paths "types" - .. lua_module_paths "./src/awesomewm.d.tl", + .. lua_module_paths "src", cpath = "lua_modules/lib/lua/" .. version .. "/?.so;", loaders = { "teal" }, }, From ac1ba61cb275b91008fd028f98a898e018f08003 Mon Sep 17 00:00:00 2001 From: Aire-One Date: Sun, 10 Sep 2023 19:44:18 +0200 Subject: [PATCH 06/16] chore: fix CI `test` pipeline --- .woodpecker/test.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.woodpecker/test.yml b/.woodpecker/test.yml index 1cf8865..229f90c 100644 --- a/.woodpecker/test.yml +++ b/.woodpecker/test.yml @@ -5,7 +5,9 @@ pipeline: prepare: image: *busted commands: - - luarocks install --only-deps awesomewm-d-tl-dev-1.rockspec + - just local-install-dependencies + # TODO : understand why busted can't resolve the dependency in the CI environment + # - luarocks install --only-deps awesomewm-d-tl-dev-1.rockspec test: image: *busted commands: From c67c9362da6c37d0ea44c9248107451496662b72 Mon Sep 17 00:00:00 2001 From: Aire-One Date: Sun, 10 Sep 2023 19:55:03 +0200 Subject: [PATCH 07/16] ci(lint): rockspec --- .vscode/settings.json | 1 + .woodpecker/lint.yml | 11 +++++++++++ justfile | 11 +++++++++-- 3 files changed, 21 insertions(+), 2 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index f071b81..f1293ce 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -34,6 +34,7 @@ "modname", "reportfile", "rockspec", + "rockspecs", "rstrip", "runreport", "setopt", diff --git a/.woodpecker/lint.yml b/.woodpecker/lint.yml index 12c6e34..c984f9d 100644 --- a/.woodpecker/lint.yml +++ b/.woodpecker/lint.yml @@ -18,6 +18,17 @@ pipeline: # path: # - ".woodpecker/**" + lint-rockspec: + image: gitea.aireone.xyz/aire-one/awesomewm.d.tl/luacheck_just:latest + group: lint + commands: + - just check-rockspec + when: + path: + - ".woodpecker/**" + - "awesomewm-d-tl-dev-1.rockspec" + - "rockspec/*.rockspec" + lint-lua: image: gitea.aireone.xyz/aire-one/awesomewm.d.tl/luacheck_just:latest group: lint diff --git a/justfile b/justfile index 9cae98d..87da3e3 100644 --- a/justfile +++ b/justfile @@ -4,10 +4,11 @@ lua := "lua" + " -l set_paths" tl := "tl run" + " -l set_paths" rocks_tree := "lua_modules" -rockspec_file := "rockspecs/awesomewm.d.tl-dev-1.rockspec" +rockspec_file := "awesomewm.d.tl-dev-1.rockspec" lua_targets := `find src/ -type f -iname '*.lua' | xargs` + " " + `ls *.lua | xargs` teal_targets := `find src/ types/ -type f -iname '*.tl' | xargs` +rockspec_targets := `find . -type f -iname '*.rockspec' | xargs` local-install-dependencies: luarocks \ @@ -29,7 +30,13 @@ check-teal: check-format: stylua --check {{ lua_targets }} -check: check-lua check-format check-teal +check-rockspecs: + luarocks \ + --lua-version {{ lua_version }} \ + lint \ + {{ rockspec_targets }} + +check: check-lua check-format check-teal check-rockspecs build: cyan build From 64fbdf908fd82d5113533468e6d621566ee16d33 Mon Sep 17 00:00:00 2001 From: Aire-One Date: Sun, 10 Sep 2023 20:06:11 +0200 Subject: [PATCH 08/16] chore: fix justfile rockspec_file --- justfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/justfile b/justfile index 87da3e3..0573d75 100644 --- a/justfile +++ b/justfile @@ -4,7 +4,7 @@ lua := "lua" + " -l set_paths" tl := "tl run" + " -l set_paths" rocks_tree := "lua_modules" -rockspec_file := "awesomewm.d.tl-dev-1.rockspec" +rockspec_file := "awesomewm-d-tl-dev-1.rockspec" lua_targets := `find src/ -type f -iname '*.lua' | xargs` + " " + `ls *.lua | xargs` teal_targets := `find src/ types/ -type f -iname '*.tl' | xargs` From 00fa4ba32e4b7ac6d29b8d56adb33ee842cfd512 Mon Sep 17 00:00:00 2001 From: Aire-One Date: Mon, 18 Sep 2023 11:44:19 +0200 Subject: [PATCH 09/16] chore(just): rockspec lint --- .woodpecker/lint.yml | 2 +- justfile | 12 +++++++----- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/.woodpecker/lint.yml b/.woodpecker/lint.yml index c984f9d..95577f9 100644 --- a/.woodpecker/lint.yml +++ b/.woodpecker/lint.yml @@ -22,7 +22,7 @@ pipeline: image: gitea.aireone.xyz/aire-one/awesomewm.d.tl/luacheck_just:latest group: lint commands: - - just check-rockspec + - just check-rockspecs when: path: - ".woodpecker/**" diff --git a/justfile b/justfile index 0573d75..40b4ee8 100644 --- a/justfile +++ b/justfile @@ -8,7 +8,7 @@ rockspec_file := "awesomewm-d-tl-dev-1.rockspec" lua_targets := `find src/ -type f -iname '*.lua' | xargs` + " " + `ls *.lua | xargs` teal_targets := `find src/ types/ -type f -iname '*.tl' | xargs` -rockspec_targets := `find . -type f -iname '*.rockspec' | xargs` +rockspec_targets := `find {.,rockspecs} -maxdepth 1 -type f -iname '*.rockspec' | xargs` local-install-dependencies: luarocks \ @@ -31,10 +31,12 @@ check-format: stylua --check {{ lua_targets }} check-rockspecs: - luarocks \ - --lua-version {{ lua_version }} \ - lint \ - {{ rockspec_targets }} + for rock in {{ rockspec_targets }}; do \ + luarocks \ + --lua-version {{ lua_version }} \ + lint \ + $rock ; \ + done check: check-lua check-format check-teal check-rockspecs From 1ac471da89a2710bb6e8bda28c629446a9575860 Mon Sep 17 00:00:00 2001 From: Aire-One Date: Mon, 18 Sep 2023 12:04:36 +0200 Subject: [PATCH 10/16] chore: remove special characters from module name --- .vscode/settings.json | 1 + .woodpecker/build.yml | 2 +- .woodpecker/lint.yml | 2 +- .woodpecker/test.yml | 2 +- awesomewm-d-tl-dev-1.rockspec | 61 ------------------- awesomewmdtl-dev-1.rockspec | 61 +++++++++++++++++++ bin/awesomewm-d-tl | 3 - bin/awesomewmdtl | 3 + justfile | 4 +- spec/printer/teal_type_definition_spec.tl | 4 +- spec/scraper/module_doc_spec.tl | 4 +- src/awesomewm-d-tl/filesystem/init.tl | 3 - src/awesomewm-d-tl/printer/init.tl | 6 -- src/awesomewm-d-tl/scraper/init.tl | 5 -- src/{awesomewm-d-tl => awesomewmdtl}/ast.tl | 2 +- .../crawler/init.tl | 2 +- src/{awesomewm-d-tl => awesomewmdtl}/dag.tl | 6 +- .../entity/Function_Info.tl | 6 +- .../entity/Module_Doc.tl | 4 +- .../entity/Module_Info.tl | 0 .../entity/Type_Info.tl | 0 .../entity/Variable_Info.tl | 2 +- .../filesystem/file_writer.tl | 2 +- src/awesomewmdtl/filesystem/init.tl | 3 + src/{awesomewm-d-tl => awesomewmdtl}/init.tl | 26 ++++---- .../logger/init.tl | 0 .../printer/global_env_def.tl | 6 +- src/awesomewmdtl/printer/init.tl | 6 ++ .../printer/module_init_definition.tl | 4 +- .../printer/snippets.tl | 8 +-- .../printer/teal_type_definition.tl | 8 +-- .../property.tl | 0 src/awesomewmdtl/scraper/init.tl | 5 ++ .../scraper/module_doc.tl | 10 +-- .../scraper/module_info_list.tl | 6 +- .../scraper/utils.tl | 2 +- .../types/Dag.tl | 2 +- .../types/Node.tl | 0 src/{awesomewm-d-tl => awesomewmdtl}/utils.tl | 2 +- .../visitors/module_dependencies.tl | 6 +- .../visitors/type_mapping.tl | 2 +- 41 files changed, 141 insertions(+), 140 deletions(-) delete mode 100644 awesomewm-d-tl-dev-1.rockspec create mode 100644 awesomewmdtl-dev-1.rockspec delete mode 100755 bin/awesomewm-d-tl create mode 100755 bin/awesomewmdtl delete mode 100644 src/awesomewm-d-tl/filesystem/init.tl delete mode 100644 src/awesomewm-d-tl/printer/init.tl delete mode 100644 src/awesomewm-d-tl/scraper/init.tl rename src/{awesomewm-d-tl => awesomewmdtl}/ast.tl (97%) rename src/{awesomewm-d-tl => awesomewmdtl}/crawler/init.tl (96%) rename src/{awesomewm-d-tl => awesomewmdtl}/dag.tl (78%) rename src/{awesomewm-d-tl => awesomewmdtl}/entity/Function_Info.tl (93%) rename src/{awesomewm-d-tl => awesomewmdtl}/entity/Module_Doc.tl (96%) rename src/{awesomewm-d-tl => awesomewmdtl}/entity/Module_Info.tl (100%) rename src/{awesomewm-d-tl => awesomewmdtl}/entity/Type_Info.tl (100%) rename src/{awesomewm-d-tl => awesomewmdtl}/entity/Variable_Info.tl (92%) rename src/{awesomewm-d-tl => awesomewmdtl}/filesystem/file_writer.tl (96%) create mode 100644 src/awesomewmdtl/filesystem/init.tl rename src/{awesomewm-d-tl => awesomewmdtl}/init.tl (85%) rename src/{awesomewm-d-tl => awesomewmdtl}/logger/init.tl (100%) rename src/{awesomewm-d-tl => awesomewmdtl}/printer/global_env_def.tl (88%) create mode 100644 src/awesomewmdtl/printer/init.tl rename src/{awesomewm-d-tl => awesomewmdtl}/printer/module_init_definition.tl (84%) rename src/{awesomewm-d-tl => awesomewmdtl}/printer/snippets.tl (95%) rename src/{awesomewm-d-tl => awesomewmdtl}/printer/teal_type_definition.tl (96%) rename src/{awesomewm-d-tl => awesomewmdtl}/property.tl (100%) create mode 100644 src/awesomewmdtl/scraper/init.tl rename src/{awesomewm-d-tl => awesomewmdtl}/scraper/module_doc.tl (97%) rename src/{awesomewm-d-tl => awesomewmdtl}/scraper/module_info_list.tl (77%) rename src/{awesomewm-d-tl => awesomewmdtl}/scraper/utils.tl (98%) rename src/{awesomewm-d-tl => awesomewmdtl}/types/Dag.tl (76%) rename src/{awesomewm-d-tl => awesomewmdtl}/types/Node.tl (100%) rename src/{awesomewm-d-tl => awesomewmdtl}/utils.tl (97%) rename src/{awesomewm-d-tl => awesomewmdtl}/visitors/module_dependencies.tl (91%) rename src/{awesomewm-d-tl => awesomewmdtl}/visitors/type_mapping.tl (96%) diff --git a/.vscode/settings.json b/.vscode/settings.json index f1293ce..4a43426 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -10,6 +10,7 @@ "akorn", "ansicolors", "awesomewm", + "awesomewmdtl", "buildx", "concat", "dryrun", diff --git a/.woodpecker/build.yml b/.woodpecker/build.yml index e6515f2..2621add 100644 --- a/.woodpecker/build.yml +++ b/.woodpecker/build.yml @@ -5,7 +5,7 @@ pipeline: prepare: image: *cyan commands: - - luarocks install --only-deps awesomewm-d-tl-dev-1.rockspec + - luarocks install --only-deps awesomewmdtl-dev-1.rockspec build: image: *cyan commands: diff --git a/.woodpecker/lint.yml b/.woodpecker/lint.yml index 95577f9..0125255 100644 --- a/.woodpecker/lint.yml +++ b/.woodpecker/lint.yml @@ -26,7 +26,7 @@ pipeline: when: path: - ".woodpecker/**" - - "awesomewm-d-tl-dev-1.rockspec" + - "awesomewmdtl-dev-1.rockspec" - "rockspec/*.rockspec" lint-lua: diff --git a/.woodpecker/test.yml b/.woodpecker/test.yml index 229f90c..11eaa9c 100644 --- a/.woodpecker/test.yml +++ b/.woodpecker/test.yml @@ -7,7 +7,7 @@ pipeline: commands: - just local-install-dependencies # TODO : understand why busted can't resolve the dependency in the CI environment - # - luarocks install --only-deps awesomewm-d-tl-dev-1.rockspec + # - luarocks install --only-deps awesomewmdtl-dev-1.rockspec test: image: *busted commands: diff --git a/awesomewm-d-tl-dev-1.rockspec b/awesomewm-d-tl-dev-1.rockspec deleted file mode 100644 index cd656f7..0000000 --- a/awesomewm-d-tl-dev-1.rockspec +++ /dev/null @@ -1,61 +0,0 @@ -rockspec_format = "3.0" -package = "awesomewm-d-tl" -version = "dev-1" -source = { - url = "git+https://gitea.aireone.xyz/Aire-One/awesomewm.d.tl.git", -} -description = { - homepage = "https://gitea.aireone.xyz/Aire-One/awesomewm.d.tl/src/branch/master/README.MD", - license = "GPLv2", -} -dependencies = { - "lualogging 1.6.0", - "inspect 3.1.3", - "ansicolors 1.0.2", - "web_sanitize 1.3.0", - "penlight 1.13.1", - "luasocket 3.1.0-1", - "luasec 1.2.0-1", - "luafilesystem 1.8.0-1", -} -build_dependencies = { - "cyan", -} -build = { - type = "command", - build_command = "cyan build", - install = { - bin = { - "bin/awesomewm-d-tl", - }, - lua = { - ["awesomewm-d-tl.crawler.init"] = "build/awesomewm-d-tl/crawler/init.lua", - ["awesomewm-d-tl.entity.Function_Info"] = "build/awesomewm-d-tl/entity/Function_Info.lua", - ["awesomewm-d-tl.entity.Module_Doc"] = "build/awesomewm-d-tl/entity/Module_Doc.lua", - ["awesomewm-d-tl.entity.Module_Info"] = "build/awesomewm-d-tl/entity/Module_Info.lua", - ["awesomewm-d-tl.entity.Type_Info"] = "build/awesomewm-d-tl/entity/Type_Info.lua", - ["awesomewm-d-tl.entity.Variable_Info"] = "build/awesomewm-d-tl/entity/Variable_Info.lua", - ["awesomewm-d-tl.filesystem.file_writer"] = "build/awesomewm-d-tl/filesystem/file_writer.lua", - ["awesomewm-d-tl.filesystem.init"] = "build/awesomewm-d-tl/filesystem/init.lua", - ["awesomewm-d-tl.logger.init"] = "build/awesomewm-d-tl/logger/init.lua", - ["awesomewm-d-tl.printer.global_env_def"] = "build/awesomewm-d-tl/printer/global_env_def.lua", - ["awesomewm-d-tl.printer.init"] = "build/awesomewm-d-tl/printer/init.lua", - ["awesomewm-d-tl.printer.module_init_definition"] = "build/awesomewm-d-tl/printer/module_init_definition.lua", - ["awesomewm-d-tl.printer.snippets"] = "build/awesomewm-d-tl/printer/snippets.lua", - ["awesomewm-d-tl.printer.teal_type_definition"] = "build/awesomewm-d-tl/printer/teal_type_definition.lua", - ["awesomewm-d-tl.scraper.init"] = "build/awesomewm-d-tl/scraper/init.lua", - ["awesomewm-d-tl.scraper.module_doc"] = "build/awesomewm-d-tl/scraper/module_doc.lua", - ["awesomewm-d-tl.scraper.module_info_list"] = "build/awesomewm-d-tl/scraper/module_info_list.lua", - ["awesomewm-d-tl.scraper.utils"] = "build/awesomewm-d-tl/scraper/utils.lua", - ["awesomewm-d-tl.types.Dag"] = "build/awesomewm-d-tl/types/Dag.lua", - ["awesomewm-d-tl.types.Node"] = "build/awesomewm-d-tl/types/Node.lua", - ["awesomewm-d-tl.visitors.module_dependencies"] = "build/awesomewm-d-tl/visitors/module_dependencies.lua", - ["awesomewm-d-tl.visitors.type_mapping"] = "build/awesomewm-d-tl/visitors/type_mapping.lua", - ["awesomewm-d-tl.ast"] = "build/awesomewm-d-tl/ast.lua", - ["awesomewm-d-tl.dag"] = "build/awesomewm-d-tl/dag.lua", - ["awesomewm-d-tl.init"] = "build/awesomewm-d-tl/init.lua", - ["awesomewm-d-tl.property"] = "build/awesomewm-d-tl/property.lua", - ["awesomewm-d-tl.utils"] = "build/awesomewm-d-tl/utils.lua", - }, - }, -} diff --git a/awesomewmdtl-dev-1.rockspec b/awesomewmdtl-dev-1.rockspec new file mode 100644 index 0000000..8d1a48b --- /dev/null +++ b/awesomewmdtl-dev-1.rockspec @@ -0,0 +1,61 @@ +rockspec_format = "3.0" +package = "awesomewmdtl" +version = "dev-1" +source = { + url = "git+https://gitea.aireone.xyz/Aire-One/awesomewm.d.tl.git", +} +description = { + homepage = "https://gitea.aireone.xyz/Aire-One/awesomewm.d.tl/src/branch/master/README.MD", + license = "GPLv2", +} +dependencies = { + "lualogging 1.6.0", + "inspect 3.1.3", + "ansicolors 1.0.2", + "web_sanitize 1.3.0", + "penlight 1.13.1", + "luasocket 3.1.0-1", + "luasec 1.2.0-1", + "luafilesystem 1.8.0-1", +} +build_dependencies = { + "cyan", +} +build = { + type = "command", + build_command = "cyan build", + install = { + bin = { + "bin/awesomewmdtl", + }, + lua = { + ["awesomewmdtl.crawler.init"] = "build/awesomewmdtl/crawler/init.lua", + ["awesomewmdtl.entity.Function_Info"] = "build/awesomewmdtl/entity/Function_Info.lua", + ["awesomewmdtl.entity.Module_Doc"] = "build/awesomewmdtl/entity/Module_Doc.lua", + ["awesomewmdtl.entity.Module_Info"] = "build/awesomewmdtl/entity/Module_Info.lua", + ["awesomewmdtl.entity.Type_Info"] = "build/awesomewmdtl/entity/Type_Info.lua", + ["awesomewmdtl.entity.Variable_Info"] = "build/awesomewmdtl/entity/Variable_Info.lua", + ["awesomewmdtl.filesystem.file_writer"] = "build/awesomewmdtl/filesystem/file_writer.lua", + ["awesomewmdtl.filesystem.init"] = "build/awesomewmdtl/filesystem/init.lua", + ["awesomewmdtl.logger.init"] = "build/awesomewmdtl/logger/init.lua", + ["awesomewmdtl.printer.global_env_def"] = "build/awesomewmdtl/printer/global_env_def.lua", + ["awesomewmdtl.printer.init"] = "build/awesomewmdtl/printer/init.lua", + ["awesomewmdtl.printer.module_init_definition"] = "build/awesomewmdtl/printer/module_init_definition.lua", + ["awesomewmdtl.printer.snippets"] = "build/awesomewmdtl/printer/snippets.lua", + ["awesomewmdtl.printer.teal_type_definition"] = "build/awesomewmdtl/printer/teal_type_definition.lua", + ["awesomewmdtl.scraper.init"] = "build/awesomewmdtl/scraper/init.lua", + ["awesomewmdtl.scraper.module_doc"] = "build/awesomewmdtl/scraper/module_doc.lua", + ["awesomewmdtl.scraper.module_info_list"] = "build/awesomewmdtl/scraper/module_info_list.lua", + ["awesomewmdtl.scraper.utils"] = "build/awesomewmdtl/scraper/utils.lua", + ["awesomewmdtl.types.Dag"] = "build/awesomewmdtl/types/Dag.lua", + ["awesomewmdtl.types.Node"] = "build/awesomewmdtl/types/Node.lua", + ["awesomewmdtl.visitors.module_dependencies"] = "build/awesomewmdtl/visitors/module_dependencies.lua", + ["awesomewmdtl.visitors.type_mapping"] = "build/awesomewmdtl/visitors/type_mapping.lua", + ["awesomewmdtl.ast"] = "build/awesomewmdtl/ast.lua", + ["awesomewmdtl.dag"] = "build/awesomewmdtl/dag.lua", + ["awesomewmdtl.init"] = "build/awesomewmdtl/init.lua", + ["awesomewmdtl.property"] = "build/awesomewmdtl/property.lua", + ["awesomewmdtl.utils"] = "build/awesomewmdtl/utils.lua", + }, + }, +} diff --git a/bin/awesomewm-d-tl b/bin/awesomewm-d-tl deleted file mode 100755 index 65c0b70..0000000 --- a/bin/awesomewm-d-tl +++ /dev/null @@ -1,3 +0,0 @@ -#!/usr/bin/env lua - -local a = require("awesomewm-d-tl") diff --git a/bin/awesomewmdtl b/bin/awesomewmdtl new file mode 100755 index 0000000..4bf0d3e --- /dev/null +++ b/bin/awesomewmdtl @@ -0,0 +1,3 @@ +#!/usr/bin/env lua + +local a = require("awesomewmdtl") diff --git a/justfile b/justfile index 40b4ee8..80746f5 100644 --- a/justfile +++ b/justfile @@ -4,7 +4,7 @@ lua := "lua" + " -l set_paths" tl := "tl run" + " -l set_paths" rocks_tree := "lua_modules" -rockspec_file := "awesomewm-d-tl-dev-1.rockspec" +rockspec_file := "awesomewmdtl-dev-1.rockspec" lua_targets := `find src/ -type f -iname '*.lua' | xargs` + " " + `ls *.lua | xargs` teal_targets := `find src/ types/ -type f -iname '*.tl' | xargs` @@ -47,7 +47,7 @@ clean: rm -rf build run: - {{ tl }} src/awesomewm-d-tl/init.tl + {{ tl }} src/awesomewmdtl/init.tl validate: cd generated && cyan \ diff --git a/spec/printer/teal_type_definition_spec.tl b/spec/printer/teal_type_definition_spec.tl index 56d7c2c..2714ac2 100644 --- a/spec/printer/teal_type_definition_spec.tl +++ b/spec/printer/teal_type_definition_spec.tl @@ -1,7 +1,7 @@ local assert = require("luassert") -local type Node = require("awesomewm-d-tl.types.Node") +local type Node = require("awesomewmdtl.types.Node") local stringx = require("pl.stringx") -local teal_type_definition_printer = require("awesomewm-d-tl.printer.teal_type_definition") +local teal_type_definition_printer = require("awesomewmdtl.printer.teal_type_definition") local printer = teal_type_definition_printer.printer diff --git a/spec/scraper/module_doc_spec.tl b/spec/scraper/module_doc_spec.tl index 97e5920..23b3546 100644 --- a/spec/scraper/module_doc_spec.tl +++ b/spec/scraper/module_doc_spec.tl @@ -1,6 +1,6 @@ local assert = require("luassert") -local type Node = require("awesomewm-d-tl.types.Node") -local scraper = require("awesomewm-d-tl.scraper.module_doc") +local type Node = require("awesomewmdtl.types.Node") +local scraper = require("awesomewmdtl.scraper.module_doc") local get_doc_from_page = scraper.get_doc_from_page diff --git a/src/awesomewm-d-tl/filesystem/init.tl b/src/awesomewm-d-tl/filesystem/init.tl deleted file mode 100644 index bb44825..0000000 --- a/src/awesomewm-d-tl/filesystem/init.tl +++ /dev/null @@ -1,3 +0,0 @@ -return { - file_writer = require("awesomewm-d-tl.filesystem.file_writer"), -} diff --git a/src/awesomewm-d-tl/printer/init.tl b/src/awesomewm-d-tl/printer/init.tl deleted file mode 100644 index 60e7bd5..0000000 --- a/src/awesomewm-d-tl/printer/init.tl +++ /dev/null @@ -1,6 +0,0 @@ -return { - global_env_def = require("awesomewm-d-tl.printer.global_env_def"), - module_init_definition = require("awesomewm-d-tl.printer.module_init_definition"), - snippets = require("awesomewm-d-tl.printer.snippets"), - teal_type_definition = require("awesomewm-d-tl.printer.teal_type_definition"), -} diff --git a/src/awesomewm-d-tl/scraper/init.tl b/src/awesomewm-d-tl/scraper/init.tl deleted file mode 100644 index c5b0555..0000000 --- a/src/awesomewm-d-tl/scraper/init.tl +++ /dev/null @@ -1,5 +0,0 @@ -return { - module_doc = require("awesomewm-d-tl.scraper.module_doc"), - module_info_list = require("awesomewm-d-tl.scraper.module_info_list"), - utils = require("awesomewm-d-tl.scraper.utils"), -} diff --git a/src/awesomewm-d-tl/ast.tl b/src/awesomewmdtl/ast.tl similarity index 97% rename from src/awesomewm-d-tl/ast.tl rename to src/awesomewmdtl/ast.tl index 9abe5e4..1e488d4 100644 --- a/src/awesomewm-d-tl/ast.tl +++ b/src/awesomewmdtl/ast.tl @@ -1,4 +1,4 @@ -local type Node = require("awesomewm-d-tl.types.Node") +local type Node = require("awesomewmdtl.types.Node") local basic_nodes : { Node.Token : function(name: string, ...: any): Node } = { module = function(name: string, module_path: string): Node diff --git a/src/awesomewm-d-tl/crawler/init.tl b/src/awesomewmdtl/crawler/init.tl similarity index 96% rename from src/awesomewm-d-tl/crawler/init.tl rename to src/awesomewmdtl/crawler/init.tl index c5905a9..dd95e3f 100644 --- a/src/awesomewm-d-tl/crawler/init.tl +++ b/src/awesomewmdtl/crawler/init.tl @@ -1,6 +1,6 @@ local file = require("pl.file") local http = require("socket.http") -local logger = require("awesomewm-d-tl.logger") +local logger = require("awesomewmdtl.logger") local tablex = require("pl.tablex") local log = logger.log("crawler") diff --git a/src/awesomewm-d-tl/dag.tl b/src/awesomewmdtl/dag.tl similarity index 78% rename from src/awesomewm-d-tl/dag.tl rename to src/awesomewmdtl/dag.tl index 3211675..3a86ec3 100644 --- a/src/awesomewm-d-tl/dag.tl +++ b/src/awesomewmdtl/dag.tl @@ -1,6 +1,6 @@ -local type Dag = require("awesomewm-d-tl.types.Dag") -local type Node = require("awesomewm-d-tl.types.Node") -local utils = require("awesomewm-d-tl.utils") +local type Dag = require("awesomewmdtl.types.Dag") +local type Node = require("awesomewmdtl.types.Node") +local utils = require("awesomewmdtl.utils") local function new(): Dag local dag : Dag = { diff --git a/src/awesomewm-d-tl/entity/Function_Info.tl b/src/awesomewmdtl/entity/Function_Info.tl similarity index 93% rename from src/awesomewm-d-tl/entity/Function_Info.tl rename to src/awesomewmdtl/entity/Function_Info.tl index 24029a9..93f9203 100644 --- a/src/awesomewm-d-tl/entity/Function_Info.tl +++ b/src/awesomewmdtl/entity/Function_Info.tl @@ -1,8 +1,8 @@ local List = require("pl.List") local Map = require("pl.Map") -local Type_Info = require("awesomewm-d-tl.entity.Type_Info") -local Variable_Info = require("awesomewm-d-tl.entity.Variable_Info") -local utils = require("awesomewm-d-tl.utils") +local Type_Info = require("awesomewmdtl.entity.Type_Info") +local Variable_Info = require("awesomewmdtl.entity.Variable_Info") +local utils = require("awesomewmdtl.utils") local record Function_Info metamethod __call: function( diff --git a/src/awesomewm-d-tl/entity/Module_Doc.tl b/src/awesomewmdtl/entity/Module_Doc.tl similarity index 96% rename from src/awesomewm-d-tl/entity/Module_Doc.tl rename to src/awesomewmdtl/entity/Module_Doc.tl index 4c627fb..e004e2d 100644 --- a/src/awesomewm-d-tl/entity/Module_Doc.tl +++ b/src/awesomewmdtl/entity/Module_Doc.tl @@ -1,7 +1,7 @@ -local Function_Info = require("awesomewm-d-tl.entity.Function_Info") +local Function_Info = require("awesomewmdtl.entity.Function_Info") local List = require("pl.List") local Map = require("pl.Map") -local Variable_Info = require("awesomewm-d-tl.entity.Variable_Info") +local Variable_Info = require("awesomewmdtl.entity.Variable_Info") local module_to_require : Map = Map({ Shape = "gears.shape", diff --git a/src/awesomewm-d-tl/entity/Module_Info.tl b/src/awesomewmdtl/entity/Module_Info.tl similarity index 100% rename from src/awesomewm-d-tl/entity/Module_Info.tl rename to src/awesomewmdtl/entity/Module_Info.tl diff --git a/src/awesomewm-d-tl/entity/Type_Info.tl b/src/awesomewmdtl/entity/Type_Info.tl similarity index 100% rename from src/awesomewm-d-tl/entity/Type_Info.tl rename to src/awesomewmdtl/entity/Type_Info.tl diff --git a/src/awesomewm-d-tl/entity/Variable_Info.tl b/src/awesomewmdtl/entity/Variable_Info.tl similarity index 92% rename from src/awesomewm-d-tl/entity/Variable_Info.tl rename to src/awesomewmdtl/entity/Variable_Info.tl index 742af51..628be3d 100644 --- a/src/awesomewm-d-tl/entity/Variable_Info.tl +++ b/src/awesomewmdtl/entity/Variable_Info.tl @@ -1,5 +1,5 @@ local List = require("pl.List") -local Type_Info = require("awesomewm-d-tl.entity.Type_Info") +local Type_Info = require("awesomewmdtl.entity.Type_Info") local record Variable_Info metamethod __call: function(self: Variable_Info, name: string | nil, types: List | nil): Variable_Info diff --git a/src/awesomewm-d-tl/filesystem/file_writer.tl b/src/awesomewmdtl/filesystem/file_writer.tl similarity index 96% rename from src/awesomewm-d-tl/filesystem/file_writer.tl rename to src/awesomewmdtl/filesystem/file_writer.tl index b61c865..e07f545 100644 --- a/src/awesomewm-d-tl/filesystem/file_writer.tl +++ b/src/awesomewmdtl/filesystem/file_writer.tl @@ -1,6 +1,6 @@ local file = require("pl.file") local lfs = require("lfs") -local logger = require("awesomewm-d-tl.logger") +local logger = require("awesomewmdtl.logger") local path = require("pl.path") local log = logger.log("file_writer") diff --git a/src/awesomewmdtl/filesystem/init.tl b/src/awesomewmdtl/filesystem/init.tl new file mode 100644 index 0000000..b1b6951 --- /dev/null +++ b/src/awesomewmdtl/filesystem/init.tl @@ -0,0 +1,3 @@ +return { + file_writer = require("awesomewmdtl.filesystem.file_writer"), +} diff --git a/src/awesomewm-d-tl/init.tl b/src/awesomewmdtl/init.tl similarity index 85% rename from src/awesomewm-d-tl/init.tl rename to src/awesomewmdtl/init.tl index 8d08a1d..6459ef8 100644 --- a/src/awesomewm-d-tl/init.tl +++ b/src/awesomewmdtl/init.tl @@ -2,22 +2,22 @@ if os.getenv("LOCAL_LUA_DEBUGGER_VSCODE") == "1" then require("lldebugger").start() end -local ast = require("awesomewm-d-tl.ast") -local crawler = require("awesomewm-d-tl.crawler") -local dag = require("awesomewm-d-tl.dag") -local filesystem = require("awesomewm-d-tl.filesystem") -local printer = require("awesomewm-d-tl.printer") +local ast = require("awesomewmdtl.ast") +local crawler = require("awesomewmdtl.crawler") +local dag = require("awesomewmdtl.dag") +local filesystem = require("awesomewmdtl.filesystem") +local printer = require("awesomewmdtl.printer") local List = require("pl.List") -local logger = require("awesomewm-d-tl.logger") +local logger = require("awesomewmdtl.logger") local Map = require("pl.Map") -local Module_Info = require("awesomewm-d-tl.entity.Module_Info") -local module_dependencies = require("awesomewm-d-tl.visitors.module_dependencies") -local type Node = require("awesomewm-d-tl.types.Node") -local property = require("awesomewm-d-tl.property") -local scraper = require("awesomewm-d-tl.scraper") +local Module_Info = require("awesomewmdtl.entity.Module_Info") +local module_dependencies = require("awesomewmdtl.visitors.module_dependencies") +local type Node = require("awesomewmdtl.types.Node") +local property = require("awesomewmdtl.property") +local scraper = require("awesomewmdtl.scraper") local stringx = require("pl.stringx") -local type_mapping = require("awesomewm-d-tl.visitors.type_mapping") -local utils = require("awesomewm-d-tl.utils") +local type_mapping = require("awesomewmdtl.visitors.type_mapping") +local utils = require("awesomewmdtl.utils") local log = logger.log("main") diff --git a/src/awesomewm-d-tl/logger/init.tl b/src/awesomewmdtl/logger/init.tl similarity index 100% rename from src/awesomewm-d-tl/logger/init.tl rename to src/awesomewmdtl/logger/init.tl diff --git a/src/awesomewm-d-tl/printer/global_env_def.tl b/src/awesomewmdtl/printer/global_env_def.tl similarity index 88% rename from src/awesomewm-d-tl/printer/global_env_def.tl rename to src/awesomewmdtl/printer/global_env_def.tl index 8e54ca8..de98eb8 100644 --- a/src/awesomewm-d-tl/printer/global_env_def.tl +++ b/src/awesomewmdtl/printer/global_env_def.tl @@ -1,8 +1,8 @@ local List = require("pl.List") -local Module_Doc = require("awesomewm-d-tl.entity.Module_Doc") +local Module_Doc = require("awesomewmdtl.entity.Module_Doc") local template = require("pl.template") -local utils = require("awesomewm-d-tl.utils") -local snippets = require("awesomewm-d-tl.printer.snippets") +local utils = require("awesomewmdtl.utils") +local snippets = require("awesomewmdtl.printer.snippets") -- The long therm goal is to have so many `snippets.render_*` functions that -- we can render the whole file with the smallest template possible. diff --git a/src/awesomewmdtl/printer/init.tl b/src/awesomewmdtl/printer/init.tl new file mode 100644 index 0000000..1a8fd07 --- /dev/null +++ b/src/awesomewmdtl/printer/init.tl @@ -0,0 +1,6 @@ +return { + global_env_def = require("awesomewmdtl.printer.global_env_def"), + module_init_definition = require("awesomewmdtl.printer.module_init_definition"), + snippets = require("awesomewmdtl.printer.snippets"), + teal_type_definition = require("awesomewmdtl.printer.teal_type_definition"), +} diff --git a/src/awesomewm-d-tl/printer/module_init_definition.tl b/src/awesomewmdtl/printer/module_init_definition.tl similarity index 84% rename from src/awesomewm-d-tl/printer/module_init_definition.tl rename to src/awesomewmdtl/printer/module_init_definition.tl index 88c324a..db0d1ea 100644 --- a/src/awesomewm-d-tl/printer/module_init_definition.tl +++ b/src/awesomewmdtl/printer/module_init_definition.tl @@ -1,7 +1,7 @@ local Map = require("pl.Map") local template = require("pl.template") -local utils = require("awesomewm-d-tl.utils") -local snippets = require("awesomewm-d-tl.printer.snippets") +local utils = require("awesomewmdtl.utils") +local snippets = require("awesomewmdtl.printer.snippets") -- The long therm goal is to have so many `snippets.render_*` functions that -- we can render the whole file with the smallest template possible. diff --git a/src/awesomewm-d-tl/printer/snippets.tl b/src/awesomewmdtl/printer/snippets.tl similarity index 95% rename from src/awesomewm-d-tl/printer/snippets.tl rename to src/awesomewmdtl/printer/snippets.tl index 6460d0b..e86e232 100644 --- a/src/awesomewm-d-tl/printer/snippets.tl +++ b/src/awesomewmdtl/printer/snippets.tl @@ -1,11 +1,11 @@ -local Function_Info = require("awesomewm-d-tl.entity.Function_Info") +local Function_Info = require("awesomewmdtl.entity.Function_Info") local List = require("pl.List") local Map = require("pl.Map") local stringx = require("pl.stringx") local template = require("pl.template") -local Type_Info = require("awesomewm-d-tl.entity.Type_Info") -local utils = require("awesomewm-d-tl.utils") -local Variable_Info = require("awesomewm-d-tl.entity.Variable_Info") +local Type_Info = require("awesomewmdtl.entity.Type_Info") +local utils = require("awesomewmdtl.utils") +local Variable_Info = require("awesomewmdtl.entity.Variable_Info") local record Module indent: function(str: string, level: number): string diff --git a/src/awesomewm-d-tl/printer/teal_type_definition.tl b/src/awesomewmdtl/printer/teal_type_definition.tl similarity index 96% rename from src/awesomewm-d-tl/printer/teal_type_definition.tl rename to src/awesomewmdtl/printer/teal_type_definition.tl index bb5c4bf..32bfd51 100644 --- a/src/awesomewm-d-tl/printer/teal_type_definition.tl +++ b/src/awesomewmdtl/printer/teal_type_definition.tl @@ -1,8 +1,8 @@ -local ast = require("awesomewm-d-tl.ast") -local logger = require("awesomewm-d-tl.logger") -local type Node = require("awesomewm-d-tl.types.Node") +local ast = require("awesomewmdtl.ast") +local logger = require("awesomewmdtl.logger") +local type Node = require("awesomewmdtl.types.Node") local stringx = require("pl.stringx") -local utils = require("awesomewm-d-tl.utils") +local utils = require("awesomewmdtl.utils") local log = logger.log("scraper") diff --git a/src/awesomewm-d-tl/property.tl b/src/awesomewmdtl/property.tl similarity index 100% rename from src/awesomewm-d-tl/property.tl rename to src/awesomewmdtl/property.tl diff --git a/src/awesomewmdtl/scraper/init.tl b/src/awesomewmdtl/scraper/init.tl new file mode 100644 index 0000000..02d4bd4 --- /dev/null +++ b/src/awesomewmdtl/scraper/init.tl @@ -0,0 +1,5 @@ +return { + module_doc = require("awesomewmdtl.scraper.module_doc"), + module_info_list = require("awesomewmdtl.scraper.module_info_list"), + utils = require("awesomewmdtl.scraper.utils"), +} diff --git a/src/awesomewm-d-tl/scraper/module_doc.tl b/src/awesomewmdtl/scraper/module_doc.tl similarity index 97% rename from src/awesomewm-d-tl/scraper/module_doc.tl rename to src/awesomewmdtl/scraper/module_doc.tl index d48e217..155376f 100644 --- a/src/awesomewm-d-tl/scraper/module_doc.tl +++ b/src/awesomewmdtl/scraper/module_doc.tl @@ -1,10 +1,10 @@ -local ast = require("awesomewm-d-tl.ast") -local type Node = require("awesomewm-d-tl.types.Node") -local logger = require("awesomewm-d-tl.logger") +local ast = require("awesomewmdtl.ast") +local type Node = require("awesomewmdtl.types.Node") +local logger = require("awesomewmdtl.logger") local scan = require("web_sanitize.query.scan_html") -local scraper_utils = require("awesomewm-d-tl.scraper.utils") +local scraper_utils = require("awesomewmdtl.scraper.utils") local stringx = require("pl.stringx") -local utils = require("awesomewm-d-tl.utils") +local utils = require("awesomewmdtl.utils") local log = logger.log("scraper") diff --git a/src/awesomewm-d-tl/scraper/module_info_list.tl b/src/awesomewmdtl/scraper/module_info_list.tl similarity index 77% rename from src/awesomewm-d-tl/scraper/module_info_list.tl rename to src/awesomewmdtl/scraper/module_info_list.tl index 4137ec3..142f934 100644 --- a/src/awesomewm-d-tl/scraper/module_info_list.tl +++ b/src/awesomewmdtl/scraper/module_info_list.tl @@ -1,7 +1,7 @@ -local Module_Info = require("awesomewm-d-tl.entity.Module_Info") +local Module_Info = require("awesomewmdtl.entity.Module_Info") local scan = require("web_sanitize.query.scan_html") -local scraper_utils = require("awesomewm-d-tl.scraper.utils") -local utils = require("awesomewm-d-tl.utils") +local scraper_utils = require("awesomewmdtl.scraper.utils") +local utils = require("awesomewmdtl.utils") local module = {} diff --git a/src/awesomewm-d-tl/scraper/utils.tl b/src/awesomewmdtl/scraper/utils.tl similarity index 98% rename from src/awesomewm-d-tl/scraper/utils.tl rename to src/awesomewmdtl/scraper/utils.tl index 858246c..5f5983f 100644 --- a/src/awesomewm-d-tl/scraper/utils.tl +++ b/src/awesomewmdtl/scraper/utils.tl @@ -1,5 +1,5 @@ local List = require("pl.List") -local logger = require("awesomewm-d-tl.logger") +local logger = require("awesomewmdtl.logger") local Map = require("pl.Map") local scan = require("web_sanitize.query.scan_html") local scanner = require("web_sanitize.query.scan_html") diff --git a/src/awesomewm-d-tl/types/Dag.tl b/src/awesomewmdtl/types/Dag.tl similarity index 76% rename from src/awesomewm-d-tl/types/Dag.tl rename to src/awesomewmdtl/types/Dag.tl index 3ae193a..b8719cc 100644 --- a/src/awesomewm-d-tl/types/Dag.tl +++ b/src/awesomewmdtl/types/Dag.tl @@ -1,4 +1,4 @@ -local type Node = require("awesomewm-d-tl.types.Node") +local type Node = require("awesomewmdtl.types.Node") local record Dag modules: { string : Node } -- module_path (AKA "full name" `package.module.name`) -> root_node (token = "module") diff --git a/src/awesomewm-d-tl/types/Node.tl b/src/awesomewmdtl/types/Node.tl similarity index 100% rename from src/awesomewm-d-tl/types/Node.tl rename to src/awesomewmdtl/types/Node.tl diff --git a/src/awesomewm-d-tl/utils.tl b/src/awesomewmdtl/utils.tl similarity index 97% rename from src/awesomewm-d-tl/utils.tl rename to src/awesomewmdtl/utils.tl index 4387fd7..1c57b26 100644 --- a/src/awesomewm-d-tl/utils.tl +++ b/src/awesomewmdtl/utils.tl @@ -63,7 +63,7 @@ end -- At some point, we should probably write a wrapper to make penlight's function work with pcalls. function utils.do_or_fail(func: function(...: any): (T | nil, string), ...: any): T - local logger = require("awesomewm-d-tl.logger") + local logger = require("awesomewmdtl.logger") local log = logger.log("utils") local ok, res, err = pcall(func, ...) diff --git a/src/awesomewm-d-tl/visitors/module_dependencies.tl b/src/awesomewmdtl/visitors/module_dependencies.tl similarity index 91% rename from src/awesomewm-d-tl/visitors/module_dependencies.tl rename to src/awesomewmdtl/visitors/module_dependencies.tl index c8cd170..24365ef 100644 --- a/src/awesomewm-d-tl/visitors/module_dependencies.tl +++ b/src/awesomewmdtl/visitors/module_dependencies.tl @@ -1,6 +1,6 @@ -local type Dag = require("awesomewm-d-tl.types.Dag") -local type Node = require("awesomewm-d-tl.types.Node") -local utils = require("awesomewm-d-tl.utils") +local type Dag = require("awesomewmdtl.types.Dag") +local type Node = require("awesomewmdtl.types.Node") +local utils = require("awesomewmdtl.utils") local spread = utils.spread diff --git a/src/awesomewm-d-tl/visitors/type_mapping.tl b/src/awesomewmdtl/visitors/type_mapping.tl similarity index 96% rename from src/awesomewm-d-tl/visitors/type_mapping.tl rename to src/awesomewmdtl/visitors/type_mapping.tl index c901c94..877a054 100644 --- a/src/awesomewm-d-tl/visitors/type_mapping.tl +++ b/src/awesomewmdtl/visitors/type_mapping.tl @@ -1,4 +1,4 @@ -local type Node = require("awesomewm-d-tl.types.Node") +local type Node = require("awesomewmdtl.types.Node") -- Special types I don't want to deal with for now local gears_shape_function = "function(cr: any, width: integer, height: integer)" From a036df9c5f831467a1d3916148c343fb4c42fe79 Mon Sep 17 00:00:00 2001 From: Aire-One Date: Mon, 18 Sep 2023 12:22:05 +0200 Subject: [PATCH 11/16] chore: configure tests in luarocks --- awesomewmdtl-dev-1.rockspec | 7 +++++++ justfile | 6 +++++- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/awesomewmdtl-dev-1.rockspec b/awesomewmdtl-dev-1.rockspec index 8d1a48b..aaffe00 100644 --- a/awesomewmdtl-dev-1.rockspec +++ b/awesomewmdtl-dev-1.rockspec @@ -18,6 +18,13 @@ dependencies = { "luasec 1.2.0-1", "luafilesystem 1.8.0-1", } +test_dependencies = { + "busted", + "busted-tl" +} +test = { + type = "busted", +} build_dependencies = { "cyan", } diff --git a/justfile b/justfile index 80746f5..3b9bee4 100644 --- a/justfile +++ b/justfile @@ -57,7 +57,11 @@ validate: # `find . -type f -iname '*.d.tl' | xargs` test PATTERN="_spec": - busted --pattern={{ PATTERN }} + luarocks \ + --lua-version {{ lua_version }} \ + test \ + {{ rockspec_file }} \ + -- --pattern={{ PATTERN }} # Requires a patched version of luacov (https://github.com/lunarmodules/luacov/issues/98#issuecomment-1530491759) coverage: From 6f6c4eca0ddad214f8d47c7d45bb14f5dcf7e4bd Mon Sep 17 00:00:00 2001 From: Aire-One Date: Mon, 18 Sep 2023 12:34:37 +0200 Subject: [PATCH 12/16] ci(test): install dependencies only once --- .woodpecker/test.yml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.woodpecker/test.yml b/.woodpecker/test.yml index 11eaa9c..b5e1947 100644 --- a/.woodpecker/test.yml +++ b/.woodpecker/test.yml @@ -5,9 +5,7 @@ pipeline: prepare: image: *busted commands: - - just local-install-dependencies - # TODO : understand why busted can't resolve the dependency in the CI environment - # - luarocks install --only-deps awesomewmdtl-dev-1.rockspec + - luarocks install --only-deps awesomewmdtl-dev-1.rockspec test: image: *busted commands: From cac7b0a00a85bf72a6070d802e64ba8182f013e8 Mon Sep 17 00:00:00 2001 From: Aire-One Date: Mon, 18 Sep 2023 14:00:18 +0200 Subject: [PATCH 13/16] ci: fix test and build dependencies install --- .woodpecker/build.yml | 4 ---- .woodpecker/test.yml | 4 ---- justfile | 5 ++++- 3 files changed, 4 insertions(+), 9 deletions(-) diff --git a/.woodpecker/build.yml b/.woodpecker/build.yml index 2621add..1bf3db0 100644 --- a/.woodpecker/build.yml +++ b/.woodpecker/build.yml @@ -2,10 +2,6 @@ variables: - &cyan gitea.aireone.xyz/aire-one/awesomewm.d.tl/cyan:latest pipeline: - prepare: - image: *cyan - commands: - - luarocks install --only-deps awesomewmdtl-dev-1.rockspec build: image: *cyan commands: diff --git a/.woodpecker/test.yml b/.woodpecker/test.yml index b5e1947..cc2eb1b 100644 --- a/.woodpecker/test.yml +++ b/.woodpecker/test.yml @@ -2,10 +2,6 @@ variables: - &busted gitea.aireone.xyz/aire-one/awesomewm.d.tl/busted-tl_just:latest pipeline: - prepare: - image: *busted - commands: - - luarocks install --only-deps awesomewmdtl-dev-1.rockspec test: image: *busted commands: diff --git a/justfile b/justfile index 3b9bee4..90e8541 100644 --- a/justfile +++ b/justfile @@ -41,7 +41,10 @@ check-rockspecs: check: check-lua check-format check-teal check-rockspecs build: - cyan build + luarocks \ + --lua-version {{ lua_version }} \ + make \ + {{ rockspec_file }} clean: rm -rf build From 9a75c18f4eca55900f74265da9fd63021cae8d8e Mon Sep 17 00:00:00 2001 From: Aire-One Date: Mon, 18 Sep 2023 14:18:58 +0200 Subject: [PATCH 14/16] chore(just): define local build and test targets --- justfile | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/justfile b/justfile index 90e8541..6fdfa40 100644 --- a/justfile +++ b/justfile @@ -46,6 +46,13 @@ build: make \ {{ rockspec_file }} +local-build: + luarocks \ + --lua-version {{ lua_version }} \ + make \ + --tree {{ rocks_tree }} \ + {{ rockspec_file }} + clean: rm -rf build @@ -66,6 +73,14 @@ test PATTERN="_spec": {{ rockspec_file }} \ -- --pattern={{ PATTERN }} +local-test PATTERN="_spec": + luarocks \ + --lua-version {{ lua_version }} \ + test \ + --tree {{ rocks_tree }} \ + {{ rockspec_file }} \ + -- --pattern={{ PATTERN }} + # Requires a patched version of luacov (https://github.com/lunarmodules/luacov/issues/98#issuecomment-1530491759) coverage: busted --coverage From 0e44793bd99675f634f613e05eba4a5cf9445822 Mon Sep 17 00:00:00 2001 From: Aire-One Date: Mon, 18 Sep 2023 14:47:18 +0200 Subject: [PATCH 15/16] chore: move bin inside src --- awesomewmdtl-dev-1.rockspec | 2 +- bin/awesomewmdtl | 3 --- src/bin/awesomewmdtl | 3 +++ 3 files changed, 4 insertions(+), 4 deletions(-) delete mode 100755 bin/awesomewmdtl create mode 100755 src/bin/awesomewmdtl diff --git a/awesomewmdtl-dev-1.rockspec b/awesomewmdtl-dev-1.rockspec index aaffe00..430d2e6 100644 --- a/awesomewmdtl-dev-1.rockspec +++ b/awesomewmdtl-dev-1.rockspec @@ -33,7 +33,7 @@ build = { build_command = "cyan build", install = { bin = { - "bin/awesomewmdtl", + "src/bin/awesomewmdtl", }, lua = { ["awesomewmdtl.crawler.init"] = "build/awesomewmdtl/crawler/init.lua", diff --git a/bin/awesomewmdtl b/bin/awesomewmdtl deleted file mode 100755 index 4bf0d3e..0000000 --- a/bin/awesomewmdtl +++ /dev/null @@ -1,3 +0,0 @@ -#!/usr/bin/env lua - -local a = require("awesomewmdtl") diff --git a/src/bin/awesomewmdtl b/src/bin/awesomewmdtl new file mode 100755 index 0000000..5c67c85 --- /dev/null +++ b/src/bin/awesomewmdtl @@ -0,0 +1,3 @@ +#!/usr/bin/env lua + +require("awesomewmdtl") From 94f233325d41169916a2c3edd6481bf77c373201 Mon Sep 17 00:00:00 2001 From: Aire-One Date: Mon, 18 Sep 2023 15:02:09 +0200 Subject: [PATCH 16/16] chore: update README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ee21b00..0f6df88 100644 --- a/README.md +++ b/README.md @@ -24,10 +24,10 @@ Note that additional dependencies are installed as rocks with Luarocks. ```sh # Install rocks -just install +just local-install # Run the main script just run ``` -Custom settings for the project can be changed in the `src/awesomewm.d.tl/properties.lua` file. +Custom settings for the project can be changed in the `src/awesomewmdtl/properties.lua` file.