disma 0.11.0

Discord server management has never been easier!
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

<div align="center">

# Disma

[![Build](https://github.com/vigenere23/disma/actions/workflows/build.yml/badge.svg)](https://github.com/vigenere23/disma/actions/workflows/build.yml)
[![Crates.io](https://img.shields.io/crates/v/disma)](https://crates.io/crates/disma)

👨🏼‍🔧 Discord server management has never been easier!

</div>

## ⁉️ Why?

In the new context of the pandemic, many educational institutions have shifted their courses online, with the use of communication platforms like Discord. However, managing multiple roles and channels across a Discord server is challenging : there are no way to centrally visualize the information nor to apply synchronized permissions updates. This tool allows you to define a single configuration file to be applied to a server, and it will automatically find the changes that needs to be made, ensuring that your Discord will always be in synch with your config.

## ⭐ Features

- 📜 **Diff current Discord server config with your desired one**
- 🏗️ **Apply large scale changes to your Discord server**
- ⚡ **Fast, secure and reliable**

## Modules

- [disma](./disma) : Core Rust library for defining configuration as code and controlling your own orchestrations and implementations.
- [disma-cli](./disma-cli) : A stable and easy to use command line interface for defining configuration as simple YAML files. Still allows for templating to simplify the configuration.

## V1 Roadmap

### Features

- [x] Roles: add, update or remove roles
- [x] Categories: add, update or remove categories
- [x] Channels: add, update or remove channels
- [x] Allow additional roles, categories or members
- [ ] Members: invite or kick members ([#25](https://github.com/vigenere23/disma/issues/25))
- [ ] Other small but important features (see the [Stable features milestone](https://github.com/vigenere23/disma/milestone/2))

### Technical

- [ ] Bulletproof test all important concepts :
  - [ ] Diffs (comparisons)
  - [ ] Diff commands
  - [ ] Commands to requests convertion
  - [ ] Responses to existing guild convertion
  - [x] Config to awaiting guild convertion
  - [x] Existing guild to config convertion
- [ ] Exception handling strategies for :
  - [ ] Discord API
    - [ ] Server errors (Discord's end)
    - [ ] Permission errors (user's bot configuration) - see bug [#26](https://github.com/vigenere23/disma/issues/26)
  - [ ] Config validation
  - [ ] Runtime errors (ex: changes in existing state)
    - [ ] Fatal
    - [ ] Non-fatal

### Documentation

- [ ] Library
  - [ ] Rust doc (with doc-tests if needed)
- [ ] Cli
  - [ ] Examples
  - [ ] Guide
  - [ ] JSON and YAML schemas for config