https://github.com/mbasso/natural-regex

Create regex from natural language
https://github.com/mbasso/natural-regex

javascript natural-language regex

Last synced: 18 days ago
JSON representation

Create regex from natural language

• Host: GitHub
• URL: https://github.com/mbasso/natural-regex
• Owner: mbasso
• License: mit
• Created: 2016-10-17T18:51:25.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-02-26T21:00:21.000Z (over 7 years ago)
• Last Synced: 2024-10-07T14:36:37.657Z (about 1 month ago)
• Topics: javascript, natural-language, regex
• Language: JavaScript
• Homepage:
• Size: 72.3 KB
• Stars: 152
• Watchers: 15
• Forks: 10
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# natural-regex

[![Build Status](https://travis-ci.org/mbasso/natural-regex.svg?branch=master)](https://travis-ci.org/mbasso/natural-regex)

[![npm version](https://img.shields.io/npm/v/natural-regex.svg)](https://www.npmjs.com/package/natural-regex)

[![npm downloads](https://img.shields.io/npm/dm/natural-regex.svg?maxAge=2592000)](https://www.npmjs.com/package/natural-regex)

[![Join the chat at https://gitter.im/mbasso/natural-regex](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/mbasso/natural-regex?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

> Create regex from natural language

---

**Attention - This project isn't completed yet. There might be breaking changes until version 1.0.0. Feel free to contribute, see [TODO](https://github.com/mbasso/natural-regex/blob/master/TODO.md) to get started.**

---

---

[natural-regex](https://github.com/mbasso/natural-regex) is a parser that allows you to write regular expressions in natural language.

This means that you can write self documentating regex using a simpler syntax that can be undestood by anyone.

No more pain with validations and other stuff.

## Installation

You can install natural-regex using [npm](https://www.npmjs.com/package/natural-regex):

```bash

npm install --save natural-regex

```

If you aren't using npm in your project, you can include `NaturalRegex` using UMD build in the dist folder with `` tag.

## Usage

Once you have installed natural-regex, supposing a CommonJS environment, you can import and immediately use it:

```js

import NaturalRegex from 'natural-regex';

// validate string

const dateAndEmail = NaturalRegex.from('starts with dd/MM/yyyy, space, minus, space and then email, end.');

dateAndEmail.test('06/07/2016 - [email protected]'); // this evaluates true

dateAndEmail.test('Foo Bar foo@bar'); // this evaluates false

// replace in string

NaturalRegex.replace({

  string: '06/07/2014 - [email protected]',

  match: 'yyyy',

  replace: '2016',

});

// this returns '06/07/2016 - [email protected]'

```

NaturalRegex also includes a [command line tool](https://github.com/mbasso/natural-regex-cli), check [this](https://github.com/mbasso/natural-regex/wiki/Cli) for more information.

## Documentation

Visit the [Wiki](https://github.com/mbasso/natural-regex/wiki) for the full documentation.

## Examples

Examples can be found [here](https://github.com/mbasso/natural-regex/wiki/Examples)

## Change Log

This project adheres to [Semantic Versioning](http://semver.org/).  

Every release, along with the migration instructions, is documented on the Github [Releases](https://github.com/mbasso/natural-regex/releases) page.

## Authors

**Matteo Basso**

- [github/mbasso](https://github.com/mbasso)

- [@teo_basso](https://twitter.com/teo_basso)

## Copyright and License

Copyright (c) 2016, Matteo Basso.

natural-regex source code is licensed under the [MIT License](https://github.com/mbasso/natural-regex/blob/master/LICENSE.md).