Skip to content

Commit 098a42b

Browse files
seballotmrflos
authored andcommitted
run prettier linting
1 parent f29eeb4 commit 098a42b

File tree

91 files changed

+5600
-3249
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

91 files changed

+5600
-3249
lines changed

.github/CODE_OF_CONDUCT.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,19 @@ In the interest of fostering an open and welcoming environment, we as contributo
1010

1111
Examples of behavior that contributes to creating a positive environment include:
1212

13-
* Using welcoming and inclusive language
14-
* Being respectful of differing viewpoints and experiences
15-
* Gracefully accepting constructive criticism
16-
* Focusing on what is best for the community
17-
* Showing empathy towards other community members
13+
- Using welcoming and inclusive language
14+
- Being respectful of differing viewpoints and experiences
15+
- Gracefully accepting constructive criticism
16+
- Focusing on what is best for the community
17+
- Showing empathy towards other community members
1818

1919
Examples of unacceptable behavior by participants include:
2020

21-
* The use of sexualized language or imagery and unwelcome sexual attention or advances
22-
* Trolling, insulting/derogatory comments, and personal or political attacks
23-
* Public or private harassment
24-
* Publishing others' private information, such as a physical or electronic address, without explicit permission
25-
* Other conduct which could reasonably be considered inappropriate in a professional setting
21+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
22+
- Trolling, insulting/derogatory comments, and personal or political attacks
23+
- Public or private harassment
24+
- Publishing others' private information, such as a physical or electronic address, without explicit permission
25+
- Other conduct which could reasonably be considered inappropriate in a professional setting
2626

2727
## Our Responsibilities
2828

.github/CONTRIBUTING.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,9 @@ Interesting in contributing? Awesome!
44

55
**Quick Links:**
66

