pmonks / multigrep

A little Clojure library that provides regex-based file grepping and/or text substitution.

main
dev

multigrep

A little Clojure library that provides regex-based file grepping and/or text substitution.

Installation

multigrep is available as a Maven artifact from Clojars.

Trying it Out

Clojure CLI

$ clj -Sdeps '{:deps {com.github.pmonks/multigrep {:mvn/version "#.#.#"}}}'  # Where #.#.# is replaced with an actual version number (see badge above)

Leiningen

$ lein try com.github.pmonks/spinner

Usage

The multigrep functionality is provided by the multigrep.core namespace.

Require it in the REPL:

(require '[multigrep.core :as mg])

Require it in your application:

(ns my-app.core
  (:require [multigrep.core :as mg]))

The library provides two functions - grep (for searching for text within files) and greplace! (for searching and replacing text within files). The API documentation has full details, and the unit tests contain comprehensive usage examples.

API Documentation

API documentation is available here.

Contributor Information

Contributing Guidelines

Bug Tracker

Code of Conduct

Developer Workflow

The repository has two permanent branches: main and dev. All development must occur either in branch dev, or (preferably) in feature branches off of dev. All PRs must also be submitted against dev; the main branch is only updated from dev via PRs created by the core development team. All other changes submitted to main will be rejected.

This model allows otherwise unrelated changes to be batched up in the dev branch, integration tested there, and then released en masse to the main branch, which will trigger automated generation and deployment of the release (Codox docs to GitHub Pages, JARs to Clojars, etc.).

Why are there so many different groupIds on Clojars for this project?

The project was originally developed under my personal GitHub account. In early 2018 it was transferred to the clj-commons GitHub organisation, but then, as that group refined their scope and mission, it was determined that it no longer belonged there, and the project were transferred back in late 2021. During this time the build tooling for the project also changed from Leiningen to tools.build, which created further groupId churn (tools.build introduced special, useful semantics for com.github.username groupIds that don't exist with Leiningen or Clojars).

License

Copyright © 2014 Peter Monks

Distributed under the Apache License, Version 2.0.

SPDX-License-Identifier: Apache-2.0