@stdlib/string-first 0.1.0 → 0.2.1

package/NOTICE

@@ -1 +1 @@
-Copyright (c) 2016-2023 The Stdlib Authors.
+Copyright (c) 2016-2024 The Stdlib Authors.

package/README.md

@@ -72,7 +72,7 @@ The function supports the following options:
     -   `'grapheme'`: grapheme clusters. Appropriate for strings containing visual characters which can span multiple Unicode code points (e.g., emoji).
     -   `'code_point'`: Unicode code points. Appropriate for strings containing visual characters which are comprised of more than one Unicode code unit (e.g., ideographic symbols and punctuation and mathematical alphanumerics).
     -   `'code_unit'`: UTF-16 code units. Appropriate for strings containing visual characters drawn from the basic multilingual plane (BMP) (e.g., common characters, such as those from the Latin, Greek, and Cyrillic alphabets).
-    
+
     Default: `'grapheme'`.
 
 By default, the function returns the first character. To return the first `n` characters, provide a second argument specifying the number of characters to return.
@@ -101,7 +101,6 @@ out = first( 'foo bar', 10 );
 
 <!-- /.notes -->
 
-
 <section class="examples">
 
 ## Examples
@@ -146,7 +145,7 @@ str = first( '🐶🐮🐷🐰🐸', 10 );
 ## See Also
 
 -   <span class="package-name">[`@stdlib/string-first-cli`][@stdlib/string-first-cli]</span><span class="delimiter">: </span><span class="description">CLI package for use as a command-line utility.</span>
-
+-   <span class="package-name">[`@stdlib/string-remove-first`][@stdlib/string/remove-first]</span><span class="delimiter">: </span><span class="description">remove the first character(s) of a string.</span>
 
 </section>
 
@@ -178,7 +177,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -193,8 +192,8 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/string-first.svg
 [npm-url]: https://npmjs.org/package/@stdlib/string-first
 
-[test-image]: https://github.com/stdlib-js/string-first/actions/workflows/test.yml/badge.svg?branch=v0.1.0
-[test-url]: https://github.com/stdlib-js/string-first/actions/workflows/test.yml?query=branch:v0.1.0
+[test-image]: https://github.com/stdlib-js/string-first/actions/workflows/test.yml/badge.svg?branch=v0.2.1
+[test-url]: https://github.com/stdlib-js/string-first/actions/workflows/test.yml?query=branch:v0.2.1
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/string-first/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/string-first?branch=main
@@ -221,8 +220,11 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
 
 [deno-url]: https://github.com/stdlib-js/string-first/tree/deno
+[deno-readme]: https://github.com/stdlib-js/string-first/blob/deno/README.md
 [umd-url]: https://github.com/stdlib-js/string-first/tree/umd
+[umd-readme]: https://github.com/stdlib-js/string-first/blob/umd/README.md
 [esm-url]: https://github.com/stdlib-js/string-first/tree/esm
+[esm-readme]: https://github.com/stdlib-js/string-first/blob/esm/README.md
 [branches-url]: https://github.com/stdlib-js/string-first/blob/main/branches.md
 
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/string-first/main/LICENSE
@@ -231,6 +233,12 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 
 [mdn-regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
 
+<!-- <related-links> -->
+
+[@stdlib/string/remove-first]: https://www.npmjs.com/package/@stdlib/string-remove-first
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->

package/SECURITY.md

@@ -0,0 +1,5 @@
+# Security
+
+> Policy for reporting security vulnerabilities.
+
+See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security).

package/docs/types/index.d.ts

@@ -18,7 +18,7 @@
 
 // TypeScript Version: 4.1
 
-// tslint:disable:unified-signatures
+/* eslint-disable @typescript-eslint/unified-signatures */
 
 /**
 * Interface describing function options.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/string-first",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "description": "Return the first character(s) of a string.",
   "license": "Apache-2.0",
   "author": {
@@ -15,19 +15,12 @@
   ],
   "main": "./lib",
   "directories": {
-    "benchmark": "./benchmark",
     "doc": "./docs",
-    "example": "./examples",
     "lib": "./lib",
-    "test": "./test"
+    "dist": "./dist"
   },
   "types": "./docs/types",
-  "scripts": {
-    "test": "make test",
-    "test-cov": "make test-cov",
-    "examples": "make examples",
-    "benchmark": "make benchmark"
-  },
+  "scripts": {},
   "homepage": "https://stdlib.io",
   "repository": {
     "type": "git",
@@ -37,22 +30,18 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/array-base-assert-contains": "^0.1.0",
-    "@stdlib/assert-has-own-property": "^0.1.0",
-    "@stdlib/assert-is-nonnegative-integer": "^0.1.0",
-    "@stdlib/assert-is-plain-object": "^0.1.0",
-    "@stdlib/assert-is-string": "^0.1.0",
-    "@stdlib/string-base-first": "^0.1.0",
-    "@stdlib/string-base-first-code-point": "^0.1.0",
-    "@stdlib/string-base-first-grapheme-cluster": "^0.1.0",
-    "@stdlib/string-format": "^0.1.0"
-  },
-  "devDependencies": {
-    "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
-    "proxyquire": "^2.0.0",
-    "istanbul": "^0.4.1",
-    "tap-min": "git+https://github.com/Planeshifter/tap-min.git"
+    "@stdlib/array-base-assert-contains": "^0.2.1",
+    "@stdlib/assert-has-own-property": "^0.2.1",
+    "@stdlib/assert-is-nonnegative-integer": "^0.2.1",
+    "@stdlib/assert-is-plain-object": "^0.2.1",
+    "@stdlib/assert-is-string": "^0.2.1",
+    "@stdlib/string-base-first": "^0.2.1",
+    "@stdlib/string-base-first-code-point": "^0.2.1",
+    "@stdlib/string-base-first-grapheme-cluster": "^0.2.1",
+    "@stdlib/string-format": "^0.2.1",
+    "@stdlib/error-tools-fmtprodmsg": "^0.2.1"
   },
+  "devDependencies": {},
   "engines": {
     "node": ">=0.10.0",
     "npm": ">2.7.0"

package/CITATION.cff

@@ -1,30 +0,0 @@
-cff-version: 1.2.0
-title: stdlib
-message: >-
-  If you use this software, please cite it using the
-  metadata from this file.
-
-type: software
-
-authors:
-  - name: The Stdlib Authors
-    url: https://github.com/stdlib-js/stdlib/graphs/contributors
-
-repository-code: https://github.com/stdlib-js/stdlib
-url: https://stdlib.io
-
-abstract: |
-  Standard library for JavaScript and Node.js.
-
-keywords:
-  - JavaScript
-  - Node.js
-  - TypeScript
-  - standard library
-  - scientific computing
-  - numerical computing
-  - statistical computing
-
-license: Apache-2.0 AND BSL-1.0
-
-date-released: 2016