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.

Sign up for GitHub

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

Jump to bottom

Add Prettier as a script to help enforcing code style #861

Closed
Rodrigoplp-work opened this issue Oct 25, 2022 · 1 comment · Fixed by #973
Closed

Add Prettier as a script to help enforcing code style #861

Rodrigoplp-work opened this issue Oct 25, 2022 · 1 comment · Fixed by #973
Assignees
@hoangphamEclipse
Labels
dependencies Pull requests that update a dependency file help wanted Extra attention is needed

Comments

@Rodrigoplp-work
Copy link
Contributor

Prettier allows the definition of code style for the project.

Install Prettier, define the rules and setup a script in ./package.json so that it can be used by everyone, regardless of the IDE / code editor of preference.

Also, once the script is ready, it can be added to the build workflow to automatically check the code on every commit.
@marco-miller marco-miller added help wanted Extra attention is needed dependencies Pull requests that update a dependency file labels Oct 25, 2022
@Rodrigoplp-work Rodrigoplp-work self-assigned this Nov 2, 2022
@marco-miller
Copy link
Contributor

A teammate is about to push a PR as work just restarted on this internally.

EstFoisy pushed a commit to EstFoisy/theia-trace-extension that referenced this issue Apr 19, 2023
Add Prettier to script to help enforce code style
b322382 
Fix the issue eclipse-cdt-cloud#861 regarding code style.
@EstFoisy EstFoisy mentioned this issue Apr 19, 2023
Closed
EstFoisy pushed a commit to EstFoisy/theia-trace-extension that referenced this issue Apr 19, 2023
Add Prettier to script to help enforce code style
608b7d1 
Fix the issue eclipse-cdt-cloud#861 regarding code style.
EstFoisy pushed a commit to EstFoisy/theia-trace-extension that referenced this issue Apr 19, 2023
Add Prettier to script to help enforce code style
1112e41 
Fix the issue eclipse-cdt-cloud#861 regarding code style.
EstFoisy pushed a commit to EstFoisy/theia-trace-extension that referenced this issue Apr 19, 2023
Add Prettier to script to help enforce code style
136fd41 
Fix the issue eclipse-cdt-cloud#861 regarding code style .
EstFoisy pushed a commit to EstFoisy/theia-trace-extension that referenced this issue Apr 19, 2023
Add Prettier to script to help enforce code style
2246574 
Fix the issue eclipse-cdt-cloud#861 regarding code style.
@EstFoisy EstFoisy mentioned this issue Apr 20, 2023
Closed
EstFoisy pushed a commit to EstFoisy/theia-trace-extension that referenced this issue Apr 20, 2023
Add Prettier to script to help enforce code style
c1e81ac 
Fix the issue eclipse-cdt-cloud#861 regarding code style.
EstFoisy pushed a commit to EstFoisy/theia-trace-extension that referenced this issue Apr 20, 2023
Add Prettier to script to help enforce code style
7cd6f93 
Fix the issue eclipse-cdt-cloud#861 regarding code style.
EstFoisy pushed a commit to EstFoisy/theia-trace-extension that referenced this issue Apr 20, 2023
Add Prettier to script to help enforce code style
fd7a915 
Fix the issue eclipse-cdt-cloud#861 regarding code style.
EstFoisy pushed a commit to EstFoisy/theia-trace-extension that referenced this issue Apr 21, 2023
Add Prettier to script to help enforce code style
62364a3 
Fix the issue eclipse-cdt-cloud#861 regarding code style.
@EstFoisy EstFoisy mentioned this issue Apr 21, 2023
Closed
EstFoisy pushed a commit to EstFoisy/theia-trace-extension that referenced this issue Apr 24, 2023
Add Prettier to script to help enforce code style
fc93122 
Fix the issue eclipse-cdt-cloud#861 regarding code style.
EstFoisy pushed a commit to EstFoisy/theia-trace-extension that referenced this issue Apr 24, 2023
Add Prettier to script to help enforce code style
dabe41c 
Fix the issue eclipse-cdt-cloud#861 regarding code style.
hoangphamEclipse pushed a commit to EstFoisy/theia-trace-extension that referenced this issue Apr 24, 2023
@hoangphamEclipse
Add Prettier to script to help enforce code style
0cd158d 
Fix the issue eclipse-cdt-cloud#861 regarding code style.
hoangphamEclipse pushed a commit to EstFoisy/theia-trace-extension that referenced this issue Apr 24, 2023
@hoangphamEclipse
Add Prettier to script to help enforce code style
ed64bdf 
This commit adds Prettier to the trace extension. Prettier allows the
extension to define rules for code style and formatting. This helps keep
the format of the code consistent and allow quick formatting of new code.

