Compare commits
12 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 0e0bd5cd6c | |||
| 1f3e170a88 | |||
| 6a7570de7b | |||
| 579e25fe5a | |||
| 871a22a801 | |||
| aacb4a6873 | |||
| 0ef1af7b86 | |||
| 2af0329918 | |||
| b65a460ef2 | |||
| 3f5b0ebe1e | |||
| 6f2cedc1dd | |||
| 2c29ae3bf0 |
96
changelog.md
Normal file
96
changelog.md
Normal file
@@ -0,0 +1,96 @@
|
|||||||
|
# Changelog
|
||||||
|
|
||||||
|
## 2025-09-12 - 4.1.0 - feat(core)
|
||||||
|
Introduce native implementations for Base64, random generation and normalization; remove runtime plugin dependencies; update tests, docs and package metadata
|
||||||
|
|
||||||
|
- Implemented a cross-platform universal Base64 encoder/decoder and replaced usage of external js-base64 with the internal implementation
|
||||||
|
- Added a custom, cross-platform random string generator (uses crypto.getRandomValues when available) and removed dependency on randomatic / crypto-random-string
|
||||||
|
- Replaced strip-indent usage with an internal stripIndent implementation in normalize utilities
|
||||||
|
- Switched domain parsing to use the standard URL class instead of external url.parse
|
||||||
|
- Simplified ts/smartstring.plugins.ts to only export @push.rocks/isounique and removed several plugin re-exports (js-base64, strip-indent, randomatic, url, smartenv)
|
||||||
|
- Updated test imports to use @git.zone/tstest/tapbundle
|
||||||
|
- Expanded and updated README with full usage, examples and API reference
|
||||||
|
- Updated package.json: trimmed dependencies, bumped @git.zone/tstest version, added packageManager (pnpm) entry and adjusted files/browserslist
|
||||||
|
- Added .claude/settings.local.json
|
||||||
|
|
||||||
|
## 2024-05-29 - 4.0.15 - maintenance
|
||||||
|
Package metadata and TypeScript configuration updates.
|
||||||
|
|
||||||
|
- Updated package description.
|
||||||
|
- TypeScript configuration (tsconfig) adjustments.
|
||||||
|
- npmextra.json updated (githost entries).
|
||||||
|
|
||||||
|
## 2024-03-03 - 4.0.14 → 4.0.1 - maintenance & core fixes
|
||||||
|
Routine core fixes, small updates and version bumps across the 4.0.x series.
|
||||||
|
|
||||||
|
- Multiple "fix(core): update" commits addressing internal/core issues.
|
||||||
|
- Several version-only releases (patch bumps and releases with minimal change notes).
|
||||||
|
|
||||||
|
## 2022-03-18 - 4.0.2 → 3.0.26 - release consolidation
|
||||||
|
Consolidated releases and small fixes spanning late 2020–early 2022.
|
||||||
|
|
||||||
|
- Several patch releases with minor fixes and version bumps.
|
||||||
|
- Routine maintenance and stability improvements.
|
||||||
|
|
||||||
|
## 2018-11-28 - 3.0.4 → 3.0.0 - CI & dependency fixes
|
||||||
|
Improvements to build/CI and dependency cleanups for the 3.0.x line.
|
||||||
|
|
||||||
|
- fix(dependencies and structure): updated dependencies and project structure (3.0.4).
|
||||||
|
- fix(ci): reduced build dependencies and fixed build steps (3.0.3, 3.0.2).
|
||||||
|
- fix(dependencies): updated test framework and removed obsolete dependency on typings-global (3.0.1, 3.0.0).
|
||||||
|
- Numerous small fixes and version bump releases across 3.0.x.
|
||||||
|
|
||||||
|
## 2018-07-21 - 2.0.28 - BREAKING CHANGE: package scope
|
||||||
|
Breaking change: package scope changed.
|
||||||
|
|
||||||
|
- Changed package scope to @pushrocks (BREAKING CHANGE).
|
||||||
|
|
||||||
|
## 2017-10-26 - 2.0.27 → 2.0.25 - code quality & npm metadata
|
||||||
|
Small refactors and npm metadata additions.
|
||||||
|
|
||||||
|
- Refactor to use const (2.0.27).
|
||||||
|
- Added npmextra.json (2.0.26).
|
||||||
|
- Added create module (2.0.25).
|
||||||
|
|
||||||
|
## 2016-10-31 - 2.0.19 → 2.0.17 - Base64 & exports
|
||||||
|
Added Base64 handling and improved exports.
|
||||||
|
|
||||||
|
- Added Base64 handling and exposed base64 functions separate from class (2.0.17–2.0.19).
|
||||||
|
- Small export fixes.
|
||||||
|
|
||||||
|
## 2016-07-17 - 2.0.14 → 2.0.12 - ES6, indent/deindent, tests
|
||||||
|
Feature enhancements around string indentation and ES6 migration.
|
||||||
|
|
||||||
|
- Switched codebase to ES6 (2.0.14).
|
||||||
|
- Implemented deindent and working indent module; added tests (2.0.12).
|
||||||
|
- Prep work for indent functionality and recompiled builds (2.0.11, 2.0.10).
|
||||||
|
|
||||||
|
## 2016-06-21 - 2.0.9 → 2.0.6 - domain handling improvements
|
||||||
|
Domain parsing and regex improvements.
|
||||||
|
|
||||||
|
- Fixed Domain regex to include '-' and '_' and improved fullName handling (2.0.9, 2.0.8).
|
||||||
|
- Now evaluates Domains without protocol specified (2.0.6).
|
||||||
|
|
||||||
|
## 2016-05-25 - 2.0.4 → 2.0.0 - core features & CI/docs
|
||||||
|
Major 2.0.0 work and related improvements.
|
||||||
|
|
||||||
|
- Now computes zoneName and detects protocol (2.0.0).
|
||||||
|
- Added authors note, improved README and CI (AppVeyor, GitLab CI) across several commits.
|
||||||
|
- Multiple small fixes, dependency updates and YML/CI tweaks (2.0.4, 2.0.3, 2.0.2, 2.0.1).
|
||||||
|
|
||||||
|
## 2016-05-16 - 1.0.3 → 1.0.1 - parser & typings fixes
|
||||||
|
Parser improvements and TypeScript declaration fixes.
|
||||||
|
|
||||||
|
- Correctly parsing a Domain and structure updates (1.0.3).
|
||||||
|
- Fixes for typings and declaration issues (1.0.2, 1.0.1).
|
||||||
|
|
||||||
|
## 2016-04-15 - 1.0.0 → 0.0.3 - initial stable release
|
||||||
|
Initial stable release artifacts.
|
||||||
|
|
||||||
|
- Added TypeScript regex section and performed first 1.0.0 release (1.0.0).
|
||||||
|
- Prior 0.0.x preparatory releases.
|
||||||
|
|
||||||
|
## 2016-02-23 - 0.0.0 → initial - project initialization
|
||||||
|
Project initialization and first commits.
|
||||||
|
|
||||||
|
- Initial commit and early CI/travis updates.
|
||||||
@@ -11,12 +11,29 @@
|
|||||||
"gitzone": {
|
"gitzone": {
|
||||||
"projectType": "npm",
|
"projectType": "npm",
|
||||||
"module": {
|
"module": {
|
||||||
"githost": "gitlab.com",
|
"githost": "code.foss.global",
|
||||||
"gitscope": "push.rocks",
|
"gitscope": "push.rocks",
|
||||||
"gitrepo": "smartstring",
|
"gitrepo": "smartstring",
|
||||||
"description": "handle strings in smart ways. TypeScript ready.",
|
"description": "A library for handling strings in smart ways, including manipulation and encoding, with TypeScript support.",
|
||||||
"npmPackagename": "@push.rocks/smartstring",
|
"npmPackagename": "@push.rocks/smartstring",
|
||||||
"license": "MIT"
|
"license": "MIT",
|
||||||
|
"keywords": [
|
||||||
|
"string manipulation",
|
||||||
|
"encode",
|
||||||
|
"decode",
|
||||||
|
"base64",
|
||||||
|
"indentation",
|
||||||
|
"normalization",
|
||||||
|
"regex",
|
||||||
|
"random string",
|
||||||
|
"cryptographic string",
|
||||||
|
"domain parsing",
|
||||||
|
"git repository parsing",
|
||||||
|
"docker environment parsing"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
|
},
|
||||||
|
"tsdoc": {
|
||||||
|
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
41
package.json
41
package.json
@@ -1,8 +1,8 @@
|
|||||||
{
|
{
|
||||||
"name": "@push.rocks/smartstring",
|
"name": "@push.rocks/smartstring",
|
||||||
"version": "4.0.12",
|
"version": "4.1.0",
|
||||||
"private": false,
|
"private": false,
|
||||||
"description": "handle strings in smart ways. TypeScript ready.",
|
"description": "A library for handling strings in smart ways, including manipulation and encoding, with TypeScript support.",
|
||||||
"main": "dist_ts/index.js",
|
"main": "dist_ts/index.js",
|
||||||
"typings": "dist_ts/index.d.ts",
|
"typings": "dist_ts/index.d.ts",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
@@ -13,36 +13,36 @@
|
|||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "git+https://gitlab.com/push.rocks/smartstring.git"
|
"url": "https://code.foss.global/push.rocks/smartstring.git"
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
|
"string manipulation",
|
||||||
|
"encode",
|
||||||
|
"decode",
|
||||||
|
"base64",
|
||||||
|
"indentation",
|
||||||
|
"normalization",
|
||||||
"regex",
|
"regex",
|
||||||
"string"
|
"random string",
|
||||||
|
"cryptographic string",
|
||||||
|
"domain parsing",
|
||||||
|
"git repository parsing",
|
||||||
|
"docker environment parsing"
|
||||||
],
|
],
|
||||||
"author": "Lossless GmbH",
|
"author": "Lossless GmbH",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"bugs": {
|
"bugs": {
|
||||||
"url": "https://gitlab.com/push.rocks/smartstring/issues"
|
"url": "https://gitlab.com/push.rocks/smartstring/issues"
|
||||||
},
|
},
|
||||||
"homepage": "https://gitlab.com/push.rocks/smartstring#readme",
|
"homepage": "https://code.foss.global/push.rocks/smartstring",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@git.zone/tsbuild": "^2.1.66",
|
"@git.zone/tsbuild": "^2.1.72",
|
||||||
"@git.zone/tsrun": "^1.2.42",
|
"@git.zone/tsrun": "^1.2.42",
|
||||||
"@git.zone/tstest": "^1.0.84",
|
"@git.zone/tstest": "^2.3.7",
|
||||||
"@push.rocks/tapbundle": "^5.0.15",
|
"@types/node": "^20.11.24"
|
||||||
"@types/node": "^20.10.5"
|
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@push.rocks/isounique": "^1.0.5",
|
"@push.rocks/isounique": "^1.0.5"
|
||||||
"@push.rocks/smartenv": "^5.0.12",
|
|
||||||
"@types/randomatic": "^3.1.5",
|
|
||||||
"buffer": "^6.0.3",
|
|
||||||
"crypto-random-string": "^5.0.0",
|
|
||||||
"js-base64": "^3.7.5",
|
|
||||||
"normalize-newline": "^4.1.0",
|
|
||||||
"randomatic": "^3.1.1",
|
|
||||||
"strip-indent": "^4.0.0",
|
|
||||||
"url": "^0.11.3"
|
|
||||||
},
|
},
|
||||||
"files": [
|
"files": [
|
||||||
"ts/**/*",
|
"ts/**/*",
|
||||||
@@ -58,5 +58,6 @@
|
|||||||
],
|
],
|
||||||
"browserslist": [
|
"browserslist": [
|
||||||
"last 1 chrome versions"
|
"last 1 chrome versions"
|
||||||
]
|
],
|
||||||
|
"packageManager": "pnpm@10.14.0+sha512.ad27a79641b49c3e481a16a805baa71817a04bbe06a38d17e60e2eaee83f6a146c6a688125f5792e48dd5ba30e7da52a5cda4c3992b9ccf333f9ce223af84748"
|
||||||
}
|
}
|
||||||
|
|||||||
11651
pnpm-lock.yaml
generated
11651
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
1
readme.hints.md
Normal file
1
readme.hints.md
Normal file
@@ -0,0 +1 @@
|
|||||||
|
|
||||||
420
readme.md
420
readme.md
@@ -1,75 +1,379 @@
|
|||||||
# @push.rocks/smartstring
|
# @push.rocks/smartstring
|
||||||
handle strings in smart ways. TypeScript ready.
|
|
||||||
|
|
||||||
## Availabililty and Links
|
🎯 **Smart string manipulation for TypeScript** - Your comprehensive toolkit for handling strings, domains, Git URLs, and encodings with elegance and precision.
|
||||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/smartstring)
|
|
||||||
* [gitlab.com (source)](https://gitlab.com/push.rocks/smartstring)
|
|
||||||
* [github.com (source mirror)](https://github.com/push.rocks/smartstring)
|
|
||||||
* [docs (typedoc)](https://push.rocks.gitlab.io/smartstring/)
|
|
||||||
|
|
||||||
## Status for master
|
## Why smartstring?
|
||||||
|
|
||||||
Status Category | Status Badge
|
When working with strings in modern JavaScript/TypeScript applications, you often need more than just basic manipulation. You need to:
|
||||||
-- | --
|
- Parse and validate domains and URLs
|
||||||
GitLab Pipelines | [](https://lossless.cloud)
|
- Handle Git repository URLs across different formats
|
||||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
- Encode/decode Base64 for data transmission
|
||||||
npm | [](https://lossless.cloud)
|
- Normalize indentation in code generators
|
||||||
Snyk | [](https://lossless.cloud)
|
- Create cryptographically secure random strings
|
||||||
TypeScript Support | [](https://lossless.cloud)
|
- Validate string encodings
|
||||||
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
- Parse Docker environment variables
|
||||||
Code Style | [](https://lossless.cloud)
|
|
||||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
**smartstring** unifies all these capabilities in a single, tree-shakeable, TypeScript-native package with zero setup overhead.
|
||||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
|
||||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
## Install
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install @push.rocks/smartstring --save
|
||||||
|
```
|
||||||
|
|
||||||
|
Or using pnpm (recommended):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pnpm add @push.rocks/smartstring
|
||||||
|
```
|
||||||
|
|
||||||
|
## Features at a Glance
|
||||||
|
|
||||||
|
✅ **Domain parsing** - Extract protocols, subdomains, domains, and TLDs
|
||||||
|
✅ **Git URL handling** - Parse and convert between SSH and HTTPS formats
|
||||||
|
✅ **Base64 encoding** - Standard and URL-safe Base64 operations
|
||||||
|
✅ **Smart indentation** - Indent, outdent, and normalize multi-line strings
|
||||||
|
✅ **Random strings** - Pattern-based and cryptographically secure generation
|
||||||
|
✅ **String normalization** - Clean and standardize whitespace
|
||||||
|
✅ **Type checking** - Validate UTF-8 and Base64 encodings
|
||||||
|
✅ **Docker env parsing** - Transform Docker environment arrays to objects
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
Use TypeScript for best in class instellisense.
|
### 🌐 Domain Parsing
|
||||||
|
|
||||||
```javascript
|
Extract detailed information from any URL or domain string:
|
||||||
import * as smartstring from 'smartstring';
|
|
||||||
|
|
||||||
// classes
|
```typescript
|
||||||
|
import { Domain } from '@push.rocks/smartstring';
|
||||||
|
|
||||||
// smartstring.Domain class
|
const domain = new Domain('https://subdomain.example.com:3000/path');
|
||||||
let myDomain = new smartstring.Domain('https://sub.main.tld');
|
|
||||||
myDomain.level1; // "tld"
|
|
||||||
myDomain.level2; // "main"
|
|
||||||
// level3 , level 4 and so on...
|
|
||||||
myDomain.zoneName; // "main.tld"
|
|
||||||
myDOmain.protocol; // "https"
|
|
||||||
|
|
||||||
// smartstring.GitRepo class
|
console.log(domain.protocol); // 'https'
|
||||||
let myGitRepo = new smartstring.GitRepo('git@github.com:someorg/somerepo.git'); // takes https and git and npm repo URL versions
|
console.log(domain.hostname); // 'subdomain.example.com'
|
||||||
myGitRepo.host; // "github.com"
|
console.log(domain.port); // '3000'
|
||||||
myGitRepo.user; // "someorg"
|
console.log(domain.pathname); // '/path'
|
||||||
myGitRepo.repo; // "somerepo"
|
console.log(domain.fullUrl); // 'https://subdomain.example.com:3000/path'
|
||||||
myGitRepo.accessToken; // accessToken if specified with https
|
|
||||||
myGitRepo.sshUrl; // "git@github.com:someorg/somerepo.git" (computed also from https)
|
|
||||||
myGitRepo.httpsUrl; // "https://github.com/someorg/somerepo.git" (computed also from ssh)
|
|
||||||
|
|
||||||
//smartstring.Base64
|
// Domain level extraction
|
||||||
let myBase64 = new smartstring.Base64('somestring', 'string'); // first arg is the string, second is string type (can be string, base64, base64uri)
|
console.log(domain.level1); // 'com' - TLD
|
||||||
myBase64.simpleString; // 'somestring'
|
console.log(domain.level2); // 'example' - Domain
|
||||||
myBase64.base64String; // base64 representation of 'somestring'
|
console.log(domain.level3); // 'subdomain' - Subdomain
|
||||||
myBase64.base64UriString; // base64uri representation of 'sometring'
|
console.log(domain.zoneName); // 'example.com' - Full domain without subdomain
|
||||||
|
console.log(domain.subdomain); // 'subdomain'
|
||||||
// methods
|
|
||||||
smartstring.base64.encode('somestring'); // encodes 'somestring' to base64
|
|
||||||
smartstring.base64.encodeUri('sometring'); // encodes 'somestring' to base64uri
|
|
||||||
smartstring.base64.decode(); // decodes base64 and base64uri to simple string respresentation
|
|
||||||
|
|
||||||
smartstring.indent.indent('somestringanotherstring', 4); // indents a string by 4
|
|
||||||
smartstring.indent.indent('somestringanotherstring', '>>>> '); // indents a string with a prefix
|
|
||||||
smartstring.indent.normalize(' somestring anotherstring', '>>>> '); // looks for the least amount of indention and removes superflouous space
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Contribution
|
### 🔧 Git Repository URLs
|
||||||
|
|
||||||
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
Parse and convert Git repository URLs between SSH and HTTPS formats:
|
||||||
|
|
||||||
For further information read the linked docs at the top of this readme.
|
```typescript
|
||||||
|
import { GitRepo } from '@push.rocks/smartstring';
|
||||||
|
|
||||||
## Legal
|
// Parse SSH format
|
||||||
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
|
const repo = new GitRepo('git@github.com:user/awesome-project.git');
|
||||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
console.log(repo.host); // 'github.com'
|
||||||
|
console.log(repo.user); // 'user'
|
||||||
|
console.log(repo.repo); // 'awesome-project'
|
||||||
|
console.log(repo.httpsUrl); // 'https://github.com/user/awesome-project.git'
|
||||||
|
|
||||||
|
// Parse HTTPS format
|
||||||
|
const httpsRepo = new GitRepo('https://gitlab.com/team/project.git');
|
||||||
|
console.log(httpsRepo.sshUrl); // 'git@gitlab.com:team/project.git'
|
||||||
|
console.log(httpsRepo.httpsUrl); // 'https://gitlab.com/team/project.git'
|
||||||
|
```
|
||||||
|
|
||||||
|
### 🔐 Base64 Encoding
|
||||||
|
|
||||||
|
Handle Base64 encoding with both standard and URL-safe variants:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Base64, base64 } from '@push.rocks/smartstring';
|
||||||
|
|
||||||
|
// Using the Base64 class
|
||||||
|
const encoded = new Base64('Hello World! 👋', 'string');
|
||||||
|
console.log(encoded.base64String); // Standard Base64
|
||||||
|
console.log(encoded.base64UriString); // URL-safe Base64
|
||||||
|
console.log(encoded.simpleString); // Decoded string
|
||||||
|
|
||||||
|
// Using utility functions
|
||||||
|
const quickEncode = base64.encode('Secret message');
|
||||||
|
const quickDecode = base64.decode(quickEncode);
|
||||||
|
|
||||||
|
// Validate Base64 strings
|
||||||
|
console.log(base64.isBase64('SGVsbG8=')); // true
|
||||||
|
console.log(base64.isBase64('Not Base64!')); // false
|
||||||
|
|
||||||
|
// URL-safe Base64 operations
|
||||||
|
const urlSafeEncoded = base64.encodeUri('https://example.com/path?param=value');
|
||||||
|
const urlSafeDecoded = base64.decodeUri(urlSafeEncoded);
|
||||||
|
```
|
||||||
|
|
||||||
|
### 📐 Smart Indentation
|
||||||
|
|
||||||
|
Manage indentation in multi-line strings with precision:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { indent } from '@push.rocks/smartstring';
|
||||||
|
|
||||||
|
// Indent with spaces
|
||||||
|
const indented = indent.indent('Line 1\nLine 2\nLine 3', 4);
|
||||||
|
// Result:
|
||||||
|
// Line 1
|
||||||
|
// Line 2
|
||||||
|
// Line 3
|
||||||
|
|
||||||
|
// Indent with custom prefix
|
||||||
|
const prefixed = indent.indentWithPrefix('Item 1\nItem 2', '> ');
|
||||||
|
// Result:
|
||||||
|
// > Item 1
|
||||||
|
// > Item 2
|
||||||
|
|
||||||
|
// Add prefix to first line only
|
||||||
|
const firstLinePrefixed = indent.addPrefix('Chapter\nContent here', '# ');
|
||||||
|
// Result:
|
||||||
|
// # Chapter
|
||||||
|
// Content here
|
||||||
|
|
||||||
|
// Normalize irregular indentation
|
||||||
|
const messy = `
|
||||||
|
function hello() {
|
||||||
|
console.log('Hi');
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
`;
|
||||||
|
const clean = indent.normalize(messy);
|
||||||
|
// Result: Properly aligned with minimum indentation preserved
|
||||||
|
```
|
||||||
|
|
||||||
|
### 🎲 Random String Generation
|
||||||
|
|
||||||
|
Create random strings with specific patterns or cryptographic security:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { create } from '@push.rocks/smartstring';
|
||||||
|
|
||||||
|
// Pattern-based random strings
|
||||||
|
// A = uppercase, a = lowercase, 0 = number, ! = special, * = any
|
||||||
|
const password = create.createRandomString('Aa0!', 16);
|
||||||
|
// Example: "Kg7$Lp2@Qm9#Xn4!"
|
||||||
|
|
||||||
|
const alphanumeric = create.createRandomString('Aa0', 10);
|
||||||
|
// Example: "K7gLp2Qm9X"
|
||||||
|
|
||||||
|
const numbers = create.createRandomString('0', 6);
|
||||||
|
// Example: "472819"
|
||||||
|
|
||||||
|
// Cryptographically secure random strings
|
||||||
|
const cryptoId = create.createCryptoRandomString();
|
||||||
|
// Example: "f7b2d8e0-3c4a-4b9c-8d2e-1f0a7b9c8d7e"
|
||||||
|
```
|
||||||
|
|
||||||
|
### 🧹 String Normalization
|
||||||
|
|
||||||
|
Clean and standardize strings for consistent formatting:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { normalize } from '@push.rocks/smartstring';
|
||||||
|
|
||||||
|
const messyString = `
|
||||||
|
This text has
|
||||||
|
inconsistent indentation
|
||||||
|
and too much whitespace
|
||||||
|
|
||||||
|
|
||||||
|
between lines...
|
||||||
|
`;
|
||||||
|
|
||||||
|
const cleaned = normalize.standard(messyString);
|
||||||
|
// Result: Properly formatted with consistent spacing
|
||||||
|
|
||||||
|
// Custom normalization
|
||||||
|
const customNormalized = normalize.normal(messyString);
|
||||||
|
```
|
||||||
|
|
||||||
|
### 🔍 String Type Validation
|
||||||
|
|
||||||
|
Check string encodings and types:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { type } from '@push.rocks/smartstring';
|
||||||
|
|
||||||
|
// Check if string is valid UTF-8
|
||||||
|
const isValidUtf8 = type.isUtf8('Hello 世界');
|
||||||
|
console.log(isValidUtf8); // true
|
||||||
|
|
||||||
|
// Check if string is Base64
|
||||||
|
const isBase64String = type.isBase64('SGVsbG8gV29ybGQ=');
|
||||||
|
console.log(isBase64String); // true
|
||||||
|
```
|
||||||
|
|
||||||
|
### 🐳 Docker Environment Variables
|
||||||
|
|
||||||
|
Parse Docker-style environment variable arrays:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { docker } from '@push.rocks/smartstring';
|
||||||
|
|
||||||
|
const envArray = [
|
||||||
|
'NODE_ENV=production',
|
||||||
|
'PORT=3000',
|
||||||
|
'DATABASE_URL=postgresql://localhost:5432/mydb',
|
||||||
|
'API_KEY=secret123'
|
||||||
|
];
|
||||||
|
|
||||||
|
const envObject = docker.makeEnvObject(envArray);
|
||||||
|
|
||||||
|
console.log(envObject.NODE_ENV); // 'production'
|
||||||
|
console.log(envObject.PORT); // '3000'
|
||||||
|
console.log(envObject.DATABASE_URL); // 'postgresql://localhost:5432/mydb'
|
||||||
|
console.log(envObject.API_KEY); // 'secret123'
|
||||||
|
|
||||||
|
// Use in Docker-related configurations
|
||||||
|
// Perfect for parsing process.env or Docker Compose outputs
|
||||||
|
```
|
||||||
|
|
||||||
|
## API Reference
|
||||||
|
|
||||||
|
### Classes
|
||||||
|
|
||||||
|
- **`Domain`** - URL/domain parser with component extraction
|
||||||
|
- **`GitRepo`** - Git repository URL parser and converter
|
||||||
|
- **`Base64`** - Base64 encoder/decoder with multiple formats
|
||||||
|
|
||||||
|
### Modules
|
||||||
|
|
||||||
|
- **`create`** - Random string generation
|
||||||
|
- `createRandomString(pattern, length, options)` - Pattern-based generation
|
||||||
|
- `createCryptoRandomString()` - Cryptographically secure strings
|
||||||
|
|
||||||
|
- **`indent`** - Indentation management
|
||||||
|
- `indent(text, spaces)` - Add spaces to each line
|
||||||
|
- `indentWithPrefix(text, prefix)` - Add custom prefix to each line
|
||||||
|
- `normalize(text)` - Fix inconsistent indentation
|
||||||
|
- `addPrefix(text, prefix)` - Add prefix to first line only
|
||||||
|
|
||||||
|
- **`normalize`** - String normalization
|
||||||
|
- `standard(text)` - Apply standard normalization
|
||||||
|
- `normal(text)` - Basic normalization
|
||||||
|
|
||||||
|
- **`type`** - String type checking
|
||||||
|
- `isUtf8(text)` - Validate UTF-8 encoding
|
||||||
|
- `isBase64(text)` - Validate Base64 format
|
||||||
|
|
||||||
|
- **`base64`** - Base64 utilities
|
||||||
|
- `encode(text)` - Standard Base64 encoding
|
||||||
|
- `decode(text)` - Standard Base64 decoding
|
||||||
|
- `encodeUri(text)` - URL-safe Base64 encoding
|
||||||
|
- `decodeUri(text)` - URL-safe Base64 decoding
|
||||||
|
- `isBase64(text)` - Check if string is valid Base64
|
||||||
|
|
||||||
|
- **`docker`** - Docker utilities
|
||||||
|
- `makeEnvObject(envArray)` - Convert env array to object
|
||||||
|
|
||||||
|
## Real-World Examples
|
||||||
|
|
||||||
|
### Building a URL Shortener
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Domain, create, base64 } from '@push.rocks/smartstring';
|
||||||
|
|
||||||
|
function createShortUrl(longUrl: string): string {
|
||||||
|
const domain = new Domain(longUrl);
|
||||||
|
const shortCode = create.createRandomString('Aa0', 6);
|
||||||
|
const encoded = base64.encodeUri(`${domain.hostname}${domain.pathname}`);
|
||||||
|
|
||||||
|
return `short.ly/${shortCode}`;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Processing Code Templates
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { indent, normalize } from '@push.rocks/smartstring';
|
||||||
|
|
||||||
|
function generateComponent(name: string, props: string[]): string {
|
||||||
|
const propsSection = props
|
||||||
|
.map(prop => `${prop}: string;`)
|
||||||
|
.join('\n');
|
||||||
|
|
||||||
|
const template = `
|
||||||
|
export interface ${name}Props {
|
||||||
|
${indent.indent(propsSection, 2)}
|
||||||
|
}
|
||||||
|
|
||||||
|
export function ${name}(props: ${name}Props) {
|
||||||
|
${indent.indent('// Component implementation', 2)}
|
||||||
|
}
|
||||||
|
`;
|
||||||
|
|
||||||
|
return normalize.standard(template);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Git Repository Manager
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GitRepo } from '@push.rocks/smartstring';
|
||||||
|
|
||||||
|
class RepoManager {
|
||||||
|
repos: Map<string, GitRepo> = new Map();
|
||||||
|
|
||||||
|
addRepo(url: string): void {
|
||||||
|
const repo = new GitRepo(url);
|
||||||
|
this.repos.set(repo.repo, repo);
|
||||||
|
}
|
||||||
|
|
||||||
|
getCloneCommand(name: string, useSSH = false): string {
|
||||||
|
const repo = this.repos.get(name);
|
||||||
|
if (!repo) throw new Error('Repository not found');
|
||||||
|
|
||||||
|
const url = useSSH ? repo.sshUrl : repo.httpsUrl;
|
||||||
|
return `git clone ${url}`;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Browser Support
|
||||||
|
|
||||||
|
This package is built for modern environments and includes:
|
||||||
|
- ✅ Full ES Module support
|
||||||
|
- ✅ Tree-shaking ready
|
||||||
|
- ✅ TypeScript definitions
|
||||||
|
- ✅ Browser-compatible (via bundlers)
|
||||||
|
- ✅ Node.js 14+ support
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Clone the repository
|
||||||
|
git clone https://code.foss.global/push.rocks/smartstring.git
|
||||||
|
|
||||||
|
# Install dependencies
|
||||||
|
pnpm install
|
||||||
|
|
||||||
|
# Run tests
|
||||||
|
pnpm test
|
||||||
|
|
||||||
|
# Build the project
|
||||||
|
pnpm build
|
||||||
|
```
|
||||||
|
|
||||||
|
## License and Legal Information
|
||||||
|
|
||||||
|
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
|
||||||
|
|
||||||
|
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
### Trademarks
|
||||||
|
|
||||||
|
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
|
||||||
|
|
||||||
|
### Company Information
|
||||||
|
|
||||||
|
Task Venture Capital GmbH
|
||||||
|
Registered at District court Bremen HRB 35230 HB, Germany
|
||||||
|
|
||||||
|
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
|
||||||
|
|
||||||
|
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
import * as smartstring from '../ts/index.js';
|
import * as smartstring from '../ts/index.js';
|
||||||
import { tap, expect } from '@push.rocks/tapbundle';
|
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||||
|
|
||||||
// Base64
|
// Base64
|
||||||
let testBase64: smartstring.Base64;
|
let testBase64: smartstring.Base64;
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
import * as smartstring from '../ts/index.js';
|
import * as smartstring from '../ts/index.js';
|
||||||
import { tap, expect } from '@push.rocks/tapbundle';
|
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||||
|
|
||||||
// Docker
|
// Docker
|
||||||
tap.test('expect create a Env Object', async () => {
|
tap.test('expect create a Env Object', async () => {
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
import * as smartstring from '../ts/index.js';
|
import * as smartstring from '../ts/index.js';
|
||||||
import { tap, expect } from '@push.rocks/tapbundle';
|
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||||
|
|
||||||
// Domain
|
// Domain
|
||||||
let testDomain: smartstring.Domain;
|
let testDomain: smartstring.Domain;
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
import * as smartstring from '../ts/index.js';
|
import * as smartstring from '../ts/index.js';
|
||||||
import { tap, expect } from '@push.rocks/tapbundle';
|
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||||
|
|
||||||
// git
|
// git
|
||||||
let testGit: smartstring.GitRepo;
|
let testGit: smartstring.GitRepo;
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
import * as smartstring from '../ts/index.js';
|
import * as smartstring from '../ts/index.js';
|
||||||
import { tap, expect } from '@push.rocks/tapbundle';
|
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||||
|
|
||||||
// indent
|
// indent
|
||||||
let testString = `
|
let testString = `
|
||||||
|
|||||||
@@ -1,13 +1,15 @@
|
|||||||
import { tap, expect } from '@push.rocks/tapbundle';
|
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||||
|
|
||||||
import * as smartstring from '../ts/index.js';
|
import * as smartstring from '../ts/index.js';
|
||||||
|
|
||||||
tap.test('should normalize a string', async () => {
|
tap.test('should normalize a string', async (toolsArg) => {
|
||||||
const testString = `
|
const testString = `
|
||||||
myawesome string;
|
myawesome string;
|
||||||
is indented with two spaces
|
is indented with two spaces
|
||||||
`;
|
`;
|
||||||
const normalizedString = smartstring.normalize.standard(testString);
|
const normalizedString = smartstring.normalize.standard(testString);
|
||||||
|
console.log(normalizedString);
|
||||||
|
|
||||||
expect(normalizedString).toEqual(
|
expect(normalizedString).toEqual(
|
||||||
`myawesome string;
|
`myawesome string;
|
||||||
is indented with two spaces
|
is indented with two spaces
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
import { tap, expect } from '@push.rocks/tapbundle';
|
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||||
import * as smartstring from '../ts/index.js';
|
import * as smartstring from '../ts/index.js';
|
||||||
|
|
||||||
tap.test('should state valuid utf8', async () => {
|
tap.test('should state valuid utf8', async () => {
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
/**
|
/**
|
||||||
* autocreated commitinfo by @pushrocks/commitinfo
|
* autocreated commitinfo by @push.rocks/commitinfo
|
||||||
*/
|
*/
|
||||||
export const commitinfo = {
|
export const commitinfo = {
|
||||||
name: '@push.rocks/smartstring',
|
name: '@push.rocks/smartstring',
|
||||||
version: '4.0.12',
|
version: '4.1.0',
|
||||||
description: 'handle strings in smart ways. TypeScript ready.'
|
description: 'A library for handling strings in smart ways, including manipulation and encoding, with TypeScript support.'
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,10 +1,89 @@
|
|||||||
import * as plugins from './smartstring.plugins.js';
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* the type for base 64
|
* the type for base 64
|
||||||
*/
|
*/
|
||||||
export type TStringInputType = 'string' | 'base64' | 'base64uri';
|
export type TStringInputType = 'string' | 'base64' | 'base64uri';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Cross-platform base64 implementation
|
||||||
|
* Works in both Node.js and browser environments
|
||||||
|
*/
|
||||||
|
const universalBase64 = {
|
||||||
|
encode: (str: string): string => {
|
||||||
|
if (typeof Buffer !== 'undefined') {
|
||||||
|
// Node.js environment
|
||||||
|
return Buffer.from(str, 'utf8').toString('base64');
|
||||||
|
} else if (typeof btoa !== 'undefined') {
|
||||||
|
// Browser environment
|
||||||
|
// Handle Unicode properly
|
||||||
|
const utf8Bytes = new TextEncoder().encode(str);
|
||||||
|
const binaryString = Array.from(utf8Bytes, byte => String.fromCharCode(byte)).join('');
|
||||||
|
return btoa(binaryString);
|
||||||
|
} else {
|
||||||
|
// Fallback pure JS implementation
|
||||||
|
const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/';
|
||||||
|
const bytes = new TextEncoder().encode(str);
|
||||||
|
let result = '';
|
||||||
|
let i = 0;
|
||||||
|
|
||||||
|
while (i < bytes.length) {
|
||||||
|
const a = bytes[i++];
|
||||||
|
const b = i < bytes.length ? bytes[i++] : 0;
|
||||||
|
const c = i < bytes.length ? bytes[i++] : 0;
|
||||||
|
|
||||||
|
const bitmap = (a << 16) | (b << 8) | c;
|
||||||
|
|
||||||
|
result += chars.charAt((bitmap >> 18) & 63);
|
||||||
|
result += chars.charAt((bitmap >> 12) & 63);
|
||||||
|
result += i - 2 < bytes.length ? chars.charAt((bitmap >> 6) & 63) : '=';
|
||||||
|
result += i - 1 < bytes.length ? chars.charAt(bitmap & 63) : '=';
|
||||||
|
}
|
||||||
|
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
decode: (str: string): string => {
|
||||||
|
// Handle base64uri by converting back to standard base64
|
||||||
|
const base64String = str
|
||||||
|
.replace(/-/g, '+')
|
||||||
|
.replace(/_/g, '/')
|
||||||
|
.padEnd(str.length + ((4 - (str.length % 4)) % 4), '=');
|
||||||
|
|
||||||
|
if (typeof Buffer !== 'undefined') {
|
||||||
|
// Node.js environment
|
||||||
|
return Buffer.from(base64String, 'base64').toString('utf8');
|
||||||
|
} else if (typeof atob !== 'undefined') {
|
||||||
|
// Browser environment
|
||||||
|
const binaryString = atob(base64String);
|
||||||
|
const bytes = new Uint8Array(binaryString.length);
|
||||||
|
for (let i = 0; i < binaryString.length; i++) {
|
||||||
|
bytes[i] = binaryString.charCodeAt(i);
|
||||||
|
}
|
||||||
|
return new TextDecoder().decode(bytes);
|
||||||
|
} else {
|
||||||
|
// Fallback pure JS implementation
|
||||||
|
const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/';
|
||||||
|
let bytes: number[] = [];
|
||||||
|
let i = 0;
|
||||||
|
|
||||||
|
while (i < base64String.length) {
|
||||||
|
const encoded1 = chars.indexOf(base64String.charAt(i++));
|
||||||
|
const encoded2 = chars.indexOf(base64String.charAt(i++));
|
||||||
|
const encoded3 = chars.indexOf(base64String.charAt(i++));
|
||||||
|
const encoded4 = chars.indexOf(base64String.charAt(i++));
|
||||||
|
|
||||||
|
const bitmap = (encoded1 << 18) | (encoded2 << 12) | (encoded3 << 6) | encoded4;
|
||||||
|
|
||||||
|
bytes.push((bitmap >> 16) & 255);
|
||||||
|
if (encoded3 !== 64) bytes.push((bitmap >> 8) & 255);
|
||||||
|
if (encoded4 !== 64) bytes.push(bitmap & 255);
|
||||||
|
}
|
||||||
|
|
||||||
|
return new TextDecoder().decode(new Uint8Array(bytes));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* handle base64 strings
|
* handle base64 strings
|
||||||
*/
|
*/
|
||||||
@@ -50,21 +129,24 @@ export let base64 = {
|
|||||||
* encodes the string
|
* encodes the string
|
||||||
*/
|
*/
|
||||||
encode: (stringArg: string) => {
|
encode: (stringArg: string) => {
|
||||||
return plugins.jsBase64.encode(stringArg);
|
return universalBase64.encode(stringArg);
|
||||||
},
|
},
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* encodes a stringArg to base64 uri style
|
* encodes a stringArg to base64 uri style
|
||||||
*/
|
*/
|
||||||
encodeUri: (stringArg: string) => {
|
encodeUri: (stringArg: string) => {
|
||||||
return plugins.jsBase64.encodeURI(stringArg);
|
return universalBase64.encode(stringArg)
|
||||||
|
.replace(/\+/g, '-')
|
||||||
|
.replace(/\//g, '_')
|
||||||
|
.replace(/=/g, '');
|
||||||
},
|
},
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* decodes a base64 encoded string
|
* decodes a base64 encoded string
|
||||||
*/
|
*/
|
||||||
decode: (stringArg: string) => {
|
decode: (stringArg: string) => {
|
||||||
return plugins.jsBase64.decode(stringArg);
|
return universalBase64.decode(stringArg);
|
||||||
},
|
},
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -1,5 +1,63 @@
|
|||||||
import * as plugins from './smartstring.plugins.js';
|
import * as plugins from './smartstring.plugins.js';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Cross-platform random number generator
|
||||||
|
* Uses crypto.getRandomValues in browser and Math.random as fallback
|
||||||
|
*/
|
||||||
|
const getRandomInt = (min: number, max: number): number => {
|
||||||
|
if (typeof globalThis !== 'undefined' && globalThis.crypto && globalThis.crypto.getRandomValues) {
|
||||||
|
// Browser environment with crypto API
|
||||||
|
const range = max - min;
|
||||||
|
const array = new Uint32Array(1);
|
||||||
|
globalThis.crypto.getRandomValues(array);
|
||||||
|
return min + (array[0] % range);
|
||||||
|
} else {
|
||||||
|
// Fallback to Math.random for environments without crypto
|
||||||
|
return Math.floor(Math.random() * (max - min)) + min;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Custom implementation of randomatic pattern-based string generator
|
||||||
|
* Pattern characters:
|
||||||
|
* A - Uppercase letter
|
||||||
|
* a - Lowercase letter
|
||||||
|
* 0 - Number (0-9)
|
||||||
|
* ! - Special character
|
||||||
|
* * - Any character (A, a, 0, or !)
|
||||||
|
*/
|
||||||
|
const customRandomatic = (pattern: string, length?: number, options?: any): string => {
|
||||||
|
const charSets = {
|
||||||
|
'A': 'ABCDEFGHIJKLMNOPQRSTUVWXYZ',
|
||||||
|
'a': 'abcdefghijklmnopqrstuvwxyz',
|
||||||
|
'0': '0123456789',
|
||||||
|
'!': '!@#$%^&*()_+-=[]{}|;:,.<>?',
|
||||||
|
'*': 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789!@#$%^&*()_+-=[]{}|;:,.<>?'
|
||||||
|
};
|
||||||
|
|
||||||
|
// If length is provided, repeat the pattern to match length
|
||||||
|
let actualPattern = pattern;
|
||||||
|
if (length && length > pattern.length) {
|
||||||
|
actualPattern = pattern.repeat(Math.ceil(length / pattern.length)).slice(0, length);
|
||||||
|
} else if (length) {
|
||||||
|
actualPattern = pattern.slice(0, length);
|
||||||
|
}
|
||||||
|
|
||||||
|
let result = '';
|
||||||
|
for (const char of actualPattern) {
|
||||||
|
if (charSets[char]) {
|
||||||
|
const charSet = charSets[char];
|
||||||
|
const randomIndex = getRandomInt(0, charSet.length);
|
||||||
|
result += charSet[randomIndex];
|
||||||
|
} else {
|
||||||
|
// If not a pattern character, use it literally
|
||||||
|
result += char;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return result;
|
||||||
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* creates a random string
|
* creates a random string
|
||||||
*
|
*
|
||||||
@@ -17,7 +75,7 @@ export const createRandomString = (
|
|||||||
lengthArg?: number,
|
lengthArg?: number,
|
||||||
optionsArg?: any
|
optionsArg?: any
|
||||||
): string => {
|
): string => {
|
||||||
return plugins.randomatic(patternArg, lengthArg, optionsArg);
|
return customRandomatic(patternArg, lengthArg, optionsArg);
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -1,5 +1,3 @@
|
|||||||
import * as plugins from './smartstring.plugins.js';
|
|
||||||
|
|
||||||
export class Domain {
|
export class Domain {
|
||||||
public fullName: string;
|
public fullName: string;
|
||||||
public level1: string;
|
public level1: string;
|
||||||
@@ -14,14 +12,14 @@ export class Domain {
|
|||||||
public domainName;
|
public domainName;
|
||||||
public subDomain;
|
public subDomain;
|
||||||
public port;
|
public port;
|
||||||
public nodeParsedUrl: plugins.url.UrlWithStringQuery;
|
public nodeParsedUrl: URL;
|
||||||
constructor(domainStringArg: string) {
|
constructor(domainStringArg: string) {
|
||||||
// lets do the node standard stuff first
|
// lets do the node standard stuff first
|
||||||
this.protocol = this._protocolRegex(domainStringArg);
|
this.protocol = this._protocolRegex(domainStringArg);
|
||||||
if (!this.protocol) {
|
if (!this.protocol) {
|
||||||
domainStringArg = `https://${domainStringArg}`;
|
domainStringArg = `https://${domainStringArg}`;
|
||||||
}
|
}
|
||||||
this.nodeParsedUrl = plugins.url.parse(domainStringArg);
|
this.nodeParsedUrl = new URL(domainStringArg);
|
||||||
this.port = this.nodeParsedUrl.port;
|
this.port = this.nodeParsedUrl.port;
|
||||||
|
|
||||||
// lets do the rest after
|
// lets do the rest after
|
||||||
|
|||||||
@@ -1,5 +1,3 @@
|
|||||||
import * as plugins from './smartstring.plugins.js';
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* replaces all occurences of something in a string
|
* replaces all occurences of something in a string
|
||||||
* @param stringArg
|
* @param stringArg
|
||||||
@@ -10,6 +8,38 @@ export const replaceAll = (stringArg: string, searchPattern: string, replacement
|
|||||||
return stringArg.replace(new RegExp(searchPattern, 'g'), replacementString);
|
return stringArg.replace(new RegExp(searchPattern, 'g'), replacementString);
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Custom implementation of strip-indent
|
||||||
|
* Removes the minimum indentation from all lines
|
||||||
|
*/
|
||||||
|
const stripIndent = (str: string): string => {
|
||||||
|
const lines = str.split('\n');
|
||||||
|
|
||||||
|
// Find the minimum indentation (ignoring empty lines)
|
||||||
|
let minIndent = Infinity;
|
||||||
|
for (const line of lines) {
|
||||||
|
if (line.trim().length > 0) {
|
||||||
|
const match = line.match(/^(\s*)/);
|
||||||
|
if (match) {
|
||||||
|
minIndent = Math.min(minIndent, match[1].length);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// If no indentation found, return original string
|
||||||
|
if (minIndent === Infinity || minIndent === 0) {
|
||||||
|
return str;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Remove the minimum indentation from all lines
|
||||||
|
return lines.map(line => {
|
||||||
|
if (line.length >= minIndent) {
|
||||||
|
return line.slice(minIndent);
|
||||||
|
}
|
||||||
|
return line;
|
||||||
|
}).join('\n');
|
||||||
|
};
|
||||||
|
|
||||||
export interface INormalizeOptions {
|
export interface INormalizeOptions {
|
||||||
stripLeadingTrailingEmptyLines?: boolean;
|
stripLeadingTrailingEmptyLines?: boolean;
|
||||||
stripAllEmptyLines?: boolean;
|
stripAllEmptyLines?: boolean;
|
||||||
@@ -27,11 +57,11 @@ export const standard = (stringArg: string, options?: INormalizeOptions): string
|
|||||||
let result = stringArg;
|
let result = stringArg;
|
||||||
|
|
||||||
if (!options || options.stripIndent) {
|
if (!options || options.stripIndent) {
|
||||||
result = plugins.stripIndent(result); // fix indention
|
result = stripIndent(result); // fix indention
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!options || options.normalizeNewline) {
|
if (!options || options.normalizeNewline) {
|
||||||
result = plugins.normalizeNewline(result); // fix newlines
|
result = result.replace(/\r\n/g, '\n'); // fix newlines
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!options || options.replaceTabs) {
|
if (!options || options.replaceTabs) {
|
||||||
|
|||||||
@@ -1,22 +1,4 @@
|
|||||||
// node native
|
// @push.rocks ecosystem
|
||||||
import * as smartenv from '@push.rocks/smartenv';
|
|
||||||
const smartenvInstance = new smartenv.Smartenv();
|
|
||||||
import * as isounique from '@push.rocks/isounique';
|
import * as isounique from '@push.rocks/isounique';
|
||||||
|
|
||||||
export { isounique };
|
export { isounique };
|
||||||
|
|
||||||
import { Buffer } from 'buffer';
|
|
||||||
if (smartenvInstance.isBrowser) {
|
|
||||||
globalThis.Buffer = Buffer;
|
|
||||||
}
|
|
||||||
import * as url from 'url';
|
|
||||||
export { url };
|
|
||||||
|
|
||||||
// third party
|
|
||||||
import { Base64 as jsBase64 } from 'js-base64';
|
|
||||||
|
|
||||||
import stripIndent from 'strip-indent';
|
|
||||||
import normalizeNewline from 'normalize-newline';
|
|
||||||
import randomatic from 'randomatic';
|
|
||||||
|
|
||||||
export { jsBase64, stripIndent, normalizeNewline, randomatic };
|
|
||||||
|
|||||||
@@ -1,8 +1,12 @@
|
|||||||
import * as plugins from './smartstring.plugins.js';
|
import * as plugins from './smartstring.plugins.js';
|
||||||
import * as base64 from './smartstring.base64.js';
|
import * as base64 from './smartstring.base64.js';
|
||||||
|
|
||||||
export const isUtf8 = (stringArg: string) => {
|
export const isUtf8 = (stringArg: string): boolean => {
|
||||||
const bytes = Buffer.from(stringArg);
|
// Convert string to a Uint8Array. In browsers, this will be a bit more complex
|
||||||
|
// because we need to convert the string to a binary representation first.
|
||||||
|
const encoder = new TextEncoder();
|
||||||
|
const bytes = encoder.encode(stringArg);
|
||||||
|
|
||||||
let i = 0;
|
let i = 0;
|
||||||
while (i < bytes.length) {
|
while (i < bytes.length) {
|
||||||
if (
|
if (
|
||||||
@@ -33,12 +37,14 @@ export const isUtf8 = (stringArg: string) => {
|
|||||||
0xa0 <= bytes[i + 1] &&
|
0xa0 <= bytes[i + 1] &&
|
||||||
bytes[i + 1] <= 0xbf &&
|
bytes[i + 1] <= 0xbf &&
|
||||||
0x80 <= bytes[i + 2] &&
|
0x80 <= bytes[i + 2] &&
|
||||||
bytes[i + 2] <= 0xbf) || // straight 3-byte
|
bytes[i + 2] <= 0xbf) ||
|
||||||
|
// straight 3-byte
|
||||||
(((0xe1 <= bytes[i] && bytes[i] <= 0xec) || bytes[i] === 0xee || bytes[i] === 0xef) &&
|
(((0xe1 <= bytes[i] && bytes[i] <= 0xec) || bytes[i] === 0xee || bytes[i] === 0xef) &&
|
||||||
0x80 <= bytes[i + 1] &&
|
0x80 <= bytes[i + 1] &&
|
||||||
bytes[i + 1] <= 0xbf &&
|
bytes[i + 1] <= 0xbf &&
|
||||||
0x80 <= bytes[i + 2] &&
|
0x80 <= bytes[i + 2] &&
|
||||||
bytes[i + 2] <= 0xbf) || // excluding surrogates
|
bytes[i + 2] <= 0xbf) ||
|
||||||
|
// excluding surrogates
|
||||||
(bytes[i] === 0xed &&
|
(bytes[i] === 0xed &&
|
||||||
0x80 <= bytes[i + 1] &&
|
0x80 <= bytes[i + 1] &&
|
||||||
bytes[i + 1] <= 0x9f &&
|
bytes[i + 1] <= 0x9f &&
|
||||||
@@ -57,7 +63,8 @@ export const isUtf8 = (stringArg: string) => {
|
|||||||
0x80 <= bytes[i + 2] &&
|
0x80 <= bytes[i + 2] &&
|
||||||
bytes[i + 2] <= 0xbf &&
|
bytes[i + 2] <= 0xbf &&
|
||||||
0x80 <= bytes[i + 3] &&
|
0x80 <= bytes[i + 3] &&
|
||||||
bytes[i + 3] <= 0xbf) || // planes 4-15
|
bytes[i + 3] <= 0xbf) ||
|
||||||
|
// planes 4-15
|
||||||
(0xf1 <= bytes[i] &&
|
(0xf1 <= bytes[i] &&
|
||||||
bytes[i] <= 0xf3 &&
|
bytes[i] <= 0xf3 &&
|
||||||
0x80 <= bytes[i + 1] &&
|
0x80 <= bytes[i + 1] &&
|
||||||
@@ -65,7 +72,8 @@ export const isUtf8 = (stringArg: string) => {
|
|||||||
0x80 <= bytes[i + 2] &&
|
0x80 <= bytes[i + 2] &&
|
||||||
bytes[i + 2] <= 0xbf &&
|
bytes[i + 2] <= 0xbf &&
|
||||||
0x80 <= bytes[i + 3] &&
|
0x80 <= bytes[i + 3] &&
|
||||||
bytes[i + 3] <= 0xbf) || // plane 16
|
bytes[i + 3] <= 0xbf) ||
|
||||||
|
// plane 16
|
||||||
(bytes[i] === 0xf4 &&
|
(bytes[i] === 0xf4 &&
|
||||||
0x80 <= bytes[i + 1] &&
|
0x80 <= bytes[i + 1] &&
|
||||||
bytes[i + 1] <= 0x8f &&
|
bytes[i + 1] <= 0x8f &&
|
||||||
@@ -84,6 +92,7 @@ export const isUtf8 = (stringArg: string) => {
|
|||||||
return true;
|
return true;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
||||||
export const isBase64 = (stringArg: string) => {
|
export const isBase64 = (stringArg: string) => {
|
||||||
const notBase64 = /[^A-Z0-9+\/=]/i;
|
const notBase64 = /[^A-Z0-9+\/=]/i;
|
||||||
const len = stringArg.length;
|
const len = stringArg.length;
|
||||||
|
|||||||
@@ -3,9 +3,12 @@
|
|||||||
"experimentalDecorators": true,
|
"experimentalDecorators": true,
|
||||||
"useDefineForClassFields": false,
|
"useDefineForClassFields": false,
|
||||||
"target": "ES2022",
|
"target": "ES2022",
|
||||||
"module": "ES2022",
|
"module": "NodeNext",
|
||||||
"moduleResolution": "nodenext",
|
"moduleResolution": "NodeNext",
|
||||||
"esModuleInterop": true,
|
"esModuleInterop": true,
|
||||||
"verbatimModuleSyntax": true,
|
"verbatimModuleSyntax": true
|
||||||
}
|
},
|
||||||
|
"exclude": [
|
||||||
|
"dist_*/**/*.d.ts"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user