@stdlib/string-remove-utf8-bom - npm Package Compare versions

Comparing version 0.0.9 to 0.1.0

docs/types/index.d.ts

@@ -19,3 +19,3 @@ /*
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
@@ -22,0 +22,0 @@ /**

lib/index.js

@@ -35,3 +35,3 @@ /**
 
-var removeUTF8BOM = require( './remove_utf_8_bom.js' );
+var removeUTF8BOM = require( './main.js' );
 
@@ -38,0 +38,0 @@

package.json

 {
   "name": "@stdlib/string-remove-utf8-bom",
-  "version": "0.0.9",
+  "version": "0.1.0",
   "description": "Remove a UTF-8 byte order mark (BOM) from the beginning of a string.",
@@ -16,5 +16,2 @@ "license": "Apache-2.0",
   ],
-  "bin": {
-    "remove-utf8-bom": "./bin/cli"
-  },
   "main": "./lib",
@@ -44,22 +41,10 @@ "directories": {
   "dependencies": {
-    "@stdlib/assert-is-string": "^0.0.x",
-    "@stdlib/cli-ctor": "^0.0.x",
-    "@stdlib/fs-read-file": "^0.0.x",
-    "@stdlib/process-read-stdin": "^0.0.x",
-    "@stdlib/regexp-eol": "^0.0.x",
-    "@stdlib/streams-node-stdin": "^0.0.x",
-    "@stdlib/string-format": "^0.0.x"
+    "@stdlib/assert-is-string": "^0.1.0",
+    "@stdlib/string-format": "^0.1.0"
   },
   "devDependencies": {
-    "@stdlib/assert-is-browser": "^0.0.x",
-    "@stdlib/assert-is-windows": "^0.0.x",
-    "@stdlib/bench": "^0.0.x",
-    "@stdlib/buffer-ctor": "^0.0.x",
-    "@stdlib/process-exec-path": "^0.0.x",
-    "@stdlib/string-from-code-point": "^0.0.x",
-    "@stdlib/string-replace": "^0.0.x",
     "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
     "proxyquire": "^2.0.0",
     "istanbul": "^0.4.1",
-    "tap-spec": "5.x.x"
+    "tap-min": "git+https://github.com/Planeshifter/tap-min.git"
   },
@@ -101,5 +86,5 @@ "engines": {
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

README.md

@@ -21,2 +21,13 @@ <!--
 
+
+<details>
+  <summary>
+    About stdlib...
+  </summary>
+  <p>We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.</p>
+  <p>The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.</p>
+  <p>When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.</p>
+  <p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p>
+</details>
+
 # Remove UTF-8 BOM
@@ -91,71 +102,15 @@
 
-* * *
 
-<section class="cli">
 
-## CLI
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
 
-<section class="installation">
+<section class="related">
 
-## Installation
+## See Also
 
-To use the module as a general utility, install the module globally
+-   <span class="package-name">[`@stdlib/string-remove-utf8-bom-cli`][@stdlib/string-remove-utf8-bom-cli]</span><span class="delimiter">: </span><span class="description">CLI package for use as a command-line utility.</span>
 
-```bash
-npm install -g @stdlib/string-remove-utf8-bom
-```
 
 </section>
 
-<!-- CLI usage documentation. -->
-
-<section class="usage">
-
-### Usage
-
-```text
-Usage: remove-utf8-bom [options] [<string>]
-
-Options:
-
-  -h,    --help                Print this message.
-  -V,    --version             Print the package version.
-```
-
-</section>
-
-<!-- /.usage -->
-
-<section class="examples">
-
-### Examples
-
-Assuming a shell which understands escape sequences,
-
-```bash
-$ remove-utf8-bom "\xEF\xBB\xBFbeep boop"
-beep boop
-```
-
-To use as a [standard stream][standard-streams],
-
-```bash
-$ echo -n '\ufeffbeep' | remove-utf8-bom
-beep
-```
-
-</section>
-
-<!-- /.examples -->
-
-</section>
-
-<!-- /.cli -->
-
-<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
-
-<section class="related">
-
-</section>
-
 <!-- /.related -->
@@ -189,3 +144,3 @@
 
-Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 
@@ -200,7 +155,9 @@ </section>
 
+[@stdlib/string-remove-utf8-bom-cli]: https://www.npmjs.com/package/@stdlib/string-remove-utf8-bom-cli
+
 [npm-image]: http://img.shields.io/npm/v/@stdlib/string-remove-utf8-bom.svg
 [npm-url]: https://npmjs.org/package/@stdlib/string-remove-utf8-bom
 
-[test-image]: https://github.com/stdlib-js/string-remove-utf8-bom/actions/workflows/test.yml/badge.svg?branch=v0.0.9
-[test-url]: https://github.com/stdlib-js/string-remove-utf8-bom/actions/workflows/test.yml?query=branch:v0.0.9
+[test-image]: https://github.com/stdlib-js/string-remove-utf8-bom/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/string-remove-utf8-bom/actions/workflows/test.yml?query=branch:v0.1.0
 
@@ -218,3 +175,3 @@ [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/string-remove-utf8-bom/main.svg
 [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://gitter.im/stdlib-js/stdlib/
+[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
 
@@ -225,2 +182,6 @@ [stdlib]: https://github.com/stdlib-js/stdlib
 
+[cli-section]: https://github.com/stdlib-js/string-remove-utf8-bom#cli
+[cli-url]: https://github.com/stdlib-js/string-remove-utf8-bom/tree/cli
+[@stdlib/string-remove-utf8-bom]: https://github.com/stdlib-js/string-remove-utf8-bom/tree/main
+
 [umd]: https://github.com/umdjs/umd
@@ -227,0 +188,0 @@ [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

27315

increased by3.38%

Dependency count

2

decreased by-71.43%

Dev dependency count

4

decreased by-63.64%

Worsened metrics

Number of package files

11

decreased by-8.33%

Lines of code

134

decreased by-25.56%

Number of lines in readme file

198

decreased by-16.46%

Dependency changes

• + Added@stdlib/assert-has-own-property@0.1.1(transitive)

• + Added@stdlib/assert-has-symbol-support@0.1.1(transitive)

• + Added@stdlib/assert-has-tostringtag-support@0.1.1(transitive)

• + Added@stdlib/assert-is-string@0.1.1(transitive)

• + Added@stdlib/error-tools-fmtprodmsg@0.1.1(transitive)

• + Added@stdlib/string-base-format-interpolate@0.1.1(transitive)

• + Added@stdlib/string-base-format-tokenize@0.1.1(transitive)

• + Added@stdlib/string-format@0.1.1(transitive)

• + Added@stdlib/symbol-ctor@0.1.1(transitive)

• + Added@stdlib/types@0.1.0(transitive)

• + Added@stdlib/utils-define-nonenumerable-read-only-property@0.1.1(transitive)

• + Added@stdlib/utils-define-property@0.1.1(transitive)

• + Added@stdlib/utils-native-class@0.1.1(transitive)

• - Removed@stdlib/cli-ctor@^0.0.x

• - Removed@stdlib/fs-read-file@^0.0.x

• - Removed@stdlib/process-read-stdin@^0.0.x

• - Removed@stdlib/regexp-eol@^0.0.x

• - Removed@stdlib/streams-node-stdin@^0.0.x

• - Removed@stdlib/assert-has-node-buffer-support@0.0.8(transitive)

• - Removed@stdlib/assert-has-own-property@0.0.7(transitive)

• - Removed@stdlib/assert-has-symbol-support@0.0.8(transitive)

• - Removed@stdlib/assert-has-tostringtag-support@0.0.9(transitive)

• - Removed@stdlib/assert-is-array@0.0.7(transitive)

• - Removed@stdlib/assert-is-boolean@0.0.8(transitive)

• - Removed@stdlib/assert-is-buffer@0.0.8(transitive)

• - Removed@stdlib/assert-is-function@0.0.8(transitive)

• - Removed@stdlib/assert-is-object@0.0.8(transitive)

• - Removed@stdlib/assert-is-object-like@0.0.8(transitive)

• - Removed@stdlib/assert-is-plain-object@0.0.7(transitive)

• - Removed@stdlib/assert-is-string@0.0.8(transitive)

• - Removed@stdlib/assert-tools-array-function@0.0.7(transitive)

• - Removed@stdlib/buffer-ctor@0.0.7(transitive)

• - Removed@stdlib/buffer-from-string@0.0.8(transitive)

• - Removed@stdlib/cli-ctor@0.0.3(transitive)

• - Removed@stdlib/fs-read-file@0.0.8(transitive)

• - Removed@stdlib/process-read-stdin@0.0.7(transitive)

• - Removed@stdlib/regexp-eol@0.0.7(transitive)

• - Removed@stdlib/regexp-function-name@0.0.7(transitive)

• - Removed@stdlib/streams-node-stdin@0.0.7(transitive)

• - Removed@stdlib/string-base-format-interpolate@0.0.4(transitive)

• - Removed@stdlib/string-base-format-tokenize@0.0.4(transitive)

• - Removed@stdlib/string-format@0.0.3(transitive)

• - Removed@stdlib/types@0.0.14(transitive)

• - Removed@stdlib/utils-constructor-name@0.0.8(transitive)

• - Removed@stdlib/utils-define-nonenumerable-read-only-property@0.0.7(transitive)

• - Removed@stdlib/utils-define-property@0.0.9(transitive)

• - Removed@stdlib/utils-get-prototype-of@0.0.7(transitive)

• - Removed@stdlib/utils-global@0.0.7(transitive)

• - Removed@stdlib/utils-native-class@0.0.8(transitive)

• - Removed@stdlib/utils-next-tick@0.0.8(transitive)

• - Removed@stdlib/utils-noop@0.0.14(transitive)

• - Removed@stdlib/utils-type-of@0.0.8(transitive)

• - Removedminimist@1.2.8(transitive)

• Updated@stdlib/assert-is-string@^0.1.0

• Updated@stdlib/string-format@^0.1.0