@stdlib/datasets-cmudict 0.0.7 → 0.1.0

package/CITATION.cff

@@ -0,0 +1,30 @@
+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

package/NOTICE

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

package/README.md

@@ -18,9 +18,20 @@ limitations under the License.
 
 -->
 
+
+<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>
+
 # CMUdict
 
-[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] [![dependencies][dependencies-image]][dependencies-url]
+[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
 
 > The Carnegie Mellon Pronouncing Dictionary.
 
@@ -187,82 +198,32 @@ console.dir( cmudict( opts ) );
 
 <!-- /.examples -->
 
-* * *
-
-<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/datasets-cmudict
-```
-
-</section>
-
-<section class="usage">
-
-### Usage
-
-```text
-Usage: cmudict [options]
-
-Options:
-
-  -h,    --help                Print this message.
-  -V,    --version             Print the package version.
-         --data name           Dataset name: dict, phones, symbols, vp.
-```
-
-</section>
 
-<!-- /.usage -->
 
-<section class="notes">
+* * *
 
-### Notes
+<!-- <license> -->
 
--   If the `--data` option is set to a supported dataset name, the CLI prints the contents of the respective dataset file as plain text. Otherwise, the output format is newline-delimited JSON ([NDJSON][ndjson]).
+## License
 
-</section>
+The data files (databases) and their contents are licensed under a [BSD-2-Clause license][bsd-license]. The software is licensed under [Apache License, Version 2.0][apache-license].
 
-<!-- /.notes -->
+<!-- </license> -->
 
-<section class="examples">
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
 
-### Examples
+<section class="related">
 
-```bash
-$ cmudict --data symbols
-AA
-AA0
-AA1
-AA2
-...
-```
+## See Also
 
-</section>
+-   <span class="package-name">[`@stdlib/datasets-cmudict-cli`][@stdlib/datasets-cmudict-cli]</span><span class="delimiter">: </span><span class="description">CLI package for use as a command-line utility.</span>
 
-<!-- /.examples -->
 
 </section>
 
-<!-- /.cli -->
-
-* * *
-
-<!-- <license> -->
-
-## License
-
-The data files (databases) and their contents are licensed under a [BSD-2-Clause license][bsd-license]. The software is licensed under [Apache License, Version 2.0][apache-license].
+<!-- /.related -->
 
-<!-- </license> -->
+<!-- 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" >
@@ -283,7 +244,7 @@ For more information on the project, filing bug reports and feature requests, an
 
 ## Copyright
 
-Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -293,25 +254,43 @@ Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
 
 <section class="links">
 
+[@stdlib/datasets-cmudict-cli]: https://www.npmjs.com/package/@stdlib/datasets-cmudict-cli
+
 [npm-image]: http://img.shields.io/npm/v/@stdlib/datasets-cmudict.svg
 [npm-url]: https://npmjs.org/package/@stdlib/datasets-cmudict
 
-[test-image]: https://github.com/stdlib-js/datasets-cmudict/actions/workflows/test.yml/badge.svg
-[test-url]: https://github.com/stdlib-js/datasets-cmudict/actions/workflows/test.yml
+[test-image]: https://github.com/stdlib-js/datasets-cmudict/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/datasets-cmudict/actions/workflows/test.yml?query=branch:v0.1.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/datasets-cmudict/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/datasets-cmudict?branch=main
 
+<!--
+
 [dependencies-image]: https://img.shields.io/david/stdlib-js/datasets-cmudict.svg
 [dependencies-url]: https://david-dm.org/stdlib-js/datasets-cmudict/main
 
+-->
+
 [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
 
 [stdlib]: https://github.com/stdlib-js/stdlib
 
 [stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
 
+[cli-section]: https://github.com/stdlib-js/datasets-cmudict#cli
+[cli-url]: https://github.com/stdlib-js/datasets-cmudict/tree/cli
+[@stdlib/datasets-cmudict]: https://github.com/stdlib-js/datasets-cmudict/tree/main
+
+[umd]: https://github.com/umdjs/umd
+[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
+
+[deno-url]: https://github.com/stdlib-js/datasets-cmudict/tree/deno
+[umd-url]: https://github.com/stdlib-js/datasets-cmudict/tree/umd
+[esm-url]: https://github.com/stdlib-js/datasets-cmudict/tree/esm
+[branches-url]: https://github.com/stdlib-js/datasets-cmudict/blob/main/branches.md
+
 [cmudict]: http://www.speech.cs.cmu.edu/cgi-bin/cmudict#about
 
 [arpabet]: https://en.wikipedia.org/wiki/ARPABET

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+/// <reference path="../docs/types/index.d.ts" />
+import cmudict from '../docs/types/index';
+export = cmudict;

package/dist/index.js

@@ -0,0 +1,7 @@
+"use strict";var v=function(a,r){return function(){return r||a((r={exports:{}}).exports,r),r.exports}};var m=v(function(k,l){
+var g=require('@stdlib/assert-has-own-property/dist'),q=require('@stdlib/assert-is-plain-object/dist'),w=require('@stdlib/assert-is-string/dist').isPrimitive,f=require('@stdlib/error-tools-fmtprodmsg/dist');function b(a,r){return q(r)?g(r,"data")&&(a.data=r.data,!w(a.data))?new TypeError(f('0M32W',"data",a.data)):null:new TypeError(f('0M32V',r));}l.exports=b
+});var h=v(function(S,c){
+var n=require("path").resolve,y=require('@stdlib/error-tools-fmtprodmsg/dist'),p=require('@stdlib/fs-read-json/dist').sync,_=require('@stdlib/assert-has-own-property/dist'),j=m(),d=["dict","phones","symbols","vp"],u={dict:n(__dirname,"..","data","dict.json"),phones:n(__dirname,"..","data","phones.json"),symbols:n(__dirname,"..","data","symbols.json"),vp:n(__dirname,"..","data","vp.json")},O={encoding:"utf8"};function E(a){var r,o,s,e,t,i;if(arguments.length>0){if(r={},o=j(r,a),o)throw o;if(r.data){if(!_(u,r.data))throw new RangeError(y('0M34S',"data",d.join('", "'),r.data));if(e=p(u[r.data],O),e instanceof Error)throw e;return e}}for(e={},i=0;i<d.length;i++){if(s=d[i],t=p(u[s]),t instanceof Error)throw t;e[s]=t}return e}c.exports=E
+});var x=h();module.exports=x;
+/** @license Apache-2.0 */
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../lib/validate.js", "../lib/main.js", "../lib/index.js"],
+  "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar isString = require( '@stdlib/assert-is-string' ).isPrimitive;\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.data] - dataset name\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n*     'data': 'phones'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n*     throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'data' ) ) {\n\t\topts.data = options.data;\n\t\tif ( !isString( opts.data ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a string. Option: `%s`.', 'data', opts.data ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar resolve = require( 'path' ).resolve;\nvar format = require( '@stdlib/string-format' );\nvar readJSON = require( '@stdlib/fs-read-json' ).sync;\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar validate = require( './validate.js' );\n\n\n// VARIABLES //\n\nvar keys = [ 'dict', 'phones', 'symbols', 'vp' ];\nvar dataCMU = {\n\t'dict': resolve( __dirname, '..', 'data', 'dict.json' ),\n\t'phones': resolve( __dirname, '..', 'data', 'phones.json' ),\n\t'symbols': resolve( __dirname, '..', 'data', 'symbols.json' ),\n\t'vp': resolve( __dirname, '..', 'data', 'vp.json' )\n};\nvar fopts = {\n\t'encoding': 'utf8'\n};\n\n\n// MAIN //\n\n/**\n* Returns datasets from the Carnegie Mellon Pronouncing Dictionary (CMUdict).\n*\n* ## Notes\n*\n* -   This function synchronously reads data from disk for each invocation. Such behavior is intentional and so is the avoidance of `require`. We assume that invocations are infrequent, and we want to avoid the `require` cache. This means that we allow data to be garbage collected and a user is responsible for explicitly caching data.\n*\n* @param {Options} [options] - options object\n* @param {string} [options.data] - dataset name\n* @throws {Error} unable to read data\n* @throws {TypeError} must provide an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a recognized dataset name\n* @returns {(Object|StringArray)} dataset(s)\n*\n* @example\n* var data = cmudict();\n* // returns <Object>\n*\n* @example\n* var data = cmudict({\n*\t'data': 'symbols'\n* });\n* // returns <Array>\n*/\nfunction cmudict( options ) {\n\tvar opts;\n\tvar err;\n\tvar key;\n\tvar out;\n\tvar val;\n\tvar i;\n\n\tif ( arguments.length > 0 ) {\n\t\topts = {};\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( opts.data ) {\n\t\t\tif ( !hasOwnProp( dataCMU, opts.data ) ) {\n\t\t\t\tthrow new RangeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'data', keys.join( '\", \"' ), opts.data ) );\n\t\t\t}\n\t\t\tout = readJSON( dataCMU[ opts.data ], fopts );\n\t\t\tif ( out instanceof Error ) {\n\t\t\t\tthrow out;\n\t\t\t}\n\t\t\treturn out;\n\t\t}\n\t}\n\tout = {};\n\tfor ( i = 0; i < keys.length; i++ ) {\n\t\tkey = keys[ i ];\n\t\tval = readJSON( dataCMU[ key ] );\n\t\tif ( val instanceof Error ) {\n\t\t\tthrow val;\n\t\t}\n\t\tout[ key ] = val;\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = cmudict;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* The Carnegie Mellon Pronouncing Dictionary (CMUdict).\n*\n* @module @stdlib/datasets-cmudict\n*\n* @example\n* var dict = require( '@stdlib/datasets-cmudict' );\n*\n* var data = dict();\n* // returns {...}\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
+  "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAa,QAAS,iCAAkC,EACxDC,EAAW,QAAS,gCAAiC,EACrDC,EAAW,QAAS,0BAA2B,EAAE,YACjDC,EAAS,QAAS,uBAAwB,EAwB9C,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAML,EAAUK,CAAQ,EAGnBN,EAAYM,EAAS,MAAO,IAChCD,EAAK,KAAOC,EAAQ,KACf,CAACJ,EAAUG,EAAK,IAAK,GAClB,IAAI,UAAWF,EAAQ,8DAA+D,OAAQE,EAAK,IAAK,CAAE,EAG5G,KARC,IAAI,UAAWF,EAAQ,qEAAsEG,CAAQ,CAAE,CAShH,CAKAP,EAAO,QAAUK,ICjEjB,IAAAG,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,QAAS,MAAO,EAAE,QAC5BC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,QAAS,sBAAuB,EAAE,KAC7CC,EAAa,QAAS,iCAAkC,EACxDC,EAAW,IAKXC,EAAO,CAAE,OAAQ,SAAU,UAAW,IAAK,EAC3CC,EAAU,CACb,KAAQN,EAAS,UAAW,KAAM,OAAQ,WAAY,EACtD,OAAUA,EAAS,UAAW,KAAM,OAAQ,aAAc,EAC1D,QAAWA,EAAS,UAAW,KAAM,OAAQ,cAAe,EAC5D,GAAMA,EAAS,UAAW,KAAM,OAAQ,SAAU,CACnD,EACIO,EAAQ,CACX,SAAY,MACb,EA8BA,SAASC,EAASC,EAAU,CAC3B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACA,EAEJ,GAAK,UAAU,OAAS,EAAI,CAG3B,GAFAJ,EAAO,CAAC,EACRC,EAAMP,EAAUM,EAAMD,CAAQ,EACzBE,EACJ,MAAMA,EAEP,GAAKD,EAAK,KAAO,CAChB,GAAK,CAACP,EAAYG,EAASI,EAAK,IAAK,EACpC,MAAM,IAAI,WAAYT,EAAQ,gFAAiF,OAAQI,EAAK,KAAM,MAAO,EAAGK,EAAK,IAAK,CAAE,EAGzJ,GADAG,EAAMX,EAAUI,EAASI,EAAK,IAAK,EAAGH,CAAM,EACvCM,aAAe,MACnB,MAAMA,EAEP,OAAOA,CACR,CACD,CAEA,IADAA,EAAM,CAAC,EACD,EAAI,EAAG,EAAIR,EAAK,OAAQ,IAAM,CAGnC,GAFAO,EAAMP,EAAM,CAAE,EACdS,EAAMZ,EAAUI,EAASM,CAAI,CAAE,EAC1BE,aAAe,MACnB,MAAMA,EAEPD,EAAKD,CAAI,EAAIE,CACd,CACA,OAAOD,CACR,CAKAd,EAAO,QAAUS,IC5EjB,IAAIO,EAAO,IAKX,OAAO,QAAUA",
+  "names": ["require_validate", "__commonJSMin", "exports", "module", "hasOwnProp", "isObject", "isString", "format", "validate", "opts", "options", "require_main", "__commonJSMin", "exports", "module", "resolve", "format", "readJSON", "hasOwnProp", "validate", "keys", "dataCMU", "fopts", "cmudict", "options", "opts", "err", "key", "out", "val", "main"]
+}

package/docs/types/index.d.ts

@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Interface defining function options.

package/lib/browser.js

@@ -23,6 +23,7 @@
 var objectKeys = require( '@stdlib/utils-keys' );
 var copy = require( '@stdlib/utils-copy' );
 var hasOwnProp = require( '@stdlib/assert-has-own-property' );
+var format = require( '@stdlib/string-format' );
 var validate = require( './validate.js' );
 var dataCMU = require( './data.js' );
 
@@ -61,7 +62,7 @@ function cmudict( options ) {
 		}
 		if ( opts.data ) {
 			if ( !hasOwnProp( dataCMU, opts.data ) ) {
-				throw new RangeError( 'invalid option. `data` option must be one of the following values: `'+objectKeys( dataCMU ).join(',')+'`. Option: `'+opts.data+'`.' );
+				throw new RangeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'data', objectKeys( dataCMU ).join( '", "' ), opts.data ) );
 			}
 			return copy( dataCMU[ opts.data ] );
 		}

package/lib/data.js

@@ -18,11 +18,21 @@
 
 'use strict';
 
+// MODULES //
+
+var dict = require( './../data/dict.json' );
+var phones = require( './../data/phones.json' );
+var symbols = require( './../data/symbols.json' );
+var vp = require( './../data/vp.json' );
+
+
+// MAIN //
+
 var data = {};
-data.dict = require( './../data/dict.json' );
-data.phones = require( './../data/phones.json' );
-data.symbols = require( './../data/symbols.json' );
-data.vp = require( './../data/vp.json' );
+data.dict = dict;
+data.phones = phones;
+data.symbols = symbols;
+data.vp = vp;
 
 
 // EXPORTS //

package/lib/index.js

@@ -32,9 +32,9 @@
 
 // MODULES //
 
-var dict = require( './main.js' );
+var main = require( './main.js' );
 
 
 // EXPORTS //
 
-module.exports = dict;
+module.exports = main;

package/lib/main.js

@@ -21,6 +21,7 @@
 // MODULES //
 
 var resolve = require( 'path' ).resolve;
+var format = require( '@stdlib/string-format' );
 var readJSON = require( '@stdlib/fs-read-json' ).sync;
 var hasOwnProp = require( '@stdlib/assert-has-own-property' );
 var validate = require( './validate.js' );
@@ -49,7 +50,6 @@ var fopts = {
 *
 * -   This function synchronously reads data from disk for each invocation. Such behavior is intentional and so is the avoidance of `require`. We assume that invocations are infrequent, and we want to avoid the `require` cache. This means that we allow data to be garbage collected and a user is responsible for explicitly caching data.
 *
-*
 * @param {Options} [options] - options object
 * @param {string} [options.data] - dataset name
 * @throws {Error} unable to read data
@@ -84,7 +84,7 @@ function cmudict( options ) {
 		}
 		if ( opts.data ) {
 			if ( !hasOwnProp( dataCMU, opts.data ) ) {
-				throw new RangeError( 'invalid option. `data` option must be one of the following values: `'+keys.join(',')+'`. Option: `'+opts.data+'`.' );
+				throw new RangeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'data', keys.join( '", "' ), opts.data ) );
 			}
 			out = readJSON( dataCMU[ opts.data ], fopts );
 			if ( out instanceof Error ) {

package/lib/validate.js

@@ -23,6 +23,7 @@
 var hasOwnProp = require( '@stdlib/assert-has-own-property' );
 var isObject = require( '@stdlib/assert-is-plain-object' );
 var isString = require( '@stdlib/assert-is-string' ).isPrimitive;
+var format = require( '@stdlib/string-format' );
 
 
 // MAIN //
@@ -48,12 +49,12 @@ var isString = require( '@stdlib/assert-is-string' ).isPrimitive;
 */
 function validate( opts, options ) {
 	if ( !isObject( options ) ) {
-		return new TypeError( 'invalid argument. Options must be an object. Value: `' + options + '`.' );
+		return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
 	}
 	if ( hasOwnProp( options, 'data' ) ) {
 		opts.data = options.data;
 		if ( !isString( opts.data ) ) {
-			return new TypeError( 'invalid option. `data` option must be a string primitive. Option: `' + opts.data + '`.' );
+			return new TypeError( format( 'invalid option. `%s` option must be a string. Option: `%s`.', 'data', opts.data ) );
 		}
 	}
 	return null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/datasets-cmudict",
-  "version": "0.0.7",
+  "version": "0.1.0",
   "description": "The Carnegie Mellon Pronouncing Dictionary (CMUdict).",
   "license": "Apache-2.0 and BSD",
   "author": {
@@ -13,9 +13,6 @@
       "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
     }
   ],
-  "bin": {
-    "cmudict": "./bin/cli"
-  },
   "main": "./lib",
   "browser": "./lib/browser.js",
   "directories": {
@@ -43,29 +40,19 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/assert-has-own-property": "^0.0.x",
-    "@stdlib/assert-is-plain-object": "^0.0.x",
-    "@stdlib/assert-is-string": "^0.0.x",
-    "@stdlib/cli-ctor": "^0.0.x",
-    "@stdlib/fs-read-file": "^0.0.x",
-    "@stdlib/fs-read-json": "^0.0.x",
-    "@stdlib/streams-node-stdout": "^0.0.x",
-    "@stdlib/utils-copy": "^0.0.x",
-    "@stdlib/utils-index-of": "^0.0.x",
-    "@stdlib/utils-keys": "^0.0.x"
+    "@stdlib/assert-has-own-property": "^0.1.0",
+    "@stdlib/assert-is-plain-object": "^0.1.0",
+    "@stdlib/assert-is-string": "^0.1.0",
+    "@stdlib/fs-read-json": "^0.1.0",
+    "@stdlib/string-format": "^0.1.0",
+    "@stdlib/utils-copy": "^0.1.0",
+    "@stdlib/utils-keys": "^0.1.0"
   },
   "devDependencies": {
-    "@stdlib/assert-is-array": "^0.0.x",
-    "@stdlib/assert-is-browser": "^0.0.x",
-    "@stdlib/assert-is-string-array": "^0.0.x",
-    "@stdlib/assert-is-windows": "^0.0.x",
-    "@stdlib/bench": "^0.0.x",
-    "@stdlib/process-exec-path": "^0.0.x",
-    "@stdlib/regexp-eol": "^0.0.x",
     "proxyquire": "^2.0.0",
     "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
     "istanbul": "^0.4.1",
-    "tap-spec": "5.x.x"
+    "tap-min": "git+https://github.com/Planeshifter/tap-min.git"
   },
   "engines": {
     "node": ">=0.10.0",
@@ -98,7 +85,7 @@
     "en"
   ],
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/bin/cli

@@ -1,113 +0,0 @@
-#!/usr/bin/env node
-
-/**
-* @license Apache-2.0
-*
-* Copyright (c) 2018 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 createReadStream = require( 'fs' ).createReadStream;
-var resolve = require( 'path' ).resolve;
-var getKeys = require( '@stdlib/utils-keys' );
-var indexOf = require( '@stdlib/utils-index-of' );
-var readFileSync = require( '@stdlib/fs-read-file' ).sync;
-var stdout = require( '@stdlib/streams-node-stdout' );
-var CLI = require( '@stdlib/cli-ctor' );
-var cmudict = require( './../lib' );
-
-
-// MAIN //
-
-/**
-* Main execution sequence.
-*
-* @private
-*/
-function main() {
-	var names;
-	var flags;
-	var opts;
-	var cli;
-
-	// Create a command-line interface:
-	cli = new CLI({
-		'pkg': require( './../package.json' ),
-		'options': require( './../etc/cli_opts.json' ),
-		'help': readFileSync( resolve( __dirname, '..', 'docs', 'usage.txt' ), {
-			'encoding': 'utf8'
-		})
-	});
-
-	// Get any provided command-line options:
-	flags = cli.flags();
-	if ( flags.help || flags.version ) {
-		return;
-	}
-
-	opts = {};
-	if ( flags.data ) {
-		opts.data = flags.data;
-	}
-	names = [ 'dict', 'phones', 'symbols', 'vp' ];
-	if ( indexOf( names, opts.data ) === -1 ) {
-		ndjson();
-	} else {
-		txt( opts.data );
-	}
-
-	/**
-	* Prints data as newline-delimited JSON (ndjson).
-	*
-	* @private
-	*/
-	function ndjson() {
-		var data;
-		var keys;
-		var i;
-		data = cmudict( opts );
-		keys = getKeys( data );
-		for ( i = 0; i < keys.length; i++ ) {
-			console.log( JSON.stringify( data[ keys[i] ] ) ); // eslint-disable-line no-console
-		}
-	}
-
-	/**
-	* Prints data to `stdout`.
-	*
-	* @private
-	* @param {string} filename - file name (no extension)
-	*/
-	function txt( filename ) {
-		var fpath = resolve( __dirname, '../data/'+filename+'.txt' );
-		createReadStream( fpath )
-			.pipe( stdout )
-			.on( 'close', onClose );
-	}
-
-	/**
-	* Exits the CLI.
-	*
-	* @private
-	*/
-	function onClose() {
-		cli.close( 0 );
-	}
-}
-
-main();

package/docs/repl.txt

@@ -1,39 +0,0 @@
-
-{{alias}}( [options] )
-    Returns datasets from the Carnegie Mellon Pronouncing Dictionary (CMUdict).
-
-    Data includes the following:
-
-    - dict: the main pronouncing dictionary
-    - phones: manners of articulation for each sound
-    - symbols: complete list of ARPABET symbols used by the dictionary
-    - vp: verbal pronunciations of punctuation marks
-
-    Parameters
-    ----------
-    options: Object (optional)
-        Function options.
-
-    options.data: string (optional)
-        Dataset name.
-
-    Returns
-    -------
-    out: Object|Array
-        CMUdict dataset.
-
-    Examples
-    --------
-    > var data = {{alias}}();
-    > var dict = data.dict
-    {...}
-    > var phones = data.phones
-    {...}
-    > var symbols = data.symbols
-    [...]
-    > var vp = data.vp
-    {...}
-
-    See Also
-    --------
-

package/docs/types/test.ts

@@ -1,49 +0,0 @@
-/*
-* @license Apache-2.0
-*
-* Copyright (c) 2020 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.
-*/
-
-import cmudict = require( './index' );
-
-
-// TESTS //
-
-// The function returns an object or array of strings...
-{
-	cmudict(); // $ExpectType Object | String[]
-}
-
-// The compiler throws an error if the function is provided a first argument which is not an object...
-{
-	cmudict( 'abc' ); // $ExpectError
-	cmudict( false ); // $ExpectError
-	cmudict( true ); // $ExpectError
-	cmudict( null ); // $ExpectError
-	cmudict( 123 ); // $ExpectError
-	cmudict( [] ); // $ExpectError
-	cmudict( ( x: number ): number => x ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a `data` option which is not a recognized dataset name...
-{
-	cmudict( { 'data': 'abc' } ); // $ExpectError
-	cmudict( { 'data': 123 } ); // $ExpectError
-	cmudict( { 'data': true } ); // $ExpectError
-	cmudict( { 'data': false } ); // $ExpectError
-	cmudict( { 'data': [] } ); // $ExpectError
-	cmudict( { 'data': {} } ); // $ExpectError
-	cmudict( { 'data': ( x: number ): number => x } ); // $ExpectError
-}

package/docs/usage.txt

@@ -1,8 +0,0 @@
-
-Usage: cmudict [options]
-
-Options:
-
-  -h,    --help                Print this message.
-  -V,    --version             Print the package version.
-         --data name           Dataset name: dict, phones, symbols, vp.

package/etc/cli_opts.json

@@ -1,17 +0,0 @@
-{
-	"string": [
-		"data"
-	],
-	"boolean": [
-		"help",
-		"version"
-	],
-	"alias": {
-		"help": [
-			"h"
-		],
-		"version": [
-			"V"
-		]
-	}
-}