chore(docs): update documentation to use the new import mechanism

draft/database/CMakeLists.txt

@@ -18,7 +18,7 @@ add_library(${PROJECT_NAME} SHARED ${SOURCE_FILES})
 
 target_link_libraries(${PROJECT_NAME} PRIVATE ArkReactor ${SQLite3_LIBRARIES})
 
-target_compile_features(ArkReactor PRIVATE cxx_std_20)
+target_compile_features(${PROJECT_NAME} PRIVATE cxx_std_20)
 
 add_custom_command(TARGET ${PROJECT_NAME}
     COMMAND ${CMAKE_COMMAND} -E copy

draft/database/tests/main.ark

@@ -1,4 +1,4 @@
-(import "database.arkm")
+(import database)
 
 (let db (database:sqlite:open "test.db"))
 

draft/http/CMakeLists.txt

@@ -19,7 +19,7 @@ add_library(${PROJECT_NAME} SHARED ${SOURCE_FILES})
 
 target_link_libraries(${PROJECT_NAME} PRIVATE ArkReactor OpenSSL::Crypto OpenSSL::SSL)
 
-target_compile_features(ArkReactor PRIVATE cxx_std_20)
+target_compile_features(${PROJECT_NAME} PRIVATE cxx_std_20)
 
 add_custom_command(TARGET ${PROJECT_NAME}
     COMMAND ${CMAKE_COMMAND} -E copy

draft/http/documentation/README.md

@@ -12,4 +12,4 @@ Disclaimer: this module does not handle
 * chunked transfer encoding
 * server-sent events
 * multiple servers per program
-* digest authentification (needs OpenSSL and libcrypto for that)
+* digest authentication (needs OpenSSL and libcrypto for that)

draft/http/documentation/client.md

@@ -26,7 +26,7 @@ They work as pairs with:
 
 ## http:client:create
 
-Create an http client to query a server.
+Create a http client to query a server.
 
 **Parameters**
 - `host`: string, you must not put the protocol `http://` nor `https://`
@@ -44,7 +44,7 @@ Create an http client to query a server.
 
 ## http:client:get
 
-Get content from an online ressource.
+Get content from an online resource.
 
 **Parameters**
 - `client`: `UserType<httpClient>`
@@ -176,7 +176,7 @@ It works like `http:headers:create`, you need to give an even number of Strings
 Convert an `httpParams` to an ArkScript readable list.
 
 **Parameters**
-- `httpParams`: UserType<Params>, can generated by the module with `http:params:create`
+- `httpParams`: UserType<Params>, can be generated by the module with `http:params:create`
 
 **Return value** `List`
 
@@ -248,7 +248,7 @@ Set the write timeout.
 
 ## http:client:setBasicAuth
 
-Set the basic authentification username and password for a client to use.
+Set the basic authentication username and password for a client to use.
 
 **Parameters**
 - `username`: string
@@ -261,7 +261,7 @@ Set the basic authentification username and password for a client to use.
 
 ## http:client:setBearerTokenAuth
 
-Set the basic bearer token authentification for a client to use.
+Set the basic bearer token authentication for a client to use.
 
 **Parameters**
 - `token`: string
@@ -298,7 +298,7 @@ Set the parameters (host and port) of a proxy, to be used by a client.
 
 ## http:client:setProxyBasicAuth
 
-Set the basic proxy authentification username and password for a client to use.
+Set the basic proxy authentication username and password for a client to use.
 
 **Parameters**
 - `username`: string
@@ -311,7 +311,7 @@ Set the basic proxy authentification username and password for a client to use.
 
 ## http:client:setProxyBearerTokenAuth
 
-Set the basic proxy bearer token authentification for a client to use.
+Set the basic proxy bearer token authentication for a client to use.
 
 **Parameters**
 - `token`: string

draft/http/documentation/server.md

@@ -4,7 +4,7 @@ Important note related to the routes: in case the given content argument doesn't
 
 ## http:server:create
 
-Create the server (only one per VM may be instanciated).
+Create the server (only one per VM may be instanced).
 
 **Parameters**
 - None.
@@ -16,7 +16,7 @@ Create the server (only one per VM may be instanciated).
 
 **Example**
 ~~~~{.lisp}
-(import "http.arkm")
+(import http)
 (http:server:create)
 ~~~~
 
@@ -30,7 +30,7 @@ Create the server (only one per VM may be instanciated).
 Create a route to answer the specified request type.
 
 **Parameters**
-- `route`: a string representing the route to handle. The route can receive matches with the regex syntax, eg `/(\\d+)` to match on numbers
+- `route`: a string representing the route to handle. The route can receive matches with the regex syntax, e.g. `/(\\d+)` to match on numbers
 - `handler`: a function returning a list `[status-code content type]`
     - `status-code`: number, representing an HTTP code
     - `content`: string
@@ -48,7 +48,7 @@ The typical `handler` function looks like this: `(fun (matches body params) ...)
 
 **Example**
 ~~~~{.lisp}
-(import "http.arkm")
+(import http)
 
 (http:server:create)
 (http:server:get "/hi" "this is my fabulous content" "text/plain")
@@ -79,7 +79,7 @@ Stop a server.
 
 **Example**
 ~~~~{.lisp}
-(import "http.arkm")
+(import http)
 
 (http:server:create)
 ...
@@ -94,7 +94,7 @@ Stop a server.
 
 ## http:server:listen
 
-Setup the server to listen forever. Should only be called once after having setup all the routes.
+Set up the server to listen forever. Should only be called once after having setup all the routes.
 
 **Parameters**
 - `host`: a string ; an IP address or `localhost`
@@ -107,7 +107,7 @@ Setup the server to listen forever. Should only be called once after having setu
 
 **Example**
 ~~~~{.lisp}
-(import "http.arkm")
+(import http)
 
 (http:server:create)
 
@@ -132,7 +132,7 @@ Mount a given directory to a specific location. You can mount a directory to mul
 
 **Example**
 ~~~~{.lisp}
-(import "http.arkm")
+(import http)
 
 (http:server:create)
 
@@ -149,7 +149,7 @@ Mount a given directory to a specific location. You can mount a directory to mul
 Remove a mount point.
 
 **Parameters**
-- `mountpoint`: string, a mountpoint name
+- `mountpoint`: string, a mount point name
 
 **Return value** `bool`, false if the mount point can't be found, true otherwise.
 
@@ -158,7 +158,7 @@ Remove a mount point.
 
 **Example**
 ~~~~{.lisp}
-(import "http.arkm")
+(import http)
 
 (http:server:create)
 
@@ -185,22 +185,22 @@ Map a file extension to a mimetype.
 
 Built-in mappings:
 
-Extension | MIME Type
---------- | ---------
-txt | text/plain
-html, htm | text/html
-css | text/css
-jpeg, jpg | image/jpg
-png | image/png
-gif | image/gif
-svg | image/svg+xml
-ico | image/x-icon
-json | application/json
-pdf | application/pdf
-js | application/javascript
-wasm | application/wasm
-xml | application/xml
-xhtml | application/xhtml+xml
+| Extension | MIME Type              |
+|-----------|------------------------|
+| txt       | text/plain             |
+| html, htm | text/html              |
+| css       | text/css               |
+| jpeg, jpg | image/jpg              |
+| png       | image/png              |
+| gif       | image/gif              |
+| svg       | image/svg+xml          |
+| ico       | image/x-icon           |
+| json      | application/json       |
+| pdf       | application/pdf        |
+| js        | application/javascript |
+| wasm      | application/wasm       |
+| xml       | application/xml        |
+| xhtml     | application/xhtml+xml  |
 
 **Author**
 - [@SuperFola](https://github.com/SuperFola)
@@ -227,7 +227,7 @@ Level 2 will add the request body as well.
 
 **Example**
 ~~~~{.lisp}
-(import "http.arkm")
+(import http)
 
 (http:server:create)
 

draft/json/CMakeLists.txt

@@ -16,7 +16,7 @@ add_library(${PROJECT_NAME} SHARED ${SOURCE_FILES})
 
 target_link_libraries(${PROJECT_NAME} PRIVATE ArkReactor)
 
-target_compile_features(ArkReactor PRIVATE cxx_std_20)
+target_compile_features(${PROJECT_NAME} PRIVATE cxx_std_20)
 
 add_custom_command(TARGET ${PROJECT_NAME}
     COMMAND ${CMAKE_COMMAND} -E copy

draft/json/tests/main.ark

@@ -1,4 +1,4 @@
-(import "json.arkm")
+(import json)
 
 (let json (json:open "test.json"))
 (let jsonString "{\"hello\":\"world\",\"key\":12}")

draft/msgpack/CMakeLists.txt

@@ -17,7 +17,7 @@ add_library(${PROJECT_NAME} SHARED ${SOURCE_FILES})
 
 target_link_libraries(${PROJECT_NAME} PRIVATE ArkReactor)
 
-target_compile_features(ArkReactor PRIVATE cxx_std_20)
+target_compile_features(${PROJECT_NAME} PRIVATE cxx_std_20)
 
 add_custom_command(TARGET ${PROJECT_NAME}
     COMMAND ${CMAKE_COMMAND} -E copy

draft/msgpack/documentation/Readme.md

@@ -14,7 +14,7 @@ A module for **msgpack**, an efficient binary serialization format like JSON, bu
 ### Example
 
 ``` clojure
-(import "msgpack.arkm")
+(import msgpack)
 
 # buffer
 (let sbuf (msgpack:sbuffer))

draft/msgpack/tests/main.ark

@@ -1,4 +1,4 @@
-(import "msgpack.arkm")
+(import msgpack)
 
 # buffer
 (let sbuf (msgpack:sbuffer))

src/bitwise/CMakeLists.txt

@@ -15,7 +15,7 @@ add_library(${PROJECT_NAME} SHARED ${SOURCE_FILES})
 
 target_link_libraries(${PROJECT_NAME} PRIVATE ArkReactor)
 
-target_compile_features(ArkReactor PRIVATE cxx_std_20)
+target_compile_features(${PROJECT_NAME} PRIVATE cxx_std_20)
 
 add_custom_command(TARGET ${PROJECT_NAME}
     COMMAND ${CMAKE_COMMAND} -E copy

src/bitwise/documentation/README.md

@@ -17,7 +17,7 @@ Right shifts a given number.
 
 **Example**
 ~~~~{.lisp}
-(import "bitwise.arkm")
+(import bitwise)
 (print (bitwise:rshift 4096 3))  # 512
 ~~~~
 
@@ -36,7 +36,7 @@ Left shifts a given number.
 
 **Example**
 ~~~~{.lisp}
-(import "bitwise.arkm")
+(import bitwise)
 (print (bitwise:lshift 512 3))  # 4096
 ~~~~
 
@@ -55,7 +55,7 @@ Xor a number given a mask.
 
 **Example**
 ~~~~{.lisp}
-(import "bitwise.arkm")
+(import bitwise)
 (print (bitwise:xor 99 13))  # 110
 ~~~~
 
@@ -74,7 +74,7 @@ Compute the bitwise `a OR b` operation.
 
 **Example**
 ~~~~{.lisp}
-(import "bitwise.arkm")
+(import bitwise)
 (print (bitwise:or 89 13))  # 93
 ~~~~
 
@@ -93,6 +93,6 @@ Compute the bitwise `a AND b` operation.
 
 **Example**
 ~~~~{.lisp}
-(import "bitwise.arkm")
+(import bitwise)
 (print (bitwise:and 89 13))  # 9
 ~~~~

src/bitwise/tests/main.ark

@@ -1,4 +1,4 @@
-(import "bitwise.arkm")
+(import bitwise)
 
 (assert (= 4 (bitwise:rshift 140 5)) "140 >> 5")
 (assert (= 8 (bitwise:rshift 140 4)) "140 >> 4")

src/console/CMakeLists.txt

@@ -15,7 +15,7 @@ add_library(${PROJECT_NAME} SHARED ${SOURCE_FILES})
 
 target_link_libraries(${PROJECT_NAME} PRIVATE ArkReactor)
 
-target_compile_features(ArkReactor PRIVATE cxx_std_20)
+target_compile_features(${PROJECT_NAME} PRIVATE cxx_std_20)
 
 add_custom_command(TARGET ${PROJECT_NAME}
     COMMAND ${CMAKE_COMMAND} -E copy

src/console/documentation/README.md

@@ -14,7 +14,7 @@ Clear the terminal on Windows and Posix.
 
 **Example**
 ~~~~{.lisp}
-(import "console.arkm")
+(import console)
 (print "hello world")  # hello world is printed
 (console:clear)        # now the whole terminal is empty and nothing is printed
 ~~~~
@@ -61,7 +61,7 @@ on_white
 
 **Example**
 ~~~~{.lisp}
-(import "console.arkm")
+(import console)
 (print "hello world")  # this is using the default color of the terminal
 (console:color "red")
 (print "this is in red")

src/console/tests/main.ark

@@ -1,4 +1,4 @@
-(import "console.arkm")
+(import console)
 
 # no tests to do as this is only visual and cosmetics
 

src/hash/CMakeLists.txt

@@ -16,7 +16,7 @@ add_library(${PROJECT_NAME} SHARED ${SOURCE_FILES})
 
 target_link_libraries(${PROJECT_NAME} PRIVATE ArkReactor)
 
-target_compile_features(ArkReactor PRIVATE cxx_std_20)
+target_compile_features(${PROJECT_NAME} PRIVATE cxx_std_20)
 
 add_custom_command(TARGET ${PROJECT_NAME}
     COMMAND ${CMAKE_COMMAND} -E copy

src/hash/documentation/README.md

@@ -14,7 +14,7 @@ Generates a SHA256 of a given string.
 
 **Example**
 ~~~~{.lisp}
-(import "hash.arkm")
+(import hash)
 (print (hash:sha256 "arkscript"))  # c56d0bb03e9e03e7000f7b596cdb333c315523af7e4781f02610c690441c43dd
 ~~~~
 
@@ -32,6 +32,6 @@ Generates a MD5 of a given string.
 
 **Example**
 ~~~~{.lisp}
-(import "hash.arkm")
+(import hash)
 (print (hash:md5 "arkscript"))  # a27ee01c49b7552b8d69a631b7bb23c9
 ~~~~

src/hash/tests/main.ark

@@ -1,4 +1,4 @@
-(import "hash.arkm")
+(import hash)
 
 (assert (= "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" (hash:sha256 "")) "sha256 ''")
 (assert (= "2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824" (hash:sha256 "hello")) "sha256 'hello'")