Skip to content

docs(vscode): include formatting information in CONTRIBUTING.md #826

@alestiago

Description

@alestiago

Description

Currently, the contributing file for the VS Code extension does not have any information regarding code formatting. The current formatting strategy is largely dictated by the Prettier [1] extension. This should be at least documented so other developers know how to format the project adequately. Ideally, we should introduce a npm script [2], such as npm run format that formats the project without the need of contributors installing an extension in their IDE. Note that this command should be equivalent to using the extension and should be compatible with the current analyser, eslint [3].

Requirements

  • Include an npm script to format the VS Code extension project as the Prettier extension
  • Document the use of a formatter in the VS Code CONTRIBUTING.md file

References

[1] Prettier - code formatter - visual studio marketplace (no date) Marketplace. Available at: https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode (Accessed: 31 July 2023).

[2] Scripts npm Docs. Available at: https://docs.npmjs.com/cli/v9/using-npm/scripts (Accessed: 31 July 2023).

[3] ESLint - pluggable JavaScript linter. Available at: https://eslint.org/ (Accessed: 31 July 2023).

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationp2Important issues not at the top of the work listproduct: vscode extensionIssues related to the Dart Frog VSCode extension

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions