@grandom/string - npm Package Compare versions

Comparing version 1.2.4 to 1.2.5

index.js

@@ -1,11 +0,1 @@
-/*!
- * @grandom/string v1.2.4
- * https://github.com/grandom-library/grandom-js/tree/main/packages/string#readme
- *
- * Copyright (c) 2023 Richard King <[e-mail]> (www.richrdkng.com)
- * Released under the MIT License
- * https://github.com/grandom-library/grandom-js/tree/main/packages/string#readme/blob/main/LICENSE
- *
- * Date: 2023-08-24T23:49:01.646Z
- */
 'use strict';
@@ -18,4 +8,7 @@
 const string = random.string.bind(random);
+// @ts-expect-error
+// make RandomString accessible in UMD
+random.RandomString = index;
 
 module.exports = string;
 //# sourceMappingURL=index.js.map

package.json

 {
   "name": "@grandom/string",
-  "version": "1.2.4",
-  "description": "Great random string generator.",
+  "version": "1.2.5",
+  "description": "A great random string generator.",
   "author": "Richard King <[e-mail]> (www.richrdkng.com)",
@@ -19,2 +19,20 @@ "license": "MIT",
   "homepage": "https://github.com/grandom-library/grandom-js/tree/main/packages/string#readme",
+  "keywords": [
+    "random",
+    "seedable",
+    "generator",
+    "string",
+    "biased",
+    "seed",
+    "rng",
+    "prng",
+    "srng",
+    "sprng",
+    "crypto",
+    "randomness",
+    "rand",
+    "seedrand",
+    "seedrandom",
+    "grandom"
+  ],
   "engines": {
@@ -30,8 +48,12 @@ "node": ">= 16"
     "start": "npm test -- --watchAll",
-    "types": "tsc --noEmit && tsc -p tsconfig.types.json --outDir .temp",
-    "lint": "ts-standard --verbose | snazzy",
+    "fix:lint": "ts-standard --verbose --fix | snazzy",
+    "check": "npm run check:commits && npm run check:lint && npm run check:types && npm test",
+    "//": "-------------------------------------------------------------------",
+    "check:commits": "commitlint --from $(git rev-parse --short HEAD^1) --to $(git rev-parse --short HEAD^2) --verbose",
+    "check:lint": "ts-standard --verbose | snazzy",
+    "check:types": "tsc --noEmit && tsc -p tsconfig.types.json --outDir .temp-types && rm -rf .temp-types",
     "test": "jest",
     "prep": "npm run __prep:init && npm run __prep:copy",
     "build": "npm run __build:src && npm run __build:types",
-    "//": "-------------------------------------------------------------------",
+    "///": "------------------------------------------------------------------",
     "__prep:init": "rm -rf dist && mkdir dist",
@@ -43,2 +65,6 @@ "__prep:copy": "cp ../../LICENSE* README* package.json dist",
   "devDependencies": {
+    "@commitlint/cli": "^17.7.1",
+    "@commitlint/config-conventional": "^17.7.0",
+    "@rollup/plugin-commonjs": "^25.0.4",
+    "@rollup/plugin-node-resolve": "^15.2.1",
     "@rollup/plugin-terser": "^0.4.3",
@@ -45,0 +71,0 @@ "@rollup/plugin-typescript": "^11.1.2",

RandomString/index.js

@@ -1,11 +0,1 @@
-/*!
- * @grandom/string v1.2.4
- * https://github.com/grandom-library/grandom-js/tree/main/packages/string#readme
- *
- * Copyright (c) 2023 Richard King <[e-mail]> (www.richrdkng.com)
- * Released under the MIT License
- * https://github.com/grandom-library/grandom-js/tree/main/packages/string#readme/blob/main/LICENSE
- *
- * Date: 2023-08-24T23:49:01.646Z
- */
 'use strict';
@@ -12,0 +2,0 @@

README.md

@@ -1,7 +0,71 @@
-# grandom/string
+<h1 align="center">
+  @grandom/string
+</h1>
 
-Versatile and great random data generator.
+<br />
 
-## License
+<!-- Badges - 1st row -->
+<p align="center">
+  <!-- NPM badge -->
+  <a href="https://www.npmjs.com/package/@grandom/string"><img src="https://img.shields.io/npm/v/@grandom/string?color=brightgreen&logo=npm" alt="release-badge"></a>
+  <!-- CI badge -->
+  <a href="https://github.com/grandom-library/grandom-js/actions?query=workflow%3ACI"><img src="https://github.com/grandom-library/grandom-js/workflows/CI/badge.svg" alt="ci-badge"></a>
+  <!-- Coverage badge -->
+  <a href="https://app.codecov.io/gh/grandom-library/grandom-js/tree/main/packages"><img src="https://img.shields.io/codecov/c/github/grandom-library/grandom-js?flag=grandom-string&logo=codecov&logoColor=white" alt="coverage-badge"></a>
+  <!-- Dependency badge -->
+  <a href="https://github.com/grandom-library/grandom-js/pulls?q=is%3Apr+is%3Aopen+label%3Adependencies"><img src="https://img.shields.io/badge/Dependencies-✔-brightgreen.svg?logo=dependabot" alt="dependency-badge"></a>
+  <!-- Security badge -->
+  <a href="https://socket.dev/npm/package/@grandom/string"><img src="https://img.shields.io/badge/Security-✔-brightgreen.svg?logo=auth0&logoColor=white" alt="release-workflow-badge"></a> 
+</p>
 
+<!-- Badges - 2nd row -->
+<p align="center">
+  <!-- Code style badge -->
+  <a href="https://www.npmjs.com/package/ts-standard"><img src="https://img.shields.io/badge/Code-TS--Standard-3178C6.svg?logo=typescript&logoColor=white" alt="code-style-badge"></a>
+  <!-- Commit style badge -->
+  <a href="https://github.com/semantic-release/semantic-release/blob/master/CONTRIBUTING.md#commit-message-guidelines"><img src="https://img.shields.io/badge/Commit-Conventional_Commits-EF7B4D.svg?logo=git&logoColor=white" alt="commit-style-badge"></a>
+  <!-- Release workflow badge -->
+  <a href="https://semantic-release.gitbook.io/semantic-release"><img src="https://img.shields.io/badge/Release-Semantic_Release-ED2B88.svg?logo=semanticweb&logoColor=white" alt="release-workflow-badge"></a>    
+</p>
+
+<!-- Badges - 3rd row -->
+<p align="center">
+  <!-- License badge -->
+  <a href="https://github.com/grandom-library/grandom-js/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-brightgreen.svg?logo=github" alt="license-badge"></a>
+  <!-- Contribution badge -->
+  <a href="https://github.com/grandom-library/grandom-js/blob/main/.github/CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-Welcome!-brightgreen.svg?logo=git&logoColor=white" alt="contribution-badge"></a>
+</p>
+
+---
+
+<h3 align="center">
+  The necessary random strings for your work.
+</h3>
+
+<p align="center">
+  A configurable, flexible, and overall great<br/> <b>random 
+  string generator</b> with an optional bias capability.
+</p>
+
+---
+
+## 📦 Installation
+
+```
+npm i @grandom/string
+```
+
+## ⭐ Related
+
+- [grandom on GitHub](https://github.com/grandom-library)
+- [grandom on NPM](https://www.npmjs.com/search?q=keywords:grandom)
+
+## 🍻 Contribution
+
+**Any contribution is ***highly appreciated*****. To get going, check out the [**contribution guidelines**][url-contrib-doc].
+
+***Thank you!***
+
+## ©️ License
+
 [MIT][url-license-doc] @ [Richard King](https://richrdkng.com)
@@ -12,2 +76,3 @@
 <!--- URLs -->
-[url-license-doc]: https://github.com/grandom/grandom-js/blob/main/LICENSE
+[url-license-doc]: https://github.com/grandom-library/grandom-js/blob/main/LICENSE
+[url-contrib-doc]: https://github.com/grandom-library/grandom-js/blob/main/.github/CONTRIBUTING.md

No alert changes

Improved metrics

Total package byte prevSize

43903

173.86%

Number of package files

12

20%

Lines of code

241

22.96%

Number of lines in readme file

78

500%

Worsened metrics

Dev dependency count

26

18.18%

No dependency changes