Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add settings & documentation for formatting (Workspace for vscode & IntelliJ preferences) #97

Open
vferraro-scottlogic opened this issue Nov 2, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@vferraro-scottlogic
Copy link

vferraro-scottlogic commented Nov 2, 2023

Background

we have a set of workspace settings for vscode (in vuu-ui/vscode/settings.json) we want to add default formatters

Work Required

VSCode / Frontend code:

  • make prettier the default for ts, tsx, js,jsx,css, html,json
    i.e.
    ` "[typescript]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
    },

    "[typescriptreact]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
    }`

  • add extensions.json with recommended extensions for the project:

    • prettier, eslint

IntelliJ / Backend code:

  • Adjust settings as per the screenshot (import layout, general import settings, wildcard imports):
    Image

Docs:

  • Add settings configuration to VUU documentation and ReadME
    • also mention that project needs to be opened from vuu-ui folder for the VSCode settings to be picked up
    • mention other IDEs settings (e.g. Webstorm)

Notes

  • project needs to be opened from the workspace folder (vuu-ui) to use the workspace settings
  • if not using vscode (i.e. WebStorm) make sure your IDE settings match vscode/settings.json
@vferraro-scottlogic vferraro-scottlogic added this to the Layout Management milestone Nov 3, 2023
@cfisher-scottlogic cfisher-scottlogic changed the title Add Workspace settings around formatting for vscode Add Workspace settings around formatting for vscode & IntelliJ settings Nov 7, 2023
@cfisher-scottlogic cfisher-scottlogic changed the title Add Workspace settings around formatting for vscode & IntelliJ settings Add settings & documentation for formatting (Workspace for vscode & IntelliJ preferences) Nov 7, 2023
@vferraro-scottlogic vferraro-scottlogic self-assigned this Nov 8, 2023
@vferraro-scottlogic vferraro-scottlogic linked a pull request Nov 9, 2023 that will close this issue
1 task
@cfisher-scottlogic cfisher-scottlogic added the documentation Improvements or additions to documentation label Nov 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants