Validating the list entries and adding new tools could be easier by using a proper data-exchange format like YAML for storing all entries.
The way I imagine this to work is that we have a data.yml file, which contains all linters.
- name: My Linter
url: https://www.example.com
proprietary: True
description: Static code analysis for C and PHP code.
lints: ["php", "containers", "packages"]
type: "tool"
The lints could be any programming language or category we have in the README.md right now.
The type can be any of tool, webservice, or collection.
This would be rendered into the human-readable format from the README.md that we have right now.
Required steps:
This is quite a big change, but I think it's worth it, because it will make contributing and testing the tools much easier. Also it paves the way for providing different ways for using the list, such as through an API, as a Website with different categories for tools, or as a tool for suggesting linters to IDEs.
Validating the list entries and adding new tools could be easier by using a proper data-exchange format like
YAMLfor storing all entries.The way I imagine this to work is that we have a
data.ymlfile, which contains all linters.The lints could be any programming language or category we have in the
README.mdright now.The type can be any of
tool,webservice, orcollection.This would be rendered into the human-readable format from the
README.mdthat we have right now.Required steps:
YAML/cifolderREADME.mdand push to master.CONTRIBUTING.mdThis is quite a big change, but I think it's worth it, because it will make contributing and testing the tools much easier. Also it paves the way for providing different ways for using the list, such as through an API, as a Website with different categories for tools, or as a tool for suggesting linters to IDEs.