Merge pull request '[Refactor] Development rockspec, Project structure and Entry point' (#84) from feat/#65 into master

Reviewed-on: #84

.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" },
    },

.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]

.gitignore

@@ -1,4 +1,4 @@
-lua_modules
+lua_modules/
-generated
+generated/
-build
+build/
-luacov
+luacov/

.vscode/settings.json

@@ -10,6 +10,7 @@
     "akorn",
     "ansicolors",
     "awesomewm",
+    "awesomewmdtl",
     "buildx",
     "concat",
     "dryrun",
@@ -34,6 +35,7 @@
     "modname",
     "reportfile",
     "rockspec",
+    "rockspecs",
     "rstrip",
     "runreport",
     "setopt",

.woodpecker/build.yml

@@ -2,10 +2,6 @@ variables:
   - &cyan gitea.aireone.xyz/aire-one/awesomewm.d.tl/cyan:latest
 
 pipeline:
-  prepare:
-    image: *cyan
-    commands:
-      - just install
   build:
     image: *cyan
     commands:

.woodpecker/lint.yml

@@ -9,14 +9,25 @@ variables:
     - "**/*.tl"
 
 pipeline:
-  lint-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
+  #   when:
+  #     path:
+  #       - ".woodpecker/**"
+
+  lint-rockspec:
+    image: gitea.aireone.xyz/aire-one/awesomewm.d.tl/luacheck_just:latest
     group: lint
     commands:
