Release v0.1.0

stdlib-js · Sep 24, 2023 · 8386167 · 8386167
1 parent 06ed6b6
commit 8386167
Show file tree

Hide file tree

Showing 19 changed files with 102 additions and 54 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -179,3 +179,8 @@ indent_size = 2
 [*.gypi]
 indent_style = space
 indent_size = 2
+
+# Set properties for citation files:
+[*.{cff,cff.txt}]
+indent_style = space
+indent_size = 2
diff --git a/.github/.keepalive b/.github/.keepalive
diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml
@@ -82,21 +82,6 @@ jobs:
         id: transform-error-messages
         uses: stdlib-js/transform-errors-action@main
 
-      # Format error messages:
-      - name: 'Replace double quotes with single quotes in rewritten format string error messages'
-        run: |
-          find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \;
-
-      # Format string literal error messages:
-      - name: 'Replace double quotes with single quotes in rewritten string literal error messages'
-        run: |
-          find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \;
-
-      # Format code:
-      - name: 'Replace double quotes with single quotes in inserted `require` calls'
-        run: |
-          find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \;
-
       # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency:
       - name: 'Update dependencies in package.json'
         run: |
@@ -349,7 +334,7 @@ jobs:
 
       # Send status to Slack channel if job fails:
       - name: 'Send status to Slack channel in case of failure'
-        uses: act10ns/slack@v1
+        uses: act10ns/slack@v2
         with:
           status: ${{ job.status }}
           steps: ${{ toJson(steps) }}
@@ -520,7 +505,7 @@ jobs:
 
       # Send status to Slack channel if job fails:
       - name: 'Send status to Slack channel in case of failure'
-        uses: act10ns/slack@v1
+        uses: act10ns/slack@v2
         with:
           status: ${{ job.status }}
           steps: ${{ toJson(steps) }}
@@ -697,7 +682,7 @@ jobs:
 
       # Send status to Slack channel if job fails:
       - name: 'Send status to Slack channel in case of failure'
-        uses: act10ns/slack@v1
+        uses: act10ns/slack@v2
         with:
           status: ${{ job.status }}
           steps: ${{ toJson(steps) }}

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -209,7 +209,7 @@ jobs:
 
       # Send status to Slack channel if job fails:
       - name: 'Send status to Slack channel in case of failure'
-        uses: act10ns/slack@v1
+        uses: act10ns/slack@v2
         with:
           status: ${{ job.status }}
           steps: ${{ toJson(steps) }}

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -89,7 +89,7 @@ jobs:
 
       # Send status to Slack channel if job fails:
       - name: 'Send status to Slack channel in case of failure'
-        uses: act10ns/slack@v1
+        uses: act10ns/slack@v2
         with:
           status: ${{ job.status }}
           steps: ${{ toJson(steps) }}

diff --git a/.github/workflows/test_bundles.yml b/.github/workflows/test_bundles.yml
@@ -88,7 +88,7 @@ jobs:
 
       # Send notification to Slack channel if job fails:
       - name: 'Send status to Slack channel in case of failure'
-        uses: act10ns/slack@v1
+        uses: act10ns/slack@v2
         with:
           status: ${{ job.status }}
           steps: ${{ toJson(steps) }}
@@ -130,7 +130,7 @@ jobs:
 
       # Send notification to Slack channel if job fails:
       - name: 'Send status to Slack channel in case of failure'
-        uses: act10ns/slack@v1
+        uses: act10ns/slack@v2
         with:
           status: ${{ job.status }}
           steps: ${{ toJson(steps) }}
@@ -172,7 +172,7 @@ jobs:
 
       # Send notification to Slack channel if job fails:
       - name: 'Send status to Slack channel in case of failure'
-        uses: act10ns/slack@v1
+        uses: act10ns/slack@v2
         with:
           status: ${{ job.status }}
           steps: ${{ toJson(steps) }}

diff --git a/.github/workflows/test_coverage.yml b/.github/workflows/test_coverage.yml
@@ -106,7 +106,7 @@ jobs:
 
       # Send Slack notification if job fails:
       - name: 'Send status to Slack channel in case of failure'
-        uses: act10ns/slack@v1
+        uses: act10ns/slack@v2
         with:
           status: ${{ job.status }}
           steps: ${{ toJson(steps) }}

diff --git a/.github/workflows/test_install.yml b/.github/workflows/test_install.yml
@@ -75,7 +75,7 @@ jobs:
 
       # Send Slack notification if job fails:
       - name: 'Send notification to Slack in case of failure'
-        uses: act10ns/slack@v1
+        uses: act10ns/slack@v2
         with:
           status: ${{ job.status }}
           steps: ${{ toJson(steps) }}

diff --git a/CITATION.cff b/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
diff --git a/CONTRIBUTORS b/CONTRIBUTORS
@@ -3,36 +3,37 @@
 # Contributors listed in alphabetical order.
 
 Ali Salesi <[email protected]>
+Amit Jimiwal <[email protected]>
 Athan Reines <[email protected]>
 Brendan Graetz <[email protected]>
 Bruno Fenzl <[email protected]>
 Christopher Dambamuromo <[email protected]>
+Dan Rose <[email protected]>
 Dominik Moritz <[email protected]>
+Dorrin Sotoudeh <[email protected]>
 Frank Kovacs <[email protected]>
