chore: remove special characters from module name

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

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

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

awesomewm-d-tl-dev-1.rockspec

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

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

bin/awesomewm-d-tl

@@ -1,3 +1,3 @@
 #!/usr/bin/env lua
 
-local a = require("awesomewm-d-tl")
+local a = require("awesomewmdtl")

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 \

spec/printer/teal_type_definition_spec.tl

@@ -1,7 +1,7 @@
 local assert <const> = require("luassert")
-local type Node = require("awesomewm-d-tl.types.Node")
+local type Node = require("awesomewmdtl.types.Node")
 local stringx <const> = require("pl.stringx")
-local teal_type_definition_printer <const> = require("awesomewm-d-tl.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 <const> = require("luassert")
-local type Node = require("awesomewm-d-tl.types.Node")
-local scraper <const> = require("awesomewm-d-tl.scraper.module_doc")
+local type Node = require("awesomewmdtl.types.Node")
+local scraper <const> = require("awesomewmdtl.scraper.module_doc")
 
 local get_doc_from_page = scraper.get_doc_from_page
 

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

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

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

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

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

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

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 <total>: { Node.Token : function(name: string, ...: any): Node } = {
    module = function(name: string, module_path: string): Node

src/awesomewmdtl/crawler/init.tl

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

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 <const> = require("awesomewm-d-tl.utils")
+local type Dag = require("awesomewmdtl.types.Dag")
+local type Node = require("awesomewmdtl.types.Node")
+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 <const> = require("pl.List")
 local Map <const> = require("pl.Map")
-local Type_Info <const> = require("awesomewm-d-tl.entity.Type_Info")
-local Variable_Info <const> = require("awesomewm-d-tl.entity.Variable_Info")
-local utils <const> = require("awesomewm-d-tl.utils")
+local Type_Info <const> = require("awesomewmdtl.entity.Type_Info")
+local Variable_Info <const> = require("awesomewmdtl.entity.Variable_Info")
+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 <const> = require("awesomewm-d-tl.entity.Function_Info")
+local Function_Info <const> = require("awesomewmdtl.entity.Function_Info")
 local List <const> = require("pl.List")
 local Map <const> = require("pl.Map")
-local Variable_Info <const> = require("awesomewm-d-tl.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 <const> = require("pl.List")
-local Type_Info <const> = require("awesomewm-d-tl.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,6 +1,6 @@
 local file <const> = require("pl.file")
 local lfs <const> = require("lfs")
-local logger <const> = require("awesomewm-d-tl.logger")
+local logger <const> = require("awesomewmdtl.logger")
 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 <const> = require("awesomewm-d-tl.ast")
-local crawler <const> = require("awesomewm-d-tl.crawler")
-local dag <const> = require("awesomewm-d-tl.dag")
-local filesystem <const> = require("awesomewm-d-tl.filesystem")
-local printer <const> = require("awesomewm-d-tl.printer")
+local ast <const> = require("awesomewmdtl.ast")
+local crawler <const> = require("awesomewmdtl.crawler")
+local dag <const> = require("awesomewmdtl.dag")
+local filesystem <const> = require("awesomewmdtl.filesystem")
+local printer <const> = require("awesomewmdtl.printer")
 local List <const> = require("pl.List")
-local logger <const> = require("awesomewm-d-tl.logger")
+local logger <const> = require("awesomewmdtl.logger")
 local Map <const> = require("pl.Map")
-local Module_Info <const> = require("awesomewm-d-tl.entity.Module_Info")
-local module_dependencies <const> = require("awesomewm-d-tl.visitors.module_dependencies")
-local type Node = require("awesomewm-d-tl.types.Node")
-local property <const> = require("awesomewm-d-tl.property")
-local scraper <const> = require("awesomewm-d-tl.scraper")
+local Module_Info <const> = require("awesomewmdtl.entity.Module_Info")
+local module_dependencies <const> = require("awesomewmdtl.visitors.module_dependencies")
+local type Node = require("awesomewmdtl.types.Node")
+local property <const> = require("awesomewmdtl.property")
+local scraper <const> = require("awesomewmdtl.scraper")
 local stringx <const> = require("pl.stringx")
-local type_mapping <const> = require("awesomewm-d-tl.visitors.type_mapping")
-local utils <const> = require("awesomewm-d-tl.utils")
+local type_mapping <const> = require("awesomewmdtl.visitors.type_mapping")
+local utils <const> = require("awesomewmdtl.utils")
 
 local log = logger.log("main")
 

src/awesomewmdtl/printer/global_env_def.tl

@@ -1,8 +1,8 @@
 local List <const> = require("pl.List")
-local Module_Doc <const> = require("awesomewm-d-tl.entity.Module_Doc")
+local Module_Doc <const> = require("awesomewmdtl.entity.Module_Doc")
 local template <const> = require("pl.template")
-local utils <const> = require("awesomewm-d-tl.utils")
-local snippets <const> = require("awesomewm-d-tl.printer.snippets")
+local utils <const> = require("awesomewmdtl.utils")
+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 <const> = require("pl.Map")
 local template <const> = require("pl.template")
-local utils <const> = require("awesomewm-d-tl.utils")
-local snippets <const> = require("awesomewm-d-tl.printer.snippets")
+local utils <const> = require("awesomewmdtl.utils")
+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 <const> = require("awesomewm-d-tl.entity.Function_Info")
+local Function_Info <const> = require("awesomewmdtl.entity.Function_Info")
 local List <const> = require("pl.List")
 local Map <const> = require("pl.Map")
 local stringx <const> = require("pl.stringx")
 local template <const> = require("pl.template")
-local Type_Info <const> = require("awesomewm-d-tl.entity.Type_Info")
-local utils <const> = require("awesomewm-d-tl.utils")
-local Variable_Info <const> = require("awesomewm-d-tl.entity.Variable_Info")
+local Type_Info <const> = require("awesomewmdtl.entity.Type_Info")
+local utils <const> = require("awesomewmdtl.utils")
+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("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")
 

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("awesomewm-d-tl.ast")
-local type Node = require("awesomewm-d-tl.types.Node")
-local logger <const> = require("awesomewm-d-tl.logger")
+local ast <const> = require("awesomewmdtl.ast")
+local type Node = require("awesomewmdtl.types.Node")
+local logger <const> = require("awesomewmdtl.logger")
 local scan <const> = require("web_sanitize.query.scan_html")
-local scraper_utils <const> = require("awesomewm-d-tl.scraper.utils")
+local scraper_utils <const> = require("awesomewmdtl.scraper.utils")
 local stringx <const> = require("pl.stringx")
-local utils <const> = require("awesomewm-d-tl.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 <const> = require("awesomewm-d-tl.entity.Module_Info")
+local Module_Info <const> = require("awesomewmdtl.entity.Module_Info")
 local scan <const> = require("web_sanitize.query.scan_html")
-local scraper_utils <const> = require("awesomewm-d-tl.scraper.utils")
-local utils <const> = require("awesomewm-d-tl.utils")
+local scraper_utils <const> = require("awesomewmdtl.scraper.utils")
+local utils <const> = require("awesomewmdtl.utils")
 
 local module = {}
 

src/awesomewmdtl/scraper/utils.tl

@@ -1,5 +1,5 @@
 local List <const> = require("pl.List")
-local logger <const> = require("awesomewm-d-tl.logger")
+local logger <const> = require("awesomewmdtl.logger")
 local Map <const> = require("pl.Map")
 local scan <const> = require("web_sanitize.query.scan_html")
 local scanner <const> = require("web_sanitize.query.scan_html")

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

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("awesomewm-d-tl.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("awesomewm-d-tl.types.Dag")
-local type Node = require("awesomewm-d-tl.types.Node")
-local utils <const> = require("awesomewm-d-tl.utils")
+local type Dag = require("awesomewmdtl.types.Dag")
+local type Node = require("awesomewmdtl.types.Node")
+local utils <const> = require("awesomewmdtl.utils")
 
 local spread = utils.spread
 

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