7-
* [Give your feedback](#give-your-feedback)
8-
* [Write documentation](#write-documentation)
9-
* [Develop](#develop)
10-
7+
- [Give your feedback](#give-your-feedback)
8+
- [Write documentation](#write-documentation)
9+
- [Develop](#develop)
1110

1211
## Give your feedback
1312

@@ -44,4 +43,4 @@ Then, just go in the browser to start the installation procedure.
4443
### Coding standards
4544

4645
It's a work in progress but we try to follow the [PHP PSR-2 standards](https://www.php-fig.org/psr/psr-2/).
47-
As for Javascript, a linter (like eslint) can be used to check the code.
46+
As for Javascript, a linter (like eslint) can be used to check the code.

.github/ISSUE_TEMPLATE/Custom.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ about: Describe a bug / Remonter un bogue
44
title: ''
55
labels: ''
66
assignees: ''
7-
87
---
98

109
> [!NOTE]
@@ -19,6 +18,7 @@ assignees: ''
1918
Explain the bug / expliquer le bogue
2019

2120
**Additionnal informations / Informations complémentaires**
21+
2222
- version of YesWiki / version de YesWiki
2323
- url to see the problem or an example / url pour voir le probleme ou un exemple
2424
- screenshot / capture d’écran

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
## Description of pull request / Description de la demande d'ajout
2+
23
Describe what it does / Expliquer ce que cela fait
34
Issue references (if exists)/ Demande associée (si elle existe)

SECURITY.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
The two last major versions of YesWiki are
66
currently being supported with security updates.
77

8-
| Version | Supported |
9-
| ------------------- | ------------------ |
10-
| doryphore 4.x | :white_check_mark: |
11-
| cercopitheque 3.x | :white_check_mark: |
12-
| bachibouzouk 2.x | :x: |
13-
| anacoluthe 1.x | :x: |
8+
| Version | Supported |
9+
| ----------------- | ------------------ |
10+
| doryphore 4.x | :white_check_mark: |
11+
| cercopitheque 3.x | :white_check_mark: |
12+
| bachibouzouk 2.x | :x: |
13+
| anacoluthe 1.x | :x: |
1414

1515
## Reporting a Vulnerability
1616

composer.json

Lines changed: 92 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -1,90 +1,98 @@
11
{
2-
"name": "yeswiki/yeswiki",
3-
"description": "A wiki system with extensions making collaboration more simple (databases, maps, easy editing, themes,...)",
4-
"homepage": "https://yeswiki.net",
5-
"license": "AGPL-3.0-or-later",
6-
"minimum-stability": "dev",
7-
"prefer-stable": true,
8-
"scripts": {
9-
"test": "bash tests/tests.sh",
10-
"post-install-cmd": [
11-
"@composer install --working-dir ./tools/autoupdate/",
12-
"YesWiki\\Core\\ComposerScriptsHelper::postInstall"
2+
"name": "yeswiki/yeswiki",
3+
"description": "A wiki system with extensions making collaboration more simple (databases, maps, easy editing, themes,...)",
4+
"homepage": "https://yeswiki.net",
5+
"license": "AGPL-3.0-or-later",
6+
"minimum-stability": "dev",
7+
"prefer-stable": true,
8+
"scripts": {
9+
"test": "bash tests/tests.sh",
10+
"post-install-cmd": [
11+
"@composer install --working-dir ./tools/autoupdate/",
12+
"YesWiki\\Core\\ComposerScriptsHelper::postInstall"
13+
],
14+
"post-update-cmd": [
15+
"@composer update --working-dir ./tools/autoupdate/",
16+
"YesWiki\\Core\\ComposerScriptsHelper::postUpdate"
17+
]
18+
},
19+
"require": {
20+
"php": "^7.3 || ^8.0",
21+
"ext-ctype": "*",
22+
"ext-curl": "*",
23+
"ext-fileinfo": "*",
24+
"ext-filter": "*",
25+
"ext-gd": "*",
26+
"ext-iconv": "*",
27+
"ext-json": "*",
28+
"ext-mbstring": "*",
29+
"ext-mysqli": "*",
30+
"ext-pcre": "*",
31+
"ext-zip": "^1.0",
32+
"caxy/php-htmldiff": "^0.1.13",
33+
"doctrine/annotations": "^1.11",
34+
"doctrine/cache": "^1.10",
35+
"enshrined/svg-sanitize": "^0.16.0",
36+
"ezyang/htmlpurifier": "^4.14",
37+
"jbroadway/urlify": "^1.2",
38+
"nesbot/carbon": "^2.66.0",
39+
"oomphinc/composer-installers-extender": "^2.0",
40+
"phpmailer/phpmailer": "^6.2",
41+
"stefangabos/zebra_image": "^2.7",
42+
"symfony/config": "^5.1",
43+
"symfony/console": "^5.2",
44+
"symfony/dependency-injection": "^5.1",
45+
"symfony/event-dispatcher": "^5.4",
46+
"symfony/http-foundation": "^5.1",
47+
"symfony/http-kernel": "^5.3.12",
48+
"symfony/process": "^5.4",
49+
"symfony/routing": "^5.1",
50+
"symfony/security-core": "^5.4",
51+
"symfony/security-csrf": "^5.0",
52+
"symfony/yaml": "^5.1",
53+
"tamtamchik/simple-flash": "^2.0",
54+
"twig/twig": "^3.4.3",
55+
"voku/anti-xss": "^4.1",
56+
"yeswiki/theme-margot": "^1.0"
57+
},
58+
"conflict": {},
59+
"extra": {
60+
"installer-types": [
61+
"yeswiki-extension",
62+
"yeswiki-theme"
63+
],
64+
"installer-paths": {
65+
"tools/{$name}": [
66+
"type:yeswiki-extension"
1367
],
14-
"post-update-cmd": [
15-
"@composer update --working-dir ./tools/autoupdate/",
16-
"YesWiki\\Core\\ComposerScriptsHelper::postUpdate"
68+
"themes/{$name}": [
69+
"type:yeswiki-theme"
1770
]
71+
}
72+
},
73+
"require-dev": {
74+
"friendsofphp/php-cs-fixer": "^3.4",
75+
"phpunit/phpunit": "^9",
76+
"symfony/var-dumper": "^5.1"
77+
},
78+
"config": {
79+
"allow-plugins": {
80+
"composer/installers": true,
81+
"oomphinc/composer-installers-extender": true
1882
},
19-
"require": {
20-
"php": "^7.3 || ^8.0",
21-
"ext-ctype": "*",
22-
"ext-curl": "*",
23-
"ext-fileinfo": "*",
24-
"ext-filter": "*",
25-
"ext-gd": "*",
26-
"ext-iconv": "*",
27-
"ext-json": "*",
28-
"ext-mbstring": "*",
29-
"ext-mysqli": "*",
30-
"ext-pcre": "*",
31-
"ext-zip": "^1.0",
32-
"caxy/php-htmldiff": "^0.1.13",
33-
"doctrine/annotations": "^1.11",
34-
"doctrine/cache": "^1.10",
35-
"enshrined/svg-sanitize": "^0.16.0",
36-
"ezyang/htmlpurifier": "^4.14",
37-
"jbroadway/urlify": "^1.2",
38-
"nesbot/carbon": "^2.66.0",
39-
"oomphinc/composer-installers-extender": "^2.0",
40-
"phpmailer/phpmailer": "^6.2",
41-
"stefangabos/zebra_image": "^2.7",
42-
"symfony/config": "^5.1",
43-
"symfony/console": "^5.2",
44-
"symfony/dependency-injection": "^5.1",
45-
"symfony/event-dispatcher": "^5.4",
46-
"symfony/http-foundation": "^5.1",
47-
"symfony/http-kernel": "^5.3.12",
48-
"symfony/process": "^5.4",
49-
"symfony/routing": "^5.1",
50-
"symfony/security-core": "^5.4",
51-
"symfony/security-csrf": "^5.0",
52-
"symfony/yaml": "^5.1",
53-
"tamtamchik/simple-flash": "^2.0",
54-
"twig/twig": "^3.4.3",
55-
"voku/anti-xss": "^4.1",
56-
"yeswiki/theme-margot": "^1.0"
57-
},
58-
"conflict": {
59-
},
60-
"extra": {
61-
"installer-types": ["yeswiki-extension", "yeswiki-theme"],
62-
"installer-paths": {
63-
"tools/{$name}" : ["type:yeswiki-extension"],
64-
"themes/{$name}": ["type:yeswiki-theme"]
65-
}
66-
},
67-
"require-dev": {
68-
"friendsofphp/php-cs-fixer": "^3.4",
69-
"phpunit/phpunit": "^9",
70-
"symfony/var-dumper": "^5.1"
71-
},
72-
"config": {
73-
"allow-plugins": {
74-
"composer/installers": true,
75-
"oomphinc/composer-installers-extender": true
76-
},
77-
"optimize-autoloader": true,
78-
"platform": {
79-
"php": "7.3.0"
80-
},
81-
"platform-check": true,
82-
"sort-packages": true
83+
"optimize-autoloader": true,
84+
"platform": {
85+
"php": "7.3.0"
8386
},
84-
"bin": [
85-
"yeswicli"
86-
],
87-
"autoload": {
88-
"classmap": ["includes/ComposerScriptsHelper.php"]
89-
}
87+
"platform-check": true,
88+
"sort-packages": true
89+
},
90+
"bin": [
91+
"yeswicli"
92+
],
93+
"autoload": {
94+
"classmap": [
95+
"includes/ComposerScriptsHelper.php"
96+
]
97+
}
9098
}

docker/README.md

Lines changed: 26 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,46 +4,51 @@ This directory contain 2 dockerfiles and 2 docker-compose. One of each for dev a
44

55
## Dev
66

7-
The dev docker-compose contain the following images :
8-
9-
- yeswiki-app: This image have only a php-fpm process and mount the directory in the container to be able to develop locally
10-
- yeswiki-db : a mysql (mariadb seems to not work properly currently) accessible from yeswiki with domaine name `yeswiki-db`
11-
- yeswiki-web : a nginx reverse-proxy. configuration can be found on nginx.conf file. Accessible on `localhost:8085`
12-
- myadmin : phpmyadmin accessible on `localhost:8086`
13-
- mail : container to intercept email send by yeswiki. Webmail is accessible on `localhost:1080`.You have to set the following in `wakka.config.php`
14-
```
7+
The dev docker-compose contain the following images :
8+
9+
- yeswiki-app: This image have only a php-fpm process and mount the directory in the container to be able to develop locally
10+
- yeswiki-db : a mysql (mariadb seems to not work properly currently) accessible from yeswiki with domaine name `yeswiki-db`
11+
- yeswiki-web : a nginx reverse-proxy. configuration can be found on nginx.conf file. Accessible on `localhost:8085`
12+
- myadmin : phpmyadmin accessible on `localhost:8086`
13+
- mail : container to intercept email send by yeswiki. Webmail is accessible on `localhost:1080`.You have to set the following in `wakka.config.php`
14+
15+
```
1516
'contact_mail_func' => 'smtp',
1617
'contact_smtp_host' => 'mail',
1718
'contact_smtp_port' => '1025',
18-
```
19+
```
20+
1921
### How-To
2022

2123
> [!]info
2224
> all commands have to be launched from docker directory
2325
2426
To be able to develop locally without messing up with users and permissions, the dev dockerfile uses the same user and group as computer user.
25-
You need to create a file called `.env` within the `docker` directory with the following content :
27+
You need to create a file called `.env` within the `docker` directory with the following content :
28+
2629
```
2730
UID="YOUR_USER_ID" # can be found with id -u
2831
GID="YOUR_USER_GID" # can be found with id -g
2932
```
3033

31-
Then you can build the container with the following command :
34+
Then you can build the container with the following command :
35+
3236
```
3337
docker compose build
3438
```
3539

36-
Once done, you can start containers :
40+
Once done, you can start containers :
41+
3742
```
3843
docker compose up
3944
# or docker compose up -d if you want to detach from terminal
4045
```
4146

4247
It should take some time for the first launch, it will perform `compose install` and `yarn install`.
4348
Then yeswiki will be accessible at [localhost:8085](http://localhost:8085),
44-
phpmyadmin at [localohost:8086](http://localhost:8086) and mailcatcher at [localhost:1080](http://localhost:1080).
49+
phpmyadmin at [localohost:8086](http://localhost:8086) and mailcatcher at [localhost:1080](http://localhost:1080).
4550

46-
Once on the install page, use the following values :
51+
Once on the install page, use the following values :
4752

4853
- **Mysql server host** : yeswiki-db
4954
- **MYSQL database name** : yeswiki (can be found in yeswiki.secret)
@@ -68,22 +73,27 @@ It should be enough to remove the `wakka.config.php` file
6873
## Remove database
6974

7075
- remove containers (stopping container doesn't remove them)
76+
7177
```
72-
docker compose down
78+
docker compose down
7379
```
80+
7481
- remove docker volume (containing database files)
82+
7583
```
7684
docker volume rm yeswiki-db
7785
```
7886

7987
## updating php or yarn dependency
8088

81-
You can simply restart container with the following command : 
89+
You can simply restart container with the following command :
90+
8291
```
8392
docker compose restart
8493
```
8594

8695
If you want to update php or yarn dependency without restarting everything, you can do the following commands.
96+
8797
```
8898
docker compose exec yeswiki-app composer install
8999
docker compose exec yeswiki-app yarn install

docs/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
Yeswiki Documentation
2-
=====================
1+
# Yeswiki Documentation
32

43
Documentation is organized in different sections :
54

0 commit comments

Comments
 (0)