-Harshita Kalani <[email protected].com>
-James <[email protected]>
+Harshita Kalani <harshitakalani02@gmail.com>
+James Gelok <[email protected]>
 Jithin KS <[email protected]>
 Joey Reed <[email protected]>
-Jordan-Gallivan <[email protected]>
+Jordan Gallivan <[email protected]>
 Joris Labie <[email protected]>
 Justin Dennison <[email protected]>
-KATTA NAGA NITHIN <[email protected]>
-Marcus <[email protected]>
+Marcus Fantham <[email protected]>
 Matt Cochrane <[email protected]>
 Milan Raj <[email protected]>
 Momtchil Momtchev <[email protected]>
-Naresh Jagadeesan <[email protected]>
+Naresh Jagadeesan <[email protected]>
+Nithin Katta <[email protected]>
 Ognjen Jevremović <[email protected]>
 Philipp Burckhardt <[email protected]>
-Pranav <[email protected]>
+Pranav Goswami <[email protected]>
 Ricky Reusser <[email protected]>
 Roman Stetsyk <[email protected]>
 Ryan Seal <[email protected]>
 Seyyed Parsa Neshaei <[email protected]>
 Shraddheya Shendre <[email protected]>
 Stephannie Jiménez Gacha <[email protected]>
 Yernar Yergaziyev <[email protected]>
-dorrin-sot <[email protected]>
-drunken_devv <[email protected]>
 orimiles5 <[email protected]>
-rei2hu <[email protected]>
+rei2hu <[email protected]>
diff --git a/README.md b/README.md
@@ -18,6 +18,17 @@ 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>
+
 # Probability Density Function
 
 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
@@ -210,8 +221,8 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-rayleigh-pdf.svg
 [npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-rayleigh-pdf
 
-[test-image]: https://github.com/stdlib-js/stats-base-dists-rayleigh-pdf/actions/workflows/test.yml/badge.svg?branch=main
-[test-url]: https://github.com/stdlib-js/stats-base-dists-rayleigh-pdf/actions/workflows/test.yml?query=branch:main
+[test-image]: https://github.com/stdlib-js/stats-base-dists-rayleigh-pdf/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/stats-base-dists-rayleigh-pdf/actions/workflows/test.yml?query=branch:v0.1.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-rayleigh-pdf/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-rayleigh-pdf?branch=main

diff --git a/dist/index.d.ts b/dist/index.d.ts
@@ -0,0 +1,3 @@
+/// <reference path="../docs/types/index.d.ts" />
+import pdf from '../docs/types/index';
+export = pdf;
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/docs/types/index.d.ts b/docs/types/index.d.ts
@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Evaluates the probability density function (PDF) for a Rayleigh distribution.

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/stats-base-dists-rayleigh-pdf",
-  "version": "0.0.7",
+  "version": "0.1.0",
   "description": "Rayleigh distribution probability density function (PDF).",
   "license": "Apache-2.0",
   "author": {
@@ -37,19 +37,19 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/constants-float64-pinf": "^0.0.8",
-    "@stdlib/math-base-assert-is-nan": "^0.0.8",
-    "@stdlib/math-base-special-exp": "^0.0.6",
-    "@stdlib/math-base-special-pow": "^0.0.7",
-    "@stdlib/stats-base-dists-degenerate-pdf": "^0.0.8",
-    "@stdlib/utils-constant-function": "^0.0.8",
-    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7"
+    "@stdlib/constants-float64-pinf": "^0.1.0",
+    "@stdlib/math-base-assert-is-nan": "^0.1.0",
+    "@stdlib/math-base-special-exp": "^0.1.0",
+    "@stdlib/math-base-special-pow": "^0.1.0",
+    "@stdlib/stats-base-dists-degenerate-pdf": "^0.1.0",
+    "@stdlib/utils-constant-function": "^0.1.0",
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0"
   },
   "devDependencies": {
-    "@stdlib/bench": "^0.0.12",
-    "@stdlib/constants-float64-eps": "^0.0.8",
-    "@stdlib/constants-float64-ninf": "^0.0.8",
-    "@stdlib/math-base-special-abs": "^0.0.6",
+    "@stdlib/bench": "^0.1.0",
+    "@stdlib/constants-float64-eps": "^0.1.0",
+    "@stdlib/constants-float64-ninf": "^0.1.0",
+    "@stdlib/math-base-special-abs": "^0.1.0",
     "@stdlib/random-base-randu": "^0.0.8",
     "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
     "istanbul": "^0.4.1",

diff --git a/test/test.factory.js b/test/test.factory.js
@@ -40,7 +40,7 @@ var largeScale = require( './fixtures/julia/large_scale.json' );
 
 tape( 'main export is a function', function test( t ) {
 	t.ok( true, __filename );
-	t.equal( typeof factory, 'function', 'main export is a function' );
+	t.strictEqual( typeof factory, 'function', 'main export is a function' );
 	t.end();
 });
 

diff --git a/test/test.js b/test/test.js
@@ -28,7 +28,7 @@ var pdf = require( './../lib' );
 
 tape( 'main export is a function', function test( t ) {
 	t.ok( true, __filename );
-	t.equal( typeof pdf, 'function', 'main export is a function' );
+	t.strictEqual( typeof pdf, 'function', 'main export is a function' );
 	t.end();
 });