We're OGS, check out our work on github.com/ogs-gmbh

Linter

Linter rules to enforce consistent, high-quality code across projects.

• Easy to Set Up
  Simple configuration lets you start linting quickly without complex setup.

• Strict Rules
  Enforces a highly opinionated and rigorous set of rules designed to maximize correctness, consistency, and long-term maintainability.

• Supports Multiple Languages
  Provides unified linting across Package.json, TypeScript, JavaScript, JSDoc, Markdown, JSON, Angular, and Angular HTML templates.

• Consistent Results
  Guarantees stable, repeatable linting results suitable for automated enforcement in CI environments.

Getting Started

[!IMPORTANT] We're offering an extensive API-Reference covered with in-depth usage examples of this project.

To get a starting point, simply refer to our documentation at ogs-gmbh.github.io/linter.

Prerequisites

• Node.js version 18 or higher
• A package manager: e.g. npm, pnpm, ...

Installation

Using npm:

$ npm install -D @ogs-gmbh/linter

Using yarn:

$ pnpm add -D @ogs-gmbh/linter

Using pnpm:

$ pnpm add -D @ogs-gmbh/linter

Using bun:

$ bun add -D @ogs-gmbh/linter

License

The MIT License (MIT) - Please have a look at the LICENSE file for more details.

Contributing

Contributions are always welcome and greatly appreciated. Whether you want to report a bug, suggest a new feature, or improve the documentation, your input helps make the project better for everyone.

Feel free to submit a pull request, issue or feature request.

Issues and Feature Requests

Reporting an issue or creating a feature request is made by creating a new issue on this repository.

You can create a new issue or feature request here.

Pull Requests

GitHub offers a solid guideline for contributing to open source projects through pull requests, covering key practices. These best practices provide a reliable starting point for making effective contributions.

You can find the guidelines here.

Code Of Conduct

We are committed to keeping a welcoming, inclusive, and respectful community for everyone. To help us achieve this, we kindly ask that you adhere to our Code of Conduct.

Disclaimer

All trademarks and registered trademarks mentioned are property of their respective owners and are used for identification purposes only. Use of these names does not imply endorsement or affiliation.

This project is a trademark of OGS Gesellschaft für Datenverarbeitung und Systemberatung mbH. The License does not grant rights to use the trademark without permission.

Gesellschaft für Datenverarbeitung und Systemberatung mbH

Imprint | Contact | Careers