https://github.com/mbarbin/dunolint

A linter for build files in dune projects (OCaml)
https://github.com/mbarbin/dunolint

build codemods dune linter ocaml

Last synced: 10 months ago
JSON representation

A linter for build files in dune projects (OCaml)

• Host: GitHub
• URL: https://github.com/mbarbin/dunolint
• Owner: mbarbin
• License: lgpl-3.0
• Created: 2024-06-13T12:56:45.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2025-02-21T09:04:28.000Z (over 1 year ago)
• Last Synced: 2025-02-21T09:36:14.422Z (over 1 year ago)
• Topics: build, codemods, dune, linter, ocaml
• Language: OCaml
• Homepage: https://mbarbin.github.io/dunolint/
• Size: 338 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: COPYING
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# dunolint

[![CI Status](https://github.com/mbarbin/dunolint/workflows/ci/badge.svg)](https://github.com/mbarbin/dunolint/actions/workflows/ci.yml)

[![Coverage Status](https://coveralls.io/repos/github/mbarbin/dunolint/badge.svg?branch=main)](https://coveralls.io/github/mbarbin/dunolint?branch=main)

[![Deploy Doc Status](https://github.com/mbarbin/dunolint/workflows/deploy-doc/badge.svg)](https://github.com/mbarbin/dunolint/actions/workflows/deploy-doc.yml)

[![OCaml-CI Build Status](https://img.shields.io/endpoint?url=https://ocaml.ci.dev/badge/mbarbin/dunolint/main&logo=ocaml)](https://ocaml.ci.dev/github/mbarbin/dunolint)

## Introduction

Welcome to **dunolint**, a project composed of libraries and a CLI designed to assist with maintaining *build files* typically found in OCaml repos managed by the Dune build system (e.g., files named *dune*, *dune-project*, etc.).

## Project Goals

The goal of **dunolint** is to check customizable invariants in your repo and help with ergonomic issues, such as applying systematic changes across many files. It supports things like enabling instrumentation, configuring recurring lint or preprocess flags, sorting libraries alphabetically, and more. You can use it at your convenience during development, and enforce consistency by integrating it into your CI pipeline.

## Documentation

Published [here](https://mbarbin.github.io/dunolint).

## Current State

It's currently in the early stages of development and there's little code and features at this point. I'm seeking feedback and early discussions about the project next steps.

## Get Involved

I would love to hear your thoughts about dunolint. If you're interested in this project and would like to engage in discussions or provide feedback, please feel free to open an issue or start a discussion in the GitHub space of the project.

Thank you for your interest in dunolint!

## Acknowledgements

We're very thankful to:

- Jérémie Dimino and the **Dune** developers for their work on the [Dune](https://github.com/ocaml/dune) build system for OCaml.

- The [diataxis](https://diataxis.fr/) approach to technical documentation, which we use as inspiration to structure our doc.