Fix eclipse-cdt-cloud#861.
@hoangphamEclipse hoangphamEclipse mentioned this issue Apr 24, 2023
Closed
@hoangphamEclipse hoangphamEclipse mentioned this issue May 9, 2023
Merged
hoangphamEclipse added a commit to hoangphamEclipse/theia-trace-extension that referenced this issue May 9, 2023
@hoangphamEclipse
Set up Prettier to enforce code style
8e39564 
This commit adds Prettier to enforce code style for the trace
extension.

Contributors can run yarn format to automatically run Prettier
to format the source code of the  three packages 	raceviewer-base,
	raceviewer-react-components, and 	heia-traceviewer. Alternatively,
they can run Prettier on a single file using the command
yarn prettier --write <file-name>.

This commit also configures CI to run yarn prettier --check to ensure
that any new code follows the pre-defined code style rules.

Replaces eclipse-cdt-cloud#968 and resolves eclipse-cdt-cloud#861.

Signed-off-by: Hoang Thuan Pham <hoang.pham@calian.ca>
hoangphamEclipse added a commit to hoangphamEclipse/theia-trace-extension that referenced this issue May 9, 2023
@hoangphamEclipse
Set up Prettier to enforce code style
0b39037 
This commit adds Prettier to enforce code style for the trace
extension.

Contributors can run yarn format to automatically run Prettier
to format the source code of the  three packages 	raceviewer-base,
	raceviewer-react-components, and 	heia-traceviewer. Alternatively,
they can run Prettier on a single file using the command
yarn prettier --write <file-name>.

This commit also configures CI to run yarn prettier --check to ensure
that any new code follows the pre-defined code style rules.

Replaces eclipse-cdt-cloud#968 and resolves eclipse-cdt-cloud#861.

Signed-off-by: Hoang Thuan Pham <hoang.pham@calian.ca>
hoangphamEclipse added a commit to hoangphamEclipse/theia-trace-extension that referenced this issue May 9, 2023
@hoangphamEclipse
Set up Prettier to enforce code style
6f5229c 
This commit adds Prettier to enforce code style for the trace
extension.

Contributors can run yarn format to automatically run Prettier
to format the source code of the  three packages 	raceviewer-base,
	raceviewer-react-components, and 	heia-traceviewer. Alternatively,
they can run Prettier on a single file using the command
yarn prettier --write <file-name>.

This commit also configures CI to run yarn prettier --check to ensure
that any new code follows the pre-defined code style rules.

Replaces eclipse-cdt-cloud#968 and resolves eclipse-cdt-cloud#861.

Signed-off-by: Hoang Thuan Pham <hoang.pham@calian.ca>
hoangphamEclipse added a commit to hoangphamEclipse/theia-trace-extension that referenced this issue May 9, 2023
@hoangphamEclipse
Set up Prettier to enforce code style
31b69f6 
This commit adds Prettier to enforce code style for the trace
extension.

Contributors can run yarn format to automatically run Prettier
to format the source code of the  three packages traceviewer-base,
traceviewer-react-components, and theia-traceviewer. Alternatively,
they can run Prettier on a single file using the command
yarn prettier --write <file-name>.

This commit also configures CI to run yarn prettier --check to ensure
that any new code follows the pre-defined code style rules.

Replaces eclipse-cdt-cloud#968 and resolves eclipse-cdt-cloud#861.

Signed-off-by: Hoang Thuan Pham <hoang.pham@calian.ca>
hoangphamEclipse added a commit to hoangphamEclipse/theia-trace-extension that referenced this issue May 10, 2023
@hoangphamEclipse
Set up Prettier to enforce code style
f919914 
This commit adds Prettier to enforce code style for the trace
extension.

Contributors can run yarn format to automatically run Prettier
to format the source code of the  three packages traceviewer-base,
traceviewer-react-components, and theia-traceviewer. Alternatively,
they can run Prettier on a single file using the command
yarn prettier --write <file-name>.

