Tool Installation: Prettier

[emshyu]

Prettier is a static analysis tool that checks for consistent code style and has code reformatting capabilities. The tool will need further testing of rules so that it can coexist with EsLint. Currently, both tools can be run separately. Attached below is the command line stdout and stderr output of a successful run of 'npx prettier . --check' on our current nodebb codebase, a command that checks the style of the code.

Proof of installation:

• .prettierignore file
• .prettierrc file

Proof of running the tool successfully:
prettierinstallationproof.txt

KEY DETAILS FOR COMPLETE INTEGRATION:

• I added installations of Prettier, eslint-config-prettier, a call to prettier that reformats the code to fit standards, and a prettier formatting check to the integration pipeline.
• Currently, the pipeline passes for the Prettier and Node tests. Because Prettier is a linter, some EsLint tests still fail.
• To allow Eslint to coexist with Prettier, the workflow installs eslint-config-prettier and .eslintrc extends prettier. However, some rules still fail with EsLint, notably comma-dangle. I attempted to make an eslint.config.js file that can ignore certain rules, however I found challenges getting it to extend nodebb.
• Prettier ignores all files under the install/, build/, and test/ directories. Reformatting the test cases caused some formatting-specific Node tests to fail, meaning ignoring certain directories when 'npx prettier . --write' (the reformatter) is called allows for complete integration with Node tests.

[coveralls]

Pull Request Test Coverage Report for Build 11511413906

Details

• 0 of 0 changed or added relevant lines in 0 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage remained the same at 82.671%

---

Totals
Change from base Build 11446603378:	0.0%
Covered Lines:	22323
Relevant Lines:	25582

---

💛 - Coveralls

[emshyu]

KEY DETAILS FOR COMPLETE INTEGRATION:

• I added installations of Prettier, eslint-config-prettier, a call to prettier that reformats the code to fit standards, and a prettier formatting check to the integration pipeline.
• Currently, the pipeline passes for the Prettier and Node tests. Because Prettier is a linter, some EsLint tests still fail after prettier write is called.
• To allow Eslint to coexist with Prettier, the workflow installs eslint-config-prettier and .eslintrc extends prettier. However, some rules still fail with EsLint, notably comma-dangle. I attempted to make an eslint.config.js file that can ignore certain rules, however I found challenges getting it to extend nodebb.
• Prettier ignores all files under the install/, build/, and test/ directories. Reformatting the test cases caused some formatting-specific Node tests to fail, meaning ignoring certain directories when 'npx prettier . --write' (the reformatter) is called allows for complete integration with Node tests.

[emshyu]

Because Prettier conflicts with Eslint, despite interventions, this branch will not be merged.