Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pustovitdmytro/curly-express

print all received requests as curl's
https://github.com/pustovitdmytro/curly-express

curl express middleware

Last synced: about 2 months ago
JSON representation

print all received requests as curl's

Awesome Lists containing this project

README 

        
![Logo](.docs/logo_250.png "curly-express")

# curly-express

**curly-express** print all received requests as curls.



[![Version][badge-vers]][npm]

[![Bundle size][npm-size-badge]][npm-size-url]

[![Downloads][npm-downloads-badge]][npm]



[![CodeFactor][codefactor-badge]][codefactor-url]

[![SonarCloud][sonarcloud-badge]][sonarcloud-url]

[![Codacy][codacy-badge]][codacy-url]

[![Scrutinizer][scrutinizer-badge]][scrutinizer-url]



[![Dependencies][badge-deps]][npm]

[![Security][snyk-badge]][snyk-url]

[![Build Status][tests-badge]][tests-url]

[![Coverage Status][badge-coverage]][url-coverage]



[![Commit activity][commit-activity-badge]][github]

[![FOSSA][fossa-badge]][fossa-url]

[![License][badge-lic]][github]

[![Made in Ukraine][ukr-badge]][ukr-link]



## 🇺🇦 Help Ukraine

I woke up on my 26th birthday at 5 am from the blows of russian missiles. They attacked the city of Kyiv, where I live, as well as the cities in which my family and friends live. Now my country is a war zone. 



We fight for democratic values, freedom, for our future! Once again Ukrainians have to stand against evil, terror, against genocide. The outcome of this war will determine what path human history is taking from now on.



💛💙  Help Ukraine! We need your support! There are [dozen ways][ukr-link] to help us, just do it!



## Table of Contents

- [curly-express](#curly-express)

  - [🇺🇦 Help Ukraine](#-help-ukraine)

  - [Table of Contents](#table-of-contents)

  - [Requirements](#requirements)

  - [Installation](#installation)

  - [Usage](#usage)

    - [Default configuration](#default-configuration)

    - [Advanced usage](#advanced-usage)

      - [Customize logger](#customize-logger)

      - [Attach to request](#attach-to-request)

  - [Contribute](#contribute)



## Requirements

[![Platform Status][node-ver-test-badge]][node-ver-test-url]



To use library you need to have [node](https://nodejs.org) and [npm](https://www.npmjs.com) installed in your machine:



* node `>=10`

* npm `>=6`



Package is [continuously tested][node-ver-test-url] on darwin, linux and win32 platforms. All active and maintenance [LTS](https://nodejs.org/en/about/releases/) node releases are supported.



## Installation



To install the library run the following command



```bash

  npm i --save curly-express

```



## Usage



This package can be used as middleware. Note that it must be placed after [body-parser](https://www.npmjs.com/package/body-parser) in order to receive the request body.



### Default configuration



In the default configuration, the middleware will print cURL to stdout:



```javascript

import curl             from 'curly-express';

import express          from 'express';



const app = express();



app.use(bodyParser.json());

app.use(curl);

app.use(router);

```



### Advanced usage



You can customize some stuff by importing the factory method:



#### Customize logger

 

You can pass your own logger as an optional parameter:



```javascript

import { cURL }  from 'curly-express';



const curl =  cURL({

    log : console.log

});



app.use(curl);

```



#### Attach to request



If you need curl in further middlewares, you can do it with optional argument ```attach```:



```javascript

import { cURL }  from 'curly-express';



const curl =  cURL({

    attach : true

});



app.use(curl); // check req._curl

```



it will add curl to ```_curl``` property of the request object. If you want to change the property key, use:



```javascript

const curl =  cURL({

    attach : '_curl_custom_key'

});

```



## Contribute



Make the changes to the code and tests. Then commit to your branch. Be sure to follow the commit message conventions. Read [Contributing Guidelines](.github/CONTRIBUTING.md) for details.



[npm]: https://www.npmjs.com/package/curly-express

[github]: https://github.com/pustovitDmytro/curly-express

[coveralls]: https://coveralls.io/github/pustovitDmytro/curly-express?branch=master

[badge-deps]: https://img.shields.io/librariesio/release/npm/curly-express.svg

[badge-vuln]: https://img.shields.io/snyk/vulnerabilities/npm/curly-express.svg?style=popout

[badge-vers]: https://img.shields.io/npm/v/curly-express.svg

[badge-lic]: https://img.shields.io/github/license/pustovitDmytro/curly-express.svg

[badge-coverage]: https://coveralls.io/repos/github/pustovitDmytro/curly-express/badge.svg?branch=master

[url-coverage]: https://coveralls.io/github/pustovitDmytro/curly-express?branch=master



[snyk-badge]: https://snyk-widget.herokuapp.com/badge/npm/curly-express/badge.svg

[snyk-url]: https://snyk.io/advisor/npm-package/curly-express



[tests-badge]: https://img.shields.io/circleci/build/github/pustovitDmytro/curly-express

[tests-url]: https://app.circleci.com/pipelines/github/pustovitDmytro/curly-express



[codefactor-badge]: https://www.codefactor.io/repository/github/pustovitdmytro/curly-express/badge

[codefactor-url]: https://www.codefactor.io/repository/github/pustovitdmytro/curly-express



[commit-activity-badge]: https://img.shields.io/github/commit-activity/m/pustovitDmytro/curly-express



[scrutinizer-badge]: https://scrutinizer-ci.com/g/pustovitDmytro/curly-express/badges/quality-score.png?b=master

[scrutinizer-url]: https://scrutinizer-ci.com/g/pustovitDmytro/curly-express/?branch=master



[codacy-badge]: https://app.codacy.com/project/badge/Grade/389f7d625cac48a7b487510eead3ba16

[codacy-url]: https://www.codacy.com/gh/pustovitDmytro/curly-express/dashboard?utm_source=github.com&utm_medium=referral&utm_content=pustovitDmytro/curly-express&utm_campaign=Badge_Grade



[sonarcloud-badge]: https://sonarcloud.io/api/project_badges/measure?project=pustovitDmytro_curly-express&metric=alert_status

[sonarcloud-url]: https://sonarcloud.io/dashboard?id=pustovitDmytro_curly-express



[npm-downloads-badge]: https://img.shields.io/npm/dw/curly-express

[npm-size-badge]: https://img.shields.io/bundlephobia/min/curly-express

[npm-size-url]: https://bundlephobia.com/result?p=curly-express



[node-ver-test-badge]: https://github.com/pustovitDmytro/curly-express/actions/workflows/npt.yml/badge.svg?branch=master

[node-ver-test-url]: https://github.com/pustovitDmytro/curly-express/actions?query=workflow%3A%22Node.js+versions%22



[fossa-badge]: https://app.fossa.com/api/projects/custom%2B24828%2Fcurly-express.svg?type=shield

[fossa-url]: https://app.fossa.com/projects/custom%2B24828%2Fcurly-express?ref=badge_shield



[ukr-badge]: https://img.shields.io/badge/made_in-ukraine-ffd700.svg?labelColor=0057b7

[ukr-link]: https://war.ukraine.ua