TS Cornucopia

Description

The objective of this package is to aggregate small pieces of code that are easily needed in many projects of different scopes.

The idea came after tinkering for some years with different approaches to sharing codes between my own projects, resulting in different headaches. So why not simply bundle those inside an NPM package? And why not just leave it open source in case this can help someone else? So, here we are...

Table of Contents

• Installation
• Usage
• Tests
• Contributing
• License

Installation

npm install ts-cornucopia

Usage

To simplify this section, each separate function will have its own documentation file (linked on the name), and here I only list them all with a brief explanation:

File

• executeOnFiles: This function is used to iterate inside a directory (recursivity as an option) and then execute a function with the path of each file found inside.

• executeOnFolders: This function is used to iterate inside a directory (recursivity as an option) and then execute a function with the path of each folder found, including the root folder of the execution.

• proccessTemplate: This function reads a file, replaces all iterations of named placeholders with values passed.

Number

• numberFormat: This function converts a number into a string and adds a separator every three integer digits.

• randomRange: This function returns a random integer between two values.

Scripts

• indexer: This function will generate a index file that imports and exports all other files of the same folder.

String

• cammelToSpace: This function detects cammelcase and adds a space behind every word, it also adds uppercase to the first letter of the first word.

• firstToUppercase: This function returns the given string with the changed first letter to be uppercase.

Tests

To guarantee conformity after bundling the test script runs only with the bundled codes. Which means you have to build before running it:

npm run build

npm run test

Roadmap

• 4.0.0:
  • Merge of executeOnFolders and executeOnFiles into a single function since there is too much overlap between the two and a few extra options could be added to make the final function have returns on par with both situations.
  • Creation of executeOnFilesSync and conversion of executeOnFiles into an async function so the final function is more similar to "fs"'s patterns.