Linting configurations for trophoria's dart/flutter and typescript projects.
« Explore the docs »

Report Bug · Request Feature

Table of Contents

1. 👋 Getting Started
2. 👥 Contributing
3. 🪲 Issue Reporting
4. 🔓 License
5. 💌 Contact

👋 Getting started

Welcome to trophoria! This repository contains an ansible playbook which is used to easily setup a secured remote linux server to run a whole trophoria backend.

If you want to contribute to our community projects, we advice you to fist read through our wiki pages. If you for example want to learn, how we set up our development environment, you can read our Development setup. This repository itself contains more useful information like pull request templates, security guidelines and so on. Make sure to read those too!

This repository contains our linting configurations we use in our typescript and flutter projects.

Typescript

Install both linting packages for eslint and prettier via yarn:

yarn add -D @trophoria/eslint-config @trophoria/prettier

Now add the following configuration to your package.json file:

{
  "prettier": "@trophoria/prettier-config",
  "eslintConfig": {
    "extends": [ "@trophoria/eslint-config" ]
  }
}

Flutter

Add the linting package to your pubspec.yaml file:

dev_dependencies:
  trophoria_lints:
    git: 
      url: https://github.com/trophoria/trophoria-lints.git
      path: trophoria-flutter

Now you can include the config in your analysis_options.yaml file:

include: package:trophoria_lints/lints.yaml

(back to top)

👥 Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this project better, please fork the repo and create a pull request. Don't forget to give the project a star! Thanks again! But before you get started, please see the following pages first:

• Code of Conduct
• Contributing Guidelines

You can also take a look at the already mentioned wiki pages to find a few guides on how to work with the repository technologies and so on. We also included a pull request template which includes a pretty large checklist of things, you should already fulfill before creating a merge request, to keep the review time as small as possible!

(back to top)

🪲 Issue Reporting

If you have found a bug or if you have a feature request, please report them at this repository issues section. For other related questions/support please use the official discord server. More information about issue reporting contributing are found in the Contributing guidelines.

(back to top)

🔓 License

All of our software is distributed under the MIT License. See the LICENSE file for more information.

(back to top)

💌 Contact

If you are interested in connecting with us, don't hesitate to do so. Either write us an email to [email protected] or join our community discord .

(back to top)