GitHub/flatbuffers
1
0
Fork 0
mirror of https://github.com/google/flatbuffers.git synced 2025-04-08 09:12:14 +08:00
Code Issues Packages Projects Releases Wiki Activity
flatbuffers/Formatters.md
Derek Bailey ef0eb3701d
Ran clang-format-all.sh. Removed default --style=file parameter (#6639) 
* Ran clang-format-all.sh. Removed default --style=file parameter

* Moved scripts to scripts/ location
2021-05-15 12:54:08 -07:00

1.1 KiB
Raw Blame History

Format Guidelines

If you are interesting in contributing to the flatbuffers project, please take a second to read this document. Each language has it's own set of rules, that are defined in their respective formatter/linter documents.

Notes

  • Run the linter on the language you are working on before making a Pull Request.
  • DONT format/lint the generated code.

Languages

C++

C++ uses clang-format as it's formatter. Run the following script sh scripts/clang-format-git.sh, and it should style the C++ code according to google style guide.

Swift

Swift uses swiftformat as it's formatter. Take a look at how to install here. Run the following command swiftformat --config swift.swiftformat . in the root directory of the project

Typescript

Typescript uses eslint as it's linter. Take a look at how to install here. Run the following command eslint ts/** --ext .ts in the root directory of the project