https://github.com/ballerina-platform/module-ballerina-regex

Ballerina Regex Module
https://github.com/ballerina-platform/module-ballerina-regex

ballerina hacktoberfest integration match regex replace string wso2

Last synced: 5 months ago
JSON representation

Ballerina Regex Module

• Host: GitHub
• URL: https://github.com/ballerina-platform/module-ballerina-regex
• Owner: ballerina-platform
• License: apache-2.0
• Created: 2021-01-06T06:18:36.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2025-03-03T18:18:43.000Z (over 1 year ago)
• Last Synced: 2025-03-03T19:27:44.706Z (over 1 year ago)
• Topics: ballerina, hacktoberfest, integration, match, regex, replace, string, wso2
• Language: Ballerina
• Homepage:
• Size: 753 KB
• Stars: 108
• Watchers: 69
• Forks: 22
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
Ballerina Regex Library [DEPRECATED]

==============================

  [![Build](https://github.com/ballerina-platform/module-ballerina-regex/actions/workflows/build-timestamped-master.yml/badge.svg)](https://github.com/ballerina-platform/module-ballerina-regex/actions/workflows/build-timestamped-master.yml)

  [![codecov](https://codecov.io/gh/ballerina-platform/module-ballerina-regex/branch/main/graph/badge.svg)](https://codecov.io/gh/ballerina-platform/module-ballerina-regex)

  [![Trivy](https://github.com/ballerina-platform/module-ballerina-regex/actions/workflows/trivy-scan.yml/badge.svg)](https://github.com/ballerina-platform/module-ballerina-regex/actions/workflows/trivy-scan.yml)

  [![GraalVM Check](https://github.com/ballerina-platform/module-ballerina-regex/actions/workflows/build-with-bal-test-graalvm.yml/badge.svg)](https://github.com/ballerina-platform/module-ballerina-regex/actions/workflows/build-with-bal-test-graalvm.yml)  

  [![GitHub Last Commit](https://img.shields.io/github/last-commit/ballerina-platform/module-ballerina-regex.svg)](https://github.com/ballerina-platform/module-ballerina-regex/commits/main)

  [![Github issues](https://img.shields.io/github/issues/ballerina-platform/ballerina-standard-library/module/regex.svg?label=Open%20Issues)](https://github.com/ballerina-platform/ballerina-standard-library/labels/module%2Fregex)

**Deprecation Notice:** This library is deprecated and will no longer be maintained or updated. Instead, it is recommended to use the [`ballerina/lang.regexp`](https://lib.ballerina.io/ballerina/lang.regexp/latest) library for continued support and updates. For more information, see the new [RegExp type example](https://ballerina.io/by-example/regexp-type), [RegExp operations example](https://ballerina.io/by-example/regexp-operations), and [Regular expressions feature guide](https://ballerina.io/learn/distinctive-language-features/advanced-general-purpose-language-features/#regular-expressions).

This module provides APIs for searching, splitting, and replacing the set of characters of a string. These APIs are using a

regular expression as a `String` to perform these operations by finding the string matches.

[Regular expressions](https://en.wikipedia.org/wiki/Regular_expression), are notations for describing sets of

character strings. If a particular string is in the set described by a regular expression, the regular expression matches that string.

For a quick sample on demonstrating the usage, see [Ballerina By Examples](https://ballerina.io/learn/by-example/).

## Issues and projects

The **Issues** and **Projects** tabs are disabled for this repository as this is part of the Ballerina Standard Library. To report bugs, request new features, start new discussions, view project boards, etc., go to the Ballerina Standard Library [parent repository](https://github.com/ballerina-platform/ballerina-standard-library). 

This repository contains only the source code of the package.

## Build from the source

### Set up the prerequisites

* Download and install Java SE Development Kit (JDK) version 21 (from one of the following locations).

   * [Oracle](https://www.oracle.com/java/technologies/downloads/)

   

   * [OpenJDK](https://adoptium.net/)

   

        > **Note:** Set the JAVA_HOME environment variable to the path name of the directory into which you installed JDK.

### Build the source

Execute the commands below to build from the source.

1. To build the library:

        ./gradlew clean build

2. To run the integration tests:

        ./gradlew clean test

3. To build the package without the tests:

        ./gradlew clean build -x test

4. To debug the tests:

        ./gradlew clean build -Pdebug=

        

5. To debug the package with Ballerina language:

   

        ./gradlew clean build -PbalJavaDebug=

6. Publish ZIP artifact to the local `.m2` repository:

        ./gradlew clean build publishToMavenLocal

7. Publish the generated artifacts to the local Ballerina central repository:

   

        ./gradlew clean build -PpublishToLocalCentral=true

8. Publish the generated artifacts to the Ballerina central repository:

        ./gradlew clean build -PpublishToCentral=true

        

## Contribute to Ballerina

As an open source project, Ballerina welcomes contributions from the community. 

For more information, go to the [contribution guidelines](https://github.com/ballerina-platform/ballerina-lang/blob/master/CONTRIBUTING.md).

## Code of conduct

All contributors are encouraged to read the [Ballerina Code of Conduct](https://ballerina.io/code-of-conduct).

## Useful links

* For more information go to the [`regex` library](https://lib.ballerina.io/ballerina/regex/latest).

* For example demonstrations of the usage, go to [Ballerina By Examples](https://ballerina.io/learn/by-example/).

* Chat live with us on our [Discord server](https://discord.gg/ballerinalang).

* Technical questions should be posted on Stack Overflow with the [#ballerina](https://stackoverflow.com/questions/tagged/ballerina) tag.