Skip to content

Latest commit

 

History

History
104 lines (67 loc) · 3.53 KB

README.md

File metadata and controls

104 lines (67 loc) · 3.53 KB
Raw

Pluralize Ballerina Connector

Build codecov GitHub Last Commit GitHub Issues

The pluralize Ballerina Connector is designed to assist with the pluralization and singularization of English words. This can be particularly useful when generating dynamic strings based on numerical values.

This module utilizes a predefined list of rules, applied sequentially, to singularize or pluralize a given word. This can be beneficial in many scenarios, such as automating tasks based on user input. For applications where the words are known in advance, a simple ternary (or function) can be used as a lighter alternative.

This module is a migration of the pluralize library by Blake Embrey. All credit goes to him.

Quickstart

To use the pluralize connector in your Ballerina application, modify the .bal file as follows:

Step 1: Import the module

Import the pluralize module.

import niveathika/pluralize;

Step 2: Invoke the connector operation

Now, utilize the available connector operations.

pluralize:pluralize('test'); //=> "tests"
pluralize:pluralize('test', 0); //=> "tests"
pluralize:pluralize('test', 1); //=> "test"
pluralize:pluralize('test', 5); //=> "tests"
pluralize:pluralize('test', 1, true); //=> "1 test"
pluralize:pluralize('test', 5, true); //=> "5 tests"
pluralize:pluralize('蘋果', 2, true); //=> "2 蘋果"

pluralize:isPlural("test"); // false
pluralize:isPlural("tests"); // true

Step 3: Run the Ballerina application

bal run

Build from the source

Prerequisites

  1. Download and install Java SE Development Kit (JDK) version 17. You can download it from either of the following sources:

    Note: After installation, remember to set the JAVA_HOME environment variable to the directory where JDK was installed.

  2. Download and install Ballerina Swan Lake.

  3. Download and install Docker.

    Note: Ensure that the Docker daemon is running before executing any tests.

Build options

Execute the commands below to build from the source.

  1. To build the package:

    ./gradlew clean build

  2. To run the tests:

    ./gradlew clean test

  3. To build the without the tests:

    ./gradlew clean build -x test

  4. To debug package with a remote debugger:

    ./gradlew clean build -Pdebug=<port>

  5. Publish the generated artifacts to the local Ballerina Central repository:

    ./gradlew clean build -PpublishToLocalCentral=true

  6. Publish the generated artifacts to the Ballerina Central repository:

    ./gradlew clean build -PpublishToCentral=true