This commit also configures CI to run yarn prettier --check to ensure
that any new code follows the pre-defined code style rules.

Replaces eclipse-cdt-cloud#968 and resolves eclipse-cdt-cloud#861.

Signed-off-by: Hoang Thuan Pham <hoang.pham@calian.ca>
hoangphamEclipse added a commit to hoangphamEclipse/theia-trace-extension that referenced this issue May 10, 2023
@hoangphamEclipse
Format code with Prettier
5937605 
This commit applies the changes made by running yarn format:write to
format the source code of the three the three packages 	raceviewer-base,
	raceviewer-react-components, and 	heia-traceviewer using Prettier.

Resolves eclipse-cdt-cloud#861.

Signed-off-by: Hoang Thuan Pham <hoang.pham@calian.ca>
hoangphamEclipse added a commit to hoangphamEclipse/theia-trace-extension that referenced this issue May 10, 2023
@hoangphamEclipse
Format code with Prettier
f194f10 
This commit applies the changes made by running yarn format:write to
format the source code of the three the three packages traceviewer-base,
traceviewer-react-components, and theia-traceviewer using Prettier.

Resolves eclipse-cdt-cloud#861.

Signed-off-by: Hoang Thuan Pham <hoang.pham@calian.ca>
hoangphamEclipse added a commit to hoangphamEclipse/theia-trace-extension that referenced this issue May 10, 2023
@hoangphamEclipse
Add .git-blame-ignore-revs to ignore linting/formatting commits
281893d 
This commit adds a .git-blame-ignore-revs file to ignore linting/
formatting commits while using git blame. It also documents its usage
in CONTRIBUTING.md for future references.

Resolves eclipse-cdt-cloud#861.

Signed-off-by: Hoang Thuan Pham <hoang.pham@calian.ca>
hoangphamEclipse added a commit to hoangphamEclipse/theia-trace-extension that referenced this issue May 10, 2023
@hoangphamEclipse
Add documentation for Prettier scripts
754da08 
This commit adds documentation on how to run Prettier to check and format
code for contributors of the Trace Extension.

Resolves eclipse-cdt-cloud#861.

Signed-off-by: Hoang Thuan Pham <hoang.pham@calian.ca>
hoangphamEclipse added a commit that referenced this issue May 15, 2023
@hoangphamEclipse
Set up Prettier to enforce code style
b2f94a4 
This commit adds Prettier to enforce code style for the trace
extension.

Contributors can run yarn format to automatically run Prettier
to format the source code of the  three packages traceviewer-base,
traceviewer-react-components, and theia-traceviewer. Alternatively,
they can run Prettier on a single file using the command
yarn prettier --write <file-name>.

This commit also configures CI to run yarn prettier --check to ensure
that any new code follows the pre-defined code style rules.

Replaces #968 and resolves #861.

Signed-off-by: Hoang Thuan Pham <hoang.pham@calian.ca>
hoangphamEclipse added a commit that referenced this issue May 15, 2023
@hoangphamEclipse
Format code with Prettier
6e3116b 
This commit applies the changes made by running yarn format:write to
format the source code of the three the three packages traceviewer-base,
traceviewer-react-components, and theia-traceviewer using Prettier.

Resolves #861.

Signed-off-by: Hoang Thuan Pham <hoang.pham@calian.ca>
hoangphamEclipse added a commit that referenced this issue May 15, 2023
@hoangphamEclipse
Add .git-blame-ignore-revs to ignore linting/formatting commits
8d5db13 
This commit adds a .git-blame-ignore-revs file to ignore linting/
formatting commits while using git blame. It also documents its usage
in CONTRIBUTING.md for future references.

Resolves #861.

Signed-off-by: Hoang Thuan Pham <hoang.pham@calian.ca>
hoangphamEclipse added a commit that referenced this issue May 15, 2023
@hoangphamEclipse
Add documentation for Prettier scripts
1620942 
This commit adds documentation on how to run Prettier to check and format
code for contributors of the Trace Extension.

Resolves #861.

Signed-off-by: Hoang Thuan Pham <hoang.pham@calian.ca>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@hoangphamEclipse hoangphamEclipse

Labels
dependencies Pull requests that update a dependency file help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
3 participants
@marco-miller @Rodrigoplp-work @hoangphamEclipse