locutus 2.0.31 → 2.0.34

package/README.md

@@ -0,0 +1,84 @@
+# Locutus
+
+[![CI](https://github.com/locutusjs/locutus/actions/workflows/ci.yml/badge.svg)](https://github.com/locutusjs/locutus/actions/workflows/ci.yml)
+[![npm version](https://img.shields.io/npm/v/locutus.svg)](https://www.npmjs.com/package/locutus)
+[![Verified: PHP 8.3](https://img.shields.io/badge/verified-PHP%208.3-777BB4.svg)](https://locutus.io/php/)
+[![Verified: Python 3.12](https://img.shields.io/badge/verified-Python%203.12-3776AB.svg)](https://locutus.io/python/)
+
+> All your standard libraries will be assimilated into our JavaScript collective. Resistance is futile.
+
+Welcome to Locutus, where the boundaries of coding languages blur. We're a dedicated collective developers on a mission
+to explore the possibilities of porting standard libraries from various programming language (Go, Ruby, PHP, C) to
+JavaScript. Our journey is one of discovery, innovation, and sometimes, delightful chaos.
+
+From the complex to the quirky, we assimilate libraries with a spirit of curiosity and a penchant for experimentation.
+Our creations typically start as rainy Sunday afternoon puzzles, and end up ranging from groundbreaking functions that
+enhance the JavaScript ecosystem, to unique oddities that challenge the norms of coding.
+
+As we navigate through this uncharted territory, we invite you to join us. Whether to contribute, learn, or simply
+marvel at the wonders of cross-language integration and portability, your presence on GitHub is valued.
+
+Embark on this journey with us at [locutus.io](https://locutus.io/).
+
+Use our creations at your own risk, and may they inspire you to push the boundaries of what's possible with JavaScript.
+
+## Table of contents
+
+- [Install](#install)
+- [Use](#use)
+- [Development](#development)
+- [License](#license)
+
+## Install
+
+```bash
+yarn add locutus
+```
+
+## Use
+
+```bash
+$ vim php.js
+```
+
+```javascript
+const sprintf = require('locutus/php/strings/sprintf')
+const echo = require('locutus/php/strings/echo')
+const effectiveness = 'futile'
+echo(sprintf('Resistance is %s', effectiveness))
+```
+
+```bash
+$ node php.js
+Resistance is futile
+```
+
+```bash
+$ vim go.js
+```
+
+```javascript
+const strings = require('locutus/golang/strings')
+console.log(strings.Contains('Locutus', 'cut'))
+```
+
+```bash
+$ node go.js
+true
+```
+
+## Development
+
+Some guidelines and instructions can be found in [CONTRIBUTING.md](CONTRIBUTING.md)
+
+Quick commands:
+
+- `yarn check` - format + lint + test
+- `yarn test:parity` - cross-language verification
+- `yarn test` - full test suite
+- `yarn lint` - Biome check
+- `yarn fix:biome` - auto-fix
+
+## License
+
+MIT, except for `src/php/bc/` and `src/php/_helpers/_bc.js` which are LGPL-2.1 (derived from PHP's bcmath/Libbcmath). See [LICENSE](LICENSE) for details.

package/_data/rosetta.yml

@@ -0,0 +1,325 @@
+# Rosetta Stone Mappings
+# Maps semantically equivalent functions across languages.
+# When adding a new function, check if an equivalent exists and add it here.
+# Format: group_name -> list of "language/category/function" paths
+#
+# IMPORTANT: Keep this file updated when adding functions!
+# See CONTRIBUTING.md for details.
+
+# =============================================================================
+# STRING OPERATIONS
+# =============================================================================
+
+string_length:
+  - php/strings/strlen
+  - c/string/strlen
+  - ruby/String/length
+  - perl/core/length
+  - awk/builtin/length
+
+string_lowercase:
+  - php/strings/strtolower
+  - ruby/String/downcase
+  - golang/strings/ToLower
+
+string_uppercase:
+  - php/strings/strtoupper
+  - ruby/String/upcase
+  - golang/strings/ToUpper
+
+string_trim:
+  - php/strings/trim
+  - ruby/String/strip
+  - golang/strings/TrimSpace
+  - golang/strings/Trim
+
+string_rtrim:
+  - php/strings/rtrim
+  - php/strings/chop
+  - ruby/String/chop
+  - ruby/String/chomp
+
+string_contains:
+  - golang/strings/Contains
+  - ruby/String/include
+
+string_starts_with:
+  - golang/strings/HasPrefix
+  - ruby/String/start_with
+
+string_ends_with:
+  - golang/strings/HasSuffix
+  - ruby/String/end_with
+
+string_reverse:
+  - php/strings/strrev
+  - ruby/String/reverse
+
+string_split:
+  - php/strings/explode
+  - golang/strings/Split
+
+string_join:
+  - php/strings/implode
+  - golang/strings/Join
+
+string_replace:
+  - php/strings/str_replace
+  - golang/strings/Replace
+
+string_index:
+  - php/strings/strpos
+  - golang/strings/Index
+  - golang/strings/Index2
+
+string_last_index:
+  - php/strings/strrpos
+  - golang/strings/LastIndex
+
+string_repeat:
+  - php/strings/str_repeat
+  - golang/strings/Repeat
+
+string_capitalize:
+  - php/strings/ucfirst
+  - ruby/String/capitalize
+
+string_compare:
+  - php/strings/strcmp
+  - c/string/strcmp
+  - golang/strings/Compare
+
+string_substring_search:
+  - php/strings/strstr
+  - c/string/strstr
+
+string_char_search:
+  - php/strings/strchr
+  - c/string/strchr
+
+string_count:
+  - php/strings/substr_count
+  - golang/strings/Count
+
+string_substring:
+  - php/strings/substr
+  - awk/builtin/substr
+
+# =============================================================================
+# MATH OPERATIONS
+# =============================================================================
+
+math_sqrt:
+  - php/math/sqrt
+  - python/math/sqrt
+  - ruby/Math/sqrt
+
+math_exp:
+  - php/math/exp
+  - python/math/exp
+  - ruby/Math/exp
+
+math_log:
+  - php/math/log
+  - python/math/log
+  - ruby/Math/log
+
+math_log10:
+  - php/math/log10
+  - python/math/log10
+  - ruby/Math/log10
+
+math_log2:
+  - python/math/log2
+  - ruby/Math/log2
+
+math_sin:
+  - php/math/sin
+  - ruby/Math/sin
+
+math_cos:
+  - php/math/cos
+  - ruby/Math/cos
+
+math_tan:
+  - php/math/tan
+  - ruby/Math/tan
+
+math_asin:
+  - php/math/asin
+  - ruby/Math/asin
+
+math_acos:
+  - php/math/acos
+  - ruby/Math/acos
+
+math_atan:
+  - php/math/atan
+  - ruby/Math/atan
+
+math_sinh:
+  - php/math/sinh
+  - ruby/Math/sinh
+
+math_cosh:
+  - php/math/cosh
+  - ruby/Math/cosh
+
+math_tanh:
+  - php/math/tanh
+  - ruby/Math/tanh
+
+math_ceil:
+  - php/math/ceil
+  - python/math/ceil
+  - perl/POSIX/ceil
+  - lua/math/ceil
+  - r/base/ceiling
+  - julia/Base/ceil
+  - elixir/Float/ceil
+  - clojure/Math/ceil
+
+math_floor:
+  - php/math/floor
+  - python/math/floor
+  - perl/POSIX/floor
+  - lua/math/floor
+  - r/base/floor
+  - julia/Base/floor
+  - elixir/Float/floor
+  - clojure/Math/floor
+
+math_abs:
+  - php/math/abs
+  - c/math/abs
+  - lua/math/abs
+  - r/base/abs
+  - julia/Base/abs
+  - elixir/Kernel/abs
+  - clojure/Math/abs
+
+math_fabs:
+  - python/math/fabs
+
+math_pow:
+  - php/math/pow
+  - python/math/pow
+
+math_cbrt:
+  - ruby/Math/cbrt
+
+math_trunc:
+  - python/math/trunc
+  - awk/builtin/int
+
+math_factorial:
+  - python/math/factorial
+
+math_gcd:
+  - python/math/gcd
+
+math_isfinite:
+  - php/math/is_finite
+  - python/math/isfinite
+
+math_isinf:
+  - php/math/is_infinite
+  - python/math/isinf
+
+math_isnan:
+  - php/math/is_nan
+  - python/math/isnan
+
+# =============================================================================
+# CHARACTER TYPE CHECKING
+# =============================================================================
+
+char_isalnum:
+  - php/ctype/ctype_alnum
+  - c/ctype/isalnum
+
+char_isalpha:
+  - php/ctype/ctype_alpha
+  - c/ctype/isalpha
+
+char_isdigit:
+  - php/ctype/ctype_digit
+  - c/ctype/isdigit
+
+char_islower:
+  - php/ctype/ctype_lower
+  - c/ctype/islower
+
+char_isupper:
+  - php/ctype/ctype_upper
+  - c/ctype/isupper
+
+char_isspace:
+  - php/ctype/ctype_space
+  - c/ctype/isspace
+
+char_tolower:
+  - c/ctype/tolower
+
+char_toupper:
+  - c/ctype/toupper
+
+# =============================================================================
+# TYPE CONVERSION
+# =============================================================================
+
+string_to_int:
+  - php/var/intval
+  - c/stdlib/atoi
+  - golang/strconv/Atoi
+
+int_to_string:
+  - golang/strconv/Itoa
+
+string_to_float:
+  - c/stdlib/atof
+
+parse_int:
+  - golang/strconv/ParseInt
+
+format_int:
+  - golang/strconv/FormatInt
+
+parse_bool:
+  - golang/strconv/ParseBool
+
+format_bool:
+  - golang/strconv/FormatBool
+
+# =============================================================================
+# ARRAY/COLLECTION OPERATIONS
+# =============================================================================
+
+array_first:
+  - php/array/reset
+  - ruby/Array/first
+
+array_last:
+  - php/array/end
+  - ruby/Array/last
+
+array_unique:
+  - php/array/array_unique
+  - ruby/Array/uniq
+
+array_flatten:
+  - ruby/Array/flatten
+
+array_compact:
+  - ruby/Array/compact
+
+array_sample:
+  - ruby/Array/sample
+
+# =============================================================================
+# FORMATTING
+# =============================================================================
+
+sprintf:
+  - php/strings/sprintf
+  - c/stdio/sprintf

package/awk/builtin/index.js

@@ -0,0 +1,3 @@
+module.exports.int = require('./int')
+module.exports.length = require('./length')
+module.exports.substr = require('./substr')

package/awk/builtin/int.js

@@ -0,0 +1,13 @@
+module.exports = function int(x) {
+  //      discuss at: https://locutus.io/awk/int/
+  // parity verified: GNU AWK 5.3
+  //     original by: Kevin van Zonneveld (https://kvz.io)
+  //       example 1: int(4.7)
+  //       returns 1: 4
+  //       example 2: int(-4.7)
+  //       returns 2: -4
+  //       example 3: int(3)
+  //       returns 3: 3
+
+  return Math.trunc(x)
+}

package/awk/builtin/length.js

@@ -0,0 +1,16 @@
+module.exports = function length(s) {
+  //      discuss at: https://locutus.io/awk/length/
+  // parity verified: GNU AWK 5.3
+  //     original by: Kevin van Zonneveld (https://kvz.io)
+  //       example 1: length('hello')
+  //       returns 1: 5
+  //       example 2: length('')
+  //       returns 2: 0
+  //       example 3: length('test string')
+  //       returns 3: 11
+
+  if (s === undefined || s === null) {
+    return 0
+  }
+  return String(s).length
+}

package/awk/builtin/substr.js

@@ -0,0 +1,23 @@
+module.exports = function substr(str, start, len) {
+  //      discuss at: https://locutus.io/awk/substr/
+  // parity verified: GNU AWK 5.3
+  //     original by: Kevin van Zonneveld (https://kvz.io)
+  //          note 1: AWK uses 1-based indexing, so start=1 is the first character
+  //       example 1: substr('hello', 2, 3)
+  //       returns 1: 'ell'
+  //       example 2: substr('hello', 1, 2)
+  //       returns 2: 'he'
+  //       example 3: substr('hello', 3)
+  //       returns 3: 'llo'
+
+  if (str === undefined || str === null) {
+    return ''
+  }
+  const s = String(str)
+  // AWK uses 1-based indexing
+  const startIdx = Math.max(0, start - 1)
+  if (len === undefined) {
+    return s.substring(startIdx)
+  }
+  return s.substring(startIdx, startIdx + len)
+}

package/c/ctype/index.js

@@ -0,0 +1,8 @@
+module.exports.isalnum = require('./isalnum')
+module.exports.isalpha = require('./isalpha')
+module.exports.isdigit = require('./isdigit')
+module.exports.islower = require('./islower')
+module.exports.isspace = require('./isspace')
+module.exports.isupper = require('./isupper')
+module.exports.tolower = require('./tolower')
+module.exports.toupper = require('./toupper')

package/c/ctype/isalnum.js

@@ -0,0 +1,15 @@
+module.exports = function isalnum(c) {
+  //      discuss at: https://locutus.io/c/ctype/isalnum/
+  // parity verified: C 23
+  //     original by: Kevin van Zonneveld (https://kvz.io)
+  //          note 1: Checks if the character is alphanumeric (A-Z, a-z, or 0-9).
+  //       example 1: isalnum('A')
+  //       returns 1: true
+  //       example 2: isalnum('5')
+  //       returns 2: true
+  //       example 3: isalnum('_')
+  //       returns 3: false
+
+  c = (c + '').charAt(0)
+  return /^[A-Za-z0-9]$/.test(c)
+}

package/c/ctype/isalpha.js

@@ -0,0 +1,17 @@
+module.exports = function isalpha(c) {
+  //      discuss at: https://locutus.io/c/ctype/isalpha/
+  // parity verified: C 23
+  //     original by: Kevin van Zonneveld (https://kvz.io)
+  //          note 1: Checks if the character is an alphabetic letter (A-Z or a-z).
+  //       example 1: isalpha('A')
+  //       returns 1: true
+  //       example 2: isalpha('z')
+  //       returns 2: true
+  //       example 3: isalpha('5')
+  //       returns 3: false
+  //       example 4: isalpha(' ')
+  //       returns 4: false
+
+  c = (c + '').charAt(0)
+  return /^[A-Za-z]$/.test(c)
+}

package/c/ctype/isdigit.js

@@ -0,0 +1,15 @@
+module.exports = function isdigit(c) {
+  //      discuss at: https://locutus.io/c/ctype/isdigit/
+  // parity verified: C 23
+  //     original by: Kevin van Zonneveld (https://kvz.io)
+  //          note 1: Checks if the character is a decimal digit (0-9).
+  //       example 1: isdigit('5')
+  //       returns 1: true
+  //       example 2: isdigit('0')
+  //       returns 2: true
+  //       example 3: isdigit('A')
+  //       returns 3: false
+
+  c = (c + '').charAt(0)
+  return /^[0-9]$/.test(c)
+}

package/c/ctype/islower.js

@@ -0,0 +1,15 @@
+module.exports = function islower(c) {
+  //      discuss at: https://locutus.io/c/ctype/islower/
+  // parity verified: C 23
+  //     original by: Kevin van Zonneveld (https://kvz.io)
+  //          note 1: Checks if the character is a lowercase letter (a-z).
+  //       example 1: islower('a')
+  //       returns 1: true
+  //       example 2: islower('A')
+  //       returns 2: false
+  //       example 3: islower('5')
+  //       returns 3: false
+
+  c = (c + '').charAt(0)
+  return /^[a-z]$/.test(c)
+}

package/c/ctype/isspace.js

@@ -0,0 +1,15 @@
+module.exports = function isspace(c) {
+  //  discuss at: https://locutus.io/c/ctype/isspace/
+  // original by: Kevin van Zonneveld (https://kvz.io)
+  //      note 1: Checks if the character is a whitespace character.
+  //      note 1: Includes space, tab, newline, vertical tab, form feed, carriage return.
+  //   example 1: isspace(' ')
+  //   returns 1: true
+  //   example 2: isspace('\t')
+  //   returns 2: true
+  //   example 3: isspace('a')
+  //   returns 3: false
+
+  c = (c + '').charAt(0)
+  return /^[\s]$/.test(c)
+}

package/c/ctype/isupper.js

@@ -0,0 +1,15 @@
+module.exports = function isupper(c) {
+  //      discuss at: https://locutus.io/c/ctype/isupper/
+  // parity verified: C 23
+  //     original by: Kevin van Zonneveld (https://kvz.io)
+  //          note 1: Checks if the character is an uppercase letter (A-Z).
+  //       example 1: isupper('A')
+  //       returns 1: true
+  //       example 2: isupper('a')
+  //       returns 2: false
+  //       example 3: isupper('5')
+  //       returns 3: false
+
+  c = (c + '').charAt(0)
+  return /^[A-Z]$/.test(c)
+}

package/c/ctype/tolower.js

@@ -0,0 +1,15 @@
+module.exports = function tolower(c) {
+  //      discuss at: https://locutus.io/c/ctype/tolower/
+  // parity verified: C 23
+  //     original by: Kevin van Zonneveld (https://kvz.io)
+  //          note 1: Converts an uppercase letter to lowercase.
+  //       example 1: tolower('A')
+  //       returns 1: 'a'
+  //       example 2: tolower('a')
+  //       returns 2: 'a'
+  //       example 3: tolower('5')
+  //       returns 3: '5'
+
+  c = (c + '').charAt(0)
+  return c.toLowerCase()
+}

package/c/ctype/toupper.js

@@ -0,0 +1,15 @@
+module.exports = function toupper(c) {
+  //      discuss at: https://locutus.io/c/ctype/toupper/
+  // parity verified: C 23
+  //     original by: Kevin van Zonneveld (https://kvz.io)
+  //          note 1: Converts a lowercase letter to uppercase.
+  //       example 1: toupper('a')
+  //       returns 1: 'A'
+  //       example 2: toupper('A')
+  //       returns 2: 'A'
+  //       example 3: toupper('5')
+  //       returns 3: '5'
+
+  c = (c + '').charAt(0)
+  return c.toUpperCase()
+}

package/c/index.js

@@ -1,5 +1,2 @@
-'use strict';
-
-module.exports.math = require('./math');
-module.exports.stdio = require('./stdio');
-//# sourceMappingURL=index.js.map
+module.exports.math = require('./math')
+module.exports.stdio = require('./stdio')

package/c/math/abs.js

@@ -1,20 +1,16 @@
-"use strict";
-
 module.exports = function abs(mixedNumber) {
-  //  discuss at: https://locutus.io/c/abs/
-  // original by: Waldo Malqui Silva (https://waldo.malqui.info)
-  // improved by: Karol Kowalski
-  // improved by: Kevin van Zonneveld (https://kvz.io)
-  // improved by: Jonas Raoni Soares Silva (https://www.jsfromhell.com)
-  //   example 1: abs(4.2)
-  //   returns 1: 4.2
-  //   example 2: abs(-4.2)
-  //   returns 2: 4.2
-  //   example 3: abs(-5)
-  //   returns 3: 5
-  //   example 4: abs('_argos')
-  //   returns 4: 0
+  //      discuss at: https://locutus.io/c/abs/
+  // parity verified: C 23
+  //     original by: Waldo Malqui Silva (https://waldo.malqui.info)
+  //     improved by: Karol Kowalski
+  //     improved by: Kevin van Zonneveld (https://kvz.io)
+  //     improved by: Jonas Raoni Soares Silva (https://www.jsfromhell.com)
+  //       example 1: abs(-5)
+  //       returns 1: 5
+  //       example 2: abs(-42)
+  //       returns 2: 42
+  //       example 3: abs(0)
+  //       returns 3: 0
 
-  return Math.abs(mixedNumber) || 0;
-};
-//# sourceMappingURL=abs.js.map
+  return Math.abs(mixedNumber) || 0
+}