@pcg/text-kit 1.0.0-alpha.0

package/.turbo/turbo-build.log

@@ -0,0 +1,15 @@
+
+
+> @pcg/text-kit@1.0.0-alpha.0 build /Users/serg_sadovyi/prj/deepvisionsoftware.github/pcg/packages/text-kit
+> tsdown
+
+ℹ tsdown v0.15.12 powered by rolldown v1.0.0-beta.45
+ℹ Using tsdown config: /Users/serg_sadovyi/prj/deepvisionsoftware.github/pcg/packages/text-kit/tsdown.config.ts
+ℹ entry: src/index.ts
+ℹ tsconfig: ../../tsconfig.build.json
+ℹ Build start
+ℹ dist/index.js       9.79 kB │ gzip: 2.42 kB
+ℹ dist/index.js.map  14.23 kB │ gzip: 3.60 kB
+ℹ dist/index.d.ts     8.15 kB │ gzip: 1.67 kB
+ℹ 3 files, total: 32.17 kB
+✔ Build complete in 580ms

package/README.md

@@ -0,0 +1,243 @@
+# @deeepvision/textkit
+
+`@deeepvision/textkit` is a text transformation and manipulation library that provides a collection of utility functions to help you work with strings effortlessly. This package is designed to simplify the process of changing cases, declination, pluralization, and more.
+
+## Features
+
+* Case conversion (PascalCase, camelCase, param-case, snake_case, CONSTANT_CASE)
+* Sentence transformation (to sentence, upper cased sentence, lower cased sentence)
+* Abbreviation generation
+* Declination based on number
+* Pluralization and singularization
+  
+## Installation
+
+Install the package using npm or yarn:
+
+```bash
+npm install @deeepvision/textkit
+```
+
+## Usage
+
+Import and use the desired functions from the package:
+
+```ts
+import {
+  ucfirst,
+  pascalCase,
+  camelCase,
+  // ...
+  decline,
+  singularToPlural,
+  pluralToSingular,
+} from '@deeepvision/textkit';
+
+// Change cases
+const upperFirstChar = ucfirst('hello');
+const pascal = pascalCase('hello world');
+const camel = camelCase('hello world');
+// ...
+
+// Declination
+const declinedNoun = decline('apple', 3);
+
+// Pluralization
+const plural = singularToPlural('cat');
+const singular = pluralToSingular('cats');
+```
+
+For a comprehensive list of available functions, please refer to the feature list provided in the package description.
+
+## API
+
+### Case conversion
+
+#### `ucfirst(string: string): string`
+
+Convert a string to string with the first character in uppercase.
+
+```ts
+ucfirst('hello world'); // Hello world
+ucfirst('HELLO WORLD'); // Hello world
+```
+
+#### `lcfirst(string: string): string`
+
+Convert a string to string with the first character in lower case.
+
+```ts
+lcfirst('Hello world'); // hello world
+```
+
+#### `pascalCase(string: string): string`
+
+Convert a string to `PascalCase`.
+
+```ts
+pascalCase('simple') //=> "Simple"
+pascalCase('some.dot.case') //=> "SomeDotCase"
+pascalCase('some-param-case') //=> "SomeParamCase"
+pascalCase('some spaced case') //=> "SomeSpacedCase"
+pascalCase('someCamelCase')) //=> "SomeCamelCase"
+pascalCase('SomePascalCase') //=> "SomePascalCase"
+```
+
+#### `camelCase(string: string): string`
+
+Convert a string to camelCase.
+
+```ts
+camelCase('simple') //=> "simple"
+camelCase('some.dot.case') //=> "someDotCase"
+camelCase('some-param-case') //=> "someParamCase"
+camelCase('some spaced case') //=> "someSpacedCase"
+camelCase('someCamelCase')) //=> "someCamelCase"
+camelCase('SomePascalCase') //=> "somePascalCase"
+```
+
+#### `paramCase(string: string): string` - Convert a string to param-case.
+
+```ts
+paramCase('simple') //=> "simple"
+paramCase('some.dot.case') //=> "some-dot-case"
+paramCase('some-param-case') //=> "some-param-case"
+paramCase('some spaced case') //=> "some-spaced-case"
+paramCase('someCamelCase')) //=> "some-camel-case"
+paramCase('SomePascalCase') //=> "some-pascal-case"
+```
+
+#### `snakeCase(string: string): string`
+
+Convert a string to snake_case.
+
+```ts
+camelCase('simple') //=> "simple"
+camelCase('some.dot.case') //=> "some_dot_case"
+camelCase('some-param-case') //=> "some_param_case"
+camelCase('some spaced case') //=> "some_spaced_case"
+camelCase('someCamelCase')) //=> "some_camel_case"
+camelCase('SomePascalCase') //=> "some_pascal_case"
+```
+
+#### `constantCase(string: string): string`
+
+Convert a string to CONSTANT_CASE.
+
+```ts
+constantCase('foo bar'); //=> 'FOO_BAR'
+constantCase('foo_bar'); //=> 'FOO_BAR'
+constantCase('foo-bar'); //=> 'FOO_BAR'
+constantCase('foo.bar'); //=> 'FOO_BAR'
+constantCase('fooBar'); //=> 'FOO_BAR'
+constantCase('FooBar'); //=> 'FOO_BAR'
+```
+
+### Sentence transformation
+
+#### `toSentence(string: string): string`
+
+Convert a string to sentence.
+
+```ts
+toSentence('foo bar'); //=> 'Foo bar'
+toSentence('foo_bar'); //=> 'Foo bar'
+toSentence('foo-bar'); //=> 'Foo bar'
+toSentence('foo.bar'); //=> 'Foo bar'
+toSentence('fooBar'); //=> 'Foo bar'
+toSentence('FooBar'); //=> 'Foo bar'
+toSentence('foo bar baz'); //=> 'Foo bar baz'
+```
+
+#### `toUcSentence(string: string): string`
+
+Convert a string to upper cased sentence.
+
+```ts
+toUcSentence('foo bar'); //=> 'Foo Bar'
+toUcSentence('foo_bar'); //=> 'Foo Bar'
+toUcSentence('foo-bar'); //=> 'Foo Bar'
+toUcSentence('foo.bar'); //=> 'Foo Bar'
+toUcSentence('fooBar'); //=> 'Foo Bar'
+toUcSentence('FooBar'); //=> 'Foo Bar'
+toUcSentence('foo bar baz'); //=> 'Foo Bar Baz'
+```
+
+#### `toLcSentence(string: string): string`
+
+Convert a string to lower cased sentence.
+
+```ts
+toLcSentence('foo bar'); //=> 'foo bar'
+toLcSentence('foo_bar'); //=> 'foo bar'
+toLcSentence('foo-bar'); //=> 'foo bar'
+toLcSentence('foo.bar'); //=> 'foo bar'
+toLcSentence('fooBar'); //=> 'foo bar'
+toLcSentence('FooBar'); //=> 'foo bar'
+toLcSentence('Foo bar baz'); //=> 'foo bar baz'
+```
+
+### SQL alias and abbreviation
+
+#### `toSqlAlias(string: string): string`
+
+Convert a table name to SQL alias.
+  
+```ts
+toSqlAlias('foo bar'); //=> 'fb'
+toSqlAlias('book'); //=> 'b'
+toSqlAlias('article-category'); //=> 'ac'
+```
+
+#### `toAbbreviation(string: string): string`
+
+Convert a string to abbreviation.
+
+```ts
+toAbbreviation('Deep Vision'); //=> 'DV'
+toAbbreviation('Рожеві окуляри', {
+  lang: 'uk',
+}); //=> 'RO'
+toAbbreviation('Удивительные факты', {
+  lang: 'ru'
+}); //=> 'UF'
+toAbbreviation('The very long title that can be shorter but I love long titles', {
+  maxLength: 3
+}); //=> 'TVL'
+toAbbreviation('Vision'); //=> 'VSN'
+toAbbreviation('Deep Vision', {
+  iteration: 1,
+}); //=> 'DV1'
+```
+
+### Declination
+
+#### `decline(noun: string, number: number): string`
+
+Decline a noun based on a number.
+
+```ts
+const words = ['элемент', 'элемента', 'элементов'];
+
+decline(0, words, false) // => 'элементов'
+decline(24, words, false) // => 'элемента'
+decline(21, words, false) // => 'элемент'
+```
+
+### Pluralization
+
+#### `singularToPlural(singular: string): string` 
+  
+Change the plural form of a word to its singular form.
+
+```ts
+singularToPlural('book'); //=> 'books'
+```
+
+#### `pluralToSingular(plural: string): string`
+
+Change the singular form of a word to its plural form.
+
+```ts
+pluralToSingular('books'); //=> 'book'
+```

