diff --git a/.gitignore b/.gitignore index c69c9168e..c3c199a10 100644 --- a/.gitignore +++ b/.gitignore @@ -106,7 +106,10 @@ dist .serverless # IDE / Editor -.idea +.idea/* +!.idea/jsLinters +!.idea/runConfigurations +!.idea/vcs.xml # Service worker sw.* diff --git a/.idea/jsLinters/eslint.xml b/.idea/jsLinters/eslint.xml new file mode 100644 index 000000000..67738fad0 --- /dev/null +++ b/.idea/jsLinters/eslint.xml @@ -0,0 +1,7 @@ + + + + + + \ No newline at end of file diff --git a/.idea/runConfigurations/jest-all-tests.run.xml b/.idea/runConfigurations/jest-all-tests.run.xml new file mode 100644 index 000000000..359b0b181 --- /dev/null +++ b/.idea/runConfigurations/jest-all-tests.run.xml @@ -0,0 +1,11 @@ + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 000000000..f183d1548 --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,20 @@ + + + + + + + + + \ No newline at end of file diff --git a/README.md b/README.md index 6c7b4950e..272b8af68 100644 --- a/README.md +++ b/README.md @@ -77,12 +77,22 @@ SECRET=replaceThis ### Editor -Some libraries like Vue recommend using Visual Studio Code as editor. -There are some recommended extensions in `.vscode/extensions.json` to help with development. +#### Visual Studio Code +Recommended extensions are provided in `.vscode/extensions.json` +and Visual Studio Code will ask for your permission to install them upon project open. +`.vscode/settings.json` already includes settings to integrate with tooling. + +#### JetBrains IDE (WebStorm, PhpStorm, …) +Most of the tooling is already shipped with a JetBrains IDE. +`.idea` already contains some settings to integrate with the tooling. +If you want syntax highlighting for `.suml` files, you need to manually bind them to `yaml` syntax +via `Settings › Editor › File Types`. + +#### Others When you want to use a different editor, you may need to configure some points to reduce manual work: - Integrating ESLint with auto-fixing on save (the formatting relies on it) -- Integration Jest to easily view test results +- Integrating Jest to easily view test results - Use `yaml` syntax highlighting for `.suml` files ### Tools