-      - woodpecker-cli lint .woodpecker/*.yml
+      - just check-rockspecs
     when:
       path:
         - ".woodpecker/**"
+        - "awesomewmdtl-dev-1.rockspec"
+        - "rockspec/*.rockspec"
 
   lint-lua:
     image: gitea.aireone.xyz/aire-one/awesomewm.d.tl/luacheck_just:latest

.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:
-      - just install
   test:
     image: *busted
     commands:

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.

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.

awesomewmdtl-dev-1.rockspec

@@ -0,0 +1,68 @@
+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",
+}
+test_dependencies = {
+   "busted",
+   "busted-tl"
+}
+test = {
+   type = "busted",
+}
+build_dependencies = {
+   "cyan",
+}
+build = {
+   type = "command",
+   build_command = "cyan build",
+   install = {
+      bin = {
+         "src/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",
+      },
+   },
+}

justfile

@@ -4,12 +4,13 @@ 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 := "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`
+rockspec_targets := `find {.,rockspecs} -maxdepth 1 -type f -iname '*.rockspec' | xargs`
 
-install:
+local-install-dependencies:
   luarocks \
     --lua-version {{ lua_version }} \
     install \
@@ -17,7 +18,7 @@ install:
     --only-deps \
     {{ rockspec_file }}
 
-uninstall:
+local-uninstall-dependencies:
   rm -rf {{ rocks_tree }}
 
 check-lua *FLAGS:
@@ -29,16 +30,34 @@ check-teal:
 check-format:
   stylua --check {{ lua_targets }}
 
-check: check-lua check-format check-teal
+check-rockspecs:
+  for rock in {{ rockspec_targets }}; do \
+    luarocks \
+      --lua-version {{ lua_version }} \
+      lint \
+      $rock ; \
+  done
+
+check: check-lua check-format check-teal check-rockspecs
 
 build:
-  cyan build
+  luarocks \
+    --lua-version {{ lua_version }} \
+    make \
+    {{ rockspec_file }}
+
+local-build:
+  luarocks \
+    --lua-version {{ lua_version }} \
+    make \
+    --tree {{ rocks_tree }} \
+    {{ rockspec_file }}
 
 clean:
   rm -rf build
 
 run:
-  {{ tl }} src/awesomewm.d.tl/init.tl
+  {{ tl }} src/awesomewmdtl/init.tl
 
 validate:
   cd generated && cyan \
@@ -48,7 +67,19 @@ validate:
 # `find . -type f -iname '*.d.tl' | xargs`
 
 test PATTERN="_spec":
-  busted --pattern={{ PATTERN }}
+  luarocks \
+    --lua-version {{ lua_version }} \
+    test \
+    {{ 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:

rockspecs/awesomewm.d.tl-dev-1.rockspec

@@ -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 = {},
-}

set_paths.lua

@@ -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

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

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")

spec/printer/teal_type_definition_spec.tl

@@ -1,7 +1,7 @@
-local assert = require("luassert")
+local assert <const> = require("luassert")
-local type Node = require("types.Node")
+local type Node = require("awesomewmdtl.types.Node")
-local stringx = require("pl.stringx")
+local stringx <const> = require("pl.stringx")
-local teal_type_definition_printer = require("printer.teal_type_definition")
+local teal_type_definition_printer <const> = require("awesomewmdtl.printer.teal_type_definition")
 
 local printer = teal_type_definition_printer.printer
 

spec/scraper/module_doc_spec.tl

@@ -1,6 +1,6 @@
-local assert = require("luassert")
+local assert <const> = require("luassert")
-local type Node = require("types.Node")
+local type Node = require("awesomewmdtl.types.Node")
-local scraper = require("scraper.module_doc")
+local scraper <const> = require("awesomewmdtl.scraper.module_doc")
 
 local get_doc_from_page = scraper.get_doc_from_page
 

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",
 }

src/awesomewm.d.tl/filesystem/init.tl

@@ -1,3 +0,0 @@
-return {
-   file_writer = require "filesystem.file_writer",
-}

src/awesomewm.d.tl/printer/init.tl

@@ -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"),
-}

src/awesomewm.d.tl/scraper/init.tl

@@ -1,5 +0,0 @@
-return {
-   module_doc = require "scraper.module_doc",
-   module_info_list = require "scraper.module_info_list",
-   utils = require "scraper.utils",
-}

src/awesomewmdtl/ast.tl

@@ -1,4 +1,4 @@
-local type Node = require("types.Node")
+local type Node = require("awesomewmdtl.types.Node")
 
 local basic_nodes <total>: { Node.Token : function(name: string, ...: any): Node } = {
    module = function(name: string, module_path: string): Node

src/awesomewmdtl/crawler/init.tl

@@ -1,7 +1,7 @@
-local file = require "pl.file"
+local file <const> = require("pl.file")
-local http = require "socket.http"
+local http <const> = require("socket.http")
-local logger = require "logger"
+local logger <const> = require("awesomewmdtl.logger")
-local tablex = require "pl.tablex"
+local tablex <const> = require("pl.tablex")
 
 local log = logger.log("crawler")
 

src/awesomewmdtl/dag.tl

@@ -1,6 +1,6 @@
-local type Dag = require("types.Dag")
+local type Dag = require("awesomewmdtl.types.Dag")
-local type Node = require("types.Node")
+local type Node = require("awesomewmdtl.types.Node")
-local utils = require("utils")
+local utils <const> = require("awesomewmdtl.utils")
 
 local function new(): Dag
    local dag <total>: Dag = {

src/awesomewmdtl/entity/Function_Info.tl

@@ -1,8 +1,8 @@
-local List = require "pl.List"
+local List <const> = require("pl.List")
-local Map = require "pl.Map"
+local Map <const> = require("pl.Map")
-local Type_Info = require "entity.Type_Info"
+local Type_Info <const> = require("awesomewmdtl.entity.Type_Info")
-local Variable_Info = require "entity.Variable_Info"
+local Variable_Info <const> = require("awesomewmdtl.entity.Variable_Info")
-local utils = require "utils"
+local utils <const> = require("awesomewmdtl.utils")
 
 local record Function_Info
    metamethod __call: function(

src/awesomewmdtl/entity/Module_Doc.tl

@@ -1,7 +1,7 @@
-local Function_Info = require "entity.Function_Info"
+local Function_Info <const> = require("awesomewmdtl.entity.Function_Info")
-local List = require "pl.List"
+local List <const> = require("pl.List")
-local Map = require "pl.Map"
+local Map <const> = require("pl.Map")
-local Variable_Info = require "entity.Variable_Info"
+local Variable_Info <const> = require("awesomewmdtl.entity.Variable_Info")
 
 local module_to_require <const> : Map<string, string> = Map({
    Shape = "gears.shape",

src/awesomewmdtl/entity/Variable_Info.tl

@@ -1,5 +1,5 @@
-local List = require "pl.List"
+local List <const> = require("pl.List")
-local Type_Info = require "entity.Type_Info"
+local Type_Info <const> = require("awesomewmdtl.entity.Type_Info")
 
 local record Variable_Info
    metamethod __call: function(self: Variable_Info, name: string | nil, types: List<Type_Info.Type_Info> | nil): Variable_Info

src/awesomewmdtl/filesystem/file_writer.tl

@@ -1,7 +1,7 @@
-local file = require "pl.file"
+local file <const> = require("pl.file")
-local lfs = require "lfs"
+local lfs <const> = require("lfs")
-local logger = require "logger"
+local logger <const> = require("awesomewmdtl.logger")
-local path = require "pl.path"
+local path <const> = require("pl.path")
 
 local log = logger.log("file_writer")
 

src/awesomewmdtl/filesystem/init.tl

@@ -0,0 +1,3 @@
+return {
+   file_writer = require("awesomewmdtl.filesystem.file_writer"),
+}

src/awesomewmdtl/init.tl

@@ -2,22 +2,22 @@ if os.getenv("LOCAL_LUA_DEBUGGER_VSCODE") == "1" then
    require("lldebugger").start()
 end
 
-local ast = require "ast"
+local ast <const> = require("awesomewmdtl.ast")
-local crawler = require "crawler"
+local crawler <const> = require("awesomewmdtl.crawler")
-local dag = require "dag"
+local dag <const> = require("awesomewmdtl.dag")
-local filesystem = require "filesystem"
+local filesystem <const> = require("awesomewmdtl.filesystem")
-local printer = require "printer"
+local printer <const> = require("awesomewmdtl.printer")
-local List = require "pl.List"
+local List <const> = require("pl.List")
-local logger = require "logger"
+local logger <const> = require("awesomewmdtl.logger")
-local Map = require "pl.Map"
+local Map <const> = require("pl.Map")
-local Module_Info = require "entity.Module_Info"
+local Module_Info <const> = require("awesomewmdtl.entity.Module_Info")
-local module_dependencies = require "visitors.module_dependencies"
+local module_dependencies <const> = require("awesomewmdtl.visitors.module_dependencies")
-local type Node = require "types.Node"
+local type Node = require("awesomewmdtl.types.Node")
-local property = require "property"
+local property <const> = require("awesomewmdtl.property")
-local scraper = require "scraper"
+local scraper <const> = require("awesomewmdtl.scraper")
-local stringx = require "pl.stringx"
+local stringx <const> = require("pl.stringx")
-local type_mapping = require "visitors.type_mapping"
+local type_mapping <const> = require("awesomewmdtl.visitors.type_mapping")
-local utils = require "utils"
+local utils <const> = require("awesomewmdtl.utils")
 
 local log = logger.log("main")
 

src/awesomewmdtl/logger/init.tl

@@ -1,7 +1,7 @@
-local ansicolors = require "ansicolors"
+local ansicolors <const> = require("ansicolors")
-local inspect = require "inspect"
+local inspect <const> = require("inspect")
-local Logging = require "logging"
+local Logging <const> = require("logging")
-local logging_console = require "logging.console"
+local logging_console <const> = require("logging.console")
 
 local function colorize(level: Logging.Level, message: string): string
    if level == "DEBUG" then

src/awesomewmdtl/printer/global_env_def.tl

@@ -1,8 +1,8 @@
-local List = require "pl.List"
+local List <const> = require("pl.List")
-local Module_Doc = require "entity.Module_Doc"
+local Module_Doc <const> = require("awesomewmdtl.entity.Module_Doc")
-local template = require "pl.template"
+local template <const> = require("pl.template")
-local utils = require "utils"
+local utils <const> = require("awesomewmdtl.utils")
-local snippets = require "printer.snippets"
+local snippets <const> = 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.

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"),
+}

src/awesomewmdtl/printer/module_init_definition.tl

@@ -1,7 +1,7 @@
-local Map = require "pl.Map"
+local Map <const> = require("pl.Map")
-local template = require "pl.template"
+local template <const> = require("pl.template")
-local utils = require "utils"
+local utils <const> = require("awesomewmdtl.utils")
-local snippets = require "printer.snippets"
+local snippets <const> = 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.

src/awesomewmdtl/printer/snippets.tl

@@ -1,11 +1,11 @@
-local Function_Info = require "entity.Function_Info"
+local Function_Info <const> = require("awesomewmdtl.entity.Function_Info")
-local List = require "pl.List"
+local List <const> = require("pl.List")
-local Map = require "pl.Map"
+local Map <const> = require("pl.Map")
-local stringx = require "pl.stringx"
+local stringx <const> = require("pl.stringx")
-local template = require "pl.template"
+local template <const> = require("pl.template")
-local Type_Info = require "entity.Type_Info"
+local Type_Info <const> = require("awesomewmdtl.entity.Type_Info")
-local utils = require "utils"
+local utils <const> = require("awesomewmdtl.utils")
-local Variable_Info = require "entity.Variable_Info"
+local Variable_Info <const> = require("awesomewmdtl.entity.Variable_Info")
 
 local record Module
    indent: function(str: string, level: number): string

src/awesomewmdtl/printer/teal_type_definition.tl

@@ -1,8 +1,8 @@
-local ast = require("ast")
+local ast = require("awesomewmdtl.ast")
-local logger = require("logger")
+local logger = require("awesomewmdtl.logger")
-local type Node = require("types.Node")
+local type Node = require("awesomewmdtl.types.Node")
 local stringx = require("pl.stringx")
-local utils = require("utils")
+local utils = require("awesomewmdtl.utils")
 
 local log = logger.log("scraper")
 

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"),
+}

src/awesomewmdtl/scraper/module_doc.tl

@@ -1,10 +1,10 @@
-local ast <const> = require("ast")
+local ast <const> = require("awesomewmdtl.ast")
-local type Node = require("types.Node")
+local type Node = require("awesomewmdtl.types.Node")
-local logger = require "logger"
+local logger <const> = require("awesomewmdtl.logger")
-local scan = require "web_sanitize.query.scan_html"
+local scan <const> = require("web_sanitize.query.scan_html")
-local scraper_utils = require "scraper.utils"
+local scraper_utils <const> = require("awesomewmdtl.scraper.utils")
-local stringx = require "pl.stringx"
+local stringx <const> = require("pl.stringx")
-local utils = require "utils"
+local utils <const> = require("awesomewmdtl.utils")
 
 local log = logger.log("scraper")
 

src/awesomewmdtl/scraper/module_info_list.tl

@@ -1,7 +1,7 @@
-local Module_Info = require "entity.Module_Info"
+local Module_Info <const> = require("awesomewmdtl.entity.Module_Info")
-local scan = require "web_sanitize.query.scan_html"
+local scan <const> = require("web_sanitize.query.scan_html")
-local scraper_utils = require "scraper.utils"
+local scraper_utils <const> = require("awesomewmdtl.scraper.utils")
-local utils = require "utils"
+local utils <const> = require("awesomewmdtl.utils")
 
 local module = {}
 

src/awesomewmdtl/scraper/utils.tl

@@ -1,9 +1,9 @@
-local List = require "pl.List"
+local List <const> = require("pl.List")
-local logger = require "logger"
+local logger <const> = require("awesomewmdtl.logger")
-local Map = require "pl.Map"
+local Map <const> = require("pl.Map")
-local scan = require "web_sanitize.query.scan_html"
+local scan <const> = require("web_sanitize.query.scan_html")
-local scanner = require "web_sanitize.query.scan_html"
+local scanner <const> = require("web_sanitize.query.scan_html")
-local tablex = require "pl.tablex"
+local tablex <const> = require("pl.tablex")
 
 local log = logger.log("scrapper")
 

src/awesomewmdtl/types/Dag.tl

@@ -1,4 +1,4 @@
-local type Node = require("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")

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<T>(func: function<T>(...: any): (T | nil, string), ...: any): T
-   local logger = require "logger"
+   local logger = require("awesomewmdtl.logger")
    local log = logger.log("utils")
 
    local ok, res, err = pcall(func, ...)

src/awesomewmdtl/visitors/module_dependencies.tl

@@ -1,6 +1,6 @@
-local type Dag = require("types.Dag")
+local type Dag = require("awesomewmdtl.types.Dag")
-local type Node = require("types.Node")
+local type Node = require("awesomewmdtl.types.Node")
-local utils = require("utils")
+local utils <const> = require("awesomewmdtl.utils")
 
 local spread = utils.spread
 

src/awesomewmdtl/visitors/type_mapping.tl

@@ -1,4 +1,4 @@
-local type Node = require("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)"

src/bin/awesomewmdtl

@@ -0,0 +1,3 @@
+#!/usr/bin/env lua
+
+require("awesomewmdtl")

tlconfig.lua

@@ -2,7 +2,7 @@ return {
    build_dir = "build",
    source_dir = "src",
    include_dir = {
-      "src/awesomewm.d.tl",
+      "src",
       "types",
    },
 }