Software /
code /
prosody-modules
Annotate
CONTRIBUTING @ 6112:4c0e3fe57e92
mod_compliance_latest: Gracefull error logging on missing dependency.
diff --git a/mod_compliance_latest/README.md b/mod_compliance_latest/README.md
--- a/mod_compliance_latest/README.md
+++ b/mod_compliance_latest/README.md
@@ -9,13 +9,15 @@ rockspec:
# Introduction
-This module will always require and load to the lastest compliance tester we have in the community modules.
-Currently this is [mod_compliance_2023].
+This meta-module will always `require` (and therefore auto-load) the lastest compliance tester we have in the community modules.
+Currently this is [mod_compliance_2023]. See the linked module for further details.
+
+If you do not use the *Prosody plugin installer* this module will likely have limited value to you.
+You can also just install the current compliance tester manually.
# Configuration
-Just load this module as any other module and it will automatically install [mod_compliance_2023] if you use the Prosody plugin installer.
-See the linked module for further details.
+Just load this module as any other module and it will automatically install and load [mod_compliance_2023] if you use the *Prosody plugin installer*.
# Compatibility
diff --git a/mod_compliance_latest/mod_compliance_latest.lua b/mod_compliance_latest/mod_compliance_latest.lua
--- a/mod_compliance_latest/mod_compliance_latest.lua
+++ b/mod_compliance_latest/mod_compliance_latest.lua
@@ -1,1 +1,6 @@
-module:depends("compliance_2023");
+local success, err = pcall(function() module:depends("compliance_2023") end)
+
+if not success then
+ module:log("error", "Error, can't load module: mod_compliance_2023. Is this module downloaded in a folder readable by prosody?")
+ return 1, "Error: Couldn't load dependency mod_compliance_2023."
+end
author | Menel <menel@snikket.de> |
---|---|
date | Mon, 23 Dec 2024 12:58:03 +0100 |
parent | 1809:0b7d65b4f576 |
rev | line source |
---|---|
1669
a25d137439a7
Add README and CONTRIBUTING files containing the text from https://code.google.com/p/prosody-modules/
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
1 Contributing |
a25d137439a7
Add README and CONTRIBUTING files containing the text from https://code.google.com/p/prosody-modules/
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
2 ============ |
a25d137439a7
Add README and CONTRIBUTING files containing the text from https://code.google.com/p/prosody-modules/
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
3 |
a25d137439a7
Add README and CONTRIBUTING files containing the text from https://code.google.com/p/prosody-modules/
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
4 Guidelines for developers |
a25d137439a7
Add README and CONTRIBUTING files containing the text from https://code.google.com/p/prosody-modules/
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
5 ------------------------- |
a25d137439a7
Add README and CONTRIBUTING files containing the text from https://code.google.com/p/prosody-modules/
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
6 |
1809
0b7d65b4f576
CONTRIBUTING: Run through pandoc to normalize markdown syntax
Kim Alvefur <zash@zash.se>
parents:
1808
diff
changeset
|
7 - Each module should be contained in a folder of its name (e.g.\ |
0b7d65b4f576
CONTRIBUTING: Run through pandoc to normalize markdown syntax
Kim Alvefur <zash@zash.se>
parents:
1808
diff
changeset
|
8 `mod_ping/mod_ping.lua`) |
0b7d65b4f576
CONTRIBUTING: Run through pandoc to normalize markdown syntax
Kim Alvefur <zash@zash.se>
parents:
1808
diff
changeset
|
9 - Each module should have a `README.markdown` page in their folder |
0b7d65b4f576
CONTRIBUTING: Run through pandoc to normalize markdown syntax
Kim Alvefur <zash@zash.se>
parents:
1808
diff
changeset
|
10 with a description, usage, configuration and todo sections (feel |
0b7d65b4f576
CONTRIBUTING: Run through pandoc to normalize markdown syntax
Kim Alvefur <zash@zash.se>
parents:
1808
diff
changeset
|
11 free to copy an existing one as a template) |
0b7d65b4f576
CONTRIBUTING: Run through pandoc to normalize markdown syntax
Kim Alvefur <zash@zash.se>
parents:
1808
diff
changeset
|
12 - Commit messages should begin with the name of the plugin they are |
0b7d65b4f576
CONTRIBUTING: Run through pandoc to normalize markdown syntax
Kim Alvefur <zash@zash.se>
parents:
1808
diff
changeset
|
13 for (e.g. `mod_ping: Set correct namespace on pongs`) |
1669
a25d137439a7
Add README and CONTRIBUTING files containing the text from https://code.google.com/p/prosody-modules/
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
14 |
1809
0b7d65b4f576
CONTRIBUTING: Run through pandoc to normalize markdown syntax
Kim Alvefur <zash@zash.se>
parents:
1808
diff
changeset
|
15 Instructions on cloning the repository are at |
1808
e6e45ef1608b
CONTRIBUTING: Update guidelines and URL to hg repo
Kim Alvefur <zash@zash.se>
parents:
1669
diff
changeset
|
16 <https://prosody.im/doc/installing_modules#prosody-modules> |