Skip to content

Commit

Permalink
Adds VsCode extensions and settings recommendations
Browse files Browse the repository at this point in the history
  • Loading branch information
seballot committed Jun 19, 2024
1 parent 2d74fda commit e873a72
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 2 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,8 @@ tools/*
*.iml

# vscode IDE
.vscode
!.vscode
.vscode/settings.json

# Docker
.db
Expand Down
8 changes: 8 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"recommendations": [
"esbenp.prettier-vscode",
"mhutchie.git-graph",
"junstyle.php-cs-fixer",
"dbaeumer.vscode-eslint"
]
}
23 changes: 23 additions & 0 deletions .vscode/settings.example.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"php-cs-fixer.executablePath": "/var/www/html/vendor/bin/php-cs-fixer",
"php-cs-fixer.ignorePHPVersion": true,
"editor.formatOnSave": true,
"editor.formatOnPaste": true,
"editor.defaultFormatter": "esbenp.prettier-vscode",
"[php]": {
"editor.defaultFormatter": "junstyle.php-cs-fixer"
},
"editor.codeActionsOnSave": {
"source.fixAll.eslint": "always"
},
"[twig]": {
"editor.formatOnSave": false,
"editor.formatOnPaste": false
},
"[javascript]": {
"editor.defaultFormatter": "dbaeumer.vscode-eslint"
},
"[css]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
}
}
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,9 @@ We recommand an installation through docker.

### Linters & Formatters

Please install relevant extension and enable auto formating on your editor. Or run `make lint` before commit
Please install relevant extension and enable auto formating on your editor.

Alternatly you can run `make lint`

| Language | Linter/Formatter |
| --------------------------- | ------------------------------------------------------------ |
Expand All @@ -40,6 +42,8 @@ Please install relevant extension and enable auto formating on your editor. Or r
| Twig | no automatic linter. Couldn't find one which is good enough. |
| CSS, Yaml, JSON, Markdown.. | `prettier` |

If you use VS Code, get yeswiki linting settings with `cp .vscode/settings.example.json .vscode/settings.json`

## History

YesWiki grew out of a French language version of [WakkaWiki](https://en.wikipedia.org/wiki/WakkaWiki) called [Wikini](http://wikini.net), and hence has strong French language support.
Expand Down

0 comments on commit e873a72

Please sign in to comment.