Giter VIP home page Giter VIP logo

multigrep's Introduction

main CI Dependencies
dev CI Dependencies

Latest Version Open Issues License

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

multigrep's People

Contributors

pmonks avatar slipset avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

multigrep's Issues

Rename master branch to main

Rename the master branch to main, in accordance with the general move in the development community away from problematic words.

Migrate from midje to clojure.test

Description of Problem:

It's probably past time to port from midje to clojure.test. Despite offering a more pleasant developer experience than clojure.test, midje doesn't seem to be very actively maintained any longer.

Migrate to tools.build for builds

When I am working on this library, I want to use a tools.build-based build script for development- and deployment-time activities, so that I am not reliant on outdated technologies.

Both grep and greplace! use "heisenparameters"

As articulated by Stuart Sierra, the use of function parameters that may either be collections or singletons is an anti-pattern, yet that's exactly how grep and greplace! are implemented, for exactly the reason the article decries (convenience).

Although the fix is technically trivial, it does break backwards compatibility, so this will require some research to try to identify downstream users of the library, and then outreach to those projects' maintainers to ask them whether this fix is worth the pain it will inflict on them.

Add support for JDK 11

Description of Problem:

Now that the latest LTS release of the JDK is out (v11), multigrep's CI test suite should be updated to include it.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.