package/dist/index.d.ts

@@ -0,0 +1,243 @@
+//#region src/cases.d.ts
+/**
+ * Convert a string to string with the first character in uppercase.
+ * @example
+ * ucfirst('hello world'); // Hello world
+**/
+declare const ucfirst: (input: string) => string;
+/**
+ * Convert a string to string with the first character in lower case.
+ * @example
+ * lcfirst('Hello world'); // hello world
+ **/
+declare const lcfirst: (input: string) => string;
+/**
+ * Convert a string to PascalCase.
+ * @example
+ * pascalCase('foo bar'); //=> 'FooBar'
+ * pascalCase('foo_bar'); //=> 'FooBar'
+ * pascalCase('foo-bar'); //=> 'FooBar'
+ * pascalCase('foo.bar'); //=> 'FooBar'
+ * pascalCase('fooBar'); //=> 'FooBar'
+**/
+declare const pascalCase: (input: string) => string;
+/**
+ * Convert a string to camelCase.
+ * @example
+ * camelCase('foo bar'); //=> 'fooBar'
+ * camelCase('foo_bar'); //=> 'fooBar'
+ * camelCase('foo-bar'); //=> 'fooBar'
+ * camelCase('foo.bar'); //=> 'fooBar'
+ * camelCase('fooBar'); //=> 'fooBar'
+ * camelCase('FooBar'); //=> 'fooBar'
+**/
+declare const camelCase: (input: string) => string;
+/**
+ * Convert a string to param-case.
+ * @example
+ * paramCase('foo bar'); //=> 'foo-bar'
+ * paramCase('foo_bar'); //=> 'foo-bar'
+ * paramCase('foo-bar'); //=> 'foo-bar'
+ * paramCase('foo.bar'); //=> 'foo-bar'
+ * paramCase('fooBar'); //=> 'foo-bar'
+ * paramCase('FooBar'); //=> 'foo-bar'
+**/
+declare const paramCase: (input: string) => string;
+/**
+ * Convert a string to "dot.case".
+ * @example
+ * dotCase('foo bar'); //=> 'foo.bar'
+ * dotCase('foo_bar'); //=> 'foo.bar'
+ * dotCase('foo-bar'); //=> 'foo.bar'
+ * dotCase('foo.bar'); //=> 'foo.bar'
+ * dotCase('fooBar'); //=> 'foo.bar'
+ * dotCase('FooBar'); //=> 'foo.bar'
+**/
+declare const dotCase: (input: string) => string;
+/**
+ * Convert a string to snake_case.
+ * @example
+ * snakeCase('foo bar'); //=> 'foo_bar'
+ * snakeCase('foo_bar'); //=> 'foo_bar'
+ * snakeCase('foo-bar'); //=> 'foo_bar'
+ * snakeCase('foo.bar'); //=> 'foo_bar'
+ * snakeCase('fooBar'); //=> 'foo_bar'
+ * snakeCase('FooBar'); //=> 'foo_bar'
+**/
+declare const snakeCase: (input: string) => string;
+/**
+ * Convert a string to CONSTANT_CASE.
+ * @example
+ * constantCase('foo bar'); //=> 'FOO_BAR'
+ * constantCase('foo_bar'); //=> 'FOO_BAR'
+ * constantCase('foo-bar'); //=> 'FOO_BAR'
+ * constantCase('foo.bar'); //=> 'FOO_BAR'
+ * constantCase('fooBar'); //=> 'FOO_BAR'
+ * constantCase('FooBar'); //=> 'FOO_BAR'
+**/
+declare const constantCase: (input: string) => string;
+/**
+ * Convert a string to sentence.
+ * @deprecated use sentenceCase instead
+ * @example
+ * toSentence('foo bar'); //=> 'Foo bar'
+ * toSentence('foo_bar'); //=> 'Foo bar'
+ * toSentence('foo-bar'); //=> 'Foo bar'
+ * toSentence('foo.bar'); //=> 'Foo bar'
+ * toSentence('fooBar'); //=> 'Foo bar'
+ * toSentence('FooBar'); //=> 'Foo bar'
+ * toSentence('foo bar baz'); //=> 'Foo bar baz'
+**/
+declare const toSentence: (input: string) => string;
+/**
+ * Convert a string to sentence.
+ * @example
+ * sentenceCase('foo bar'); //=> 'Foo bar'
+ * sentenceCase('foo_bar'); //=> 'Foo bar'
+ * sentenceCase('foo-bar'); //=> 'Foo bar'
+ * sentenceCase('foo.bar'); //=> 'Foo bar'
+ * sentenceCase('fooBar'); //=> 'Foo bar'
+ * sentenceCase('FooBar'); //=> 'Foo bar'
+ * sentenceCase('foo bar baz'); //=> 'Foo bar baz'
+**/
+declare const sentenceCase: (input: string) => string;
+/**
+ * Convert a string to upper cased sentence.
+ * @deprecated use capitalCase instead
+ * @example
+ * toUcSentence('foo bar'); //=> 'Foo Bar'
+ * toUcSentence('foo_bar'); //=> 'Foo Bar'
+ * toUcSentence('foo-bar'); //=> 'Foo Bar'
+ * toUcSentence('foo.bar'); //=> 'Foo Bar'
+ * toUcSentence('fooBar'); //=> 'Foo Bar'
+ * toUcSentence('FooBar'); //=> 'Foo Bar'
+ * toUcSentence('foo bar baz'); //=> 'Foo Bar Baz'
+**/
+declare const toUcSentence: (input: string) => string;
+/**
+ * Convert a string to upper cased sentence.
+ * @example
+ * capitalCase('foo bar'); //=> 'Foo Bar'
+ * capitalCase('foo_bar'); //=> 'Foo Bar'
+ * capitalCase('foo-bar'); //=> 'Foo Bar'
+ * capitalCase('foo.bar'); //=> 'Foo Bar'
+ * capitalCase('fooBar'); //=> 'Foo Bar'
+ * capitalCase('FooBar'); //=> 'Foo Bar'
+ * capitalCase('foo bar baz'); //=> 'Foo Bar Baz'
+**/
+declare const capitalCase: (input: string) => string;
+/**
+ * Alias to "toUcSentence"
+ * @deprecated use capitalCase instead
+**/
+declare const capitalize: (input: string) => string;
+/**
+ * Convert a string to lower cased sentence.
+ * @deprecated use lowerSentenceCase instead
+ * @example
+ * toLcSentence('foo bar'); //=> 'foo bar'
+ * toLcSentence('foo_bar'); //=> 'foo bar'
+ * toLcSentence('foo-bar'); //=> 'foo bar'
+ * toLcSentence('foo.bar'); //=> 'foo bar'
+ * toLcSentence('fooBar'); //=> 'foo bar'
+ * toLcSentence('FooBar'); //=> 'foo bar'
+ * toLcSentence('Foo bar baz'); //=> 'foo bar baz'
+**/
+declare const toLcSentence: (input: string) => string;
+/**
+ * Convert a string to lower cased sentence.
+ * @example
+ * lowerSentenceCase('foo bar'); //=> 'foo bar'
+ * lowerSentenceCase('foo_bar'); //=> 'foo bar'
+ * lowerSentenceCase('foo-bar'); //=> 'foo bar'
+ * lowerSentenceCase('foo.bar'); //=> 'foo bar'
+ * lowerSentenceCase('fooBar'); //=> 'foo bar'
+ * lowerSentenceCase('FooBar'); //=> 'foo bar'
+ * lowerSentenceCase('Foo bar baz'); //=> 'foo bar baz'
+**/
+declare const lowerSentenceCase: (input: string) => string;
+/**
+ * Convert a table name to sql alias.
+ * @example
+ * toSqlAlias('foo bar'); //=> 'fb'
+ * toSqlAlias('book'); //=> 'b'
+ * toSqlAlias('article-category'); //=> 'ac'
+**/
+declare const toSqlAlias: (input: string) => string;
+interface ToAbbreviationOptions {
+  maxLength?: number;
+  minLength?: number;
+  lang?: 'uk' | 'ru' | 'mn';
+  iteration?: number;
+}
+/**
+ * Remove vowels from a word.
+ * @param word - word to remove vowels from
+ * @returns word without vowels
+ * @example
+ * removeVowels('foo'); //=> 'f'
+ */
+declare const removeVowels: (word: string) => string;
+/**
+ * Convert a string to abbreviation.
+ * @example
+ * toAbbreviation('Sabbath Schook'); //=> 'SB'
+ * toAbbreviation('Рожеві окуляри', {
+ *  lang: 'uk',
+ * }); //=> 'RO'
+ * toAbbreviation('Удивительные факты', {
+ *  lang: 'ru',
+ * }); //=> 'UF'
+ */
+declare const toAbbreviation: (input: string, opts?: ToAbbreviationOptions) => string;
+//#endregion
+//#region src/declination.d.ts
+/**
+ * Decline a noun based on a number.
+ * @example
+ * const words = ['элемент', 'элемента', 'элементов'];
+ *
+ * decline(0, words, false) // => 'элементов'
+ * decline(24, words, false) // => 'элемента'
+ * decline(21, words, false) // => 'элемент'
+ *
+ * decline(0, words) // => '0 элементов'
+ * decline(24, words) // => '24 элемента'
+ * decline(21, words) // => '21 элемент'
+ */
+declare const decline: (n: number, words: string[], concat?: boolean) => string;
+//#endregion
+//#region src/generators.d.ts
+declare const createRandomString: (size?: number) => string;
+declare const createRandomAbbreviationString: (size?: number) => string;
+declare const createNumericCode: (num: number, length: number) => string;
+//#endregion
+//#region src/pluralize.d.ts
+/**
+ * Change the plural form of a word to its singular form.
+ * @example
+ * pluralToSingular('books'); //=> 'book'
+ */
+declare const singularToPlural: (input: string) => string;
+/**
+ * Change the singular form of a word to its plural form.
+ * @example
+ * singularToPlural('book'); //=> 'books'
+ */
+declare const pluralToSingular: (input: string) => string;
+/**
+ * Checks if a given word is in its plural form.
+ *
+ * @param word - The word to check for plural form
+ * @returns `true` if the word is plural, `false` if it's singular
+ *
+ * @example
+ * ```typescript
+ * isPlural("cats"); // true
+ * isPlural("cat");  // false
+ * ```
+ */
+declare const isPlural: (word: string) => boolean;
+//#endregion
+export { ToAbbreviationOptions, camelCase, capitalCase, capitalize, constantCase, createNumericCode, createRandomAbbreviationString, createRandomString, decline, dotCase, isPlural, lcfirst, lowerSentenceCase, paramCase, pascalCase, pluralToSingular, removeVowels, sentenceCase, singularToPlural, snakeCase, toAbbreviation, toLcSentence, toSentence, toSqlAlias, toUcSentence, ucfirst };
+//# sourceMappingURL=index.d.ts.map