@stdlib/string-dotcase 0.0.1 → 0.0.4

package/NOTICE

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

package/README.md

@@ -1,31 +1,31 @@
-<!--
-
-@license Apache-2.0
-
-Copyright (c) 2023 The Stdlib Authors.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-   http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-
--->
-
-# dotcase
-
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2023 The Stdlib Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+-->
+
+# dotcase
+
 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
 
-> Convert a string to dot case.
-
-<!-- Package usage documentation. -->
-
+> Convert a string to dot case.
+
+<!-- Package usage documentation. -->
+
 <section class="installation">
 
 ## Installation
@@ -36,79 +36,81 @@ npm install @stdlib/string-dotcase
 
 </section>
 
-<section class="usage">
-
-## Usage
-
-```javascript
-var dotcase = require( '@stdlib/string-dotcase' );
-```
-
-#### dotcase( str )
-
-Converts a string to dot case.
-
-```javascript
-var out = dotcase( 'foo bar' );
-// returns 'foo.bar'
-
-out = dotcase( 'IS_MOBILE' );
-// returns 'is.mobile'
-
-out = dotcase( 'Hello World!' );
-// returns 'hello.world'
-
-out = dotcase( '--foo-bar--' );
-// returns 'foo.bar'
-```
-
-</section>
-
-<!-- /.usage -->
-
-<!-- Package usage examples. -->
-
-<section class="examples">
-
-## Examples
-
-```javascript
-var dotcase = require( '@stdlib/string-dotcase' );
-
-var str = 'Hello World!';
-var out = dotcase( str );
-// returns 'hello.world'
-
-str = 'HELLO WORLD!';
-out = dotcase( str );
-// returns 'hello.world'
-
-str = 'To be, or not to be: that is the question.';
-out = dotcase( str );
-// returns 'to.be.or.not.to.be.that.is.the.question'
-```
-
-</section>
-
-<!-- /.examples -->
-
-
-
-<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
-
+<section class="usage">
+
+## Usage
+
+```javascript
+var dotcase = require( '@stdlib/string-dotcase' );
+```
+
+#### dotcase( str )
+
+Converts a string to dot case.
+
+```javascript
+var out = dotcase( 'foo bar' );
+// returns 'foo.bar'
+
+out = dotcase( 'IS_MOBILE' );
+// returns 'is.mobile'
+
+out = dotcase( 'Hello World!' );
+// returns 'hello.world'
+
+out = dotcase( '--foo-bar--' );
+// returns 'foo.bar'
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+```javascript
+var dotcase = require( '@stdlib/string-dotcase' );
+
+var str = 'Hello World!';
+var out = dotcase( str );
+// returns 'hello.world'
+
+str = 'HELLO WORLD!';
+out = dotcase( str );
+// returns 'hello.world'
+
+str = 'To be, or not to be: that is the question.';
+out = dotcase( str );
+// returns 'to.be.or.not.to.be.that.is.the.question'
+```
+
+</section>
+
+<!-- /.examples -->
+
+* * *
+
+
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
 <section class="related">
 
 ## See Also
 
 -   <span class="package-name">[`@stdlib/string-dotcase-cli`][@stdlib/string-dotcase-cli]</span><span class="delimiter">: </span><span class="description">CLI package for use as a command-line utility.</span>
-
-
-</section>
-
-<!-- /.related -->
-
-<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
-
+
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
 
 <section class="main-repo" >
 
@@ -148,8 +150,8 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/string-dotcase.svg
 [npm-url]: https://npmjs.org/package/@stdlib/string-dotcase
 
-[test-image]: https://github.com/stdlib-js/string-dotcase/actions/workflows/test.yml/badge.svg?branch=v0.0.1
-[test-url]: https://github.com/stdlib-js/string-dotcase/actions/workflows/test.yml?query=branch:v0.0.1
+[test-image]: https://github.com/stdlib-js/string-dotcase/actions/workflows/test.yml/badge.svg?branch=v0.0.4
+[test-url]: https://github.com/stdlib-js/string-dotcase/actions/workflows/test.yml?query=branch:v0.0.4
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/string-dotcase/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/string-dotcase?branch=main
@@ -180,12 +182,12 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 [esm-url]: https://github.com/stdlib-js/string-dotcase/tree/esm
 [branches-url]: https://github.com/stdlib-js/string-dotcase/blob/main/branches.md
 
-[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/string-dotcase/main/LICENSE
-
-[standard-streams]: https://en.wikipedia.org/wiki/Standard_streams
-
-[mdn-regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
-
-</section>
-
-<!-- /.links -->
+[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/string-dotcase/main/LICENSE
+
+[standard-streams]: https://en.wikipedia.org/wiki/Standard_streams
+
+[mdn-regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
+
+</section>
+
+<!-- /.links -->

package/docs/types/index.d.ts

@@ -1,44 +1,44 @@
-/*
-* @license Apache-2.0
-*
-* Copyright (c) 2023 The Stdlib Authors.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-*    http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
-
-// TypeScript Version: 2.0
-
-/**
-* Converts a string to dot case.
-*
-* @param str - string to convert
-* @returns dot-cased string
-*
-* @example
-* var str = dotcase( 'Hello World!' );
-* // returns 'hello.world'
-*
-* @example
-* var str = dotcase( 'foo_bar' );
-* // returns 'foo.bar'
-*
-* @example
-* var str = dotcase( 'foo-bar' );
-* // returns 'foo.bar'
-*/
-declare function dotcase( str: string ): string;
-
-
-// EXPORTS //
-
-export = dotcase;
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2023 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+// TypeScript Version: 2.0
+
+/**
+* Converts a string to dot case.
+*
+* @param str - string to convert
+* @returns dot-cased string
+*
+* @example
+* var str = dotcase( 'Hello World!' );
+* // returns 'hello.world'
+*
+* @example
+* var str = dotcase( 'foo_bar' );
+* // returns 'foo.bar'
+*
+* @example
+* var str = dotcase( 'foo-bar' );
+* // returns 'foo.bar'
+*/
+declare function dotcase( str: string ): string;
+
+
+// EXPORTS //
+
+export = dotcase;

package/lib/index.js

@@ -1,4 +1,20 @@
-// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2023 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
 
 'use strict';
 

package/lib/main.js

@@ -1,11 +1,27 @@
-// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2023 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
 
 'use strict';
 
 // MODULES //
 
 var isString = require( '@stdlib/assert-is-string' ).isPrimitive;
-var format = require( '@stdlib/error-tools-fmtprodmsg' );
+var format = require( '@stdlib/string-format' );
 var base = require( '@stdlib/string-base-dotcase' );
 
 
@@ -36,7 +52,7 @@ var base = require( '@stdlib/string-base-dotcase' );
 */
 function dotcase( str ) {
 	if ( !isString( str ) ) {
-		throw new TypeError( format( "null3F,Ex", str ) );
+		throw new TypeError( format( 'invalid argument. First argument must be a string. Value: `%s`.', str ) );
 	}
 	return base( str );
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/string-dotcase",
-  "version": "0.0.1",
+  "version": "0.0.4",
   "description": "Convert a string to dot case.",
   "license": "Apache-2.0",
   "author": {
@@ -39,6 +39,7 @@
   "dependencies": {
     "@stdlib/assert-is-string": "^0.0.8",
     "@stdlib/string-base-dotcase": "^0.0.1",
+    "@stdlib/string-format": "^0.0.3",
     "@stdlib/error-tools-fmtprodmsg": "^0.0.2"
   },
   "devDependencies": {