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

DRAFT [Issue#3] add tools for static code analysis - Prettier init config old #9

Closed
wants to merge 2 commits into from

Conversation

KarolinaZakrzewska
Copy link
Collaborator

@KarolinaZakrzewska KarolinaZakrzewska commented Oct 24, 2023

Partially Resolves #3

Scope of changes

  • added the use of single quotes (') in Prettier configuration
  • added appropriate line break depending on the system, for Windows: CRLF (\r\n)
  • Prettier is set as the default formatting
  • formatting of all files corrected

How to use

  • install Prettier
npm install --save-dev --save-exact prettier
  • add an exclusion file .prettierignore
package-lock.json
playwright-report
  • add the rules file .prettierrc.json
{
  "singleQuote": true,
  "endOfLine": "auto"
}
  • run Prettier formatting
npx prettier --write .

Additionally, you can add the VSC extension: Prettier - Code formatter (you see it in extensions as recommended)

  • set as default formatting
    Right-click in the file e.g. package.json -> Format Document With... -> Configure Default Formatter... -> Select Prettier

@kat-kan
Copy link
Owner

kat-kan commented Oct 24, 2023

Is PR title correct?

@bugITwhisperer bugITwhisperer changed the title Resolves #7 && Partially Resolves #3 [Issue#3] add tools for static code analysis - init config Oct 24, 2023
Copy link
Collaborator

@bugITwhisperer bugITwhisperer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@KarolinaZakrzewska : Congrats on your first PR!!! 😸 🎉
As discussed on Discord, please install the prettier lib via npm package manager 🙏🏻

@bugITwhisperer bugITwhisperer changed the title [Issue#3] add tools for static code analysis - init config [Issue#3] add tools for static code analysis - Prettier init config Oct 24, 2023
@bugITwhisperer
Copy link
Collaborator

Is PR title correct?

Well, it didn't say much about the changes, so I've just adjusted it as per our discussion on Discord - to keep the current convention going:

[Issue#{number}] {short description of changes in present tense with action and the subject on which the action was made)
where:

  • number is the referenced Issue that was created to cover the change from PR

short description in present tense

  • with action} describes the action: add/create/update/fix etc.
  • and the subject on which the action was made: README file, Playwright config, and such

Anyways, let's discuss the approach in more details in a upcoming meeting. Coz we might decide on something else instead. It's just how I do it for now, but my approach has been also evolving a bit since I started😅

@bugITwhisperer bugITwhisperer added the chore: configuration Project configuration label Oct 29, 2023
@KarolinaZakrzewska
Copy link
Collaborator Author

Is PR title correct?

now it's ok, thank you @bugITwhisperer

@KarolinaZakrzewska KarolinaZakrzewska deleted the feat/prettier-configuration branch November 5, 2023 20:14
@bugITwhisperer bugITwhisperer restored the feat/prettier-configuration branch November 5, 2023 20:50
@bugITwhisperer bugITwhisperer reopened this Nov 5, 2023
Copy link
Owner

@kat-kan kat-kan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@KarolinaZakrzewska please finish the changes - as I remember you're still working on it :)

@kat-kan kat-kan changed the title [Issue#3] add tools for static code analysis - Prettier init config DRAFT [Issue#3] add tools for static code analysis - Prettier init config Nov 8, 2023
@KarolinaZakrzewska KarolinaZakrzewska changed the title DRAFT [Issue#3] add tools for static code analysis - Prettier init config DRAFT [Issue#3] add tools for static code analysis - Prettier init config old Nov 11, 2023
@KarolinaZakrzewska
Copy link
Collaborator Author

closing due to conflicts with the latest version of main

@bugITwhisperer bugITwhisperer deleted the feat/prettier-configuration branch November 13, 2023 21:36
@bugITwhisperer
Copy link
Collaborator

bugITwhisperer commented Nov 15, 2023

@KarolinaZakrzewska : are you planning to open a new PR with the Prettier config changes? :)

@KarolinaZakrzewska
Copy link
Collaborator Author

@KarolinaZakrzewska : are you planning to open a new PR with the Prettier config changes? :)

Yes, I prepared a new PR #37

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore: configuration Project configuration
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Github workflow standards && project standards to be established
3 participants