@stdlib/fs-write-file - npm Package Compare versions

Comparing version 0.0.8 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 @@ /// <reference types="node"/>

lib/index.js

@@ -49,3 +49,3 @@ /**
 var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
-var writeFile = require( './main.js' );
+var main = require( './main.js' );
 var sync = require( './sync.js' );
@@ -56,3 +56,3 @@
 
-setReadOnly( writeFile, 'sync', sync );
+setReadOnly( main, 'sync', sync );
 
@@ -62,2 +62,2 @@
 
-module.exports = writeFile;
+module.exports = main;

package.json

 {
   "name": "@stdlib/fs-write-file",
-  "version": "0.0.8",
+  "version": "0.1.0",
   "description": "Write data to a file.",
@@ -16,5 +16,2 @@ "license": "Apache-2.0",
   ],
-  "bin": {
-    "write-file": "./bin/cli"
-  },
   "main": "./lib",
@@ -44,19 +41,9 @@ "directories": {
   "dependencies": {
-    "@stdlib/cli-ctor": "^0.0.x",
-    "@stdlib/fs-read-file": "^0.0.x",
-    "@stdlib/process-cwd": "^0.0.x",
-    "@stdlib/process-read-stdin": "^0.0.x",
-    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x"
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^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-from-string": "^0.0.x",
-    "@stdlib/process-exec-path": "^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"
   },
@@ -93,5 +80,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>
+
 # Write File
@@ -174,70 +185,4 @@
 
-* * *
 
-<section class="cli">
 
-## CLI
-
-<section class="installation">
-
-## Installation
-
-To use the module as a general utility, install the module globally
-
-```bash
-npm install -g @stdlib/fs-write-file
-```
-
-</section>
-
-<!-- CLI usage documentation. -->
-
-<section class="usage">
-
-### Usage
-
-```text
-Usage: write-file [options] <filepath>
-
-Options:
-
-  -h,    --help                Print this message.
-  -V,    --version             Print the package version.
-  --enc, --encoding encoding   Encoding. Default: 'utf8'.
-         --flag flag           Flag. Default: 'r'.
-         --mode mode           Mode. Default: 0o666.
-```
-
-</section>
-
-<!-- /.usage -->
-
-<section class="notes">
-
-### Notes
-
--   Relative output file paths are resolved relative to the current working directory.
--   Errors are written to `stderr`.
--   File contents should be provided over `stdin` as part of a [standard stream][standard-stream] pipeline.
-
-</section>
-
-<!-- /.notes -->
-
-<section class="examples">
-
-### Examples
-
-```bash
-$ printf 'beep boop\n' | write-file ./examples/fixtures/file.txt
-```
-
-</section>
-
-<!-- /.examples -->
-
-</section>
-
-<!-- /.cli -->
-
 <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
@@ -247,8 +192,7 @@
 
-* * *
-
 ## See Also
 
--   <span class="package-name">[`@stdlib/fs/exists`][@stdlib/fs/exists]</span><span class="delimiter">: </span><span class="description">test whether a path exists on the filesystem.</span>
--   <span class="package-name">[`@stdlib/fs/read-file`][@stdlib/fs/read-file]</span><span class="delimiter">: </span><span class="description">read the entire contents of a file.</span>
+-   <span class="package-name">[`@stdlib/fs-write-file-cli`][@stdlib/fs-write-file-cli]</span><span class="delimiter">: </span><span class="description">CLI package for use as a command-line utility.</span>
+-   <span class="package-name">[`@stdlib/fs-exists`][@stdlib/fs/exists]</span><span class="delimiter">: </span><span class="description">test whether a path exists on the filesystem.</span>
+-   <span class="package-name">[`@stdlib/fs-read-file`][@stdlib/fs/read-file]</span><span class="delimiter">: </span><span class="description">read the entire contents of a file.</span>
 
@@ -285,3 +229,3 @@ </section>
 
-Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 
@@ -296,7 +240,9 @@ </section>
 
+[@stdlib/fs-write-file-cli]: https://www.npmjs.com/package/@stdlib/fs-write-file-cli
+
 [npm-image]: http://img.shields.io/npm/v/@stdlib/fs-write-file.svg
 [npm-url]: https://npmjs.org/package/@stdlib/fs-write-file
 
-[test-image]: https://github.com/stdlib-js/fs-write-file/actions/workflows/test.yml/badge.svg
-[test-url]: https://github.com/stdlib-js/fs-write-file/actions/workflows/test.yml
+[test-image]: https://github.com/stdlib-js/fs-write-file/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/fs-write-file/actions/workflows/test.yml?query=branch:v0.1.0
 
@@ -313,2 +259,13 @@ [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/fs-write-file/main.svg
 
+[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
+[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
+
+[stdlib]: https://github.com/stdlib-js/stdlib
+
+[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
+
+[cli-section]: https://github.com/stdlib-js/fs-write-file#cli
+[cli-url]: https://github.com/stdlib-js/fs-write-file/tree/cli
+[@stdlib/fs-write-file]: https://github.com/stdlib-js/fs-write-file/tree/main
+
 [umd]: https://github.com/umdjs/umd
@@ -320,10 +277,4 @@ [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
 [esm-url]: https://github.com/stdlib-js/fs-write-file/tree/esm
+[branches-url]: https://github.com/stdlib-js/fs-write-file/blob/main/branches.md
 
-[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://gitter.im/stdlib-js/stdlib/
-
-[stdlib]: https://github.com/stdlib-js/stdlib
-
-[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
-
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/fs-write-file/main/LICENSE
@@ -335,3 +286,3 @@
 
-[standard-stream]: http://en.wikipedia.org/wiki/Pipeline_%28Unix%29
+[standard-stream]: https://en.wikipedia.org/wiki/Pipeline_%28Unix%29
 
@@ -338,0 +289,0 @@ <!-- <related-links> -->

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Unidentified License

License

(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Improved metrics

Dependency count

1

decreased by-80%

Dev dependency count

4

decreased by-60%

Worsened metrics

Total package byte prevSize

34972

decreased by-38.37%

Number of package files

12

decreased by-7.69%

Lines of code

276

decreased by-40.13%

Number of low quality alerts

2

increased by100%

Number of lines in readme file

292

decreased by-14.37%

Number of low supply chain risk alerts

4

increased by100%

Dependency changes

• + 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/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)

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

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

• - Removed@stdlib/process-cwd@^0.0.x

• - Removed@stdlib/process-read-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-like@0.0.8(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-cwd@0.0.8(transitive)

• - Removed@stdlib/process-read-stdin@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-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/utils-define-nonenumerable-read-only-property@^0.1.0