diff --git a/.clang-format b/.clang-format
index a79f189fde97..a92906763f98 100644
--- a/.clang-format
+++ b/.clang-format
@@ -856,11 +856,11 @@ IncludeCategories:
Priority: 3
# Built-in headers (e.g., `<stdint.h>`) should always come at the end...
- - Regex: '<[[:alnum:].]+>'
+ - Regex: "<[[:alnum:].]+>"
Priority: 4
# All other headers (e.g., those resolved using relative paths) should come first...
- - Regex: '.*'
+ - Regex: ".*"
Priority: 1
#/
diff --git a/.codecov.yml b/.codecov.yml
index 4e6d1c77d976..7942594a3450 100644
--- a/.codecov.yml
+++ b/.codecov.yml
@@ -28,7 +28,6 @@ codecov:
# Default branch to show (if not set, inherited from repository settings):
branch: develop
-
coverage:
# Number of decimals to display in UI:
precision: 4
@@ -93,7 +92,6 @@ coverage:
# If CI fails, report an "error" commit status:
if_ci_failed: error
-
# Comment settings:
comment:
layout: "header, diff, changes, sunburst, uncovered, tree"
diff --git a/.commitlintrc.js b/.commitlintrc.js
index 91609f5ad685..aceeca3bba72 100644
--- a/.commitlintrc.js
+++ b/.commitlintrc.js
@@ -1,27 +1,26 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// MODULES //
-var config = require( './etc/commitlint/.commitlintrc.js' ); // eslint-disable-line node/no-unpublished-require
-
+var config = require("./etc/commitlint/.commitlintrc.js"); // eslint-disable-line node/no-unpublished-require
// EXPORTS //
diff --git a/.devcontainer/README.md b/.devcontainer/README.md
index 1c329ea899c0..cbe66d099c5d 100644
--- a/.devcontainer/README.md
+++ b/.devcontainer/README.md
@@ -57,13 +57,9 @@ This folder includes configuration for developing the project in a local contain
<section class="links">
[dev-container-image]: https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode
-
[dev-container-url]: https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/stdlib-js/stdlib
-
[github-codespaces]: https://github.com/features/codespaces
-
[github-codespaces-image]: https://github.com/codespaces/badge.svg
-
[github-codespaces-url]: https://codespaces.new/stdlib-js/stdlib
</section>
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
index 9ab8cc667fff..0a4bc8a5c757 100644
--- a/.devcontainer/devcontainer.json
+++ b/.devcontainer/devcontainer.json
@@ -10,9 +10,7 @@
"postCreateCommand": "./.devcontainer/post-create",
"customizations": {
"codespaces": {
- "openFiles": [
- "README.md"
- ]
+ "openFiles": ["README.md"]
},
"vscode": {
"settings": {
diff --git a/.eslintrc.js b/.eslintrc.js
index 0bfa6a817256..5dd4dae502b5 100644
--- a/.eslintrc.js
+++ b/.eslintrc.js
@@ -1,27 +1,26 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// MODULES //
-var eslint = require( './etc/eslint/.eslintrc.overrides.js' );
-
+var eslint = require("./etc/eslint/.eslintrc.overrides.js");
// EXPORTS //
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
index 4ba43d0f0492..4f6debbe6d55 100644
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -26,4 +26,3 @@ contact_links:
- name: 👏 Support Us
url: https://github.com/stdlib-js/stdlib/blob/develop/docs/support_the_project.md
about: Want to help support the project? 😍
-
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 855e454e3ebf..5495f235f59d 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -6,7 +6,7 @@ Resolves #{{TODO: add issue number}}.
This pull request:
-- {{TODO: add description describing what this pull request does}}
+- {{TODO: add description describing what this pull request does}}
## Related Issues
@@ -14,7 +14,7 @@ This pull request:
This pull request:
-- resolves #{{TODO: add issue number}}
+- resolves #{{TODO: add issue number}}
## Questions
@@ -32,9 +32,9 @@ No.
> Please ensure the following tasks are completed before submitting this pull request.
-- [ ] Read, understood, and followed the [contributing guidelines][contributing].
+- [ ] Read, understood, and followed the [contributing guidelines][contributing].
-* * *
+---
@stdlib-js/reviewers
diff --git a/.github/codeql/codeql_config.yml b/.github/codeql/codeql_config.yml
index a2c52c0c093e..6a3067e86a4e 100644
--- a/.github/codeql/codeql_config.yml
+++ b/.github/codeql/codeql_config.yml
@@ -20,18 +20,18 @@ name: codeql_configuration
# Define paths for which code scanning should be performed:
paths:
- - 'lib'
+ - "lib"
# Define paths for which code scanning should *not* be performed:
paths-ignore:
- - '**/_tools'
- - '**/test/*.js'
- - '**/test/**/*.js'
- - '**/benchmark/*.js'
- - '**/benchmark/**/*.js'
- - '**/examples/*.js'
- - '**/examples/**/*.js'
- - '**/data'
- - '**/scripts'
- - '**/etc'
- - '**/docs'
+ - "**/_tools"
+ - "**/test/*.js"
+ - "**/test/**/*.js"
+ - "**/benchmark/*.js"
+ - "**/benchmark/**/*.js"
+ - "**/examples/*.js"
+ - "**/examples/**/*.js"
+ - "**/data"
+ - "**/scripts"
+ - "**/etc"
+ - "**/docs"
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
index 9077f78ef69c..e00db1c18e18 100644
--- a/.github/dependabot.yml
+++ b/.github/dependabot.yml
@@ -18,32 +18,32 @@
version: 2
updates:
-- package-ecosystem: github-actions
- directory: "/"
- schedule:
- interval: monthly
- ignore:
- - dependency-name: "distributhor/workflow-webhook"
+ - package-ecosystem: github-actions
+ directory: "/"
+ schedule:
+ interval: monthly
+ ignore:
+ - dependency-name: "distributhor/workflow-webhook"
-- package-ecosystem: npm
- directory: "/"
- schedule:
- interval: monthly
- open-pull-requests-limit: 10
- allow:
- - dependency-name: "*"
- dependency-type: "production"
- ignore:
- - dependency-name: "remark*"
- - dependency-name: "chai"
- - dependency-name: "debug"
- - dependency-name: "ajv"
- - dependency-name: "d3-scale"
- - dependency-name: "d3-shape"
- - dependency-name: "d3-time-format"
- - dependency-name: "d3-format"
- - dependency-name: "readable-stream"
- - dependency-name: "mkdirp"
- - dependency-name: "semver"
- - dependency-name: "glob"
- - dependency-name: "node-gyp"
+ - package-ecosystem: npm
+ directory: "/"
+ schedule:
+ interval: monthly
+ open-pull-requests-limit: 10
+ allow:
+ - dependency-name: "*"
+ dependency-type: "production"
+ ignore:
+ - dependency-name: "remark*"
+ - dependency-name: "chai"
+ - dependency-name: "debug"
+ - dependency-name: "ajv"
+ - dependency-name: "d3-scale"
+ - dependency-name: "d3-shape"
+ - dependency-name: "d3-time-format"
+ - dependency-name: "d3-format"
+ - dependency-name: "readable-stream"
+ - dependency-name: "mkdirp"
+ - dependency-name: "semver"
+ - dependency-name: "glob"
+ - dependency-name: "node-gyp"
diff --git a/.github/labeler.yml b/.github/labeler.yml
index 2994baf6234e..68c9a60e2f5a 100644
--- a/.github/labeler.yml
+++ b/.github/labeler.yml
@@ -17,25 +17,25 @@
#/
BLAS:
-- changed-files:
- - any-glob-to-all-files: '**/blas/**/*'
+ - changed-files:
+ - any-glob-to-all-files: "**/blas/**/*"
LAPACK:
-- changed-files:
- - any-glob-to-all-files: '**/lapack/**/*'
+ - changed-files:
+ - any-glob-to-all-files: "**/lapack/**/*"
Math:
-- changed-files:
- - any-glob-to-all-files: '**/math/**/*'
+ - changed-files:
+ - any-glob-to-all-files: "**/math/**/*"
REPL:
-- changed-files:
- - any-glob-to-all-files: '**/repl/**/*'
+ - changed-files:
+ - any-glob-to-all-files: "**/repl/**/*"
Statistics:
-- changed-files:
- - any-glob-to-all-files: '**/stats/**/*'
+ - changed-files:
+ - any-glob-to-all-files: "**/stats/**/*"
Tools:
-- changed-files:
- - any-glob-to-all-files: '**/_tools/**/*'
+ - changed-files:
+ - any-glob-to-all-files: "**/_tools/**/*"
diff --git a/.github/workflows/autoclose.yml b/.github/workflows/autoclose.yml
index 9ef595156cfe..d40930baf952 100644
--- a/.github/workflows/autoclose.yml
+++ b/.github/workflows/autoclose.yml
@@ -27,12 +27,10 @@ on:
# Workflow jobs:
jobs:
-
# Define a job which closes a pull request if a contributor failed to setup EditorConfig:
editorconfig:
-
# Define job name:
- name: 'Check for EditorConfig label'
+ name: "Check for EditorConfig label"
# Only run this job if the pull request has a specific label:
if: "${{ github.event.label.name == 'autoclose: EditorConfig' }}"
@@ -47,9 +45,8 @@ jobs:
# Define the sequence of job steps:
steps:
-
# Close the pull request:
- - name: 'Close pull request'
+ - name: "Close pull request"
run: gh pr close "$NUMBER" --comment "$BODY"
env:
GH_TOKEN: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
@@ -66,9 +63,8 @@ jobs:
# Define a job which closes a pull request if a contributor failed to follow contributing guidelines:
contributor_guidelines:
-
# Define job name:
- name: 'Check for contributor guidelines label'
+ name: "Check for contributor guidelines label"
# Only run this job if the pull request has a specific label:
if: "${{ github.event.label.name == 'autoclose: Contributor Guidelines' }}"
@@ -83,9 +79,8 @@ jobs:
# Define the sequence of job steps:
steps:
-
# Close the pull request:
- - name: 'Close pull request'
+ - name: "Close pull request"
run: gh pr close "$NUMBER" --comment "$BODY"
env:
GH_TOKEN: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
@@ -102,9 +97,8 @@ jobs:
# Define a job which closes a pull request if a contributor failed to follow project conventions:
project_conventions:
-
# Define job name:
- name: 'Check for project conventions label'
+ name: "Check for project conventions label"
# Only run this job if the pull request has a specific label:
if: "${{ github.event.label.name == 'autoclose: Project Conventions' }}"
@@ -119,9 +113,8 @@ jobs:
# Define the sequence of job steps:
steps:
-
# Close the pull request:
- - name: 'Close pull request'
+ - name: "Close pull request"
run: gh pr close "$NUMBER" --comment "$BODY"
env:
GH_TOKEN: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
@@ -142,9 +135,8 @@ jobs:
# Define a job which closes a pull request if a pull request is considered spam:
spam:
-
# Define job name:
- name: 'Check for spam label'
+ name: "Check for spam label"
# Only run this job if the pull request has a specific label:
if: "${{ github.event.label.name == 'autoclose: Spam' }}"
@@ -159,9 +151,8 @@ jobs:
# Define the sequence of job steps:
steps:
-
# Close the pull request:
- - name: 'Close pull request'
+ - name: "Close pull request"
run: gh pr close "$NUMBER" --comment "$BODY"
env:
GH_TOKEN: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
@@ -173,7 +164,7 @@ jobs:
Thank you again for your interest in stdlib, and we look forward to reviewing your future contributions.
# Lock pull request conversation:
- - name: 'Lock conversation'
+ - name: "Lock conversation"
run: gh pr lock "$NUMBER" --reason spam
env:
GH_TOKEN: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
@@ -182,9 +173,8 @@ jobs:
# Define a job which closes a pull request if a pull request is considered stale:
stale:
-
# Define job name:
- name: 'Check for stale label'
+ name: "Check for stale label"
# Only run this job if the pull request has a specific label:
if: "${{ github.event.label.name == 'autoclose: Stale' }}"
@@ -201,7 +191,7 @@ jobs:
# Define the sequence of job steps:
steps:
# Close the pull request:
- - name: 'Close pull request'
+ - name: "Close pull request"
run: gh pr close "$NUMBER" --comment "$BODY"
env:
GH_TOKEN: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
diff --git a/.github/workflows/check_contributing_guidelines_acceptance.yml b/.github/workflows/check_contributing_guidelines_acceptance.yml
index bced3463ec75..d31baad17804 100644
--- a/.github/workflows/check_contributing_guidelines_acceptance.yml
+++ b/.github/workflows/check_contributing_guidelines_acceptance.yml
@@ -26,7 +26,7 @@ on:
# Define the input parameters for the workflow:
inputs:
pull_request_number:
- description: 'Pull request number'
+ description: "Pull request number"
required: true
type: number
user:
@@ -35,7 +35,7 @@ on:
# Define the secrets accessible by the workflow:
secrets:
STDLIB_BOT_GITHUB_TOKEN:
- description: 'stdlib-bot GitHub token to create pull request comments'
+ description: "stdlib-bot GitHub token to create pull request comments"
required: true
# Trigger on pull request events:
@@ -55,12 +55,10 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for checking the contributing guidelines acceptance...
check_acknowledgment:
-
# Define a display name:
- name: 'Check Contributing Guidelines Acceptance'
+ name: "Check Contributing Guidelines Acceptance"
# Define the type of virtual host machine:
runs-on: ubuntu-latest
@@ -71,7 +69,7 @@ jobs:
# Define the sequence of job steps...
steps:
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -86,7 +84,7 @@ jobs:
timeout-minutes: 10
# Check contributing guidelines acceptance:
- - name: 'Check contributing guidelines acceptance'
+ - name: "Check contributing guidelines acceptance"
env:
GITHUB_TOKEN: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
PR_NUMBER: ${{ github.event.pull_request.number || inputs.pull_request_number }}
diff --git a/.github/workflows/check_licenses.yml b/.github/workflows/check_licenses.yml
index 5f6a3e434863..990cd781b0f0 100644
--- a/.github/workflows/check_licenses.yml
+++ b/.github/workflows/check_licenses.yml
@@ -20,7 +20,7 @@
name: check_licenses
# Workflow triggers:
-on: [ pull_request ]
+on: [pull_request]
# Global permissions:
permissions:
@@ -29,20 +29,18 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for checking that pull requests do not introduce dependencies which fail license requirements...
check_licenses:
-
# Define a display name:
- name: 'Check licenses'
+ name: "Check licenses"
# Define the type of virtual host machine:
runs-on: ubuntu-latest
# Define environment variables:
env:
- BUILD_TASK: 'check_licenses'
- GITHUB: 'true'
+ BUILD_TASK: "check_licenses"
+ GITHUB: "true"
LOG_DIR: "${{ github.workspace }}/tmp/var/log"
LOG_FILE_BUILD_TASK: "${{ github.workspace }}/tmp/var/log/check_licenses.log"
LOG_NUM_LINES: 5000
@@ -55,9 +53,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -72,22 +69,22 @@ jobs:
timeout-minutes: 10
# Initialize log files:
- - name: 'Initialize log files'
+ - name: "Initialize log files"
run: |
mkdir -p "${{ env.LOG_DIR }}"
touch "${{ env.LOG_FILE_BUILD_TASK }}"
timeout-minutes: 2
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
- node-version: '20' # 'lts/*'
+ node-version: "20" # 'lts/*'
timeout-minutes: 5
# Print debug info:
- - name: 'Print debug info'
+ - name: "Print debug info"
run: |
echo 'PATH:'
echo $PATH
@@ -106,19 +103,19 @@ jobs:
timeout-minutes: 2
# Perform install sequence (accounting for possible network failures, etc, when installing node module dependencies):
- - name: 'Perform install sequence'
+ - name: "Perform install sequence"
run: |
make install-node-modules || make install-node-modules || make install-node-modules
timeout-minutes: 30
# Run the build task:
- - name: 'Run build task'
+ - name: "Run build task"
run: |
. "$GITHUB_WORKSPACE/.github/workflows/scripts/task_runner" "${{ env.BUILD_TASK }}" "${{ env.LOG_FILE_BUILD_TASK }}"
timeout-minutes: 360
# View the log file if the previous step fails:
- - name: 'View log file'
+ - name: "View log file"
if: failure()
run: |
echo "Printing the last ${{ env.LOG_NUM_LINES }} lines of log output..."
@@ -126,7 +123,7 @@ jobs:
timeout-minutes: 5
# Upload the log file:
- - name: 'Upload log file'
+ - name: "Upload log file"
# Pin action to full length commit SHA
uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0
if: always()
diff --git a/.github/workflows/check_required_files.yml b/.github/workflows/check_required_files.yml
index 8a1f96dd1317..659c8546bdf0 100644
--- a/.github/workflows/check_required_files.yml
+++ b/.github/workflows/check_required_files.yml
@@ -26,7 +26,7 @@ on:
# Define the input parameters for the workflow:
inputs:
pull_request_number:
- description: 'Pull request number'
+ description: "Pull request number"
required: true
type: number
user:
@@ -36,14 +36,14 @@ on:
# Define the secrets accessible by the workflow:
secrets:
STDLIB_BOT_GITHUB_TOKEN:
- description: 'stdlib-bot GitHub token to create pull request comments'
+ description: "stdlib-bot GitHub token to create pull request comments"
required: true
# Allow the workflow to be manually triggered:
workflow_dispatch:
inputs:
pull_request_number:
- description: 'Pull request number'
+ description: "Pull request number"
required: true
type: number
user:
@@ -57,21 +57,18 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for checking that pull requests contain the required files...
check_required_files:
-
# Define a display name:
- name: 'Check Required Files'
+ name: "Check Required Files"
# Define the type of virtual host machine:
runs-on: ubuntu-latest
# Define the sequence of job steps...
steps:
-
# Get list of added files:
- - name: 'Get list of added files'
+ - name: "Get list of added files"
id: added-files
env:
GITHUB_TOKEN: ${{ secrets.STDLIB_BOT_GITHUB_TOKEN }}
@@ -91,7 +88,7 @@ jobs:
echo "files=${files}" >> $GITHUB_OUTPUT
# Check whether the pull request contains a new `README.md` file; if not, exit with a non-zero exit code:
- - name: 'Exit if pull request does not contain a new README.md file'
+ - name: "Exit if pull request does not contain a new README.md file"
run: |
if [[ ! "${{ steps.added-files.outputs.files }}" =~ "README.md" ]]; then
echo "Pull request does not contain a new README.md file."
@@ -99,7 +96,7 @@ jobs:
fi
# Check whether the pull request contains files which are required to be present for all packages:
- - name: 'Check whether the pull request contains files which are required to be present for all packages'
+ - name: "Check whether the pull request contains files which are required to be present for all packages"
run: |
# Define a list of required files:
required_files=(
@@ -195,7 +192,7 @@ jobs:
timeout-minutes: 10
# Create a comment on the pull request informing the user whether the pull request is missing required files:
- - name: 'Create a comment on the pull request informing the user whether the pull request is missing required files'
+ - name: "Create a comment on the pull request informing the user whether the pull request is missing required files"
# Pin action to full length commit SHA
uses: peter-evans/create-or-update-comment@71345be0265236311c031f5c7866368bd1eff043 # v4.0.0
with:
diff --git a/.github/workflows/cleanup_coverage.yml b/.github/workflows/cleanup_coverage.yml
index 353087d0ac9b..a8675ff69794 100644
--- a/.github/workflows/cleanup_coverage.yml
+++ b/.github/workflows/cleanup_coverage.yml
@@ -21,7 +21,6 @@ name: cleanup_coverage
# Workflow triggers:
on:
-
# Trigger the workflow when a pull request is closed (e.g., merged or closed without merging):
pull_request_target:
types:
@@ -29,19 +28,17 @@ on:
# Workflow jobs:
jobs:
-
# Define a job to perform coverage cleanup...
cleanup:
-
# Define a display name:
- name: 'Cleanup coverage'
+ name: "Cleanup coverage"
# Define the type of virtual host machine:
runs-on: ubuntu-latest
steps:
# Delete the 'pr-<number>' branch from the 'stdlib-js/www-test-code-coverage' repository:
- - name: 'Delete coverage branch for PR'
+ - name: "Delete coverage branch for PR"
env:
REPO_GITHUB_TOKEN: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
PR_NUMBER: ${{ github.event.pull_request.number }}
@@ -51,7 +48,7 @@ jobs:
|| echo "Branch pr-${PR_NUMBER} does not exist or could not be deleted."
# Find and update the '## Coverage Report' comment in the PR
- - name: 'Update coverage comment in PR'
+ - name: "Update coverage comment in PR"
# Pin action to full length commit SHA
uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
with:
diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
index 157003d59e88..436eba4feb44 100644
--- a/.github/workflows/codeql.yml
+++ b/.github/workflows/codeql.yml
@@ -26,7 +26,7 @@ on:
# branches: [ "develop", "master" ]
schedule:
# Run the workflow once a week (Sunday at midnight):
- - cron: '0 0 * * 0'
+ - cron: "0 0 * * 0"
# Allow the workflow to be manually run:
workflow_dispatch:
@@ -38,12 +38,10 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for performing CodeQL analysis...
analyze:
-
# Define a display name:
- name: 'Analyze'
+ name: "Analyze"
# Ensure the job does not run on forks:
if: github.repository == 'stdlib-js/stdlib'
@@ -71,13 +69,11 @@ jobs:
# Define the build matrix strategy...
strategy:
-
# Specify whether to cancel all in-progress jobs if any matrix job fails:
fail-fast: false
# Define the build matrix:
matrix:
-
# CodeQL supports the following languages:
#
# [ 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift' ]
@@ -85,13 +81,12 @@ jobs:
# Use only 'java-kotlin' to analyze code written in Java, Kotlin, or both.
#
# Use only 'javascript-typescript' to analyze code written in JavaScript, TypeScript, or both.
- language: [ 'javascript-typescript' ]
+ language: ["javascript-typescript"]
# Define the sequence of job steps:
steps:
-
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -106,7 +101,7 @@ jobs:
timeout-minutes: 10
# Install compilers:
- - name: 'Install compilers'
+ - name: "Install compilers"
run: |
sudo -E apt-add-repository -y "ppa:ubuntu-toolchain-r/test"
sudo -E apt-get update -q
@@ -119,15 +114,15 @@ jobs:
timeout-minutes: 10
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
- node-version: '20' # 'lts/*'
+ node-version: "20" # 'lts/*'
timeout-minutes: 5
# Print debug info:
- - name: 'Print debug info'
+ - name: "Print debug info"
run: |
echo 'PATH:'
echo $PATH
@@ -155,7 +150,7 @@ jobs:
timeout-minutes: 2
# Install dependencies (accounting for possible network failures, etc, when installing node module dependencies):
- - name: 'Install dependencies'
+ - name: "Install dependencies"
run: |
make install-node-modules || make install-node-modules || make install-node-modules
timeout-minutes: 15
@@ -166,7 +161,7 @@ jobs:
# make install-node-addons
# Initialize CodeQL tools for scanning:
- - name: 'Initialize CodeQL'
+ - name: "Initialize CodeQL"
# Pin action to full length commit SHA
uses: github/codeql-action/init@382a50a0284c0de445104889a9d6003acb4b3c1d # v2.15.4
@@ -175,10 +170,10 @@ jobs:
languages: ${{ matrix.language }}
# Specify a path to a custom CodeQL configuration file:
- config-file: './.github/codeql/codeql_config.yml'
+ config-file: "./.github/codeql/codeql_config.yml"
# Perform CodeQL analysis:
- - name: 'Perform CodeQL Analysis'
+ - name: "Perform CodeQL Analysis"
# Pin action to full length commit SHA
uses: github/codeql-action/analyze@382a50a0284c0de445104889a9d6003acb4b3c1d # v2.15.4
diff --git a/.github/workflows/create_address_commit_comment_issues.yml b/.github/workflows/create_address_commit_comment_issues.yml
index 7ae675950fcc..c3ec68b8865c 100644
--- a/.github/workflows/create_address_commit_comment_issues.yml
+++ b/.github/workflows/create_address_commit_comment_issues.yml
@@ -23,7 +23,7 @@ name: create_address_commit_comment_issues
on:
# Run the workflow daily at midnight UTC:
schedule:
- - cron: '0 0 * * *'
+ - cron: "0 0 * * *"
# Allow the workflow to be manually run:
workflow_dispatch:
@@ -35,12 +35,10 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for creating issues from commit comments...
create_issues:
-
# Define a display name:
- name: 'Create issues from commit comments'
+ name: "Create issues from commit comments"
# Ensure the job does not run on forks:
if: github.repository == 'stdlib-js/stdlib'
@@ -51,7 +49,7 @@ jobs:
# Define the sequence of job steps...
steps:
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -66,7 +64,7 @@ jobs:
timeout-minutes: 10
# Create issues from commit comments:
- - name: 'Create issues from commit comments'
+ - name: "Create issues from commit comments"
env:
GITHUB_TOKEN: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
run: |
diff --git a/.github/workflows/deprecate_packages.yml b/.github/workflows/deprecate_packages.yml
index 7a66319199cc..e184d1d7a463 100644
--- a/.github/workflows/deprecate_packages.yml
+++ b/.github/workflows/deprecate_packages.yml
@@ -25,10 +25,10 @@ on:
workflow_dispatch:
inputs:
packages:
- description: 'List of packages (space separated):'
+ description: "List of packages (space separated):"
required: true
message:
- description: 'Custom deprecation message:'
+ description: "Custom deprecation message:"
# Global permissions:
permissions:
@@ -37,7 +37,6 @@ permissions:
# Workflow concurrency group:
concurrency:
-
# Specify a group name:
group: ${{ github.workflow }}
@@ -46,12 +45,10 @@ concurrency:
# Workflow jobs:
jobs:
-
# Define a job for deprecating packages...
deprecate:
-
# Define a display name:
- name: 'Deprecate packages'
+ name: "Deprecate packages"
# Define the type of virtual host machine:
runs-on: ubuntu-latest
@@ -59,7 +56,7 @@ jobs:
# Define the sequence of job steps...
steps:
# Deprecate the specified packages on npm and the respective GitHub repositories:
- - name: 'Deprecate packages'
+ - name: "Deprecate packages"
env:
GITHUB_TOKEN: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
run: |
diff --git a/.github/workflows/do_not_merge.yml b/.github/workflows/do_not_merge.yml
index 9afe2a559e70..95a1e109c9f7 100644
--- a/.github/workflows/do_not_merge.yml
+++ b/.github/workflows/do_not_merge.yml
@@ -31,12 +31,10 @@ on:
# Workflow jobs:
jobs:
-
# Define a job which fails a pull request if the pull request has a "Do Not Merge" label:
do_not_merge:
-
# Define job name:
- name: 'Check for Do Not Merge label'
+ name: "Check for Do Not Merge label"
# Only run this job if the pull request has a "Do Not Merge" label:
if: ${{ contains(github.event.*.labels.*.name, 'Do Not Merge') }}
@@ -50,9 +48,8 @@ jobs:
# Define the sequence of job steps:
steps:
-
# Fail the pull request:
- - name: 'Prevent merge'
+ - name: "Prevent merge"
run: |
echo "Pull request is labeled as 'Do Not Merge'."
echo "This workflow fails so that the pull request cannot be merged."
diff --git a/.github/workflows/first_time_greeting.yml b/.github/workflows/first_time_greeting.yml
index 1eb5acae18f8..b10ffdc6afb0 100644
--- a/.github/workflows/first_time_greeting.yml
+++ b/.github/workflows/first_time_greeting.yml
@@ -29,21 +29,18 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for commenting on first-time contributions...
greeting:
-
# Define a display name:
- name: 'Welcome new contributors'
+ name: "Welcome new contributors"
# Define the type of virtual host machine:
runs-on: ubuntu-latest
# Define the sequence of job steps...
steps:
-
# Greet first-time contributors:
- - name: 'Greet first-time contributors'
+ - name: "Greet first-time contributors"
# Pin action to full length commit SHA
uses: actions/first-interaction@34f15e814fe48ac9312ccf29db4e74fa767cbab7 # v1.3.0
with:
diff --git a/.github/workflows/generate_pr_commit_message.yml b/.github/workflows/generate_pr_commit_message.yml
index 15ec17886ef8..3d399092f412 100644
--- a/.github/workflows/generate_pr_commit_message.yml
+++ b/.github/workflows/generate_pr_commit_message.yml
@@ -38,12 +38,10 @@ permissions:
# Workflow jobs:
jobs:
-
# Job to generate commit message draft:
generate-commit-message:
-
# Define a display name:
- name: 'Generate PR Commit Message Draft'
+ name: "Generate PR Commit Message Draft"
# Define the type of virtual host machine:
runs-on: ubuntu-latest
@@ -58,7 +56,7 @@ jobs:
# Define the sequence of job steps...
steps:
# Checkout repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -66,7 +64,7 @@ jobs:
fetch-depth: 0
# Generate commit message:
- - name: 'Generate commit message'
+ - name: "Generate commit message"
id: commit_message
run: |
COMMIT_MESSAGE=$($GITHUB_WORKSPACE/.github/workflows/scripts/generate_pr_commit_message $PR_NUMBER)
@@ -86,7 +84,7 @@ jobs:
exit 0
# Post commit message as PR comment:
- - name: 'Post commit message as PR comment'
+ - name: "Post commit message as PR comment"
# Pin action to full length commit SHA
uses: peter-evans/create-or-update-comment@71345be0265236311c031f5c7866368bd1eff043 # v4.0.0
with:
diff --git a/.github/workflows/git_note_amend_message.yml b/.github/workflows/git_note_amend_message.yml
index 1732f13d28cb..3af2035c099f 100644
--- a/.github/workflows/git_note_amend_message.yml
+++ b/.github/workflows/git_note_amend_message.yml
@@ -26,11 +26,11 @@ on:
# Define the input parameters for the workflow:
inputs:
commit_hash:
- description: 'Commit hash to create note for'
+ description: "Commit hash to create note for"
required: true
type: string
message:
- description: 'New commit message'
+ description: "New commit message"
required: true
type: string
@@ -39,34 +39,32 @@ on:
# Define the input parameters for the workflow:
inputs:
commit_hash:
- description: 'Commit hash to create note for'
+ description: "Commit hash to create note for"
required: true
type: string
message:
- description: 'New commit message'
+ description: "New commit message"
required: true
type: string
# Define the secrets accessible by the workflow:
secrets:
STDLIB_BOT_GITHUB_TOKEN:
- description: 'GitHub token for stdlib-bot'
+ description: "GitHub token for stdlib-bot"
required: true
STDLIB_BOT_GPG_PRIVATE_KEY:
- description: 'GPG private key for stdlib-bot'
+ description: "GPG private key for stdlib-bot"
required: true
STDLIB_BOT_GPG_PASSPHRASE:
- description: 'GPG passphrase for stdlib-bot'
+ description: "GPG passphrase for stdlib-bot"
required: true
# Workflow jobs:
jobs:
-
# Define a job to create a Git note amending a commit message:
create_git_note_amending_commit_message:
-
# Define job name:
- name: 'Create Git Note Amending Commit Message'
+ name: "Create Git Note Amending Commit Message"
# Define the type of virtual host machine:
runs-on: ubuntu-latest
@@ -74,7 +72,7 @@ jobs:
# Define the sequence of job steps:
steps:
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -88,7 +86,7 @@ jobs:
persist-credentials: false
# Verify commit exists:
- - name: 'Verify commit exists'
+ - name: "Verify commit exists"
run: |
if ! git rev-parse --quiet --verify ${{ inputs.commit_hash }}^{commit}; then
echo "Error: Commit ${{ inputs.commit_hash }} not found"
@@ -96,7 +94,7 @@ jobs:
fi
# Create Git note:
- - name: 'Create Git note'
+ - name: "Create Git note"
run: |
# Create Git note file:
cat > "docs/git-notes/${{ inputs.commit_hash }}.txt" << EOF
@@ -113,12 +111,12 @@ jobs:
cat "docs/git-notes/${{ inputs.commit_hash }}.txt" >> $GITHUB_STEP_SUMMARY
# Disable Git hooks:
- - name: 'Disable Git hooks'
+ - name: "Disable Git hooks"
run: |
rm -rf .git/hooks
# Import GPG key to sign commits:
- - name: 'Import GPG key to sign commits'
+ - name: "Import GPG key to sign commits"
# Pin action to full length commit SHA
uses: crazy-max/ghaction-import-gpg@cb9bde2e2525e640591a934b1fd28eef1dcaf5e5 # v6.2.0
with:
@@ -128,10 +126,10 @@ jobs:
git_commit_gpgsign: true
# Commit and push changes:
- - name: 'Commit and push changes'
+ - name: "Commit and push changes"
env:
- REPO_GITHUB_TOKEN: ${{ secrets.STDLIB_BOT_GITHUB_TOKEN }}
- USER_NAME: stdlib-bot
+ REPO_GITHUB_TOKEN: ${{ secrets.STDLIB_BOT_GITHUB_TOKEN }}
+ USER_NAME: stdlib-bot
run: |
git config --local user.email "82920195+stdlib-bot@users.noreply.github.com"
git config --local user.name "${USER_NAME}"
diff --git a/.github/workflows/git_note_filter_packages.yml b/.github/workflows/git_note_filter_packages.yml
index 4a989fb181e4..d792bea968fd 100644
--- a/.github/workflows/git_note_filter_packages.yml
+++ b/.github/workflows/git_note_filter_packages.yml
@@ -26,11 +26,11 @@ on:
# Define the input parameters for the workflow:a
inputs:
commit_hash:
- description: 'Commit hash to create note for'
+ description: "Commit hash to create note for"
required: true
type: string
excludes:
- description: 'Comma-separated list of packages to exclude'
+ description: "Comma-separated list of packages to exclude"
required: true
type: string
@@ -39,34 +39,32 @@ on:
# Define the input parameters for the workflow:
inputs:
commit_hash:
- description: 'Commit hash to create note for'
+ description: "Commit hash to create note for"
required: true
type: string
excludes:
- description: 'Comma-separated list of packages to exclude'
+ description: "Comma-separated list of packages to exclude"
required: true
type: string
# Define the secrets accessible by the workflow:
secrets:
STDLIB_BOT_GITHUB_TOKEN:
- description: 'GitHub token for stdlib-bot'
+ description: "GitHub token for stdlib-bot"
required: true
STDLIB_BOT_GPG_PRIVATE_KEY:
- description: 'GPG private key for stdlib-bot'
+ description: "GPG private key for stdlib-bot"
required: true
STDLIB_BOT_GPG_PASSPHRASE:
- description: 'GPG passphrase for stdlib-bot'
+ description: "GPG passphrase for stdlib-bot"
required: true
# Workflow jobs:
jobs:
-
# Define a job to create a Git note amending a commit message:
create_git_note_filtering_packages:
-
# Define job name:
- name: 'Create Git Note Filtering Packages for Commit'
+ name: "Create Git Note Filtering Packages for Commit"
# Define the type of virtual host machine:
runs-on: ubuntu-latest
@@ -74,7 +72,7 @@ jobs:
# Define the sequence of job steps:
steps:
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -88,7 +86,7 @@ jobs:
persist-credentials: false
# Verify commit exists:
- - name: 'Verify commit exists'
+ - name: "Verify commit exists"
run: |
if ! git rev-parse --quiet --verify ${{ inputs.commit_hash }}^{commit}; then
echo "Error: Commit ${{ inputs.commit_hash }} not found"
@@ -96,7 +94,7 @@ jobs:
fi
# Create Git note:
- - name: 'Create Git note'
+ - name: "Create Git note"
run: |
# Start creating the note file:
cat > "docs/git-notes/${{ inputs.commit_hash }}.txt" << 'EOF'
@@ -122,12 +120,12 @@ jobs:
cat "docs/git-notes/${{ inputs.commit_hash }}.txt" >> $GITHUB_STEP_SUMMARY
# Disable Git hooks:
- - name: 'Disable Git hooks'
+ - name: "Disable Git hooks"
run: |
rm -rf .git/hooks
# Import GPG key to sign commits:
- - name: 'Import GPG key to sign commits'
+ - name: "Import GPG key to sign commits"
# Pin action to full length commit SHA
uses: crazy-max/ghaction-import-gpg@cb9bde2e2525e640591a934b1fd28eef1dcaf5e5 # v6.2.0
with:
@@ -137,10 +135,10 @@ jobs:
git_commit_gpgsign: true
# Commit and push changes:
- - name: 'Commit and push changes'
+ - name: "Commit and push changes"
env:
- REPO_GITHUB_TOKEN: ${{ secrets.STDLIB_BOT_GITHUB_TOKEN }}
- USER_NAME: stdlib-bot
+ REPO_GITHUB_TOKEN: ${{ secrets.STDLIB_BOT_GITHUB_TOKEN }}
+ USER_NAME: stdlib-bot
run: |
git config --local user.email "82920195+stdlib-bot@users.noreply.github.com"
git config --local user.name "${USER_NAME}"
diff --git a/.github/workflows/good_first_issue.yml b/.github/workflows/good_first_issue.yml
index f59488d7de8e..cb063a3e1e48 100644
--- a/.github/workflows/good_first_issue.yml
+++ b/.github/workflows/good_first_issue.yml
@@ -27,12 +27,10 @@ on:
# Workflow jobs:
jobs:
-
# Define a job which posts a comment to "good first issues":
add_comment:
-
# Define job name:
- name: 'Check for Good First Issue label'
+ name: "Check for Good First Issue label"
# Only run this job if the pull request has a specific label:
if: "${{ github.event.label.name == 'Good First Issue' }}"
@@ -47,9 +45,8 @@ jobs:
# Define the sequence of job steps:
steps:
-
# Post a comment:
- - name: 'Add comment'
+ - name: "Add comment"
run: gh issue comment "$NUMBER" --body "$BODY"
env:
GH_TOKEN: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
diff --git a/.github/workflows/label_commands.yml b/.github/workflows/label_commands.yml
index 4538336cc0e2..b9adc5fbe683 100644
--- a/.github/workflows/label_commands.yml
+++ b/.github/workflows/label_commands.yml
@@ -27,12 +27,10 @@ on:
# Workflow jobs:
jobs:
-
# Define a job for removing the label and adding in-progress label:
manage_labels:
-
# Define a display name:
- name: 'Manage labels'
+ name: "Manage labels"
# Define the type of virtual host machine:
runs-on: ubuntu-latest
@@ -47,8 +45,7 @@ jobs:
# Define the job's steps:
steps:
-
- - name: 'Remove label'
+ - name: "Remove label"
# Pin action to full length commit SHA
uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
with:
@@ -65,7 +62,7 @@ jobs:
console.log( 'Error removing label: %s', error.message );
}
- - name: 'Add in-progress label'
+ - name: "Add in-progress label"
# Pin action to full length commit SHA
uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
with:
@@ -79,7 +76,7 @@ jobs:
})
# Add initial reaction to comment with slash command:
- - name: 'Add initial reaction'
+ - name: "Add initial reaction"
run: |
curl -X POST \
-H "Accept: application/vnd.github.v3+json" \
@@ -89,12 +86,11 @@ jobs:
# Define a job for checking for required files:
check_files:
-
# Define a display name:
- name: 'Check for required files'
+ name: "Check for required files"
# Ensure initial reaction job has completed before running this job:
- needs: [ manage_labels ]
+ needs: [manage_labels]
# Define the conditions under which the job should run:
if: |
@@ -110,12 +106,11 @@ jobs:
# Define a job for updating copyright header years:
update_copyright_years:
-
# Define a display name:
- name: 'Update copyright header years'
+ name: "Update copyright header years"
# Ensure initial reaction job has completed before running this job:
- needs: [ manage_labels ]
+ needs: [manage_labels]
# Define the conditions under which the job should run:
if: |
@@ -132,12 +127,11 @@ jobs:
# Define a job for auto-fixing lint errors:
fix_lint_errors:
-
# Define a display name:
- name: 'Auto-fix lint errors'
+ name: "Auto-fix lint errors"
# Ensure initial reaction job has completed before running this job:
- needs: [ manage_labels ]
+ needs: [manage_labels]
# Define the conditions under which the job should run:
if: |
@@ -154,12 +148,11 @@ jobs:
# Define a job for merging develop branch:
merge_develop:
-
# Define a display name:
- name: 'Merge changes from develop branch into this PR'
+ name: "Merge changes from develop branch into this PR"
# Ensure initial reaction job has completed before running this job:
- needs: [ manage_labels ]
+ needs: [manage_labels]
# Define the conditions under which the job should run:
if: |
@@ -176,12 +169,11 @@ jobs:
# Define a job for rebasing on develop branch:
rebase_develop:
-
# Define a display name:
- name: 'Rebase this PR on top of develop branch'
+ name: "Rebase this PR on top of develop branch"
# Ensure initial reaction job has completed before running this job:
- needs: [ manage_labels ]
+ needs: [manage_labels]
# Define the conditions under which the job should run:
if: |
@@ -198,15 +190,22 @@ jobs:
# Define a job for removing the in-progress label:
remove_progress_label:
-
# Define a display name:
- name: 'Remove in-progress label'
+ name: "Remove in-progress label"
# Define the type of virtual host machine:
runs-on: ubuntu-latest
# Ensure all previous jobs have completed before running this job:
- needs: [ manage_labels, check_files, update_copyright_years, fix_lint_errors, merge_develop, rebase_develop ]
+ needs:
+ [
+ manage_labels,
+ check_files,
+ update_copyright_years,
+ fix_lint_errors,
+ merge_develop,
+ rebase_develop,
+ ]
# Define the conditions under which the job should run:
if: |
diff --git a/.github/workflows/label_good_first_prs.yml b/.github/workflows/label_good_first_prs.yml
index 0f60ecd4f3f8..ad053a488092 100644
--- a/.github/workflows/label_good_first_prs.yml
+++ b/.github/workflows/label_good_first_prs.yml
@@ -31,10 +31,8 @@ on:
# Workflow jobs:
jobs:
-
# Define a job which automatically labels pull requests based on whether they reference good first issues
labeler:
-
# Define job name:
name: 'Label PRs for issues with label "Good First Issue" as "Good First PR"s'
@@ -52,7 +50,7 @@ jobs:
# Define the sequence of job steps:
steps:
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -68,7 +66,7 @@ jobs:
# Check whether any of the referenced issues is a "Good First Issue":
- name: 'Check whether any of the referenced issues is a "Good First Issue"'
- id: 'check-pr'
+ id: "check-pr"
env:
PR_NUMBER: ${{ github.event.pull_request.number }}
run: |
diff --git a/.github/workflows/labeler.yml b/.github/workflows/labeler.yml
index 2626d24d9ecc..06b2317dff05 100644
--- a/.github/workflows/labeler.yml
+++ b/.github/workflows/labeler.yml
@@ -36,12 +36,10 @@ on:
# Workflow jobs:
jobs:
-
# Define a job which automatically labels pull requests based on the contents of the pull request:
labeler:
-
# Define job name:
- name: 'Labeler'
+ name: "Labeler"
# Only run this job if the pull request did not have label `automated-pr`:
if: contains(github.event.pull_request.labels.*.name, 'automated-pr') == false
@@ -56,9 +54,8 @@ jobs:
# Define the sequence of job steps:
steps:
-
# Automatically label pull requests:
- - name: 'Automatically label pull requests'
+ - name: "Automatically label pull requests"
# Pin action to full length commit SHA
uses: actions/labeler@8558fd74291d67161a8a78ce36a881fa63b766a9 # v5.0.0
with:
diff --git a/.github/workflows/lint_autofix.yml b/.github/workflows/lint_autofix.yml
index d01dd0614dff..554e25d418bc 100644
--- a/.github/workflows/lint_autofix.yml
+++ b/.github/workflows/lint_autofix.yml
@@ -21,45 +21,41 @@ name: lint_autofix
# Workflow triggers:
on:
-
# Allow the workflow to be triggered by other workflows
workflow_call:
# Define the input parameters for the workflow:
inputs:
pull_request_number:
- description: 'PR number'
+ description: "PR number"
required: true
type: number
# Define the secrets accessible by the workflow:
secrets:
STDLIB_BOT_GITHUB_TOKEN:
- description: 'GitHub token for stdlib-bot'
+ description: "GitHub token for stdlib-bot"
required: true
STDLIB_BOT_GPG_PRIVATE_KEY:
- description: 'GPG private key for stdlib-bot'
+ description: "GPG private key for stdlib-bot"
required: true
STDLIB_BOT_GPG_PASSPHRASE:
- description: 'GPG passphrase for stdlib-bot'
+ description: "GPG passphrase for stdlib-bot"
required: true
# Workflow jobs:
jobs:
-
# Define a job for automatically fixing lint errors:
autofix:
-
# Define a display name:
- name: 'Fix lint errors'
+ name: "Fix lint errors"
# Define the type of virtual host machine:
runs-on: ubuntu-latest
# Define the sequence of job steps...
steps:
-
# Get PR details:
- - name: 'Get PR details'
+ - name: "Get PR details"
id: pr-details
run: |
pr_response=$(curl -s \
@@ -79,7 +75,7 @@ jobs:
echo "repository=$pr_repo_full_name" >> $GITHUB_OUTPUT
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -93,30 +89,30 @@ jobs:
token: ${{ secrets.STDLIB_BOT_GITHUB_TOKEN }}
# File path to checkout to:
- path: './'
+ path: "./"
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
- node-version: '20' # 'lts/*'
+ node-version: "20" # 'lts/*'
timeout-minutes: 5
# Install dependencies (accounting for possible network failures, etc, when installing node module dependencies):
- - name: 'Install dependencies'
+ - name: "Install dependencies"
run: |
make install-node-modules || make install-node-modules || make install-node-modules
timeout-minutes: 15
# Initialize development environment:
- - name: 'Initialize development environment'
+ - name: "Initialize development environment"
run: |
make init
timeout-minutes: 5
# Get list of changed files:
- - name: 'Get list of changed files'
+ - name: "Get list of changed files"
id: changed-files
run: |
page=1
@@ -134,32 +130,32 @@ jobs:
echo "files=${files}" >> $GITHUB_OUTPUT
# Fix JavaScript lint errors:
- - name: 'Fix JavaScript lint errors'
+ - name: "Fix JavaScript lint errors"
id: fix-lint-errors
run: |
files="${{ steps.changed-files.outputs.files }}"
FIX=1 . "$GITHUB_WORKSPACE/.github/workflows/scripts/lint_javascript_files" "$files" || true
# Add missing trailing newlines:
- - name: 'Add missing trailing newlines'
+ - name: "Add missing trailing newlines"
id: add-trailing-newlines
run: |
files="${{ steps.changed-files.outputs.files }}"
. "$GITHUB_WORKSPACE/.github/workflows/scripts/add_trailing_newlines" "$files"
# Remove related packages from README.md files:
- - name: 'Remove related packages from README.md files'
+ - name: "Remove related packages from README.md files"
run: |
files="${{ steps.changed-files.outputs.files }}"
. "$GITHUB_WORKSPACE/.github/workflows/scripts/remove_related_packages" "$files"
# Disable Git hooks:
- - name: 'Disable Git hooks'
+ - name: "Disable Git hooks"
run: |
rm -rf .git/hooks
# Import GPG key to sign commits:
- - name: 'Import GPG key to sign commits'
+ - name: "Import GPG key to sign commits"
# Pin action to full length commit SHA
uses: crazy-max/ghaction-import-gpg@cb9bde2e2525e640591a934b1fd28eef1dcaf5e5 # v6.2.0
with:
@@ -169,12 +165,12 @@ jobs:
git_commit_gpgsign: true
# Commit and push changes:
- - name: 'Commit and push changes'
+ - name: "Commit and push changes"
env:
- REPO_GITHUB_TOKEN: ${{ secrets.STDLIB_BOT_GITHUB_TOKEN }}
- USER_NAME: stdlib-bot
- BRANCH_NAME: ${{ steps.pr-details.outputs.branch }}
- REPO_NAME: ${{ steps.pr-details.outputs.repository }}
+ REPO_GITHUB_TOKEN: ${{ secrets.STDLIB_BOT_GITHUB_TOKEN }}
+ USER_NAME: stdlib-bot
+ BRANCH_NAME: ${{ steps.pr-details.outputs.branch }}
+ REPO_NAME: ${{ steps.pr-details.outputs.repository }}
run: |
git config --local user.email "82920195+stdlib-bot@users.noreply.github.com"
git config --local user.name "$USER_NAME"
diff --git a/.github/workflows/lint_changed_files.yml b/.github/workflows/lint_changed_files.yml
index 380805af49cb..f0090c1749fc 100644
--- a/.github/workflows/lint_changed_files.yml
+++ b/.github/workflows/lint_changed_files.yml
@@ -37,12 +37,10 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for linting committed code...
lint:
-
# Define a display name:
- name: 'Lint Changed Files'
+ name: "Lint Changed Files"
# Define the type of virtual host machine:
runs-on: ubuntu-latest
@@ -50,7 +48,7 @@ jobs:
# Define the sequence of job steps...
steps:
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -65,15 +63,15 @@ jobs:
timeout-minutes: 10
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
- node-version: '20' # 'lts/*'
+ node-version: "20" # 'lts/*'
timeout-minutes: 5
# Cache dependencies:
- - name: 'Cache dependencies'
+ - name: "Cache dependencies"
# Pin action to full length commit SHA
uses: actions/cache@1bd1e32a3bdc45362d1e726936510720a7c30a57 # v4.2.0
id: cache
@@ -85,20 +83,20 @@ jobs:
${{ runner.os }}-node-
# Install dependencies (accounting for possible network failures, etc, when installing node module dependencies):
- - name: 'Install dependencies'
+ - name: "Install dependencies"
if: steps.cache.outputs.cache-hit != 'true'
run: |
make install-node-modules || make install-node-modules || make install-node-modules
timeout-minutes: 15
# Initialize development environment:
- - name: 'Initialize development environment'
+ - name: "Initialize development environment"
run: |
make init
timeout-minutes: 5
# Get list of changed files:
- - name: 'Get list of changed files'
+ - name: "Get list of changed files"
id: changed-files
continue-on-error: true
run: |
@@ -118,7 +116,7 @@ jobs:
echo "files=${files}" >> $GITHUB_OUTPUT
# Lint file names:
- - name: 'Lint file names'
+ - name: "Lint file names"
run: |
# Determine root directory:
root=$(git rev-parse --show-toplevel)
@@ -130,13 +128,13 @@ jobs:
echo "${{ steps.changed-files.outputs.files }}" || "${lint_filenames}"
# Lint files against EditorConfig:
- - name: 'Lint against EditorConfig'
+ - name: "Lint against EditorConfig"
if: success() || failure()
run: |
make lint-editorconfig-files EDITORCONFIG_FORMAT=github-actions FILES="${{ steps.changed-files.outputs.files }}"
# Lint Markdown files:
- - name: 'Lint Markdown files'
+ - name: "Lint Markdown files"
if: success() || failure()
run: |
files=$(echo "${{ steps.changed-files.outputs.files }}" | tr ' ' '\n' | grep -E '\.md$' | tr '\n' ' ' | sed 's/ $//')
@@ -145,7 +143,7 @@ jobs:
fi
# Lint shell script files:
- - name: 'Lint shell script files'
+ - name: "Lint shell script files"
if: success() || failure()
run: |
files=$(echo "${{ steps.random-files.outputs.files }}" | tr ' ' '\n' | grep -vE '\.(js|md|json|ts|c|h)$' | while read -r file; do head -n1 "$file" | grep -q '^\#\!/usr/bin/env bash' && echo "$file"; done | tr '\n' ' ' | sed 's/ $//')
@@ -158,13 +156,13 @@ jobs:
fi
# Lint package.json files:
- - name: 'Lint package.json files'
+ - name: "Lint package.json files"
if: success() || failure()
run: |
. "$GITHUB_WORKSPACE/.github/workflows/scripts/lint_package_json_files" "${{ steps.changed-files.outputs.files }}"
# Lint REPL help files...
- - name: 'Lint REPL help files'
+ - name: "Lint REPL help files"
if: success() || failure()
run: |
# Determine root directory:
@@ -179,7 +177,7 @@ jobs:
fi
# Lint JavaScript files:
- - name: 'Lint JavaScript files'
+ - name: "Lint JavaScript files"
if: success() || failure()
run: |
# Determine root directory:
@@ -234,7 +232,7 @@ jobs:
fi
# Lint Python files:
- - name: 'Lint Python files'
+ - name: "Lint Python files"
if: success() || failure()
run: |
files=$(echo "${{ steps.changed-files.outputs.files }}" | tr ' ' '\n' | grep -E '\.py$' | tr '\n' ' ' | sed 's/ $//')
@@ -247,7 +245,7 @@ jobs:
fi
# Check for R files:
- - name: 'Check for R files'
+ - name: "Check for R files"
if: success() || failure()
id: check-r-files
run: |
@@ -261,15 +259,15 @@ jobs:
fi
# Setup R:
- - name: 'Setup R'
+ - name: "Setup R"
if: ( success() || failure() ) && steps.check-r-files.outputs.files != ''
# Pin action to full length commit SHA
uses: r-lib/actions/setup-r@473c68190595b311a74f208fba61a8d8c0d4c247 # v2.11.1
with:
- r-version: '3.5.3'
+ r-version: "3.5.3"
# Lint R files:
- - name: 'Lint R files'
+ - name: "Lint R files"
if: ( success() || failure() ) && steps.check-r-files.outputs.files != ''
run: |
# Install R dependencies:
@@ -279,7 +277,7 @@ jobs:
make lint-r-files FILES="${{ steps.check-r-files.outputs.files }}"
# Lint C files:
- - name: 'Lint C files'
+ - name: "Lint C files"
if: success() || failure()
run: |
# Determine root directory:
@@ -325,7 +323,7 @@ jobs:
fi
# Lint TypeScript declarations files:
- - name: 'Lint TypeScript declarations files'
+ - name: "Lint TypeScript declarations files"
if: success() || failure()
run: |
files=$(echo "${{ steps.changed-files.outputs.files }}" | tr ' ' '\n' | grep -E '\.d\.ts$' | tr '\n' ' ' | sed 's/ $//')
@@ -334,7 +332,7 @@ jobs:
fi
# Lint license headers:
- - name: 'Lint license headers'
+ - name: "Lint license headers"
if: success() || failure()
run: |
files=$(echo "${{ steps.changed-files.outputs.files }}")
diff --git a/.github/workflows/lint_copyright_years.yml b/.github/workflows/lint_copyright_years.yml
index e1c361c50b3c..91407f9bd010 100644
--- a/.github/workflows/lint_copyright_years.yml
+++ b/.github/workflows/lint_copyright_years.yml
@@ -17,7 +17,7 @@
#/
# Workflow name:
-name: 'lint_copyright_years'
+name: "lint_copyright_years"
# Workflow triggers:
on:
@@ -33,12 +33,12 @@ permissions:
jobs:
# Define a job for linting copyright years in newly added files:
lint:
- name: 'Lint Copyright Years'
+ name: "Lint Copyright Years"
runs-on: ubuntu-latest
steps:
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -53,7 +53,7 @@ jobs:
timeout-minutes: 10
# Get list of newly added files:
- - name: 'Get list of newly added files'
+ - name: "Get list of newly added files"
id: added-files
run: |
page=1
@@ -74,7 +74,7 @@ jobs:
echo "files=${files}" >> $GITHUB_OUTPUT
# Check copyright years in newly added files:
- - name: 'Check copyright years'
+ - name: "Check copyright years"
run: |
current_year=$(date +"%Y")
files="${{ steps.added-files.outputs.files }}"
diff --git a/.github/workflows/lint_pr_title.yml b/.github/workflows/lint_pr_title.yml
index 7ff1f7b2702d..30103e57bd86 100644
--- a/.github/workflows/lint_pr_title.yml
+++ b/.github/workflows/lint_pr_title.yml
@@ -35,12 +35,10 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for linting PR titles...
lint_pr_title:
-
# Define a display name:
- name: 'Lint PR title'
+ name: "Lint PR title"
# Define the type of virtual host machine:
runs-on: ubuntu-latest
@@ -53,9 +51,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -70,21 +67,21 @@ jobs:
timeout-minutes: 10
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
- node-version: '20' # 'lts/*'
+ node-version: "20" # 'lts/*'
timeout-minutes: 5
# Perform install sequence (accounting for possible network failures, etc, when installing node module dependencies):
- - name: 'Perform install sequence'
+ - name: "Perform install sequence"
run: |
make install-node-modules || make install-node-modules || make install-node-modules
timeout-minutes: 30
# Perform linting:
- - name: 'Perform linting'
+ - name: "Perform linting"
env:
PR_TITLE: ${{ github.event.pull_request.title }}
run: |
diff --git a/.github/workflows/lint_random_files.yml b/.github/workflows/lint_random_files.yml
index b4dff058e24b..b908c966b0a6 100644
--- a/.github/workflows/lint_random_files.yml
+++ b/.github/workflows/lint_random_files.yml
@@ -26,47 +26,47 @@ on:
inputs:
num:
type: string
- description: 'Maximum number of files to lint:'
- default: '100'
+ description: "Maximum number of files to lint:"
+ default: "100"
pattern:
- description: 'Regular expression for files to include:'
+ description: "Regular expression for files to include:"
default: .*
javascript:
type: boolean
- description: 'Lint JavaScript and TypeScript'
+ description: "Lint JavaScript and TypeScript"
default: true
markdown:
type: boolean
- description: 'Lint Markdown'
+ description: "Lint Markdown"
default: true
json:
type: boolean
- description: 'Lint JSON'
+ description: "Lint JSON"
default: true
repl:
type: boolean
- description: 'Lint REPL documentation and shell script files'
+ description: "Lint REPL documentation and shell script files"
default: true
r:
type: boolean
- description: 'Lint R'
+ description: "Lint R"
default: true
c:
type: boolean
- description: 'Lint C'
+ description: "Lint C"
default: true
python:
type: boolean
- description: 'Lint Python'
+ description: "Lint Python"
default: true
fix:
type: boolean
- description: 'Fix lint errors and submit a PR (if possible)'
+ description: "Fix lint errors and submit a PR (if possible)"
default: false
# Trigger the workflow every 24 hours:
schedule:
- - cron: '0 0 * * *'
+ - cron: "0 0 * * *"
# Global permissions:
permissions:
@@ -75,12 +75,10 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for linting committed code...
lint:
-
# Define a display name:
- name: 'Lint Random Files'
+ name: "Lint Random Files"
# Ensure the job does not run on forks:
if: github.repository == 'stdlib-js/stdlib'
@@ -91,7 +89,7 @@ jobs:
# Define the sequence of job steps...
steps:
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -106,27 +104,27 @@ jobs:
timeout-minutes: 10
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
- node-version: '20' # 'lts/*'
+ node-version: "20" # 'lts/*'
timeout-minutes: 5
# Install dependencies (accounting for possible network failures, etc, when installing node module dependencies):
- - name: 'Install dependencies'
+ - name: "Install dependencies"
run: |
make install-node-modules || make install-node-modules || make install-node-modules
timeout-minutes: 15
# Initialize development environment:
- - name: 'Initialize development environment'
+ - name: "Initialize development environment"
run: |
make init
timeout-minutes: 5
# Pick random files from the `lib/node_modules/@stdlib` directory:
- - name: 'Pick random files from the `lib/node_modules/@stdlib` directory'
+ - name: "Pick random files from the `lib/node_modules/@stdlib` directory"
id: random-files
run: |
name=""
@@ -184,7 +182,7 @@ jobs:
echo "files=$files" >> $GITHUB_OUTPUT
# Lint file names:
- - name: 'Lint file names'
+ - name: "Lint file names"
run: |
# Determine root directory:
root=$(git rev-parse --show-toplevel)
@@ -196,7 +194,7 @@ jobs:
echo "${{ steps.random-files.outputs.files }}" | tr ',' '\n' | "${lint_filenames}"
# Lint files against EditorConfig:
- - name: 'Lint against EditorConfig'
+ - name: "Lint against EditorConfig"
id: lint-editorconfig
run: |
set -o pipefail
@@ -204,7 +202,7 @@ jobs:
make lint-editorconfig-files FILES="${files}" 2>&1 | tee lint_editorconfig_errors.txt
# Create sub-issue for EditorConfig lint failures:
- - name: 'Create sub-issue for EditorConfig lint failures'
+ - name: "Create sub-issue for EditorConfig lint failures"
if: failure() && contains(steps.lint-editorconfig.outcome, 'failure')
env:
GITHUB_TOKEN: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
@@ -241,7 +239,7 @@ jobs:
rm "$BODY_FILE"
# Lint Markdown files:
- - name: 'Lint Markdown files'
+ - name: "Lint Markdown files"
if: ( github.event.inputs.markdown != 'false' ) && ( success() || failure() )
run: |
files=$(echo "${{ steps.random-files.outputs.files }}" | tr ',' '\n' | grep -E '\.md$' | tr '\n' ' ')
@@ -250,7 +248,7 @@ jobs:
fi
# Lint package.json files:
- - name: 'Lint package.json files'
+ - name: "Lint package.json files"
if: ( github.event.inputs.json != 'false' ) && ( success() || failure() )
run: |
# Determine root directory:
@@ -265,7 +263,7 @@ jobs:
fi
# Lint REPL help files...
- - name: 'Lint REPL help files'
+ - name: "Lint REPL help files"
if: ( github.event.inputs.repl != 'false' ) && ( success() || failure() )
run: |
# Determine root directory:
@@ -280,7 +278,7 @@ jobs:
fi
# Lint shell script files:
- - name: 'Lint shell script files'
+ - name: "Lint shell script files"
if: ( github.event.inputs.repl != 'false' ) && ( success() || failure() )
run: |
files=$(echo "${{ steps.random-files.outputs.files }}" | tr ',' '\n' | grep -vE '\.(js|md|json|ts|c|h)$' | while read -r file; do head -n1 "$file" | grep -q '^\#\!/usr/bin/env bash' && echo "$file"; done | tr '\n' ' ')
@@ -293,7 +291,7 @@ jobs:
fi
# Lint JavaScript files:
- - name: 'Lint JavaScript files'
+ - name: "Lint JavaScript files"
id: lint-javascript
if: ( github.event.inputs.javascript != 'false' ) && ( success() || failure() )
run: |
@@ -363,7 +361,7 @@ jobs:
fi
# Create sub-issue for JavaScript lint failures:
- - name: 'Create sub-issue for JavaScript lint failures'
+ - name: "Create sub-issue for JavaScript lint failures"
if: failure() && contains(steps.lint-javascript.outcome, 'failure')
env:
GITHUB_TOKEN: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
@@ -395,7 +393,7 @@ jobs:
rm "$BODY_FILE"
# Lint Python files:
- - name: 'Lint Python files'
+ - name: "Lint Python files"
if: ( github.event.inputs.python != 'false' ) && ( success() || failure() )
run: |
files=$(echo "${{ steps.random-files.outputs.files }}" | tr ',' '\n' | grep -E '\.py$' | tr '\n' ' ')
@@ -408,15 +406,15 @@ jobs:
fi
# Setup R:
- - name: 'Setup R'
+ - name: "Setup R"
if: ( github.event.inputs.r != 'false' ) && ( success() || failure() )
# Pin action to full length commit SHA
uses: r-lib/actions/setup-r@473c68190595b311a74f208fba61a8d8c0d4c247 # v2.11.1
with:
- r-version: '4.3.3'
+ r-version: "4.3.3"
# Lint R files:
- - name: 'Lint R files'
+ - name: "Lint R files"
if: ( github.event.inputs.r != 'false' ) && ( success() || failure() )
run: |
files=$(echo "${{ steps.random-files.outputs.files }}" | tr ',' '\n' | grep -E '\.R$' | tr '\n' ' ')
@@ -429,7 +427,7 @@ jobs:
fi
# Lint C files:
- - name: 'Lint C files'
+ - name: "Lint C files"
id: lint-c
if: ( github.event.inputs.c != 'false' ) && ( success() || failure() )
run: |
@@ -501,7 +499,7 @@ jobs:
fi
# Create sub-issue for C linting failures:
- - name: 'Create sub-issue for C lint failures'
+ - name: "Create sub-issue for C lint failures"
if: ( github.event.inputs.c != 'false' ) && failure() && contains(steps.*.outcome, 'failure') && contains(steps.lint-c.outcome, 'failure')
env:
GITHUB_TOKEN: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
@@ -534,7 +532,7 @@ jobs:
rm "$BODY_FILE"
# Lint TypeScript declarations files:
- - name: 'Lint TypeScript declarations files'
+ - name: "Lint TypeScript declarations files"
if: ( github.event.inputs.javascript != 'false' ) && ( success() || failure() )
run: |
files=$(echo "${{ steps.random-files.outputs.files }}" | tr ',' '\n' | grep -E '\.d\.ts$' | tr '\n' ' ')
@@ -543,7 +541,7 @@ jobs:
fi
# Lint license headers:
- - name: 'Lint license headers'
+ - name: "Lint license headers"
if: success() || failure()
run: |
files=$(echo "${{ steps.random-files.outputs.files }}" | tr ',' ' ')
@@ -552,13 +550,13 @@ jobs:
fi
# Disable Git hooks:
- - name: 'Disable Git hooks'
+ - name: "Disable Git hooks"
if: ${{ github.event.inputs.fix == 'true' }} && ( success() || failure() )
run: |
rm -rf .git/hooks
# Import GPG key to sign commits:
- - name: 'Import GPG key to sign commits'
+ - name: "Import GPG key to sign commits"
if: ${{ github.event.inputs.fix == 'true' }} && ( success() || failure() )
# Pin action to full length commit SHA
uses: crazy-max/ghaction-import-gpg@cb9bde2e2525e640591a934b1fd28eef1dcaf5e5 # v6.2.0
@@ -569,26 +567,26 @@ jobs:
git_commit_gpgsign: true
# Create a pull request with the fixes (if applicable):
- - name: 'Create pull request'
+ - name: "Create pull request"
if: ${{ github.event.inputs.fix == 'true' }} && ( success() || failure() )
id: cpr
# Pin action to full length commit SHA
uses: peter-evans/create-pull-request@67ccf781d68cd99b580ae25a5c18a1cc84ffff1f # v7.0.6
with:
- title: 'style: fix lint errors'
+ title: "style: fix lint errors"
add-paths: ${{ steps.random-files.outputs.files }}
body: |
This PR
- fixes lint errors
- commit-message: 'style: resolve lint errors'
- committer: 'stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>'
+ commit-message: "style: resolve lint errors"
+ committer: "stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>"
signoff: true
token: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
labels: |
automated-pr
team-reviewers: |
reviewers
- branch: 'fix-lint-errors'
+ branch: "fix-lint-errors"
delete-branch: true
diff --git a/.github/workflows/linux_benchmark.yml b/.github/workflows/linux_benchmark.yml
index 1009e17d51e3..1ebb729829fc 100644
--- a/.github/workflows/linux_benchmark.yml
+++ b/.github/workflows/linux_benchmark.yml
@@ -32,7 +32,6 @@ on:
# Workflow concurrency group:
concurrency:
-
# Specify a group name:
group: ${{ github.workflow }}
@@ -46,10 +45,8 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for running benchmarks on Linux...
benchmark:
-
# Define a display name:
name: "Node.js v${{ matrix.NODE_VERSION }}"
@@ -61,15 +58,15 @@ jobs:
# Define environment variables:
env:
- FC: 'gfortran'
- FORTRAN_COMPILER: 'gfortran'
- CC: 'gcc'
- C_COMPILER: 'gcc'
- CXX: 'g++'
- CXX_COMPILER: 'g++'
- LINKER: 'g++'
- GITHUB: 'true'
- DISPLAY: ':99'
+ FC: "gfortran"
+ FORTRAN_COMPILER: "gfortran"
+ CC: "gcc"
+ C_COMPILER: "gcc"
+ CXX: "g++"
+ CXX_COMPILER: "g++"
+ LINKER: "g++"
+ GITHUB: "true"
+ DISPLAY: ":99"
LOG_DIR: "${{ github.workspace }}/tmp/var/log"
LOG_FILE_INSTALL: "${{ github.workspace }}/tmp/var/log/install.log"
LOG_FILE_BUILD_TASK: "${{ github.workspace }}/tmp/var/log/${{ matrix.BUILD_TASK }}.log"
@@ -77,35 +74,33 @@ jobs:
# Define the build matrix strategy...
strategy:
-
# Specify whether to cancel all in-progress jobs if any matrix job fails:
fail-fast: false
# Define the build matrix:
matrix:
-
# Define the list of build tasks:
- BUILD_TASK: ['benchmark']
+ BUILD_TASK: ["benchmark"]
# Define the list of Node.js versions on which to run this job:
- NODE_VERSION: ['16', '14', '12']
+ NODE_VERSION: ["16", "14", "12"]
# Define the list of operating systems on which to run this job:
- OS: ['ubuntu-latest']
+ OS: ["ubuntu-latest"]
# Define configuration options for each Node.js version:
include:
- - OS: 'ubuntu-latest'
- PLATFORM: 'linux'
+ - OS: "ubuntu-latest"
+ PLATFORM: "linux"
- - NODE_VERSION: '16'
- NPM_VERSION: '>2.7.0'
+ - NODE_VERSION: "16"
+ NPM_VERSION: ">2.7.0"
- - NODE_VERSION: '14'
- NPM_VERSION: '>2.7.0'
+ - NODE_VERSION: "14"
+ NPM_VERSION: ">2.7.0"
- - NODE_VERSION: '12'
- NPM_VERSION: '>2.7.0'
+ - NODE_VERSION: "12"
+ NPM_VERSION: ">2.7.0"
# - NODE_VERSION: '10'
# NPM_VERSION: '>2.7.0 <6.0.0'
@@ -133,9 +128,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -150,7 +144,7 @@ jobs:
timeout-minutes: 10
# Initialize log files:
- - name: 'Initialize log files'
+ - name: "Initialize log files"
run: |
mkdir -p "${{ env.LOG_DIR }}"
touch "${{ env.LOG_FILE_INSTALL }}"
@@ -158,7 +152,7 @@ jobs:
timeout-minutes: 2
# Install compilers:
- - name: 'Install compilers'
+ - name: "Install compilers"
run: |
sudo -E apt-add-repository -y "ppa:ubuntu-toolchain-r/test"
sudo -E apt-get update -q
@@ -171,14 +165,14 @@ jobs:
timeout-minutes: 10
# Configure a virtual display server (needed for electron):
- - name: 'Configure virtual display server'
+ - name: "Configure virtual display server"
run: |
sudo apt-get install -y xvfb libxkbcommon-x11-0 libxcb-icccm4 libxcb-image0 libxcb-keysyms1 libxcb-randr0 libxcb-render-util0 libxcb-xinerama0 libxcb-xinput0 libxcb-xfixes0
sudo /usr/bin/Xvfb "${{ env.DISPLAY }}" -screen 0 1280x768x24 > /dev/null 2>&1 &
timeout-minutes: 10
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
@@ -186,7 +180,7 @@ jobs:
timeout-minutes: 5
# Print debug info:
- - name: 'Print debug info'
+ - name: "Print debug info"
run: |
echo 'PATH:'
echo $PATH
@@ -214,20 +208,20 @@ jobs:
timeout-minutes: 2
# Update the npm client (older clients cannot handle scoped modules):
- - name: 'Update npm'
+ - name: "Update npm"
run: |
npm install -g npm@"${{ matrix.NPM_VERSION }}"
npm --version
timeout-minutes: 5
# Perform install sequence:
- - name: 'Perform install sequence'
+ - name: "Perform install sequence"
run: |
. "$GITHUB_WORKSPACE/.github/workflows/scripts/task_runner" install "${{ env.LOG_FILE_INSTALL }}"
timeout-minutes: 30
# View the log file if the previous step fails:
- - name: 'View log file'
+ - name: "View log file"
if: failure()
run: |
echo "Printing the last ${{ env.LOG_NUM_LINES }} lines of log output..."
@@ -235,13 +229,13 @@ jobs:
timeout-minutes: 5
# Run the build task:
- - name: 'Run build task'
+ - name: "Run build task"
run: |
. "$GITHUB_WORKSPACE/.github/workflows/scripts/task_runner" ${{ matrix.BUILD_TASK }} "${{ env.LOG_FILE_BUILD_TASK }}"
timeout-minutes: 360
# View the log file if the previous step fails:
- - name: 'View log file'
+ - name: "View log file"
if: failure()
run: |
echo "Printing the last ${{ env.LOG_NUM_LINES }} lines of log output..."
@@ -249,7 +243,7 @@ jobs:
timeout-minutes: 5
# Upload the log file:
- - name: 'Upload log file'
+ - name: "Upload log file"
# Pin action to full length commit SHA
uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0
if: always()
@@ -266,12 +260,11 @@ jobs:
# Define a job for sending notifications to Slack...
slack:
-
# Define a display name:
- name: 'Slack notification'
+ name: "Slack notification"
# Define the type of virtual host machine:
- runs-on: 'ubuntu-latest'
+ runs-on: "ubuntu-latest"
# Indicate that this job depends on the prior job finishing:
needs: benchmark
@@ -287,9 +280,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Resolve notification data:
- - name: 'Resolve notification data'
+ - name: "Resolve notification data"
run: |
echo 'NOTIFICATION_STATUS=${{ needs.benchmark.result}}' >> $GITHUB_ENV
if [[ "${{ needs.benchmark.result }}" = "success" ]]; then
@@ -307,7 +299,7 @@ jobs:
timeout-minutes: 5
# Send notification to Slack:
- - name: 'Send notification'
+ - name: "Send notification"
# Pin action to full length commit SHA
uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
if: success()
diff --git a/.github/workflows/linux_examples.yml b/.github/workflows/linux_examples.yml
index 43246c05129c..0ad7fe7bb5e8 100644
--- a/.github/workflows/linux_examples.yml
+++ b/.github/workflows/linux_examples.yml
@@ -32,7 +32,6 @@ on:
# Workflow concurrency group:
concurrency:
-
# Specify a group name:
group: ${{ github.workflow }}
@@ -46,10 +45,8 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for running examples on Linux...
examples:
-
# Define a display name:
name: "Node.js v${{ matrix.NODE_VERSION }}"
@@ -61,15 +58,15 @@ jobs:
# Define environment variables:
env:
- FC: 'gfortran'
- FORTRAN_COMPILER: 'gfortran'
- CC: 'gcc'
- C_COMPILER: 'gcc'
- CXX: 'g++'
- CXX_COMPILER: 'g++'
- LINKER: 'g++'
- GITHUB: 'true'
- DISPLAY: ':99'
+ FC: "gfortran"
+ FORTRAN_COMPILER: "gfortran"
+ CC: "gcc"
+ C_COMPILER: "gcc"
+ CXX: "g++"
+ CXX_COMPILER: "g++"
+ LINKER: "g++"
+ GITHUB: "true"
+ DISPLAY: ":99"
LOG_DIR: "${{ github.workspace }}/tmp/var/log"
LOG_FILE_INSTALL: "${{ github.workspace }}/tmp/var/log/install.log"
LOG_FILE_BUILD_TASK: "${{ github.workspace }}/tmp/var/log/${{ matrix.BUILD_TASK }}.log"
@@ -77,35 +74,33 @@ jobs:
# Define the build matrix strategy...
strategy:
-
# Specify whether to cancel all in-progress jobs if any matrix job fails:
fail-fast: false
# Define the build matrix:
matrix:
-
# Define the list of build tasks:
- BUILD_TASK: ['examples']
+ BUILD_TASK: ["examples"]
# Define the list of Node.js versions:
- NODE_VERSION: ['16', '14', '12']
+ NODE_VERSION: ["16", "14", "12"]
# Define the list of operating systems:
- OS: ['ubuntu-latest']
+ OS: ["ubuntu-latest"]
# Define configuration options for each Node.js version:
include:
- - OS: 'ubuntu-latest'
- PLATFORM: 'linux'
+ - OS: "ubuntu-latest"
+ PLATFORM: "linux"
- - NODE_VERSION: '16'
- NPM_VERSION: '>2.7.0'
+ - NODE_VERSION: "16"
+ NPM_VERSION: ">2.7.0"
- - NODE_VERSION: '14'
- NPM_VERSION: '>2.7.0'
+ - NODE_VERSION: "14"
+ NPM_VERSION: ">2.7.0"
- - NODE_VERSION: '12'
- NPM_VERSION: '>2.7.0'
+ - NODE_VERSION: "12"
+ NPM_VERSION: ">2.7.0"
# - NODE_VERSION: '10'
# NPM_VERSION: '>2.7.0 <7.0.0'
@@ -133,9 +128,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -150,7 +144,7 @@ jobs:
timeout-minutes: 10
# Initialize log files:
- - name: 'Initialize log files'
+ - name: "Initialize log files"
run: |
mkdir -p "${{ env.LOG_DIR }}"
touch "${{ env.LOG_FILE_INSTALL }}"
@@ -158,7 +152,7 @@ jobs:
timeout-minutes: 2
# Install compilers:
- - name: 'Install compilers'
+ - name: "Install compilers"
run: |
sudo -E apt-add-repository -y "ppa:ubuntu-toolchain-r/test"
sudo -E apt-get update -q
@@ -171,14 +165,14 @@ jobs:
timeout-minutes: 10
# Configure a virtual display server (needed for electron):
- - name: 'Configure virtual display server'
+ - name: "Configure virtual display server"
run: |
sudo apt-get install -y xvfb libxkbcommon-x11-0 libxcb-icccm4 libxcb-image0 libxcb-keysyms1 libxcb-randr0 libxcb-render-util0 libxcb-xinerama0 libxcb-xinput0 libxcb-xfixes0
sudo /usr/bin/Xvfb "${{ env.DISPLAY }}" -screen 0 1280x768x24 > /dev/null 2>&1 &
timeout-minutes: 10
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
@@ -186,7 +180,7 @@ jobs:
timeout-minutes: 5
# Print debug info:
- - name: 'Print debug info'
+ - name: "Print debug info"
run: |
echo 'PATH:'
echo $PATH
@@ -214,20 +208,20 @@ jobs:
timeout-minutes: 2
# Update the npm client (older clients cannot handle scoped modules):
- - name: 'Update npm'
+ - name: "Update npm"
run: |
npm install -g npm@"${{ matrix.NPM_VERSION }}"
npm --version
timeout-minutes: 5
# Perform install sequence:
- - name: 'Perform install sequence'
+ - name: "Perform install sequence"
run: |
. "$GITHUB_WORKSPACE/.github/workflows/scripts/task_runner" install "${{ env.LOG_FILE_INSTALL }}"
timeout-minutes: 30
# View the log file if the previous step fails:
- - name: 'View log file'
+ - name: "View log file"
if: failure()
run: |
echo "Printing the last ${{ env.LOG_NUM_LINES }} lines of log output..."
@@ -235,13 +229,13 @@ jobs:
timeout-minutes: 5
# Run the build task:
- - name: 'Run build task'
+ - name: "Run build task"
run: |
. "$GITHUB_WORKSPACE/.github/workflows/scripts/task_runner" ${{ matrix.BUILD_TASK }} "${{ env.LOG_FILE_BUILD_TASK }}"
timeout-minutes: 360
# View the log file if the previous step fails:
- - name: 'View log file'
+ - name: "View log file"
if: failure()
run: |
echo "Printing the last ${{ env.LOG_NUM_LINES }} lines of log output..."
@@ -249,7 +243,7 @@ jobs:
timeout-minutes: 5
# Upload the log file:
- - name: 'Upload log file'
+ - name: "Upload log file"
# Pin action to full length commit SHA
uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0
if: always()
@@ -266,12 +260,11 @@ jobs:
# Define a job for sending notifications to Slack...
slack:
-
# Define a display name:
- name: 'Slack notification'
+ name: "Slack notification"
# Define the type of virtual host machine:
- runs-on: 'ubuntu-latest'
+ runs-on: "ubuntu-latest"
# Indicate that this job depends on the prior job finishing:
needs: examples
@@ -287,9 +280,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Resolve notification data:
- - name: 'Resolve notification data'
+ - name: "Resolve notification data"
run: |
echo 'NOTIFICATION_STATUS=${{ needs.examples.result}}' >> $GITHUB_ENV
if [[ "${{ needs.examples.result }}" = "success" ]]; then
@@ -307,7 +299,7 @@ jobs:
timeout-minutes: 5
# Send notification to Slack:
- - name: 'Send notification'
+ - name: "Send notification"
# Pin action to full length commit SHA
uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
if: success()
@@ -319,4 +311,3 @@ jobs:
env:
SLACK_WEBHOOK_URL: ${{ secrets.REPO_SLACK_WEBHOOK_URL }}
timeout-minutes: 5
-
diff --git a/.github/workflows/linux_test.yml b/.github/workflows/linux_test.yml
index 2716dd136fff..4238937913e2 100644
--- a/.github/workflows/linux_test.yml
+++ b/.github/workflows/linux_test.yml
@@ -23,14 +23,13 @@ name: linux_test
on:
# Run nightly:
schedule:
- - cron: '0 9 * * *'
+ - cron: "0 9 * * *"
# Allow the workflow to be manually run:
workflow_dispatch:
# Workflow concurrency group:
concurrency:
-
# Specify a group name:
group: ${{ github.workflow }}
@@ -44,10 +43,8 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for running unit tests on Linux...
test:
-
# Define a display name:
name: "Node.js v${{ matrix.NODE_VERSION }}"
@@ -59,15 +56,15 @@ jobs:
# Define environment variables:
env:
- FC: 'gfortran'
- FORTRAN_COMPILER: 'gfortran'
- CC: 'gcc'
- C_COMPILER: 'gcc'
- CXX: 'g++'
- CXX_COMPILER: 'g++'
- LINKER: 'g++'
- GITHUB: 'true'
- DISPLAY: ':99'
+ FC: "gfortran"
+ FORTRAN_COMPILER: "gfortran"
+ CC: "gcc"
+ C_COMPILER: "gcc"
+ CXX: "g++"
+ CXX_COMPILER: "g++"
+ LINKER: "g++"
+ GITHUB: "true"
+ DISPLAY: ":99"
LOG_DIR: "${{ github.workspace }}/tmp/var/log"
LOG_FILE_INSTALL: "${{ github.workspace }}/tmp/var/log/install.log"
LOG_FILE_BUILD_TASK: "${{ github.workspace }}/tmp/var/log/${{ matrix.BUILD_TASK }}.log"
@@ -75,36 +72,34 @@ jobs:
# Define the build matrix strategy...
strategy:
-
# Specify whether to cancel all in-progress jobs if any matrix job fails:
fail-fast: false
# Define the build matrix:
matrix:
-
# Define the list of build tasks:
- BUILD_TASK: ['test']
+ BUILD_TASK: ["test"]
# Define the list of Node.js versions on which to run this job:
# NODE_VERSION: ['16', '14', '12', '10', '8', '6', '4', '0.12', '0.10']
- NODE_VERSION: ['16', '14', '12']
+ NODE_VERSION: ["16", "14", "12"]
# Define the list of operating systems on which to run this job:
- OS: ['ubuntu-latest']
+ OS: ["ubuntu-latest"]
# Define configuration options for each Node.js version:
include:
- - OS: 'ubuntu-latest'
- PLATFORM: 'linux'
+ - OS: "ubuntu-latest"
+ PLATFORM: "linux"
- - NODE_VERSION: '16'
- NPM_VERSION: '>2.7.0'
+ - NODE_VERSION: "16"
+ NPM_VERSION: ">2.7.0"
- - NODE_VERSION: '14'
- NPM_VERSION: '>2.7.0'
+ - NODE_VERSION: "14"
+ NPM_VERSION: ">2.7.0"
- - NODE_VERSION: '12'
- NPM_VERSION: '>2.7.0'
+ - NODE_VERSION: "12"
+ NPM_VERSION: ">2.7.0"
# - NODE_VERSION: '10'
# NPM_VERSION: '>2.7.0 <7.0.0'
@@ -132,9 +127,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -149,7 +143,7 @@ jobs:
timeout-minutes: 10
# Initialize log files:
- - name: 'Initialize log files'
+ - name: "Initialize log files"
run: |
mkdir -p "${{ env.LOG_DIR }}"
touch "${{ env.LOG_FILE_INSTALL }}"
@@ -157,7 +151,7 @@ jobs:
timeout-minutes: 2
# Install compilers:
- - name: 'Install compilers'
+ - name: "Install compilers"
run: |
sudo -E apt-add-repository -y "ppa:ubuntu-toolchain-r/test"
sudo -E apt-get update -q
@@ -170,14 +164,14 @@ jobs:
timeout-minutes: 10
# Configure a virtual display server (needed for electron):
- - name: 'Configure virtual display server'
+ - name: "Configure virtual display server"
run: |
sudo apt-get install -y xvfb libxkbcommon-x11-0 libxcb-icccm4 libxcb-image0 libxcb-keysyms1 libxcb-randr0 libxcb-render-util0 libxcb-xinerama0 libxcb-xinput0 libxcb-xfixes0
sudo /usr/bin/Xvfb "${{ env.DISPLAY }}" -screen 0 1280x768x24 > /dev/null 2>&1 &
timeout-minutes: 10
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
@@ -185,7 +179,7 @@ jobs:
timeout-minutes: 5
# Print debug info:
- - name: 'Print debug info'
+ - name: "Print debug info"
run: |
echo 'PATH:'
echo $PATH
@@ -213,20 +207,20 @@ jobs:
timeout-minutes: 2
# Update the npm client (older clients cannot handle scoped modules):
- - name: 'Update npm'
+ - name: "Update npm"
run: |
npm install -g npm@"${{ matrix.NPM_VERSION }}"
npm --version
timeout-minutes: 5
# Perform install sequence:
- - name: 'Perform install sequence'
+ - name: "Perform install sequence"
run: |
. "$GITHUB_WORKSPACE/.github/workflows/scripts/task_runner" install "${{ env.LOG_FILE_INSTALL }}"
timeout-minutes: 30
# View the log file if the previous step fails:
- - name: 'View log file'
+ - name: "View log file"
if: failure()
run: |
echo "Printing the last ${{ env.LOG_NUM_LINES }} lines of log output..."
@@ -234,13 +228,13 @@ jobs:
timeout-minutes: 5
# Run the build task:
- - name: 'Run build task'
+ - name: "Run build task"
run: |
. "$GITHUB_WORKSPACE/.github/workflows/scripts/task_runner" ${{ matrix.BUILD_TASK }} "${{ env.LOG_FILE_BUILD_TASK }}"
timeout-minutes: 360
# View the log file if the previous step fails:
- - name: 'View log file'
+ - name: "View log file"
if: failure()
run: |
echo "Printing the last ${{ env.LOG_NUM_LINES }} lines of log output..."
@@ -248,7 +242,7 @@ jobs:
timeout-minutes: 5
# Upload the log file:
- - name: 'Upload log file'
+ - name: "Upload log file"
# Pin action to full length commit SHA
uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0
if: always()
@@ -265,12 +259,11 @@ jobs:
# Define a job for sending notifications to Slack...
slack:
-
# Define a display name:
- name: 'Slack notification'
+ name: "Slack notification"
# Define the type of virtual host machine:
- runs-on: 'ubuntu-latest'
+ runs-on: "ubuntu-latest"
# Indicate that this job depends on the prior job finishing:
needs: test
@@ -286,9 +279,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Resolve notification data:
- - name: 'Resolve notification data'
+ - name: "Resolve notification data"
run: |
echo 'NOTIFICATION_STATUS=${{ needs.test.result}}' >> $GITHUB_ENV
if [[ "${{ needs.test.result }}" = "success" ]]; then
@@ -306,7 +298,7 @@ jobs:
timeout-minutes: 5
# Send notification to Slack:
- - name: 'Send notification'
+ - name: "Send notification"
# Pin action to full length commit SHA
uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
if: success()
diff --git a/.github/workflows/linux_test_cov.yml b/.github/workflows/linux_test_cov.yml
index 513d2d4b1012..1ca94cf586e9 100644
--- a/.github/workflows/linux_test_cov.yml
+++ b/.github/workflows/linux_test_cov.yml
@@ -32,7 +32,6 @@ on:
# Workflow concurrency group:
concurrency:
-
# Specify a group name:
group: ${{ github.workflow }}
@@ -46,10 +45,8 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for determining test coverage on Linux...
test_cov:
-
# Define a display name:
name: "Node.js v${{ matrix.NODE_VERSION }}"
@@ -61,15 +58,15 @@ jobs:
# Define environment variables:
env:
- FC: 'gfortran'
- FORTRAN_COMPILER: 'gfortran'
- CC: 'gcc'
- C_COMPILER: 'gcc'
- CXX: 'g++'
- CXX_COMPILER: 'g++'
- LINKER: 'g++'
- GITHUB: 'true'
- DISPLAY: ':99'
+ FC: "gfortran"
+ FORTRAN_COMPILER: "gfortran"
+ CC: "gcc"
+ C_COMPILER: "gcc"
+ CXX: "g++"
+ CXX_COMPILER: "g++"
+ LINKER: "g++"
+ GITHUB: "true"
+ DISPLAY: ":99"
LOG_DIR: "${{ github.workspace }}/tmp/var/log"
LOG_FILE_INSTALL: "${{ github.workspace }}/tmp/var/log/install.log"
LOG_FILE_BUILD_TASK: "${{ github.workspace }}/tmp/var/log/${{ matrix.BUILD_TASK }}.log"
@@ -77,35 +74,33 @@ jobs:
# Define the build matrix strategy...
strategy:
-
# Specify whether to cancel all in-progress jobs if any matrix job fails:
fail-fast: false
# Define the build matrix:
matrix:
-
# Define the list of build tasks:
- BUILD_TASK: ['test-coverage']
+ BUILD_TASK: ["test-coverage"]
# Define the list of Node.js versions on which to run this job:
- NODE_VERSION: ['16', '14', '12']
+ NODE_VERSION: ["16", "14", "12"]
# Define the list of operating systems on which to run this job:
- OS: ['ubuntu-latest']
+ OS: ["ubuntu-latest"]
# Define configuration options for each Node.js version:
include:
- - OS: 'ubuntu-latest'
- PLATFORM: 'linux'
+ - OS: "ubuntu-latest"
+ PLATFORM: "linux"
- - NODE_VERSION: '16'
- NPM_VERSION: '>2.7.0'
+ - NODE_VERSION: "16"
+ NPM_VERSION: ">2.7.0"
- - NODE_VERSION: '14'
- NPM_VERSION: '>2.7.0'
+ - NODE_VERSION: "14"
+ NPM_VERSION: ">2.7.0"
- - NODE_VERSION: '12'
- NPM_VERSION: '>2.7.0'
+ - NODE_VERSION: "12"
+ NPM_VERSION: ">2.7.0"
# - NODE_VERSION: '10'
# NPM_VERSION: '>2.7.0 <7.0.0'
@@ -133,9 +128,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -150,7 +144,7 @@ jobs:
timeout-minutes: 10
# Initialize log files:
- - name: 'Initialize log files'
+ - name: "Initialize log files"
run: |
mkdir -p "${{ env.LOG_DIR }}"
touch "${{ env.LOG_FILE_INSTALL }}"
@@ -158,7 +152,7 @@ jobs:
timeout-minutes: 2
# Install compilers:
- - name: 'Install compilers'
+ - name: "Install compilers"
run: |
sudo -E apt-add-repository -y "ppa:ubuntu-toolchain-r/test"
sudo -E apt-get update -q
@@ -171,14 +165,14 @@ jobs:
timeout-minutes: 10
# Configure a virtual display server (needed for electron):
- - name: 'Configure virtual display server'
+ - name: "Configure virtual display server"
run: |
sudo apt-get install -y xvfb libxkbcommon-x11-0 libxcb-icccm4 libxcb-image0 libxcb-keysyms1 libxcb-randr0 libxcb-render-util0 libxcb-xinerama0 libxcb-xinput0 libxcb-xfixes0
sudo /usr/bin/Xvfb "${{ env.DISPLAY }}" -screen 0 1280x768x24 > /dev/null 2>&1 &
timeout-minutes: 10
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
@@ -186,7 +180,7 @@ jobs:
timeout-minutes: 5
# Print debug info:
- - name: 'Print debug info'
+ - name: "Print debug info"
run: |
echo 'PATH:'
echo $PATH
@@ -214,20 +208,20 @@ jobs:
timeout-minutes: 2
# Update the npm client (older clients cannot handle scoped modules):
- - name: 'Update npm'
+ - name: "Update npm"
run: |
npm install -g npm@"${{ matrix.NPM_VERSION }}"
npm --version
timeout-minutes: 5
# Perform install sequence:
- - name: 'Perform install sequence'
+ - name: "Perform install sequence"
run: |
. "$GITHUB_WORKSPACE/.github/workflows/scripts/task_runner" install "${{ env.LOG_FILE_INSTALL }}"
timeout-minutes: 30
# View the log file if the previous step fails:
- - name: 'View log file'
+ - name: "View log file"
if: failure()
run: |
echo "Printing the last ${{ env.LOG_NUM_LINES }} lines of log output..."
@@ -235,13 +229,13 @@ jobs:
timeout-minutes: 5
# Run the build task:
- - name: 'Run build task'
+ - name: "Run build task"
run: |
. "$GITHUB_WORKSPACE/.github/workflows/scripts/task_runner" ${{ matrix.BUILD_TASK }} "${{ env.LOG_FILE_BUILD_TASK }}"
timeout-minutes: 360
# View the log file if the previous step fails:
- - name: 'View log file'
+ - name: "View log file"
if: failure()
run: |
echo "Printing the last ${{ env.LOG_NUM_LINES }} lines of log output..."
@@ -249,7 +243,7 @@ jobs:
timeout-minutes: 5
# Upload the log file:
- - name: 'Upload log file'
+ - name: "Upload log file"
# Pin action to full length commit SHA
uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0
if: always()
@@ -266,12 +260,11 @@ jobs:
# Define a job for sending notifications to Slack...
slack:
-
# Define a display name:
- name: 'Slack notification'
+ name: "Slack notification"
# Define the type of virtual host machine:
- runs-on: 'ubuntu-latest'
+ runs-on: "ubuntu-latest"
# Indicate that this job depends on the prior job finishing:
needs: test_cov
@@ -287,9 +280,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Resolve notification data:
- - name: 'Resolve notification data'
+ - name: "Resolve notification data"
run: |
echo 'NOTIFICATION_STATUS=${{ needs.test_cov.result}}' >> $GITHUB_ENV
if [[ "${{ needs.test_cov.result }}" = "success" ]]; then
@@ -307,7 +299,7 @@ jobs:
timeout-minutes: 5
# Send notification to Slack:
- - name: 'Send notification'
+ - name: "Send notification"
# Pin action to full length commit SHA
uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
if: success()
@@ -319,4 +311,3 @@ jobs:
env:
SLACK_WEBHOOK_URL: ${{ secrets.REPO_SLACK_WEBHOOK_URL }}
timeout-minutes: 5
-
diff --git a/.github/workflows/linux_test_install.yml b/.github/workflows/linux_test_install.yml
index 2b7937cbd58c..b346769402c2 100644
--- a/.github/workflows/linux_test_install.yml
+++ b/.github/workflows/linux_test_install.yml
@@ -23,14 +23,13 @@ name: linux_test_install
on:
# Run nightly:
schedule:
- - cron: '0 9 * * *'
+ - cron: "0 9 * * *"
# Allow the workflow to be manually run:
workflow_dispatch:
# Workflow concurrency group:
concurrency:
-
# Specify a group name:
group: ${{ github.workflow }}
@@ -44,10 +43,8 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for testing project installation on Linux...
test_install:
-
# Define a display name:
name: "Node.js v${{ matrix.NODE_VERSION }} - ${{ matrix.PACKAGE_MANAGER }}"
@@ -59,15 +56,15 @@ jobs:
# Define environment variables:
env:
- FC: 'gfortran'
- FORTRAN_COMPILER: 'gfortran'
- CC: 'gcc'
- C_COMPILER: 'gcc'
- CXX: 'g++'
- CXX_COMPILER: 'g++'
- LINKER: 'g++'
- GITHUB: 'true'
- DISPLAY: ':99'
+ FC: "gfortran"
+ FORTRAN_COMPILER: "gfortran"
+ CC: "gcc"
+ C_COMPILER: "gcc"
+ CXX: "g++"
+ CXX_COMPILER: "g++"
+ LINKER: "g++"
+ GITHUB: "true"
+ DISPLAY: ":99"
INSTALL_DIR: "${{ github.workspace }}/test-install"
LOG_DIR: "${{ github.workspace }}/tmp/var/log"
LOG_FILE_BUILD_TASK: "${{ github.workspace }}/tmp/var/log/${{ matrix.BUILD_TASK }}.log"
@@ -75,85 +72,83 @@ jobs:
# Define the build matrix strategy...
strategy:
-
# Specify whether to cancel all in-progress jobs if any matrix job fails:
fail-fast: false
# Define the build matrix:
matrix:
-
# Define the list of build tasks:
- BUILD_TASK: ['test-install']
+ BUILD_TASK: ["test-install"]
# Define the list of Node.js versions on which to run this job:
- NODE_VERSION: ['20', '18', '16'] # ['20', '18', '16', '14', '12', '10', '8', '6', '4', '0.12', '0.10']
+ NODE_VERSION: ["20", "18", "16"] # ['20', '18', '16', '14', '12', '10', '8', '6', '4', '0.12', '0.10']
# Define the list of package managers to test:
- PACKAGE_MANAGER: ['npm']
+ PACKAGE_MANAGER: ["npm"]
# Define the list of operating systems on which to run this job:
- OS: ['ubuntu-latest']
+ OS: ["ubuntu-latest"]
# Define configuration options for each Node.js version:
include:
- - OS: 'ubuntu-latest'
- PLATFORM: 'linux'
+ - OS: "ubuntu-latest"
+ PLATFORM: "linux"
- - NODE_VERSION: '20'
- NPM_VERSION: '>10.0.0'
- PNPM_VERSION: '6'
+ - NODE_VERSION: "20"
+ NPM_VERSION: ">10.0.0"
+ PNPM_VERSION: "6"
- - NODE_VERSION: '18'
- NPM_VERSION: '>10.0.0'
- PNPM_VERSION: '6'
+ - NODE_VERSION: "18"
+ NPM_VERSION: ">10.0.0"
+ PNPM_VERSION: "6"
- - NODE_VERSION: '16'
- NPM_VERSION: '>2.7.0 <10.0.0'
- PNPM_VERSION: '6'
+ - NODE_VERSION: "16"
+ NPM_VERSION: ">2.7.0 <10.0.0"
+ PNPM_VERSION: "6"
- - NODE_VERSION: '14'
- NPM_VERSION: '>2.7.0 <10.0.0'
- PNPM_VERSION: '6'
+ - NODE_VERSION: "14"
+ NPM_VERSION: ">2.7.0 <10.0.0"
+ PNPM_VERSION: "6"
- - NODE_VERSION: '12'
- NPM_VERSION: '>2.7.0 <9.0.0'
- PNPM_VERSION: '6'
+ - NODE_VERSION: "12"
+ NPM_VERSION: ">2.7.0 <9.0.0"
+ PNPM_VERSION: "6"
- - NODE_VERSION: '10'
- NPM_VERSION: '>2.7.0 <7.0.0'
- PNPM_VERSION: '5'
+ - NODE_VERSION: "10"
+ NPM_VERSION: ">2.7.0 <7.0.0"
+ PNPM_VERSION: "5"
- - NODE_VERSION: '8'
- NPM_VERSION: '>2.7.0 <6.0.0'
- PNPM_VERSION: '3'
+ - NODE_VERSION: "8"
+ NPM_VERSION: ">2.7.0 <6.0.0"
+ PNPM_VERSION: "3"
- - NODE_VERSION: '6'
- NPM_VERSION: '>2.7.0 <6.0.0'
- PNPM_VERSION: '2'
+ - NODE_VERSION: "6"
+ NPM_VERSION: ">2.7.0 <6.0.0"
+ PNPM_VERSION: "2"
- - NODE_VERSION: '4'
- NPM_VERSION: '>2.7.0 <6.0.0'
- PNPM_VERSION: '1'
+ - NODE_VERSION: "4"
+ NPM_VERSION: ">2.7.0 <6.0.0"
+ PNPM_VERSION: "1"
- - NODE_VERSION: '0.12'
- NPM_VERSION: '>2.7.0 <4.0.0'
+ - NODE_VERSION: "0.12"
+ NPM_VERSION: ">2.7.0 <4.0.0"
- - NODE_VERSION: '0.10'
- NPM_VERSION: '>2.7.0 <4.0.0'
+ - NODE_VERSION: "0.10"
+ NPM_VERSION: ">2.7.0 <4.0.0"
# Exclude certain matrix combinations:
exclude:
- - NODE_VERSION: '0.12'
- PACKAGE_MANAGER: 'pnpm'
+ - NODE_VERSION: "0.12"
+ PACKAGE_MANAGER: "pnpm"
- - NODE_VERSION: '0.12'
- PACKAGE_MANAGER: 'yarn'
+ - NODE_VERSION: "0.12"
+ PACKAGE_MANAGER: "yarn"
- - NODE_VERSION: '0.10'
- PACKAGE_MANAGER: 'pnpm'
+ - NODE_VERSION: "0.10"
+ PACKAGE_MANAGER: "pnpm"
- - NODE_VERSION: '0.10'
- PACKAGE_MANAGER: 'yarn'
+ - NODE_VERSION: "0.10"
+ PACKAGE_MANAGER: "yarn"
# Set defaults:
defaults:
@@ -163,9 +158,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -180,14 +174,14 @@ jobs:
timeout-minutes: 10
# Initialize log files:
- - name: 'Initialize log files'
+ - name: "Initialize log files"
run: |
mkdir -p "${{ env.LOG_DIR }}"
touch "${{ env.LOG_FILE_BUILD_TASK }}"
timeout-minutes: 2
# Install compilers:
- - name: 'Install compilers'
+ - name: "Install compilers"
run: |
sudo -E apt-add-repository -y "ppa:ubuntu-toolchain-r/test"
sudo -E apt-get update -q
@@ -200,14 +194,14 @@ jobs:
timeout-minutes: 10
# Configure a virtual display server (needed for electron):
- - name: 'Configure virtual display server'
+ - name: "Configure virtual display server"
run: |
sudo apt-get install -y xvfb libxkbcommon-x11-0 libxcb-icccm4 libxcb-image0 libxcb-keysyms1 libxcb-randr0 libxcb-render-util0 libxcb-xinerama0 libxcb-xinput0 libxcb-xfixes0
sudo /usr/bin/Xvfb "${{ env.DISPLAY }}" -screen 0 1280x768x24 > /dev/null 2>&1 &
timeout-minutes: 10
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
@@ -215,7 +209,7 @@ jobs:
timeout-minutes: 5
# Configure Git:
- - name: 'Configure Git'
+ - name: "Configure Git"
# Force Git to use HTTPS rather than SSH:
run: |
@@ -223,7 +217,7 @@ jobs:
git config --global url."https://".insteadOf git://
# Print debug info:
- - name: 'Print debug info'
+ - name: "Print debug info"
run: |
echo 'PATH:'
echo $PATH
@@ -251,20 +245,20 @@ jobs:
timeout-minutes: 2
# Update the npm client (older clients cannot handle scoped modules):
- - name: 'Update npm'
+ - name: "Update npm"
run: |
npm install -g npm@"${{ matrix.NPM_VERSION }}"
npm --version
timeout-minutes: 5
# Run the build task:
- - name: 'Run build task'
+ - name: "Run build task"
run: |
. "$GITHUB_WORKSPACE/.github/workflows/scripts/test_install" "${{ matrix.PACKAGE_MANAGER }}" "${{ env.INSTALL_DIR }}" "${{ env.LOG_FILE_BUILD_TASK }}"
timeout-minutes: 360
# View the log file if the previous step fails:
- - name: 'View log file'
+ - name: "View log file"
if: failure()
run: |
echo "Printing the last ${{ env.LOG_NUM_LINES }} lines of log output..."
@@ -272,7 +266,7 @@ jobs:
timeout-minutes: 5
# Upload the log file:
- - name: 'Upload log file'
+ - name: "Upload log file"
# Pin action to full length commit SHA
uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0
if: always()
@@ -289,12 +283,11 @@ jobs:
# Define a job for sending notifications to Slack...
slack:
-
# Define a display name:
- name: 'Slack notification'
+ name: "Slack notification"
# Define the type of virtual host machine:
- runs-on: 'ubuntu-latest'
+ runs-on: "ubuntu-latest"
# Indicate that this job depends on the prior job finishing:
needs: test_install
@@ -310,9 +303,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Resolve notification data:
- - name: 'Resolve notification data'
+ - name: "Resolve notification data"
run: |
echo 'NOTIFICATION_STATUS=${{ needs.test_install.result}}' >> $GITHUB_ENV
if [[ "${{ needs.test_install.result }}" = "success" ]]; then
@@ -330,7 +322,7 @@ jobs:
timeout-minutes: 5
# Send notification to Slack:
- - name: 'Send notification'
+ - name: "Send notification"
# Pin action to full length commit SHA
uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
if: success()
diff --git a/.github/workflows/macos_benchmark.yml b/.github/workflows/macos_benchmark.yml
index 13fd5b82386d..56b85de0d634 100644
--- a/.github/workflows/macos_benchmark.yml
+++ b/.github/workflows/macos_benchmark.yml
@@ -32,7 +32,6 @@ on:
# Workflow concurrency group:
concurrency:
-
# Specify a group name:
group: ${{ github.workflow }}
@@ -46,10 +45,8 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for running benchmarks on macOS...
benchmark:
-
# Define a display name:
name: "Node.js v${{ matrix.NODE_VERSION }}"
@@ -61,14 +58,14 @@ jobs:
# Define environment variables:
env:
- FC: 'gfortran'
- FORTRAN_COMPILER: 'gfortran'
- CC: 'gcc'
- C_COMPILER: 'gcc'
- CXX: 'g++'
- CXX_COMPILER: 'g++'
- LINKER: 'g++'
- GITHUB: 'true'
+ FC: "gfortran"
+ FORTRAN_COMPILER: "gfortran"
+ CC: "gcc"
+ C_COMPILER: "gcc"
+ CXX: "g++"
+ CXX_COMPILER: "g++"
+ LINKER: "g++"
+ GITHUB: "true"
LOG_DIR: "${{ github.workspace }}/tmp/var/log"
LOG_FILE_INSTALL: "${{ github.workspace }}/tmp/var/log/install.log"
LOG_FILE_BUILD_TASK: "${{ github.workspace }}/tmp/var/log/${{ matrix.BUILD_TASK }}.log"
@@ -76,35 +73,33 @@ jobs:
# Define the build matrix strategy...
strategy:
-
# Specify whether to cancel all in-progress jobs if any matrix job fails:
fail-fast: false
# Define the build matrix:
matrix:
-
# Define the list of build tasks:
- BUILD_TASK: ['benchmark']
+ BUILD_TASK: ["benchmark"]
# Define the list of Node.js versions:
- NODE_VERSION: ['16', '14', '12']
+ NODE_VERSION: ["16", "14", "12"]
# Define the list of operating systems:
- OS: ['macOS-latest']
+ OS: ["macOS-latest"]
# Define configuration options for each Node.js version:
include:
- - OS: 'macOS-latest'
- PLATFORM: 'macos'
+ - OS: "macOS-latest"
+ PLATFORM: "macos"
- - NODE_VERSION: '16'
- NPM_VERSION: '>2.7.0'
+ - NODE_VERSION: "16"
+ NPM_VERSION: ">2.7.0"
- - NODE_VERSION: '14'
- NPM_VERSION: '>2.7.0'
+ - NODE_VERSION: "14"
+ NPM_VERSION: ">2.7.0"
- - NODE_VERSION: '12'
- NPM_VERSION: '>2.7.0'
+ - NODE_VERSION: "12"
+ NPM_VERSION: ">2.7.0"
# - NODE_VERSION: '10'
# NPM_VERSION: '>2.7.0 <7.0.0'
@@ -132,9 +127,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -149,7 +143,7 @@ jobs:
timeout-minutes: 10
# Initialize log files:
- - name: 'Initialize log files'
+ - name: "Initialize log files"
run: |
mkdir -p "${{ env.LOG_DIR }}"
touch "${{ env.LOG_FILE_INSTALL }}"
@@ -157,14 +151,14 @@ jobs:
timeout-minutes: 2
# Install compilers:
- - name: 'Install compilers'
+ - name: "Install compilers"
run: |
brew update
brew reinstall gcc
timeout-minutes: 10
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
@@ -172,7 +166,7 @@ jobs:
timeout-minutes: 5
# Print debug info:
- - name: 'Print debug info'
+ - name: "Print debug info"
run: |
echo 'PATH:'
echo $PATH
@@ -200,20 +194,20 @@ jobs:
timeout-minutes: 2
# Update the npm client (older clients cannot handle scoped modules):
- - name: 'Update npm'
+ - name: "Update npm"
run: |
npm install -g npm@"${{ matrix.NPM_VERSION }}"
npm --version
timeout-minutes: 5
# Perform install sequence:
- - name: 'Perform install sequence'
+ - name: "Perform install sequence"
run: |
. "$GITHUB_WORKSPACE/.github/workflows/scripts/task_runner" install "${{ env.LOG_FILE_INSTALL }}"
timeout-minutes: 30
# View the log file if the previous step fails:
- - name: 'View log file'
+ - name: "View log file"
if: failure()
run: |
echo "Printing the last ${{ env.LOG_NUM_LINES }} lines of log output..."
@@ -221,13 +215,13 @@ jobs:
timeout-minutes: 5
# Run the build task:
- - name: 'Run build task'
+ - name: "Run build task"
run: |
. "$GITHUB_WORKSPACE/.github/workflows/scripts/task_runner" ${{ matrix.BUILD_TASK }} "${{ env.LOG_FILE_BUILD_TASK }}"
timeout-minutes: 360
# View the log file if the previous step fails:
- - name: 'View log file'
+ - name: "View log file"
if: failure()
run: |
echo "Printing the last ${{ env.LOG_NUM_LINES }} lines of log output..."
@@ -235,7 +229,7 @@ jobs:
timeout-minutes: 5
# Upload the log file:
- - name: 'Upload log file'
+ - name: "Upload log file"
# Pin action to full length commit SHA
uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0
if: always()
@@ -252,12 +246,11 @@ jobs:
# Define a job for sending notifications to Slack...
slack:
-
# Define a display name:
- name: 'Slack notification'
+ name: "Slack notification"
# Define the type of virtual host machine:
- runs-on: 'ubuntu-latest'
+ runs-on: "ubuntu-latest"
# Indicate that this job depends on the prior job finishing:
needs: benchmark
@@ -273,9 +266,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Resolve notification data:
- - name: 'Resolve notification data'
+ - name: "Resolve notification data"
run: |
echo 'NOTIFICATION_STATUS=${{ needs.benchmark.result}}' >> $GITHUB_ENV
if [[ "${{ needs.benchmark.result }}" = "success" ]]; then
@@ -293,7 +285,7 @@ jobs:
timeout-minutes: 5
# Send notification to Slack:
- - name: 'Send notification'
+ - name: "Send notification"
# Pin action to full length commit SHA
uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
if: success()
diff --git a/.github/workflows/macos_test.yml b/.github/workflows/macos_test.yml
index c4e8d898a33e..e3be03c2b7f7 100644
--- a/.github/workflows/macos_test.yml
+++ b/.github/workflows/macos_test.yml
@@ -23,14 +23,13 @@ name: macos_test
on:
# Run nightly:
schedule:
- - cron: '0 9 * * *'
+ - cron: "0 9 * * *"
# Allow the workflow to be manually run:
workflow_dispatch:
# Workflow concurrency group:
concurrency:
-
# Specify a group name:
group: ${{ github.workflow }}
@@ -44,10 +43,8 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for running unit tests on macOS...
test:
-
# Define a display name:
name: "Node.js v${{ matrix.NODE_VERSION }}"
@@ -59,14 +56,14 @@ jobs:
# Define environment variables:
env:
- FC: 'gfortran'
- FORTRAN_COMPILER: 'gfortran'
- CC: 'gcc'
- C_COMPILER: 'gcc'
- CXX: 'g++'
- CXX_COMPILER: 'g++'
- LINKER: 'g++'
- GITHUB: 'true'
+ FC: "gfortran"
+ FORTRAN_COMPILER: "gfortran"
+ CC: "gcc"
+ C_COMPILER: "gcc"
+ CXX: "g++"
+ CXX_COMPILER: "g++"
+ LINKER: "g++"
+ GITHUB: "true"
LOG_DIR: "${{ github.workspace }}/tmp/var/log"
LOG_FILE_INSTALL: "${{ github.workspace }}/tmp/var/log/install.log"
LOG_FILE_BUILD_TASK: "${{ github.workspace }}/tmp/var/log/${{ matrix.BUILD_TASK }}.log"
@@ -74,36 +71,34 @@ jobs:
# Define the build matrix strategy...
strategy:
-
# Specify whether to cancel all in-progress jobs if any matrix job fails:
fail-fast: false
# Define the build matrix:
matrix:
-
# Define the list of build tasks:
- BUILD_TASK: ['test']
+ BUILD_TASK: ["test"]
# Define the list of Node.js versions:
# NODE_VERSION: ['16', '14', '12', '10', '8', '6', '4', '0.12', '0.10']
- NODE_VERSION: ['16', '14', '12']
+ NODE_VERSION: ["16", "14", "12"]
# Define the list of operating systems:
- OS: ['macOS-latest']
+ OS: ["macOS-latest"]
# Define configuration options for each Node.js version:
include:
- - OS: 'macOS-latest'
- PLATFORM: 'macos'
+ - OS: "macOS-latest"
+ PLATFORM: "macos"
- - NODE_VERSION: '16'
- NPM_VERSION: '>2.7.0'
+ - NODE_VERSION: "16"
+ NPM_VERSION: ">2.7.0"
- - NODE_VERSION: '14'
- NPM_VERSION: '>2.7.0'
+ - NODE_VERSION: "14"
+ NPM_VERSION: ">2.7.0"
- - NODE_VERSION: '12'
- NPM_VERSION: '>2.7.0'
+ - NODE_VERSION: "12"
+ NPM_VERSION: ">2.7.0"
# - NODE_VERSION: '10'
# NPM_VERSION: '>2.7.0 <7.0.0'
@@ -131,9 +126,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -148,7 +142,7 @@ jobs:
timeout-minutes: 10
# Initialize log files:
- - name: 'Initialize log files'
+ - name: "Initialize log files"
run: |
mkdir -p "${{ env.LOG_DIR }}"
touch "${{ env.LOG_FILE_INSTALL }}"
@@ -156,14 +150,14 @@ jobs:
timeout-minutes: 2
# Install compilers:
- - name: 'Install compilers'
+ - name: "Install compilers"
run: |
brew update
brew reinstall gcc
timeout-minutes: 10
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
@@ -171,7 +165,7 @@ jobs:
timeout-minutes: 5
# Print debug info:
- - name: 'Print debug info'
+ - name: "Print debug info"
run: |
echo 'PATH:'
echo $PATH
@@ -199,20 +193,20 @@ jobs:
timeout-minutes: 2
# Update the npm client (older clients cannot handle scoped modules):
- - name: 'Update npm'
+ - name: "Update npm"
run: |
npm install -g npm@"${{ matrix.NPM_VERSION }}"
npm --version
timeout-minutes: 5
# Perform install sequence:
- - name: 'Perform install sequence'
+ - name: "Perform install sequence"
run: |
. "$GITHUB_WORKSPACE/.github/workflows/scripts/task_runner" install "${{ env.LOG_FILE_INSTALL }}"
timeout-minutes: 30
# View the log file if the previous step fails:
- - name: 'View log file'
+ - name: "View log file"
if: failure()
run: |
echo "Printing the last ${{ env.LOG_NUM_LINES }} lines of log output..."
@@ -220,13 +214,13 @@ jobs:
timeout-minutes: 5
# Run the build task:
- - name: 'Run build task'
+ - name: "Run build task"
run: |
. "$GITHUB_WORKSPACE/.github/workflows/scripts/task_runner" ${{ matrix.BUILD_TASK }} "${{ env.LOG_FILE_BUILD_TASK }}"
timeout-minutes: 360
# View the log file if the previous step fails:
- - name: 'View log file'
+ - name: "View log file"
if: failure()
run: |
echo "Printing the last ${{ env.LOG_NUM_LINES }} lines of log output..."
@@ -234,7 +228,7 @@ jobs:
timeout-minutes: 5
# Upload the log file:
- - name: 'Upload log file'
+ - name: "Upload log file"
# Pin action to full length commit SHA
uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0
if: always()
@@ -251,12 +245,11 @@ jobs:
# Define a job for sending notifications to Slack...
slack:
-
# Define a display name:
- name: 'Slack notification'
+ name: "Slack notification"
# Define the type of virtual host machine:
- runs-on: 'ubuntu-latest'
+ runs-on: "ubuntu-latest"
# Indicate that this job depends on the prior job finishing:
needs: test
@@ -272,9 +265,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Resolve notification data:
- - name: 'Resolve notification data'
+ - name: "Resolve notification data"
run: |
echo 'NOTIFICATION_STATUS=${{ needs.test.result}}' >> $GITHUB_ENV
if [[ "${{ needs.test.result }}" = "success" ]]; then
@@ -292,7 +284,7 @@ jobs:
timeout-minutes: 5
# Send notification to Slack:
- - name: 'Send notification'
+ - name: "Send notification"
# Pin action to full length commit SHA
uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
if: success()
diff --git a/.github/workflows/macos_test_cov.yml b/.github/workflows/macos_test_cov.yml
index 0104d22afafa..5726ddfa5188 100644
--- a/.github/workflows/macos_test_cov.yml
+++ b/.github/workflows/macos_test_cov.yml
@@ -32,7 +32,6 @@ on:
# Workflow concurrency group:
concurrency:
-
# Specify a group name:
group: ${{ github.workflow }}
@@ -46,10 +45,8 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for determining test coverage on macOS...
test_cov:
-
# Define a display name:
name: "Node.js v${{ matrix.NODE_VERSION }}"
@@ -61,14 +58,14 @@ jobs:
# Define environment variables:
env:
- FC: 'gfortran'
- FORTRAN_COMPILER: 'gfortran'
- CC: 'gcc'
- C_COMPILER: 'gcc'
- CXX: 'g++'
- CXX_COMPILER: 'g++'
- LINKER: 'g++'
- GITHUB: 'true'
+ FC: "gfortran"
+ FORTRAN_COMPILER: "gfortran"
+ CC: "gcc"
+ C_COMPILER: "gcc"
+ CXX: "g++"
+ CXX_COMPILER: "g++"
+ LINKER: "g++"
+ GITHUB: "true"
LOG_DIR: "${{ github.workspace }}/tmp/var/log"
LOG_FILE_INSTALL: "${{ github.workspace }}/tmp/var/log/install.log"
LOG_FILE_BUILD_TASK: "${{ github.workspace }}/tmp/var/log/${{ matrix.BUILD_TASK }}.log"
@@ -76,35 +73,33 @@ jobs:
# Define the build matrix strategy...
strategy:
-
# Specify whether to cancel all in-progress jobs if any matrix job fails:
fail-fast: false
# Define the build matrix:
matrix:
-
# Define the list of build tasks:
- BUILD_TASK: ['test-coverage']
+ BUILD_TASK: ["test-coverage"]
# Define the list of Node.js versions:
- NODE_VERSION: ['16', '14', '12']
+ NODE_VERSION: ["16", "14", "12"]
# Define the list of operating systems:
- OS: ['macOS-latest']
+ OS: ["macOS-latest"]
# Define configuration options for each Node.js version:
include:
- - OS: 'macOS-latest'
- PLATFORM: 'macos'
+ - OS: "macOS-latest"
+ PLATFORM: "macos"
- - NODE_VERSION: '16'
- NPM_VERSION: '>2.7.0'
+ - NODE_VERSION: "16"
+ NPM_VERSION: ">2.7.0"
- - NODE_VERSION: '14'
- NPM_VERSION: '>2.7.0'
+ - NODE_VERSION: "14"
+ NPM_VERSION: ">2.7.0"
- - NODE_VERSION: '12'
- NPM_VERSION: '>2.7.0'
+ - NODE_VERSION: "12"
+ NPM_VERSION: ">2.7.0"
# - NODE_VERSION: '10'
# NPM_VERSION: '>2.7.0 <7.0.0'
@@ -132,9 +127,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -149,7 +143,7 @@ jobs:
timeout-minutes: 10
# Initialize log files:
- - name: 'Initialize log files'
+ - name: "Initialize log files"
run: |
mkdir -p "${{ env.LOG_DIR }}"
touch "${{ env.LOG_FILE_INSTALL }}"
@@ -157,14 +151,14 @@ jobs:
timeout-minutes: 2
# Install compilers:
- - name: 'Install compilers'
+ - name: "Install compilers"
run: |
brew update
brew reinstall gcc
timeout-minutes: 10
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
@@ -172,7 +166,7 @@ jobs:
timeout-minutes: 5
# Print debug info:
- - name: 'Print debug info'
+ - name: "Print debug info"
run: |
echo 'PATH:'
echo $PATH
@@ -200,20 +194,20 @@ jobs:
timeout-minutes: 2
# Update the npm client (older clients cannot handle scoped modules):
- - name: 'Update npm'
+ - name: "Update npm"
run: |
npm install -g npm@"${{ matrix.NPM_VERSION }}"
npm --version
timeout-minutes: 5
# Perform install sequence:
- - name: 'Perform install sequence'
+ - name: "Perform install sequence"
run: |
. "$GITHUB_WORKSPACE/.github/workflows/scripts/task_runner" install "${{ env.LOG_FILE_INSTALL }}"
timeout-minutes: 30
# View the log file if the previous step fails:
- - name: 'View log file'
+ - name: "View log file"
if: failure()
run: |
echo "Printing the last ${{ env.LOG_NUM_LINES }} lines of log output..."
@@ -221,13 +215,13 @@ jobs:
timeout-minutes: 5
# Run the build task:
- - name: 'Run build task'
+ - name: "Run build task"
run: |
. "$GITHUB_WORKSPACE/.github/workflows/scripts/task_runner" ${{ matrix.BUILD_TASK }} "${{ env.LOG_FILE_BUILD_TASK }}"
timeout-minutes: 360
# View the log file if the previous step fails:
- - name: 'View log file'
+ - name: "View log file"
if: failure()
run: |
echo "Printing the last ${{ env.LOG_NUM_LINES }} lines of log output..."
@@ -235,7 +229,7 @@ jobs:
timeout-minutes: 5
# Upload the log file:
- - name: 'Upload log file'
+ - name: "Upload log file"
# Pin action to full length commit SHA
uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0
if: always()
@@ -252,12 +246,11 @@ jobs:
# Define a job for sending notifications to Slack...
slack:
-
# Define a display name:
- name: 'Slack notification'
+ name: "Slack notification"
# Define the type of virtual host machine:
- runs-on: 'ubuntu-latest'
+ runs-on: "ubuntu-latest"
# Indicate that this job depends on the prior job finishing:
needs: test_cov
@@ -273,9 +266,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Resolve notification data:
- - name: 'Resolve notification data'
+ - name: "Resolve notification data"
run: |
echo 'NOTIFICATION_STATUS=${{ needs.test_cov.result}}' >> $GITHUB_ENV
if [[ "${{ needs.test_cov.result }}" = "success" ]]; then
@@ -293,7 +285,7 @@ jobs:
timeout-minutes: 5
# Send notification to Slack:
- - name: 'Send notification'
+ - name: "Send notification"
# Pin action to full length commit SHA
uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
if: success()
diff --git a/.github/workflows/macos_test_npm_install.yml b/.github/workflows/macos_test_npm_install.yml
index 2fa732ae3fad..4a4b8ff45b2b 100644
--- a/.github/workflows/macos_test_npm_install.yml
+++ b/.github/workflows/macos_test_npm_install.yml
@@ -23,14 +23,13 @@ name: macos_test_npm_install
on:
# Run nightly:
schedule:
- - cron: '0 9 * * *'
+ - cron: "0 9 * * *"
# Allow the workflow to be manually run:
workflow_dispatch:
# Workflow concurrency group:
concurrency:
-
# Specify a group name:
group: ${{ github.workflow }}
@@ -44,10 +43,8 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for testing project installation on macOS...
test_npm_install:
-
# Define a display name:
name: "Node.js v${{ matrix.NODE_VERSION }}"
@@ -59,73 +56,71 @@ jobs:
# Define environment variables:
env:
- FC: 'gfortran'
- FORTRAN_COMPILER: 'gfortran'
- CC: 'gcc'
- C_COMPILER: 'gcc'
- CXX: 'g++'
- CXX_COMPILER: 'g++'
- LINKER: 'g++'
- GITHUB: 'true'
+ FC: "gfortran"
+ FORTRAN_COMPILER: "gfortran"
+ CC: "gcc"
+ C_COMPILER: "gcc"
+ CXX: "g++"
+ CXX_COMPILER: "g++"
+ LINKER: "g++"
+ GITHUB: "true"
LOG_DIR: "${{ github.workspace }}/tmp/var/log"
LOG_FILE_BUILD_TASK: "${{ github.workspace }}/tmp/var/log/${{ matrix.BUILD_TASK }}.log"
LOG_NUM_LINES: 5000
# Define the build matrix strategy...
strategy:
-
# Specify whether to cancel all in-progress jobs if any matrix job fails:
fail-fast: false
# Define the build matrix:
matrix:
-
# Define the list of build tasks:
- BUILD_TASK: ['test-npm-install']
+ BUILD_TASK: ["test-npm-install"]
# Define the list of Node.js versions:
- NODE_VERSION: ['20', '18', '16']
+ NODE_VERSION: ["20", "18", "16"]
# Define the list of operating systems:
- OS: ['macOS-latest']
+ OS: ["macOS-latest"]
# Define configuration options for each Node.js version:
include:
- - OS: 'macOS-latest'
- PLATFORM: 'macos'
+ - OS: "macOS-latest"
+ PLATFORM: "macos"
- - NODE_VERSION: '20'
- NPM_VERSION: '>10.0.0'
+ - NODE_VERSION: "20"
+ NPM_VERSION: ">10.0.0"
- - NODE_VERSION: '18'
- NPM_VERSION: '>10.0.0'
+ - NODE_VERSION: "18"
+ NPM_VERSION: ">10.0.0"
- - NODE_VERSION: '16'
- NPM_VERSION: '>2.7.0 <10.0.0'
+ - NODE_VERSION: "16"
+ NPM_VERSION: ">2.7.0 <10.0.0"
- - NODE_VERSION: '14'
- NPM_VERSION: '>2.7.0 <10.0.0'
+ - NODE_VERSION: "14"
+ NPM_VERSION: ">2.7.0 <10.0.0"
- - NODE_VERSION: '12'
- NPM_VERSION: '>2.7.0 <9.0.0'
+ - NODE_VERSION: "12"
+ NPM_VERSION: ">2.7.0 <9.0.0"
- - NODE_VERSION: '10'
- NPM_VERSION: '>2.7.0 <7.0.0'
+ - NODE_VERSION: "10"
+ NPM_VERSION: ">2.7.0 <7.0.0"
- - NODE_VERSION: '8'
- NPM_VERSION: '>2.7.0 <6.0.0'
+ - NODE_VERSION: "8"
+ NPM_VERSION: ">2.7.0 <6.0.0"
- - NODE_VERSION: '6'
- NPM_VERSION: '>2.7.0 <6.0.0'
+ - NODE_VERSION: "6"
+ NPM_VERSION: ">2.7.0 <6.0.0"
- - NODE_VERSION: '4'
- NPM_VERSION: '>2.7.0 <6.0.0'
+ - NODE_VERSION: "4"
+ NPM_VERSION: ">2.7.0 <6.0.0"
- - NODE_VERSION: '0.12'
- NPM_VERSION: '>2.7.0 <4.0.0'
+ - NODE_VERSION: "0.12"
+ NPM_VERSION: ">2.7.0 <4.0.0"
- - NODE_VERSION: '0.10'
- NPM_VERSION: '>2.7.0 <4.0.0'
+ - NODE_VERSION: "0.10"
+ NPM_VERSION: ">2.7.0 <4.0.0"
# Set defaults:
defaults:
@@ -135,9 +130,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -152,21 +146,21 @@ jobs:
timeout-minutes: 10
# Initialize log files:
- - name: 'Initialize log files'
+ - name: "Initialize log files"
run: |
mkdir -p "${{ env.LOG_DIR }}"
touch "${{ env.LOG_FILE_BUILD_TASK }}"
timeout-minutes: 2
# Install compilers:
- - name: 'Install compilers'
+ - name: "Install compilers"
run: |
brew update
brew reinstall gcc
timeout-minutes: 10
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
@@ -174,7 +168,7 @@ jobs:
timeout-minutes: 5
# Configure Git:
- - name: 'Configure Git'
+ - name: "Configure Git"
# Force Git to use HTTPS rather than SSH:
run: |
@@ -182,7 +176,7 @@ jobs:
git config --global url."https://".insteadOf git://
# Print debug info:
- - name: 'Print debug info'
+ - name: "Print debug info"
run: |
echo 'PATH:'
echo $PATH
@@ -210,20 +204,20 @@ jobs:
timeout-minutes: 2
# Update the npm client (older clients cannot handle scoped modules):
- - name: 'Update npm'
+ - name: "Update npm"
run: |
npm install -g npm@"${{ matrix.NPM_VERSION }}"
npm --version
timeout-minutes: 5
# Run the build task:
- - name: 'Run build task'
+ - name: "Run build task"
run: |
. "$GITHUB_WORKSPACE/.github/workflows/scripts/task_runner" ${{ matrix.BUILD_TASK }} "${{ env.LOG_FILE_BUILD_TASK }}"
timeout-minutes: 360
# View the log file if the previous step fails:
- - name: 'View log file'
+ - name: "View log file"
if: failure()
run: |
echo "Printing the last ${{ env.LOG_NUM_LINES }} lines of log output..."
@@ -231,7 +225,7 @@ jobs:
timeout-minutes: 5
# Upload the log file:
- - name: 'Upload log file'
+ - name: "Upload log file"
# Pin action to full length commit SHA
uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0
if: always()
@@ -248,12 +242,11 @@ jobs:
# Define a job for sending notifications to Slack...
slack:
-
# Define a display name:
- name: 'Slack notification'
+ name: "Slack notification"
# Define the type of virtual host machine:
- runs-on: 'ubuntu-latest'
+ runs-on: "ubuntu-latest"
# Indicate that this job depends on the prior job finishing:
needs: test_npm_install
@@ -269,9 +262,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Resolve notification data:
- - name: 'Resolve notification data'
+ - name: "Resolve notification data"
run: |
echo 'NOTIFICATION_STATUS=${{ needs.test_npm_install.result}}' >> $GITHUB_ENV
if [[ "${{ needs.test_npm_install.result }}" = "success" ]]; then
@@ -289,7 +281,7 @@ jobs:
timeout-minutes: 5
# Send notification to Slack:
- - name: 'Send notification'
+ - name: "Send notification"
# Pin action to full length commit SHA
uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
if: success()
diff --git a/.github/workflows/make.yml b/.github/workflows/make.yml
index f6a6c9b8bbb3..c1f8459c692d 100644
--- a/.github/workflows/make.yml
+++ b/.github/workflows/make.yml
@@ -38,21 +38,18 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for running make commands...
run-make:
-
# Define a display name:
- name: 'Run make command'
+ name: "Run make command"
# Define the type of virtual host machine:
runs-on: ubuntu-latest
# Define the sequence of job steps...
steps:
-
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -70,27 +67,27 @@ jobs:
timeout-minutes: 10
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
- node-version: '20' # 'lts/*'
+ node-version: "20" # 'lts/*'
timeout-minutes: 5
# Install dependencies (accounting for possible network failures, etc, when installing node module dependencies):
- - name: 'Install dependencies'
+ - name: "Install dependencies"
run: |
make install-node-modules || make install-node-modules || make install-node-modules
timeout-minutes: 15
# Initialize development environment:
- - name: 'Initialize development environment'
+ - name: "Initialize development environment"
run: |
make init
timeout-minutes: 5
# Run the make command:
- - name: 'Run make command'
+ - name: "Run make command"
run: |
${{ github.event.inputs.env }} make ${{ github.event.inputs.command }}
timeout-minutes: 5
diff --git a/.github/workflows/markdown_equations.yml b/.github/workflows/markdown_equations.yml
index 9b119e9f1268..bdb94a52a872 100644
--- a/.github/workflows/markdown_equations.yml
+++ b/.github/workflows/markdown_equations.yml
@@ -23,7 +23,7 @@ name: markdown_equations
on:
schedule:
# Run the workflow once a day at 2:00 AM UTC:
- - cron: '0 2 * * *'
+ - cron: "0 2 * * *"
# Allow the workflow to be manually run:
workflow_dispatch:
@@ -35,12 +35,10 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for updating equations in Markdown files...
update:
-
# Define a display name:
- name: 'Update equations'
+ name: "Update equations"
# Ensure the job does not run on forks:
if: github.repository == 'stdlib-js/stdlib'
@@ -50,9 +48,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -70,34 +67,34 @@ jobs:
timeout-minutes: 10
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
- node-version: '20' # 'lts/*'
+ node-version: "20" # 'lts/*'
timeout-minutes: 5
# Install dependencies (accounting for possible network failures, etc, when installing node module dependencies):
- - name: 'Install dependencies'
+ - name: "Install dependencies"
run: |
make install-node-modules || make install-node-modules || make install-node-modules
timeout-minutes: 15
# Initialize development environment:
- - name: 'Initialize development environment'
+ - name: "Initialize development environment"
run: |
make init
timeout-minutes: 5
# Configure Git:
- - name: 'Configure Git'
+ - name: "Configure Git"
run: |
git config --local user.email "82920195+stdlib-bot@users.noreply.github.com"
git config --local user.name "stdlib-bot"
timeout-minutes: 5
# Import GPG key to sign commits:
- - name: 'Import GPG key to sign commits'
+ - name: "Import GPG key to sign commits"
# Pin action to full length commit SHA
uses: crazy-max/ghaction-import-gpg@cb9bde2e2525e640591a934b1fd28eef1dcaf5e5 # v6.2.0
with:
@@ -107,13 +104,13 @@ jobs:
git_commit_gpgsign: true
# Generate list of changed Markdown files:
- - name: 'Find changed Markdown files'
+ - name: "Find changed Markdown files"
run: |
echo "files=$(git diff --name-only ${{ github.event.pull_request.base.sha }} ${{ github.sha }} -G '<equation' | grep .md | tr '\n' ' ')" >> $GITHUB_OUTPUT
id: changed
# Generate SVG equations:
- - name: 'Generate SVG equations'
+ - name: "Generate SVG equations"
id: svg-equations
run: |
make markdown-svg-equations-files FILES="${{ steps.changed.outputs.files }}"
@@ -130,7 +127,7 @@ jobs:
timeout-minutes: 15
# Update Markdown equation elements:
- - name: 'Update equation elements'
+ - name: "Update equation elements"
id: equation-elements
run: |
make markdown-img-equations-files FILES="${{ steps.changed.outputs.files }}"
@@ -148,20 +145,20 @@ jobs:
timeout-minutes: 15
# Create a pull request with the updated equations:
- - name: 'Create pull request'
+ - name: "Create pull request"
id: cpr
if: steps.svg-equations.outputs.changed == 'true' || steps.equation-elements.outputs.changed == 'true'
# Pin action to full length commit SHA
uses: peter-evans/create-pull-request@67ccf781d68cd99b580ae25a5c18a1cc84ffff1f # v7.0.6
with:
- title: 'docs: update Markdown equation elements'
+ title: "docs: update Markdown equation elements"
body: |
This PR
- updates equation elements found in Markdown files
- commit-message: 'docs: update Markdown equation elements'
- committer: 'stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>'
+ commit-message: "docs: update Markdown equation elements"
+ committer: "stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>"
signoff: true
token: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
labels: |
@@ -173,7 +170,7 @@ jobs:
delete-branch: true
# Create Markdown summary of the pull request:
- - name: 'Create summary'
+ - name: "Create summary"
if: steps.svg-equations.outputs.changed == 'true' || steps.equation-elements.outputs.changed == 'true'
run: |
echo "# :tada: Pull Request created! :tada:" >> $GITHUB_STEP_SUMMARY
diff --git a/.github/workflows/markdown_links.yml b/.github/workflows/markdown_links.yml
index 2b3b1b097f8b..b0b9cb5fb13f 100644
--- a/.github/workflows/markdown_links.yml
+++ b/.github/workflows/markdown_links.yml
@@ -23,7 +23,7 @@ name: markdown_links
on:
schedule:
# Run the workflow once a month on the 1st day of every month:
- - cron: '0 0 1 * *'
+ - cron: "0 0 1 * *"
# Allow the workflow to be manually run:
workflow_dispatch:
@@ -35,12 +35,10 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for detecting broken links in Markdown files...
markdown_links:
-
# Define a display name:
- name: 'Check links'
+ name: "Check links"
# Ensure the job does not run on forks:
if: github.repository == 'stdlib-js/stdlib'
@@ -62,9 +60,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -82,7 +79,7 @@ jobs:
timeout-minutes: 10
# Initialize log files:
- - name: 'Initialize log files'
+ - name: "Initialize log files"
run: |
mkdir -p "${{ env.LOG_DIR }}"
touch "${{ env.LOG_FILE_FAILURES }}"
@@ -90,7 +87,7 @@ jobs:
timeout-minutes: 2
# Check for broken links:
- - name: 'Check links'
+ - name: "Check links"
uses: stdlib-js/check-markdown-link-definitions-action@main
id: results
with:
@@ -98,27 +95,27 @@ jobs:
timeout-minutes: 240
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
- node-version: '20' # 'lts/*'
+ node-version: "20" # 'lts/*'
timeout-minutes: 5
# Install dependencies (accounting for possible network failures, etc, when installing node module dependencies):
- - name: 'Install dependencies'
+ - name: "Install dependencies"
run: |
make install-node-modules || make install-node-modules || make install-node-modules
timeout-minutes: 15
# Initialize development environment:
- - name: 'Initialize development environment'
+ - name: "Initialize development environment"
run: |
make init
timeout-minutes: 5
# Check whether links are included in `docs/links/database.json` and use the correct identifier:
- - name: 'Check links against database'
+ - name: "Check links against database"
run: |
# Determine root directory:
root=$(git rev-parse --show-toplevel)
@@ -141,20 +138,20 @@ jobs:
fi
# Log the results:
- - name: 'Log results'
+ - name: "Log results"
run: |
echo ${{ steps.results.outputs.failures }} >> "${{ env.LOG_FILE_FAILURES }}"
echo ${{ steps.results.outputs.warnings }} >> "${{ env.LOG_FILE_WARNINGS }}"
timeout-minutes: 2
# Fail the workflow if the status is not "success":
- - name: 'Check status'
+ - name: "Check status"
if: ${{ steps.results.outputs.status }} != 'success'
run: |
exit 1
# View the log file if the previous step fails:
- - name: 'View log file'
+ - name: "View log file"
if: failure()
run: |
echo "Printing the list of failures..."
@@ -162,7 +159,7 @@ jobs:
timeout-minutes: 5
# Upload the log files:
- - name: 'Upload log files'
+ - name: "Upload log files"
# Pin action to full length commit SHA
uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0
if: always()
@@ -181,12 +178,11 @@ jobs:
# Define a job for sending notifications to Slack...
slack:
-
# Define a display name:
- name: 'Slack notification'
+ name: "Slack notification"
# Define the type of virtual host machine:
- runs-on: 'ubuntu-latest'
+ runs-on: "ubuntu-latest"
# Indicate that this job depends on the prior job finishing:
needs: markdown_links
@@ -202,9 +198,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Resolve notification data:
- - name: 'Resolve notification data'
+ - name: "Resolve notification data"
run: |
echo 'NOTIFICATION_STATUS=${{ needs.markdown_links.result}}' >> $GITHUB_ENV
if [[ "${{ needs.markdown_links.result }}" = "success" ]]; then
@@ -222,7 +217,7 @@ jobs:
timeout-minutes: 5
# Send notification to Slack:
- - name: 'Send notification'
+ - name: "Send notification"
# Pin action to full length commit SHA
uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
if: success()
diff --git a/.github/workflows/markdown_pkg_urls.yml b/.github/workflows/markdown_pkg_urls.yml
index b9064a5004c3..c00b1e064446 100644
--- a/.github/workflows/markdown_pkg_urls.yml
+++ b/.github/workflows/markdown_pkg_urls.yml
@@ -23,7 +23,7 @@ name: markdown_pkg_urls
on:
schedule:
# Run the workflow once a day at 2:00 AM UTC:
- - cron: '0 2 * * *'
+ - cron: "0 2 * * *"
# Allow the workflow to be manually run:
workflow_dispatch:
@@ -35,12 +35,10 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for updating Markdown stdlib package URLs...
markdown_pkg_urls:
-
# Define a display name:
- name: 'Update Markdown stdlib package URLs'
+ name: "Update Markdown stdlib package URLs"
# Ensure the job does not run on forks:
if: github.repository == 'stdlib-js/stdlib'
@@ -56,9 +54,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -77,39 +74,39 @@ jobs:
timeout-minutes: 10
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
- node-version: '20' # 'lts/*'
+ node-version: "20" # 'lts/*'
timeout-minutes: 5
# Install dependencies (accounting for possible network failures, etc, when installing node module dependencies):
- - name: 'Install dependencies'
+ - name: "Install dependencies"
run: |
make install-node-modules || make install-node-modules || make install-node-modules
timeout-minutes: 15
# Initialize development environment:
- - name: 'Initialize development environment'
+ - name: "Initialize development environment"
run: |
make init
timeout-minutes: 5
# Configure Git:
- - name: 'Configure Git'
+ - name: "Configure Git"
run: |
git config --local user.email "82920195+stdlib-bot@users.noreply.github.com"
git config --local user.name "stdlib-bot"
timeout-minutes: 5
# Disable Git hooks:
- - name: 'Disable Git hooks'
+ - name: "Disable Git hooks"
run: |
rm -rf .git/hooks
# Import GPG key to sign commits:
- - name: 'Import GPG key to sign commits'
+ - name: "Import GPG key to sign commits"
# Pin action to full length commit SHA
uses: crazy-max/ghaction-import-gpg@cb9bde2e2525e640591a934b1fd28eef1dcaf5e5 # v6.2.0
with:
@@ -119,7 +116,7 @@ jobs:
git_commit_gpgsign: true
# Update Markdown stdlib package URLs:
- - name: 'Update Markdown stdlib package URLs'
+ - name: "Update Markdown stdlib package URLs"
id: update-markdown-pkg-urls
run: |
make markdown-pkg-urls MARKDOWN_FILTER='.*/lib/node_modules/@stdlib/.*'
@@ -136,20 +133,20 @@ jobs:
timeout-minutes: 10
# Create a pull request with the changes:
- - name: 'Create pull request'
+ - name: "Create pull request"
id: cpr
if: steps.update-markdown-pkg-urls.outputs.changed == 'true'
# Pin action to full length commit SHA
uses: peter-evans/create-pull-request@67ccf781d68cd99b580ae25a5c18a1cc84ffff1f # v7.0.6
with:
- title: 'docs: update Markdown stdlib package URLs'
+ title: "docs: update Markdown stdlib package URLs"
body: |
This PR
- updates Markdown files by resolving stdlib package identifiers to GitHub repository URLs.
- commit-message: 'docs: update Markdown stdlib package URLs'
- committer: 'stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>'
+ commit-message: "docs: update Markdown stdlib package URLs"
+ committer: "stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>"
signoff: true
token: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
labels: |
diff --git a/.github/workflows/markdown_related_packages.yml b/.github/workflows/markdown_related_packages.yml
index 0e83b751a9c9..0982bc8884f4 100644
--- a/.github/workflows/markdown_related_packages.yml
+++ b/.github/workflows/markdown_related_packages.yml
@@ -26,12 +26,12 @@ on:
inputs:
num:
type: string
- description: 'Number of READMEs to process'
- default: '250'
+ description: "Number of READMEs to process"
+ default: "250"
schedule:
# Run the workflow once a day at 2:00 AM UTC:
- - cron: '0 2 * * *'
+ - cron: "0 2 * * *"
# Global permissions:
permissions:
@@ -40,12 +40,10 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for updating the related packages section of READMEs:
update:
-
# Define a display name:
- name: 'Update related packages section of READMEs'
+ name: "Update related packages section of READMEs"
# Ensure the job does not run on forks:
if: github.repository == 'stdlib-js/stdlib'
@@ -56,7 +54,7 @@ jobs:
# Define the sequence of job steps...
steps:
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -74,39 +72,39 @@ jobs:
timeout-minutes: 10
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
- node-version: '20' # 'lts/*'
+ node-version: "20" # 'lts/*'
timeout-minutes: 5
# Install dependencies (accounting for possible network failures, etc, when installing node module dependencies):
- - name: 'Install dependencies'
+ - name: "Install dependencies"
run: |
make install-node-modules || make install-node-modules || make install-node-modules
timeout-minutes: 15
# Initialize development environment:
- - name: 'Initialize development environment'
+ - name: "Initialize development environment"
run: |
make init
timeout-minutes: 5
# Configure Git:
- - name: 'Configure Git'
+ - name: "Configure Git"
run: |
git config --local user.email "82920195+stdlib-bot@users.noreply.github.com"
git config --local user.name "stdlib-bot"
timeout-minutes: 5
# Disable Git hooks:
- - name: 'Disable Git hooks'
+ - name: "Disable Git hooks"
run: |
rm -rf .git/hooks
# Import GPG key to sign commits:
- - name: 'Import GPG key to sign commits'
+ - name: "Import GPG key to sign commits"
# Pin action to full length commit SHA
uses: crazy-max/ghaction-import-gpg@cb9bde2e2525e640591a934b1fd28eef1dcaf5e5 # v6.2.0
with:
@@ -116,7 +114,7 @@ jobs:
git_commit_gpgsign: true
# Pick random READMEs from the `lib/node_modules/@stdlib` directory:
- - name: 'Pick random READMEs from the `lib/node_modules/@stdlib` directory'
+ - name: "Pick random READMEs from the `lib/node_modules/@stdlib` directory"
id: random-readmes
run: |
command="find lib/node_modules/@stdlib -type f -name 'README.md' |
@@ -128,7 +126,7 @@ jobs:
echo "readmes=$readmes" >> $GITHUB_OUTPUT
# Update READMEs:
- - name: 'Update READMEs'
+ - name: "Update READMEs"
id: update-related-packages
run: |
files=$(echo "${{ steps.random-readmes.outputs.readmes }}" | tr ',' ' ')
@@ -147,20 +145,20 @@ jobs:
timeout-minutes: 10
# Create a pull request with the changes:
- - name: 'Create pull request'
+ - name: "Create pull request"
id: cpr
if: steps.update-related-packages.outputs.changed == 'true'
# Pin action to full length commit SHA
uses: peter-evans/create-pull-request@67ccf781d68cd99b580ae25a5c18a1cc84ffff1f # v7.0.6
with:
- title: 'docs: update related packages sections'
+ title: "docs: update related packages sections"
body: |
This PR
- updates the related packages section of READMEs to include links to related packages.
- commit-message: 'docs: update related packages sections'
- committer: 'stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>'
+ commit-message: "docs: update related packages sections"
+ committer: "stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>"
signoff: true
token: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
labels: |
diff --git a/.github/workflows/markdown_src_attributes.yml b/.github/workflows/markdown_src_attributes.yml
index 133898b95c61..1483e138e60e 100644
--- a/.github/workflows/markdown_src_attributes.yml
+++ b/.github/workflows/markdown_src_attributes.yml
@@ -23,7 +23,7 @@ name: markdown_src_attributes
on:
schedule:
# Run the workflow once a month on the 1st day of every month:
- - cron: '0 0 1 * *'
+ - cron: "0 0 1 * *"
# Allow the workflow to be manually run:
workflow_dispatch:
@@ -35,12 +35,10 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for detecting broken `src` in Markdown files...
markdown_src_attributes:
-
# Define a display name:
- name: 'Check `src` attribute URLs'
+ name: "Check `src` attribute URLs"
# Define the type of virtual host machine:
runs-on: ubuntu-latest
@@ -59,9 +57,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -79,7 +76,7 @@ jobs:
timeout-minutes: 10
# Initialize log files:
- - name: 'Initialize log files'
+ - name: "Initialize log files"
run: |
mkdir -p "${{ env.LOG_DIR }}"
touch "${{ env.LOG_FILE_FAILURES }}"
@@ -87,7 +84,7 @@ jobs:
timeout-minutes: 2
# Check for broken `src` attribute URLs:
- - name: 'Check `src` attribute URLs'
+ - name: "Check `src` attribute URLs"
# Pin action to full length commit SHA
uses: stdlib-js/check-markdown-src-action@9d9c0883b8c06a04576a146e480ef7937c51cdbf # v2.0.1
id: results
@@ -96,20 +93,20 @@ jobs:
timeout-minutes: 120
# Log the results:
- - name: 'Log results'
+ - name: "Log results"
run: |
echo ${{ steps.results.outputs.failures }} >> "${{ env.LOG_FILE_FAILURES }}"
echo ${{ steps.results.outputs.warnings }} >> "${{ env.LOG_FILE_WARNINGS }}"
timeout-minutes: 2
# Fail the workflow if the status is not "success":
- - name: 'Check status'
+ - name: "Check status"
if: ${{ steps.results.outputs.status }} != 'success'
run: |
exit 1
# View the log file if the previous step fails:
- - name: 'View log file'
+ - name: "View log file"
if: failure()
run: |
echo "Printing the list of failures..."
@@ -117,7 +114,7 @@ jobs:
timeout-minutes: 5
# Upload the log files:
- - name: 'Upload log files'
+ - name: "Upload log files"
# Pin action to full length commit SHA
uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0
if: always()
@@ -136,12 +133,11 @@ jobs:
# Define a job for sending notifications to Slack...
slack:
-
# Define a display name:
- name: 'Slack notification'
+ name: "Slack notification"
# Define the type of virtual host machine:
- runs-on: 'ubuntu-latest'
+ runs-on: "ubuntu-latest"
# Indicate that this job depends on the prior job finishing:
needs: markdown_src_attributes
@@ -157,9 +153,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Resolve notification data:
- - name: 'Resolve notification data'
+ - name: "Resolve notification data"
run: |
echo 'NOTIFICATION_STATUS=${{ needs.markdown_src_attributes.result}}' >> $GITHUB_ENV
if [[ "${{ needs.markdown_src_attributes.result }}" = "success" ]]; then
@@ -177,7 +172,7 @@ jobs:
timeout-minutes: 5
# Send notification to Slack:
- - name: 'Send notification'
+ - name: "Send notification"
# Pin action to full length commit SHA
uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
if: success()
diff --git a/.github/workflows/markdown_tocs.yml b/.github/workflows/markdown_tocs.yml
index 951c5d52aa8f..c03b7e068e46 100644
--- a/.github/workflows/markdown_tocs.yml
+++ b/.github/workflows/markdown_tocs.yml
@@ -23,7 +23,7 @@ name: markdown_tocs
on:
schedule:
# Run the workflow once a day at 2:00 AM UTC:
- - cron: '0 2 * * *'
+ - cron: "0 2 * * *"
# Allow the workflow to be manually run:
workflow_dispatch:
@@ -35,12 +35,10 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for updating namespace table of contents...
update:
-
# Define a display name:
- name: 'Update namespace ToCs'
+ name: "Update namespace ToCs"
# Ensure the job does not run on forks:
if: github.repository == 'stdlib-js/stdlib'
@@ -50,9 +48,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -70,45 +67,45 @@ jobs:
timeout-minutes: 10
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
- node-version: '20' # 'lts/*'
+ node-version: "20" # 'lts/*'
timeout-minutes: 5
# Install dependencies (accounting for possible network failures, etc, when installing node module dependencies):
- - name: 'Install dependencies'
+ - name: "Install dependencies"
run: |
make install-node-modules || make install-node-modules || make install-node-modules
timeout-minutes: 15
# Initialize development environment:
- - name: 'Initialize development environment'
+ - name: "Initialize development environment"
run: |
make init
timeout-minutes: 5
# Generate list of namespace READMEs:
- - name: 'Generate list of namespace READMEs'
+ - name: "Generate list of namespace READMEs"
run: |
echo "files=$( make list-pkgs-namespace-readmes | tr '\n' ' ' )" >> $GITHUB_OUTPUT
id: namespace_files
# Update namespace table of contents:
- - name: 'Update tables of contents'
+ - name: "Update tables of contents"
run: |
make markdown-namespace-tocs-files FILES="${{ steps.namespace_files.outputs.files }}"
make markdown-pkg-urls-files FILES="${{ steps.namespace_files.outputs.files }}"
timeout-minutes: 60
# Disable Git hooks:
- - name: 'Disable Git hooks'
+ - name: "Disable Git hooks"
run: |
rm -rf .git/hooks
# Import GPG key to sign commits:
- - name: 'Import GPG key to sign commits'
+ - name: "Import GPG key to sign commits"
# Pin action to full length commit SHA
uses: crazy-max/ghaction-import-gpg@cb9bde2e2525e640591a934b1fd28eef1dcaf5e5 # v6.2.0
with:
@@ -118,20 +115,20 @@ jobs:
git_commit_gpgsign: true
# Create a pull request with the updated tables of contents:
- - name: 'Create pull request'
+ - name: "Create pull request"
id: cpr
# Pin action to full length commit SHA
uses: peter-evans/create-pull-request@67ccf781d68cd99b580ae25a5c18a1cc84ffff1f # v7.0.6
with:
- title: 'docs: update namespace table of contents'
+ title: "docs: update namespace table of contents"
body: |
This PR
- updates namespace table of contents
- commit-message: 'docs: update namespace table of contents'
+ commit-message: "docs: update namespace table of contents"
signoff: true
- committer: 'stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>'
+ committer: "stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>"
token: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
labels: |
documentation
@@ -142,7 +139,7 @@ jobs:
delete-branch: true
# Create Markdown summary of the pull request:
- - name: 'Create summary'
+ - name: "Create summary"
run: |
echo "# :tada: Pull Request created! :tada:" >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
diff --git a/.github/workflows/namespace_declarations.yml b/.github/workflows/namespace_declarations.yml
index 246c16bc5b09..21db733a6882 100644
--- a/.github/workflows/namespace_declarations.yml
+++ b/.github/workflows/namespace_declarations.yml
@@ -23,7 +23,7 @@ name: namespace_declarations
on:
schedule:
# Run the workflow once a day at 2:00 AM UTC:
- - cron: '0 2 * * *'
+ - cron: "0 2 * * *"
# Allow the workflow to be manually run:
workflow_dispatch:
@@ -35,12 +35,10 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for updating namespace TypeScript declarations...
update:
-
# Define a display name:
- name: 'Update TypeScript Declarations'
+ name: "Update TypeScript Declarations"
# Ensure the job does not run on forks:
if: github.repository == 'stdlib-js/stdlib'
@@ -50,9 +48,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -70,31 +67,31 @@ jobs:
timeout-minutes: 10
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
- node-version: '20' # 'lts/*'
+ node-version: "20" # 'lts/*'
timeout-minutes: 5
# Install dependencies (accounting for possible network failures, etc, when installing node module dependencies):
- - name: 'Install dependencies'
+ - name: "Install dependencies"
run: |
make install-node-modules || make install-node-modules || make install-node-modules
timeout-minutes: 15
# Update namespace Typescript declarations:
- - name: 'Update declarations'
+ - name: "Update declarations"
run: |
make list-pkgs-namespaces | node lib/node_modules/@stdlib/_tools/scripts/create_namespace_types.js
# Disable Git hooks:
- - name: 'Disable Git hooks'
+ - name: "Disable Git hooks"
run: |
rm -rf .git/hooks
# Import GPG key to sign commits:
- - name: 'Import GPG key to sign commits'
+ - name: "Import GPG key to sign commits"
# Pin action to full length commit SHA
uses: crazy-max/ghaction-import-gpg@cb9bde2e2525e640591a934b1fd28eef1dcaf5e5 # v6.2.0
with:
@@ -104,12 +101,12 @@ jobs:
git_commit_gpgsign: true
# Create a pull request with the updated declarations:
- - name: 'Create pull request'
+ - name: "Create pull request"
id: cpr
# Pin action to full length commit SHA
uses: peter-evans/create-pull-request@67ccf781d68cd99b580ae25a5c18a1cc84ffff1f # v7.0.6
with:
- title: 'feat: update namespace TypeScript declarations'
+ title: "feat: update namespace TypeScript declarations"
body: |
This PR
@@ -124,8 +121,8 @@ jobs:
- [ ] Update the PR title to align with the change type (`feat`, `feat!`, or `docs`).
- [ ] Approve the PR once you are confident about the classification and changes made.
- commit-message: 'feat: update namespace TypeScript declarations'
- committer: 'stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>'
+ commit-message: "feat: update namespace TypeScript declarations"
+ committer: "stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>"
signoff: true
token: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
labels: |
@@ -137,7 +134,7 @@ jobs:
delete-branch: true
# Create Markdown summary of the pull request:
- - name: 'Create summary'
+ - name: "Create summary"
run: |
echo "# :tada: Pull Request created! :tada:" >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
diff --git a/.github/workflows/namespace_exports.yml b/.github/workflows/namespace_exports.yml
index 80507a2b4b0f..7b966e6a208f 100644
--- a/.github/workflows/namespace_exports.yml
+++ b/.github/workflows/namespace_exports.yml
@@ -31,12 +31,10 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for updating namespace exports...
update:
-
# Define a display name:
- name: 'Update Namespace Exports'
+ name: "Update Namespace Exports"
# Ensure the job does not run on forks:
if: github.repository == 'stdlib-js/stdlib'
@@ -46,9 +44,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -66,27 +63,27 @@ jobs:
timeout-minutes: 10
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
- node-version: '20' # 'lts/*'
+ node-version: "20" # 'lts/*'
timeout-minutes: 5
# Install dependencies (accounting for possible network failures, etc, when installing node module dependencies):
- - name: 'Install dependencies'
+ - name: "Install dependencies"
run: |
make install-node-modules || make install-node-modules || make install-node-modules
timeout-minutes: 15
# Initialize development environment:
- - name: 'Initialize development environment'
+ - name: "Initialize development environment"
run: |
make init
timeout-minutes: 5
# Update namespace exports:
- - name: 'Update namespace exports'
+ - name: "Update namespace exports"
run: |
# Determine root directory:
root=$(git rev-parse --show-toplevel)
@@ -110,12 +107,12 @@ jobs:
make FILES="${namespaces}" FIX=1 FIX_TYPE="suggestion" lint-javascript-files
# Disable Git hooks:
- - name: 'Disable Git hooks'
+ - name: "Disable Git hooks"
run: |
rm -rf .git/hooks
# Import GPG key to sign commits:
- - name: 'Import GPG key to sign commits'
+ - name: "Import GPG key to sign commits"
# Pin action to full length commit SHA
uses: crazy-max/ghaction-import-gpg@cb9bde2e2525e640591a934b1fd28eef1dcaf5e5 # v6.2.0
with:
@@ -125,19 +122,19 @@ jobs:
git_commit_gpgsign: true
# Create a pull request with the updated namespace exports:
- - name: 'Create pull request'
+ - name: "Create pull request"
id: cpr
# Pin action to full length commit SHA
uses: peter-evans/create-pull-request@67ccf781d68cd99b580ae25a5c18a1cc84ffff1f # v7.0.6
with:
- title: 'feat: update namespace exports'
+ title: "feat: update namespace exports"
body: |
This PR
- updates namespace exports
- commit-message: 'feat: update namespace exports'
- committer: 'stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>'
+ commit-message: "feat: update namespace exports"
+ committer: "stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>"
signoff: true
token: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
labels: |
diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml
index 7864aec56504..c20e9d521f0d 100644
--- a/.github/workflows/npm_downloads.yml
+++ b/.github/workflows/npm_downloads.yml
@@ -24,7 +24,7 @@ on:
# Run this workflow weekly:
schedule:
# cron: '<minutes> <hours> <day_of_month> <month> <day_of_week>'
- - cron: '0 8 * * 6'
+ - cron: "0 8 * * 6"
# Allow the workflow to be manually run:
workflow_dispatch:
@@ -36,12 +36,10 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for retrieving npm download counts...
npm_downloads:
-
# Define a display name:
- name: 'Retrieve npm Download Counts'
+ name: "Retrieve npm Download Counts"
# Ensure the job does not run on forks:
if: github.repository == 'stdlib-js/stdlib'
@@ -52,13 +50,13 @@ jobs:
# Define the sequence of job steps...
steps:
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
timeout-minutes: 10
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
@@ -66,7 +64,7 @@ jobs:
timeout-minutes: 5
# Resolve package name:
- - name: 'Resolve package name'
+ - name: "Resolve package name"
id: package_name
run: |
name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'`
@@ -74,7 +72,7 @@ jobs:
timeout-minutes: 5
# Fetch download data:
- - name: 'Fetch data'
+ - name: "Fetch data"
id: download_data
run: |
url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}"
@@ -86,7 +84,7 @@ jobs:
timeout-minutes: 5
# Upload the download data:
- - name: 'Upload data'
+ - name: "Upload data"
# Pin action to full length commit SHA
uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0
with:
@@ -102,7 +100,7 @@ jobs:
if: success()
# Send data to events server:
- - name: 'Post data'
+ - name: "Post data"
# Pin action to full length commit SHA
uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3
env:
diff --git a/.github/workflows/ossf_scorecard.yml b/.github/workflows/ossf_scorecard.yml
index 5850535ff52d..909411763832 100644
--- a/.github/workflows/ossf_scorecard.yml
+++ b/.github/workflows/ossf_scorecard.yml
@@ -27,7 +27,7 @@ on:
# To guarantee Maintained check is occasionally updated. See
# https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained
schedule:
- - cron: '24 9 * * 0'
+ - cron: "24 9 * * 0"
# Allow the workflow to be manually run:
workflow_dispatch:
@@ -37,10 +37,8 @@ permissions: read-all
# Workflow jobs:
jobs:
-
# Define a job for running the scorecard analysis:
analysis:
-
# Define a display name:
name: Scorecard analysis
@@ -60,7 +58,7 @@ jobs:
# Define the sequence of job steps...
steps:
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
timeout-minutes: 10
diff --git a/.github/workflows/pr_merge_develop.yml b/.github/workflows/pr_merge_develop.yml
index 16258674316d..ce4b8d762136 100644
--- a/.github/workflows/pr_merge_develop.yml
+++ b/.github/workflows/pr_merge_develop.yml
@@ -26,27 +26,27 @@ on:
# Define the input parameters for the workflow:
inputs:
pull_request_number:
- description: 'PR number'
+ description: "PR number"
required: true
type: number
# Define the secrets accessible by the workflow:
secrets:
STDLIB_BOT_GITHUB_TOKEN:
- description: 'GitHub token for stdlib-bot'
+ description: "GitHub token for stdlib-bot"
required: true
STDLIB_BOT_GPG_PRIVATE_KEY:
- description: 'GPG private key for stdlib-bot'
+ description: "GPG private key for stdlib-bot"
required: true
STDLIB_BOT_GPG_PASSPHRASE:
- description: 'GPG passphrase for stdlib-bot'
+ description: "GPG passphrase for stdlib-bot"
required: true
# Workflow jobs:
jobs:
merge:
# Define a display name:
- name: 'Merge Develop into PR Branch'
+ name: "Merge Develop into PR Branch"
# Define the type of virtual host machine:
runs-on: ubuntu-latest
@@ -54,7 +54,7 @@ jobs:
# Define the job's steps:
steps:
# Get PR details:
- - name: 'Get PR details'
+ - name: "Get PR details"
id: pr-details
run: |
pr_response=$(curl -s \
@@ -73,7 +73,7 @@ jobs:
echo "repository=$pr_repo_full_name" >> $GITHUB_OUTPUT
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
ref: ${{ steps.pr-details.outputs.branch }}
@@ -82,12 +82,12 @@ jobs:
fetch-depth: 0
# Disable Git hooks:
- - name: 'Disable Git hooks'
+ - name: "Disable Git hooks"
run: |
rm -rf .git/hooks
# Import GPG key to sign commits:
- - name: 'Import GPG key to sign commits'
+ - name: "Import GPG key to sign commits"
# Pin action to full length commit SHA
uses: crazy-max/ghaction-import-gpg@cb9bde2e2525e640591a934b1fd28eef1dcaf5e5 # v6.2.0
with:
@@ -97,7 +97,7 @@ jobs:
git_commit_gpgsign: true
# Merge the develop branch into the PR branch:
- - name: 'Merge develop branch'
+ - name: "Merge develop branch"
env:
REPO_GITHUB_TOKEN: ${{ secrets.STDLIB_BOT_GITHUB_TOKEN }}
USER_NAME: stdlib-bot
diff --git a/.github/workflows/pr_rebase_develop.yml b/.github/workflows/pr_rebase_develop.yml
index 053632d8755c..aaebd53398ef 100644
--- a/.github/workflows/pr_rebase_develop.yml
+++ b/.github/workflows/pr_rebase_develop.yml
@@ -21,33 +21,32 @@ name: pr_rebase_develop
# Workflow triggers:
on:
-
# Allow the workflow to be triggered by other workflows
workflow_call:
# Define the input parameters for the workflow:
inputs:
pull_request_number:
- description: 'PR number'
+ description: "PR number"
required: true
type: number
# Define the secrets accessible by the workflow:
secrets:
STDLIB_BOT_GITHUB_TOKEN:
- description: 'GitHub token for stdlib-bot'
+ description: "GitHub token for stdlib-bot"
required: true
STDLIB_BOT_GPG_PRIVATE_KEY:
- description: 'GPG private key for stdlib-bot'
+ description: "GPG private key for stdlib-bot"
required: true
STDLIB_BOT_GPG_PASSPHRASE:
- description: 'GPG passphrase for stdlib-bot'
+ description: "GPG passphrase for stdlib-bot"
required: true
# Workflow jobs:
jobs:
rebase:
# Define a display name:
- name: 'Rebase PR Branch onto Develop'
+ name: "Rebase PR Branch onto Develop"
# Define the type of virtual host machine:
runs-on: ubuntu-latest
@@ -55,7 +54,7 @@ jobs:
# Define the job's steps:
steps:
# Get PR details:
- - name: 'Get PR details'
+ - name: "Get PR details"
id: pr-details
run: |
pr_response=$(curl -s \
@@ -74,7 +73,7 @@ jobs:
echo "repository=$pr_repo_full_name" >> $GITHUB_OUTPUT
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
ref: ${{ steps.pr-details.outputs.branch }}
@@ -83,12 +82,12 @@ jobs:
fetch-depth: 0
# Disable Git hooks:
- - name: 'Disable Git hooks'
+ - name: "Disable Git hooks"
run: |
rm -rf .git/hooks
# Import GPG key to sign commits:
- - name: 'Import GPG key to sign commits'
+ - name: "Import GPG key to sign commits"
# Pin action to full length commit SHA
uses: crazy-max/ghaction-import-gpg@cb9bde2e2525e640591a934b1fd28eef1dcaf5e5 # v6.2.0
with:
@@ -98,7 +97,7 @@ jobs:
git_commit_gpgsign: true
# Rebase on develop branch:
- - name: 'Rebase on develop branch'
+ - name: "Rebase on develop branch"
env:
REPO_GITHUB_TOKEN: ${{ secrets.STDLIB_BOT_GITHUB_TOKEN }}
USER_NAME: stdlib-bot
diff --git a/.github/workflows/process_metadata.yml b/.github/workflows/process_metadata.yml
index d7578e308742..249fb5e692c1 100644
--- a/.github/workflows/process_metadata.yml
+++ b/.github/workflows/process_metadata.yml
@@ -25,7 +25,7 @@ on:
branches:
- develop
issue_comment:
- types: [ created, edited ]
+ types: [created, edited]
# Global permissions:
permissions:
@@ -34,12 +34,10 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for processing commit message and issue comment metadata...
process:
-
# Define a display name:
- name: 'Process Metadata'
+ name: "Process Metadata"
# Define the type of virtual host machine:
runs-on: ubuntu-latest
@@ -47,13 +45,13 @@ jobs:
# Define the sequence of job steps...
steps:
# Exit if the user does not have write access to the repository:
- - name: 'Exit if user does not have write access'
+ - name: "Exit if user does not have write access"
id: assert-write-access
# Pin action to full length commit SHA
uses: lannonbr/repo-permission-check-action@2bb8c89ba8bf115c4bfab344d6a6f442b24c9a1f # v2.0.2
with:
- permission: 'write'
+ permission: "write"
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -61,7 +59,7 @@ jobs:
continue-on-error: true
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Only run this step if a user has write access:
if: steps.assert-write-access.outcome == 'success'
@@ -80,7 +78,7 @@ jobs:
timeout-minutes: 10
# Extract commit message and issue comment metadata:
- - name: 'Extract metadata'
+ - name: "Extract metadata"
id: extract-metadata
# Only run this step if a user has write access:
@@ -90,7 +88,7 @@ jobs:
uses: stdlib-js/metadata-action@3ccf68f24c51ae23470319e8e5619d539df8212b # v3.0.0
# Check the metadata for directives to send tweets:
- - name: 'Send tweets'
+ - name: "Send tweets"
# Only run this step if a user has write access:
if: steps.assert-write-access.outcome == 'success'
@@ -105,7 +103,7 @@ jobs:
TWITTER_ACCESS_TOKEN_SECRET: ${{ secrets.TWITTER_ACCESS_TOKEN_SECRET }}
# Check the metadata for directives to dispatch workflows:
- - name: 'Check metadata for workflow dispatch directives'
+ - name: "Check metadata for workflow dispatch directives"
id: check-workflow-dispatch
# Only run this step if a user has write access:
@@ -124,7 +122,7 @@ jobs:
fi
# Dispatch first found workflow (if applicable):
- - name: 'Dispatch workflow with inputs'
+ - name: "Dispatch workflow with inputs"
# Pin action to full length commit SHA
uses: benc-uk/workflow-dispatch@e2e5e9a103e331dad343f381a29e654aea3cf8fc # v1.2.4
diff --git a/.github/workflows/random_examples.yml b/.github/workflows/random_examples.yml
index c8eabd665a68..225cc02da9ad 100644
--- a/.github/workflows/random_examples.yml
+++ b/.github/workflows/random_examples.yml
@@ -23,7 +23,7 @@ name: random_examples
on:
# Trigger the workflow every 24 hours:
schedule:
- - cron: '0 0 * * *'
+ - cron: "0 0 * * *"
# Allow the workflow to be manually run:
workflow_dispatch:
@@ -35,12 +35,10 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for running random examples...
process:
-
# Define a display name:
- name: 'Run random examples'
+ name: "Run random examples"
# Ensure the job does not run on forks:
if: github.repository == 'stdlib-js/stdlib'
@@ -51,7 +49,7 @@ jobs:
# Define the sequence of job steps...
steps:
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -69,21 +67,21 @@ jobs:
timeout-minutes: 10
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
- node-version: '18' # 'lts/*'
+ node-version: "18" # 'lts/*'
timeout-minutes: 5
# Install dependencies (accounting for possible network failures, etc, when installing node module dependencies):
- - name: 'Install dependencies'
+ - name: "Install dependencies"
run: |
make install-node-modules || make install-node-modules || make install-node-modules
timeout-minutes: 15
# Run JavaScript examples:
- - name: 'Run JavaScript examples'
+ - name: "Run JavaScript examples"
run: |
make examples-random-javascript RANDOM_SELECTION_SIZE=50
timeout-minutes: 60
diff --git a/.github/workflows/run_affected_benchmarks.yml b/.github/workflows/run_affected_benchmarks.yml
index 52253d7a55c5..a22df87092d4 100644
--- a/.github/workflows/run_affected_benchmarks.yml
+++ b/.github/workflows/run_affected_benchmarks.yml
@@ -24,7 +24,7 @@ on:
push:
paths:
# List paths for which changes should trigger this workflow:
- - 'lib/**/benchmark/**'
+ - "lib/**/benchmark/**"
pull_request:
types:
@@ -33,12 +33,12 @@ on:
- reopened
paths:
# List paths for which changes should trigger this workflow:
- - 'lib/**/benchmark/**'
+ - "lib/**/benchmark/**"
workflow_dispatch:
inputs:
directories:
- description: 'List of changed directories for which to run affected benchmarks (space-separated)'
+ description: "List of changed directories for which to run affected benchmarks (space-separated)"
# Global permissions:
permissions:
@@ -47,12 +47,10 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for running changed benchmarks...
process:
-
# Define a display name:
- name: 'Run affected benchmarks'
+ name: "Run affected benchmarks"
# Define the type of virtual host machine:
runs-on: ubuntu-latest
@@ -60,11 +58,10 @@ jobs:
# Define the sequence of job steps...
steps:
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
-
# Specify whether to remove untracked files before checking out the repository:
clean: true
@@ -79,15 +76,15 @@ jobs:
timeout-minutes: 10
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
- node-version: '20' # 'lts/*'
+ node-version: "20" # 'lts/*'
timeout-minutes: 5
# Cache dependencies:
- - name: 'Cache dependencies'
+ - name: "Cache dependencies"
# Pin action to full length commit SHA
uses: actions/cache@1bd1e32a3bdc45362d1e726936510720a7c30a57 # v4.2.0
id: cache
@@ -99,20 +96,20 @@ jobs:
${{ runner.os }}-node-
# Install dependencies (accounting for possible network failures, etc, when installing node module dependencies):
- - name: 'Install dependencies'
+ - name: "Install dependencies"
if: steps.cache.outputs.cache-hit != 'true'
run: |
make install-node-modules || make install-node-modules || make install-node-modules
timeout-minutes: 15
# Initialize development environment:
- - name: 'Initialize development environment'
+ - name: "Initialize development environment"
run: |
make init
timeout-minutes: 5
# Get list of changed directories from PR and push events:
- - name: 'Get list of changed directories'
+ - name: "Get list of changed directories"
if: github.event_name != 'workflow_dispatch'
id: changed-directories
continue-on-error: true
@@ -133,7 +130,7 @@ jobs:
echo "directories=${directories}" >> $GITHUB_OUTPUT
# Get list of changed directories from workflow dispatch event:
- - name: 'Get list of changed directories (from user input)'
+ - name: "Get list of changed directories (from user input)"
if: github.event_name == 'workflow_dispatch'
id: changed-directories-user-input
run: |
@@ -141,7 +138,7 @@ jobs:
timeout-minutes: 5
# Run affected benchmarks:
- - name: 'Run affected benchmarks'
+ - name: "Run affected benchmarks"
run: |
if [ "${{ github.event_name }}" == "workflow_dispatch" ]; then
directories="${{ steps.changed-directories-user-input.outputs.directories }}"
diff --git a/.github/workflows/run_affected_examples.yml b/.github/workflows/run_affected_examples.yml
index 93e20ae705d9..64f11fd2b39e 100644
--- a/.github/workflows/run_affected_examples.yml
+++ b/.github/workflows/run_affected_examples.yml
@@ -24,8 +24,8 @@ on:
push:
paths:
# List paths for which changes should trigger this workflow:
- - 'lib/**/examples/**'
- - 'lib/**/README.md'
+ - "lib/**/examples/**"
+ - "lib/**/README.md"
pull_request:
types:
@@ -34,8 +34,8 @@ on:
- reopened
paths:
# List paths for which changes should trigger this workflow:
- - 'lib/**/examples/**'
- - 'lib/**/README.md'
+ - "lib/**/examples/**"
+ - "lib/**/README.md"
# Global permissions:
permissions:
@@ -44,12 +44,10 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for running changed examples...
process:
-
# Define a display name:
- name: 'Run changed examples'
+ name: "Run changed examples"
# Define the type of virtual host machine:
runs-on: ubuntu-latest
@@ -57,7 +55,7 @@ jobs:
# Define the sequence of job steps...
steps:
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -75,15 +73,15 @@ jobs:
timeout-minutes: 10
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
- node-version: '20' # 'lts/*'
+ node-version: "20" # 'lts/*'
timeout-minutes: 5
# Cache dependencies:
- - name: 'Cache dependencies'
+ - name: "Cache dependencies"
# Pin action to full length commit SHA
uses: actions/cache@1bd1e32a3bdc45362d1e726936510720a7c30a57 # v4.2.0
id: cache
@@ -95,20 +93,20 @@ jobs:
${{ runner.os }}-node-
# Install dependencies (accounting for possible network failures, etc, when installing node module dependencies):
- - name: 'Install dependencies'
+ - name: "Install dependencies"
if: steps.cache.outputs.cache-hit != 'true'
run: |
make install-node-modules || make install-node-modules || make install-node-modules
timeout-minutes: 15
# Initialize development environment:
- - name: 'Initialize development environment'
+ - name: "Initialize development environment"
run: |
make init
timeout-minutes: 5
# Get list of changed files:
- - name: 'Get list of changed files'
+ - name: "Get list of changed files"
id: changed-files
continue-on-error: true
run: |
@@ -129,7 +127,7 @@ jobs:
echo "files=${files}" >> $GITHUB_OUTPUT
# Run JavaScript examples:
- - name: 'Run JavaScript examples'
+ - name: "Run JavaScript examples"
run: |
files=$(echo "${{ steps.changed-files.outputs.files }}" | tr ' ' '\n' | grep -E '\.js$' | tr '\n' ' ' | sed 's/ $//')
if [ -n "$files" ]; then
@@ -138,7 +136,7 @@ jobs:
timeout-minutes: 15
# Run C examples:
- - name: 'Run C examples'
+ - name: "Run C examples"
run: |
files=$(echo "${{ steps.changed-files.outputs.files }}" | tr ' ' '\n' | grep -E '\.c$' | sed "s|^|${GITHUB_WORKSPACE}/|" | tr '\n' ' ' | sed 's/ $//')
if [ -n "$files" ]; then
@@ -147,7 +145,7 @@ jobs:
timeout-minutes: 15
# Run examples in Markdown files:
- - name: 'Run examples in Markdown files'
+ - name: "Run examples in Markdown files"
run: |
files=$(echo "${{ steps.changed-files.outputs.files }}" | tr ' ' '\n' | grep -E '\.md$' | tr '\n' ' ' | sed 's/ $//')
if [ -n "$files" ]; then
diff --git a/.github/workflows/run_affected_tests.yml b/.github/workflows/run_affected_tests.yml
index b13f9a65e29b..dfdf38cbb152 100644
--- a/.github/workflows/run_affected_tests.yml
+++ b/.github/workflows/run_affected_tests.yml
@@ -24,23 +24,23 @@ on:
push:
paths:
# List paths for which changes should trigger this workflow:
- - 'lib/**/bin/**'
- - 'lib/**/data/**'
- - 'lib/**/etc/**'
- - 'lib/**/include/**'
- - 'lib/**/lib/**'
- - 'lib/**/src/**'
- - 'lib/**/test/**'
+ - "lib/**/bin/**"
+ - "lib/**/data/**"
+ - "lib/**/etc/**"
+ - "lib/**/include/**"
+ - "lib/**/lib/**"
+ - "lib/**/src/**"
+ - "lib/**/test/**"
- - 'lib/**/*.gyp'
- - 'lib/**/*.gypi'
- - 'lib/**/manifest.json'
+ - "lib/**/*.gyp"
+ - "lib/**/*.gypi"
+ - "lib/**/manifest.json"
- - 'package.json'
+ - "package.json"
# List paths for which changes should *not* trigger this workflow:
- - '!lib/**/_tools/**'
- - '!lib/**/*.md'
+ - "!lib/**/_tools/**"
+ - "!lib/**/*.md"
pull_request:
types:
@@ -49,28 +49,28 @@ on:
- reopened
paths:
# List paths for which changes should trigger this workflow:
- - 'lib/**/bin/**'
- - 'lib/**/data/**'
- - 'lib/**/etc/**'
- - 'lib/**/include/**'
- - 'lib/**/lib/**'
- - 'lib/**/src/**'
- - 'lib/**/test/**'
+ - "lib/**/bin/**"
+ - "lib/**/data/**"
+ - "lib/**/etc/**"
+ - "lib/**/include/**"
+ - "lib/**/lib/**"
+ - "lib/**/src/**"
+ - "lib/**/test/**"
- - 'lib/**/*.gyp'
- - 'lib/**/*.gypi'
- - 'lib/**/manifest.json'
+ - "lib/**/*.gyp"
+ - "lib/**/*.gypi"
+ - "lib/**/manifest.json"
- - 'package.json'
+ - "package.json"
# List paths for which changes should *not* trigger this workflow:
- - '!lib/**/_tools/**'
- - '!lib/**/*.md'
+ - "!lib/**/_tools/**"
+ - "!lib/**/*.md"
workflow_dispatch:
inputs:
directories:
- description: 'List of changed directories for which to run affected tests (space separated):'
+ description: "List of changed directories for which to run affected tests (space separated):"
# Global permissions:
permissions:
@@ -79,12 +79,10 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for running tests affected by changes to the repository...
process:
-
# Define a display name:
- name: 'Run affected tests'
+ name: "Run affected tests"
# Define the type of virtual host machine:
runs-on: ubuntu-latest
@@ -92,7 +90,7 @@ jobs:
# Define the sequence of job steps...
steps:
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -110,15 +108,15 @@ jobs:
timeout-minutes: 10
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
- node-version: '20' # 'lts/*'
+ node-version: "20" # 'lts/*'
timeout-minutes: 5
# Cache dependencies:
- - name: 'Cache dependencies'
+ - name: "Cache dependencies"
# Pin action to full length commit SHA
uses: actions/cache@1bd1e32a3bdc45362d1e726936510720a7c30a57 # v4.2.0
id: cache
@@ -130,20 +128,20 @@ jobs:
${{ runner.os }}-node-
# Install dependencies (accounting for possible network failures, etc, when installing node module dependencies):
- - name: 'Install dependencies'
+ - name: "Install dependencies"
if: steps.cache.outputs.cache-hit != 'true'
run: |
make install-node-modules || make install-node-modules || make install-node-modules
timeout-minutes: 15
# Initialize development environment:
- - name: 'Initialize development environment'
+ - name: "Initialize development environment"
run: |
make init
timeout-minutes: 5
# Get list of changed directories from PR and push events:
- - name: 'Get list of changed directories'
+ - name: "Get list of changed directories"
if: github.event_name != 'workflow_dispatch'
id: changed-directories
continue-on-error: true
@@ -164,7 +162,7 @@ jobs:
echo "directories=${directories}" >> $GITHUB_OUTPUT
# Get list of changed directories from workflow dispatch event:
- - name: 'Get list of changed directories (from user input)'
+ - name: "Get list of changed directories (from user input)"
if: github.event_name == 'workflow_dispatch'
id: changed-directories-user-input
run: |
@@ -172,7 +170,7 @@ jobs:
timeout-minutes: 5
# Run JavaScript tests:
- - name: 'Run JavaScript tests'
+ - name: "Run JavaScript tests"
run: |
if [ "${{ github.event_name }}" == "workflow_dispatch" ]; then
directories="${{ steps.changed-directories-user-input.outputs.directories }}"
diff --git a/.github/workflows/run_tests_coverage.yml b/.github/workflows/run_tests_coverage.yml
index 7b67178c753f..28844831a34a 100644
--- a/.github/workflows/run_tests_coverage.yml
+++ b/.github/workflows/run_tests_coverage.yml
@@ -26,22 +26,22 @@ on:
- develop
paths:
# List paths for which changes should trigger this workflow:
- - 'lib/**/bin/**'
- - 'lib/**/data/**'
- - 'lib/**/etc/**'
- - 'lib/**/include/**'
- - 'lib/**/lib/**'
- - 'lib/**/src/**'
- - 'lib/**/test/**'
+ - "lib/**/bin/**"
+ - "lib/**/data/**"
+ - "lib/**/etc/**"
+ - "lib/**/include/**"
+ - "lib/**/lib/**"
+ - "lib/**/src/**"
+ - "lib/**/test/**"
- - 'lib/**/*.gyp'
- - 'lib/**/*.gypi'
- - 'lib/**/manifest.json'
+ - "lib/**/*.gyp"
+ - "lib/**/*.gypi"
+ - "lib/**/manifest.json"
- - 'package.json'
+ - "package.json"
# List paths for which changes should *not* trigger this workflow:
- - '!lib/**/_tools/**'
+ - "!lib/**/_tools/**"
pull_request_target:
types:
@@ -50,27 +50,27 @@ on:
- reopened
paths:
# List paths for which changes should trigger this workflow:
- - 'lib/**/bin/**'
- - 'lib/**/data/**'
- - 'lib/**/etc/**'
- - 'lib/**/include/**'
- - 'lib/**/lib/**'
- - 'lib/**/src/**'
- - 'lib/**/test/**'
+ - "lib/**/bin/**"
+ - "lib/**/data/**"
+ - "lib/**/etc/**"
+ - "lib/**/include/**"
+ - "lib/**/lib/**"
+ - "lib/**/src/**"
+ - "lib/**/test/**"
- - 'lib/**/*.gyp'
- - 'lib/**/*.gypi'
- - 'lib/**/manifest.json'
+ - "lib/**/*.gyp"
+ - "lib/**/*.gypi"
+ - "lib/**/manifest.json"
- - 'package.json'
+ - "package.json"
# List paths for which changes should *not* trigger this workflow:
- - '!lib/**/_tools/**'
+ - "!lib/**/_tools/**"
workflow_dispatch:
inputs:
directories:
- description: 'List of changed directories for which to run tests (space separated):'
+ description: "List of changed directories for which to run tests (space separated):"
# Global permissions:
permissions:
@@ -79,12 +79,10 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for calculating test coverage for changed files...
coverage:
-
# Define a display name:
- name: 'Calculate test coverage for packages'
+ name: "Calculate test coverage for packages"
# Define the type of virtual host machine:
runs-on: ubuntu-latest
@@ -92,7 +90,7 @@ jobs:
# Define the sequence of job steps...
steps:
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -113,7 +111,7 @@ jobs:
timeout-minutes: 10
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
@@ -121,7 +119,7 @@ jobs:
timeout-minutes: 5
# Cache dependencies:
- - name: 'Cache dependencies'
+ - name: "Cache dependencies"
# Pin action to full length commit SHA
uses: actions/cache@1bd1e32a3bdc45362d1e726936510720a7c30a57 # v4.2.0
id: cache
@@ -133,20 +131,20 @@ jobs:
${{ runner.os }}-node-
# Install dependencies (accounting for possible network failures, etc, when installing node module dependencies):
- - name: 'Install dependencies'
+ - name: "Install dependencies"
if: steps.cache.outputs.cache-hit != 'true'
run: |
make install-node-modules || make install-node-modules || make install-node-modules
timeout-minutes: 15
# Initialize development environment:
- - name: 'Initialize development environment'
+ - name: "Initialize development environment"
run: |
make init
timeout-minutes: 5
# Get list of changed directories from PR and push events:
- - name: 'Get list of changed directories'
+ - name: "Get list of changed directories"
if: github.event_name != 'workflow_dispatch'
id: changed-directories
continue-on-error: true
@@ -178,7 +176,7 @@ jobs:
echo "directories=${directories}" >> $GITHUB_OUTPUT
# Get list of changed directories from workflow dispatch event:
- - name: 'Get list of changed directories (from user input)'
+ - name: "Get list of changed directories (from user input)"
if: github.event_name == 'workflow_dispatch'
id: changed-directories-user-input
run: |
@@ -186,7 +184,7 @@ jobs:
timeout-minutes: 5
# Exit early if non-package directories are changed:
- - name: 'Exit early if non-package directories are changed'
+ - name: "Exit early if non-package directories are changed"
id: check-changed
if: github.event_name != 'workflow_dispatch'
run: |
@@ -202,7 +200,7 @@ jobs:
echo "skip=${skip}" >> $GITHUB_OUTPUT
# Run JavaScript tests:
- - name: 'Run JavaScript tests'
+ - name: "Run JavaScript tests"
id: extract-coverage
if: steps.check-changed.outputs.skip == 'false'
env:
@@ -227,7 +225,7 @@ jobs:
timeout-minutes: 30
# Create final coverage report:
- - name: 'Create final coverage report'
+ - name: "Create final coverage report"
id: create-report
if: steps.check-changed.outputs.skip == 'false'
run: |
@@ -249,7 +247,7 @@ jobs:
echo "report=$report" >> $GITHUB_OUTPUT
# Post report as comment to PR:
- - name: 'Post report as comment to PR'
+ - name: "Post report as comment to PR"
if: github.event_name == 'pull_request_target' && steps.check-changed.outputs.skip == 'false'
# Pin action to full length commit SHA
uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
@@ -280,7 +278,7 @@ jobs:
}
# Post report as comment to commit:
- - name: 'Post report as comment to commit'
+ - name: "Post report as comment to commit"
if: github.event_name == 'push' && steps.check-changed.outputs.skip == 'false'
# Pin action to full length commit SHA
uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
@@ -295,16 +293,16 @@ jobs:
})
# Checkout coverage repository:
- - name: 'Checkout coverage repository'
+ - name: "Checkout coverage repository"
if: steps.check-changed.outputs.skip == 'false'
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
# Code coverage repository:
- repository: 'stdlib-js/www-test-code-coverage'
+ repository: "stdlib-js/www-test-code-coverage"
# File path to checkout to:
- path: './www-test-code-coverage'
+ path: "./www-test-code-coverage"
# Specify whether to remove untracked files before checking out the repository:
clean: false
@@ -319,7 +317,7 @@ jobs:
persist-credentials: false
# Checkout coverage repository branch:
- - name: 'Checkout coverage repository branch'
+ - name: "Checkout coverage repository branch"
if: steps.check-changed.outputs.skip == 'false'
run: |
cd ./www-test-code-coverage
@@ -336,7 +334,7 @@ jobs:
fi
# Copy artifacts to the repository:
- - name: 'Copy artifacts to the repository'
+ - name: "Copy artifacts to the repository"
if: steps.check-changed.outputs.skip == 'false'
run: |
if [ -d "./artifacts" ]; then
@@ -358,7 +356,7 @@ jobs:
fi
# Import GPG key to sign commits:
- - name: 'Import GPG key to sign commits'
+ - name: "Import GPG key to sign commits"
if: steps.check-changed.outputs.skip == 'false'
# Pin action to full length commit SHA
uses: crazy-max/ghaction-import-gpg@cb9bde2e2525e640591a934b1fd28eef1dcaf5e5 # v6.2.0
@@ -369,7 +367,7 @@ jobs:
git_commit_gpgsign: true
# Commit and push changes:
- - name: 'Commit and push changes'
+ - name: "Commit and push changes"
if: steps.check-changed.outputs.skip == 'false'
env:
REPO_GITHUB_TOKEN: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
diff --git a/.github/workflows/slash_commands.yml b/.github/workflows/slash_commands.yml
index 7fbac945941c..7b6cae692a85 100644
--- a/.github/workflows/slash_commands.yml
+++ b/.github/workflows/slash_commands.yml
@@ -28,12 +28,10 @@ on:
# Workflow jobs:
jobs:
-
# Define a job for adding an initial reaction:
add_initial_reaction:
-
# Define a display name:
- name: 'Add initial reaction'
+ name: "Add initial reaction"
# Define the type of virtual host machine:
runs-on: ubuntu-latest
@@ -44,7 +42,7 @@ jobs:
# Define the job's steps:
steps:
# Add "bot: In progress" label to the issue / PR:
- - name: 'Add in-progress label'
+ - name: "Add in-progress label"
# Pin action to full length commit SHA
uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
with:
@@ -58,7 +56,7 @@ jobs:
})
# Add initial reaction to comment with slash command:
- - name: 'Add initial reaction'
+ - name: "Add initial reaction"
uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
with:
github-token: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
@@ -89,12 +87,11 @@ jobs:
# Define a job for checking for required files:
check_files:
-
# Define a display name:
- name: 'Check for required files'
+ name: "Check for required files"
# Ensure initial reaction job has completed before running this job:
- needs: [ add_initial_reaction ]
+ needs: [add_initial_reaction]
# Define the conditions under which the job should run:
if: github.event.issue.pull_request && startsWith(github.event.comment.body, '/stdlib check-files')
@@ -109,9 +106,8 @@ jobs:
# Define a job for updating copyright header years:
update_copyright_years:
-
# Define a display name:
- name: 'Update copyright header years'
+ name: "Update copyright header years"
# Define the conditions under which the job should run:
if: github.event.issue.pull_request && startsWith(github.event.comment.body, '/stdlib update-copyright-years')
@@ -127,12 +123,11 @@ jobs:
# Define a job for auto-fixing lint errors:
fix_lint_errors:
-
# Define a display name:
- name: 'Auto-fix lint errors'
+ name: "Auto-fix lint errors"
# Ensure initial reaction job has completed before running this job:
- needs: [ add_initial_reaction ]
+ needs: [add_initial_reaction]
# Define the conditions under which the job should run:
if: github.event.issue.pull_request && startsWith(github.event.comment.body, '/stdlib lint-autofix')
@@ -148,12 +143,11 @@ jobs:
# Define a job for merging develop branch:
merge_develop:
-
# Define a display name:
- name: 'Merge changes from develop branch into this PR'
+ name: "Merge changes from develop branch into this PR"
# Ensure initial reaction job has completed before running this job:
- needs: [ add_initial_reaction ]
+ needs: [add_initial_reaction]
# Define the conditions under which the job should run:
if: github.event.issue.pull_request && startsWith(github.event.comment.body, '/stdlib merge')
@@ -169,12 +163,11 @@ jobs:
# Define a job for rebasing on develop branch:
rebase_develop:
-
# Define a display name:
- name: 'Rebase this PR on top of develop branch'
+ name: "Rebase this PR on top of develop branch"
# Ensure initial reaction job has completed before running this job:
- needs: [ add_initial_reaction ]
+ needs: [add_initial_reaction]
# Define the conditions under which the job should run:
if: github.event.issue.pull_request && startsWith(github.event.comment.body, '/stdlib rebase')
@@ -190,15 +183,14 @@ jobs:
# Define a job for printing a list of available slash commands:
help:
-
# Define a display name:
- name: 'Print a list of available slash commands'
+ name: "Print a list of available slash commands"
# Define the type of virtual host machine:
runs-on: ubuntu-latest
# Ensure initial reaction job has completed before running this job:
- needs: [ add_initial_reaction ]
+ needs: [add_initial_reaction]
# Define the conditions under which the job should run:
if: github.event.issue.pull_request && startsWith(github.event.comment.body, '/stdlib help')
@@ -206,7 +198,7 @@ jobs:
# Define the job's steps:
steps:
# Create a comment on the pull request informing the user of available slash commands:
- - name: 'Create a comment on the pull request informing the user of available slash commands'
+ - name: "Create a comment on the pull request informing the user of available slash commands"
# Pin action to full length commit SHA
uses: peter-evans/create-or-update-comment@71345be0265236311c031f5c7866368bd1eff043 # v4.0.0
with:
@@ -228,15 +220,23 @@ jobs:
# Define a job for removing the in-progress label:
remove_progress_label:
-
# Define a display name:
- name: 'Remove in-progress label'
+ name: "Remove in-progress label"
# Define the type of virtual host machine:
runs-on: ubuntu-latest
# Ensure all previous jobs have completed before running this job:
- needs: [ add_initial_reaction, check_files, update_copyright_years, fix_lint_errors, merge_develop, rebase_develop, help ]
+ needs:
+ [
+ add_initial_reaction,
+ check_files,
+ update_copyright_years,
+ fix_lint_errors,
+ merge_develop,
+ rebase_develop,
+ help,
+ ]
# Define the conditions under which the job should run:
if: |
diff --git a/.github/workflows/standalone_keepalive.yml b/.github/workflows/standalone_keepalive.yml
index 92b13489547c..a5b7036acb40 100644
--- a/.github/workflows/standalone_keepalive.yml
+++ b/.github/workflows/standalone_keepalive.yml
@@ -23,14 +23,13 @@ name: standalone_keepalive
on:
# Run the workflow on the first day of each week:
schedule:
- - cron: '0 0 * * 1'
+ - cron: "0 0 * * 1"
# Allow the workflow to be manually run:
workflow_dispatch:
# Workflow concurrency group:
concurrency:
-
# Specify a group name:
group: ${{ github.workflow }}
@@ -44,12 +43,10 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for scheduled updates to standalone packages...
keepalive:
-
# Define a display name:
- name: 'Keep alive'
+ name: "Keep alive"
# Ensure the job does not run on forks:
if: github.repository == 'stdlib-js/stdlib'
@@ -59,9 +56,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -76,33 +72,33 @@ jobs:
timeout-minutes: 10
# Configure Git:
- - name: 'Configure Git'
+ - name: "Configure Git"
run: |
git config --local user.email "82920195+stdlib-bot@users.noreply.github.com"
git config --local user.name "stdlib-bot"
# Apply Git notes:
- - name: 'Apply Git notes'
+ - name: "Apply Git notes"
run: |
make apply-git-notes
timeout-minutes: 5
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
- node-version: '20' # 'lts/*'
+ node-version: "20" # 'lts/*'
timeout-minutes: 5
# Install dependencies (accounting for possible network failures, etc, when installing node module dependencies):
- - name: 'Install dependencies'
+ - name: "Install dependencies"
run: |
make install-node-modules || make install-node-modules || make install-node-modules
timeout-minutes: 15
# Update standalone packages:
- - name: 'Update standalone packages'
+ - name: "Update standalone packages"
env:
GITHUB_TOKEN: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
run: |
diff --git a/.github/workflows/standalone_publish.yml b/.github/workflows/standalone_publish.yml
index 9e26f098c273..170da34552b7 100644
--- a/.github/workflows/standalone_publish.yml
+++ b/.github/workflows/standalone_publish.yml
@@ -26,30 +26,29 @@ on:
inputs:
release-type:
type: choice
- description: 'Type of release to create'
- default: 'none'
+ description: "Type of release to create"
+ default: "none"
options:
- - none
- - patch
- - minor
- - major
- - auto
+ - none
+ - patch
+ - minor
+ - major
+ - auto
dry-run:
type: boolean
- description: 'Skip uploading packages (dry run):'
+ description: "Skip uploading packages (dry run):"
default: false
start-index:
type: number
- description: 'Index of first package to publish'
+ description: "Index of first package to publish"
default: 0
end-index:
type: number
- description: 'Index of last package to publish'
+ description: "Index of last package to publish"
default: 9999
# Workflow concurrency group:
concurrency:
-
# Specify a group name:
group: ${{ github.workflow }}
@@ -63,21 +62,18 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for publishing standalone packages...
publish:
-
# Define a display name:
- name: 'Publish'
+ name: "Publish"
# Define the type of virtual host machine:
runs-on: ubuntu-latest
# Define the sequence of job steps...
steps:
-
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -92,32 +88,32 @@ jobs:
timeout-minutes: 10
# Configure Git:
- - name: 'Configure Git'
+ - name: "Configure Git"
run: |
git config --local user.email "82920195+stdlib-bot@users.noreply.github.com"
git config --local user.name "stdlib-bot"
# Apply Git notes:
- - name: 'Apply Git notes'
+ - name: "Apply Git notes"
run: |
make apply-git-notes
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
- node-version: '20' # 'lts/*'
+ node-version: "20" # 'lts/*'
timeout-minutes: 5
# Install dependencies (accounting for possible network failures, etc, when installing node module dependencies):
- - name: 'Install dependencies'
+ - name: "Install dependencies"
run: |
make install-node-modules || make install-node-modules || make install-node-modules
timeout-minutes: 15
# Publish standalone packages:
- - name: 'Publish packages'
+ - name: "Publish packages"
env:
GITHUB_TOKEN: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
@@ -128,7 +124,7 @@ jobs:
node lib/node_modules/@stdlib/_tools/scripts/publish_packages.js --skip-toplevel --release-type=${{ github.event.inputs.release-type }} --start-index=${{ github.event.inputs.start-index }} --end-index=${{ github.event.inputs.end-index }} ${{ github.event.inputs.dry-run == 'true' && '--skip-upload ' || '' }}
# Archive list of to be published packages:
- - name: 'Archive package list'
+ - name: "Archive package list"
# Pin action to full length commit SHA
uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0
with:
@@ -139,12 +135,11 @@ jobs:
# Define a job for sending notifications to Slack...
slack:
-
# Define a display name:
- name: 'Slack notification'
+ name: "Slack notification"
# Define the type of virtual host machine:
- runs-on: 'ubuntu-latest'
+ runs-on: "ubuntu-latest"
# Indicate that this job depends on the prior job finishing:
needs: publish
@@ -160,9 +155,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Resolve notification data:
- - name: 'Resolve notification data'
+ - name: "Resolve notification data"
run: |
echo 'NOTIFICATION_STATUS=${{ needs.publish.result}}' >> $GITHUB_ENV
if [[ "${{ needs.publish.result }}" = "success" ]]; then
@@ -180,7 +174,7 @@ jobs:
timeout-minutes: 5
# Send notification to Slack:
- - name: 'Send notification'
+ - name: "Send notification"
# Pin action to full length commit SHA
uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
if: success()
diff --git a/.github/workflows/standalone_publish_custom.yml b/.github/workflows/standalone_publish_custom.yml
index b39b29081193..c82b0e4df5b0 100644
--- a/.github/workflows/standalone_publish_custom.yml
+++ b/.github/workflows/standalone_publish_custom.yml
@@ -26,37 +26,36 @@ on:
inputs:
skip:
type: choice
- description: 'Skip individual or toplevel package publishing?'
+ description: "Skip individual or toplevel package publishing?"
options:
- - none
- - skip-toplevel
- - skip-individual
+ - none
+ - skip-toplevel
+ - skip-individual
packages:
- description: 'List of packages to publish (space separated):'
+ description: "List of packages to publish (space separated):"
pattern:
- description: 'Regular expression for packages to include:'
+ description: "Regular expression for packages to include:"
dry-run:
type: boolean
- description: 'Skip uploading packages (dry run):'
+ description: "Skip uploading packages (dry run):"
default: false
release-type:
type: choice
- description: 'Type of release to create'
- default: 'none'
+ description: "Type of release to create"
+ default: "none"
options:
- - none
- - patch
- - minor
- - major
- - auto
+ - none
+ - patch
+ - minor
+ - major
+ - auto
only-unpublished:
type: boolean
- description: 'Only publish packages that have not yet been published'
+ description: "Only publish packages that have not yet been published"
default: false
# Workflow concurrency group:
concurrency:
-
# Specify a group name:
group: ${{ github.workflow }}
@@ -70,21 +69,18 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for publishing standalone packages...
publish:
-
# Define a display name:
- name: 'Publish'
+ name: "Publish"
# Define the type of virtual host machine:
runs-on: ubuntu-latest
# Define the sequence of job steps...
steps:
-
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -99,33 +95,33 @@ jobs:
timeout-minutes: 10
# Configure Git:
- - name: 'Configure Git'
+ - name: "Configure Git"
run: |
git config --local user.email "82920195+stdlib-bot@users.noreply.github.com"
git config --local user.name "stdlib-bot"
# Apply Git notes:
- - name: 'Apply Git notes'
+ - name: "Apply Git notes"
run: |
make apply-git-notes
timeout-minutes: 5
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
- node-version: '20' # 'lts/*'
+ node-version: "20" # 'lts/*'
timeout-minutes: 5
# Install dependencies (accounting for possible network failures, etc, when installing node module dependencies):
- - name: 'Install dependencies'
+ - name: "Install dependencies"
run: |
make install-node-modules || make install-node-modules || make install-node-modules
timeout-minutes: 15
# Publish standalone packages:
- - name: 'Publish packages'
+ - name: "Publish packages"
env:
GITHUB_TOKEN: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
DEBUG: ${{ env.ACTIONS_STEP_DEBUG && 'scripts:publish-packages' || '' }}
diff --git a/.github/workflows/standalone_push_changes.yml b/.github/workflows/standalone_push_changes.yml
index 7f35b5b6f9a4..67b3c057679e 100644
--- a/.github/workflows/standalone_push_changes.yml
+++ b/.github/workflows/standalone_push_changes.yml
@@ -26,10 +26,10 @@ on:
- develop
paths:
# List paths for which changes should trigger this workflow:
- - 'lib/node_modules/@stdlib/**'
+ - "lib/node_modules/@stdlib/**"
# List paths for which changes should *not* trigger this workflow:
- - '!lib/node_modules/@stdlib/_tools/**'
+ - "!lib/node_modules/@stdlib/_tools/**"
# Global permissions:
permissions:
@@ -38,21 +38,18 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for pushing changes to standalone packages...
push:
-
# Define a display name:
- name: 'Push changes'
+ name: "Push changes"
# Define the type of virtual host machine:
runs-on: ubuntu-latest
# Define the sequence of job steps...
steps:
-
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -67,40 +64,40 @@ jobs:
timeout-minutes: 10
# Configure Git:
- - name: 'Configure Git'
+ - name: "Configure Git"
run: |
git config --local user.email "82920195+stdlib-bot@users.noreply.github.com"
git config --local user.name "stdlib-bot"
# Apply Git notes:
- - name: 'Apply Git notes'
+ - name: "Apply Git notes"
run: |
make apply-git-notes
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
- node-version: '20' # 'lts/*'
+ node-version: "20" # 'lts/*'
timeout-minutes: 5
# Install dependencies (accounting for possible network failures, etc, when installing node module dependencies):
- - name: 'Install dependencies'
+ - name: "Install dependencies"
run: |
make install-node-modules || make install-node-modules || make install-node-modules
timeout-minutes: 15
# Retrieve list of changed packages:
- - name: 'Find changed packages'
- id: 'changed_packages'
+ - name: "Find changed packages"
+ id: "changed_packages"
# Pin action to full length commit SHA
uses: stdlib-js/changed-packages-action@e489c6b4eff164c5912a0b2d17d7462f38c11712 # v2.0.0
with:
GITHUB_TOKEN: ${{ secrets.STDLIB_BOT_FGPAT_REPO_READ }}
# Push changes to the package repositories:
- - name: 'Push changes'
+ - name: "Push changes"
if: ${{ steps.changed_packages.outputs.packages != '[]' }}
env:
GITHUB_TOKEN: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
@@ -110,12 +107,11 @@ jobs:
# Define a job for sending notifications to Slack...
slack:
-
# Define a display name:
- name: 'Slack notification'
+ name: "Slack notification"
# Define the type of virtual host machine:
- runs-on: 'ubuntu-latest'
+ runs-on: "ubuntu-latest"
# Indicate that this job depends on the prior job finishing:
needs: push
@@ -131,9 +127,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Resolve notification data:
- - name: 'Resolve notification data'
+ - name: "Resolve notification data"
run: |
echo 'NOTIFICATION_STATUS=${{ needs.push.result}}' >> $GITHUB_ENV
if [[ "${{ needs.push.result }}" = "success" ]]; then
@@ -151,7 +146,7 @@ jobs:
timeout-minutes: 5
# Send notification to Slack:
- - name: 'Send notification'
+ - name: "Send notification"
# Pin action to full length commit SHA
uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
if: success()
diff --git a/.github/workflows/standalone_test.yml b/.github/workflows/standalone_test.yml
index 3aa1b442ecab..b5998e4e6d38 100644
--- a/.github/workflows/standalone_test.yml
+++ b/.github/workflows/standalone_test.yml
@@ -26,7 +26,6 @@ on:
# Workflow concurrency group:
concurrency:
-
# Specify a group name:
group: ${{ github.workflow }}
@@ -40,21 +39,18 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for triggering test workflows for standalone packages...
trigger:
-
# Define a display name:
- name: 'Trigger tests'
+ name: "Trigger tests"
# Define the type of virtual host machine:
runs-on: ubuntu-latest
# Define the sequence of job steps...
steps:
-
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -69,21 +65,21 @@ jobs:
timeout-minutes: 10
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
- node-version: '20' # 'lts/*'
+ node-version: "20" # 'lts/*'
timeout-minutes: 5
# Install dependencies (accounting for possible network failures, etc, when installing node module dependencies):
- - name: 'Install dependencies'
+ - name: "Install dependencies"
run: |
make install-node-modules || make install-node-modules || make install-node-modules
timeout-minutes: 15
# Trigger standalone package tests:
- - name: 'Trigger tests'
+ - name: "Trigger tests"
env:
GITHUB_TOKEN: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
run: |
@@ -91,12 +87,11 @@ jobs:
# Define a job for sending notifications to Slack...
slack:
-
# Define a display name:
- name: 'Slack notification'
+ name: "Slack notification"
# Define the type of virtual host machine:
- runs-on: 'ubuntu-latest'
+ runs-on: "ubuntu-latest"
# Indicate that this job depends on the prior job finishing:
needs: trigger
@@ -112,9 +107,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Resolve notification data:
- - name: 'Resolve notification data'
+ - name: "Resolve notification data"
run: |
echo 'NOTIFICATION_STATUS=${{ needs.trigger.result}}' >> $GITHUB_ENV
if [[ "${{ needs.trigger.result }}" = "success" ]]; then
@@ -132,7 +126,7 @@ jobs:
timeout-minutes: 5
# Send notification to Slack:
- - name: 'Send notification'
+ - name: "Send notification"
# Pin action to full length commit SHA
uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
if: success()
diff --git a/.github/workflows/terminal.yml b/.github/workflows/terminal.yml
index 91548319ac0d..e3aa3f0d626a 100644
--- a/.github/workflows/terminal.yml
+++ b/.github/workflows/terminal.yml
@@ -30,12 +30,10 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for running tests affected by changes to the repository...
process:
-
# Define a display name:
- name: 'Open Terminal'
+ name: "Open Terminal"
# Define the type of virtual host machine:
runs-on: ubuntu-latest
@@ -43,7 +41,7 @@ jobs:
# Define the sequence of job steps...
steps:
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -58,27 +56,27 @@ jobs:
timeout-minutes: 10
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
- node-version: '20' # 'lts/*'
+ node-version: "20" # 'lts/*'
timeout-minutes: 5
# Install dependencies (accounting for possible network failures, etc, when installing node module dependencies):
- - name: 'Install dependencies'
+ - name: "Install dependencies"
run: |
make install-node-modules || make install-node-modules || make install-node-modules
timeout-minutes: 15
# Initialize development environment:
- - name: 'Initialize development environment'
+ - name: "Initialize development environment"
run: |
make init
timeout-minutes: 5
# Import GPG key to sign commits:
- - name: 'Import GPG key to sign commits'
+ - name: "Import GPG key to sign commits"
# Pin action to full length commit SHA
uses: crazy-max/ghaction-import-gpg@cb9bde2e2525e640591a934b1fd28eef1dcaf5e5 # v6.2.0
with:
@@ -88,6 +86,6 @@ jobs:
git_commit_gpgsign: true
# Setup a terminal session:
- - name: 'Setup upterm session'
+ - name: "Setup upterm session"
# Pin action to full length commit SHA
uses: lhotari/action-upterm@b0357f23233f5ea6d58947c0c402e0631bab7334 # v1.0.0
diff --git a/.github/workflows/test_published_package.yml b/.github/workflows/test_published_package.yml
index 4d6ef003e012..fba991fe0da2 100644
--- a/.github/workflows/test_published_package.yml
+++ b/.github/workflows/test_published_package.yml
@@ -23,7 +23,7 @@ name: test_published_package
on:
# Run workflow on a weekly schedule:
schedule:
- - cron: '0 0 * * 0'
+ - cron: "0 0 * * 0"
# Allow workflow to be manually run:
workflow_dispatch:
@@ -37,7 +37,7 @@ permissions:
jobs:
test-published:
# Define a display name:
- name: 'Test running examples of published package'
+ name: "Test running examples of published package"
# Define the type of virtual host machine:
runs-on: ubuntu-latest
@@ -49,21 +49,21 @@ jobs:
# Define the job's steps:
steps:
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
# Do not persist GitHub token in local Git configuration since no continued authentication is needed:
persist-credentials: false
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
node-version: 20
timeout-minutes: 5
# Create test directory and run examples:
- - name: 'Create test directory and run examples'
+ - name: "Create test directory and run examples"
run: |
cd ..
mkdir test-published
@@ -96,9 +96,9 @@ jobs:
node index.js
# Send Slack notification if job fails:
- - name: 'Send notification to Slack in case of failure'
+ - name: "Send notification to Slack in case of failure"
uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
with:
status: ${{ job.status }}
- channel: '#npm-ci'
+ channel: "#npm-ci"
if: failure()
diff --git a/.github/workflows/track_todos.yml b/.github/workflows/track_todos.yml
index 233828a41f2b..a57950540fe9 100644
--- a/.github/workflows/track_todos.yml
+++ b/.github/workflows/track_todos.yml
@@ -23,7 +23,7 @@ name: track_todos
on:
schedule:
# Run the workflow once a month on the 1st day of every month:
- - cron: '0 0 1 * *'
+ - cron: "0 0 1 * *"
# Allow the workflow to be manually run:
workflow_dispatch:
@@ -35,12 +35,10 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for running tests affected by changes to the repository...
process:
-
# Define a display name:
- name: 'Track TODO and FIXME comments'
+ name: "Track TODO and FIXME comments"
# Ensure the job does not run on forks:
if: github.repository == 'stdlib-js/stdlib'
@@ -51,7 +49,7 @@ jobs:
# Define the sequence of job steps...
steps:
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -66,23 +64,23 @@ jobs:
timeout-minutes: 10
# Create content of tracking issue for TODO comments:
- - name: 'Create content of tracking issue for TODO comments'
+ - name: "Create content of tracking issue for TODO comments"
run: |
. "$GITHUB_WORKSPACE/.github/workflows/scripts/track_todos" > tracking_issue_todos.md
cat tracking_issue_todos.md >> $GITHUB_STEP_SUMMARY
# Create content of tracking issue for FIXME comments:
- - name: 'Create content of tracking issue for FIXME comments'
+ - name: "Create content of tracking issue for FIXME comments"
run: |
. "$GITHUB_WORKSPACE/.github/workflows/scripts/track_fixmes" > tracking_issue_fixmes.md
cat tracking_issue_fixmes.md >> $GITHUB_STEP_SUMMARY
# Create or update issue for TODO comments:
- - name: 'Create or update issue for TODO comments'
+ - name: "Create or update issue for TODO comments"
# Pin action to full length commit SHA
uses: peter-evans/create-issue-from-file@e8ef132d6df98ed982188e460ebb3b5d4ef3a9cd # v5.0.1
with:
- title: 'TODO comments'
+ title: "TODO comments"
content-filepath: ./tracking_issue_todos.md
issue-number: 803
token: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
@@ -91,11 +89,11 @@ jobs:
automated-issue
# Create or update issue for FIXME comments:
- - name: 'Create or update issue for FIXME comments'
+ - name: "Create or update issue for FIXME comments"
# Pin action to full length commit SHA
uses: peter-evans/create-issue-from-file@e8ef132d6df98ed982188e460ebb3b5d4ef3a9cd # v5.0.1
with:
- title: 'FIXME comments'
+ title: "FIXME comments"
content-filepath: ./tracking_issue_fixmes.md
issue-number: 804
token: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
diff --git a/.github/workflows/update_cli_permissions.yml b/.github/workflows/update_cli_permissions.yml
index 34f017b3974a..5c6a8643b1fa 100644
--- a/.github/workflows/update_cli_permissions.yml
+++ b/.github/workflows/update_cli_permissions.yml
@@ -23,7 +23,7 @@ name: update_cli_permissions
on:
schedule:
# Run the workflow once a week (Sunday at midnight):
- - cron: '0 0 * * 0'
+ - cron: "0 0 * * 0"
# Allow the workflow to be manually run:
workflow_dispatch:
@@ -35,12 +35,10 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for making CLI scripts executable:
update:
-
# Define a display name:
- name: 'Update CLI Permissions'
+ name: "Update CLI Permissions"
# Ensure the job does not run on forks:
if: github.repository == 'stdlib-js/stdlib'
@@ -50,9 +48,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -70,7 +67,7 @@ jobs:
timeout-minutes: 10
# Make CLI scripts executable:
- - name: 'Make CLI scripts executable'
+ - name: "Make CLI scripts executable"
run: |
files=$(find lib/node_modules/@stdlib -type d -name 'bin' -exec find {} -type f -name 'cli' \;)
@@ -79,12 +76,12 @@ jobs:
done
# Disable Git hooks:
- - name: 'Disable Git hooks'
+ - name: "Disable Git hooks"
run: |
rm -rf .git/hooks
# Import GPG key to sign commits:
- - name: 'Import GPG key to sign commits'
+ - name: "Import GPG key to sign commits"
# Pin action to full length commit SHA
uses: crazy-max/ghaction-import-gpg@cb9bde2e2525e640591a934b1fd28eef1dcaf5e5 # v6.2.0
with:
@@ -94,14 +91,14 @@ jobs:
git_commit_gpgsign: true
# Create a pull request with the updated files:
- - name: 'Create pull request'
+ - name: "Create pull request"
id: cpr
# Pin action to full length commit SHA
uses: peter-evans/create-pull-request@67ccf781d68cd99b580ae25a5c18a1cc84ffff1f # v7.0.6
with:
- title: 'fix: make CLI scripts executable'
- commit-message: 'fix: make CLI scripts executable'
- committer: 'stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>'
+ title: "fix: make CLI scripts executable"
+ commit-message: "fix: make CLI scripts executable"
+ committer: "stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>"
signoff: true
body: |
This PR changes the permissions of project `cli` scripts to be executable.
diff --git a/.github/workflows/update_contributors.yml b/.github/workflows/update_contributors.yml
index 7a2d58a4d687..68faaeb7d88f 100644
--- a/.github/workflows/update_contributors.yml
+++ b/.github/workflows/update_contributors.yml
@@ -23,7 +23,7 @@ name: update_contributors
on:
schedule:
# Run the workflow once a day at 2:00 AM UTC:
- - cron: '0 2 * * *'
+ - cron: "0 2 * * *"
# Allow the workflow to be manually run:
workflow_dispatch:
@@ -35,12 +35,10 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for updating the contributors list...
update-contributors:
-
# Define a display name:
- name: 'Update contributors'
+ name: "Update contributors"
# Ensure the job does not run on forks:
if: github.repository == 'stdlib-js/stdlib'
@@ -50,9 +48,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -60,7 +57,7 @@ jobs:
clean: true
# Refers to the development branch:
- ref: 'develop'
+ ref: "develop"
# Fetch entire history:
fetch-depth: 0
@@ -73,7 +70,7 @@ jobs:
timeout-minutes: 10
# Update the contributors list:
- - name: 'Update contributors'
+ - name: "Update contributors"
id: update-contributors
run: |
make update-contributors
@@ -86,7 +83,7 @@ jobs:
fi
# Import GPG key to sign commits:
- - name: 'Import GPG key to sign commits'
+ - name: "Import GPG key to sign commits"
# Pin action to full length commit SHA
uses: crazy-max/ghaction-import-gpg@cb9bde2e2525e640591a934b1fd28eef1dcaf5e5 # v6.2.0
with:
@@ -96,13 +93,13 @@ jobs:
git_commit_gpgsign: true
# Create a pull request:
- - name: 'Create pull request'
+ - name: "Create pull request"
if: steps.update-contributors.outputs.changed == 'true'
# Pin action to full length commit SHA
uses: peter-evans/create-pull-request@67ccf781d68cd99b580ae25a5c18a1cc84ffff1f # v7.0.6
id: cpr
with:
- title: 'docs: update list of contributors'
+ title: "docs: update list of contributors"
body: |
This PR
@@ -115,8 +112,8 @@ jobs:
- [ ] If updating `.mailmap`, **regenerate** the contributors file by running `make update-contributors` on the PR branch afterward.
- [ ] Approve the PR after verifying the changes.
- commit-message: 'docs: update list of contributors'
- committer: 'stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>'
+ commit-message: "docs: update list of contributors"
+ committer: "stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>"
signoff: true
token: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
labels: |
@@ -128,7 +125,7 @@ jobs:
delete-branch: true
# Create a pull request summary:
- - name: 'Create summary'
+ - name: "Create summary"
run: |
echo "# :tada: Pull Request created! :tada:" >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
diff --git a/.github/workflows/update_error_databases.yml b/.github/workflows/update_error_databases.yml
index d26034f13683..054591a2a714 100644
--- a/.github/workflows/update_error_databases.yml
+++ b/.github/workflows/update_error_databases.yml
@@ -23,7 +23,7 @@ name: update_error_databases
on:
schedule:
# Run the workflow once a week (Sunday at midnight):
- - cron: '0 0 * * 0'
+ - cron: "0 0 * * 0"
# Allow the workflow to be manually run:
workflow_dispatch:
@@ -35,12 +35,10 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for updating the error databases:
update:
-
# Define a display name:
- name: 'Update Error Databases'
+ name: "Update Error Databases"
# Ensure the job does not run on forks:
if: github.repository == 'stdlib-js/stdlib'
@@ -50,9 +48,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -70,28 +67,28 @@ jobs:
timeout-minutes: 10
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
- node-version: '20' # 'lts/*'
+ node-version: "20" # 'lts/*'
timeout-minutes: 5
# Install dependencies (accounting for possible network failures, etc, when installing node module dependencies):
- - name: 'Install dependencies'
+ - name: "Install dependencies"
run: |
make install-node-modules || make install-node-modules || make install-node-modules
timeout-minutes: 15
# Update the error databases:
- - name: 'Update error databases'
+ - name: "Update error databases"
run: |
node lib/node_modules/@stdlib/error/tools/database/scripts/build.js
node lib/node_modules/@stdlib/error/tools/pkg2id/scripts/build.js
node lib/node_modules/@stdlib/error/tools/id2pkg/scripts/build.js
# Check if there are any changes to the error databases:
- - name: 'Check for changes'
+ - name: "Check for changes"
id: check_changes
run: |
if [ -z "$(git diff lib/node_modules/@stdlib/error/tools/database/data/data.csv | grep '^+')" ]; then
@@ -103,7 +100,7 @@ jobs:
fi
# Generate comment with Markdown table of added error codes:
- - name: 'Generate comment body with Markdown table of added error codes'
+ - name: "Generate comment body with Markdown table of added error codes"
if: steps.check_changes.outputs.has_changes == 'true'
run: |
# Save the added lines from the diff to a temporary file:
@@ -138,13 +135,13 @@ jobs:
shell: bash
# Disable Git hooks:
- - name: 'Disable Git hooks'
+ - name: "Disable Git hooks"
if: steps.check_changes.outputs.has_changes == 'true'
run: |
rm -rf .git/hooks
# Import GPG key to sign commits:
- - name: 'Import GPG key to sign commits'
+ - name: "Import GPG key to sign commits"
if: steps.check_changes.outputs.has_changes == 'true'
# Pin action to full length commit SHA
uses: crazy-max/ghaction-import-gpg@cb9bde2e2525e640591a934b1fd28eef1dcaf5e5 # v6.2.0
@@ -155,16 +152,16 @@ jobs:
git_commit_gpgsign: true
# Create a pull request with the updated declarations:
- - name: 'Create pull request'
+ - name: "Create pull request"
if: steps.check_changes.outputs.has_changes == 'true'
id: cpr
# Pin action to full length commit SHA
uses: peter-evans/create-pull-request@67ccf781d68cd99b580ae25a5c18a1cc84ffff1f # v7.0.6
with:
- title: 'feat: update error databases'
+ title: "feat: update error databases"
body-path: /tmp/body.md
- commit-message: 'feat: update error databases'
- committer: 'stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>'
+ commit-message: "feat: update error databases"
+ committer: "stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>"
signoff: true
token: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
labels: |
diff --git a/.github/workflows/update_package_meta_data.yml b/.github/workflows/update_package_meta_data.yml
index 71704ec3f77b..fea0c0d4c803 100644
--- a/.github/workflows/update_package_meta_data.yml
+++ b/.github/workflows/update_package_meta_data.yml
@@ -27,7 +27,7 @@ on:
# Run the workflow on a schedule:
schedule:
# Run the workflow every week on Sunday at 00:00 UTC:
- - cron: '0 0 * * 0'
+ - cron: "0 0 * * 0"
# Global permissions:
permissions:
@@ -36,12 +36,10 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for updating `package.json` files...
update:
-
# Define a display name:
- name: 'Update meta data'
+ name: "Update meta data"
# Ensure the job does not run on forks:
if: github.repository == 'stdlib-js/stdlib'
@@ -51,9 +49,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -71,31 +68,31 @@ jobs:
timeout-minutes: 10
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
- node-version: '20' # 'lts/*'
+ node-version: "20" # 'lts/*'
timeout-minutes: 5
# Install dependencies (accounting for possible network failures, etc, when installing node module dependencies):
- - name: 'Install dependencies'
+ - name: "Install dependencies"
run: |
make install-node-modules || make install-node-modules || make install-node-modules
timeout-minutes: 15
# Update directories:
- - name: 'Update directories'
+ - name: "Update directories"
run: |
node lib/node_modules/@stdlib/_tools/package-json/scripts/update_directories lib/node_modules/@stdlib
# Update gypfile field:
- - name: 'Update gypfile field'
+ - name: "Update gypfile field"
run: |
node lib/node_modules/@stdlib/_tools/package-json/scripts/update_gypfile lib/node_modules/@stdlib
# Import GPG key to sign commits:
- - name: 'Import GPG key to sign commits'
+ - name: "Import GPG key to sign commits"
# Pin action to full length commit SHA
uses: crazy-max/ghaction-import-gpg@cb9bde2e2525e640591a934b1fd28eef1dcaf5e5 # v6.2.0
with:
@@ -105,19 +102,19 @@ jobs:
git_commit_gpgsign: true
# Create a pull request with the updated `package.json` files:
- - name: 'Create pull request'
+ - name: "Create pull request"
id: cpr
# Pin action to full length commit SHA
uses: peter-evans/create-pull-request@67ccf781d68cd99b580ae25a5c18a1cc84ffff1f # v7.0.6
with:
- title: 'chore: update package meta data'
+ title: "chore: update package meta data"
body: |
This PR
- updates package meta data
- commit-message: 'chore: update package meta data'
- committer: 'stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>'
+ commit-message: "chore: update package meta data"
+ committer: "stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>"
signoff: true
token: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
labels: |
@@ -128,7 +125,7 @@ jobs:
delete-branch: true
# Create a pull request summary:
- - name: 'Create summary'
+ - name: "Create summary"
run: |
echo "# :tada: Pull Request created! :tada:" >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
diff --git a/.github/workflows/update_pr_copyright_years.yml b/.github/workflows/update_pr_copyright_years.yml
index 74275f738236..12c47ad47b27 100644
--- a/.github/workflows/update_pr_copyright_years.yml
+++ b/.github/workflows/update_pr_copyright_years.yml
@@ -21,45 +21,41 @@ name: update_pr_copyright_years
# Workflow triggers:
on:
-
# Allow the workflow to be triggered by other workflows
workflow_call:
# Define the input parameters for the workflow:
inputs:
pull_request_number:
- description: 'PR number'
+ description: "PR number"
required: true
type: number
# Define the secrets accessible by the workflow:
secrets:
STDLIB_BOT_GITHUB_TOKEN:
- description: 'GitHub token for stdlib-bot'
+ description: "GitHub token for stdlib-bot"
required: true
STDLIB_BOT_GPG_PRIVATE_KEY:
- description: 'GPG private key for stdlib-bot'
+ description: "GPG private key for stdlib-bot"
required: true
STDLIB_BOT_GPG_PASSPHRASE:
- description: 'GPG passphrase for stdlib-bot'
+ description: "GPG passphrase for stdlib-bot"
required: true
# Workflow jobs:
jobs:
-
# Define a job for updating the copyright years:
update:
-
# Define a display name:
- name: 'Update Copyright Years'
+ name: "Update Copyright Years"
# Define the type of virtual host machine:
runs-on: ubuntu-latest
# Define the sequence of job steps...
steps:
-
# Get PR details:
- - name: 'Get PR details'
+ - name: "Get PR details"
id: pr-details
run: |
pr_response=$(curl -s \
@@ -79,7 +75,7 @@ jobs:
echo "repository=$pr_repo_full_name" >> $GITHUB_OUTPUT
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -93,10 +89,10 @@ jobs:
token: ${{ secrets.STDLIB_BOT_GITHUB_TOKEN }}
# File path to checkout to:
- path: './'
+ path: "./"
# Get list of added files:
- - name: 'Get list of added files'
+ - name: "Get list of added files"
id: added-files
run: |
page=1
@@ -114,19 +110,19 @@ jobs:
echo "files=${files}" >> $GITHUB_OUTPUT
# Update the copyright years:
- - name: 'Update copyright years'
+ - name: "Update copyright years"
id: update-years
run: |
files="${{ steps.added-files.outputs.files }}"
. "$GITHUB_WORKSPACE/.github/workflows/scripts/update_copyright_years" "$files"
# Disable Git hooks:
- - name: 'Disable Git hooks'
+ - name: "Disable Git hooks"
run: |
rm -rf .git/hooks
# Import GPG key to sign commits:
- - name: 'Import GPG key to sign commits'
+ - name: "Import GPG key to sign commits"
# Pin action to full length commit SHA
uses: crazy-max/ghaction-import-gpg@cb9bde2e2525e640591a934b1fd28eef1dcaf5e5 # v6.2.0
with:
@@ -136,12 +132,12 @@ jobs:
git_commit_gpgsign: true
# Commit and push changes:
- - name: 'Commit and push changes'
+ - name: "Commit and push changes"
env:
- REPO_GITHUB_TOKEN: ${{ secrets.STDLIB_BOT_GITHUB_TOKEN }}
- USER_NAME: stdlib-bot
- BRANCH_NAME: ${{ steps.pr-details.outputs.branch }}
- REPO_NAME: ${{ steps.pr-details.outputs.repository }}
+ REPO_GITHUB_TOKEN: ${{ secrets.STDLIB_BOT_GITHUB_TOKEN }}
+ USER_NAME: stdlib-bot
+ BRANCH_NAME: ${{ steps.pr-details.outputs.branch }}
+ REPO_NAME: ${{ steps.pr-details.outputs.repository }}
run: |
git config --local user.email "82920195+stdlib-bot@users.noreply.github.com"
git config --local user.name "$USER_NAME"
diff --git a/.github/workflows/update_repl_docs.yml b/.github/workflows/update_repl_docs.yml
index 3a17f8511410..f737035bc9b1 100644
--- a/.github/workflows/update_repl_docs.yml
+++ b/.github/workflows/update_repl_docs.yml
@@ -23,7 +23,7 @@ name: update_repl_docs
on:
schedule:
# Run the workflow once a day at 2:00 AM UTC:
- - cron: '0 2 * * *'
+ - cron: "0 2 * * *"
# Allow the workflow to be manually run:
workflow_dispatch:
@@ -35,12 +35,10 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for updating REPL documentation...
update:
-
# Define a display name:
- name: 'Update REPL docs'
+ name: "Update REPL docs"
# Ensure the job does not run on forks:
if: github.repository == 'stdlib-js/stdlib'
@@ -50,9 +48,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -70,37 +67,37 @@ jobs:
timeout-minutes: 10
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
# Pin action to full length commit SHA
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
- node-version: '20' # 'lts/*'
+ node-version: "20" # 'lts/*'
timeout-minutes: 5
# Install dependencies (accounting for possible network failures, etc, when installing node module dependencies):
- - name: 'Install dependencies'
+ - name: "Install dependencies"
run: |
make install-node-modules || make install-node-modules || make install-node-modules
timeout-minutes: 15
# Initialize development environment:
- - name: 'Initialize development environment'
+ - name: "Initialize development environment"
run: |
make init
timeout-minutes: 5
# Update REPL documentation:
- - name: 'Update documentation'
+ - name: "Update documentation"
run: |
make repl-docs
# Disable Git hooks:
- - name: 'Disable Git hooks'
+ - name: "Disable Git hooks"
run: |
rm -rf .git/hooks
# Import GPG key to sign commits:
- - name: 'Import GPG key to sign commits'
+ - name: "Import GPG key to sign commits"
# Pin action to full length commit SHA
uses: crazy-max/ghaction-import-gpg@cb9bde2e2525e640591a934b1fd28eef1dcaf5e5 # v6.2.0
with:
@@ -110,19 +107,19 @@ jobs:
git_commit_gpgsign: true
# Create a pull request:
- - name: 'Create pull request'
+ - name: "Create pull request"
id: cpr
# Pin action to full length commit SHA
uses: peter-evans/create-pull-request@67ccf781d68cd99b580ae25a5c18a1cc84ffff1f # v7.0.6
with:
- title: 'docs: update REPL namespace documentation'
+ title: "docs: update REPL namespace documentation"
body: |
This PR
- updates the REPL namespace documentation
- commit-message: 'docs: update REPL namespace documentation'
- committer: 'stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>'
+ commit-message: "docs: update REPL namespace documentation"
+ committer: "stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>"
signoff: true
token: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
labels: |
@@ -134,7 +131,7 @@ jobs:
delete-branch: true
# Create a pull request summary:
- - name: 'Create summary'
+ - name: "Create summary"
run: |
echo "# :tada: Pull Request created! :tada:" >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
diff --git a/.github/workflows/windows_test_npm_install.yml b/.github/workflows/windows_test_npm_install.yml
index 5e852577378f..67f44ccaff4e 100644
--- a/.github/workflows/windows_test_npm_install.yml
+++ b/.github/workflows/windows_test_npm_install.yml
@@ -23,14 +23,13 @@ name: windows_test_npm_install
on:
# Run nightly:
schedule:
- - cron: '0 9 * * *'
+ - cron: "0 9 * * *"
# Allow the workflow to be manually run:
workflow_dispatch:
# Workflow concurrency group:
concurrency:
-
# Specify a group name:
group: ${{ github.workflow }}
@@ -44,10 +43,8 @@ permissions:
# Workflow jobs:
jobs:
-
# Define a job for testing project installation on Windows...
test_npm_install:
-
# Define a display name:
name: "Node.js v${{ matrix.NODE_VERSION }}"
@@ -59,35 +56,33 @@ jobs:
# Define environment variables:
env:
- FC: 'gfortran'
- FORTRAN_COMPILER: 'gfortran'
- CC: 'gcc'
- C_COMPILER: 'gcc'
- CXX: 'g++'
- CXX_COMPILER: 'g++'
- LINKER: 'g++'
- GITHUB: 'true'
+ FC: "gfortran"
+ FORTRAN_COMPILER: "gfortran"
+ CC: "gcc"
+ C_COMPILER: "gcc"
+ CXX: "g++"
+ CXX_COMPILER: "g++"
+ LINKER: "g++"
+ GITHUB: "true"
LOG_DIR: "${{ github.workspace }}\\tmp\\var\\log"
LOG_FILE_BUILD_TASK: "${{ github.workspace }}\\\\tmp\\\\var\\\\log\\\\${{ matrix.BUILD_TASK }}.log"
LOG_NUM_LINES: 5000
# Define the build matrix strategy...
strategy:
-
# Specify whether to cancel all in-progress jobs if any matrix job fails:
fail-fast: false
# Define the build matrix:
matrix:
-
# Define the list of build tasks:
- BUILD_TASK: ['test-npm-install']
+ BUILD_TASK: ["test-npm-install"]
# Define the list of Node.js versions:
- NODE_VERSION: ['20', '18', '16', '14', '12', '10', '8', '6', '4']
+ NODE_VERSION: ["20", "18", "16", "14", "12", "10", "8", "6", "4"]
# Define the list of operating systems:
- OS: ['windows-latest']
+ OS: ["windows-latest"]
# Define the list of host architectures:
ARCHITECTURE:
@@ -95,35 +90,35 @@ jobs:
# Define configuration options for each Node.js version:
include:
- - OS: 'windows-latest'
- PLATFORM: 'windows'
+ - OS: "windows-latest"
+ PLATFORM: "windows"
- - NODE_VERSION: '20'
- NPM_VERSION: '>10.0.0'
+ - NODE_VERSION: "20"
+ NPM_VERSION: ">10.0.0"
- - NODE_VERSION: '18'
- NPM_VERSION: '>10.0.0'
+ - NODE_VERSION: "18"
+ NPM_VERSION: ">10.0.0"
- - NODE_VERSION: '16'
- NPM_VERSION: '>2.7.0 <10.0.0'
+ - NODE_VERSION: "16"
+ NPM_VERSION: ">2.7.0 <10.0.0"
- - NODE_VERSION: '14'
- NPM_VERSION: '>2.7.0 <10.0.0'
+ - NODE_VERSION: "14"
+ NPM_VERSION: ">2.7.0 <10.0.0"
- - NODE_VERSION: '12'
- NPM_VERSION: '>2.7.0 <9.0.0'
+ - NODE_VERSION: "12"
+ NPM_VERSION: ">2.7.0 <9.0.0"
- - NODE_VERSION: '10'
- NPM_VERSION: '>2.7.0 <7.0.0'
+ - NODE_VERSION: "10"
+ NPM_VERSION: ">2.7.0 <7.0.0"
- - NODE_VERSION: '8'
- NPM_VERSION: '>2.7.0 <6.0.0'
+ - NODE_VERSION: "8"
+ NPM_VERSION: ">2.7.0 <6.0.0"
- - NODE_VERSION: '6'
- NPM_VERSION: '>2.7.0 <6.0.0'
+ - NODE_VERSION: "6"
+ NPM_VERSION: ">2.7.0 <6.0.0"
- - NODE_VERSION: '4'
- NPM_VERSION: '>2.7.0 <6.0.0'
+ - NODE_VERSION: "4"
+ NPM_VERSION: ">2.7.0 <6.0.0"
# Set defaults:
defaults:
@@ -133,9 +128,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Checkout the repository:
- - name: 'Checkout repository'
+ - name: "Checkout repository"
# Pin action to full length commit SHA
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
@@ -153,7 +147,7 @@ jobs:
timeout-minutes: 10
# Install MSYS2:
- - name: 'Install MSYS2'
+ - name: "Install MSYS2"
# Pin action to full length commit SHA
uses: msys2/setup-msys2@d44ca8e88d8b43d56cf5670f91747359d5537f97 # v2.26.0
with:
@@ -168,14 +162,14 @@ jobs:
timeout-minutes: 10
# Initialize log files:
- - name: 'Initialize log files'
+ - name: "Initialize log files"
run: |
mkdir -p "${{ env.LOG_DIR }}"
touch "${{ env.LOG_FILE_BUILD_TASK }}"
timeout-minutes: 2
# Configure Git:
- - name: 'Configure Git'
+ - name: "Configure Git"
# Instruct Git to convert CRLF line endings (Windows) to LF on commit and force Git to use HTTPS rather than SSH.
#
@@ -187,14 +181,14 @@ jobs:
timeout-minutes: 2
# Configure NVS:
- - name: 'Configure NVS'
+ - name: "Configure NVS"
run: |
echo "NVS_HOME=$HOME/.nvs" >> $GITHUB_ENV
echo "NVS_LINK_TO_SYSTEM=1" >> $GITHUB_ENV
timeout-minutes: 2
# Install Node.js:
- - name: 'Install Node.js'
+ - name: "Install Node.js"
run: |
echo 'Cloning NVS...'
git clone https://github.com/jasongin/nvs "${{ env.NVS_HOME }}"
@@ -210,7 +204,7 @@ jobs:
timeout-minutes: 15
# Print debug info:
- - name: 'Print debug info'
+ - name: "Print debug info"
run: |
. "${{ env.NVS_HOME }}/nvs.sh" && nvs use ${{ matrix.NODE_VERSION }}
echo 'PATH:'
@@ -235,7 +229,7 @@ jobs:
timeout-minutes: 2
# Update the npm client (older clients cannot handle scoped modules):
- - name: 'Update npm'
+ - name: "Update npm"
run: |
. "${{ env.NVS_HOME }}/nvs.sh" && nvs use ${{ matrix.NODE_VERSION }}
npm install -g npm@"${{ matrix.NPM_VERSION }}"
@@ -243,7 +237,7 @@ jobs:
timeout-minutes: 5
# Install Windows build tools for compiling Node.js native add-ons.
- - name: 'Install Windows build tools'
+ - name: "Install Windows build tools"
# Pin action to full length commit SHA
uses: crazy-max/ghaction-chocolatey@2ae99523e93879734d432250f87e2c45c379cd60 # v3.2.0
with:
@@ -251,7 +245,7 @@ jobs:
timeout-minutes: 10
# View the log file if the previous step fails:
- - name: 'View log file'
+ - name: "View log file"
if: failure()
run: |
echo "Printing the last ${{ env.LOG_NUM_LINES }} lines of log output..."
@@ -259,25 +253,25 @@ jobs:
timeout-minutes: 5
# Configure npm:
- - name: 'Configure npm'
+ - name: "Configure npm"
run: |
. "${{ env.NVS_HOME }}/nvs.sh" && nvs use ${{ matrix.NODE_VERSION }}
npm config set msvs_version 2019
timeout-minutes: 2
# Run the build task:
- - name: 'Run build task'
+ - name: "Run build task"
env:
# Explicitly set computed environment variables:
- TEST_NPM_INSTALL_PKG: '@stdlib/stdlib'
- TEST_NPM_INSTALL_GITHUB_URL: 'https://github.com/stdlib-js/stdlib'
+ TEST_NPM_INSTALL_PKG: "@stdlib/stdlib"
+ TEST_NPM_INSTALL_GITHUB_URL: "https://github.com/stdlib-js/stdlib"
run: |
. "${{ env.NVS_HOME }}/nvs.sh" && nvs use ${{ matrix.NODE_VERSION }}
. "$GITHUB_WORKSPACE/.github/workflows/scripts/task_runner" ${{ matrix.BUILD_TASK }} "${{ env.LOG_FILE_BUILD_TASK }}"
timeout-minutes: 360
# View the log file if the previous step fails:
- - name: 'View log file'
+ - name: "View log file"
if: failure()
run: |
echo "Printing the last ${{ env.LOG_NUM_LINES }} lines of log output..."
@@ -285,7 +279,7 @@ jobs:
timeout-minutes: 5
# Upload the log file:
- - name: 'Upload log file'
+ - name: "Upload log file"
# Pin action to full length commit SHA
uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0
if: always()
@@ -302,12 +296,11 @@ jobs:
# Define a job for sending notifications to Slack...
slack:
-
# Define a display name:
- name: 'Slack notification'
+ name: "Slack notification"
# Define the type of virtual host machine:
- runs-on: 'ubuntu-latest'
+ runs-on: "ubuntu-latest"
# Indicate that this job depends on the prior job finishing:
needs: test_npm_install
@@ -323,9 +316,8 @@ jobs:
# Define the sequence of job steps...
steps:
-
# Resolve notification data:
- - name: 'Resolve notification data'
+ - name: "Resolve notification data"
run: |
echo 'NOTIFICATION_STATUS=${{ needs.test_npm_install.result}}' >> $GITHUB_ENV
if [[ "${{ needs.test_npm_install.result }}" = "success" ]]; then
@@ -343,7 +335,7 @@ jobs:
timeout-minutes: 5
# Send notification to Slack:
- - name: 'Send notification'
+ - name: "Send notification"
# Pin action to full length commit SHA
uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
if: success()
diff --git a/.travis.yml b/.travis.yml
index bac61723e462..34ef39497696 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -32,7 +32,7 @@ dist: xenial
# Specify the list of Node.js versions on which we want to build:
node_js:
# Node.js
- - '16'
+ - "16"
# Specify which branches should trigger builds:
branches:
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
index 5cf845c15be6..dd1b2fa4bd3f 100644
--- a/CODE_OF_CONDUCT.md
+++ b/CODE_OF_CONDUCT.md
@@ -32,43 +32,43 @@ We ask that you respect that people have differences of opinion regarding techni
The following behaviors are **expected** of **all** community members:
-- Be careful in the words you choose.
-- Use welcoming and inclusive language.
-- Refrain from demeaning, discriminatory, or harassing behavior and speech.
-- Avoid sarcasm in **any** form. What is considered benign by you is seen as caustic by others.
-- Be respectful of differing viewpoints and experiences.
-- Resist the urge to be defensive if someone takes issue with something you said or did. Even if you feel misinterpreted or unfairly accused, in all likelihood, you probably could have communicated better. **Remember**: it is **your** responsibility to make fellow community members comfortable and feel respected.
-- Keep unstructured critique to a minimum. If you have solid contribution ideas, make a fork, experiment, and evaluate accordingly.
-- Gracefully accept constructive criticism.
-- Attempt collaboration before conflict.
-- Always be professional.
-- Show empathy toward other community members.
-- Focus on what is best for the community.
+- Be careful in the words you choose.
+- Use welcoming and inclusive language.
+- Refrain from demeaning, discriminatory, or harassing behavior and speech.
+- Avoid sarcasm in **any** form. What is considered benign by you is seen as caustic by others.
+- Be respectful of differing viewpoints and experiences.
+- Resist the urge to be defensive if someone takes issue with something you said or did. Even if you feel misinterpreted or unfairly accused, in all likelihood, you probably could have communicated better. **Remember**: it is **your** responsibility to make fellow community members comfortable and feel respected.
+- Keep unstructured critique to a minimum. If you have solid contribution ideas, make a fork, experiment, and evaluate accordingly.
+- Gracefully accept constructive criticism.
+- Attempt collaboration before conflict.
+- Always be professional.
+- Show empathy toward other community members.
+- Focus on what is best for the community.
## Unacceptable Behavior
The following behaviors are considered harassment, are unacceptable within our community, and will **not** be tolerated:
-- Personal insults.
-- Deliberate intimidation.
-- Harmful or prejudicial verbal or written comments related to gender identity, sexual orientation, ability, ethnicity, religion, age, physical appearance, body size, race, or other personal characteristics.
-- Deliberate "outing" of any aspect of a person's identity without their consent, except as necessary to protect others from intentional abuse.
-- Unwelcome comments regarding a person's lifestyle choices and practices, including those related to food, health, parenting, drugs, and employment.
-- Deliberate misgendering. This includes deadnaming or persistently using a pronoun that does not correctly reflect a person's gender identity.
-- Posting or displaying sexually explicit or violent material.
-- Posting or threatening to post personally identifying information ("doxing").
-- Stalking or following (online or in person).
-- Any spamming, trolling, flaming, baiting, or other attention-stealing behavior.
-- Harassing photography or recording, including logging online activity for harassment purposes.
-- Violence, threats of violence (physical or psychological), or violent language.
-- Public or private harassment.
-- Unwelcome sexual attention, including gratuitous or off-topic sexual images or behavior.
-- Physical or simulated contact without consent or after a request to stop.
-- Continued one-on-one communication after requests to cease.
-- Publication of non-harassing private communication.
-- Sustained disruption of discussion.
-- Any other conduct which could reasonably be considered inappropriate in a professional setting.
-- Advocating for, or encouraging, any of the above behavior, including but not limited to "liking", "starring", "retweeting", or any other form of promotion.
+- Personal insults.
+- Deliberate intimidation.
+- Harmful or prejudicial verbal or written comments related to gender identity, sexual orientation, ability, ethnicity, religion, age, physical appearance, body size, race, or other personal characteristics.
+- Deliberate "outing" of any aspect of a person's identity without their consent, except as necessary to protect others from intentional abuse.
+- Unwelcome comments regarding a person's lifestyle choices and practices, including those related to food, health, parenting, drugs, and employment.
+- Deliberate misgendering. This includes deadnaming or persistently using a pronoun that does not correctly reflect a person's gender identity.
+- Posting or displaying sexually explicit or violent material.
+- Posting or threatening to post personally identifying information ("doxing").
+- Stalking or following (online or in person).
+- Any spamming, trolling, flaming, baiting, or other attention-stealing behavior.
+- Harassing photography or recording, including logging online activity for harassment purposes.
+- Violence, threats of violence (physical or psychological), or violent language.
+- Public or private harassment.
+- Unwelcome sexual attention, including gratuitous or off-topic sexual images or behavior.
+- Physical or simulated contact without consent or after a request to stop.
+- Continued one-on-one communication after requests to cease.
+- Publication of non-harassing private communication.
+- Sustained disruption of discussion.
+- Any other conduct which could reasonably be considered inappropriate in a professional setting.
+- Advocating for, or encouraging, any of the above behavior, including but not limited to "liking", "starring", "retweeting", or any other form of promotion.
Note that your free speech is not **our** problem. That this policy is a restrictive political stance is intentional. If you want different rules, go create a separate project.
@@ -89,14 +89,14 @@ Project owners are held to a higher standard than other community members. If an
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the [reporting team][reporting]. In your report, please include
-- Your contact information.
-- Names (real, nicknames, or pseudonyms) of any individuals involved. If available, any additional witnesses.
-- An account of what occurred, and if you believe the incident is ongoing.
-- If available, a public record (e.g., a link to a mailing list archive, public IRC logger, Tweet, or issue thread).
-- Any prior records of behavior either inside or outside the community which can be used to establish prior precedent.
-- Any additional information that may be helpful.
+- Your contact information.
+- Names (real, nicknames, or pseudonyms) of any individuals involved. If available, any additional witnesses.
+- An account of what occurred, and if you believe the incident is ongoing.
+- If available, a public record (e.g., a link to a mailing list archive, public IRC logger, Tweet, or issue thread).
+- Any prior records of behavior either inside or outside the community which can be used to establish prior precedent.
+- Any additional information that may be helpful.
-All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate. Complaint recipients are obligated to maintain confidentiality with regard to the reporter of an incident.
+All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate. Complaint recipients are obligated to maintain confidentiality with regard to the reporter of an incident.
If an accused person is part of the reporting team, they will recuse themselves from handling your incident. If the reporter is a reporting team member, the complaint will be handled by a different member of the reporting team.
@@ -112,11 +112,11 @@ If you feel you have been falsely or unfairly accused of violating this Code of
Note that we prioritize marginalized people's safety over privileged people's comfort. We will **not** act on complaints regarding:
-- "Reverse"-isms, including "reverse racism," "reverse sexism," and "cisphobia"
-- Reasonable communication of boundaries, such as "leave me alone," "go away," or "I'm not discussing this with you."
-- Refusal to explain or debate social justice concepts.
-- Communicating in a "tone" you do not find congenial.
-- Criticizing racist, sexist, cissexist, or otherwise oppressive behavior or assumptions.
+- "Reverse"-isms, including "reverse racism," "reverse sexism," and "cisphobia"
+- Reasonable communication of boundaries, such as "leave me alone," "go away," or "I'm not discussing this with you."
+- Refusal to explain or debate social justice concepts.
+- Communicating in a "tone" you do not find congenial.
+- Criticizing racist, sexist, cissexist, or otherwise oppressive behavior or assumptions.
## Changes
@@ -124,15 +124,15 @@ This is a living document and may be updated over time. Refer to the [git histor
## Attribution
-This Code of Conduct borrows heavily from
+This Code of Conduct borrows heavily from
-- [npm Code of Conduct][npm-code-of-conduct]
-- [#node.js IRC policy on trolling][nodejs-irc]
-- Stumptown Syndicate [Citizen Code of Conduct][citizen-code-of-conduct]
-- Geek Feminism [Code of Conduct][geek-feminism-code-of-conduct]
-- [Contributor Covenant][contributor-covenant]
-- [Open Code of Conduct][open-code-of-conduct]
-- [The Rust Code of Conduct][rust-code-of-conduct]
+- [npm Code of Conduct][npm-code-of-conduct]
+- [#node.js IRC policy on trolling][nodejs-irc]
+- Stumptown Syndicate [Citizen Code of Conduct][citizen-code-of-conduct]
+- Geek Feminism [Code of Conduct][geek-feminism-code-of-conduct]
+- [Contributor Covenant][contributor-covenant]
+- [Open Code of Conduct][open-code-of-conduct]
+- [The Rust Code of Conduct][rust-code-of-conduct]
## License
@@ -141,23 +141,14 @@ This document may be reused under a [Creative Commons Attribution-ShareAlike 4.0
<section class="links">
[git-history]: https://github.com/stdlib-js/stdlib/commits/develop/CODE_OF_CONDUCT.md
-
[npm-code-of-conduct]: https://docs.npmjs.com/policies/conduct
-
[nodejs-irc]: https://blog.izs.me/2012/08/policy-on-trolling
-
[citizen-code-of-conduct]: https://github.com/stumpsyn/policies/blob/7caa4699ba74e341a46b3266d4610af477ba2c3d/citizen_code_of_conduct.md
-
[geek-feminism-code-of-conduct]: https://geekfeminismdotorg.wordpress.com/about/code-of-conduct/
-
[contributor-covenant]: https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md
-
[open-code-of-conduct]: https://github.com/todogroup/opencodeofconduct
-
[rust-code-of-conduct]: https://www.rust-lang.org/policies/code-of-conduct
-
[cc-by-sa-4.0]: https://creativecommons.org/licenses/by-sa/4.0/
-
[reporting]: mailto:kgryte@gmail.com
</section>
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index fdef9e2906f1..f439f82f893b 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -38,8 +38,8 @@ When filing new [issues][stdlib-issues] and commenting on existing [issues][stdl
**Before** filing a potential bug report,
-- Search for existing [issues][stdlib-issues] and [pull requests][stdlib-pull-requests].
-- Try some debugging techniques to help isolate the problem, including logging inputs and outputs.
+- Search for existing [issues][stdlib-issues] and [pull requests][stdlib-pull-requests].
+- Try some debugging techniques to help isolate the problem, including logging inputs and outputs.
If the source of the problem is a third party package, file a bug report with the relevant package author, rather than on this repository.
@@ -53,13 +53,13 @@ Unfortunately, we are not able to investigate or fix bugs without a minimal repr
When filing an [issue][stdlib-issues], provide the following, where possible:
-- A description of the issue.
-- Links to any related issues.
-- The full error message, including the stacktrace.
-- The sequence of steps required to reproduce the issue.
-- A minimal working example (i.e., the smallest chunk of code that triggers the error.) Ideally, the code can be pasted into a REPL or run from a source file. If the code is larger than `100` lines, consider creating a [gist][github-gist].
-- The expected results.
-- List of affected environments (e.g., browser, browser version, `npm` version, Node.js version, operating system, and stdlib version).
+- A description of the issue.
+- Links to any related issues.
+- The full error message, including the stacktrace.
+- The sequence of steps required to reproduce the issue.
+- A minimal working example (i.e., the smallest chunk of code that triggers the error.) Ideally, the code can be pasted into a REPL or run from a source file. If the code is larger than `100` lines, consider creating a [gist][github-gist].
+- The expected results.
+- List of affected environments (e.g., browser, browser version, `npm` version, Node.js version, operating system, and stdlib version).
When pasting code blocks or output, use triple backticks to enable proper formatting. Surround inline code with single backticks. For other Markdown formatting tips and trips, see GitHub's [Markdown guide][github-markdown-guide].
@@ -71,36 +71,36 @@ Be aware that the `@` symbol tags users on GitHub, so **always** surround packag
**Before** contributing code, be sure to
-- read and understand the [licensing terms][stdlib-license].
-- read and understand the [style guides][stdlib-style-guides].
-- read and understand the [doctest guide][stdlib-doctest].
+- read and understand the [licensing terms][stdlib-license].
+- read and understand the [style guides][stdlib-style-guides].
+- read and understand the [doctest guide][stdlib-doctest].
For instructions on how to setup and configure your environment, be sure to
-- read and follow the [development guide][stdlib-development].
+- read and follow the [development guide][stdlib-development].
If you have found a bug that you would like to fix,
-- file an [issue][stdlib-issues] on the project GitHub issue [tracker][stdlib-issues] describing the bug as instructed [above](#issues).
-- wait for feedback.
-- submit a [pull request][stdlib-pull-requests] with your proposed changes.
+- file an [issue][stdlib-issues] on the project GitHub issue [tracker][stdlib-issues] describing the bug as instructed [above](#issues).
+- wait for feedback.
+- submit a [pull request][stdlib-pull-requests] with your proposed changes.
If you want to contribute a new feature or a breaking change to stdlib, be sure to
-- consult the [Gitter][stdlib-gitter] channel to discuss ideas and to gather feedback as to whether a feature would be better developed as an external package. Discussing the design upfront helps ensure that we're ready to accept to your work.
-- write an RFC (request for comments) detailing the proposed change and submit as an issue on the project GitHub issue tracker.
-- wait for RFC approval.
-- submit a [pull request][stdlib-pull-requests], making sure to adhere to the guidance set forth in the RFC.
+- consult the [Gitter][stdlib-gitter] channel to discuss ideas and to gather feedback as to whether a feature would be better developed as an external package. Discussing the design upfront helps ensure that we're ready to accept to your work.
+- write an RFC (request for comments) detailing the proposed change and submit as an issue on the project GitHub issue tracker.
+- wait for RFC approval.
+- submit a [pull request][stdlib-pull-requests], making sure to adhere to the guidance set forth in the RFC.
If you want to contribute a new package, be sure to
-- read and follow the [package development guide][stdlib-packages].
-- read and follow the [REPL text guide][stdlib-repl-text].
+- read and follow the [package development guide][stdlib-packages].
+- read and follow the [REPL text guide][stdlib-repl-text].
If you are unfamiliar with [Git][git], the version control system used by GitHub and this project,
-- see the [Git][git] docs.
-- try a tutorial, such as the [tutorial][github-git-tutorial] provided by GitHub.
+- see the [Git][git] docs.
+- try a tutorial, such as the [tutorial][github-git-tutorial] provided by GitHub.
Next, take a look around the project, noting the style and organization of documentation, tests, examples, benchmarks, and source implementations. Consistency is highly **prioritized** within stdlib. Thus, the more you are able to match and adhere to project conventions and style, the more likely your contribution will be accepted. While we have done our best to automate linting and style guidelines, project automation is not perfect and cannot adequately capture the inevitable exceptions and nuance to many rules. In short, the more you study existing practice, the better prepared you will be to contribute to stdlib.
@@ -332,8 +332,8 @@ Note that, in most cases during the merge process, multiple commits will be [squ
### GitHub
-- When linking to specific lines of code in an issue or a pull request, hit the `y` key while viewing a file on GitHub. Doing so reloads the page with a URL that includes the specific version of the file you are viewing. This ensures that, when you refer to specific lines, these same lines can be easily viewed in the future, even if the content of the file changes.
-- GitHub does not send notifications to project maintainers when you push a commit and update a [pull request][github-pull-request], so be sure to comment on the pull request thread to inform reviewers that you have made changes and request another review using the GitHub UI.
+- When linking to specific lines of code in an issue or a pull request, hit the `y` key while viewing a file on GitHub. Doing so reloads the page with a URL that includes the specific version of the file you are viewing. This ensures that, when you refer to specific lines, these same lines can be easily viewed in the future, even if the content of the file changes.
+- GitHub does not send notifications to project maintainers when you push a commit and update a [pull request][github-pull-request], so be sure to comment on the pull request thread to inform reviewers that you have made changes and request another review using the GitHub UI.
### Writing Tests
@@ -414,10 +414,10 @@ Only a project administrator can manually trigger a build.
By making a contribution to this project, I certify that:
-- (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
-- (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
-- (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
-- (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.
+- (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
+- (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
+- (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
+- (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.
## Conclusion
@@ -426,63 +426,34 @@ Phew. While the above may be a lot to remember, even for what seem like minor ch
<section class="links">
[stdlib-code-of-conduct]: https://github.com/stdlib-js/stdlib/blob/develop/CODE_OF_CONDUCT.md
-
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stdlib/develop/LICENSE
-
[stdlib-style-guides]: https://github.com/stdlib-js/stdlib/blob/develop/docs/style-guides
-
[stdlib-style-guides-text]: https://github.com/stdlib-js/stdlib/blob/develop/docs/style-guides/text
-
[stdlib-style-guides-git]: https://github.com/stdlib-js/stdlib/blob/develop/docs/style-guides/git
-
[stdlib-doctest]: https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/doctest.md
-
[stdlib-development]: https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md
-
[stdlib-branching]: https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/branching.md
-
[stdlib-packages]: https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/packages.md
-
[stdlib-repl-text]: https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/repl_text.md
-
[stdlib-faq]: https://github.com/stdlib-js/stdlib/blob/develop/FAQ.md
-
[stdlib-code-coverage]: https://codecov.io/github/stdlib-js/stdlib/branch/develop
-
[stdlib-gitter]: https://gitter.im/stdlib-js/stdlib
-
[stdlib-issues]: https://github.com/stdlib-js/stdlib/issues
-
[stdlib-pull-requests]: https://github.com/stdlib-js/stdlib/pulls
-
[open-collective-stdlib]: https://opencollective.com/stdlib
-
[github-signup]: https://github.com/signup/free
-
[github-pull-request]: https://help.github.com/articles/creating-a-pull-request/
-
[github-gist]: https://gist.github.com/
-
[github-markdown-guide]: https://guides.github.com/features/mastering-markdown/
-
[github-fork]: https://help.github.com/articles/fork-a-repo/
-
[github-git-tutorial]: http://try.github.io/levels/1/challenges/1
-
[git]: http://git-scm.com/
-
[git-clone-depth]: https://git-scm.com/docs/git-clone#git-clone---depthltdepthgt
-
[git-remotes]: https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes
-
[git-rebase]: https://git-scm.com/docs/git-rebase
-
[git-merge]: https://git-scm.com/docs/git-merge
-
[git-rewriting-history]: https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History
-
[git-commit-squash]: https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---squashltcommitgt
-
[git-commit-fixup]: https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---fixupamendrewordltcommitgt
</section>
diff --git a/CORE_CONTRIBUTORS.md b/CORE_CONTRIBUTORS.md
index cbf298d32d18..116b733b51f7 100644
--- a/CORE_CONTRIBUTORS.md
+++ b/CORE_CONTRIBUTORS.md
@@ -26,50 +26,36 @@ For information about the governance of the stdlib project, see [GOVERNANCE.md][
## Core Contributors
-- [kgryte][athan-reines-github] - **Athan Reines** <[kgryte@gmail.com][athan-reines-email]> (he/him)
-- [Planeshifter][philipp-burckhardt-github] - **Philipp Burckhardt** <[pburckhardt@outlook.com][philipp-burckhardt-email]> (he/him)
-- [gunjjoshi][gunj-joshi-github] - **Gunj Joshi** <[gunjjoshi8372@gmail.com][gunj-joshi-email]> (he/him)
-- [headlessNode][muhammad-haris-github] - **Muhammad Haris** <[harriskhan047@outlook.com][muhammad-haris-email]> (he/him)
-- [aman-095][aman-bhansali-github] - **Aman Bhansali** <[amanbhansali65@gmail.com][aman-bhansali-email]> (he/him)
-- [aayush0325][aayush-khanna-github] - **Aayush Khanna** <[aayushiitbhu23@gmail.com][aayush-khanna-email]> (he/him)
+- [kgryte][athan-reines-github] - **Athan Reines** <[kgryte@gmail.com][athan-reines-email]> (he/him)
+- [Planeshifter][philipp-burckhardt-github] - **Philipp Burckhardt** <[pburckhardt@outlook.com][philipp-burckhardt-email]> (he/him)
+- [gunjjoshi][gunj-joshi-github] - **Gunj Joshi** <[gunjjoshi8372@gmail.com][gunj-joshi-email]> (he/him)
+- [headlessNode][muhammad-haris-github] - **Muhammad Haris** <[harriskhan047@outlook.com][muhammad-haris-email]> (he/him)
+- [aman-095][aman-bhansali-github] - **Aman Bhansali** <[amanbhansali65@gmail.com][aman-bhansali-email]> (he/him)
+- [aayush0325][aayush-khanna-github] - **Aayush Khanna** <[aayushiitbhu23@gmail.com][aayush-khanna-email]> (he/him)
<details>
<summary>Emeriti</summary>
-- [rreusser][ricky-reusser-github] - **Ricky Reusser** <[rsreusser@gmail.com][ricky-reusser-email]> (he/him)
+- [rreusser][ricky-reusser-github] - **Ricky Reusser** <[rsreusser@gmail.com][ricky-reusser-email]> (he/him)
</details>
<section class="links">
[stdlib-governance]: https://github.com/stdlib-js/stdlib/blob/develop/GOVERNANCE.md
-
[athan-reines-github]: https://github.com/kgryte
-
[athan-reines-email]: mailto:kgryte@gmail.com
-
[philipp-burckhardt-github]: https://github.com/Planeshifter
-
[philipp-burckhardt-email]: mailto:pburckhardt@outlook.com
-
[ricky-reusser-github]: https://github.com/rreusser
-
[ricky-reusser-email]: mailto:rsreusser@gmail.com
-
[gunj-joshi-github]: https://github.com/gunjjoshi
-
[gunj-joshi-email]: mailto:gunjjoshi8372@gmail.com
-
[muhammad-haris-github]: https://github.com/headlessNode
-
[muhammad-haris-email]: mailto:harriskhan047@outlook.com
-
[aman-bhansali-github]: https://github.com/aman-095
-
[aman-bhansali-email]: mailto:amanbhansali65@gmail.com
-
[aayush-khanna-github]: https://github.com/aayush0325
-
[aayush-khanna-email]: mailto:aayushiitbhu23@gmail.com
</section>
diff --git a/FAQ.md b/FAQ.md
index 4338a4ef11cb..94250d2f5a46 100644
--- a/FAQ.md
+++ b/FAQ.md
@@ -24,37 +24,37 @@ limitations under the License.
> Common answers to common questions.
-- [Why use this project?](#why-use)
-- [What are the project's core values?](#core-values)
-- [Why numerical computing in JavaScript?](#numerical-computing-in-javascript)
-- [What are the use cases for numerical computing in JavaScript?](#use-cases)
-- [Why not use R, Python, or Julia?](#other-languages)
-- [Why not exclusively use native add-ons?](#native-add-ons)
-- [What about WebAssembly?](#web-assembly)
-- [Why reimplement and provide custom Math implementations?](#custom-math-implementations)
-- [Why not change the ECMAScript specification to use better Math algorithms?](#ecmascript-math-specification)
-- [What can be done at the standards level to better support numerical computing?](#ecmascript-recommendations)
-- [Why reimplement module functionality already available on npm?](#reimplementing-existing-packages)
-- [Why not submit improvements to existing libraries?](#contributing-to-existing-libraries)
-- [Why not aggregate (curate) packages published to npm?](#why-not-curate)
-- [Why are built-in JavaScript globals wrapped and imported as packages?](#globals-as-packages)
-- [Backward compatibility?](#backward-compatibility)
-- [Why use semicolons?](#semicolons)
-- [Import support?](#import-support)
-- [Promise support?](#promise-support)
-- [ES2015 and beyond?](#es2015)
-- [Why a monorepo?](#monorepo)
-- [Why are library packages in a node_modules directory?](#lib-node-modules)
-- [What is meant by saying the project is "decomposable"?](#decomposable-software)
-- [How can I support the project?](#supporting)
-- [Why contribute?](#why-contribute)
-- [How can I contribute?](#contributing)
+- [Why use this project?](#why-use)
+- [What are the project's core values?](#core-values)
+- [Why numerical computing in JavaScript?](#numerical-computing-in-javascript)
+- [What are the use cases for numerical computing in JavaScript?](#use-cases)
+- [Why not use R, Python, or Julia?](#other-languages)
+- [Why not exclusively use native add-ons?](#native-add-ons)
+- [What about WebAssembly?](#web-assembly)
+- [Why reimplement and provide custom Math implementations?](#custom-math-implementations)
+- [Why not change the ECMAScript specification to use better Math algorithms?](#ecmascript-math-specification)
+- [What can be done at the standards level to better support numerical computing?](#ecmascript-recommendations)
+- [Why reimplement module functionality already available on npm?](#reimplementing-existing-packages)
+- [Why not submit improvements to existing libraries?](#contributing-to-existing-libraries)
+- [Why not aggregate (curate) packages published to npm?](#why-not-curate)
+- [Why are built-in JavaScript globals wrapped and imported as packages?](#globals-as-packages)
+- [Backward compatibility?](#backward-compatibility)
+- [Why use semicolons?](#semicolons)
+- [Import support?](#import-support)
+- [Promise support?](#promise-support)
+- [ES2015 and beyond?](#es2015)
+- [Why a monorepo?](#monorepo)
+- [Why are library packages in a node_modules directory?](#lib-node-modules)
+- [What is meant by saying the project is "decomposable"?](#decomposable-software)
+- [How can I support the project?](#supporting)
+- [Why contribute?](#why-contribute)
+- [How can I contribute?](#contributing)
<!-- <faq-questions> -->
<!-- <faq-question> -->
-* * *
+---
<a name="why-use"></a>
@@ -74,11 +74,11 @@ This project
6. increases productivity by:
- - deterring reinvention
- - accelerating initial development
- - reducing bugs
- - reducing long-term maintenance costs
- - reducing search, evaluation, and quality-control requirements
+ - deterring reinvention
+ - accelerating initial development
+ - reducing bugs
+ - reducing long-term maintenance costs
+ - reducing search, evaluation, and quality-control requirements
7. provides standard reference implementations.
@@ -88,17 +88,17 @@ This project
<!-- <faq-question> -->
-* * *
+---
<a name="core-values"></a>
### What are the project's core values?
-- **Thoroughness**: implementations should be thorough, including testing, benchmarking, and documentation. Algorithms should be researched, studied, and measured. Taking shortcuts is not acceptable. Attention to detail is highly prized. Code should be written well the first time.
-- **Rigor**: development should be rigorous. High-quality code is expected, and authors are expected to strive for excellence.
-- **Robustness**: implementations should demonstrate an exhaustive understanding of how they can fail.
-- **Approachability**: user-facing APIs and underlying implementations should be approachable. Interfaces should embrace simplicity. Source code should use the simplest primitives. Documentation should be abundant.
-- **Integrity**: all aspects of the project—documentation, testing, benchmarking, implementations, tooling—should form a consistent and coherent whole. Code should be of one voice and reflect a single purpose: to write high-quality software.
+- **Thoroughness**: implementations should be thorough, including testing, benchmarking, and documentation. Algorithms should be researched, studied, and measured. Taking shortcuts is not acceptable. Attention to detail is highly prized. Code should be written well the first time.
+- **Rigor**: development should be rigorous. High-quality code is expected, and authors are expected to strive for excellence.
+- **Robustness**: implementations should demonstrate an exhaustive understanding of how they can fail.
+- **Approachability**: user-facing APIs and underlying implementations should be approachable. Interfaces should embrace simplicity. Source code should use the simplest primitives. Documentation should be abundant.
+- **Integrity**: all aspects of the project—documentation, testing, benchmarking, implementations, tooling—should form a consistent and coherent whole. Code should be of one voice and reflect a single purpose: to write high-quality software.
<!-- TODO: once the project stabilizes, consider "stability"; e.g., backward compatibility support, etc -->
@@ -106,7 +106,7 @@ This project
<!-- <faq-question> -->
-* * *
+---
<a name="numerical-computing-in-javascript"></a>
@@ -123,7 +123,7 @@ This project
<!-- <faq-question> -->
-* * *
+---
<a name="use-cases"></a>
@@ -131,42 +131,42 @@ This project
Fundamentally, the use cases for numerical and scientific computing in JavaScript are the same as for any other commonly used language for numerical and scientific computation, such as MATLAB, R, Python, and Julia. For example,
-- perform some sort of statistical analysis, such as computing summary statistics or hypothesis testing.
-- train and apply a statistical model (e.g., assign a probability as to whether `A` has characteristic `B` given an observation `Q`).
-- cluster observations into a set of `N` distinct groups.
-- determine the similarity of two or more datasets (i.e., can we reasonably distinguish `X` from `Y`?).
-- assign a likelihood to unexpected events (i.e., all things being equal, how often should we expect to see a particular outcome were we to repeat our experiment hundreds, thousands or millions of times?).
-- perform simulations involving alternative models (e.g., what would the data look like if we change model parameters `a` and `b`?).
-- extract key "features" accounting for the most variation in observed values.
-- translate text from one language to another.
-- generate synthetic speech.
-- rank documents according to their relevance (e.g., to build a search engine).
-- recognize and classify objects in images (e.g., does image `I` contain a cat or a dog?).
-- predict growth and financial returns.
-- compute the trajectory of spacecraft and flying objects.
-- determine optimal ticket prices and staffing requirements to maximize revenue.
-- parse, transform, filter, and aggregate data.
-- add, subtract, multiply, and divide numbers.
+- perform some sort of statistical analysis, such as computing summary statistics or hypothesis testing.
+- train and apply a statistical model (e.g., assign a probability as to whether `A` has characteristic `B` given an observation `Q`).
+- cluster observations into a set of `N` distinct groups.
+- determine the similarity of two or more datasets (i.e., can we reasonably distinguish `X` from `Y`?).
+- assign a likelihood to unexpected events (i.e., all things being equal, how often should we expect to see a particular outcome were we to repeat our experiment hundreds, thousands or millions of times?).
+- perform simulations involving alternative models (e.g., what would the data look like if we change model parameters `a` and `b`?).
+- extract key "features" accounting for the most variation in observed values.
+- translate text from one language to another.
+- generate synthetic speech.
+- rank documents according to their relevance (e.g., to build a search engine).
+- recognize and classify objects in images (e.g., does image `I` contain a cat or a dog?).
+- predict growth and financial returns.
+- compute the trajectory of spacecraft and flying objects.
+- determine optimal ticket prices and staffing requirements to maximize revenue.
+- parse, transform, filter, and aggregate data.
+- add, subtract, multiply, and divide numbers.
In addition to the above, JavaScript has additional use cases by virtue of its being the _lingua franca_ of the web.
-- offline computation in web applications (i.e., an entirely client-side machine learning library does not require a network connection in order to execute commands as is the case, e.g., in the [Jupyter][jupyter] notebook computation model).
-- rapid prototyping and visualization.
-- interactive explanations.
+- offline computation in web applications (i.e., an entirely client-side machine learning library does not require a network connection in order to execute commands as is the case, e.g., in the [Jupyter][jupyter] notebook computation model).
+- rapid prototyping and visualization.
+- interactive explanations.
The popularity of Node.js due to its ease-of-use and growing ubiquity in the HTTP networking stack affords Node.js additional use cases such as
-- a rapidly prototyped and demo-able Node.js server endpoint which performs natural language processing (NLP) and uses the Amazon Alexa API for a chat bot.
-- a serverless application which performs a machine learning computation without needing to install and bundle all of, e.g., Python, [NumPy][numpy], and [SciPy][scipy], thus saving time, money, and resources (all by virtue of Node.js' dominance in serverless cloud offerings, such as AWS Lambda, Google Cloud, and Microsoft Azure).
-- browserless model computation done entirely in JavaScript.
+- a rapidly prototyped and demo-able Node.js server endpoint which performs natural language processing (NLP) and uses the Amazon Alexa API for a chat bot.
+- a serverless application which performs a machine learning computation without needing to install and bundle all of, e.g., Python, [NumPy][numpy], and [SciPy][scipy], thus saving time, money, and resources (all by virtue of Node.js' dominance in serverless cloud offerings, such as AWS Lambda, Google Cloud, and Microsoft Azure).
+- browserless model computation done entirely in JavaScript.
-While other languages and platforms exist which _may_ be better suited for specific use cases, particularly those requiring bare metal performance or involving massive data sets, when considered in totality, the opinion of this project is that JavaScript (and Node.js) provides a comparable, if not better, environment for numerical and scientific computation than other competitor environments.
+While other languages and platforms exist which _may_ be better suited for specific use cases, particularly those requiring bare metal performance or involving massive data sets, when considered in totality, the opinion of this project is that JavaScript (and Node.js) provides a comparable, if not better, environment for numerical and scientific computation than other competitor environments.
<!-- </faq-question> -->
<!-- <faq-question> -->
-* * *
+---
<a name="other-languages"></a>
@@ -185,13 +185,13 @@ You should use JavaScript because
9. **Community**: you want to leverage the continually growing JavaScript and Node.js community. JavaScript has one of the [largest][stackoverflow-developer-survey] and most diverse developer [ecosystems][stackoverflow-developer-survey]. Using JavaScript means greater access to help, expertise, and resources, including tutorials, workshops, and education materials.
10. **Visualization**: you want tighter integration between computation and data visualization. Other languages require intermediary layers to translate computational results into visual artifacts. These layers often involve network requests, longer latency, and increased complexity. Using JavaScript for numerical computation removes the need for intermediaries, allowing immediate and more transparent integration between computation and visualization.
11. **Mad science**: you are interested in mad science applications. Certain applications are only possible in JavaScript due to tight integration between the language and web APIs (e.g., client-based peer-to-peer distributed computing).
-12. **Future**: you want to be part of the future: a future where numerical and scientific computation in JavaScript is not only possible, but also inevitable.
+12. **Future**: you want to be part of the future: a future where numerical and scientific computation in JavaScript is not only possible, but also inevitable.
<!-- </faq-question> -->
<!-- <faq-question> -->
-* * *
+---
<a name="native-add-ons"></a>
@@ -200,7 +200,7 @@ You should use JavaScript because
Native [add-ons][node-add-ons] have several disadvantages:
1. **Maintenance**: historically, native [add-ons][node-add-ons] have entailed considerable maintenance costs. Due to a rapidly changing V8 API and a V8 development approach which does not prioritize backward compatibility, each successive Node.js version required rewriting native [add-ons][node-add-ons] to accommodate breaking changes. To address initially this problem, the Native Abstractions for Node.js project ([NAN][node-nan]) provided a V8 API abstraction layer which [add-ons][node-add-ons] could target, thus allowing an [add-on][node-add-ons] to maintain compatibility between Node.js versions. While [NAN][node-nan] did reduce maintenance costs, costs were not entirely eliminated. [NAN][node-nan] has been superseded by an [ABI stable API][node-napi] (N-API), which provides a similar abstraction layer but also across VMs (e.g., V8 and Chakra). While N-API significantly reduces native add-on maintenance burden, that burden is not zero.
-2. **Portability**: the primary means for building native [add-ons][node-add-ons] is [node-gyp][node-gyp], a tool which wraps [GYP][gyp] (a deprecated build tool formerly used by the Chromium team) and aims to provide a cross-platform approach for compiling Node.js native [add-ons][node-add-ons]. While [GYP][gyp] is suitable for many native [add-on][node-add-ons] use cases, the tool is less well-suited for building numerical and scientific computing libraries. In particular, [GYP][gyp] is primarily oriented toward compiling C/C++ libraries and applications. This orientation is problematic because numerical computing libraries often require the ability to not only compile C/C++, but also Fortran, CUDA, and other compiled languages. On Linux systems, [GYP][gyp] can leverage the GNU compiler toolchain, including [gfortran][gfortran]; however, [node-gyp][node-gyp]'s reliance on Microsoft Visual Studio (MSVS) [prevents][msvs-fortran-issue] compiling [add-ons][node-add-ons] containing Fortran code on Windows. Furthermore, building [add-ons][node-add-ons] on Windows requires installing Windows [build tools][node-windows-build-tools], and, currently, the [recommended][node-windows-build-tools] means of installation is not backward compatible with Node.js environments prior to version `4`. Lastly, while pre-building binaries is one way to circumvent compilation and portability issues, cross-compilation is neither straightforward nor foolproof and does not obviate the need for portable compilation (see debugging below).
+2. **Portability**: the primary means for building native [add-ons][node-add-ons] is [node-gyp][node-gyp], a tool which wraps [GYP][gyp] (a deprecated build tool formerly used by the Chromium team) and aims to provide a cross-platform approach for compiling Node.js native [add-ons][node-add-ons]. While [GYP][gyp] is suitable for many native [add-on][node-add-ons] use cases, the tool is less well-suited for building numerical and scientific computing libraries. In particular, [GYP][gyp] is primarily oriented toward compiling C/C++ libraries and applications. This orientation is problematic because numerical computing libraries often require the ability to not only compile C/C++, but also Fortran, CUDA, and other compiled languages. On Linux systems, [GYP][gyp] can leverage the GNU compiler toolchain, including [gfortran][gfortran]; however, [node-gyp][node-gyp]'s reliance on Microsoft Visual Studio (MSVS) [prevents][msvs-fortran-issue] compiling [add-ons][node-add-ons] containing Fortran code on Windows. Furthermore, building [add-ons][node-add-ons] on Windows requires installing Windows [build tools][node-windows-build-tools], and, currently, the [recommended][node-windows-build-tools] means of installation is not backward compatible with Node.js environments prior to version `4`. Lastly, while pre-building binaries is one way to circumvent compilation and portability issues, cross-compilation is neither straightforward nor foolproof and does not obviate the need for portable compilation (see debugging below).
3. **Web browsers**: native [add-ons][node-add-ons] are not compatible with or portable to web browsers. ([WebAssembly][wasm] will not change this fact.)
4. **Complexity**: compilation presupposes the existence of compilers (e.g., [gfortran][gfortran]) and other tooling in order to successfully compile, thus often requiring out-of-band installation, setup, and configuration. In short, compilation increases complexity and increases the risk that something can and will go wrong.
5. **Development**: native Node.js [add-ons][node-add-ons] require significant upfront development costs compared to porting implementations to JavaScript. Creating a native [add-on][node-add-ons] entails more than writing a simple wrapper around an existing C/C++ library; the process involves additional tooling, testing, and development procedures, all requiring time and effort. These costs are acutely apparent during iteration cycles targeting multiple platforms. In comparison, as a higher-level language, JavaScript facilitates faster development, has built-in portability, and has minimized performance costs.
@@ -213,7 +213,7 @@ Despite the disadvantages articulated above, this project **does** include Node.
<!-- <faq-question> -->
-* * *
+---
<a name="web-assembly"></a>
@@ -234,7 +234,7 @@ Despite the disadvantages articulated above, this project **does** include Node.
<!-- <faq-question> -->
-* * *
+---
<a name="custom-math-implementations"></a>
@@ -250,7 +250,7 @@ Despite the disadvantages articulated above, this project **does** include Node.
<!-- <faq-question> -->
-* * *
+---
<a name="ecmascript-math-specification"></a>
@@ -258,9 +258,9 @@ Despite the disadvantages articulated above, this project **does** include Node.
Common arguments in support of changing the official ECMAScript specification:
-- **standards**: everyone benefits from using common implementations.
-- **network**: more and better built-ins translates to smaller bundles and thus decreased network costs.
-- **evergreen**: improving built-ins means existing codebases using built-ins get "upgraded" (and patched) for free.
+- **standards**: everyone benefits from using common implementations.
+- **network**: more and better built-ins translates to smaller bundles and thus decreased network costs.
+- **evergreen**: improving built-ins means existing codebases using built-ins get "upgraded" (and patched) for free.
On the surface, the above arguments seem compelling. They fail, however, to recognize the rather messy reality of JavaScript applications and originate from a misunderstanding as to how JavaScript is implemented and practiced today.
@@ -272,13 +272,13 @@ The reasons are as follows:
<!--lint disable list-item-spacing-->
-1. **underspecified standard**: the ECMAScript specification for the standard Math library is underspecified, but not without merit. Namely, underspecification allows those implementing the specification to make trade-offs between speed and accuracy. Were the specification to mandate a particular algorithm, e.g., for `Math.sin`, implementers would be locked into **always** using a particular implementation. Especially for special functions, different algorithms will yield different results under varying conditions. Thus, to change an underlying algorithm would mean to break backward compatibility. By not committing themselves to any hard backward compatibility constraints, implementors maintain a degree of flexibility, including the ability to use algorithms which cater to a particular user base (gaming versus numerical computing). In which case, underspecification has advantages.
+1. **underspecified standard**: the ECMAScript specification for the standard Math library is underspecified, but not without merit. Namely, underspecification allows those implementing the specification to make trade-offs between speed and accuracy. Were the specification to mandate a particular algorithm, e.g., for `Math.sin`, implementers would be locked into **always** using a particular implementation. Especially for special functions, different algorithms will yield different results under varying conditions. Thus, to change an underlying algorithm would mean to break backward compatibility. By not committing themselves to any hard backward compatibility constraints, implementors maintain a degree of flexibility, including the ability to use algorithms which cater to a particular user base (gaming versus numerical computing). In which case, underspecification has advantages.
2. **cross-browser variability**: an underspecified standard, however, has disadvantages. Because implementors are free to choose underlying algorithms, relying exclusively on built-in Math functionality renders portability across more than one environment impossible. Even if all implementors happened to use the same underlying algorithm, a developer cannot, _a priori_, **guarantee** or assume that only one algorithm is implemented. The default assumption must be: _if more than one algorithm can exist, more than one algorithm will exist_.
3. **no single codebase**: unlike other standard libraries (e.g., Golang, Python, Julia, etc), JavaScript does not have a single shared codebase. Each browser manufacturer has their own implementation and independent codebase with varying architecture and organization. More fundamentally, a common _implementation_ does **not** exist; only common _interfaces_ exist. Thus, a developer wanting to write a numerical application must navigate and understand multiple sources of truth. Such expenditures incur significant overhead, especially when wanting to file issues, submit patches, or standardize a particular algorithm. For example, a patch in Chrome does not translate to a patch in all other web browsers. Because each implementor is free to erect a protected castle, those writing numerical algorithms are resigned to treating the standard Math library as a black box and must always cater to the lowest common denominator (which is often the empirically determined slowest and/or least precise algorithm).
-4. **versioning**: a developer does not have the freedom to choose which version of a particular algorithm she is given. In an "evergreen" environment, her application is only guaranteed a consistent interface, not an underlying implementation. Each background update may influence results in subtle ways and introduce bugs and unforeseen variability. A developer relying exclusively on standard library built-ins cannot assume reproducibility upon relaunching a browser. Thus, not only is cross-browser portability problematic, but same-browser-different-version portability is problematic.
+4. **versioning**: a developer does not have the freedom to choose which version of a particular algorithm she is given. In an "evergreen" environment, her application is only guaranteed a consistent interface, not an underlying implementation. Each background update may influence results in subtle ways and introduce bugs and unforeseen variability. A developer relying exclusively on standard library built-ins cannot assume reproducibility upon relaunching a browser. Thus, not only is cross-browser portability problematic, but same-browser-different-version portability is problematic.
5. **required shims**: because no common codebase exists and implementors make mistakes, application developers are dependent on shims (i.e., libraries which ensure consistent implementations across browsers, provide missing built-in functionality, and patch bugs). The issue here, of course, is that, if an application developer must supply a shim, reduced network cost due to the presence of built-ins is non-existent: an implementation is sent over the network regardless in order to patch a possibly buggy environment. While a developer could use browser sniffing and HTTP2 to lazily load patches, such practices incur a performance cost. Accordingly, if an implementation is sent irrespective of whether an environment provides an implementation natively, why does an environment need to guarantee the existence of an implementation in the first place?
@@ -304,7 +304,7 @@ Based on the reasons above, Math is fundamentally broken at the standards and im
<!-- <faq-question> -->
-* * *
+---
<a name="ecmascript-recommendations"></a>
@@ -340,9 +340,9 @@ NOTE: addressed by BigInt
1. **Typed objects**: add support for [typed objects][typed-objects-proposal]. Typed objects would facilitate efficient memory storage of data, which is critical for [performant][five-things-that-make-go-fast] numerical computations. In short,
- - typed objects allow compact data structures and avoid unnecessary indirection
- - typed objects enable better cache utilization
- - better cache utilization leads to better performance
+ - typed objects allow compact data structures and avoid unnecessary indirection
+ - typed objects enable better cache utilization
+ - better cache utilization leads to better performance
Complex numbers are a prime example where typed objects would be immensely valuable. Particularly for complex vector arrays, the ability to access adjacent memory locations would result in significant performance benefits.
@@ -372,36 +372,36 @@ NOTE: see https://nodejs.org/api/worker_threads.html
<!-- <faq-question> -->
-* * *
+---
<a name="reimplementing-existing-packages"></a>
### Why reimplement module functionality already available on npm?
-- **Consistency**: package structure, documentation, testing, and code style vary widely, often as artifacts of author taste and eccentricities. By adhering to a single style, library consumers can focus on implementation details, rather than continual and arbitrary style distractions.
-- **Quality**: packages range from extremely high quality to extremely poor quality, with the distribution of packages skewed toward the latter end of the spectrum. Any reimplementation of existing package functionality is done to ensure the same high standard and quality across all project modules.
-- **Control**: bringing functionality "in-house" enables control of release cycles, testing, distribution, interface design, and API changes.
+- **Consistency**: package structure, documentation, testing, and code style vary widely, often as artifacts of author taste and eccentricities. By adhering to a single style, library consumers can focus on implementation details, rather than continual and arbitrary style distractions.
+- **Quality**: packages range from extremely high quality to extremely poor quality, with the distribution of packages skewed toward the latter end of the spectrum. Any reimplementation of existing package functionality is done to ensure the same high standard and quality across all project modules.
+- **Control**: bringing functionality "in-house" enables control of release cycles, testing, distribution, interface design, and API changes.
<!-- </faq-question> -->
<!-- <faq-question> -->
-* * *
+---
<a name="contributing-to-existing-libraries"></a>
### Why not submit improvements to existing libraries?
-- **Rewrites**: often, the project's approach and implementation improvements would require a drastic shift in how existing libraries are written. In some cases, incorporating changes would require completely rewriting one or more libraries. And if a rewrite is necessary, a rewritten library differs from a separate implementation in name only.
-- **Bandwidth**: the demands of the project mean that core project authors do not have the time or resources to both develop the project and actively contribute to any and all existing libraries which might benefit from this project's implementation improvements. In an ideal world, any insights, bug fixes, and improved algorithms included in this project would be pushed to external community libraries; however, the project lacks the bandwidth to do so. As this project is open source, authors of community libraries are encouraged to track project development. If someone wants to take this project's implementation improvements and incorporate them elsewhere, she is free to do so (_subject to the project license_), but this is **not** something the project can actively pursue.
-- **Opportunity cost**: while the project may benefit from engaging with authors of existing libraries in terms of knowledge transfer and insight, such efforts entail risk (no guarantee efforts will lead to library inclusion or achieve intended aim) and real costs (allocated time), and, as such, the opportunity cost (along with maintenance burden) of _pushing_ changes to external community libraries is too great.
-- **Priorities**: given the project's rather strong opinions, there exists a strong possibility of endless developer debate (and bikeshedding) when pushing changes to external community libraries. The more time spent in debate, the less time allocated to project development. In general, this project is biased toward focusing attention on those aspects over which project authors have most control and which can best facilitate development efficiency.
+- **Rewrites**: often, the project's approach and implementation improvements would require a drastic shift in how existing libraries are written. In some cases, incorporating changes would require completely rewriting one or more libraries. And if a rewrite is necessary, a rewritten library differs from a separate implementation in name only.
+- **Bandwidth**: the demands of the project mean that core project authors do not have the time or resources to both develop the project and actively contribute to any and all existing libraries which might benefit from this project's implementation improvements. In an ideal world, any insights, bug fixes, and improved algorithms included in this project would be pushed to external community libraries; however, the project lacks the bandwidth to do so. As this project is open source, authors of community libraries are encouraged to track project development. If someone wants to take this project's implementation improvements and incorporate them elsewhere, she is free to do so (_subject to the project license_), but this is **not** something the project can actively pursue.
+- **Opportunity cost**: while the project may benefit from engaging with authors of existing libraries in terms of knowledge transfer and insight, such efforts entail risk (no guarantee efforts will lead to library inclusion or achieve intended aim) and real costs (allocated time), and, as such, the opportunity cost (along with maintenance burden) of _pushing_ changes to external community libraries is too great.
+- **Priorities**: given the project's rather strong opinions, there exists a strong possibility of endless developer debate (and bikeshedding) when pushing changes to external community libraries. The more time spent in debate, the less time allocated to project development. In general, this project is biased toward focusing attention on those aspects over which project authors have most control and which can best facilitate development efficiency.
<!-- </faq-question> -->
<!-- <faq-question> -->
-* * *
+---
<a name="why-not-curate"></a>
@@ -409,19 +409,19 @@ NOTE: see https://nodejs.org/api/worker_threads.html
This project chose to centralize project development and to forgo aggregation/curation for the following reasons:
-- **Security**: centralized development facilitates security patches and updates. In a distributed aggregation development model, patching security vulnerabilities is subject to increased lag and errors, both in terms of communication and resolution.
-- **Control**: an aggregation model depends on a pull request development cycle, and the model's success depends on developer responsiveness. The latter is by no means guaranteed and resides outside the project's control.
-- **Immediacy**: no additional tooling is needed for notification of source changes. As all development happens on a single source repository, changes are persisted in the commit history, facilitating code archeology and providing an embedded mechanism for both pushing and pulling change notifications.
-- **History**: no additional tooling is needed to aggregate and compile a centralized history (changelog) for communicating changes included in a particular release. The ability to even generate a changelog in an aggregation model assumes codification and adoption of, e.g., a particular commit style, which, given significant variation in developer attitude, tastes, and willingness to adopt any one style, is unrealistic.
-- **Search**: performing a code search is significantly more difficult in an aggregation model, especially given inevitable variation in style and naming conventions.
-- **Continuous integration**: a centralized development model greatly facilitates testing whether changes in one part of the project affect other parts of the project. Feedback for external effects is more immediate and does not require propagation through a disperse network of curated libraries, each with independently managed build environments and configurations.
-- **Testing**: a centralized development model better facilitates test coverage metrics, making a clearer delineation between project and external code.
-- **Tooling**: an aggregation model cannot as readily leverage project tooling for testing, benchmarking, and documentation generation. Furthermore, requiring aggregated libraries to use project tooling would mean a significant amount of code redundancy, as each library would need to independently install and manage project tooling. Centralized development thus minimizes disk usage and redundancy.
-- **Development efficiency**: centralized development enables efficiencies for refactoring and propagating changes which are not possible (without significant time and resources) in an aggregation model. While, in theory, a decentralized aggregation model distributes **initial** development work/costs across multiple developers, the model is not particularly efficient in distributing maintenance costs across those same (or even different) developers. While a centralized development model _may_ incur a greater **initial** development cost, maintenance costs (e.g., communication overhead, propagation of changes, et cetera) are considerably less. In short, centralized development helps unlock efficiencies of scale.
-- **Operational efficiency**: from a practical standpoint, an aggregation model, by definition, means significantly longer installation times due to the need for the many HTTP requests which would be required to build an aggregated library.
-- **Reproducibility**: in a centralized development model, project development always happens on (more or less) the "latest" code. In an aggregation model, which by definition involves dependencies, local development versions can vary significantly due to old/stale node modules and other dependencies. Accordingly, in a centralized model, reproducibility is streamlined (e.g., a `git pull` is faster than `npm clean && npm install`).
-- **Source of truth**: a centralized development model allows operating on a single source of truth, while an aggregation model requires a search path involving two or more dispersed resources, thus incurring increased search and communication costs.
-- **Integrity**: a centralized development model helps ensure project integrity. An aggregation model cannot guarantee that aggregated packages will not "drift" in terms of style, organization, tooling, and, most importantly, **quality**.
+- **Security**: centralized development facilitates security patches and updates. In a distributed aggregation development model, patching security vulnerabilities is subject to increased lag and errors, both in terms of communication and resolution.
+- **Control**: an aggregation model depends on a pull request development cycle, and the model's success depends on developer responsiveness. The latter is by no means guaranteed and resides outside the project's control.
+- **Immediacy**: no additional tooling is needed for notification of source changes. As all development happens on a single source repository, changes are persisted in the commit history, facilitating code archeology and providing an embedded mechanism for both pushing and pulling change notifications.
+- **History**: no additional tooling is needed to aggregate and compile a centralized history (changelog) for communicating changes included in a particular release. The ability to even generate a changelog in an aggregation model assumes codification and adoption of, e.g., a particular commit style, which, given significant variation in developer attitude, tastes, and willingness to adopt any one style, is unrealistic.
+- **Search**: performing a code search is significantly more difficult in an aggregation model, especially given inevitable variation in style and naming conventions.
+- **Continuous integration**: a centralized development model greatly facilitates testing whether changes in one part of the project affect other parts of the project. Feedback for external effects is more immediate and does not require propagation through a disperse network of curated libraries, each with independently managed build environments and configurations.
+- **Testing**: a centralized development model better facilitates test coverage metrics, making a clearer delineation between project and external code.
+- **Tooling**: an aggregation model cannot as readily leverage project tooling for testing, benchmarking, and documentation generation. Furthermore, requiring aggregated libraries to use project tooling would mean a significant amount of code redundancy, as each library would need to independently install and manage project tooling. Centralized development thus minimizes disk usage and redundancy.
+- **Development efficiency**: centralized development enables efficiencies for refactoring and propagating changes which are not possible (without significant time and resources) in an aggregation model. While, in theory, a decentralized aggregation model distributes **initial** development work/costs across multiple developers, the model is not particularly efficient in distributing maintenance costs across those same (or even different) developers. While a centralized development model _may_ incur a greater **initial** development cost, maintenance costs (e.g., communication overhead, propagation of changes, et cetera) are considerably less. In short, centralized development helps unlock efficiencies of scale.
+- **Operational efficiency**: from a practical standpoint, an aggregation model, by definition, means significantly longer installation times due to the need for the many HTTP requests which would be required to build an aggregated library.
+- **Reproducibility**: in a centralized development model, project development always happens on (more or less) the "latest" code. In an aggregation model, which by definition involves dependencies, local development versions can vary significantly due to old/stale node modules and other dependencies. Accordingly, in a centralized model, reproducibility is streamlined (e.g., a `git pull` is faster than `npm clean && npm install`).
+- **Source of truth**: a centralized development model allows operating on a single source of truth, while an aggregation model requires a search path involving two or more dispersed resources, thus incurring increased search and communication costs.
+- **Integrity**: a centralized development model helps ensure project integrity. An aggregation model cannot guarantee that aggregated packages will not "drift" in terms of style, organization, tooling, and, most importantly, **quality**.
**Aside**: in the long arc of history for this project, prior to the current project iteration, an aggregation model was both explored and even pursued. The reasons outlined above find their origin in that (often painful) experience.
@@ -429,7 +429,7 @@ This project chose to centralize project development and to forgo aggregation/cu
<!-- <faq-question> -->
-* * *
+---
<a name="backward-compatibility"></a>
@@ -451,7 +451,7 @@ This project has every intent on maintaining backward compatibility with older N
<!-- <faq-question> -->
-* * *
+---
<a name="globals-as-packages"></a>
@@ -471,7 +471,7 @@ In general, a core belief of this project is that **all** functionality **should
<!-- <faq-question> -->
-* * *
+---
<a name="semicolons"></a>
@@ -489,7 +489,7 @@ For the following reasons:
<!-- <faq-question> -->
-* * *
+---
<a name="import-support"></a>
@@ -513,7 +513,7 @@ Tree shaking (i.e., removing unused symbols) treats the symptom, not the disease
<!-- <faq-question> -->
-* * *
+---
<a name="promise-support"></a>
@@ -525,7 +525,7 @@ Promise support is planned. Help providing promise support, including implementi
<!-- <faq-question> -->
-* * *
+---
<a name="es2015"></a>
@@ -539,34 +539,34 @@ Only **if** three conditions are met:
The reasons are as follows:
-- **Abstraction**: in general, the lower the abstraction, the less magic. Less magic means increased comprehensibility, a smaller surface area, and more control over performance and optimization. Many ES2015+ features are higher-order abstractions for things already possible in ES5. The preference of this project is to eschew higher-order abstractions for the simplest primitives and the greatest clarity.
-- **Control**: unless a transpiler is developed in-house, transpilation requires third party tooling. Transpilers range from the good to the bad, with many generating unoptimized transpiled code. (And why would they? They are designed to be general tools.) Accordingly, efficiency and performance would reside outside the control of this project, which is not an acceptable cost.
-- **Backward Compatibility**: the ability to probe the past is equally as valuable as the ability to build for the future.
-- **Transparency**: source code matches distributed code. This one-to-one correspondence means a) easier debugging without maintenance overhead (e.g., source-maps) and b) individuals reading the source code can better form expectations as to how that code will execute in a deployed environment.
-- **Simplicity**: any additional interface, syntax, or build step adds complexity.
+- **Abstraction**: in general, the lower the abstraction, the less magic. Less magic means increased comprehensibility, a smaller surface area, and more control over performance and optimization. Many ES2015+ features are higher-order abstractions for things already possible in ES5. The preference of this project is to eschew higher-order abstractions for the simplest primitives and the greatest clarity.
+- **Control**: unless a transpiler is developed in-house, transpilation requires third party tooling. Transpilers range from the good to the bad, with many generating unoptimized transpiled code. (And why would they? They are designed to be general tools.) Accordingly, efficiency and performance would reside outside the control of this project, which is not an acceptable cost.
+- **Backward Compatibility**: the ability to probe the past is equally as valuable as the ability to build for the future.
+- **Transparency**: source code matches distributed code. This one-to-one correspondence means a) easier debugging without maintenance overhead (e.g., source-maps) and b) individuals reading the source code can better form expectations as to how that code will execute in a deployed environment.
+- **Simplicity**: any additional interface, syntax, or build step adds complexity.
<!-- </faq-question> -->
<!-- <faq-question> -->
-* * *
+---
<a name="monorepo"></a>
### Why a monorepo?
-- **Tooling**: a monorepo facilitates better and more extensive tooling related to actual development. A polyrepo approach requires more tooling orthogonal to development, such as tooling for aggregation and maintaining repository consistency.
-- **Dependencies**: a monorepo enables easier management of project dependencies, particularly development dependencies related to testing and automation.
-- **Coordination**: a monorepo facilitates coordination of changes across multiple modules and/or an entire project.
-- **Issues**: a monorepo centralizes issues and bug reporting. Managing and tracking issues and bug reports across many repositories is time consuming and error prone.
-- **Testing**: a monorepo drastically simplifies continuous, automated testing. Integration testing across multiple repositories requires extensive tooling, which distracts from core library development. Further, individual repositories are frequently tested only when a change happens to code within **that** repository, which means that bugs caused by changes to other project repositories are caught after-the-fact, rather than pro-actively via continuous testing.
-- **Context**: a monorepo provides a single entry point and context by which new and existing users can access the project. In a polyrepo approach, new and existing users often lack the required context to understand how an individual repository fits within a larger project.
+- **Tooling**: a monorepo facilitates better and more extensive tooling related to actual development. A polyrepo approach requires more tooling orthogonal to development, such as tooling for aggregation and maintaining repository consistency.
+- **Dependencies**: a monorepo enables easier management of project dependencies, particularly development dependencies related to testing and automation.
+- **Coordination**: a monorepo facilitates coordination of changes across multiple modules and/or an entire project.
+- **Issues**: a monorepo centralizes issues and bug reporting. Managing and tracking issues and bug reports across many repositories is time consuming and error prone.
+- **Testing**: a monorepo drastically simplifies continuous, automated testing. Integration testing across multiple repositories requires extensive tooling, which distracts from core library development. Further, individual repositories are frequently tested only when a change happens to code within **that** repository, which means that bugs caused by changes to other project repositories are caught after-the-fact, rather than pro-actively via continuous testing.
+- **Context**: a monorepo provides a single entry point and context by which new and existing users can access the project. In a polyrepo approach, new and existing users often lack the required context to understand how an individual repository fits within a larger project.
<!-- </faq-question> -->
<!-- <faq-question> -->
-* * *
+---
<a name="lib-node-modules"></a>
@@ -577,7 +577,7 @@ This project leverages the Node.js module resolution [algorithm][node-require] t
<!-- eslint-disable stdlib/require-file-extensions -->
```javascript
-var foo = require( './../../../../../@stdlib/foo' );
+var foo = require("./../../../../../@stdlib/foo");
```
becomes
@@ -585,7 +585,7 @@ becomes
<!-- eslint-disable stdlib/require-file-extensions, stdlib/no-redeclare -->
```javascript
-var foo = require( '@stdlib/foo' );
+var foo = require("@stdlib/foo");
```
In general, far too many developers are oblivious to the module resolution [algorithm][node-require], often resorting to various unnecessary hacks, such as setting environment variables (e.g., `NODE_PATH`), using globals, creating symbolic links (symlink), using `require` wrappers, running startup scripts, or actually hacking `require` itself (see [here][modifying-node-path-hack] and [here][list-of-require-hacks] as representative references). A superior approach is to leverage the module resolution [algorithm][node-require] to scope internal packages to their relevant context. For example, consider the following application directory structure
@@ -667,11 +667,11 @@ where `g.js`
<!-- eslint-disable -->
```javascript
-var beep = require( 'beep' );
-var debug = require( 'debug' );
-var get = require( 'db-get' );
-var transform = require( 'transform' );
-var h = require( './h.js' );
+var beep = require("beep");
+var debug = require("debug");
+var get = require("db-get");
+var transform = require("transform");
+var h = require("./h.js");
// ...
```
@@ -691,7 +691,7 @@ In short, the module resolution [algorithm][node-require] provides a simple and
<!-- <faq-question> -->
-* * *
+---
<a name="decomposable-software"></a>
@@ -715,7 +715,7 @@ While development happens on a single repository (i.e., a monorepo), the larger
<!-- <faq-question> -->
-* * *
+---
<a name="supporting"></a>
@@ -723,15 +723,15 @@ While development happens on a single repository (i.e., a monorepo), the larger
You can support the project by
-- contributing algorithms and implementations
-- adding tests and benchmarks
-- helping improve documentation and examples
-- using the project and offering feedback
-- filing bug reports and flagging performance regressions
-- advocating for standards committees to add features at the specification level to better enable numerical computing in JavaScript
-- helping promote the project on social media, at your company, and within your networks
-- providing build and infrastructure support
-- providing financial support ([Open Collective][open-collective-stdlib])
+- contributing algorithms and implementations
+- adding tests and benchmarks
+- helping improve documentation and examples
+- using the project and offering feedback
+- filing bug reports and flagging performance regressions
+- advocating for standards committees to add features at the specification level to better enable numerical computing in JavaScript
+- helping promote the project on social media, at your company, and within your networks
+- providing build and infrastructure support
+- providing financial support ([Open Collective][open-collective-stdlib])
If you have additional ideas, get in touch, and we'll do our best to help!
@@ -739,7 +739,7 @@ If you have additional ideas, get in touch, and we'll do our best to help!
<!-- <faq-question> -->
-* * *
+---
<a name="why-contribute"></a>
@@ -747,12 +747,12 @@ If you have additional ideas, get in touch, and we'll do our best to help!
You should contribute
-- if you want to write high-quality software
-- if you want to learn underlying algorithms
-- if you want to learn how to write rigorous and robust implementations
-- if you want to bring numerical and scientific computing to JavaScript and the Web
-- if you want to be part of a dedicated, supportive, and inclusive community
-- if you believe in what we are doing and want to be a part of it :)
+- if you want to write high-quality software
+- if you want to learn underlying algorithms
+- if you want to learn how to write rigorous and robust implementations
+- if you want to bring numerical and scientific computing to JavaScript and the Web
+- if you want to be part of a dedicated, supportive, and inclusive community
+- if you believe in what we are doing and want to be a part of it :)
Reach out, get in touch, and we'll be happy to get you started!
@@ -760,7 +760,7 @@ Reach out, get in touch, and we'll be happy to get you started!
<!-- <faq-question> -->
-* * *
+---
<a name="contributing"></a>
@@ -775,43 +775,24 @@ See the [contributing guide][contributing-guide].
<!-- <definitions> -->
[dom]: https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model
-
[canvas]: https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API
-
[webgl]: https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API
-
[gpgpu]: https://en.wikipedia.org/wiki/General-purpose_computing_on_graphics_processing_units
-
[compute-shaders]: https://www.khronos.org/opengl/wiki/Compute_Shader
-
[vulkan]: https://www.khronos.org/vulkan/
-
[shiny]: http://shiny.rstudio.com/
-
[bokeh]: http://bokeh.pydata.org/en/latest/
-
[plotly]: https://plot.ly/matlab/
-
[stackoverflow-developer-survey]: http://stackoverflow.com/research/developer-survey-2016
-
[module-counts]: http://www.modulecounts.com/
-
[node-fortune-500]: https://nodejs.org/en/blog/announcements/foundation-advances-growth/
-
[javascript-ubiquity]: https://blog.codinghorror.com/javascript-the-lingua-franca-of-the-web/
-
[cylon-js]: https://github.com/hybridgroup/cylon/
-
[iot-js]: https://github.com/Samsung/iotjs
-
[jerryscript]: https://github.com/Samsung/jerryscript
-
[johnny-five]: https://github.com/rwaldron/johnny-five
-
[virtualenvs]: http://docs.python-guide.org/en/latest/dev/virtualenvs/
-
[npm]: https://www.npmjs.com/
-
[mdn-math]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math
<!--
@@ -821,41 +802,23 @@ See the [contributing guide][contributing-guide].
-->
[built-in-math-bugs]: https://github.com/stdlib-js/stdlib/blob/develop/docs/misc/built_in_math_bugs.md
-
[contributing-guide]: https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md
-
[wasm]: https://github.com/WebAssembly/spec/
-
[asm]: http://asmjs.org/spec/latest/
-
[gyp]: https://gyp.gsrc.io/
-
[gfortran]: https://gcc.gnu.org/fortran/
-
[msvs-fortran-issue]: https://github.com/nodejs/node-gyp/issues/1102
-
[numpy]: https://numpy.org/
-
[scipy]: https://www.scipy.org/scipylib/index.html
-
[scikit-learn]: http://scikit-learn.org/stable/
-
[jupyter]: http://jupyter.org/
-
[semver]: http://semver.org/
-
[node-release]: https://github.com/nodejs/Release
-
[node-add-ons]: https://nodejs.org/api/addons.html
-
[node-nan]: https://github.com/nodejs/nan
-
[node-gyp]: https://github.com/nodejs/node-gyp
-
[node-windows-build-tools]: https://github.com/felixrieseberg/windows-build-tools
-
[node-napi]: https://github.com/nodejs/abi-stable-node/
-
[node-require]: https://nodejs.org/api/modules.html
<!--
@@ -863,15 +826,10 @@ See the [contributing guide][contributing-guide].
-->
[modifying-node-path-hack]: https://lostechies.com/derickbailey/2014/02/20/how-i-work-around-the-require-problem-in-nodejs/
-
[list-of-require-hacks]: https://gist.github.com/branneman/8048520
-
[ecma-262]: http://www.ecma-international.org/publications/standards/Ecma-262.htm
-
[ecma-262-array-length]: http://www.ecma-international.org/ecma-262/6.0/#sec-arraycreate
-
[ecma-262-tolength]: http://www.ecma-international.org/ecma-262/6.0/#sec-tolength
-
[ecma-262-asi]: https://www.ecma-international.org/ecma-262/5.1/#sec-7.9
<!--
@@ -881,9 +839,7 @@ See the [contributing guide][contributing-guide].
-->
[golang-big]: https://golang.org/pkg/math/big/
-
[julia-bigint]: http://docs.julialang.org/en/stable/stdlib/numbers/?highlight=bigfloat#Base.BigInt
-
[julia-bigfloat]: http://docs.julialang.org/en/stable/stdlib/numbers/?highlight=bigfloat#Base.BigFloat
<!--
@@ -909,15 +865,10 @@ See the [contributing guide][contributing-guide].
-->
[mozilla-simd]: https://hacks.mozilla.org/2014/10/introducing-simd-js/
-
[ecmascript-simd]: https://github.com/tc39/ecmascript_simd/
-
[five-things-that-make-go-fast]: http://dave.cheney.net/2014/06/07/five-things-that-make-go-fast
-
[typed-objects-proposal]: https://github.com/dslomov/typed-objects-es7
-
[typed-objects-explainer]: https://github.com/nikomatsakis/typed-objects-explainer
-
[operator-overloading]: https://en.wikipedia.org/wiki/Operator_overloading
<!--
diff --git a/GOVERNANCE.md b/GOVERNANCE.md
index a5b8ff1ce15b..58ab63283a55 100644
--- a/GOVERNANCE.md
+++ b/GOVERNANCE.md
@@ -24,9 +24,9 @@ The Project Community consists of all Contributors and Users of The Project. Con
This section describes the governance and leadership model of The Project. The core values of The Project's governance model are:
-- Openness and Transparency
-- Active Contribution
-- Institutional Neutrality
+- Openness and Transparency
+- Active Contribution
+- Institutional Neutrality
### Roles and Responsibilities
@@ -52,12 +52,12 @@ A Core Contributor is automatically made emeritus (and removed from active Core
##### Core Contributor Activities
-- Helping users and novice Contributors
-- Contributing code and documentation changes that improve The Project
-- Reviewing and commenting on Issues and Pull Requests
-- Participation in working groups
-- Casting votes for and against merging a Pull Request
-- Merging approved Pull Requests
+- Helping users and novice Contributors
+- Contributing code and documentation changes that improve The Project
+- Reviewing and commenting on Issues and Pull Requests
+- Participation in working groups
+- Casting votes for and against merging a Pull Request
+- Merging approved Pull Requests
#### Technical Steering Committee
@@ -65,16 +65,16 @@ A subset of the Core Contributors who have produced contributions that are subst
The TSC has final authority over The Project, including:
-- Technical direction
-- Project governance and process (including this policy)
-- Contribution policy
-- Conduct guidelines
-- GitHub repository hosting
-- Development process and any coding standards
-- Setting release dates
-- Release quality standards
-- Making decisions when Core Contributors are unable to reach consensus on an issue within a reasonable time frame
-- Maintaining the list of Core Contributors
+- Technical direction
+- Project governance and process (including this policy)
+- Contribution policy
+- Conduct guidelines
+- GitHub repository hosting
+- Development process and any coding standards
+- Setting release dates
+- Release quality standards
+- Making decisions when Core Contributors are unable to reach consensus on an issue within a reasonable time frame
+- Maintaining the list of Core Contributors
TSC Members participate in all discussions, code review, and other everyday Project activities as peers with all other Contributors and the Community. In these activities, TSC Members do not have any special power or privilege through their membership on the TSC. However, because of the quality and quantity of their contributions and their expert knowledge of The Project Software and Services, TSC Members are expected to provide useful guidance, both technically and concerning Project direction, to potentially less experienced Contributors.
@@ -102,8 +102,8 @@ Changes to TSC membership should be posted in the agenda and may be suggested as
A TSC Member is eligible for automatic removal from the TSC if, during a 6-month period, all of the following are true:
-- They attend fewer than 25% of the regularly scheduled meetings.
-- They do not participate in any TSC votes.
+- They attend fewer than 25% of the regularly scheduled meetings.
+- They do not participate in any TSC votes.
Before removal, an inactive TSC Member must be approached to confirm that they no longer wish to participate in the TSC. If they no longer wish to participate, they will be immediately removed from the TSC. If they plan to resume active participation in the TSC, they will be given a grace period of one year. If they don't return to active participation within that time period, they will be immediately removed from the TSC.
@@ -121,8 +121,8 @@ These numeric votes may be used informally as a way of getting a general sense o
TSC Members are expected to be employed at a wide range of companies, universities, and non-profit organizations. Because of this, TSC Members may have possible conflicts of interest. Such conflicts of interest include, but are not limited to:
-- Financial interests, such as investments, employment, or contracting work outside of The Project that may influence their work on The Project.
-- Access to proprietary information of their employer that could potentially leak into their work with The Project.
+- Financial interests, such as investments, employment, or contracting work outside of The Project that may influence their work on The Project.
+- Access to proprietary information of their employer that could potentially leak into their work with The Project.
All TSC Members shall disclose to the rest of the TSC any conflict of interest they may have. Members with a conflict of interest in a particular issue may participate in TSC discussions on that issue but must recuse themselves from voting on the issue.
@@ -148,9 +148,9 @@ This is a living document and may be updated over time. Refer to the [git histor
Substantial portions of this document were adapted from the following governance models:
-- [NumPy][numpy-governance]
-- [Node.js][nodejs-governance]
-- [Sckit-learn][scikit-learn-governance]
+- [NumPy][numpy-governance]
+- [Node.js][nodejs-governance]
+- [Sckit-learn][scikit-learn-governance]
## License
@@ -159,15 +159,10 @@ This document may be reused under a [Creative Commons Attribution-ShareAlike 4.0
<section class="links">
[apache-foundation-voting-process]: https://www.apache.org/foundation/voting.html
-
[numpy-governance]: https://github.com/numpy/numpy/blob/6db3236cd81c107d752d8ef5fb411f26bf8b7255/doc/source/dev/governance/governance.rst
-
[nodejs-governance]: https://github.com/nodejs/node/blob/0be1c5728173ea9ac42843058e26b6268568acf0/GOVERNANCE.md
-
[scikit-learn-governance]: https://github.com/scikit-learn/scikit-learn/blob/0c8820b6e4f9c49f55e96fcbb297073a887eb37b/doc/governance.rst
-
[cc-by-sa-4.0]: https://creativecommons.org/licenses/by-sa/4.0/
-
[stdlib-git-commit-log-governance]: https://github.com/stdlib-js/stdlib/commits/develop/GOVERNANCE.md
</section>
diff --git a/PRIVACY.md b/PRIVACY.md
index 5355a82ae399..0784b1f55445 100644
--- a/PRIVACY.md
+++ b/PRIVACY.md
@@ -6,9 +6,9 @@ This document tells you what data is tracked and how the data is used.
## Definitions
-- "Project" means the source repository and all officially affiliated services, including websites, applications, content, and products ("Services").
-- "Website" is defined to comprise the main project website, officially affiliated websites, and the hosted (GitHub) source repository.
-- "We/Us" refers to the principal body (project owners) governing the project.
+- "Project" means the source repository and all officially affiliated services, including websites, applications, content, and products ("Services").
+- "Website" is defined to comprise the main project website, officially affiliated websites, and the hosted (GitHub) source repository.
+- "We/Us" refers to the principal body (project owners) governing the project.
## Website
@@ -74,9 +74,9 @@ If you have any questions or concerns about how we track user information, or ho
Parts of this policy document were originally included in
-- [WordPress.org Privacy Policy][wordpress-privacy-policy]
-- [npm, Inc Privacy Policy][npm-privacy-policy]
-- [Medium Privacy Policy][medium-privacy-policy]
+- [WordPress.org Privacy Policy][wordpress-privacy-policy]
+- [npm, Inc Privacy Policy][npm-privacy-policy]
+- [Medium Privacy Policy][medium-privacy-policy]
all of which were licensed under Creative Commons Attribution-ShareAlike licenses.
@@ -91,19 +91,12 @@ Copyright © The Stdlib [Authors][stdlib-authors].
<section class="links">
[google-analytics-privacy-policy]: https://support.google.com/analytics/answer/2700409?hl=en&utm_id=ad
-
[google-analytics-opt-out-browser-add-on]: https://support.google.com/analytics/answer/181881?hl=en&ref_topic=2919631
-
[stdlib-git-commit-log-privacy-policy]: https://github.com/stdlib-js/stdlib/commits/develop/PRIVACY
-
[wordpress-privacy-policy]: https://wordpress.org/about/privacy/
-
[npm-privacy-policy]: https://docs.npmjs.com/policies/privacy
-
[medium-privacy-policy]: https://github.com/Medium/medium-policy/blob/3c76f50e5e6a529c8352c85c9ed596ef95f863b7/privacy-policy.md
-
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
-
[cc-by-sa-4.0]: https://creativecommons.org/licenses/by-sa/4.0/
</section>
diff --git a/README.md b/README.md
index 2d615e1eb632..9fec22ec9c89 100644
--- a/README.md
+++ b/README.md
@@ -46,7 +46,7 @@ limitations under the License.
<!-- /.banner -->
-* * *
+---
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
@@ -68,95 +68,95 @@ Thank you for being a part of our community! Your support is invaluable to us!
## Resources
-- [**Installation**](#installation)
-- [**Homepage**][stdlib-homepage]
-- [**Documentation**][stdlib-documentation]
-- [**Source code**][stdlib-source]
-- [**Code coverage**][stdlib-code-coverage]
-- [**FAQ**][stdlib-faq]
+- [**Installation**](#installation)
+- [**Homepage**][stdlib-homepage]
+- [**Documentation**][stdlib-documentation]
+- [**Source code**][stdlib-source]
+- [**Code coverage**][stdlib-code-coverage]
+- [**FAQ**][stdlib-faq]
### External Resources
-- [**Google Calendar**][stdlib-public-calendar]: calendar of public events, including [open office hours][stdlib-office-hours].
-- [**Open Collective**][open-collective-stdlib]: financially support the project.
-- [**Twitter**][stdlib-twitter]: follow us on social media.
-- [**Gitter**][stdlib-gitter]: chat with project maintainers and other community members.
+- [**Google Calendar**][stdlib-public-calendar]: calendar of public events, including [open office hours][stdlib-office-hours].
+- [**Open Collective**][open-collective-stdlib]: financially support the project.
+- [**Twitter**][stdlib-twitter]: follow us on social media.
+- [**Gitter**][stdlib-gitter]: chat with project maintainers and other community members.
## Features
-- 150+ [special math functions][@stdlib/math/base/special].
+- 150+ [special math functions][@stdlib/math/base/special].
<div class="image" align="center">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@203839353bc74297fe641207270f7917d2bda560/docs/assets/readme/base_special_math.png" alt="Demo showcasing special math functions">
</div>
-- 35+ [probability distributions][@stdlib/stats/base/dists], with support for evaluating probability density functions (PDFs), cumulative distribution functions (CDFs), quantiles, moments, and more.
+- 35+ [probability distributions][@stdlib/stats/base/dists], with support for evaluating probability density functions (PDFs), cumulative distribution functions (CDFs), quantiles, moments, and more.
<div class="image" align="center">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@e13885087939c064c69aa43ee80ea52710de5591/docs/assets/readme/base_dists.png" alt="Demo showcasing probability distributions">
</div>
-- 40+ [seedable pseudorandom number generators][@stdlib/random/base] (PRNGs).
+- 40+ [seedable pseudorandom number generators][@stdlib/random/base] (PRNGs).
<div class="image" align="center">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@83dcd0fad98883320a8b1efc801b2fc1ed2a003d/docs/assets/readme/base_prngs.png" alt="Demo showcasing PRNGs">
</div>
-- 200+ general [utilities][@stdlib/utils] for data transformation, functional programming, and asynchronous control flow.
+- 200+ general [utilities][@stdlib/utils] for data transformation, functional programming, and asynchronous control flow.
<div class="image" align="center">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@e6eeea31e49d6db1b6f57ae59d2988d4b427e285/docs/assets/readme/utils.png" alt="Demo showcasing general utilities">
</div>
-- 200+ [assertion utilities][@stdlib/assert] for data validation and feature detection.
+- 200+ [assertion utilities][@stdlib/assert] for data validation and feature detection.
<div class="image" align="center">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@6970c8b4eb546a10712734d225c15863db9b2c92/docs/assets/readme/assert.png" alt="Demo showcasing assertion utilities">
</div>
-- 50+ [sample datasets][@stdlib/datasets] for testing and development.
+- 50+ [sample datasets][@stdlib/datasets] for testing and development.
<div class="image" align="center">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@f71a38e62247e31dc47d248f6f1b3e434abeb971/docs/assets/readme/datasets.png" alt="Demo showcasing sample datasets">
</div>
-- A [plot API][@stdlib/plot/ctor] for data visualization and exploratory data analysis.
+- A [plot API][@stdlib/plot/ctor] for data visualization and exploratory data analysis.
<div class="image" align="center">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@39d75174b24ea2a84828d9624643776a164478e4/docs/assets/readme/plot.png" alt="Demo showcasing plot API">
</div>
-- Native add-ons for interfacing with BLAS libraries, with pure JavaScript fallbacks.
+- Native add-ons for interfacing with BLAS libraries, with pure JavaScript fallbacks.
<div class="image" align="center">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@efede6af3ef957da08838903b0558441263adf85/docs/assets/readme/base_blas.png" alt="Demo showcasing BLAS APIs">
</div>
-- A [benchmark framework][@stdlib/bench/harness] supporting TAP.
+- A [benchmark framework][@stdlib/bench/harness] supporting TAP.
<div class="image" align="center">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@4833049f8d1895585bd51ec6fa97b8ca0d37c6fb/docs/assets/readme/benchmark.gif" alt="Demo showcasing benchmark framework">
</div>
-- REPL environment with integrated help and examples.
+- REPL environment with integrated help and examples.
<div class="image" align="center">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@3864ae6f86bbc215956c0e667d82d49a6eaca780/docs/assets/readme/repl.gif" alt="Demo showcasing REPL environment">
</div>
-- Can be bundled using [Browserify][browserify], [Webpack][webpack], and other bundlers for use in web browsers.
+- Can be bundled using [Browserify][browserify], [Webpack][webpack], and other bundlers for use in web browsers.
<div class="image" align="center">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@e54894a93697653dda22d11cd0aec1ccb292b7b8/docs/assets/readme/bundled.png" alt="Demo showcasing browser support">
</div>
-- Every function is accompanied by [TypeScript][typescript] declaration files, ensuring type safety and facilitating intelligent code completion in IDEs.
+- Every function is accompanied by [TypeScript][typescript] declaration files, ensuring type safety and facilitating intelligent code completion in IDEs.
<div class="image" align="center">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@f5f1f915a7178d9bc76a95d34afd799e6092ec3a/docs/assets/readme/typescript.png" alt="Demo showcasing TypeScript declaration files" >
</div>
-* * *
+---
## Installation
@@ -166,61 +166,61 @@ While this project's installation instructions defaults to using [npm][npm] for
### User Stories
-- I want to perform **data analysis** and **data science** tasks in JavaScript and Node.js, similar to how I might use Python, Julia, R, and MATLAB.
+- I want to perform **data analysis** and **data science** tasks in JavaScript and Node.js, similar to how I might use Python, Julia, R, and MATLAB.
- - Install the entire project as a [command-line utility](#install_command_line_utility).
+ - Install the entire project as a [command-line utility](#install_command_line_utility).
-- I am building a **web application**.
+- I am building a **web application**.
- - I plan on using [Browserify][browserify], [Webpack][webpack], and other bundlers for use in web browsers.
+ - I plan on using [Browserify][browserify], [Webpack][webpack], and other bundlers for use in web browsers.
- - Install [individual packages](#install_individual_packages). Installing the entire project is likely unnecessary and will lead to slower installation times.
+ - Install [individual packages](#install_individual_packages). Installing the entire project is likely unnecessary and will lead to slower installation times.
- - I would like to **vendor** a custom bundle containing various stdlib functionality.
+ - I would like to **vendor** a custom bundle containing various stdlib functionality.
- - Follow the steps for creating [custom bundles](#install_custom_bundles).
+ - Follow the steps for creating [custom bundles](#install_custom_bundles).
- - I would like to include stdlib functionality by just using a `script` tag.
+ - I would like to include stdlib functionality by just using a `script` tag.
- - I would like to use ES Modules.
+ - I would like to use ES Modules.
- - Use an individual package's ES Module [build](#install_env_builds_esm).
+ - Use an individual package's ES Module [build](#install_env_builds_esm).
- - I would like to use a pre-built bundle (possibly via a CDN, such as [unpkg][unpkg] or [jsDelivr][jsdelivr]).
+ - I would like to use a pre-built bundle (possibly via a CDN, such as [unpkg][unpkg] or [jsDelivr][jsdelivr]).
- - Install (or consume via a CDN) an individual package's pre-built UMD [browser bundle](#install_env_builds_umd).
+ - Install (or consume via a CDN) an individual package's pre-built UMD [browser bundle](#install_env_builds_umd).
- - I am interested in using a substantial amount of functionality found in a top-level stdlib namespace and don't want to separately install hundreds of individual packages (e.g., if building an on-line calculator application and wanting all of stdlib's math functionality).
+ - I am interested in using a substantial amount of functionality found in a top-level stdlib namespace and don't want to separately install hundreds of individual packages (e.g., if building an on-line calculator application and wanting all of stdlib's math functionality).
- - Install one or more top-level [namespaces](#install_namespaces). Installing the entire project is likely unnecessary and will lead to slower installation times. Installing a top-level namespace is likely to mean installing functionality which will never be used; however, installing a top-level namespace is likely to be easier and less time-consuming than installing many individual packages separately.
+ - Install one or more top-level [namespaces](#install_namespaces). Installing the entire project is likely unnecessary and will lead to slower installation times. Installing a top-level namespace is likely to mean installing functionality which will never be used; however, installing a top-level namespace is likely to be easier and less time-consuming than installing many individual packages separately.
When bundling, installing a top-level namespace should not be a concern, as individual functionality can still be independently required/imported. Project installation times may, however, be somewhat slower.
-- I am building a [Node.js][node-js] **server application**.
+- I am building a [Node.js][node-js] **server application**.
- - I am interested in using various functionality found in stdlib.
+ - I am interested in using various functionality found in stdlib.
- - Install [individual packages](#install_individual_packages). Installing the entire project is likely unnecessary and will lead to slower installation times.
+ - Install [individual packages](#install_individual_packages). Installing the entire project is likely unnecessary and will lead to slower installation times.
- - I would like to **vendor** stdlib functionality and avoid dependency trees.
+ - I would like to **vendor** stdlib functionality and avoid dependency trees.
- - Install individual package UMD [bundles](#install_env_builds_nodejs).
+ - Install individual package UMD [bundles](#install_env_builds_nodejs).
- - I am interested in using a _substantial_ amount of functionality found in a top-level stdlib namespace and don't want to separately install hundreds of individual packages.
+ - I am interested in using a _substantial_ amount of functionality found in a top-level stdlib namespace and don't want to separately install hundreds of individual packages.
- - Install one or more top-level [namespaces](#install_namespaces). Installing the entire project is likely unnecessary and will lead to slower installation times. Installing a top-level namespace is likely to mean installing functionality which will never be used; however, installing a top-level namespace is likely to be easier and less time-consuming than installing many individual packages separately.
+ - Install one or more top-level [namespaces](#install_namespaces). Installing the entire project is likely unnecessary and will lead to slower installation times. Installing a top-level namespace is likely to mean installing functionality which will never be used; however, installing a top-level namespace is likely to be easier and less time-consuming than installing many individual packages separately.
-- I am using **Deno**.
+- I am using **Deno**.
- - Import [individual packages](#install_env_builds_deno) using pre-built Deno builds.
+ - Import [individual packages](#install_env_builds_deno) using pre-built Deno builds.
-- I would like to use stdlib functionality in an [Observable][observable] notebook.
+- I would like to use stdlib functionality in an [Observable][observable] notebook.
- - Consume a pre-built [browser bundles](#install_env_builds_umd) via a CDN, such as [unpkg][unpkg] or [jsDelivr][jsdelivr].
+ - Consume a pre-built [browser bundles](#install_env_builds_umd) via a CDN, such as [unpkg][unpkg] or [jsDelivr][jsdelivr].
-- I want to hack at stdlib, possibly even creating **customized** builds to link to platform-specific native libraries (such as Intel's MKL or some other numerical library).
+- I want to hack at stdlib, possibly even creating **customized** builds to link to platform-specific native libraries (such as Intel's MKL or some other numerical library).
- - Install the project as a [system library](#install_system_library) by cloning this repository and following the [installation][stdlib-development] instructions as described in the [development guide][stdlib-development].
+ - Install the project as a [system library](#install_system_library) by cloning this repository and following the [installation][stdlib-development] instructions as described in the [development guide][stdlib-development].
<a name="install_complete_library"></a>
@@ -237,9 +237,12 @@ $ npm install @stdlib/stdlib
Once installed, stdlib packages can be individually required/imported to minimize load times and decrease bundle sizes. For example, to use `require`
```javascript
-var ndarray = require( '@stdlib/ndarray/array' );
+var ndarray = require("@stdlib/ndarray/array");
-var arr = ndarray( [ [ 1, 2 ], [ 3, 4 ] ] );
+var arr = ndarray([
+ [1, 2],
+ [3, 4],
+]);
// returns <ndarray>
```
@@ -248,9 +251,12 @@ and to use `import`
<!-- run-disable -->
```javascript
-import ndarray from '@stdlib/ndarray/array';
+import ndarray from "@stdlib/ndarray/array";
-var arr = ndarray( [ [ 1, 2 ], [ 3, 4 ] ] );
+var arr = ndarray([
+ [1, 2],
+ [3, 4],
+]);
// returns <ndarray>
```
@@ -271,9 +277,12 @@ $ npm install @stdlib/ndarray-array
Once installed, individual packages can be required/imported. For example, to use `require`
```javascript
-var ndarray = require( '@stdlib/ndarray-array' );
+var ndarray = require("@stdlib/ndarray-array");
-var arr = ndarray( [ [ 1, 2 ], [ 3, 4 ] ] );
+var arr = ndarray([
+ [1, 2],
+ [3, 4],
+]);
// returns <ndarray>
```
@@ -282,9 +291,12 @@ and to use `import`
<!-- run-disable -->
```javascript
-import ndarray from '@stdlib/ndarray-array';
+import ndarray from "@stdlib/ndarray-array";
-var arr = ndarray( [ [ 1, 2 ], [ 3, 4 ] ] );
+var arr = ndarray([
+ [1, 2],
+ [3, 4],
+]);
// returns <ndarray>
```
@@ -303,9 +315,9 @@ $ npm install @stdlib/math
Once installed, packages within a top-level namespace can be individually required/imported to minimize load times and decrease bundle sizes. For example, to use `require`
```javascript
-var sin = require( '@stdlib/math/base/special/sin' );
+var sin = require("@stdlib/math/base/special/sin");
-var v = sin( 3.14 );
+var v = sin(3.14);
// returns <number>
```
@@ -314,9 +326,9 @@ and to use `import`
<!-- run-disable -->
```javascript
-import sin from '@stdlib/math/base/special/sin';
+import sin from "@stdlib/math/base/special/sin";
-var v = sin( 3.14 );
+var v = sin(3.14);
// returns <number>
```
@@ -364,14 +376,14 @@ To use ES Modules via a `<script>` tag, use **ES Module builds** available in ea
```html
<script type="module">
-import linspace from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-linspace@esm/index.mjs';
-import erf from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-erf@esm/index.mjs';
+ import linspace from "https://cdn.jsdelivr.net/gh/stdlib-js/array-base-linspace@esm/index.mjs";
+ import erf from "https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-erf@esm/index.mjs";
-const x = linspace( -10.0, 10.0, 100 );
+ const x = linspace(-10.0, 10.0, 100);
-for ( let i = 0; i < x.length; i++ ) {
- console.log( 'x: %d, erf(x): %d', x[ i ], erf( x[ i ] ) );
-}
+ for (let i = 0; i < x.length; i++) {
+ console.log("x: %d, erf(x): %d", x[i], erf(x[i]));
+ }
</script>
```
@@ -384,12 +396,14 @@ To use individual packages in Deno, use **Deno builds** available in each packag
<!-- run-disable -->
```javascript
-import ndarray from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-array@deno/mod.js';
+import ndarray from "https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-array@deno/mod.js";
-var arr = ndarray( [ [ 1, 2 ], [ 3, 4 ] ] );
+var arr = ndarray([
+ [1, 2],
+ [3, 4],
+]);
// returns <ndarray>
-````
-
+```
<a name="install_env_builds_jquery"></a>
@@ -406,18 +420,22 @@ To use UMD bundles either via a `<script>` tag or in [Observable][observable], u
<!-- run-disable -->
```html
-<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/array-base-linspace@umd/browser.js"></script>
-<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-erf@umd/browser.js"></script>
+<script
+ type="text/javascript"
+ src="https://cdn.jsdelivr.net/gh/stdlib-js/array-base-linspace@umd/browser.js"
+></script>
+<script
+ type="text/javascript"
+ src="https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-erf@umd/browser.js"
+></script>
<script type="text/javascript">
-(function () {
-
-var x = linspace( -10.0, 10.0, 100 );
+ (function () {
+ var x = linspace(-10.0, 10.0, 100);
-for ( var i = 0; i < x.length; i++ ) {
- console.log( 'x: %d, erf(x): %d', x[ i ], erf( x[ i ] ) );
-}
-
-})();
+ for (var i = 0; i < x.length; i++) {
+ console.log("x: %d, erf(x): %d", x[i], erf(x[i]));
+ }
+ })();
</script>
```
@@ -430,13 +448,13 @@ To **vendor** stdlib functionality and avoid installing dependency trees, use UM
<!-- run-disable -->
```javascript
-var linspace = require( '/path/to/vendor/umd/@stdlib/array-base-linspace' );
-var erf = require( '/path/to/vendor/umd/@stdlib/math-base-special-erf' );
+var linspace = require("/path/to/vendor/umd/@stdlib/array-base-linspace");
+var erf = require("/path/to/vendor/umd/@stdlib/math-base-special-erf");
-var x = linspace( -10.0, 10.0, 100 );
+var x = linspace(-10.0, 10.0, 100);
-for ( var i = 0; i < x.length; i++ ) {
- console.log( 'x: %d, erf(x): %d', x[ i ], erf( x[ i ] ) );
+for (var i = 0; i < x.length; i++) {
+ console.log("x: %d, erf(x): %d", x[i], erf(x[i]));
}
```
@@ -487,44 +505,44 @@ Upon generating a bundle, the bundle can be loaded via a `<script>` tag as descr
To install as a system library (e.g., for the purposes of creating custom builds), follow the [download][stdlib-development], [configuration][stdlib-development], and [installation][stdlib-development] instructions as described in the [development guide][stdlib-development].
-* * *
+---
## Prerequisites
Installing and running stdlib for use in [Node.js][node-js] **requires** the following prerequisites:
-- [Node.js][node-js]: JavaScript runtime (version `>= 0.10`)
-- [npm][npm]: package manager (version `> 2.7.0`; if Node `< 1.0.0`, version `> 2.7.0` and `< 4.0.0`; if Node `<= 10.x.x`, version `> 2.7.0` and `< 6.0.0`)
+- [Node.js][node-js]: JavaScript runtime (version `>= 0.10`)
+- [npm][npm]: package manager (version `> 2.7.0`; if Node `< 1.0.0`, version `> 2.7.0` and `< 4.0.0`; if Node `<= 10.x.x`, version `> 2.7.0` and `< 6.0.0`)
Most functionality in stdlib is implemented in JavaScript and no further prerequisites are required to use stdlib (i.e., you can safely avoid installing any additional prerequisites); however, some implementations try to capture performance benefits by using [native bindings][node-js-add-ons] and/or [WebAssembly][webassembly]. While **not** required to run stdlib, as **every** stdlib implementation has a JavaScript fallback, the following dependencies are **required** for building native add-ons, including linking to BLAS and LAPACK libraries:
-- [GNU make][make]: development utility and task runner
-- [GNU bash][bash]: an sh-compatible shell
-- [gcc & g++][gcc] or [Clang][clang]: C/C++ compilation and linking (g++ version `>= 4.8`; clang version `>= 3.5`, Xcode version `>=8.3.1` on OS X)
-- [gfortran][gfortran]: Fortran compilation and linking (version `>= 4.8`)
+- [GNU make][make]: development utility and task runner
+- [GNU bash][bash]: an sh-compatible shell
+- [gcc & g++][gcc] or [Clang][clang]: C/C++ compilation and linking (g++ version `>= 4.8`; clang version `>= 3.5`, Xcode version `>=8.3.1` on OS X)
+- [gfortran][gfortran]: Fortran compilation and linking (version `>= 4.8`)
While **not** required to run stdlib, the following dependencies are **required** for automatically downloading external libraries:
-- [curl][curl], [wget][wget], or [fetch][fetch] (FreeBSD): utilities for downloading remote resources
+- [curl][curl], [wget][wget], or [fetch][fetch] (FreeBSD): utilities for downloading remote resources
The following external libraries can be automatically downloaded and compiled from source using `make`:
-- [OpenBLAS][openblas]: optimized BLAS library
-- [Electron][electron]: framework for cross-platform desktop applications
+- [OpenBLAS][openblas]: optimized BLAS library
+- [Electron][electron]: framework for cross-platform desktop applications
-* * *
+---
## Contributing
First time contributor?
-- See the [contributing guidelines][stdlib-contributing].
+- See the [contributing guidelines][stdlib-contributing].
Already an expert?
-- Fork the repository.
+- Fork the repository.
-- Clone the forked repository
+- Clone the forked repository
```bash
$ git clone --depth=1 https://github.com/<username>/stdlib.git
@@ -532,19 +550,19 @@ Already an expert?
where `<username>` is your GitHub username.
-- Navigate to the `stdlib` directory
+- Navigate to the `stdlib` directory
```bash
$ cd stdlib
```
-- Install dependencies
+- Install dependencies
```bash
$ make install-node-modules
```
-- Initialize your stdlib development environment
+- Initialize your stdlib development environment
```bash
$ make init
@@ -552,7 +570,7 @@ Already an expert?
<!-- Project sponsors. If sponsors are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
-* * *
+---
<section class="sponsors">
@@ -577,7 +595,7 @@ Are you interested in supporting stdlib? If so, join our [Open Collective][open-
<!-- Project users. If users are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
-* * *
+---
<section class="users">
@@ -600,7 +618,7 @@ Does your organization use stdlib? If so, we'd love to hear from you!
<!-- /.users -->
-* * *
+---
## Governance
@@ -620,7 +638,7 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].
<!-- Project badges. If badges are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
-* * *
+---
<section class="badges">
@@ -693,15 +711,10 @@ Test and build infrastructure is generously provided by the following services:
<section class="links">
[npm-image]: https://img.shields.io/npm/v/@stdlib/stdlib.svg
-
[npm-url]: https://npmjs.com/package/@stdlib/stdlib
-
[tag-image]: https://img.shields.io/github/v/tag/stdlib-js/stdlib.svg
-
[tag-url]: https://github.com/stdlib-js/stdlib/tags
-
[node-image]: https://img.shields.io/node/v/@stdlib/stdlib.svg
-
[node-url]: https://github.com/stdlib-js/stdlib
<!-- [build-image-develop]: https://img.shields.io/travis/stdlib-js/stdlib/develop.svg
@@ -717,105 +730,55 @@ Test and build infrastructure is generously provided by the following services:
[dev-dependencies-url]: https://socket.dev/npm/package/@stdlib/stdlib/dependencies -->
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
-
[make]: https://www.gnu.org/software/make/
-
[bash]: https://www.gnu.org/software/bash/
-
[curl]: https://curl.se/
-
[wget]: https://www.gnu.org/software/wget/
-
[fetch]: https://www.freebsd.org/cgi/man.cgi?fetch%281%29
-
[node-js]: https://nodejs.org/en/
-
[npm]: https://www.npmjs.com/
-
[yarn]: https://yarnpkg.com/
-
[gcc]: http://gcc.gnu.org/
-
[clang]: https://clang.llvm.org/
-
[gfortran]: https://gcc.gnu.org/fortran/
-
[openblas]: https://github.com/xianyi/OpenBLAS
-
[electron]: https://www.electronjs.org/
-
[webassembly]: https://webassembly.org/
-
[node-js-add-ons]: https://nodejs.org/api/addons.html
-
[browserify]: https://github.com/substack/node-browserify
-
[webpack]: https://webpack.js.org/
-
[typescript]: https://www.typescriptlang.org/
-
[unpkg]: https://unpkg.com/#/
-
[jsdelivr]: https://www.jsdelivr.com/
-
[observable]: https://observablehq.com/
-
[ipa-english]: https://en.wikipedia.org/wiki/Help:IPA/English
-
[stdlib-contributing]: https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md
-
[stdlib-development]: https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md
-
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
-
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stdlib/develop/LICENSE
-
[stdlib-governance]: https://raw.githubusercontent.com/stdlib-js/stdlib/develop/GOVERNANCE.md
-
[stdlib-homepage]: https://stdlib.io
-
[stdlib-documentation]: https://stdlib.io/docs/api
-
[stdlib-faq]: https://github.com/stdlib-js/stdlib/blob/develop/FAQ.md
-
[stdlib-source]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib
-
[stdlib-code-coverage]: https://codecov.io/github/stdlib-js/stdlib/branch/develop
-
[stdlib-public-calendar]: https://calendar.google.com/calendar/embed?src=a72677fe2820c833714b8b9a2aa87393f742bcaf0d0f6c9499eee6661795eae0%40group.calendar.google.com
-
[stdlib-office-hours]: https://github.com/stdlib-js/meetings/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20label%3A%22Office%20Hours%22
-
[open-collective-stdlib]: https://opencollective.com/stdlib
-
[stdlib-twitter]: https://twitter.com/stdlibjs
-
[stdlib-gitter]: https://gitter.im/stdlib-js/stdlib
-
[@stdlib/math/base/special]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special
-
[@stdlib/stats/base/dists]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists
-
[@stdlib/random/base]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/base
-
[@stdlib/assert]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert
-
[@stdlib/datasets]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/datasets
-
[@stdlib/utils]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils
-
[@stdlib/plot/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/plot/ctor
-
[@stdlib/bench/harness]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/bench/harness
-
[@stdlib/repl]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/repl
-
[@stdlib/ndarray-array-deno]: https://github.com/stdlib-js/ndarray-array/tree/deno
-
[@stdlib/math-base-special-erf-esm]: https://github.com/stdlib-js/math-base-special-erf/tree/esm
-
[@stdlib/math-base-special-erf-umd]: https://github.com/stdlib-js/math-base-special-erf/tree/umd
</section>
diff --git a/ROADMAP.md b/ROADMAP.md
index 6a380dcc5839..3b945be5f135 100644
--- a/ROADMAP.md
+++ b/ROADMAP.md
@@ -36,40 +36,40 @@ The third major theme is data visualization. Building on the first and second th
The fourth major theme is automation. Automation is critical for the project's ability to scale and to streamline the development experience. This work will make stdlib one of the most innovative and developer friendly open source projects.
-Last, the final theme is documentation. Part of this effort will be continuing to build a web presence and demonstrating the need and importance for stdlib. This work will enable the project to grow and attract both users and contributors.
+Last, the final theme is documentation. Part of this effort will be continuing to build a web presence and demonstrating the need and importance for stdlib. This work will enable the project to grow and attract both users and contributors.
## Details
### Multi-dimensional Arrays
-- broadcasting semantics
-- ndarray engine for element-wise operations
-- ndarray engine for axis-wise operations
-- add vectorized array APIs
+- broadcasting semantics
+- ndarray engine for element-wise operations
+- ndarray engine for axis-wise operations
+- add vectorized array APIs
### Native Implementations
-- BLAS bindings
-- BLAS ports (JavaScript and C)
-- LAPACK bindings
-- LAPACK ports (JavaScript and C)
+- BLAS bindings
+- BLAS ports (JavaScript and C)
+- LAPACK bindings
+- LAPACK ports (JavaScript and C)
### Data Visualization
-- Additional chart types (bar, column, histogram)
-- ASCII engine
-- Canvas engine (including PNG output)
+- Additional chart types (bar, column, histogram)
+- ASCII engine
+- Canvas engine (including PNG output)
### Automation
-- Performance improvements to continuous integration environments
-- Browser testing
-- Package scaffolding tools
-- Package decomposition (independent package publishing)
+- Performance improvements to continuous integration environments
+- Browser testing
+- Package scaffolding tools
+- Package decomposition (independent package publishing)
### Documentation
-- Website
-- Source code (JSDoc)
-- Blog posts
-- Tutorials
+- Website
+- Source code (JSDoc)
+- Blog posts
+- Tutorials
diff --git a/SECURITY.md b/SECURITY.md
index 9e71c71fd277..8b1fb3226632 100644
--- a/SECURITY.md
+++ b/SECURITY.md
@@ -26,7 +26,7 @@ The maintainers of stdlib take very seriously the security of stdlib and its ope
We appreciate your efforts to responsibly disclose your findings, and we will make every effort to acknowledge your contributions.
-* * *
+---
## Scope
@@ -42,10 +42,10 @@ In the stdlib threat model, certain elements, such as the underlying operating s
Examples of trusted elements include the following:
-- The developers using stdlib and the infrastructure on which stdlib is used.
-- The operating system on which stdlib is used and its configuration, along with anything under control of the operating system.
-- The code stdlib is asked to run, including JavaScript and native code. Any provided code inherits all the privileges of the execution user.
-- The inputs provided to stdlib by the code it is asked to run. It is the responsibility of the consumer of stdlib to perform requisite input validations.
+- The developers using stdlib and the infrastructure on which stdlib is used.
+- The operating system on which stdlib is used and its configuration, along with anything under control of the operating system.
+- The code stdlib is asked to run, including JavaScript and native code. Any provided code inherits all the privileges of the execution user.
+- The inputs provided to stdlib by the code it is asked to run. It is the responsibility of the consumer of stdlib to perform requisite input validations.
stdlib strives to avoid APIs and internal implementations which make it easy for downstream code to use stdlib APIs incorrectly and thereby enable vulnerabilities. While we do not consider these vulnerabilities to be in stdlib itself, we do ask that they be reported privately to stdlib. Having this information allows us to improve stdlib APIs and issue fixes in either regular or security releases depending on how much risk they pose to the stdlib community.
@@ -53,8 +53,8 @@ For an issue to be considered a stdlib security vulnerability, the issue must be
Being able to cause the following through control of untrusted elements is likely to be considered a vulnerability:
-- Disclosure or loss of integrity or confidentiality of data protected through the correct use of stdlib APIs.
-- The unavailability of the host JavaScript runtime (e.g., due to unbounded performance degradation).
+- Disclosure or loss of integrity or confidentiality of data protected through the correct use of stdlib APIs.
+- The unavailability of the host JavaScript runtime (e.g., due to unbounded performance degradation).
#### Examples of vulnerabilities
@@ -68,7 +68,7 @@ stdlib provides APIs for accessing underlying memory, such as those for ndarray
stdlib trusts inputs provided to it by downstream code. It is thus the responsibility of the downstream code to sanitize appropriately. Any scenario that requires control over user input is **not** considered a vulnerability.
-* * *
+---
## How to submit a report
@@ -76,14 +76,14 @@ stdlib supports [privately reporting security vulnerabilities][github-security-a
When submitting a report,
-- please provide detailed reports with reproducible steps and a clearly defined impact.
-- submit only one vulnerability per report.
-- do not engage in any form of social engineering (such as phishing, vishing, or smishing).
-- do not attempt to show CI/CD vulnerabilities by creating new pull requests to any of stdlib's repositories. Doing so will result in a [content report][github-content-report] to GitHub as an unsolicited exploit. The proper way to provide such reports is by creating a new repository, configured in the same manner as the repository about which you would like to submit a report, and, with a pull request to your own repository, showing the proof-of-concept.
+- please provide detailed reports with reproducible steps and a clearly defined impact.
+- submit only one vulnerability per report.
+- do not engage in any form of social engineering (such as phishing, vishing, or smishing).
+- do not attempt to show CI/CD vulnerabilities by creating new pull requests to any of stdlib's repositories. Doing so will result in a [content report][github-content-report] to GitHub as an unsolicited exploit. The proper way to provide such reports is by creating a new repository, configured in the same manner as the repository about which you would like to submit a report, and, with a pull request to your own repository, showing the proof-of-concept.
**Please do NOT report security vulnerabilities through public GitHub issues, discussions, or pull requests, or any other public stdlib forum.**
-* * *
+---
## Process
@@ -95,51 +95,51 @@ Please note that it is of the utmost importance that you read carefully and foll
stdlib does **not** support any reporting outside of the process outlined in this document.
-* * *
+---
## Disclosure policy
Our disclosure policy is as follows:
-- Once a security vulnerability is reported, the report is assigned a primary handler. This person will coordinate the fix and release process.
+- Once a security vulnerability is reported, the report is assigned a primary handler. This person will coordinate the fix and release process.
-- The problem is then validated against the **latest** release version (e.g., if a package published to npm, the latest `<major>.<minor>.x` release). Due to limited maintainer bandwidth, security vulnerabilities discovered in older `<major>.x.x` release lines are considered out-of-scope and will not receive security updates. Users are advised that only vulnerabilities affecting the **latest** release line will receive patches.
+- The problem is then validated against the **latest** release version (e.g., if a package published to npm, the latest `<major>.<minor>.x` release). Due to limited maintainer bandwidth, security vulnerabilities discovered in older `<major>.x.x` release lines are considered out-of-scope and will not receive security updates. Users are advised that only vulnerabilities affecting the **latest** release line will receive patches.
-- Depending on the outcome of validation, the primary handler will communicate to the individual who submitted the potential vulnerability one of the following possible responses:
+- Depending on the outcome of validation, the primary handler will communicate to the individual who submitted the potential vulnerability one of the following possible responses:
- - **Acceptance**: what was reported is a considered a new vulnerability.
- - **Rejection**: what was reported is not considered a new vulnerability.
- - **Needs more information**: we need more information in order to evaluate what was reported.
+ - **Acceptance**: what was reported is a considered a new vulnerability.
+ - **Rejection**: what was reported is not considered a new vulnerability.
+ - **Needs more information**: we need more information in order to evaluate what was reported.
-- Once a vulnerability is accepted, code is then audited to find any potential similar problems.
+- Once a vulnerability is accepted, code is then audited to find any potential similar problems.
-- Fixes are subsequently prepared for the latest `<major>.<minor>.x` release line.
+- Fixes are subsequently prepared for the latest `<major>.<minor>.x` release line.
-- After fix preparation, the primary handler will coordinate with stdlib maintainers to define a release date for the publication of the vulnerability.
+- After fix preparation, the primary handler will coordinate with stdlib maintainers to define a release date for the publication of the vulnerability.
-- The changes are pushed to the affected public repositories and, where relevant, new builds are published to npm.
+- The changes are pushed to the affected public repositories and, where relevant, new builds are published to npm.
-- The private security vulnerability report is then made public.
+- The private security vulnerability report is then made public.
Note that the above process can take time (up to and beyond **90** days depending on the complexity of the fix), especially when coordination is required with maintainers of other projects. We thus ask that you provide us with a reasonable amount of time to resolve reported vulnerabilities prior to any public disclosure or third party reporting. We will make every effort to handle the security report in as timely a manner as possible.
We further ask that you please allow us to follow the release process described above so that we can ensure that disclosures are handled in a consistent manner.
-* * *
+---
## Safe harbor
stdlib supports safe harbor for security researchers who
-- make a good faith effort to avoid privacy violations, destruction of data, and interruption or degradation of our services.
-- only interact with accounts they own or with explicit permission of the account holder. Upon encountering Personally Identifiable Information (PII), researchers are asked to contact us immediately, to not proceed with access, and to immediately delete any locally stored information.
-- provide us with a reasonable amount of time to resolve vulnerabilities prior to public or third party disclosure.
+- make a good faith effort to avoid privacy violations, destruction of data, and interruption or degradation of our services.
+- only interact with accounts they own or with explicit permission of the account holder. Upon encountering Personally Identifiable Information (PII), researchers are asked to contact us immediately, to not proceed with access, and to immediately delete any locally stored information.
+- provide us with a reasonable amount of time to resolve vulnerabilities prior to public or third party disclosure.
We will consider activities which are conducted in a manner consistent with the above policy to constitute authorized conduct and will not pursue civil action or initiate a complaint with law enforcement.
**Please submit a vulnerability report before engaging in conduct which may be inconsistent with or unaddressed by the above policy.**
-* * *
+---
## Comments on this policy
@@ -147,17 +147,17 @@ If you have suggestions on how the stdlib security process could be improved, pl
Thank you for helping make stdlib safe for everyone! ❤️
-* * *
+---
## Attribution
This policy document draws from the following security policies:
-- [npm][npm-security-policy]
-- [Electron][electron-security-policy]
-- [Node.js][nodejs-security-policy]
-- [remark][remark-security-policy]
-- [fastify][fastify-security-policy]
+- [npm][npm-security-policy]
+- [Electron][electron-security-policy]
+- [Node.js][nodejs-security-policy]
+- [remark][remark-security-policy]
+- [fastify][fastify-security-policy]
## License
@@ -172,27 +172,16 @@ Copyright © The Stdlib [Authors][stdlib-authors].
<section class="links">
[github-security-advisories]: https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/privately-reporting-a-security-vulnerability
-
[github-content-report]: https://docs.github.com/en/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam#reporting-an-issue-or-pull-request
-
[stdlib]: https://github.com/stdlib-js/stdlib
-
[stdlib-issues]: https://github.com/stdlib-js/stdlib/issues
-
[stdlib-new-security-advisory]: https://github.com/stdlib-js/stdlib/security/advisories/new
-
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
-
[npm-security-policy]: https://github.com/npm/cli/blob/86ac76caa4a8bd5d1acb1777befdbc4d9ebc8a1a/SECURITY.md
-
[electron-security-policy]: https://github.com/electron/electron/blob/95d094d75bddb99c83d2902fbc9a4335632a41cf/SECURITY.md
-
[nodejs-security-policy]: https://github.com/nodejs/node/blob/fa183786ef1dba08b960e7a64ec9b093a9b8b59d/SECURITY.md
-
[remark-security-policy]: https://github.com/remarkjs/.github/blob/8070442fde16e2c81f80bd65caab6d3a8cc090f4/security.md
-
[fastify-security-policy]: https://github.com/fastify/fastify/blob/e3a07eaa444d0e769802195816d4e1718c2fc9ea/SECURITY.md
-
[cc-by-sa-4.0]: https://creativecommons.org/licenses/by-sa/4.0/
</section>
diff --git a/SUPPORT.md b/SUPPORT.md
index 359c1df3ac78..491b1596f183 100644
--- a/SUPPORT.md
+++ b/SUPPORT.md
@@ -30,13 +30,13 @@ This document explains how to get help with stdlib. Please read through the foll
Please seek support in the following ways:
-- **Bugs**: if you have found a bug or would like to make a specific feature request, please file an issue on the stdlib [issue tracker][stdlib-issues].
-- **Security vulnerabilities**: if you would like to report a security vulnerability, please consult the stdlib [security policy][stdlib-security] and follow requested steps for responsible [disclosure][stdlib-security].
-- **Questions**: for general questions (i.e., concerns which are **not** bug reports or explicit feature requests), please ask on either [GitHub discussions][stdlib-discussions] or on [Gitter][stdlib-gitter].
+- **Bugs**: if you have found a bug or would like to make a specific feature request, please file an issue on the stdlib [issue tracker][stdlib-issues].
+- **Security vulnerabilities**: if you would like to report a security vulnerability, please consult the stdlib [security policy][stdlib-security] and follow requested steps for responsible [disclosure][stdlib-security].
+- **Questions**: for general questions (i.e., concerns which are **not** bug reports or explicit feature requests), please ask on either [GitHub discussions][stdlib-discussions] or on [Gitter][stdlib-gitter].
Please do **not** file issues on the issue tracker seeking help or support debugging your application or open-source project when the encountered issues are specific to your project. You will have better luck in such instances seeking help from other users of stdlib via Stack Overflow or other non-stdlib affiliated public forums.
-* * *
+---
### Asking Quality Questions
@@ -44,44 +44,44 @@ Help us help you! Be sure to spend time framing questions and to provide links a
When seeking help, you are encouraged to adhere to the following principles in order to increase the likelihood of receiving a successful response:
-- **Read documentation and other guides** for the project to see if you can answer the question or figure out the issue on your own. Try locating an example project, and explore how the project works to see if you can answer your question.
+- **Read documentation and other guides** for the project to see if you can answer the question or figure out the issue on your own. Try locating an example project, and explore how the project works to see if you can answer your question.
-- **Search for existing questions and answers** by consulting the stdlib [issue tracker][stdlib-issues], [discussions][stdlib-discussions], and [FAQ][stdlib-faq]. For debugging issues specific to your project or figuring out how to use stdlib in a manner unique to your application, search for answers and ask questions on Stack Overflow.
+- **Search for existing questions and answers** by consulting the stdlib [issue tracker][stdlib-issues], [discussions][stdlib-discussions], and [FAQ][stdlib-faq]. For debugging issues specific to your project or figuring out how to use stdlib in a manner unique to your application, search for answers and ask questions on Stack Overflow.
-- **Try ["rubber ducking"][rubber-duck-debugging]** to see if verbalizing and discussing the problem helps reveal or challenge any of your current assumptions.
+- **Try ["rubber ducking"][rubber-duck-debugging]** to see if verbalizing and discussing the problem helps reveal or challenge any of your current assumptions.
-- **Ensure that you ask about your actual problem** and not your attempted solution (i.e., do not fall prey to the [XY problem][xy-problem]).
+- **Ensure that you ask about your actual problem** and not your attempted solution (i.e., do not fall prey to the [XY problem][xy-problem]).
-- **Define what you need help with** by asking the following questions:
+- **Define what you need help with** by asking the following questions:
- - Are you confronted with a concept that you do not understand? If so, consider engaging more deeply with project documentation and seeking out example projects from which you can learn.
- - What are you specifically wanting to do? The more specific you are, the more targeted your response.
- - What problem are you encountering? The more granular you are in terms of circumstances, the more quickly others can reproduce the issue.
- - What steps have you taken to try and fix the problem? If you have settled on a particular solution, explain why the other attempts have failed.
+ - Are you confronted with a concept that you do not understand? If so, consider engaging more deeply with project documentation and seeking out example projects from which you can learn.
+ - What are you specifically wanting to do? The more specific you are, the more targeted your response.
+ - What problem are you encountering? The more granular you are in terms of circumstances, the more quickly others can reproduce the issue.
+ - What steps have you taken to try and fix the problem? If you have settled on a particular solution, explain why the other attempts have failed.
-- **Provide sample code**, but do not attach your entire project for someone else to debug. Instead, provide a minimal reproducible example of the issue you are encountering.
+- **Provide sample code**, but do not attach your entire project for someone else to debug. Instead, provide a minimal reproducible example of the issue you are encountering.
-- **Prefer providing code and error messages as text** rather than screenshots. While screenshots can be useful, maintainers will benefit from being to engage directly with important text, especially when attempting to reproduce the encountered issue.
+- **Prefer providing code and error messages as text** rather than screenshots. While screenshots can be useful, maintainers will benefit from being to engage directly with important text, especially when attempting to reproduce the encountered issue.
-- **Proofread and cross-check** your question to ensure that your question is communicated as clearly as possible.
+- **Proofread and cross-check** your question to ensure that your question is communicated as clearly as possible.
-- **Do not open duplicate issues** or litter an existing issue with separate "+1" comments. If you want to "upvote" an issue or comment, instead of posting a separate comment, use GitHub's built-in [reaction support][github-reactions] to record a 👍 emoji response.
+- **Do not open duplicate issues** or litter an existing issue with separate "+1" comments. If you want to "upvote" an issue or comment, instead of posting a separate comment, use GitHub's built-in [reaction support][github-reactions] to record a 👍 emoji response.
-- **Do not e-mail (or reach out to via social media) specific project authors or contributors** asking for help debugging your project or application. Please be respectful of maintainer time, and respect that maintainers are likely to have other obligations outside of stdlib.
+- **Do not e-mail (or reach out to via social media) specific project authors or contributors** asking for help debugging your project or application. Please be respectful of maintainer time, and respect that maintainers are likely to have other obligations outside of stdlib.
-* * *
+---
## Contributing
If you are interested in contributing to stdlib, please see the stdlib [contributing guide][stdlib-contributing] for guidance on how to contribute.
-* * *
+---
## Attribution
This policy document draws from the following support documents:
-- [remark][remark-support]
+- [remark][remark-support]
## License
@@ -96,29 +96,17 @@ Copyright © The Stdlib [Authors][stdlib-authors].
<section class="links">
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
-
[stdlib-code-of-conduct]: https://github.com/stdlib-js/stdlib/blob/develop/CODE_OF_CONDUCT.md
-
[stdlib-discussions]: https://github.com/stdlib-js/stdlib/discussions
-
[stdlib-gitter]: https://gitter.im/stdlib-js/stdlib
-
[stdlib-issues]: https://github.com/stdlib-js/stdlib/issues
-
[stdlib-security]: https://github.com/stdlib-js/stdlib/security
-
[stdlib-faq]: https://github.com/stdlib-js/stdlib/blob/develop/FAQ.md
-
[stdlib-contributing]: https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md
-
[rubber-duck-debugging]: https://rubberduckdebugging.com/
-
[xy-problem]: https://meta.stackexchange.com/questions/66377/what-is-the-xy-problem/66378#66378
-
[remark-support]: https://github.com/remarkjs/.github/blob/8070442fde16e2c81f80bd65caab6d3a8cc090f4/support.md
-
[github-reactions]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/
-
[cc-by-sa-4.0]: https://creativecommons.org/licenses/by-sa/4.0/
</section>
diff --git a/TSC.md b/TSC.md
index 668b8dff85ed..afb8b6c1f276 100644
--- a/TSC.md
+++ b/TSC.md
@@ -26,19 +26,15 @@ For information about the governance of the stdlib project, see [GOVERNANCE.md][
## Members
-- [kgryte][athan-reines-github] - **Athan Reines** <[kgryte@gmail.com][athan-reines-email]> (he/him)
-- [Planeshifter][philipp-burckhardt-github] - **Philipp Burckhardt** <[pburckhardt@outlook.com][philipp-burckhardt-email]> (he/him)
+- [kgryte][athan-reines-github] - **Athan Reines** <[kgryte@gmail.com][athan-reines-email]> (he/him)
+- [Planeshifter][philipp-burckhardt-github] - **Philipp Burckhardt** <[pburckhardt@outlook.com][philipp-burckhardt-email]> (he/him)
<section class="links">
[stdlib-governance]: https://github.com/stdlib-js/stdlib/blob/develop/GOVERNANCE.md
-
[athan-reines-github]: https://github.com/kgryte
-
[athan-reines-email]: mailto:kgryte@gmail.com
-
[philipp-burckhardt-github]: https://github.com/Planeshifter
-
[philipp-burckhardt-email]: mailto:pburckhardt@outlook.com
</section>
diff --git a/azure-pipelines-disabled.yml b/azure-pipelines-disabled.yml
index d94a7995d5b2..9beef074d5a3 100644
--- a/azure-pipelines-disabled.yml
+++ b/azure-pipelines-disabled.yml
@@ -18,10 +18,8 @@
# Define the triggers which will cause a build to run:
trigger:
-
# Define branch triggers:
branches:
-
# List branches for which changes will trigger a build:
include:
- master
@@ -29,7 +27,6 @@ trigger:
# Define path triggers:
paths:
-
# List paths for which changes should trigger a build:
include:
- bin
@@ -52,22 +49,17 @@ trigger:
- datapackage.json
- "*.md"
-
# Define pull request triggers which will cause a build to run:
pr:
-
# Define branch triggers:
branches:
-
# List branches against which PRs will trigger a build to run:
include:
- master
- develop
-
# Define path triggers:
paths:
-
# List paths for which changes should trigger a build:
include:
- bin
@@ -91,12 +83,11 @@ pr:
- datapackage.json
- "*.md"
-
jobs:
- - job: 'unit_tests_linux'
+ - job: "unit_tests_linux"
# Define a display name for use in the UI:
- displayName: 'unit tests: linux'
+ displayName: "unit tests: linux"
# Define how long a job is allowed to run before timing out:
timeoutInMinutes: 360
@@ -106,37 +97,36 @@ jobs:
# Specify the host environment:
pool:
- vmImage: 'ubuntu-16.04'
+ vmImage: "ubuntu-16.04"
# Define variable sets for parallel job execution:
strategy:
-
# Define the maximum number of parallel jobs:
maxParallel: 10
# Define variable sets which will be used to create separate jobs (one per variable set!):
matrix:
node_v16:
- NODE_VERSION: '16'
- NPM_VERSION: '>2.7.0'
+ NODE_VERSION: "16"
+ NPM_VERSION: ">2.7.0"
node_v14:
- NODE_VERSION: '14'
- NPM_VERSION: '>2.7.0'
+ NODE_VERSION: "14"
+ NPM_VERSION: ">2.7.0"
node_v12:
- NODE_VERSION: '12'
- NPM_VERSION: '>2.7.0'
+ NODE_VERSION: "12"
+ NPM_VERSION: ">2.7.0"
node_v10:
- NODE_VERSION: '10'
- NPM_VERSION: '>2.7.0 <7.0.0'
+ NODE_VERSION: "10"
+ NPM_VERSION: ">2.7.0 <7.0.0"
node_v8:
- NODE_VERSION: '8'
- NPM_VERSION: '>2.7.0 <6.0.0'
+ NODE_VERSION: "8"
+ NPM_VERSION: ">2.7.0 <6.0.0"
node_v6:
- NODE_VERSION: '6'
- NPM_VERSION: '>2.7.0 <6.0.0'
+ NODE_VERSION: "6"
+ NPM_VERSION: ">2.7.0 <6.0.0"
node_v4:
- NODE_VERSION: '4'
- NPM_VERSION: '>2.7.0 <6.0.0'
+ NODE_VERSION: "4"
+ NPM_VERSION: ">2.7.0 <6.0.0"
steps:
# Configure clone settings:
@@ -149,20 +139,20 @@ jobs:
- task: NodeTool@0
# Define a UI display name:
- displayName: 'Install Node.js'
+ displayName: "Install Node.js"
# Define a task-specific timeout:
timeoutInMinutes: 5
# Define the Node.js version to install:
inputs:
- versionSpec: '$(NODE_VERSION)'
+ versionSpec: "$(NODE_VERSION)"
# Update the npm client (older clients cannot handle scoped modules):
- task: Npm@1
# Define a UI display name:
- displayName: 'Update npm'
+ displayName: "Update npm"
# Define a task-specific timeout:
timeoutInMinutes: 5
@@ -172,12 +162,11 @@ jobs:
command: custom
customCommand: 'install -g npm@"$(NPM_VERSION)"'
-
# Print debug information:
- task: bash@3
# Define a UI display name:
- displayName: 'Debug info'
+ displayName: "Debug info"
# Define a task-specific timeout:
timeoutInMinutes: 2
diff --git a/bin/cli b/bin/cli
index 94eec1fb40b5..82a002f490d7 100644
--- a/bin/cli
+++ b/bin/cli
@@ -1,195 +1,200 @@
#!/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';
+ * @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 path = require( 'path' );
-var spawn = require( 'child_process' ).spawn;
-var CLI = require( '@stdlib/cli/ctor' );
-var parentPath = require( '@stdlib/fs/resolve-parent-path' ).sync;
-var readFile = require( '@stdlib/fs/read-file' ).sync;
-var hasOwnProp = require( '@stdlib/assert/has-own-property' );
-var objectKeys = require( '@stdlib/utils/keys' );
-var dirname = require( '@stdlib/utils/dirname' );
-var cwd = require( '@stdlib/process/cwd' );
-var ENV = require( '@stdlib/process/env' );
-var COMMANDS = require( './cli_commands.json' );
-
+var path = require("path");
+var spawn = require("child_process").spawn;
+var CLI = require("@stdlib/cli/ctor");
+var parentPath = require("@stdlib/fs/resolve-parent-path").sync;
+var readFile = require("@stdlib/fs/read-file").sync;
+var hasOwnProp = require("@stdlib/assert/has-own-property");
+var objectKeys = require("@stdlib/utils/keys");
+var dirname = require("@stdlib/utils/dirname");
+var cwd = require("@stdlib/process/cwd");
+var ENV = require("@stdlib/process/env");
+var COMMANDS = require("./cli_commands.json");
// FUNCTIONS //
/**
-* Returns command information.
-*
-* @private
-* @param {string} cmd - command
-* @returns {(Object|null)} command info
-*/
-function findCommand( cmd ) {
- var i;
- for ( i = 0; i < COMMANDS.length; i++ ) {
- if ( cmd === COMMANDS[ i ].command ) {
- return COMMANDS[ i ];
- }
- }
- return null;
+ * Returns command information.
+ *
+ * @private
+ * @param {string} cmd - command
+ * @returns {(Object|null)} command info
+ */
+function findCommand(cmd) {
+ var i;
+ for (i = 0; i < COMMANDS.length; i++) {
+ if (cmd === COMMANDS[i].command) {
+ return COMMANDS[i];
+ }
+ }
+ return null;
}
/**
-* Resolves a CLI file path.
-*
-* @private
-* @param {string} pkgPath - package name/path
-* @throws {Error} unable to resolve CLI
-* @returns {string} file path
-*/
-function getPath( pkgPath ) {
- var mpath;
- var cmds;
- var pkg;
-
- if ( /^@stdlib/.test( pkgPath ) ) {
- // Resolve a package's main entry point:
- mpath = require.resolve( pkgPath );
-
- // Resolve a dependency's path by finding the dependency's `package.json`:
- mpath = parentPath( 'package.json', {
- 'dir': dirname( mpath )
- });
-
- // Read the package meta data:
- pkg = require( mpath ); // eslint-disable-line stdlib/no-dynamic-require
-
- // Resolve a `bin` field:
- if ( !hasOwnProp( pkg, 'bin' ) ) {
- throw new Error( 'unexpected error. Unable to resolve command.' );
- }
- cmds = objectKeys( pkg.bin );
- if ( cmds.length === 0 ) {
- throw new Error( 'unexpected error. Unable to resolve command.' );
- }
- // NOTE: assume that the first command is the desired command:
- return path.join( dirname( mpath ), pkg.bin[ cmds[ 0 ] ] );
- }
- // Assume we are given a path relative to the root directory:
- return path.resolve( __dirname, '..', pkgPath );
+ * Resolves a CLI file path.
+ *
+ * @private
+ * @param {string} pkgPath - package name/path
+ * @throws {Error} unable to resolve CLI
+ * @returns {string} file path
+ */
+function getPath(pkgPath) {
+ var mpath;
+ var cmds;
+ var pkg;
+
+ if (/^@stdlib/.test(pkgPath)) {
+ // Resolve a package's main entry point:
+ mpath = require.resolve(pkgPath);
+
+ // Resolve a dependency's path by finding the dependency's `package.json`:
+ mpath = parentPath("package.json", {
+ dir: dirname(mpath),
+ });
+
+ // Read the package meta data:
+ pkg = require(mpath); // eslint-disable-line stdlib/no-dynamic-require
+
+ // Resolve a `bin` field:
+ if (!hasOwnProp(pkg, "bin")) {
+ throw new Error("unexpected error. Unable to resolve command.");
+ }
+ cmds = objectKeys(pkg.bin);
+ if (cmds.length === 0) {
+ throw new Error("unexpected error. Unable to resolve command.");
+ }
+ // NOTE: assume that the first command is the desired command:
+ return path.join(dirname(mpath), pkg.bin[cmds[0]]);
+ }
+ // Assume we are given a path relative to the root directory:
+ return path.resolve(__dirname, "..", pkgPath);
}
-
// MAIN //
/**
-* Main execution sequence.
-*
-* @private
-* @returns {void}
-*/
+ * Main execution sequence.
+ *
+ * @private
+ * @returns {void}
+ */
function main() {
- var subargs;
- var flags;
- var keys;
- var args;
- var opts;
- var proc;
- var cli;
- var cmd;
- var key;
- var i;
-
- // Create a command-line interface:
- cli = new CLI({
- 'pkg': require( './../package.json' ),
- 'options': require( './cli_opts.json' ),
- 'help': readFile( path.resolve( __dirname, 'usage.txt' ), {
- 'encoding': 'utf8'
- })
- });
-
- // Get any provided command-line options:
- flags = cli.flags();
- if ( flags.help || flags.version ) {
- return;
- }
-
- // Get any provided command-line arguments:
- args = cli.args();
-
- // Extract the command:
- if ( args.length === 0 ) {
- return cli.help();
- }
- if ( args[ 0 ] === 'help' ) {
- if ( args.length === 1 ) {
- return cli.help();
- }
- cmd = findCommand( args[ 1 ] );
- if ( cmd === null ) {
- return cli.error( new Error( 'invalid argument. Unrecognized/unsupported command. Value: `' + args[ 1 ] + '`.' ) );
- }
- subargs = [ getPath( cmd.path ), '--help' ];
- } else {
- cmd = findCommand( args[ 0 ] );
- if ( cmd === null ) {
- return cli.error( new Error( 'invalid argument. Unrecognized/unsupported command. Value: `' + args[ 0 ] + '`.' ) );
- }
- subargs = [ getPath( cmd.path ) ];
- for ( i = 1; i < args.length; i++ ) {
- subargs.push( args[ i ] );
- }
- keys = objectKeys( flags );
- for ( i = 0; i < keys.length; i++ ) {
- key = keys[ i ];
- if (
- key === 'h' ||
- key === 'help' ||
- key === 'V' ||
- key === 'version'
- ) {
- continue;
- }
- subargs.push( '--'+keys[ i ]+'='+flags[ keys[ i ] ] );
- }
- }
-
- // Define sub-process options:
- opts = {
- 'cwd': cwd(),
- 'env': ENV,
- 'stdio': 'inherit'
- };
-
- // Invoke the command in a sub-process:
- proc = spawn( 'node', subargs, opts );
- proc.on( 'error', onError );
-
- /**
- * Callback invoked upon encountering an error while running a command.
- *
- * @private
- * @param {Error} error - error object
- */
- function onError( error ) {
- cli.error( error );
- }
+ var subargs;
+ var flags;
+ var keys;
+ var args;
+ var opts;
+ var proc;
+ var cli;
+ var cmd;
+ var key;
+ var i;
+
+ // Create a command-line interface:
+ cli = new CLI({
+ pkg: require("./../package.json"),
+ options: require("./cli_opts.json"),
+ help: readFile(path.resolve(__dirname, "usage.txt"), {
+ encoding: "utf8",
+ }),
+ });
+
+ // Get any provided command-line options:
+ flags = cli.flags();
+ if (flags.help || flags.version) {
+ return;
+ }
+
+ // Get any provided command-line arguments:
+ args = cli.args();
+
+ // Extract the command:
+ if (args.length === 0) {
+ return cli.help();
+ }
+ if (args[0] === "help") {
+ if (args.length === 1) {
+ return cli.help();
+ }
+ cmd = findCommand(args[1]);
+ if (cmd === null) {
+ return cli.error(
+ new Error(
+ "invalid argument. Unrecognized/unsupported command. Value: `" +
+ args[1] +
+ "`.",
+ ),
+ );
+ }
+ subargs = [getPath(cmd.path), "--help"];
+ } else {
+ cmd = findCommand(args[0]);
+ if (cmd === null) {
+ return cli.error(
+ new Error(
+ "invalid argument. Unrecognized/unsupported command. Value: `" +
+ args[0] +
+ "`.",
+ ),
+ );
+ }
+ subargs = [getPath(cmd.path)];
+ for (i = 1; i < args.length; i++) {
+ subargs.push(args[i]);
+ }
+ keys = objectKeys(flags);
+ for (i = 0; i < keys.length; i++) {
+ key = keys[i];
+ if (key === "h" || key === "help" || key === "V" || key === "version") {
+ continue;
+ }
+ subargs.push("--" + keys[i] + "=" + flags[keys[i]]);
+ }
+ }
+
+ // Define sub-process options:
+ opts = {
+ cwd: cwd(),
+ env: ENV,
+ stdio: "inherit",
+ };
+
+ // Invoke the command in a sub-process:
+ proc = spawn("node", subargs, opts);
+ proc.on("error", onError);
+
+ /**
+ * Callback invoked upon encountering an error while running a command.
+ *
+ * @private
+ * @param {Error} error - error object
+ */
+ function onError(error) {
+ cli.error(error);
+ }
}
main();
diff --git a/bin/cli_commands.json b/bin/cli_commands.json
index bb3c9e94231f..c2734b707317 100644
--- a/bin/cli_commands.json
+++ b/bin/cli_commands.json
@@ -1,956 +1,956 @@
[
- {
- "command": "help [command]",
- "description": "Print a help message.",
- "path": "",
- "group": "general"
- },
- {
- "command": "arch",
- "description": "Operating system CPU architecture.",
- "path": "@stdlib/os/arch",
- "group": "system"
- },
- {
- "command": "bench",
- "description": "Run JavaScript benchmark files.",
- "path": "@stdlib/bench",
- "group": "benchmarking"
- },
- {
- "command": "bundle-pkg-list",
- "description": "Bundle a list of stdlib packages.",
- "path": "@stdlib/_tools/bundle/pkg-list",
- "group": "tools"
- },
- {
- "command": "capitalize",
- "description": "Capitalize the first character in a string.",
- "path": "@stdlib/string/capitalize",
- "group": "utilities"
- },
- {
- "command": "configdir",
- "description": "Configuration directory path.",
- "path": "@stdlib/os/configdir",
- "group": "system"
- },
- {
- "command": "convert-path",
- "description": "Convert between Windows and POSIX paths.",
- "path": "@stdlib/utils/convert-path",
- "group": "utilities"
- },
- {
- "command": "cwd",
- "description": "Current working directory.",
- "path": "@stdlib/process/cwd",
- "group": "system"
- },
- {
- "command": "datasets",
- "description": "Retrieve a dataset.",
- "path": "@stdlib/datasets",
- "group": "general"
- },
- {
- "command": "day-of-quarter",
- "description": "Calculate day of quarter.",
- "path": "@stdlib/time/day-of-quarter",
- "group": "time"
- },
- {
- "command": "day-of-year",
- "description": "Calculate day of year.",
- "path": "@stdlib/time/day-of-year",
- "group": "time"
- },
- {
- "command": "days-in-month",
- "description": "Calculate the number of days in a month.",
- "path": "@stdlib/time/days-in-month",
- "group": "time"
- },
- {
- "command": "days-in-year",
- "description": "Calculate the number of days in a year.",
- "path": "@stdlib/time/days-in-year",
- "group": "time"
- },
- {
- "command": "ends-with",
- "description": "Test if a string ends with another string.",
- "path": "@stdlib/string/ends-with",
- "group": "utilities"
- },
- {
- "command": "exists",
- "description": "Test if a file exists.",
- "path": "@stdlib/fs/exists",
- "group": "filesystem"
- },
- {
- "command": "from-code-point",
- "description": "Create a string from code points.",
- "path": "@stdlib/string/from-code-point",
- "group": "utilities"
- },
- {
- "command": "has-arraybuffer-support",
- "description": "Detect ArrayBuffer support.",
- "path": "@stdlib/assert/has-arraybuffer-support",
- "group": "assert"
- },
- {
- "command": "has-async-await-support",
- "description": "Detect async/await support.",
- "path": "@stdlib/assert/has-async-await-support",
- "group": "assert"
- },
- {
- "command": "has-async-iterator-symbol-support",
- "description": "Detect Symbol.asyncIterator support.",
- "path": "@stdlib/assert/has-async-iterator-symbol-support",
- "group": "assert"
- },
- {
- "command": "has-class-support",
- "description": "Detect ES6 class support.",
- "path": "@stdlib/assert/has-class-support",
- "group": "assert"
- },
- {
- "command": "has-float32array-support",
- "description": "Detect Float32Array support.",
- "path": "@stdlib/assert/has-float32array-support",
- "group": "assert"
- },
- {
- "command": "has-float64array-support",
- "description": "Detect Float64Array support.",
- "path": "@stdlib/assert/has-float64array-support",
- "group": "assert"
- },
- {
- "command": "has-function-name-support",
- "description": "Detect function name support.",
- "path": "@stdlib/assert/has-function-name-support",
- "group": "assert"
- },
- {
- "command": "has-generator-support",
- "description": "Detect generator support.",
- "path": "@stdlib/assert/has-generator-support",
- "group": "assert"
- },
- {
- "command": "has-int16array-support",
- "description": "Detect Int16Array support.",
- "path": "@stdlib/assert/has-int16array-support",
- "group": "assert"
- },
- {
- "command": "has-int32array-support",
- "description": "Detect Int32Array support.",
- "path": "@stdlib/assert/has-int32array-support",
- "group": "assert"
- },
- {
- "command": "has-int8array-support",
- "description": "Detect Int8Array support.",
- "path": "@stdlib/assert/has-int8array-support",
- "group": "assert"
- },
- {
- "command": "has-iterator-symbol-support",
- "description": "Detect Symbol.iterator support.",
- "path": "@stdlib/assert/has-iterator-symbol-support",
- "group": "assert"
- },
- {
- "command": "has-map-support",
- "description": "Detect Map support.",
- "path": "@stdlib/assert/has-map-support",
- "group": "assert"
- },
- {
- "command": "has-node-buffer-support",
- "description": "Detect Node buffer support.",
- "path": "@stdlib/assert/has-node-buffer-support",
- "group": "assert"
- },
- {
- "command": "has-proxy-support",
- "description": "Detect Proxy support.",
- "path": "@stdlib/assert/has-proxy-support",
- "group": "assert"
- },
- {
- "command": "has-set-support",
- "description": "Detect Set support.",
- "path": "@stdlib/assert/has-set-support",
- "group": "assert"
- },
- {
- "command": "has-sharedarraybuffer-support",
- "description": "Detect SharedArrayBuffer support.",
- "path": "@stdlib/assert/has-sharedarraybuffer-support",
- "group": "assert"
- },
- {
- "command": "has-symbol-support",
- "description": "Detect Symbol support.",
- "path": "@stdlib/assert/has-symbol-support",
- "group": "assert"
- },
- {
- "command": "has-tostringtag-support",
- "description": "Detect Symbol.toStringTag support.",
- "path": "@stdlib/assert/has-tostringtag-support",
- "group": "assert"
- },
- {
- "command": "has-uint16array-support",
- "description": "Detect Uit16Array support.",
- "path": "@stdlib/assert/has-uint16array-support",
- "group": "assert"
- },
- {
- "command": "has-uint32array-support",
- "description": "Detect Uit32Array support.",
- "path": "@stdlib/assert/has-uint32array-support",
- "group": "assert"
- },
- {
- "command": "has-uint8array-support",
- "description": "Detect Uit8Array support.",
- "path": "@stdlib/assert/has-uint8array-support",
- "group": "assert"
- },
- {
- "command": "has-uint8clampedarray-support",
- "description": "Detect Uit8ClampedArray support.",
- "path": "@stdlib/assert/has-uint8clampedarray-support",
- "group": "assert"
- },
- {
- "command": "has-wasm-support",
- "description": "Detect WebAssembly support.",
- "path": "@stdlib/assert/has-wasm-support",
- "group": "assert"
- },
- {
- "command": "has-weakmap-support",
- "description": "Detect WeakMap support.",
- "path": "@stdlib/assert/has-weakmap-support",
- "group": "assert"
- },
- {
- "command": "has-weakset-support",
- "description": "Detect WeakSet support.",
- "path": "@stdlib/assert/has-weakset-support",
- "group": "assert"
- },
- {
- "command": "homedir",
- "description": "Home directory path.",
- "path": "@stdlib/os/homedir",
- "group": "system"
- },
- {
- "command": "hours-in-month",
- "description": "Calculate the number of hours in a month.",
- "path": "@stdlib/time/hours-in-month",
- "group": "time"
- },
- {
- "command": "hours-in-year",
- "description": "Calculate the number of hours in a year.",
- "path": "@stdlib/time/hours-in-year",
- "group": "time"
- },
- {
- "command": "iso-weeks-in-year",
- "description": "Calculate the number of ISO weeks in a year.",
- "path": "@stdlib/time/iso-weeks-in-year",
- "group": "time"
- },
- {
- "command": "is-absolute-path",
- "description": "Assert an absolute path.",
- "path": "@stdlib/assert/is-absolute-path",
- "group": "assert"
- },
- {
- "command": "is-alphagram",
- "description": "Assert if a value is an alphagram.",
- "path": "@stdlib/assert/is-alphagram",
- "group": "assert"
- },
- {
- "command": "is-alphanumeric",
- "description": "Assert if a value is alphanumeric.",
- "path": "@stdlib/assert/is-alphanumeric",
- "group": "assert"
- },
- {
- "command": "is-anagram",
- "description": "Assert if a value is an anagram.",
- "path": "@stdlib/assert/is-anagram",
- "group": "assert"
- },
- {
- "command": "is-ascii",
- "description": "Assert if a value is ASCII.",
- "path": "@stdlib/assert/is-ascii",
- "group": "assert"
- },
- {
- "command": "is-binary-string",
- "description": "Assert if a value is a binary string.",
- "path": "@stdlib/assert/is-binary-string",
- "group": "assert"
- },
- {
- "command": "is-capitalized",
- "description": "Assert if a value is capitalized.",
- "path": "@stdlib/assert/is-capitalized",
- "group": "assert"
- },
- {
- "command": "is-digit-string",
- "description": "Assert if a value is a digit string.",
- "path": "@stdlib/assert/is-digit-string",
- "group": "assert"
- },
- {
- "command": "is-email-address",
- "description": "Assert if a value is an email address.",
- "path": "@stdlib/assert/is-email-address",
- "group": "assert"
- },
- {
- "command": "is-hex-string",
- "description": "Assert if a value is a hexadecimal string.",
- "path": "@stdlib/assert/is-hex-string",
- "group": "assert"
- },
- {
- "command": "is-leap-year",
- "description": "Assert if a leap year.",
- "path": "@stdlib/assert/is-leap-year",
- "group": "assert"
- },
- {
- "command": "is-little-endian",
- "description": "Assert if little endian.",
- "path": "@stdlib/assert/is-little-endian",
- "group": "assert"
- },
- {
- "command": "is-lowercase",
- "description": "Assert if a value is lowercase.",
- "path": "@stdlib/assert/is-lowercase",
- "group": "assert"
- },
- {
- "command": "is-regexp-string",
- "description": "Assert if a value is a regexp string.",
- "path": "@stdlib/assert/is-regexp-string",
- "group": "assert"
- },
- {
- "command": "is-unc-path",
- "description": "Assert a UNC path.",
- "path": "@stdlib/assert/is-unc-path",
- "group": "assert"
- },
- {
- "command": "is-uppercase",
- "description": "Assert if a value is uppercase.",
- "path": "@stdlib/assert/is-uppercase",
- "group": "assert"
- },
- {
- "command": "is-uri",
- "description": "Assert if a value is a URI.",
- "path": "@stdlib/assert/is-uri",
- "group": "assert"
- },
- {
- "command": "is-whitespace",
- "description": "Assert if a value is only whitespace.",
- "path": "@stdlib/assert/is-whitespace",
- "group": "assert"
- },
- {
- "command": "js-eval",
- "description": "Evaluate a JavaScript string.",
- "path": "@stdlib/utils/eval",
- "group": "utilities"
- },
- {
- "command": "library-manifest",
- "description": "Load a manifest for compiling source files.",
- "path": "@stdlib/utils/library-manifest",
- "group": "meta"
- },
- {
- "command": "lpad",
- "description": "Left pad a string.",
- "path": "@stdlib/string/left-pad",
- "group": "utilities"
- },
- {
- "command": "ltrim",
- "description": "Left trim a string.",
- "path": "@stdlib/string/left-trim",
- "group": "utilities"
- },
- {
- "command": "lowercase",
- "description": "Lowercase a string.",
- "path": "@stdlib/string/lowercase",
- "group": "utilities"
- },
- {
- "command": "ls",
- "description": "List stdlib package names.",
- "path": "@stdlib/_tools/pkgs/names",
- "group": "meta"
- },
- {
- "command": "ls-tree",
- "description": "Show stdlib package tree.",
- "path": "@stdlib/_tools/pkgs/tree",
- "group": "meta"
- },
- {
- "command": "minutes-in-month",
- "description": "Calculate the number of minutes in a month.",
- "path": "@stdlib/time/minutes-in-month",
- "group": "time"
- },
- {
- "command": "minutes-in-year",
- "description": "Calculate the number of minutes in a year.",
- "path": "@stdlib/time/minutes-in-year",
- "group": "time"
- },
- {
- "command": "node-version",
- "description": "Node.js version.",
- "path": "@stdlib/process/node-version",
- "group": "meta"
- },
- {
- "command": "now",
- "description": "Number of seconds since the epoch.",
- "path": "@stdlib/time/now",
- "group": "time"
- },
- {
- "command": "ns",
- "description": "Print stdlib namespace.",
- "path": "@stdlib/namespace",
- "group": "meta"
- },
- {
- "command": "num-cpus",
- "description": "Number of CPUs.",
- "path": "@stdlib/os/num-cpus",
- "group": "system"
- },
- {
- "command": "random-arcsine",
- "description": "Arcsine distributed pseudorandom numbers.",
- "path": "@stdlib/random/streams/arcsine",
- "group": "random"
- },
- {
- "command": "random-bernoulli",
- "description": "Bernoulli distributed pseudorandom numbers.",
- "path": "@stdlib/random/streams/bernoulli",
- "group": "random"
- },
- {
- "command": "random-beta",
- "description": "Beta distributed pseudorandom numbers.",
- "path": "@stdlib/random/streams/beta",
- "group": "random"
- },
- {
- "command": "random-betaprime",
- "description": "Beta prime distributed pseudorandom numbers.",
- "path": "@stdlib/random/streams/betaprime",
- "group": "random"
- },
- {
- "command": "random-box-muller",
- "description": "Box-Muller pseudorandom numbers.",
- "path": "@stdlib/random/streams/box-muller",
- "group": "random"
- },
- {
- "command": "random-cauchy",
- "description": "Cauchy distributed pseudorandom numbers.",
- "path": "@stdlib/random/streams/cauchy",
- "group": "random"
- },
- {
- "command": "random-chi",
- "description": "Chi distributed pseudorandom numbers.",
- "path": "@stdlib/random/streams/chi",
- "group": "random"
- },
- {
- "command": "random-chisquare",
- "description": "Chi-square distributed pseudorandom numbers.",
- "path": "@stdlib/random/streams/chisquare",
- "group": "random"
- },
- {
- "command": "random-cosine",
- "description": "Raised cosine distributed pseudorandom numbers.",
- "path": "@stdlib/random/streams/cosine",
- "group": "random"
- },
- {
- "command": "random-discrete-uniform",
- "description": "Uniformly distributed pseudorandom integers.",
- "path": "@stdlib/random/streams/discrete-uniform",
- "group": "random"
- },
- {
- "command": "random-erlang",
- "description": "Erlang distributed pseudorandom numbers.",
- "path": "@stdlib/random/streams/erlang",
- "group": "random"
- },
- {
- "command": "random-exponential",
- "description": "Exponentially distributed pseudorandom numbers.",
- "path": "@stdlib/random/streams/exponential",
- "group": "random"
- },
- {
- "command": "random-f",
- "description": "F distributed pseudorandom numbers.",
- "path": "@stdlib/random/streams/f",
- "group": "random"
- },
- {
- "command": "random-gamma",
- "description": "Gamma distributed pseudorandom numbers.",
- "path": "@stdlib/random/streams/gamma",
- "group": "random"
- },
- {
- "command": "random-geometric",
- "description": "Geometric distributed pseudorandom numbers.",
- "path": "@stdlib/random/streams/geometric",
- "group": "random"
- },
- {
- "command": "random-gumbel",
- "description": "Gumbel distributed pseudorandom numbers.",
- "path": "@stdlib/random/streams/gumbel",
- "group": "random"
- },
- {
- "command": "random-improved-ziggurat",
- "description": "Improved Ziggurat pseudorandom numbers.",
- "path": "@stdlib/random/streams/improved-ziggurat",
- "group": "random"
- },
- {
- "command": "random-invgamma",
- "description": "Inverse gamma distributed pseudorandom numbers.",
- "path": "@stdlib/random/streams/invgamma",
- "group": "random"
- },
- {
- "command": "random-kumaraswamy",
- "description": "Kumaraswamy distributed pseudorandom numbers.",
- "path": "@stdlib/random/streams/kumaraswamy",
- "group": "random"
- },
- {
- "command": "random-laplace",
- "description": "Laplace distributed pseudorandom numbers.",
- "path": "@stdlib/random/streams/laplace",
- "group": "random"
- },
- {
- "command": "random-levy",
- "description": "Lévy distributed pseudorandom numbers.",
- "path": "@stdlib/random/streams/levy",
- "group": "random"
- },
- {
- "command": "random-logistic",
- "description": "Logistic distributed pseudorandom numbers.",
- "path": "@stdlib/random/streams/logistic",
- "group": "random"
- },
- {
- "command": "random-lognormal",
- "description": "Lognormal distributed pseudorandom numbers.",
- "path": "@stdlib/random/streams/lognormal",
- "group": "random"
- },
- {
- "command": "random-minstd",
- "description": "Park and Miller LCG pseudorandom numbers.",
- "path": "@stdlib/random/streams/minstd",
- "group": "random"
- },
- {
- "command": "random-minstd-shuffle",
- "description": "Shuffled LCG pseudorandom numbers.",
- "path": "@stdlib/random/streams/minstd-shuffle",
- "group": "random"
- },
- {
- "command": "random-mt19937",
- "description": "32-bit Mersenne Twister pseudorandom numbers.",
- "path": "@stdlib/random/streams/mt19937",
- "group": "random"
- },
- {
- "command": "random-normal",
- "description": "Normally distributed pseudorandom numbers.",
- "path": "@stdlib/random/streams/normal",
- "group": "random"
- },
- {
- "command": "random-pareto-type1",
- "description": "Pareto (type 1) distributed pseudorandom numbers.",
- "path": "@stdlib/random/streams/pareto-type1",
- "group": "random"
- },
- {
- "command": "random-poisson",
- "description": "Poisson distributed pseudorandom numbers.",
- "path": "@stdlib/random/streams/poisson",
- "group": "random"
- },
- {
- "command": "random-randi",
- "description": "Pseudorandom numbers having integer values.",
- "path": "@stdlib/random/streams/randi",
- "group": "random"
- },
- {
- "command": "random-randn",
- "description": "Normally distributed pseudorandom numbers.",
- "path": "@stdlib/random/streams/randn",
- "group": "random"
- },
- {
- "command": "random-randu",
- "description": "Pseudorandom numbers between 0 and 1.",
- "path": "@stdlib/random/streams/randu",
- "group": "random"
- },
- {
- "command": "random-Rayleigh",
- "description": "Rayleigh distributed pseudorandom numbers.",
- "path": "@stdlib/random/streams/rayleigh",
- "group": "random"
- },
- {
- "command": "random-t",
- "description": "Student's t distributed pseudorandom numbers.",
- "path": "@stdlib/random/streams/t",
- "group": "random"
- },
- {
- "command": "random-uniform",
- "description": "Uniformly distributed pseudorandom numbers.",
- "path": "@stdlib/random/streams/uniform",
- "group": "random"
- },
- {
- "command": "random-weibull",
- "description": "Weibull distributed pseudorandom numbers.",
- "path": "@stdlib/random/streams/weibull",
- "group": "random"
- },
- {
- "command": "open-url",
- "description": "Open a URL.",
- "path": "@stdlib/utils/open-url",
- "group": "utilities"
- },
- {
- "command": "padstr",
- "description": "Pad a string.",
- "path": "@stdlib/string/pad",
- "group": "utilities"
- },
- {
- "command": "parallel",
- "description": "Execute scripts in parallel.",
- "path": "@stdlib/utils/parallel",
- "group": "utilities"
- },
- {
- "command": "percent-encode",
- "description": "Percent-encode a UTF-16 encoded string.",
- "path": "@stdlib/string/percent-encode",
- "group": "utilities"
- },
- {
- "command": "platform",
- "description": "Platform.",
- "path": "@stdlib/os/platform",
- "group": "system"
- },
- {
- "command": "quarter-of-year",
- "description": "Calculate the quarter of a year.",
- "path": "@stdlib/time/quarter-of-year",
- "group": "time"
- },
- {
- "command": "read-dir",
- "description": "Read all files in a directory.",
- "path": "@stdlib/fs/read-dir",
- "group": "filesystem"
- },
- {
- "command": "read-file",
- "description": "Read a file.",
- "path": "@stdlib/fs/read-file",
- "group": "filesystem"
- },
- {
- "command": "read-file-list",
- "description": "Read a list of files.",
- "path": "@stdlib/fs/read-file-list",
- "group": "filesystem"
- },
- {
- "command": "realmax",
- "description": "Maximum representable finite value.",
- "path": "@stdlib/utils/real-max",
- "group": "utilities"
- },
- {
- "command": "realmin",
- "description": "Minimum representable finite value.",
- "path": "@stdlib/utils/real-min",
- "group": "utilities"
- },
- {
- "command": "remove-first",
- "description": "Remove the first character in a string.",
- "path": "@stdlib/string/remove-first",
- "group": "utilities"
- },
- {
- "command": "remove-last",
- "description": "Remove the last character in a string.",
- "path": "@stdlib/string/remove-last",
- "group": "utilities"
- },
- {
- "command": "remove-punctuation",
- "description": "Remove punctuation characters from a string.",
- "path": "@stdlib/string/remove-punctuation",
- "group": "utilities"
- },
- {
- "command": "remove-utf8-bom",
- "description": "Remove a UTF-8 byte order mark (BOM).",
- "path": "@stdlib/string/remove-first",
- "group": "utilities"
- },
- {
- "command": "remove-words",
- "description": "Remove a list of words from a string.",
- "path": "@stdlib/string/remove-words",
- "group": "utilities"
- },
- {
- "command": "rename",
- "description": "Rename a file.",
- "path": "@stdlib/fs/rename",
- "group": "filesystem"
- },
- {
- "command": "repstr",
- "description": "Repeat a string.",
- "path": "@stdlib/string/repeat",
- "group": "utilities"
- },
- {
- "command": "repl",
- "description": "Start a REPL.",
- "path": "@stdlib/repl",
- "group": "general"
- },
- {
- "command": "repl-presentation",
- "description": "Start a REPL presentation.",
- "path": "@stdlib/repl/presentation",
- "group": "general"
- },
- {
- "command": "replace",
- "description": "Replace search occurrences in a string.",
- "path": "@stdlib/string/replace",
- "group": "utilities"
- },
- {
- "command": "resolve-parent-path",
- "description": "Resolve a path by walking parent directories.",
- "path": "@stdlib/fs/resolve-parent-path",
- "group": "filesystem"
- },
- {
- "command": "reverse",
- "description": "Reverse a string.",
- "path": "@stdlib/string/reverse",
- "group": "utilities"
- },
- {
- "command": "rpad",
- "description": "Right pad a string.",
- "path": "@stdlib/string/right-pad",
- "group": "utilities"
- },
- {
- "command": "rtrim",
- "description": "Right trim a string.",
- "path": "@stdlib/string/right-trim",
- "group": "utilities"
- },
- {
- "command": "safeintmax",
- "description": "Maximum representable safe integer value.",
- "path": "@stdlib/utils/safe-int-max",
- "group": "utilities"
- },
- {
- "command": "safeintmin",
- "description": "Minimum representable safe integer value.",
- "path": "@stdlib/utils/safe-int-min",
- "group": "utilities"
- },
- {
- "command": "seconds-in-month",
- "description": "Calculate the number of seconds in a month.",
- "path": "@stdlib/time/seconds-in-month",
- "group": "time"
- },
- {
- "command": "seconds-in-year",
- "description": "Calculate the number of seconds in a year.",
- "path": "@stdlib/time/seconds-in-year",
- "group": "time"
- },
- {
- "command": "sizeof",
- "description": "Size (in bytes) of a numeric data type.",
- "path": "@stdlib/utils/size-of",
- "group": "utilities"
- },
- {
- "command": "sparkline",
- "description": "Plot a sparkline.",
- "path": "@stdlib/plot/sparklines/unicode",
- "group": "plot"
- },
- {
- "command": "startcase",
- "description": "Capitalize each word in a string.",
- "path": "@stdlib/string/startcase",
- "group": "utilities"
- },
- {
- "command": "starts-with",
- "description": "Test if a string starts with another string.",
- "path": "@stdlib/string/starts-with",
- "group": "utilities"
- },
- {
- "command": "temp-http-server",
- "description": "Create a temporary HTTP server.",
- "path": "@stdlib/net/disposable-http-server",
- "group": "utilities"
- },
- {
- "command": "timeit",
- "description": "Time a JavaScript snippet.",
- "path": "@stdlib/utils/timeit",
- "group": "benchmarking"
- },
- {
- "command": "tmpdir",
- "description": "Directory path for storing temporary files.",
- "path": "@stdlib/os/tmpdir",
- "group": "system"
- },
- {
- "command": "trim",
- "description": "Trim a string.",
- "path": "@stdlib/string/trim",
- "group": "utilities"
- },
- {
- "command": "typemax",
- "description": "Maximum value for a numeric data type.",
- "path": "@stdlib/utils/type-max",
- "group": "utilities"
- },
- {
- "command": "typemin",
- "description": "Minimum value for a numeric data type.",
- "path": "@stdlib/utils/type-min",
- "group": "utilities"
- },
- {
- "command": "umask",
- "description": "Process mask.",
- "path": "@stdlib/process/umask",
- "group": "system"
- },
- {
- "command": "uncapitalize",
- "description": "Uncapitalize a string.",
- "path": "@stdlib/string/uncapitalize",
- "group": "utilities"
- },
- {
- "command": "unlink",
- "description": "Remove a file.",
- "path": "@stdlib/fs/unlink",
- "group": "filesystem"
- },
- {
- "command": "uppercase",
- "description": "Uppercase a string.",
- "path": "@stdlib/string/uppercase",
- "group": "utilities"
- },
- {
- "command": "write-file",
- "description": "Write to file.",
- "path": "@stdlib/fs/write-file",
- "group": "filesystem"
- },
- {
- "command": "constant-stream",
- "description": "Stream a constant value.",
- "path": "@stdlib/streams/node/from-constant",
- "group": "utilities"
- },
- {
- "command": "empty-stream",
- "description": "Empty stream.",
- "path": "@stdlib/streams/node/empty",
- "group": "utilities"
- }
+ {
+ "command": "help [command]",
+ "description": "Print a help message.",
+ "path": "",
+ "group": "general"
+ },
+ {
+ "command": "arch",
+ "description": "Operating system CPU architecture.",
+ "path": "@stdlib/os/arch",
+ "group": "system"
+ },
+ {
+ "command": "bench",
+ "description": "Run JavaScript benchmark files.",
+ "path": "@stdlib/bench",
+ "group": "benchmarking"
+ },
+ {
+ "command": "bundle-pkg-list",
+ "description": "Bundle a list of stdlib packages.",
+ "path": "@stdlib/_tools/bundle/pkg-list",
+ "group": "tools"
+ },
+ {
+ "command": "capitalize",
+ "description": "Capitalize the first character in a string.",
+ "path": "@stdlib/string/capitalize",
+ "group": "utilities"
+ },
+ {
+ "command": "configdir",
+ "description": "Configuration directory path.",
+ "path": "@stdlib/os/configdir",
+ "group": "system"
+ },
+ {
+ "command": "convert-path",
+ "description": "Convert between Windows and POSIX paths.",
+ "path": "@stdlib/utils/convert-path",
+ "group": "utilities"
+ },
+ {
+ "command": "cwd",
+ "description": "Current working directory.",
+ "path": "@stdlib/process/cwd",
+ "group": "system"
+ },
+ {
+ "command": "datasets",
+ "description": "Retrieve a dataset.",
+ "path": "@stdlib/datasets",
+ "group": "general"
+ },
+ {
+ "command": "day-of-quarter",
+ "description": "Calculate day of quarter.",
+ "path": "@stdlib/time/day-of-quarter",
+ "group": "time"
+ },
+ {
+ "command": "day-of-year",
+ "description": "Calculate day of year.",
+ "path": "@stdlib/time/day-of-year",
+ "group": "time"
+ },
+ {
+ "command": "days-in-month",
+ "description": "Calculate the number of days in a month.",
+ "path": "@stdlib/time/days-in-month",
+ "group": "time"
+ },
+ {
+ "command": "days-in-year",
+ "description": "Calculate the number of days in a year.",
+ "path": "@stdlib/time/days-in-year",
+ "group": "time"
+ },
+ {
+ "command": "ends-with",
+ "description": "Test if a string ends with another string.",
+ "path": "@stdlib/string/ends-with",
+ "group": "utilities"
+ },
+ {
+ "command": "exists",
+ "description": "Test if a file exists.",
+ "path": "@stdlib/fs/exists",
+ "group": "filesystem"
+ },
+ {
+ "command": "from-code-point",
+ "description": "Create a string from code points.",
+ "path": "@stdlib/string/from-code-point",
+ "group": "utilities"
+ },
+ {
+ "command": "has-arraybuffer-support",
+ "description": "Detect ArrayBuffer support.",
+ "path": "@stdlib/assert/has-arraybuffer-support",
+ "group": "assert"
+ },
+ {
+ "command": "has-async-await-support",
+ "description": "Detect async/await support.",
+ "path": "@stdlib/assert/has-async-await-support",
+ "group": "assert"
+ },
+ {
+ "command": "has-async-iterator-symbol-support",
+ "description": "Detect Symbol.asyncIterator support.",
+ "path": "@stdlib/assert/has-async-iterator-symbol-support",
+ "group": "assert"
+ },
+ {
+ "command": "has-class-support",
+ "description": "Detect ES6 class support.",
+ "path": "@stdlib/assert/has-class-support",
+ "group": "assert"
+ },
+ {
+ "command": "has-float32array-support",
+ "description": "Detect Float32Array support.",
+ "path": "@stdlib/assert/has-float32array-support",
+ "group": "assert"
+ },
+ {
+ "command": "has-float64array-support",
+ "description": "Detect Float64Array support.",
+ "path": "@stdlib/assert/has-float64array-support",
+ "group": "assert"
+ },
+ {
+ "command": "has-function-name-support",
+ "description": "Detect function name support.",
+ "path": "@stdlib/assert/has-function-name-support",
+ "group": "assert"
+ },
+ {
+ "command": "has-generator-support",
+ "description": "Detect generator support.",
+ "path": "@stdlib/assert/has-generator-support",
+ "group": "assert"
+ },
+ {
+ "command": "has-int16array-support",
+ "description": "Detect Int16Array support.",
+ "path": "@stdlib/assert/has-int16array-support",
+ "group": "assert"
+ },
+ {
+ "command": "has-int32array-support",
+ "description": "Detect Int32Array support.",
+ "path": "@stdlib/assert/has-int32array-support",
+ "group": "assert"
+ },
+ {
+ "command": "has-int8array-support",
+ "description": "Detect Int8Array support.",
+ "path": "@stdlib/assert/has-int8array-support",
+ "group": "assert"
+ },
+ {
+ "command": "has-iterator-symbol-support",
+ "description": "Detect Symbol.iterator support.",
+ "path": "@stdlib/assert/has-iterator-symbol-support",
+ "group": "assert"
+ },
+ {
+ "command": "has-map-support",
+ "description": "Detect Map support.",
+ "path": "@stdlib/assert/has-map-support",
+ "group": "assert"
+ },
+ {
+ "command": "has-node-buffer-support",
+ "description": "Detect Node buffer support.",
+ "path": "@stdlib/assert/has-node-buffer-support",
+ "group": "assert"
+ },
+ {
+ "command": "has-proxy-support",
+ "description": "Detect Proxy support.",
+ "path": "@stdlib/assert/has-proxy-support",
+ "group": "assert"
+ },
+ {
+ "command": "has-set-support",
+ "description": "Detect Set support.",
+ "path": "@stdlib/assert/has-set-support",
+ "group": "assert"
+ },
+ {
+ "command": "has-sharedarraybuffer-support",
+ "description": "Detect SharedArrayBuffer support.",
+ "path": "@stdlib/assert/has-sharedarraybuffer-support",
+ "group": "assert"
+ },
+ {
+ "command": "has-symbol-support",
+ "description": "Detect Symbol support.",
+ "path": "@stdlib/assert/has-symbol-support",
+ "group": "assert"
+ },
+ {
+ "command": "has-tostringtag-support",
+ "description": "Detect Symbol.toStringTag support.",
+ "path": "@stdlib/assert/has-tostringtag-support",
+ "group": "assert"
+ },
+ {
+ "command": "has-uint16array-support",
+ "description": "Detect Uit16Array support.",
+ "path": "@stdlib/assert/has-uint16array-support",
+ "group": "assert"
+ },
+ {
+ "command": "has-uint32array-support",
+ "description": "Detect Uit32Array support.",
+ "path": "@stdlib/assert/has-uint32array-support",
+ "group": "assert"
+ },
+ {
+ "command": "has-uint8array-support",
+ "description": "Detect Uit8Array support.",
+ "path": "@stdlib/assert/has-uint8array-support",
+ "group": "assert"
+ },
+ {
+ "command": "has-uint8clampedarray-support",
+ "description": "Detect Uit8ClampedArray support.",
+ "path": "@stdlib/assert/has-uint8clampedarray-support",
+ "group": "assert"
+ },
+ {
+ "command": "has-wasm-support",
+ "description": "Detect WebAssembly support.",
+ "path": "@stdlib/assert/has-wasm-support",
+ "group": "assert"
+ },
+ {
+ "command": "has-weakmap-support",
+ "description": "Detect WeakMap support.",
+ "path": "@stdlib/assert/has-weakmap-support",
+ "group": "assert"
+ },
+ {
+ "command": "has-weakset-support",
+ "description": "Detect WeakSet support.",
+ "path": "@stdlib/assert/has-weakset-support",
+ "group": "assert"
+ },
+ {
+ "command": "homedir",
+ "description": "Home directory path.",
+ "path": "@stdlib/os/homedir",
+ "group": "system"
+ },
+ {
+ "command": "hours-in-month",
+ "description": "Calculate the number of hours in a month.",
+ "path": "@stdlib/time/hours-in-month",
+ "group": "time"
+ },
+ {
+ "command": "hours-in-year",
+ "description": "Calculate the number of hours in a year.",
+ "path": "@stdlib/time/hours-in-year",
+ "group": "time"
+ },
+ {
+ "command": "iso-weeks-in-year",
+ "description": "Calculate the number of ISO weeks in a year.",
+ "path": "@stdlib/time/iso-weeks-in-year",
+ "group": "time"
+ },
+ {
+ "command": "is-absolute-path",
+ "description": "Assert an absolute path.",
+ "path": "@stdlib/assert/is-absolute-path",
+ "group": "assert"
+ },
+ {
+ "command": "is-alphagram",
+ "description": "Assert if a value is an alphagram.",
+ "path": "@stdlib/assert/is-alphagram",
+ "group": "assert"
+ },
+ {
+ "command": "is-alphanumeric",
+ "description": "Assert if a value is alphanumeric.",
+ "path": "@stdlib/assert/is-alphanumeric",
+ "group": "assert"
+ },
+ {
+ "command": "is-anagram",
+ "description": "Assert if a value is an anagram.",
+ "path": "@stdlib/assert/is-anagram",
+ "group": "assert"
+ },
+ {
+ "command": "is-ascii",
+ "description": "Assert if a value is ASCII.",
+ "path": "@stdlib/assert/is-ascii",
+ "group": "assert"
+ },
+ {
+ "command": "is-binary-string",
+ "description": "Assert if a value is a binary string.",
+ "path": "@stdlib/assert/is-binary-string",
+ "group": "assert"
+ },
+ {
+ "command": "is-capitalized",
+ "description": "Assert if a value is capitalized.",
+ "path": "@stdlib/assert/is-capitalized",
+ "group": "assert"
+ },
+ {
+ "command": "is-digit-string",
+ "description": "Assert if a value is a digit string.",
+ "path": "@stdlib/assert/is-digit-string",
+ "group": "assert"
+ },
+ {
+ "command": "is-email-address",
+ "description": "Assert if a value is an email address.",
+ "path": "@stdlib/assert/is-email-address",
+ "group": "assert"
+ },
+ {
+ "command": "is-hex-string",
+ "description": "Assert if a value is a hexadecimal string.",
+ "path": "@stdlib/assert/is-hex-string",
+ "group": "assert"
+ },
+ {
+ "command": "is-leap-year",
+ "description": "Assert if a leap year.",
+ "path": "@stdlib/assert/is-leap-year",
+ "group": "assert"
+ },
+ {
+ "command": "is-little-endian",
+ "description": "Assert if little endian.",
+ "path": "@stdlib/assert/is-little-endian",
+ "group": "assert"
+ },
+ {
+ "command": "is-lowercase",
+ "description": "Assert if a value is lowercase.",
+ "path": "@stdlib/assert/is-lowercase",
+ "group": "assert"
+ },
+ {
+ "command": "is-regexp-string",
+ "description": "Assert if a value is a regexp string.",
+ "path": "@stdlib/assert/is-regexp-string",
+ "group": "assert"
+ },
+ {
+ "command": "is-unc-path",
+ "description": "Assert a UNC path.",
+ "path": "@stdlib/assert/is-unc-path",
+ "group": "assert"
+ },
+ {
+ "command": "is-uppercase",
+ "description": "Assert if a value is uppercase.",
+ "path": "@stdlib/assert/is-uppercase",
+ "group": "assert"
+ },
+ {
+ "command": "is-uri",
+ "description": "Assert if a value is a URI.",
+ "path": "@stdlib/assert/is-uri",
+ "group": "assert"
+ },
+ {
+ "command": "is-whitespace",
+ "description": "Assert if a value is only whitespace.",
+ "path": "@stdlib/assert/is-whitespace",
+ "group": "assert"
+ },
+ {
+ "command": "js-eval",
+ "description": "Evaluate a JavaScript string.",
+ "path": "@stdlib/utils/eval",
+ "group": "utilities"
+ },
+ {
+ "command": "library-manifest",
+ "description": "Load a manifest for compiling source files.",
+ "path": "@stdlib/utils/library-manifest",
+ "group": "meta"
+ },
+ {
+ "command": "lpad",
+ "description": "Left pad a string.",
+ "path": "@stdlib/string/left-pad",
+ "group": "utilities"
+ },
+ {
+ "command": "ltrim",
+ "description": "Left trim a string.",
+ "path": "@stdlib/string/left-trim",
+ "group": "utilities"
+ },
+ {
+ "command": "lowercase",
+ "description": "Lowercase a string.",
+ "path": "@stdlib/string/lowercase",
+ "group": "utilities"
+ },
+ {
+ "command": "ls",
+ "description": "List stdlib package names.",
+ "path": "@stdlib/_tools/pkgs/names",
+ "group": "meta"
+ },
+ {
+ "command": "ls-tree",
+ "description": "Show stdlib package tree.",
+ "path": "@stdlib/_tools/pkgs/tree",
+ "group": "meta"
+ },
+ {
+ "command": "minutes-in-month",
+ "description": "Calculate the number of minutes in a month.",
+ "path": "@stdlib/time/minutes-in-month",
+ "group": "time"
+ },
+ {
+ "command": "minutes-in-year",
+ "description": "Calculate the number of minutes in a year.",
+ "path": "@stdlib/time/minutes-in-year",
+ "group": "time"
+ },
+ {
+ "command": "node-version",
+ "description": "Node.js version.",
+ "path": "@stdlib/process/node-version",
+ "group": "meta"
+ },
+ {
+ "command": "now",
+ "description": "Number of seconds since the epoch.",
+ "path": "@stdlib/time/now",
+ "group": "time"
+ },
+ {
+ "command": "ns",
+ "description": "Print stdlib namespace.",
+ "path": "@stdlib/namespace",
+ "group": "meta"
+ },
+ {
+ "command": "num-cpus",
+ "description": "Number of CPUs.",
+ "path": "@stdlib/os/num-cpus",
+ "group": "system"
+ },
+ {
+ "command": "random-arcsine",
+ "description": "Arcsine distributed pseudorandom numbers.",
+ "path": "@stdlib/random/streams/arcsine",
+ "group": "random"
+ },
+ {
+ "command": "random-bernoulli",
+ "description": "Bernoulli distributed pseudorandom numbers.",
+ "path": "@stdlib/random/streams/bernoulli",
+ "group": "random"
+ },
+ {
+ "command": "random-beta",
+ "description": "Beta distributed pseudorandom numbers.",
+ "path": "@stdlib/random/streams/beta",
+ "group": "random"
+ },
+ {
+ "command": "random-betaprime",
+ "description": "Beta prime distributed pseudorandom numbers.",
+ "path": "@stdlib/random/streams/betaprime",
+ "group": "random"
+ },
+ {
+ "command": "random-box-muller",
+ "description": "Box-Muller pseudorandom numbers.",
+ "path": "@stdlib/random/streams/box-muller",
+ "group": "random"
+ },
+ {
+ "command": "random-cauchy",
+ "description": "Cauchy distributed pseudorandom numbers.",
+ "path": "@stdlib/random/streams/cauchy",
+ "group": "random"
+ },
+ {
+ "command": "random-chi",
+ "description": "Chi distributed pseudorandom numbers.",
+ "path": "@stdlib/random/streams/chi",
+ "group": "random"
+ },
+ {
+ "command": "random-chisquare",
+ "description": "Chi-square distributed pseudorandom numbers.",
+ "path": "@stdlib/random/streams/chisquare",
+ "group": "random"
+ },
+ {
+ "command": "random-cosine",
+ "description": "Raised cosine distributed pseudorandom numbers.",
+ "path": "@stdlib/random/streams/cosine",
+ "group": "random"
+ },
+ {
+ "command": "random-discrete-uniform",
+ "description": "Uniformly distributed pseudorandom integers.",
+ "path": "@stdlib/random/streams/discrete-uniform",
+ "group": "random"
+ },
+ {
+ "command": "random-erlang",
+ "description": "Erlang distributed pseudorandom numbers.",
+ "path": "@stdlib/random/streams/erlang",
+ "group": "random"
+ },
+ {
+ "command": "random-exponential",
+ "description": "Exponentially distributed pseudorandom numbers.",
+ "path": "@stdlib/random/streams/exponential",
+ "group": "random"
+ },
+ {
+ "command": "random-f",
+ "description": "F distributed pseudorandom numbers.",
+ "path": "@stdlib/random/streams/f",
+ "group": "random"
+ },
+ {
+ "command": "random-gamma",
+ "description": "Gamma distributed pseudorandom numbers.",
+ "path": "@stdlib/random/streams/gamma",
+ "group": "random"
+ },
+ {
+ "command": "random-geometric",
+ "description": "Geometric distributed pseudorandom numbers.",
+ "path": "@stdlib/random/streams/geometric",
+ "group": "random"
+ },
+ {
+ "command": "random-gumbel",
+ "description": "Gumbel distributed pseudorandom numbers.",
+ "path": "@stdlib/random/streams/gumbel",
+ "group": "random"
+ },
+ {
+ "command": "random-improved-ziggurat",
+ "description": "Improved Ziggurat pseudorandom numbers.",
+ "path": "@stdlib/random/streams/improved-ziggurat",
+ "group": "random"
+ },
+ {
+ "command": "random-invgamma",
+ "description": "Inverse gamma distributed pseudorandom numbers.",
+ "path": "@stdlib/random/streams/invgamma",
+ "group": "random"
+ },
+ {
+ "command": "random-kumaraswamy",
+ "description": "Kumaraswamy distributed pseudorandom numbers.",
+ "path": "@stdlib/random/streams/kumaraswamy",
+ "group": "random"
+ },
+ {
+ "command": "random-laplace",
+ "description": "Laplace distributed pseudorandom numbers.",
+ "path": "@stdlib/random/streams/laplace",
+ "group": "random"
+ },
+ {
+ "command": "random-levy",
+ "description": "Lévy distributed pseudorandom numbers.",
+ "path": "@stdlib/random/streams/levy",
+ "group": "random"
+ },
+ {
+ "command": "random-logistic",
+ "description": "Logistic distributed pseudorandom numbers.",
+ "path": "@stdlib/random/streams/logistic",
+ "group": "random"
+ },
+ {
+ "command": "random-lognormal",
+ "description": "Lognormal distributed pseudorandom numbers.",
+ "path": "@stdlib/random/streams/lognormal",
+ "group": "random"
+ },
+ {
+ "command": "random-minstd",
+ "description": "Park and Miller LCG pseudorandom numbers.",
+ "path": "@stdlib/random/streams/minstd",
+ "group": "random"
+ },
+ {
+ "command": "random-minstd-shuffle",
+ "description": "Shuffled LCG pseudorandom numbers.",
+ "path": "@stdlib/random/streams/minstd-shuffle",
+ "group": "random"
+ },
+ {
+ "command": "random-mt19937",
+ "description": "32-bit Mersenne Twister pseudorandom numbers.",
+ "path": "@stdlib/random/streams/mt19937",
+ "group": "random"
+ },
+ {
+ "command": "random-normal",
+ "description": "Normally distributed pseudorandom numbers.",
+ "path": "@stdlib/random/streams/normal",
+ "group": "random"
+ },
+ {
+ "command": "random-pareto-type1",
+ "description": "Pareto (type 1) distributed pseudorandom numbers.",
+ "path": "@stdlib/random/streams/pareto-type1",
+ "group": "random"
+ },
+ {
+ "command": "random-poisson",
+ "description": "Poisson distributed pseudorandom numbers.",
+ "path": "@stdlib/random/streams/poisson",
+ "group": "random"
+ },
+ {
+ "command": "random-randi",
+ "description": "Pseudorandom numbers having integer values.",
+ "path": "@stdlib/random/streams/randi",
+ "group": "random"
+ },
+ {
+ "command": "random-randn",
+ "description": "Normally distributed pseudorandom numbers.",
+ "path": "@stdlib/random/streams/randn",
+ "group": "random"
+ },
+ {
+ "command": "random-randu",
+ "description": "Pseudorandom numbers between 0 and 1.",
+ "path": "@stdlib/random/streams/randu",
+ "group": "random"
+ },
+ {
+ "command": "random-Rayleigh",
+ "description": "Rayleigh distributed pseudorandom numbers.",
+ "path": "@stdlib/random/streams/rayleigh",
+ "group": "random"
+ },
+ {
+ "command": "random-t",
+ "description": "Student's t distributed pseudorandom numbers.",
+ "path": "@stdlib/random/streams/t",
+ "group": "random"
+ },
+ {
+ "command": "random-uniform",
+ "description": "Uniformly distributed pseudorandom numbers.",
+ "path": "@stdlib/random/streams/uniform",
+ "group": "random"
+ },
+ {
+ "command": "random-weibull",
+ "description": "Weibull distributed pseudorandom numbers.",
+ "path": "@stdlib/random/streams/weibull",
+ "group": "random"
+ },
+ {
+ "command": "open-url",
+ "description": "Open a URL.",
+ "path": "@stdlib/utils/open-url",
+ "group": "utilities"
+ },
+ {
+ "command": "padstr",
+ "description": "Pad a string.",
+ "path": "@stdlib/string/pad",
+ "group": "utilities"
+ },
+ {
+ "command": "parallel",
+ "description": "Execute scripts in parallel.",
+ "path": "@stdlib/utils/parallel",
+ "group": "utilities"
+ },
+ {
+ "command": "percent-encode",
+ "description": "Percent-encode a UTF-16 encoded string.",
+ "path": "@stdlib/string/percent-encode",
+ "group": "utilities"
+ },
+ {
+ "command": "platform",
+ "description": "Platform.",
+ "path": "@stdlib/os/platform",
+ "group": "system"
+ },
+ {
+ "command": "quarter-of-year",
+ "description": "Calculate the quarter of a year.",
+ "path": "@stdlib/time/quarter-of-year",
+ "group": "time"
+ },
+ {
+ "command": "read-dir",
+ "description": "Read all files in a directory.",
+ "path": "@stdlib/fs/read-dir",
+ "group": "filesystem"
+ },
+ {
+ "command": "read-file",
+ "description": "Read a file.",
+ "path": "@stdlib/fs/read-file",
+ "group": "filesystem"
+ },
+ {
+ "command": "read-file-list",
+ "description": "Read a list of files.",
+ "path": "@stdlib/fs/read-file-list",
+ "group": "filesystem"
+ },
+ {
+ "command": "realmax",
+ "description": "Maximum representable finite value.",
+ "path": "@stdlib/utils/real-max",
+ "group": "utilities"
+ },
+ {
+ "command": "realmin",
+ "description": "Minimum representable finite value.",
+ "path": "@stdlib/utils/real-min",
+ "group": "utilities"
+ },
+ {
+ "command": "remove-first",
+ "description": "Remove the first character in a string.",
+ "path": "@stdlib/string/remove-first",
+ "group": "utilities"
+ },
+ {
+ "command": "remove-last",
+ "description": "Remove the last character in a string.",
+ "path": "@stdlib/string/remove-last",
+ "group": "utilities"
+ },
+ {
+ "command": "remove-punctuation",
+ "description": "Remove punctuation characters from a string.",
+ "path": "@stdlib/string/remove-punctuation",
+ "group": "utilities"
+ },
+ {
+ "command": "remove-utf8-bom",
+ "description": "Remove a UTF-8 byte order mark (BOM).",
+ "path": "@stdlib/string/remove-first",
+ "group": "utilities"
+ },
+ {
+ "command": "remove-words",
+ "description": "Remove a list of words from a string.",
+ "path": "@stdlib/string/remove-words",
+ "group": "utilities"
+ },
+ {
+ "command": "rename",
+ "description": "Rename a file.",
+ "path": "@stdlib/fs/rename",
+ "group": "filesystem"
+ },
+ {
+ "command": "repstr",
+ "description": "Repeat a string.",
+ "path": "@stdlib/string/repeat",
+ "group": "utilities"
+ },
+ {
+ "command": "repl",
+ "description": "Start a REPL.",
+ "path": "@stdlib/repl",
+ "group": "general"
+ },
+ {
+ "command": "repl-presentation",
+ "description": "Start a REPL presentation.",
+ "path": "@stdlib/repl/presentation",
+ "group": "general"
+ },
+ {
+ "command": "replace",
+ "description": "Replace search occurrences in a string.",
+ "path": "@stdlib/string/replace",
+ "group": "utilities"
+ },
+ {
+ "command": "resolve-parent-path",
+ "description": "Resolve a path by walking parent directories.",
+ "path": "@stdlib/fs/resolve-parent-path",
+ "group": "filesystem"
+ },
+ {
+ "command": "reverse",
+ "description": "Reverse a string.",
+ "path": "@stdlib/string/reverse",
+ "group": "utilities"
+ },
+ {
+ "command": "rpad",
+ "description": "Right pad a string.",
+ "path": "@stdlib/string/right-pad",
+ "group": "utilities"
+ },
+ {
+ "command": "rtrim",
+ "description": "Right trim a string.",
+ "path": "@stdlib/string/right-trim",
+ "group": "utilities"
+ },
+ {
+ "command": "safeintmax",
+ "description": "Maximum representable safe integer value.",
+ "path": "@stdlib/utils/safe-int-max",
+ "group": "utilities"
+ },
+ {
+ "command": "safeintmin",
+ "description": "Minimum representable safe integer value.",
+ "path": "@stdlib/utils/safe-int-min",
+ "group": "utilities"
+ },
+ {
+ "command": "seconds-in-month",
+ "description": "Calculate the number of seconds in a month.",
+ "path": "@stdlib/time/seconds-in-month",
+ "group": "time"
+ },
+ {
+ "command": "seconds-in-year",
+ "description": "Calculate the number of seconds in a year.",
+ "path": "@stdlib/time/seconds-in-year",
+ "group": "time"
+ },
+ {
+ "command": "sizeof",
+ "description": "Size (in bytes) of a numeric data type.",
+ "path": "@stdlib/utils/size-of",
+ "group": "utilities"
+ },
+ {
+ "command": "sparkline",
+ "description": "Plot a sparkline.",
+ "path": "@stdlib/plot/sparklines/unicode",
+ "group": "plot"
+ },
+ {
+ "command": "startcase",
+ "description": "Capitalize each word in a string.",
+ "path": "@stdlib/string/startcase",
+ "group": "utilities"
+ },
+ {
+ "command": "starts-with",
+ "description": "Test if a string starts with another string.",
+ "path": "@stdlib/string/starts-with",
+ "group": "utilities"
+ },
+ {
+ "command": "temp-http-server",
+ "description": "Create a temporary HTTP server.",
+ "path": "@stdlib/net/disposable-http-server",
+ "group": "utilities"
+ },
+ {
+ "command": "timeit",
+ "description": "Time a JavaScript snippet.",
+ "path": "@stdlib/utils/timeit",
+ "group": "benchmarking"
+ },
+ {
+ "command": "tmpdir",
+ "description": "Directory path for storing temporary files.",
+ "path": "@stdlib/os/tmpdir",
+ "group": "system"
+ },
+ {
+ "command": "trim",
+ "description": "Trim a string.",
+ "path": "@stdlib/string/trim",
+ "group": "utilities"
+ },
+ {
+ "command": "typemax",
+ "description": "Maximum value for a numeric data type.",
+ "path": "@stdlib/utils/type-max",
+ "group": "utilities"
+ },
+ {
+ "command": "typemin",
+ "description": "Minimum value for a numeric data type.",
+ "path": "@stdlib/utils/type-min",
+ "group": "utilities"
+ },
+ {
+ "command": "umask",
+ "description": "Process mask.",
+ "path": "@stdlib/process/umask",
+ "group": "system"
+ },
+ {
+ "command": "uncapitalize",
+ "description": "Uncapitalize a string.",
+ "path": "@stdlib/string/uncapitalize",
+ "group": "utilities"
+ },
+ {
+ "command": "unlink",
+ "description": "Remove a file.",
+ "path": "@stdlib/fs/unlink",
+ "group": "filesystem"
+ },
+ {
+ "command": "uppercase",
+ "description": "Uppercase a string.",
+ "path": "@stdlib/string/uppercase",
+ "group": "utilities"
+ },
+ {
+ "command": "write-file",
+ "description": "Write to file.",
+ "path": "@stdlib/fs/write-file",
+ "group": "filesystem"
+ },
+ {
+ "command": "constant-stream",
+ "description": "Stream a constant value.",
+ "path": "@stdlib/streams/node/from-constant",
+ "group": "utilities"
+ },
+ {
+ "command": "empty-stream",
+ "description": "Empty stream.",
+ "path": "@stdlib/streams/node/empty",
+ "group": "utilities"
+ }
]
diff --git a/bin/cli_opts.json b/bin/cli_opts.json
index f245a17e6317..913c05e1d52d 100644
--- a/bin/cli_opts.json
+++ b/bin/cli_opts.json
@@ -1,14 +1,7 @@
{
- "boolean": [
- "help",
- "version"
- ],
+ "boolean": ["help", "version"],
"alias": {
- "help": [
- "h"
- ],
- "version": [
- "V"
- ]
+ "help": ["h"],
+ "version": ["V"]
}
}
diff --git a/deps/README.md b/deps/README.md
index 1e64d7accb60..25077f94440c 100644
--- a/deps/README.md
+++ b/deps/README.md
@@ -10,10 +10,10 @@ This directory is the target directory for installing vendor dependencies (i.e.,
The directory is structured as follows:
-- `deps/checksums`: vendor dependency checksums.
-- `deps/test`: vendor dependency installation tests.
-- `deps/tmp`: location for storing dependency downloads.
-- `deps/build`: location for stored dependency builds.
+- `deps/checksums`: vendor dependency checksums.
+- `deps/test`: vendor dependency installation tests.
+- `deps/tmp`: location for storing dependency downloads.
+- `deps/build`: location for stored dependency builds.
Neither the `tmp` nor `build` directory should be committed to the project repository.
diff --git a/docs/assets/sponsors/README.md b/docs/assets/sponsors/README.md
index 2d222f86e043..5f43fb0e9166 100644
--- a/docs/assets/sponsors/README.md
+++ b/docs/assets/sponsors/README.md
@@ -38,8 +38,8 @@ This directory contains assets for project sponsors.
## Notes
-- Image assets should be [PNG][png].
-- The image width is based on sponsor level.
+- Image assets should be [PNG][png].
+- The image width is based on sponsor level.
<!-- TODO: include dimensions for each level -->
diff --git a/docs/assets/talks/README.md b/docs/assets/talks/README.md
index 94320cef1ec7..1c7ddeceaf65 100644
--- a/docs/assets/talks/README.md
+++ b/docs/assets/talks/README.md
@@ -18,8 +18,8 @@ This directory contains assets for talks featuring the project.
## Notes
-- Image assets should be [PNG][png].
-- The recommended image width is `480px`.
+- Image assets should be [PNG][png].
+- The recommended image width is `480px`.
</section>
diff --git a/docs/assets/web/manifest.json b/docs/assets/web/manifest.json
index 21b4f6714f05..160d777246a7 100644
--- a/docs/assets/web/manifest.json
+++ b/docs/assets/web/manifest.json
@@ -1,20 +1,20 @@
{
- "name": "",
- "icons": [
- {
- "src": "/android-chrome-192x192.png",
- "sizes": "192x192",
- "type": "image/png"
- },
- {
- "src": "/android-chrome-512x512.png",
- "sizes": "512x512",
- "type": "image/png"
- }
- ],
- "theme_color": "#ffffff",
- "background_color": "#ffffff",
- "display": "standalone",
- "start_url": "",
- "prefer_related_applications": true
+ "name": "",
+ "icons": [
+ {
+ "src": "/android-chrome-192x192.png",
+ "sizes": "192x192",
+ "type": "image/png"
+ },
+ {
+ "src": "/android-chrome-512x512.png",
+ "sizes": "512x512",
+ "type": "image/png"
+ }
+ ],
+ "theme_color": "#ffffff",
+ "background_color": "#ffffff",
+ "display": "standalone",
+ "start_url": "",
+ "prefer_related_applications": true
}
diff --git a/docs/contributing/FAQ.md b/docs/contributing/FAQ.md
index 388137c0bac1..9ed46a15f2bd 100644
--- a/docs/contributing/FAQ.md
+++ b/docs/contributing/FAQ.md
@@ -22,22 +22,22 @@ limitations under the License.
> Frequently Asked Questions (FAQs) by First-Time Contributors to stdlib.
-- [Introduction](#intro)
-- [As a first-time contributor to stdlib, where should I start?](#first-time-contributor)
-- [How can I set up my development environment to contribute to stdlib?](#setup-dev-environment)
-- [How can I install cppcheck?](#install-cppcheck)
-- [I am seeing different return values in the JavaScript and C implementation for the same implementation.](#js-vs-c-return-values)
-- [What should I do if Markdown linting on my commits fails because my headings exceed the maximum permissible length?](#markdown-heading-length)
-- [I have opened a pull request, where can I seek feedback?](#pr-feedback)
-- [I need to generate fixtures for my tests. How can I do that, and what are the best references for inspiration?](#generate-fixtures)
-- [I am facing a `Shadowed declaration` linting error in my C files, how can I fix it?](#shadowed-declaration)
-- [I am facing a `Uninitialized variable` linting error in my C files, how can I fix it?](#uninitialized-variable)
-- [I have the required packages in the expected paths, but I am still encountering an error like this while compiling the native add-on.](#compilation-error)
-- [When should I use decimals in examples, benchmarks, and documentation, and when should I avoid them?](#decimal-usage)
-- [How should I name my pull request?](#pr-naming)
-- [How do I call the stdlib bot on my PR?](#stdlib-bot)
-- [Frequently used `make` commands](#freq-make-commands)
-- [Other Links](#other-links)
+- [Introduction](#intro)
+- [As a first-time contributor to stdlib, where should I start?](#first-time-contributor)
+- [How can I set up my development environment to contribute to stdlib?](#setup-dev-environment)
+- [How can I install cppcheck?](#install-cppcheck)
+- [I am seeing different return values in the JavaScript and C implementation for the same implementation.](#js-vs-c-return-values)
+- [What should I do if Markdown linting on my commits fails because my headings exceed the maximum permissible length?](#markdown-heading-length)
+- [I have opened a pull request, where can I seek feedback?](#pr-feedback)
+- [I need to generate fixtures for my tests. How can I do that, and what are the best references for inspiration?](#generate-fixtures)
+- [I am facing a `Shadowed declaration` linting error in my C files, how can I fix it?](#shadowed-declaration)
+- [I am facing a `Uninitialized variable` linting error in my C files, how can I fix it?](#uninitialized-variable)
+- [I have the required packages in the expected paths, but I am still encountering an error like this while compiling the native add-on.](#compilation-error)
+- [When should I use decimals in examples, benchmarks, and documentation, and when should I avoid them?](#decimal-usage)
+- [How should I name my pull request?](#pr-naming)
+- [How do I call the stdlib bot on my PR?](#stdlib-bot)
+- [Frequently used `make` commands](#freq-make-commands)
+- [Other Links](#other-links)
<!-- lint disable no-heading-punctuation -->
@@ -154,6 +154,7 @@ lib/node_modules/@stdlib/stats/base/dmeanvarpn/benchmark/c/benchmark.length.c:10
lib/node_modules/@stdlib/stats/base/dmeanvarpn/benchmark/c/benchmark.length.c:112:38: note: Uninitialized variable: x
stdlib_strided_dmeanvarpn( len, 1, x, 1, out, 1 );
```
+
You can suppress that warning by adding a `// cppcheck-suppress uninitvar` comment above the function. For example:
```c
@@ -171,56 +172,44 @@ In packages involving C implementations, you need a `manifest.json` file to info
```json
{
- // Other sections above....
-
- "confs": [
- {
- "task": "build",
- "src": [
- "./src/main.c"
- ],
- "include": [
- "./include"
- ],
- "libraries": [],
- "libpath": [],
- "dependencies": [
- "@stdlib/math/base/napi/unary",
- "@stdlib/math/base/assert/is-nanf",
- "@stdlib/constants/float32/pinf"
- ]
- },
- {
- "task": "benchmark",
- "src": [
- "./src/main.c"
- ],
- "include": [
- "./include"
- ],
- "libraries": [],
- "libpath": [],
- "dependencies": [
- "@stdlib/math/base/assert/is-nanf",
- "@stdlib/constants/float32/pinf"
- ]
- },
- {
- "task": "examples",
- "src": [
- "./src/main.c"
- ],
- "include": [
- "./include"
- ],
- "libraries": [],
- "libpath": [],
- "dependencies": [
- "@stdlib/math/base/assert/is-nanf",
- "@stdlib/constants/float32/pinf"
- ]
- }
- ]
+ // Other sections above....
+
+ "confs": [
+ {
+ "task": "build",
+ "src": ["./src/main.c"],
+ "include": ["./include"],
+ "libraries": [],
+ "libpath": [],
+ "dependencies": [
+ "@stdlib/math/base/napi/unary",
+ "@stdlib/math/base/assert/is-nanf",
+ "@stdlib/constants/float32/pinf"
+ ]
+ },
+ {
+ "task": "benchmark",
+ "src": ["./src/main.c"],
+ "include": ["./include"],
+ "libraries": [],
+ "libpath": [],
+ "dependencies": [
+ "@stdlib/math/base/assert/is-nanf",
+ "@stdlib/constants/float32/pinf"
+ ]
+ },
+ {
+ "task": "examples",
+ "src": ["./src/main.c"],
+ "include": ["./include"],
+ "libraries": [],
+ "libpath": [],
+ "dependencies": [
+ "@stdlib/math/base/assert/is-nanf",
+ "@stdlib/constants/float32/pinf"
+ ]
+ }
+ ]
}
```
@@ -239,13 +228,13 @@ double stdlib_strided_dnanvariancetk( const CBLAS_INT N, const double correction
When calling this function in JavaScript, we expect the following usage:
```javascript
-var dnanvariancetk = require( '@stdlib/stats/base/dnanvariancetk' );
-var Float64Array = require( '@stdlib/array/float64' );
+var dnanvariancetk = require("@stdlib/stats/base/dnanvariancetk");
+var Float64Array = require("@stdlib/array/float64");
-var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
+var x = new Float64Array([1.0, -2.0, NaN, 2.0]);
// Use decimals for floating-point values, not for integers.
-var v = dnanvariancetk( 4, 1.0, x, 1 );
+var v = dnanvariancetk(4, 1.0, x, 1);
```
Notice that we used `1.0` as the second argument because it is a double-precision floating-point number. However, we did not use a decimal point for the first and fourth arguments, as they represent integers.
@@ -296,11 +285,13 @@ $ make install-node-addons NODE_ADDONS_PATTERN="math/base/special/abs"
### 4. Generate Test Fixtures
- **Julia**
+
```bash
$ make test-fixtures-julia TESTS_FIXTURES_FILTER=".*/path/to/package/.*"
```
- **Python**
+
```bash
$ make test-fixtures-python TESTS_FIXTURES_FILTER=".*/path/to/package/.*"
```
@@ -339,51 +330,28 @@ For more `make` commands, refer to the [documentation][benchmark] on running ben
<section class="links">
[git]: http://git-scm.com/
-
[docker]: https://www.docker.com/
-
[vscode]: https://code.visualstudio.com/
-
[github-fork]: https://help.github.com/articles/fork-a-repo/
-
[development-guide]: https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md
-
[contributing-guide]: https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md
-
[good-first-issues]: https://github.com/stdlib-js/stdlib/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22Good%20First%20Issue%22
-
[manual-setup]: https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md#step-0-github
-
[devcontainer-setup]: https://github.com/stdlib-js/stdlib/blob/87cbd67623892f90ddeea94e1d4e01eeada417b5/docs/devcontainer_setup.md
-
[devcontainer-issue]: https://github.com/stdlib-js/stdlib/issues/4934
-
[install-link]: https://github.com/stdlib-js/stdlib/tree/develop/tools/make/lib/install#install
-
[ref-discussion]: https://github.com/stdlib-js/stdlib/pull/2298#discussion_r1624765205
-
[ref-comment]: https://github.com/stdlib-js/stdlib/blob/1f9cb760e3345cc7e08320a11f6a051873ef3586/lib/node_modules/%40stdlib/math/base/special/spence/test/test.native.js#L90
-
[python-fixtures]: https://github.com/stdlib-js/stdlib/blob/develop/lib/node_modules/%40stdlib/math/base/special/hyp2f1/test/fixtures/python/runner.py
-
[julia-fixtures]: https://github.com/stdlib-js/stdlib/blob/develop/lib/node_modules/%40stdlib/math/base/special/acosdf/test/fixtures/julia/runner.jl
-
[test-fixtures]: https://github.com/stdlib-js/stdlib/tree/develop/tools/make/lib/test-fixtures
-
[examples]: https://github.com/stdlib-js/stdlib/tree/develop/tools/make/lib/examples
-
[benchmark]: https://github.com/stdlib-js/stdlib/tree/develop/tools/make/lib/benchmark
-
[make]: https://www.gnu.org/software/make/
-
[node-gyp]: https://github.com/nodejs/node-gyp
-
[stdlib-gitter]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
-
[stdlib-office-hours]: https://github.com/stdlib-js/meetings/issues
-
[style-guide]: https://github.com/stdlib-js/stdlib/tree/develop/docs/style-guides
-
[make-commands]: https://github.com/stdlib-js/stdlib/tree/develop/tools/make/lib
</section>
diff --git a/docs/contributing/branching.md b/docs/contributing/branching.md
index e4a05fdf8e8b..42b39be4341e 100644
--- a/docs/contributing/branching.md
+++ b/docs/contributing/branching.md
@@ -26,11 +26,11 @@ This project follows the branching model articulated in ["A successful Git branc
## Master
-- The `master` branch is **protected**.
+- The `master` branch is **protected**.
-- The `master` branch should **only** include source code which is stable, tested, and peer reviewed. In short, the source code should **always** reflect a "production-ready" state.
+- The `master` branch should **only** include source code which is stable, tested, and peer reviewed. In short, the source code should **always** reflect a "production-ready" state.
-- Each commit on the `master` branch should have an associated tag.
+- Each commit on the `master` branch should have an associated tag.
<!-- run-disable -->
@@ -41,15 +41,15 @@ This project follows the branching model articulated in ["A successful Git branc
## Develop
-- The `develop` branch is **protected**.
-- The `develop` branch should **only** include code which is tested, peer reviewed, and passes continuous integration tests.
-- The source code should **always** reflect the latest development changes for the **next** release.
+- The `develop` branch is **protected**.
+- The `develop` branch should **only** include code which is tested, peer reviewed, and passes continuous integration tests.
+- The source code should **always** reflect the latest development changes for the **next** release.
## Features
-- A feature branch should use the naming convention: `feature/<name>`.
+- A feature branch should use the naming convention: `feature/<name>`.
-- A feature branch should branch from the `develop` branch.
+- A feature branch should branch from the `develop` branch.
<!-- run-disable -->
@@ -57,19 +57,19 @@ This project follows the branching model articulated in ["A successful Git branc
$ git checkout -b feature/<name> develop
```
-- Once a feature is complete, [squash][git-squash] commits into a single commit.
+- Once a feature is complete, [squash][git-squash] commits into a single commit.
-- In order to merge a feature branch into the `develop` branch, submit a pull request against the `develop` branch.
+- In order to merge a feature branch into the `develop` branch, submit a pull request against the `develop` branch.
-- Before merging a feature branch into the `develop` branch, the source code **must** be peer reviewed and pass continuous integration tests.
+- Before merging a feature branch into the `develop` branch, the source code **must** be peer reviewed and pass continuous integration tests.
## Releases
-- A release branch should use the naming convention: `release-<major>.<minor>.<patch>`.
+- A release branch should use the naming convention: `release-<major>.<minor>.<patch>`.
-- The release number should follow [semantic versioning][semver].
+- The release number should follow [semantic versioning][semver].
-- A release branch should branch from the `develop` branch.
+- A release branch should branch from the `develop` branch.
<!-- run-disable -->
@@ -77,19 +77,19 @@ This project follows the branching model articulated in ["A successful Git branc
$ git checkout -b release-2.0.0 develop
```
-- Active development should **not** occur on a release branch. A release branch is a preparation branch (vetting, testing, updating meta data, et cetera) before merging into the `master` branch.
+- Active development should **not** occur on a release branch. A release branch is a preparation branch (vetting, testing, updating meta data, et cetera) before merging into the `master` branch.
-- Once a release branch is complete, submit a pull request against the `master` branch.
+- Once a release branch is complete, submit a pull request against the `master` branch.
-- Before merging the release branch into the `master` branch, the changes **must** be peer reviewed and pass continuous integration tests.
+- Before merging the release branch into the `master` branch, the changes **must** be peer reviewed and pass continuous integration tests.
-- Once merged into `master`, submit a pull request against the `develop` branch to retain the changes made in the release branch.
+- Once merged into `master`, submit a pull request against the `develop` branch to retain the changes made in the release branch.
## Hotfixes
-- A hotfix branch should use the naming convention: `hotfix/<name>`.
+- A hotfix branch should use the naming convention: `hotfix/<name>`.
-- The purpose of a hotfix branch is to immediately patch a bug on the `master` branch. Accordingly, a hotfix branch should branch from the `master` branch.
+- The purpose of a hotfix branch is to immediately patch a bug on the `master` branch. Accordingly, a hotfix branch should branch from the `master` branch.
<!-- run-disable -->
@@ -97,24 +97,24 @@ This project follows the branching model articulated in ["A successful Git branc
$ git checkout -b hotfix/<name> master
```
-- The hotfix branch should increment the ["patch"][semver] version number.
+- The hotfix branch should increment the ["patch"][semver] version number.
-- Once a hotfix is complete, [squash][git-squash] commits into a single commit.
+- Once a hotfix is complete, [squash][git-squash] commits into a single commit.
-- Submit a pull request against the `master` branch.
+- Submit a pull request against the `master` branch.
-- Before merging a hotfix branch into the `master` branch, the changes **must** be peer reviewed and pass continuous integration tests.
+- Before merging a hotfix branch into the `master` branch, the changes **must** be peer reviewed and pass continuous integration tests.
-- Once merged into `master`, if a release branch currently exists, submit a pull request against the `release` branch. Otherwise, submit a pull request against the `develop` branch. By merging a hotfix into a release branch, the hotfix changes should be propagated to the `develop` branch upon merging the release branch into the `develop` branch.
+- Once merged into `master`, if a release branch currently exists, submit a pull request against the `release` branch. Otherwise, submit a pull request against the `develop` branch. By merging a hotfix into a release branch, the hotfix changes should be propagated to the `develop` branch upon merging the release branch into the `develop` branch.
-* * *
+---
## Pull Requests
-- All feature pull requests should be [rebased][git-rebase] against the latest `develop` branch.
-- All feature pull requests should be submitted against the `develop` branch.
+- All feature pull requests should be [rebased][git-rebase] against the latest `develop` branch.
+- All feature pull requests should be submitted against the `develop` branch.
-* * *
+---
## License
@@ -123,15 +123,10 @@ This document may be reused under a [Creative Commons Attribution-ShareAlike Lic
<section class="links">
[git]: https://git-scm.com/
-
[git-rebase]: https://git-scm.com/docs/git-rebase
-
[git-squash]: https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Squashing-Commits
-
[git-flow]: http://nvie.com/posts/a-successful-git-branching-model/
-
[semver]: http://semver.org/
-
[license]: https://creativecommons.org/licenses/by-sa/4.0/
</section>
diff --git a/docs/contributing/development.md b/docs/contributing/development.md
index 5a12af0c2c48..3c9e7d010479 100644
--- a/docs/contributing/development.md
+++ b/docs/contributing/development.md
@@ -34,54 +34,54 @@ So, without further ado, let's get you started!
Developing and running stdlib **requires** the following prerequisites:
-- [Git][git]: version control
+- [Git][git]: version control
-- [GNU make][make]: development utility and task runner
+- [GNU make][make]: development utility and task runner
-- [GNU bash][bash]: an sh-compatible shell
+- [GNU bash][bash]: an sh-compatible shell
-- [curl][curl], [wget][wget], or [fetch][fetch] (FreeBSD): utilities for downloading remote resources
+- [curl][curl], [wget][wget], or [fetch][fetch] (FreeBSD): utilities for downloading remote resources
-- [Node.js][node-js]: JavaScript runtime (version `>= 0.10`; although the latest stable version is **strongly** recommended)
+- [Node.js][node-js]: JavaScript runtime (version `>= 0.10`; although the latest stable version is **strongly** recommended)
-- [npm][npm]: package manager
+- [npm][npm]: package manager
- - version `> 2.7.0`
- - if Node `< 1.0.0`, version `> 2.7.0` and `< 4.0.0`
- - if Node `< 10.x.x`, version `> 2.7.0` and `< 6.0.0`
- - if Node `< 14.17.0`, version `> 2.7.0` and `< 9.0.0`
+ - version `> 2.7.0`
+ - if Node `< 1.0.0`, version `> 2.7.0` and `< 4.0.0`
+ - if Node `< 10.x.x`, version `> 2.7.0` and `< 6.0.0`
+ - if Node `< 14.17.0`, version `> 2.7.0` and `< 9.0.0`
While not required to run stdlib, the following dependencies **may** be required for testing, benchmarking, and general development:
-- [Julia][julia]: language for technical computing (version `>= 1.0`)
-- [R][r]: language for statistical computing (version `>= 3.4.0`)
-- [Python][python]: general purpose language (version `>=2.7.x`)
-- [pip][pip]: Python package manager (version `>= 9.0.0`; **required** for automatically installing Python packages, such as lint tools)
-- [gcc & g++][gcc] or [Clang][clang]: C/C++ compilation and linking (g++ version `>= 4.8`; clang version `>= 3.5`, Xcode version `>=8.3.1` on OS X)
-- [gfortran][gfortran]: Fortran compilation and linking (version `>= 4.8`)
-- [CMake][cmake]: cross-platform build environment (version `>= 3.4.3`)
-- [pandoc][pandoc]: universal document converter (version `>= 1.18`)
-- [Homebrew][homebrew]: macOS package manager (only **required** on OS X in order to install [shellcheck][shellcheck])
+- [Julia][julia]: language for technical computing (version `>= 1.0`)
+- [R][r]: language for statistical computing (version `>= 3.4.0`)
+- [Python][python]: general purpose language (version `>=2.7.x`)
+- [pip][pip]: Python package manager (version `>= 9.0.0`; **required** for automatically installing Python packages, such as lint tools)
+- [gcc & g++][gcc] or [Clang][clang]: C/C++ compilation and linking (g++ version `>= 4.8`; clang version `>= 3.5`, Xcode version `>=8.3.1` on OS X)
+- [gfortran][gfortran]: Fortran compilation and linking (version `>= 4.8`)
+- [CMake][cmake]: cross-platform build environment (version `>= 3.4.3`)
+- [pandoc][pandoc]: universal document converter (version `>= 1.18`)
+- [Homebrew][homebrew]: macOS package manager (only **required** on OS X in order to install [shellcheck][shellcheck])
Assuming the requisite language is present on the host machine, the following language libraries can be automatically downloaded and installed using `make` (see [installation](#installation)):
-- [NumPy][numpy]: general purpose array-processing library for Python
-- [SciPy][scipy]: Python library containing numerical routines
-- [Pylint][pylint]: Python source code analyzer
-- [pycodestyle][pycodestyle]: Python style guide checker against PEP 8
-- [pydocstyle][pydocstyle]: Python docstring checker against PEP 257
-- [lintr][lintr]: static code analysis for R
-- [shellcheck][shellcheck]: static code analysis for shell scripts
-- [cppcheck][cppcheck]: C/C++ static code analysis
+- [NumPy][numpy]: general purpose array-processing library for Python
+- [SciPy][scipy]: Python library containing numerical routines
+- [Pylint][pylint]: Python source code analyzer
+- [pycodestyle][pycodestyle]: Python style guide checker against PEP 8
+- [pydocstyle][pydocstyle]: Python docstring checker against PEP 257
+- [lintr][lintr]: static code analysis for R
+- [shellcheck][shellcheck]: static code analysis for shell scripts
+- [cppcheck][cppcheck]: C/C++ static code analysis
The following external libraries can be automatically downloaded and compiled from source using `make` (see [installation](#installation)):
-- [Boost][boost]: portable C++ libraries
-- [Cephes][cephes]: C/C++ special functions math library
-- [OpenBLAS][openblas]: optimized BLAS library
-- [Electron][electron]: framework for cross-platform desktop applications
-- [Emscripten][emscripten]: LLVM to JavaScript compiler
-- [WebAssembly Binary Toolkit][wabt]: suite of tools for WebAssembly
+- [Boost][boost]: portable C++ libraries
+- [Cephes][cephes]: C/C++ special functions math library
+- [OpenBLAS][openblas]: optimized BLAS library
+- [Electron][electron]: framework for cross-platform desktop applications
+- [Emscripten][emscripten]: LLVM to JavaScript compiler
+- [WebAssembly Binary Toolkit][wabt]: suite of tools for WebAssembly
## Download
@@ -220,7 +220,7 @@ workshops workshops
## Troubleshooting
-- Occasionally, new versions of external dependencies may cause conflicts with existing builds. Most of the time, running
+- Occasionally, new versions of external dependencies may cause conflicts with existing builds. Most of the time, running
<!-- run-disable -->
@@ -231,7 +231,7 @@ workshops workshops
will be enough to resolve these conflicts. Otherwise, remove the [Git][git] repository, clone, and reinstall.
-- Some terminal prompts display the current [Git][git] branch and its status. Displaying the status may add significant lag to your terminal. You may hide this information within the repository directory by updating the repository's [Git][git] configuration. For example, if using [GNU bash][bash],
+- Some terminal prompts display the current [Git][git] branch and its status. Displaying the status may add significant lag to your terminal. You may hide this information within the repository directory by updating the repository's [Git][git] configuration. For example, if using [GNU bash][bash],
<!-- run-disable -->
@@ -247,7 +247,7 @@ workshops workshops
$ git config --add oh-my-zsh.hide-dirty 1
```
-- Some shells (e.g., [Zsh][zsh]) may require quotes around environment variables to prevent the shell from expanding paths. If this is the case, wrap paths, or values which may be interpreted as paths, in quotes. For example, replace
+- Some shells (e.g., [Zsh][zsh]) may require quotes around environment variables to prevent the shell from expanding paths. If this is the case, wrap paths, or values which may be interpreted as paths, in quotes. For example, replace
<!-- run-disable -->
@@ -265,7 +265,7 @@ workshops workshops
## Editors
-- This repository uses [EditorConfig][editorconfig] to maintain consistent coding styles between different editors and IDEs, including [browsers][editorconfig-chrome]. You should be sure to download and setup [EditorConfig][editorconfig] to ensure that files are automatically configured to use expected indentation and line endings.
+- This repository uses [EditorConfig][editorconfig] to maintain consistent coding styles between different editors and IDEs, including [browsers][editorconfig-chrome]. You should be sure to download and setup [EditorConfig][editorconfig] to ensure that files are automatically configured to use expected indentation and line endings.
## Testing
@@ -337,85 +337,45 @@ For contribution guidelines, see the [contributing guide][stdlib-contributing].
<section class="links">
[stdlib-contributing]: https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md
-
[github-fork]: https://help.github.com/articles/fork-a-repo/
-
[github-fork-sync]: https://help.github.com/articles/syncing-a-fork/
-
[github-remote]: https://help.github.com/articles/configuring-a-remote-for-a-fork/
-
[git-clone-depth]: https://git-scm.com/docs/git-clone#git-clone---depthltdepthgt
-
[git-remotes]: https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes
-
[git]: http://git-scm.com/
-
[make]: https://www.gnu.org/software/make/
-
[bash]: https://www.gnu.org/software/bash/
-
[zsh]: https://en.wikipedia.org/wiki/Z_shell
-
[curl]: https://curl.se/
-
[wget]: https://www.gnu.org/software/wget/
-
[fetch]: https://www.freebsd.org/cgi/man.cgi?fetch%281%29
-
[node-js]: https://nodejs.org/en/
-
[npm]: https://www.npmjs.com/
-
[julia]: https://julialang.org/
-
[r]: https://www.r-project.org/
-
[python]: https://www.python.org/
-
[pip]: https://github.com/pypa/pip
-
[scipy]: https://www.scipy.org/index.html
-
[numpy]: https://numpy.org/
-
[pylint]: https://github.com/PyCQA/pylint
-
[pycodestyle]: https://github.com/PyCQA/pycodestyle
-
[pydocstyle]: https://github.com/PyCQA/pydocstyle
-
[lintr]: https://github.com/jimhester/lintr
-
[shellcheck]: https://github.com/koalaman/shellcheck
-
[cppcheck]: http://cppcheck.sourceforge.net/
-
[gcc]: http://gcc.gnu.org/
-
[clang]: https://clang.llvm.org/
-
[gfortran]: https://gcc.gnu.org/fortran/
-
[cmake]: https://cmake.org/
-
[pandoc]: http://pandoc.org/
-
[homebrew]: https://brew.sh/
-
[boost]: http://www.boost.org/
-
[cephes]: http://www.moshier.net/#Cephes
-
[openblas]: https://github.com/xianyi/OpenBLAS
-
[electron]: https://www.electronjs.org/
-
[emscripten]: http://kripken.github.io/emscripten-site/index.html
-
[wabt]: https://github.com/WebAssembly/wabt
-
[editorconfig]: http://editorconfig.org/
-
[editorconfig-chrome]: https://chrome.google.com/webstore/detail/github-editorconfig/bppnolhdpdfmmpeefopdbpmabdpoefjh?hl=en-US
</section>
diff --git a/docs/contributing/doctest.md b/docs/contributing/doctest.md
index 2d9f79ff5265..8b9e2dbcdddb 100644
--- a/docs/contributing/doctest.md
+++ b/docs/contributing/doctest.md
@@ -24,9 +24,9 @@ limitations under the License.
Documentation tests (**doctests**) are comment annotations which indicate expected behavior. In the spirit of "literate testing" or "executable documentation", doctests serve three primary purposes:
-- to allow readers to gain an intuition as to return value types, ranges, and behavior.
-- to facilitate (in-line) unit testing, thus guarding against regressions.
-- to ensure documentation remains current, documenting behavior as it is, not as it was.
+- to allow readers to gain an intuition as to return value types, ranges, and behavior.
+- to facilitate (in-line) unit testing, thus guarding against regressions.
+- to ensure documentation remains current, documenting behavior as it is, not as it was.
In contrast to unit tests which can become complex and involved, doctests are meant to be small (preferably fitting on a single line) and equivalent to a single assertion. For example,
@@ -52,23 +52,23 @@ A doctest annotation is a syntactically valid language comment consisting of a *
Doctest annotations begin with one of three keyword markers (with limited exceptions documented below):
-- `returns`: indicates that a preceding expression should **return** a value.
-- `=>`: indicates that a preceding expression should **print** a value (e.g., via `console.log`) or, alternately, when preceded by a variable name, indicates a **mutated** value.
-- `throws`: indicates that a preceding expression should **throw** an error.
+- `returns`: indicates that a preceding expression should **return** a value.
+- `=>`: indicates that a preceding expression should **print** a value (e.g., via `console.log`) or, alternately, when preceded by a variable name, indicates a **mutated** value.
+- `throws`: indicates that a preceding expression should **throw** an error.
For example,
<!-- eslint-disable no-useless-concat, stdlib/doctest-marker, no-unused-expressions -->
```javascript
-('Hello ' + 'world');
+"Hello " + "world";
// returns 'Hello world'
```
contains a JavaScript doctest annotation for the expression `('Hello ' + 'world')` and indicates that the expression should "return" the value `'Hello world'`. Similarly,
```javascript
-console.log( 'Hello world' );
+console.log("Hello world");
// => 'Hello world'
```
@@ -78,7 +78,7 @@ annotates that the expression `console.log( 'Hello world' )` should "print" the
```javascript
function beep() {
- throw new TypeError( 'boop' );
+ throw new TypeError("boop");
}
beep();
@@ -116,16 +116,16 @@ where `returns [...]` indicates a more generic non-empty `array`, this is perhap
To indicate value mutation, the `=>` annotation marker is preceded by a value reference (variable name). For example,
```javascript
-function swap( arr, i, j ) {
- var tmp = arr[ i ];
- arr[ i ] = arr[ j ];
- arr[ j ] = tmp;
+function swap(arr, i, j) {
+ var tmp = arr[i];
+ arr[i] = arr[j];
+ arr[j] = tmp;
return true;
}
-var x = [ 1, 2 ];
+var x = [1, 2];
-swap( x, 0, 1 );
+swap(x, 0, 1);
// x => [ 2, 1 ]
```
@@ -138,7 +138,7 @@ The `e.g.,` and `{var} =>` prefixes can be used in combination. For example,
<!-- eslint-disable stdlib/doctest -->
```javascript
-foo( x );
+foo(x);
// e.g., x => [ 1, 3, 2 ]
```
@@ -158,8 +158,8 @@ var y = x;
asserts that `y` should equal the numeric value `3.141592653589793`.
```javascript
-var s1 = 'foo';
-var s2 = 'bar';
+var s1 = "foo";
+var s2 = "bar";
var s3 = s1 + s2;
// returns 'foobar'
@@ -170,7 +170,7 @@ asserts that `s3` should equal the string `'foobar'`. Similarly,
```javascript
var x = 3.141592653589793;
-console.log( x );
+console.log(x);
// => 3.141592653589793
```
@@ -181,22 +181,22 @@ asserts that the value `3.141592653589793` is printed to an output destination (
Often when generating numeric output, one wishes to display approximate values due to, e.g., floating-point rounding error. To indicate approximate equality, expected values are prefixed with `~`. For example,
```javascript
-function npi( i ) {
+function npi(i) {
return i * 3.141592653589793;
}
-var x = npi( 2 );
+var x = npi(2);
// returns ~6.28
```
indicates that `x` should **approximately equal** `6.28`. Similarly,
```javascript
-function npi( i ) {
+function npi(i) {
return i * 3.141592653589793;
}
-console.log( npi( 2 ) );
+console.log(npi(2));
// => ~6.28
```
@@ -259,7 +259,7 @@ indicates that `foo()` returns a JavaScript `object` containing a nested array w
```javascript
var o = foo();
-console.log( JSON.stringify( o ) );
+console.log(JSON.stringify(o));
// => '{ "a": [ ~1.1, ~2.2, ~3.3 ] }'
```
@@ -325,7 +325,7 @@ indicates that `foo()` returns a value which is an "instance of" `RegExp` (i.e.,
<!-- eslint-disable stdlib/doctest -->
```javascript
-var z = new Complex128( 1.0, -1.0 );
+var z = new Complex128(1.0, -1.0);
// returns <Complex128>
```
@@ -335,7 +335,7 @@ indicates that `z` should be an "instance of" `Complex128` (i.e., a custom class
```javascript
function foo() {
- throw new Error( 'beep' );
+ throw new Error("beep");
}
foo();
@@ -353,7 +353,7 @@ In _limited_ circumstances, deep equality can be combined with instance equality
<!-- eslint-disable stdlib/require-globals -->
```javascript
-var x = new Float64Array( [ 1.0, 2.0, 3.0 ] );
+var x = new Float64Array([1.0, 2.0, 3.0]);
// returns <Float64Array>[ 1.0, 2.0, 3.0 ]
```
@@ -396,7 +396,7 @@ Similarly, although expected to be a **rare** use case, conditional equality can
```javascript
var v = foo();
-console.log( v );
+console.log(v);
// => 'foo' || null
```
@@ -498,22 +498,22 @@ var arr = foo();
indicates that `foo()` returns a JavaScript `object` having the properties `a` and `b` and zero or more **additional** undefined/unspecified properties.
-* * *
+---
## Notes
-- Write doctests with care. Avoid the extravagant. Prefer simple test cases.
-- Avoid obscure test cases, as these typically make for bad documentation.
-- Doctests complement, but are **not** a substitute for, unit testing. While both doctests and unit tests aid in regression testing, one of the principle strengths of doctests is the ability to interleave (in a more natural manner) code and explanatory text. Doctests are **not** the place to exhaustively test, especially with little explanation, complex edge cases involving significant preceding code. As a general rule, use doctests to convey essential aspects as simply and concisely as possible in a literate manner. Use unit tests to thoroughly and exhaustively explore and probe API contracts and expected behavior.
-- Writing effective doctests is an _art_ in knowing when, how much, and (precisely) what you want to convey to the reader. The more you write and use doctests, the better your intuition will be in recognizing what is truly essential and how each essential aspect should be conveyed.
+- Write doctests with care. Avoid the extravagant. Prefer simple test cases.
+- Avoid obscure test cases, as these typically make for bad documentation.
+- Doctests complement, but are **not** a substitute for, unit testing. While both doctests and unit tests aid in regression testing, one of the principle strengths of doctests is the ability to interleave (in a more natural manner) code and explanatory text. Doctests are **not** the place to exhaustively test, especially with little explanation, complex edge cases involving significant preceding code. As a general rule, use doctests to convey essential aspects as simply and concisely as possible in a literate manner. Use unit tests to thoroughly and exhaustively explore and probe API contracts and expected behavior.
+- Writing effective doctests is an _art_ in knowing when, how much, and (precisely) what you want to convey to the reader. The more you write and use doctests, the better your intuition will be in recognizing what is truly essential and how each essential aspect should be conveyed.
-* * *
+---
## Command-line Interfaces
Doctest annotations can be extended to command-line interface (CLI) terminal output. Annotations, however, differ as follows:
-- Preceding terminal commands should include a command-line prompt. For example,
+- Preceding terminal commands should include a command-line prompt. For example,
<!-- run-disable -->
@@ -524,7 +524,7 @@ Doctest annotations can be extended to command-line interface (CLI) terminal out
where `$` is the command-line prompt. Including the command-line prompt allows for straightforward identification of commands and expected output.
-- Expected output does **not** need an annotation marker prefix. For example,
+- Expected output does **not** need an annotation marker prefix. For example,
<!-- run-disable -->
@@ -535,7 +535,7 @@ Doctest annotations can be extended to command-line interface (CLI) terminal out
does not require `returns` or `=>` to indicate the expected value `boop`. We simply **assume** that whatever is not preceded by a command-line prompt is an expected value.
-- Multiple successive wildcards can be used to indicate repeated output. For example,
+- Multiple successive wildcards can be used to indicate repeated output. For example,
<!-- run-disable -->
@@ -547,7 +547,7 @@ Doctest annotations can be extended to command-line interface (CLI) terminal out
indicates that the `foo` command prints two or more lines of undefined/unspecified output. This convention is particularly useful when indicating that a command will/may continually print (a potentially indefinite amount of) output until its process is stopped.
-- The only prefix which is supported is `e.g.,` in order to indicate exemplary/illustrative output.
+- The only prefix which is supported is `e.g.,` in order to indicate exemplary/illustrative output.
<!-- run-disable -->
@@ -556,9 +556,9 @@ Doctest annotations can be extended to command-line interface (CLI) terminal out
e.g., foobar
```
-- Command-line interfaces primarily communicate with one another using text (the universal interface), and, thus, expected output is **always** interpreted as text. Accordingly, language syntax distinguishing value types should be **omitted** (as used, e.g., in `returns` doctest annotations), and neither conditional nor type equality annotations should be supported.
+- Command-line interfaces primarily communicate with one another using text (the universal interface), and, thus, expected output is **always** interpreted as text. Accordingly, language syntax distinguishing value types should be **omitted** (as used, e.g., in `returns` doctest annotations), and neither conditional nor type equality annotations should be supported.
-* * *
+---
## stdlib
@@ -618,7 +618,7 @@ var mat = foo();
*/
```
-indicates that `foo()` returns a matrix having at least `2` rows and at least `2` columns and whose contents include the values `1.14`, `-3.14`, `0.00`, and `0.50`.
+indicates that `foo()` returns a matrix having at least `2` rows and at least `2` columns and whose contents include the values `1.14`, `-3.14`, `0.00`, and `0.50`.
Lastly, similar to other complex data structures, approximate values are demarcated with a tilde `~`. For example,
@@ -688,8 +688,8 @@ indicates that the command `foo` prints a JavaScript `number` value.
### Notes
-- For JavaScript doctests, printed output (via `console.log()`) **should be** valid JSON and/or a canonical serialized string representation. In general, valid JSON significantly simplifies the de-serialization and comparison of expected values. Because of this constraint, authors should think carefully about how and what is printed as expected output. For example, rather than print a large serialized JSON object, one might choose to print particular properties whose serialized expected values are more readily parsed and compiled.
-- The matrix and ndarray doctest annotations documented above apply **only** to `returns` doctest annotations and **not** to printed output. When printing matrices and ndarrays, either serialize as JSON or to a canonical string.
+- For JavaScript doctests, printed output (via `console.log()`) **should be** valid JSON and/or a canonical serialized string representation. In general, valid JSON significantly simplifies the de-serialization and comparison of expected values. Because of this constraint, authors should think carefully about how and what is printed as expected output. For example, rather than print a large serialized JSON object, one might choose to print particular properties whose serialized expected values are more readily parsed and compiled.
+- The matrix and ndarray doctest annotations documented above apply **only** to `returns` doctest annotations and **not** to printed output. When printing matrices and ndarrays, either serialize as JSON or to a canonical string.
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
diff --git a/docs/contributing/gfortran.md b/docs/contributing/gfortran.md
index 8265590c82ed..fa21e10d1f76 100644
--- a/docs/contributing/gfortran.md
+++ b/docs/contributing/gfortran.md
@@ -24,10 +24,10 @@ limitations under the License.
## Installation
-- Prebuilt binaries are available through the GNU Fortran [wiki][gfortran-wiki].
-- On MacOS, you may need to update Xcode.
+- Prebuilt binaries are available through the GNU Fortran [wiki][gfortran-wiki].
+- On MacOS, you may need to update Xcode.
-* * *
+---
## Commands
@@ -41,47 +41,47 @@ $ gfortran -std=f95 -ffree-form -O3 -Wall -Wextra -Wimplicit-interface -pedantic
The command options are as follows:
-- `-std`: specify the Fortran standard to which the program is expected to conform.
+- `-std`: specify the Fortran standard to which the program is expected to conform.
-- `-ffree-form`: indicate that the layout is free-form source code.
+- `-ffree-form`: indicate that the layout is free-form source code.
-- `-O3`: aggressive optimization. Note that this option increases compilation time and may lead to larger binaries.
+- `-O3`: aggressive optimization. Note that this option increases compilation time and may lead to larger binaries.
-- `-Wall`: enable commonly used warning options, including:
+- `-Wall`: enable commonly used warning options, including:
- - `-Waliasing`: warn if unnecessary aliasing of dummy arguments.
- - `-Wampersand`: warn about missing ampersand in continued character constants.
- - `-Wconversion`: warn about implicit conversions which are likely to change the value of the expression after conversion.
- - `-Wsurprising`: warn if source code contains "suspicious" code constructs.
- - `-Wc-binding-type`: warn if variable might not be C compatible.
- - `-Wintrinsics-std`: warn if a procedure named like an _intrinsic_ is not available in the standard to which the program is expected to conform.
- - `-Wtabs`: warn if source code contains a `\tab` character.
- - `-Wintrinsic-shadow`: warn if a user-defined procedure or module procedure has the same name as an _intrinsic_.
- - `-Wline-truncation`: warn if a source code line will be truncated.
- - `-Wtarget-lifetime`: warn if the pointer in a pointer assignment might have a longer lifetime than the its target.
- - `-Winteger-division`: warn if integer division of constants is truncated.
- - `-Wreal-q-constant`: warn if a real-literal-constant contains a `q` exponent-letter.
- - `-Wunused`: warn if source code contains unused dummy arguments.
- - `-Wundefined-do-loop`: warn if a `DO` loop with step equal to either `1` or `-1` underflows or overflows during induction variable iteration.
+ - `-Waliasing`: warn if unnecessary aliasing of dummy arguments.
+ - `-Wampersand`: warn about missing ampersand in continued character constants.
+ - `-Wconversion`: warn about implicit conversions which are likely to change the value of the expression after conversion.
+ - `-Wsurprising`: warn if source code contains "suspicious" code constructs.
+ - `-Wc-binding-type`: warn if variable might not be C compatible.
+ - `-Wintrinsics-std`: warn if a procedure named like an _intrinsic_ is not available in the standard to which the program is expected to conform.
+ - `-Wtabs`: warn if source code contains a `\tab` character.
+ - `-Wintrinsic-shadow`: warn if a user-defined procedure or module procedure has the same name as an _intrinsic_.
+ - `-Wline-truncation`: warn if a source code line will be truncated.
+ - `-Wtarget-lifetime`: warn if the pointer in a pointer assignment might have a longer lifetime than the its target.
+ - `-Winteger-division`: warn if integer division of constants is truncated.
+ - `-Wreal-q-constant`: warn if a real-literal-constant contains a `q` exponent-letter.
+ - `-Wunused`: warn if source code contains unused dummy arguments.
+ - `-Wundefined-do-loop`: warn if a `DO` loop with step equal to either `1` or `-1` underflows or overflows during induction variable iteration.
-- `-Wextra`: warn if source code contains problematic language features. Enables the following options:
+- `-Wextra`: warn if source code contains problematic language features. Enables the following options:
- - `-Wcompare-reals`: warn when comparing real or complex types for equality or inequality.
- - `-Wunused-parameter`: warn if source code contains unused `PARAMETER` values.
+ - `-Wcompare-reals`: warn when comparing real or complex types for equality or inequality.
+ - `-Wunused-parameter`: warn if source code contains unused `PARAMETER` values.
-- `-Wimplicit-interface`: warn if a procedure is called without an explicit interface.
+- `-Wimplicit-interface`: warn if a procedure is called without an explicit interface.
-- `-pedantic`: warn if source code contains Fortran 95 extensions and C-language constructs.
+- `-pedantic`: warn if source code contains Fortran 95 extensions and C-language constructs.
-- `-c`: compile but do not link. Output is an object file.
+- `-c`: compile but do not link. Output is an object file.
Other possible options include:
-- `-Wconversion-extra`: warn if source code contains implicit conversion between different types and kinds. Does not imply `-Wconversion`.
-- `-fexternal-blas`: generate calls to BLAS functions for some matrix operations, e.g., `MATMUL`, instead of using internal `gfortran` algorithms, if the size of the matrices involved is larger than a given limit (see `-fblas-matmul-limit`). This may be useful if an optimized BLAS library is available. The BLAS library must be specified at link time.
-- `-fno-underscoring`: do not transform names of entities specified in Fortran source files by appending underscores. Be careful when using this option, as user-defined names may conflict with a name in a system library.
-- `-fcheck=bounds`: enable generation of run-time checks for array subscripts and against the declared minimum and maximum values. Also, check array indices for assumed and deferred shape arrays against the actual allocated bounds and ensure that all string lengths are equal for character array constructors without an explicit typespec. Note that generated checks may have a performance cost.
-- `-o <file>`: save output to a `file`.
+- `-Wconversion-extra`: warn if source code contains implicit conversion between different types and kinds. Does not imply `-Wconversion`.
+- `-fexternal-blas`: generate calls to BLAS functions for some matrix operations, e.g., `MATMUL`, instead of using internal `gfortran` algorithms, if the size of the matrices involved is larger than a given limit (see `-fblas-matmul-limit`). This may be useful if an optimized BLAS library is available. The BLAS library must be specified at link time.
+- `-fno-underscoring`: do not transform names of entities specified in Fortran source files by appending underscores. Be careful when using this option, as user-defined names may conflict with a name in a system library.
+- `-fcheck=bounds`: enable generation of run-time checks for array subscripts and against the declared minimum and maximum values. Also, check array indices for assumed and deferred shape arrays against the actual allocated bounds and ensure that all string lengths are equal for character array constructors without an explicit typespec. Note that generated checks may have a performance cost.
+- `-o <file>`: save output to a `file`.
### Syntax Errors
@@ -91,7 +91,7 @@ To check for syntax errors without compiling, provide a `-fsyntax-only` option.
$ gfortran [options] -fsyntax-only <file>
```
-* * *
+---
## Examples
@@ -248,27 +248,22 @@ To run the executable,
$ ./main
```
-* * *
+---
## Resources
-- [Fortran 90 Subprograms][fortran-90-subprograms]
-- [Summary of Fortran][summary-of-fortran]
-- [C with Fortran][c-with-fortran]
-- [Intel: Calling BLAS Functions that Return the Complex Values in C/C++ Code][intel-mkl]
+- [Fortran 90 Subprograms][fortran-90-subprograms]
+- [Summary of Fortran][summary-of-fortran]
+- [C with Fortran][c-with-fortran]
+- [Intel: Calling BLAS Functions that Return the Complex Values in C/C++ Code][intel-mkl]
<!-- <definitions> -->
[gfortran]: https://gcc.gnu.org/fortran/
-
[gfortran-wiki]: https://gcc.gnu.org/wiki/GFortranBinaries
-
[fortran-90-subprograms]: http://www.cs.mtu.edu/~shene/COURSES/cs201/NOTES/F90-Subprograms.pdf
-
[summary-of-fortran]: https://www.math.utah.edu/~beebe/software/fortran-documentation/ftnsum.pdf
-
[c-with-fortran]: https://www.math.utah.edu/software/c-with-fortran.html
-
[intel-mkl]: https://www.intel.com/content/www/us/en/docs/onemkl/developer-guide-windows/2023-1/call-blas-funcs-return-complex-values-in-c-code.html
<!-- </definitions> -->
diff --git a/docs/contributing/javascript_quirks.md b/docs/contributing/javascript_quirks.md
index ac34a00cb989..75837b440251 100644
--- a/docs/contributing/javascript_quirks.md
+++ b/docs/contributing/javascript_quirks.md
@@ -29,10 +29,10 @@ limitations under the License.
<!-- eslint-disable stdlib/no-builtin-math -->
```javascript
- var x = Math.round( 1.5 );
+ var x = Math.round(1.5);
// returns 2.0
- x = Math.round( -1.5 );
+ x = Math.round(-1.5);
// returns -1.0
```
@@ -43,7 +43,6 @@ limitations under the License.
<section class="links">
[ecma-262-math-round]: http://www.ecma-international.org/ecma-262/6.0/#sec-math.round
-
[java-math-round]: https://docs.oracle.com/javase/7/docs/api/java/lang/Math.html#round%28double%29
</section>
diff --git a/docs/contributing/moving_packages.md b/docs/contributing/moving_packages.md
index c449cf433900..164375526c65 100644
--- a/docs/contributing/moving_packages.md
+++ b/docs/contributing/moving_packages.md
@@ -64,12 +64,12 @@ cp -R lib/node_modules/@stdlib/stats/base/dmax lib/node_modules/@stdlib/stats/st
Next, update the contents of the new package, which is likely to include the following:
-- The package name, as found in files, such as `package.json`, `lib/index.js`, `README.md`, and any other files which include the name of the original package.
+- The package name, as found in files, such as `package.json`, `lib/index.js`, `README.md`, and any other files which include the name of the original package.
-- If a package contains `src` and `include` directories,
+- If a package contains `src` and `include` directories,
- - update the `include` directory tree according to the path of the new package (e.g., `include/stdlib/stats/base/dmax` would become `include/stdlib/stats/strided/dmax`).
- - update header guards within header files in the `include` directory (e.g., `STDLIB_STATS_BASE_DMAX` would become `STDLIB_STATS_STRIDED_DMAX`).
+ - update the `include` directory tree according to the path of the new package (e.g., `include/stdlib/stats/base/dmax` would become `include/stdlib/stats/strided/dmax`).
+ - update header guards within header files in the `include` directory (e.g., `STDLIB_STATS_BASE_DMAX` would become `STDLIB_STATS_STRIDED_DMAX`).
There may be other contents needing updating, so be sure to carefully inspect package contents.
@@ -271,27 +271,27 @@ Next, perform a global find-and-replace to migrate all `require` (and `import`)
For example, the following `require` statement
```javascript
-var dmax = require( 'stats/base/dmax' );
+var dmax = require("stats/base/dmax");
```
should become
```javascript
-var dmax = require( 'stats/strided/dmax' );
+var dmax = require("stats/strided/dmax");
```
A couple of very important notes to keep in mind when performing a global find-and-replace.
-- Be **very careful** to avoid erroneously updating the paths of packages whose names have a common prefix (e.g., `stats/base/dmaxabs`, `stats/base/dmaxsorted`, `stats/base/dmaxabssorted`). Those packages should **not** be inadvertently updated.
-- Additionally, ensure that, for packages having C implementations, if a package basename (e.g., `dmax`) has a hyphen, then downstream include paths also need to be updated. E.g., for package `stats/base/foo-bar` with include file `stats/base/foo_bar`, all downstream packages which include the previous header file need to be updated accordingly (e.g., `stats/strided/foo_bar`).
+- Be **very careful** to avoid erroneously updating the paths of packages whose names have a common prefix (e.g., `stats/base/dmaxabs`, `stats/base/dmaxsorted`, `stats/base/dmaxabssorted`). Those packages should **not** be inadvertently updated.
+- Additionally, ensure that, for packages having C implementations, if a package basename (e.g., `dmax`) has a hyphen, then downstream include paths also need to be updated. E.g., for package `stats/base/foo-bar` with include file `stats/base/foo_bar`, all downstream packages which include the previous header file need to be updated accordingly (e.g., `stats/strided/foo_bar`).
### 9. Avoid updating original package and error database
There are three packages where we do **not** want to update `require` paths.
-- **The original package.** The original package should remain working and keep its original paths.
-- **The global error database.** The global error database is an append-only log. We need to avoid invalidating any existing references.
-- **The REPL databases.** Given the high velocity of stdlib development, updating these databases will create merge conflicts, which do not need to be immediately resolved. We can avoid the hassle of needing to rectify these conflicts by deferring to stdlib's daily cron job which automatically maintains and updates these databases.
+- **The original package.** The original package should remain working and keep its original paths.
+- **The global error database.** The global error database is an append-only log. We need to avoid invalidating any existing references.
+- **The REPL databases.** Given the high velocity of stdlib development, updating these databases will create merge conflicts, which do not need to be immediately resolved. We can avoid the hassle of needing to rectify these conflicts by deferring to stdlib's daily cron job which automatically maintains and updates these databases.
To dismiss any changes made to the above, run the following command
@@ -333,14 +333,12 @@ Ref: https://github.com/stdlib-js/stdlib/issues/4797
At this point, now that all downstream packages use the new package, we should be able to remove the original package from the project.
-
```bash
rm -rf lib/node_modules/@stdlib/path/to/original/package
```
For example,
-
```bash
rm -rf lib/node_modules/@stdlib/stats/base/dmax
```
@@ -387,42 +385,42 @@ where `<branch_name>` is the name of the branch on which you've been working.
If you made these changes on a fork, you should open a pull request against the `develop` branch on the main project [repository][stdlib-github].
-* * *
+---
## Notes
-- A pull request should **only** migrate a single package. Please do **not** open pull request which attempts to migrate multiple packages at the same time.
-- Notice that every commit includes a `Ref:` link back to the RFC issue on the main project repository. This is useful for providing additional context regarding changes, especially those involving deprecations.
-- Provided you have properly setup your local repository (see the [contributing][stdlib-contributing] and [development][stdlib-development] guides), linting will be performed after every commit, and, prior to pushing changes to a remote repository, affected unit tests, examples, and benchmarks should automatically run. Depending on how widely used the original package was throughout stdlib, these quality control steps may take considerable time, and it is possible that unrelated lint errors may be flagged. If possible, address any failures, restage the changes, and attempt to commit or push again. Note that resolution of failures may require amending previous commits.
-- As mentioned above, be **very careful** when performing a global find-and-replace. It can be easy to mistakenly update non-applicable paths, thus breaking packages and all downstream dependents. You've been warned.
+- A pull request should **only** migrate a single package. Please do **not** open pull request which attempts to migrate multiple packages at the same time.
+- Notice that every commit includes a `Ref:` link back to the RFC issue on the main project repository. This is useful for providing additional context regarding changes, especially those involving deprecations.
+- Provided you have properly setup your local repository (see the [contributing][stdlib-contributing] and [development][stdlib-development] guides), linting will be performed after every commit, and, prior to pushing changes to a remote repository, affected unit tests, examples, and benchmarks should automatically run. Depending on how widely used the original package was throughout stdlib, these quality control steps may take considerable time, and it is possible that unrelated lint errors may be flagged. If possible, address any failures, restage the changes, and attempt to commit or push again. Note that resolution of failures may require amending previous commits.
+- As mentioned above, be **very careful** when performing a global find-and-replace. It can be easy to mistakenly update non-applicable paths, thus breaking packages and all downstream dependents. You've been warned.
-* * *
+---
## Checklist
The following is a checklist you can use when performing a package migration:
-- [ ] Established a clean repository and created a migration branch based on the latest changes on the upstream `develop`.
-- [ ] Copied the existing package to the desired location.
-- [ ] Updated require paths in the new package.
-- [ ] Updated include directories in the new package.
-- [ ] Updated header guards in the new package.
-- [ ] Compiled native code and ran unit tests for the new package.
-- [ ] Committed the new package to a migration branch, with a link to any relevant public GitHub issues.
-- [ ] Removed the export of the original package from its parent namespace (if applicable).
-- [ ] Committed the changes to the parent namespace (if applicable), with a link to any relevant public GitHub issues and with user migration instructions.
-- [ ] Updated `require` paths across the project to refer to the new package.
-- [ ] Discarded any path changes to the original package.
-- [ ] Discarded any path changes to the `@stdlib/error` namespace.
-- [ ] Discarded any path changes to `@stdlib/repl/**/data` database files.
-- [ ] Committed path updates, with a link to any relevant public GitHub issues.
-- [ ] Removed the original package.
-- [ ] Committed removal of the original package, with a link to any relevant public GitHub issues and with user migration instructions.
-- [ ] Resolved any encountered lint errors or test failures when committing and/or pushing changes.
-- [ ] Opened a pull request which performs one and only one package migration.
-- [ ] The pull request includes at most `4` commits.
-
-* * *
+- [ ] Established a clean repository and created a migration branch based on the latest changes on the upstream `develop`.
+- [ ] Copied the existing package to the desired location.
+- [ ] Updated require paths in the new package.
+- [ ] Updated include directories in the new package.
+- [ ] Updated header guards in the new package.
+- [ ] Compiled native code and ran unit tests for the new package.
+- [ ] Committed the new package to a migration branch, with a link to any relevant public GitHub issues.
+- [ ] Removed the export of the original package from its parent namespace (if applicable).
+- [ ] Committed the changes to the parent namespace (if applicable), with a link to any relevant public GitHub issues and with user migration instructions.
+- [ ] Updated `require` paths across the project to refer to the new package.
+- [ ] Discarded any path changes to the original package.
+- [ ] Discarded any path changes to the `@stdlib/error` namespace.
+- [ ] Discarded any path changes to `@stdlib/repl/**/data` database files.
+- [ ] Committed path updates, with a link to any relevant public GitHub issues.
+- [ ] Removed the original package.
+- [ ] Committed removal of the original package, with a link to any relevant public GitHub issues and with user migration instructions.
+- [ ] Resolved any encountered lint errors or test failures when committing and/or pushing changes.
+- [ ] Opened a pull request which performs one and only one package migration.
+- [ ] The pull request includes at most `4` commits.
+
+---
## Reviewers
@@ -436,10 +434,10 @@ When reviewing a pull request involving a package migration, one should do the f
3. Inspect each commit for the following:
- - `feat`: should only add the new package. Ensure that all `require` paths have been updated and correctly refer to the new package. Ensure that any `include` directories have been renamed. Ensure that header guards have been updated.
- - `remove`: should only remove the symbol from the parent namespace of the original package.
- - `refactor`: should only update paths, but may include lint fixes if these were encountered while committing. Check as many files as possible in order to obtain a wide cross-section of affected files and ensure that the updated paths correctly point to the new package. Verify that affected packages do **not** include the original package, error databases, or REPL databases.
- - `remove`: should only remove the original package.
+ - `feat`: should only add the new package. Ensure that all `require` paths have been updated and correctly refer to the new package. Ensure that any `include` directories have been renamed. Ensure that header guards have been updated.
+ - `remove`: should only remove the symbol from the parent namespace of the original package.
+ - `refactor`: should only update paths, but may include lint fixes if these were encountered while committing. Check as many files as possible in order to obtain a wide cross-section of affected files and ensure that the updated paths correctly point to the new package. Verify that affected packages do **not** include the original package, error databases, or REPL databases.
+ - `remove`: should only remove the original package.
If there exists a public issue associated with the migration, ensure that each commit refers to that public issue with a `ref:` Git trailer.
@@ -451,30 +449,28 @@ When reviewing a pull request involving a package migration, one should do the f
6. If the pull request includes a merge commit, do the following:
- - Enable "Allow merge commits" (with the default message) on GitHub in repository settings.
- - Refresh the pull request page.
- - Select "Create a merge commit".
- - In the commit body, add a `ref:` trailer which points to the PR URL and add a `reviewed-by:` trailer with your info.
- - Merge.
- - Disable "Allow merge commits" on GitHub in repository settings. Our default merge setting should be "Squash and merge", and we do not want to mistakenly perform merge commits in future PRs.
- - Finished.
+ - Enable "Allow merge commits" (with the default message) on GitHub in repository settings.
+ - Refresh the pull request page.
+ - Select "Create a merge commit".
+ - In the commit body, add a `ref:` trailer which points to the PR URL and add a `reviewed-by:` trailer with your info.
+ - Merge.
+ - Disable "Allow merge commits" on GitHub in repository settings. Our default merge setting should be "Squash and merge", and we do not want to mistakenly perform merge commits in future PRs.
+ - Finished.
7. Otherwise, do the following:
- - Enable "Allow rebase merging" on GitHub in repository settings.
- - Refresh the pull request page.
- - Select "Rebase and merge".
- - Confirm that you wish to perform the operation.
- - Merge.
- - Disable "Allow rebase merging" on GitHub in repository settings. Our default merge setting should be "Squash and merge", and we do not want to mistakenly perform rebase commits in future PRs.
- - Finished.
+ - Enable "Allow rebase merging" on GitHub in repository settings.
+ - Refresh the pull request page.
+ - Select "Rebase and merge".
+ - Confirm that you wish to perform the operation.
+ - Merge.
+ - Disable "Allow rebase merging" on GitHub in repository settings. Our default merge setting should be "Squash and merge", and we do not want to mistakenly perform rebase commits in future PRs.
+ - Finished.
<section class="links">
[stdlib-github]: https://github.com/stdlib-js/stdlib
-
[stdlib-contributing]: https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md
-
[stdlib-development]: https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md
</section>
diff --git a/docs/contributing/packages.md b/docs/contributing/packages.md
index d8f963f60706..fa3f85425a98 100644
--- a/docs/contributing/packages.md
+++ b/docs/contributing/packages.md
@@ -113,7 +113,6 @@ Once a package is complete and tested, you are ready to request that your contri
<section class="links">
[stdlib-snippets]: https://github.com/stdlib-js/stdlib/tree/develop/tools/snippets
-
[stdlib-repl-text]: https://github.com/stdlib-js/stdlib/tree/develop/docs/contributing/repl_text.md
</section>
diff --git a/docs/contributing/repl_text.md b/docs/contributing/repl_text.md
index a51833977397..8ea40ad33113 100644
--- a/docs/contributing/repl_text.md
+++ b/docs/contributing/repl_text.md
@@ -143,7 +143,7 @@ foo.boop( beep )
A few notes:
-- In a function interface, each parameter should be surrounded by `1` space to the left and `1` space to the right.
+- In a function interface, each parameter should be surrounded by `1` space to the left and `1` space to the right.
```text
foo( beep, boop, bop )
@@ -152,7 +152,7 @@ A few notes:
...
```
-- If a function parameter is **optional**, enclose the parameter in square brackets.
+- If a function parameter is **optional**, enclose the parameter in square brackets.
```text
foo( beep[, boop[, bop]] )
@@ -271,44 +271,44 @@ foo( ...args )
The following parameter types are supported:
-- `any`: if a parameter can be any type.
-- `null`: if a parameter must be `null`.
-- `undefined`: if a parameter must be `undefined`.
-- `string`: if a parameter must be a `string` primitive.
-- `number`: if a parameter must be a `number` primitive.
-- `integer`: if a parameter must be a `number` primitive having an integer value.
-- `boolean`: if a parameter must be a `boolean` primitive.
-- `Function`: if a parameter must be a `function`.
-- `Object`: if a parameter must be an `object`.
-- `Array`: if a parameter must be an `array`.
-- `Array<type>`: if a parameter must be an `array` containing only values of a particular type.
-- `ArrayLike`: if a parameter must be array-like.
-- `ArrayLike<type>`: if a parameter must be array-like containing only values of a particular type.
-- `ArrayLikeObject`: if a parameter must be an array-like `object`.
-- `ArrayLikeObject<type>`: if a parameter must be an array-like `object` containing only values of a particular type.
-- `RegExp`: if a parameter must be a regular expression.
-- `Date`: if a parameter must be a `Date` object.
-- `Buffer`: if a parameter must be a Node.js `Buffer` object.
-- `Error`: if a parameter must be an `Error` object.
-- `TypeError`: if a parameter must be a `TypeError` object.
-- `SyntaxError`: if a parameter must be a `SyntaxError` object.
-- `RangeError`: if a parameter must be a `RangeError` object.
-- `ReferenceError`: if a parameter must be a `ReferenceError` object.
-- `EvalError`: if a parameter must be an `EvalError` object.
-- `URIError`: if a parameter must be a `URIError` object.
-- `TypedArray`: if a parameter must be a typed array.
-- `Float64Array`: if a parameter must be a `Float64Array`.
-- `Float32Array`: if a parameter must be a `Float32Array`.
-- `Int32Array`: if a parameter must be an `Int32Array`.
-- `Uint32Array`: if a parameter must be a `Uint32Array`.
-- `Int16Array`: if a parameter must be an `Int16Array`.
-- `Uint16Array`: if a parameter must be a `Uint16Array`.
-- `Int8Array`: if a parameter must be an `Int8Array`.
-- `Uint8Array`: if a parameter must be a `Uint8Array`.
-- `Uint8ClampedArray`: if a parameter must be a `Uint8ClampedArray`.
-- `ArrayBuffer`: if a parameter must be an `ArrayBuffer`.
-- `SharedArrayBuffer`: if a parameter must be a `SharedArrayBuffer`.
-- `ndarray`: if a parameter must be an `ndarray`.
+- `any`: if a parameter can be any type.
+- `null`: if a parameter must be `null`.
+- `undefined`: if a parameter must be `undefined`.
+- `string`: if a parameter must be a `string` primitive.
+- `number`: if a parameter must be a `number` primitive.
+- `integer`: if a parameter must be a `number` primitive having an integer value.
+- `boolean`: if a parameter must be a `boolean` primitive.
+- `Function`: if a parameter must be a `function`.
+- `Object`: if a parameter must be an `object`.
+- `Array`: if a parameter must be an `array`.
+- `Array<type>`: if a parameter must be an `array` containing only values of a particular type.
+- `ArrayLike`: if a parameter must be array-like.
+- `ArrayLike<type>`: if a parameter must be array-like containing only values of a particular type.
+- `ArrayLikeObject`: if a parameter must be an array-like `object`.
+- `ArrayLikeObject<type>`: if a parameter must be an array-like `object` containing only values of a particular type.
+- `RegExp`: if a parameter must be a regular expression.
+- `Date`: if a parameter must be a `Date` object.
+- `Buffer`: if a parameter must be a Node.js `Buffer` object.
+- `Error`: if a parameter must be an `Error` object.
+- `TypeError`: if a parameter must be a `TypeError` object.
+- `SyntaxError`: if a parameter must be a `SyntaxError` object.
+- `RangeError`: if a parameter must be a `RangeError` object.
+- `ReferenceError`: if a parameter must be a `ReferenceError` object.
+- `EvalError`: if a parameter must be an `EvalError` object.
+- `URIError`: if a parameter must be a `URIError` object.
+- `TypedArray`: if a parameter must be a typed array.
+- `Float64Array`: if a parameter must be a `Float64Array`.
+- `Float32Array`: if a parameter must be a `Float32Array`.
+- `Int32Array`: if a parameter must be an `Int32Array`.
+- `Uint32Array`: if a parameter must be a `Uint32Array`.
+- `Int16Array`: if a parameter must be an `Int16Array`.
+- `Uint16Array`: if a parameter must be a `Uint16Array`.
+- `Int8Array`: if a parameter must be an `Int8Array`.
+- `Uint8Array`: if a parameter must be a `Uint8Array`.
+- `Uint8ClampedArray`: if a parameter must be a `Uint8ClampedArray`.
+- `ArrayBuffer`: if a parameter must be an `ArrayBuffer`.
+- `SharedArrayBuffer`: if a parameter must be a `SharedArrayBuffer`.
+- `ndarray`: if a parameter must be an `ndarray`.
For parameters which may be more than one type, use a `|` separator.
@@ -328,11 +328,11 @@ In general, avoid specialized and/or uncommon value types (e.g., `NonNegativeInt
A few notes:
-- Parameter names should **match** the parameter names in function and method signatures.
-- If a parameter is **optional**, explicitly state that the parameter is optional **after** the type declaration.
-- For `Object` parameters, list each required and/or optional `Object` property as a separate parameter.
-- All parameter descriptions should end with a period.
-- If a `function` does not have parameter values, **omit** this section.
+- Parameter names should **match** the parameter names in function and method signatures.
+- If a parameter is **optional**, explicitly state that the parameter is optional **after** the type declaration.
+- For `Object` parameters, list each required and/or optional `Object` property as a separate parameter.
+- All parameter descriptions should end with a period.
+- If a `function` does not have parameter values, **omit** this section.
### Returns
@@ -351,10 +351,10 @@ The `Returns` section states the return value name, the return value type, and a
Conventional names for output values include
-- `bool`: for `boolean` return values.
-- `fcn`: for `Function` return values.
-- `out`: for generic return values.
-- `y`: for `number` return values mathematical functions satisfying the form `y = f(x)`.
+- `bool`: for `boolean` return values.
+- `fcn`: for `Function` return values.
+- `out`: for generic return values.
+- `y`: for `number` return values mathematical functions satisfying the form `y = f(x)`.
For return values which can be more than one type, use a `|` separator.
@@ -385,10 +385,10 @@ Foo()
A few notes:
-- For `Object` return values having a defined structure (e.g., mathematical models), list each `Object` property as a separate return value and separate each property with an empty line.
-- Return value types are the same as for parameters.
-- All return value descriptions should end with a period.
-- If a `function` does not have return values, **omit** this section.
+- For `Object` return values having a defined structure (e.g., mathematical models), list each `Object` property as a separate return value and separate each property with an empty line.
+- Return value types are the same as for parameters.
+- All return value descriptions should end with a period.
+- If a `function` does not have return values, **omit** this section.
### Examples
@@ -472,12 +472,12 @@ foo( clbk )
A few notes:
-- Begin each line of user input with a `>` symbol.
-- Place expected output on the line immediately following a line of user input.
-- To indicate silenced output (i.e., a line of user input whose output is suppressed), end a user input line with a semicolon. Note that this includes `Function` declarations.
-- Only declare a variable the first time a variable is used.
-- Where possible, **prefer** single line user input over multi-line input. The latter is harder for users to copy and paste within a REPL context.
-- A REPL text should **always** include an `Examples` section.
+- Begin each line of user input with a `>` symbol.
+- Place expected output on the line immediately following a line of user input.
+- To indicate silenced output (i.e., a line of user input whose output is suppressed), end a user input line with a semicolon. Note that this includes `Function` declarations.
+- Only declare a variable the first time a variable is used.
+- Where possible, **prefer** single line user input over multi-line input. The latter is harder for users to copy and paste within a REPL context.
+- A REPL text should **always** include an `Examples` section.
### References
@@ -501,9 +501,9 @@ Only include references **if** usage requires citations. If not required, **remo
A few notes:
-- Each citation should be a properly formatted citation.
-- Citations are not required to include URLs.
-- Include only **one** `References` section per REPL text.
+- Each citation should be a properly formatted citation.
+- Citations are not required to include URLs.
+- Include only **one** `References` section per REPL text.
### See Also
@@ -519,16 +519,16 @@ The `See Also` section should include related functionality available in a REPL
A few notes:
-- Separate each entry with a comma followed by a space.
-- Insert an empty line following the last line containing entries.
-- If a `See Also` section does **not** contain entries, insert two empty lines following the section header.
-- Include only **one** `See Also` section per REPL text.
+- Separate each entry with a comma followed by a space.
+- Insert an empty line following the last line containing entries.
+- If a `See Also` section does **not** contain entries, insert two empty lines following the section header.
+- Include only **one** `See Also` section per REPL text.
-* * *
+---
## stdlib
-- All `stdlib` REPL texts should use an alias placeholder.
+- All `stdlib` REPL texts should use an alias placeholder.
```text
{{alias}}( str )
@@ -546,9 +546,9 @@ A few notes:
The alias is injected via a separate build process which manages the REPL namespace.
-- Do **not** manually add entries to the `See Also` section. Entries are injected via a separate build process which manages the REPL namespace.
+- Do **not** manually add entries to the `See Also` section. Entries are injected via a separate build process which manages the REPL namespace.
-- To reference other REPL functionality, use an alias placeholder which references the package name.
+- To reference other REPL functionality, use an alias placeholder which references the package name.
```text
{{alias}}( x )
@@ -566,4 +566,4 @@ A few notes:
External aliases are resolved during a separate build process which manages the REPL namespace. Where possible, limit the use of external aliases unless absolutely necessary.
-- All references should originate from the `stdlib` bibliographic database. Generate reference citations using `make citation` to ensure a consistent bibliographic style.
+- All references should originate from the `stdlib` bibliographic database. Generate reference citations using `make citation` to ensure a consistent bibliographic style.
diff --git a/docs/contributing/setting_up_a_devcontainer.md b/docs/contributing/setting_up_a_devcontainer.md
index 3287d2d6df42..37b6f740697d 100644
--- a/docs/contributing/setting_up_a_devcontainer.md
+++ b/docs/contributing/setting_up_a_devcontainer.md
@@ -36,9 +36,9 @@ The stdlib repository includes a preconfigured dev container, making it the easi
Setting up the stdlib dev container **requires** the following prerequisites:
-- [Git][git]: Version control
-- [Docker][docker]: Containerization
-- [VS Code][vscode]: Preferred IDE
+- [Git][git]: Version control
+- [Docker][docker]: Containerization
+- [VS Code][vscode]: Preferred IDE
### Download
@@ -74,7 +74,6 @@ $ cd stdlib && code .
When prompted, open the repository in the dev container.
-
<div class="image" align="center">
<img width="480" src="./img/vscode_dev_container_prompt.png" alt="Prompt by VS Code to reopen the repository in a devcontainer.">
<br>
@@ -116,13 +115,9 @@ If you see this when you open the terminal, then the dev container installation
<section class="links">
[git]: http://git-scm.com/
-
[docker]: https://www.docker.com/
-
[vscode]: https://code.visualstudio.com/
-
[devcontainer-issue]: https://github.com/stdlib-js/stdlib/issues/4934
-
[github-fork]: https://help.github.com/articles/fork-a-repo/
</section>
diff --git a/docs/editors/sublime-text/README.md b/docs/editors/sublime-text/README.md
index f9b7efe4321c..8bc2fa37c2fb 100644
--- a/docs/editors/sublime-text/README.md
+++ b/docs/editors/sublime-text/README.md
@@ -71,27 +71,27 @@ Copy the `completions/*.sublime-completions` and `snippets/*.sublime-snippet` fi
## Packages
-- [**Package Control**][sublime-text-package-control]: package manager which helps in finding, installing, and keeping installed packages up-to-date. This **should** be installed prior to installing any of the packages subsequently listed here.
+- [**Package Control**][sublime-text-package-control]: package manager which helps in finding, installing, and keeping installed packages up-to-date. This **should** be installed prior to installing any of the packages subsequently listed here.
-- [**Git**][sublime-text-git]: package which provides [Git][git] integration.
+- [**Git**][sublime-text-git]: package which provides [Git][git] integration.
-- [**EditorConfig**][sublime-text-editorconfig]: package for using [EditorConfig][editorconfig], which helps define and maintain consistent coding styles between different editors and IDEs.
+- [**EditorConfig**][sublime-text-editorconfig]: package for using [EditorConfig][editorconfig], which helps define and maintain consistent coding styles between different editors and IDEs.
-- [**Pretty JSON**][sublime-text-pretty-json]: package for pretty printing and minifying [JSON][json].
+- [**Pretty JSON**][sublime-text-pretty-json]: package for pretty printing and minifying [JSON][json].
-- [**Sidebar Enhancements**][sublime-text-sidebar-enhancements]: package which provides enhancements for working with files and folders in the Sublime Text sidebar.
+- [**Sidebar Enhancements**][sublime-text-sidebar-enhancements]: package which provides enhancements for working with files and folders in the Sublime Text sidebar.
-- [**UnicodeMath**][sublime-text-unicode-math]: package for inserting Unicode math and emoji.
+- [**UnicodeMath**][sublime-text-unicode-math]: package for inserting Unicode math and emoji.
-- [**Julia**][sublime-text-julia]: package which provides syntax highlighting for [Julia][julia].
+- [**Julia**][sublime-text-julia]: package which provides syntax highlighting for [Julia][julia].
-- [**AWK**][sublime-text-awk]: package which provides syntax highlighting for [AWK][awk].
+- [**AWK**][sublime-text-awk]: package which provides syntax highlighting for [AWK][awk].
-- [**Fortran**][sublime-text-fortran]: package which provides syntax highlighting for [Fortran][fortran]. Once installed, configure [Sublime Text][sublime-text] to always open files having the file extension `*.f` as `Fortran (modern)`.
+- [**Fortran**][sublime-text-fortran]: package which provides syntax highlighting for [Fortran][fortran]. Once installed, configure [Sublime Text][sublime-text] to always open files having the file extension `*.f` as `Fortran (modern)`.
-- [**TypeScript**][sublime-text-typescript]: package which provides an IO wrapper around [TypeScript][typescript] language services.
+- [**TypeScript**][sublime-text-typescript]: package which provides an IO wrapper around [TypeScript][typescript] language services.
-- [**MarkdownEditing**][sublime-text-markdownediting]: package which provides syntax highlighting (including for fenced code blocks) and editing features for Markdown. Once installed, configure the package settings as follows:
+- [**MarkdownEditing**][sublime-text-markdownediting]: package which provides syntax highlighting (including for fenced code blocks) and editing features for Markdown. Once installed, configure the package settings as follows:
```text
{
@@ -123,9 +123,9 @@ Copy the `completions/*.sublime-completions` and `snippets/*.sublime-snippet` fi
}
```
-- [**SublimeLinter**][sublime-text-sublimelinter]: package which provides an interactive linting framework for [Sublime Text][sublime-text]. The framework does **not** contain any built-in linters. Instead, you must install plugins which provide interfaces to lint executables.
+- [**SublimeLinter**][sublime-text-sublimelinter]: package which provides an interactive linting framework for [Sublime Text][sublime-text]. The framework does **not** contain any built-in linters. Instead, you must install plugins which provide interfaces to lint executables.
- - [**SublimeLinter-eslint**][sublime-text-sublimelinter-eslint]: plugin which provides an interface to [ESLint][eslint]. Once installed, you need to configure [SublimeLinter][sublime-text-sublimelinter] to use the project [ESLint][eslint] configuration files and to set the `NODE_PATH` environment variable upon invoking [ESLint][eslint]:
+ - [**SublimeLinter-eslint**][sublime-text-sublimelinter-eslint]: plugin which provides an interface to [ESLint][eslint]. Once installed, you need to configure [SublimeLinter][sublime-text-sublimelinter] to use the project [ESLint][eslint] configuration files and to set the `NODE_PATH` environment variable upon invoking [ESLint][eslint]:
```text
...
@@ -161,7 +161,7 @@ Copy the `completions/*.sublime-completions` and `snippets/*.sublime-snippet` fi
},
```
- - [**SublimeLinter-annotations**][sublime-text-sublimelinter-annotations]: plugin which marks annotations such as `TODO`, `FIXME`, etc. Once installed, you need to configure [SublimeLinter][sublime-text-sublimelinter] to mark project annotations.
+ - [**SublimeLinter-annotations**][sublime-text-sublimelinter-annotations]: plugin which marks annotations such as `TODO`, `FIXME`, etc. Once installed, you need to configure [SublimeLinter][sublime-text-sublimelinter] to mark project annotations.
```text
...
@@ -184,9 +184,9 @@ Copy the `completions/*.sublime-completions` and `snippets/*.sublime-snippet` fi
...
```
- - [**SublimeLinter-json**][sublime-text-sublimelinter-json]: plugin which lints [JSON][json].
+ - [**SublimeLinter-json**][sublime-text-sublimelinter-json]: plugin which lints [JSON][json].
- - [**SublimeLinter-shellcheck**][sublime-text-sublimelinter-shellcheck]: plugin which provides an interface to [shellcheck][shellcheck] for linting files having "Shell-Unix-Generic" syntax (aka Shell Script).
+ - [**SublimeLinter-shellcheck**][sublime-text-sublimelinter-shellcheck]: plugin which provides an interface to [shellcheck][shellcheck] for linting files having "Shell-Unix-Generic" syntax (aka Shell Script).
If [shellcheck][shellcheck] was installed as a local project dependency (e.g., `make install-deps` on non-MacOS platforms per the project development guide), you need to configure [SublimeLinter][sublime-text-sublimelinter] to search the top-level `deps` directory for locally installed linter executables. For example, on Linux,
@@ -206,55 +206,30 @@ Copy the `completions/*.sublime-completions` and `snippets/*.sublime-snippet` fi
<section class="links">
[sublime-text]: https://www.sublimetext.com/
-
[sublime-text-package-control]: https://packagecontrol.io
-
[sublime-text-git]: https://github.com/kemayo/sublime-text-git
-
[sublime-text-sublimelinter]: https://github.com/SublimeLinter/SublimeLinter3
-
[sublime-text-sublimelinter-eslint]: https://github.com/roadhump/SublimeLinter-eslint
-
[sublime-text-sublimelinter-annotations]: https://github.com/SublimeLinter/SublimeLinter-annotations
-
[sublime-text-sublimelinter-json]: https://github.com/SublimeLinter/SublimeLinter-json
-
[sublime-text-sublimelinter-shellcheck]: https://github.com/SublimeLinter/SublimeLinter-shellcheck
-
[sublime-text-editorconfig]: https://github.com/sindresorhus/editorconfig-sublime
-
[sublime-text-pretty-json]: https://github.com/dzhibas/SublimePrettyJson
-
[sublime-text-sidebar-enhancements]: https://github.com/SideBarEnhancements-org/SideBarEnhancements
-
[sublime-text-unicode-math]: https://github.com/mvoidex/UnicodeMath
-
[sublime-text-markdownediting]: https://github.com/SublimeText-Markdown/MarkdownEditing
-
[sublime-text-julia]: https://github.com/JuliaEditorSupport/Julia-sublime
-
[sublime-text-awk]: https://github.com/JohnNilsson/awk-sublime
-
[sublime-text-fortran]: https://github.com/315234/SublimeFortran
-
[sublime-text-typescript]: https://github.com/Microsoft/TypeScript-Sublime-Plugin
-
[git]: https://git-scm.com/
-
[eslint]: https://eslint.org/
-
[shellcheck]: https://github.com/koalaman/shellcheck
-
[json]: http://www.json.org/
-
[editorconfig]: http://editorconfig.org/
-
[julia]: https://julialang.org/
-
[awk]: https://en.wikipedia.org/wiki/AWK
-
[fortran]: https://en.wikipedia.org/wiki/Fortran
-
[typescript]: https://www.typescriptlang.org/
</section>
diff --git a/docs/editors/sublime-text/completions/stdlib-awk.sublime-completions b/docs/editors/sublime-text/completions/stdlib-awk.sublime-completions
index 646926cc9de0..f320d260f798 100644
--- a/docs/editors/sublime-text/completions/stdlib-awk.sublime-completions
+++ b/docs/editors/sublime-text/completions/stdlib-awk.sublime-completions
@@ -1,9 +1,9 @@
{
- "scope": "source.awk",
- "completions": [
- {
- "trigger": "stdlib.stub",
- "contents": "#!/usr/bin/env awk -f\n#\n# @license Apache-2.0\n#\n# Copyright (c) 2023 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"
- }
- ]
-}
\ No newline at end of file
+ "scope": "source.awk",
+ "completions": [
+ {
+ "trigger": "stdlib.stub",
+ "contents": "#!/usr/bin/env awk -f\n#\n# @license Apache-2.0\n#\n# Copyright (c) 2023 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",
+ },
+ ],
+}
diff --git a/docs/editors/sublime-text/completions/stdlib-bash.sublime-completions b/docs/editors/sublime-text/completions/stdlib-bash.sublime-completions
index 3adb008345e7..05f57c7710e0 100644
--- a/docs/editors/sublime-text/completions/stdlib-bash.sublime-completions
+++ b/docs/editors/sublime-text/completions/stdlib-bash.sublime-completions
@@ -1,9 +1,9 @@
{
- "scope": "source.bash",
- "completions": [
- {
- "trigger": "stdlib.stub",
- "contents": "#!/usr/bin/env bash\n#\n# @license Apache-2.0\n#\n# Copyright (c) 2023 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"
- }
- ]
-}
\ No newline at end of file
+ "scope": "source.bash",
+ "completions": [
+ {
+ "trigger": "stdlib.stub",
+ "contents": "#!/usr/bin/env bash\n#\n# @license Apache-2.0\n#\n# Copyright (c) 2023 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",
+ },
+ ],
+}
diff --git a/docs/editors/sublime-text/completions/stdlib-js.sublime-completions b/docs/editors/sublime-text/completions/stdlib-js.sublime-completions
index 96a8b15fb178..302fdbc49f3b 100644
--- a/docs/editors/sublime-text/completions/stdlib-js.sublime-completions
+++ b/docs/editors/sublime-text/completions/stdlib-js.sublime-completions
@@ -1,13 +1,13 @@
{
- "scope": "source.js",
- "completions": [
- {
- "trigger": "stdlib.stub",
- "contents": "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 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"
- },
- {
- "trigger": "stdlib.stub.script",
- "contents": "#!/usr/bin/env node\n\n/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 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"
- }
- ]
-}
\ No newline at end of file
+ "scope": "source.js",
+ "completions": [
+ {
+ "trigger": "stdlib.stub",
+ "contents": "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 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",
+ },
+ {
+ "trigger": "stdlib.stub.script",
+ "contents": "#!/usr/bin/env node\n\n/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 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",
+ },
+ ],
+}
diff --git a/docs/editors/sublime-text/completions/stdlib-julia.sublime-completions b/docs/editors/sublime-text/completions/stdlib-julia.sublime-completions
index 02ed7ad8182c..e35add8d3165 100644
--- a/docs/editors/sublime-text/completions/stdlib-julia.sublime-completions
+++ b/docs/editors/sublime-text/completions/stdlib-julia.sublime-completions
@@ -1,9 +1,9 @@
{
- "scope": "source.julia",
- "completions": [
- {
- "trigger": "stdlib.stub",
- "contents": "#!/usr/bin/env julia\n#\n# @license Apache-2.0\n#\n# Copyright (c) 2023 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"
- }
- ]
-}
\ No newline at end of file
+ "scope": "source.julia",
+ "completions": [
+ {
+ "trigger": "stdlib.stub",
+ "contents": "#!/usr/bin/env julia\n#\n# @license Apache-2.0\n#\n# Copyright (c) 2023 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",
+ },
+ ],
+}
diff --git a/docs/editors/sublime-text/completions/stdlib-python.sublime-completions b/docs/editors/sublime-text/completions/stdlib-python.sublime-completions
index ac3d402861b2..1767791df09d 100644
--- a/docs/editors/sublime-text/completions/stdlib-python.sublime-completions
+++ b/docs/editors/sublime-text/completions/stdlib-python.sublime-completions
@@ -1,9 +1,9 @@
{
- "scope": "source.python",
- "completions": [
- {
- "trigger": "stdlib.stub",
- "contents": "#!/usr/bin/env python\n#\n# @license Apache-2.0\n#\n# Copyright (c) 2023 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"
- }
- ]
-}
\ No newline at end of file
+ "scope": "source.python",
+ "completions": [
+ {
+ "trigger": "stdlib.stub",
+ "contents": "#!/usr/bin/env python\n#\n# @license Apache-2.0\n#\n# Copyright (c) 2023 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",
+ },
+ ],
+}
diff --git a/docs/editors/sublime-text/completions/stdlib-r.sublime-completions b/docs/editors/sublime-text/completions/stdlib-r.sublime-completions
index 556f0f4c3f1d..7ccf087fa6c2 100644
--- a/docs/editors/sublime-text/completions/stdlib-r.sublime-completions
+++ b/docs/editors/sublime-text/completions/stdlib-r.sublime-completions
@@ -1,9 +1,9 @@
{
- "scope": "source.r",
- "completions": [
- {
- "trigger": "stdlib.stub",
- "contents": "#!/usr/bin/env Rscript\n#\n# @license Apache-2.0\n#\n# Copyright (c) 2023 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"
- }
- ]
-}
\ No newline at end of file
+ "scope": "source.r",
+ "completions": [
+ {
+ "trigger": "stdlib.stub",
+ "contents": "#!/usr/bin/env Rscript\n#\n# @license Apache-2.0\n#\n# Copyright (c) 2023 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",
+ },
+ ],
+}
diff --git a/docs/editors/sublime-text/node.sublime-build b/docs/editors/sublime-text/node.sublime-build
index 49d435e24dd0..880d4bbaedd6 100644
--- a/docs/editors/sublime-text/node.sublime-build
+++ b/docs/editors/sublime-text/node.sublime-build
@@ -1,4 +1,4 @@
{
- "cmd": [ "node", "$file" ],
- "selector": "source.js"
+ "cmd": ["node", "$file"],
+ "selector": "source.js",
}
diff --git a/docs/editors/sublime-text/scripts/build.js b/docs/editors/sublime-text/scripts/build.js
index d3192913d266..94f6ca4db0d3 100644
--- a/docs/editors/sublime-text/scripts/build.js
+++ b/docs/editors/sublime-text/scripts/build.js
@@ -1,29 +1,29 @@
#!/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.
-*/
+ * @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.
+ */
/* eslint-disable node/shebang */
-'use strict';
+"use strict";
// Generate license header snippets:
-require( './license_header_snippets.js' ); // eslint-disable-line stdlib/no-unassigned-require
+require("./license_header_snippets.js"); // eslint-disable-line stdlib/no-unassigned-require
// Generate completions files:
-require( './sublime_completions.js' ); // eslint-disable-line stdlib/no-unassigned-require
+require("./sublime_completions.js"); // eslint-disable-line stdlib/no-unassigned-require
diff --git a/docs/editors/sublime-text/scripts/completions/awk.js b/docs/editors/sublime-text/scripts/completions/awk.js
index 740ea1859007..7989bc9aa248 100644
--- a/docs/editors/sublime-text/scripts/completions/awk.js
+++ b/docs/editors/sublime-text/scripts/completions/awk.js
@@ -1,62 +1,60 @@
#!/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.
-*/
+ * @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.
+ */
/* eslint-disable node/shebang */
-'use strict';
+"use strict";
// MODULES //
-var currentYear = require( '@stdlib/time/current-year' );
-var licenseHeader = require( '@stdlib/_tools/licenses/header' );
-
+var currentYear = require("@stdlib/time/current-year");
+var licenseHeader = require("@stdlib/_tools/licenses/header");
// MAIN //
// SPDX license identifier:
-var spdx = 'Apache-2.0';
+var spdx = "Apache-2.0";
// License header options:
var opts = {
- 'year': currentYear(),
- 'copyright': 'The Stdlib Authors'
+ year: currentYear(),
+ copyright: "The Stdlib Authors",
};
// License header:
-var license = licenseHeader( spdx, 'awk', opts );
+var license = licenseHeader(spdx, "awk", opts);
// Configurations for each completion:
var completions = [
{
- 'name': 'awk',
- 'scope': 'source.awk',
- 'completions': [
+ name: "awk",
+ scope: "source.awk",
+ completions: [
{
- 'trigger': 'stdlib.stub',
- 'contents': '#!/usr/bin/env awk -f\n'+license+'\n'
- }
- ]
- }
+ trigger: "stdlib.stub",
+ contents: "#!/usr/bin/env awk -f\n" + license + "\n",
+ },
+ ],
+ },
];
-
// EXPORTS //
module.exports = completions;
diff --git a/docs/editors/sublime-text/scripts/completions/bash.js b/docs/editors/sublime-text/scripts/completions/bash.js
index 79fa5b9d7357..1df46202fa7c 100644
--- a/docs/editors/sublime-text/scripts/completions/bash.js
+++ b/docs/editors/sublime-text/scripts/completions/bash.js
@@ -1,62 +1,60 @@
#!/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.
-*/
+ * @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.
+ */
/* eslint-disable node/shebang */
-'use strict';
+"use strict";
// MODULES //
-var currentYear = require( '@stdlib/time/current-year' );
-var licenseHeader = require( '@stdlib/_tools/licenses/header' );
-
+var currentYear = require("@stdlib/time/current-year");
+var licenseHeader = require("@stdlib/_tools/licenses/header");
// VARIABLES //
// SPDX license identifier:
-var spdx = 'Apache-2.0';
+var spdx = "Apache-2.0";
// License header options:
var opts = {
- 'year': currentYear(),
- 'copyright': 'The Stdlib Authors'
+ year: currentYear(),
+ copyright: "The Stdlib Authors",
};
// License header:
-var license = licenseHeader( spdx, 'bash', opts );
+var license = licenseHeader(spdx, "bash", opts);
// Configurations for each completion:
var completions = [
{
- 'name': 'bash',
- 'scope': 'source.bash',
- 'completions': [
+ name: "bash",
+ scope: "source.bash",
+ completions: [
{
- 'trigger': 'stdlib.stub',
- 'contents': '#!/usr/bin/env bash\n'+license+'\n'
- }
- ]
- }
+ trigger: "stdlib.stub",
+ contents: "#!/usr/bin/env bash\n" + license + "\n",
+ },
+ ],
+ },
];
-
// EXPORTS //
module.exports = completions;
diff --git a/docs/editors/sublime-text/scripts/completions/index.js b/docs/editors/sublime-text/scripts/completions/index.js
index 16648b1d4c93..de5f0f3c56ff 100644
--- a/docs/editors/sublime-text/scripts/completions/index.js
+++ b/docs/editors/sublime-text/scripts/completions/index.js
@@ -1,37 +1,36 @@
#!/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';
+ * @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 list = [];
// Note: keep in alphabetical order
-list = list.concat( require( './awk.js' ) );
-list = list.concat( require( './bash.js' ) );
-list = list.concat( require( './javascript.js' ) );
-list = list.concat( require( './julia.js' ) );
-list = list.concat( require( './python.js' ) );
-list = list.concat( require( './r.js' ) );
-
+list = list.concat(require("./awk.js"));
+list = list.concat(require("./bash.js"));
+list = list.concat(require("./javascript.js"));
+list = list.concat(require("./julia.js"));
+list = list.concat(require("./python.js"));
+list = list.concat(require("./r.js"));
// EXPORTS //
diff --git a/docs/editors/sublime-text/scripts/completions/javascript.js b/docs/editors/sublime-text/scripts/completions/javascript.js
index df762567137a..2025311c6745 100644
--- a/docs/editors/sublime-text/scripts/completions/javascript.js
+++ b/docs/editors/sublime-text/scripts/completions/javascript.js
@@ -1,66 +1,64 @@
#!/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.
-*/
+ * @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.
+ */
/* eslint-disable node/shebang */
-'use strict';
+"use strict";
// MODULES //
-var currentYear = require( '@stdlib/time/current-year' );
-var licenseHeader = require( '@stdlib/_tools/licenses/header' );
-
+var currentYear = require("@stdlib/time/current-year");
+var licenseHeader = require("@stdlib/_tools/licenses/header");
// MAIN //
// SPDX license identifier:
-var spdx = 'Apache-2.0';
+var spdx = "Apache-2.0";
// License header options:
var opts = {
- 'year': currentYear(),
- 'copyright': 'The Stdlib Authors'
+ year: currentYear(),
+ copyright: "The Stdlib Authors",
};
// License header:
-var license = licenseHeader( spdx, 'javascript', opts );
+var license = licenseHeader(spdx, "javascript", opts);
// Configurations for each completion:
var completions = [
{
- 'name': 'js',
- 'scope': 'source.js',
- 'completions': [
+ name: "js",
+ scope: "source.js",
+ completions: [
{
- 'trigger': 'stdlib.stub',
- 'contents': license+'\n\'use strict\';\n\n'
+ trigger: "stdlib.stub",
+ contents: license + "\n'use strict';\n\n",
},
{
- 'trigger': 'stdlib.stub.script',
- 'contents': '#!/usr/bin/env node\n\n'+license+'\n\'use strict\';\n\n'
- }
- ]
- }
+ trigger: "stdlib.stub.script",
+ contents: "#!/usr/bin/env node\n\n" + license + "\n'use strict';\n\n",
+ },
+ ],
+ },
];
-
// EXPORTS //
module.exports = completions;
diff --git a/docs/editors/sublime-text/scripts/completions/julia.js b/docs/editors/sublime-text/scripts/completions/julia.js
index 933b21bf5283..38804fce95c1 100644
--- a/docs/editors/sublime-text/scripts/completions/julia.js
+++ b/docs/editors/sublime-text/scripts/completions/julia.js
@@ -1,62 +1,60 @@
#!/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.
-*/
+ * @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.
+ */
/* eslint-disable node/shebang */
-'use strict';
+"use strict";
// MODULES //
-var currentYear = require( '@stdlib/time/current-year' );
-var licenseHeader = require( '@stdlib/_tools/licenses/header' );
-
+var currentYear = require("@stdlib/time/current-year");
+var licenseHeader = require("@stdlib/_tools/licenses/header");
// VARIABLES //
// SPDX license identifier:
-var spdx = 'Apache-2.0';
+var spdx = "Apache-2.0";
// License header options:
var opts = {
- 'year': currentYear(),
- 'copyright': 'The Stdlib Authors'
+ year: currentYear(),
+ copyright: "The Stdlib Authors",
};
// License header:
-var license = licenseHeader( spdx, 'julia', opts );
+var license = licenseHeader(spdx, "julia", opts);
// Configurations for each completion:
var completions = [
{
- 'name': 'julia',
- 'scope': 'source.julia',
- 'completions': [
+ name: "julia",
+ scope: "source.julia",
+ completions: [
{
- 'trigger': 'stdlib.stub',
- 'contents': '#!/usr/bin/env julia\n'+license+'\n'
- }
- ]
- }
+ trigger: "stdlib.stub",
+ contents: "#!/usr/bin/env julia\n" + license + "\n",
+ },
+ ],
+ },
];
-
// EXPORTS //
module.exports = completions;
diff --git a/docs/editors/sublime-text/scripts/completions/python.js b/docs/editors/sublime-text/scripts/completions/python.js
index bb90014ecae6..9bd7cb8c1945 100644
--- a/docs/editors/sublime-text/scripts/completions/python.js
+++ b/docs/editors/sublime-text/scripts/completions/python.js
@@ -1,62 +1,60 @@
#!/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.
-*/
+ * @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.
+ */
/* eslint-disable node/shebang */
-'use strict';
+"use strict";
// MODULES //
-var currentYear = require( '@stdlib/time/current-year' );
-var licenseHeader = require( '@stdlib/_tools/licenses/header' );
-
+var currentYear = require("@stdlib/time/current-year");
+var licenseHeader = require("@stdlib/_tools/licenses/header");
// VARIABLES //
// SPDX license identifier:
-var spdx = 'Apache-2.0';
+var spdx = "Apache-2.0";
// License header options:
var opts = {
- 'year': currentYear(),
- 'copyright': 'The Stdlib Authors'
+ year: currentYear(),
+ copyright: "The Stdlib Authors",
};
// License header:
-var license = licenseHeader( spdx, 'python', opts );
+var license = licenseHeader(spdx, "python", opts);
// Configurations for each completion:
var completions = [
{
- 'name': 'python',
- 'scope': 'source.python',
- 'completions': [
+ name: "python",
+ scope: "source.python",
+ completions: [
{
- 'trigger': 'stdlib.stub',
- 'contents': '#!/usr/bin/env python\n'+license+'\n'
- }
- ]
- }
+ trigger: "stdlib.stub",
+ contents: "#!/usr/bin/env python\n" + license + "\n",
+ },
+ ],
+ },
];
-
// EXPORTS //
module.exports = completions;
diff --git a/docs/editors/sublime-text/scripts/completions/r.js b/docs/editors/sublime-text/scripts/completions/r.js
index d45e6621b046..1e1f58f3e3bc 100644
--- a/docs/editors/sublime-text/scripts/completions/r.js
+++ b/docs/editors/sublime-text/scripts/completions/r.js
@@ -1,62 +1,60 @@
#!/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.
-*/
+ * @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.
+ */
/* eslint-disable node/shebang */
-'use strict';
+"use strict";
// MODULES //
-var currentYear = require( '@stdlib/time/current-year' );
-var licenseHeader = require( '@stdlib/_tools/licenses/header' );
-
+var currentYear = require("@stdlib/time/current-year");
+var licenseHeader = require("@stdlib/_tools/licenses/header");
// VARIABLES //
// SPDX license identifier:
-var spdx = 'Apache-2.0';
+var spdx = "Apache-2.0";
// License header options:
var opts = {
- 'year': currentYear(),
- 'copyright': 'The Stdlib Authors'
+ year: currentYear(),
+ copyright: "The Stdlib Authors",
};
// License header:
-var license = licenseHeader( spdx, 'r', opts );
+var license = licenseHeader(spdx, "r", opts);
// Configurations for each completion:
var completions = [
{
- 'name': 'r',
- 'scope': 'source.r',
- 'completions': [
+ name: "r",
+ scope: "source.r",
+ completions: [
{
- 'trigger': 'stdlib.stub',
- 'contents': '#!/usr/bin/env Rscript\n'+license+'\n'
- }
- ]
- }
+ trigger: "stdlib.stub",
+ contents: "#!/usr/bin/env Rscript\n" + license + "\n",
+ },
+ ],
+ },
];
-
// EXPORTS //
module.exports = completions;
diff --git a/docs/editors/sublime-text/scripts/license_header_snippets.js b/docs/editors/sublime-text/scripts/license_header_snippets.js
index bb2b6f72e7c5..a07bd9407785 100755
--- a/docs/editors/sublime-text/scripts/license_header_snippets.js
+++ b/docs/editors/sublime-text/scripts/license_header_snippets.js
@@ -1,195 +1,192 @@
#!/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.
-*/
+ * @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.
+ */
/* eslint-disable node/shebang */
-'use strict';
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var join = require( 'path' ).join;
-var logger = require( 'debug' );
-var objectKeys = require( '@stdlib/utils/keys' );
-var readFileSync = require( '@stdlib/fs/read-file' ).sync;
-var writeFileSync = require( '@stdlib/fs/write-file' ).sync;
-var replace = require( '@stdlib/string/replace' );
-var currentYear = require( '@stdlib/time/current-year' );
-var licenseHeader = require( '@stdlib/_tools/licenses/header' );
-
+var resolve = require("path").resolve;
+var join = require("path").join;
+var logger = require("debug");
+var objectKeys = require("@stdlib/utils/keys");
+var readFileSync = require("@stdlib/fs/read-file").sync;
+var writeFileSync = require("@stdlib/fs/write-file").sync;
+var replace = require("@stdlib/string/replace");
+var currentYear = require("@stdlib/time/current-year");
+var licenseHeader = require("@stdlib/_tools/licenses/header");
// VARIABLES //
-var debug = logger( 'sublime-license-header-snippets' );
+var debug = logger("sublime-license-header-snippets");
// SPDX license identifier:
-var SPDX = 'Apache-2.0';
+var SPDX = "Apache-2.0";
// Configuration for each license header snippet:
var LANGS = {
- 'awk': {
- 'trigger': 'stdlib.license',
- 'scope': 'source.awk',
- 'desc': 'AWK license header'
- },
- 'c': {
- 'trigger': 'stdlib.license',
- 'scope': 'source.c',
- 'desc': 'C license header'
- },
- 'cpp': {
- 'trigger': 'stdlib.license',
- 'scope': 'source.c++',
- 'desc': 'C++ license header'
- },
- 'css': {
- 'trigger': 'stdlib.license',
- 'scope': 'source.css',
- 'desc': 'CSS license header'
- },
- 'f': {
- 'trigger': 'stdlib.license',
- 'scope': 'source.modern-fortran',
- 'desc': 'Fortran license header (modern)'
- },
- 'gyp': {
- 'trigger': 'stdlib.license.gyp',
- 'scope': '', // gyp
- 'desc': 'GYP license header'
- },
- 'gypi': {
- 'trigger': 'stdlib.license.gypi',
- 'scope': '', // gyp
- 'desc': 'GYP include license header'
- },
- 'html': {
- 'trigger': 'stdlib.license',
- 'scope': 'text.html',
- 'desc': 'HTML license header'
- },
- 'ini': {
- 'trigger': 'stdlib.license.ini',
- 'scope': '', // ini
- 'desc': 'INI license header'
- },
- 'jl': {
- 'trigger': 'stdlib.license',
- 'scope': 'source.julia',
- 'desc': 'Julia license header'
- },
- 'js': {
- 'trigger': 'stdlib.license',
- 'scope': 'source.js',
- 'desc': 'JavaScript license header'
- },
- 'md': {
- 'trigger': 'stdlib.license',
- 'scope': 'text.html.markdown',
- 'desc': 'Markdown license header'
- },
- 'mk': {
- 'trigger': 'stdlib.license',
- 'scope': 'source.makefile',
- 'desc': 'Makefile license header'
- },
- 'py': {
- 'trigger': 'stdlib.license',
- 'scope': 'source.python',
- 'desc': 'Python license header'
- },
- 'r': {
- 'trigger': 'stdlib.license',
- 'scope': 'source.r',
- 'desc': 'R license header'
- },
- 'sh': {
- 'trigger': 'stdlib.license',
- 'scope': 'source.shell',
- 'desc': 'Shell script license header'
- },
- 'ts': {
- 'trigger': 'stdlib.license',
- 'scope': 'source.ts',
- 'desc': 'TypeScript license header'
- },
- 'yml': {
- 'trigger': 'stdlib.license',
- 'scope': 'source.yaml',
- 'desc': 'YAML license header'
- },
- 'default': {
- 'trigger': 'stdlib.license',
- 'scope': '',
- 'desc': 'Default license header'
- }
+ awk: {
+ trigger: "stdlib.license",
+ scope: "source.awk",
+ desc: "AWK license header",
+ },
+ c: {
+ trigger: "stdlib.license",
+ scope: "source.c",
+ desc: "C license header",
+ },
+ cpp: {
+ trigger: "stdlib.license",
+ scope: "source.c++",
+ desc: "C++ license header",
+ },
+ css: {
+ trigger: "stdlib.license",
+ scope: "source.css",
+ desc: "CSS license header",
+ },
+ f: {
+ trigger: "stdlib.license",
+ scope: "source.modern-fortran",
+ desc: "Fortran license header (modern)",
+ },
+ gyp: {
+ trigger: "stdlib.license.gyp",
+ scope: "", // gyp
+ desc: "GYP license header",
+ },
+ gypi: {
+ trigger: "stdlib.license.gypi",
+ scope: "", // gyp
+ desc: "GYP include license header",
+ },
+ html: {
+ trigger: "stdlib.license",
+ scope: "text.html",
+ desc: "HTML license header",
+ },
+ ini: {
+ trigger: "stdlib.license.ini",
+ scope: "", // ini
+ desc: "INI license header",
+ },
+ jl: {
+ trigger: "stdlib.license",
+ scope: "source.julia",
+ desc: "Julia license header",
+ },
+ js: {
+ trigger: "stdlib.license",
+ scope: "source.js",
+ desc: "JavaScript license header",
+ },
+ md: {
+ trigger: "stdlib.license",
+ scope: "text.html.markdown",
+ desc: "Markdown license header",
+ },
+ mk: {
+ trigger: "stdlib.license",
+ scope: "source.makefile",
+ desc: "Makefile license header",
+ },
+ py: {
+ trigger: "stdlib.license",
+ scope: "source.python",
+ desc: "Python license header",
+ },
+ r: {
+ trigger: "stdlib.license",
+ scope: "source.r",
+ desc: "R license header",
+ },
+ sh: {
+ trigger: "stdlib.license",
+ scope: "source.shell",
+ desc: "Shell script license header",
+ },
+ ts: {
+ trigger: "stdlib.license",
+ scope: "source.ts",
+ desc: "TypeScript license header",
+ },
+ yml: {
+ trigger: "stdlib.license",
+ scope: "source.yaml",
+ desc: "YAML license header",
+ },
+ default: {
+ trigger: "stdlib.license",
+ scope: "",
+ desc: "Default license header",
+ },
};
// Default header "style":
-var DEFAULT_HEADER_LANG = 'js';
+var DEFAULT_HEADER_LANG = "js";
// File read/write options:
var FOPTS = {
- 'encoding': 'utf8'
+ encoding: "utf8",
};
// Snippet template:
-var TEMPLATE = readFileSync( join( __dirname, 'snippet_template.txt' ), FOPTS );
+var TEMPLATE = readFileSync(join(__dirname, "snippet_template.txt"), FOPTS);
// Output directory:
-var OUT_DIR = resolve( __dirname, '..', 'snippets' );
+var OUT_DIR = resolve(__dirname, "..", "snippets");
// License header options:
var OPTS = {
- 'year': currentYear(),
- 'copyright': 'The Stdlib Authors'
+ year: currentYear(),
+ copyright: "The Stdlib Authors",
};
-
// FUNCTIONS //
/**
-* Returns a license header snippet.
-*
-* @private
-* @param {string} content - snippet content
-* @param {Object} conf - snippet configuration
-* @param {string} conf.trigger - tab trigger
-* @param {string} conf.scope - snippet scope
-* @param {string} conf.desc - snippet description
-* @returns {string} snippet
-*/
-function createSnippet( content, conf ) {
- var snippet = replace( TEMPLATE, '{{SNIPPET}}', content );
- snippet = replace( snippet, '{{TAB_TRIGGER}}', conf.trigger );
- snippet = replace( snippet, '{{SCOPE}}', conf.scope );
- return replace( snippet, '{{DESCRIPTION}}', conf.desc );
+ * Returns a license header snippet.
+ *
+ * @private
+ * @param {string} content - snippet content
+ * @param {Object} conf - snippet configuration
+ * @param {string} conf.trigger - tab trigger
+ * @param {string} conf.scope - snippet scope
+ * @param {string} conf.desc - snippet description
+ * @returns {string} snippet
+ */
+function createSnippet(content, conf) {
+ var snippet = replace(TEMPLATE, "{{SNIPPET}}", content);
+ snippet = replace(snippet, "{{TAB_TRIGGER}}", conf.trigger);
+ snippet = replace(snippet, "{{SCOPE}}", conf.scope);
+ return replace(snippet, "{{DESCRIPTION}}", conf.desc);
}
-
// MAIN //
/**
-* Main execution sequence.
-*
-* @private
-*/
+ * Main execution sequence.
+ *
+ * @private
+ */
function main() {
var snippet;
var header;
@@ -200,39 +197,39 @@ function main() {
var len;
var i;
- keys = objectKeys( LANGS );
+ keys = objectKeys(LANGS);
len = keys.length;
- debug( 'Generating %d license header snippets...', len );
- for ( i = 0; i < len; i++ ) {
- lang = keys[ i ];
+ debug("Generating %d license header snippets...", len);
+ for (i = 0; i < len; i++) {
+ lang = keys[i];
- debug( 'Generating license header for `%s`...', lang );
- if ( lang === 'default' ) {
- header = licenseHeader( SPDX, DEFAULT_HEADER_LANG, OPTS );
+ debug("Generating license header for `%s`...", lang);
+ if (lang === "default") {
+ header = licenseHeader(SPDX, DEFAULT_HEADER_LANG, OPTS);
} else {
- header = licenseHeader( SPDX, lang, OPTS );
+ header = licenseHeader(SPDX, lang, OPTS);
}
- if ( header === null ) {
- debug( 'Failed to generate a license header for `%s`.', lang );
+ if (header === null) {
+ debug("Failed to generate a license header for `%s`.", lang);
continue;
}
- conf = LANGS[ lang ];
+ conf = LANGS[lang];
- debug( 'Generating license header snippet...' );
- snippet = createSnippet( header, conf );
+ debug("Generating license header snippet...");
+ snippet = createSnippet(header, conf);
- debug( 'Writing license header snippet to file...' );
- if ( lang === 'default' ) {
- fpath = join( OUT_DIR, 'stdlib-license.sublime-snippet' );
+ debug("Writing license header snippet to file...");
+ if (lang === "default") {
+ fpath = join(OUT_DIR, "stdlib-license.sublime-snippet");
} else {
- fpath = join( OUT_DIR, 'stdlib-license-'+lang+'.sublime-snippet' );
+ fpath = join(OUT_DIR, "stdlib-license-" + lang + ".sublime-snippet");
}
- writeFileSync( fpath, snippet, FOPTS );
+ writeFileSync(fpath, snippet, FOPTS);
- debug( 'Successfully generated license header snippet.' );
+ debug("Successfully generated license header snippet.");
}
- debug( 'Finished generating snippets.' );
+ debug("Finished generating snippets.");
}
main();
diff --git a/docs/editors/sublime-text/scripts/sublime_completions.js b/docs/editors/sublime-text/scripts/sublime_completions.js
index 9e2887c5867b..976221e8da36 100644
--- a/docs/editors/sublime-text/scripts/sublime_completions.js
+++ b/docs/editors/sublime-text/scripts/sublime_completions.js
@@ -1,49 +1,47 @@
#!/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';
+ * @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 resolve = require( 'path' ).resolve;
-var join = require( 'path' ).join;
-var logger = require( 'debug' );
-var writeFileSync = require( '@stdlib/fs/write-file' ).sync;
-var completions = require( './completions' );
-
+var resolve = require("path").resolve;
+var join = require("path").join;
+var logger = require("debug");
+var writeFileSync = require("@stdlib/fs/write-file").sync;
+var completions = require("./completions");
// VARIABLES //
-var debug = logger( 'sublime-completions' );
+var debug = logger("sublime-completions");
// Output directory:
-var DIR = resolve( __dirname, '..', 'completions' );
-
+var DIR = resolve(__dirname, "..", "completions");
// MAIN //
/**
-* Main execution sequence.
-*
-* @private
-*/
+ * Main execution sequence.
+ *
+ * @private
+ */
function main() {
var fpath;
var fopts;
@@ -53,29 +51,29 @@ function main() {
var i;
fopts = {
- 'encoding': 'utf8'
+ encoding: "utf8",
};
len = completions.length;
- debug( 'Generating %d completions files...', len );
+ debug("Generating %d completions files...", len);
- for ( i = 0; i < len; i++ ) {
- conf = completions[ i ];
+ for (i = 0; i < len; i++) {
+ conf = completions[i];
- debug( 'Generating completions (%s)...', conf.name );
+ debug("Generating completions (%s)...", conf.name);
out = {
- 'scope': conf.scope,
- 'completions': conf.completions
+ scope: conf.scope,
+ completions: conf.completions,
};
- out = JSON.stringify( out, null, '\t' );
+ out = JSON.stringify(out, null, "\t");
- debug( 'Writing completions file...' );
- fpath = join( DIR, 'stdlib-'+conf.name+'.sublime-completions' );
- writeFileSync( fpath, out, fopts );
+ debug("Writing completions file...");
+ fpath = join(DIR, "stdlib-" + conf.name + ".sublime-completions");
+ writeFileSync(fpath, out, fopts);
- debug( 'Successfully generated completions file.' );
+ debug("Successfully generated completions file.");
}
- debug( 'Finished generating completions files.' );
+ debug("Finished generating completions files.");
}
main();
diff --git a/docs/editors/vscode/README.md b/docs/editors/vscode/README.md
index 2be31a9135da..2e51a059babd 100644
--- a/docs/editors/vscode/README.md
+++ b/docs/editors/vscode/README.md
@@ -28,7 +28,7 @@ limitations under the License.
Pre-built binaries are available for download on the Visual Studio Code [homepage][vscode].
-To use [Visual Studio Code][vscode] as a command-line utility, users on MacOS have to run a command to add the [Visual Studio Code][vscode] executable to the `PATH` environment variable (see the official [documentation][vscode-macos-setup]).
+To use [Visual Studio Code][vscode] as a command-line utility, users on MacOS have to run a command to add the [Visual Studio Code][vscode] executable to the `PATH` environment variable (see the official [documentation][vscode-macos-setup]).
To test the command-line utility,
@@ -45,19 +45,19 @@ $ code .
## Extensions
-- [**EditorConfig**][vscode-editorconfig]: extension for using [EditorConfig][editorconfig], which helps define and maintain consistent coding styles between different editors and IDEs.
+- [**EditorConfig**][vscode-editorconfig]: extension for using [EditorConfig][editorconfig], which helps define and maintain consistent coding styles between different editors and IDEs.
-- [**JSON Tools**][vscode-json-tools]: extension for pretty printing and minifying [JSON][json].
+- [**JSON Tools**][vscode-json-tools]: extension for pretty printing and minifying [JSON][json].
-- [**Julia**][vscode-julia]: extension which provides support for [Julia][julia], including syntax highlighting, snippets, and code completion.
+- [**Julia**][vscode-julia]: extension which provides support for [Julia][julia], including syntax highlighting, snippets, and code completion.
-- [**Python**][vscode-python]: extension which provides rich support for [Python][python], including syntax highlighting, snippets, and code completion, among other features.
+- [**Python**][vscode-python]: extension which provides rich support for [Python][python], including syntax highlighting, snippets, and code completion, among other features.
-- [**AWK**][vscode-awk]: extension which provides syntax highlighting for [AWK][awk].
+- [**AWK**][vscode-awk]: extension which provides syntax highlighting for [AWK][awk].
-- [**C/C++**][vscode-cpptools]: official extension providing language support for C/C++ to [Visual Studio Code][vscode]. Features include IntelliSense, debugging, and code browsing.
+- [**C/C++**][vscode-cpptools]: official extension providing language support for C/C++ to [Visual Studio Code][vscode]. Features include IntelliSense, debugging, and code browsing.
-- [**Fortran**][vscode-fortran]: extension which provides syntax highlighting and snippets for [Fortran][fortran]. Once installed, configure [Visual Studio Code][vscode] to always open files having the file extension `*.f` as `Fortran - Modern` in your user or workspace settings.
+- [**Fortran**][vscode-fortran]: extension which provides syntax highlighting and snippets for [Fortran][fortran]. Once installed, configure [Visual Studio Code][vscode] to always open files having the file extension `*.f` as `Fortran - Modern` in your user or workspace settings.
```text
...
@@ -67,9 +67,9 @@ $ code .
...
```
-- [**Code Spell Checker**][vscode-spell-checker]: A simple source code spell checker. See the [official documentation][vscode-spell-checker-readme] for configuration options.
+- [**Code Spell Checker**][vscode-spell-checker]: A simple source code spell checker. See the [official documentation][vscode-spell-checker-readme] for configuration options.
-- [**ESLint**][vscode-eslint]: extension to integrate [eslint][eslint] into [Visual Studio Code][vscode]. Once installed, you need to configure the extension to use the project [ESLint][eslint] configuration files in your workspace settings.
+- [**ESLint**][vscode-eslint]: extension to integrate [eslint][eslint] into [Visual Studio Code][vscode]. Once installed, you need to configure the extension to use the project [ESLint][eslint] configuration files in your workspace settings.
```text
...
@@ -79,11 +79,11 @@ $ code .
...
```
-- [**Path Intellisense**][vscode-path-intellisense]: extension that autocompletes filenames.
+- [**Path Intellisense**][vscode-path-intellisense]: extension that autocompletes filenames.
-- [**Runner**][vscode-runner]: extension allowing one to run various scripts from the editor.
+- [**Runner**][vscode-runner]: extension allowing one to run various scripts from the editor.
-- [**TODO Highlight**][vscode-todo-highlight]: extension which marks annotations such as `TODO`, `FIXME`, etc. Once installed, you may configure the extension to your liking in your user or workspace settings, e.g. by specifying the list of keywords to be highlighted.
+- [**TODO Highlight**][vscode-todo-highlight]: extension which marks annotations such as `TODO`, `FIXME`, etc. Once installed, you may configure the extension to your liking in your user or workspace settings, e.g. by specifying the list of keywords to be highlighted.
```text
...
@@ -113,7 +113,7 @@ $ code .
{
"text": "TODO:",
"color": "darkred",
- "backgroundColor": "rgba(0,0,0,.2)",
+ "backgroundColor": "rgba(0,0,0,.2)",
"isWholeLine": true
},
{
@@ -129,47 +129,26 @@ $ code .
<section class="links">
[vscode]: https://code.visualstudio.com/
-
[vscode-macos-setup]: https://code.visualstudio.com/docs/setup/mac
-
[vscode-eslint]: https://github.com/Microsoft/vscode-eslint
-
[vscode-spell-checker]: https://github.com/Jason-Rev/vscode-spell-checker
-
[vscode-spell-checker-readme]: https://github.com/Jason-Rev/vscode-spell-checker/blob/master/client/README.md
-
[vscode-path-intellisense]: https://github.com/ChristianKohler/PathIntellisense
-
[vscode-todo-highlight]: https://github.com/wayou/vscode-todo-highlight
-
[vscode-editorconfig]: https://github.com/editorconfig/editorconfig-vscode
-
[vscode-json-tools]: https://marketplace.visualstudio.com/items?itemName=eriklynd.json-tools#overview
-
[vscode-python]: https://github.com/Microsoft/vscode-python
-
[vscode-julia]: https://github.com/JuliaEditorSupport/julia-vscode
-
[vscode-awk]: https://github.com/luggage66/vscode-awk
-
[vscode-cpptools]: https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools
-
[vscode-fortran]: https://github.com/Gimly/vscode-fortran
-
[vscode-runner]: https://github.com/mattn/vscode-runner
-
[eslint]: https://eslint.org/
-
[json]: http://www.json.org/
-
[editorconfig]: http://editorconfig.org/
-
[python]: https://www.python.org/
-
[julia]: https://julialang.org/
-
[awk]: https://en.wikipedia.org/wiki/AWK
-
[fortran]: https://en.wikipedia.org/wiki/Fortran
</section>
diff --git a/docs/links/README.md b/docs/links/README.md
index 759c9029dba9..98b50ea510ec 100644
--- a/docs/links/README.md
+++ b/docs/links/README.md
@@ -42,9 +42,9 @@ The database is a [JSON][json] file, where each `key` is a URL specifying the lo
## Notes
-- Before adding a database entry, ensure that the resource is **unique** and not already present in the database.
-- Before assigning an `id` to a URL, ensure that the `id` is **unique**.
-- Ensure that a URL is [**percent-encoded**][percent-encoding].
+- Before adding a database entry, ensure that the resource is **unique** and not already present in the database.
+- Before assigning an `id` to a URL, ensure that the `id` is **unique**.
+- Ensure that a URL is [**percent-encoded**][percent-encoding].
</section>
@@ -53,7 +53,6 @@ The database is a [JSON][json] file, where each `key` is a URL specifying the lo
<section class="links">
[json]: http://www.json.org/
-
[percent-encoding]: https://en.wikipedia.org/wiki/Percent-encoding
</section>
diff --git a/docs/links/database.json b/docs/links/database.json
index 140ce89b3bc6..b03e023e1c41 100644
--- a/docs/links/database.json
+++ b/docs/links/database.json
@@ -3,22 +3,13 @@
"id": "asm",
"description": "Specification of asm.js, a strict subset of JavaScript that can be used as a low-level, efficient target language for compilers.",
"short_url": "",
- "keywords": [
- "asm",
- "asm.js",
- "asmjs",
- "spec",
- "specification"
- ]
+ "keywords": ["asm", "asm.js", "asmjs", "spec", "specification"]
},
"http://blog.izs.me/post/59142742143/designing-apis-for-asynchrony": {
"id": "zalgo",
"description": "Blog post by Isaac Z. Schlueter on designing asynchronous APIs and releasing Zalgo.",
"short_url": "",
- "keywords": [
- "asynchronous",
- "node.js"
- ]
+ "keywords": ["asynchronous", "node.js"]
},
"http://bokeh.pydata.org/en/latest/": {
"id": "bokeh",
@@ -38,11 +29,7 @@
"id": "git-seven-rules",
"description": "Seven rules of a great Git commit message.",
"short_url": "",
- "keywords": [
- "git",
- "commit",
- "message"
- ]
+ "keywords": ["git", "commit", "message"]
},
"http://citationstyles.org/": {
"id": "csl",
@@ -60,25 +47,13 @@
"id": "clang",
"description": "C language family frontend for LLVM.",
"short_url": "",
- "keywords": [
- "clang",
- "llvm",
- "c",
- "c++",
- "c-family",
- "compiler"
- ]
+ "keywords": ["clang", "llvm", "c", "c++", "c-family", "compiler"]
},
"http://cppcheck.sourceforge.net/": {
"id": "cppcheck",
"description": "A static analysis tool for C/C++ code.",
"short_url": "",
- "keywords": [
- "static analysis",
- "lint",
- "linter",
- "c"
- ]
+ "keywords": ["static analysis", "lint", "linter", "c"]
},
"http://creativecommons.org/licenses/by/4.0/": {
"id": "cc-by-4.0",
@@ -98,43 +73,25 @@
"id": "curl",
"description": "Command line tool and library for transferring data with URL syntax.",
"short_url": "",
- "keywords": [
- "curl",
- "http",
- "https",
- "libcurl"
- ]
+ "keywords": ["curl", "http", "https", "libcurl"]
},
"http://dave.cheney.net/2014/06/07/five-things-that-make-go-fast": {
"id": "five-things-that-make-go-fast",
"description": "Dave Cheney's blog post on five things that make Go fast.",
"short_url": "",
- "keywords": [
- "go",
- "golang",
- "performance"
- ]
+ "keywords": ["go", "golang", "performance"]
},
"http://davidcel.is/posts/stop-validating-email-addresses-with-regex/": {
"id": "validate-email-address",
"description": "Blog entry by David Celis arguing that one should not try to validate email addresses via regular expressions.",
"short_url": "",
- "keywords": [
- "regexp",
- "email",
- "validation"
- ]
+ "keywords": ["regexp", "email", "validation"]
},
"http://docs.python-guide.org/en/latest/dev/virtualenvs/": {
"id": "virtualenvs",
"description": "Python Guide on virtual environments.",
"short_url": "",
- "keywords": [
- "python",
- "virtualenv",
- "virtualenvs",
- "virtual environments"
- ]
+ "keywords": ["python", "virtualenv", "virtualenvs", "virtual environments"]
},
"http://dx.doi.org/10.1007/BF02293108": {
"id": "@ahrens:1974",
@@ -320,32 +277,19 @@
"id": "ecma-262-same-value-algorithm",
"description": "ECMAScript 5 specification of the SameValue algorithm.",
"short_url": "",
- "keywords": [
- "equal",
- "same",
- "ecmascript",
- "javascript"
- ]
+ "keywords": ["equal", "same", "ecmascript", "javascript"]
},
"http://editorconfig.org/": {
"id": "editorconfig",
"description": "EditorConfig helps developers define and maintain consistent coding styles between different editors and IDEs. Official website.",
"short_url": "",
- "keywords": [
- "configuration",
- "editor",
- "ide"
- ]
+ "keywords": ["configuration", "editor", "ide"]
},
"http://en.cppreference.com/w/cpp/numeric/math/fdim": {
"id": "fdim",
"description": "C++ reference for the fdim function.",
"short_url": "",
- "keywords": [
- "c++",
- "math",
- "fdim"
- ]
+ "keywords": ["c++", "math", "fdim"]
},
"http://eudml.org/doc/175224": {
"id": "@joehnk:1964",
@@ -365,14 +309,7 @@
"id": "gcc",
"description": "The GNU Compiler Collection.",
"short_url": "",
- "keywords": [
- "compiler",
- "c",
- "c++",
- "c++11",
- "c++14",
- "gnu"
- ]
+ "keywords": ["compiler", "c", "c++", "c++11", "c++14", "gnu"]
},
"http://geojson.org/": {
"id": "geojson",
@@ -392,68 +329,37 @@
"id": "jshint",
"description": "A static code analysis tool for JavaScript.",
"short_url": "",
- "keywords": [
- "jshint",
- "lint",
- "linter",
- "linting",
- "javascript",
- "js"
- ]
+ "keywords": ["jshint", "lint", "linter", "linting", "javascript", "js"]
},
"http://json-schema.org/": {
"id": "json-schema",
"description": "JSON Schema is a vocabulary that allows you to annotate and validate JSON documents.",
"short_url": "",
- "keywords": [
- "json",
- "schema",
- "json-schema",
- "jsonschema"
- ]
+ "keywords": ["json", "schema", "json-schema", "jsonschema"]
},
"http://jupyter.org/": {
"id": "jupyter",
"description": "Official homepage for Jupyter, an open source project whose principal offering is the Jupyter notebook, an open-source web application that allows you to create and share documents that contain live code, equations, visualizations and narrative text.",
"short_url": "",
- "keywords": [
- "jupyter",
- "python"
- ]
+ "keywords": ["jupyter", "python"]
},
"http://kapadia.github.io/emscripten/2013/09/13/emscripten-pointers-and-pointers.html": {
"id": "emscripten-pointers",
"description": "Emscripten pointers and pointers blog post.",
"short_url": "",
- "keywords": [
- "emscripten",
- "pointer",
- "pointers",
- "c",
- "c++"
- ]
+ "keywords": ["emscripten", "pointer", "pointers", "c", "c++"]
},
"http://lea.verou.me/2012/01/why-tabs-are-clearly-superior/": {
"id": "tab-indentation",
"description": "Blog post on why tabs are superior to spaces for indentation.",
"short_url": "",
- "keywords": [
- "tab",
- "indentation",
- "space",
- "spaces"
- ]
+ "keywords": ["tab", "indentation", "space", "spaces"]
},
"http://man7.org/linux/man-pages/man2/chdir.2.html": {
"id": "chdir",
"description": "Documentation for the `chdir` function to change the working directory of the calling process.",
"short_url": "",
- "keywords": [
- "chdir",
- "linux",
- "man",
- "dir"
- ]
+ "keywords": ["chdir", "linux", "man", "dir"]
},
"http://man7.org/linux/man-pages/man2/getegid.2.html": {
"id": "getegid",
@@ -473,60 +379,31 @@
"id": "geteuid",
"description": "Documentation for the function `geteuid` for returning the effective user identity of the calling process.",
"short_url": "",
- "keywords": [
- "man",
- "linux",
- "geteuid",
- "getuid",
- "user",
- "identity"
- ]
+ "keywords": ["man", "linux", "geteuid", "getuid", "user", "identity"]
},
"http://man7.org/linux/man-pages/man2/getgid.2.html": {
"id": "getgid",
"description": "Documentation for the `getgid` function for returning the group identity.",
"short_url": "",
- "keywords": [
- "linux",
- "man",
- "getgid",
- "group",
- "identity"
- ]
+ "keywords": ["linux", "man", "getgid", "group", "identity"]
},
"http://man7.org/linux/man-pages/man2/getuid.2.html": {
"id": "getuid",
"description": "Documentation for the `getuid` function to retrieve a user's identity.",
"short_url": "",
- "keywords": [
- "linux",
- "man",
- "user",
- "id"
- ]
+ "keywords": ["linux", "man", "user", "id"]
},
"http://man7.org/linux/man-pages/man2/umask.2.html": {
"id": "umask",
"description": "Documentation for the `umask` function to set the file creation mode mask.",
"short_url": "",
- "keywords": [
- "linux",
- "man",
- "umask",
- "permissions"
- ]
+ "keywords": ["linux", "man", "umask", "permissions"]
},
"http://man7.org/linux/man-pages/man7/environ.7.html": {
"id": "man-environ",
"description": "Documentation for `environ`, a variable which points to an array of pointers to strings called the \"environment\".",
"short_url": "",
- "keywords": [
- "man",
- "environ",
- "environment",
- "env",
- "user"
- ]
+ "keywords": ["man", "environ", "environment", "env", "user"]
},
"http://mathworld.wolfram.com/Euler-MascheroniConstant.html": {
"id": "eulergamma",
@@ -545,69 +422,37 @@
"id": "hyperbolic-cosine",
"description": "Wolfram MathWorld page on the hyperbolic cosine function.",
"short_url": "",
- "keywords": [
- "hyperbolic",
- "cosine",
- "cosh",
- "math",
- "mathworld"
- ]
+ "keywords": ["hyperbolic", "cosine", "cosh", "math", "mathworld"]
},
"http://mathworld.wolfram.com/HyperbolicSine.html": {
"id": "hyperbolic-sine",
"description": "Wolfram MathWorld page on the hyperbolic sine function.",
"short_url": "",
- "keywords": [
- "hyperbolic",
- "sine",
- "sinh",
- "math",
- "mathworld"
- ]
+ "keywords": ["hyperbolic", "sine", "sinh", "math", "mathworld"]
},
"http://mathworld.wolfram.com/HyperbolicTangent.html": {
"id": "hyperbolic-tangent",
"description": "Wolfram MathWorld page on the hyperbolic tangent function.",
"short_url": "",
- "keywords": [
- "hyperbolic",
- "tangent",
- "tanh",
- "math",
- "mathworld"
- ]
+ "keywords": ["hyperbolic", "tangent", "tanh", "math", "mathworld"]
},
"http://mathworld.wolfram.com/MaclaurinSeries.html": {
"id": "maclaurin-series",
"description": "Wolfram MathWorld page on the Maclaurin series.",
"short_url": "",
- "keywords": [
- "maclaurin",
- "series",
- "math",
- "mathworld"
- ]
+ "keywords": ["maclaurin", "series", "math", "mathworld"]
},
"http://nginx.org/en/docs/": {
"id": "nginx",
"description": "Official documentation for nginx, an HTTP and reverse proxy server, a mail proxy server, and a generic TCP/UDP proxy server.",
"short_url": "",
- "keywords": [
- "nginx",
- "server",
- "proxy"
- ]
+ "keywords": ["nginx", "server", "proxy"]
},
"http://nvie.com/posts/a-successful-git-branching-model/": {
"id": "git-flow",
"description": "A successful Git branching model by Vincent Driessen.",
"short_url": "",
- "keywords": [
- "git",
- "flow",
- "branching",
- "model"
- ]
+ "keywords": ["git", "flow", "branching", "model"]
},
"http://oeis.org/A000027": {
"id": "oeis-a000027",
@@ -639,61 +484,31 @@
"id": "oeis-a000290",
"description": "The OEIS entry for the sequence of squares.",
"short_url": "",
- "keywords": [
- "sequence",
- "seq",
- "squares",
- "integers",
- "numbers"
- ]
+ "keywords": ["sequence", "seq", "squares", "integers", "numbers"]
},
"http://oeis.org/A001622": {
"id": "phi-value",
"description": "The OEIS entry for the sequence of phi values.",
"short_url": "",
- "keywords": [
- "phi",
- "sequence",
- "seq"
- ]
+ "keywords": ["phi", "sequence", "seq"]
},
"http://oeis.org/A005408": {
"id": "oeis-a005408",
"description": "The OEIS entry for the sequence of odd numbers.",
"short_url": "",
- "keywords": [
- "odd",
- "sequence",
- "seq",
- "integers",
- "numbers"
- ]
+ "keywords": ["odd", "sequence", "seq", "integers", "numbers"]
},
"http://oeis.org/A005843": {
"id": "oeis-a005843",
"description": "The OEIS entry for the sequence of nonnegative even integers.",
"short_url": "",
- "keywords": [
- "oeis",
- "sequence",
- "seq",
- "integers",
- "numbers",
- "even"
- ]
+ "keywords": ["oeis", "sequence", "seq", "integers", "numbers", "even"]
},
"http://oeis.org/A299174": {
"id": "oeis-a299174",
"description": "The OEIS entry for the sequence of positive even integers.",
"short_url": "",
- "keywords": [
- "oeis",
- "sequence",
- "integers",
- "seq",
- "positive",
- "numbers"
- ]
+ "keywords": ["oeis", "sequence", "integers", "seq", "positive", "numbers"]
},
"http://onlinelibrary.wiley.com/doi/10.1111/1467-9884.00122/": {
"id": "@joanes:1998",
@@ -713,12 +528,7 @@
"id": "odc-by-1.0",
"description": "Open Data Commons Attribution License.",
"short_url": "",
- "keywords": [
- "licensing",
- "license",
- "opendata",
- "database"
- ]
+ "keywords": ["licensing", "license", "opendata", "database"]
},
"http://opendatacommons.org/licenses/pddl/1.0/": {
"id": "pddl-1.0",
@@ -752,48 +562,25 @@
"id": "scikit-learn",
"description": "Scikit-learn is a Python module for machine learning built on top of SciPy.",
"short_url": "",
- "keywords": [
- "scikit-learn",
- "machine",
- "learning",
- "python",
- "module"
- ]
+ "keywords": ["scikit-learn", "machine", "learning", "python", "module"]
},
"http://semver.org/": {
"id": "semver",
"description": "Semantic Versioning",
"short_url": "",
- "keywords": [
- "semver",
- "versioning",
- "semantic",
- "version"
- ]
+ "keywords": ["semver", "versioning", "semantic", "version"]
},
"http://shiny.rstudio.com/": {
"id": "shiny",
"description": "Shiny is an R package that makes it easy to build interactive web apps straight from R.",
"short_url": "",
- "keywords": [
- "shiny",
- "r",
- "package",
- "interactive",
- "web",
- "app"
- ]
+ "keywords": ["shiny", "r", "package", "interactive", "web", "app"]
},
"http://sideeffect.kr/popularconvention/#javascript": {
"id": "popular-convention",
"description": "Popular conventions in JavaScript.",
"short_url": "",
- "keywords": [
- "javascript",
- "convention",
- "popular",
- "js"
- ]
+ "keywords": ["javascript", "convention", "popular", "js"]
},
"http://spamassassin.apache.org/old/publiccorpus/readme.html": {
"id": "spam-assassin",
@@ -825,15 +612,7 @@
"id": "sed-find-and-replace",
"description": "Stack Overflow question on how to replace a string in multiple files in Linux command line.",
"short_url": "",
- "keywords": [
- "sed",
- "find",
- "replace",
- "string",
- "linux",
- "command",
- "line"
- ]
+ "keywords": ["sed", "find", "replace", "string", "linux", "command", "line"]
},
"http://stackoverflow.com/research/developer-survey-2016": {
"id": "stackoverflow-developer-survey",
@@ -866,88 +645,49 @@
"id": "bash-profile",
"description": "Bash initialization files.",
"short_url": "",
- "keywords": [
- "bash",
- "profile",
- "bashrc",
- "bash_profile"
- ]
+ "keywords": ["bash", "profile", "bashrc", "bash_profile"]
},
"https://jsdoc.app/": {
"id": "jsdoc",
"description": "The official website of JSDoc.",
"short_url": "",
- "keywords": [
- "jsdoc",
- "documentation",
- "docs",
- "javascript"
- ]
+ "keywords": ["jsdoc", "documentation", "docs", "javascript"]
},
"https://jsdoc.app/tags-typedef.html": {
"id": "jsdoc-typedef",
"description": "JSDoc documentation for defining custom types (type definitions).",
"short_url": "",
- "keywords": [
- "jsdoc",
- "documentation",
- "docs",
- "javascript",
- "types"
- ]
+ "keywords": ["jsdoc", "documentation", "docs", "javascript", "types"]
},
"http://wiki.commonjs.org/wiki/CommonJS": {
"id": "commonjs",
"description": "Wiki for the CommonJS specification and working group.",
"short_url": "",
- "keywords": [
- "commonjs",
- "modules",
- "javascript"
- ]
+ "keywords": ["commonjs", "modules", "javascript"]
},
"http://wiki.commonjs.org/wiki/Packages/1.0": {
"id": "commonjs-package-format",
"description": "A specification which describes the CommonJS package format, including package.json, for distributing CommonJS programs and libraries.",
"short_url": "",
- "keywords": [
- "commonjs",
- "package",
- "package.json"
- ]
+ "keywords": ["commonjs", "package", "package.json"]
},
"http://www.2ality.com/2013/05/quirk-array-like-objects.html": {
"id": "array-like",
"description": "Blog post by Dr. Axel Rauschmeyer on array-like objects in JavaScript.",
"short_url": "",
- "keywords": [
- "array",
- "arraylike",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["array", "arraylike", "javascript", "ecmascript"]
},
"http://www.2ality.com/2013/10/safe-integers.html": {
"id": "safe-integers",
"description": "Blog post by Dr. Axel Rauschmeyer on safe integers in JavaScript.",
"short_url": "",
- "keywords": [
- "safe",
- "integer",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["safe", "integer", "javascript", "ecmascript"]
},
"http://www.2ality.com/2015/09/function-names-es6.html": {
"id": "2ality-function-names",
"description": "Blog post by Dr. Axel Rauschmeyer on the name property of a JavaScript function.",
"short_url": "",
- "keywords": [
- "function",
- "property",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["function", "property", "javascript", "ecmascript"]
},
"http://www.bibtex.org/": {
"id": "bibtex",
@@ -980,43 +720,25 @@
"id": "unix-philosophy",
"description": "The Unix Philosophy.",
"short_url": "",
- "keywords": [
- "unix",
- "philosophy",
- "esr",
- "eric",
- "raymond"
- ]
+ "keywords": ["unix", "philosophy", "esr", "eric", "raymond"]
},
"http://www.cs.mtu.edu/~shene/COURSES/cs201/NOTES/F90-Subprograms.pdf": {
"id": "fortran-90-subprograms",
"description": "A PDF document slideshow on subprograms in Fortran 90.",
"short_url": "",
- "keywords": [
- "fortran",
- "subprograms",
- "functions",
- "subroutines"
- ]
+ "keywords": ["fortran", "subprograms", "functions", "subroutines"]
},
"http://www.cs.uic.edu/~liub/FBS/sentiment-analysis.html#lexicon": {
"id": "sentiment-lexicon",
"description": "A list of sentiment lexicons.",
"short_url": "",
- "keywords": [
- "sentiment",
- "lexicon"
- ]
+ "keywords": ["sentiment", "lexicon"]
},
"http://www.ecma-international.org/ecma-262/5.1": {
"id": "ecma-262",
"description": "ECMAScript language specification.",
"short_url": "",
- "keywords": [
- "specification",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["specification", "javascript", "ecmascript"]
},
"https://262.ecma-international.org/5.1/#sec-12.6.4": {
"id": "ecma-262-for-in",
@@ -1072,34 +794,19 @@
"id": "@gould:1965a",
"description": "Gould, H.W. 1965. \"Non-Fibonacci Numbers.\" *Fibonacci Quarterly*, no. 3: 177–83.",
"short_url": "",
- "keywords": [
- "fibonacci",
- "fibo",
- "integers",
- "sequences",
- "number theory"
- ]
+ "keywords": ["fibonacci", "fibo", "integers", "sequences", "number theory"]
},
"http://www.frbsf.org/economic-research/indicators-data/nominal-wage-rigidity/": {
"id": "@frbsf:wagerigidity",
"description": "Federal Reserve Bank of San Francisco Wage Rigidity Meter.",
"short_url": "",
- "keywords": [
- "wage",
- "rigidity",
- "unemployment",
- "labor",
- "economics"
- ]
+ "keywords": ["wage", "rigidity", "unemployment", "labor", "economics"]
},
"http://www.freebsd.org/cgi/man.cgi?fetch%281%29": {
"id": "fetch",
"description": "The FreeBSD manual page for the fetch(1) command.",
"short_url": "",
- "keywords": [
- "fetch",
- "freebsd"
- ]
+ "keywords": ["fetch", "freebsd"]
},
"http://www.getty.edu/about/opencontent.html": {
"id": "getty-open-content",
@@ -1131,126 +838,67 @@
"id": "azari:1929a",
"description": "Azari, Fedele. 1929. \"Airplane, Viewed from Above, Looking Down.\" *Italian*.",
"short_url": "",
- "keywords": [
- "getty",
- "images",
- "publicdomain",
- "opencontent",
- "fairuse"
- ]
+ "keywords": ["getty", "images", "publicdomain", "opencontent", "fairuse"]
},
"http://www.getty.edu/art/collection/objects/141994/peter-henry-emerson-a-march-pastoral-suffolk-british-1888/": {
"id": "@emerson:1888a",
"description": "Emerson, Peter Henry. 1888. \"A March Pastoral, Suffolk.\" *British*.",
"short_url": "",
- "keywords": [
- "getty",
- "images",
- "publicdomain",
- "opencontent",
- "fairuse"
- ]
+ "keywords": ["getty", "images", "publicdomain", "opencontent", "fairuse"]
},
"http://www.getty.edu/art/collection/objects/241797/felice-beato-boats-in-river-nagasaki-british-about-1865/": {
"id": "@beato:1865a",
"description": "Beato, Felice. 1865. \"Boats in River, Nagasaki.\" *British*.",
"short_url": "",
- "keywords": [
- "getty",
- "images",
- "publicdomain",
- "opencontent",
- "fairuse"
- ]
+ "keywords": ["getty", "images", "publicdomain", "opencontent", "fairuse"]
},
"http://www.getty.edu/art/collection/objects/35443/karl-blossfeldt-acanthus-mollis-german-1928/": {
"id": "@blossfeldt:1928a",
"description": "Blossfeldt, Karl. 1928. \"Acanthus mollis.\" *German*.",
"short_url": "",
- "keywords": [
- "getty",
- "images",
- "publicdomain",
- "opencontent",
- "fairuse"
- ]
+ "keywords": ["getty", "images", "publicdomain", "opencontent", "fairuse"]
},
"http://www.getty.edu/art/collection/objects/35448/karl-blossfeldt-allium-ostrowskianum-knoblauchpflanze-german-1928/": {
"id": "@blossfeldt:1928b",
"description": "Blossfeldt, Karl. 1928. \"Allium ostrowskianum, Knoblauchpflanze.\" *German*.",
"short_url": "",
- "keywords": [
- "getty",
- "images",
- "publicdomain",
- "opencontent",
- "fairuse"
- ]
+ "keywords": ["getty", "images", "publicdomain", "opencontent", "fairuse"]
},
"http://www.getty.edu/art/collection/objects/40209/timothy-h-o%27sullivan-black-canon-colorado-river-from-camp-8-looking-above-american-1871/": {
"id": "@osullivan:1871a",
"description": "O'Sullivan, Timothy H. 1871. \"Black Canon, Colorado River, from Camp 8, Looking Above.\" *American*.",
"short_url": "",
- "keywords": [
- "getty",
- "images",
- "publicdomain",
- "opencontent",
- "fairuse"
- ]
+ "keywords": ["getty", "images", "publicdomain", "opencontent", "fairuse"]
},
"http://www.getty.edu/art/collection/objects/40907/eadweard-j-muybridge-animal-locomotion-american-1887/": {
"id": "@muybridge:1887b",
"description": "Muybridge, Eadweard J. 1887. \"Animal Locomotion.\" *American*.",
"short_url": "",
- "keywords": [
- "getty",
- "images",
- "publicdomain",
- "opencontent",
- "fairuse"
- ]
+ "keywords": ["getty", "images", "publicdomain", "opencontent", "fairuse"]
},
"http://www.getty.edu/art/collection/objects/40918/eadweard-j-muybridge-animal-locomotion-american-1887/": {
"id": "muybridge:1887a",
"description": "Muybridge, Eadweard J. 1887. \"Animal Locomotion.\" *American*.",
"short_url": "",
- "keywords": [
- "getty",
- "images",
- "publicdomain",
- "opencontent",
- "fairuse"
- ]
+ "keywords": ["getty", "images", "publicdomain", "opencontent", "fairuse"]
},
"http://www.getty.edu/art/collection/objects/54324/adolphe-braun-alpine-landscape-french-1865-1870/": {
"id": "@braun:1870a",
"description": "Braun, Adolphe. 1870. \"Alpine Landscape.\" *French*.",
"short_url": "",
- "keywords": [
- "getty",
- "images",
- "publicdomain",
- "opencontent",
- "fairuse"
- ]
+ "keywords": ["getty", "images", "publicdomain", "opencontent", "fairuse"]
},
"http://www.gnu.org/software/wget": {
"id": "wget",
"description": "GNU Wget homepage.",
"short_url": "",
- "keywords": [
- "wget",
- "gnu"
- ]
+ "keywords": ["wget", "gnu"]
},
"http://www.json.org/": {
"id": "json",
"description": "The official JSON website.",
"short_url": "",
- "keywords": [
- "json"
- ]
+ "keywords": ["json"]
},
"http://www.jstor.org/stable/747086": {
"id": "@klare:1974a",
@@ -1270,127 +918,73 @@
"id": "module-counts",
"description": "A website that tracks the number of modules in the npm registry and other package managers.",
"short_url": "",
- "keywords": [
- "npm",
- "modules",
- "package",
- "managers",
- "registry"
- ]
+ "keywords": ["npm", "modules", "package", "managers", "registry"]
},
"http://www.moshier.net/#Cephes": {
"id": "cephes",
"description": "Moshier's website which provides Cephes distributions.",
"short_url": "",
- "keywords": [
- "cephes",
- "math"
- ]
+ "keywords": ["cephes", "math"]
},
"http://www.netlib.org/blas": {
"id": "blas",
"description": "The Basic Linear Algebra Subprograms (BLAS) website.",
"short_url": "",
- "keywords": [
- "blas",
- "math"
- ]
+ "keywords": ["blas", "math"]
},
"http://www.netlib.org/lapack/explore-html/da/df6/group__complex__blas__level1.html": {
"id": "ccopy",
"description": "The BLAS ccopy function in the LAPACK documentation.",
"short_url": "",
- "keywords": [
- "blas",
- "math"
- ]
+ "keywords": ["blas", "math"]
},
"http://www.netlib.org/lapack/explore-html/de/da4/group__double__blas__level1.html": {
"id": "dasum",
"description": "The BLAS dasum function in the LAPACK documentation.",
"short_url": "",
- "keywords": [
- "blas",
- "math"
- ]
+ "keywords": ["blas", "math"]
},
"http://www.netlib.org/lapack/explore-html/df/d28/group__single__blas__level1.html": {
"id": "snrm2",
"description": "The BLAS snrm2 function in the LAPACK documentation.",
"short_url": "",
- "keywords": [
- "blas",
- "math"
- ]
+ "keywords": ["blas", "math"]
},
"http://www.pcg-random.org/other-rngs.html": {
"id": "pcg",
"description": "PCG Random Number Generation for C.",
"short_url": "",
- "keywords": [
- "pcg",
- "random",
- "number",
- "generation"
- ]
+ "keywords": ["pcg", "random", "number", "generation"]
},
"http://www.sitepoint.com/jquery-vs-raw-javascript-1-dom-forms/": {
"id": "native-dom-equivalents",
"description": "A comparison of native DOM methods and jQuery equivalents.",
"short_url": "",
- "keywords": [
- "jquery",
- "dom",
- "native",
- "javascript"
- ]
+ "keywords": ["jquery", "dom", "native", "javascript"]
},
"http://www.speech.cs.cmu.edu/cgi-bin/cmudict#about": {
"id": "cmudict",
"description": "Website for the Carnegie Mellon Pronouncing Dictionary.",
"short_url": "",
- "keywords": [
- "dataset",
- "data",
- "dictionary",
- "nlp",
- "speech"
- ]
+ "keywords": ["dataset", "data", "dictionary", "nlp", "speech"]
},
"http://www.uncg.edu/cmp/downloads/lwsndr.html": {
"id": "suthaharan-multi-hop-sensor-network-data",
"description": "Multi-hop sensor network data from Suthaharan et al. 2006.",
"short_url": "",
- "keywords": [
- "dataset",
- "data",
- "sensor",
- "network",
- "multi-hop"
- ]
+ "keywords": ["dataset", "data", "sensor", "network", "multi-hop"]
},
"http://www.unicode.org/reports/tr29/": {
"id": "unicode-text-segmentation",
"description": "Unicode Standard Annex for Unicode text segmentation.",
"short_url": "",
- "keywords": [
- "unicode",
- "standard",
- "text",
- "segmentation",
- "nlp"
- ]
+ "keywords": ["unicode", "standard", "text", "segmentation", "nlp"]
},
"https://www.yaml.org/": {
"id": "yaml",
"description": "Human friendly data serialization standard.",
"short_url": "",
- "keywords": [
- "markup",
- "serialization",
- "configuration",
- "config"
- ]
+ "keywords": ["markup", "serialization", "configuration", "config"]
},
"http://www2.imm.dtu.dk/pubdb/views/publication_details.php?id=6010": {
"id": "afinn",
@@ -1409,13 +1003,7 @@
"id": "@farhi:2011a",
"description": "Farhi, Bakir. 2011. \"An explicit formula generating the non-Fibonacci numbers.\" *arXiv \\[Math.NT\\]* abs/1105.1127 (May): 1-5.",
"short_url": "",
- "keywords": [
- "fibonacci",
- "fibo",
- "number theory",
- "integers",
- "sequences"
- ]
+ "keywords": ["fibonacci", "fibo", "number theory", "integers", "sequences"]
},
"https://arxiv.org/abs/1210.4539": {
"id": "@baudin:2012",
@@ -1433,30 +1021,19 @@
"id": "javascript-ubiquity",
"description": "Blog post by Jeff Atwood on the ubiquity of JavaScript.",
"short_url": "",
- "keywords": [
- "javascript",
- "ubiquity"
- ]
+ "keywords": ["javascript", "ubiquity"]
},
"https://blog.izs.me/2012/08/policy-on-trolling": {
"id": "nodejs-irc",
"description": "Node.js IRC channel policy on trolling.",
"short_url": "",
- "keywords": [
- "nodejs",
- "irc",
- "trolling"
- ]
+ "keywords": ["nodejs", "irc", "trolling"]
},
"https://books.google.com/books?id=2nbuAAAAMAAJ": {
"id": "@chall:1995a",
"description": "Challe, J. S. and Dale, E. 1995. Readability Revisited: The New Dale-Chall Readability Formula.",
"short_url": "",
- "keywords": [
- "readability",
- "formula",
- "dale-chall"
- ]
+ "keywords": ["readability", "formula", "dale-chall"]
},
"https://books.google.com/books?id=vC7I_gdX-A0C": {
"id": "@herzog:2002",
@@ -1475,14 +1052,7 @@
"id": "homebrew",
"description": "Package manager for MacOS.",
"short_url": "",
- "keywords": [
- "mac",
- "os x",
- "osx",
- "macintosh",
- "pkg",
- "package manager"
- ]
+ "keywords": ["mac", "os x", "osx", "macintosh", "pkg", "package manager"]
},
"https://bugs.chromium.org/p/chromium/issues/detail?id=246054": {
"id": "@bug:chromium:246054",
@@ -1501,153 +1071,79 @@
"id": "@bug:chromium:320097",
"description": "Chromium bug report concerning change of results of trigonometric functions.",
"short_url": "",
- "keywords": [
- "bug",
- "chromium",
- "trigonometric",
- "function",
- "result"
- ]
+ "keywords": ["bug", "chromium", "trigonometric", "function", "result"]
},
"https://bugs.chromium.org/p/v8/issues/detail?id=1101": {
"id": "@bug:v8:1101",
"description": "V8 bug report about NaN being converted to 0xfff8000000000000",
"short_url": "",
- "keywords": [
- "bug",
- "v8",
- "nan"
- ]
+ "keywords": ["bug", "v8", "nan"]
},
"https://bugs.chromium.org/p/v8/issues/detail?id=1975": {
"id": "@bug:v8:1975",
"description": "V8 bug report about the precision of trigonometric functions being low.",
"short_url": "",
- "keywords": [
- "bug",
- "v8",
- "trigonometric",
- "function",
- "precision"
- ]
+ "keywords": ["bug", "v8", "trigonometric", "function", "precision"]
},
"https://bugs.chromium.org/p/v8/issues/detail?id=2890": {
"id": "@bug:v8:2890",
"description": "V8 bug report about deeopt loops involving Math.round / Math.floor.",
"short_url": "",
- "keywords": [
- "bug",
- "v8",
- "loop",
- "math",
- "round",
- "floor"
- ]
+ "keywords": ["bug", "v8", "loop", "math", "round", "floor"]
},
"https://bugs.chromium.org/p/v8/issues/detail?id=3006": {
"id": "@bug:v8:3006",
"description": "V8 bug report about inaccurate sin/cos values.",
"short_url": "",
- "keywords": [
- "bug",
- "v8",
- "sin",
- "cos",
- "inaccurate"
- ]
+ "keywords": ["bug", "v8", "sin", "cos", "inaccurate"]
},
"https://bugs.chromium.org/p/v8/issues/detail?id=3089": {
"id": "@bug:v8:3089",
"description": "V8 bug report about Math.sin(-x) not being equal to -Math.sin(x).",
"short_url": "",
- "keywords": [
- "bug",
- "v8",
- "math",
- "sin",
- "equal"
- ]
+ "keywords": ["bug", "v8", "math", "sin", "equal"]
},
"https://bugs.chromium.org/p/v8/issues/detail?id=3266": {
"id": "@bug:v8:3266",
"description": "V8 bug report about numeric issues in hyperbolic functions.",
"short_url": "",
- "keywords": [
- "bug",
- "v8",
- "hyperbolic",
- "function",
- "numeric"
- ]
+ "keywords": ["bug", "v8", "hyperbolic", "function", "numeric"]
},
"https://bugs.chromium.org/p/v8/issues/detail?id=3468": {
"id": "@bug:v8:3468",
"description": "V8 bug report about Math.exp(100) being inaccurate.",
"short_url": "",
- "keywords": [
- "bug",
- "v8",
- "math",
- "exp",
- "inaccurate"
- ]
+ "keywords": ["bug", "v8", "math", "exp", "inaccurate"]
},
"https://bugs.chromium.org/p/v8/issues/detail?id=3496": {
"id": "@bug:v8:3496",
"description": "V8 bug report about Math.asinh issues.",
"short_url": "",
- "keywords": [
- "bug",
- "v8",
- "math",
- "asinh"
- ]
+ "keywords": ["bug", "v8", "math", "asinh"]
},
"https://bugs.chromium.org/p/v8/issues/detail?id=3509": {
"id": "@bug:v8:3509",
"description": "V8 bug report about Math.acosh issues.",
"short_url": "",
- "keywords": [
- "bug",
- "v8",
- "math",
- "acosh"
- ]
+ "keywords": ["bug", "v8", "math", "acosh"]
},
"https://bugs.chromium.org/p/v8/issues/detail?id=3511": {
"id": "@bug:v8:3511",
"description": "V8 bug report about Math.atanh issues.",
"short_url": "",
- "keywords": [
- "bug",
- "v8",
- "math",
- "atanh"
- ]
+ "keywords": ["bug", "v8", "math", "atanh"]
},
"https://bugs.chromium.org/p/v8/issues/detail?id=3599": {
"id": "@bug:v8:3599",
"description": "V8 bug report about Math.pow(10,308) being inaccurate.",
"short_url": "",
- "keywords": [
- "bug",
- "v8",
- "math",
- "pow",
- "inaccurate"
- ]
+ "keywords": ["bug", "v8", "math", "pow", "inaccurate"]
},
"https://bugs.chromium.org/p/v8/issues/detail?id=4059": {
"id": "@bug:v8:4059",
"description": "V8 bug report about Math.ceil(0) deopt loops.",
"short_url": "",
- "keywords": [
- "bug",
- "v8",
- "math",
- "ceil",
- "loop"
- ]
+ "keywords": ["bug", "v8", "math", "ceil", "loop"]
},
"https://bugs.chromium.org/p/v8/issues/detail?id=436": {
"id": "@bug:v8:436",
@@ -1668,212 +1164,109 @@
"id": "@bug:v8:4566",
"description": "V8 bug report about replacement of MWC1616 used in PRNG Math.random().",
"short_url": "",
- "keywords": [
- "bug",
- "v8",
- "math",
- "random",
- "prng",
- "mwc1616"
- ]
+ "keywords": ["bug", "v8", "math", "random", "prng", "mwc1616"]
},
"https://bugs.chromium.org/p/v8/issues/detail?id=5086": {
"id": "@bug:v8:5086",
"description": "V8 bug report about unifying the implementation of the various Math builtins.",
"short_url": "",
- "keywords": [
- "bug",
- "v8",
- "math",
- "builtin"
- ]
+ "keywords": ["bug", "v8", "math", "builtin"]
},
"https://bugs.chromium.org/p/v8/issues/detail?id=5157": {
"id": "@bug:v8:5157",
"description": "V8 bug report about unifying the implementation of the implementation of Math.pow.",
"short_url": "",
- "keywords": [
- "bug",
- "v8",
- "math",
- "pow"
- ]
+ "keywords": ["bug", "v8", "math", "pow"]
},
"https://bugs.chromium.org/p/v8/issues/detail?id=958": {
"id": "@bug:v8:958",
"description": "V8 bug report about Math.round rounding incorrectly.",
"short_url": "",
- "keywords": [
- "bug",
- "v8",
- "math",
- "round",
- "incorrect"
- ]
+ "keywords": ["bug", "v8", "math", "round", "incorrect"]
},
"https://bugs.chromium.org/p/v8/issues/list?can=1&q=math&colspec=ID%20Type%20Status%20Priority%20Owner%20Summary%20HW%20OS%20Component%20Stars&num=100&start=100": {
"id": "v8-issue-tracker",
"description": "V8 issue tracker",
"short_url": "",
- "keywords": [
- "bug",
- "v8",
- "issue",
- "tracker"
- ]
+ "keywords": ["bug", "v8", "issue", "tracker"]
},
"https://bugs.webkit.org/buglist.cgi?quicksearch=math": {
"id": "webkit-issue-tracker",
"description": "Webkit issue tracker",
"short_url": "",
- "keywords": [
- "bug",
- "webkit",
- "issue",
- "tracker"
- ]
+ "keywords": ["bug", "webkit", "issue", "tracker"]
},
"https://bugs.webkit.org/show_bug.cgi?id=151641": {
"id": "@bug:webkit:151641",
"description": "Webkit bug report about better RNG for Math.random().",
"short_url": "",
- "keywords": [
- "bug",
- "webkit",
- "math",
- "random",
- "rng"
- ]
+ "keywords": ["bug", "webkit", "math", "random", "rng"]
},
"https://bugs.webkit.org/show_bug.cgi?id=26972": {
"id": "@bug:webkit:26972",
"description": "Webkit bug report about predictable random number generators.",
"short_url": "",
- "keywords": [
- "bug",
- "webkit",
- "random",
- "predictable",
- "generator"
- ]
+ "keywords": ["bug", "webkit", "random", "predictable", "generator"]
},
"https://bugs.webkit.org/show_bug.cgi?id=36673": {
"id": "@bug:webkit:36673",
"description": "Webkit bug report about Math.random repeating values in different workers.",
"short_url": "",
- "keywords": [
- "bug",
- "webkit",
- "math",
- "random",
- "worker"
- ]
+ "keywords": ["bug", "webkit", "math", "random", "worker"]
},
"https://bugs.webkit.org/show_bug.cgi?id=40367": {
"id": "@bug:webkit:40367",
"description": "Webkit bug report about a bug under 32-bit mode.",
"short_url": "",
- "keywords": [
- "bug",
- "webkit",
- "32-bit"
- ]
+ "keywords": ["bug", "webkit", "32-bit"]
},
"https://bugs.webkit.org/show_bug.cgi?id=7726": {
"id": "webkit-bug-7726",
"description": "Webkit bug report related to the naming of anonymous functions.",
"short_url": "",
- "keywords": [
- "function",
- "bug",
- "webkit",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["function", "bug", "webkit", "javascript", "ecmascript"]
},
"https://bugzilla.mozilla.org/buglist.cgi?quicksearch=math": {
"id": "mozilla-issue-tracker",
"description": "Mozilla issue tracker.",
"short_url": "",
- "keywords": [
- "mozilla",
- "bug",
- "issue",
- "tracker"
- ]
+ "keywords": ["mozilla", "bug", "issue", "tracker"]
},
"https://bugzilla.mozilla.org/show_bug.cgi?id=1316557": {
"id": "@bug:mozilla:1316557",
"description": "Mozilla bug report related to Math.pow sometimes returning incorrect results.",
"short_url": "",
- "keywords": [
- "bug",
- "mozilla",
- "math",
- "pow",
- "power",
- "exponentiation"
- ]
+ "keywords": ["bug", "mozilla", "math", "pow", "power", "exponentiation"]
},
"https://bugzilla.mozilla.org/show_bug.cgi?id=322529": {
"id": "@bug:mozilla:322529",
"description": "Mozilla issue related to upgrading Math.random to use the better XorShift128+ algorithm.",
"short_url": "",
- "keywords": [
- "bug",
- "mozilla",
- "math",
- "random",
- "xorshift"
- ]
+ "keywords": ["bug", "mozilla", "math", "random", "xorshift"]
},
"https://bugzilla.mozilla.org/show_bug.cgi?id=618251": {
"id": "@bug:mozilla:618251",
"description": "Mozilla bug report related to Math.pow accumulating error.",
"short_url": "",
- "keywords": [
- "bug",
- "mozilla",
- "math",
- "pow",
- "power",
- "exponentiation"
- ]
+ "keywords": ["bug", "mozilla", "math", "pow", "power", "exponentiation"]
},
"https://bugzilla.mozilla.org/show_bug.cgi?id=681357": {
"id": "@bug:mozilla:681357",
"description": "Mozilla bug report related to making fast math functions accessible.",
"short_url": "",
- "keywords": [
- "bug",
- "mozilla",
- "math",
- "fast"
- ]
+ "keywords": ["bug", "mozilla", "math", "fast"]
},
"https://bugzilla.mozilla.org/show_bug.cgi?id=686708": {
"id": "@bug:mozilla:686708",
"description": "Mozilla bug report about Math.round() not handling -0 and -0.5 properly.",
"short_url": "",
- "keywords": [
- "bug",
- "mozilla",
- "math",
- "round"
- ]
+ "keywords": ["bug", "mozilla", "math", "round"]
},
"https://bugzilla.mozilla.org/show_bug.cgi?id=703611": {
"id": "@bug:mozilla:703611",
"description": "Mozilla bug report about Math.pow(-Infinity, even int < 0) not producimh the correct value.",
"short_url": "",
- "keywords": [
- "bug",
- "mozilla",
- "math",
- "pow",
- "power",
- "exponentiation"
- ]
+ "keywords": ["bug", "mozilla", "math", "pow", "power", "exponentiation"]
},
"https://bugzilla.mozilla.org/show_bug.cgi?id=717379#c5": {
"id": "@bug:mozilla:717379",
@@ -1885,81 +1278,43 @@
"id": "@bug:mozilla:892671",
"description": "Mozilla bug report about specifying the tolerance in each new ES6 Math test.",
"short_url": "",
- "keywords": [
- "bug",
- "mozilla",
- "math",
- "es6"
- ]
+ "keywords": ["bug", "mozilla", "math", "es6"]
},
"https://bugzilla.mozilla.org/show_bug.cgi?id=897634": {
"id": "@bug:mozilla:897634",
"description": "Mozilla bug report about Math.expm1 when !HAVE_EXPM1.",
"short_url": "",
- "keywords": [
- "bug",
- "mozilla",
- "math",
- "expm1"
- ]
+ "keywords": ["bug", "mozilla", "math", "expm1"]
},
"https://bugzilla.mozilla.org/show_bug.cgi?id=933257": {
"id": "@bug:mozilla:933257",
"description": "Mozilla bug report about precision in new Math functions.",
"short_url": "",
- "keywords": [
- "bug",
- "mozilla",
- "math",
- "precision"
- ]
+ "keywords": ["bug", "mozilla", "math", "precision"]
},
"https://bugzilla.mozilla.org/show_bug.cgi?id=948321": {
"id": "@bug:mozilla:948321",
"description": "Mozilla bug report about different division results on x86 platforms.",
"short_url": "",
- "keywords": [
- "bug",
- "mozilla",
- "math",
- "division"
- ]
+ "keywords": ["bug", "mozilla", "math", "division"]
},
"https://bugzilla.mozilla.org/show_bug.cgi?id=967709": {
"id": "@bug:mozilla:967709",
"description": "Mozilla bug report about V8 being 2.8x faster at sin/cos.",
"short_url": "",
- "keywords": [
- "bug",
- "mozilla",
- "math",
- "sin",
- "cos",
- "v8",
- "performance"
- ]
+ "keywords": ["bug", "mozilla", "math", "sin", "cos", "v8", "performance"]
},
"https://bugzilla.mozilla.org/show_bug.cgi?id=969203#c8": {
"id": "@bug:mozilla:969203",
"description": "Mozilla bug comment about Math function optimizations.",
"short_url": "",
- "keywords": [
- "bug",
- "mozilla",
- "math",
- "optimization"
- ]
+ "keywords": ["bug", "mozilla", "math", "optimization"]
},
"https://chrome.google.com/webstore/detail/github-editorconfig/bppnolhdpdfmmpeefopdbpmabdpoefjh?hl=en-US": {
"id": "editorconfig-chrome",
"description": "Chrome extension for EditorConfig for GitHub.",
"short_url": "",
- "keywords": [
- "chrome",
- "extension",
- "editorconfig",
- "github"
- ]
+ "keywords": ["chrome", "extension", "editorconfig", "github"]
},
"https://circleci.com/": {
"id": "circleci",
@@ -1979,68 +1334,37 @@
"id": "cmake",
"description": "Cross-platform build system.",
"short_url": "",
- "keywords": [
- "build",
- "system",
- "cmake",
- "cross-platform"
- ]
+ "keywords": ["build", "system", "cmake", "cross-platform"]
},
"https://code.visualstudio.com/": {
"id": "vscode",
"description": "A cross-platform open-source code editor from Microsoft.",
"short_url": "",
- "keywords": [
- "editor",
- "microsoft",
- "code",
- "open",
- "source"
- ]
+ "keywords": ["editor", "microsoft", "code", "open", "source"]
},
"https://code.visualstudio.com/docs/setup/mac": {
"id": "vscode-macos-setup",
"description": "Visual Studio Code setup instructions for MacOS.",
"short_url": "",
- "keywords": [
- "vscode",
- "macos",
- "mac",
- "setup",
- "editor"
- ]
+ "keywords": ["vscode", "macos", "mac", "setup", "editor"]
},
"https://codecov.io/": {
"id": "codecov",
"description": "A hosted code coverage service.",
"short_url": "",
- "keywords": [
- "codecov",
- "coverage",
- "unit testing"
- ]
+ "keywords": ["codecov", "coverage", "unit testing"]
},
"https://codecov.io/github/stdlib-js/stdlib/branch/develop": {
"id": "stdlib-code-coverage",
"description": "Code coverage for the stdlib JavaScript library.",
"short_url": "",
- "keywords": [
- "stdlib",
- "javascript",
- "library",
- "coverage",
- "unit testing"
- ]
+ "keywords": ["stdlib", "javascript", "library", "coverage", "unit testing"]
},
"https://coveralls.io/": {
"id": "coveralls",
"description": "A hosted code coverage service.",
"short_url": "",
- "keywords": [
- "coveralls",
- "coverage",
- "unit testing"
- ]
+ "keywords": ["coveralls", "coverage", "unit testing"]
},
"https://creativecommons.org/licenses/by-sa/4.0/": {
"id": "cc-by-sa-4.0",
@@ -2061,12 +1385,7 @@
"id": "cc0",
"description": "Creative commons public domain dedication (CC0 1.0 Universal license).",
"short_url": "",
- "keywords": [
- "license",
- "public",
- "domain",
- "cc0"
- ]
+ "keywords": ["license", "public", "domain", "cc0"]
},
"https://curiosity.lib.harvard.edu/contagion/catalog/36-990101646750203941": {
"id": "@nightingale:1859a",
@@ -2088,335 +1407,181 @@
"id": "difference-url-uri",
"description": "Blog post on the difference between URIs and URLs.",
"short_url": "",
- "keywords": [
- "url",
- "uri",
- "identifier",
- "access",
- "protocol"
- ]
+ "keywords": ["url", "uri", "identifier", "access", "protocol"]
},
"https://datatracker.ietf.org/doc/html/rfc5988": {
"id": "rfc-5988",
"description": "An RFC describing web links.",
"short_url": "",
- "keywords": [
- "web links",
- "linking",
- "link header"
- ]
+ "keywords": ["web links", "linking", "link header"]
},
"https://developer.github.com/guides/traversing-with-pagination/": {
"id": "github-pagination",
"description": "GitHub documentation for pagination.",
"short_url": "",
- "keywords": [
- "github",
- "api",
- "paginate",
- "pagination"
- ]
+ "keywords": ["github", "api", "paginate", "pagination"]
},
"https://developer.github.com/v3/": {
"id": "github-api",
"description": "Documentation for the GitHub API.",
"short_url": "",
- "keywords": [
- "github",
- "api"
- ]
+ "keywords": ["github", "api"]
},
"https://developer.github.com/v3/#oauth2-token-sent-in-a-header": {
"id": "github-oauth2",
"description": "GitHub documentation for OAuth2 header token.",
"short_url": "",
- "keywords": [
- "github",
- "api",
- "oauth2",
- "oauth",
- "token",
- "header"
- ]
+ "keywords": ["github", "api", "oauth2", "oauth", "token", "header"]
},
"https://developer.github.com/v3/#user-agent-required": {
"id": "github-user-agent",
"description": "GitHub documentation for user agent header.",
"short_url": "",
- "keywords": [
- "github",
- "api",
- "useragent"
- ]
+ "keywords": ["github", "api", "useragent"]
},
"https://developer.github.com/v3/activity/starring/#star-a-repository": {
"id": "github-star-repo",
"description": "GitHub documentation for starring a repository.",
"short_url": "",
- "keywords": [
- "github",
- "api",
- "star",
- "starring",
- "repository"
- ]
+ "keywords": ["github", "api", "star", "starring", "repository"]
},
"https://developer.github.com/v3/activity/watching/": {
"id": "github-watching",
"description": "GitHub documentation for watching a repository.",
"short_url": "",
- "keywords": [
- "github",
- "api",
- "watch",
- "watching",
- "repository"
- ]
+ "keywords": ["github", "api", "watch", "watching", "repository"]
},
"https://developer.github.com/v3/issues/#create-an-issue": {
"id": "github-create-issue",
"description": "GitHub documentation for creating an issue.",
"short_url": "",
- "keywords": [
- "github",
- "api",
- "issue",
- "create"
- ]
+ "keywords": ["github", "api", "issue", "create"]
},
- "https://developer.github.com/v3/media/": {
- "id": "github-media",
- "description": "GitHub documentation for media types.",
- "short_url": "",
- "keywords": [
- "github",
- "api",
- "media"
- ]
+ "https://developer.github.com/v3/media/": {
+ "id": "github-media",
+ "description": "GitHub documentation for media types.",
+ "short_url": "",
+ "keywords": ["github", "api", "media"]
},
"https://developer.github.com/v3/oauth/#scopes": {
"id": "github-scopes",
"description": "GitHub documentation for OAuth scopes.",
"short_url": "",
- "keywords": [
- "github",
- "api",
- "oauth",
- "scope"
- ]
+ "keywords": ["github", "api", "oauth", "scope"]
},
"https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization": {
"id": "github-create-token",
"description": "GitHub documentation for creating an OAuth token.",
"short_url": "",
- "keywords": [
- "github",
- "api",
- "oauth",
- "token",
- "create"
- ]
+ "keywords": ["github", "api", "oauth", "token", "create"]
},
"https://developer.github.com/v3/oauth_authorizations/#delete-an-authorization": {
"id": "github-delete-token",
"description": "GitHub documentation for deleting an OAuth token.",
"short_url": "",
- "keywords": [
- "github",
- "api",
- "oauth",
- "token",
- "delete"
- ]
+ "keywords": ["github", "api", "oauth", "token", "delete"]
},
"https://developer.github.com/v3/orgs/#organizations": {
"id": "github-user-orgs",
"description": "GitHub documentation for managing user organizations.",
"short_url": "",
- "keywords": [
- "github",
- "api",
- "user",
- "organization",
- "org"
- ]
+ "keywords": ["github", "api", "user", "organization", "org"]
},
"https://developer.github.com/v3/rate_limit/": {
"id": "github-rate-limit",
"description": "GitHub documentation for rate limits.",
"short_url": "",
- "keywords": [
- "github",
- "api",
- "rate limit"
- ]
+ "keywords": ["github", "api", "rate limit"]
},
"https://developer.github.com/v3/repos/": {
"id": "github-repos",
"description": "GitHub documentation for repositories.",
"short_url": "",
- "keywords": [
- "github",
- "api",
- "repository",
- "repo"
- ]
+ "keywords": ["github", "api", "repository", "repo"]
},
"https://developer.github.com/v3/repos/#list-organization-repositories": {
"id": "github-org-repos",
"description": "GitHub documentation for listing organization repositories.",
"short_url": "",
- "keywords": [
- "github",
- "api",
- "repository",
- "repo",
- "organization",
- "org"
- ]
+ "keywords": ["github", "api", "repository", "repo", "organization", "org"]
},
"https://developer.github.com/v3/users/followers/": {
"id": "github-followers",
"description": "GitHub documentation for followers.",
"short_url": "",
- "keywords": [
- "github",
- "api",
- "followers"
- ]
+ "keywords": ["github", "api", "followers"]
},
"https://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Generator": {
"id": "mdn-generator-object",
"description": "Mozilla Developer Network (MDN) documentation for ECMAScript 2015 generator objects.",
"short_url": "",
- "keywords": [
- "generator",
- "object",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["generator", "object", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API": {
"id": "canvas",
"description": "Mozilla Developer Network (MDN) documentation for the HTML5 Canvas API.",
"short_url": "",
- "keywords": [
- "canvas",
- "html5",
- "api"
- ]
+ "keywords": ["canvas", "html5", "api"]
},
"https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model": {
"id": "dom",
"description": "Mozilla Developer Network (MDN) documentation for the Document Object Model (DOM).",
"short_url": "",
- "keywords": [
- "dom",
- "document",
- "object",
- "model"
- ]
+ "keywords": ["dom", "document", "object", "model"]
},
"https://developer.mozilla.org/en-US/docs/Web/API/NavigatorConcurrentHardware/hardwareConcurrency": {
"id": "hardware-concurrency",
"description": "Mozilla Developer Network (MDN) documentation for the hardware concurrency API to retrieve the number of logical processors on the computer.",
"short_url": "",
- "keywords": [
- "api",
- "browser",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["api", "browser", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/API/Performance/now": {
"id": "performance-now",
"description": "Mozilla Developer Network (MDN) documentation for the performance.now() API to retrieve the number of milliseconds since the current document was loaded.",
"short_url": "",
- "keywords": [
- "api",
- "browser",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["api", "browser", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/API/Transferable": {
"id": "mdn-transferable-objects",
"description": "Mozilla Developer Network (MDN) documentation for ECMAScript 2015 transferable objects.",
"short_url": "",
- "keywords": [
- "transferable",
- "object",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["transferable", "object", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API": {
"id": "webgl",
"description": "Mozilla Developer Network (MDN) documentation for WebGL.",
"short_url": "",
- "keywords": [
- "webgl",
- "api"
- ]
+ "keywords": ["webgl", "api"]
},
"https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API": {
"id": "mdn-web-workers-api",
"description": "Mozilla Developer Network (MDN) documentation on the Web Workers API.",
"short_url": "",
- "keywords": [
- "webworker",
- "worker",
- "api",
- "browser",
- "application",
- "web"
- ]
+ "keywords": ["webworker", "worker", "api", "browser", "application", "web"]
},
"https://developer.mozilla.org/en-US/docs/Web/API/Window/open": {
"id": "window-open",
"description": "Mozilla Developer Network (MDN) documentation for the Window.open() function.",
"short_url": "",
- "keywords": [
- "browser",
- "dom",
- "api",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["browser", "dom", "api", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/API/Worker/Worker": {
"id": "mdn-web-workers",
"description": "Mozilla Developer Network (MDN) documentation for ECMAScript 2015 web workers.",
"short_url": "",
- "keywords": [
- "webworker",
- "worker",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["webworker", "worker", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/HTTP/Browser_detection_using_the_user_agent#mobile_tablet_or_desktop": {
"id": "mdn-mobile",
"description": "Mozilla Developer Network (MDN) documentation for detecting mobile devices.",
"short_url": "",
- "keywords": [
- "mobile",
- "device",
- "browser",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["mobile", "device", "browser", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP": {
"id": "mdn-csp",
"description": "MDN reference for content security policy (CSP).",
"short_url": "",
- "keywords": [
- "csp",
- "content",
- "security",
- "policy"
- ]
+ "keywords": ["csp", "content", "security", "policy"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions": {
"id": "mdn-regexp",
@@ -2452,45 +1617,25 @@
"id": "mdn-class",
"description": "Mozilla Developer Network (MDN) documentation for ECMAScript 2015 classes.",
"short_url": "",
- "keywords": [
- "class",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["class", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/Arrow_functions": {
"id": "mdn-arrow-function",
"description": "Mozilla Developer Network (MDN) documentation for ECMAScript 2015 arrow functions.",
"short_url": "",
- "keywords": [
- "arrow",
- "function",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["arrow", "function", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects": {
"id": "mdn-builtins",
"description": "Mozilla Developer Network (MDN) documentation on JavaScript's built-in objects as well as their methods and properties.",
"short_url": "",
- "keywords": [
- "object",
- "globals",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["object", "globals", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array": {
"id": "mdn-array",
"description": "Mozilla Developer Network (MDN) documentation for the JavaScript Array object.",
"short_url": "",
- "keywords": [
- "globals",
- "array",
- "javascript",
- "ecmascript",
- "js"
- ]
+ "keywords": ["globals", "array", "javascript", "ecmascript", "js"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/ReduceRight": {
"id": "mdn-array-reduceright",
@@ -2511,12 +1656,7 @@
"id": "mdn-array-every",
"description": "Mozilla Developer Network (MDN) documentation for the every Array.prototype method.",
"short_url": "",
- "keywords": [
- "every",
- "array",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["every", "array", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/find": {
"id": "mdn-array-find",
@@ -2620,12 +1760,7 @@
"id": "mdn-array-some",
"description": "Mozilla Developer Network (MDN) documentation for the some Array.prototype method.",
"short_url": "",
- "keywords": [
- "array",
- "prototype",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["array", "prototype", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/unshift": {
"id": "mdn-array-unshift",
@@ -2658,12 +1793,7 @@
"id": "mdn-bigint",
"description": "Mozilla Developer Network (MDN) documentation for the BigInt object.",
"short_url": "",
- "keywords": [
- "bigint",
- "javascript",
- "ecmascript",
- "js"
- ]
+ "keywords": ["bigint", "javascript", "ecmascript", "js"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt64Array": {
"id": "mdn-bigint64array",
@@ -2695,90 +1825,49 @@
"id": "mdn-boolean",
"description": "Mozilla Developer Network (MDN) documentation for the Boolean object.",
"short_url": "",
- "keywords": [
- "boolean",
- "javascript",
- "ecmascript",
- "js"
- ]
+ "keywords": ["boolean", "javascript", "ecmascript", "js"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView": {
"id": "mdn-dataview",
"description": "Mozilla Developer Network (MDN) documentation for the DataView object.",
"short_url": "",
- "keywords": [
- "typed-array",
- "dataview",
- "javascript",
- "ecmascript",
- "js"
- ]
+ "keywords": ["typed-array", "dataview", "javascript", "ecmascript", "js"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date": {
"id": "mdn-date-object",
"description": "Mozilla Developer Network (MDN) documentation for the JavaScript Date object.",
"short_url": "",
- "keywords": [
- "date",
- "globals",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["date", "globals", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/now": {
"id": "date",
"description": "Mozilla Developer Network (MDN) documentation for the Date.now() method, which returns the number of milliseconds elapsed since January 1, 1970 00:00:00 UTC.",
"short_url": "",
- "keywords": [
- "date",
- "now",
- "javascript",
- "ecmascript",
- "js"
- ]
+ "keywords": ["date", "now", "javascript", "ecmascript", "js"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error": {
"id": "mdn-error",
"description": "Mozilla Developer Network (MDN) documentation for the Error constructor.",
"short_url": "",
- "keywords": [
- "error",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["error", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/EvalError": {
"id": "mdn-eval-error",
"description": "Mozilla Developer Network (MDN) documentation for the EvalError constructor.",
"short_url": "",
- "keywords": [
- "error",
- "evalerror",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["error", "evalerror", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float32Array": {
"id": "mdn-float32array",
"description": "Mozilla Developer Network (MDN) documentation for Float32Arrays.",
"short_url": "",
- "keywords": [
- "float32array",
- "typedarray",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["float32array", "typedarray", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float64Array": {
"id": "mdn-float64array",
"description": "Mozilla Developer Network (MDN) documentation for Float64Arrays.",
"short_url": "",
- "keywords": [
- "float64array",
- "typedarray",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["float64array", "typedarray", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function": {
"id": "mdn-function",
@@ -2797,119 +1886,67 @@
"id": "mdn-function-name",
"description": "Mozilla Developer Network (MDN) documentation on the function.name property.",
"short_url": "",
- "keywords": [
- "function",
- "property",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["function", "property", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int16Array": {
"id": "mdn-int16array",
"description": "Mozilla Developer Network (MDN) documentation for Int16Arrays.",
"short_url": "",
- "keywords": [
- "int16array",
- "typedarray",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["int16array", "typedarray", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int32Array": {
"id": "mdn-int32array",
"description": "Mozilla Developer Network (MDN) documentation for Int32Arrays.",
"short_url": "",
- "keywords": [
- "int32array",
- "typedarray",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["int32array", "typedarray", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int8Array": {
"id": "mdn-int8array",
"description": "Mozilla Developer Network (MDN) documentation for Int8Arrays.",
"short_url": "",
- "keywords": [
- "int8array",
- "typedarray",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["int8array", "typedarray", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify": {
"id": "mdn-json-stringify",
"description": "Mozilla Developer Network (MDN) documentation for the JSON.stringify() method.",
"short_url": "",
- "keywords": [
- "json",
- "stringify",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["json", "stringify", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map": {
"id": "mdn-map",
"description": "Mozilla Developer Network (MDN) documentation for Map objects.",
"short_url": "",
- "keywords": [
- "map",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["map", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/fround": {
"id": "math-fround",
"description": "Mozilla Developer Network (MDN) documentation for the Math.fround() method.",
"short_url": "",
- "keywords": [
- "math",
- "fround",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["math", "fround", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number": {
"id": "mdn-number",
"description": "Documentation for the Number constructor.",
"short_url": "",
- "keywords": [
- "number",
- "constructor",
- "javascript"
- ]
+ "keywords": ["number", "constructor", "javascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object": {
"id": "mdn-object",
"description": "Mozilla Developer Network (MDN) documentation for JavaScript objects.",
"short_url": "",
- "keywords": [
- "globals",
- "object",
- "javascript",
- "ecmascript",
- "js"
- ]
+ "keywords": ["globals", "object", "javascript", "ecmascript", "js"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/defineProperties": {
"id": "mdn-define-properties",
"description": "Mozilla Developer Network (MDN) documentation for the Object.defineProperties() method.",
"short_url": "",
- "keywords": [
- "object",
- "ecmascript",
- "javascript"
- ]
+ "keywords": ["object", "ecmascript", "javascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/defineProperty": {
"id": "mdn-define-property",
"description": "Mozilla Developer Network (MDN) documentation for the Object.defineProperty() method.",
"short_url": "",
- "keywords": [
- "object",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["object", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/getPrototypeOf": {
"id": "object-get-prototype-of",
@@ -2940,78 +1977,43 @@
"id": "object-to-string",
"description": "Mozilla Developer Network (MDN) documentation for the Object.toString() method.",
"short_url": "",
- "keywords": [
- "object",
- "prototype",
- "tostring",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["object", "prototype", "tostring", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy": {
"id": "mdn-proxy",
"description": "Mozilla Developer Network (MDN) documentation for Proxy objects.",
"short_url": "",
- "keywords": [
- "proxy",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["proxy", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RangeError": {
"id": "mdn-range-error",
"description": "Mozilla Developer Network (MDN) documentation for the RangeError constructor.",
"short_url": "",
- "keywords": [
- "error",
- "rangeerror",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["error", "rangeerror", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ReferenceError": {
"id": "mdn-reference-error",
"description": "Mozilla Developer Network (MDN) documentation for the ReferenceError constructor.",
"short_url": "",
- "keywords": [
- "error",
- "referenceerror",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["error", "referenceerror", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set": {
"id": "mdn-set",
"description": "Mozilla Developer Network (MDN) documentation for Set objects.",
"short_url": "",
- "keywords": [
- "set",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["set", "javascript", "ecmascript"]
},
- "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer": {
- "id": "mdn-sharedarraybuffer",
- "description": "Documentation for SharedArrayBuffer, a constructor returning an object used to represent a generic, fixed-length raw binary data buffer which can be used to create views of shared memory.",
- "short_url": "",
- "keywords": [
- "array",
- "buffer",
- "typed array",
- "shared",
- "memory"
- ]
+ "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer": {
+ "id": "mdn-sharedarraybuffer",
+ "description": "Documentation for SharedArrayBuffer, a constructor returning an object used to represent a generic, fixed-length raw binary data buffer which can be used to create views of shared memory.",
+ "short_url": "",
+ "keywords": ["array", "buffer", "typed array", "shared", "memory"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String": {
"id": "mdn-string",
"description": "Mozilla Developer Network (MDN) documentation for the String object.",
"short_url": "",
- "keywords": [
- "string",
- "globals",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["string", "globals", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/codePointAt": {
"id": "mdn-string-codepointat",
@@ -3029,13 +2031,7 @@
"id": "mdn-string-endswith",
"description": "Mozilla Developer Network (MDN) documentation for the String.prototype.endsWith() method.",
"short_url": "",
- "keywords": [
- "string",
- "endswith",
- "prototype",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["string", "endswith", "prototype", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/fromCharCode": {
"id": "mdn-string-fromcharcode",
@@ -3073,49 +2069,25 @@
"id": "mdn-includes",
"description": "Mozilla Developer Network (MDN) documentation for the includes String.prototype method.",
"short_url": "",
- "keywords": [
- "string",
- "prototype",
- "globals",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["string", "prototype", "globals", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/padStart": {
"id": "mdn-string-padstart",
"description": "Mozilla Developer Network (MDN) documentation for the String.prototype.padStart() method.",
"short_url": "",
- "keywords": [
- "string",
- "padstart",
- "prototype",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["string", "padstart", "prototype", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace": {
"id": "mdn-string-replace",
"description": "Mozilla Developer Network (MDN) documentation for the String.prototype.replace() method.",
"short_url": "",
- "keywords": [
- "string",
- "replace",
- "prototype",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["string", "replace", "prototype", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/split": {
"id": "string-split",
"description": "Mozilla Developer Network (MDN) documentation for the String.prototype.split() method.",
"short_url": "",
- "keywords": [
- "string",
- "split",
- "prototype",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["string", "split", "prototype", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/startsWith": {
"id": "mdn-string-startswith",
@@ -3133,222 +2105,121 @@
"id": "mdn-symbol",
"description": "Mozilla Developer Network (MDN) documentation for the Symbol object.",
"short_url": "",
- "keywords": [
- "symbol",
- "key",
- "ecmascript",
- "javascript"
- ]
+ "keywords": ["symbol", "key", "ecmascript", "javascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/iterator": {
"id": "mdn-iterator-symbol",
"description": "Documentation for the symbol which specifies the default iterator for an object.",
"short_url": "",
- "keywords": [
- "javascript",
- "symbol",
- "iterator",
- "documentation",
- "docs"
- ]
+ "keywords": ["javascript", "symbol", "iterator", "documentation", "docs"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag": {
"id": "mdn-symbol-tostringtag",
"description": "Mozilla Developer Network (MDN) documentation for the Symbol.toStringTag property.",
"short_url": "",
- "keywords": [
- "symbol",
- "tostringtag",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["symbol", "tostringtag", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SyntaxError": {
"id": "mdn-syntax-error",
"description": "Mozilla Developer Network (MDN) documentation for the SyntaxError constructor.",
"short_url": "",
- "keywords": [
- "error",
- "syntaxerror",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["error", "syntaxerror", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError": {
"id": "mdn-type-error",
"description": "Mozilla Developer Network (MDN) documentation for the TypeError constructor.",
"short_url": "",
- "keywords": [
- "error",
- "typeerror",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["error", "typeerror", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray": {
"id": "mdn-typed-array",
"description": "Mozilla Developer Network (MDN) documentation for JavaScript typed arrays.",
"short_url": "",
- "keywords": [
- "globals",
- "typed-array",
- "javascript",
- "ecmascript",
- "js"
- ]
+ "keywords": ["globals", "typed-array", "javascript", "ecmascript", "js"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/map": {
"id": "mdn-typedarray-map",
"description": "MDN documentation for the `map` method on typed array objects.",
"short_url": "",
- "keywords": [
- "typedarray",
- "map",
- "transform",
- "mdn",
- "apply"
- ]
+ "keywords": ["typedarray", "map", "transform", "mdn", "apply"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/URIError": {
"id": "mdn-uri-error",
"description": "Mozilla Developer Network (MDN) documentation for the URIError constructor.",
"short_url": "",
- "keywords": [
- "error",
- "urierror",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["error", "urierror", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint16Array": {
"id": "mdn-uint16array",
"description": "Mozilla Developer Network (MDN) documentation for UInt16Arrays.",
"short_url": "",
- "keywords": [
- "uint16array",
- "typedarray",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["uint16array", "typedarray", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint32Array": {
"id": "mdn-uint32array",
"description": "Mozilla Developer Network (MDN) documentation for UInt32Arrays.",
"short_url": "",
- "keywords": [
- "uint32array",
- "typedarray",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["uint32array", "typedarray", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array": {
"id": "mdn-uint8array",
"description": "Mozilla Developer Network (MDN) documentation for UInt8Arrays.",
"short_url": "",
- "keywords": [
- "uint8array",
- "typedarray",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["uint8array", "typedarray", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8ClampedArray": {
"id": "mdn-uint8clampedarray",
"description": "Mozilla Developer Network (MDN) documentation for UInt8ClampedArrays.",
"short_url": "",
- "keywords": [
- "uint8clampedarray",
- "typedarray",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["uint8clampedarray", "typedarray", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap": {
"id": "mdn-weakmap",
"description": "Mozilla Developer Network (MDN) documentation for WeakMap objects.",
"short_url": "",
- "keywords": [
- "weakmap",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["weakmap", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakSet": {
"id": "mdn-weakset",
"description": "Mozilla Developer Network (MDN) documentation for WeakSet objects.",
"short_url": "",
- "keywords": [
- "weakset",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["weakset", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/eval": {
"id": "mdn-eval",
"description": "Mozilla Developer Network (MDN) documentation for the eval function.",
"short_url": "",
- "keywords": [
- "eval",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["eval", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/globalThis": {
"id": "mdn-global-this",
"description": "MDN documentation for `globalThis`, a reference to the global object.",
"short_url": "",
- "keywords": [
- "global",
- "this",
- "self",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["global", "this", "self", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/isFinite": {
"id": "mdn-is-finite",
"description": "Mozilla Developer Network (MDN) documentation of the isFinite global JavaScript function.",
"short_url": "",
- "keywords": [
- "isfinite",
- "globals",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["isfinite", "globals", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterable_protocol": {
"id": "mdn-iterable-protocol",
"description": "MDN documentation for the iterable protocol.",
"short_url": "",
- "keywords": [
- "iterable",
- "iterator",
- "javascript",
- "es2015",
- "es6"
- ]
+ "keywords": ["iterable", "iterator", "javascript", "es2015", "es6"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol": {
"id": "mdn-iterator-protocol",
"description": "Documentation for the iterator protocol.",
"short_url": "",
- "keywords": [
- "iterator",
- "iter",
- "protocol",
- "javascript"
- ]
+ "keywords": ["iterator", "iter", "protocol", "javascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await": {
"id": "mdn-await",
"description": "MDN entry for the `await` operator.",
"short_url": "",
- "keywords": [
- "async",
- "await",
- "es2017"
- ]
+ "keywords": ["async", "await", "es2017"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/function": {
"id": "function-expressions",
@@ -3366,226 +2237,127 @@
"id": "type-of",
"description": "MDN documentation for the `typeof` operator.",
"short_url": "",
- "keywords": [
- "typeof",
- "operator",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["typeof", "operator", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function": {
"id": "mdn-async",
"description": "MDN entry for async functions.",
"short_url": "",
- "keywords": [
- "async",
- "await",
- "es2017"
- ]
+ "keywords": ["async", "await", "es2017"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function*": {
"id": "mdn-generator-function",
"description": "Mozilla Developer Network (MDN) documentation for ECMAScript 2015 generator functions.",
"short_url": "",
- "keywords": [
- "function",
- "generator",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["function", "generator", "javascript", "ecmascript"]
},
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Strict_mode": {
"id": "mdn-strict-mode",
"description": "Mozilla Developer Network (MDN) documentation of ECMAScript 5's strict mode.",
"short_url": "",
- "keywords": [
- "javascript",
- "ecmascript",
- "js",
- "strict",
- "mode"
- ]
+ "keywords": ["javascript", "ecmascript", "js", "strict", "mode"]
},
"https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse": {
"id": "mdn-json-parse",
"description": "Mozilla Developer Network (MDN) documentation for the JSON.parse method.",
"short_url": "",
- "keywords": [
- "json",
- "parse",
- "javascript",
- "ecmascript",
- "js"
- ]
+ "keywords": ["json", "parse", "javascript", "ecmascript", "js"]
},
"https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Object/hasOwnProperty": {
"id": "mdn-object-has-own-property",
"description": "Mozilla Developer Network (MDN) documentation for the hasOwnProperty Object.prototype method.",
"short_url": "",
- "keywords": [
- "object",
- "prototype",
- "globals",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["object", "prototype", "globals", "javascript", "ecmascript"]
},
"https://docs.codecov.com/docs/codecovyml-reference": {
"id": "codecov-yaml",
"description": "Codecov documentation for the codecov.yml file.",
"short_url": "",
- "keywords": [
- "codecov",
- "codecov.yml"
- ]
+ "keywords": ["codecov", "codecov.yml"]
},
"https://docs.github.com/en/actions/reference/events-that-trigger-workflows": {
"id": "github-workflow-triggering-events",
"description": "GitHub API documentation for workflow triggering events.",
"short_url": "",
- "keywords": [
- "github",
- "actions",
- "workflow",
- "trigger",
- "event"
- ]
+ "keywords": ["github", "actions", "workflow", "trigger", "event"]
},
"https://docs.github.com/en/rest/reference/actions#create-a-workflow-dispatch-event": {
"id": "github-dispatch-workflow",
"description": "GitHub API documentation for the dispatch workflow event.",
"short_url": "",
- "keywords": [
- "github",
- "actions",
- "workflow",
- "manual",
- "dispatch",
- "event"
- ]
+ "keywords": ["github", "actions", "workflow", "manual", "dispatch", "event"]
},
"https://docs.github.com/en/rest/reference/actions#list-workflow-runs-for-a-repository": {
"id": "github-workflow-runs",
"description": "GitHub API documentation for listing workflow runs.",
"short_url": "",
- "keywords": [
- "github",
- "actions",
- "workflow",
- "run",
- "list"
- ]
+ "keywords": ["github", "actions", "workflow", "run", "list"]
},
"https://docs.github.com/en/rest/reference/repos#create-an-organization-repository": {
"id": "github-create-repo",
"description": "GitHub API documentation for creating a repository.",
"short_url": "",
- "keywords": [
- "github",
- "repository",
- "create"
- ]
+ "keywords": ["github", "repository", "create"]
},
"https://docs.github.com/en/rest/reference/repos#replace-all-repository-topics": {
"id": "github-topics",
"description": "GitHub API documentation for repository topics.",
"short_url": "",
- "keywords": [
- "github",
- "repository",
- "topic"
- ]
+ "keywords": ["github", "repository", "topic"]
},
"https://docs.google.com/spreadsheets/d/1t2jrptAvaQetDIYPD8GKc90Dni2dT3FuHgKKFF-eJHw/edit#gid=0": {
"id": "@bug:esdiscuss:038525:spreadsheet",
"description": "Google spreadsheet showing trigonometric results across browsers.",
"short_url": "",
- "keywords": [
- "spreadsheet",
- "trigonometry",
- "bug",
- "esdiscuss"
- ]
+ "keywords": ["spreadsheet", "trigonometry", "bug", "esdiscuss"]
},
"https://docs.npmjs.com/files/package.json#bin": {
"id": "package-command",
"description": "npm documentation for the `bin` field in package.json.",
"short_url": "",
- "keywords": [
- "npm",
- "package.json",
- "bin"
- ]
+ "keywords": ["npm", "package.json", "bin"]
},
"https://docs.npmjs.com/files/package.json#description": {
"id": "package-description",
"description": "npm documentation for the `description` field in package.json.",
"short_url": "",
- "keywords": [
- "npm",
- "package.json",
- "description"
- ]
+ "keywords": ["npm", "package.json", "description"]
},
"https://docs.npmjs.com/files/package.json#keywords": {
"id": "package-keywords",
"description": "npm documentation for the `keywords` field in package.json.",
"short_url": "",
- "keywords": [
- "npm",
- "package.json",
- "keywords"
- ]
+ "keywords": ["npm", "package.json", "keywords"]
},
"https://docs.npmjs.com/files/package.json#name": {
"id": "package-name",
"description": "npm documentation for the `name` field in package.json.",
"short_url": "",
- "keywords": [
- "npm",
- "package.json",
- "name"
- ]
+ "keywords": ["npm", "package.json", "name"]
},
"https://docs.npmjs.com/policies/conduct": {
"id": "npm-code-of-conduct",
"description": "npm Code of Conduct.",
"short_url": "",
- "keywords": [
- "npm",
- "code",
- "conduct"
- ]
+ "keywords": ["npm", "code", "conduct"]
},
"https://docs.npmjs.com/policies/privacy": {
"id": "npm-privacy-policy",
"description": "npm Privacy Policy.",
"short_url": "",
- "keywords": [
- "npm",
- "privacy",
- "policy"
- ]
+ "keywords": ["npm", "privacy", "policy"]
},
"https://docs.oracle.com/javase/7/docs/api/java/lang/Math.html#round%28double%29": {
"id": "java-math-round",
"description": "Java documentation for the Math.round method.",
"short_url": "",
- "keywords": [
- "java",
- "math",
- "round"
- ]
+ "keywords": ["java", "math", "round"]
},
"https://docs.python.org/2/library/simplehttpserver.html": {
"id": "python-simplehttpserver",
"description": "Documentation for Python's SimpleHTTPServer module.",
"short_url": "",
- "keywords": [
- "python",
- "server",
- "http"
- ]
+ "keywords": ["python", "server", "http"]
},
"https://docs.travis-ci.com/user/customizing-the-build": {
"id": "travis-ci-customing-the-build",
@@ -3623,49 +2395,25 @@
"id": "@gilley:1996a",
"description": "Digital Object Identifier for Gilley, D. and Pace, R. K. 1996. On the Harrison and Rubinfeld Data.",
"short_url": "",
- "keywords": [
- "doi",
- "gilley",
- "harrison",
- "rubinfeld",
- "data"
- ]
+ "keywords": ["doi", "gilley", "harrison", "rubinfeld", "data"]
},
"https://doi.org/10.1007/0-387-28695-0": {
"id": "@wilkinson:2005a",
"description": "Digital Object Identifier for Wilkinson, L. 2005. The Grammar of Graphics.",
"short_url": "",
- "keywords": [
- "doi",
- "wilkinson",
- "grammar",
- "graphics"
- ]
+ "keywords": ["doi", "wilkinson", "grammar", "graphics"]
},
"https://doi.org/10.1007/3-540-44669-9_12": {
"id": "@ciura:2001a",
"description": "Digital Object Identifier for Ciura, M. 2001. Best Increments for the Average Case of Shellsort.",
"short_url": "",
- "keywords": [
- "doi",
- "ciura",
- "increment",
- "average",
- "case",
- "shellsort"
- ]
+ "keywords": ["doi", "ciura", "increment", "average", "case", "shellsort"]
},
"https://doi.org/10.1007/978-3-642-22309-9_5": {
"id": "@hansen:2011a",
"description": "Digital Object Identifier for Hansen, L. K. et al. 2011. Good Friends, Bad News - Affinity and Virality in Twitter.",
"short_url": "",
- "keywords": [
- "doi",
- "hansen",
- "affinity",
- "virality",
- "twitter"
- ]
+ "keywords": ["doi", "hansen", "affinity", "virality", "twitter"]
},
"https://doi.org/10.1007/s00607-005-0139-x": {
"id": "@klein:2005a",
@@ -3715,13 +2463,7 @@
"id": "@stein:1967",
"description": "Digital Object Identifier for Stein, J. 1967. Computational problems associated with Racah algebra.",
"short_url": "",
- "keywords": [
- "doi",
- "stein",
- "computational",
- "racah",
- "algebra"
- ]
+ "keywords": ["doi", "stein", "computational", "racah", "algebra"]
},
"https://doi.org/10.1016/0095-0696%2878%2990006-2": {
"id": "@harrison:1978a",
@@ -3743,13 +2485,7 @@
"id": "@sedgewick:1986a",
"description": "Digital Object Identifier for Sedgewick, R. 1986. A new upper bound for shellsort.",
"short_url": "",
- "keywords": [
- "doi",
- "sedgewick",
- "upper",
- "bound",
- "shellsort"
- ]
+ "keywords": ["doi", "sedgewick", "upper", "bound", "shellsort"]
},
"https://doi.org/10.1016/j.cam.2014.12.038": {
"id": "@fukushima:2015a",
@@ -3895,14 +2631,7 @@
"id": "@spache:1953a",
"description": "Digital Object Identifier for Spache, George. 1953.",
"short_url": "",
- "keywords": [
- "paper",
- "journal",
- "doi",
- "school",
- "grade",
- "reading"
- ]
+ "keywords": ["paper", "journal", "doi", "school", "grade", "reading"]
},
"https://doi.org/10.1108/eb046814": {
"id": "@porter:1980",
@@ -4086,14 +2815,7 @@
"id": "@floyd:1964a",
"description": "Digital Object Identifier for Floyd, R. W. 1964. Algorithm 245: Treesort.",
"short_url": "",
- "keywords": [
- "paper",
- "journal",
- "doi",
- "floyd",
- "algorithm",
- "treesort"
- ]
+ "keywords": ["paper", "journal", "doi", "floyd", "algorithm", "treesort"]
},
"https://doi.org/10.1145/355841.355848": {
"id": "@lawson:1979a",
@@ -4181,13 +2903,7 @@
"id": "@williams:1964a",
"description": "Digital Object Identifier for Forsythe, G. E. 1964. Algorithms.",
"short_url": "",
- "keywords": [
- "paper",
- "journal",
- "doi",
- "forsythe",
- "algorithm"
- ]
+ "keywords": ["paper", "journal", "doi", "forsythe", "algorithm"]
},
"https://doi.org/10.1214/aoms/1177729885": {
"id": "@grubbs:1950a",
@@ -4246,76 +2962,43 @@
"id": "max-int32",
"description": "Wikipedia article on the maximum value of a 32-bit signed integer.",
"short_url": "",
- "keywords": [
- "int",
- "integer",
- "2147483647",
- "2^31-1"
- ]
+ "keywords": ["int", "integer", "2147483647", "2^31-1"]
},
"https://en.wikipedia.org/wiki/ARPABET": {
"id": "arpabet",
"description": "Wikipedia article on the ARPABET set of phonetic transcription codes.",
"short_url": "",
- "keywords": [
- "phonetic",
- "alphabet",
- "nlp"
- ]
+ "keywords": ["phonetic", "alphabet", "nlp"]
},
"https://en.wikipedia.org/wiki/ASCII": {
"id": "ascii",
"description": "Wikipedia entry for the \"American Standard Code for Information Interchange\" (ASCII) character encoding standard.",
"short_url": "",
- "keywords": [
- "ascii",
- "encoding",
- "standard"
- ]
+ "keywords": ["ascii", "encoding", "standard"]
},
"https://en.wikipedia.org/wiki/AWK": {
"id": "awk",
"description": "Wikipedia entry for the AWK programming language.",
- "short_url": "",
- "keywords": [
- "awk",
- "data processing",
- "command-line"
- ]
+ "short_url": "",
+ "keywords": ["awk", "data processing", "command-line"]
},
"https://en.wikipedia.org/wiki/Absolute_difference": {
"id": "absolute-difference",
"description": "Wikipedia entry for the absolute difference function.",
"short_url": "",
- "keywords": [
- "absolute",
- "difference",
- "math",
- "function"
- ]
+ "keywords": ["absolute", "difference", "math", "function"]
},
"https://en.wikipedia.org/wiki/Absolute_value": {
"id": "absolute-value",
"description": "Wikipedia entry for the absolute value.",
"short_url": "",
- "keywords": [
- "mathematics",
- "math",
- "abs",
- "absolute",
- "magnitude"
- ]
+ "keywords": ["mathematics", "math", "abs", "absolute", "magnitude"]
},
"https://en.wikipedia.org/wiki/Additive_white_Gaussian_noise": {
"id": "awgn",
"description": "Wikipedia entry for additive white Gaussian noise.",
"short_url": "",
- "keywords": [
- "noise",
- "signal",
- "gaussian",
- "white"
- ]
+ "keywords": ["noise", "signal", "gaussian", "white"]
},
"https://en.wikipedia.org/wiki/Algorithms_for_calculating_variance": {
"id": "algorithms-variance",
@@ -4348,12 +3031,7 @@
"id": "anagram",
"description": "Wikipedia entry for anagrams.",
"short_url": "",
- "keywords": [
- "alphabetical",
- "anagram",
- "words",
- "letters"
- ]
+ "keywords": ["alphabetical", "anagram", "words", "letters"]
},
"https://en.wikipedia.org/wiki/Analytic_continuation": {
"id": "analytic-continuation",
@@ -4372,22 +3050,13 @@
"id": "anscombes-quartet",
"description": "Wikipedia entry for Anscombe's quartet.",
"short_url": "",
- "keywords": [
- "anscombe",
- "quartet",
- "dataset"
- ]
+ "keywords": ["anscombe", "quartet", "dataset"]
},
"https://en.wikipedia.org/wiki/Ap%C3%A9ry%27s_constant": {
"id": "apery-constant",
"description": "Wikipedia entry for Apéry's constant.",
"short_url": "",
- "keywords": [
- "apery",
- "riemann",
- "zeta",
- "constant"
- ]
+ "keywords": ["apery", "riemann", "zeta", "constant"]
},
"https://en.wikipedia.org/wiki/Arbitrary-precision_arithmetic": {
"id": "arbitrary-precision-arithmetic",
@@ -4437,14 +3106,7 @@
"id": "arithmetic-mean",
"description": "Wikipedia entry for the arithmetic mean.",
"short_url": "",
- "keywords": [
- "arithmetic",
- "mean",
- "average",
- "avg",
- "statistics",
- "stats"
- ]
+ "keywords": ["arithmetic", "mean", "average", "avg", "statistics", "stats"]
},
"https://en.wikipedia.org/wiki/Bernoulli_distribution": {
"id": "bernoulli",
@@ -4463,28 +3125,19 @@
"id": "bernoulli-number",
"description": "Wikipedia entry for the Bernoulli numbers.",
"short_url": "",
- "keywords": [
- "bernoulli",
- "number"
- ]
+ "keywords": ["bernoulli", "number"]
},
"https://en.wikipedia.org/wiki/Bessel_function#Bessel_functions_of_the_first_kind:_J.CE.B1": {
"id": "bessel-first-kind",
"description": "Wikipedia entry for Bessel functions of the first kind.",
"short_url": "",
- "keywords": [
- "bessel",
- "math"
- ]
+ "keywords": ["bessel", "math"]
},
"https://en.wikipedia.org/wiki/Bessel_function#Bessel_functions_of_the_second_kind:_Y.CE.B1": {
"id": "bessel-second-kind",
"description": "Wikipedia page for Bessel functions of the second kind.",
"short_url": "",
- "keywords": [
- "math",
- "bessel"
- ]
+ "keywords": ["math", "bessel"]
},
"https://en.wikipedia.org/wiki/Beta_distribution": {
"id": "beta-distribution",
@@ -4504,11 +3157,7 @@
"id": "beta-function",
"description": "Wikipedia entry for the beta function.",
"short_url": "",
- "keywords": [
- "beta",
- "function",
- "math"
- ]
+ "keywords": ["beta", "function", "math"]
},
"https://en.wikipedia.org/wiki/Beta_function#Incomplete_beta_function": {
"id": "incomplete-beta",
@@ -4555,12 +3204,7 @@
"id": "binomial-coefficient",
"description": "Wikipedia entry for the binomial coefficient.",
"short_url": "",
- "keywords": [
- "binomial",
- "coefficient",
- "math",
- "mathematics"
- ]
+ "keywords": ["binomial", "coefficient", "math", "mathematics"]
},
"https://en.wikipedia.org/wiki/Binomial_distribution": {
"id": "binomial-distribution",
@@ -4581,35 +3225,19 @@
"id": "box-muller",
"description": "Wikipedia entry for the Box-Muller transform to generate standard normal pseudorandom numbers.",
"short_url": "",
- "keywords": [
- "random",
- "rng",
- "prng",
- "algorithm",
- "gaussian",
- "normal"
- ]
+ "keywords": ["random", "rng", "prng", "algorithm", "gaussian", "normal"]
},
"https://en.wikipedia.org/wiki/Byte_order_mark": {
"id": "bom",
"description": "Wikipedia entry for the byte order mark.",
"short_url": "",
- "keywords": [
- "byte",
- "order",
- "mark",
- "bom"
- ]
+ "keywords": ["byte", "order", "mark", "bom"]
},
"https://en.wikipedia.org/wiki/Catalan%27s_constant": {
"id": "catalan-constant",
"description": "Wikipedia entry for Catalan's constant.",
"short_url": "",
- "keywords": [
- "catalan",
- "constant",
- "math"
- ]
+ "keywords": ["catalan", "constant", "math"]
},
"https://en.wikipedia.org/wiki/Cauchy_distribution": {
"id": "cauchy-distribution",
@@ -4629,12 +3257,7 @@
"id": "centrosymmetric-matrix",
"description": "Wikipedia entry for centrosymmetric matrices (i.e., matrices symmetric about their center).",
"short_url": "",
- "keywords": [
- "matrix",
- "centrosymmetric",
- "symmetric",
- "linear algebra"
- ]
+ "keywords": ["matrix", "centrosymmetric", "symmetric", "linear algebra"]
},
"https://en.wikipedia.org/wiki/Charles_Joseph_Minard": {
"id": "minard",
@@ -4685,26 +3308,13 @@
"id": "cis",
"description": "Wikipedia entry for cis function.",
"short_url": "",
- "keywords": [
- "cis",
- "complex",
- "exponential",
- "math",
- "phasor",
- "special"
- ]
+ "keywords": ["cis", "complex", "exponential", "math", "phasor", "special"]
},
"https://en.wikipedia.org/wiki/Code_point": {
"id": "code-point",
"description": "Wikipedia entry for a code point, a term from character encoding to refer to a numerical value in code space.",
"short_url": "",
- "keywords": [
- "unicode",
- "encoding",
- "encode",
- "code",
- "point"
- ]
+ "keywords": ["unicode", "encoding", "encode", "code", "point"]
},
"https://en.wikipedia.org/wiki/Coefficient_of_variation": {
"id": "coefficient-of-variation",
@@ -4724,121 +3334,67 @@
"id": "common-logarithm",
"description": "Wikipedia entry for the common logarithm, which is the logarithm with base 10.",
"short_url": "",
- "keywords": [
- "log",
- "logarithm",
- "common",
- "base 10"
- ]
+ "keywords": ["log", "logarithm", "common", "base 10"]
},
"https://en.wikipedia.org/wiki/Complex_conjugate": {
"id": "complex-conjugate",
"description": "Wikipedia entry for the complex conjugate.",
"short_url": "",
- "keywords": [
- "complex",
- "conjugate",
- "math",
- "mathematics"
- ]
+ "keywords": ["complex", "conjugate", "math", "mathematics"]
},
"https://en.wikipedia.org/wiki/Complex_number": {
"id": "complex",
"description": "Wikipedia entry for complex numbers.",
"short_url": "",
- "keywords": [
- "complex",
- "number",
- "math",
- "mathematics"
- ]
+ "keywords": ["complex", "number", "math", "mathematics"]
},
"https://en.wikipedia.org/wiki/Constant_function": {
"id": "constant-function",
"description": "Wikipedia entry for a constant function (i.e., a function whose output value is the same for every input value).",
"short_url": "",
- "keywords": [
- "constant",
- "function",
- "fcn"
- ]
+ "keywords": ["constant", "function", "fcn"]
},
"https://en.wikipedia.org/wiki/Content_delivery_network": {
"id": "cdn",
"description": "Wikipedia entry for content delivery network (CDN), a geographically distributed network of proxy servers and their data centers.",
"short_url": "",
- "keywords": [
- "cdn",
- "content delivery network"
- ]
+ "keywords": ["cdn", "content delivery network"]
},
"https://en.wikipedia.org/wiki/Continued_fraction": {
"id": "continued-fraction",
"description": "Wikipedia entry for a continued fraction, a way of representing a real number as an infinite sum of fractions.",
"short_url": "",
- "keywords": [
- "continued",
- "fraction",
- "math",
- "mathematics"
- ]
+ "keywords": ["continued", "fraction", "math", "mathematics"]
},
"https://en.wikipedia.org/wiki/Coprime_integers": {
"id": "coprime-integers",
"description": "Wikipedia entry for coprime integers.",
"short_url": "",
- "keywords": [
- "integers",
- "coprime",
- "primes",
- "number theory"
- ]
+ "keywords": ["integers", "coprime", "primes", "number theory"]
},
"https://en.wikipedia.org/wiki/Cosine": {
"id": "cosine",
"description": "Wikipedia entry for the cosine function.",
"short_url": "",
- "keywords": [
- "cos",
- "cosine",
- "trigonometry",
- "trig",
- "function",
- "fcn"
- ]
+ "keywords": ["cos", "cosine", "trigonometry", "trig", "function", "fcn"]
},
"https://en.wikipedia.org/wiki/Covariance": {
"id": "covariance",
"description": "Wikipedia entry for covariance, a measure of joint variability of two random variables.",
"short_url": "",
- "keywords": [
- "covariance",
- "statistics",
- "stats",
- "variance"
- ]
+ "keywords": ["covariance", "statistics", "stats", "variance"]
},
"https://en.wikipedia.org/wiki/Covariance_matrix": {
"id": "covariance-matrix",
"description": "Wikipedia entry for covariance matrices.",
"short_url": "",
- "keywords": [
- "covariance",
- "matrix",
- "statistics",
- "stats"
- ]
+ "keywords": ["covariance", "matrix", "statistics", "stats"]
},
"https://en.wikipedia.org/wiki/Cube_root": {
"id": "cube-root",
"description": "Wikipedia entry for the cube root.",
"short_url": "",
- "keywords": [
- "cube",
- "root",
- "math",
- "mathematics"
- ]
+ "keywords": ["cube", "root", "math", "mathematics"]
},
"https://en.wikipedia.org/wiki/Cumulative_distribution_function": {
"id": "cdf",
@@ -4858,23 +3414,13 @@
"id": "darwin",
"description": "Wikipedia entry for the Darwin Unix operating system by Apple Inc.",
"short_url": "",
- "keywords": [
- "os",
- "unix",
- "macos",
- "ios"
- ]
+ "keywords": ["os", "unix", "macos", "ios"]
},
"https://en.wikipedia.org/wiki/Data_parallelism": {
"id": "data-parallelism",
"description": "Wikipedia entry for data parallelism, a form of parallelism in which each processor operates on a different piece of data.",
"short_url": "",
- "keywords": [
- "parallelism",
- "data",
- "parallel",
- "concurrency"
- ]
+ "keywords": ["parallelism", "data", "parallel", "concurrency"]
},
"https://en.wikipedia.org/wiki/Degenerate_distribution": {
"id": "degenerate-distribution",
@@ -4913,79 +3459,43 @@
"id": "diacritics",
"description": "Wikipedia entry on diacritics.",
"short_url": "",
- "keywords": [
- "typography",
- "punctuation",
- "diacritics",
- "glyph"
- ]
+ "keywords": ["typography", "punctuation", "diacritics", "glyph"]
},
"https://en.wikipedia.org/wiki/Digamma_function": {
"id": "digamma-function",
"description": "Wikipedia entry for the digamma function.",
"short_url": "",
- "keywords": [
- "digamma",
- "psi",
- "special",
- "function",
- "fcn"
- ]
+ "keywords": ["digamma", "psi", "special", "function", "fcn"]
},
"https://en.wikipedia.org/wiki/Dirac_delta_function": {
"id": "dirac-delta-function",
"description": "Wikipedia entry for the Dirac delta function.",
"short_url": "",
- "keywords": [
- "dirac",
- "delta",
- "function",
- "fcn"
- ]
+ "keywords": ["dirac", "delta", "function", "fcn"]
},
"https://en.wikipedia.org/wiki/Dirichlet_eta_function": {
"id": "eta-function",
"description": "Wikipedia entry for the Dirichlet eta function.",
"short_url": "",
- "keywords": [
- "eta",
- "dirichlet",
- "function",
- "fcn"
- ]
+ "keywords": ["eta", "dirichlet", "function", "fcn"]
},
"https://en.wikipedia.org/wiki/Dirichlet_series": {
"id": "dirichlet-series",
"description": "Wikipedia entry for Dirichlet series.",
"short_url": "",
- "keywords": [
- "dirichlet",
- "series",
- "math",
- "mathematics"
- ]
+ "keywords": ["dirichlet", "series", "math", "mathematics"]
},
"https://en.wikipedia.org/wiki/Dirname": {
"id": "dirname",
"description": "A UNIX program which returns the directory-path name for a given path.",
"short_url": "",
- "keywords": [
- "unix",
- "utilities",
- "dirname"
- ]
+ "keywords": ["unix", "utilities", "dirname"]
},
"https://en.wikipedia.org/wiki/Discrete_uniform_distribution": {
"id": "discrete-uniform-distribution",
"description": "Wikipedia entry for the discrete uniform distribution.",
"short_url": "",
- "keywords": [
- "discrete",
- "uniform",
- "distribution",
- "dist",
- "stats"
- ]
+ "keywords": ["discrete", "uniform", "distribution", "dist", "stats"]
},
"https://en.wikipedia.org/wiki/Dot_product": {
"id": "dot-product",
@@ -5005,34 +3515,19 @@
"id": "eulers-number",
"description": "Wikipedia entry for the mathematical constant e.",
"short_url": "",
- "keywords": [
- "e",
- "euler",
- "napier",
- "constant"
- ]
+ "keywords": ["e", "euler", "napier", "constant"]
},
"https://en.wikipedia.org/wiki/Elliptic_integral": {
"id": "elliptic-integral",
"description": "Wikipedia entry for elliptic integrals.",
"short_url": "",
- "keywords": [
- "elliptic",
- "integrals",
- "math",
- "calculus"
- ]
+ "keywords": ["elliptic", "integrals", "math", "calculus"]
},
"https://en.wikipedia.org/wiki/Empty_product": {
"id": "empty-product",
"description": "Wikipedia entry for the empty product.",
"short_url": "",
- "keywords": [
- "empty",
- "product",
- "math",
- "mathematics"
- ]
+ "keywords": ["empty", "product", "math", "mathematics"]
},
"https://en.wikipedia.org/wiki/Endianness": {
"id": "endianness",
@@ -5051,38 +3546,19 @@
"id": "entropy",
"description": "Wikipedia entry for the concept of entropy from information theory.",
"short_url": "",
- "keywords": [
- "entropy",
- "shannon",
- "information",
- "random",
- "probability"
- ]
+ "keywords": ["entropy", "shannon", "information", "random", "probability"]
},
"https://en.wikipedia.org/wiki/Environment_variable": {
"id": "environment-variable",
"description": "Wikipedia entry for environment variables, which are a set of dynamically named values that can affect how running processes behave on a computer.",
"short_url": "",
- "keywords": [
- "environment",
- "variable",
- "env",
- "envvars",
- "envs"
- ]
+ "keywords": ["environment", "variable", "env", "envvars", "envs"]
},
"https://en.wikipedia.org/wiki/Environment_variable#Windows": {
"id": "environment-variable-windows",
"description": "Wikipedia entry for environment variables on Windows operating systems.",
"short_url": "",
- "keywords": [
- "environment",
- "variable",
- "env",
- "envvars",
- "envs",
- "windows"
- ]
+ "keywords": ["environment", "variable", "env", "envvars", "envs", "windows"]
},
"https://en.wikipedia.org/wiki/Erlang_distribution": {
"id": "erlang-distribution",
@@ -5147,23 +3623,13 @@
"id": "euler-mascheroni",
"description": "Wikipedia entry for the Euler-Mascheroni constant.",
"short_url": "",
- "keywords": [
- "euler",
- "mascheroni",
- "constant"
- ]
+ "keywords": ["euler", "mascheroni", "constant"]
},
"https://en.wikipedia.org/wiki/Even_and_odd_functions": {
"id": "odd-function",
"description": "Wikipedia entry for even and odd functions.",
"short_url": "",
- "keywords": [
- "even",
- "odd",
- "function",
- "math",
- "mathematics"
- ]
+ "keywords": ["even", "odd", "function", "math", "mathematics"]
},
"https://en.wikipedia.org/wiki/Expected_value": {
"id": "expected-value",
@@ -5226,23 +3692,13 @@
"id": "factorial-function",
"description": "Wikipedia entry for the factorial function.",
"short_url": "",
- "keywords": [
- "factorial",
- "math",
- "mathematics",
- "function"
- ]
+ "keywords": ["factorial", "math", "mathematics", "function"]
},
"https://en.wikipedia.org/wiki/Falling_and_rising_factorials": {
"id": "falling-and-rising-factorials",
"description": "Wikipedia entry for falling and rising factorials.",
"short_url": "",
- "keywords": [
- "factorial",
- "falling",
- "rising",
- "pochhammer"
- ]
+ "keywords": ["factorial", "falling", "rising", "pochhammer"]
},
"https://en.wikipedia.org/wiki/Fano_factor": {
"id": "fano-factor",
@@ -5263,22 +3719,13 @@
"id": "fibonacci-number",
"description": "Wikipedia entry for Fibonacci numbers.",
"short_url": "",
- "keywords": [
- "fibonacci",
- "number",
- "fibo",
- "fib"
- ]
+ "keywords": ["fibonacci", "number", "fibo", "fib"]
},
"https://en.wikipedia.org/wiki/Fibonacci_polynomials": {
"id": "fibonacci-polynomials",
"description": "Wikipedia entry for Fibonacci polynomials.",
"short_url": "",
- "keywords": [
- "fibonacci",
- "fibo",
- "polynomial"
- ]
+ "keywords": ["fibonacci", "fibo", "polynomial"]
},
"https://en.wikipedia.org/wiki/Fisher_transformation": {
"id": "fisher-transform",
@@ -5297,58 +3744,31 @@
"id": "floor",
"description": "Wikipedia entry for the floor and ceiling functions.",
"short_url": "",
- "keywords": [
- "floor",
- "ceil",
- "ceiling",
- "math",
- "mathematics",
- "function"
- ]
+ "keywords": ["floor", "ceil", "ceiling", "math", "mathematics", "function"]
},
"https://en.wikipedia.org/wiki/Florence_Nightingale": {
"id": "nightingale",
"description": "Wikipedia entry on social reformer and statistician Florence Nightingale.",
"short_url": "",
- "keywords": [
- "visualization",
- "viz",
- "statistician",
- "person",
- "nurse"
- ]
+ "keywords": ["visualization", "viz", "statistician", "person", "nurse"]
},
"https://en.wikipedia.org/wiki/Fluent_interface": {
"id": "fluent-interface",
"description": "Wikipedia entry for fluent interfaces.",
"short_url": "",
- "keywords": [
- "fluent",
- "interface",
- "design",
- "pattern"
- ]
+ "keywords": ["fluent", "interface", "design", "pattern"]
},
"https://en.wikipedia.org/wiki/Food_frequency_questionnaire": {
"id": "ffq",
"description": "Wikipedia entry for the food frequency questionnaire, a questionnaire used to obtain frequency and, in some cases, portion size information about food and beverage consumption over a specified period of time, typically the past month or year.",
"short_url": "",
- "keywords": [
- "ffq",
- "food frequency",
- "survey",
- "questionnaire"
- ]
+ "keywords": ["ffq", "food frequency", "survey", "questionnaire"]
},
"https://en.wikipedia.org/wiki/Fortran": {
"id": "fortran",
"description": "Wikipedia entry for Fortran, a general-purpose, imperative programming language that is especially suited to numeric computation and scientific computing.",
"short_url": "",
- "keywords": [
- "fortran",
- "language",
- "programming"
- ]
+ "keywords": ["fortran", "language", "programming"]
},
"https://en.wikipedia.org/wiki/Fr%C3%A9chet_distribution": {
"id": "frechet-distribution",
@@ -5370,44 +3790,25 @@
"id": "francis-anscombe",
"description": "Wikipedia entry for Francis Anscombe, an English statistician.",
"short_url": "",
- "keywords": [
- "anscombe"
- ]
+ "keywords": ["anscombe"]
},
"https://en.wikipedia.org/wiki/French_invasion_of_Russia_%281812%29": {
"id": "campaign-of-1812",
"description": "Wikipedia entry for the French invasion of Russia in 1812.",
"short_url": "",
- "keywords": [
- "1812",
- "russia",
- "french",
- "invasion",
- "war",
- "history"
- ]
+ "keywords": ["1812", "russia", "french", "invasion", "war", "history"]
},
"https://en.wikipedia.org/wiki/Fresnel_integral": {
"id": "fresnel-integral",
"description": "Wikipedia entry for Fresnel integral.",
"short_url": "",
- "keywords": [
- "math",
- "special",
- "fresnel",
- "integral"
- ]
+ "keywords": ["math", "special", "fresnel", "integral"]
},
"https://en.wikipedia.org/wiki/Function_composition_%28computer_science%29": {
"id": "function-composition",
"description": "Wikipedia entry for function composition.",
"short_url": "",
- "keywords": [
- "programming",
- "cs",
- "function",
- "composition"
- ]
+ "keywords": ["programming", "cs", "function", "composition"]
},
"https://en.wikipedia.org/wiki/Gamma_distribution": {
"id": "gamma-distribution",
@@ -5425,15 +3826,9 @@
},
"https://en.wikipedia.org/wiki/Gamma_function": {
"id": "gamma-function",
- "description": "Wikipedia entry for the gamma function.",
- "short_url": "",
- "keywords": [
- "gamma",
- "special",
- "function",
- "math",
- "special"
- ]
+ "description": "Wikipedia entry for the gamma function.",
+ "short_url": "",
+ "keywords": ["gamma", "special", "function", "math", "special"]
},
"https://en.wikipedia.org/wiki/General-purpose_computing_on_graphics_processing_units": {
"id": "gpgpu",
@@ -5454,25 +3849,13 @@
"id": "tribonacci-number",
"description": "Wikipedia entry for Tribonacci numbers.",
"short_url": "",
- "keywords": [
- "tribonacci",
- "fibonacci",
- "number",
- "tribo",
- "trib"
- ]
+ "keywords": ["tribonacci", "fibonacci", "number", "tribo", "trib"]
},
"https://en.wikipedia.org/wiki/Generalized_linear_model#Link_function": {
"id": "generalized-linear-model-link-function",
"description": "Wikipedia entry for the link function within the context of a generalized linear model.",
"short_url": "",
- "keywords": [
- "glm",
- "regression",
- "ml",
- "machine learning",
- "fit"
- ]
+ "keywords": ["glm", "regression", "ml", "machine learning", "fit"]
},
"https://en.wikipedia.org/wiki/Geometric_distribution": {
"id": "geometric-distribution",
@@ -5492,70 +3875,37 @@
"id": "geometric-mean",
"description": "Wikipedia entry for the geometric mean which is defined as the nth root of a product of n numbers.",
"short_url": "",
- "keywords": [
- "geometric",
- "mean",
- "product",
- "prod",
- "statistics",
- "stats"
- ]
+ "keywords": ["geometric", "mean", "product", "prod", "statistics", "stats"]
},
"https://en.wikipedia.org/wiki/Given_name": {
"id": "given-name",
"description": "Wikipedia entry on given / first names.",
"short_url": "",
- "keywords": [
- "givenname",
- "firstname",
- "personalname"
- ]
+ "keywords": ["givenname", "firstname", "personalname"]
},
"https://en.wikipedia.org/wiki/Glaisher%E2%80%93Kinkelin_constant": {
"id": "glaisher-constant",
"description": "Wikipedia entry for the Glaisher–Kinkelin constant.",
"short_url": "",
- "keywords": [
- "glaisher",
- "kinkelin",
- "constant",
- "math",
- "special"
- ]
+ "keywords": ["glaisher", "kinkelin", "constant", "math", "special"]
},
"https://en.wikipedia.org/wiki/Golden_ratio": {
"id": "golden-ratio",
"description": "Wikipedia entry for the golden ratio.",
"short_url": "",
- "keywords": [
- "golden",
- "ratio",
- "phi",
- "math"
- ]
+ "keywords": ["golden", "ratio", "phi", "math"]
},
"https://en.wikipedia.org/wiki/Greatest_common_divisor": {
"id": "gcd",
"description": "Wikipedia entry for the greatest common divisor.",
"short_url": "",
- "keywords": [
- "gcd",
- "greatest",
- "common",
- "divisor",
- "math"
- ]
+ "keywords": ["gcd", "greatest", "common", "divisor", "math"]
},
"https://en.wikipedia.org/wiki/Gregorian_calendar": {
"id": "gregorian-calendar",
"description": "Wikipedia entry for the Gregorian calendar.",
"short_url": "",
- "keywords": [
- "gregorian",
- "calendar",
- "date",
- "time"
- ]
+ "keywords": ["gregorian", "calendar", "date", "time"]
},
"https://en.wikipedia.org/wiki/Grubbs%27_test_for_outliers": {
"id": "grubbs-test",
@@ -5588,12 +3938,7 @@
"id": "gzip",
"description": "Wikipedia entry for gzip, a file format and a software application used for file compression and decompression.",
"short_url": "",
- "keywords": [
- "gzip",
- "compression",
- "file",
- "format"
- ]
+ "keywords": ["gzip", "compression", "file", "format"]
},
"https://en.wikipedia.org/wiki/Half-precision_floating-point_format": {
"id": "half-precision-floating-point-format",
@@ -5615,56 +3960,31 @@
"id": "harmonic-mean",
"description": "Wikipedia entry for the harmonic mean.",
"short_url": "",
- "keywords": [
- "harmonic",
- "mean",
- "avg",
- "average",
- "statistics",
- "stats"
- ]
+ "keywords": ["harmonic", "mean", "avg", "average", "statistics", "stats"]
},
"https://en.wikipedia.org/wiki/Heaviside_step_function": {
"id": "heaviside-function",
"description": "Wikipedia entry for the Heaviside step function.",
"short_url": "",
- "keywords": [
- "heaviside",
- "step",
- "function",
- "step function"
- ]
+ "keywords": ["heaviside", "step", "function", "step function"]
},
"https://en.wikipedia.org/wiki/Help:IPA/English": {
"id": "ipa-english",
"description": "Wikipedia entry for the International Phonetic Alphabet (IPA) for English.",
"short_url": "",
- "keywords": [
- "ipa",
- "english",
- "phonetic",
- "alphabet"
- ]
+ "keywords": ["ipa", "english", "phonetic", "alphabet"]
},
"https://en.wikipedia.org/wiki/Hermite_polynomials": {
"id": "hermite-polynomials",
"description": "Wikipedia entry for Hermite polynomials, a classic orthogonal polynomial sequence.",
"short_url": "",
- "keywords": [
- "hermite",
- "polynomial"
- ]
+ "keywords": ["hermite", "polynomial"]
},
"https://en.wikipedia.org/wiki/Horner%27s_method": {
"id": "horners-method",
"description": "Wikipedia entry for Horner's method, an algorithm for evaluating polynomials.",
"short_url": "",
- "keywords": [
- "horner",
- "polynomials",
- "algorithm",
- "math"
- ]
+ "keywords": ["horner", "polynomials", "algorithm", "math"]
},
"https://en.wikipedia.org/wiki/Huber_loss": {
"id": "huber-loss",
@@ -5682,12 +4002,7 @@
"id": "hyperbolic-functions",
"description": "Wikipedia entry for hyperbolic functions.",
"short_url": "",
- "keywords": [
- "trigonometry",
- "trig",
- "hyperbolic",
- "angle"
- ]
+ "keywords": ["trigonometry", "trig", "hyperbolic", "angle"]
},
"https://en.wikipedia.org/wiki/Hypergeometric_distribution": {
"id": "hypergeometric",
@@ -5720,58 +4035,31 @@
"id": "iso-week-date",
"description": "Wikipedia entry for the ISO week date.",
"short_url": "",
- "keywords": [
- "iso",
- "week",
- "date",
- "calendar"
- ]
+ "keywords": ["iso", "week", "date", "calendar"]
},
"https://en.wikipedia.org/wiki/Identity_function": {
"id": "identity-function",
"description": "Wikipedia entry for the identity function.",
"short_url": "",
- "keywords": [
- "identity",
- "math",
- "function",
- "fcn"
- ]
+ "keywords": ["identity", "math", "function", "fcn"]
},
"https://en.wikipedia.org/wiki/Imperative_mood": {
"id": "imperative-mood",
"description": "Wikipedia entry for the imperative mood.",
"short_url": "",
- "keywords": [
- "imperative",
- "mood",
- "grammar",
- "english"
- ]
+ "keywords": ["imperative", "mood", "grammar", "english"]
},
"https://en.wikipedia.org/wiki/Incomplete_beta_function": {
"id": "incomplete-beta-function",
"description": "Wikipedia entry for the incomplete beta function.",
"short_url": "",
- "keywords": [
- "beta",
- "special",
- "function",
- "incomplete",
- "math"
- ]
+ "keywords": ["beta", "special", "function", "incomplete", "math"]
},
"https://en.wikipedia.org/wiki/Incomplete_gamma_function": {
"id": "incomplete-gamma-function",
"description": "Wikipedia entry for the incomplete gamma function.",
"short_url": "",
- "keywords": [
- "gamma",
- "special",
- "function",
- "incomplete",
- "math"
- ]
+ "keywords": ["gamma", "special", "function", "incomplete", "math"]
},
"https://en.wikipedia.org/wiki/Index_of_dispersion": {
"id": "variance-to-mean-ratio",
@@ -5791,14 +4079,7 @@
"id": "integer",
"description": "Wikipedia entry for the integer data type.",
"short_url": "",
- "keywords": [
- "integer",
- "int",
- "data",
- "type",
- "computer",
- "science"
- ]
+ "keywords": ["integer", "int", "data", "type", "computer", "science"]
},
"https://en.wikipedia.org/wiki/Inverse-gamma_distribution": {
"id": "invgamma-distribution",
@@ -5849,13 +4130,7 @@
"id": "inverse-hyperbolic-functions",
"description": "Wikipedia page for inverse hyperbolic functions.",
"short_url": "",
- "keywords": [
- "trigonometry",
- "trig",
- "hyperbolic",
- "inverse",
- "angle"
- ]
+ "keywords": ["trigonometry", "trig", "hyperbolic", "inverse", "angle"]
},
"https://en.wikipedia.org/wiki/Inverse_trigonometric_functions": {
"id": "inverse-trigonmetric",
@@ -5892,26 +4167,13 @@
"id": "k-means-clustering",
"description": "Wikipedia entry for k-means clustering, an approach for partitioning a set of observations into k clusters.",
"short_url": "",
- "keywords": [
- "clustering",
- "machine learning",
- "ml",
- "kmeans",
- "k-means"
- ]
+ "keywords": ["clustering", "machine learning", "ml", "kmeans", "k-means"]
},
"https://en.wikipedia.org/wiki/Kronecker_delta": {
"id": "kronecker-delta",
"description": "Wikipedia entry for the Kronecker delta.",
"short_url": "",
- "keywords": [
- "kronecker",
- "delta",
- "math",
- "mathematics",
- "function",
- "fcn"
- ]
+ "keywords": ["kronecker", "delta", "math", "mathematics", "function", "fcn"]
},
"https://en.wikipedia.org/wiki/Kumaraswamy_distribution": {
"id": "kumaraswamy-distribution",
@@ -5960,35 +4222,19 @@
"id": "llvm",
"description": "Wikipedia entry for LLVM, a compiler infrastructure.",
"short_url": "",
- "keywords": [
- "compiler",
- "llvm"
- ]
+ "keywords": ["compiler", "llvm"]
},
"https://en.wikipedia.org/wiki/LaTeX": {
"id": "latex",
"description": "Wikipedia entry for documentation preparation system LaTeX.",
"short_url": "",
- "keywords": [
- "markup",
- "latex",
- "tex",
- "texteditor",
- "typesetting",
- "knuth"
- ]
+ "keywords": ["markup", "latex", "tex", "texteditor", "typesetting", "knuth"]
},
"https://en.wikipedia.org/wiki/Lanczos_approximation": {
"id": "lanczos-approximation",
"description": "Wikipedia entry on the Lanczos approximation for the gamma function.",
"short_url": "",
- "keywords": [
- "gamma",
- "lanczos",
- "approximation",
- "mathematics",
- "math"
- ]
+ "keywords": ["gamma", "lanczos", "approximation", "mathematics", "math"]
},
"https://en.wikipedia.org/wiki/Laplace_distribution": {
"id": "laplace-distribution",
@@ -6022,13 +4268,7 @@
"id": "leap-year",
"description": "Wikipedia entry for leap years.",
"short_url": "",
- "keywords": [
- "leap",
- "year",
- "calendar",
- "gregorian",
- "julian"
- ]
+ "keywords": ["leap", "year", "calendar", "gregorian", "julian"]
},
"https://en.wikipedia.org/wiki/Least_common_multiple": {
"id": "lcm",
@@ -6075,13 +4315,7 @@
"id": "http-status-codes",
"description": "Wikipedia entry for HTTP status codes.",
"short_url": "",
- "keywords": [
- "http",
- "status",
- "code",
- "codes",
- "response"
- ]
+ "keywords": ["http", "status", "code", "codes", "response"]
},
"https://en.wikipedia.org/wiki/Log-normal_distribution": {
"id": "lognormal-distribution",
@@ -6101,12 +4335,7 @@
"id": "logarithm",
"description": "Wikipedia entry for the logarithm, the inverse operation of exponentiation.",
"short_url": "",
- "keywords": [
- "log",
- "logarithm",
- "exp",
- "exponentiation"
- ]
+ "keywords": ["log", "logarithm", "exp", "exponentiation"]
},
"https://en.wikipedia.org/wiki/Logistic_distribution": {
"id": "logistic-distribution",
@@ -6126,25 +4355,13 @@
"id": "logistic-function",
"description": "Wikipedia entry for the logistic function.",
"short_url": "",
- "keywords": [
- "math",
- "sigmoid",
- "expit",
- "logistic",
- "logit"
- ]
+ "keywords": ["math", "sigmoid", "expit", "logistic", "logit"]
},
"https://en.wikipedia.org/wiki/Logit": {
"id": "logit",
"description": "Wikipedia entry for the logit function.",
"short_url": "",
- "keywords": [
- "math",
- "sigmoid",
- "expit",
- "logistic",
- "logit"
- ]
+ "keywords": ["math", "sigmoid", "expit", "logistic", "logit"]
},
"https://en.wikipedia.org/wiki/Lucas_number": {
"id": "lucas-number",
@@ -6178,13 +4395,7 @@
"id": "marginal-distribution",
"description": "Wikipedia entry describing marginal distributions.",
"short_url": "",
- "keywords": [
- "marginal",
- "distribution",
- "dist",
- "statistics",
- "stats"
- ]
+ "keywords": ["marginal", "distribution", "dist", "statistics", "stats"]
},
"https://en.wikipedia.org/wiki/Mean": {
"id": "mean",
@@ -6218,52 +4429,25 @@
"id": "mean-absolute-error",
"description": "Wikipedia entry for the mean absolute error which is a measure of the difference between two continuous variables.",
"short_url": "",
- "keywords": [
- "stats",
- "statistics",
- "mean",
- "average",
- "avg",
- "error"
- ]
+ "keywords": ["stats", "statistics", "mean", "average", "avg", "error"]
},
"https://en.wikipedia.org/wiki/Mean_absolute_percentage_error": {
"id": "mean-absolute-percentage-error",
"description": "Wikipedia entry for the mean absolute percentage error (MAPE), which is used to access how well a model's forecast compares to actual values.",
"short_url": "",
- "keywords": [
- "mpe",
- "mape",
- "statistics",
- "stats",
- "forecasting",
- "error"
- ]
+ "keywords": ["mpe", "mape", "statistics", "stats", "forecasting", "error"]
},
"https://en.wikipedia.org/wiki/Mean_percentage_error": {
"id": "mean-percentage-error",
"description": "Wikipedia entry for the mean percentage error (MPE), which is used to assess how well a model's forecast compares to actual values.",
"short_url": "",
- "keywords": [
- "mpe",
- "statistics",
- "stats",
- "forecasting",
- "error"
- ]
+ "keywords": ["mpe", "statistics", "stats", "forecasting", "error"]
},
"https://en.wikipedia.org/wiki/Mean_squared_error": {
"id": "mean-squared-error",
"description": "Wikipedia entry for the mean squared error (MSE).",
"short_url": "",
- "keywords": [
- "mse",
- "statistics",
- "stats",
- "error",
- "model",
- "prediction"
- ]
+ "keywords": ["mse", "statistics", "stats", "error", "model", "prediction"]
},
"https://en.wikipedia.org/wiki/Median": {
"id": "median",
@@ -6368,10 +4552,7 @@
"id": "nop",
"description": "Wikipedia entry for the no operation instruction.",
"short_url": "",
- "keywords": [
- "programming",
- "acronyms"
- ]
+ "keywords": ["programming", "acronyms"]
},
"https://en.wikipedia.org/wiki/Nat_%28unit%29": {
"id": "nats",
@@ -6391,11 +4572,7 @@
"id": "natural-logarithm",
"description": "Wikipedia entry for the natural logarithm.",
"short_url": "",
- "keywords": [
- "logarithm",
- "log",
- "ln"
- ]
+ "keywords": ["logarithm", "log", "ln"]
},
"https://en.wikipedia.org/wiki/Nearest_integer_function": {
"id": "nearest-integer",
@@ -6449,22 +4626,13 @@
"id": "newline",
"description": "Wikipedia entry for the newline character.",
"short_url": "",
- "keywords": [
- "programming",
- "newline",
- "new line",
- "line break"
- ]
+ "keywords": ["programming", "newline", "new line", "line break"]
},
"https://en.wikipedia.org/wiki/Norm_%28mathematics%29": {
"id": "l1norm",
"description": "Wikipedia entry for the L1 norm.",
"short_url": "",
- "keywords": [
- "l1",
- "norm",
- "math"
- ]
+ "keywords": ["l1", "norm", "math"]
},
"https://en.wikipedia.org/wiki/Norm_%28mathematics%29#Euclidean_norm": {
"id": "euclidean-norm",
@@ -6498,35 +4666,19 @@
"id": "nth-root",
"description": "Wikipedia entry for the nth root.",
"short_url": "",
- "keywords": [
- "root",
- "nth",
- "math",
- "mathematics",
- "algebra",
- "algebraic"
- ]
+ "keywords": ["root", "nth", "math", "mathematics", "algebra", "algebraic"]
},
"https://en.wikipedia.org/wiki/Operator_overloading": {
"id": "operator-overloading",
"description": "Wikipedia entry for operator overloading.",
"short_url": "",
- "keywords": [
- "programming",
- "operators",
- "overloading"
- ]
+ "keywords": ["programming", "operators", "overloading"]
},
"https://en.wikipedia.org/wiki/POSIX": {
"id": "posix",
"description": "Wikipedia entry for the Portable Operating System Interface.",
"short_url": "",
- "keywords": [
- "programming",
- "unix",
- "linux",
- "os"
- ]
+ "keywords": ["programming", "unix", "linux", "os"]
},
"https://en.wikipedia.org/wiki/Pareto_distribution": {
"id": "pareto-distribution",
@@ -6575,12 +4727,7 @@
"id": "persymmetric-matrix",
"description": "Wikipedia entry for persymmetric matrices.",
"short_url": "",
- "keywords": [
- "persymmetric",
- "matrix",
- "linear algebra",
- "symmetric"
- ]
+ "keywords": ["persymmetric", "matrix", "linear algebra", "symmetric"]
},
"https://en.wikipedia.org/wiki/Pi": {
"id": "pi",
@@ -6599,12 +4746,7 @@
"id": "standard-stream",
"description": "Wikipedia entry for UNIX pipelines.",
"short_url": "",
- "keywords": [
- "standard",
- "stream",
- "unix",
- "pipeline"
- ]
+ "keywords": ["standard", "stream", "unix", "pipeline"]
},
"https://en.wikipedia.org/wiki/Poisson_distribution": {
"id": "poisson-distribution",
@@ -6624,13 +4766,7 @@
"id": "polar-area-diagram",
"description": "Wikipedia section on the polar area diagram.",
"short_url": "",
- "keywords": [
- "visualization",
- "viz",
- "plot",
- "piechart",
- "chart"
- ]
+ "keywords": ["visualization", "viz", "plot", "piechart", "chart"]
},
"https://en.wikipedia.org/wiki/Polygamma_function": {
"id": "polygamma-function",
@@ -6651,11 +4787,7 @@
"id": "polynomial",
"description": "Wikipedia entry for polynomials.",
"short_url": "",
- "keywords": [
- "polynomial",
- "math",
- "mathematics"
- ]
+ "keywords": ["polynomial", "math", "mathematics"]
},
"https://en.wikipedia.org/wiki/Portable_Network_Graphics": {
"id": "png",
@@ -6676,13 +4808,7 @@
"id": "box-cox-transformation",
"description": "Wikipedia entry for the Box-Cox transformation.",
"short_url": "",
- "keywords": [
- "box-cox",
- "transformation",
- "power",
- "transform",
- "math"
- ]
+ "keywords": ["box-cox", "transformation", "power", "transform", "math"]
},
"https://en.wikipedia.org/wiki/Probability_density_function": {
"id": "pdf",
@@ -6757,12 +4883,7 @@
"id": "reaumur-scale",
"description": "Wikipedia entry for the Réaumur scale.",
"short_url": "",
- "keywords": [
- "temperature",
- "scale",
- "reaumur",
- "réaumur"
- ]
+ "keywords": ["temperature", "scale", "reaumur", "réaumur"]
},
"https://en.wikipedia.org/wiki/Raised_cosine_distribution": {
"id": "raised-cosine-distribution",
@@ -6783,35 +4904,19 @@
"id": "ramp-function",
"description": "Wikipedia entry for the ramp function.",
"short_url": "",
- "keywords": [
- "ramp",
- "function",
- "math",
- "mathematics"
- ]
+ "keywords": ["ramp", "function", "math", "mathematics"]
},
"https://en.wikipedia.org/wiki/Range_%28statistics%29": {
"id": "range",
"description": "Wikipedia entry for the range of a set of data.",
"short_url": "",
- "keywords": [
- "statistics",
- "stats",
- "range",
- "data",
- "set"
- ]
+ "keywords": ["statistics", "stats", "range", "data", "set"]
},
"https://en.wikipedia.org/wiki/Rational_function": {
"id": "rational-function",
"description": "Wikipedia entry for rational functions.",
"short_url": "",
- "keywords": [
- "rational",
- "function",
- "math",
- "mathematics"
- ]
+ "keywords": ["rational", "function", "math", "mathematics"]
},
"https://en.wikipedia.org/wiki/Rayleigh_distribution": {
"id": "rayleigh-distribution",
@@ -6831,24 +4936,13 @@
"id": "real",
"description": "Wikipedia entry for real numbers.",
"short_url": "",
- "keywords": [
- "real",
- "number",
- "math",
- "mathematics"
- ]
+ "keywords": ["real", "number", "math", "mathematics"]
},
"https://en.wikipedia.org/wiki/Relative_change_and_difference": {
"id": "relative-difference",
"description": "Wikipedia entry for relative difference.",
"short_url": "",
- "keywords": [
- "relative",
- "difference",
- "change",
- "math",
- "mathematics"
- ]
+ "keywords": ["relative", "difference", "change", "math", "mathematics"]
},
"https://en.wikipedia.org/wiki/Residual_sum_of_squares": {
"id": "residual-sum-of-squares",
@@ -6868,13 +4962,7 @@
"id": "zeta-function",
"description": "Wikipedia entry for the Riemann zeta function.",
"short_url": "",
- "keywords": [
- "zeta",
- "special",
- "function",
- "math",
- "mathematics"
- ]
+ "keywords": ["zeta", "special", "function", "math", "mathematics"]
},
"https://en.wikipedia.org/wiki/Root-mean-square_deviation": {
"id": "root-mean-squared-error",
@@ -6894,12 +4982,7 @@
"id": "rounding",
"description": "Wikipedia entry on rounding, an operation which replaces a numerical value by another value that is approximately equal to the original number but has a shorter, simpler, or more explicit representation.",
"short_url": "",
- "keywords": [
- "round",
- "rounding",
- "floating-point",
- "math"
- ]
+ "keywords": ["round", "rounding", "floating-point", "math"]
},
"https://en.wikipedia.org/wiki/Scale_parameter": {
"id": "scale",
@@ -6919,78 +5002,43 @@
"id": "oxford-comma",
"description": "Wikipedia entry for the Oxford comma, also known as the serial comma.",
"short_url": "",
- "keywords": [
- "serial",
- "comma",
- "oxford",
- "punctuation"
- ]
+ "keywords": ["serial", "comma", "oxford", "punctuation"]
},
"https://en.wikipedia.org/wiki/Series_%28mathematics%29": {
"id": "infinite-series",
"description": "Wikipedia entry for infinite series.",
"short_url": "",
- "keywords": [
- "series",
- "infinite",
- "math",
- "mathematics"
- ]
+ "keywords": ["series", "infinite", "math", "mathematics"]
},
"https://en.wikipedia.org/wiki/Shape_parameter": {
"id": "shape",
"description": "Wikipedia entry for the shape parameter.",
"short_url": "",
- "keywords": [
- "shape",
- "parameter",
- "statistics",
- "stats"
- ]
+ "keywords": ["shape", "parameter", "statistics", "stats"]
},
"https://en.wikipedia.org/wiki/Sign_function": {
"id": "signum",
"description": "Wikipedia entry for the signum function.",
"short_url": "",
- "keywords": [
- "signum",
- "sign",
- "function",
- "math"
- ]
+ "keywords": ["signum", "sign", "function", "math"]
},
"https://en.wikipedia.org/wiki/Significand": {
"id": "significand",
"description": "Wikipedia entry for the significand of a floating-point number.",
"short_url": "",
- "keywords": [
- "significand",
- "floating-point",
- "math"
- ]
+ "keywords": ["significand", "floating-point", "math"]
},
"https://en.wikipedia.org/wiki/Sinc_function": {
"id": "sinc",
"description": "Wikipedia entry for the sinc function.",
"short_url": "",
- "keywords": [
- "sinc",
- "function",
- "math",
- "mathematics"
- ]
+ "keywords": ["sinc", "function", "math", "mathematics"]
},
"https://en.wikipedia.org/wiki/Sine": {
"id": "sine",
"description": "Wikipedia entry for the sine function.",
"short_url": "",
- "keywords": [
- "sine",
- "trigonometry",
- "trig",
- "math",
- "mathematics"
- ]
+ "keywords": ["sine", "trigonometry", "trig", "math", "mathematics"]
},
"https://en.wikipedia.org/wiki/Skew-symmetric_matrix": {
"id": "skew-symmetric-matrix",
@@ -7008,59 +5056,31 @@
"id": "skewness",
"description": "Wikipedia entry for the skewness.",
"short_url": "",
- "keywords": [
- "distribution",
- "dist",
- "statistics",
- "stats",
- "probability"
- ]
+ "keywords": ["distribution", "dist", "statistics", "stats", "probability"]
},
"https://en.wikipedia.org/wiki/Spence%27s_function": {
"id": "spence",
"description": "Wikipedia entry for Spence's function.",
"short_url": "",
- "keywords": [
- "spence",
- "function",
- "math",
- "mathematics"
- ]
+ "keywords": ["spence", "function", "math", "mathematics"]
},
"https://en.wikipedia.org/wiki/Square_root": {
"id": "square-root",
"description": "Wikipedia entry for the square root.",
"short_url": "",
- "keywords": [
- "mathematics",
- "math",
- "function",
- "root"
- ]
+ "keywords": ["mathematics", "math", "function", "root"]
},
"https://en.wikipedia.org/wiki/Square_triangular_number": {
"id": "square-triangular-number",
"description": "Wikipedia entry for square triangular numbers.",
"short_url": "",
- "keywords": [
- "triangular",
- "square",
- "numbers",
- "integers",
- "sequences"
- ]
+ "keywords": ["triangular", "square", "numbers", "integers", "sequences"]
},
"https://en.wikipedia.org/wiki/Squared_triangular_number": {
"id": "squared-triangular-number",
"description": "Wikipedia entry for squared triangular numbers.",
"short_url": "",
- "keywords": [
- "triangular",
- "numbers",
- "integers",
- "squared",
- "sequences"
- ]
+ "keywords": ["triangular", "numbers", "integers", "squared", "sequences"]
},
"https://en.wikipedia.org/wiki/Standard_deviation": {
"id": "stdev",
@@ -7117,12 +5137,7 @@
"id": "sotu",
"description": "Wikipedia entry on the State of the Union address, an annual speech given by U.S. presidents.",
"short_url": "",
- "keywords": [
- "sotu",
- "usa",
- "president",
- "speech"
- ]
+ "keywords": ["sotu", "usa", "president", "speech"]
},
"https://en.wikipedia.org/wiki/Stochastic_gradient_descent": {
"id": "stochastic-gradient-descent",
@@ -7141,13 +5156,7 @@
"id": "stopwords",
"description": "Wikipedia entry on stop words, which are filtered from text for many natural language processing (NLP) tasks.",
"short_url": "",
- "keywords": [
- "nlp",
- "text",
- "ir",
- "stopword",
- "preprocessing"
- ]
+ "keywords": ["nlp", "text", "ir", "stopword", "preprocessing"]
},
"https://en.wikipedia.org/wiki/Student%27s_t-distribution": {
"id": "t-distribution",
@@ -7197,56 +5206,31 @@
"id": "symmetric-matrix",
"description": "Wikipedia entry for symmetric matrix, a matrix which equals its transpose.",
"short_url": "",
- "keywords": [
- "linear algebra",
- "symmetric",
- "matrix"
- ]
+ "keywords": ["linear algebra", "symmetric", "matrix"]
},
"https://en.wikipedia.org/wiki/Tangent": {
"id": "tangent",
"description": "Wikipedia entry for the tangent function.",
"short_url": "",
- "keywords": [
- "trigonometry",
- "tangent",
- "function",
- "math",
- "mathematics"
- ]
+ "keywords": ["trigonometry", "tangent", "function", "math", "mathematics"]
},
"https://en.wikipedia.org/wiki/TeX": {
"id": "tex",
"description": "Wikipedia entry for the TeX typesetting system.",
"short_url": "",
- "keywords": [
- "markup",
- "latex",
- "tex",
- "typesetting",
- "knuth",
- "typography"
- ]
+ "keywords": ["markup", "latex", "tex", "typesetting", "knuth", "typography"]
},
"https://en.wikipedia.org/wiki/Thunk": {
"id": "thunk",
"description": "Wikpedia for a thunk.",
"short_url": "",
- "keywords": [
- "thunk",
- "functional",
- "programming"
- ]
+ "keywords": ["thunk", "functional", "programming"]
},
"https://en.wikipedia.org/wiki/Tikhonov_regularization": {
"id": "tikhonov-regularization",
"description": "Wikipedia page for Tikhonov regularization.",
"short_url": "",
- "keywords": [
- "regularization",
- "regression",
- "l2-regularization"
- ]
+ "keywords": ["regularization", "regression", "l2-regularization"]
},
"https://en.wikipedia.org/wiki/Triangular_distribution": {
"id": "triangular-distribution",
@@ -7266,34 +5250,19 @@
"id": "triangular-number",
"description": "Wikipedia entry for triangular numbers.",
"short_url": "",
- "keywords": [
- "triangular",
- "number",
- "binomial",
- "sequence"
- ]
+ "keywords": ["triangular", "number", "binomial", "sequence"]
},
"https://en.wikipedia.org/wiki/Trigamma_function": {
"id": "trigamma-function",
"description": "Wikipedia entry for the trigamma function.",
"short_url": "",
- "keywords": [
- "trigamma",
- "special",
- "function",
- "math",
- "mathematics"
- ]
+ "keywords": ["trigamma", "special", "function", "math", "mathematics"]
},
"https://en.wikipedia.org/wiki/Trigonometric_functions": {
"id": "trigonometric-functions",
"description": "Wikipedia entry for trigonometric functions.",
"short_url": "",
- "keywords": [
- "trigonometry",
- "trig",
- "math"
- ]
+ "keywords": ["trigonometry", "trig", "math"]
},
"https://en.wikipedia.org/wiki/Truncated_normal_distribution": {
"id": "truncated-normal-distribution",
@@ -7314,14 +5283,7 @@
"id": "uri",
"description": "Wikipedia entry on Uniform Resource Identifiers (URIs) to identify resources in a network.",
"short_url": "",
- "keywords": [
- "internet",
- "web",
- "uri",
- "standard",
- "identifier",
- "protocol"
- ]
+ "keywords": ["internet", "web", "uri", "standard", "identifier", "protocol"]
},
"https://en.wikipedia.org/wiki/UTF-16": {
"id": "utf-16",
@@ -7355,11 +5317,7 @@
"id": "unicode",
"description": "Wikipedia entry for Unicode, a computing industry standard for the consistent encoding, representation, and handling of text.",
"short_url": "",
- "keywords": [
- "unicode",
- "standard",
- "text"
- ]
+ "keywords": ["unicode", "standard", "text"]
},
"https://en.wikipedia.org/wiki/Uniform_distribution_%28continuous%29": {
"id": "uniform-distribution",
@@ -7392,26 +5350,13 @@
"id": "uuid",
"description": "Wikipedia entry for universally unique identifiers.",
"short_url": "",
- "keywords": [
- "uuid",
- "unique",
- "identifier",
- "id",
- "hash",
- "random"
- ]
+ "keywords": ["uuid", "unique", "identifier", "id", "hash", "random"]
},
"https://en.wikipedia.org/wiki/Unix_time": {
"id": "unix-time",
"description": "Wikipedia entry describing system for describing a point in time, defined as the number of seconds that have elapsed since 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970, minus the number of leap seconds that have taken place since then.",
"short_url": "",
- "keywords": [
- "unix",
- "time",
- "timestamp",
- "ts",
- "epoch"
- ]
+ "keywords": ["unix", "time", "timestamp", "ts", "epoch"]
},
"https://en.wikipedia.org/wiki/Valence_%28psychology%29": {
"id": "valence",
@@ -7461,25 +5406,13 @@
"id": "weighted-arithmetic-mean",
"description": "Wikipedia entry for the weighted arithmetic mean.",
"short_url": "",
- "keywords": [
- "mean",
- "weighted",
- "statistics",
- "stats",
- "average",
- "avg"
- ]
+ "keywords": ["mean", "weighted", "statistics", "stats", "average", "avg"]
},
"https://en.wikipedia.org/wiki/Whitespace_character": {
"id": "whitespace",
"description": "Wikipedia entry on whitespace characters.",
"short_url": "",
- "keywords": [
- "whitespace",
- "encoding",
- "cs",
- "character"
- ]
+ "keywords": ["whitespace", "encoding", "cs", "character"]
},
"https://en.wikipedia.org/wiki/Xorshift": {
"id": "xorshift*",
@@ -7500,26 +5433,13 @@
"id": "zsh",
"description": "Wikipedia for Z shell (Zsh).",
"short_url": "",
- "keywords": [
- "zsh",
- "shell",
- "terminal",
- "development",
- "dev"
- ]
+ "keywords": ["zsh", "shell", "terminal", "development", "dev"]
},
"https://en.wikipedia.org/wiki/Ziggurat_algorithm": {
"id": "ziggurat-algorithm",
"description": "Wikipedia entry for the Ziggurat algorithm to generate standard normal pseudorandom numbers.",
"short_url": "",
- "keywords": [
- "random",
- "rng",
- "prng",
- "algorithm",
- "gaussian",
- "normal"
- ]
+ "keywords": ["random", "rng", "prng", "algorithm", "gaussian", "normal"]
},
"https://en.wikipedia.org/wiki/hypergeometric_distribution": {
"id": "hypergeometric-distribution",
@@ -7539,24 +5459,13 @@
"id": "us-copyright",
"description": "Paragraphs 105 and 106 of the United States Code, establishing that copyright protection is not available for works of the government.",
"short_url": "",
- "keywords": [
- "copyright",
- "law",
- "government",
- "usa",
- "publicdomain"
- ]
+ "keywords": ["copyright", "law", "government", "usa", "publicdomain"]
},
"https://en.wiktionary.org/wiki/alphagram": {
"id": "alphagram",
"description": "Wiktionary entry for alphagrams.",
"short_url": "",
- "keywords": [
- "alphabetical",
- "anagram",
- "words",
- "letters"
- ]
+ "keywords": ["alphabetical", "anagram", "words", "letters"]
},
"https://esdiscuss.org/topic/es6-accuracy-of-special-functions": {
"id": "@bug:esdiscuss:038525",
@@ -7576,36 +5485,19 @@
"id": "@bug:esdiscuss:2013-03-20",
"description": "ES Discuss thread discussing the observability of NaN distinctions.",
"short_url": "",
- "keywords": [
- "es6",
- "es2015",
- "math",
- "NaN"
- ]
+ "keywords": ["es6", "es2015", "math", "NaN"]
},
"https://eslint.org/": {
"id": "eslint",
"description": "A pluggable linting utility for JavaScript. Official website.",
"short_url": "",
- "keywords": [
- "lint",
- "linting",
- "linter",
- "javascript",
- "ecmascript"
- ]
+ "keywords": ["lint", "linting", "linter", "javascript", "ecmascript"]
},
"https://eslint.org/docs/developer-guide/working-with-rules": {
"id": "eslint-rules",
"description": "ESLint documentation for working with rules.",
"short_url": "",
- "keywords": [
- "eslint",
- "rules",
- "linting",
- "js",
- "javascript"
- ]
+ "keywords": ["eslint", "rules", "linting", "js", "javascript"]
},
"https://fivethirtyeight.com/features/you-cant-trust-what-you-read-about-nutrition/": {
"id": "fivethirtyeight-nutrition-studies",
@@ -7628,14 +5520,7 @@
"id": "gfortran",
"description": "GNU Fortran compiler.",
"short_url": "",
- "keywords": [
- "gfortran",
- "fortran",
- "compiler",
- "cs",
- "development",
- "dev"
- ]
+ "keywords": ["gfortran", "fortran", "compiler", "cs", "development", "dev"]
},
"https://gcc.gnu.org/wiki/GFortranBinaries": {
"id": "gfortran-wiki",
@@ -7655,70 +5540,37 @@
"id": "geek-feminism-code-of-conduct",
"description": "Geek Feminism Code of Conduct.",
"short_url": "",
- "keywords": [
- "code",
- "conduct",
- "geek",
- "feminism"
- ]
+ "keywords": ["code", "conduct", "geek", "feminism"]
},
"https://gist.github.com/": {
"id": "github-gist",
"description": "GitHub Gist, a service for sharing code snippets.",
"short_url": "",
- "keywords": [
- "github",
- "gist",
- "code",
- "snippet",
- "share"
- ]
+ "keywords": ["github", "gist", "code", "snippet", "share"]
},
"https://gist.github.com/branneman/8048520": {
"id": "list-of-require-hacks",
"description": "List of hacks to get around long require paths in Node.js require() calls.",
"short_url": "",
- "keywords": [
- "require",
- "hacks",
- "node",
- "js",
- "javascript"
- ]
+ "keywords": ["require", "hacks", "node", "js", "javascript"]
},
"https://git-scm.com/": {
"id": "git",
"description": "The official website for Git, a free and open-source distributed version control system.",
"short_url": "",
- "keywords": [
- "git",
- "vcs",
- "version",
- "control",
- "system"
- ]
+ "keywords": ["git", "vcs", "version", "control", "system"]
},
"https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks": {
"id": "git-hooks",
"description": "Git documentation describing Git hooks, which are scripts triggered when certain actions occur.",
"short_url": "",
- "keywords": [
- "git",
- "hooks",
- "scripts"
- ]
+ "keywords": ["git", "hooks", "scripts"]
},
"https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes": {
"id": "git-remotes",
"description": "Git documentation describing remotes, which are named references to other repositories.",
"short_url": "",
- "keywords": [
- "git",
- "remotes",
- "remote",
- "repository",
- "repo"
- ]
+ "keywords": ["git", "remotes", "remote", "repository", "repo"]
},
"https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History": {
"id": "git-rewriting-history",
@@ -7753,39 +5605,25 @@
"id": "git-clone-depth",
"description": "Git documentation describing the --depth option for git clone.",
"short_url": "",
- "keywords": [
- "git",
- "clone",
- "depth"
- ]
+ "keywords": ["git", "clone", "depth"]
},
"https://git-scm.com/docs/git-merge": {
"id": "git-merge",
"description": "Git documentation describing the git merge command.",
"short_url": "",
- "keywords": [
- "git",
- "merge"
- ]
+ "keywords": ["git", "merge"]
},
"https://git-scm.com/docs/git-rebase": {
"id": "git-rebase",
"description": "Git documentation describing the git rebase command.",
"short_url": "",
- "keywords": [
- "git",
- "rebase"
- ]
+ "keywords": ["git", "rebase"]
},
"https://github.com/315234/SublimeFortran": {
"id": "sublime-text-fortran",
"description": "GitHub repository for a Sublime Text plugin which provides syntax highlighting for Fortran.",
"short_url": "",
- "keywords": [
- "sublime",
- "text",
- "fortran"
- ]
+ "keywords": ["sublime", "text", "fortran"]
},
"https://github.com/ChristianKohler/PathIntellisense": {
"id": "vscode-path-intellisense",
@@ -7803,54 +5641,31 @@
"id": "vscode-fortran",
"description": "GitHub repository for a Visual Studio Code plugin which provides syntax highlighting for Fortran.",
"short_url": "",
- "keywords": [
- "vscode",
- "fortran"
- ]
+ "keywords": ["vscode", "fortran"]
},
"https://github.com/Jason-Rev/vscode-spell-checker": {
"id": "vscode-spell-checker",
"description": "GitHub repository for a Visual Studio Code plugin which provides spell checking.",
"short_url": "",
- "keywords": [
- "vscode",
- "spell",
- "checker"
- ]
+ "keywords": ["vscode", "spell", "checker"]
},
"https://github.com/Jason-Rev/vscode-spell-checker/blob/master/client/README.md": {
"id": "vscode-spell-checker-readme",
"description": "README.md for a Visual Studio Code plugin which provides spell checking.",
"short_url": "",
- "keywords": [
- "vscode",
- "spell",
- "checker"
- ]
+ "keywords": ["vscode", "spell", "checker"]
},
"https://github.com/JohnNilsson/awk-sublime": {
"id": "sublime-text-awk",
"description": "GitHub repository for a Sublime Text plugin which provides syntax highlighting for AWK.",
"short_url": "",
- "keywords": [
- "awk",
- "sublime",
- "text",
- "editor",
- "plugin"
- ]
+ "keywords": ["awk", "sublime", "text", "editor", "plugin"]
},
"https://github.com/JuliaEditorSupport/Julia-sublime": {
"id": "sublime-text-julia",
"description": "GitHub repository for a Sublime Text plugin which provides syntax highlighting for Julia.",
"short_url": "",
- "keywords": [
- "julia",
- "sublime",
- "text",
- "editor",
- "plugin"
- ]
+ "keywords": ["julia", "sublime", "text", "editor", "plugin"]
},
"https://github.com/JuliaEditorSupport/julia-vscode": {
"id": "vscode-julia",
@@ -7870,31 +5685,19 @@
"id": "virtual-dom",
"description": "A Virtual DOM and diffing algorithm. The official repository of virtual-dom.",
"short_url": "",
- "keywords": [
- "vdom",
- "virtual",
- "dom"
- ]
+ "keywords": ["vdom", "virtual", "dom"]
},
"https://github.com/Medium/medium-policy/blob/3c76f50e5e6a529c8352c85c9ed596ef95f863b7/privacy-policy.md": {
"id": "medium-privacy-policy",
"description": "The privacy policy of Medium, a blogging platform.",
"short_url": "",
- "keywords": [
- "medium",
- "privacy",
- "policy"
- ]
+ "keywords": ["medium", "privacy", "policy"]
},
"https://github.com/Medium/medium-policy/blob/3c76f50e5e6a529c8352c85c9ed596ef95f863b7/terms-of-service.md": {
"id": "medium-terms-of-service",
"description": "The terms of service of Medium, a blogging platform.",
"short_url": "",
- "keywords": [
- "medium",
- "terms",
- "service"
- ]
+ "keywords": ["medium", "terms", "service"]
},
"https://github.com/Microsoft/TypeScript-Sublime-Plugin": {
"id": "sublime-text-typescript",
@@ -7914,13 +5717,7 @@
"id": "dtslint",
"description": "GitHub repository for dtslint, a utility for testing TypeScript definition files for style and correctness.",
"short_url": "",
- "keywords": [
- "typescript",
- "tslint",
- "definition files",
- "ts",
- "lint"
- ]
+ "keywords": ["typescript", "tslint", "definition files", "ts", "lint"]
},
"https://github.com/Microsoft/vscode-eslint": {
"id": "vscode-eslint",
@@ -7954,58 +5751,31 @@
"id": "philipp-burckhardt-github",
"description": "GitHub profile of Philipp Burckhardt",
"short_url": "",
- "keywords": [
- "github",
- "philipp",
- "burckhardt"
- ]
+ "keywords": ["github", "philipp", "burckhardt"]
},
"https://github.com/Planeshifter/emscripten-examples": {
"id": "planeshifter-examples",
"description": "GitHub repository with Emscripten example code.",
"short_url": "",
- "keywords": [
- "emscripten",
- "examples",
- "github"
- ]
+ "keywords": ["emscripten", "examples", "github"]
},
"https://github.com/PyCQA/pycodestyle": {
"id": "pycodestyle",
"description": "Python style guide checker.",
"short_url": "",
- "keywords": [
- "python",
- "lint",
- "linter",
- "linting",
- "style",
- "guide"
- ]
+ "keywords": ["python", "lint", "linter", "linting", "style", "guide"]
},
"https://github.com/PyCQA/pydocstyle": {
"id": "pydocstyle",
"description": "Python docstring style checker.",
"short_url": "",
- "keywords": [
- "python",
- "docstring",
- "lint",
- "linter",
- "linting",
- "style"
- ]
+ "keywords": ["python", "docstring", "lint", "linter", "linting", "style"]
},
"https://github.com/PyCQA/pylint": {
"id": "pylint",
"description": "Pylint is a Python source code analyzer which looks for programming errors, helps enforcing a coding standard, and sniffs for some code smells.",
"short_url": "",
- "keywords": [
- "python",
- "lint",
- "linter",
- "linting"
- ]
+ "keywords": ["python", "lint", "linter", "linting"]
},
"https://github.com/Samsung/iotjs": {
"id": "iot-js",
@@ -8040,35 +5810,19 @@
"id": "sublime-text-sidebar-enhancements",
"description": "Sublime Text package which provides enhancements to the Sublime Text sidebar.",
"short_url": "",
- "keywords": [
- "sublime",
- "text",
- "editor",
- "sidebar"
- ]
+ "keywords": ["sublime", "text", "editor", "sidebar"]
},
"https://github.com/SublimeLinter/SublimeLinter-annotations": {
"id": "sublime-text-sublimelinter-annotations",
"description": "Plugin for SublimeLinter3 which marks annotations such as TODO, FIXME, etc.",
"short_url": "",
- "keywords": [
- "sublime",
- "text",
- "plugin",
- "linting",
- "lint"
- ]
+ "keywords": ["sublime", "text", "plugin", "linting", "lint"]
},
"https://github.com/SublimeLinter/SublimeLinter-json": {
"id": "sublime-text-sublimelinter-json",
"description": "Plugin for SublimeLinter3 which lints JSON.",
"short_url": "",
- "keywords": [
- "sublime",
- "text",
- "plugin",
- "json"
- ]
+ "keywords": ["sublime", "text", "plugin", "json"]
},
"https://github.com/SublimeLinter/SublimeLinter-shellcheck": {
"id": "sublime-text-sublimelinter-shellcheck",
@@ -8088,111 +5842,61 @@
"id": "sublime-text-sublimelinter3",
"description": "Linting framework for Sublime Text 3.",
"short_url": "",
- "keywords": [
- "sublime",
- "text",
- "editor",
- "linting",
- "lint"
- ]
+ "keywords": ["sublime", "text", "editor", "linting", "lint"]
},
"https://github.com/SublimeText-Markdown/MarkdownEditing": {
"id": "sublime-text-markdownediting",
"description": "GitHub repository for a Sublime Text plugin which provides syntax highlighting (including for fenced code blocks) and editing features for Markdown.",
"short_url": "",
- "keywords": [
- "markdown",
- "sublime",
- "text",
- "editor",
- "plugin"
- ]
+ "keywords": ["markdown", "sublime", "text", "editor", "plugin"]
},
"https://github.com/WebAssembly/spec/": {
"id": "wasm",
"description": "GitHub repository for the WebAssembly specification.",
"short_url": "",
- "keywords": [
- "wasm",
- "webassembly",
- "specification"
- ]
+ "keywords": ["wasm", "webassembly", "specification"]
},
"https://github.com/WebAssembly/wabt": {
"id": "wabt",
"description": "The GitHub repository for the WebAssembly Binary Toolkit (WABT), a suite of tools for developing with WebAssembly.",
"short_url": "",
- "keywords": [
- "webassembly",
- "wasm",
- "wabt",
- "wast",
- "wat",
- "toolkit"
- ]
+ "keywords": ["webassembly", "wasm", "wabt", "wast", "wat", "toolkit"]
},
"https://github.com/airbnb/javascript": {
"id": "airbnb",
"description": "Airbnb JavaScript Style Guide.",
"short_url": "",
- "keywords": [
- "javascript",
- "style",
- "guide"
- ]
+ "keywords": ["javascript", "style", "guide"]
},
"https://github.com/bevacqua/js": {
"id": "quality-guide",
"description": "A guide to writing high quality JavaScript.",
"short_url": "",
- "keywords": [
- "javascript",
- "guide",
- "quality"
- ]
+ "keywords": ["javascript", "guide", "quality"]
},
"https://github.com/buildfirst/buildfirst/tree/master/ch05/04_hoisting": {
"id": "hoisting",
"description": "Variable hoisting in JavaScript.",
"short_url": "",
- "keywords": [
- "javascript",
- "hoisting"
- ]
+ "keywords": ["javascript", "hoisting"]
},
"https://github.com/creationix/nvm": {
"id": "nvm",
"description": "Node Version Manager, a simple bash script to manage multiple active Node.js versions.",
"short_url": "",
- "keywords": [
- "node",
- "version",
- "manager",
- "nvm"
- ]
+ "keywords": ["node", "version", "manager", "nvm"]
},
"https://github.com/dslomov/typed-objects-es7": {
"id": "typed-objects-proposal",
"description": "Typed Objects proposal for ECMAScript 7.",
"short_url": "",
- "keywords": [
- "typed",
- "objects",
- "proposal",
- "ecmascript",
- "es7"
- ]
+ "keywords": ["typed", "objects", "proposal", "ecmascript", "es7"]
},
"https://github.com/dzhibas/SublimePrettyJson": {
"id": "sublime-text-pretty-json",
"description": "Sublime Text package for pretty printing and minifying JSON.",
"short_url": "",
- "keywords": [
- "sublime",
- "text",
- "editor",
- "json"
- ]
+ "keywords": ["sublime", "text", "editor", "json"]
},
"https://github.com/editorconfig/editorconfig-vscode": {
"id": "vscode-editorconfig",
@@ -8212,21 +5916,13 @@
"id": "emscripten-sdk",
"description": "Emscripten SDK.",
"short_url": "",
- "keywords": [
- "emscripten",
- "sdk"
- ]
+ "keywords": ["emscripten", "sdk"]
},
"https://github.com/felixrieseberg/windows-build-tools": {
"id": "node-windows-build-tools",
"description": "A set of tools to build native Windows modules for Node.js.",
"short_url": "",
- "keywords": [
- "node",
- "windows",
- "build",
- "tools"
- ]
+ "keywords": ["node", "windows", "build", "tools"]
},
"https://github.com/feross/buffer": {
"id": "browser-buffer",
@@ -8245,44 +5941,25 @@
"id": "golang-float64bits",
"description": "Go's Float64bits function.",
"short_url": "",
- "keywords": [
- "golang",
- "go",
- "float64bits"
- ]
+ "keywords": ["golang", "go", "float64bits"]
},
"https://github.com/golang/go/blob/c007ce824d9a4fccb148f9204e04c23ed2984b71/src/math/frexp.go#L27": {
"id": "golang-frexp",
"description": "Go implementation of the frexp function.",
"short_url": "",
- "keywords": [
- "golang",
- "go",
- "frexp",
- "math"
- ]
+ "keywords": ["golang", "go", "frexp", "math"]
},
"https://github.com/golang/lint": {
"id": "golint",
"description": "Golint is a linter for Go source code.",
"short_url": "",
- "keywords": [
- "golang",
- "go",
- "lint",
- "linter"
- ]
+ "keywords": ["golang", "go", "lint", "linter"]
},
"https://github.com/gotwarlost/istanbul": {
"id": "istanbul",
"description": "Istanbul is a JavaScript code coverage tool.",
"short_url": "",
- "keywords": [
- "javascript",
- "code",
- "coverage",
- "tool"
- ]
+ "keywords": ["javascript", "code", "coverage", "tool"]
},
"https://github.com/hybridgroup/cylon/": {
"id": "cylon-js",
@@ -8302,21 +5979,13 @@
"id": "pandoc-citeproc",
"description": "Pandoc's citeproc library.",
"short_url": "",
- "keywords": [
- "pandoc",
- "citeproc",
- "library"
- ]
+ "keywords": ["pandoc", "citeproc", "library"]
},
"https://github.com/jimhester/lintr": {
"id": "lintr",
"description": "Linter for R.",
"short_url": "",
- "keywords": [
- "r",
- "linter",
- "lint"
- ]
+ "keywords": ["r", "linter", "lint"]
},
"https://github.com/kangax/compat-table/issues/392": {
"id": "@bug:kangax:compat-table:392",
@@ -8336,130 +6005,73 @@
"id": "sublime-text-git",
"description": "GitHub repository for a Sublime Text plugin which provides Git integration.",
"short_url": "",
- "keywords": [
- "git",
- "sublime",
- "text",
- "editor",
- "plugin"
- ]
+ "keywords": ["git", "sublime", "text", "editor", "plugin"]
},
"https://github.com/kgryte": {
"id": "athan-reines-github",
"description": "Athan Reines' GitHub profile.",
"short_url": "",
- "keywords": [
- "athan",
- "reines",
- "github",
- "profile"
- ]
+ "keywords": ["athan", "reines", "github", "profile"]
},
"https://github.com/koalaman/shellcheck": {
"id": "shellcheck",
"description": "GitHub repository for shellcheck, a shell script static analysis tool.",
"short_url": "",
- "keywords": [
- "linter",
- "lint",
- "shell",
- "bash",
- "static analysis"
- ]
+ "keywords": ["linter", "lint", "shell", "bash", "static analysis"]
},
"https://github.com/kripken/emscripten": {
"id": "emscripten",
"description": "GitHub repository of emscripten, an LLVM-to-JavaScript compiler.",
"short_url": "",
- "keywords": [
- "emscripten",
- "llvm",
- "javascript",
- "compiler"
- ]
+ "keywords": ["emscripten", "llvm", "javascript", "compiler"]
},
"https://github.com/ljharb/get-nans": {
"id": "get-nans",
"description": "Get an array of all distinct NaN values supported by the current JavaScript engine.",
"short_url": "",
- "keywords": [
- "nan",
- "javascript",
- "js",
- "engine"
- ]
+ "keywords": ["nan", "javascript", "js", "engine"]
},
"https://github.com/luggage66/vscode-awk": {
"id": "vscode-awk",
"description": "VSCode extension for AWK.",
"short_url": "",
- "keywords": [
- "vscode",
- "extension",
- "awk"
- ]
+ "keywords": ["vscode", "extension", "awk"]
},
"https://github.com/mattn/vscode-runner": {
"id": "vscode-runner",
"description": "VSCode extension for running code.",
"short_url": "",
- "keywords": [
- "vscode",
- "extension",
- "run",
- "code"
- ]
+ "keywords": ["vscode", "extension", "run", "code"]
},
"https://github.com/mdn/webassembly-examples/blob/master/wasm-sobel/sobel.js": {
"id": "web-assembly-examples",
"description": "WebAssembly examples.",
"short_url": "",
- "keywords": [
- "webassembly",
- "wasm",
- "example"
- ]
+ "keywords": ["webassembly", "wasm", "example"]
},
"https://github.com/mvoidex/UnicodeMath": {
"id": "sublime-text-unicode-math",
"description": "Sublime Text package for inserting Unicode math symbols and emoji.",
"short_url": "",
- "keywords": [
- "sublime text",
- "st3",
- "sublime",
- "editor",
- "plugin"
- ]
+ "keywords": ["sublime text", "st3", "sublime", "editor", "plugin"]
},
"https://github.com/nodejs/Release": {
"id": "node-release",
"description": "Node.js Release Working Group.",
"short_url": "",
- "keywords": [
- "node",
- "lts",
- "release",
- "working group"
- ]
+ "keywords": ["node", "lts", "release", "working group"]
},
"https://github.com/nodejs/abi-stable-node/": {
"id": "node-napi",
"description": "Node.js Node-API.",
"short_url": "",
- "keywords": [
- "node",
- "napi"
- ]
+ "keywords": ["node", "napi"]
},
"https://github.com/nodejs/nan": {
"id": "node-nan",
"description": "Native Abstractions for Node.js.",
"short_url": "",
- "keywords": [
- "node",
- "nan"
- ]
+ "keywords": ["node", "nan"]
},
"https://github.com/nodejs/node-gyp/issues/1102": {
"id": "msvs-fortran-issue",
@@ -8479,42 +6091,25 @@
"id": "nodejs-governance",
"description": "Node.js project governance.",
"short_url": "",
- "keywords": [
- "node.js",
- "node",
- "governance"
- ]
+ "keywords": ["node.js", "node", "governance"]
},
"https://github.com/numpy/numpy/blob/6db3236cd81c107d752d8ef5fb411f26bf8b7255/doc/source/dev/governance/governance.rst": {
"id": "numpy-governance",
"description": "NumPy project governance.",
"short_url": "",
- "keywords": [
- "numpy",
- "governance"
- ]
+ "keywords": ["numpy", "governance"]
},
"https://github.com/paulmillr/es6-shim/issues/314": {
"id": "@bug:paulmillr:es6-shim:314",
"description": "GitHub issue on relative error being too big for Math.expm1 and Math.log1p.",
"short_url": "",
- "keywords": [
- "github",
- "es6",
- "shim",
- "math"
- ]
+ "keywords": ["github", "es6", "shim", "math"]
},
"https://github.com/paulmillr/es6-shim/issues/334": {
"id": "@bug:paulmiller:es6-shim:334",
"description": "GitHub issue on Math.asinh and Math.atanh being imprecise.",
"short_url": "",
- "keywords": [
- "github",
- "es6",
- "shim",
- "math"
- ]
+ "keywords": ["github", "es6", "shim", "math"]
},
"https://github.com/pypa/pip": {
"id": "pip",
@@ -8534,211 +6129,127 @@
"id": "remark-lint-blockquote-indentation",
"description": "remark-lint rule to enforce blockquote indentation.",
"short_url": "",
- "keywords": [
- "remark",
- "lint",
- "plugin"
- ]
+ "keywords": ["remark", "lint", "plugin"]
},
"https://github.com/remarkjs/remark-lint/tree/19150d94f89f7a0d94d083417890236d11839641/packages/remark-lint-checkbox-character-style": {
"id": "remark-lint-checkbox-character-style",
"description": "remark-lint rule to enforce checkbox character style.",
"short_url": "",
- "keywords": [
- "remark",
- "lint",
- "plugin"
- ]
+ "keywords": ["remark", "lint", "plugin"]
},
"https://github.com/remarkjs/remark-lint/tree/19150d94f89f7a0d94d083417890236d11839641/packages/remark-lint-code-block-style": {
"id": "remark-lint-code-block-style",
"description": "remark-lint rule to enforce code block style.",
"short_url": "",
- "keywords": [
- "remark",
- "lint",
- "plugin"
- ]
+ "keywords": ["remark", "lint", "plugin"]
},
"https://github.com/remarkjs/remark-lint/tree/19150d94f89f7a0d94d083417890236d11839641/packages/remark-lint-emphasis-marker": {
"id": "remark-lint-emphasis-marker",
"description": "remark-lint rule to enforce emphasis marker style.",
"short_url": "",
- "keywords": [
- "remark",
- "lint",
- "plugin"
- ]
+ "keywords": ["remark", "lint", "plugin"]
},
"https://github.com/remarkjs/remark-lint/tree/19150d94f89f7a0d94d083417890236d11839641/packages/remark-lint-fenced-code-flag": {
"id": "remark-lint-fenced-code-flag",
"description": "remark-lint rule to enforce fenced code flag style.",
"short_url": "",
- "keywords": [
- "remark",
- "lint",
- "plugin"
- ]
+ "keywords": ["remark", "lint", "plugin"]
},
"https://github.com/remarkjs/remark-lint/tree/19150d94f89f7a0d94d083417890236d11839641/packages/remark-lint-fenced-code-marker": {
"id": "remark-lint-fenced-code-marker",
"description": "remark-lint rule to enforce fenced code marker style.",
"short_url": "",
- "keywords": [
- "remark",
- "lint",
- "plugin"
- ]
+ "keywords": ["remark", "lint", "plugin"]
},
"https://github.com/remarkjs/remark-lint/tree/19150d94f89f7a0d94d083417890236d11839641/packages/remark-lint-first-heading-level": {
"id": "remark-lint-first-heading-level",
"description": "remark-lint rule to enforce first heading level.",
"short_url": "",
- "keywords": [
- "remark",
- "lint",
- "plugin"
- ]
+ "keywords": ["remark", "lint", "plugin"]
},
"https://github.com/remarkjs/remark-lint/tree/19150d94f89f7a0d94d083417890236d11839641/packages/remark-lint-heading-style": {
"id": "remark-lint-heading-style",
"description": "remark-lint rule to enforce heading style.",
"short_url": "",
- "keywords": [
- "remark",
- "lint",
- "plugin"
- ]
+ "keywords": ["remark", "lint", "plugin"]
},
"https://github.com/remarkjs/remark-lint/tree/19150d94f89f7a0d94d083417890236d11839641/packages/remark-lint-linebreak-style": {
"id": "remark-lint-linebreak-style",
"description": "remark-lint rule to enforce linebreak style.",
"short_url": "",
- "keywords": [
- "remark",
- "lint",
- "plugin"
- ]
+ "keywords": ["remark", "lint", "plugin"]
},
"https://github.com/remarkjs/remark-lint/tree/19150d94f89f7a0d94d083417890236d11839641/packages/remark-lint-no-heading-punctuation": {
"id": "remark-lint-no-heading-punctuation",
"description": "remark-lint rule to enforce no heading punctuation.",
"short_url": "",
- "keywords": [
- "remark",
- "lint",
- "plugin"
- ]
+ "keywords": ["remark", "lint", "plugin"]
},
"https://github.com/remarkjs/remark-lint/tree/19150d94f89f7a0d94d083417890236d11839641/packages/remark-lint-no-missing-blank-lines": {
"id": "remark-lint-no-missing-blank-lines",
"description": "remark-lint rule to enforce no missing blank lines.",
"short_url": "",
- "keywords": [
- "remark",
- "lint",
- "plugin"
- ]
+ "keywords": ["remark", "lint", "plugin"]
},
"https://github.com/remarkjs/remark-lint/tree/19150d94f89f7a0d94d083417890236d11839641/packages/remark-lint-no-multiple-toplevel-headings": {
"id": "remark-lint-multiple-toplevel-headings",
"description": "remark-lint rule to enforce no multiple toplevel headings.",
"short_url": "",
- "keywords": [
- "remark",
- "lint",
- "plugin"
- ]
+ "keywords": ["remark", "lint", "plugin"]
},
"https://github.com/remarkjs/remark-lint/tree/19150d94f89f7a0d94d083417890236d11839641/packages/remark-lint-ordered-list-marker-style": {
"id": "remark-lint-ordered-list-marker-style",
"description": "remark-lint rule to enforce ordered list marker style.",
"short_url": "",
- "keywords": [
- "remark",
- "lint",
- "plugin"
- ]
+ "keywords": ["remark", "lint", "plugin"]
},
"https://github.com/remarkjs/remark-lint/tree/19150d94f89f7a0d94d083417890236d11839641/packages/remark-lint-ordered-list-marker-value": {
"id": "remark-lint-ordered-list-marker-value",
"description": "remark-lint rule to enforce ordered list marker value.",
"short_url": "",
- "keywords": [
- "remark",
- "lint",
- "plugin"
- ]
+ "keywords": ["remark", "lint", "plugin"]
},
"https://github.com/remarkjs/remark-lint/tree/19150d94f89f7a0d94d083417890236d11839641/packages/remark-lint-rule-style": {
"id": "remark-lint-rule-style",
"description": "remark-lint rule to enforce rule style.",
"short_url": "",
- "keywords": [
- "remark",
- "lint",
- "plugin"
- ]
+ "keywords": ["remark", "lint", "plugin"]
},
"https://github.com/remarkjs/remark-lint/tree/19150d94f89f7a0d94d083417890236d11839641/packages/remark-lint-strong-marker": {
"id": "remark-lint-strong-marker",
"description": "remark-lint rule to enforce strong marker style.",
"short_url": "",
- "keywords": [
- "remark",
- "lint",
- "plugin"
- ]
+ "keywords": ["remark", "lint", "plugin"]
},
"https://github.com/remarkjs/remark-lint/tree/19150d94f89f7a0d94d083417890236d11839641/packages/remark-lint-table-cell-padding": {
"id": "remark-lint-table-cell-padding",
"description": "remark-lint rule to enforce table cell padding.",
"short_url": "",
- "keywords": [
- "remark",
- "lint",
- "plugin"
- ]
+ "keywords": ["remark", "lint", "plugin"]
},
"https://github.com/remarkjs/remark-lint/tree/19150d94f89f7a0d94d083417890236d11839641/packages/remark-lint-unordered-list-marker-style": {
"id": "remark-lint-unordered-list-marker-style",
"description": "remark-lint rule to enforce unordered list marker style.",
"short_url": "",
- "keywords": [
- "remark",
- "lint",
- "plugin"
- ]
+ "keywords": ["remark", "lint", "plugin"]
},
"https://github.com/remarkjs/remark-lint/tree/7727269a1088e9e9b2008465e8c1947b38a44b69/packages/remark-lint-maximum-line-length": {
"id": "remark-lint-maximum-line-length",
"description": "remark-lint rule to enforce a maximum line length.",
"short_url": "",
- "keywords": [
- "remark",
- "lint",
- "plugin"
- ]
+ "keywords": ["remark", "lint", "plugin"]
},
"https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-list-item-spacing": {
"id": "remark-lint-list-item-spacing",
"description": "remark-lint rule to enforce list item spacing.",
"short_url": "",
- "keywords": [
- "remark",
- "lint",
- "plugin"
- ]
+ "keywords": ["remark", "lint", "plugin"]
},
"https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-maximum-heading-length": {
"id": "remark-lint-maximum-heading-length",
"description": "remark-lint rule to enforce a maximum heading length.",
"short_url": "",
- "keywords": [
- "remark",
- "lint",
- "plugin"
- ]
+ "keywords": ["remark", "lint", "plugin"]
},
"https://github.com/roadhump/SublimeLinter-eslint": {
"id": "sublime-text-sublimelinter-eslint",
@@ -8760,34 +6271,19 @@
"id": "ricky-reusser-github",
"description": "Ricky Reusser's GitHub profile.",
"short_url": "",
- "keywords": [
- "github",
- "profile",
- "ricky",
- "reusser"
- ]
+ "keywords": ["github", "profile", "ricky", "reusser"]
},
"https://github.com/rse/browserify-derequire": {
"id": "browserify-derequire",
"description": "Browserify Plugin for Renaming require() Calls.",
"short_url": "",
- "keywords": [
- "browserify",
- "plugin",
- "derequire",
- "require"
- ]
+ "keywords": ["browserify", "plugin", "derequire", "require"]
},
"https://github.com/rwaldron/idiomatic.js/": {
"id": "idiomatic-js",
"description": "Principles of Writing Consistent, Idiomatic JavaScript.",
"short_url": "",
- "keywords": [
- "javascript",
- "style",
- "guide",
- "idiomatic"
- ]
+ "keywords": ["javascript", "style", "guide", "idiomatic"]
},
"https://github.com/rwaldron/johnny-five": {
"id": "johnny-five",
@@ -8810,103 +6306,55 @@
"id": "scikit-learn-governance",
"description": "Governance of the scikit-learn project.",
"short_url": "",
- "keywords": [
- "scikit-learn",
- "governance"
- ]
+ "keywords": ["scikit-learn", "governance"]
},
"https://github.com/settings/tokens/new": {
"id": "github-token",
"description": "Link for creating a new GitHub token.",
"short_url": "",
- "keywords": [
- "github",
- "auth",
- "token",
- "authorization"
- ]
+ "keywords": ["github", "auth", "token", "authorization"]
},
"https://github.com/signup/free": {
"id": "github-signup",
"description": "Link for creating a new GitHub account.",
"short_url": "",
- "keywords": [
- "github",
- "signup"
- ]
+ "keywords": ["github", "signup"]
},
- "https://github.com/sindresorhus/atom-editorconfig": {
- "id": "atom-editorconfig",
- "description": "EditorConfig plugin for Atom.",
- "short_url": "",
- "keywords": [
- "atom",
- "editorconfig",
- "editor",
- "config",
- "configuration"
- ]
+ "https://github.com/sindresorhus/atom-editorconfig": {
+ "id": "atom-editorconfig",
+ "description": "EditorConfig plugin for Atom.",
+ "short_url": "",
+ "keywords": ["atom", "editorconfig", "editor", "config", "configuration"]
},
"https://github.com/sindresorhus/editorconfig-sublime": {
"id": "sublime-text-editorconfig",
"description": "Sublime Text package for using EditorConfig.",
"short_url": "",
- "keywords": [
- "configuration",
- "editor",
- "sublime",
- "text"
- ]
+ "keywords": ["configuration", "editor", "sublime", "text"]
},
"https://github.com/sponsors/kgryte": {
"id": "github-stdlib",
"description": "Link to the GitHub Sponsors page for stdlib.",
"short_url": "",
- "keywords": [
- "github",
- "sponsors",
- "stdlib"
- ]
+ "keywords": ["github", "sponsors", "stdlib"]
},
"https://github.com/stdlib-js/math-base-special-erf/tree/esm": {
"id": "@stdlib/math-base-special-erf-esm",
"description": "ESM bundle for @stdlib/math-base-special-erf.",
"short_url": "",
- "keywords": [
- "stdlib",
- "math",
- "base",
- "special",
- "erf",
- "esm",
- "bundle"
- ]
+ "keywords": ["stdlib", "math", "base", "special", "erf", "esm", "bundle"]
},
"https://github.com/stdlib-js/math-base-special-erf/tree/umd": {
"id": "@stdlib/math-base-special-erf-umd",
"description": "UMD bundle for @stdlib/math-base-special-erf.",
"short_url": "",
- "keywords": [
- "stdlib",
- "math",
- "base",
- "special",
- "erf",
- "umd",
- "bundle"
- ]
+ "keywords": ["stdlib", "math", "base", "special", "erf", "umd", "bundle"]
},
"https://github.com/stdlib-js/ndarray-array/tree/deno": {
"id": "@stdlib/ndarray-array-deno",
"description": "Deno bundle for @stdlib/ndarray-array.",
"short_url": "",
- "keywords": [
- "stdlib",
- "ndarray",
- "array",
- "deno",
- "bundle"
- ]
+ "keywords": ["stdlib", "ndarray", "array", "deno", "bundle"]
},
"https://github.com/stdlib-js/stdlib": {
"id": "stdlib-github",
@@ -8934,115 +6382,67 @@
"id": "stdlib-code-of-conduct",
"description": "The stdlib code of conduct.",
"short_url": "",
- "keywords": [
- "stdlib",
- "code",
- "conduct",
- "code of conduct"
- ]
+ "keywords": ["stdlib", "code", "conduct", "code of conduct"]
},
"https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md": {
"id": "stdlib-contributing",
"description": "The stdlib contributing guidelines.",
"short_url": "",
- "keywords": [
- "stdlib",
- "contributing",
- "guidelines"
- ]
+ "keywords": ["stdlib", "contributing", "guidelines"]
},
"https://github.com/stdlib-js/stdlib/blob/develop/FAQ.md": {
"id": "stdlib-faq",
"description": "Frequency asked questions about stdlib.",
"short_url": "",
- "keywords": [
- "stdlib",
- "faq",
- "frequently",
- "asked",
- "questions"
- ]
+ "keywords": ["stdlib", "faq", "frequently", "asked", "questions"]
},
"https://github.com/stdlib-js/stdlib/blob/develop/GOVERNANCE.md": {
"id": "stdlib-governance",
"description": "The stdlib governance structure.",
"short_url": "",
- "keywords": [
- "stdlib",
- "governance",
- "structure"
- ]
+ "keywords": ["stdlib", "governance", "structure"]
},
"https://github.com/stdlib-js/stdlib/blob/develop/NOTICE": {
"id": "stdlib-copyright",
"description": "stdlib copyright notice.",
"short_url": "",
- "keywords": [
- "stdlib",
- "copyright",
- "notice"
- ]
+ "keywords": ["stdlib", "copyright", "notice"]
},
"https://github.com/stdlib-js/stdlib/blob/develop/PRIVACY.md": {
"id": "stdlib-privacy-policy",
"description": "The stdlib privacy policy.",
"short_url": "",
- "keywords": [
- "stdlib",
- "privacy",
- "policy"
- ]
+ "keywords": ["stdlib", "privacy", "policy"]
},
"https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md": {
"id": "stdlib-development",
"description": "The stdlib development guidelines.",
"short_url": "",
- "keywords": [
- "stdlib",
- "development",
- "guidelines"
- ]
+ "keywords": ["stdlib", "development", "guidelines"]
},
"https://github.com/stdlib-js/stdlib/blob/develop/docs/misc/built_in_math_bugs.md": {
"id": "built-in-math-bugs",
"description": "A list of known bugs in built-in math functions.",
"short_url": "",
- "keywords": [
- "stdlib",
- "built-in",
- "math",
- "bugs"
- ]
+ "keywords": ["stdlib", "built-in", "math", "bugs"]
},
"https://github.com/stdlib-js/stdlib/blob/develop/docs/policies/TERMS_OF_SERVICE.md": {
"id": "stdlib-terms-of-service",
"description": "The stdlib terms of service.",
"short_url": "",
- "keywords": [
- "stdlib",
- "terms",
- "service"
- ]
+ "keywords": ["stdlib", "terms", "service"]
},
"https://github.com/stdlib-js/stdlib/blob/develop/docs/policies/domains.md": {
"id": "stdlib-domains",
"description": "Domain names associated with stdlib.",
"short_url": "",
- "keywords": [
- "stdlib",
- "domains"
- ]
+ "keywords": ["stdlib", "domains"]
},
"https://github.com/stdlib-js/stdlib/blob/develop/docs/style-guides": {
"id": "stdlib-style-guides",
"description": "The stdlib style guides.",
"short_url": "",
- "keywords": [
- "stdlib",
- "code",
- "style",
- "guides"
- ]
+ "keywords": ["stdlib", "code", "style", "guides"]
},
"https://github.com/stdlib-js/stdlib/blob/develop/lib/node_modules/@stdlib/ndarray/ctor/README.md": {
"id": "nd-array",
@@ -9061,144 +6461,79 @@
"id": "stdlib-git-commit-log-governance",
"description": "The stdlib git commit log for the governance file.",
"short_url": "",
- "keywords": [
- "stdlib",
- "git",
- "commit",
- "log",
- "governance"
- ]
+ "keywords": ["stdlib", "git", "commit", "log", "governance"]
},
"https://github.com/stdlib-js/stdlib/commits/develop/PRIVACY": {
"id": "stdlib-git-commit-log-privacy-policy",
"description": "The stdlib git commit log for the privacy policy.",
"short_url": "",
- "keywords": [
- "stdlib",
- "git",
- "commit",
- "log",
- "privacy",
- "policy"
- ]
+ "keywords": ["stdlib", "git", "commit", "log", "privacy", "policy"]
},
"https://github.com/stdlib-js/stdlib/commits/develop/docs/policies/TERMS_OF_SERVICE.md": {
"id": "stdlib-git-commit-log-terms-of-service",
"description": "The stdlib git commit log for the terms of service.",
"short_url": "",
- "keywords": [
- "stdlib",
- "git",
- "commit",
- "log",
- "terms",
- "service"
- ]
+ "keywords": ["stdlib", "git", "commit", "log", "terms", "service"]
},
"https://github.com/stdlib-js/stdlib/commits/develop/docs/policies/domains.md": {
"id": "stdlib-git-commit-log-domains",
"description": "The stdlib git commit log for the domains file.",
"short_url": "",
- "keywords": [
- "stdlib",
- "git",
- "commit",
- "log",
- "domains"
- ]
+ "keywords": ["stdlib", "git", "commit", "log", "domains"]
},
"https://github.com/stdlib-js/stdlib/graphs/contributors": {
"id": "stdlib-authors",
"description": "List of stdlib contributors.",
"short_url": "",
- "keywords": [
- "stdlib",
- "authors",
- "contributors"
- ]
+ "keywords": ["stdlib", "authors", "contributors"]
},
"https://github.com/stdlib-js/stdlib/issues": {
"id": "stdlib-issues",
"description": "The stdlib issue tracker.",
"short_url": "",
- "keywords": [
- "stdlib",
- "issues",
- "issue",
- "tracker"
- ]
+ "keywords": ["stdlib", "issues", "issue", "tracker"]
},
"https://github.com/stdlib-js/stdlib/pulls": {
"id": "stdlib-pull-requests",
"description": "GitHub pull requests for stdlib.",
"short_url": "",
- "keywords": [
- "stdlib",
- "pull",
- "requests"
- ]
+ "keywords": ["stdlib", "pull", "requests"]
},
"https://github.com/stdlib-js/stdlib/releases": {
"id": "stdlib-github-releases",
"description": "GitHub releases for stdlib.",
"short_url": "",
- "keywords": [
- "stdlib",
- "github",
- "releases"
- ]
+ "keywords": ["stdlib", "github", "releases"]
},
"https://github.com/stdlib-js/stdlib/tags": {
"id": "tag-url",
"description": "GitHub tags for stdlib.",
"short_url": "",
- "keywords": [
- "stdlib",
- "github",
- "tags"
- ]
+ "keywords": ["stdlib", "github", "tags"]
},
"https://github.com/stdlib-js/stdlib/tree/develop/dist": {
"id": "stdlib-bundles",
"description": "stdlib distributible files.",
"short_url": "",
- "keywords": [
- "stdlib",
- "distributible",
- "files",
- "bundles",
- "dist"
- ]
+ "keywords": ["stdlib", "distributible", "files", "bundles", "dist"]
},
"https://github.com/stdlib-js/stdlib/tree/develop/docs": {
"id": "stdlib-docs",
"description": "stdlib project documentation.",
"short_url": "",
- "keywords": [
- "stdlib",
- "docs",
- "documentation"
- ]
+ "keywords": ["stdlib", "docs", "documentation"]
},
"https://github.com/stdlib-js/stdlib/tree/develop/tools/snippets": {
"id": "stdlib-snippets",
"description": "stdlib code snippets.",
"short_url": "",
- "keywords": [
- "stdlib",
- "snippets",
- "code"
- ]
+ "keywords": ["stdlib", "snippets", "code"]
},
"https://github.com/stumpsyn/policies/blob/7caa4699ba74e341a46b3266d4610af477ba2c3d/citizen_code_of_conduct.md": {
"id": "citizen-code-of-conduct",
"description": "stdlib's Code of Conduct.",
"short_url": "",
- "keywords": [
- "stdlib",
- "code",
- "conduct"
- ]
+ "keywords": ["stdlib", "code", "conduct"]
},
"https://github.com/substack/node-browserify": {
"id": "browserify",
@@ -9218,12 +6553,7 @@
"id": "tape",
"description": "GitHub repository for tape, a minimalist test framework.",
"short_url": "",
- "keywords": [
- "tape",
- "test",
- "framework",
- "minimalist"
- ]
+ "keywords": ["tape", "test", "framework", "minimalist"]
},
"https://github.com/tc39/ecma262/issues/635": {
"id": "ecma262-635",
@@ -9242,55 +6572,31 @@
"id": "ecmascript-simd",
"description": "GitHub repository for ECMAScript SIMD.",
"short_url": "",
- "keywords": [
- "ecmascript",
- "simd",
- "specification",
- "spec"
- ]
+ "keywords": ["ecmascript", "simd", "specification", "spec"]
},
"https://github.com/tc39/test262/pull/269": {
"id": "@bug:tc39:test262:269",
"description": "GitHub pull request adding new tests for Math built-ins.",
"short_url": "",
- "keywords": [
- "tc39",
- "test262",
- "math",
- "built-ins"
- ]
+ "keywords": ["tc39", "test262", "math", "built-ins"]
},
"https://github.com/todogroup/opencodeofconduct": {
"id": "open-code-of-conduct",
"description": "GitHub repository for the Open Code of Conduct.",
"short_url": "",
- "keywords": [
- "open",
- "code",
- "conduct"
- ]
+ "keywords": ["open", "code", "conduct"]
},
"https://github.com/umdjs/umd": {
"id": "umd",
"description": "GitHub repository which formalizes the design and implementation of the Universal Module Definition (UMD) API for JavaScript modules.",
"short_url": "",
- "keywords": [
- "umd",
- "modules",
- "javascript"
- ]
+ "keywords": ["umd", "modules", "javascript"]
},
"https://github.com/v8/v8/commit/33b5db090258c2a2dc825659c3ad109bd02110c1": {
"id": "@bug:chromium:78263005",
"description": "GitHub commit embedding trigonometric lookup table.",
"short_url": "",
- "keywords": [
- "chromium",
- "v8",
- "trigonometric",
- "lookup",
- "table"
- ]
+ "keywords": ["chromium", "v8", "trigonometric", "lookup", "table"]
},
"https://github.com/wayou/vscode-todo-highlight": {
"id": "vscode-todo-highlight",
@@ -9311,110 +6617,61 @@
"id": "rehype",
"description": "GitHub repository for rehype, a unified interface to transform HTML.",
"short_url": "",
- "keywords": [
- "rehype",
- "unified",
- "interface",
- "transform",
- "html"
- ]
+ "keywords": ["rehype", "unified", "interface", "transform", "html"]
},
"https://github.com/wooorm/remark": {
"id": "remark",
"description": "A Markdown processor powered by plugins.",
"short_url": "",
- "keywords": [
- "remark",
- "lint",
- "linter",
- "linting",
- "markdown"
- ]
+ "keywords": ["remark", "lint", "linter", "linting", "markdown"]
},
"https://github.com/xianyi/OpenBLAS": {
"id": "openblas",
"description": "GitHub repository for OpenBLAS, an optimized BLAS library based on GotoBLAS2 1.13 BSD version.",
"short_url": "",
- "keywords": [
- "openblas",
- "blas",
- "library",
- "optimized",
- "gotoblas2"
- ]
+ "keywords": ["openblas", "blas", "library", "optimized", "gotoblas2"]
},
"https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im": {
"id": "chat-url",
"description": "stdlib chat room.",
"short_url": "",
- "keywords": [
- "stdlib",
- "chat",
- "room"
- ]
+ "keywords": ["stdlib", "chat", "room"]
},
"https://golang.org/cmd/gofmt/": {
"id": "gofmt",
"description": "Go formatting tool.",
"short_url": "",
- "keywords": [
- "gofmt",
- "go",
- "formatting",
- "tool"
- ]
+ "keywords": ["gofmt", "go", "formatting", "tool"]
},
"https://golang.org/cmd/vet/": {
"id": "govet",
"description": "Go vet tool.",
"short_url": "",
- "keywords": [
- "govet",
- "go",
- "vet",
- "tool"
- ]
+ "keywords": ["govet", "go", "vet", "tool"]
},
"https://golang.org/doc/effective_go.html": {
"id": "effective-go",
"description": "Effective Go.",
"short_url": "",
- "keywords": [
- "effective",
- "go"
- ]
+ "keywords": ["effective", "go"]
},
"https://golang.org/pkg/math/big/": {
"id": "golang-big",
"description": "Go big package implementing arbitrary-precision arithmetic.",
"short_url": "",
- "keywords": [
- "golang",
- "big",
- "arbitrary",
- "precision",
- "arithmetic"
- ]
+ "keywords": ["golang", "big", "arbitrary", "precision", "arithmetic"]
},
"https://guides.github.com/features/mastering-markdown/": {
"id": "github-markdown-guide",
"description": "GitHub guide to mastering Markdown.",
"short_url": "",
- "keywords": [
- "github",
- "markdown",
- "guide",
- "mastering"
- ]
+ "keywords": ["github", "markdown", "guide", "mastering"]
},
"https://gyp.gsrc.io/": {
"id": "gyp",
"description": "Gyp is a Meta-Build system: : a build system that generates other build systems.",
"short_url": "",
- "keywords": [
- "gyp",
- "cmake"
- ]
+ "keywords": ["gyp", "cmake"]
},
"https://hacks.mozilla.org/2014/10/introducing-simd-js/": {
"id": "mozilla-simd",
@@ -9434,188 +6691,109 @@
"id": "github-two-factor",
"description": "GitHub help on two-factor authentication.",
"short_url": "",
- "keywords": [
- "github",
- "two-factor",
- "authentication"
- ]
+ "keywords": ["github", "two-factor", "authentication"]
},
"https://help.github.com/articles/configuring-a-remote-for-a-fork/": {
"id": "github-remote",
"description": "GitHub documentation on how to configure a remote for a fork.",
"short_url": "",
- "keywords": [
- "github",
- "fork",
- "remote",
- "configuration",
- "configure"
- ]
+ "keywords": ["github", "fork", "remote", "configuration", "configure"]
},
"https://help.github.com/articles/creating-a-pull-request/": {
"id": "github-pull-request",
"description": "GitHub documentation on how to create a pull request.",
"short_url": "",
- "keywords": [
- "github",
- "pull",
- "request",
- "create"
- ]
+ "keywords": ["github", "pull", "request", "create"]
},
"https://help.github.com/articles/fork-a-repo/": {
"id": "github-fork",
"description": "GitHub documentation on how to fork a repository.",
"short_url": "",
- "keywords": [
- "github",
- "fork",
- "repository"
- ]
+ "keywords": ["github", "fork", "repository"]
},
"https://help.github.com/articles/syncing-a-fork/": {
"id": "github-fork-sync",
"description": "GitHub documentation on how to sync a fork.",
"short_url": "",
- "keywords": [
- "github",
- "fork",
- "sync"
- ]
+ "keywords": ["github", "fork", "sync"]
},
"https://help.github.com/en/articles/about-github-actions": {
"id": "github-actions",
"description": "GitHub documentation on GitHub Actions.",
"short_url": "",
- "keywords": [
- "github",
- "actions"
- ]
+ "keywords": ["github", "actions"]
},
"https://img.shields.io/badge/stability-experimental-orange.svg": {
"id": "stability-image",
"description": "Image indicating experimental stability.",
"short_url": "",
- "keywords": [
- "stability",
- "experimental",
- "image"
- ]
+ "keywords": ["stability", "experimental", "image"]
},
"https://img.shields.io/codecov/c/github/stdlib-js/stdlib/develop.svg": {
"id": "coverage-image-develop",
"description": "Image indicating code coverage for the develop branch.",
"short_url": "",
- "keywords": [
- "coverage",
- "image",
- "develop",
- "branch"
- ]
+ "keywords": ["coverage", "image", "develop", "branch"]
},
"https://img.shields.io/github/v/tag/stdlib-js/stdlib.svg": {
"id": "tag-image",
"description": "Image indicating the latest tag.",
"short_url": "",
- "keywords": [
- "tag",
- "image"
- ]
+ "keywords": ["tag", "image"]
},
"https://img.shields.io/gitter/room/stdlib-js/stdlib.svg": {
"id": "chat-image",
"description": "Image for the Gitter chat room.",
"short_url": "",
- "keywords": [
- "chat",
- "gitter",
- "image"
- ]
+ "keywords": ["chat", "gitter", "image"]
},
"https://img.shields.io/node/v/@stdlib/stdlib.svg": {
"id": "node-image",
"description": "Image for the supported Node.js versions of stdlib.",
"short_url": "",
- "keywords": [
- "image",
- "node",
- "node.js",
- "stdlib"
- ]
+ "keywords": ["image", "node", "node.js", "stdlib"]
},
"https://img.shields.io/npm/v/@stdlib/stdlib.svg": {
"id": "npm-image",
"description": "Image for the latest npm release of stdlib.",
"short_url": "",
- "keywords": [
- "image",
- "npm",
- "stdlib"
- ]
+ "keywords": ["image", "npm", "stdlib"]
},
"https://jsdelivr.com/": {
"id": "jsdelivr",
"description": "A content delivery network (CDN) for npm and GitHub.",
"short_url": "",
- "keywords": [
- "cdn",
- "npm",
- "github"
- ]
+ "keywords": ["cdn", "npm", "github"]
},
"https://julialang.org/": {
"id": "julia",
"description": "The official website of Julia, a high-level, high-performance dynamic programming language for numerical computing.",
"short_url": "",
- "keywords": [
- "julia",
- "julialang",
- "numeric computing",
- "language",
- "lang"
- ]
+ "keywords": ["julia", "julialang", "numeric computing", "language", "lang"]
},
"https://lostechies.com/derickbailey/2014/02/20/how-i-work-around-the-require-problem-in-nodejs/": {
"id": "modifying-node-path-hack",
"description": "Blog pot on how to work around the `require` problem in Node.js.",
"short_url": "",
- "keywords": [
- "node",
- "node.js",
- "require",
- "hack"
- ]
+ "keywords": ["node", "node.js", "require", "hack"]
},
"https://lunrjs.com": {
"id": "lunr-js",
"description": "Lunr.js is a simple full-text search engine for the browser.",
"short_url": "",
- "keywords": [
- "lunr",
- "lunr.js",
- "search"
- ]
+ "keywords": ["lunr", "lunr.js", "search"]
},
"https://marketplace.visualstudio.com/items?itemName=eriklynd.json-tools#overview": {
"id": "vscode-json-tools",
"description": "Visual Studio Code extension for working with JSON.",
"short_url": "",
- "keywords": [
- "vscode",
- "json",
- "extension"
- ]
+ "keywords": ["vscode", "json", "extension"]
},
"https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools": {
"id": "vscode-cpptools",
"description": "Visual Studio Code extension for working with C/C++.",
"short_url": "",
- "keywords": [
- "vscode",
- "c",
- "c++",
- "extension"
- ]
+ "keywords": ["vscode", "c", "c++", "extension"]
},
"https://msdn.microsoft.com/en-us/library/gg465305.aspx": {
"id": "unc",
@@ -9635,11 +6813,7 @@
"id": "extended-length-path",
"description": "Rules and limitations for file names and directory names on Windows.",
"short_url": "",
- "keywords": [
- "windows",
- "filesystem",
- "naming"
- ]
+ "keywords": ["windows", "filesystem", "naming"]
},
"https://nodejs.org/api/addons.html": {
"id": "node-js-add-ons",
@@ -9687,12 +6861,7 @@
"id": "node-system-error",
"description": "Node.js documentation for the System Error class.",
"short_url": "",
- "keywords": [
- "node.js",
- "node-js",
- "node",
- "error"
- ]
+ "keywords": ["node.js", "node-js", "node", "error"]
},
"https://nodejs.org/api/fs.html": {
"id": "node-fs",
@@ -9723,16 +6892,10 @@
]
},
"https://nodejs.org/api/http.html": {
- "id": "http",
- "description": "Node.js documentation for the HTTP module.",
- "short_url": "",
- "keywords": [
- "node.js",
- "node-js",
- "node",
- "http",
- "https"
- ]
+ "id": "http",
+ "description": "Node.js documentation for the HTTP module.",
+ "short_url": "",
+ "keywords": ["node.js", "node-js", "node", "http", "https"]
},
"https://nodejs.org/api/modules.html": {
"id": "node-require",
@@ -9754,24 +6917,13 @@
"id": "node-os",
"description": "Node.js documentation for the `cpus()` function of the `os` module.",
"short_url": "",
- "keywords": [
- "node.js",
- "node-js",
- "node",
- "os"
- ]
+ "keywords": ["node.js", "node-js", "node", "os"]
},
"https://nodejs.org/api/path.html#path_path_resolve_paths": {
"id": "node-core-path-resolve",
"description": "Node.js documentation for the `path.resolve()` function.",
"short_url": "",
- "keywords": [
- "node.js",
- "node-js",
- "node",
- "path",
- "resolve"
- ]
+ "keywords": ["node.js", "node-js", "node", "path", "resolve"]
},
"https://nodejs.org/api/process.html#process_event_uncaughtexception": {
"id": "uncaught-exception",
@@ -9790,110 +6942,55 @@
"id": "process-hrtime",
"description": "Node.js documentation for the `process.hrtime()` function.",
"short_url": "",
- "keywords": [
- "node.js",
- "node-js",
- "node",
- "process",
- "hrtime"
- ]
+ "keywords": ["node.js", "node-js", "node", "process", "hrtime"]
},
"https://nodejs.org/api/process.html#process_process_platform": {
"id": "process-platform",
"description": "Node.js documentation for the process.platform property.",
"short_url": "",
- "keywords": [
- "node-js",
- "node.js",
- "process",
- "platform"
- ]
+ "keywords": ["node-js", "node.js", "process", "platform"]
},
"https://nodejs.org/api/stream.html": {
"id": "nodejs-stream",
"description": "Documentation for the Node.js base stream API.",
"short_url": "",
- "keywords": [
- "node-js",
- "node.js",
- "node",
- "stream",
- "api"
- ]
+ "keywords": ["node-js", "node.js", "node", "stream", "api"]
},
"https://nodejs.org/api/stream.html#stream_class_stream_readable": {
"id": "readable-stream",
"description": "Node.js documentation for the Readable stream class.",
"short_url": "",
- "keywords": [
- "node.js",
- "node-js",
- "node",
- "stream",
- "readable"
- ]
+ "keywords": ["node.js", "node-js", "node", "stream", "readable"]
},
"https://nodejs.org/api/stream.html#stream_class_stream_writable": {
"id": "writable-stream",
"description": "Node.js documentation for the Writable stream class.",
"short_url": "",
- "keywords": [
- "node.js",
- "node-js",
- "node",
- "stream",
- "writable"
- ]
+ "keywords": ["node.js", "node-js", "node", "stream", "writable"]
},
"https://nodejs.org/api/stream.html#stream_object_mode": {
"id": "object-mode",
"description": "Node.js documentation for the objectMode option of the stream constructor.",
"short_url": "",
- "keywords": [
- "node.js",
- "node-js",
- "node",
- "stream",
- "object",
- "mode"
- ]
+ "keywords": ["node.js", "node-js", "node", "stream", "object", "mode"]
},
"https://nodejs.org/api/stream.html#stream_writable_streams": {
"id": "nodejs-writable-stream",
"description": "Documentation for Node.js writable streams.",
"short_url": "",
- "keywords": [
- "node-js",
- "node.js",
- "node",
- "stream",
- "writable",
- "api"
- ]
+ "keywords": ["node-js", "node.js", "node", "stream", "writable", "api"]
},
"https://nodejs.org/api/tty.html#tty_tty": {
"id": "tty",
"description": "Node.js documentation for the tty module, which is used when Node.js is run inside a text terminal context.",
"short_url": "",
- "keywords": [
- "node-js",
- "node.js",
- "streams",
- "terminal"
- ]
+ "keywords": ["node-js", "node.js", "streams", "terminal"]
},
"https://nodejs.org/en/": {
"id": "node-js",
"description": "The official website of Node.js, a JavaScript runtime.",
"short_url": "",
- "keywords": [
- "node",
- "node-js",
- "node.js",
- "nodejs",
- "javascript",
- "js"
- ]
+ "keywords": ["node", "node-js", "node.js", "nodejs", "javascript", "js"]
},
"https://nodejs.org/en/blog/announcements/foundation-advances-growth/": {
"id": "node-fortune-500",
@@ -9933,22 +7030,13 @@
"id": "numpy",
"description": "Official homepage for NumPy, the fundamental package for scientific computing with Python.",
"short_url": "",
- "keywords": [
- "numpy",
- "python"
- ]
+ "keywords": ["numpy", "python"]
},
"https://nutritionquest.com/assessment/list-of-questionnaires-and-screeners/": {
"id": "block-ffq",
"description": "List of questionnaires and screeners.",
"short_url": "",
- "keywords": [
- "block",
- "ffq",
- "food",
- "frequency",
- "questionnaire"
- ]
+ "keywords": ["block", "ffq", "food", "frequency", "questionnaire"]
},
"https://observablehq.com/": {
"id": "observable",
@@ -9972,26 +7060,13 @@
"id": "oeis-a000040",
"description": "The OEIS entry for the sequence of prime numbers.",
"short_url": "",
- "keywords": [
- "oeis",
- "sequence",
- "seq",
- "integers",
- "numbers",
- "primes"
- ]
+ "keywords": ["oeis", "sequence", "seq", "integers", "numbers", "primes"]
},
"https://oeis.org/A000142": {
"id": "oeis-a000142",
"description": "The OEIS entry for the sequence of factorials.",
"short_url": "",
- "keywords": [
- "sequence",
- "seq",
- "factorials",
- "integers",
- "numbers"
- ]
+ "keywords": ["sequence", "seq", "factorials", "integers", "numbers"]
},
"https://oeis.org/A000217": {
"id": "oeis-a000217",
@@ -10010,48 +7085,25 @@
"id": "oeis-a000537",
"description": "The OEIS entry for squared triangular numbers.",
"short_url": "",
- "keywords": [
- "triangular",
- "squared",
- "numbers",
- "integers",
- "sequence"
- ]
+ "keywords": ["triangular", "squared", "numbers", "integers", "sequence"]
},
"https://oeis.org/A000578": {
"id": "oeis-a000578",
"description": "The OEIS entry for a sequence of cubes.",
"short_url": "",
- "keywords": [
- "sequence",
- "seq",
- "integers",
- "cubes",
- "numbers"
- ]
+ "keywords": ["sequence", "seq", "integers", "cubes", "numbers"]
},
"https://oeis.org/A000583": {
"id": "oeis-a000583",
"description": "The OEIS entry for fourth powers.",
"short_url": "",
- "keywords": [
- "sequence",
- "seq",
- "integers",
- "numbers",
- "fourth",
- "powers"
- ]
+ "keywords": ["sequence", "seq", "integers", "numbers", "fourth", "powers"]
},
"https://oeis.org/A000584": {
"id": "oeis-a000584",
"description": "OEIS sequence for fifth powers.",
"short_url": "",
- "keywords": [
- "oeis",
- "sequence",
- "integers"
- ]
+ "keywords": ["oeis", "sequence", "integers"]
},
"https://oeis.org/A001057": {
"id": "oeis-a001057",
@@ -10069,35 +7121,19 @@
"id": "oeis-a001477",
"description": "The OEIS entry for the sequence of nonnegative integers.",
"short_url": "",
- "keywords": [
- "nonnegative",
- "integers",
- "sequence",
- "natural",
- "numbers"
- ]
+ "keywords": ["nonnegative", "integers", "sequence", "natural", "numbers"]
},
"https://oeis.org/A001478": {
"id": "oeis-a001478",
"description": "The OEIS entry for the sequence of negative integers.",
"short_url": "",
- "keywords": [
- "sequence",
- "integers",
- "numbers",
- "negative"
- ]
+ "keywords": ["sequence", "integers", "numbers", "negative"]
},
"https://oeis.org/A001489": {
"id": "oeis-a001489",
"description": "The OEIS entry for the sequence of nonpositive integers.",
"short_url": "",
- "keywords": [
- "nonpositive",
- "sequence",
- "integers",
- "numbers"
- ]
+ "keywords": ["nonpositive", "sequence", "integers", "numbers"]
},
"https://oeis.org/A001690": {
"id": "oeis-a001690",
@@ -10172,50 +7208,25 @@
"id": "sublime-text-package-control",
"description": "Package manager for Sublime Text",
"short_url": "",
- "keywords": [
- "sublime",
- "text",
- "editor",
- "package",
- "pkg",
- "manager"
- ]
+ "keywords": ["sublime", "text", "editor", "package", "pkg", "manager"]
},
"https://plot.ly/matlab/": {
"id": "plotly",
"description": "Interactive, browser-based graphing with MATLAB and Plotly.",
"short_url": "",
- "keywords": [
- "plotly",
- "plot",
- "graph",
- "interactive",
- "browser",
- "matlab"
- ]
+ "keywords": ["plotly", "plot", "graph", "interactive", "browser", "matlab"]
},
"https://raw.githubusercontent.com/stdlib-js/stdlib/develop/LICENSE": {
"id": "stdlib-license",
"description": "The license for the stdlib JavaScript library.",
"short_url": "",
- "keywords": [
- "license",
- "stdlib",
- "javascript",
- "js",
- "library"
- ]
+ "keywords": ["license", "stdlib", "javascript", "js", "library"]
},
"https://semver.org/": {
"id": "semantic-version",
"description": "Semantic Versioning.",
"short_url": "",
- "keywords": [
- "semver",
- "version",
- "semantic",
- "versioning"
- ]
+ "keywords": ["semver", "version", "semantic", "versioning"]
},
"https://stdlib.io/": {
"id": "stdlib",
@@ -10269,49 +7280,25 @@
"id": "google-analytics-privacy-policy",
"description": "Google Analytics Privacy Policy Requirements.",
"short_url": "",
- "keywords": [
- "google",
- "analytics",
- "privacy",
- "policy",
- "requirements"
- ]
+ "keywords": ["google", "analytics", "privacy", "policy", "requirements"]
},
"https://tools.ietf.org/html/rfc1952": {
"id": "gzip-rfc-1952",
"description": "RFC format for the gzip file format.",
"short_url": "",
- "keywords": [
- "gzip",
- "compression",
- "compress",
- "file",
- "format"
- ]
+ "keywords": ["gzip", "compression", "compress", "file", "format"]
},
"https://tools.ietf.org/html/rfc2181": {
"id": "rfc-2181",
"description": "An RFC clarifying the DNS specification.",
"short_url": "",
- "keywords": [
- "rfc",
- "dns",
- "specification",
- "clarification"
- ]
+ "keywords": ["rfc", "dns", "specification", "clarification"]
},
"https://tools.ietf.org/html/rfc3986": {
"id": "rfc-3986",
"description": "An RFC describing the generic syntax for a URI.",
"short_url": "",
- "keywords": [
- "rfc",
- "uri",
- "url",
- "scheme",
- "specification",
- "spec"
- ]
+ "keywords": ["rfc", "uri", "url", "scheme", "specification", "spec"]
},
"https://tools.ietf.org/html/rfc3986#section-2.1": {
"id": "rfc-3986-percent-encoding",
@@ -10331,12 +7318,7 @@
"id": "csv",
"description": "Memo documenting the format used for Comma-Separated Values (CSV) files.",
"short_url": "",
- "keywords": [
- "csv",
- "mime",
- "rfc",
- "format"
- ]
+ "keywords": ["csv", "mime", "rfc", "format"]
},
"https://travis-ci.org/": {
"id": "travis-ci",
@@ -10394,12 +7376,7 @@
"id": "unpkg",
"description": "A fast, global content delivery network for everything on npm.",
"short_url": "",
- "keywords": [
- "npm",
- "distributable",
- "dist",
- "cdn"
- ]
+ "keywords": ["npm", "distributable", "dist", "cdn"]
},
"https://web.viu.ca/pughg/phdThesis/phdThesis.pdf": {
"id": "@pugh:2004a",
@@ -10418,23 +7395,13 @@
"id": "webassembly",
"description": "Official website for WebAssembly, a portable compilation target for the Web.",
"short_url": "",
- "keywords": [
- "webassembly",
- "wasm",
- "asm",
- "binary"
- ]
+ "keywords": ["webassembly", "wasm", "asm", "binary"]
},
"https://webassembly.org/docs/semantics/": {
"id": "web-assembly-semantics",
"description": "WebAssembly semantics.",
"short_url": "",
- "keywords": [
- "webassembly",
- "wasm",
- "asm",
- "binary"
- ]
+ "keywords": ["webassembly", "wasm", "asm", "binary"]
},
"https://webpack.js.org/": {
"id": "webpack",
@@ -10457,22 +7424,13 @@
"id": "wordpress-privacy-policy",
"description": "WordPress privacy policy.",
"short_url": "",
- "keywords": [
- "wordpress",
- "privacy",
- "policy"
- ]
+ "keywords": ["wordpress", "privacy", "policy"]
},
"https://www.apache.org/foundation/voting.html": {
"id": "apache-foundation-voting-process",
"description": "Apache Foundation voting process.",
"short_url": "",
- "keywords": [
- "apache",
- "foundation",
- "voting",
- "process"
- ]
+ "keywords": ["apache", "foundation", "voting", "process"]
},
"https://www.apache.org/licenses/LICENSE-2.0": {
"id": "apache-license",
@@ -10490,24 +7448,13 @@
"id": "appveyor",
"description": "A continuous integration service for Windows.",
"short_url": "",
- "keywords": [
- "ci",
- "continuous",
- "integration",
- "windows",
- "build"
- ]
+ "keywords": ["ci", "continuous", "integration", "windows", "build"]
},
"https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md": {
"id": "contributor-covenant",
"description": "Contributor Covenant Code of Conduct.",
"short_url": "",
- "keywords": [
- "contributor",
- "covenant",
- "code",
- "conduct"
- ]
+ "keywords": ["contributor", "covenant", "code", "conduct"]
},
"https://www.docker.com/": {
"id": "docker",
@@ -10586,35 +7533,19 @@
"id": "bash",
"description": "The official site of GNU bash, an sh-compatible shell.",
"short_url": "",
- "keywords": [
- "bash",
- "gnu",
- "shell"
- ]
+ "keywords": ["bash", "gnu", "shell"]
},
"https://www.gnu.org/software/bash/manual/bashref.html#Programmable-Completion": {
"id": "bash-completion",
"description": "Programmable completion in GNU bash.",
"short_url": "",
- "keywords": [
- "bash",
- "gnu",
- "shell",
- "completion",
- "programmable"
- ]
+ "keywords": ["bash", "gnu", "shell", "completion", "programmable"]
},
"https://www.gnu.org/software/make/": {
"id": "make",
"description": "A development utility which controls the generation of executables and other non-source files of a program from the program's source files.",
"short_url": "",
- "keywords": [
- "make",
- "makefile",
- "build",
- "development",
- "utility"
- ]
+ "keywords": ["make", "makefile", "build", "development", "utility"]
},
"https://www.itl.nist.gov/div898/handbook/ppc/section2/ppc231.htm": {
"id": "anova-nist",
@@ -10701,13 +7632,7 @@
"id": "matlab-parfor",
"description": "Parallel for loop in MATLAB.",
"short_url": "",
- "keywords": [
- "matlab",
- "parallel",
- "for",
- "loop",
- "parfor"
- ]
+ "keywords": ["matlab", "parallel", "for", "loop", "parfor"]
},
"https://www.npmjs.com/": {
"id": "npm",
@@ -10743,25 +7668,13 @@
"id": "repl-template-lib",
"description": "A lightweight template library in NodeJS.",
"short_url": "",
- "keywords": [
- "template",
- "engine",
- "repl",
- "nodejs",
- "javascript"
- ]
+ "keywords": ["template", "engine", "repl", "nodejs", "javascript"]
},
"https://www.npmjs.com/policies/open-source-terms": {
"id": "npm-open-source-terms",
"description": "NPM's open source terms.",
"short_url": "",
- "keywords": [
- "npm",
- "open",
- "source",
- "terms",
- "license"
- ]
+ "keywords": ["npm", "open", "source", "terms", "license"]
},
"https://www.patreon.com/athan": {
"id": "patreon",
@@ -10780,23 +7693,13 @@
"id": "python",
"description": "The official website of Python, a general purpose programming language.",
"short_url": "",
- "keywords": [
- "python",
- "language",
- "lang"
- ]
+ "keywords": ["python", "language", "lang"]
},
"https://www.r-project.org/": {
"id": "r",
"description": "A free software environment for statistical computing and graphics.",
"short_url": "",
- "keywords": [
- "r",
- "statistics",
- "stats",
- "lang",
- "language"
- ]
+ "keywords": ["r", "statistics", "stats", "lang", "language"]
},
"https://www.rfc-editor.org/rfc/rfc4180": {
"id": "rfc-4180",
@@ -10817,97 +7720,54 @@
"id": "rust-code-of-conduct",
"description": "The Rust Code of Conduct.",
"short_url": "",
- "keywords": [
- "rust",
- "code",
- "conduct",
- "coc"
- ]
+ "keywords": ["rust", "code", "conduct", "coc"]
},
"https://www.sciencedirect.com/science/article/pii/S0169207016000121": {
"id": "@kim:2016a",
"description": "Kim, S. and Kim, H. 2016. A new metric of absolute percentage error for intermittent demand forecasts.",
"short_url": "",
- "keywords": [
- "journal",
- "paper",
- "forecasing",
- "forecast",
- "maape"
- ]
+ "keywords": ["journal", "paper", "forecasing", "forecast", "maape"]
},
"https://www.scipy.org/scipylib/index.html": {
"id": "scipy",
"description": "Official homepage for SciPy, a collection of mathematical algorithms and convenience functions built on the Numpy extension of Python.",
"short_url": "",
- "keywords": [
- "scipy",
- "python"
- ]
+ "keywords": ["scipy", "python"]
},
"https://www.sublimetext.com/": {
"id": "sublime-text",
"description": "Sublime Text text editor. Official website.",
"short_url": "",
- "keywords": [
- "sublime",
- "text",
- "editor"
- ]
+ "keywords": ["sublime", "text", "editor"]
},
"https://www.typescriptlang.org/": {
"id": "typescript",
"description": "Typescript language homepage.",
"short_url": "",
- "keywords": [
- "typescript",
- "ts",
- "docs",
- "documentation"
- ]
+ "keywords": ["typescript", "ts", "docs", "documentation"]
},
"https://www.unicode.org/Public/13.0.0/ucd/auxiliary/GraphemeBreakProperty.txt": {
"id": "unicode-grapheme-break-property",
"description": "Unicode grapheme break property.",
"short_url": "",
- "keywords": [
- "unicode",
- "grapheme",
- "break",
- "property"
- ]
+ "keywords": ["unicode", "grapheme", "break", "property"]
},
"https://www.unicode.org/Public/13.0.0/ucd/emoji/emoji-data.txt": {
"id": "unicode-emoji-property",
"description": "Unicode emoji property.",
"short_url": "",
- "keywords": [
- "unicode",
- "emoji",
- "property"
- ]
+ "keywords": ["unicode", "emoji", "property"]
},
"https://www.w3.org/Graphics/SVG/": {
"id": "svg",
"description": "The site of the official W3C SVG working group.",
"short_url": "",
- "keywords": [
- "svg",
- "scalable",
- "vector",
- "graphics"
- ]
+ "keywords": ["svg", "scalable", "vector", "graphics"]
},
"https://yarnpkg.com/": {
"id": "yarn",
"description": "Yarn is a package manager that doubles down as project manager.",
"short_url": "",
- "keywords": [
- "yarn",
- "package",
- "manager",
- "nodejs",
- "javascript"
- ]
+ "keywords": ["yarn", "package", "manager", "nodejs", "javascript"]
}
}
diff --git a/docs/migration-guides/jstat/benchmark/benchmark.max.js b/docs/migration-guides/jstat/benchmark/benchmark.max.js
index 93740f3da5ac..d283086208dc 100644
--- a/docs/migration-guides/jstat/benchmark/benchmark.max.js
+++ b/docs/migration-guides/jstat/benchmark/benchmark.max.js
@@ -1,90 +1,87 @@
/**
-* @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.
-*/
-
-'use strict';
+ * @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.
+ */
+
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var randu = require( '@stdlib/random/base/randu' );
-var pow = require( '@stdlib/math/base/special/pow' );
-var Float64Array = require( '@stdlib/array/float64' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var randu = require("@stdlib/random/base/randu");
+var pow = require("@stdlib/math/base/special/pow");
+var Float64Array = require("@stdlib/array/float64");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var jstat = tryRequire( resolve( __dirname, '..', 'node_modules', 'jstat' ) );
+var jstat = tryRequire(resolve(__dirname, "..", "node_modules", "jstat"));
var opts = {
- 'skip': ( jstat instanceof Error )
+ skip: jstat instanceof Error,
};
-
// FUNCTIONS //
/**
-* Creates a benchmark function.
-*
-* @private
-* @param {PositiveInteger} len - array length
-* @returns {Function} benchmark function
-*/
-function createBenchmark( len ) {
+ * Creates a benchmark function.
+ *
+ * @private
+ * @param {PositiveInteger} len - array length
+ * @returns {Function} benchmark function
+ */
+function createBenchmark(len) {
var x;
var i;
- x = new Float64Array( len );
- for ( i = 0; i < x.length; i++ ) {
- x[ i ] = ( randu()*20.0 ) - 10.0;
+ x = new Float64Array(len);
+ for (i = 0; i < x.length; i++) {
+ x[i] = randu() * 20.0 - 10.0;
}
return benchmark;
- function benchmark( b ) {
+ function benchmark(b) {
var v;
var i;
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- v = jstat.max( x );
- if ( isnan( v ) ) {
- b.fail( 'should not return NaN' );
+ for (i = 0; i < b.iterations; i++) {
+ v = jstat.max(x);
+ if (isnan(v)) {
+ b.fail("should not return NaN");
}
}
b.toc();
- if ( isnan( v ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(v)) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
}
}
-
// MAIN //
/**
-* Main execution sequence.
-*
-* @private
-*/
+ * Main execution sequence.
+ *
+ * @private
+ */
function main() {
var len;
var min;
@@ -95,10 +92,10 @@ function main() {
min = 1; // 10^min
max = 6; // 10^max
- for ( i = min; i <= max; i++ ) {
- len = pow( 10, i );
- f = createBenchmark( len );
- bench( pkg+'::jstat:max:len='+len, opts, f );
+ for (i = min; i <= max; i++) {
+ len = pow(10, i);
+ f = createBenchmark(len);
+ bench(pkg + "::jstat:max:len=" + len, opts, f);
}
}
diff --git a/docs/migration-guides/jstat/benchmark/benchmark.min.js b/docs/migration-guides/jstat/benchmark/benchmark.min.js
index 905a725f0dae..ee195b347bd1 100644
--- a/docs/migration-guides/jstat/benchmark/benchmark.min.js
+++ b/docs/migration-guides/jstat/benchmark/benchmark.min.js
@@ -1,90 +1,87 @@
/**
-* @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.
-*/
-
-'use strict';
+ * @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.
+ */
+
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var randu = require( '@stdlib/random/base/randu' );
-var pow = require( '@stdlib/math/base/special/pow' );
-var Float64Array = require( '@stdlib/array/float64' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var randu = require("@stdlib/random/base/randu");
+var pow = require("@stdlib/math/base/special/pow");
+var Float64Array = require("@stdlib/array/float64");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var jstat = tryRequire( resolve( __dirname, '..', 'node_modules', 'jstat' ) );
+var jstat = tryRequire(resolve(__dirname, "..", "node_modules", "jstat"));
var opts = {
- 'skip': ( jstat instanceof Error )
+ skip: jstat instanceof Error,
};
-
// FUNCTIONS //
/**
-* Creates a benchmark function.
-*
-* @private
-* @param {PositiveInteger} len - array length
-* @returns {Function} benchmark function
-*/
-function createBenchmark( len ) {
+ * Creates a benchmark function.
+ *
+ * @private
+ * @param {PositiveInteger} len - array length
+ * @returns {Function} benchmark function
+ */
+function createBenchmark(len) {
var x;
var i;
- x = new Float64Array( len );
- for ( i = 0; i < x.length; i++ ) {
- x[ i ] = ( randu()*20.0 ) - 10.0;
+ x = new Float64Array(len);
+ for (i = 0; i < x.length; i++) {
+ x[i] = randu() * 20.0 - 10.0;
}
return benchmark;
- function benchmark( b ) {
+ function benchmark(b) {
var v;
var i;
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- v = jstat.min( x );
- if ( isnan( v ) ) {
- b.fail( 'should not return NaN' );
+ for (i = 0; i < b.iterations; i++) {
+ v = jstat.min(x);
+ if (isnan(v)) {
+ b.fail("should not return NaN");
}
}
b.toc();
- if ( isnan( v ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(v)) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
}
}
-
// MAIN //
/**
-* Main execution sequence.
-*
-* @private
-*/
+ * Main execution sequence.
+ *
+ * @private
+ */
function main() {
var len;
var min;
@@ -95,10 +92,10 @@ function main() {
min = 1; // 10^min
max = 6; // 10^max
- for ( i = min; i <= max; i++ ) {
- len = pow( 10, i );
- f = createBenchmark( len );
- bench( pkg+'::jstat:min:len='+len, opts, f );
+ for (i = min; i <= max; i++) {
+ len = pow(10, i);
+ f = createBenchmark(len);
+ bench(pkg + "::jstat:min:len=" + len, opts, f);
}
}
diff --git a/docs/migration-guides/jstat/benchmark/benchmark.range.js b/docs/migration-guides/jstat/benchmark/benchmark.range.js
index 2df201800b78..0b46752a7d16 100644
--- a/docs/migration-guides/jstat/benchmark/benchmark.range.js
+++ b/docs/migration-guides/jstat/benchmark/benchmark.range.js
@@ -1,90 +1,87 @@
/**
-* @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.
-*/
-
-'use strict';
+ * @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.
+ */
+
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var randu = require( '@stdlib/random/base/randu' );
-var pow = require( '@stdlib/math/base/special/pow' );
-var Float64Array = require( '@stdlib/array/float64' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var randu = require("@stdlib/random/base/randu");
+var pow = require("@stdlib/math/base/special/pow");
+var Float64Array = require("@stdlib/array/float64");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var jstat = tryRequire( resolve( __dirname, '..', 'node_modules', 'jstat' ) );
+var jstat = tryRequire(resolve(__dirname, "..", "node_modules", "jstat"));
var opts = {
- 'skip': ( jstat instanceof Error )
+ skip: jstat instanceof Error,
};
-
// FUNCTIONS //
/**
-* Creates a benchmark function.
-*
-* @private
-* @param {PositiveInteger} len - array length
-* @returns {Function} benchmark function
-*/
-function createBenchmark( len ) {
+ * Creates a benchmark function.
+ *
+ * @private
+ * @param {PositiveInteger} len - array length
+ * @returns {Function} benchmark function
+ */
+function createBenchmark(len) {
var x;
var i;
- x = new Float64Array( len );
- for ( i = 0; i < x.length; i++ ) {
- x[ i ] = ( randu()*20.0 ) - 10.0;
+ x = new Float64Array(len);
+ for (i = 0; i < x.length; i++) {
+ x[i] = randu() * 20.0 - 10.0;
}
return benchmark;
- function benchmark( b ) {
+ function benchmark(b) {
var v;
var i;
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- v = jstat.range( x );
- if ( isnan( v ) ) {
- b.fail( 'should not return NaN' );
+ for (i = 0; i < b.iterations; i++) {
+ v = jstat.range(x);
+ if (isnan(v)) {
+ b.fail("should not return NaN");
}
}
b.toc();
- if ( isnan( v ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(v)) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
}
}
-
// MAIN //
/**
-* Main execution sequence.
-*
-* @private
-*/
+ * Main execution sequence.
+ *
+ * @private
+ */
function main() {
var len;
var min;
@@ -95,10 +92,10 @@ function main() {
min = 1; // 10^min
max = 6; // 10^max
- for ( i = min; i <= max; i++ ) {
- len = pow( 10, i );
- f = createBenchmark( len );
- bench( pkg+'::jstat:range:len='+len, opts, f );
+ for (i = min; i <= max; i++) {
+ len = pow(10, i);
+ f = createBenchmark(len);
+ bench(pkg + "::jstat:range:len=" + len, opts, f);
}
}
diff --git a/docs/migration-guides/jstat/benchmark/benchmark.sum.js b/docs/migration-guides/jstat/benchmark/benchmark.sum.js
index f3f39486c5d9..551faf86abf4 100644
--- a/docs/migration-guides/jstat/benchmark/benchmark.sum.js
+++ b/docs/migration-guides/jstat/benchmark/benchmark.sum.js
@@ -1,90 +1,87 @@
/**
-* @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.
-*/
-
-'use strict';
+ * @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.
+ */
+
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var randu = require( '@stdlib/random/base/randu' );
-var pow = require( '@stdlib/math/base/special/pow' );
-var Float64Array = require( '@stdlib/array/float64' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var randu = require("@stdlib/random/base/randu");
+var pow = require("@stdlib/math/base/special/pow");
+var Float64Array = require("@stdlib/array/float64");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var jstat = tryRequire( resolve( __dirname, '..', 'node_modules', 'jstat' ) );
+var jstat = tryRequire(resolve(__dirname, "..", "node_modules", "jstat"));
var opts = {
- 'skip': ( jstat instanceof Error )
+ skip: jstat instanceof Error,
};
-
// FUNCTIONS //
/**
-* Creates a benchmark function.
-*
-* @private
-* @param {PositiveInteger} len - array length
-* @returns {Function} benchmark function
-*/
-function createBenchmark( len ) {
+ * Creates a benchmark function.
+ *
+ * @private
+ * @param {PositiveInteger} len - array length
+ * @returns {Function} benchmark function
+ */
+function createBenchmark(len) {
var x;
var i;
- x = new Float64Array( len );
- for ( i = 0; i < x.length; i++ ) {
- x[ i ] = ( randu()*20.0 ) - 10.0;
+ x = new Float64Array(len);
+ for (i = 0; i < x.length; i++) {
+ x[i] = randu() * 20.0 - 10.0;
}
return benchmark;
- function benchmark( b ) {
+ function benchmark(b) {
var v;
var i;
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- v = jstat.sum( x );
- if ( isnan( v ) ) {
- b.fail( 'should not return NaN' );
+ for (i = 0; i < b.iterations; i++) {
+ v = jstat.sum(x);
+ if (isnan(v)) {
+ b.fail("should not return NaN");
}
}
b.toc();
- if ( isnan( v ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(v)) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
}
}
-
// MAIN //
/**
-* Main execution sequence.
-*
-* @private
-*/
+ * Main execution sequence.
+ *
+ * @private
+ */
function main() {
var len;
var min;
@@ -95,10 +92,10 @@ function main() {
min = 1; // 10^min
max = 6; // 10^max
- for ( i = min; i <= max; i++ ) {
- len = pow( 10, i );
- f = createBenchmark( len );
- bench( pkg+'::jstat:sum:len='+len, opts, f );
+ for (i = min; i <= max; i++) {
+ len = pow(10, i);
+ f = createBenchmark(len);
+ bench(pkg + "::jstat:sum:len=" + len, opts, f);
}
}
diff --git a/docs/migration-guides/lodash/benchmark/benchmark.count_by.js b/docs/migration-guides/lodash/benchmark/benchmark.count_by.js
index a925d452238a..c60dc96ba917 100644
--- a/docs/migration-guides/lodash/benchmark/benchmark.count_by.js
+++ b/docs/migration-guides/lodash/benchmark/benchmark.count_by.js
@@ -1,107 +1,105 @@
/**
-* @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';
+ * @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 resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var countBy = require( '@stdlib/utils/count-by' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var discreteUniform = require("@stdlib/random/base/discrete-uniform");
+var tryRequire = require("@stdlib/utils/try-require");
+var countBy = require("@stdlib/utils/count-by");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var _ = tryRequire( resolve( __dirname, '..', 'node_modules', 'lodash' ) );
+var _ = tryRequire(resolve(__dirname, "..", "node_modules", "lodash"));
var opts = {
- 'skip': ( _ instanceof Error )
+ skip: _ instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:utils/count-by', opts, function benchmark( b ) {
+bench(pkg + "::stdlib:utils/count-by", opts, function benchmark(b) {
var vals;
var arr;
var o;
var i;
var j;
- vals = [ 'beep', 'boop', 'foo', 'bar', 'woot' ];
+ vals = ["beep", "boop", "foo", "bar", "woot"];
arr = [];
- for ( i = 0; i < 100; i++ ) {
- j = discreteUniform( 0, vals.length-1 );
- arr.push( vals[ j ] );
+ for (i = 0; i < 100; i++) {
+ j = discreteUniform(0, vals.length - 1);
+ arr.push(vals[j]);
}
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- arr[ 0 ] = vals[ i%vals.length ];
- o = countBy( arr, indicator );
- if ( typeof o !== 'object' ) {
- b.fail( 'should return an object' );
+ for (i = 0; i < b.iterations; i++) {
+ arr[0] = vals[i % vals.length];
+ o = countBy(arr, indicator);
+ if (typeof o !== "object") {
+ b.fail("should return an object");
}
}
b.toc();
- if ( typeof o !== 'object' ) {
- b.fail( 'should return an object' );
+ if (typeof o !== "object") {
+ b.fail("should return an object");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
- function indicator( v ) {
- return v[ 0 ];
+ function indicator(v) {
+ return v[0];
}
});
-bench( pkg+'::lodash:countBy', opts, function benchmark( b ) {
+bench(pkg + "::lodash:countBy", opts, function benchmark(b) {
var vals;
var arr;
var o;
var i;
var j;
- vals = [ 'beep', 'boop', 'foo', 'bar', 'woot' ];
+ vals = ["beep", "boop", "foo", "bar", "woot"];
arr = [];
- for ( i = 0; i < 100; i++ ) {
- j = discreteUniform( 0, vals.length-1 );
- arr.push( vals[ j ] );
+ for (i = 0; i < 100; i++) {
+ j = discreteUniform(0, vals.length - 1);
+ arr.push(vals[j]);
}
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- arr[ 0 ] = vals[ i%vals.length ];
- o = _.countBy( arr, indicator );
- if ( typeof o !== 'object' ) {
- b.fail( 'should return an object' );
+ for (i = 0; i < b.iterations; i++) {
+ arr[0] = vals[i % vals.length];
+ o = _.countBy(arr, indicator);
+ if (typeof o !== "object") {
+ b.fail("should return an object");
}
}
b.toc();
- if ( typeof o !== 'object' ) {
- b.fail( 'should return an object' );
+ if (typeof o !== "object") {
+ b.fail("should return an object");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
- function indicator( v ) {
- return v[ 0 ];
+ function indicator(v) {
+ return v[0];
}
});
diff --git a/docs/migration-guides/lodash/benchmark/benchmark.every.js b/docs/migration-guides/lodash/benchmark/benchmark.every.js
index 3dbb5667cb56..beba21369792 100644
--- a/docs/migration-guides/lodash/benchmark/benchmark.every.js
+++ b/docs/migration-guides/lodash/benchmark/benchmark.every.js
@@ -1,94 +1,92 @@
/**
-* @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';
+ * @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 resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
-var tryRequire = require( '@stdlib/utils/try-require' );
-var every = require( '@stdlib/utils/every' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var isBoolean = require("@stdlib/assert/is-boolean").isPrimitive;
+var tryRequire = require("@stdlib/utils/try-require");
+var every = require("@stdlib/utils/every");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var _ = tryRequire( resolve( __dirname, '..', 'node_modules', 'lodash' ) );
+var _ = tryRequire(resolve(__dirname, "..", "node_modules", "lodash"));
var opts = {
- 'skip': ( _ instanceof Error )
+ skip: _ instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:utils/every', opts, function benchmark( b ) {
+bench(pkg + "::stdlib:utils/every", opts, function benchmark(b) {
var bool;
var arr;
var i;
- arr = [ 1, 2, 3, 4, 5 ];
+ arr = [1, 2, 3, 4, 5];
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- arr[ 0 ] += i;
- bool = every( arr, predicate );
- if ( typeof bool !== 'boolean' ) {
- b.fail( 'should return a boolean' );
+ for (i = 0; i < b.iterations; i++) {
+ arr[0] += i;
+ bool = every(arr, predicate);
+ if (typeof bool !== "boolean") {
+ b.fail("should return a boolean");
}
}
b.toc();
- if ( !isBoolean( bool ) ) {
- b.fail( 'should return a boolean' );
+ if (!isBoolean(bool)) {
+ b.fail("should return a boolean");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
- function predicate( v ) {
- return !isnan( v );
+ function predicate(v) {
+ return !isnan(v);
}
});
-bench( pkg+'::lodash:every', opts, function benchmark( b ) {
+bench(pkg + "::lodash:every", opts, function benchmark(b) {
var bool;
var arr;
var i;
- arr = [ 1, 2, 3, 4, 5 ];
+ arr = [1, 2, 3, 4, 5];
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- arr[ 0 ] += i;
- bool = _.every( arr, predicate );
- if ( typeof bool !== 'boolean' ) {
- b.fail( 'should return a boolean' );
+ for (i = 0; i < b.iterations; i++) {
+ arr[0] += i;
+ bool = _.every(arr, predicate);
+ if (typeof bool !== "boolean") {
+ b.fail("should return a boolean");
}
}
b.toc();
- if ( !isBoolean( bool ) ) {
- b.fail( 'should return a boolean' );
+ if (!isBoolean(bool)) {
+ b.fail("should return a boolean");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
- function predicate( v ) {
- return !isnan( v );
+ function predicate(v) {
+ return !isnan(v);
}
});
diff --git a/docs/migration-guides/lodash/benchmark/benchmark.for_each.js b/docs/migration-guides/lodash/benchmark/benchmark.for_each.js
index ed347a47b97f..948ced1cf631 100644
--- a/docs/migration-guides/lodash/benchmark/benchmark.for_each.js
+++ b/docs/migration-guides/lodash/benchmark/benchmark.for_each.js
@@ -1,95 +1,93 @@
/**
-* @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';
+ * @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 resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var forEach = require( '@stdlib/utils/for-each' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var tryRequire = require("@stdlib/utils/try-require");
+var forEach = require("@stdlib/utils/for-each");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var _ = tryRequire( resolve( __dirname, '..', 'node_modules', 'lodash' ) );
+var _ = tryRequire(resolve(__dirname, "..", "node_modules", "lodash"));
var opts = {
- 'skip': ( _ instanceof Error )
+ skip: _ instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:utils/for-each', opts, function benchmark( b ) {
+bench(pkg + "::stdlib:utils/for-each", opts, function benchmark(b) {
var arr;
var i;
- arr = [ 1, 2, 3, 4, 5 ];
+ arr = [1, 2, 3, 4, 5];
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- arr[ 0 ] += i;
- forEach( arr, onItem );
- if ( arr.length !== 5 ) {
- b.fail( 'should not change the array length' );
+ for (i = 0; i < b.iterations; i++) {
+ arr[0] += i;
+ forEach(arr, onItem);
+ if (arr.length !== 5) {
+ b.fail("should not change the array length");
}
}
b.toc();
- if ( arr.length !== 5 ) {
- b.fail( 'should not change the array length' );
+ if (arr.length !== 5) {
+ b.fail("should not change the array length");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
- function onItem( v ) {
- if ( isnan( v ) ) {
- b.fail( 'should not be NaN' );
+ function onItem(v) {
+ if (isnan(v)) {
+ b.fail("should not be NaN");
}
}
});
-bench( pkg+'::lodash:forEach', opts, function benchmark( b ) {
+bench(pkg + "::lodash:forEach", opts, function benchmark(b) {
var arr;
var i;
- arr = [ 1, 2, 3, 4, 5 ];
+ arr = [1, 2, 3, 4, 5];
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- arr[ 0 ] += i;
- _.forEach( arr, onItem );
- if ( arr.length !== 5 ) {
- b.fail( 'should not change the array length' );
+ for (i = 0; i < b.iterations; i++) {
+ arr[0] += i;
+ _.forEach(arr, onItem);
+ if (arr.length !== 5) {
+ b.fail("should not change the array length");
}
}
b.toc();
- if ( arr.length !== 5 ) {
- b.fail( 'should not change the array length' );
+ if (arr.length !== 5) {
+ b.fail("should not change the array length");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
- function onItem( v ) {
- if ( isnan( v ) ) {
- b.fail( 'should not be NaN' );
+ function onItem(v) {
+ if (isnan(v)) {
+ b.fail("should not be NaN");
}
}
});
diff --git a/docs/migration-guides/lodash/benchmark/benchmark.for_each_right.js b/docs/migration-guides/lodash/benchmark/benchmark.for_each_right.js
index d5956f77743c..8b0b655e8828 100644
--- a/docs/migration-guides/lodash/benchmark/benchmark.for_each_right.js
+++ b/docs/migration-guides/lodash/benchmark/benchmark.for_each_right.js
@@ -1,95 +1,93 @@
/**
-* @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';
+ * @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 resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var forEachRight = require( '@stdlib/utils/for-each-right' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var tryRequire = require("@stdlib/utils/try-require");
+var forEachRight = require("@stdlib/utils/for-each-right");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var _ = tryRequire( resolve( __dirname, '..', 'node_modules', 'lodash' ) );
+var _ = tryRequire(resolve(__dirname, "..", "node_modules", "lodash"));
var opts = {
- 'skip': ( _ instanceof Error )
+ skip: _ instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:utils/for-each-right', opts, function benchmark( b ) {
+bench(pkg + "::stdlib:utils/for-each-right", opts, function benchmark(b) {
var arr;
var i;
- arr = [ 1, 2, 3, 4, 5 ];
+ arr = [1, 2, 3, 4, 5];
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- arr[ 0 ] += i;
- forEachRight( arr, onItem );
- if ( arr.length !== 5 ) {
- b.fail( 'should not change the array length' );
+ for (i = 0; i < b.iterations; i++) {
+ arr[0] += i;
+ forEachRight(arr, onItem);
+ if (arr.length !== 5) {
+ b.fail("should not change the array length");
}
}
b.toc();
- if ( arr.length !== 5 ) {
- b.fail( 'should not change the array length' );
+ if (arr.length !== 5) {
+ b.fail("should not change the array length");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
- function onItem( v ) {
- if ( isnan( v ) ) {
- b.fail( 'should not be NaN' );
+ function onItem(v) {
+ if (isnan(v)) {
+ b.fail("should not be NaN");
}
}
});
-bench( pkg+'::lodash:forEachRight', opts, function benchmark( b ) {
+bench(pkg + "::lodash:forEachRight", opts, function benchmark(b) {
var arr;
var i;
- arr = [ 1, 2, 3, 4, 5 ];
+ arr = [1, 2, 3, 4, 5];
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- arr[ 0 ] += i;
- _.forEachRight( arr, onItem );
- if ( arr.length !== 5 ) {
- b.fail( 'should not change the array length' );
+ for (i = 0; i < b.iterations; i++) {
+ arr[0] += i;
+ _.forEachRight(arr, onItem);
+ if (arr.length !== 5) {
+ b.fail("should not change the array length");
}
}
b.toc();
- if ( arr.length !== 5 ) {
- b.fail( 'should not change the array length' );
+ if (arr.length !== 5) {
+ b.fail("should not change the array length");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
- function onItem( v ) {
- if ( isnan( v ) ) {
- b.fail( 'should not be NaN' );
+ function onItem(v) {
+ if (isnan(v)) {
+ b.fail("should not be NaN");
}
}
});
diff --git a/docs/migration-guides/lodash/benchmark/benchmark.group_by.js b/docs/migration-guides/lodash/benchmark/benchmark.group_by.js
index 8ac5ba54aaaf..e3d4ce90ef23 100644
--- a/docs/migration-guides/lodash/benchmark/benchmark.group_by.js
+++ b/docs/migration-guides/lodash/benchmark/benchmark.group_by.js
@@ -1,107 +1,105 @@
/**
-* @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';
+ * @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 resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var groupBy = require( '@stdlib/utils/group-by' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var discreteUniform = require("@stdlib/random/base/discrete-uniform");
+var tryRequire = require("@stdlib/utils/try-require");
+var groupBy = require("@stdlib/utils/group-by");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var _ = tryRequire( resolve( __dirname, '..', 'node_modules', 'lodash' ) );
+var _ = tryRequire(resolve(__dirname, "..", "node_modules", "lodash"));
var opts = {
- 'skip': ( _ instanceof Error )
+ skip: _ instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:utils/group-by', opts, function benchmark( b ) {
+bench(pkg + "::stdlib:utils/group-by", opts, function benchmark(b) {
var vals;
var arr;
var o;
var i;
var j;
- vals = [ 'beep', 'boop', 'foo', 'bar', 'woot' ];
+ vals = ["beep", "boop", "foo", "bar", "woot"];
arr = [];
- for ( i = 0; i < 100; i++ ) {
- j = discreteUniform( 0, vals.length-1 );
- arr.push( vals[ j ] );
+ for (i = 0; i < 100; i++) {
+ j = discreteUniform(0, vals.length - 1);
+ arr.push(vals[j]);
}
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- arr[ 0 ] = vals[ i%vals.length ];
- o = groupBy( arr, indicator );
- if ( typeof o !== 'object' ) {
- b.fail( 'should return an object' );
+ for (i = 0; i < b.iterations; i++) {
+ arr[0] = vals[i % vals.length];
+ o = groupBy(arr, indicator);
+ if (typeof o !== "object") {
+ b.fail("should return an object");
}
}
b.toc();
- if ( typeof o !== 'object' ) {
- b.fail( 'should return an object' );
+ if (typeof o !== "object") {
+ b.fail("should return an object");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
- function indicator( v ) {
- return v[ 0 ];
+ function indicator(v) {
+ return v[0];
}
});
-bench( pkg+'::lodash:groupBy', opts, function benchmark( b ) {
+bench(pkg + "::lodash:groupBy", opts, function benchmark(b) {
var vals;
var arr;
var o;
var i;
var j;
- vals = [ 'beep', 'boop', 'foo', 'bar', 'woot' ];
+ vals = ["beep", "boop", "foo", "bar", "woot"];
arr = [];
- for ( i = 0; i < 100; i++ ) {
- j = discreteUniform( 0, vals.length-1 );
- arr.push( vals[ j ] );
+ for (i = 0; i < 100; i++) {
+ j = discreteUniform(0, vals.length - 1);
+ arr.push(vals[j]);
}
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- arr[ 0 ] = vals[ i%vals.length ];
- o = _.groupBy( arr, indicator );
- if ( typeof o !== 'object' ) {
- b.fail( 'should return an object' );
+ for (i = 0; i < b.iterations; i++) {
+ arr[0] = vals[i % vals.length];
+ o = _.groupBy(arr, indicator);
+ if (typeof o !== "object") {
+ b.fail("should return an object");
}
}
b.toc();
- if ( typeof o !== 'object' ) {
- b.fail( 'should return an object' );
+ if (typeof o !== "object") {
+ b.fail("should return an object");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
- function indicator( v ) {
- return v[ 0 ];
+ function indicator(v) {
+ return v[0];
}
});
diff --git a/docs/migration-guides/lodash/benchmark/benchmark.key_by.js b/docs/migration-guides/lodash/benchmark/benchmark.key_by.js
index 1c1b84970e1a..4fee738caeea 100644
--- a/docs/migration-guides/lodash/benchmark/benchmark.key_by.js
+++ b/docs/migration-guides/lodash/benchmark/benchmark.key_by.js
@@ -1,102 +1,100 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var keyBy = require( '@stdlib/utils/key-by' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var tryRequire = require("@stdlib/utils/try-require");
+var keyBy = require("@stdlib/utils/key-by");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var _ = tryRequire( resolve( __dirname, '..', 'node_modules', 'lodash' ) );
+var _ = tryRequire(resolve(__dirname, "..", "node_modules", "lodash"));
var opts = {
- 'skip': ( _ instanceof Error )
+ skip: _ instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:utils/key-by', opts, function benchmark( b ) {
+bench(pkg + "::stdlib:utils/key-by", opts, function benchmark(b) {
var arr;
var out;
var i;
arr = [];
- for ( i = 0; i < 100; i++ ) {
+ for (i = 0; i < 100; i++) {
arr.push({
- 'name': 'v'+i,
- 'value': i
+ name: "v" + i,
+ value: i,
});
}
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- arr[ 0 ].value = i;
- out = keyBy( arr, toKey );
- if ( typeof out !== 'object' ) {
- b.fail( 'should return an object' );
+ for (i = 0; i < b.iterations; i++) {
+ arr[0].value = i;
+ out = keyBy(arr, toKey);
+ if (typeof out !== "object") {
+ b.fail("should return an object");
}
}
b.toc();
- if ( typeof out !== 'object' ) {
- b.fail( 'should return an object' );
+ if (typeof out !== "object") {
+ b.fail("should return an object");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
- function toKey( value ) {
+ function toKey(value) {
return value.name;
}
});
-bench( pkg+'::lodash:keyBy', opts, function benchmark( b ) {
+bench(pkg + "::lodash:keyBy", opts, function benchmark(b) {
var arr;
var out;
var i;
arr = [];
- for ( i = 0; i < 100; i++ ) {
+ for (i = 0; i < 100; i++) {
arr.push({
- 'name': 'v'+i,
- 'value': i
+ name: "v" + i,
+ value: i,
});
}
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- arr[ 0 ].value = i;
- out = _.keyBy( arr, toKey );
- if ( typeof out !== 'object' ) {
- b.fail( 'should return an object' );
+ for (i = 0; i < b.iterations; i++) {
+ arr[0].value = i;
+ out = _.keyBy(arr, toKey);
+ if (typeof out !== "object") {
+ b.fail("should return an object");
}
}
b.toc();
- if ( typeof out !== 'object' ) {
- b.fail( 'should return an object' );
+ if (typeof out !== "object") {
+ b.fail("should return an object");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
- function toKey( value ) {
+ function toKey(value) {
return value.name;
}
});
diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.abs.array.float64.js b/docs/migration-guides/mathjs/benchmark/benchmark.abs.array.float64.js
index 51757b3c70af..e46ccb5f80d4 100644
--- a/docs/migration-guides/mathjs/benchmark/benchmark.abs.array.float64.js
+++ b/docs/migration-guides/mathjs/benchmark/benchmark.abs.array.float64.js
@@ -1,138 +1,152 @@
/**
-* @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';
+ * @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 resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var filledBy = require( '@stdlib/array/filled-by' );
-var zeros = require( '@stdlib/array/zeros' );
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
-var strided = require( '@stdlib/math/strided/special/abs' );
-var dabs = require( '@stdlib/math/strided/special/dabs' );
-var abs = require( '@stdlib/math/special/abs' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var filledBy = require("@stdlib/array/filled-by");
+var zeros = require("@stdlib/array/zeros");
+var uniform = require("@stdlib/random/base/uniform").factory;
+var strided = require("@stdlib/math/strided/special/abs");
+var dabs = require("@stdlib/math/strided/special/dabs");
+var abs = require("@stdlib/math/special/abs");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var mathjs = tryRequire( resolve( __dirname, '..', 'node_modules', 'mathjs' ) );
+var mathjs = tryRequire(resolve(__dirname, "..", "node_modules", "mathjs"));
var opts = {
- 'skip': ( mathjs instanceof Error )
+ skip: mathjs instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:math/strided/special/abs:value=array,dtype=float64,len=100', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
-
- x = filledBy( 100, 'float64', uniform( -100.0, 100.0 ) );
- y = zeros( x.length, 'float64' );
-
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- strided( x.length, 'float64', x, 1, 'float64', y, 1 );
- if ( isnan( y[ 0 ] ) || isnan( y[ y.length-1 ] ) ) {
- b.fail( 'should not return NaN' );
+bench(
+ pkg + "::stdlib:math/strided/special/abs:value=array,dtype=float64,len=100",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
+
+ x = filledBy(100, "float64", uniform(-100.0, 100.0));
+ y = zeros(x.length, "float64");
+
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ strided(x.length, "float64", x, 1, "float64", y, 1);
+ if (isnan(y[0]) || isnan(y[y.length - 1])) {
+ b.fail("should not return NaN");
+ }
}
- }
- b.toc();
- if ( isnan( y[ 0 ] ) || isnan( y[ y.length-1 ] ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
-
-bench( pkg+'::stdlib:math/strided/special/dabs:value=array,dtype=float64,len=100', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
-
- x = filledBy( 100, 'float64', uniform( -100.0, 100.0 ) );
- y = zeros( x.length, 'float64' );
-
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- dabs( x.length, x, 1, y, 1 );
- if ( isnan( y[ 0 ] ) || isnan( y[ y.length-1 ] ) ) {
- b.fail( 'should not return NaN' );
+ b.toc();
+ if (isnan(y[0]) || isnan(y[y.length - 1])) {
+ b.fail("should not return NaN");
}
- }
- b.toc();
- if ( isnan( y[ 0 ] ) || isnan( y[ y.length-1 ] ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
-
-bench( pkg+'::stdlib:math/special/abs:value=array,dtype=float64,len=100', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
-
- x = filledBy( 100, 'float64', uniform( -100.0, 100.0 ) );
-
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = abs( x );
- if ( isnan( y[ 0 ] ) || isnan( y[ y.length-1 ] ) ) {
- b.fail( 'should not return NaN' );
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
+
+bench(
+ pkg + "::stdlib:math/strided/special/dabs:value=array,dtype=float64,len=100",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
+
+ x = filledBy(100, "float64", uniform(-100.0, 100.0));
+ y = zeros(x.length, "float64");
+
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ dabs(x.length, x, 1, y, 1);
+ if (isnan(y[0]) || isnan(y[y.length - 1])) {
+ b.fail("should not return NaN");
+ }
}
- }
- b.toc();
- if ( isnan( y[ 0 ] ) || isnan( y[ y.length-1 ] ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.toc();
+ if (isnan(y[0]) || isnan(y[y.length - 1])) {
+ b.fail("should not return NaN");
+ }
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
+
+bench(
+ pkg + "::stdlib:math/special/abs:value=array,dtype=float64,len=100",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
+
+ x = filledBy(100, "float64", uniform(-100.0, 100.0));
+
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = abs(x);
+ if (isnan(y[0]) || isnan(y[y.length - 1])) {
+ b.fail("should not return NaN");
+ }
+ }
+ b.toc();
+ if (isnan(y[0]) || isnan(y[y.length - 1])) {
+ b.fail("should not return NaN");
+ }
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
// NOTE: Math.js does not seem to accept typed arrays for element-wise functions
opts = {
- 'skip': true
+ skip: true,
};
-bench( pkg+'::mathjs:abs:value=array,dtype=float64,len=100', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
-
- x = filledBy( 100, 'float64', uniform( -100.0, 100.0 ) );
-
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = mathjs.abs( x );
- if ( isnan( y[ 0 ] ) || isnan( y[ y.length-1 ] ) ) {
- b.fail( 'should not return NaN' );
+bench(
+ pkg + "::mathjs:abs:value=array,dtype=float64,len=100",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
+
+ x = filledBy(100, "float64", uniform(-100.0, 100.0));
+
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = mathjs.abs(x);
+ if (isnan(y[0]) || isnan(y[y.length - 1])) {
+ b.fail("should not return NaN");
+ }
+ }
+ b.toc();
+ if (isnan(y[0]) || isnan(y[y.length - 1])) {
+ b.fail("should not return NaN");
}
- }
- b.toc();
- if ( isnan( y[ 0 ] ) || isnan( y[ y.length-1 ] ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.abs.array.generic.js b/docs/migration-guides/mathjs/benchmark/benchmark.abs.array.generic.js
index 0805ac7043cc..87766f93f83c 100644
--- a/docs/migration-guides/mathjs/benchmark/benchmark.abs.array.generic.js
+++ b/docs/migration-guides/mathjs/benchmark/benchmark.abs.array.generic.js
@@ -1,110 +1,120 @@
/**
-* @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';
+ * @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 resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var filledBy = require( '@stdlib/array/filled-by' );
-var zeros = require( '@stdlib/array/zeros' );
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
-var strided = require( '@stdlib/math/strided/special/abs' );
-var abs = require( '@stdlib/math/special/abs' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var filledBy = require("@stdlib/array/filled-by");
+var zeros = require("@stdlib/array/zeros");
+var uniform = require("@stdlib/random/base/uniform").factory;
+var strided = require("@stdlib/math/strided/special/abs");
+var abs = require("@stdlib/math/special/abs");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var mathjs = tryRequire( resolve( __dirname, '..', 'node_modules', 'mathjs' ) );
+var mathjs = tryRequire(resolve(__dirname, "..", "node_modules", "mathjs"));
var opts = {
- 'skip': ( mathjs instanceof Error )
+ skip: mathjs instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:math/strided/special/abs:value=array,dtype=generic,len=100', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
-
- x = filledBy( 100, 'generic', uniform( -100.0, 100.0 ) );
- y = zeros( x.length, 'generic' );
-
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- strided( x.length, 'generic', x, 1, 'generic', y, 1 );
- if ( isnan( y[ 0 ] ) || isnan( y[ y.length-1 ] ) ) {
- b.fail( 'should not return NaN' );
+bench(
+ pkg + "::stdlib:math/strided/special/abs:value=array,dtype=generic,len=100",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
+
+ x = filledBy(100, "generic", uniform(-100.0, 100.0));
+ y = zeros(x.length, "generic");
+
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ strided(x.length, "generic", x, 1, "generic", y, 1);
+ if (isnan(y[0]) || isnan(y[y.length - 1])) {
+ b.fail("should not return NaN");
+ }
}
- }
- b.toc();
- if ( isnan( y[ 0 ] ) || isnan( y[ y.length-1 ] ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
-
-bench( pkg+'::stdlib:math/special/abs:value=array,dtype=generic,len=100', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
-
- x = filledBy( 100, 'generic', uniform( -100.0, 100.0 ) );
-
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = abs( x );
- if ( isnan( y[ 0 ] ) || isnan( y[ y.length-1 ] ) ) {
- b.fail( 'should not return NaN' );
+ b.toc();
+ if (isnan(y[0]) || isnan(y[y.length - 1])) {
+ b.fail("should not return NaN");
}
- }
- b.toc();
- if ( isnan( y[ 0 ] ) || isnan( y[ y.length-1 ] ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
-
-bench( pkg+'::mathjs:abs:value=array,dtype=generic,len=100', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
-
- x = filledBy( 100, 'generic', uniform( -100.0, 100.0 ) );
-
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = mathjs.abs( x );
- if ( isnan( y[ 0 ] ) || isnan( y[ y.length-1 ] ) ) {
- b.fail( 'should not return NaN' );
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
+
+bench(
+ pkg + "::stdlib:math/special/abs:value=array,dtype=generic,len=100",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
+
+ x = filledBy(100, "generic", uniform(-100.0, 100.0));
+
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = abs(x);
+ if (isnan(y[0]) || isnan(y[y.length - 1])) {
+ b.fail("should not return NaN");
+ }
+ }
+ b.toc();
+ if (isnan(y[0]) || isnan(y[y.length - 1])) {
+ b.fail("should not return NaN");
+ }
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
+
+bench(
+ pkg + "::mathjs:abs:value=array,dtype=generic,len=100",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
+
+ x = filledBy(100, "generic", uniform(-100.0, 100.0));
+
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = mathjs.abs(x);
+ if (isnan(y[0]) || isnan(y[y.length - 1])) {
+ b.fail("should not return NaN");
+ }
+ }
+ b.toc();
+ if (isnan(y[0]) || isnan(y[y.length - 1])) {
+ b.fail("should not return NaN");
}
- }
- b.toc();
- if ( isnan( y[ 0 ] ) || isnan( y[ y.length-1 ] ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.abs.complex_number.js b/docs/migration-guides/mathjs/benchmark/benchmark.abs.complex_number.js
index 4d7a2eac7c83..844f7a63d2e1 100644
--- a/docs/migration-guides/mathjs/benchmark/benchmark.abs.complex_number.js
+++ b/docs/migration-guides/mathjs/benchmark/benchmark.abs.complex_number.js
@@ -1,127 +1,134 @@
/**
-* @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';
+ * @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 resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var Complex128 = require( '@stdlib/complex/float64/ctor' );
-var base = require( '@stdlib/math/base/special/cabs' );
-var abs = require( '@stdlib/math/special/abs' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var Complex128 = require("@stdlib/complex/float64/ctor");
+var base = require("@stdlib/math/base/special/cabs");
+var abs = require("@stdlib/math/special/abs");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var mathjs = tryRequire( resolve( __dirname, '..', 'node_modules', 'mathjs' ) );
+var mathjs = tryRequire(resolve(__dirname, "..", "node_modules", "mathjs"));
var opts = {
- 'skip': ( mathjs instanceof Error )
+ skip: mathjs instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:math/base/special/cabs:value=complex_number', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
-
- x = [
- new Complex128( 5.0, 3.0 ),
- new Complex128( -5.0, 3.0 ),
- new Complex128( 5.0, -3.0 ),
- new Complex128( -5.0, -3.0 ),
- new Complex128( 3.0, -4.0 )
- ];
-
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = base( x[ i%x.length ] );
- if ( y !== y ) {
- b.fail( 'should not return NaN' );
+bench(
+ pkg + "::stdlib:math/base/special/cabs:value=complex_number",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
+
+ x = [
+ new Complex128(5.0, 3.0),
+ new Complex128(-5.0, 3.0),
+ new Complex128(5.0, -3.0),
+ new Complex128(-5.0, -3.0),
+ new Complex128(3.0, -4.0),
+ ];
+
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = base(x[i % x.length]);
+ if (y !== y) {
+ b.fail("should not return NaN");
+ }
}
- }
- b.toc();
- if ( isnan( y ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
-
-bench( pkg+'::stdlib:math/special/abs:value=complex_number', {
- 'skip': true
-}, function benchmark( b ) { // FIXME: update once complex supported in top-level abs
- var x;
- var y;
- var i;
-
- x = [
- new Complex128( 5.0, 3.0 ),
- new Complex128( -5.0, 3.0 ),
- new Complex128( 5.0, -3.0 ),
- new Complex128( -5.0, -3.0 ),
- new Complex128( 3.0, -4.0 )
- ];
-
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = abs( x[ i%x.length ] );
- if ( y !== y ) {
- b.fail( 'should not return NaN' );
+ b.toc();
+ if (isnan(y)) {
+ b.fail("should not return NaN");
}
- }
- b.toc();
- if ( isnan( y ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
+
+bench(
+ pkg + "::stdlib:math/special/abs:value=complex_number",
+ {
+ skip: true,
+ },
+ function benchmark(b) {
+ // FIXME: update once complex supported in top-level abs
+ var x;
+ var y;
+ var i;
+
+ x = [
+ new Complex128(5.0, 3.0),
+ new Complex128(-5.0, 3.0),
+ new Complex128(5.0, -3.0),
+ new Complex128(-5.0, -3.0),
+ new Complex128(3.0, -4.0),
+ ];
+
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = abs(x[i % x.length]);
+ if (y !== y) {
+ b.fail("should not return NaN");
+ }
+ }
+ b.toc();
+ if (isnan(y)) {
+ b.fail("should not return NaN");
+ }
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
-bench( pkg+'::mathjs:abs:value=complex_number', opts, function benchmark( b ) {
+bench(pkg + "::mathjs:abs:value=complex_number", opts, function benchmark(b) {
var x;
var y;
var i;
x = [
- mathjs.complex( 5.0, 3.0 ),
- mathjs.complex( -5.0, 3.0 ),
- mathjs.complex( 5.0, -3.0 ),
- mathjs.complex( -5.0, -3.0 ),
- mathjs.complex( 3.0, -4.0 )
+ mathjs.complex(5.0, 3.0),
+ mathjs.complex(-5.0, 3.0),
+ mathjs.complex(5.0, -3.0),
+ mathjs.complex(-5.0, -3.0),
+ mathjs.complex(3.0, -4.0),
];
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = mathjs.abs( x[ i%x.length ] );
- if ( y !== y ) {
- b.fail( 'should not return NaN' );
+ for (i = 0; i < b.iterations; i++) {
+ y = mathjs.abs(x[i % x.length]);
+ if (y !== y) {
+ b.fail("should not return NaN");
}
}
b.toc();
- if ( isnan( y ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(y)) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
});
diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.abs.matrix.2d.js b/docs/migration-guides/mathjs/benchmark/benchmark.abs.matrix.2d.js
index 3b435236fdae..0266664cb8e1 100644
--- a/docs/migration-guides/mathjs/benchmark/benchmark.abs.matrix.2d.js
+++ b/docs/migration-guides/mathjs/benchmark/benchmark.abs.matrix.2d.js
@@ -1,144 +1,161 @@
/**
-* @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';
+ * @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 resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var filled2dBy = require( '@stdlib/array/base/filled2d-by' );
-var filledndBy = require( '@stdlib/array/base/fillednd-by' );
-var unary2d = require( '@stdlib/array/base/unary2d' );
-var unarynd = require( '@stdlib/array/base/unarynd' );
-var zeros2d = require( '@stdlib/array/base/zeros2d' );
-var zerosnd = require( '@stdlib/array/base/zerosnd' );
-var array = require( '@stdlib/ndarray/array' );
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
-var base = require( '@stdlib/math/base/special/abs' );
-var abs = require( '@stdlib/math/special/abs' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var filled2dBy = require("@stdlib/array/base/filled2d-by");
+var filledndBy = require("@stdlib/array/base/fillednd-by");
+var unary2d = require("@stdlib/array/base/unary2d");
+var unarynd = require("@stdlib/array/base/unarynd");
+var zeros2d = require("@stdlib/array/base/zeros2d");
+var zerosnd = require("@stdlib/array/base/zerosnd");
+var array = require("@stdlib/ndarray/array");
+var uniform = require("@stdlib/random/base/uniform").factory;
+var base = require("@stdlib/math/base/special/abs");
+var abs = require("@stdlib/math/special/abs");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var mathjs = tryRequire( resolve( __dirname, '..', 'node_modules', 'mathjs' ) );
+var mathjs = tryRequire(resolve(__dirname, "..", "node_modules", "mathjs"));
var opts = {
- 'skip': ( mathjs instanceof Error )
+ skip: mathjs instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:math/special/abs:value=ndarray,dtype=generic,size=100,shape=(10,10)', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
-
- x = array( filled2dBy( [ 10, 10 ], uniform( -100.0, 100.0 ) ), {
- 'dtype': 'generic'
- });
-
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = abs( x );
- if ( typeof y !== 'object' ) {
- b.fail( 'should return an object' );
+bench(
+ pkg +
+ "::stdlib:math/special/abs:value=ndarray,dtype=generic,size=100,shape=(10,10)",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
+
+ x = array(filled2dBy([10, 10], uniform(-100.0, 100.0)), {
+ dtype: "generic",
+ });
+
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = abs(x);
+ if (typeof y !== "object") {
+ b.fail("should return an object");
+ }
+ }
+ b.toc();
+ if (isnan(y.get(0, 0)) || isnan(y.get(9, 9))) {
+ b.fail("should not return NaN");
+ }
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
+
+bench(
+ pkg +
+ "::stdlib:array/base/unary2d:value=nested_array,dtype=generic,size=100,shape=(10,10)",
+ opts,
+ function benchmark(b) {
+ var sh;
+ var x;
+ var y;
+ var i;
+
+ sh = [10, 10];
+ x = filled2dBy(sh, uniform(-100.0, 100.0));
+
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = zeros2d(sh);
+ unary2d([x, y], sh, base);
+ if (isnan(y[0][0]) || isnan(y[9][9])) {
+ b.fail("should not return NaN");
+ }
+ }
+ b.toc();
+ if (isnan(y[1][1]) || isnan(y[8][8])) {
+ b.fail("should not return NaN");
+ }
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
+
+bench(
+ pkg +
+ "::stdlib:array/base/unarynd:value=nested_array,dtype=generic,size=100,shape=(10,10)",
+ opts,
+ function benchmark(b) {
+ var sh;
+ var x;
+ var y;
+ var i;
+
+ sh = [10, 10];
+ x = filledndBy(sh, uniform(-100.0, 100.0));
+
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = zerosnd(sh);
+ unarynd([x, y], sh, base);
+ if (isnan(y[0][0]) || isnan(y[9][9])) {
+ b.fail("should not return NaN");
+ }
}
- }
- b.toc();
- if ( isnan( y.get( 0, 0 ) ) || isnan( y.get( 9, 9 ) ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
-
-bench( pkg+'::stdlib:array/base/unary2d:value=nested_array,dtype=generic,size=100,shape=(10,10)', opts, function benchmark( b ) {
- var sh;
- var x;
- var y;
- var i;
-
- sh = [ 10, 10 ];
- x = filled2dBy( sh, uniform( -100.0, 100.0 ) );
-
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = zeros2d( sh );
- unary2d( [ x, y ], sh, base );
- if ( isnan( y[ 0 ][ 0 ] ) || isnan( y[ 9 ][ 9 ] ) ) {
- b.fail( 'should not return NaN' );
+ b.toc();
+ if (isnan(y[1][1]) || isnan(y[8][8])) {
+ b.fail("should not return NaN");
}
- }
- b.toc();
- if ( isnan( y[ 1 ][ 1 ] ) || isnan( y[ 8 ][ 8 ] ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
-
-bench( pkg+'::stdlib:array/base/unarynd:value=nested_array,dtype=generic,size=100,shape=(10,10)', opts, function benchmark( b ) {
- var sh;
- var x;
- var y;
- var i;
-
- sh = [ 10, 10 ];
- x = filledndBy( sh, uniform( -100.0, 100.0 ) );
-
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = zerosnd( sh );
- unarynd( [ x, y ], sh, base );
- if ( isnan( y[ 0 ][ 0 ] ) || isnan( y[ 9 ][ 9 ] ) ) {
- b.fail( 'should not return NaN' );
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
+
+bench(
+ pkg + "::mathjs:abs:value=matrix,dtype=generic,size=100,shape=(10,10)",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
+
+ x = mathjs.matrix(filled2dBy([10, 10], uniform(-100.0, 100.0)));
+
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = mathjs.abs(x);
+ if (typeof y !== "object") {
+ b.fail("should return an object");
+ }
}
- }
- b.toc();
- if ( isnan( y[ 1 ][ 1 ] ) || isnan( y[ 8 ][ 8 ] ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
-
-bench( pkg+'::mathjs:abs:value=matrix,dtype=generic,size=100,shape=(10,10)', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
-
- x = mathjs.matrix( filled2dBy( [ 10, 10 ], uniform( -100.0, 100.0 ) ) );
-
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = mathjs.abs( x );
- if ( typeof y !== 'object' ) {
- b.fail( 'should return an object' );
+ b.toc();
+ if (isnan(y.get([0, 0])) || isnan(y.get([9, 9]))) {
+ b.fail("should not return NaN");
}
- }
- b.toc();
- if ( isnan( y.get( [ 0, 0 ] ) ) || isnan( y.get( [ 9, 9 ] ) ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.abs.matrix.2d.size.js b/docs/migration-guides/mathjs/benchmark/benchmark.abs.matrix.2d.size.js
index 5f81d83ec024..d8eacbee198b 100644
--- a/docs/migration-guides/mathjs/benchmark/benchmark.abs.matrix.2d.size.js
+++ b/docs/migration-guides/mathjs/benchmark/benchmark.abs.matrix.2d.size.js
@@ -1,220 +1,217 @@
/**
-* @license Apache-2.0
-*
-* Copyright (c) 2024 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.
-*/
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2024 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.
+ */
/* eslint-disable max-len */
-'use strict';
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var pow = require( '@stdlib/math/base/special/pow' );
-var floor = require( '@stdlib/math/base/special/floor' );
-var numel = require( '@stdlib/ndarray/base/numel' );
-var filled2dBy = require( '@stdlib/array/base/filled2d-by' );
-var filledndBy = require( '@stdlib/array/base/fillednd-by' );
-var unary2d = require( '@stdlib/array/base/unary2d' );
-var unarynd = require( '@stdlib/array/base/unarynd' );
-var zeros2d = require( '@stdlib/array/base/zeros2d' );
-var zerosnd = require( '@stdlib/array/base/zerosnd' );
-var array = require( '@stdlib/ndarray/array' );
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
-var base = require( '@stdlib/math/base/special/abs' );
-var abs = require( '@stdlib/math/special/abs' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var format = require( '@stdlib/string/format' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var pow = require("@stdlib/math/base/special/pow");
+var floor = require("@stdlib/math/base/special/floor");
+var numel = require("@stdlib/ndarray/base/numel");
+var filled2dBy = require("@stdlib/array/base/filled2d-by");
+var filledndBy = require("@stdlib/array/base/fillednd-by");
+var unary2d = require("@stdlib/array/base/unary2d");
+var unarynd = require("@stdlib/array/base/unarynd");
+var zeros2d = require("@stdlib/array/base/zeros2d");
+var zerosnd = require("@stdlib/array/base/zerosnd");
+var array = require("@stdlib/ndarray/array");
+var uniform = require("@stdlib/random/base/uniform").factory;
+var base = require("@stdlib/math/base/special/abs");
+var abs = require("@stdlib/math/special/abs");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var format = require("@stdlib/string/format");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var mathjs = tryRequire( resolve( __dirname, '..', 'node_modules', 'mathjs' ) );
+var mathjs = tryRequire(resolve(__dirname, "..", "node_modules", "mathjs"));
var opts = {
- 'skip': ( mathjs instanceof Error )
+ skip: mathjs instanceof Error,
};
var OPTS = {
- 'dtype': 'generic'
+ dtype: "generic",
};
-var rand = uniform( -100.0, 100.0 );
-
+var rand = uniform(-100.0, 100.0);
// FUNCTIONS //
/**
-* Creates a benchmark function.
-*
-* @private
-* @param {PositiveIntegerArray} shape - array shape
-* @returns {Function} benchmark function
-*/
-function createBenchmark1( shape ) {
- var x = array( filled2dBy( shape, rand ), OPTS );
+ * Creates a benchmark function.
+ *
+ * @private
+ * @param {PositiveIntegerArray} shape - array shape
+ * @returns {Function} benchmark function
+ */
+function createBenchmark1(shape) {
+ var x = array(filled2dBy(shape, rand), OPTS);
return benchmark;
/**
- * Benchmark function.
- *
- * @private
- * @param {Benchmark} b - benchmark instance
- */
- function benchmark( b ) {
+ * Benchmark function.
+ *
+ * @private
+ * @param {Benchmark} b - benchmark instance
+ */
+ function benchmark(b) {
var y;
var i;
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = abs( x );
- if ( typeof y !== 'object' ) {
- b.fail( 'should return an object' );
+ for (i = 0; i < b.iterations; i++) {
+ y = abs(x);
+ if (typeof y !== "object") {
+ b.fail("should return an object");
}
}
b.toc();
- if ( isnan( y.get( 0, 0 ) ) || isnan( y.get( shape[0]-1, shape[1]-1 ) ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(y.get(0, 0)) || isnan(y.get(shape[0] - 1, shape[1] - 1))) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
}
}
/**
-* Creates a benchmark function.
-*
-* @private
-* @param {PositiveIntegerArray} shape - array shape
-* @returns {Function} benchmark function
-*/
-function createBenchmark2( shape ) {
- var x = filled2dBy( shape, rand );
+ * Creates a benchmark function.
+ *
+ * @private
+ * @param {PositiveIntegerArray} shape - array shape
+ * @returns {Function} benchmark function
+ */
+function createBenchmark2(shape) {
+ var x = filled2dBy(shape, rand);
return benchmark;
/**
- * Benchmark function.
- *
- * @private
- * @param {Benchmark} b - benchmark instance
- */
- function benchmark( b ) {
+ * Benchmark function.
+ *
+ * @private
+ * @param {Benchmark} b - benchmark instance
+ */
+ function benchmark(b) {
var y;
var i;
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = zeros2d( shape );
- unary2d( [ x, y ], shape, base );
- if ( typeof y !== 'object' ) {
- b.fail( 'should return an object' );
+ for (i = 0; i < b.iterations; i++) {
+ y = zeros2d(shape);
+ unary2d([x, y], shape, base);
+ if (typeof y !== "object") {
+ b.fail("should return an object");
}
}
b.toc();
- if ( isnan( y[ 0 ][ 0 ] ) || isnan( y[ shape[0]-1 ][ shape[1]-1 ] ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(y[0][0]) || isnan(y[shape[0] - 1][shape[1] - 1])) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
}
}
/**
-* Creates a benchmark function.
-*
-* @private
-* @param {PositiveIntegerArray} shape - array shape
-* @returns {Function} benchmark function
-*/
-function createBenchmark3( shape ) {
- var x = filledndBy( shape, rand );
+ * Creates a benchmark function.
+ *
+ * @private
+ * @param {PositiveIntegerArray} shape - array shape
+ * @returns {Function} benchmark function
+ */
+function createBenchmark3(shape) {
+ var x = filledndBy(shape, rand);
return benchmark;
/**
- * Benchmark function.
- *
- * @private
- * @param {Benchmark} b - benchmark instance
- */
- function benchmark( b ) {
+ * Benchmark function.
+ *
+ * @private
+ * @param {Benchmark} b - benchmark instance
+ */
+ function benchmark(b) {
var y;
var i;
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = zerosnd( shape );
- unarynd( [ x, y ], shape, base );
- if ( typeof y !== 'object' ) {
- b.fail( 'should return an object' );
+ for (i = 0; i < b.iterations; i++) {
+ y = zerosnd(shape);
+ unarynd([x, y], shape, base);
+ if (typeof y !== "object") {
+ b.fail("should return an object");
}
}
b.toc();
- if ( isnan( y[ 0 ][ 0 ] ) || isnan( y[ shape[0]-1 ][ shape[1]-1 ] ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(y[0][0]) || isnan(y[shape[0] - 1][shape[1] - 1])) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
}
}
/**
-* Creates a benchmark function.
-*
-* @private
-* @param {PositiveIntegerArray} shape - input array shape
-* @returns {Function} benchmark function
-*/
-function createBenchmark4( shape ) {
- var x = mathjs.matrix( filled2dBy( shape, rand ) );
+ * Creates a benchmark function.
+ *
+ * @private
+ * @param {PositiveIntegerArray} shape - input array shape
+ * @returns {Function} benchmark function
+ */
+function createBenchmark4(shape) {
+ var x = mathjs.matrix(filled2dBy(shape, rand));
return benchmark;
/**
- * Benchmark function.
- *
- * @private
- * @param {Benchmark} b - benchmark instance
- */
- function benchmark( b ) {
+ * Benchmark function.
+ *
+ * @private
+ * @param {Benchmark} b - benchmark instance
+ */
+ function benchmark(b) {
var y;
var i;
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = mathjs.abs( x );
- if ( typeof y !== 'object' ) {
- b.fail( 'should return an object' );
+ for (i = 0; i < b.iterations; i++) {
+ y = mathjs.abs(x);
+ if (typeof y !== "object") {
+ b.fail("should return an object");
}
}
b.toc();
- if ( isnan( y.get( [ 0, 0 ] ) ) || isnan( y.get( [ shape[0]-1, shape[1]-1 ] ) ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(y.get([0, 0])) || isnan(y.get([shape[0] - 1, shape[1] - 1]))) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
}
}
-
// MAIN //
/**
-* Main execution sequence.
-*
-* @private
-*/
+ * Main execution sequence.
+ *
+ * @private
+ */
function main() {
var shape;
var min;
@@ -226,21 +223,58 @@ function main() {
min = 1; // 10^min
max = 6; // 10^max
- for ( i = min; i <= max; i++ ) {
- N = floor( pow( pow( 10, i ), 1.0/2.0 ) );
- shape = [ N, N ];
+ for (i = min; i <= max; i++) {
+ N = floor(pow(pow(10, i), 1.0 / 2.0));
+ shape = [N, N];
- f = createBenchmark1( shape );
- bench( format( '%s::stdlib:math/special/abs:dtype=%s,size=%d,shape=(%s)', pkg, OPTS.dtype, numel( shape ), shape.join( ',' ) ), f );
+ f = createBenchmark1(shape);
+ bench(
+ format(
+ "%s::stdlib:math/special/abs:dtype=%s,size=%d,shape=(%s)",
+ pkg,
+ OPTS.dtype,
+ numel(shape),
+ shape.join(","),
+ ),
+ f,
+ );
- f = createBenchmark2( shape );
- bench( format( '%s::stdlib:array/base/unary2d:dtype=%s,size=%d,shape=(%s)', pkg, OPTS.dtype, numel( shape ), shape.join( ',' ) ), f );
+ f = createBenchmark2(shape);
+ bench(
+ format(
+ "%s::stdlib:array/base/unary2d:dtype=%s,size=%d,shape=(%s)",
+ pkg,
+ OPTS.dtype,
+ numel(shape),
+ shape.join(","),
+ ),
+ f,
+ );
- f = createBenchmark3( shape );
- bench( format( '%s::stdlib:array/base/unarynd:dtype=%s,size=%d,shape=(%s)', pkg, OPTS.dtype, numel( shape ), shape.join( ',' ) ), f );
+ f = createBenchmark3(shape);
+ bench(
+ format(
+ "%s::stdlib:array/base/unarynd:dtype=%s,size=%d,shape=(%s)",
+ pkg,
+ OPTS.dtype,
+ numel(shape),
+ shape.join(","),
+ ),
+ f,
+ );
- f = createBenchmark4( shape );
- bench( format( '%s::mathjs:abs:dtype=%s,size=%d,shape=(%s)', pkg, OPTS.dtype, numel( shape ), shape.join( ',' ) ), opts, f );
+ f = createBenchmark4(shape);
+ bench(
+ format(
+ "%s::mathjs:abs:dtype=%s,size=%d,shape=(%s)",
+ pkg,
+ OPTS.dtype,
+ numel(shape),
+ shape.join(","),
+ ),
+ opts,
+ f,
+ );
}
}
diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.abs.matrix.3d.js b/docs/migration-guides/mathjs/benchmark/benchmark.abs.matrix.3d.js
index 6d80dd4f1d2d..0e2211cc5ac8 100644
--- a/docs/migration-guides/mathjs/benchmark/benchmark.abs.matrix.3d.js
+++ b/docs/migration-guides/mathjs/benchmark/benchmark.abs.matrix.3d.js
@@ -1,144 +1,161 @@
/**
-* @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';
+ * @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 resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var filled3dBy = require( '@stdlib/array/base/filled3d-by' );
-var filledndBy = require( '@stdlib/array/base/fillednd-by' );
-var unary3d = require( '@stdlib/array/base/unary3d' );
-var unarynd = require( '@stdlib/array/base/unarynd' );
-var zeros3d = require( '@stdlib/array/base/zeros3d' );
-var zerosnd = require( '@stdlib/array/base/zerosnd' );
-var array = require( '@stdlib/ndarray/array' );
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
-var base = require( '@stdlib/math/base/special/abs' );
-var abs = require( '@stdlib/math/special/abs' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var filled3dBy = require("@stdlib/array/base/filled3d-by");
+var filledndBy = require("@stdlib/array/base/fillednd-by");
+var unary3d = require("@stdlib/array/base/unary3d");
+var unarynd = require("@stdlib/array/base/unarynd");
+var zeros3d = require("@stdlib/array/base/zeros3d");
+var zerosnd = require("@stdlib/array/base/zerosnd");
+var array = require("@stdlib/ndarray/array");
+var uniform = require("@stdlib/random/base/uniform").factory;
+var base = require("@stdlib/math/base/special/abs");
+var abs = require("@stdlib/math/special/abs");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var mathjs = tryRequire( resolve( __dirname, '..', 'node_modules', 'mathjs' ) );
+var mathjs = tryRequire(resolve(__dirname, "..", "node_modules", "mathjs"));
var opts = {
- 'skip': ( mathjs instanceof Error )
+ skip: mathjs instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:math/special/abs:value=ndarray,dtype=generic,size=100,shape=(4,5,5)', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
-
- x = array( filled3dBy( [ 4, 5, 5 ], uniform( -100.0, 100.0 ) ), {
- 'dtype': 'generic'
- });
-
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = abs( x );
- if ( typeof y !== 'object' ) {
- b.fail( 'should return an object' );
+bench(
+ pkg +
+ "::stdlib:math/special/abs:value=ndarray,dtype=generic,size=100,shape=(4,5,5)",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
+
+ x = array(filled3dBy([4, 5, 5], uniform(-100.0, 100.0)), {
+ dtype: "generic",
+ });
+
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = abs(x);
+ if (typeof y !== "object") {
+ b.fail("should return an object");
+ }
+ }
+ b.toc();
+ if (isnan(y.get(0, 0, 0)) || isnan(y.get(3, 4, 4))) {
+ b.fail("should not return NaN");
+ }
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
+
+bench(
+ pkg +
+ "::stdlib:array/base/unary3d:value=nested_array,dtype=generic,size=100,shape=(4,5,5)",
+ opts,
+ function benchmark(b) {
+ var sh;
+ var x;
+ var y;
+ var i;
+
+ sh = [4, 5, 5];
+ x = filled3dBy(sh, uniform(-100.0, 100.0));
+
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = zeros3d(sh);
+ unary3d([x, y], sh, base);
+ if (isnan(y[0][0][0]) || isnan(y[3][4][4])) {
+ b.fail("should not return NaN");
+ }
+ }
+ b.toc();
+ if (isnan(y[1][1][1]) || isnan(y[2][3][3])) {
+ b.fail("should not return NaN");
+ }
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
+
+bench(
+ pkg +
+ "::stdlib:array/base/unarynd:value=nested_array,dtype=generic,size=100,shape=(4,5,5)",
+ opts,
+ function benchmark(b) {
+ var sh;
+ var x;
+ var y;
+ var i;
+
+ sh = [4, 5, 5];
+ x = filledndBy(sh, uniform(-100.0, 100.0));
+
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = zerosnd(sh);
+ unarynd([x, y], sh, base);
+ if (isnan(y[0][0][0]) || isnan(y[3][4][4])) {
+ b.fail("should not return NaN");
+ }
}
- }
- b.toc();
- if ( isnan( y.get( 0, 0, 0 ) ) || isnan( y.get( 3, 4, 4 ) ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
-
-bench( pkg+'::stdlib:array/base/unary3d:value=nested_array,dtype=generic,size=100,shape=(4,5,5)', opts, function benchmark( b ) {
- var sh;
- var x;
- var y;
- var i;
-
- sh = [ 4, 5, 5 ];
- x = filled3dBy( sh, uniform( -100.0, 100.0 ) );
-
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = zeros3d( sh );
- unary3d( [ x, y ], sh, base );
- if ( isnan( y[ 0 ][ 0 ][ 0 ] ) || isnan( y[ 3 ][ 4 ][ 4 ] ) ) {
- b.fail( 'should not return NaN' );
+ b.toc();
+ if (isnan(y[1][1][1]) || isnan(y[2][3][3])) {
+ b.fail("should not return NaN");
}
- }
- b.toc();
- if ( isnan( y[ 1 ][ 1 ][ 1 ] ) || isnan( y[ 2 ][ 3 ][ 3 ] ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
-
-bench( pkg+'::stdlib:array/base/unarynd:value=nested_array,dtype=generic,size=100,shape=(4,5,5)', opts, function benchmark( b ) {
- var sh;
- var x;
- var y;
- var i;
-
- sh = [ 4, 5, 5 ];
- x = filledndBy( sh, uniform( -100.0, 100.0 ) );
-
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = zerosnd( sh );
- unarynd( [ x, y ], sh, base );
- if ( isnan( y[ 0 ][ 0 ][ 0 ] ) || isnan( y[ 3 ][ 4 ][ 4 ] ) ) {
- b.fail( 'should not return NaN' );
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
+
+bench(
+ pkg + "::mathjs:abs:value=matrix,dtype=generic,size=100,shape=(4,5,5)",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
+
+ x = mathjs.matrix(filled3dBy([4, 5, 5], uniform(-100.0, 100.0)));
+
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = mathjs.abs(x);
+ if (typeof y !== "object") {
+ b.fail("should return an object");
+ }
}
- }
- b.toc();
- if ( isnan( y[ 1 ][ 1 ][ 1 ] ) || isnan( y[ 2 ][ 3 ][ 3 ] ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
-
-bench( pkg+'::mathjs:abs:value=matrix,dtype=generic,size=100,shape=(4,5,5)', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
-
- x = mathjs.matrix( filled3dBy( [ 4, 5, 5 ], uniform( -100.0, 100.0 ) ) );
-
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = mathjs.abs( x );
- if ( typeof y !== 'object' ) {
- b.fail( 'should return an object' );
+ b.toc();
+ if (isnan(y.get([0, 0, 0])) || isnan(y.get([3, 4, 4]))) {
+ b.fail("should not return NaN");
}
- }
- b.toc();
- if ( isnan( y.get( [ 0, 0, 0 ] ) ) || isnan( y.get( [ 3, 4, 4 ] ) ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.abs.matrix.4d.js b/docs/migration-guides/mathjs/benchmark/benchmark.abs.matrix.4d.js
index 8460a56c98ad..a111a38aea03 100644
--- a/docs/migration-guides/mathjs/benchmark/benchmark.abs.matrix.4d.js
+++ b/docs/migration-guides/mathjs/benchmark/benchmark.abs.matrix.4d.js
@@ -1,144 +1,164 @@
/**
-* @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';
+ * @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 resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var filled4dBy = require( '@stdlib/array/base/filled4d-by' );
-var filledndBy = require( '@stdlib/array/base/fillednd-by' );
-var unary4d = require( '@stdlib/array/base/unary4d' );
-var unarynd = require( '@stdlib/array/base/unarynd' );
-var zeros4d = require( '@stdlib/array/base/zeros4d' );
-var zerosnd = require( '@stdlib/array/base/zerosnd' );
-var array = require( '@stdlib/ndarray/array' );
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
-var base = require( '@stdlib/math/base/special/abs' );
-var abs = require( '@stdlib/math/special/abs' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var filled4dBy = require("@stdlib/array/base/filled4d-by");
+var filledndBy = require("@stdlib/array/base/fillednd-by");
+var unary4d = require("@stdlib/array/base/unary4d");
+var unarynd = require("@stdlib/array/base/unarynd");
+var zeros4d = require("@stdlib/array/base/zeros4d");
+var zerosnd = require("@stdlib/array/base/zerosnd");
+var array = require("@stdlib/ndarray/array");
+var uniform = require("@stdlib/random/base/uniform").factory;
+var base = require("@stdlib/math/base/special/abs");
+var abs = require("@stdlib/math/special/abs");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var mathjs = tryRequire( resolve( __dirname, '..', 'node_modules', 'mathjs' ) );
+var mathjs = tryRequire(resolve(__dirname, "..", "node_modules", "mathjs"));
var opts = {
- 'skip': ( mathjs instanceof Error )
+ skip: mathjs instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:math/special/abs:value=ndarray,dtype=generic,size=100,shape=(2,5,2,5)', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
-
- x = array( filled4dBy( [ 2, 5, 2, 5 ], uniform( -100.0, 100.0 ) ), {
- 'dtype': 'generic'
- });
-
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = abs( x );
- if ( typeof y !== 'object' ) {
- b.fail( 'should return an object' );
+bench(
+ pkg +
+ "::stdlib:math/special/abs:value=ndarray,dtype=generic,size=100,shape=(2,5,2,5)",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
+
+ x = array(filled4dBy([2, 5, 2, 5], uniform(-100.0, 100.0)), {
+ dtype: "generic",
+ });
+
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = abs(x);
+ if (typeof y !== "object") {
+ b.fail("should return an object");
+ }
+ }
+ b.toc();
+ if (isnan(y.get(0, 0, 0, 0)) || isnan(y.get(1, 4, 1, 4))) {
+ b.fail("should not return NaN");
+ }
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
+
+bench(
+ pkg +
+ "::stdlib:array/base/unary4d:value=nested_array,dtype=generic,size=100,shape=(2,5,2,5)",
+ opts,
+ function benchmark(b) {
+ var sh;
+ var x;
+ var y;
+ var i;
+
+ sh = [2, 5, 2, 5];
+ x = filled4dBy(sh, uniform(-100.0, 100.0));
+
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = zeros4d(sh);
+ unary4d([x, y], sh, base);
+ if (isnan(y[0][0][0][0]) || isnan(y[1][4][1][4])) {
+ // eslint-disable-line max-len
+ b.fail("should not return NaN");
+ }
+ }
+ b.toc();
+ if (isnan(y[1][1][1][1]) || isnan(y[0][3][0][3])) {
+ b.fail("should not return NaN");
+ }
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
+
+bench(
+ pkg +
+ "::stdlib:array/base/unarynd:value=nested_array,dtype=generic,size=100,shape=(2,5,2,5)",
+ opts,
+ function benchmark(b) {
+ var sh;
+ var x;
+ var y;
+ var i;
+
+ sh = [2, 5, 2, 5];
+ x = filledndBy(sh, uniform(-100.0, 100.0));
+
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = zerosnd(sh);
+ unarynd([x, y], sh, base);
+ if (isnan(y[0][0][0][0]) || isnan(y[1][4][1][4])) {
+ // eslint-disable-line max-len
+ b.fail("should not return NaN");
+ }
}
- }
- b.toc();
- if ( isnan( y.get( 0, 0, 0, 0 ) ) || isnan( y.get( 1, 4, 1, 4 ) ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
-
-bench( pkg+'::stdlib:array/base/unary4d:value=nested_array,dtype=generic,size=100,shape=(2,5,2,5)', opts, function benchmark( b ) {
- var sh;
- var x;
- var y;
- var i;
-
- sh = [ 2, 5, 2, 5 ];
- x = filled4dBy( sh, uniform( -100.0, 100.0 ) );
-
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = zeros4d( sh );
- unary4d( [ x, y ], sh, base );
- if ( isnan( y[ 0 ][ 0 ][ 0 ][ 0 ] ) || isnan( y[ 1 ][ 4 ][ 1 ][ 4 ] ) ) { // eslint-disable-line max-len
- b.fail( 'should not return NaN' );
+ b.toc();
+ if (isnan(y[1][1][1][1]) || isnan(y[0][3][0][3])) {
+ b.fail("should not return NaN");
}
- }
- b.toc();
- if ( isnan( y[ 1 ][ 1 ][ 1 ][ 1 ] ) || isnan( y[ 0 ][ 3 ][ 0 ][ 3 ] ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
-
-bench( pkg+'::stdlib:array/base/unarynd:value=nested_array,dtype=generic,size=100,shape=(2,5,2,5)', opts, function benchmark( b ) {
- var sh;
- var x;
- var y;
- var i;
-
- sh = [ 2, 5, 2, 5 ];
- x = filledndBy( sh, uniform( -100.0, 100.0 ) );
-
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = zerosnd( sh );
- unarynd( [ x, y ], sh, base );
- if ( isnan( y[ 0 ][ 0 ][ 0 ][ 0 ] ) || isnan( y[ 1 ][ 4 ][ 1 ][ 4 ] ) ) { // eslint-disable-line max-len
- b.fail( 'should not return NaN' );
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
+
+bench(
+ pkg + "::mathjs:abs:value=matrix,dtype=generic,size=100,shape=(2,5,2,5)",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
+
+ x = mathjs.matrix(filled4dBy([2, 5, 2, 5], uniform(-100.0, 100.0)));
+
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = mathjs.abs(x);
+ if (typeof y !== "object") {
+ b.fail("should return an object");
+ }
}
- }
- b.toc();
- if ( isnan( y[ 1 ][ 1 ][ 1 ][ 1 ] ) || isnan( y[ 0 ][ 3 ][ 0 ][ 3 ] ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
-
-bench( pkg+'::mathjs:abs:value=matrix,dtype=generic,size=100,shape=(2,5,2,5)', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
-
- x = mathjs.matrix( filled4dBy( [ 2, 5, 2, 5 ], uniform( -100.0, 100.0 ) ) );
-
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = mathjs.abs( x );
- if ( typeof y !== 'object' ) {
- b.fail( 'should return an object' );
+ b.toc();
+ if (isnan(y.get([0, 0, 0, 0])) || isnan(y.get([1, 4, 1, 4]))) {
+ // eslint-disable-line max-len
+ b.fail("should not return NaN");
}
- }
- b.toc();
- if ( isnan( y.get( [ 0, 0, 0, 0 ] ) ) || isnan( y.get( [ 1, 4, 1, 4 ] ) ) ) { // eslint-disable-line max-len
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.abs.number.js b/docs/migration-guides/mathjs/benchmark/benchmark.abs.number.js
index f30a883e1ab7..a92f17e5350f 100644
--- a/docs/migration-guides/mathjs/benchmark/benchmark.abs.number.js
+++ b/docs/migration-guides/mathjs/benchmark/benchmark.abs.number.js
@@ -1,108 +1,114 @@
/**
-* @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';
+ * @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 resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var filledBy = require( '@stdlib/array/filled-by' );
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
-var base = require( '@stdlib/math/base/special/abs' );
-var abs = require( '@stdlib/math/special/abs' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var filledBy = require("@stdlib/array/filled-by");
+var uniform = require("@stdlib/random/base/uniform").factory;
+var base = require("@stdlib/math/base/special/abs");
+var abs = require("@stdlib/math/special/abs");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var mathjs = tryRequire( resolve( __dirname, '..', 'node_modules', 'mathjs' ) );
+var mathjs = tryRequire(resolve(__dirname, "..", "node_modules", "mathjs"));
var opts = {
- 'skip': ( mathjs instanceof Error )
+ skip: mathjs instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:math/base/special/abs:value=number', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
-
- x = filledBy( 100, uniform( -100.0, 100.0 ) );
-
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = base( x[ i%x.length ] );
- if ( y !== y ) {
- b.fail( 'should not return NaN' );
+bench(
+ pkg + "::stdlib:math/base/special/abs:value=number",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
+
+ x = filledBy(100, uniform(-100.0, 100.0));
+
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = base(x[i % x.length]);
+ if (y !== y) {
+ b.fail("should not return NaN");
+ }
}
- }
- b.toc();
- if ( isnan( y ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
-
-bench( pkg+'::stdlib:math/special/abs:value=number', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
-
- x = filledBy( 100, uniform( -100.0, 100.0 ) );
-
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = abs( x[ i%x.length ] );
- if ( y !== y ) {
- b.fail( 'should not return NaN' );
+ b.toc();
+ if (isnan(y)) {
+ b.fail("should not return NaN");
}
- }
- b.toc();
- if ( isnan( y ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
+
+bench(
+ pkg + "::stdlib:math/special/abs:value=number",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
+
+ x = filledBy(100, uniform(-100.0, 100.0));
+
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = abs(x[i % x.length]);
+ if (y !== y) {
+ b.fail("should not return NaN");
+ }
+ }
+ b.toc();
+ if (isnan(y)) {
+ b.fail("should not return NaN");
+ }
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
-bench( pkg+'::mathjs:abs:value=number', opts, function benchmark( b ) {
+bench(pkg + "::mathjs:abs:value=number", opts, function benchmark(b) {
var x;
var y;
var i;
- x = filledBy( 100, uniform( -100.0, 100.0 ) );
+ x = filledBy(100, uniform(-100.0, 100.0));
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = mathjs.abs( x[ i%x.length ] );
- if ( y !== y ) {
- b.fail( 'should not return NaN' );
+ for (i = 0; i < b.iterations; i++) {
+ y = mathjs.abs(x[i % x.length]);
+ if (y !== y) {
+ b.fail("should not return NaN");
}
}
b.toc();
- if ( isnan( y ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(y)) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
});
diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.add.array.generic.js b/docs/migration-guides/mathjs/benchmark/benchmark.add.array.generic.js
index 95da14d7732e..35405821e1b6 100644
--- a/docs/migration-guides/mathjs/benchmark/benchmark.add.array.generic.js
+++ b/docs/migration-guides/mathjs/benchmark/benchmark.add.array.generic.js
@@ -1,93 +1,99 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var filledBy = require( '@stdlib/array/filled-by' );
-var zeros = require( '@stdlib/array/zeros' );
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
-var strided = require( '@stdlib/math/strided/ops/add' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var filledBy = require("@stdlib/array/filled-by");
+var zeros = require("@stdlib/array/zeros");
+var uniform = require("@stdlib/random/base/uniform").factory;
+var strided = require("@stdlib/math/strided/ops/add");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var mathjs = tryRequire( resolve( __dirname, '..', 'node_modules', 'mathjs' ) );
+var mathjs = tryRequire(resolve(__dirname, "..", "node_modules", "mathjs"));
var opts = {
- 'skip': ( mathjs instanceof Error )
+ skip: mathjs instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:math/strided/ops/add:value=array,dtype=generic,len=100', opts, function benchmark( b ) {
- var x;
- var y;
- var z;
- var i;
+bench(
+ pkg + "::stdlib:math/strided/ops/add:value=array,dtype=generic,len=100",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var z;
+ var i;
- x = filledBy( 100, 'generic', uniform( -100.0, 100.0 ) );
- y = filledBy( 100, 'generic', uniform( -100.0, 100.0 ) );
- z = zeros( x.length, 'generic' );
+ x = filledBy(100, "generic", uniform(-100.0, 100.0));
+ y = filledBy(100, "generic", uniform(-100.0, 100.0));
+ z = zeros(x.length, "generic");
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- strided( x.length, 'generic', x, 1, 'generic', y, 1, 'generic', z, 1 );
- if ( isnan( z[ 0 ] ) || isnan( z[ z.length-1 ] ) ) {
- b.fail( 'should not return NaN' );
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ strided(x.length, "generic", x, 1, "generic", y, 1, "generic", z, 1);
+ if (isnan(z[0]) || isnan(z[z.length - 1])) {
+ b.fail("should not return NaN");
+ }
}
- }
- b.toc();
- if ( isnan( z[ 0 ] ) || isnan( z[ z.length-1 ] ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.toc();
+ if (isnan(z[0]) || isnan(z[z.length - 1])) {
+ b.fail("should not return NaN");
+ }
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
// TODO: add math/ops/add benchmarks
-bench( pkg+'::mathjs:add:value=array,dtype=generic,len=100', opts, function benchmark( b ) {
- var x;
- var y;
- var z;
- var i;
+bench(
+ pkg + "::mathjs:add:value=array,dtype=generic,len=100",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var z;
+ var i;
- x = filledBy( 100, 'generic', uniform( -100.0, 100.0 ) );
- y = filledBy( 100, 'generic', uniform( -100.0, 100.0 ) );
+ x = filledBy(100, "generic", uniform(-100.0, 100.0));
+ y = filledBy(100, "generic", uniform(-100.0, 100.0));
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- z = mathjs.add( x, y );
- if ( isnan( z[ 0 ] ) || isnan( z[ z.length-1 ] ) ) {
- b.fail( 'should not return NaN' );
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ z = mathjs.add(x, y);
+ if (isnan(z[0]) || isnan(z[z.length - 1])) {
+ b.fail("should not return NaN");
+ }
+ }
+ b.toc();
+ if (isnan(z[0]) || isnan(z[z.length - 1])) {
+ b.fail("should not return NaN");
}
- }
- b.toc();
- if ( isnan( z[ 0 ] ) || isnan( z[ z.length-1 ] ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.add.complex_number.js b/docs/migration-guides/mathjs/benchmark/benchmark.add.complex_number.js
index ac01d30e53c0..37086b2137ab 100644
--- a/docs/migration-guides/mathjs/benchmark/benchmark.add.complex_number.js
+++ b/docs/migration-guides/mathjs/benchmark/benchmark.add.complex_number.js
@@ -1,104 +1,106 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var Complex128 = require( '@stdlib/complex/float64/ctor' );
-var real = require( '@stdlib/complex/float64/real' );
-var imag = require( '@stdlib/complex/float64/imag' );
-var base = require( '@stdlib/complex/float64/base/add' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var Complex128 = require("@stdlib/complex/float64/ctor");
+var real = require("@stdlib/complex/float64/real");
+var imag = require("@stdlib/complex/float64/imag");
+var base = require("@stdlib/complex/float64/base/add");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var mathjs = tryRequire( resolve( __dirname, '..', 'node_modules', 'mathjs' ) );
+var mathjs = tryRequire(resolve(__dirname, "..", "node_modules", "mathjs"));
var opts = {
- 'skip': ( mathjs instanceof Error )
+ skip: mathjs instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:math/base/special/cadd:value=complex_number', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
- var j;
+bench(
+ pkg + "::stdlib:math/base/special/cadd:value=complex_number",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
+ var j;
- x = [
- new Complex128( 5.0, 3.0 ),
- new Complex128( -5.0, 3.0 ),
- new Complex128( 5.0, -3.0 ),
- new Complex128( -5.0, -3.0 ),
- new Complex128( 3.0, -4.0 )
- ];
+ x = [
+ new Complex128(5.0, 3.0),
+ new Complex128(-5.0, 3.0),
+ new Complex128(5.0, -3.0),
+ new Complex128(-5.0, -3.0),
+ new Complex128(3.0, -4.0),
+ ];
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- j = i % x.length;
- y = base( x[ j ], x[ j ] );
- if ( typeof y !== 'object' ) {
- b.fail( 'should return an object' );
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ j = i % x.length;
+ y = base(x[j], x[j]);
+ if (typeof y !== "object") {
+ b.fail("should return an object");
+ }
}
- }
- b.toc();
- if ( isnan( real( y ) ) || isnan( imag( y ) ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.toc();
+ if (isnan(real(y)) || isnan(imag(y))) {
+ b.fail("should not return NaN");
+ }
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
// TODO: add math/special/add benchmarks
-bench( pkg+'::mathjs:add:value=complex_number', opts, function benchmark( b ) {
+bench(pkg + "::mathjs:add:value=complex_number", opts, function benchmark(b) {
var x;
var y;
var i;
var j;
x = [
- mathjs.complex( 5.0, 3.0 ),
- mathjs.complex( -5.0, 3.0 ),
- mathjs.complex( 5.0, -3.0 ),
- mathjs.complex( -5.0, -3.0 ),
- mathjs.complex( 3.0, -4.0 )
+ mathjs.complex(5.0, 3.0),
+ mathjs.complex(-5.0, 3.0),
+ mathjs.complex(5.0, -3.0),
+ mathjs.complex(-5.0, -3.0),
+ mathjs.complex(3.0, -4.0),
];
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
+ for (i = 0; i < b.iterations; i++) {
j = i % x.length;
- y = mathjs.add( x[ j ], x[ j ] );
- if ( typeof y !== 'object' ) {
- b.fail( 'should return an object' );
+ y = mathjs.add(x[j], x[j]);
+ if (typeof y !== "object") {
+ b.fail("should return an object");
}
}
b.toc();
- if ( isnan( mathjs.re( y ) ) || isnan( mathjs.im( y ) ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(mathjs.re(y)) || isnan(mathjs.im(y))) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
});
diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.add.number.js b/docs/migration-guides/mathjs/benchmark/benchmark.add.number.js
index 2ec388ea8d51..417465cdc018 100644
--- a/docs/migration-guides/mathjs/benchmark/benchmark.add.number.js
+++ b/docs/migration-guides/mathjs/benchmark/benchmark.add.number.js
@@ -1,95 +1,97 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var filledBy = require( '@stdlib/array/filled-by' );
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
-var base = require( '@stdlib/number/float64/base/add' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var filledBy = require("@stdlib/array/filled-by");
+var uniform = require("@stdlib/random/base/uniform").factory;
+var base = require("@stdlib/number/float64/base/add");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var mathjs = tryRequire( resolve( __dirname, '..', 'node_modules', 'mathjs' ) );
+var mathjs = tryRequire(resolve(__dirname, "..", "node_modules", "mathjs"));
var opts = {
- 'skip': ( mathjs instanceof Error )
+ skip: mathjs instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:number/float64/base/add:value=number', opts, function benchmark( b ) {
- var x;
- var y;
- var z;
- var i;
- var j;
+bench(
+ pkg + "::stdlib:number/float64/base/add:value=number",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var z;
+ var i;
+ var j;
- x = filledBy( 100, uniform( -100.0, 100.0 ) );
- y = filledBy( 100, uniform( -100.0, 100.0 ) );
+ x = filledBy(100, uniform(-100.0, 100.0));
+ y = filledBy(100, uniform(-100.0, 100.0));
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- j = i % x.length;
- z = base( x[ j ], y[ j ] );
- if ( z !== z ) {
- b.fail( 'should not return NaN' );
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ j = i % x.length;
+ z = base(x[j], y[j]);
+ if (z !== z) {
+ b.fail("should not return NaN");
+ }
}
- }
- b.toc();
- if ( isnan( z ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.toc();
+ if (isnan(z)) {
+ b.fail("should not return NaN");
+ }
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
// TODO: add math/ops/add benchmarks
-bench( pkg+'::mathjs:add:value=number', opts, function benchmark( b ) {
+bench(pkg + "::mathjs:add:value=number", opts, function benchmark(b) {
var x;
var y;
var z;
var i;
var j;
- x = filledBy( 100, uniform( -100.0, 100.0 ) );
- y = filledBy( 100, uniform( -100.0, 100.0 ) );
+ x = filledBy(100, uniform(-100.0, 100.0));
+ y = filledBy(100, uniform(-100.0, 100.0));
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
+ for (i = 0; i < b.iterations; i++) {
j = i % x.length;
- z = mathjs.add( x[ j ], y[ j ] );
- if ( z !== z ) {
- b.fail( 'should not return NaN' );
+ z = mathjs.add(x[j], y[j]);
+ if (z !== z) {
+ b.fail("should not return NaN");
}
}
b.toc();
- if ( isnan( z ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(z)) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
});
diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.cbrt.number.js b/docs/migration-guides/mathjs/benchmark/benchmark.cbrt.number.js
index 3571a60bb591..08e9d79681ac 100644
--- a/docs/migration-guides/mathjs/benchmark/benchmark.cbrt.number.js
+++ b/docs/migration-guides/mathjs/benchmark/benchmark.cbrt.number.js
@@ -1,87 +1,89 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var filledBy = require( '@stdlib/array/filled-by' );
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
-var base = require( '@stdlib/math/base/special/cbrt' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var filledBy = require("@stdlib/array/filled-by");
+var uniform = require("@stdlib/random/base/uniform").factory;
+var base = require("@stdlib/math/base/special/cbrt");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var mathjs = tryRequire( resolve( __dirname, '..', 'node_modules', 'mathjs' ) );
+var mathjs = tryRequire(resolve(__dirname, "..", "node_modules", "mathjs"));
var opts = {
- 'skip': ( mathjs instanceof Error )
+ skip: mathjs instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:math/base/special/cbrt:value=number', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
+bench(
+ pkg + "::stdlib:math/base/special/cbrt:value=number",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
- x = filledBy( 100, uniform( 0.0, 100.0 ) );
+ x = filledBy(100, uniform(0.0, 100.0));
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = base( x[ i%x.length ] );
- if ( y !== y ) {
- b.fail( 'should not return NaN' );
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = base(x[i % x.length]);
+ if (y !== y) {
+ b.fail("should not return NaN");
+ }
}
- }
- b.toc();
- if ( isnan( y ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.toc();
+ if (isnan(y)) {
+ b.fail("should not return NaN");
+ }
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
// TODO: add math/special/cbrt benchmarks
-bench( pkg+'::mathjs:cbrt:value=number', opts, function benchmark( b ) {
+bench(pkg + "::mathjs:cbrt:value=number", opts, function benchmark(b) {
var x;
var y;
var i;
- x = filledBy( 100, uniform( 0.0, 100.0 ) );
+ x = filledBy(100, uniform(0.0, 100.0));
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = mathjs.cbrt( x[ i%x.length ] );
- if ( y !== y ) {
- b.fail( 'should not return NaN' );
+ for (i = 0; i < b.iterations; i++) {
+ y = mathjs.cbrt(x[i % x.length]);
+ if (y !== y) {
+ b.fail("should not return NaN");
}
}
b.toc();
- if ( isnan( y ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(y)) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
});
diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.ceil.number.js b/docs/migration-guides/mathjs/benchmark/benchmark.ceil.number.js
index 2b3000ece1ee..3f1d79d1e6bc 100644
--- a/docs/migration-guides/mathjs/benchmark/benchmark.ceil.number.js
+++ b/docs/migration-guides/mathjs/benchmark/benchmark.ceil.number.js
@@ -1,87 +1,89 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var filledBy = require( '@stdlib/array/filled-by' );
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
-var base = require( '@stdlib/math/base/special/ceil' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var filledBy = require("@stdlib/array/filled-by");
+var uniform = require("@stdlib/random/base/uniform").factory;
+var base = require("@stdlib/math/base/special/ceil");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var mathjs = tryRequire( resolve( __dirname, '..', 'node_modules', 'mathjs' ) );
+var mathjs = tryRequire(resolve(__dirname, "..", "node_modules", "mathjs"));
var opts = {
- 'skip': ( mathjs instanceof Error )
+ skip: mathjs instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:math/base/special/ceil:value=number', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
+bench(
+ pkg + "::stdlib:math/base/special/ceil:value=number",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
- x = filledBy( 100, uniform( -100.0, 100.0 ) );
+ x = filledBy(100, uniform(-100.0, 100.0));
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = base( x[ i%x.length ] );
- if ( y !== y ) {
- b.fail( 'should not return NaN' );
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = base(x[i % x.length]);
+ if (y !== y) {
+ b.fail("should not return NaN");
+ }
}
- }
- b.toc();
- if ( isnan( y ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.toc();
+ if (isnan(y)) {
+ b.fail("should not return NaN");
+ }
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
// TODO: add math/special/ceil benchmarks
-bench( pkg+'::mathjs:ceil:value=number', opts, function benchmark( b ) {
+bench(pkg + "::mathjs:ceil:value=number", opts, function benchmark(b) {
var x;
var y;
var i;
- x = filledBy( 100, uniform( -100.0, 100.0 ) );
+ x = filledBy(100, uniform(-100.0, 100.0));
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = mathjs.ceil( x[ i%x.length ] );
- if ( y !== y ) {
- b.fail( 'should not return NaN' );
+ for (i = 0; i < b.iterations; i++) {
+ y = mathjs.ceil(x[i % x.length]);
+ if (y !== y) {
+ b.fail("should not return NaN");
}
}
b.toc();
- if ( isnan( y ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(y)) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
});
diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.erf.matrix.2d.size.js b/docs/migration-guides/mathjs/benchmark/benchmark.erf.matrix.2d.size.js
index 38c34b50d142..36bb211b9818 100644
--- a/docs/migration-guides/mathjs/benchmark/benchmark.erf.matrix.2d.size.js
+++ b/docs/migration-guides/mathjs/benchmark/benchmark.erf.matrix.2d.size.js
@@ -1,219 +1,216 @@
/**
-* @license Apache-2.0
-*
-* Copyright (c) 2024 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.
-*/
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2024 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.
+ */
/* eslint-disable max-len */
-'use strict';
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var pow = require( '@stdlib/math/base/special/pow' );
-var floor = require( '@stdlib/math/base/special/floor' );
-var numel = require( '@stdlib/ndarray/base/numel' );
-var filled2dBy = require( '@stdlib/array/base/filled2d-by' );
-var filledndBy = require( '@stdlib/array/base/fillednd-by' );
-var unary2d = require( '@stdlib/array/base/unary2d' );
-var unarynd = require( '@stdlib/array/base/unarynd' );
-var zeros2d = require( '@stdlib/array/base/zeros2d' );
-var zerosnd = require( '@stdlib/array/base/zerosnd' );
-var array = require( '@stdlib/ndarray/array' );
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
-var base = require( '@stdlib/math/base/special/erf' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var format = require( '@stdlib/string/format' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var pow = require("@stdlib/math/base/special/pow");
+var floor = require("@stdlib/math/base/special/floor");
+var numel = require("@stdlib/ndarray/base/numel");
+var filled2dBy = require("@stdlib/array/base/filled2d-by");
+var filledndBy = require("@stdlib/array/base/fillednd-by");
+var unary2d = require("@stdlib/array/base/unary2d");
+var unarynd = require("@stdlib/array/base/unarynd");
+var zeros2d = require("@stdlib/array/base/zeros2d");
+var zerosnd = require("@stdlib/array/base/zerosnd");
+var array = require("@stdlib/ndarray/array");
+var uniform = require("@stdlib/random/base/uniform").factory;
+var base = require("@stdlib/math/base/special/erf");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var format = require("@stdlib/string/format");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var mathjs = tryRequire( resolve( __dirname, '..', 'node_modules', 'mathjs' ) );
+var mathjs = tryRequire(resolve(__dirname, "..", "node_modules", "mathjs"));
var opts = {
- 'skip': ( mathjs instanceof Error )
+ skip: mathjs instanceof Error,
};
var OPTS = {
- 'dtype': 'generic'
+ dtype: "generic",
};
-var rand = uniform( -100.0, 100.0 );
-
+var rand = uniform(-100.0, 100.0);
// FUNCTIONS //
/**
-* Creates a benchmark function.
-*
-* @private
-* @param {PositiveIntegerArray} shape - array shape
-* @returns {Function} benchmark function
-*/
-function createBenchmark1( shape ) {
- var x = array( filled2dBy( shape, rand ), OPTS );
+ * Creates a benchmark function.
+ *
+ * @private
+ * @param {PositiveIntegerArray} shape - array shape
+ * @returns {Function} benchmark function
+ */
+function createBenchmark1(shape) {
+ var x = array(filled2dBy(shape, rand), OPTS);
return benchmark;
/**
- * Benchmark function.
- *
- * @private
- * @param {Benchmark} b - benchmark instance
- */
- function benchmark( b ) {
+ * Benchmark function.
+ *
+ * @private
+ * @param {Benchmark} b - benchmark instance
+ */
+ function benchmark(b) {
var y;
var i;
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
+ for (i = 0; i < b.iterations; i++) {
// y = erf( x ); FIXME: support once we have `@stdlib/math/special/erf`
- if ( typeof y !== 'object' ) {
- b.fail( 'should return an object' );
+ if (typeof y !== "object") {
+ b.fail("should return an object");
}
}
b.toc();
- if ( isnan( y.get( 0, 0 ) ) || isnan( y.get( shape[0]-1, shape[1]-1 ) ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(y.get(0, 0)) || isnan(y.get(shape[0] - 1, shape[1] - 1))) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
}
}
/**
-* Creates a benchmark function.
-*
-* @private
-* @param {PositiveIntegerArray} shape - array shape
-* @returns {Function} benchmark function
-*/
-function createBenchmark2( shape ) {
- var x = filled2dBy( shape, rand );
+ * Creates a benchmark function.
+ *
+ * @private
+ * @param {PositiveIntegerArray} shape - array shape
+ * @returns {Function} benchmark function
+ */
+function createBenchmark2(shape) {
+ var x = filled2dBy(shape, rand);
return benchmark;
/**
- * Benchmark function.
- *
- * @private
- * @param {Benchmark} b - benchmark instance
- */
- function benchmark( b ) {
+ * Benchmark function.
+ *
+ * @private
+ * @param {Benchmark} b - benchmark instance
+ */
+ function benchmark(b) {
var y;
var i;
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = zeros2d( shape );
- unary2d( [ x, y ], shape, base );
- if ( typeof y !== 'object' ) {
- b.fail( 'should return an object' );
+ for (i = 0; i < b.iterations; i++) {
+ y = zeros2d(shape);
+ unary2d([x, y], shape, base);
+ if (typeof y !== "object") {
+ b.fail("should return an object");
}
}
b.toc();
- if ( isnan( y[ 0 ][ 0 ] ) || isnan( y[ shape[0]-1 ][ shape[1]-1 ] ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(y[0][0]) || isnan(y[shape[0] - 1][shape[1] - 1])) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
}
}
/**
-* Creates a benchmark function.
-*
-* @private
-* @param {PositiveIntegerArray} shape - array shape
-* @returns {Function} benchmark function
-*/
-function createBenchmark3( shape ) {
- var x = filledndBy( shape, rand );
+ * Creates a benchmark function.
+ *
+ * @private
+ * @param {PositiveIntegerArray} shape - array shape
+ * @returns {Function} benchmark function
+ */
+function createBenchmark3(shape) {
+ var x = filledndBy(shape, rand);
return benchmark;
/**
- * Benchmark function.
- *
- * @private
- * @param {Benchmark} b - benchmark instance
- */
- function benchmark( b ) {
+ * Benchmark function.
+ *
+ * @private
+ * @param {Benchmark} b - benchmark instance
+ */
+ function benchmark(b) {
var y;
var i;
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = zerosnd( shape );
- unarynd( [ x, y ], shape, base );
- if ( typeof y !== 'object' ) {
- b.fail( 'should return an object' );
+ for (i = 0; i < b.iterations; i++) {
+ y = zerosnd(shape);
+ unarynd([x, y], shape, base);
+ if (typeof y !== "object") {
+ b.fail("should return an object");
}
}
b.toc();
- if ( isnan( y[ 0 ][ 0 ] ) || isnan( y[ shape[0]-1 ][ shape[1]-1 ] ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(y[0][0]) || isnan(y[shape[0] - 1][shape[1] - 1])) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
}
}
/**
-* Creates a benchmark function.
-*
-* @private
-* @param {PositiveIntegerArray} shape - input array shape
-* @returns {Function} benchmark function
-*/
-function createBenchmark4( shape ) {
- var x = mathjs.matrix( filled2dBy( shape, rand ) );
+ * Creates a benchmark function.
+ *
+ * @private
+ * @param {PositiveIntegerArray} shape - input array shape
+ * @returns {Function} benchmark function
+ */
+function createBenchmark4(shape) {
+ var x = mathjs.matrix(filled2dBy(shape, rand));
return benchmark;
/**
- * Benchmark function.
- *
- * @private
- * @param {Benchmark} b - benchmark instance
- */
- function benchmark( b ) {
+ * Benchmark function.
+ *
+ * @private
+ * @param {Benchmark} b - benchmark instance
+ */
+ function benchmark(b) {
var y;
var i;
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = mathjs.erf( x );
- if ( typeof y !== 'object' ) {
- b.fail( 'should return an object' );
+ for (i = 0; i < b.iterations; i++) {
+ y = mathjs.erf(x);
+ if (typeof y !== "object") {
+ b.fail("should return an object");
}
}
b.toc();
- if ( isnan( y.get( [ 0, 0 ] ) ) || isnan( y.get( [ shape[0]-1, shape[1]-1 ] ) ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(y.get([0, 0])) || isnan(y.get([shape[0] - 1, shape[1] - 1]))) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
}
}
-
// MAIN //
/**
-* Main execution sequence.
-*
-* @private
-*/
+ * Main execution sequence.
+ *
+ * @private
+ */
function main() {
var shape;
var min;
@@ -225,18 +222,46 @@ function main() {
min = 1; // 10^min
max = 6; // 10^max
- for ( i = min; i <= max; i++ ) {
- N = floor( pow( pow( 10, i ), 1.0/2.0 ) );
- shape = [ N, N ];
+ for (i = min; i <= max; i++) {
+ N = floor(pow(pow(10, i), 1.0 / 2.0));
+ shape = [N, N];
- f = createBenchmark2( shape );
- bench( format( '%s::stdlib:array/base/unary2d:dtype=%s,size=%d,shape=(%s)', pkg, OPTS.dtype, numel( shape ), shape.join( ',' ) ), f );
+ f = createBenchmark2(shape);
+ bench(
+ format(
+ "%s::stdlib:array/base/unary2d:dtype=%s,size=%d,shape=(%s)",
+ pkg,
+ OPTS.dtype,
+ numel(shape),
+ shape.join(","),
+ ),
+ f,
+ );
- f = createBenchmark3( shape );
- bench( format( '%s::stdlib:array/base/unarynd:dtype=%s,size=%d,shape=(%s)', pkg, OPTS.dtype, numel( shape ), shape.join( ',' ) ), f );
+ f = createBenchmark3(shape);
+ bench(
+ format(
+ "%s::stdlib:array/base/unarynd:dtype=%s,size=%d,shape=(%s)",
+ pkg,
+ OPTS.dtype,
+ numel(shape),
+ shape.join(","),
+ ),
+ f,
+ );
- f = createBenchmark4( shape );
- bench( format( '%s::mathjs:erf:dtype=%s,size=%d,shape=(%s)', pkg, OPTS.dtype, numel( shape ), shape.join( ',' ) ), opts, f );
+ f = createBenchmark4(shape);
+ bench(
+ format(
+ "%s::mathjs:erf:dtype=%s,size=%d,shape=(%s)",
+ pkg,
+ OPTS.dtype,
+ numel(shape),
+ shape.join(","),
+ ),
+ opts,
+ f,
+ );
}
}
diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.erf.number.js b/docs/migration-guides/mathjs/benchmark/benchmark.erf.number.js
index 8dbff9537091..158c34d552d0 100644
--- a/docs/migration-guides/mathjs/benchmark/benchmark.erf.number.js
+++ b/docs/migration-guides/mathjs/benchmark/benchmark.erf.number.js
@@ -1,87 +1,89 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var filledBy = require( '@stdlib/array/filled-by' );
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
-var base = require( '@stdlib/math/base/special/erf' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var filledBy = require("@stdlib/array/filled-by");
+var uniform = require("@stdlib/random/base/uniform").factory;
+var base = require("@stdlib/math/base/special/erf");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var mathjs = tryRequire( resolve( __dirname, '..', 'node_modules', 'mathjs' ) );
+var mathjs = tryRequire(resolve(__dirname, "..", "node_modules", "mathjs"));
var opts = {
- 'skip': ( mathjs instanceof Error )
+ skip: mathjs instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:math/base/special/erf:value=number', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
+bench(
+ pkg + "::stdlib:math/base/special/erf:value=number",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
- x = filledBy( 100, uniform( -100.0, 100.0 ) );
+ x = filledBy(100, uniform(-100.0, 100.0));
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = base( x[ i%x.length ] );
- if ( y !== y ) {
- b.fail( 'should not return NaN' );
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = base(x[i % x.length]);
+ if (y !== y) {
+ b.fail("should not return NaN");
+ }
}
- }
- b.toc();
- if ( isnan( y ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.toc();
+ if (isnan(y)) {
+ b.fail("should not return NaN");
+ }
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
// TODO: add math/special/erf benchmarks
-bench( pkg+'::mathjs:erf:value=number', opts, function benchmark( b ) {
+bench(pkg + "::mathjs:erf:value=number", opts, function benchmark(b) {
var x;
var y;
var i;
- x = filledBy( 100, uniform( -100.0, 100.0 ) );
+ x = filledBy(100, uniform(-100.0, 100.0));
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = mathjs.erf( x[ i%x.length ] );
- if ( y !== y ) {
- b.fail( 'should not return NaN' );
+ for (i = 0; i < b.iterations; i++) {
+ y = mathjs.erf(x[i % x.length]);
+ if (y !== y) {
+ b.fail("should not return NaN");
}
}
b.toc();
- if ( isnan( y ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(y)) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
});
diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.exp.number.js b/docs/migration-guides/mathjs/benchmark/benchmark.exp.number.js
index f4f4f5f01228..77f8c0426418 100644
--- a/docs/migration-guides/mathjs/benchmark/benchmark.exp.number.js
+++ b/docs/migration-guides/mathjs/benchmark/benchmark.exp.number.js
@@ -1,87 +1,89 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var filledBy = require( '@stdlib/array/filled-by' );
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
-var base = require( '@stdlib/math/base/special/exp' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var filledBy = require("@stdlib/array/filled-by");
+var uniform = require("@stdlib/random/base/uniform").factory;
+var base = require("@stdlib/math/base/special/exp");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var mathjs = tryRequire( resolve( __dirname, '..', 'node_modules', 'mathjs' ) );
+var mathjs = tryRequire(resolve(__dirname, "..", "node_modules", "mathjs"));
var opts = {
- 'skip': ( mathjs instanceof Error )
+ skip: mathjs instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:math/base/special/exp:value=number', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
+bench(
+ pkg + "::stdlib:math/base/special/exp:value=number",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
- x = filledBy( 100, uniform( -100.0, 100.0 ) );
+ x = filledBy(100, uniform(-100.0, 100.0));
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = base( x[ i%x.length ] );
- if ( y !== y ) {
- b.fail( 'should not return NaN' );
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = base(x[i % x.length]);
+ if (y !== y) {
+ b.fail("should not return NaN");
+ }
}
- }
- b.toc();
- if ( isnan( y ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.toc();
+ if (isnan(y)) {
+ b.fail("should not return NaN");
+ }
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
// TODO: add math/special/exp benchmarks
-bench( pkg+'::mathjs:exp:value=number', opts, function benchmark( b ) {
+bench(pkg + "::mathjs:exp:value=number", opts, function benchmark(b) {
var x;
var y;
var i;
- x = filledBy( 100, uniform( -100.0, 100.0 ) );
+ x = filledBy(100, uniform(-100.0, 100.0));
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = mathjs.exp( x[ i%x.length ] );
- if ( y !== y ) {
- b.fail( 'should not return NaN' );
+ for (i = 0; i < b.iterations; i++) {
+ y = mathjs.exp(x[i % x.length]);
+ if (y !== y) {
+ b.fail("should not return NaN");
}
}
b.toc();
- if ( isnan( y ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(y)) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
});
diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.expm1.number.js b/docs/migration-guides/mathjs/benchmark/benchmark.expm1.number.js
index 3d238651cecd..7829f71d0878 100644
--- a/docs/migration-guides/mathjs/benchmark/benchmark.expm1.number.js
+++ b/docs/migration-guides/mathjs/benchmark/benchmark.expm1.number.js
@@ -1,87 +1,89 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var filledBy = require( '@stdlib/array/filled-by' );
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
-var base = require( '@stdlib/math/base/special/expm1' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var filledBy = require("@stdlib/array/filled-by");
+var uniform = require("@stdlib/random/base/uniform").factory;
+var base = require("@stdlib/math/base/special/expm1");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var mathjs = tryRequire( resolve( __dirname, '..', 'node_modules', 'mathjs' ) );
+var mathjs = tryRequire(resolve(__dirname, "..", "node_modules", "mathjs"));
var opts = {
- 'skip': ( mathjs instanceof Error )
+ skip: mathjs instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:math/base/special/expm1:value=number', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
+bench(
+ pkg + "::stdlib:math/base/special/expm1:value=number",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
- x = filledBy( 100, uniform( -100.0, 100.0 ) );
+ x = filledBy(100, uniform(-100.0, 100.0));
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = base( x[ i%x.length ] );
- if ( y !== y ) {
- b.fail( 'should not return NaN' );
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = base(x[i % x.length]);
+ if (y !== y) {
+ b.fail("should not return NaN");
+ }
}
- }
- b.toc();
- if ( isnan( y ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.toc();
+ if (isnan(y)) {
+ b.fail("should not return NaN");
+ }
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
// TODO: add math/special/expm1 benchmarks
-bench( pkg+'::mathjs:expm1:value=number', opts, function benchmark( b ) {
+bench(pkg + "::mathjs:expm1:value=number", opts, function benchmark(b) {
var x;
var y;
var i;
- x = filledBy( 100, uniform( -100.0, 100.0 ) );
+ x = filledBy(100, uniform(-100.0, 100.0));
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = mathjs.expm1( x[ i%x.length ] );
- if ( y !== y ) {
- b.fail( 'should not return NaN' );
+ for (i = 0; i < b.iterations; i++) {
+ y = mathjs.expm1(x[i % x.length]);
+ if (y !== y) {
+ b.fail("should not return NaN");
}
}
b.toc();
- if ( isnan( y ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(y)) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
});
diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.floor.number.js b/docs/migration-guides/mathjs/benchmark/benchmark.floor.number.js
index d5bddf3e5c4a..4cee724f8185 100644
--- a/docs/migration-guides/mathjs/benchmark/benchmark.floor.number.js
+++ b/docs/migration-guides/mathjs/benchmark/benchmark.floor.number.js
@@ -1,87 +1,89 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var filledBy = require( '@stdlib/array/filled-by' );
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
-var base = require( '@stdlib/math/base/special/floor' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var filledBy = require("@stdlib/array/filled-by");
+var uniform = require("@stdlib/random/base/uniform").factory;
+var base = require("@stdlib/math/base/special/floor");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var mathjs = tryRequire( resolve( __dirname, '..', 'node_modules', 'mathjs' ) );
+var mathjs = tryRequire(resolve(__dirname, "..", "node_modules", "mathjs"));
var opts = {
- 'skip': ( mathjs instanceof Error )
+ skip: mathjs instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:math/base/special/floor:value=number', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
+bench(
+ pkg + "::stdlib:math/base/special/floor:value=number",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
- x = filledBy( 100, uniform( -100.0, 100.0 ) );
+ x = filledBy(100, uniform(-100.0, 100.0));
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = base( x[ i%x.length ] );
- if ( y !== y ) {
- b.fail( 'should not return NaN' );
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = base(x[i % x.length]);
+ if (y !== y) {
+ b.fail("should not return NaN");
+ }
}
- }
- b.toc();
- if ( isnan( y ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.toc();
+ if (isnan(y)) {
+ b.fail("should not return NaN");
+ }
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
// TODO: add math/special/floor benchmarks
-bench( pkg+'::mathjs:floor:value=number', opts, function benchmark( b ) {
+bench(pkg + "::mathjs:floor:value=number", opts, function benchmark(b) {
var x;
var y;
var i;
- x = filledBy( 100, uniform( -100.0, 100.0 ) );
+ x = filledBy(100, uniform(-100.0, 100.0));
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = mathjs.floor( x[ i%x.length ] );
- if ( y !== y ) {
- b.fail( 'should not return NaN' );
+ for (i = 0; i < b.iterations; i++) {
+ y = mathjs.floor(x[i % x.length]);
+ if (y !== y) {
+ b.fail("should not return NaN");
}
}
b.toc();
- if ( isnan( y ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(y)) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
});
diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.gemm.square_matrices.js b/docs/migration-guides/mathjs/benchmark/benchmark.gemm.square_matrices.js
index e8b2e3a98325..adf7ff43daf8 100644
--- a/docs/migration-guides/mathjs/benchmark/benchmark.gemm.square_matrices.js
+++ b/docs/migration-guides/mathjs/benchmark/benchmark.gemm.square_matrices.js
@@ -1,69 +1,67 @@
/**
-* @license Apache-2.0
-*
-* Copyright (c) 2024 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.
-*/
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2024 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.
+ */
/* eslint-disable max-len */
-'use strict';
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
-var randi = require( '@stdlib/random/base/discrete-uniform' ).factory;
-var filled2dBy = require( '@stdlib/array/base/filled2d-by' );
-var pow = require( '@stdlib/math/base/special/pow' );
-var floor = require( '@stdlib/math/base/special/floor' );
-var numel = require( '@stdlib/ndarray/base/numel' );
-var shape2strides = require( '@stdlib/ndarray/base/shape2strides' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var format = require( '@stdlib/string/format' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var dgemm = require( '@stdlib/blas/base/dgemm' ).ndarray;
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var discreteUniform = require("@stdlib/random/array/discrete-uniform");
+var randi = require("@stdlib/random/base/discrete-uniform").factory;
+var filled2dBy = require("@stdlib/array/base/filled2d-by");
+var pow = require("@stdlib/math/base/special/pow");
+var floor = require("@stdlib/math/base/special/floor");
+var numel = require("@stdlib/ndarray/base/numel");
+var shape2strides = require("@stdlib/ndarray/base/shape2strides");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var format = require("@stdlib/string/format");
+var tryRequire = require("@stdlib/utils/try-require");
+var dgemm = require("@stdlib/blas/base/dgemm").ndarray;
+var pkg = require("./../package.json").name;
// VARIABLES //
-var mathjs = tryRequire( resolve( __dirname, '..', 'node_modules', 'mathjs' ) );
+var mathjs = tryRequire(resolve(__dirname, "..", "node_modules", "mathjs"));
var opts = {
- 'skip': ( mathjs instanceof Error )
+ skip: mathjs instanceof Error,
};
var OPTS = {
- 'dtype': 'float64'
+ dtype: "float64",
};
-
// FUNCTIONS //
/**
-* Creates a benchmark function.
-*
-* @private
-* @param {PositiveIntegerArray} shapeA - shape of the first array
-* @param {string} orderA - memory layout of the first array
-* @param {PositiveIntegerArray} shapeB - shape of the second array
-* @param {string} orderB - memory layout of the second array
-* @param {PositiveIntegerArray} shapeC - shape of the third array
-* @param {string} orderC - memory layout of the third array
-* @returns {Function} benchmark function
-*/
-function createBenchmark1( shapeA, orderA, shapeB, orderB, shapeC, orderC ) {
+ * Creates a benchmark function.
+ *
+ * @private
+ * @param {PositiveIntegerArray} shapeA - shape of the first array
+ * @param {string} orderA - memory layout of the first array
+ * @param {PositiveIntegerArray} shapeB - shape of the second array
+ * @param {string} orderB - memory layout of the second array
+ * @param {PositiveIntegerArray} shapeC - shape of the third array
+ * @param {string} orderC - memory layout of the third array
+ * @returns {Function} benchmark function
+ */
+function createBenchmark1(shapeA, orderA, shapeB, orderB, shapeC, orderC) {
var sa;
var sb;
var sc;
@@ -71,51 +69,71 @@ function createBenchmark1( shapeA, orderA, shapeB, orderB, shapeC, orderC ) {
var B;
var C;
- A = discreteUniform( numel( shapeA ), 0, 10, OPTS );
- B = discreteUniform( numel( shapeB ), 0, 10, OPTS );
- C = discreteUniform( numel( shapeC ), 0, 10, OPTS );
+ A = discreteUniform(numel(shapeA), 0, 10, OPTS);
+ B = discreteUniform(numel(shapeB), 0, 10, OPTS);
+ C = discreteUniform(numel(shapeC), 0, 10, OPTS);
- sa = shape2strides( shapeA, orderA );
- sb = shape2strides( shapeB, orderB );
- sc = shape2strides( shapeC, orderC );
+ sa = shape2strides(shapeA, orderA);
+ sb = shape2strides(shapeB, orderB);
+ sc = shape2strides(shapeC, orderC);
return benchmark;
/**
- * Benchmark function.
- *
- * @private
- * @param {Benchmark} b - benchmark instance
- */
- function benchmark( b ) {
+ * Benchmark function.
+ *
+ * @private
+ * @param {Benchmark} b - benchmark instance
+ */
+ function benchmark(b) {
var i;
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- dgemm( 'no-transpose', 'no-transpose', shapeA[0], shapeC[1], shapeB[0], 0.5, A, sa[0], sa[1], 0, B, sb[0], sb[1], 0, 2.0, C, sc[0], sc[1], 0 );
- if ( isnan( C[ i%C.length ] ) ) {
- b.fail( 'should not return NaN' );
+ for (i = 0; i < b.iterations; i++) {
+ dgemm(
+ "no-transpose",
+ "no-transpose",
+ shapeA[0],
+ shapeC[1],
+ shapeB[0],
+ 0.5,
+ A,
+ sa[0],
+ sa[1],
+ 0,
+ B,
+ sb[0],
+ sb[1],
+ 0,
+ 2.0,
+ C,
+ sc[0],
+ sc[1],
+ 0,
+ );
+ if (isnan(C[i % C.length])) {
+ b.fail("should not return NaN");
}
}
b.toc();
- if ( isnan( C[ i%C.length ] ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(C[i % C.length])) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
}
}
/**
-* Creates a benchmark function.
-*
-* @private
-* @param {PositiveIntegerArray} shapeA - shape of the first array
-* @param {PositiveIntegerArray} shapeB - shape of the second array
-* @param {PositiveIntegerArray} shapeC - shape of the third array
-* @returns {Function} benchmark function
-*/
-function createBenchmark2( shapeA, shapeB, shapeC ) {
+ * Creates a benchmark function.
+ *
+ * @private
+ * @param {PositiveIntegerArray} shapeA - shape of the first array
+ * @param {PositiveIntegerArray} shapeB - shape of the second array
+ * @param {PositiveIntegerArray} shapeC - shape of the third array
+ * @returns {Function} benchmark function
+ */
+function createBenchmark2(shapeA, shapeB, shapeC) {
var abuf;
var bbuf;
var cbuf;
@@ -123,50 +141,49 @@ function createBenchmark2( shapeA, shapeB, shapeC ) {
var B;
var C;
- abuf = filled2dBy( shapeA, randi( 0, 10 ) );
- bbuf = filled2dBy( shapeB, randi( 0, 10 ) );
- cbuf = filled2dBy( shapeC, randi( 0, 10 ) );
+ abuf = filled2dBy(shapeA, randi(0, 10));
+ bbuf = filled2dBy(shapeB, randi(0, 10));
+ cbuf = filled2dBy(shapeC, randi(0, 10));
- A = mathjs.matrix( abuf );
- B = mathjs.matrix( bbuf );
- C = mathjs.matrix( cbuf );
+ A = mathjs.matrix(abuf);
+ B = mathjs.matrix(bbuf);
+ C = mathjs.matrix(cbuf);
return benchmark;
/**
- * Benchmark function.
- *
- * @private
- * @param {Benchmark} b - benchmark instance
- */
- function benchmark( b ) {
+ * Benchmark function.
+ *
+ * @private
+ * @param {Benchmark} b - benchmark instance
+ */
+ function benchmark(b) {
var out;
var i;
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- out = mathjs.add( mathjs.multiply( A, B ), C );
- if ( isnan( out.get( [ i%shapeC[0], i%shapeC[1] ] ) ) ) {
- b.fail( 'should not return NaN' );
+ for (i = 0; i < b.iterations; i++) {
+ out = mathjs.add(mathjs.multiply(A, B), C);
+ if (isnan(out.get([i % shapeC[0], i % shapeC[1]]))) {
+ b.fail("should not return NaN");
}
}
b.toc();
- if ( isnan( out.get( [ i%shapeC[0], i%shapeC[1] ] ) ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(out.get([i % shapeC[0], i % shapeC[1]]))) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
}
}
-
// MAIN //
/**
-* Main execution sequence.
-*
-* @private
-*/
+ * Main execution sequence.
+ *
+ * @private
+ */
function main() {
var shapes;
var orders;
@@ -179,34 +196,88 @@ function main() {
min = 1; // 10^min
max = 5; // 10^max
- for ( i = min; i <= max; i++ ) {
- N = floor( pow( pow( 10, i ), 1.0/2.0 ) );
+ for (i = min; i <= max; i++) {
+ N = floor(pow(pow(10, i), 1.0 / 2.0));
shapes = [
- [ N, N ],
- [ N, N ],
- [ N, N ]
+ [N, N],
+ [N, N],
+ [N, N],
];
- orders = [
- 'row-major',
- 'row-major',
- 'row-major'
- ];
- f = createBenchmark1( shapes[0], orders[0], shapes[1], orders[1], shapes[2], orders[2] );
- bench( format( '%s::stdlib:blas/base/dgemm:dtype=%s,orders=(%s),size=%d,shapes={(%s),(%s),(%s)}', pkg, OPTS.dtype, orders.join( ',' ), numel( shapes[2] ), shapes[0].join( ',' ), shapes[1].join( ',' ), shapes[2].join( ',' ) ), f );
+ orders = ["row-major", "row-major", "row-major"];
+ f = createBenchmark1(
+ shapes[0],
+ orders[0],
+ shapes[1],
+ orders[1],
+ shapes[2],
+ orders[2],
+ );
+ bench(
+ format(
+ "%s::stdlib:blas/base/dgemm:dtype=%s,orders=(%s),size=%d,shapes={(%s),(%s),(%s)}",
+ pkg,
+ OPTS.dtype,
+ orders.join(","),
+ numel(shapes[2]),
+ shapes[0].join(","),
+ shapes[1].join(","),
+ shapes[2].join(","),
+ ),
+ f,
+ );
- f = createBenchmark2( shapes[0], shapes[1], shapes[2] );
- bench( format( '%s::mathjs:multiply:dtype=%s,size=%d,shapes={(%s),(%s),(%s)}', pkg, OPTS.dtype, numel( shapes[2] ), shapes[0].join( ',' ), shapes[1].join( ',' ), shapes[2].join( ',' ) ), opts, f );
+ f = createBenchmark2(shapes[0], shapes[1], shapes[2]);
+ bench(
+ format(
+ "%s::mathjs:multiply:dtype=%s,size=%d,shapes={(%s),(%s),(%s)}",
+ pkg,
+ OPTS.dtype,
+ numel(shapes[2]),
+ shapes[0].join(","),
+ shapes[1].join(","),
+ shapes[2].join(","),
+ ),
+ opts,
+ f,
+ );
- orders = [
- 'row-major',
- 'column-major',
- 'row-major'
- ];
- f = createBenchmark1( shapes[0], orders[0], shapes[1], orders[1], shapes[2], orders[2] );
- bench( format( '%s::stdlib:blas/base/dgemm:dtype=%s,orders=(%s),size=%d,shapes={(%s),(%s),(%s)}', pkg, OPTS.dtype, orders.join( ',' ), numel( shapes[2] ), shapes[0].join( ',' ), shapes[1].join( ',' ), shapes[2].join( ',' ) ), f );
+ orders = ["row-major", "column-major", "row-major"];
+ f = createBenchmark1(
+ shapes[0],
+ orders[0],
+ shapes[1],
+ orders[1],
+ shapes[2],
+ orders[2],
+ );
+ bench(
+ format(
+ "%s::stdlib:blas/base/dgemm:dtype=%s,orders=(%s),size=%d,shapes={(%s),(%s),(%s)}",
+ pkg,
+ OPTS.dtype,
+ orders.join(","),
+ numel(shapes[2]),
+ shapes[0].join(","),
+ shapes[1].join(","),
+ shapes[2].join(","),
+ ),
+ f,
+ );
- f = createBenchmark2( shapes[0], shapes[1], shapes[2] );
- bench( format( '%s::mathjs:multiply:dtype=%s,size=%d,shapes={(%s),(%s),(%s)}', pkg, OPTS.dtype, numel( shapes[2] ), shapes[0].join( ',' ), shapes[1].join( ',' ), shapes[2].join( ',' ) ), opts, f );
+ f = createBenchmark2(shapes[0], shapes[1], shapes[2]);
+ bench(
+ format(
+ "%s::mathjs:multiply:dtype=%s,size=%d,shapes={(%s),(%s),(%s)}",
+ pkg,
+ OPTS.dtype,
+ numel(shapes[2]),
+ shapes[0].join(","),
+ shapes[1].join(","),
+ shapes[2].join(","),
+ ),
+ opts,
+ f,
+ );
}
}
diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.hypot.number.js b/docs/migration-guides/mathjs/benchmark/benchmark.hypot.number.js
index 00b31fd13a41..5a308b0917b3 100644
--- a/docs/migration-guides/mathjs/benchmark/benchmark.hypot.number.js
+++ b/docs/migration-guides/mathjs/benchmark/benchmark.hypot.number.js
@@ -1,95 +1,97 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var filledBy = require( '@stdlib/array/filled-by' );
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
-var base = require( '@stdlib/math/base/special/hypot' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var filledBy = require("@stdlib/array/filled-by");
+var uniform = require("@stdlib/random/base/uniform").factory;
+var base = require("@stdlib/math/base/special/hypot");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var mathjs = tryRequire( resolve( __dirname, '..', 'node_modules', 'mathjs' ) );
+var mathjs = tryRequire(resolve(__dirname, "..", "node_modules", "mathjs"));
var opts = {
- 'skip': ( mathjs instanceof Error )
+ skip: mathjs instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:math/base/special/hypot:value=number', opts, function benchmark( b ) {
- var x;
- var y;
- var z;
- var i;
- var j;
+bench(
+ pkg + "::stdlib:math/base/special/hypot:value=number",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var z;
+ var i;
+ var j;
- x = filledBy( 100, uniform( -100.0, 100.0 ) );
- y = filledBy( 100, uniform( -100.0, 100.0 ) );
+ x = filledBy(100, uniform(-100.0, 100.0));
+ y = filledBy(100, uniform(-100.0, 100.0));
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- j = i % x.length;
- z = base( x[ j ], y[ j ] );
- if ( z !== z ) {
- b.fail( 'should not return NaN' );
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ j = i % x.length;
+ z = base(x[j], y[j]);
+ if (z !== z) {
+ b.fail("should not return NaN");
+ }
}
- }
- b.toc();
- if ( isnan( z ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.toc();
+ if (isnan(z)) {
+ b.fail("should not return NaN");
+ }
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
// TODO: add math/special/hypot benchmarks
-bench( pkg+'::mathjs:hypot:value=number', opts, function benchmark( b ) {
+bench(pkg + "::mathjs:hypot:value=number", opts, function benchmark(b) {
var x;
var y;
var z;
var i;
var j;
- x = filledBy( 100, uniform( -100.0, 100.0 ) );
- y = filledBy( 100, uniform( -100.0, 100.0 ) );
+ x = filledBy(100, uniform(-100.0, 100.0));
+ y = filledBy(100, uniform(-100.0, 100.0));
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
+ for (i = 0; i < b.iterations; i++) {
j = i % x.length;
- z = mathjs.hypot( x[ j ], y[ j ] );
- if ( z !== z ) {
- b.fail( 'should not return NaN' );
+ z = mathjs.hypot(x[j], y[j]);
+ if (z !== z) {
+ b.fail("should not return NaN");
}
}
b.toc();
- if ( isnan( z ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(z)) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
});
diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.log10.matrix.2d.size.js b/docs/migration-guides/mathjs/benchmark/benchmark.log10.matrix.2d.size.js
index bca5672d7245..ff2d8a0a42db 100644
--- a/docs/migration-guides/mathjs/benchmark/benchmark.log10.matrix.2d.size.js
+++ b/docs/migration-guides/mathjs/benchmark/benchmark.log10.matrix.2d.size.js
@@ -1,219 +1,216 @@
/**
-* @license Apache-2.0
-*
-* Copyright (c) 2024 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.
-*/
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2024 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.
+ */
/* eslint-disable max-len */
-'use strict';
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var pow = require( '@stdlib/math/base/special/pow' );
-var floor = require( '@stdlib/math/base/special/floor' );
-var numel = require( '@stdlib/ndarray/base/numel' );
-var filled2dBy = require( '@stdlib/array/base/filled2d-by' );
-var filledndBy = require( '@stdlib/array/base/fillednd-by' );
-var unary2d = require( '@stdlib/array/base/unary2d' );
-var unarynd = require( '@stdlib/array/base/unarynd' );
-var zeros2d = require( '@stdlib/array/base/zeros2d' );
-var zerosnd = require( '@stdlib/array/base/zerosnd' );
-var array = require( '@stdlib/ndarray/array' );
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
-var base = require( '@stdlib/math/base/special/log10' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var format = require( '@stdlib/string/format' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var pow = require("@stdlib/math/base/special/pow");
+var floor = require("@stdlib/math/base/special/floor");
+var numel = require("@stdlib/ndarray/base/numel");
+var filled2dBy = require("@stdlib/array/base/filled2d-by");
+var filledndBy = require("@stdlib/array/base/fillednd-by");
+var unary2d = require("@stdlib/array/base/unary2d");
+var unarynd = require("@stdlib/array/base/unarynd");
+var zeros2d = require("@stdlib/array/base/zeros2d");
+var zerosnd = require("@stdlib/array/base/zerosnd");
+var array = require("@stdlib/ndarray/array");
+var uniform = require("@stdlib/random/base/uniform").factory;
+var base = require("@stdlib/math/base/special/log10");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var format = require("@stdlib/string/format");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var mathjs = tryRequire( resolve( __dirname, '..', 'node_modules', 'mathjs' ) );
+var mathjs = tryRequire(resolve(__dirname, "..", "node_modules", "mathjs"));
var opts = {
- 'skip': ( mathjs instanceof Error )
+ skip: mathjs instanceof Error,
};
var OPTS = {
- 'dtype': 'generic'
+ dtype: "generic",
};
-var rand = uniform( 0.001, 100.0 );
-
+var rand = uniform(0.001, 100.0);
// FUNCTIONS //
/**
-* Creates a benchmark function.
-*
-* @private
-* @param {PositiveIntegerArray} shape - array shape
-* @returns {Function} benchmark function
-*/
-function createBenchmark1( shape ) {
- var x = array( filled2dBy( shape, rand ), OPTS );
+ * Creates a benchmark function.
+ *
+ * @private
+ * @param {PositiveIntegerArray} shape - array shape
+ * @returns {Function} benchmark function
+ */
+function createBenchmark1(shape) {
+ var x = array(filled2dBy(shape, rand), OPTS);
return benchmark;
/**
- * Benchmark function.
- *
- * @private
- * @param {Benchmark} b - benchmark instance
- */
- function benchmark( b ) {
+ * Benchmark function.
+ *
+ * @private
+ * @param {Benchmark} b - benchmark instance
+ */
+ function benchmark(b) {
var y;
var i;
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
+ for (i = 0; i < b.iterations; i++) {
// y = log10( x ); FIXME: support once we have `@stdlib/math/special/log10`
- if ( typeof y !== 'object' ) {
- b.fail( 'should return an object' );
+ if (typeof y !== "object") {
+ b.fail("should return an object");
}
}
b.toc();
- if ( isnan( y.get( 0, 0 ) ) || isnan( y.get( shape[0]-1, shape[1]-1 ) ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(y.get(0, 0)) || isnan(y.get(shape[0] - 1, shape[1] - 1))) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
}
}
/**
-* Creates a benchmark function.
-*
-* @private
-* @param {PositiveIntegerArray} shape - array shape
-* @returns {Function} benchmark function
-*/
-function createBenchmark2( shape ) {
- var x = filled2dBy( shape, rand );
+ * Creates a benchmark function.
+ *
+ * @private
+ * @param {PositiveIntegerArray} shape - array shape
+ * @returns {Function} benchmark function
+ */
+function createBenchmark2(shape) {
+ var x = filled2dBy(shape, rand);
return benchmark;
/**
- * Benchmark function.
- *
- * @private
- * @param {Benchmark} b - benchmark instance
- */
- function benchmark( b ) {
+ * Benchmark function.
+ *
+ * @private
+ * @param {Benchmark} b - benchmark instance
+ */
+ function benchmark(b) {
var y;
var i;
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = zeros2d( shape );
- unary2d( [ x, y ], shape, base );
- if ( typeof y !== 'object' ) {
- b.fail( 'should return an object' );
+ for (i = 0; i < b.iterations; i++) {
+ y = zeros2d(shape);
+ unary2d([x, y], shape, base);
+ if (typeof y !== "object") {
+ b.fail("should return an object");
}
}
b.toc();
- if ( isnan( y[ 0 ][ 0 ] ) || isnan( y[ shape[0]-1 ][ shape[1]-1 ] ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(y[0][0]) || isnan(y[shape[0] - 1][shape[1] - 1])) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
}
}
/**
-* Creates a benchmark function.
-*
-* @private
-* @param {PositiveIntegerArray} shape - array shape
-* @returns {Function} benchmark function
-*/
-function createBenchmark3( shape ) {
- var x = filledndBy( shape, rand );
+ * Creates a benchmark function.
+ *
+ * @private
+ * @param {PositiveIntegerArray} shape - array shape
+ * @returns {Function} benchmark function
+ */
+function createBenchmark3(shape) {
+ var x = filledndBy(shape, rand);
return benchmark;
/**
- * Benchmark function.
- *
- * @private
- * @param {Benchmark} b - benchmark instance
- */
- function benchmark( b ) {
+ * Benchmark function.
+ *
+ * @private
+ * @param {Benchmark} b - benchmark instance
+ */
+ function benchmark(b) {
var y;
var i;
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = zerosnd( shape );
- unarynd( [ x, y ], shape, base );
- if ( typeof y !== 'object' ) {
- b.fail( 'should return an object' );
+ for (i = 0; i < b.iterations; i++) {
+ y = zerosnd(shape);
+ unarynd([x, y], shape, base);
+ if (typeof y !== "object") {
+ b.fail("should return an object");
}
}
b.toc();
- if ( isnan( y[ 0 ][ 0 ] ) || isnan( y[ shape[0]-1 ][ shape[1]-1 ] ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(y[0][0]) || isnan(y[shape[0] - 1][shape[1] - 1])) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
}
}
/**
-* Creates a benchmark function.
-*
-* @private
-* @param {PositiveIntegerArray} shape - input array shape
-* @returns {Function} benchmark function
-*/
-function createBenchmark4( shape ) {
- var x = mathjs.matrix( filled2dBy( shape, rand ) );
+ * Creates a benchmark function.
+ *
+ * @private
+ * @param {PositiveIntegerArray} shape - input array shape
+ * @returns {Function} benchmark function
+ */
+function createBenchmark4(shape) {
+ var x = mathjs.matrix(filled2dBy(shape, rand));
return benchmark;
/**
- * Benchmark function.
- *
- * @private
- * @param {Benchmark} b - benchmark instance
- */
- function benchmark( b ) {
+ * Benchmark function.
+ *
+ * @private
+ * @param {Benchmark} b - benchmark instance
+ */
+ function benchmark(b) {
var y;
var i;
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = mathjs.log10( x );
- if ( typeof y !== 'object' ) {
- b.fail( 'should return an object' );
+ for (i = 0; i < b.iterations; i++) {
+ y = mathjs.log10(x);
+ if (typeof y !== "object") {
+ b.fail("should return an object");
}
}
b.toc();
- if ( isnan( y.get( [ 0, 0 ] ) ) || isnan( y.get( [ shape[0]-1, shape[1]-1 ] ) ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(y.get([0, 0])) || isnan(y.get([shape[0] - 1, shape[1] - 1]))) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
}
}
-
// MAIN //
/**
-* Main execution sequence.
-*
-* @private
-*/
+ * Main execution sequence.
+ *
+ * @private
+ */
function main() {
var shape;
var min;
@@ -225,18 +222,46 @@ function main() {
min = 1; // 10^min
max = 6; // 10^max
- for ( i = min; i <= max; i++ ) {
- N = floor( pow( pow( 10, i ), 1.0/2.0 ) );
- shape = [ N, N ];
+ for (i = min; i <= max; i++) {
+ N = floor(pow(pow(10, i), 1.0 / 2.0));
+ shape = [N, N];
- f = createBenchmark2( shape );
- bench( format( '%s::stdlib:array/base/unary2d:dtype=%s,size=%d,shape=(%s)', pkg, OPTS.dtype, numel( shape ), shape.join( ',' ) ), f );
+ f = createBenchmark2(shape);
+ bench(
+ format(
+ "%s::stdlib:array/base/unary2d:dtype=%s,size=%d,shape=(%s)",
+ pkg,
+ OPTS.dtype,
+ numel(shape),
+ shape.join(","),
+ ),
+ f,
+ );
- f = createBenchmark3( shape );
- bench( format( '%s::stdlib:array/base/unarynd:dtype=%s,size=%d,shape=(%s)', pkg, OPTS.dtype, numel( shape ), shape.join( ',' ) ), f );
+ f = createBenchmark3(shape);
+ bench(
+ format(
+ "%s::stdlib:array/base/unarynd:dtype=%s,size=%d,shape=(%s)",
+ pkg,
+ OPTS.dtype,
+ numel(shape),
+ shape.join(","),
+ ),
+ f,
+ );
- f = createBenchmark4( shape );
- bench( format( '%s::mathjs:log10:dtype=%s,size=%d,shape=(%s)', pkg, OPTS.dtype, numel( shape ), shape.join( ',' ) ), opts, f );
+ f = createBenchmark4(shape);
+ bench(
+ format(
+ "%s::mathjs:log10:dtype=%s,size=%d,shape=(%s)",
+ pkg,
+ OPTS.dtype,
+ numel(shape),
+ shape.join(","),
+ ),
+ opts,
+ f,
+ );
}
}
diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.log10.number.js b/docs/migration-guides/mathjs/benchmark/benchmark.log10.number.js
index a2376dd8aad8..026b5d0c9445 100644
--- a/docs/migration-guides/mathjs/benchmark/benchmark.log10.number.js
+++ b/docs/migration-guides/mathjs/benchmark/benchmark.log10.number.js
@@ -1,87 +1,89 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var filledBy = require( '@stdlib/array/filled-by' );
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
-var base = require( '@stdlib/math/base/special/log10' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var filledBy = require("@stdlib/array/filled-by");
+var uniform = require("@stdlib/random/base/uniform").factory;
+var base = require("@stdlib/math/base/special/log10");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var mathjs = tryRequire( resolve( __dirname, '..', 'node_modules', 'mathjs' ) );
+var mathjs = tryRequire(resolve(__dirname, "..", "node_modules", "mathjs"));
var opts = {
- 'skip': ( mathjs instanceof Error )
+ skip: mathjs instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:math/base/special/log10:value=number', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
+bench(
+ pkg + "::stdlib:math/base/special/log10:value=number",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
- x = filledBy( 100, uniform( 0.0, 100.0 ) );
+ x = filledBy(100, uniform(0.0, 100.0));
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = base( x[ i%x.length ] );
- if ( y !== y ) {
- b.fail( 'should not return NaN' );
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = base(x[i % x.length]);
+ if (y !== y) {
+ b.fail("should not return NaN");
+ }
}
- }
- b.toc();
- if ( isnan( y ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.toc();
+ if (isnan(y)) {
+ b.fail("should not return NaN");
+ }
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
// TODO: add math/special/log10 benchmarks
-bench( pkg+'::mathjs:log10:value=number', opts, function benchmark( b ) {
+bench(pkg + "::mathjs:log10:value=number", opts, function benchmark(b) {
var x;
var y;
var i;
- x = filledBy( 100, uniform( 0.0, 100.0 ) );
+ x = filledBy(100, uniform(0.0, 100.0));
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = mathjs.log10( x[ i%x.length ] );
- if ( y !== y ) {
- b.fail( 'should not return NaN' );
+ for (i = 0; i < b.iterations; i++) {
+ y = mathjs.log10(x[i % x.length]);
+ if (y !== y) {
+ b.fail("should not return NaN");
}
}
b.toc();
- if ( isnan( y ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(y)) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
});
diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.log1p.number.js b/docs/migration-guides/mathjs/benchmark/benchmark.log1p.number.js
index 022ff35534b4..4b5f31caf9ad 100644
--- a/docs/migration-guides/mathjs/benchmark/benchmark.log1p.number.js
+++ b/docs/migration-guides/mathjs/benchmark/benchmark.log1p.number.js
@@ -1,87 +1,89 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var filledBy = require( '@stdlib/array/filled-by' );
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
-var base = require( '@stdlib/math/base/special/log1p' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var filledBy = require("@stdlib/array/filled-by");
+var uniform = require("@stdlib/random/base/uniform").factory;
+var base = require("@stdlib/math/base/special/log1p");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var mathjs = tryRequire( resolve( __dirname, '..', 'node_modules', 'mathjs' ) );
+var mathjs = tryRequire(resolve(__dirname, "..", "node_modules", "mathjs"));
var opts = {
- 'skip': ( mathjs instanceof Error )
+ skip: mathjs instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:math/base/special/log1p:value=number', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
+bench(
+ pkg + "::stdlib:math/base/special/log1p:value=number",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
- x = filledBy( 100, uniform( 0.0, 100.0 ) );
+ x = filledBy(100, uniform(0.0, 100.0));
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = base( x[ i%x.length ] );
- if ( y !== y ) {
- b.fail( 'should not return NaN' );
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = base(x[i % x.length]);
+ if (y !== y) {
+ b.fail("should not return NaN");
+ }
}
- }
- b.toc();
- if ( isnan( y ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.toc();
+ if (isnan(y)) {
+ b.fail("should not return NaN");
+ }
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
// TODO: add math/special/log1p benchmarks
-bench( pkg+'::mathjs:log1p:value=number', opts, function benchmark( b ) {
+bench(pkg + "::mathjs:log1p:value=number", opts, function benchmark(b) {
var x;
var y;
var i;
- x = filledBy( 100, uniform( 0.0, 100.0 ) );
+ x = filledBy(100, uniform(0.0, 100.0));
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = mathjs.log1p( x[ i%x.length ] );
- if ( y !== y ) {
- b.fail( 'should not return NaN' );
+ for (i = 0; i < b.iterations; i++) {
+ y = mathjs.log1p(x[i % x.length]);
+ if (y !== y) {
+ b.fail("should not return NaN");
}
}
b.toc();
- if ( isnan( y ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(y)) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
});
diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.log2.number.js b/docs/migration-guides/mathjs/benchmark/benchmark.log2.number.js
index 1903f8213ac2..98fa0979d2e0 100644
--- a/docs/migration-guides/mathjs/benchmark/benchmark.log2.number.js
+++ b/docs/migration-guides/mathjs/benchmark/benchmark.log2.number.js
@@ -1,87 +1,89 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var filledBy = require( '@stdlib/array/filled-by' );
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
-var base = require( '@stdlib/math/base/special/log2' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var filledBy = require("@stdlib/array/filled-by");
+var uniform = require("@stdlib/random/base/uniform").factory;
+var base = require("@stdlib/math/base/special/log2");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var mathjs = tryRequire( resolve( __dirname, '..', 'node_modules', 'mathjs' ) );
+var mathjs = tryRequire(resolve(__dirname, "..", "node_modules", "mathjs"));
var opts = {
- 'skip': ( mathjs instanceof Error )
+ skip: mathjs instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:math/base/special/log2:value=number', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
+bench(
+ pkg + "::stdlib:math/base/special/log2:value=number",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
- x = filledBy( 100, uniform( 0.0, 100.0 ) );
+ x = filledBy(100, uniform(0.0, 100.0));
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = base( x[ i%x.length ] );
- if ( y !== y ) {
- b.fail( 'should not return NaN' );
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = base(x[i % x.length]);
+ if (y !== y) {
+ b.fail("should not return NaN");
+ }
}
- }
- b.toc();
- if ( isnan( y ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.toc();
+ if (isnan(y)) {
+ b.fail("should not return NaN");
+ }
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
// TODO: add math/special/log2 benchmarks
-bench( pkg+'::mathjs:log2:value=number', opts, function benchmark( b ) {
+bench(pkg + "::mathjs:log2:value=number", opts, function benchmark(b) {
var x;
var y;
var i;
- x = filledBy( 100, uniform( 0.0, 100.0 ) );
+ x = filledBy(100, uniform(0.0, 100.0));
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = mathjs.log2( x[ i%x.length ] );
- if ( y !== y ) {
- b.fail( 'should not return NaN' );
+ for (i = 0; i < b.iterations; i++) {
+ y = mathjs.log2(x[i % x.length]);
+ if (y !== y) {
+ b.fail("should not return NaN");
}
}
b.toc();
- if ( isnan( y ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(y)) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
});
diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.multiply.array.generic.js b/docs/migration-guides/mathjs/benchmark/benchmark.multiply.array.generic.js
index e58064c0a39b..dcee6d37aba2 100644
--- a/docs/migration-guides/mathjs/benchmark/benchmark.multiply.array.generic.js
+++ b/docs/migration-guides/mathjs/benchmark/benchmark.multiply.array.generic.js
@@ -1,93 +1,99 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var filledBy = require( '@stdlib/array/filled-by' );
-var zeros = require( '@stdlib/array/zeros' );
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
-var strided = require( '@stdlib/math/strided/ops/mul' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var filledBy = require("@stdlib/array/filled-by");
+var zeros = require("@stdlib/array/zeros");
+var uniform = require("@stdlib/random/base/uniform").factory;
+var strided = require("@stdlib/math/strided/ops/mul");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var mathjs = tryRequire( resolve( __dirname, '..', 'node_modules', 'mathjs' ) );
+var mathjs = tryRequire(resolve(__dirname, "..", "node_modules", "mathjs"));
var opts = {
- 'skip': ( mathjs instanceof Error )
+ skip: mathjs instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:math/strided/ops/mul:value=array,dtype=generic,len=100', opts, function benchmark( b ) {
- var x;
- var y;
- var z;
- var i;
+bench(
+ pkg + "::stdlib:math/strided/ops/mul:value=array,dtype=generic,len=100",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var z;
+ var i;
- x = filledBy( 100, 'generic', uniform( -100.0, 100.0 ) );
- y = filledBy( 100, 'generic', uniform( -100.0, 100.0 ) );
- z = zeros( x.length, 'generic' );
+ x = filledBy(100, "generic", uniform(-100.0, 100.0));
+ y = filledBy(100, "generic", uniform(-100.0, 100.0));
+ z = zeros(x.length, "generic");
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- strided( x.length, 'generic', x, 1, 'generic', y, 1, 'generic', z, 1 );
- if ( isnan( z[ 0 ] ) || isnan( z[ z.length-1 ] ) ) {
- b.fail( 'should not return NaN' );
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ strided(x.length, "generic", x, 1, "generic", y, 1, "generic", z, 1);
+ if (isnan(z[0]) || isnan(z[z.length - 1])) {
+ b.fail("should not return NaN");
+ }
}
- }
- b.toc();
- if ( isnan( z[ 0 ] ) || isnan( z[ z.length-1 ] ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.toc();
+ if (isnan(z[0]) || isnan(z[z.length - 1])) {
+ b.fail("should not return NaN");
+ }
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
// TODO: add math/ops/mul benchmarks
-bench( pkg+'::mathjs:dotMultiply:value=array,dtype=generic,len=100', opts, function benchmark( b ) {
- var x;
- var y;
- var z;
- var i;
+bench(
+ pkg + "::mathjs:dotMultiply:value=array,dtype=generic,len=100",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var z;
+ var i;
- x = filledBy( 100, 'generic', uniform( -100.0, 100.0 ) );
- y = filledBy( 100, 'generic', uniform( -100.0, 100.0 ) );
+ x = filledBy(100, "generic", uniform(-100.0, 100.0));
+ y = filledBy(100, "generic", uniform(-100.0, 100.0));
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- z = mathjs.dotMultiply( x, y );
- if ( isnan( z[ 0 ] ) || isnan( z[ z.length-1 ] ) ) {
- b.fail( 'should not return NaN' );
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ z = mathjs.dotMultiply(x, y);
+ if (isnan(z[0]) || isnan(z[z.length - 1])) {
+ b.fail("should not return NaN");
+ }
+ }
+ b.toc();
+ if (isnan(z[0]) || isnan(z[z.length - 1])) {
+ b.fail("should not return NaN");
}
- }
- b.toc();
- if ( isnan( z[ 0 ] ) || isnan( z[ z.length-1 ] ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.multiply.complex_number.js b/docs/migration-guides/mathjs/benchmark/benchmark.multiply.complex_number.js
index a5695f6640a1..b80aaf85bde7 100644
--- a/docs/migration-guides/mathjs/benchmark/benchmark.multiply.complex_number.js
+++ b/docs/migration-guides/mathjs/benchmark/benchmark.multiply.complex_number.js
@@ -1,104 +1,110 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var Complex128 = require( '@stdlib/complex/float64/ctor' );
-var real = require( '@stdlib/complex/float64/real' );
-var imag = require( '@stdlib/complex/float64/imag' );
-var base = require( '@stdlib/complex/float64/base/mul' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var Complex128 = require("@stdlib/complex/float64/ctor");
+var real = require("@stdlib/complex/float64/real");
+var imag = require("@stdlib/complex/float64/imag");
+var base = require("@stdlib/complex/float64/base/mul");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var mathjs = tryRequire( resolve( __dirname, '..', 'node_modules', 'mathjs' ) );
+var mathjs = tryRequire(resolve(__dirname, "..", "node_modules", "mathjs"));
var opts = {
- 'skip': ( mathjs instanceof Error )
+ skip: mathjs instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:math/base/special/cmul:value=complex_number', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
- var j;
+bench(
+ pkg + "::stdlib:math/base/special/cmul:value=complex_number",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
+ var j;
- x = [
- new Complex128( 5.0, 3.0 ),
- new Complex128( -5.0, 3.0 ),
- new Complex128( 5.0, -3.0 ),
- new Complex128( -5.0, -3.0 ),
- new Complex128( 3.0, -4.0 )
- ];
+ x = [
+ new Complex128(5.0, 3.0),
+ new Complex128(-5.0, 3.0),
+ new Complex128(5.0, -3.0),
+ new Complex128(-5.0, -3.0),
+ new Complex128(3.0, -4.0),
+ ];
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- j = i % x.length;
- y = base( x[ j ], x[ j ] );
- if ( typeof y !== 'object' ) {
- b.fail( 'should return an object' );
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ j = i % x.length;
+ y = base(x[j], x[j]);
+ if (typeof y !== "object") {
+ b.fail("should return an object");
+ }
}
- }
- b.toc();
- if ( isnan( real( y ) ) || isnan( imag( y ) ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.toc();
+ if (isnan(real(y)) || isnan(imag(y))) {
+ b.fail("should not return NaN");
+ }
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
// TODO: add math/special/mul benchmarks
-bench( pkg+'::mathjs:multiply:value=complex_number', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
- var j;
+bench(
+ pkg + "::mathjs:multiply:value=complex_number",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
+ var j;
- x = [
- mathjs.complex( 5.0, 3.0 ),
- mathjs.complex( -5.0, 3.0 ),
- mathjs.complex( 5.0, -3.0 ),
- mathjs.complex( -5.0, -3.0 ),
- mathjs.complex( 3.0, -4.0 )
- ];
+ x = [
+ mathjs.complex(5.0, 3.0),
+ mathjs.complex(-5.0, 3.0),
+ mathjs.complex(5.0, -3.0),
+ mathjs.complex(-5.0, -3.0),
+ mathjs.complex(3.0, -4.0),
+ ];
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- j = i % x.length;
- y = mathjs.multiply( x[ j ], x[ j ] );
- if ( typeof y !== 'object' ) {
- b.fail( 'should return an object' );
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ j = i % x.length;
+ y = mathjs.multiply(x[j], x[j]);
+ if (typeof y !== "object") {
+ b.fail("should return an object");
+ }
+ }
+ b.toc();
+ if (isnan(mathjs.re(y)) || isnan(mathjs.im(y))) {
+ b.fail("should not return NaN");
}
- }
- b.toc();
- if ( isnan( mathjs.re( y ) ) || isnan( mathjs.im( y ) ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.multiply.number.js b/docs/migration-guides/mathjs/benchmark/benchmark.multiply.number.js
index dcd4cedb3944..ed48a14e8f92 100644
--- a/docs/migration-guides/mathjs/benchmark/benchmark.multiply.number.js
+++ b/docs/migration-guides/mathjs/benchmark/benchmark.multiply.number.js
@@ -1,95 +1,97 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var filledBy = require( '@stdlib/array/filled-by' );
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
-var base = require( '@stdlib/number/float64/base/mul' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var filledBy = require("@stdlib/array/filled-by");
+var uniform = require("@stdlib/random/base/uniform").factory;
+var base = require("@stdlib/number/float64/base/mul");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var mathjs = tryRequire( resolve( __dirname, '..', 'node_modules', 'mathjs' ) );
+var mathjs = tryRequire(resolve(__dirname, "..", "node_modules", "mathjs"));
var opts = {
- 'skip': ( mathjs instanceof Error )
+ skip: mathjs instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:number/float64/base/mul:value=number', opts, function benchmark( b ) {
- var x;
- var y;
- var z;
- var i;
- var j;
+bench(
+ pkg + "::stdlib:number/float64/base/mul:value=number",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var z;
+ var i;
+ var j;
- x = filledBy( 100, uniform( -100.0, 100.0 ) );
- y = filledBy( 100, uniform( -100.0, 100.0 ) );
+ x = filledBy(100, uniform(-100.0, 100.0));
+ y = filledBy(100, uniform(-100.0, 100.0));
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- j = i % x.length;
- z = base( x[ j ], y[ j ] );
- if ( z !== z ) {
- b.fail( 'should not return NaN' );
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ j = i % x.length;
+ z = base(x[j], y[j]);
+ if (z !== z) {
+ b.fail("should not return NaN");
+ }
}
- }
- b.toc();
- if ( isnan( z ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.toc();
+ if (isnan(z)) {
+ b.fail("should not return NaN");
+ }
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
// TODO: add math/ops/mul benchmarks
-bench( pkg+'::mathjs:multiply:value=number', opts, function benchmark( b ) {
+bench(pkg + "::mathjs:multiply:value=number", opts, function benchmark(b) {
var x;
var y;
var z;
var i;
var j;
- x = filledBy( 100, uniform( -100.0, 100.0 ) );
- y = filledBy( 100, uniform( -100.0, 100.0 ) );
+ x = filledBy(100, uniform(-100.0, 100.0));
+ y = filledBy(100, uniform(-100.0, 100.0));
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
+ for (i = 0; i < b.iterations; i++) {
j = i % x.length;
- z = mathjs.multiply( x[ j ], y[ j ] );
- if ( z !== z ) {
- b.fail( 'should not return NaN' );
+ z = mathjs.multiply(x[j], y[j]);
+ if (z !== z) {
+ b.fail("should not return NaN");
}
}
b.toc();
- if ( isnan( z ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(z)) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
});
diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.sqrt.number.js b/docs/migration-guides/mathjs/benchmark/benchmark.sqrt.number.js
index a3d8b7f22830..bec341c2ee6f 100644
--- a/docs/migration-guides/mathjs/benchmark/benchmark.sqrt.number.js
+++ b/docs/migration-guides/mathjs/benchmark/benchmark.sqrt.number.js
@@ -1,87 +1,89 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var filledBy = require( '@stdlib/array/filled-by' );
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
-var base = require( '@stdlib/math/base/special/sqrt' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var filledBy = require("@stdlib/array/filled-by");
+var uniform = require("@stdlib/random/base/uniform").factory;
+var base = require("@stdlib/math/base/special/sqrt");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var mathjs = tryRequire( resolve( __dirname, '..', 'node_modules', 'mathjs' ) );
+var mathjs = tryRequire(resolve(__dirname, "..", "node_modules", "mathjs"));
var opts = {
- 'skip': ( mathjs instanceof Error )
+ skip: mathjs instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:math/base/special/sqrt:value=number', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
+bench(
+ pkg + "::stdlib:math/base/special/sqrt:value=number",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
- x = filledBy( 100, uniform( 0.0, 100.0 ) );
+ x = filledBy(100, uniform(0.0, 100.0));
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = base( x[ i%x.length ] );
- if ( y !== y ) {
- b.fail( 'should not return NaN' );
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = base(x[i % x.length]);
+ if (y !== y) {
+ b.fail("should not return NaN");
+ }
}
- }
- b.toc();
- if ( isnan( y ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.toc();
+ if (isnan(y)) {
+ b.fail("should not return NaN");
+ }
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
// TODO: add math/special/sqrt benchmarks
-bench( pkg+'::mathjs:sqrt:value=number', opts, function benchmark( b ) {
+bench(pkg + "::mathjs:sqrt:value=number", opts, function benchmark(b) {
var x;
var y;
var i;
- x = filledBy( 100, uniform( 0.0, 100.0 ) );
+ x = filledBy(100, uniform(0.0, 100.0));
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = mathjs.sqrt( x[ i%x.length ] );
- if ( y !== y ) {
- b.fail( 'should not return NaN' );
+ for (i = 0; i < b.iterations; i++) {
+ y = mathjs.sqrt(x[i % x.length]);
+ if (y !== y) {
+ b.fail("should not return NaN");
}
}
b.toc();
- if ( isnan( y ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(y)) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
});
diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.square.array.float64.js b/docs/migration-guides/mathjs/benchmark/benchmark.square.array.float64.js
index 9a3ce9f8a90a..2af653adcd09 100644
--- a/docs/migration-guides/mathjs/benchmark/benchmark.square.array.float64.js
+++ b/docs/migration-guides/mathjs/benchmark/benchmark.square.array.float64.js
@@ -1,117 +1,127 @@
/**
-* @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';
+ * @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 resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var filledBy = require( '@stdlib/array/filled-by' );
-var zeros = require( '@stdlib/array/zeros' );
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
-var strided = require( '@stdlib/math/strided/special/abs2' );
-var dabs2 = require( '@stdlib/math/strided/special/dabs2' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var filledBy = require("@stdlib/array/filled-by");
+var zeros = require("@stdlib/array/zeros");
+var uniform = require("@stdlib/random/base/uniform").factory;
+var strided = require("@stdlib/math/strided/special/abs2");
+var dabs2 = require("@stdlib/math/strided/special/dabs2");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var mathjs = tryRequire( resolve( __dirname, '..', 'node_modules', 'mathjs' ) );
+var mathjs = tryRequire(resolve(__dirname, "..", "node_modules", "mathjs"));
var opts = {
- 'skip': ( mathjs instanceof Error )
+ skip: mathjs instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:math/strided/special/abs2:value=array,dtype=float64,len=100', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
-
- x = filledBy( 100, 'float64', uniform( -100.0, 100.0 ) );
- y = zeros( x.length, 'float64' );
-
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- strided( x.length, 'float64', x, 1, 'float64', y, 1 );
- if ( isnan( y[ 0 ] ) || isnan( y[ y.length-1 ] ) ) {
- b.fail( 'should not return NaN' );
+bench(
+ pkg + "::stdlib:math/strided/special/abs2:value=array,dtype=float64,len=100",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
+
+ x = filledBy(100, "float64", uniform(-100.0, 100.0));
+ y = zeros(x.length, "float64");
+
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ strided(x.length, "float64", x, 1, "float64", y, 1);
+ if (isnan(y[0]) || isnan(y[y.length - 1])) {
+ b.fail("should not return NaN");
+ }
}
- }
- b.toc();
- if ( isnan( y[ 0 ] ) || isnan( y[ y.length-1 ] ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
-
-bench( pkg+'::stdlib:math/strided/special/dabs2:value=array,dtype=float64,len=100', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
-
- x = filledBy( 100, 'float64', uniform( -100.0, 100.0 ) );
- y = zeros( x.length, 'float64' );
-
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- dabs2( x.length, x, 1, y, 1 );
- if ( isnan( y[ 0 ] ) || isnan( y[ y.length-1 ] ) ) {
- b.fail( 'should not return NaN' );
+ b.toc();
+ if (isnan(y[0]) || isnan(y[y.length - 1])) {
+ b.fail("should not return NaN");
}
- }
- b.toc();
- if ( isnan( y[ 0 ] ) || isnan( y[ y.length-1 ] ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
+
+bench(
+ pkg + "::stdlib:math/strided/special/dabs2:value=array,dtype=float64,len=100",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
+
+ x = filledBy(100, "float64", uniform(-100.0, 100.0));
+ y = zeros(x.length, "float64");
+
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ dabs2(x.length, x, 1, y, 1);
+ if (isnan(y[0]) || isnan(y[y.length - 1])) {
+ b.fail("should not return NaN");
+ }
+ }
+ b.toc();
+ if (isnan(y[0]) || isnan(y[y.length - 1])) {
+ b.fail("should not return NaN");
+ }
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
// TODO: add math/special/abs2 benchmarks
// NOTE: Math.js does not seem to accept typed arrays for element-wise functions
opts = {
- 'skip': true
+ skip: true,
};
-bench( pkg+'::mathjs:square:value=array,dtype=float64,len=100', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
-
- x = filledBy( 100, 'float64', uniform( -100.0, 100.0 ) );
-
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = mathjs.square( x );
- if ( isnan( y[ 0 ] ) || isnan( y[ y.length-1 ] ) ) {
- b.fail( 'should not return NaN' );
+bench(
+ pkg + "::mathjs:square:value=array,dtype=float64,len=100",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
+
+ x = filledBy(100, "float64", uniform(-100.0, 100.0));
+
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = mathjs.square(x);
+ if (isnan(y[0]) || isnan(y[y.length - 1])) {
+ b.fail("should not return NaN");
+ }
+ }
+ b.toc();
+ if (isnan(y[0]) || isnan(y[y.length - 1])) {
+ b.fail("should not return NaN");
}
- }
- b.toc();
- if ( isnan( y[ 0 ] ) || isnan( y[ y.length-1 ] ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.square.array.generic.js b/docs/migration-guides/mathjs/benchmark/benchmark.square.array.generic.js
index 548c21e2ed23..c7cff6f5727c 100644
--- a/docs/migration-guides/mathjs/benchmark/benchmark.square.array.generic.js
+++ b/docs/migration-guides/mathjs/benchmark/benchmark.square.array.generic.js
@@ -1,93 +1,99 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var filledBy = require( '@stdlib/array/filled-by' );
-var zeros = require( '@stdlib/array/zeros' );
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
-var strided = require( '@stdlib/math/strided/special/abs2' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var filledBy = require("@stdlib/array/filled-by");
+var zeros = require("@stdlib/array/zeros");
+var uniform = require("@stdlib/random/base/uniform").factory;
+var strided = require("@stdlib/math/strided/special/abs2");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var mathjs = tryRequire( resolve( __dirname, '..', 'node_modules', 'mathjs' ) );
+var mathjs = tryRequire(resolve(__dirname, "..", "node_modules", "mathjs"));
var opts = {
- 'skip': ( mathjs instanceof Error )
+ skip: mathjs instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:math/strided/special/abs2:value=array,dtype=generic,len=100', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
+bench(
+ pkg + "::stdlib:math/strided/special/abs2:value=array,dtype=generic,len=100",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
- x = filledBy( 100, 'generic', uniform( -100.0, 100.0 ) );
- y = zeros( x.length, 'generic' );
+ x = filledBy(100, "generic", uniform(-100.0, 100.0));
+ y = zeros(x.length, "generic");
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- strided( x.length, 'generic', x, 1, 'generic', y, 1 );
- if ( isnan( y[ 0 ] ) || isnan( y[ y.length-1 ] ) ) {
- b.fail( 'should not return NaN' );
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ strided(x.length, "generic", x, 1, "generic", y, 1);
+ if (isnan(y[0]) || isnan(y[y.length - 1])) {
+ b.fail("should not return NaN");
+ }
}
- }
- b.toc();
- if ( isnan( y[ 0 ] ) || isnan( y[ y.length-1 ] ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.toc();
+ if (isnan(y[0]) || isnan(y[y.length - 1])) {
+ b.fail("should not return NaN");
+ }
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
// TODO: add math/special/abs2 benchmarks
// NOTE: mathjs doesn't support arrays in `square`
opts = {
- 'skip': true
+ skip: true,
};
-bench( pkg+'::mathjs:square:value=array,dtype=generic,len=100', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
+bench(
+ pkg + "::mathjs:square:value=array,dtype=generic,len=100",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
- x = filledBy( 100, 'generic', uniform( -100.0, 100.0 ) );
+ x = filledBy(100, "generic", uniform(-100.0, 100.0));
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = mathjs.square( x );
- if ( isnan( y[ 0 ] ) || isnan( y[ y.length-1 ] ) ) {
- b.fail( 'should not return NaN' );
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = mathjs.square(x);
+ if (isnan(y[0]) || isnan(y[y.length - 1])) {
+ b.fail("should not return NaN");
+ }
+ }
+ b.toc();
+ if (isnan(y[0]) || isnan(y[y.length - 1])) {
+ b.fail("should not return NaN");
}
- }
- b.toc();
- if ( isnan( y[ 0 ] ) || isnan( y[ y.length-1 ] ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.square.complex_number.js b/docs/migration-guides/mathjs/benchmark/benchmark.square.complex_number.js
index fc1ba64084bf..68b423cd9d6b 100644
--- a/docs/migration-guides/mathjs/benchmark/benchmark.square.complex_number.js
+++ b/docs/migration-guides/mathjs/benchmark/benchmark.square.complex_number.js
@@ -1,98 +1,104 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var Complex128 = require( '@stdlib/complex/float64/ctor' );
-var base = require( '@stdlib/math/base/special/cabs2' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var Complex128 = require("@stdlib/complex/float64/ctor");
+var base = require("@stdlib/math/base/special/cabs2");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var mathjs = tryRequire( resolve( __dirname, '..', 'node_modules', 'mathjs' ) );
+var mathjs = tryRequire(resolve(__dirname, "..", "node_modules", "mathjs"));
var opts = {
- 'skip': ( mathjs instanceof Error )
+ skip: mathjs instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:math/base/special/cabs2:value=complex_number', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
+bench(
+ pkg + "::stdlib:math/base/special/cabs2:value=complex_number",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
- x = [
- new Complex128( 5.0, 3.0 ),
- new Complex128( -5.0, 3.0 ),
- new Complex128( 5.0, -3.0 ),
- new Complex128( -5.0, -3.0 ),
- new Complex128( 3.0, -4.0 )
- ];
+ x = [
+ new Complex128(5.0, 3.0),
+ new Complex128(-5.0, 3.0),
+ new Complex128(5.0, -3.0),
+ new Complex128(-5.0, -3.0),
+ new Complex128(3.0, -4.0),
+ ];
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = base( x[ i%x.length ] );
- if ( y !== y ) {
- b.fail( 'should not return NaN' );
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = base(x[i % x.length]);
+ if (y !== y) {
+ b.fail("should not return NaN");
+ }
}
- }
- b.toc();
- if ( isnan( y ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.toc();
+ if (isnan(y)) {
+ b.fail("should not return NaN");
+ }
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
// TODO: add math/special/abs2 benchmarks
-bench( pkg+'::mathjs:square:value=complex_number', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
+bench(
+ pkg + "::mathjs:square:value=complex_number",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
- x = [
- mathjs.complex( 5.0, 3.0 ),
- mathjs.complex( -5.0, 3.0 ),
- mathjs.complex( 5.0, -3.0 ),
- mathjs.complex( -5.0, -3.0 ),
- mathjs.complex( 3.0, -4.0 )
- ];
+ x = [
+ mathjs.complex(5.0, 3.0),
+ mathjs.complex(-5.0, 3.0),
+ mathjs.complex(5.0, -3.0),
+ mathjs.complex(-5.0, -3.0),
+ mathjs.complex(3.0, -4.0),
+ ];
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = mathjs.square( x[ i%x.length ] );
- if ( y !== y ) {
- b.fail( 'should not return NaN' );
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = mathjs.square(x[i % x.length]);
+ if (y !== y) {
+ b.fail("should not return NaN");
+ }
+ }
+ b.toc();
+ if (isnan(y)) {
+ b.fail("should not return NaN");
}
- }
- b.toc();
- if ( isnan( y ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.square.number.js b/docs/migration-guides/mathjs/benchmark/benchmark.square.number.js
index a385e47288bf..f244e7f20ee1 100644
--- a/docs/migration-guides/mathjs/benchmark/benchmark.square.number.js
+++ b/docs/migration-guides/mathjs/benchmark/benchmark.square.number.js
@@ -1,87 +1,89 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var filledBy = require( '@stdlib/array/filled-by' );
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
-var base = require( '@stdlib/math/base/special/abs2' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var filledBy = require("@stdlib/array/filled-by");
+var uniform = require("@stdlib/random/base/uniform").factory;
+var base = require("@stdlib/math/base/special/abs2");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var mathjs = tryRequire( resolve( __dirname, '..', 'node_modules', 'mathjs' ) );
+var mathjs = tryRequire(resolve(__dirname, "..", "node_modules", "mathjs"));
var opts = {
- 'skip': ( mathjs instanceof Error )
+ skip: mathjs instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:math/base/special/abs2:value=number', opts, function benchmark( b ) {
- var x;
- var y;
- var i;
+bench(
+ pkg + "::stdlib:math/base/special/abs2:value=number",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var i;
- x = filledBy( 100, uniform( 0.0, 100.0 ) );
+ x = filledBy(100, uniform(0.0, 100.0));
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = base( x[ i%x.length ] );
- if ( y !== y ) {
- b.fail( 'should not return NaN' );
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ y = base(x[i % x.length]);
+ if (y !== y) {
+ b.fail("should not return NaN");
+ }
}
- }
- b.toc();
- if ( isnan( y ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.toc();
+ if (isnan(y)) {
+ b.fail("should not return NaN");
+ }
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
// TODO: add math/special/abs2 benchmarks
-bench( pkg+'::mathjs:square:value=number', opts, function benchmark( b ) {
+bench(pkg + "::mathjs:square:value=number", opts, function benchmark(b) {
var x;
var y;
var i;
- x = filledBy( 100, uniform( 0.0, 100.0 ) );
+ x = filledBy(100, uniform(0.0, 100.0));
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- y = mathjs.square( x[ i%x.length ] );
- if ( y !== y ) {
- b.fail( 'should not return NaN' );
+ for (i = 0; i < b.iterations; i++) {
+ y = mathjs.square(x[i % x.length]);
+ if (y !== y) {
+ b.fail("should not return NaN");
}
}
b.toc();
- if ( isnan( y ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(y)) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
});
diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.subtract.js b/docs/migration-guides/mathjs/benchmark/benchmark.subtract.js
index 24512a323219..fbe4e8f0d815 100644
--- a/docs/migration-guides/mathjs/benchmark/benchmark.subtract.js
+++ b/docs/migration-guides/mathjs/benchmark/benchmark.subtract.js
@@ -1,95 +1,97 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var filledBy = require( '@stdlib/array/filled-by' );
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
-var base = require( '@stdlib/number/float64/base/sub' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var isnan = require("@stdlib/math/base/assert/is-nan");
+var filledBy = require("@stdlib/array/filled-by");
+var uniform = require("@stdlib/random/base/uniform").factory;
+var base = require("@stdlib/number/float64/base/sub");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var mathjs = tryRequire( resolve( __dirname, '..', 'node_modules', 'mathjs' ) );
+var mathjs = tryRequire(resolve(__dirname, "..", "node_modules", "mathjs"));
var opts = {
- 'skip': ( mathjs instanceof Error )
+ skip: mathjs instanceof Error,
};
-
// MAIN //
-bench( pkg+'::stdlib:number/float64/base/sub:value=number', opts, function benchmark( b ) {
- var x;
- var y;
- var z;
- var i;
- var j;
+bench(
+ pkg + "::stdlib:number/float64/base/sub:value=number",
+ opts,
+ function benchmark(b) {
+ var x;
+ var y;
+ var z;
+ var i;
+ var j;
- x = filledBy( 100, uniform( -100.0, 100.0 ) );
- y = filledBy( 100, uniform( -100.0, 100.0 ) );
+ x = filledBy(100, uniform(-100.0, 100.0));
+ y = filledBy(100, uniform(-100.0, 100.0));
- b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- j = i % x.length;
- z = base( x[ j ], y[ j ] );
- if ( z !== z ) {
- b.fail( 'should not return NaN' );
+ b.tic();
+ for (i = 0; i < b.iterations; i++) {
+ j = i % x.length;
+ z = base(x[j], y[j]);
+ if (z !== z) {
+ b.fail("should not return NaN");
+ }
}
- }
- b.toc();
- if ( isnan( z ) ) {
- b.fail( 'should not return NaN' );
- }
- b.pass( 'benchmark finished' );
- b.end();
-});
+ b.toc();
+ if (isnan(z)) {
+ b.fail("should not return NaN");
+ }
+ b.pass("benchmark finished");
+ b.end();
+ },
+);
// TODO: add math/ops/sub benchmarks
-bench( pkg+'::mathjs:subtract:value=number', opts, function benchmark( b ) {
+bench(pkg + "::mathjs:subtract:value=number", opts, function benchmark(b) {
var x;
var y;
var z;
var i;
var j;
- x = filledBy( 100, uniform( -100.0, 100.0 ) );
- y = filledBy( 100, uniform( -100.0, 100.0 ) );
+ x = filledBy(100, uniform(-100.0, 100.0));
+ y = filledBy(100, uniform(-100.0, 100.0));
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
+ for (i = 0; i < b.iterations; i++) {
j = i % x.length;
- z = mathjs.subtract( x[ j ], y[ j ] );
- if ( z !== z ) {
- b.fail( 'should not return NaN' );
+ z = mathjs.subtract(x[j], y[j]);
+ if (z !== z) {
+ b.fail("should not return NaN");
}
}
b.toc();
- if ( isnan( z ) ) {
- b.fail( 'should not return NaN' );
+ if (isnan(z)) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
});
diff --git a/docs/migration-guides/scijs/benchmark/benchmark.gemm.square_matrices.js b/docs/migration-guides/scijs/benchmark/benchmark.gemm.square_matrices.js
index 1556f5371d9d..c90350890dfb 100644
--- a/docs/migration-guides/scijs/benchmark/benchmark.gemm.square_matrices.js
+++ b/docs/migration-guides/scijs/benchmark/benchmark.gemm.square_matrices.js
@@ -1,68 +1,68 @@
/**
-* @license Apache-2.0
-*
-* Copyright (c) 2024 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.
-*/
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2024 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.
+ */
/* eslint-disable max-len */
-'use strict';
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
-var pow = require( '@stdlib/math/base/special/pow' );
-var floor = require( '@stdlib/math/base/special/floor' );
-var numel = require( '@stdlib/ndarray/base/numel' );
-var shape2strides = require( '@stdlib/ndarray/base/shape2strides' );
-var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
-var format = require( '@stdlib/string/format' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var dgemm = require( '@stdlib/blas/base/dgemm' ).ndarray;
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var discreteUniform = require("@stdlib/random/array/discrete-uniform");
+var pow = require("@stdlib/math/base/special/pow");
+var floor = require("@stdlib/math/base/special/floor");
+var numel = require("@stdlib/ndarray/base/numel");
+var shape2strides = require("@stdlib/ndarray/base/shape2strides");
+var isnanf = require("@stdlib/math/base/assert/is-nanf");
+var format = require("@stdlib/string/format");
+var tryRequire = require("@stdlib/utils/try-require");
+var dgemm = require("@stdlib/blas/base/dgemm").ndarray;
+var pkg = require("./../package.json").name;
// VARIABLES //
-var ndarray = tryRequire( resolve( __dirname, '..', 'node_modules', 'ndarray' ) );
-var ndgemm = tryRequire( resolve( __dirname, '..', 'node_modules', 'ndarray-gemm' ) );
+var ndarray = tryRequire(resolve(__dirname, "..", "node_modules", "ndarray"));
+var ndgemm = tryRequire(
+ resolve(__dirname, "..", "node_modules", "ndarray-gemm"),
+);
var opts = {
- 'skip': ( ndarray instanceof Error || ndgemm instanceof Error )
+ skip: ndarray instanceof Error || ndgemm instanceof Error,
};
var OPTS = {
- 'dtype': 'float64'
+ dtype: "float64",
};
-
// FUNCTIONS //
/**
-* Creates a benchmark function.
-*
-* @private
-* @param {PositiveIntegerArray} shapeA - shape of the first array
-* @param {string} orderA - memory layout of the first array
-* @param {PositiveIntegerArray} shapeB - shape of the second array
-* @param {string} orderB - memory layout of the second array
-* @param {PositiveIntegerArray} shapeC - shape of the third array
-* @param {string} orderC - memory layout of the third array
-* @returns {Function} benchmark function
-*/
-function createBenchmark1( shapeA, orderA, shapeB, orderB, shapeC, orderC ) {
+ * Creates a benchmark function.
+ *
+ * @private
+ * @param {PositiveIntegerArray} shapeA - shape of the first array
+ * @param {string} orderA - memory layout of the first array
+ * @param {PositiveIntegerArray} shapeB - shape of the second array
+ * @param {string} orderB - memory layout of the second array
+ * @param {PositiveIntegerArray} shapeC - shape of the third array
+ * @param {string} orderC - memory layout of the third array
+ * @returns {Function} benchmark function
+ */
+function createBenchmark1(shapeA, orderA, shapeB, orderB, shapeC, orderC) {
var sa;
var sb;
var sc;
@@ -70,54 +70,74 @@ function createBenchmark1( shapeA, orderA, shapeB, orderB, shapeC, orderC ) {
var B;
var C;
- A = discreteUniform( numel( shapeA ), 0, 10, OPTS );
- B = discreteUniform( numel( shapeB ), 0, 10, OPTS );
- C = discreteUniform( numel( shapeC ), 0, 10, OPTS );
+ A = discreteUniform(numel(shapeA), 0, 10, OPTS);
+ B = discreteUniform(numel(shapeB), 0, 10, OPTS);
+ C = discreteUniform(numel(shapeC), 0, 10, OPTS);
- sa = shape2strides( shapeA, orderA );
- sb = shape2strides( shapeB, orderB );
- sc = shape2strides( shapeC, orderC );
+ sa = shape2strides(shapeA, orderA);
+ sb = shape2strides(shapeB, orderB);
+ sc = shape2strides(shapeC, orderC);
return benchmark;
/**
- * Benchmark function.
- *
- * @private
- * @param {Benchmark} b - benchmark instance
- */
- function benchmark( b ) {
+ * Benchmark function.
+ *
+ * @private
+ * @param {Benchmark} b - benchmark instance
+ */
+ function benchmark(b) {
var i;
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- dgemm( 'no-transpose', 'no-transpose', shapeA[0], shapeC[1], shapeB[0], 0.5, A, sa[0], sa[1], 0, B, sb[0], sb[1], 0, 2.0, C, sc[0], sc[1], 0 );
- if ( isnanf( C[ i%C.length ] ) ) {
- b.fail( 'should not return NaN' );
+ for (i = 0; i < b.iterations; i++) {
+ dgemm(
+ "no-transpose",
+ "no-transpose",
+ shapeA[0],
+ shapeC[1],
+ shapeB[0],
+ 0.5,
+ A,
+ sa[0],
+ sa[1],
+ 0,
+ B,
+ sb[0],
+ sb[1],
+ 0,
+ 2.0,
+ C,
+ sc[0],
+ sc[1],
+ 0,
+ );
+ if (isnanf(C[i % C.length])) {
+ b.fail("should not return NaN");
}
}
b.toc();
- if ( isnanf( C[ i%C.length ] ) ) {
- b.fail( 'should not return NaN' );
+ if (isnanf(C[i % C.length])) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
}
}
/**
-* Creates a benchmark function.
-*
-* @private
-* @param {PositiveIntegerArray} shapeA - shape of the first array
-* @param {string} orderA - memory layout of the first array
-* @param {PositiveIntegerArray} shapeB - shape of the second array
-* @param {string} orderB - memory layout of the second array
-* @param {PositiveIntegerArray} shapeC - shape of the third array
-* @param {string} orderC - memory layout of the third array
-* @returns {Function} benchmark function
-*/
-function createBenchmark2( shapeA, orderA, shapeB, orderB, shapeC, orderC ) {
+ * Creates a benchmark function.
+ *
+ * @private
+ * @param {PositiveIntegerArray} shapeA - shape of the first array
+ * @param {string} orderA - memory layout of the first array
+ * @param {PositiveIntegerArray} shapeB - shape of the second array
+ * @param {string} orderB - memory layout of the second array
+ * @param {PositiveIntegerArray} shapeC - shape of the third array
+ * @param {string} orderC - memory layout of the third array
+ * @returns {Function} benchmark function
+ */
+function createBenchmark2(shapeA, orderA, shapeB, orderB, shapeC, orderC) {
var abuf;
var bbuf;
var cbuf;
@@ -128,53 +148,52 @@ function createBenchmark2( shapeA, orderA, shapeB, orderB, shapeC, orderC ) {
var B;
var C;
- abuf = discreteUniform( numel( shapeA ), 0, 10, OPTS );
- bbuf = discreteUniform( numel( shapeB ), 0, 10, OPTS );
- cbuf = discreteUniform( numel( shapeC ), 0, 10, OPTS );
+ abuf = discreteUniform(numel(shapeA), 0, 10, OPTS);
+ bbuf = discreteUniform(numel(shapeB), 0, 10, OPTS);
+ cbuf = discreteUniform(numel(shapeC), 0, 10, OPTS);
- sa = shape2strides( shapeA, orderA );
- sb = shape2strides( shapeB, orderB );
- sc = shape2strides( shapeC, orderC );
+ sa = shape2strides(shapeA, orderA);
+ sb = shape2strides(shapeB, orderB);
+ sc = shape2strides(shapeC, orderC);
- A = ndarray( abuf, shapeA, sa, 0 );
- B = ndarray( bbuf, shapeB, sb, 0 );
- C = ndarray( cbuf, shapeC, sc, 0 );
+ A = ndarray(abuf, shapeA, sa, 0);
+ B = ndarray(bbuf, shapeB, sb, 0);
+ C = ndarray(cbuf, shapeC, sc, 0);
return benchmark;
/**
- * Benchmark function.
- *
- * @private
- * @param {Benchmark} b - benchmark instance
- */
- function benchmark( b ) {
+ * Benchmark function.
+ *
+ * @private
+ * @param {Benchmark} b - benchmark instance
+ */
+ function benchmark(b) {
var i;
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- ndgemm( C, A, B, 0.5, 2.0 );
- if ( isnanf( cbuf[ i%cbuf.length ] ) ) {
- b.fail( 'should not return NaN' );
+ for (i = 0; i < b.iterations; i++) {
+ ndgemm(C, A, B, 0.5, 2.0);
+ if (isnanf(cbuf[i % cbuf.length])) {
+ b.fail("should not return NaN");
}
}
b.toc();
- if ( isnanf( cbuf[ i%cbuf.length ] ) ) {
- b.fail( 'should not return NaN' );
+ if (isnanf(cbuf[i % cbuf.length])) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
}
}
-
// MAIN //
/**
-* Main execution sequence.
-*
-* @private
-*/
+ * Main execution sequence.
+ *
+ * @private
+ */
function main() {
var shapes;
var orders;
@@ -187,34 +206,104 @@ function main() {
min = 1; // 10^min
max = 5; // 10^max
- for ( i = min; i <= max; i++ ) {
- N = floor( pow( pow( 10, i ), 1.0/2.0 ) );
+ for (i = min; i <= max; i++) {
+ N = floor(pow(pow(10, i), 1.0 / 2.0));
shapes = [
- [ N, N ],
- [ N, N ],
- [ N, N ]
+ [N, N],
+ [N, N],
+ [N, N],
];
- orders = [
- 'row-major',
- 'row-major',
- 'row-major'
- ];
- f = createBenchmark1( shapes[0], orders[0], shapes[1], orders[1], shapes[2], orders[2] );
- bench( format( '%s::stdlib:blas/base/dgemm:dtype=%s,orders=(%s),size=%d,shapes={(%s),(%s),(%s)}', pkg, OPTS.dtype, orders.join( ',' ), numel( shapes[2] ), shapes[0].join( ',' ), shapes[1].join( ',' ), shapes[2].join( ',' ) ), f );
+ orders = ["row-major", "row-major", "row-major"];
+ f = createBenchmark1(
+ shapes[0],
+ orders[0],
+ shapes[1],
+ orders[1],
+ shapes[2],
+ orders[2],
+ );
+ bench(
+ format(
+ "%s::stdlib:blas/base/dgemm:dtype=%s,orders=(%s),size=%d,shapes={(%s),(%s),(%s)}",
+ pkg,
+ OPTS.dtype,
+ orders.join(","),
+ numel(shapes[2]),
+ shapes[0].join(","),
+ shapes[1].join(","),
+ shapes[2].join(","),
+ ),
+ f,
+ );
- f = createBenchmark2( shapes[0], orders[0], shapes[1], orders[1], shapes[2], orders[2] );
- bench( format( '%s::scijs:ndarray-gemm:dtype=%s,orders=(%s),size=%d,shapes={(%s),(%s),(%s)}', pkg, OPTS.dtype, orders.join( ',' ), numel( shapes[2] ), shapes[0].join( ',' ), shapes[1].join( ',' ), shapes[2].join( ',' ) ), opts, f );
+ f = createBenchmark2(
+ shapes[0],
+ orders[0],
+ shapes[1],
+ orders[1],
+ shapes[2],
+ orders[2],
+ );
+ bench(
+ format(
+ "%s::scijs:ndarray-gemm:dtype=%s,orders=(%s),size=%d,shapes={(%s),(%s),(%s)}",
+ pkg,
+ OPTS.dtype,
+ orders.join(","),
+ numel(shapes[2]),
+ shapes[0].join(","),
+ shapes[1].join(","),
+ shapes[2].join(","),
+ ),
+ opts,
+ f,
+ );
- orders = [
- 'row-major',
- 'column-major',
- 'row-major'
- ];
- f = createBenchmark1( shapes[0], orders[0], shapes[1], orders[1], shapes[2], orders[2] );
- bench( format( '%s::stdlib:blas/base/dgemm:dtype=%s,orders=(%s),size=%d,shapes={(%s),(%s),(%s)}', pkg, OPTS.dtype, orders.join( ',' ), numel( shapes[2] ), shapes[0].join( ',' ), shapes[1].join( ',' ), shapes[2].join( ',' ) ), f );
+ orders = ["row-major", "column-major", "row-major"];
+ f = createBenchmark1(
+ shapes[0],
+ orders[0],
+ shapes[1],
+ orders[1],
+ shapes[2],
+ orders[2],
+ );
+ bench(
+ format(
+ "%s::stdlib:blas/base/dgemm:dtype=%s,orders=(%s),size=%d,shapes={(%s),(%s),(%s)}",
+ pkg,
+ OPTS.dtype,
+ orders.join(","),
+ numel(shapes[2]),
+ shapes[0].join(","),
+ shapes[1].join(","),
+ shapes[2].join(","),
+ ),
+ f,
+ );
- f = createBenchmark2( shapes[0], orders[0], shapes[1], orders[1], shapes[2], orders[2] );
- bench( format( '%s::scijs:ndarray-gemm:dtype=%s,orders=(%s),size=%d,shapes={(%s),(%s),(%s)}', pkg, OPTS.dtype, orders.join( ',' ), numel( shapes[2] ), shapes[0].join( ',' ), shapes[1].join( ',' ), shapes[2].join( ',' ) ), opts, f );
+ f = createBenchmark2(
+ shapes[0],
+ orders[0],
+ shapes[1],
+ orders[1],
+ shapes[2],
+ orders[2],
+ );
+ bench(
+ format(
+ "%s::scijs:ndarray-gemm:dtype=%s,orders=(%s),size=%d,shapes={(%s),(%s),(%s)}",
+ pkg,
+ OPTS.dtype,
+ orders.join(","),
+ numel(shapes[2]),
+ shapes[0].join(","),
+ shapes[1].join(","),
+ shapes[2].join(","),
+ ),
+ opts,
+ f,
+ );
}
}
diff --git a/docs/migration-guides/tfjs/benchmark/benchmark.gemm.square_matrices.js b/docs/migration-guides/tfjs/benchmark/benchmark.gemm.square_matrices.js
index 45f744ca9480..c001b51fca34 100644
--- a/docs/migration-guides/tfjs/benchmark/benchmark.gemm.square_matrices.js
+++ b/docs/migration-guides/tfjs/benchmark/benchmark.gemm.square_matrices.js
@@ -1,71 +1,73 @@
/**
-* @license Apache-2.0
-*
-* Copyright (c) 2024 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.
-*/
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2024 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.
+ */
/* eslint-disable max-len */
-'use strict';
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
-var pow = require( '@stdlib/math/base/special/pow' );
-var floor = require( '@stdlib/math/base/special/floor' );
-var numel = require( '@stdlib/ndarray/base/numel' );
-var shape2strides = require( '@stdlib/ndarray/base/shape2strides' );
-var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
-var format = require( '@stdlib/string/format' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var dgemm = require( '@stdlib/blas/base/dgemm' ).ndarray;
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var discreteUniform = require("@stdlib/random/array/discrete-uniform");
+var pow = require("@stdlib/math/base/special/pow");
+var floor = require("@stdlib/math/base/special/floor");
+var numel = require("@stdlib/ndarray/base/numel");
+var shape2strides = require("@stdlib/ndarray/base/shape2strides");
+var isnanf = require("@stdlib/math/base/assert/is-nanf");
+var format = require("@stdlib/string/format");
+var tryRequire = require("@stdlib/utils/try-require");
+var dgemm = require("@stdlib/blas/base/dgemm").ndarray;
+var pkg = require("./../package.json").name;
// VARIABLES //
-var tf = tryRequire( resolve( __dirname, '..', 'node_modules', '@tensorflow/tfjs' ) );
-var tfnode = tryRequire( resolve( __dirname, '..', 'node_modules', '@tensorflow/tfjs-node' ) );
+var tf = tryRequire(
+ resolve(__dirname, "..", "node_modules", "@tensorflow/tfjs"),
+);
+var tfnode = tryRequire(
+ resolve(__dirname, "..", "node_modules", "@tensorflow/tfjs-node"),
+);
var opts = {
- 'skip': ( tf instanceof Error )
+ skip: tf instanceof Error,
};
var SOPTS = {
- 'dtype': 'float64'
+ dtype: "float64",
};
var TOPTS = {
- 'dtype': 'float32'
+ dtype: "float32",
};
-
// FUNCTIONS //
/**
-* Creates a benchmark function.
-*
-* @private
-* @param {PositiveIntegerArray} shapeA - shape of the first array
-* @param {string} orderA - memory layout of the first array
-* @param {PositiveIntegerArray} shapeB - shape of the second array
-* @param {string} orderB - memory layout of the second array
-* @param {PositiveIntegerArray} shapeC - shape of the third array
-* @param {string} orderC - memory layout of the third array
-* @returns {Function} benchmark function
-*/
-function createBenchmark1( shapeA, orderA, shapeB, orderB, shapeC, orderC ) {
+ * Creates a benchmark function.
+ *
+ * @private
+ * @param {PositiveIntegerArray} shapeA - shape of the first array
+ * @param {string} orderA - memory layout of the first array
+ * @param {PositiveIntegerArray} shapeB - shape of the second array
+ * @param {string} orderB - memory layout of the second array
+ * @param {PositiveIntegerArray} shapeC - shape of the third array
+ * @param {string} orderC - memory layout of the third array
+ * @returns {Function} benchmark function
+ */
+function createBenchmark1(shapeA, orderA, shapeB, orderB, shapeC, orderC) {
var sa;
var sb;
var sc;
@@ -73,68 +75,88 @@ function createBenchmark1( shapeA, orderA, shapeB, orderB, shapeC, orderC ) {
var B;
var C;
- A = discreteUniform( numel( shapeA ), 0, 10, SOPTS );
- B = discreteUniform( numel( shapeB ), 0, 10, SOPTS );
- C = discreteUniform( numel( shapeC ), 0, 10, SOPTS );
+ A = discreteUniform(numel(shapeA), 0, 10, SOPTS);
+ B = discreteUniform(numel(shapeB), 0, 10, SOPTS);
+ C = discreteUniform(numel(shapeC), 0, 10, SOPTS);
- sa = shape2strides( shapeA, orderA );
- sb = shape2strides( shapeB, orderB );
- sc = shape2strides( shapeC, orderC );
+ sa = shape2strides(shapeA, orderA);
+ sb = shape2strides(shapeB, orderB);
+ sc = shape2strides(shapeC, orderC);
return benchmark;
/**
- * Benchmark function.
- *
- * @private
- * @param {Benchmark} b - benchmark instance
- */
- function benchmark( b ) {
+ * Benchmark function.
+ *
+ * @private
+ * @param {Benchmark} b - benchmark instance
+ */
+ function benchmark(b) {
var i;
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- dgemm( 'no-transpose', 'no-transpose', shapeA[0], shapeC[1], shapeB[0], 0.5, A, sa[0], sa[1], 0, B, sb[0], sb[1], 0, 2.0, C, sc[0], sc[1], 0 );
- if ( isnanf( C[ i%C.length ] ) ) {
- b.fail( 'should not return NaN' );
+ for (i = 0; i < b.iterations; i++) {
+ dgemm(
+ "no-transpose",
+ "no-transpose",
+ shapeA[0],
+ shapeC[1],
+ shapeB[0],
+ 0.5,
+ A,
+ sa[0],
+ sa[1],
+ 0,
+ B,
+ sb[0],
+ sb[1],
+ 0,
+ 2.0,
+ C,
+ sc[0],
+ sc[1],
+ 0,
+ );
+ if (isnanf(C[i % C.length])) {
+ b.fail("should not return NaN");
}
}
b.toc();
- if ( isnanf( C[ i%C.length ] ) ) {
- b.fail( 'should not return NaN' );
+ if (isnanf(C[i % C.length])) {
+ b.fail("should not return NaN");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
}
}
/**
-* Creates a benchmark function.
-*
-* @private
-* @param {PositiveIntegerArray} shapeA - shape of the first array
-* @param {PositiveIntegerArray} shapeB - shape of the second array
-* @param {PositiveIntegerArray} shapeC - shape of the third array
-* @returns {Function} benchmark function
-*/
-function createBenchmark2( shapeA, shapeB, shapeC ) {
+ * Creates a benchmark function.
+ *
+ * @private
+ * @param {PositiveIntegerArray} shapeA - shape of the first array
+ * @param {PositiveIntegerArray} shapeB - shape of the second array
+ * @param {PositiveIntegerArray} shapeC - shape of the third array
+ * @returns {Function} benchmark function
+ */
+function createBenchmark2(shapeA, shapeB, shapeC) {
var abuf;
var bbuf;
var cbuf;
- abuf = discreteUniform( numel( shapeA ), 0, 10, TOPTS );
- bbuf = discreteUniform( numel( shapeB ), 0, 10, TOPTS );
- cbuf = discreteUniform( numel( shapeC ), 0, 10, TOPTS );
+ abuf = discreteUniform(numel(shapeA), 0, 10, TOPTS);
+ bbuf = discreteUniform(numel(shapeB), 0, 10, TOPTS);
+ cbuf = discreteUniform(numel(shapeC), 0, 10, TOPTS);
return benchmark;
/**
- * Benchmark function.
- *
- * @private
- * @param {Benchmark} b - benchmark instance
- */
- function benchmark( b ) {
+ * Benchmark function.
+ *
+ * @private
+ * @param {Benchmark} b - benchmark instance
+ */
+ function benchmark(b) {
var out;
var A;
var B;
@@ -142,61 +164,61 @@ function createBenchmark2( shapeA, shapeB, shapeC ) {
var D;
var i;
- tf.setBackend( 'cpu' );
+ tf.setBackend("cpu");
- A = tf.tensor( abuf, shapeA, TOPTS.dtype );
- B = tf.tensor( bbuf, shapeB, TOPTS.dtype );
- C = tf.tensor( cbuf, shapeC, TOPTS.dtype );
+ A = tf.tensor(abuf, shapeA, TOPTS.dtype);
+ B = tf.tensor(bbuf, shapeB, TOPTS.dtype);
+ C = tf.tensor(cbuf, shapeC, TOPTS.dtype);
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- D = tf.matMul( A, B );
- out = tf.add( D, C );
- if ( typeof out !== 'object' ) {
- b.fail( 'should return an object' );
+ for (i = 0; i < b.iterations; i++) {
+ D = tf.matMul(A, B);
+ out = tf.add(D, C);
+ if (typeof out !== "object") {
+ b.fail("should return an object");
}
- tf.dispose( D );
- tf.dispose( out );
+ tf.dispose(D);
+ tf.dispose(out);
}
b.toc();
- if ( typeof out !== 'object' ) {
- b.fail( 'should return an object' );
+ if (typeof out !== "object") {
+ b.fail("should return an object");
}
- tf.dispose( A );
- tf.dispose( B );
- tf.dispose( C );
- b.pass( 'benchmark finished' );
+ tf.dispose(A);
+ tf.dispose(B);
+ tf.dispose(C);
+ b.pass("benchmark finished");
b.end();
}
}
/**
-* Creates a benchmark function.
-*
-* @private
-* @param {PositiveIntegerArray} shapeA - shape of the first array
-* @param {PositiveIntegerArray} shapeB - shape of the second array
-* @param {PositiveIntegerArray} shapeC - shape of the third array
-* @returns {Function} benchmark function
-*/
-function createBenchmark3( shapeA, shapeB, shapeC ) {
+ * Creates a benchmark function.
+ *
+ * @private
+ * @param {PositiveIntegerArray} shapeA - shape of the first array
+ * @param {PositiveIntegerArray} shapeB - shape of the second array
+ * @param {PositiveIntegerArray} shapeC - shape of the third array
+ * @returns {Function} benchmark function
+ */
+function createBenchmark3(shapeA, shapeB, shapeC) {
var abuf;
var bbuf;
var cbuf;
- abuf = discreteUniform( numel( shapeA ), 0, 10, TOPTS );
- bbuf = discreteUniform( numel( shapeB ), 0, 10, TOPTS );
- cbuf = discreteUniform( numel( shapeC ), 0, 10, TOPTS );
+ abuf = discreteUniform(numel(shapeA), 0, 10, TOPTS);
+ bbuf = discreteUniform(numel(shapeB), 0, 10, TOPTS);
+ cbuf = discreteUniform(numel(shapeC), 0, 10, TOPTS);
return benchmark;
/**
- * Benchmark function.
- *
- * @private
- * @param {Benchmark} b - benchmark instance
- */
- function benchmark( b ) {
+ * Benchmark function.
+ *
+ * @private
+ * @param {Benchmark} b - benchmark instance
+ */
+ function benchmark(b) {
var out;
var A;
var B;
@@ -204,42 +226,41 @@ function createBenchmark3( shapeA, shapeB, shapeC ) {
var D;
var i;
- tfnode.setBackend( 'tensorflow' );
+ tfnode.setBackend("tensorflow");
- A = tfnode.tensor( abuf, shapeA, TOPTS.dtype );
- B = tfnode.tensor( bbuf, shapeB, TOPTS.dtype );
- C = tfnode.tensor( cbuf, shapeC, TOPTS.dtype );
+ A = tfnode.tensor(abuf, shapeA, TOPTS.dtype);
+ B = tfnode.tensor(bbuf, shapeB, TOPTS.dtype);
+ C = tfnode.tensor(cbuf, shapeC, TOPTS.dtype);
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
- D = tfnode.matMul( A, B );
- out = tfnode.add( D, C );
- if ( typeof out !== 'object' ) {
- b.fail( 'should return an object' );
+ for (i = 0; i < b.iterations; i++) {
+ D = tfnode.matMul(A, B);
+ out = tfnode.add(D, C);
+ if (typeof out !== "object") {
+ b.fail("should return an object");
}
- tfnode.dispose( D );
- tfnode.dispose( out );
+ tfnode.dispose(D);
+ tfnode.dispose(out);
}
b.toc();
- if ( typeof out !== 'object' ) {
- b.fail( 'should return an object' );
+ if (typeof out !== "object") {
+ b.fail("should return an object");
}
- tfnode.dispose( A );
- tfnode.dispose( B );
- tfnode.dispose( C );
- b.pass( 'benchmark finished' );
+ tfnode.dispose(A);
+ tfnode.dispose(B);
+ tfnode.dispose(C);
+ b.pass("benchmark finished");
b.end();
}
}
-
// MAIN //
/**
-* Main execution sequence.
-*
-* @private
-*/
+ * Main execution sequence.
+ *
+ * @private
+ */
function main() {
var shapes;
var orders;
@@ -252,40 +273,118 @@ function main() {
min = 1; // 10^min
max = 5; // 10^max
- for ( i = min; i <= max; i++ ) {
- N = floor( pow( pow( 10, i ), 1.0/2.0 ) );
+ for (i = min; i <= max; i++) {
+ N = floor(pow(pow(10, i), 1.0 / 2.0));
shapes = [
- [ N, N ],
- [ N, N ],
- [ N, N ]
- ];
- orders = [
- 'row-major',
- 'row-major',
- 'row-major'
- ];
- f = createBenchmark1( shapes[0], orders[0], shapes[1], orders[1], shapes[2], orders[2] );
- bench( format( '%s::stdlib:blas/base/dgemm:dtype=%s,orders=(%s),size=%d,shapes={(%s),(%s),(%s)}', pkg, SOPTS.dtype, orders.join( ',' ), numel( shapes[2] ), shapes[0].join( ',' ), shapes[1].join( ',' ), shapes[2].join( ',' ) ), f );
-
- f = createBenchmark2( shapes[0], shapes[1], shapes[2] );
- bench( format( '%s::tfjs:matmul:dtype=%s,size=%d,shapes={(%s),(%s),(%s)}', pkg, TOPTS.dtype, numel( shapes[2] ), shapes[0].join( ',' ), shapes[1].join( ',' ), shapes[2].join( ',' ) ), opts, f );
-
- f = createBenchmark3( shapes[0], shapes[1], shapes[2] );
- bench( format( '%s::tfjs-node:matmul:dtype=%s,size=%d,shapes={(%s),(%s),(%s)}', pkg, TOPTS.dtype, numel( shapes[2] ), shapes[0].join( ',' ), shapes[1].join( ',' ), shapes[2].join( ',' ) ), opts, f );
-
- orders = [
- 'row-major',
- 'column-major',
- 'row-major'
+ [N, N],
+ [N, N],
+ [N, N],
];
- f = createBenchmark1( shapes[0], orders[0], shapes[1], orders[1], shapes[2], orders[2] );
- bench( format( '%s::stdlib:blas/base/dgemm:dtype=%s,orders=(%s),size=%d,shapes={(%s),(%s),(%s)}', pkg, SOPTS.dtype, orders.join( ',' ), numel( shapes[2] ), shapes[0].join( ',' ), shapes[1].join( ',' ), shapes[2].join( ',' ) ), f );
-
- f = createBenchmark2( shapes[0], shapes[1], shapes[2] );
- bench( format( '%s::tfjs:matmul:dtype=%s,size=%d,shapes={(%s),(%s),(%s)}', pkg, TOPTS.dtype, numel( shapes[2] ), shapes[0].join( ',' ), shapes[1].join( ',' ), shapes[2].join( ',' ) ), opts, f );
-
- f = createBenchmark3( shapes[0], shapes[1], shapes[2] );
- bench( format( '%s::tfjs-node:matmul:dtype=%s,size=%d,shapes={(%s),(%s),(%s)}', pkg, TOPTS.dtype, numel( shapes[2] ), shapes[0].join( ',' ), shapes[1].join( ',' ), shapes[2].join( ',' ) ), opts, f );
+ orders = ["row-major", "row-major", "row-major"];
+ f = createBenchmark1(
+ shapes[0],
+ orders[0],
+ shapes[1],
+ orders[1],
+ shapes[2],
+ orders[2],
+ );
+ bench(
+ format(
+ "%s::stdlib:blas/base/dgemm:dtype=%s,orders=(%s),size=%d,shapes={(%s),(%s),(%s)}",
+ pkg,
+ SOPTS.dtype,
+ orders.join(","),
+ numel(shapes[2]),
+ shapes[0].join(","),
+ shapes[1].join(","),
+ shapes[2].join(","),
+ ),
+ f,
+ );
+
+ f = createBenchmark2(shapes[0], shapes[1], shapes[2]);
+ bench(
+ format(
+ "%s::tfjs:matmul:dtype=%s,size=%d,shapes={(%s),(%s),(%s)}",
+ pkg,
+ TOPTS.dtype,
+ numel(shapes[2]),
+ shapes[0].join(","),
+ shapes[1].join(","),
+ shapes[2].join(","),
+ ),
+ opts,
+ f,
+ );
+
+ f = createBenchmark3(shapes[0], shapes[1], shapes[2]);
+ bench(
+ format(
+ "%s::tfjs-node:matmul:dtype=%s,size=%d,shapes={(%s),(%s),(%s)}",
+ pkg,
+ TOPTS.dtype,
+ numel(shapes[2]),
+ shapes[0].join(","),
+ shapes[1].join(","),
+ shapes[2].join(","),
+ ),
+ opts,
+ f,
+ );
+
+ orders = ["row-major", "column-major", "row-major"];
+ f = createBenchmark1(
+ shapes[0],
+ orders[0],
+ shapes[1],
+ orders[1],
+ shapes[2],
+ orders[2],
+ );
+ bench(
+ format(
+ "%s::stdlib:blas/base/dgemm:dtype=%s,orders=(%s),size=%d,shapes={(%s),(%s),(%s)}",
+ pkg,
+ SOPTS.dtype,
+ orders.join(","),
+ numel(shapes[2]),
+ shapes[0].join(","),
+ shapes[1].join(","),
+ shapes[2].join(","),
+ ),
+ f,
+ );
+
+ f = createBenchmark2(shapes[0], shapes[1], shapes[2]);
+ bench(
+ format(
+ "%s::tfjs:matmul:dtype=%s,size=%d,shapes={(%s),(%s),(%s)}",
+ pkg,
+ TOPTS.dtype,
+ numel(shapes[2]),
+ shapes[0].join(","),
+ shapes[1].join(","),
+ shapes[2].join(","),
+ ),
+ opts,
+ f,
+ );
+
+ f = createBenchmark3(shapes[0], shapes[1], shapes[2]);
+ bench(
+ format(
+ "%s::tfjs-node:matmul:dtype=%s,size=%d,shapes={(%s),(%s),(%s)}",
+ pkg,
+ TOPTS.dtype,
+ numel(shapes[2]),
+ shapes[0].join(","),
+ shapes[1].join(","),
+ shapes[2].join(","),
+ ),
+ opts,
+ f,
+ );
}
}
diff --git a/docs/misc/built_in_math_bugs.md b/docs/misc/built_in_math_bugs.md
index efc49a40a716..e885eed81cd6 100644
--- a/docs/misc/built_in_math_bugs.md
+++ b/docs/misc/built_in_math_bugs.md
@@ -22,159 +22,110 @@ limitations under the License.
> Bugs in the built-in `Math` namespace.
-- [Numeric instability of transcendental functions][@bug:v8:436]
-- [Sine and cosine in V8][@bug:v8:3006]
-- [Trigonometric functions in V8][@bug:chromium:320097]
-- [V8 not IEEE 754-2008 compliant][@bug:v8:3089]
-- [Mozilla discussion on sine and cosine in V8][@bug:mozilla:967709]
-- [V8 replaced a lookup table by computing `Math.tan` as `Math.sin/Math.cos`][@bug:chromium:78263005]
-- [Browser math accuracy issues][@bug:kangax:compat-table:392]
-- [Mozilla attempt to address precision in new Math functions][@bug:mozilla:933257]
-- [Mozilla's previous lack of tolerance tests for Math functions][@bug:mozilla:892671]
-- [Mozilla `Math.expm1` accuracy][@bug:mozilla:897634]
-- [Mozilla thread on implementing ES6 math functions][@bug:mozilla:717379]
-- [V8 `Math.atanh` issues][@bug:v8:3511]
-- [V8 `Math.acosh` issues][@bug:v8:3509]
-- [V8 `Math.asinh` issues][@bug:v8:3496]
-- [V8 numeric issues in hyperbolic functions][@bug:v8:3266]
-- [ES6 accuracy of special functions][@bug:esdiscuss:038525]
-- [Accuracy of `Math.exp` in V8][@bug:v8:3468]
-- [TC39 meeting discussing Math accuracy issues][@bug:esdiscuss:2014-07-31]
-- [Spreadsheet showing trigonometric results across browsers][@bug:esdiscuss:038525:spreadsheet]
-- [Accuracy of `Math.pow` in V8][@bug:v8:3599]
-- [Accumulation of errors in Mozilla `Math.pow`][@bug:mozilla:618251]
-- [Accuracy of hyperbolic trigonometric functions in V8][@bug:paulmiller:es6-shim:334]
-- [ES6 shim accuracy issues][@bug:paulmillr:es6-shim:314]
-- [TC39 testing of Math built-ins][@bug:tc39:test262:269]
-- [V8 `Math.random` PRNG quality][@bug:v8:4566]
-- [V8 trig function precision issues][@bug:v8:1975]
-- [WebKit `Math.random` repeat values in separate workers][@bug:webkit:36673]
-- [Predictable `Math.random` in WebKit][@bug:webkit:26972]
-- [Predictable `Math.random` in Chrome][@bug:chromium:246054]
-- [Desire for fastmath implementations][@bug:mozilla:681357]
-- [Mozilla `Math.round` issues][@bug:mozilla:686708]
-- [Mozilla `Math.pow` issue][@bug:mozilla:703611]
-- [Mozilla `Math.pow` issue][@bug:mozilla:1316557]
-- [V8 deoptimizes if `Math.floor` provided `-0`][@bug:v8:2890]
-- [V8 deoptimizes if `Math.ceil` provided `0`][@bug:v8:4059]
-- [V8 `Math.round` accuracy][@bug:v8:958]
-- [Observability of distinguishable NaNs][@bug:esdiscuss:2013-03-20] (see also [get-nans][get-nans] and ECMA262 issue [635][ecma262-635])
-- [NaN converted to -NaN][@bug:v8:1101]
-- [After 10 years, Mozilla updates `Math.random`][@bug:mozilla:322529]
-- [WebKit bug to use a better PRNG][@bug:webkit:151641]
-- [WebKit 32-bit Math bug][@bug:webkit:40367]
-- [Mozilla optimizations break commutativity][@bug:mozilla:969203]
-- [Mozilla debate on speed versus precision][@bug:mozilla:967709]
-- [Mozilla division bug to due C library delegation][@bug:mozilla:948321]
-- [Fixit to unify Math implementations in V8][@bug:v8:5086]
-- [Fixit to unify `Math.pow` implementation in V8][@bug:v8:5157]
+- [Numeric instability of transcendental functions][@bug:v8:436]
+- [Sine and cosine in V8][@bug:v8:3006]
+- [Trigonometric functions in V8][@bug:chromium:320097]
+- [V8 not IEEE 754-2008 compliant][@bug:v8:3089]
+- [Mozilla discussion on sine and cosine in V8][@bug:mozilla:967709]
+- [V8 replaced a lookup table by computing `Math.tan` as `Math.sin/Math.cos`][@bug:chromium:78263005]
+- [Browser math accuracy issues][@bug:kangax:compat-table:392]
+- [Mozilla attempt to address precision in new Math functions][@bug:mozilla:933257]
+- [Mozilla's previous lack of tolerance tests for Math functions][@bug:mozilla:892671]
+- [Mozilla `Math.expm1` accuracy][@bug:mozilla:897634]
+- [Mozilla thread on implementing ES6 math functions][@bug:mozilla:717379]
+- [V8 `Math.atanh` issues][@bug:v8:3511]
+- [V8 `Math.acosh` issues][@bug:v8:3509]
+- [V8 `Math.asinh` issues][@bug:v8:3496]
+- [V8 numeric issues in hyperbolic functions][@bug:v8:3266]
+- [ES6 accuracy of special functions][@bug:esdiscuss:038525]
+- [Accuracy of `Math.exp` in V8][@bug:v8:3468]
+- [TC39 meeting discussing Math accuracy issues][@bug:esdiscuss:2014-07-31]
+- [Spreadsheet showing trigonometric results across browsers][@bug:esdiscuss:038525:spreadsheet]
+- [Accuracy of `Math.pow` in V8][@bug:v8:3599]
+- [Accumulation of errors in Mozilla `Math.pow`][@bug:mozilla:618251]
+- [Accuracy of hyperbolic trigonometric functions in V8][@bug:paulmiller:es6-shim:334]
+- [ES6 shim accuracy issues][@bug:paulmillr:es6-shim:314]
+- [TC39 testing of Math built-ins][@bug:tc39:test262:269]
+- [V8 `Math.random` PRNG quality][@bug:v8:4566]
+- [V8 trig function precision issues][@bug:v8:1975]
+- [WebKit `Math.random` repeat values in separate workers][@bug:webkit:36673]
+- [Predictable `Math.random` in WebKit][@bug:webkit:26972]
+- [Predictable `Math.random` in Chrome][@bug:chromium:246054]
+- [Desire for fastmath implementations][@bug:mozilla:681357]
+- [Mozilla `Math.round` issues][@bug:mozilla:686708]
+- [Mozilla `Math.pow` issue][@bug:mozilla:703611]
+- [Mozilla `Math.pow` issue][@bug:mozilla:1316557]
+- [V8 deoptimizes if `Math.floor` provided `-0`][@bug:v8:2890]
+- [V8 deoptimizes if `Math.ceil` provided `0`][@bug:v8:4059]
+- [V8 `Math.round` accuracy][@bug:v8:958]
+- [Observability of distinguishable NaNs][@bug:esdiscuss:2013-03-20] (see also [get-nans][get-nans] and ECMA262 issue [635][ecma262-635])
+- [NaN converted to -NaN][@bug:v8:1101]
+- [After 10 years, Mozilla updates `Math.random`][@bug:mozilla:322529]
+- [WebKit bug to use a better PRNG][@bug:webkit:151641]
+- [WebKit 32-bit Math bug][@bug:webkit:40367]
+- [Mozilla optimizations break commutativity][@bug:mozilla:969203]
+- [Mozilla debate on speed versus precision][@bug:mozilla:967709]
+- [Mozilla division bug to due C library delegation][@bug:mozilla:948321]
+- [Fixit to unify Math implementations in V8][@bug:v8:5086]
+- [Fixit to unify `Math.pow` implementation in V8][@bug:v8:5157]
## Notes
-- To search for V8 Math bugs, see [V8 issue tracker][v8-issue-tracker].
-- To search for WebKit Math bugs, see [WebKit issue tracker][webkit-issue-tracker].
-- To search for Mozilla Math bugs, see [Bugzilla][mozilla-issue-tracker].
+- To search for V8 Math bugs, see [V8 issue tracker][v8-issue-tracker].
+- To search for WebKit Math bugs, see [WebKit issue tracker][webkit-issue-tracker].
+- To search for Mozilla Math bugs, see [Bugzilla][mozilla-issue-tracker].
<!-- <links> -->
[@bug:v8:436]: https://bugs.chromium.org/p/v8/issues/detail?id=436
-
[@bug:v8:3006]: https://bugs.chromium.org/p/v8/issues/detail?id=3006
-
[@bug:chromium:320097]: https://bugs.chromium.org/p/chromium/issues/detail?id=320097
-
[@bug:v8:3089]: https://bugs.chromium.org/p/v8/issues/detail?id=3089
-
[@bug:mozilla:967709]: https://bugzilla.mozilla.org/show_bug.cgi?id=967709
-
[@bug:chromium:78263005]: https://github.com/v8/v8/commit/33b5db090258c2a2dc825659c3ad109bd02110c1
-
[@bug:kangax:compat-table:392]: https://github.com/kangax/compat-table/issues/392
-
[@bug:mozilla:933257]: https://bugzilla.mozilla.org/show_bug.cgi?id=933257
-
[@bug:mozilla:892671]: https://bugzilla.mozilla.org/show_bug.cgi?id=892671
-
[@bug:mozilla:897634]: https://bugzilla.mozilla.org/show_bug.cgi?id=897634
-
[@bug:mozilla:717379]: https://bugzilla.mozilla.org/show_bug.cgi?id=717379#c5
-
[@bug:v8:3511]: https://bugs.chromium.org/p/v8/issues/detail?id=3511
-
[@bug:v8:3509]: https://bugs.chromium.org/p/v8/issues/detail?id=3509
-
[@bug:v8:3496]: https://bugs.chromium.org/p/v8/issues/detail?id=3496
-
[@bug:v8:3266]: https://bugs.chromium.org/p/v8/issues/detail?id=3266
-
[@bug:esdiscuss:038525]: https://esdiscuss.org/topic/es6-accuracy-of-special-functions
-
[@bug:v8:3468]: https://bugs.chromium.org/p/v8/issues/detail?id=3468
-
[@bug:esdiscuss:2014-07-31]: https://esdiscuss.org/notes/2014-07-31
-
[@bug:esdiscuss:038525:spreadsheet]: https://docs.google.com/spreadsheets/d/1t2jrptAvaQetDIYPD8GKc90Dni2dT3FuHgKKFF-eJHw/edit#gid=0
-
[@bug:v8:3599]: https://bugs.chromium.org/p/v8/issues/detail?id=3599
-
[@bug:mozilla:618251]: https://bugzilla.mozilla.org/show_bug.cgi?id=618251
-
[@bug:paulmiller:es6-shim:334]: https://github.com/paulmillr/es6-shim/issues/334
-
[@bug:paulmillr:es6-shim:314]: https://github.com/paulmillr/es6-shim/issues/314
-
[@bug:tc39:test262:269]: https://github.com/tc39/test262/pull/269
-
[@bug:v8:4566]: https://bugs.chromium.org/p/v8/issues/detail?id=4566
-
[@bug:v8:1975]: https://bugs.chromium.org/p/v8/issues/detail?id=1975
-
[@bug:webkit:36673]: https://bugs.webkit.org/show_bug.cgi?id=36673
-
[@bug:webkit:26972]: https://bugs.webkit.org/show_bug.cgi?id=26972
-
[@bug:chromium:246054]: https://bugs.chromium.org/p/chromium/issues/detail?id=246054
-
[@bug:mozilla:681357]: https://bugzilla.mozilla.org/show_bug.cgi?id=681357
-
[@bug:mozilla:686708]: https://bugzilla.mozilla.org/show_bug.cgi?id=686708
-
[@bug:mozilla:703611]: https://bugzilla.mozilla.org/show_bug.cgi?id=703611
-
[@bug:mozilla:1316557]: https://bugzilla.mozilla.org/show_bug.cgi?id=1316557
-
[@bug:v8:2890]: https://bugs.chromium.org/p/v8/issues/detail?id=2890
-
[@bug:v8:4059]: https://bugs.chromium.org/p/v8/issues/detail?id=4059
-
[@bug:v8:958]: https://bugs.chromium.org/p/v8/issues/detail?id=958
-
[@bug:esdiscuss:2013-03-20]: https://esdiscuss.org/topic/observability-of-nan-distinctions-is-this-a-concern
-
[@bug:v8:1101]: https://bugs.chromium.org/p/v8/issues/detail?id=1101
-
[get-nans]: https://github.com/ljharb/get-nans
-
[ecma262-635]: https://github.com/tc39/ecma262/issues/635
-
[@bug:mozilla:322529]: https://bugzilla.mozilla.org/show_bug.cgi?id=322529
-
[@bug:webkit:151641]: https://bugs.webkit.org/show_bug.cgi?id=151641
-
[@bug:webkit:40367]: https://bugs.webkit.org/show_bug.cgi?id=40367
-
[@bug:mozilla:969203]: https://bugzilla.mozilla.org/show_bug.cgi?id=969203#c8
-
[@bug:mozilla:948321]: https://bugzilla.mozilla.org/show_bug.cgi?id=948321
-
[@bug:v8:5086]: https://bugs.chromium.org/p/v8/issues/detail?id=5086
-
[@bug:v8:5157]: https://bugs.chromium.org/p/v8/issues/detail?id=5157
-
[v8-issue-tracker]: https://bugs.chromium.org/p/v8/issues/list?can=1&q=math&colspec=ID%20Type%20Status%20Priority%20Owner%20Summary%20HW%20OS%20Component%20Stars&num=100&start=100
-
[webkit-issue-tracker]: https://bugs.webkit.org/buglist.cgi?quicksearch=math
-
[mozilla-issue-tracker]: https://bugzilla.mozilla.org/buglist.cgi?quicksearch=math
<!-- </links> -->
diff --git a/docs/policies/README.md b/docs/policies/README.md
index e3bb5a30c915..fb92feb045cf 100644
--- a/docs/policies/README.md
+++ b/docs/policies/README.md
@@ -4,29 +4,23 @@
The following documents set forth the legal policies for the project:
-- [Code of Conduct][stdlib-code-of-conduct]
-- [Copyright][stdlib-copyright]
-- [License][stdlib-license]
-- [Privacy Policy][stdlib-privacy-policy]
-- [Terms of Service][stdlib-terms-of-service]
-- [List of Official Domains][stdlib-domains]
+- [Code of Conduct][stdlib-code-of-conduct]
+- [Copyright][stdlib-copyright]
+- [License][stdlib-license]
+- [Privacy Policy][stdlib-privacy-policy]
+- [Terms of Service][stdlib-terms-of-service]
+- [List of Official Domains][stdlib-domains]
These documents are periodically updated. Please refer to the project [git history][stdlib-git-commit-log] to view the changes.
<section class="links">
[stdlib-code-of-conduct]: https://github.com/stdlib-js/stdlib/blob/develop/CODE_OF_CONDUCT.md
-
[stdlib-copyright]: https://github.com/stdlib-js/stdlib/blob/develop/NOTICE
-
[stdlib-license]: https://github.com/stdlib-js/stdlib/blob/develop/LICENSE
-
[stdlib-privacy-policy]: https://github.com/stdlib-js/stdlib/blob/develop/PRIVACY.md
-
[stdlib-terms-of-service]: https://github.com/stdlib-js/stdlib/blob/develop/docs/policies/TERMS_OF_SERVICE.md
-
[stdlib-domains]: https://github.com/stdlib-js/stdlib/blob/develop/docs/policies/domains.md
-
[stdlib-git-commit-log]: https://github.com/stdlib-js/stdlib/commits/develop/
</section>
diff --git a/docs/policies/TERMS_OF_SERVICE.md b/docs/policies/TERMS_OF_SERVICE.md
index 1ac533acd75f..903eaeb2b748 100644
--- a/docs/policies/TERMS_OF_SERVICE.md
+++ b/docs/policies/TERMS_OF_SERVICE.md
@@ -22,20 +22,20 @@ Subject to these Terms, the Project grants you permission to use Services. That
Your permission to use Services are subject to the following conditions:
-- You must be at least 13 years of age.
-- You must use Services only in accordance with "Acceptable Use".
+- You must be at least 13 years of age.
+- You must use Services only in accordance with "Acceptable Use".
## Acceptable Use
-- You will abide by the [Code of Conduct][stdlib-code-of-conduct].
-- You will not violate any applicable law.
-- You will not falsely imply that you are affiliated with or endorsed by the Project.
-- You will not remove any copyright or marking indicating proprietary ownership from any material obtained via Services.
-- You will not display any portion of the website via an HTML iframe.
-- You will not disable, tamper with, avoid, or circumvent any security or access restrictions of Services, or access parts of Services not intended for access by you.
-- You will not forge any TCP/IP packet header or any part of the header information in any email or posting, or in any way use the Services to send altered, deceptive, or false source-identifying information.
-- You will not strain infrastructure of Services with an unreasonable volume of requests, or requests designed to impose an unreasonable load on the technical systems underlying Services.
-- You will not encourage or assist any other person in violation of "Acceptable Use".
+- You will abide by the [Code of Conduct][stdlib-code-of-conduct].
+- You will not violate any applicable law.
+- You will not falsely imply that you are affiliated with or endorsed by the Project.
+- You will not remove any copyright or marking indicating proprietary ownership from any material obtained via Services.
+- You will not display any portion of the website via an HTML iframe.
+- You will not disable, tamper with, avoid, or circumvent any security or access restrictions of Services, or access parts of Services not intended for access by you.
+- You will not forge any TCP/IP packet header or any part of the header information in any email or posting, or in any way use the Services to send altered, deceptive, or false source-identifying information.
+- You will not strain infrastructure of Services with an unreasonable volume of requests, or requests designed to impose an unreasonable load on the technical systems underlying Services.
+- You will not encourage or assist any other person in violation of "Acceptable Use".
Crawling the Services is allowed if done in accordance with the provisions of our `robots.txt` file.
@@ -73,8 +73,8 @@ If you have any questions or concerns regarding these Terms, please do not hesit
Parts of this policy document were originally included in
-- [npm, Inc Open-Source Terms][npm-open-source-terms]
-- [Medium Terms of Service][medium-terms-of-service]
+- [npm, Inc Open-Source Terms][npm-open-source-terms]
+- [Medium Terms of Service][medium-terms-of-service]
licensed under Creative Commons Attribution-ShareAlike licenses.
@@ -89,15 +89,10 @@ Copyright © The Stdlib [Authors][stdlib-authors].
<section class="links">
[stdlib-git-commit-log-terms-of-service]: https://github.com/stdlib-js/stdlib/commits/develop/docs/policies/TERMS_OF_SERVICE.md
-
[npm-open-source-terms]: https://www.npmjs.com/policies/open-source-terms
-
[medium-terms-of-service]: https://github.com/Medium/medium-policy/blob/3c76f50e5e6a529c8352c85c9ed596ef95f863b7/terms-of-service.md
-
[stdlib-code-of-conduct]: https://github.com/stdlib-js/stdlib/blob/develop/CODE_OF_CONDUCT.md
-
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
-
[cc-by-sa-4.0]: https://creativecommons.org/licenses/by-sa/4.0/
</section>
diff --git a/docs/policies/domains.md b/docs/policies/domains.md
index 3970ad4589d4..524b7285694c 100644
--- a/docs/policies/domains.md
+++ b/docs/policies/domains.md
@@ -14,30 +14,30 @@ This document lists domain names which are officially affiliated with the projec
List of active domains:
-- [stdlib.io](https://stdlib.io): the domain of the website
-- [stdlib.blog](https://stdlib.blog): the domain of the development blog
+- [stdlib.io](https://stdlib.io): the domain of the website
+- [stdlib.blog](https://stdlib.blog): the domain of the development blog
## Idle
List of **currently** unused domains:
-- [libstd.com](http://libstd.com): redirects to repository
-- [libstd.org](http://libstd.org): redirects to repository
-- [stdlib.ai](http://stdlib.ai): redirects to website
-- [stdlib.app](http://stdlib.app): ????
-- [stdlibjs.com](http://stdlibjs.com): redirects to website
-- [stdlib.co](http://stdlib.co): redirects to repository
-- [stdlibjs.co](http://stdlibjs.co): redirects to repository
-- [stdlib.fun](http://stdlib.fun): redirects to repository
-- [stdlibjs.fun](http://stdlibjs.fun): redirects to repository
-- [stdlib.rocks](http://stdlib.rocks): redirects to repository
-- [stdlibjs.rocks](http://stdlibjs.rocks): redirects to repository
-- [stdlib.party](http://stdlib.party): redirects to repository
-- [stdlibjs.party](http://stdlibjs.party): redirects to repository
-- [stdlib.studio](http://stdlib.studio): redirects to repository
-- [stdlibjs.studio](http://stdlibjs.studio): redirects to website
-- [stdlibjs.xyz](http://stdlibjs.xyz): redirects to website
-- [stdlibjs.org](http://stdlibjs.org): redirects to website
+- [libstd.com](http://libstd.com): redirects to repository
+- [libstd.org](http://libstd.org): redirects to repository
+- [stdlib.ai](http://stdlib.ai): redirects to website
+- [stdlib.app](http://stdlib.app): ????
+- [stdlibjs.com](http://stdlibjs.com): redirects to website
+- [stdlib.co](http://stdlib.co): redirects to repository
+- [stdlibjs.co](http://stdlibjs.co): redirects to repository
+- [stdlib.fun](http://stdlib.fun): redirects to repository
+- [stdlibjs.fun](http://stdlibjs.fun): redirects to repository
+- [stdlib.rocks](http://stdlib.rocks): redirects to repository
+- [stdlibjs.rocks](http://stdlibjs.rocks): redirects to repository
+- [stdlib.party](http://stdlib.party): redirects to repository
+- [stdlibjs.party](http://stdlibjs.party): redirects to repository
+- [stdlib.studio](http://stdlib.studio): redirects to repository
+- [stdlibjs.studio](http://stdlibjs.studio): redirects to website
+- [stdlibjs.xyz](http://stdlibjs.xyz): redirects to website
+- [stdlibjs.org](http://stdlibjs.org): redirects to website
## Former
@@ -58,9 +58,7 @@ Copyright © The Stdlib [Authors][stdlib-authors].
<section class="links">
[stdlib-git-commit-log-domains]: https://github.com/stdlib-js/stdlib/commits/develop/docs/policies/domains.md
-
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
-
[cc-by-sa-4.0]: https://creativecommons.org/licenses/by-sa/4.0/
</section>
diff --git a/docs/references/README.md b/docs/references/README.md
index 059339751c0a..24923d9fc61d 100644
--- a/docs/references/README.md
+++ b/docs/references/README.md
@@ -39,7 +39,7 @@ The database is a [BibTeX][bibtex] database file, where the file format is a pla
}
```
-corresponds to Bay's and Durham's 1976 article "Improving a Poor Random Number Generator" appearing in the journal _ACM Transactions on Mathematical Software_.
+corresponds to Bay's and Durham's 1976 article "Improving a Poor Random Number Generator" appearing in the journal _ACM Transactions on Mathematical Software_.
</section>
@@ -49,10 +49,10 @@ corresponds to Bay's and Durham's 1976 article "Improving a Poor Random Number G
## Notes
-- Templates for various entry types may be found in the `./templates` directory.
-- When adding an entry, ensure that fields are sorted in alphabetical order.
-- Field values should be enclosed within braces.
-- An entry identifier should follow the format `<author_last_name>:<publication_year>[<letter>]`. The `letter` suffix is optional and only necessary when distinguishing two or more entries having the same identifier.
+- Templates for various entry types may be found in the `./templates` directory.
+- When adding an entry, ensure that fields are sorted in alphabetical order.
+- Field values should be enclosed within braces.
+- An entry identifier should follow the format `<author_last_name>:<publication_year>[<letter>]`. The `letter` suffix is optional and only necessary when distinguishing two or more entries having the same identifier.
</section>
@@ -69,9 +69,7 @@ The data files (databases) are licensed under an [Open Data Commons Public Domai
<section class="links">
[pddl-1.0]: http://opendatacommons.org/licenses/pddl/1.0/
-
[cc0]: https://creativecommons.org/publicdomain/zero/1.0
-
[bibtex]: http://www.bibtex.org/
</section>
diff --git a/docs/style-guides/bash/README.md b/docs/style-guides/bash/README.md
index 47f60b6f17de..649f6c49fa25 100644
--- a/docs/style-guides/bash/README.md
+++ b/docs/style-guides/bash/README.md
@@ -4,8 +4,8 @@
TODO
-- [bash style](https://github.com/progrium/bashstyle)
-- [Google shell guide](https://google.github.io/styleguide/shell.xml)
-- [bash pitfalls](http://mywiki.wooledge.org/BashPitfalls)
-- [limitations of usual tools](https://www.gnu.org/savannah-checkouts/gnu/autoconf/manual/autoconf-2.69/html_node/Limitations-of-Usual-Tools.html#Limitations-of-Usual-Tools)
-- [autoconf](https://www.gnu.org/software/autoconf/manual/autoconf.html#Portable-Shell)
+- [bash style](https://github.com/progrium/bashstyle)
+- [Google shell guide](https://google.github.io/styleguide/shell.xml)
+- [bash pitfalls](http://mywiki.wooledge.org/BashPitfalls)
+- [limitations of usual tools](https://www.gnu.org/savannah-checkouts/gnu/autoconf/manual/autoconf-2.69/html_node/Limitations-of-Usual-Tools.html#Limitations-of-Usual-Tools)
+- [autoconf](https://www.gnu.org/software/autoconf/manual/autoconf.html#Portable-Shell)
diff --git a/docs/style-guides/c/README.md b/docs/style-guides/c/README.md
index dd05e7215eb2..c0b8d47dad13 100644
--- a/docs/style-guides/c/README.md
+++ b/docs/style-guides/c/README.md
@@ -4,11 +4,11 @@
TODO
-- [clib](https://github.com/clibs/clib)
-
- - [package.json](https://github.com/clibs/clib/wiki/Explanation-of-package.json)
- - [packages](https://github.com/clibs/clib/wiki/Packages)
- - [list](https://github.com/clibs/list)
- - [levenshtein.c](https://github.com/wooorm/levenshtein.c)
- - [freebsd](https://www.freebsd.org/cgi/man.cgi?query=style&sektion=9)
- - [example pkg](https://github.com/glisy/math)
+- [clib](https://github.com/clibs/clib)
+
+ - [package.json](https://github.com/clibs/clib/wiki/Explanation-of-package.json)
+ - [packages](https://github.com/clibs/clib/wiki/Packages)
+ - [list](https://github.com/clibs/list)
+ - [levenshtein.c](https://github.com/wooorm/levenshtein.c)
+ - [freebsd](https://www.freebsd.org/cgi/man.cgi?query=style&sektion=9)
+ - [example pkg](https://github.com/glisy/math)
diff --git a/docs/style-guides/cpp/README.md b/docs/style-guides/cpp/README.md
index c40e5a0b2732..9df3d0e2fb8f 100644
--- a/docs/style-guides/cpp/README.md
+++ b/docs/style-guides/cpp/README.md
@@ -4,12 +4,12 @@
TODO
-- [Core Guidelines](https://github.com/isocpp/CppCoreGuidelines)
+- [Core Guidelines](https://github.com/isocpp/CppCoreGuidelines)
-- [FAQ](http://www.stroustrup.com/bs_faq2.html)
+- [FAQ](http://www.stroustrup.com/bs_faq2.html)
-- [cppdoc](http://www.edparrish.net/common/cppdoc.html)
+- [cppdoc](http://www.edparrish.net/common/cppdoc.html)
-- [cpm](https://github.com/iauns/cpm)
+- [cpm](https://github.com/iauns/cpm)
- - can also be used for C packages
+ - can also be used for C packages
diff --git a/docs/style-guides/git/README.md b/docs/style-guides/git/README.md
index dfca3e46eac0..2c131e1f0acb 100644
--- a/docs/style-guides/git/README.md
+++ b/docs/style-guides/git/README.md
@@ -72,27 +72,27 @@ The **type** and **short summary** fields are **mandatory**, and the **scope** f
The **type** field labels a commit and indicates the category of change introduced by a commit. The project uses the following commit types:
-- **bench**: benchmark-only changes, such as adding missing benchmarks or correcting existing benchmarks. This type has lower precedence than other types, and, thus, benchmarks accompanying other types of changes can be categorized according to those other types.
+- **bench**: benchmark-only changes, such as adding missing benchmarks or correcting existing benchmarks. This type has lower precedence than other types, and, thus, benchmarks accompanying other types of changes can be categorized according to those other types.
-- **build**: anything to do with building and releasing the project, including changes to automation and continuous integration configuration files and scripts (e.g., GitHub actions, CircleCI, Azure, etc).
+- **build**: anything to do with building and releasing the project, including changes to automation and continuous integration configuration files and scripts (e.g., GitHub actions, CircleCI, Azure, etc).
-- **chore**: neither a fix, a feature, nor a refactor; a repetitive mechanical task, such as updating package meta data or updating external dependencies.
+- **chore**: neither a fix, a feature, nor a refactor; a repetitive mechanical task, such as updating package meta data or updating external dependencies.
-- **deprecate**: a change that deprecates an existing feature. This type correlates with `MINOR` in [Semantic Versioning][semver].
+- **deprecate**: a change that deprecates an existing feature. This type correlates with `MINOR` in [Semantic Versioning][semver].
-- **docs**: documentation-only changes. Documentation changes include changes to the following: READMEs, JSDoc/Doxygen-style comments, annotations, source comments, and examples (including examples files). Note that changes to TypeScript declarations files are **not** documentation-only changes, as TypeScript declarations are part of a package's public API and are consumed by downstream project consumers.
+- **docs**: documentation-only changes. Documentation changes include changes to the following: READMEs, JSDoc/Doxygen-style comments, annotations, source comments, and examples (including examples files). Note that changes to TypeScript declarations files are **not** documentation-only changes, as TypeScript declarations are part of a package's public API and are consumed by downstream project consumers.
-- **feat**: a new feature. This type typically correlates with `MINOR` in [Semantic Versioning][semver]; however, a new feature may introduce a breaking change and thus correlate with `MAJOR` in [Semantic Versioning][semver] (e.g., if an existing user-facing API is completely changed to support new behaviors and existing behaviors are not preserved).
+- **feat**: a new feature. This type typically correlates with `MINOR` in [Semantic Versioning][semver]; however, a new feature may introduce a breaking change and thus correlate with `MAJOR` in [Semantic Versioning][semver] (e.g., if an existing user-facing API is completely changed to support new behaviors and existing behaviors are not preserved).
-- **fix**: bug fixes, including changes to the behavior of existing features and including changes that remove or mitigate security vulnerabilities. This type correlates with `PATCH` in [Semantic Versioning][semver].
+- **fix**: bug fixes, including changes to the behavior of existing features and including changes that remove or mitigate security vulnerabilities. This type correlates with `PATCH` in [Semantic Versioning][semver].
-- **perf**: a change that improves performance.
+- **perf**: a change that improves performance.
-- **refactor**: neither a fix nor a feature; a change that does not change behavior from the perspective of downstream consumers of the project. If refactoring improves performance, **perf** takes higher priority.
+- **refactor**: neither a fix nor a feature; a change that does not change behavior from the perspective of downstream consumers of the project. If refactoring improves performance, **perf** takes higher priority.
-- **remove**: removes a feature. This type correlates with `MAJOR` in [Semantic Versioning][semver].
+- **remove**: removes a feature. This type correlates with `MAJOR` in [Semantic Versioning][semver].
-- **revert**: a change which undoes a previous change. The **short summary** must include the previous commit message short summary and the type label. For example, if the initial commit is
+- **revert**: a change which undoes a previous change. The **short summary** must include the previous commit message short summary and the type label. For example, if the initial commit is
```text
fix(tools): address race condition when iterating over files
@@ -104,11 +104,11 @@ The **type** field labels a commit and indicates the category of change introduc
revert: fix(tools): address race condition when iterating over files
```
-- **style**: a change which improves code style (e.g., whitespace, formatting, semicolons, etc) and does not affect the meaning of code.
+- **style**: a change which improves code style (e.g., whitespace, formatting, semicolons, etc) and does not affect the meaning of code.
-- **test**: test-only changes, such as adding missing tests or correcting existing tests. This type has lower precedence than other types, and, thus, tests accompanying other types of changes can be categorized according to those other types.
+- **test**: test-only changes, such as adding missing tests or correcting existing tests. This type has lower precedence than other types, and, thus, tests accompanying other types of changes can be categorized according to those other types.
-- **temp**: temporary, experimental, or exploratory changes that are not intended to be permanent. Occasionally, one may want to push changes to GitHub that are intended to be short-lived, such as when debugging continuous integration or ad-hoc debugging on live systems.
+- **temp**: temporary, experimental, or exploratory changes that are not intended to be permanent. Occasionally, one may want to push changes to GitHub that are intended to be short-lived, such as when debugging continuous integration or ad-hoc debugging on live systems.
Breaking changes **must** include an exclamation point as part of the **type**. For example,
@@ -145,10 +145,10 @@ The [Conventional Commits][conventional-commits] specification includes support
The short summary **must** provide a succinct description of a change and adhere to the following conventions:
-- Use the [imperative][imperative-mood], present tense (e.g., "change", not "changed" or "changes").
-- Do **not** capitalize the first letter.
-- Do **not** include a period at the end.
-- Should be less than **72** characters.
+- Use the [imperative][imperative-mood], present tense (e.g., "change", not "changed" or "changes").
+- Do **not** capitalize the first letter.
+- Do **not** include a period at the end.
+- Should be less than **72** characters.
A properly formed short summary should complete the following sentence:
@@ -242,13 +242,13 @@ DEPRECATED: <short summary>
A commit message footer may include other structured information using the [Git trailer format][git-trailer-format] (`token: value`). For example,
-- `Fixes:` link to a GitHub issue describing a bug that the commit fixes.
-- `Closes:` link to a GitHub issue or pull request that the commit closes.
-- `PR-URL:` link to the GitHub pull request responsible for the commit (e.g., upon squash and merge).
-- `Reviewed-by:` the name and e-mail of a commit reviewer (e.g., `Jane Doe <jane@doe.com>`).
-- `Co-authored-by:` the name and e-mail of a contributor who collaborated on the commit.
-- `Ref:` link to a public resource (e.g., commit SHA, external documentation, reference implementation, etc).
-- `Private-ref:` link to a private resource (e.g., issue tracker, pull request, discussion, etc) related to the commit. Private references should only be included in the commit message body using the `Private-ref` token.
+- `Fixes:` link to a GitHub issue describing a bug that the commit fixes.
+- `Closes:` link to a GitHub issue or pull request that the commit closes.
+- `PR-URL:` link to the GitHub pull request responsible for the commit (e.g., upon squash and merge).
+- `Reviewed-by:` the name and e-mail of a commit reviewer (e.g., `Jane Doe <jane@doe.com>`).
+- `Co-authored-by:` the name and e-mail of a contributor who collaborated on the commit.
+- `Ref:` link to a public resource (e.g., commit SHA, external documentation, reference implementation, etc).
+- `Private-ref:` link to a private resource (e.g., issue tracker, pull request, discussion, etc) related to the commit. Private references should only be included in the commit message body using the `Private-ref` token.
Each token may be repeated; however, only one token is allowed per line. Tokens **must** begin with a capital letter followed by all lowercase letters, a colon `:`, and a space. A token **must** not include whitespace, and individual words **must** be separated by a hyphen `-` (e.g., `Reviewed-by`, not `Reviewed by`).
@@ -258,13 +258,13 @@ The only exceptions to the restrictions on token case and inclusion of whitespac
If a commit reverts a previous commit, the commit type **must** be **revert**, followed by the header of the reverted commit. The commit message body should contain:
-- Information about the commit SHA being reverted in the following format:
+- Information about the commit SHA being reverted in the following format:
```text
This reverts commit <SHA>.
```
-- A clear description of the reason for reverting the previous commit.
+- A clear description of the reason for reverting the previous commit.
For example,
@@ -275,7 +275,7 @@ This reverts commit b3befad91a6e39288ea53d540a4a483b0898fb49. The previous
guidance was too restrictive.
```
-* * *
+---
## Discussion
@@ -285,7 +285,7 @@ The [Conventional Commits][conventional-commits] specification requires contribu
**Merge commits**: Git generated commits, such as merge commits, do not follow the above guidelines, but this does not mean that these commits should be avoided. When analyzing commit history (e.g., as part of automation and changelog generation), Git generated commits will be ignored.
-* * *
+---
## License
@@ -294,19 +294,12 @@ This document may be reused under a [Creative Commons Attribution-ShareAlike Lic
<section class="links">
[conventional-commits]: https://www.conventionalcommits.org/en/v1.0.0/
-
[git]: https://git-scm.com/
-
[git-commit-squash]: https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---squashltcommitgt
-
[git-commit-fixup]: https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---fixupamendrewordltcommitgt
-
[git-trailer-format]: https://git-scm.com/docs/git-interpret-trailers
-
[imperative-mood]: https://en.wikipedia.org/wiki/Imperative_mood
-
[semver]: http://semver.org/
-
[license]: https://creativecommons.org/licenses/by-sa/4.0/
</section>
diff --git a/docs/style-guides/go/README.md b/docs/style-guides/go/README.md
index 7cbf82110233..3035a8a3f6be 100644
--- a/docs/style-guides/go/README.md
+++ b/docs/style-guides/go/README.md
@@ -2,19 +2,16 @@
> Style guide for programming in Go.
-- Follow the prescriptions set forth in [Effective Go][effective-go].
-- Use [govet][govet] to find errors not caught by compilers.
-- Use [golint][golint] to lint source code.
-- Use [gofmt][gofmt] to format Go programs before committing to source control.
+- Follow the prescriptions set forth in [Effective Go][effective-go].
+- Use [govet][govet] to find errors not caught by compilers.
+- Use [golint][golint] to lint source code.
+- Use [gofmt][gofmt] to format Go programs before committing to source control.
<section class="links">
[effective-go]: https://golang.org/doc/effective_go.html
-
[govet]: https://golang.org/cmd/vet/
-
[golint]: https://github.com/golang/lint
-
[gofmt]: https://golang.org/cmd/gofmt/
</section>
diff --git a/docs/style-guides/javascript/README.md b/docs/style-guides/javascript/README.md
index b69f1121b6a4..a7b526a1adfe 100644
--- a/docs/style-guides/javascript/README.md
+++ b/docs/style-guides/javascript/README.md
@@ -35,7 +35,7 @@
## Introduction
-Always abide by the **Law of Code Style Consistency**, or, in other words, _when in Rome, do as the Romans do_.
+Always abide by the **Law of Code Style Consistency**, or, in other words, _when in Rome, do as the Romans do_.
While the code base to which you want to contribute may be a horrific mess in terms of aesthetic appearance and style, style consistency takes precedence over personal preference and canon. The more consistent a code base is in terms of style, the more readers of the code can focus on what the code does rather than deciphering changes in style.
@@ -47,13 +47,13 @@ Hopefully, most of the conventions outlined below will help enable you to do so.
## General Principles
-- Prefer standards to non-standards.
-- Do one thing and do one thing well.
-- Keep your code clean. Create feature branches for experimental development, extensive annotations, and/or alternative implementations.
+- Prefer standards to non-standards.
+- Do one thing and do one thing well.
+- Keep your code clean. Create feature branches for experimental development, extensive annotations, and/or alternative implementations.
<!-- <rule-set> -->
-* * *
+---
## Whitespace
@@ -71,15 +71,15 @@ Hopefully, most of the conventions outlined below will help enable you to do so.
##### Notes
-- Even if you must use spaces, **never** mix tabs and spaces. This is formatting hell, as a simple find-and-replace is useless in the face of such chaos.
+- Even if you must use spaces, **never** mix tabs and spaces. This is formatting hell, as a simple find-and-replace is useless in the face of such chaos.
##### Enforcement
This project contains an [`.editorconfig`][editorconfig] file to be used in conjunction with IDE and/or browser plugins.
-- [sublime text][sublime-text-editorconfig]
-- [atom][atom-editorconfig]
-- [chrome][chrome-editorconfig]
+- [sublime text][sublime-text-editorconfig]
+- [atom][atom-editorconfig]
+- [chrome][chrome-editorconfig]
<!-- </rule> -->
@@ -97,7 +97,7 @@ Including `1` space before a leading brace improves readability.
```javascript
// Do not...
-function query(){
+function query() {
// Do something...
}
```
@@ -131,7 +131,7 @@ Including `1` space before and after arguments improves readability.
```javascript
// Do not...
-function test(arg1,arg2,arg3) {
+function test(arg1, arg2, arg3) {
// Do something...
}
```
@@ -140,7 +140,7 @@ function test(arg1,arg2,arg3) {
```javascript
// Do...
-function test( arg1, arg2, arg3 ) {
+function test(arg1, arg2, arg3) {
// Do something...
}
```
@@ -170,16 +170,16 @@ var foo = bar[10];
```javascript
// Do...
-var foo = bar[ 10 ];
+var foo = bar[10];
```
##### Notes
-- Use discretion when using spaces around `array` indices buried in braces.
+- Use discretion when using spaces around `array` indices buried in braces.
```javascript
// Okay:
- var foo = myFunction( ( a === b ) ? bar[0] : bar[1] );
+ var foo = myFunction(a === b ? bar[0] : bar[1]);
```
##### Enforcement
@@ -200,7 +200,7 @@ Including `1` space before and after operators improves readability.
```javascript
// Do not...
-var a=1+1;
+var a = 1 + 1;
```
##### Good Example
@@ -212,14 +212,19 @@ var a = 1 + 1;
##### Notes
-- Use discretion when operators are contained within complex expressions and `string` concatenation.
+- Use discretion when operators are contained within complex expressions and `string` concatenation.
```javascript
// Okay...
- var str = 'This is a long string by '+firstName+' '+lastName+', which may keep going and going and...';
+ var str =
+ "This is a long string by " +
+ firstName +
+ " " +
+ lastName +
+ ", which may keep going and going and...";
// Okay...
- var n = ((x+y+z)*(t-w-v)) + 5;
+ var n = (x + y + z) * (t - w - v) + 5;
```
##### Enforcement
@@ -242,8 +247,8 @@ Immediate juxtaposition makes evident what is being affected.
```javascript
// Do not...
-x = ++ y;
-z = z ++;
+x = ++y;
+z = z++;
```
##### Good Example
@@ -280,9 +285,9 @@ Including `1` space after comment marks improves readability.
//This is a single-line comment.
/*
-*This is a mult-
-*line comment.
-*/
+ *This is a mult-
+ *line comment.
+ */
```
##### Good Example
@@ -293,9 +298,9 @@ Including `1` space after comment marks improves readability.
// This is a single-line comment.
/*
-* This is a multi-
-* line comment.
-*/
+ * This is a multi-
+ * line comment.
+ */
```
##### Enforcement
@@ -330,10 +335,10 @@ Some IDEs have a tendency to auto-indent based on the previous line, thus pushin
// Do...
/*
-* This is a multi-line comment.
-* The comment continues and continues...
-* ...until it no longer does.
-*/
+ * This is a multi-line comment.
+ * The comment continues and continues...
+ * ...until it no longer does.
+ */
```
##### Enforcement
@@ -354,19 +359,26 @@ Indentation improves readability.
```javascript
// Do not...
-var svg = d3.select( '.main' ).append( 'svg:svg' ).attr( 'class', 'canvas' ).attr( 'data-id', Date.now() ).attr( 'width', 100 ).attr( 'height', 100 );
+var svg = d3
+ .select(".main")
+ .append("svg:svg")
+ .attr("class", "canvas")
+ .attr("data-id", Date.now())
+ .attr("width", 100)
+ .attr("height", 100);
```
##### Good Example
```javascript
// Do...
-var svg = d3.select( '.main' )
- .append( 'svg:svg' )
- .attr( 'class', 'canvas' )
- .attr( 'data-id', Date.now() )
- .attr( 'width', 100 )
- .attr( 'height', 100 );
+var svg = d3
+ .select(".main")
+ .append("svg:svg")
+ .attr("class", "canvas")
+ .attr("data-id", Date.now())
+ .attr("width", 100)
+ .attr("height", 100);
```
##### Enforcement
@@ -387,10 +399,9 @@ Newline is unnecessary.
```javascript
// Do not...
-if ( foo === bar ) {
+if (foo === bar) {
// Do something...
-}
-else {
+} else {
// Do something different...
}
```
@@ -399,7 +410,7 @@ else {
```javascript
// Do...
-if ( foo === bar ) {
+if (foo === bar) {
// Do something...
} else {
// Do something different...
@@ -408,50 +419,47 @@ if ( foo === bar ) {
##### Notes
-- Use discretion when faced with multiple conditions.
+- Use discretion when faced with multiple conditions.
```javascript
// Do...
- if ( foo === bar ) {
+ if (foo === bar) {
// Do something...
- } else if ( foo === beep ) {
+ } else if (foo === beep) {
// Do something else...
- } else if ( bar === bar ) {
+ } else if (bar === bar) {
// Do something more...
} else {
// Do something different...
}
// Okay...
- if ( foo === bar ) {
+ if (foo === bar) {
// Do something...
- }
- else if ( foo === beep ) {
+ } else if (foo === beep) {
// Do something else...
- }
- else if ( baz === bar ) {
+ } else if (baz === bar) {
// Do something more...
- }
- else {
+ } else {
// Do something different...
}
```
-- Use discretion when documenting conditions.
+- Use discretion when documenting conditions.
```javascript
// Okay...
// `bar` can only equal `foo` when...
- if ( foo === bar ) {
+ if (foo === bar) {
// Do something...
}
// `beep` can only equal `foo` when...
- else if ( foo === beep ) {
+ else if (foo === beep) {
// Do something else...
}
// This pathway should rarely be taken...
- else if ( baz === bar ) {
+ else if (baz === bar) {
// Do something more...
}
// `foo` equals `bap`
@@ -480,15 +488,15 @@ Indenting the `case` keyword within `switch` statements results in excessive ind
```javascript
// Do not...
-switch ( foo ) {
- case 'bar':
+switch (foo) {
+ case "bar":
// Do something...
break;
- case 'beep':
+ case "beep":
// Do something...
break;
default:
- // Do something...
+ // Do something...
}
```
@@ -496,14 +504,14 @@ switch ( foo ) {
```javascript
// Do...
-switch ( foo ) {
-case 'bar':
- // Do something...
- break;
-case 'beep':
- // Do something...
- break;
-default:
+switch (foo) {
+ case "bar":
+ // Do something...
+ break;
+ case "beep":
+ // Do something...
+ break;
+ default:
// Do something...
}
```
@@ -518,7 +526,7 @@ TODO: ESLint rule
<!-- <rule-set> -->
-* * *
+---
## Semicolons
@@ -536,7 +544,7 @@ While semicolons are [not required][ecma-262] in most cases due to [automatic se
```javascript
// Do not...
-var bar = foo()
+var bar = foo();
```
##### Good Example
@@ -556,7 +564,7 @@ TODO: ESLint rule
<!-- <rule-set> -->
-* * *
+---
## Parentheses
@@ -574,14 +582,14 @@ Including parentheses around the test condition in ternary operators improves re
```javascript
// Do not...
-var foo = a === b ? a*3 : b/4;
+var foo = a === b ? a * 3 : b / 4;
```
##### Good Example
```javascript
// Do...
-var foo = ( a === b ) ? a*3 : b/4;
+var foo = a === b ? a * 3 : b / 4;
```
##### Enforcement
@@ -594,7 +602,7 @@ TODO
<!-- <rule-set> -->
-* * *
+---
## Variables
@@ -613,7 +621,7 @@ Doing so makes variable hoisting explicit.
function myFunction() {
var foo = 3;
- if ( foo ) {
+ if (foo) {
// Do something...
}
var bar = foo * 5;
@@ -628,7 +636,7 @@ function myFunction() {
var foo = 3;
var bar;
- if ( foo ) {
+ if (foo) {
// Do something...
}
bar = foo * 5;
@@ -655,7 +663,7 @@ Adding, removing, and reordering variables is easier. Additionally, `git` diffs
```javascript
// Do not...
-var boop = 'hello',
+var boop = "hello",
beep = false,
bar = null,
foo = 3;
@@ -665,7 +673,7 @@ var boop = 'hello',
```javascript
// Do...
-var boop = 'hello';
+var boop = "hello";
var beep = false;
var bar = null;
var foo = 3;
@@ -691,8 +699,11 @@ Declaring variables on separate lines improves readability.
```javascript
// Do not...
-var beep; var boop;
-var bop; var bap; var i;
+var beep;
+var boop;
+var bop;
+var bap;
+var i;
```
##### Good Example
@@ -786,7 +797,7 @@ Code review.
<!-- <rule-set> -->
-* * *
+---
## Strings
@@ -811,7 +822,7 @@ var str = "Hello";
```javascript
// Do...
-var str = 'Hello';
+var str = "Hello";
```
##### Enforcement
@@ -830,7 +841,7 @@ Immediate evaluation prevents a template being stored in a variable. Token synta
##### Notes
-- A function which performs string concatenation is equivalently effective.
+- A function which performs string concatenation is equivalently effective.
##### Enforcement
@@ -842,7 +853,7 @@ TODO: ESLint rule. Code review.
<!-- <rule-set> -->
-* * *
+---
## Arrays
@@ -892,8 +903,8 @@ Allows compiler to pre-allocate memory.
// Do not...
var arr = [];
var i;
-for ( i = 0; i < 100; i++ ) {
- arr.push( Math.random() );
+for (i = 0; i < 100; i++) {
+ arr.push(Math.random());
}
```
@@ -903,16 +914,16 @@ for ( i = 0; i < 100; i++ ) {
```javascript
// Do...
-var arr = new Array( 100 );
+var arr = new Array(100);
var i;
-for ( i = 0; i < arr.length; i++ ) {
- arr[ i ] = Math.random();
+for (i = 0; i < arr.length; i++) {
+ arr[i] = Math.random();
}
```
##### Notes
-- Do **not** use the `new` operator if the `array` length is **very large** due to how compilers handle "fast" elements. Instead, to ensure "fast" elements,
+- Do **not** use the `new` operator if the `array` length is **very large** due to how compilers handle "fast" elements. Instead, to ensure "fast" elements,
<!-- eslint-disable stdlib/no-builtin-math -->
@@ -921,8 +932,8 @@ for ( i = 0; i < arr.length; i++ ) {
var i;
arr = [];
- for ( i = 0; i < 1e7; i++ ) {
- arr.push( Math.random() );
+ for (i = 0; i < 1e7; i++) {
+ arr.push(Math.random());
}
```
@@ -944,7 +955,7 @@ More explicit and efficient. Additionally, passing the `arguments` object to any
```javascript
// Do not...
-var args = Array.prototype.slice.call( arguments );
+var args = Array.prototype.slice.call(arguments);
```
##### Good Example
@@ -952,10 +963,10 @@ var args = Array.prototype.slice.call( arguments );
```javascript
// Do...
var nargs = arguments.length;
-var args = new Array( nargs );
+var args = new Array(nargs);
var i;
-for ( i = 0; i < nargs; i++ ) {
- args[ i ] = arguments[ i ];
+for (i = 0; i < nargs; i++) {
+ args[i] = arguments[i];
}
```
@@ -971,7 +982,7 @@ Code review.
##### Reason
-When copying a small `array`, using `Array#slice()` incurs a function overhead which outweighs benefits. Thus, a `for` loop is more efficient. For larger `arrays`, function cost is comparable to or less than loop cost in addition to the runtime engine being able to optimize for copying large chunks of memory.
+When copying a small `array`, using `Array#slice()` incurs a function overhead which outweighs benefits. Thus, a `for` loop is more efficient. For larger `arrays`, function cost is comparable to or less than loop cost in addition to the runtime engine being able to optimize for copying large chunks of memory.
##### Small Array Example
@@ -979,15 +990,15 @@ When copying a small `array`, using `Array#slice()` incurs a function overhead w
```javascript
// Do...
-var arr = new Array( 10 );
-var out = new Array( arr.length );
+var arr = new Array(10);
+var out = new Array(arr.length);
var i;
-for ( i = 0; i < arr.length; i++ ) {
- arr[ i ] = Math.random();
+for (i = 0; i < arr.length; i++) {
+ arr[i] = Math.random();
}
// Copy...
-for ( i = 0; i < arr.length; i++ ) {
- out[ i ] = arr[ i ];
+for (i = 0; i < arr.length; i++) {
+ out[i] = arr[i];
}
```
@@ -997,11 +1008,11 @@ for ( i = 0; i < arr.length; i++ ) {
```javascript
// Do...
-var arr = new Array( 10000 );
+var arr = new Array(10000);
var out;
var i;
-for ( i = 0; i < arr.length; i++ ) {
- arr[ i ] = Math.random();
+for (i = 0; i < arr.length; i++) {
+ arr[i] = Math.random();
}
// Copy...
out = arr.slice();
@@ -1017,7 +1028,7 @@ Code review.
<!-- <rule-set> -->
-* * *
+---
## Objects
@@ -1035,7 +1046,14 @@ Splitting `object` properties over multiple lines improves readability.
```javascript
// Do not...
-var obj = { 'a': null, 'b': 5, 'c': function c() { return true; }, 'd': ( foo === bar ) ? foo : bar };
+var obj = {
+ a: null,
+ b: 5,
+ c: function c() {
+ return true;
+ },
+ d: foo === bar ? foo : bar,
+};
```
##### Good Example
@@ -1045,12 +1063,12 @@ var obj = { 'a': null, 'b': 5, 'c': function c() { return true; }, 'd': ( foo ==
```javascript
// Do...
var obj = {
- 'a': null,
- 'b': 5,
- 'c': function c() {
+ a: null,
+ b: 5,
+ c: function c() {
return true;
},
- 'd': ( foo === bar ) ? foo : bar
+ d: foo === bar ? foo : bar,
};
```
@@ -1075,9 +1093,9 @@ For complex `objects`, matching properties and their corresponding values become
```javascript
// Do not...
var obj = {
- 'prop' : true,
- 'attribute': 'foo',
- 'name' : 'bar'
+ prop: true,
+ attribute: "foo",
+ name: "bar",
};
```
@@ -1086,9 +1104,9 @@ var obj = {
```javascript
// Do...
var obj = {
- 'prop': true,
- 'attribute': 'foo',
- 'name': 'bar'
+ prop: true,
+ attribute: "foo",
+ name: "bar",
};
```
@@ -1113,9 +1131,9 @@ An object which includes a trailing comma is not valid JSON.
```javascript
// Do not...
var obj = {
- 'prop': true,
- 'attribute': 'foo',
- 'name': 'bar', // <= DON'T
+ prop: true,
+ attribute: "foo",
+ name: "bar", // <= DON'T
};
```
@@ -1124,9 +1142,9 @@ var obj = {
```javascript
// Do...
var obj = {
- 'prop': true,
- 'attribute': 'foo',
- 'name': 'bar'
+ prop: true,
+ attribute: "foo",
+ name: "bar",
};
```
@@ -1149,25 +1167,25 @@ Unnecessary syntactic sugar. In complex objects, shorthand notation decreases re
<!-- eslint-disable object-property-newline, object-shorthand, object-curly-newline -->
```javascript
-var foo = 'beep';
+var foo = "beep";
var x = true;
var y = 10;
-var obj = { foo, 'baz': 'boop', x, y };
+var obj = { foo, baz: "boop", x, y };
```
##### Good Example
```javascript
-var foo = 'beep';
+var foo = "beep";
var x = true;
var y = 10;
var obj = {
- 'foo': foo,
- 'baz': 'boop',
- 'x': x,
- 'y': y
+ foo: foo,
+ baz: "boop",
+ x: x,
+ y: y,
};
```
@@ -1181,7 +1199,7 @@ TODO: ESLint rule. Code review.
<!-- <rule-set> -->
-* * *
+---
## Functions
@@ -1200,7 +1218,7 @@ Declaring `functions` using [function statements][function-statements], rather t
```javascript
// Do not...
var beep = function () {
- console.log( 'boop' );
+ console.log("boop");
};
```
@@ -1209,7 +1227,7 @@ var beep = function () {
```javascript
// Do...
function beep() {
- console.log( 'boop' );
+ console.log("boop");
}
```
@@ -1272,12 +1290,12 @@ Declaring within loops and conditions may result in repeated function creation,
```javascript
// Do not...
-function beep( idx, clbk ) {
- clbk( 'beep'+idx );
+function beep(idx, clbk) {
+ clbk("beep" + idx);
}
-for ( var i = 0; i < 10; i++ ) {
- beep( i, function bop( msg ) {
- console.log( msg );
+for (var i = 0; i < 10; i++) {
+ beep(i, function bop(msg) {
+ console.log(msg);
});
}
```
@@ -1286,15 +1304,15 @@ for ( var i = 0; i < 10; i++ ) {
```javascript
// Do...
-function beep( idx, clbk ) {
- clbk( 'beep'+idx );
+function beep(idx, clbk) {
+ clbk("beep" + idx);
}
-function bop( msg ) {
- console.log( msg );
+function bop(msg) {
+ console.log(msg);
}
-for ( var i = 0; i < 10; i++ ) {
- beep( i, bop );
+for (var i = 0; i < 10; i++) {
+ beep(i, bop);
}
```
@@ -1304,10 +1322,10 @@ for ( var i = 0; i < 10; i++ ) {
```javascript
// Do not...
-for ( var i = 0; i < 10; i++ ) {
- setTimeout( function onTimeout() {
- console.log( i );
- }, 1000 );
+for (var i = 0; i < 10; i++) {
+ setTimeout(function onTimeout() {
+ console.log(i);
+ }, 1000);
}
```
@@ -1315,15 +1333,15 @@ for ( var i = 0; i < 10; i++ ) {
```javascript
// Do...
-function clbk( idx ) {
+function clbk(idx) {
return onTimeout;
function onTimeout() {
- console.log( idx );
+ console.log(idx);
}
}
-for ( var i = 0; i < 10; i++ ) {
- setTimeout( clbk( i ), 1000 );
+for (var i = 0; i < 10; i++) {
+ setTimeout(clbk(i), 1000);
}
```
@@ -1334,7 +1352,7 @@ for ( var i = 0; i < 10; i++ ) {
```javascript
// Do not...
var i = Math.random() * 20;
-if ( i < 11 ) {
+if (i < 11) {
bap();
function bap() {
// Do something...
@@ -1352,7 +1370,7 @@ function bap() {
// Do something...
}
var i = Math.random() * 20;
-if ( i < 11 ) {
+if (i < 11) {
bap();
}
```
@@ -1413,24 +1431,24 @@ Reduces noise when first attempting to understand implementation flow, especiall
```javascript
// Don't...
-function getEquation( a, b, c ) {
+function getEquation(a, b, c) {
/**
- * Computes a complex equation.
- *
- * @private
- * @param {number} e - dynamic value
- * @returns {number} equation output
- */
- function eqn( e ) {
- return e - d + ( 15 * a ) + ( Math.pow( b, 1 / c ) );
+ * Computes a complex equation.
+ *
+ * @private
+ * @param {number} e - dynamic value
+ * @returns {number} equation output
+ */
+ function eqn(e) {
+ return e - d + 15 * a + Math.pow(b, 1 / c);
}
var d;
a *= 3;
b = a / 5;
- c = Math.pow( b, 3 );
+ c = Math.pow(b, 3);
- d = a + ( b / c );
+ d = a + b / c;
return eqn;
}
@@ -1442,26 +1460,26 @@ function getEquation( a, b, c ) {
```javascript
// Do...
-function getEquation( a, b, c ) {
+function getEquation(a, b, c) {
var d;
a *= 3;
b = a / 5;
- c = Math.pow( b, 3 );
+ c = Math.pow(b, 3);
- d = a + ( b / c );
+ d = a + b / c;
return eqn;
/**
- * Computes a complex equation.
- *
- * @private
- * @param {number} e - dynamic value
- * @returns {number} equation output
- */
- function eqn( e ) {
- return e - d + ( 15 * a ) + ( Math.pow( b, 1 / c ) );
+ * Computes a complex equation.
+ *
+ * @private
+ * @param {number} e - dynamic value
+ * @returns {number} equation output
+ */
+ function eqn(e) {
+ return e - d + 15 * a + Math.pow(b, 1 / c);
}
}
```
@@ -1486,7 +1504,7 @@ Function calls introduce additional overhead and, often, functional counterparts
```javascript
// Do not...
-var squared = arr.map( function square( value ) {
+var squared = arr.map(function square(value) {
return value * value;
});
```
@@ -1494,11 +1512,11 @@ var squared = arr.map( function square( value ) {
##### Good Example
```javascript
-var squared = new Array( arr.length );
+var squared = new Array(arr.length);
// Do...
-for ( var i = 0; i < arr.length; i++ ) {
- squared[ i ] = arr[ i ] * arr[ i ];
+for (var i = 0; i < arr.length; i++) {
+ squared[i] = arr[i] * arr[i];
}
```
@@ -1520,16 +1538,22 @@ Code review.
```javascript
// No braces:
-var f = x => x + 1;
+var f = (x) => x + 1;
// Some braces:
f = (x, y) => x + y;
// Some other braces:
-f = x => { x += 20; return x.toString(); };
+f = (x) => {
+ x += 20;
+ return x.toString();
+};
// Many braces:
-f = (x, y) => { x += y; return x.toString(); };
+f = (x, y) => {
+ x += y;
+ return x.toString();
+};
```
(3) Implicit `returns` can lead to subtle bugs and require a constant mental model as to what is returned and when.
@@ -1567,17 +1591,17 @@ z = y( 10 );
<!-- eslint-disable arrow-body-style, no-restricted-syntax, arrow-parens -->
```javascript
-var squared = arr.map( x => x*x );
+var squared = arr.map((x) => x * x);
```
##### Good Example
```javascript
-function square( x ) {
+function square(x) {
return x * x;
}
-var squared = arr.map( square );
+var squared = arr.map(square);
```
##### Enforcement
@@ -1598,30 +1622,33 @@ This follows the Node.js callback convention.
```javascript
// Do...
-function clbk( error, value ) {
- if ( error ) {
+function clbk(error, value) {
+ if (error) {
return;
}
- console.log( value );
+ console.log(value);
}
-function onResponse( error, response, body ) {
- if ( error ) {
- clbk( error );
+function onResponse(error, response, body) {
+ if (error) {
+ clbk(error);
return;
}
- clbk( null, body );
+ clbk(null, body);
}
-request({
- 'method': 'GET',
- 'uri': 'http://127.0.0.1'
-}, onResponse );
+request(
+ {
+ method: "GET",
+ uri: "http://127.0.0.1",
+ },
+ onResponse,
+);
```
##### Notes
-- If no errors, the `error` argument should be `null`.
+- If no errors, the `error` argument should be `null`.
##### Enforcement
@@ -1655,16 +1682,16 @@ Avoids nested callback hell.
```javascript
// Do not...
-function deferredComputation( value ) {
+function deferredComputation(value) {
return compute;
function compute() {
return cube();
function cube() {
var v;
- v = mult( value, value );
- v = mult( v, value );
+ v = mult(value, value);
+ v = mult(v, value);
return v;
- function mult( x, y ) {
+ function mult(x, y) {
return x * y;
}
}
@@ -1676,24 +1703,24 @@ function deferredComputation( value ) {
```javascript
// Do...
-function mult( x, y ) {
+function mult(x, y) {
return x * y;
}
-function cube( value ) {
+function cube(value) {
var v;
- v = mult( value, value );
- v = mult( v, value );
+ v = mult(value, value);
+ v = mult(v, value);
return v;
}
-function deferred( value ) {
+function deferred(value) {
return compute;
function compute() {
- return cube( value );
+ return cube(value);
}
}
-function deferredComputation( value ) {
- return deferred( value );
+function deferredComputation(value) {
+ return deferred(value);
}
```
@@ -1718,12 +1745,12 @@ Named `functions` are easier to find in stack traces and consequently debug.
```javascript
// Do not...
-function beep( f ) {
+function beep(f) {
f();
}
-beep( function () {
- console.log( 'boop' );
+beep(function () {
+ console.log("boop");
});
```
@@ -1732,14 +1759,14 @@ beep( function () {
```javascript
// Do...
-function beep( f ) {
+function beep(f) {
f();
}
function boop() {
- console.log( 'boop' );
+ console.log("boop");
}
-beep( boop );
+beep(boop);
```
##### Enforcement
@@ -1752,7 +1779,7 @@ TODO: ESLint rule
<!-- <rule-set> -->
-* * *
+---
## Strict Mode
@@ -1769,18 +1796,18 @@ Writing JavaScript in [strict mode][strict-mode] discourages bad practices, avoi
<!-- eslint-skip -->
```javascript
-'use strict';
+"use strict";
NaN = null; // throws an Error
```
##### Notes
-- Prefer [strict mode][strict-mode] for a whole script. If not possible, use [strict mode][strict-mode] for each available `function`.
+- Prefer [strict mode][strict-mode] for a whole script. If not possible, use [strict mode][strict-mode] for each available `function`.
```javascript
function beep() {
- 'use strict';
+ "use strict";
delete Object.prototype; // throws an Error
}
@@ -1796,7 +1823,7 @@ TODO: ESLint rule
<!-- <rule-set> -->
-* * *
+---
## Arguments
@@ -1813,7 +1840,7 @@ Doing so automatically puts the `function` in optimization hell.
```javascript
// Do not...
function fcn() {
- var out = foo( arguments );
+ var out = foo(arguments);
}
```
@@ -1823,14 +1850,14 @@ function fcn() {
// Do...
function fcn() {
var nargs = arguments.length;
- var args = new Array( nargs );
+ var args = new Array(nargs);
var out;
var i;
- for ( i = 0; i < nargs; i++ ) {
- args[ i ] = arguments[ i ];
+ for (i = 0; i < nargs; i++) {
+ args[i] = arguments[i];
}
- out = foo( args );
+ out = foo(args);
}
```
@@ -1852,13 +1879,13 @@ Recycling variables when mentioning `arguments` in a `function` body prevents co
```javascript
// Do not...
-function fcn( value, options ) {
+function fcn(value, options) {
var err;
- if ( arguments.length < 2 ) {
+ if (arguments.length < 2) {
options = value;
}
- err = validate( options );
- if ( err ) {
+ err = validate(options);
+ if (err) {
throw err;
}
// ...
@@ -1869,17 +1896,17 @@ function fcn( value, options ) {
```javascript
// Do...
-function fcn( value, options ) {
+function fcn(value, options) {
var opts;
var err;
- if ( arguments.length < 2 ) {
+ if (arguments.length < 2) {
opts = value;
} else {
opts = options;
}
- err = validate( opts );
- if ( err ) {
+ err = validate(opts);
+ if (err) {
throw err;
}
// ...
@@ -1896,7 +1923,7 @@ TODO: ESLint rule
<!-- <rule-set> -->
-* * *
+---
## Regular Expressions
@@ -1912,8 +1939,8 @@ Ensures a regular expression is only created once and improves readability.
```javascript
// Do not...
-function beep( str ) {
- if ( /\.+/.test( str ) ) {
+function beep(str) {
+ if (/\.+/.test(str)) {
// Do something...
}
}
@@ -1927,8 +1954,8 @@ beep();
// Do...
var RE = /\.+/;
-function beep( str ) {
- if ( RE.test( str ) ) {
+function beep(str) {
+ if (RE.test(str)) {
// Do something...
}
}
@@ -1956,50 +1983,50 @@ Regular expressions are error prone and difficult to understand without thorough
```javascript
/**
-* Matches parts of a regular expression string.
-*
-* Regular expression: `/^\/((?:\\\/|[^\/])+)\/([imgy]*)$/`
-*
-* `/^\/`
-*
-* - match a string that begins with a `/`
-*
-* `()`
-*
-* - capture
-*
-* `(?:)+`
-*
-* - capture, but do not remember, a group of characters which occur one or more times
-*
-* `\\\/`
-*
-* - match the literal `\/`
-*
-* `|`
-*
-* - OR
-*
-* `[^\/]`
-*
-* - anything which is not the literal `\/`
-*
-* `\/`
-*
-* - match the literal `/`
-*
-* `([imgy]*)`
-*
-* - capture any characters matching `imgy` occurring zero or more times
-*
-* `$/`
-*
-* - string end
-*
-* @constant
-* @type {RegExp}
-* @default /^\/((?:\\\/|[^\/])+)\/([imgy]*)$/
-*/
+ * Matches parts of a regular expression string.
+ *
+ * Regular expression: `/^\/((?:\\\/|[^\/])+)\/([imgy]*)$/`
+ *
+ * `/^\/`
+ *
+ * - match a string that begins with a `/`
+ *
+ * `()`
+ *
+ * - capture
+ *
+ * `(?:)+`
+ *
+ * - capture, but do not remember, a group of characters which occur one or more times
+ *
+ * `\\\/`
+ *
+ * - match the literal `\/`
+ *
+ * `|`
+ *
+ * - OR
+ *
+ * `[^\/]`
+ *
+ * - anything which is not the literal `\/`
+ *
+ * `\/`
+ *
+ * - match the literal `/`
+ *
+ * `([imgy]*)`
+ *
+ * - capture any characters matching `imgy` occurring zero or more times
+ *
+ * `$/`
+ *
+ * - string end
+ *
+ * @constant
+ * @type {RegExp}
+ * @default /^\/((?:\\\/|[^\/])+)\/([imgy]*)$/
+ */
var RE = /^\/((?:\\\/|[^\/])+)\/([imgy]*)$/;
```
@@ -2013,7 +2040,7 @@ Code review.
<!-- <rule-set> -->
-* * *
+---
## Blocks
@@ -2032,7 +2059,7 @@ Not using them is a common source of bugs.
```javascript
// Do not...
function beep() {
- if ( foo === bar ) return true;
+ if (foo === bar) return true;
}
```
@@ -2041,7 +2068,7 @@ function beep() {
```javascript
// Do...
function beep() {
- if ( foo === bar ) {
+ if (foo === bar) {
return true;
}
}
@@ -2065,13 +2092,11 @@ Avoids unnecessary newline character.
```javascript
// Do not...
-if ( foo === bar )
-{
+if (foo === bar) {
// Do something...
}
-function query()
-{
+function query() {
// Do something...
}
```
@@ -2080,7 +2105,7 @@ function query()
```javascript
// Do...
-if ( foo === bar ) {
+if (foo === bar) {
// Do something...
}
@@ -2107,12 +2132,12 @@ Doing so reduces code branching and indentation.
```javascript
// Do not...
-function foo( value ) {
+function foo(value) {
var str;
- if ( value === 'bar' ) {
- str = 'Hello';
+ if (value === "bar") {
+ str = "Hello";
} else {
- str = 'Goodbye';
+ str = "Goodbye";
}
return str;
}
@@ -2122,11 +2147,11 @@ function foo( value ) {
```javascript
// Do...
-function foo( value ) {
- if ( value === 'bar' ) {
- return 'Hello';
+function foo(value) {
+ if (value === "bar") {
+ return "Hello";
}
- return 'Goodbye';
+ return "Goodbye";
}
```
@@ -2148,8 +2173,8 @@ Reduces code branching and indentation.
```javascript
// Do not...
-for ( var i = 0; i < 10; i++ ) {
- if ( i !== 5 ) {
+for (var i = 0; i < 10; i++) {
+ if (i !== 5) {
// Do something...
}
}
@@ -2159,8 +2184,8 @@ for ( var i = 0; i < 10; i++ ) {
```javascript
// Do...
-for ( var i = 0; i < 10; i++ ) {
- if ( i === 5 ) {
+for (var i = 0; i < 10; i++) {
+ if (i === 5) {
continue;
}
// Do something...
@@ -2177,7 +2202,7 @@ Code review.
<!-- <rule-set> -->
-* * *
+---
## Equality
@@ -2195,7 +2220,7 @@ Not enforcing type equality is a source of bugs.
```javascript
// Do not...
-if ( foo != bar ) {
+if (foo != bar) {
// Do something...
}
```
@@ -2204,7 +2229,7 @@ if ( foo != bar ) {
```javascript
// Do...
-if ( foo === bar ) {
+if (foo === bar) {
// Do something...
}
```
@@ -2219,7 +2244,7 @@ TODO: ESLint rule
<!-- <rule-set> -->
-* * *
+---
## Errors
@@ -2235,14 +2260,18 @@ Simplifies debugging.
```javascript
// Do not...
-var err = new Error( '1' );
+var err = new Error("1");
```
##### Good Example
```javascript
// Do...
-var err = new TypeError( 'invalid argument. Window option must be a positive integer. Value: `' + value + '`.' );
+var err = new TypeError(
+ "invalid argument. Window option must be a positive integer. Value: `" +
+ value +
+ "`.",
+);
```
##### Enforcement
@@ -2265,11 +2294,11 @@ Throw and provide tailored `error` messages if expected conditions are not met.
// Don't...
/**
-* Beep boop.
-*
-* @param {Function} clbk - callback
-*/
-function boop( clbk ) {
+ * Beep boop.
+ *
+ * @param {Function} clbk - callback
+ */
+function boop(clbk) {
clbk();
}
```
@@ -2280,13 +2309,15 @@ function boop( clbk ) {
// Do...
/**
-* Beep boop.
-*
-* @param {Function} clbk - callback
-*/
-function beep( clbk ) {
- if ( !arguments.length ) {
- throw new Error( 'insufficient input arguments. Must provide a callback function.' );
+ * Beep boop.
+ *
+ * @param {Function} clbk - callback
+ */
+function beep(clbk) {
+ if (!arguments.length) {
+ throw new Error(
+ "insufficient input arguments. Must provide a callback function.",
+ );
}
clbk();
}
@@ -2310,7 +2341,7 @@ For public facing APIs, dynamic type checking makes contracts explicit, facilita
```javascript
// Do not...
-function bar( opts ) {
+function bar(opts) {
// What happens if `opts` or `opts.ssl` are not objects???
var key = opts.ssl.key;
}
@@ -2320,37 +2351,45 @@ function bar( opts ) {
```javascript
// Do...
-function foo( opts ) {
- if ( !isObject( opts ) ) {
- throw new TypeError( 'invalid argument. Options argument must be an object. Value: `' + opts + '`.' );
+function foo(opts) {
+ if (!isObject(opts)) {
+ throw new TypeError(
+ "invalid argument. Options argument must be an object. Value: `" +
+ opts +
+ "`.",
+ );
}
}
```
##### Notes
-- When performing dynamic type checks, **always** include the invalid value in the `error` message. Doing so makes debugging and logging easier.
+- When performing dynamic type checks, **always** include the invalid value in the `error` message. Doing so makes debugging and logging easier.
```javascript
// Do...
- function bop( len ) {
- if ( !isPositiveInteger( len ) ) {
- throw new TypeError( 'invalid argument. Length must be a positive integer. Value: `' + len + '`.' );
+ function bop(len) {
+ if (!isPositiveInteger(len)) {
+ throw new TypeError(
+ "invalid argument. Length must be a positive integer. Value: `" +
+ len +
+ "`.",
+ );
}
}
// Do not...
- function bap( len ) {
- if ( !isPositiveInteger( len ) ) {
- throw new Error( 'invalid value.' );
+ function bap(len) {
+ if (!isPositiveInteger(len)) {
+ throw new Error("invalid value.");
}
}
```
##### Enforcement
-- Unit tests
-- Code review
+- Unit tests
+- Code review
<!-- </rule> -->
@@ -2366,10 +2405,10 @@ Not crashing upon encountering an [`uncaughtException`][uncaught-exception] leav
```javascript
// DO NOT...
-function onError( error ) {
- console.error( 'Caught exception. Err: %s', error.message );
+function onError(error) {
+ console.error("Caught exception. Err: %s", error.message);
}
-process.on( 'uncaughtException', onError );
+process.on("uncaughtException", onError);
```
##### Okay Example
@@ -2378,11 +2417,11 @@ process.on( 'uncaughtException', onError );
```javascript
// Okay...
-function onError( error ) {
- console.error( 'Caught exception. Err: %s', error.message );
- process.exit( 1 ); // <= THIS IS KEY!!!!
+function onError(error) {
+ console.error("Caught exception. Err: %s", error.message);
+ process.exit(1); // <= THIS IS KEY!!!!
}
-process.on( 'uncaughtException', onError );
+process.on("uncaughtException", onError);
```
##### Enforcement
@@ -2403,10 +2442,10 @@ Designing asynchronous APIs in this fashion matches the [convention][errbacks] f
```javascript
// Do not...
-function badAsync( clbk ) {
- setTimeout( done, 1000 );
+function badAsync(clbk) {
+ setTimeout(done, 1000);
function done() {
- clbk( 'beep' );
+ clbk("beep");
}
}
```
@@ -2415,10 +2454,10 @@ function badAsync( clbk ) {
```javascript
// Do...
-function goodAsync( clbk ) {
- setTimeout( done, 1000 );
+function goodAsync(clbk) {
+ setTimeout(done, 1000);
function done() {
- clbk( null, 'beep' );
+ clbk(null, "beep");
}
}
```
@@ -2441,23 +2480,19 @@ Code review.
```javascript
// Do not...
-response
- .send( 200 )
- .json({
- 'success': false
- });
+response.send(200).json({
+ success: false,
+});
```
##### Good Example
```javascript
// Do...
-response
- .status( 502 )
- .json({
- 'status': 502,
- 'message': 'unable to connect to remote database.'
- });
+response.status(502).json({
+ status: 502,
+ message: "unable to connect to remote database.",
+});
```
##### Enforcement
@@ -2470,7 +2505,7 @@ Code review.
<!-- <rule-set> -->
-* * *
+---
## Comments
@@ -2491,7 +2526,7 @@ Fewer characters per line compared to using multiple single-line comment identif
//
// @param {number} x - first argument
// @param {number} y - second argument
-function beep( x, y ) {
+function beep(x, y) {
// Do something...
}
```
@@ -2502,12 +2537,12 @@ function beep( x, y ) {
// Do...
/**
-* Beep boop.
-*
-* @param {number} x - first argument
-* @param {number} y - second argument
-*/
-function beep( x, y ) {
+ * Beep boop.
+ *
+ * @param {number} x - first argument
+ * @param {number} y - second argument
+ */
+function beep(x, y) {
// Do something...
}
```
@@ -2530,8 +2565,8 @@ Code review.
```javascript
// Do not...
-function transform( str ) {
- return str + ' has been transformed.';
+function transform(str) {
+ return str + " has been transformed.";
}
```
@@ -2541,24 +2576,24 @@ function transform( str ) {
// Do...
/**
-* String transformer.
-*
-* @param {string} str - string to be transformed.
-* @returns {string} transformed string
-*
-* @example
-* var out = transform( 'beep' );
-* // returns 'beep has been transformed.'
-*/
-function transform( str ) {
- return str + ' has been transformed.';
+ * String transformer.
+ *
+ * @param {string} str - string to be transformed.
+ * @returns {string} transformed string
+ *
+ * @example
+ * var out = transform( 'beep' );
+ * // returns 'beep has been transformed.'
+ */
+function transform(str) {
+ return str + " has been transformed.";
}
```
##### Notes
-- Be sure to include parameters, parameter types, return types (if any), errors (if any can be thrown), and examples.
-- Use Markdown syntax for extended comments.
+- Be sure to include parameters, parameter types, return types (if any), errors (if any can be thrown), and examples.
+- Use Markdown syntax for extended comments.
##### Enforcement
@@ -2594,7 +2629,7 @@ var foo = bar || null;
##### Notes
-- In general, prefer placing the comment above the comment subject and place an empty line above the comment.
+- In general, prefer placing the comment above the comment subject and place an empty line above the comment.
<!-- eslint-disable stdlib/empty-line-before-comment -->
@@ -2603,11 +2638,11 @@ var foo = bar || null;
var foo = bar || null; // bar can be `0`
// Do not...
- var beep = 'beep';
+ var beep = "beep";
// Comment about `boop`...
- var boop = 'boop';
+ var boop = "boop";
// Comment about `bap`...
- var bap = 'bap';
+ var bap = "bap";
```
##### Enforcement
@@ -2633,7 +2668,7 @@ Use `// FIXME:` to annotate problems.
```javascript
function foo() {
// FIXME: misses the case where value is 0. Want to check if value is not numeric.
- if ( !value ) {
+ if (!value) {
return false;
}
}
@@ -2648,7 +2683,7 @@ Use `// TODO:` to annotate tasks.
```javascript
function Ctor() {
// TODO: make `name` property value publicly accessible.
- this.name = 'foobar';
+ this.name = "foobar";
return this;
}
@@ -2662,7 +2697,7 @@ Use `// HACK:` to annotate fragile/non-general solutions.
```javascript
// HACK: temporary fix; host and port should be abstracted to another module handling configuration.
-var host = '127.0.0.1';
+var host = "127.0.0.1";
var port = 7331;
```
@@ -2674,7 +2709,7 @@ Use `// WARNING:` to annotate possible gotchas/pitfalls.
```javascript
// WARNING: shared reference of a mutable object; possible side effects.
-var a = b = {};
+var a = (b = {});
```
##### OPTIMIZE
@@ -2685,11 +2720,11 @@ Use `// OPTIMIZE:` to annotate code which needs optimizing.
```javascript
// OPTIMIZE: use a loop rather than recursion
-function factorial( x ) {
- if ( x <= 1 ) {
+function factorial(x) {
+ if (x <= 1) {
return 1;
}
- return x * factorial( x-1 );
+ return x * factorial(x - 1);
}
```
@@ -2701,9 +2736,9 @@ Use `// NOTE:` to annotate questions, comments, or anything which does not fit u
```javascript
// NOTE: consider optimizing this for large arrays (len > 64K).
-var arr = new Array( len );
-for ( var i = 0; i < len; i++ ) {
- arr[ i ] = Math.random();
+var arr = new Array(len);
+for (var i = 0; i < len; i++) {
+ arr[i] = Math.random();
}
```
@@ -2717,7 +2752,7 @@ Code review.
<!-- <rule-set> -->
-* * *
+---
## Naming
@@ -2774,7 +2809,7 @@ Standard JavaScript convention for constructors and classes.
```javascript
// Do not...
function roboRobot() {
- this.name = 'Boop';
+ this.name = "Boop";
return this;
}
@@ -2786,7 +2821,7 @@ var robo = new roboRobot();
```javascript
// Do...
function RoboRobot() {
- this.name = 'Beep';
+ this.name = "Beep";
return this;
}
@@ -2848,32 +2883,38 @@ Named `functions` are easier to find in stack traces and consequently debug.
```javascript
// Do not...
-request({
- 'method': 'GET',
- 'uri': 'http://127.0.0.1'
-}, function ( error, response, body ) {
- if ( error ) {
- throw error;
- }
- // Do something...
-});
+request(
+ {
+ method: "GET",
+ uri: "http://127.0.0.1",
+ },
+ function (error, response, body) {
+ if (error) {
+ throw error;
+ }
+ // Do something...
+ },
+);
```
##### Good Example
```javascript
// Do...
-function onResponse( error, response, body ) {
- if ( error ) {
+function onResponse(error, response, body) {
+ if (error) {
throw error;
}
// Do something...
}
-request({
- 'method': 'GET',
- 'uri': 'http://127.0.0.1'
-}, onResponse );
+request(
+ {
+ method: "GET",
+ uri: "http://127.0.0.1",
+ },
+ onResponse,
+);
```
##### Bad Example
@@ -2882,19 +2923,19 @@ request({
```javascript
// Do not...
-var arr = [ 1, 2, 3 ];
-var out = arr.map( x => x * x );
+var arr = [1, 2, 3];
+var out = arr.map((x) => x * x);
```
##### Good Example
```javascript
// Do...
-function square( x ) {
+function square(x) {
return x * x;
}
-var arr = [ 1, 2, 3 ];
-var out = arr.map( square );
+var arr = [1, 2, 3];
+var out = arr.map(square);
```
##### Enforcement
@@ -2949,7 +2990,7 @@ Code review.
<!-- <rule-set> -->
-* * *
+---
## This
@@ -2963,10 +3004,10 @@ Common JavaScript convention when caching a reference to `this`.
```javascript
// Do...
-function Robot( name ) {
+function Robot(name) {
var self = this;
- if ( !(this instanceof Robot) ) {
- return new Robot( name );
+ if (!(this instanceof Robot)) {
+ return new Robot(name);
}
this.name = name;
this.greet = greet;
@@ -2974,7 +3015,7 @@ function Robot( name ) {
return this;
function greet() {
- return 'Hello! My name is ' + self.name + '.';
+ return "Hello! My name is " + self.name + ".";
}
}
```
@@ -3003,11 +3044,11 @@ function greet() {
function Robot() {
var fcn;
- if ( !(this instanceof Robot) ) {
+ if (!(this instanceof Robot)) {
return new Robot();
}
- this.name = 'Beep';
- this.greet = greet.bind( this );
+ this.name = "Beep";
+ this.greet = greet.bind(this);
return this;
}
```
@@ -3016,20 +3057,20 @@ function Robot() {
```javascript
// Do...
-function greeting( ctx ) {
+function greeting(ctx) {
return greet;
function greet() {
- return 'Hello! My name is ' + ctx.name + '.';
+ return "Hello! My name is " + ctx.name + ".";
}
}
function Robot() {
- if ( !(this instanceof Robot) ) {
+ if (!(this instanceof Robot)) {
return new Robot();
}
- this.name = 'Beep';
- this.greet = greeting( this );
+ this.name = "Beep";
+ this.greet = greeting(this);
return this;
}
```
@@ -3044,7 +3085,7 @@ Code review.
<!-- <rule-set> -->
-* * *
+---
## Classes
@@ -3073,7 +3114,7 @@ var robo = createRobot(); // => fails
```javascript
// Do...
function Robot() {
- if ( !(this instanceof Robot) ) {
+ if (!(this instanceof Robot)) {
return new Robot();
}
return this;
@@ -3087,8 +3128,8 @@ var robo = createRobot();
##### Enforcement
-- Unit tests
-- Code review
+- Unit tests
+- Code review
<!-- </rule> -->
@@ -3096,7 +3137,7 @@ var robo = createRobot();
<!-- <rule-set> -->
-* * *
+---
## Setters and Getters
@@ -3114,9 +3155,13 @@ Simplifies a class interface.
```javascript
// Do not...
-Robot.prototype.setName = function set( name ) {
- if ( typeof name !== 'string' ) {
- throw new Error( 'invalid input value. Name must be a string. Value: `' + name + '`.' );
+Robot.prototype.setName = function set(name) {
+ if (typeof name !== "string") {
+ throw new Error(
+ "invalid input value. Name must be a string. Value: `" +
+ name +
+ "`.",
+ );
}
this._name = name;
return this;
@@ -3133,12 +3178,16 @@ Robot.prototype.getName = function get() {
```javascript
// Do...
-Robot.prototype.name = function robotName( name ) {
- if ( !arguments.length ) {
+Robot.prototype.name = function robotName(name) {
+ if (!arguments.length) {
return this._name;
}
- if ( typeof name !== 'string' ) {
- throw new Error( 'invalid input value. Name must be a string. Value: `' + name + '`.' );
+ if (typeof name !== "string") {
+ throw new Error(
+ "invalid input value. Name must be a string. Value: `" +
+ name +
+ "`.",
+ );
}
this._name = name;
return this;
@@ -3165,8 +3214,8 @@ While checks do incur computational cost, not providing such checks can entail a
```javascript
// Do not...
-Stream.prototype.window = function streamWindow( win ) {
- if ( !arguments.length ) {
+Stream.prototype.window = function streamWindow(win) {
+ if (!arguments.length) {
return this._window;
}
this._window = win;
@@ -3180,15 +3229,23 @@ Stream.prototype.window = function streamWindow( win ) {
```javascript
// Do...
-Stream.prototype.window = function streamWindow( win ) {
- if ( !arguments.length ) {
+Stream.prototype.window = function streamWindow(win) {
+ if (!arguments.length) {
return this._window;
}
- if ( typeof win !== 'number' || win !== win ) {
- throw new Error( 'invalid argument. Window size must be numeric. Value: `' + win + '`.' );
+ if (typeof win !== "number" || win !== win) {
+ throw new Error(
+ "invalid argument. Window size must be numeric. Value: `" +
+ win +
+ "`.",
+ );
}
- if ( Math.floor( win ) !== win || win <= 0 ) {
- throw new Error( 'invalid argument. Window size must be a positive integer. Value: `' + win + '`.' );
+ if (Math.floor(win) !== win || win <= 0) {
+ throw new Error(
+ "invalid argument. Window size must be a positive integer. Value: `" +
+ win +
+ "`.",
+ );
}
this._window = win;
return this;
@@ -3205,7 +3262,7 @@ Code review.
<!-- <rule-set> -->
-* * *
+---
## Method Chaining
@@ -3223,31 +3280,31 @@ Returning `this` enables method chaining and creates a [fluent interface][fluent
```javascript
function Robot() {
- if ( !(this instanceof Robot) ) {
+ if (!(this instanceof Robot)) {
return new Robot();
}
- this._name = '';
- this._color = 'black';
+ this._name = "";
+ this._color = "black";
return this;
}
-Robot.prototype.name = function robotName( name ) {
- if ( !arguments.length ) {
+Robot.prototype.name = function robotName(name) {
+ if (!arguments.length) {
return this._name;
}
- if ( typeof name !== 'string' ) {
- throw new Error( 'invalid input value.' );
+ if (typeof name !== "string") {
+ throw new Error("invalid input value.");
}
this._name = name;
return this;
};
-Robot.prototype.color = function robotColor( color ) {
- if ( !arguments.length ) {
+Robot.prototype.color = function robotColor(color) {
+ if (!arguments.length) {
return this._color;
}
- if ( typeof color !== 'string' ) {
- throw new Error( 'invalid input value.' );
+ if (typeof color !== "string") {
+ throw new Error("invalid input value.");
}
this._color = color;
return this;
@@ -3255,8 +3312,7 @@ Robot.prototype.color = function robotColor( color ) {
var robo = new Robot();
-robo.name( 'Robo' )
- .color( 'pink' );
+robo.name("Robo").color("pink");
```
##### Enforcement
@@ -3269,7 +3325,7 @@ Code review.
<!-- <rule-set> -->
-* * *
+---
## Documentation
@@ -3289,9 +3345,9 @@ Code is read more often than it is written. Prefer too much documentation to too
// Do not...
/**
-* Calculates auto-correlation.
-*/
-function autocorr( vector ) {
+ * Calculates auto-correlation.
+ */
+function autocorr(vector) {
// Calculate...
}
```
@@ -3304,29 +3360,29 @@ function autocorr( vector ) {
// Do...
/**
-* Calculate the auto-correlation of an input vector. To calculate the auto-correlation using an FFT, the data is padded to have length 2^n, where `n` is the next power of 2 greater than the vector length. For more details, consult [link][link].
-*
-* [link]: http://example.com
-*
-* @param {number[]} vector - 1d array
-* @returns {number} auto-correlation
-*
-* @example
-* var arr = [ 1, 6, 5, 4, 7, 2, 3, 1 ];
-* var v = autocorr( arr );
-*/
-function autocorr( vector ) {
+ * Calculate the auto-correlation of an input vector. To calculate the auto-correlation using an FFT, the data is padded to have length 2^n, where `n` is the next power of 2 greater than the vector length. For more details, consult [link][link].
+ *
+ * [link]: http://example.com
+ *
+ * @param {number[]} vector - 1d array
+ * @returns {number} auto-correlation
+ *
+ * @example
+ * var arr = [ 1, 6, 5, 4, 7, 2, 3, 1 ];
+ * var v = autocorr( arr );
+ */
+function autocorr(vector) {
// Calculate...
}
```
##### Notes
-- For client-side JavaScript, if you are concerned about file size, build/include a distributable file, stripped of comments and minified. Keep source code annotated.
-- **Always** include example/demo code that is easily runnable.
-- Do **not** claim that your code is self-documenting. Your code is not. **Period.**
-- Do **not** rely on tests as your **sole** source of documentation. While tests are documentation, annotating your source provides greater insight and a means to explain why you made particular design choices.
-- **Always** make your documentation **beautiful**. Take as much pride in your documentation as you do in your code.
+- For client-side JavaScript, if you are concerned about file size, build/include a distributable file, stripped of comments and minified. Keep source code annotated.
+- **Always** include example/demo code that is easily runnable.
+- Do **not** claim that your code is self-documenting. Your code is not. **Period.**
+- Do **not** rely on tests as your **sole** source of documentation. While tests are documentation, annotating your source provides greater insight and a means to explain why you made particular design choices.
+- **Always** make your documentation **beautiful**. Take as much pride in your documentation as you do in your code.
##### Enforcement
@@ -3338,7 +3394,7 @@ Code review.
<!-- <rule-set> -->
-* * *
+---
## Performance
@@ -3354,7 +3410,7 @@ Performance optimization, particularly of the premature variety, often comes wit
```javascript
// Do not...
-var y = ( x >> 0 );
+var y = x >> 0;
// Avoid using a bitshift unless you really need to. Possible subtle bug in the above is that `x` is converted to a signed 32-bit integer.
```
@@ -3365,12 +3421,12 @@ var y = ( x >> 0 );
```javascript
// Do...
-var y = Math.floor( x );
+var y = Math.floor(x);
```
##### Notes
-- Take JSPerf tests with a grain of salt, as results can vary significantly from browser to browser and across browser versions.
+- Take JSPerf tests with a grain of salt, as results can vary significantly from browser to browser and across browser versions.
##### Enforcement
@@ -3382,7 +3438,7 @@ Code review.
<!-- <rule-set> -->
-* * *
+---
## Modularity
@@ -3394,15 +3450,15 @@ Testing, debugging, maintainability, composition, focused interfaces, and interc
##### Notes
-- Every file within a Node module should be **less than** `200` lines of code. The only exceptions are tests files, which are generally 2-3x the length of the files they test. If a file is longer than `200` lines, the code is undoubtedly too complex, not maintainable, hard to test, and needs to be refactored into smaller sub-modules. Ideally, an individual file should **never** be longer than `80` lines.
-- Prefer only **1** `function` per file. A file which contains fewer functions is easier to test, read, and maintain. This is particularly **true** for Node modules.
-- **Always** bear in mind the single responsibility principle.
-- **Always** strive for reusability.
+- Every file within a Node module should be **less than** `200` lines of code. The only exceptions are tests files, which are generally 2-3x the length of the files they test. If a file is longer than `200` lines, the code is undoubtedly too complex, not maintainable, hard to test, and needs to be refactored into smaller sub-modules. Ideally, an individual file should **never** be longer than `80` lines.
+- Prefer only **1** `function` per file. A file which contains fewer functions is easier to test, read, and maintain. This is particularly **true** for Node modules.
+- **Always** bear in mind the single responsibility principle.
+- **Always** strive for reusability.
##### Enforcement
-- Look for parts of an implementation which can be extracted into reusable components.
-- Code review
+- Look for parts of an implementation which can be extracted into reusable components.
+- Code review
<!-- </rule> -->
@@ -3410,7 +3466,7 @@ Testing, debugging, maintainability, composition, focused interfaces, and interc
<!-- <rule-set> -->
-* * *
+---
## Client-side JavaScript
@@ -3424,14 +3480,14 @@ Relying on monolithic libraries, such as jQuery, for DOM manipulation leads to c
```javascript
// Do not...
-var el = jQuery( '#main' );
+var el = jQuery("#main");
```
##### Good Example
```javascript
// Do...
-var el = document.querySelector( '#main' );
+var el = document.querySelector("#main");
```
##### Enforcement
@@ -3455,9 +3511,9 @@ Prevents variable leakage.
```javascript
// Do...
(function foo() {
- 'use strict';
+ "use strict";
- var beep = 'boop';
+ var beep = "boop";
// ...
})();
@@ -3486,7 +3542,7 @@ Helps minimize global variable name collisions.
window.start = function start() {
// Do something...
};
-window.name = 'App';
+window.name = "App";
```
##### Good Example
@@ -3496,7 +3552,7 @@ window.name = 'App';
```javascript
// Do...
var myApp = {};
-myApp.name = 'App';
+myApp.name = "App";
myApp.start = function start() {
// Do something...
};
@@ -3514,7 +3570,7 @@ Code review.
<!-- <rule-set> -->
-* * *
+---
## Dependencies
@@ -3528,11 +3584,11 @@ Often, more focused modules are available which can accomplish the same task. In
##### Notes
-- In particular, avoid the following libraries:
+- In particular, avoid the following libraries:
- - underscore
- - lodash
- - async
+ - underscore
+ - lodash
+ - async
##### Enforcement
@@ -3550,21 +3606,21 @@ Any dependency you use becomes **your** responsibility. Demand the same level of
##### Notes
-- While GitHub stars and downloads are rough indicators, place more emphasis on the following:
+- While GitHub stars and downloads are rough indicators, place more emphasis on the following:
- - Code quality
+ - Code quality
- - conciseness
- - maintainability
+ - conciseness
+ - maintainability
- - Documentation
+ - Documentation
- - APIs
- - examples
+ - APIs
+ - examples
- - Test cases
+ - Test cases
-- For most cases, do **not** place much weight on how recently the module was updated. Small, focused, well-written modules should not require much updating.
+- For most cases, do **not** place much weight on how recently the module was updated. Small, focused, well-written modules should not require much updating.
##### Enforcement
@@ -3574,15 +3630,15 @@ Code review.
<!-- </rule-set> -->
-* * *
+---
## Additional Resources
-- [Airbnb JavaScript Style Guide][airbnb]
-- [Idiomatic.js][idiomatic-js]
-- [Popular Convention][popular-convention]
-- [JavaScript Quality Guide][quality-guide]
-- [Unix Philosophy][unix-philosophy]
+- [Airbnb JavaScript Style Guide][airbnb]
+- [Idiomatic.js][idiomatic-js]
+- [Popular Convention][popular-convention]
+- [JavaScript Quality Guide][quality-guide]
+- [Unix Philosophy][unix-philosophy]
## License
@@ -3591,49 +3647,27 @@ This document may be reused under a [Creative Commons Attribution-ShareAlike Lic
<section class="links">
[tab-indentation]: http://lea.verou.me/2012/01/why-tabs-are-clearly-superior/
-
[sublime-text]: http://www.sublimetext.com/
-
[editorconfig]: http://editorconfig.org/
-
[sublime-text-editorconfig]: https://github.com/sindresorhus/editorconfig-sublime
-
[atom-editorconfig]: https://github.com/sindresorhus/atom-editorconfig
-
[chrome-editorconfig]: https://chrome.google.com/webstore/detail/github-editorconfig/bppnolhdpdfmmpeefopdbpmabdpoefjh?hl=en-US
-
[ecma-262]: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-262.pdf
-
[function-statements]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function
-
[function-expressions]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/function
-
[hoisting]: https://github.com/buildfirst/buildfirst/tree/master/ch05/04_hoisting
-
[strict-mode]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Strict_mode
-
[uncaught-exception]: https://nodejs.org/api/process.html#process_event_uncaughtexception
-
[errbacks]: https://nodejs.org/api/fs.html
-
[http-status-codes]: https://en.wikipedia.org/wiki/List_of_HTTP_status_codes
-
[jsdoc]: https://jsdoc.app/
-
[fluent-interface]: https://en.wikipedia.org/wiki/Fluent_interface
-
[native-dom-equivalents]: http://www.sitepoint.com/jquery-vs-raw-javascript-1-dom-forms/
-
[airbnb]: https://github.com/airbnb/javascript
-
[idiomatic-js]: https://github.com/rwaldron/idiomatic.js/
-
[popular-convention]: http://sideeffect.kr/popularconvention/#javascript
-
[quality-guide]: https://github.com/bevacqua/js
-
[unix-philosophy]: http://www.catb.org/~esr/writings/taoup/html/ch01s06.html
-
[license]: https://creativecommons.org/licenses/by-sa/4.0/
</section>
diff --git a/docs/style-guides/julia/README.md b/docs/style-guides/julia/README.md
index fecfc1ee929e..52465fccd5a8 100644
--- a/docs/style-guides/julia/README.md
+++ b/docs/style-guides/julia/README.md
@@ -4,4 +4,4 @@
TODO
-- Julia [style guide](http://docs.julialang.org/en/release-0.4/manual/style-guide/).
+- Julia [style guide](http://docs.julialang.org/en/release-0.4/manual/style-guide/).
diff --git a/docs/style-guides/make/README.md b/docs/style-guides/make/README.md
index c71e25a51a7b..1dafe88cbc31 100644
--- a/docs/style-guides/make/README.md
+++ b/docs/style-guides/make/README.md
@@ -4,10 +4,10 @@
TODO
-- [style guide](http://clarkgrubb.com/makefile-style-guide)
-- [Makefile conventions](http://www.gnu.org/prep/standards/standards.html#Makefile-Conventions)
-- [portable shell](http://www.gnu.org/software/autoconf/manual/autoconf.html#Portable-Shell)
-- [portable make](http://www.gnu.org/software/autoconf/manual/autoconf.html#Portable-Make)
-- [short guide](http://style-guides.readthedocs.io/en/latest/makefile.html)
-- [FreeBSD](https://www.freebsd.org/cgi/man.cgi?query=style.Makefile&sektion=5)
-- [mkdir -p](http://unix.stackexchange.com/questions/49263/recursive-mkdir)
+- [style guide](http://clarkgrubb.com/makefile-style-guide)
+- [Makefile conventions](http://www.gnu.org/prep/standards/standards.html#Makefile-Conventions)
+- [portable shell](http://www.gnu.org/software/autoconf/manual/autoconf.html#Portable-Shell)
+- [portable make](http://www.gnu.org/software/autoconf/manual/autoconf.html#Portable-Make)
+- [short guide](http://style-guides.readthedocs.io/en/latest/makefile.html)
+- [FreeBSD](https://www.freebsd.org/cgi/man.cgi?query=style.Makefile&sektion=5)
+- [mkdir -p](http://unix.stackexchange.com/questions/49263/recursive-mkdir)
diff --git a/docs/style-guides/python/README.md b/docs/style-guides/python/README.md
index dcb3b48e1cf1..a955727a7f3e 100644
--- a/docs/style-guides/python/README.md
+++ b/docs/style-guides/python/README.md
@@ -4,4 +4,4 @@
TODO
-- [PEP 8](https://www.python.org/dev/peps/pep-0008/)
+- [PEP 8](https://www.python.org/dev/peps/pep-0008/)
diff --git a/docs/style-guides/r/README.md b/docs/style-guides/r/README.md
index 227631188d8c..77371f6954cc 100644
--- a/docs/style-guides/r/README.md
+++ b/docs/style-guides/r/README.md
@@ -4,6 +4,6 @@
TODO
-- Google [style guide](https://google.github.io/styleguide/Rguide.xml)
-- Hadley's [notes](http://adv-r.had.co.nz/OO-essentials.html), which include a comment on `function` name conventions
-- Hadley's [style guide](http://r-pkgs.had.co.nz/style.html)
+- Google [style guide](https://google.github.io/styleguide/Rguide.xml)
+- Hadley's [notes](http://adv-r.had.co.nz/OO-essentials.html), which include a comment on `function` name conventions
+- Hadley's [style guide](http://r-pkgs.had.co.nz/style.html)
diff --git a/docs/style-guides/text/README.md b/docs/style-guides/text/README.md
index ca93285e0a48..5c7968a86917 100644
--- a/docs/style-guides/text/README.md
+++ b/docs/style-guides/text/README.md
@@ -22,38 +22,38 @@ limitations under the License.
> Style guide for writing text.
-- Filenames should be lowercase. Some top-level files and all `README.md` files are exceptions.
+- Filenames should be lowercase. Some top-level files and all `README.md` files are exceptions.
-- Filenames should be snake_case.
+- Filenames should be snake_case.
-- Use American English spelling (e.g., "Capitalize" versus "Capitalise", "color" versus "colour", etc).
+- Use American English spelling (e.g., "Capitalize" versus "Capitalise", "color" versus "colour", etc).
-- Insofar as is possible, spelling and grammar issues should be identified using tools, and, if not caught by a tool, should be identified by human reviewers.
+- Insofar as is possible, spelling and grammar issues should be identified using tools, and, if not caught by a tool, should be identified by human reviewers.
-- Use the [Oxford comma][oxford-comma] for clarity.
+- Use the [Oxford comma][oxford-comma] for clarity.
-- Avoid using personal pronouns in reference documentation (e.g., "I", "you", "we").
+- Avoid using personal pronouns in reference documentation (e.g., "I", "you", "we").
-- Personal pronouns are acceptable in more colloquial documentation, such as guides.
+- Personal pronouns are acceptable in more colloquial documentation, such as guides.
-- Prefer using gender-neutral pronouns and mass nouns. For example,
+- Prefer using gender-neutral pronouns and mass nouns. For example,
- - **OK**: "one", "they", "their", "them", "people", "developers"
- - **NOT OK**: "his", "him", "guys"
+ - **OK**: "one", "they", "their", "them", "people", "developers"
+ - **NOT OK**: "his", "him", "guys"
Exclusive use of female pronoun forms is permitted.
-- Place end-of-sentence punctuation inside wrapping elements (e.g., periods should be placed inside parentheses and quotes, not after).
+- Place end-of-sentence punctuation inside wrapping elements (e.g., periods should be placed inside parentheses and quotes, not after).
-- Markdown documents must start with a level-one heading, such as in this document.
+- Markdown documents must start with a level-one heading, such as in this document.
-- Use definitions rather than in-lining (e.g., prefer `[link][]` over `[link](http://example.com)`).
+- Use definitions rather than in-lining (e.g., prefer `[link][]` over `[link](http://example.com)`).
-- References to constructor functions should use PascalCase.
+- References to constructor functions should use PascalCase.
-- References to constructor instances should use camelCase.
+- References to constructor instances should use camelCase.
-- References to functions and methods should use parentheses (e.g., `foo.factory()` versus `foo.factory`).
+- References to functions and methods should use parentheses (e.g., `foo.factory()` versus `foo.factory`).
<section class="links">
diff --git a/docs/support_the_project.md b/docs/support_the_project.md
index d7348f665c1f..4c5dbc6d2006 100644
--- a/docs/support_the_project.md
+++ b/docs/support_the_project.md
@@ -26,18 +26,16 @@ stdlib is an open-source project which is maintained by members of the community
You can help in the following ways:
-- Give developer time to the project. Message us on [Gitter][stdlib-gitter] for guidance.
-- Financially sponsor the project.
+- Give developer time to the project. Message us on [Gitter][stdlib-gitter] for guidance.
+- Financially sponsor the project.
If you want to be a sponsor 🤗, you can donate to one or more of the following:
-- [Open Collective][open-collective-stdlib]: <https://opencollective.com/stdlib>
-- [GitHub Sponsors][github-sponsors-stdlib]: <https://github.com/sponsors/stdlib-js>
+- [Open Collective][open-collective-stdlib]: <https://opencollective.com/stdlib>
+- [GitHub Sponsors][github-sponsors-stdlib]: <https://github.com/sponsors/stdlib-js>
Thank you for your support!
[stdlib-gitter]: https://gitter.im/stdlib-js/stdlib
-
[open-collective-stdlib]: https://opencollective.com/stdlib
-
[github-sponsors-stdlib]: https://github.com/sponsors/stdlib-js
diff --git a/docs/types/index.d.ts b/docs/types/index.d.ts
index 4aa17150f145..2278ae9c8659 100644
--- a/docs/types/index.d.ts
+++ b/docs/types/index.d.ts
@@ -1,257 +1,256 @@
/*
-* @license Apache-2.0
-*
-* Copyright (c) 2021 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.
-*/
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2021 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: 4.1
/* eslint-disable max-lines */
-import array = require( '@stdlib/array' );
-import assert = require( '@stdlib/assert' );
-import bench = require( '@stdlib/bench' );
-import bigint = require( '@stdlib/bigint' );
-import blas = require( '@stdlib/blas' );
-import buffer = require( '@stdlib/buffer' );
-import cli = require( '@stdlib/cli' );
-import complex = require( '@stdlib/complex' );
-import constants = require( '@stdlib/constants' );
-import datasets = require( '@stdlib/datasets' );
-import dstructs = require( '@stdlib/dstructs' );
-import error = require( '@stdlib/error' );
-import fs = require( '@stdlib/fs' );
-import iter = require( '@stdlib/iter' );
-import math = require( '@stdlib/math' );
-import ml = require( '@stdlib/ml' );
-import namespace = require( '@stdlib/namespace' );
-import ndarray = require( '@stdlib/ndarray' );
-import net = require( '@stdlib/net' );
-import nlp = require( '@stdlib/nlp' );
-import number = require( '@stdlib/number' );
-import os = require( '@stdlib/os' );
-import process = require( '@stdlib/process' );
-import proxy = require( '@stdlib/proxy' );
-import random = require( '@stdlib/random' );
-import regexp = require( '@stdlib/regexp' );
-import simulate = require( '@stdlib/simulate' );
-import slice = require( '@stdlib/slice' );
-import stats = require( '@stdlib/stats' );
-import streams = require( '@stdlib/streams' );
-import strided = require( '@stdlib/strided' );
-import string = require( '@stdlib/string' );
-import symbol = require( '@stdlib/symbol' );
-import time = require( '@stdlib/time' );
-import utils = require( '@stdlib/utils' );
-import wasm = require( '@stdlib/wasm' );
+import array = require("@stdlib/array");
+import assert = require("@stdlib/assert");
+import bench = require("@stdlib/bench");
+import bigint = require("@stdlib/bigint");
+import blas = require("@stdlib/blas");
+import buffer = require("@stdlib/buffer");
+import cli = require("@stdlib/cli");
+import complex = require("@stdlib/complex");
+import constants = require("@stdlib/constants");
+import datasets = require("@stdlib/datasets");
+import dstructs = require("@stdlib/dstructs");
+import error = require("@stdlib/error");
+import fs = require("@stdlib/fs");
+import iter = require("@stdlib/iter");
+import math = require("@stdlib/math");
+import ml = require("@stdlib/ml");
+import namespace = require("@stdlib/namespace");
+import ndarray = require("@stdlib/ndarray");
+import net = require("@stdlib/net");
+import nlp = require("@stdlib/nlp");
+import number = require("@stdlib/number");
+import os = require("@stdlib/os");
+import process = require("@stdlib/process");
+import proxy = require("@stdlib/proxy");
+import random = require("@stdlib/random");
+import regexp = require("@stdlib/regexp");
+import simulate = require("@stdlib/simulate");
+import slice = require("@stdlib/slice");
+import stats = require("@stdlib/stats");
+import streams = require("@stdlib/streams");
+import strided = require("@stdlib/strided");
+import string = require("@stdlib/string");
+import symbol = require("@stdlib/symbol");
+import time = require("@stdlib/time");
+import utils = require("@stdlib/utils");
+import wasm = require("@stdlib/wasm");
/**
-* Interface describing the `stdlib` namespace.
-*/
+ * Interface describing the `stdlib` namespace.
+ */
interface Namespace {
/**
- * Arrays.
- */
+ * Arrays.
+ */
array: typeof array;
/**
- * Standard assertion utilities.
- */
+ * Standard assertion utilities.
+ */
assert: typeof assert;
bench: typeof bench;
/**
- * BigInt.
- */
+ * BigInt.
+ */
bigint: typeof bigint;
/**
- * Standard library BLAS.
- */
+ * Standard library BLAS.
+ */
blas: typeof blas;
/**
- * Buffer.
- */
+ * Buffer.
+ */
buffer: typeof buffer;
/**
- * Command-line interface.
- */
+ * Command-line interface.
+ */
cli: typeof cli;
/**
- * Complex numbers.
- */
+ * Complex numbers.
+ */
complex: typeof complex;
/**
- * Standard library constants.
- */
+ * Standard library constants.
+ */
constants: typeof constants;
/**
- * Returns datasets.
- *
- * @param name - dataset name
- * @param options - dataset options
- * @throws unsupported/unrecognized dataset name
- * @returns dataset
- */
+ * Returns datasets.
+ *
+ * @param name - dataset name
+ * @param options - dataset options
+ * @throws unsupported/unrecognized dataset name
+ * @returns dataset
+ */
datasets: typeof datasets;
/**
- * Data structures.
- */
+ * Data structures.
+ */
dstructs: typeof dstructs;
/**
- * Errors.
- */
+ * Errors.
+ */
error: typeof error;
/**
- * Standard library for interfacing with a fileystem.
- */
+ * Standard library for interfacing with a fileystem.
+ */
fs: typeof fs;
/**
- * Standard iterator utilities.
- */
+ * Standard iterator utilities.
+ */
iter: typeof iter;
/**
- * Standard math.
- */
+ * Standard math.
+ */
math: typeof math;
/**
- * Standard library machine learning algorithms.
- */
+ * Standard library machine learning algorithms.
+ */
ml: typeof ml;
/**
- * Returns the standard library namespace.
- *
- * @returns standard library namespace
- */
+ * Returns the standard library namespace.
+ *
+ * @returns standard library namespace
+ */
namespace: typeof namespace;
/**
- * Multidimensional arrays.
- */
+ * Multidimensional arrays.
+ */
ndarray: typeof ndarray;
/**
- * Standard library networking.
- */
+ * Standard library networking.
+ */
net: typeof net;
/**
- * Standard library natural language processing.
- */
+ * Standard library natural language processing.
+ */
nlp: typeof nlp;
/**
- * Number.
- */
+ * Number.
+ */
number: typeof number;
/**
- * Standard library OS utilities.
- */
+ * Standard library OS utilities.
+ */
os: typeof os;
/**
- * Standard library process utilities.
- */
+ * Standard library process utilities.
+ */
process: typeof process;
/**
- * Proxy.
- */
+ * Proxy.
+ */
proxy: typeof proxy;
/**
- * Standard library generic random functions.
- */
+ * Standard library generic random functions.
+ */
random: typeof random;
/**
- * Standard library regular expressions.
- */
+ * Standard library regular expressions.
+ */
regexp: typeof regexp;
/**
- * Standard library simulation utilities.
- */
+ * Standard library simulation utilities.
+ */
simulate: typeof simulate;
/**
- * Standard library slice utilities.
- */
+ * Standard library slice utilities.
+ */
slice: typeof slice;
/**
- * Standard library statistical functions.
- */
+ * Standard library statistical functions.
+ */
stats: typeof stats;
/**
- * Standard library streams.
- */
+ * Standard library streams.
+ */
streams: typeof streams;
/**
- * Strided.
- */
+ * Strided.
+ */
strided: typeof strided;
/**
- * Standard library string manipulation functions.
- */
+ * Standard library string manipulation functions.
+ */
string: typeof string;
/**
- * Symbol.
- */
+ * Symbol.
+ */
symbol: typeof symbol;
/**
- * Standard library time utilities.
- */
+ * Standard library time utilities.
+ */
time: typeof time;
/**
- * Standard utilities.
- */
+ * Standard utilities.
+ */
utils: typeof utils;
/**
- * WebAssembly utilities.
- */
+ * WebAssembly utilities.
+ */
wasm: typeof wasm;
}
/**
-* Standard library.
-*/
+ * Standard library.
+ */
declare var ns: Namespace;
-
// EXPORTS //
export = ns;
diff --git a/docs/types/test.ts b/docs/types/test.ts
index 8f51915395fb..c0ed5240601b 100644
--- a/docs/types/test.ts
+++ b/docs/types/test.ts
@@ -1,25 +1,24 @@
/*
-* @license Apache-2.0
-*
-* Copyright (c) 2021 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.
-*/
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2021 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.
+ */
/* eslint-disable @typescript-eslint/no-unused-expressions */
-import stdlib = require( './index' );
-
+import stdlib = require("./index");
// TESTS //
diff --git a/docs/types/tsconfig.json b/docs/types/tsconfig.json
index eb1ac47eedae..0d474c0b75a3 100644
--- a/docs/types/tsconfig.json
+++ b/docs/types/tsconfig.json
@@ -7,9 +7,7 @@
"baseUrl": ".",
"forceConsistentCasingInFileNames": true,
"keyofStringsOnly": false,
- "lib": [
- "es6"
- ],
+ "lib": ["es6"],
"module": "commonjs",
"moduleResolution": "node",
"newLine": "lf",
@@ -28,10 +26,8 @@
"strictNullChecks": true,
"suppressExcessPropertyErrors": false,
"suppressImplicitAnyIndexErrors": false,
- "typeRoots": [ "." ],
+ "typeRoots": ["."],
"types": []
},
- "exclude": [
- "node_modules"
- ]
+ "exclude": ["node_modules"]
}
diff --git a/etc/.links.js b/etc/.links.js
index b33723de1801..b37d00de2f5f 100644
--- a/etc/.links.js
+++ b/etc/.links.js
@@ -1,35 +1,33 @@
/**
-* @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';
+ * @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 resolve = require( 'path' ).resolve;
-
+var resolve = require("path").resolve;
// MAIN //
var config = {};
// Link database:
-config.database = resolve( __dirname, '../docs/links/database.json' );
-
+config.database = resolve(__dirname, "../docs/links/database.json");
// EXPORTS //
diff --git a/etc/.makie.js b/etc/.makie.js
index d47951b82c87..e536063d6082 100644
--- a/etc/.makie.js
+++ b/etc/.makie.js
@@ -1,32 +1,33 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// MODULES //
-var path = require( 'path' );
-
+var path = require("path");
// VARIABLES //
-var prefix = path.resolve( __dirname, '../lib/node_modules/@stdlib/_tools/makie/plugins' );
-
+var prefix = path.resolve(
+ __dirname,
+ "../lib/node_modules/@stdlib/_tools/makie/plugins",
+);
// MAIN //
@@ -35,30 +36,38 @@ var plugins = {};
config.plugins = plugins;
-plugins[ 'benchmark' ] = path.join( prefix, 'makie-benchmark' );
-plugins[ 'benchmark-lang' ] = path.join( prefix, 'makie-benchmark-lang' );
-plugins[ 'complexity' ] = path.join( prefix, 'makie-complexity' );
-plugins[ 'examples' ] = path.join( prefix, 'makie-examples' );
-plugins[ 'install-node-addons' ] = path.join( prefix, 'makie-install-node-addons' );
-plugins[ 'lint-javascript' ] = path.join( prefix, 'makie-lint-javascript' );
-plugins[ 'lint-markdown' ] = path.join( prefix, 'makie-lint-markdown' );
-plugins[ 'lint-python' ] = path.join( prefix, 'makie-lint-python' );
-plugins[ 'lint-r' ] = path.join( prefix, 'makie-lint-r' );
-plugins[ 'lint-typescript-declarations' ] = path.join( prefix, 'makie-lint-typescript-declarations' );
-plugins[ 'list-pkgs' ] = path.join( prefix, 'makie-list-pkgs' );
-plugins[ 'list-pkgs-names' ] = path.join( prefix, 'makie-list-pkgs-names' );
-plugins[ 'markdown-asset-link' ] = path.join( prefix, 'makie-markdown-asset-link' );
-plugins[ 'markdown-examples-javascript' ] = path.join( prefix, 'makie-markdown-examples-javascript' );
-plugins[ 'notes' ] = path.join( prefix, 'makie-notes' );
-plugins[ 'repl' ] = path.join( prefix, 'makie-repl' );
-plugins[ 'stats-list-contributors' ] = path.join( prefix, 'makie-stats-list-contributors' );
-plugins[ 'test' ] = path.join( prefix, 'makie-test' );
-plugins[ 'test-summary' ] = path.join( prefix, 'makie-test-summary' );
-plugins[ 'test-cov' ] = path.join( prefix, 'makie-test-cov' );
-plugins[ 'view-complexity' ] = path.join( prefix, 'makie-view-complexity' );
-plugins[ 'view-cov' ] = path.join( prefix, 'makie-view-cov' );
-plugins[ 'wasm' ] = path.join( prefix, 'makie-wasm' );
-
+plugins["benchmark"] = path.join(prefix, "makie-benchmark");
+plugins["benchmark-lang"] = path.join(prefix, "makie-benchmark-lang");
+plugins["complexity"] = path.join(prefix, "makie-complexity");
+plugins["examples"] = path.join(prefix, "makie-examples");
+plugins["install-node-addons"] = path.join(prefix, "makie-install-node-addons");
+plugins["lint-javascript"] = path.join(prefix, "makie-lint-javascript");
+plugins["lint-markdown"] = path.join(prefix, "makie-lint-markdown");
+plugins["lint-python"] = path.join(prefix, "makie-lint-python");
+plugins["lint-r"] = path.join(prefix, "makie-lint-r");
+plugins["lint-typescript-declarations"] = path.join(
+ prefix,
+ "makie-lint-typescript-declarations",
+);
+plugins["list-pkgs"] = path.join(prefix, "makie-list-pkgs");
+plugins["list-pkgs-names"] = path.join(prefix, "makie-list-pkgs-names");
+plugins["markdown-asset-link"] = path.join(prefix, "makie-markdown-asset-link");
+plugins["markdown-examples-javascript"] = path.join(
+ prefix,
+ "makie-markdown-examples-javascript",
+);
+plugins["notes"] = path.join(prefix, "makie-notes");
+plugins["repl"] = path.join(prefix, "makie-repl");
+plugins["stats-list-contributors"] = path.join(
+ prefix,
+ "makie-stats-list-contributors",
+);
+plugins["test"] = path.join(prefix, "makie-test");
+plugins["test-summary"] = path.join(prefix, "makie-test-summary");
+plugins["test-cov"] = path.join(prefix, "makie-test-cov");
+plugins["view-complexity"] = path.join(prefix, "makie-view-complexity");
+plugins["view-cov"] = path.join(prefix, "makie-view-cov");
+plugins["wasm"] = path.join(prefix, "makie-wasm");
// EXPORTS //
diff --git a/etc/.references.js b/etc/.references.js
index d626231912e4..1e073be320e6 100644
--- a/etc/.references.js
+++ b/etc/.references.js
@@ -1,38 +1,39 @@
/**
-* @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';
+ * @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 resolve = require( 'path' ).resolve;
-
+var resolve = require("path").resolve;
// MAIN //
var config = {};
// Reference database:
-config.database = resolve( __dirname, '../docs/references/bib.bib' );
+config.database = resolve(__dirname, "../docs/references/bib.bib");
// Citation style language:
-config.csl = resolve( __dirname, '../docs/references/csl/chicago-author-date.csl' );
-
+config.csl = resolve(
+ __dirname,
+ "../docs/references/csl/chicago-author-date.csl",
+);
// EXPORTS //
diff --git a/etc/README.md b/etc/README.md
index b9c97109af32..979f676b6160 100644
--- a/etc/README.md
+++ b/etc/README.md
@@ -18,7 +18,7 @@ This directory contains project configuration files for both internal and third-
## Notes
-- Configuration files for external tools and environments should be placed in subdirectories. The subdirectory name should correspond to the name of the tool or environment.
+- Configuration files for external tools and environments should be placed in subdirectories. The subdirectory name should correspond to the name of the tool or environment.
</section>
diff --git a/etc/commitlint/.commitlintrc.js b/etc/commitlint/.commitlintrc.js
index 2b0153077ef2..50cb2e2155c9 100644
--- a/etc/commitlint/.commitlintrc.js
+++ b/etc/commitlint/.commitlintrc.js
@@ -1,68 +1,68 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
/* eslint-disable stdlib/jsdoc-leading-description-sentence */
/**
-* commitlint configuration.
-*
-* @namespace config
-*/
+ * commitlint configuration.
+ *
+ * @namespace config
+ */
var config = {};
/**
-* Link to commit guidance.
-*
-* @name helpUrl
-* @memberof config
-* @type {string}
-*/
-config[ 'helpUrl' ] = 'https://github.com/stdlib-js/stdlib/tree/develop/docs/style-guides/git';
+ * Link to commit guidance.
+ *
+ * @name helpUrl
+ * @memberof config
+ * @type {string}
+ */
+config["helpUrl"] =
+ "https://github.com/stdlib-js/stdlib/tree/develop/docs/style-guides/git";
/**
-* Commit message parser.
-*
-* @name parserPreset
-* @memberof config
-* @type {Object}
-*/
-config[ 'parserPreset' ] = require( './parser-preset' );
+ * Commit message parser.
+ *
+ * @name parserPreset
+ * @memberof config
+ * @type {Object}
+ */
+config["parserPreset"] = require("./parser-preset");
/**
-* Lint rules.
-*
-* @name rules
-* @memberof config
-* @type {Object}
-*/
-config[ 'rules' ] = require( './rules' );
+ * Lint rules.
+ *
+ * @name rules
+ * @memberof config
+ * @type {Object}
+ */
+config["rules"] = require("./rules");
/**
-* Prompt configuration.
-*
-* @name prompt
-* @memberof config
-* @type {Object}
-*/
-config[ 'prompt' ] = require( './prompt' );
-
+ * Prompt configuration.
+ *
+ * @name prompt
+ * @memberof config
+ * @type {Object}
+ */
+config["prompt"] = require("./prompt");
// EXPORTS //
diff --git a/etc/commitlint/parser-preset/index.js b/etc/commitlint/parser-preset/index.js
index 514fa27d0d2d..b1218690eab0 100644
--- a/etc/commitlint/parser-preset/index.js
+++ b/etc/commitlint/parser-preset/index.js
@@ -1,48 +1,43 @@
/**
-* @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';
+ * @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 config = require( 'conventional-changelog-conventionalcommits' );
-
+var config = require("conventional-changelog-conventionalcommits");
// MAIN //
/**
-* Parser configuration.
-*
-* @name conf
-* @type {Object}
-*/
+ * Parser configuration.
+ *
+ * @name conf
+ * @type {Object}
+ */
var conf = config({
// Define an array of prefixes used to detect references to issues:
- 'issuePrefixes': [
- '#',
- 'gh-'
- ],
+ issuePrefixes: ["#", "gh-"],
// Define a pattern to match a reverted commit:
- 'revertPattern': /^Revert\s([\s\S]*)\s*This reverts commit (\w*)\./
+ revertPattern: /^Revert\s([\s\S]*)\s*This reverts commit (\w*)\./,
});
-
// EXPORTS //
module.exports = conf;
diff --git a/etc/commitlint/prompt/index.js b/etc/commitlint/prompt/index.js
index 831460253e6a..55278b46e237 100644
--- a/etc/commitlint/prompt/index.js
+++ b/etc/commitlint/prompt/index.js
@@ -1,205 +1,216 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
/**
-* Custom prompt configuration.
-*
-* @name config
-* @type {Object
-*/
+ * Custom prompt configuration.
+ *
+ * @name config
+ * @type {Object
+ */
var config = {
- 'questions': {}
+ questions: {},
};
/**
-* Question for selecting the commit type.
-*
-* @name type
-* @memberof config.questions
-* @type {Object}
-*/
-config.questions[ 'type' ] = {
- 'description': 'Select the type of change that you\'re committing',
- 'enum': {
- 'feat': {
- 'description': 'New feature',
- 'title': 'Features',
- 'emoji': '✨'
+ * Question for selecting the commit type.
+ *
+ * @name type
+ * @memberof config.questions
+ * @type {Object}
+ */
+config.questions["type"] = {
+ description: "Select the type of change that you're committing",
+ enum: {
+ feat: {
+ description: "New feature",
+ title: "Features",
+ emoji: "✨",
},
- 'fix': {
- 'description': 'Bug fix, including changes to the behavior of existing features and including changes that remove or mitigate security vulnerabilities',
- 'title': 'Bug Fixes',
- 'emoji': '🐛'
+ fix: {
+ description:
+ "Bug fix, including changes to the behavior of existing features and including changes that remove or mitigate security vulnerabilities",
+ title: "Bug Fixes",
+ emoji: "🐛",
},
- 'remove': {
- 'description': 'Remove feature',
- 'title': 'Removed Features',
- 'emoji': '🗑'
+ remove: {
+ description: "Remove feature",
+ title: "Removed Features",
+ emoji: "🗑",
},
- 'deprecate': {
- 'description': 'Deprecate feature',
- 'title': 'Deprecations',
- 'emoji': '⚠️'
+ deprecate: {
+ description: "Deprecate feature",
+ title: "Deprecations",
+ emoji: "⚠️",
},
- 'perf': {
- 'description': 'Improve performance',
- 'title': 'Performance Improvements',
- 'emoji': '🚀'
+ perf: {
+ description: "Improve performance",
+ title: "Performance Improvements",
+ emoji: "🚀",
},
- 'docs': {
- 'description': 'Documentation-only change, including READMEs, JSDoc/Doxygen-style comments, source comments, annotations, and examples (including examples files) and excluding TypeScript declarations',
- 'title': 'Documentation',
- 'emoji': '📚'
+ docs: {
+ description:
+ "Documentation-only change, including READMEs, JSDoc/Doxygen-style comments, source comments, annotations, and examples (including examples files) and excluding TypeScript declarations",
+ title: "Documentation",
+ emoji: "📚",
},
- 'test': {
- 'description': 'Test-only change, including adding missing tests or correcting existing tests',
- 'title': 'Tests',
- 'emoji': '🚨'
+ test: {
+ description:
+ "Test-only change, including adding missing tests or correcting existing tests",
+ title: "Tests",
+ emoji: "🚨",
},
- 'bench': {
- 'description': 'Benchmark-only change (e.g., adding missing benchmarks or correcting existing benchmarks)',
- 'title': 'Benchmarks',
- 'emoji': '⏱'
+ bench: {
+ description:
+ "Benchmark-only change (e.g., adding missing benchmarks or correcting existing benchmarks)",
+ title: "Benchmarks",
+ emoji: "⏱",
},
- 'build': {
- 'description': 'Update how the project is built and released, including changes to automation and CI configuration files and scripts',
- 'title': 'Build Changes',
- 'emoji': '🛠'
+ build: {
+ description:
+ "Update how the project is built and released, including changes to automation and CI configuration files and scripts",
+ title: "Build Changes",
+ emoji: "🛠",
},
- 'refactor': {
- 'description': 'Neither a fix nor a feature (i.e., a change which does not affect behavior as experienced by downstream consumers',
- 'title': 'Code Refactoring',
- 'emoji': '🚧'
+ refactor: {
+ description:
+ "Neither a fix nor a feature (i.e., a change which does not affect behavior as experienced by downstream consumers",
+ title: "Code Refactoring",
+ emoji: "🚧",
},
- 'style': {
- 'description': 'Improve code style, including changes to whitespace, formatting, semicolons, etc, which do not affect the meaning of code',
- 'title': 'Style Updates',
- 'emoji': '💎'
+ style: {
+ description:
+ "Improve code style, including changes to whitespace, formatting, semicolons, etc, which do not affect the meaning of code",
+ title: "Style Updates",
+ emoji: "💎",
},
- 'chore': {
- 'description': 'Neither a fix, a feature, nor a refactor (i.e., a repetitive mechanical task, such as updating package meta data or updating external dependencies)',
- 'title': 'Chores',
- 'emoji': '🧺'
+ chore: {
+ description:
+ "Neither a fix, a feature, nor a refactor (i.e., a repetitive mechanical task, such as updating package meta data or updating external dependencies)",
+ title: "Chores",
+ emoji: "🧺",
},
- 'temp': {
- 'description': 'Temporary, experimental, or exploratory change that is not intended to be permanent (e.g., as may be desired when debugging CI or when ad-hoc debugging on live systems)',
- 'title': 'Temporary Changes',
- 'emoji': '💡'
+ temp: {
+ description:
+ "Temporary, experimental, or exploratory change that is not intended to be permanent (e.g., as may be desired when debugging CI or when ad-hoc debugging on live systems)",
+ title: "Temporary Changes",
+ emoji: "💡",
},
- 'revert': {
- 'description': 'Revert previous commit',
- 'title': 'Reverted Changes',
- 'emoji': '♻️'
- }
- }
+ revert: {
+ description: "Revert previous commit",
+ title: "Reverted Changes",
+ emoji: "♻️",
+ },
+ },
};
/**
-* Question for providing a short description.
-*
-* @name subject
-* @memberof config.questions
-* @type {Object}
-*/
-config.questions[ 'subject' ] = {
- 'description': 'Write a short description of the change using the imperative mood'
+ * Question for providing a short description.
+ *
+ * @name subject
+ * @memberof config.questions
+ * @type {Object}
+ */
+config.questions["subject"] = {
+ description:
+ "Write a short description of the change using the imperative mood",
};
/**
-* Question for providing a long description.
-*
-* @name body
-* @memberof config.questions
-* @type {Object}
-*/
-config.questions[ 'body' ] = {
- 'description': 'Provide a longer description of the change'
+ * Question for providing a long description.
+ *
+ * @name body
+ * @memberof config.questions
+ * @type {Object}
+ */
+config.questions["body"] = {
+ description: "Provide a longer description of the change",
};
/**
-* Question for indicating whether a change is breaking.
-*
-* @name isBreaking
-* @memberof config.questions
-* @type {Object}
-*/
-config.questions[ 'isBreaking' ] = {
- 'description': 'Are there any breaking changes?'
+ * Question for indicating whether a change is breaking.
+ *
+ * @name isBreaking
+ * @memberof config.questions
+ * @type {Object}
+ */
+config.questions["isBreaking"] = {
+ description: "Are there any breaking changes?",
};
/**
-* Question for providing a short summary of a breaking change.
-*
-* @name breaking
-* @memberof config.questions
-* @type {Object}
-*/
-config.questions[ 'breaking' ] = {
- 'description': 'Write a short description of the breaking change'
+ * Question for providing a short summary of a breaking change.
+ *
+ * @name breaking
+ * @memberof config.questions
+ * @type {Object}
+ */
+config.questions["breaking"] = {
+ description: "Write a short description of the breaking change",
};
/**
-* Question for providing a longer description of a breaking change.
-*
-* @name breakingCode
-* @memberof config.questions
-* @type {Object}
-*/
-config.questions[ 'breakingCode' ] = {
- 'description': 'A BREAKING CHANGE commit should typically include a detailed description and migration instructions. If applicable, please enter a longer description'
+ * Question for providing a longer description of a breaking change.
+ *
+ * @name breakingCode
+ * @memberof config.questions
+ * @type {Object}
+ */
+config.questions["breakingCode"] = {
+ description:
+ "A BREAKING CHANGE commit should typically include a detailed description and migration instructions. If applicable, please enter a longer description",
};
/**
-* Question for providing a short summary of a breaking change.
-*
-* @name breaking
-* @memberof config.questions
-* @type {Object}
-*/
-config.questions[ 'breaking' ] = {
- 'description': 'Write a short description of the breaking change'
+ * Question for providing a short summary of a breaking change.
+ *
+ * @name breaking
+ * @memberof config.questions
+ * @type {Object}
+ */
+config.questions["breaking"] = {
+ description: "Write a short description of the breaking change",
};
/**
-* Question for indicating whether a change affects any issues.
-*
-* @name isIssueAffected
-* @memberof config.questions
-* @type {Object}
-*/
-config.questions[ 'isIssueAffected' ] = {
- 'description': 'Does this change affect any issues?'
+ * Question for indicating whether a change affects any issues.
+ *
+ * @name isIssueAffected
+ * @memberof config.questions
+ * @type {Object}
+ */
+config.questions["isIssueAffected"] = {
+ description: "Does this change affect any issues?",
};
/**
-* Question for listing issue references.
-*
-* @name issues
-* @memberof config.questions
-* @type {Object}
-*/
-config.questions[ 'issues' ] = {
- 'description': 'Please list affected issues (e.g., "fix #123", "close #456", etc)'
+ * Question for listing issue references.
+ *
+ * @name issues
+ * @memberof config.questions
+ * @type {Object}
+ */
+config.questions["issues"] = {
+ description:
+ 'Please list affected issues (e.g., "fix #123", "close #456", etc)',
};
-
// EXPORTS //
module.exports = config;
diff --git a/etc/commitlint/rules/index.js b/etc/commitlint/rules/index.js
index e614089c73d4..18c17ae262c1 100644
--- a/etc/commitlint/rules/index.js
+++ b/etc/commitlint/rules/index.js
@@ -1,368 +1,375 @@
/**
-* @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';
+ * @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";
/* eslint-disable stdlib/jsdoc-leading-description-sentence */
/**
-* commitlint rules.
-*
-* @name rules
-* @type {Object}
-*/
+ * commitlint rules.
+ *
+ * @name rules
+ * @type {Object}
+ */
var rules = {};
/**
-* Allow the commit message body to end with a full stop.
-*
-* @name body-full-stop
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'body-full-stop' ] = [ 0, 'always', '.' ];
-
-/**
-* Require that the commit message body always begin with a blank line.
-*
-* @name body-leading-blank
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'body-leading-blank' ] = [ 2, 'always' ];
-
-/**
-* Allow the commit message body to be empty.
-*
-* @name body-empty
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'body-empty' ] = [ 0, 'never' ];
-
-/**
-* Do not impose a maximum commit message body length.
-*
-* @name body-max-length
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'body-max-length' ] = [ 2, 'always', 1/0 ];
-
-/**
-* Warn whenever the commit message body line length exceeds 72 characters.
-*
-* @name body-max-line-length
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'body-max-line-length' ] = [ 1, 'always', 72 ];
-
-/**
-* Require that the commit message body length be at least 20 characters.
-*
-* @name body-min-length
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'body-min-length' ] = [ 0, 'always', 20 ]; // NOTE: disabled due to commitzen not respecting the rule allowing the commit message body to be empty
-
-/**
-* Allow the commit message body to be in any case.
-*
-* @name body-case
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'body-case' ] = [ 0, 'always', 'lower-case' ];
-
-/**
-* Require that the commit message footer begin with a blank line.
-*
-* @name footer-leading-blank
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'footer-leading-blank' ] = [ 2, 'always' ];
-
-/**
-* Do not require that a commit message footer always be present.
-*
-* @name footer-empty
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'footer-empty' ] = [ 0, 'never' ];
-
-/**
-* Do not impose a maximum commit message footer length.
-*
-* @name footer-max-length
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'footer-max-length' ] = [ 2, 'always', 1/0 ];
-
-/**
-* Warn whenever the commit message footer line length exceeds 72 characters.
-*
-* @name footer-max-line-length
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'footer-max-line-length' ] = [ 1, 'always', 72 ];
-
-/**
-* Do not impose a minimum commit message footer length.
-*
-* @name footer-min-length
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'footer-min-length' ] = [ 2, 'always', 0 ];
-
-/**
-* Delegate header casing to rules governing individual components.
-*
-* @name header-case
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'header-case' ] = [ 0, 'always', 'lower-case' ];
-
-/**
-* Disallow ending the header with a full stop.
-*
-* @name header-full-stop
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'header-full-stop' ] = [ 2, 'never', '.' ];
-
-/**
-* Warn if the total header length exceeds 100 characters.
-*
-* @name header-max-length
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'header-max-length' ] = [ 1, 'always', 100 ];
-
-/**
-* Require that a commit header be at least 10 characters.
-*
-* @name header-min-length
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'header-min-length' ] = [ 2, 'always', 10 ];
-
-/**
-* Allow references to be empty.
-*
-* @name references-empty
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'references-empty' ] = [ 0, 'never' ];
-
-/**
-* Allow for arbitrary scopes.
-*
-* @name scope-enum
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'scope-enum' ] = [ 0, 'always' ];
-
-/**
-* Require that scopes be in lower case.
-*
-* @name scope-case
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'scope-case' ] = [ 2, 'always', 'lower-case' ];
-
-/**
-* Allow the scope to be empty.
-*
-* @name scope-empty
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'scope-empty' ] = [ 0, 'never' ];
-
-/**
-* Warn if the scope length exceeds 72 characters.
-*
-* @name scope-max-length
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'scope-max-length' ] = [ 1, 'always', 72 ];
-
-/**
-* Do not require a minimum scope length.
-*
-* @name scope-min-length
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'scope-min-length' ] = [ 2, 'always', 0 ];
-
-/**
-* Disallow beginning a commit message subject with a capital letter.
-*
-* @name subject-case
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'subject-case' ] = [ 2, 'never', [
- 'sentence-case', // Sentence case
- 'start-case', // Start Case
- 'pascal-case', // PascalCase
- 'upper-case' // UPPERCASE
-]];
-
-/**
-* Require that a commit message subject always be present.
-*
-* @name subject-empty
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'subject-empty' ] = [ 2, 'never' ];
-
-/**
-* Disallow ending the commit message subject with a full stop.
-*
-* @name subject-full-stop
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'subject-full-stop' ] = [ 2, 'never', '.' ];
-
-/**
-* Warn if the commit message subject exceeds 72 characters.
-*
-* @name subject-max-length
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'subject-max-length' ] = [ 1, 'always', 72 ];
-
-/**
-* Require that the commit message subject be at least 7 characters.
-*
-* @name subject-min-length
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'subject-min-length' ] = [ 2, 'always', 7 ];
-
-/**
-* Allow an exclamation mark before the `:` marker.
-*
-* @name subject-exclamation-mark
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'subject-exclamation-mark' ] = [ 0, 'always' ];
-
-/**
-* Require that the commit message type be one of a finite number of values.
-*
-* @name type-enum
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'type-enum' ] = [ 2, 'always', [
- 'bench',
- 'build',
- 'chore',
- 'deprecate',
- 'docs',
- 'feat',
- 'fix',
- 'perf',
- 'refactor',
- 'remove',
- 'revert',
- 'style',
- 'test',
- 'temp'
-]];
-
-/**
-* Require that the commit message type always be lower case.
-*
-* @name type-case
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'type-case' ] = [ 2, 'always', 'lower-case' ];
-
-/**
-* Require that a commit message type always be provided.
-*
-* @name type-empty
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'type-empty' ] = [ 2, 'never' ];
-
-/**
-* Warn if the commit message type exceeds 20 characters.
-*
-* @name type-max-length
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'type-max-length' ] = [ 1, 'always', 20 ];
-
-/**
-* Require that the commit message type be at least 1 character.
-*
-* @name type-min-length
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'type-min-length' ] = [ 2, 'always', 1 ];
-
-/**
-* Do not require the present of the `Signed-off-by` trailer.
-*
-* @name signed-off-by
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'signed-off-by' ] = [ 0, 'always' ];
-
-/**
-* Do not require that a commit message has a specific trailer.
-*
-* @name trailer-exists
-* @memberof rules
-* @type {Array}
-*/
-rules[ 'trailer-exists' ] = [ 0, 'always', 'Signed-off-by:' ];
-
+ * Allow the commit message body to end with a full stop.
+ *
+ * @name body-full-stop
+ * @memberof rules
+ * @type {Array}
+ */
+rules["body-full-stop"] = [0, "always", "."];
+
+/**
+ * Require that the commit message body always begin with a blank line.
+ *
+ * @name body-leading-blank
+ * @memberof rules
+ * @type {Array}
+ */
+rules["body-leading-blank"] = [2, "always"];
+
+/**
+ * Allow the commit message body to be empty.
+ *
+ * @name body-empty
+ * @memberof rules
+ * @type {Array}
+ */
+rules["body-empty"] = [0, "never"];
+
+/**
+ * Do not impose a maximum commit message body length.
+ *
+ * @name body-max-length
+ * @memberof rules
+ * @type {Array}
+ */
+rules["body-max-length"] = [2, "always", 1 / 0];
+
+/**
+ * Warn whenever the commit message body line length exceeds 72 characters.
+ *
+ * @name body-max-line-length
+ * @memberof rules
+ * @type {Array}
+ */
+rules["body-max-line-length"] = [1, "always", 72];
+
+/**
+ * Require that the commit message body length be at least 20 characters.
+ *
+ * @name body-min-length
+ * @memberof rules
+ * @type {Array}
+ */
+rules["body-min-length"] = [0, "always", 20]; // NOTE: disabled due to commitzen not respecting the rule allowing the commit message body to be empty
+
+/**
+ * Allow the commit message body to be in any case.
+ *
+ * @name body-case
+ * @memberof rules
+ * @type {Array}
+ */
+rules["body-case"] = [0, "always", "lower-case"];
+
+/**
+ * Require that the commit message footer begin with a blank line.
+ *
+ * @name footer-leading-blank
+ * @memberof rules
+ * @type {Array}
+ */
+rules["footer-leading-blank"] = [2, "always"];
+
+/**
+ * Do not require that a commit message footer always be present.
+ *
+ * @name footer-empty
+ * @memberof rules
+ * @type {Array}
+ */
+rules["footer-empty"] = [0, "never"];
+
+/**
+ * Do not impose a maximum commit message footer length.
+ *
+ * @name footer-max-length
+ * @memberof rules
+ * @type {Array}
+ */
+rules["footer-max-length"] = [2, "always", 1 / 0];
+
+/**
+ * Warn whenever the commit message footer line length exceeds 72 characters.
+ *
+ * @name footer-max-line-length
+ * @memberof rules
+ * @type {Array}
+ */
+rules["footer-max-line-length"] = [1, "always", 72];
+
+/**
+ * Do not impose a minimum commit message footer length.
+ *
+ * @name footer-min-length
+ * @memberof rules
+ * @type {Array}
+ */
+rules["footer-min-length"] = [2, "always", 0];
+
+/**
+ * Delegate header casing to rules governing individual components.
+ *
+ * @name header-case
+ * @memberof rules
+ * @type {Array}
+ */
+rules["header-case"] = [0, "always", "lower-case"];
+
+/**
+ * Disallow ending the header with a full stop.
+ *
+ * @name header-full-stop
+ * @memberof rules
+ * @type {Array}
+ */
+rules["header-full-stop"] = [2, "never", "."];
+
+/**
+ * Warn if the total header length exceeds 100 characters.
+ *
+ * @name header-max-length
+ * @memberof rules
+ * @type {Array}
+ */
+rules["header-max-length"] = [1, "always", 100];
+
+/**
+ * Require that a commit header be at least 10 characters.
+ *
+ * @name header-min-length
+ * @memberof rules
+ * @type {Array}
+ */
+rules["header-min-length"] = [2, "always", 10];
+
+/**
+ * Allow references to be empty.
+ *
+ * @name references-empty
+ * @memberof rules
+ * @type {Array}
+ */
+rules["references-empty"] = [0, "never"];
+
+/**
+ * Allow for arbitrary scopes.
+ *
+ * @name scope-enum
+ * @memberof rules
+ * @type {Array}
+ */
+rules["scope-enum"] = [0, "always"];
+
+/**
+ * Require that scopes be in lower case.
+ *
+ * @name scope-case
+ * @memberof rules
+ * @type {Array}
+ */
+rules["scope-case"] = [2, "always", "lower-case"];
+
+/**
+ * Allow the scope to be empty.
+ *
+ * @name scope-empty
+ * @memberof rules
+ * @type {Array}
+ */
+rules["scope-empty"] = [0, "never"];
+
+/**
+ * Warn if the scope length exceeds 72 characters.
+ *
+ * @name scope-max-length
+ * @memberof rules
+ * @type {Array}
+ */
+rules["scope-max-length"] = [1, "always", 72];
+
+/**
+ * Do not require a minimum scope length.
+ *
+ * @name scope-min-length
+ * @memberof rules
+ * @type {Array}
+ */
+rules["scope-min-length"] = [2, "always", 0];
+
+/**
+ * Disallow beginning a commit message subject with a capital letter.
+ *
+ * @name subject-case
+ * @memberof rules
+ * @type {Array}
+ */
+rules["subject-case"] = [
+ 2,
+ "never",
+ [
+ "sentence-case", // Sentence case
+ "start-case", // Start Case
+ "pascal-case", // PascalCase
+ "upper-case", // UPPERCASE
+ ],
+];
+
+/**
+ * Require that a commit message subject always be present.
+ *
+ * @name subject-empty
+ * @memberof rules
+ * @type {Array}
+ */
+rules["subject-empty"] = [2, "never"];
+
+/**
+ * Disallow ending the commit message subject with a full stop.
+ *
+ * @name subject-full-stop
+ * @memberof rules
+ * @type {Array}
+ */
+rules["subject-full-stop"] = [2, "never", "."];
+
+/**
+ * Warn if the commit message subject exceeds 72 characters.
+ *
+ * @name subject-max-length
+ * @memberof rules
+ * @type {Array}
+ */
+rules["subject-max-length"] = [1, "always", 72];
+
+/**
+ * Require that the commit message subject be at least 7 characters.
+ *
+ * @name subject-min-length
+ * @memberof rules
+ * @type {Array}
+ */
+rules["subject-min-length"] = [2, "always", 7];
+
+/**
+ * Allow an exclamation mark before the `:` marker.
+ *
+ * @name subject-exclamation-mark
+ * @memberof rules
+ * @type {Array}
+ */
+rules["subject-exclamation-mark"] = [0, "always"];
+
+/**
+ * Require that the commit message type be one of a finite number of values.
+ *
+ * @name type-enum
+ * @memberof rules
+ * @type {Array}
+ */
+rules["type-enum"] = [
+ 2,
+ "always",
+ [
+ "bench",
+ "build",
+ "chore",
+ "deprecate",
+ "docs",
+ "feat",
+ "fix",
+ "perf",
+ "refactor",
+ "remove",
+ "revert",
+ "style",
+ "test",
+ "temp",
+ ],
+];
+
+/**
+ * Require that the commit message type always be lower case.
+ *
+ * @name type-case
+ * @memberof rules
+ * @type {Array}
+ */
+rules["type-case"] = [2, "always", "lower-case"];
+
+/**
+ * Require that a commit message type always be provided.
+ *
+ * @name type-empty
+ * @memberof rules
+ * @type {Array}
+ */
+rules["type-empty"] = [2, "never"];
+
+/**
+ * Warn if the commit message type exceeds 20 characters.
+ *
+ * @name type-max-length
+ * @memberof rules
+ * @type {Array}
+ */
+rules["type-max-length"] = [1, "always", 20];
+
+/**
+ * Require that the commit message type be at least 1 character.
+ *
+ * @name type-min-length
+ * @memberof rules
+ * @type {Array}
+ */
+rules["type-min-length"] = [2, "always", 1];
+
+/**
+ * Do not require the present of the `Signed-off-by` trailer.
+ *
+ * @name signed-off-by
+ * @memberof rules
+ * @type {Array}
+ */
+rules["signed-off-by"] = [0, "always"];
+
+/**
+ * Do not require that a commit message has a specific trailer.
+ *
+ * @name trailer-exists
+ * @memberof rules
+ * @type {Array}
+ */
+rules["trailer-exists"] = [0, "always", "Signed-off-by:"];
// EXPORTS //
diff --git a/etc/editorconfig-checker/.editorconfig_checker.markdown.json b/etc/editorconfig-checker/.editorconfig_checker.markdown.json
index 5412d2b72d33..c4b9f92d5ec5 100644
--- a/etc/editorconfig-checker/.editorconfig_checker.markdown.json
+++ b/etc/editorconfig-checker/.editorconfig_checker.markdown.json
@@ -4,9 +4,7 @@
"IgnoreDefaults": true,
"SpacesAfterTabs": false,
"NoColor": false,
- "Exclude": [
- "\\.*[^d]$"
- ],
+ "Exclude": ["\\.*[^d]$"],
"AllowedContentTypes": [],
"PassedFiles": [],
"Disable": {
diff --git a/etc/eslint/.eslintrc.benchmarks.js b/etc/eslint/.eslintrc.benchmarks.js
index df81dfc6dceb..7bf218a6b2fc 100644
--- a/etc/eslint/.eslintrc.benchmarks.js
+++ b/etc/eslint/.eslintrc.benchmarks.js
@@ -1,124 +1,126 @@
/**
-* @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';
+ * @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 //
// FIXME: remove the next line and uncomment the subsequent line once all remark JSDoc ESLint rules are completed
-var copy = require( './../../lib/node_modules/@stdlib/utils/copy' );
+var copy = require("./../../lib/node_modules/@stdlib/utils/copy");
// var copy = require( './utils/copy.js' );
-var defaults = require( './.eslintrc.js' );
-
+var defaults = require("./.eslintrc.js");
// MAIN //
/**
-* ESLint configuration.
-*
-* @namespace eslint
-*/
-var eslint = copy( defaults );
+ * ESLint configuration.
+ *
+ * @namespace eslint
+ */
+var eslint = copy(defaults);
/**
-* Warn when using `String`, `Number`, and `Boolean` in place of primitives.
-*
-* @private
-*/
-eslint.rules[ 'no-new-wrappers' ] = 'warn';
+ * Warn when using `String`, `Number`, and `Boolean` in place of primitives.
+ *
+ * @private
+ */
+eslint.rules["no-new-wrappers"] = "warn";
/**
-* Override the limit for source code lines in a file.
-*
-* @private
-*/
-eslint.rules[ 'max-lines' ] = [ 'warn', {
- 'max': 1000,
- 'skipBlankLines': true,
- 'skipComments': true
-}];
+ * Override the limit for source code lines in a file.
+ *
+ * @private
+ */
+eslint.rules["max-lines"] = [
+ "warn",
+ {
+ max: 1000,
+ skipBlankLines: true,
+ skipComments: true,
+ },
+];
/**
-* Override list of restricted syntax.
-*
-* @private
-*/
-eslint.rules[ 'no-restricted-syntax' ] = [ 'error',
- 'ArrowFunctionExpression',
- 'ClassBody',
- 'ClassDeclaration',
- 'ClassExpression',
- 'DebuggerStatement',
- 'ExperimentalRestProperty',
- 'ExperimentalSpreadProperty',
+ * Override list of restricted syntax.
+ *
+ * @private
+ */
+eslint.rules["no-restricted-syntax"] = [
+ "error",
+ "ArrowFunctionExpression",
+ "ClassBody",
+ "ClassDeclaration",
+ "ClassExpression",
+ "DebuggerStatement",
+ "ExperimentalRestProperty",
+ "ExperimentalSpreadProperty",
// 'FunctionExpression',
- 'LabeledStatement',
- 'RestElement',
- 'SpreadElement',
- 'TaggedTemplateExpression',
- 'TemplateElement',
- 'TemplateLiteral',
- 'WithStatement',
- 'YieldExpression',
- 'JSXIdentifier',
- 'JSXNamespacedName',
- 'JSXMemberExpression',
- 'JSXEmptyExpression',
- 'JSXExpressionContainer',
- 'JSXElement',
- 'JSXClosingElement',
- 'JSXOpeningElement',
- 'JSXAttribute',
- 'JSXSpreadAttribute',
- 'JSXText',
- 'ExportDefaultDeclaration',
- 'ExportNamedDeclaration',
- 'ExportAllDeclaration',
- 'ExportSpecifier',
- 'ImportDeclaration',
- 'ImportSpecifier',
- 'ImportDefaultSpecifier',
- 'ImportNamespaceSpecifier'
+ "LabeledStatement",
+ "RestElement",
+ "SpreadElement",
+ "TaggedTemplateExpression",
+ "TemplateElement",
+ "TemplateLiteral",
+ "WithStatement",
+ "YieldExpression",
+ "JSXIdentifier",
+ "JSXNamespacedName",
+ "JSXMemberExpression",
+ "JSXEmptyExpression",
+ "JSXExpressionContainer",
+ "JSXElement",
+ "JSXClosingElement",
+ "JSXOpeningElement",
+ "JSXAttribute",
+ "JSXSpreadAttribute",
+ "JSXText",
+ "ExportDefaultDeclaration",
+ "ExportNamedDeclaration",
+ "ExportAllDeclaration",
+ "ExportSpecifier",
+ "ImportDeclaration",
+ "ImportSpecifier",
+ "ImportDefaultSpecifier",
+ "ImportNamespaceSpecifier",
];
/**
-* Do not require JSDoc comments.
-*
-* @private
-*/
-eslint.rules[ 'require-jsdoc' ] = 'off';
+ * Do not require JSDoc comments.
+ *
+ * @private
+ */
+eslint.rules["require-jsdoc"] = "off";
/**
-* Do not require `@private` annotations.
-*
-* @private
-*/
-eslint.rules[ 'stdlib/jsdoc-private-annotation' ] = 'off';
+ * Do not require `@private` annotations.
+ *
+ * @private
+ */
+eslint.rules["stdlib/jsdoc-private-annotation"] = "off";
/**
-* Do not lint return annotation values in JSDoc comments.
-*
-* @private
-*/
-eslint.rules[ 'stdlib/jsdoc-doctest' ] = 'off';
-
+ * Do not lint return annotation values in JSDoc comments.
+ *
+ * @private
+ */
+eslint.rules["stdlib/jsdoc-doctest"] = "off";
// EXPORTS //
diff --git a/etc/eslint/.eslintrc.examples.js b/etc/eslint/.eslintrc.examples.js
index afa9a472ffd5..113749924b6f 100644
--- a/etc/eslint/.eslintrc.examples.js
+++ b/etc/eslint/.eslintrc.examples.js
@@ -1,104 +1,102 @@
/**
-* @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';
+ * @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 //
// FIXME: remove the next line and uncomment the subsequent line once all remark JSDoc ESLint rules are completed
-var copy = require( './../../lib/node_modules/@stdlib/utils/copy' );
+var copy = require("./../../lib/node_modules/@stdlib/utils/copy");
// var copy = require( './utils/copy.js' );
-var defaults = require( './.eslintrc.js' );
-
+var defaults = require("./.eslintrc.js");
// MAIN //
/**
-* ESLint configuration.
-*
-* @namespace eslint
-*/
-var eslint = copy( defaults );
+ * ESLint configuration.
+ *
+ * @namespace eslint
+ */
+var eslint = copy(defaults);
/**
-* Warn when using `String`, `Number`, and `Boolean` in place of primitives.
-*
-* @private
-*/
-eslint.rules[ 'no-new-wrappers' ] = 'warn';
+ * Warn when using `String`, `Number`, and `Boolean` in place of primitives.
+ *
+ * @private
+ */
+eslint.rules["no-new-wrappers"] = "warn";
/**
-* Allow variables to be declared as needed.
-*
-* @private
-*/
-eslint.rules[ 'vars-on-top' ] = 'off';
+ * Allow variables to be declared as needed.
+ *
+ * @private
+ */
+eslint.rules["vars-on-top"] = "off";
/**
-* Allow using `console`.
-*
-* @private
-*/
-eslint.rules[ 'no-console' ] = 'off';
+ * Allow using `console`.
+ *
+ * @private
+ */
+eslint.rules["no-console"] = "off";
/**
-* Do not require JSDoc comments.
-*
-* @private
-*/
-eslint.rules[ 'require-jsdoc' ] = 'off';
+ * Do not require JSDoc comments.
+ *
+ * @private
+ */
+eslint.rules["require-jsdoc"] = "off";
/**
-* Do not require `@private` annotations.
-*
-* @private
-*/
-eslint.rules[ 'stdlib/jsdoc-private-annotation' ] = 'off';
+ * Do not require `@private` annotations.
+ *
+ * @private
+ */
+eslint.rules["stdlib/jsdoc-private-annotation"] = "off";
/**
-* Do not lint return annotation values in JSDoc comments.
-*
-* @private
-*/
-eslint.rules[ 'stdlib/jsdoc-doctest' ] = 'off';
+ * Do not lint return annotation values in JSDoc comments.
+ *
+ * @private
+ */
+eslint.rules["stdlib/jsdoc-doctest"] = "off";
/**
-* Lint return annotation values.
-*
-* @private
-*/
-eslint.rules[ 'stdlib/doctest' ] = 'error';
+ * Lint return annotation values.
+ *
+ * @private
+ */
+eslint.rules["stdlib/doctest"] = "error";
/**
-* Do not require ordering of variable declarations inside of functions.
-*
-* @private
-*/
-eslint.rules[ 'stdlib/vars-order' ] = 'off';
+ * Do not require ordering of variable declarations inside of functions.
+ *
+ * @private
+ */
+eslint.rules["stdlib/vars-order"] = "off";
/**
-* Enforce that last `require` is a relative path.
-*
-* @private
-*/
-eslint.rules[ 'stdlib/require-last-path-relative' ] = 'error';
-
+ * Enforce that last `require` is a relative path.
+ *
+ * @private
+ */
+eslint.rules["stdlib/require-last-path-relative"] = "error";
// EXPORTS //
diff --git a/etc/eslint/.eslintrc.js b/etc/eslint/.eslintrc.js
index 2c41be4d3051..9f2bfaf23be5 100644
--- a/etc/eslint/.eslintrc.js
+++ b/etc/eslint/.eslintrc.js
@@ -1,87 +1,86 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// MAIN //
/**
-* ESLint configuration.
-*
-* @namespace eslint
-*/
+ * ESLint configuration.
+ *
+ * @namespace eslint
+ */
var eslint = {};
/**
-* Root configuration.
-*
-* @name root
-* @memberof eslint
-* @type {boolean}
-* @default true
-*/
+ * Root configuration.
+ *
+ * @name root
+ * @memberof eslint
+ * @type {boolean}
+ * @default true
+ */
eslint.root = true;
/**
-* Default environments.
-*
-* @name env
-* @memberof eslint
-* @type {Object}
-*/
-eslint.env = require( './env' );
+ * Default environments.
+ *
+ * @name env
+ * @memberof eslint
+ * @type {Object}
+ */
+eslint.env = require("./env");
/**
-* Lint rules.
-*
-* @name rules
-* @memberof eslint
-* @type {Object}
-*/
-eslint.rules = require( './rules' );
+ * Lint rules.
+ *
+ * @name rules
+ * @memberof eslint
+ * @type {Object}
+ */
+eslint.rules = require("./rules");
/**
-* Overrides.
-*
-* @name overrides
-* @memberof eslint
-* @type {Array}
-*/
-eslint.overrides = require( './overrides/repl_namespace.js' );
+ * Overrides.
+ *
+ * @name overrides
+ * @memberof eslint
+ * @type {Array}
+ */
+eslint.overrides = require("./overrides/repl_namespace.js");
/**
-* Parser options.
-*
-* @name parserOptions
-* @memberof eslint
-* @type {Object}
-*/
-eslint.parserOptions = require( './parser-options' );
+ * Parser options.
+ *
+ * @name parserOptions
+ * @memberof eslint
+ * @type {Object}
+ */
+eslint.parserOptions = require("./parser-options");
/**
-* Plugins.
-*
-* @name plugins
-* @memberof eslint
-* @type {Object}
-*/
-eslint.plugins = require( './plugins' );
-
+ * Plugins.
+ *
+ * @name plugins
+ * @memberof eslint
+ * @type {Object}
+ */
+eslint.plugins = require("./plugins");
// EXPORTS //
diff --git a/etc/eslint/.eslintrc.markdown.js b/etc/eslint/.eslintrc.markdown.js
index 3c2648c862ad..11ba9073672a 100644
--- a/etc/eslint/.eslintrc.markdown.js
+++ b/etc/eslint/.eslintrc.markdown.js
@@ -1,151 +1,153 @@
/**
-* @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';
+ * @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 //
// FIXME: remove the next line and uncomment the subsequent line once all remark JSDoc ESLint rules are completed
-var copy = require( './../../lib/node_modules/@stdlib/utils/copy' );
+var copy = require("./../../lib/node_modules/@stdlib/utils/copy");
// Var copy = require( './utils/copy.js' );
-var defaults = require( './.eslintrc.js' );
-
+var defaults = require("./.eslintrc.js");
// MAIN //
/**
-* ESLint configuration.
-*
-* @namespace eslint
-*/
-var eslint = copy( defaults );
+ * ESLint configuration.
+ *
+ * @namespace eslint
+ */
+var eslint = copy(defaults);
/**
-* Allow variables to be declared as needed.
-*
-* @private
-*/
-eslint.rules[ 'vars-on-top' ] = 'off';
+ * Allow variables to be declared as needed.
+ *
+ * @private
+ */
+eslint.rules["vars-on-top"] = "off";
/**
-* Allow using synchronous methods.
-*
-* @private
-*/
-eslint.rules[ 'no-sync' ] = 'off';
+ * Allow using synchronous methods.
+ *
+ * @private
+ */
+eslint.rules["no-sync"] = "off";
/**
-* Allow using `console`.
-*
-* @private
-*/
-eslint.rules[ 'no-console' ] = 'off';
+ * Allow using `console`.
+ *
+ * @private
+ */
+eslint.rules["no-console"] = "off";
/**
-* Do not require `use strict` pragma.
-*
-* @private
-*/
-eslint.rules[ 'strict' ] = 'off';
+ * Do not require `use strict` pragma.
+ *
+ * @private
+ */
+eslint.rules["strict"] = "off";
/**
-* Do not require an end-of-line character in code blocks.
-*
-* @private
-*/
-eslint.rules[ 'eol-last' ] = 'off';
+ * Do not require an end-of-line character in code blocks.
+ *
+ * @private
+ */
+eslint.rules["eol-last"] = "off";
/**
-* Require `4` space indentation.
-*
-* @private
-*/
-eslint.rules[ 'indent' ] = [ 'error', 4, {
- 'SwitchCase': 0,
- 'VariableDeclarator': 1,
- 'outerIIFEBody': 1,
- 'MemberExpression': 1,
- 'FunctionDeclaration': {
- 'body': 1,
- 'parameters': 'off'
- },
- 'FunctionExpression': {
- 'body': 1,
- 'parameters': 'off'
+ * Require `4` space indentation.
+ *
+ * @private
+ */
+eslint.rules["indent"] = [
+ "error",
+ 4,
+ {
+ SwitchCase: 0,
+ VariableDeclarator: 1,
+ outerIIFEBody: 1,
+ MemberExpression: 1,
+ FunctionDeclaration: {
+ body: 1,
+ parameters: "off",
+ },
+ FunctionExpression: {
+ body: 1,
+ parameters: "off",
+ },
+ CallExpression: {
+ arguments: "off",
+ },
+ ArrayExpression: 1,
+ ObjectExpression: 1,
+ flatTernaryExpressions: true,
},
- 'CallExpression': {
- 'arguments': 'off'
- },
- 'ArrayExpression': 1,
- 'ObjectExpression': 1,
- 'flatTernaryExpressions': true
-}];
+];
/**
-* Never allow tabs.
-*
-* @private
-*/
-eslint.rules[ 'no-tabs' ] = 'error';
+ * Never allow tabs.
+ *
+ * @private
+ */
+eslint.rules["no-tabs"] = "error";
/**
-* Do not require JSDoc comments.
-*
-* @private
-*/
-eslint.rules[ 'require-jsdoc' ] = 'off';
+ * Do not require JSDoc comments.
+ *
+ * @private
+ */
+eslint.rules["require-jsdoc"] = "off";
/**
-* Do not require `@private` annotations.
-*
-* @private
-*/
-eslint.rules[ 'stdlib/jsdoc-private-annotation' ] = 'off';
+ * Do not require `@private` annotations.
+ *
+ * @private
+ */
+eslint.rules["stdlib/jsdoc-private-annotation"] = "off";
/**
-* Do not lint return annotation values in JSDoc comments.
-*
-* @private
-*/
-eslint.rules[ 'stdlib/jsdoc-return-annotations-values' ] = 'off'; // FIXME: remove this once we can reliably lint Markdown code blocks
+ * Do not lint return annotation values in JSDoc comments.
+ *
+ * @private
+ */
+eslint.rules["stdlib/jsdoc-return-annotations-values"] = "off"; // FIXME: remove this once we can reliably lint Markdown code blocks
/**
-* Allow use of undeclared variables, as variables may be defined in previous code blocks or be implied.
-*
-* @private
-*/
-eslint.rules[ 'no-undef' ] = 'off';
+ * Allow use of undeclared variables, as variables may be defined in previous code blocks or be implied.
+ *
+ * @private
+ */
+eslint.rules["no-undef"] = "off";
/**
-* Allow unused variables, as variables may be illustrative or used in subsequent code blocks.
-*
-* @private
-*/
-eslint.rules[ 'no-unused-vars' ] = 'off';
+ * Allow unused variables, as variables may be illustrative or used in subsequent code blocks.
+ *
+ * @private
+ */
+eslint.rules["no-unused-vars"] = "off";
/**
-* Allow unpublished packages to be required in example code.
-*
-* @private
-*/
-eslint.rules[ 'node/no-unpublished-require' ] = 'off';
-
+ * Allow unpublished packages to be required in example code.
+ *
+ * @private
+ */
+eslint.rules["node/no-unpublished-require"] = "off";
// EXPORTS //
diff --git a/etc/eslint/.eslintrc.overrides.js b/etc/eslint/.eslintrc.overrides.js
index 8b603bf87967..5a2cb27c9c74 100644
--- a/etc/eslint/.eslintrc.overrides.js
+++ b/etc/eslint/.eslintrc.overrides.js
@@ -1,50 +1,48 @@
/**
-* @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';
+ * @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 //
// FIXME: remove the next line and uncomment the subsequent line once all remark JSDoc ESLint rules are completed
-var copy = require( './../../lib/node_modules/@stdlib/utils/copy' );
+var copy = require("./../../lib/node_modules/@stdlib/utils/copy");
// var copy = require( './utils/copy.js' );
-var defaults = require( './.eslintrc.js' );
-
+var defaults = require("./.eslintrc.js");
// MAIN //
/**
-* ESLint configuration.
-*
-* @namespace eslint
-*/
-var eslint = copy( defaults );
+ * ESLint configuration.
+ *
+ * @namespace eslint
+ */
+var eslint = copy(defaults);
/**
-* Overrides.
-*
-* @name overrides
-* @memberof eslint
-* @type {Array}
-*/
-eslint.overrides = require( './overrides' );
-
+ * Overrides.
+ *
+ * @name overrides
+ * @memberof eslint
+ * @type {Array}
+ */
+eslint.overrides = require("./overrides");
// EXPORTS //
diff --git a/etc/eslint/.eslintrc.tests.js b/etc/eslint/.eslintrc.tests.js
index 7b8c3907a603..62553e34259c 100644
--- a/etc/eslint/.eslintrc.tests.js
+++ b/etc/eslint/.eslintrc.tests.js
@@ -1,138 +1,140 @@
/**
-* @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';
+ * @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 //
// FIXME: remove the next line and uncomment the subsequent line once all remark JSDoc ESLint rules are completed
-var copy = require( './../../lib/node_modules/@stdlib/utils/copy' );
+var copy = require("./../../lib/node_modules/@stdlib/utils/copy");
// var copy = require( './utils/copy.js' );
-var defaults = require( './.eslintrc.js' );
-
+var defaults = require("./.eslintrc.js");
// MAIN //
/**
-* ESLint configuration.
-*
-* @namespace eslint
-*/
-var eslint = copy( defaults );
+ * ESLint configuration.
+ *
+ * @namespace eslint
+ */
+var eslint = copy(defaults);
/**
-* Allow empty functions.
-*
-* @private
-*/
-eslint.rules[ 'no-empty-function' ] = 'off';
+ * Allow empty functions.
+ *
+ * @private
+ */
+eslint.rules["no-empty-function"] = "off";
/**
-* Warn when using `String`, `Number`, and `Boolean` in place of primitives.
-*
-* @private
-*/
-eslint.rules[ 'no-new-wrappers' ] = 'warn';
+ * Warn when using `String`, `Number`, and `Boolean` in place of primitives.
+ *
+ * @private
+ */
+eslint.rules["no-new-wrappers"] = "warn";
/**
-* Override the limit for source code lines in a file.
-*
-* @private
-*/
-eslint.rules[ 'max-lines' ] = [ 'warn', {
- 'max': 1000,
- 'skipBlankLines': true,
- 'skipComments': true
-}];
+ * Override the limit for source code lines in a file.
+ *
+ * @private
+ */
+eslint.rules["max-lines"] = [
+ "warn",
+ {
+ max: 1000,
+ skipBlankLines: true,
+ skipComments: true,
+ },
+];
/**
-* Override list of restricted syntax.
-*
-* @private
-*/
-eslint.rules[ 'no-restricted-syntax' ] = [ 'error',
- 'ArrowFunctionExpression',
- 'ClassBody',
- 'ClassDeclaration',
- 'ClassExpression',
- 'DebuggerStatement',
- 'ExperimentalRestProperty',
- 'ExperimentalSpreadProperty',
+ * Override list of restricted syntax.
+ *
+ * @private
+ */
+eslint.rules["no-restricted-syntax"] = [
+ "error",
+ "ArrowFunctionExpression",
+ "ClassBody",
+ "ClassDeclaration",
+ "ClassExpression",
+ "DebuggerStatement",
+ "ExperimentalRestProperty",
+ "ExperimentalSpreadProperty",
// 'FunctionExpression',
- 'LabeledStatement',
- 'RestElement',
- 'SpreadElement',
- 'TaggedTemplateExpression',
- 'TemplateElement',
- 'TemplateLiteral',
- 'WithStatement',
- 'YieldExpression',
- 'JSXIdentifier',
- 'JSXNamespacedName',
- 'JSXMemberExpression',
- 'JSXEmptyExpression',
- 'JSXExpressionContainer',
- 'JSXElement',
- 'JSXClosingElement',
- 'JSXOpeningElement',
- 'JSXAttribute',
- 'JSXSpreadAttribute',
- 'JSXText',
- 'ExportDefaultDeclaration',
- 'ExportNamedDeclaration',
- 'ExportAllDeclaration',
- 'ExportSpecifier',
- 'ImportDeclaration',
- 'ImportSpecifier',
- 'ImportDefaultSpecifier',
- 'ImportNamespaceSpecifier'
+ "LabeledStatement",
+ "RestElement",
+ "SpreadElement",
+ "TaggedTemplateExpression",
+ "TemplateElement",
+ "TemplateLiteral",
+ "WithStatement",
+ "YieldExpression",
+ "JSXIdentifier",
+ "JSXNamespacedName",
+ "JSXMemberExpression",
+ "JSXEmptyExpression",
+ "JSXExpressionContainer",
+ "JSXElement",
+ "JSXClosingElement",
+ "JSXOpeningElement",
+ "JSXAttribute",
+ "JSXSpreadAttribute",
+ "JSXText",
+ "ExportDefaultDeclaration",
+ "ExportNamedDeclaration",
+ "ExportAllDeclaration",
+ "ExportSpecifier",
+ "ImportDeclaration",
+ "ImportSpecifier",
+ "ImportDefaultSpecifier",
+ "ImportNamespaceSpecifier",
];
/**
-* Do not require JSDoc comments.
-*
-* @private
-*/
-eslint.rules[ 'require-jsdoc' ] = 'off';
+ * Do not require JSDoc comments.
+ *
+ * @private
+ */
+eslint.rules["require-jsdoc"] = "off";
/**
-* Do not require `@private` annotations.
-*
-* @private
-*/
-eslint.rules[ 'stdlib/jsdoc-private-annotation' ] = 'off';
+ * Do not require `@private` annotations.
+ *
+ * @private
+ */
+eslint.rules["stdlib/jsdoc-private-annotation"] = "off";
/**
-* Do not lint return annotation values in JSDoc comments.
-*
-* @private
-*/
-eslint.rules[ 'stdlib/jsdoc-doctest' ] = 'off';
+ * Do not lint return annotation values in JSDoc comments.
+ *
+ * @private
+ */
+eslint.rules["stdlib/jsdoc-doctest"] = "off";
/**
-* Allow the use of `undefined`.
-*
-* @private
-*/
-eslint.rules[ 'no-undefined' ] = 'off';
-
+ * Allow the use of `undefined`.
+ *
+ * @private
+ */
+eslint.rules["no-undefined"] = "off";
// EXPORTS //
diff --git a/etc/eslint/.eslintrc.typescript.js b/etc/eslint/.eslintrc.typescript.js
index c9bb3cddd867..c0059f9fc286 100644
--- a/etc/eslint/.eslintrc.typescript.js
+++ b/etc/eslint/.eslintrc.typescript.js
@@ -1,82 +1,81 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// MAIN //
var eslint = {};
/**
-* Root configuration.
-*
-* @name root
-* @memberof eslint
-* @type {boolean}
-* @default true
-*/
+ * Root configuration.
+ *
+ * @name root
+ * @memberof eslint
+ * @type {boolean}
+ * @default true
+ */
eslint.root = true;
/**
-* Default environments.
-*
-* @name env
-* @memberof eslint
-* @type {Object}
-*/
-eslint.env = require( './env/typescript.js' );
+ * Default environments.
+ *
+ * @name env
+ * @memberof eslint
+ * @type {Object}
+ */
+eslint.env = require("./env/typescript.js");
/**
-* Lint rules.
-*
-* @name rules
-* @memberof eslint
-* @type {Object}
-*/
-eslint.rules = require( './rules/typescript.js' );
+ * Lint rules.
+ *
+ * @name rules
+ * @memberof eslint
+ * @type {Object}
+ */
+eslint.rules = require("./rules/typescript.js");
/**
-* Parser.
-*
-* @name parser
-* @memberof eslint
-* @type {string}
-*/
-eslint.parser = '@typescript-eslint/parser';
+ * Parser.
+ *
+ * @name parser
+ * @memberof eslint
+ * @type {string}
+ */
+eslint.parser = "@typescript-eslint/parser";
/**
-* Parser options.
-*
-* @name parserOptions
-* @memberof eslint
-* @type {Object}
-*/
-eslint.parserOptions = require( './parser-options/typescript.js' );
+ * Parser options.
+ *
+ * @name parserOptions
+ * @memberof eslint
+ * @type {Object}
+ */
+eslint.parserOptions = require("./parser-options/typescript.js");
/**
-* Plugins.
-*
-* @name plugins
-* @memberof eslint
-* @type {Object}
-*/
-eslint.plugins = require( './plugins/typescript.js' );
-
+ * Plugins.
+ *
+ * @name plugins
+ * @memberof eslint
+ * @type {Object}
+ */
+eslint.plugins = require("./plugins/typescript.js");
// EXPORTS //
diff --git a/etc/eslint/.eslintrc.typescript.tests.js b/etc/eslint/.eslintrc.typescript.tests.js
index 2f2b6a15a0da..99e6a1f5e8d4 100644
--- a/etc/eslint/.eslintrc.typescript.tests.js
+++ b/etc/eslint/.eslintrc.typescript.tests.js
@@ -1,83 +1,81 @@
/**
-* @license Apache-2.0
-*
-* Copyright (c) 2024 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';
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2024 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 //
// FIXME: remove the next line and uncomment the subsequent line once all remark JSDoc ESLint rules are completed
-var copy = require( './../../lib/node_modules/@stdlib/utils/copy' );
+var copy = require("./../../lib/node_modules/@stdlib/utils/copy");
// var copy = require( './utils/copy.js' );
-var defaults = require( './.eslintrc.typescript.js' );
-
+var defaults = require("./.eslintrc.typescript.js");
// MAIN //
/**
-* ESLint configuration.
-*
-* @namespace eslint
-*/
-var eslint = copy( defaults );
+ * ESLint configuration.
+ *
+ * @namespace eslint
+ */
+var eslint = copy(defaults);
/**
-* Disable the rule which requires explicit return types for functions and class methods.
-*
-* @private
-*/
-eslint.rules[ '@typescript-eslint/explicit-function-return-type' ] = 'off';
+ * Disable the rule which requires explicit return types for functions and class methods.
+ *
+ * @private
+ */
+eslint.rules["@typescript-eslint/explicit-function-return-type"] = "off";
/**
-* Disable the rule which disallows the use of variables before they are defined.
-*
-* @private
-*/
-eslint.rules[ '@typescript-eslint/no-use-before-define' ] = 'off';
+ * Disable the rule which disallows the use of variables before they are defined.
+ *
+ * @private
+ */
+eslint.rules["@typescript-eslint/no-use-before-define"] = "off";
/**
-* Disable the rule which enforces consistent brace style for blocks.
-*
-* @private
-*/
-eslint.rules[ 'brace-style' ] = 'off';
+ * Disable the rule which enforces consistent brace style for blocks.
+ *
+ * @private
+ */
+eslint.rules["brace-style"] = "off";
/**
-* Disable the rule which requires that throws statements are documented in JSDoc.
-*
-* @private
-*/
-eslint.rules[ 'jsdoc/require-throws' ] = 'off';
+ * Disable the rule which requires that throws statements are documented in JSDoc.
+ *
+ * @private
+ */
+eslint.rules["jsdoc/require-throws"] = "off";
/**
-* Disable the rule which requires that return statements are documented in JSDoc.
-*
-* @private
-*/
-eslint.rules[ 'jsdoc/require-returns' ] = 'off';
+ * Disable the rule which requires that return statements are documented in JSDoc.
+ *
+ * @private
+ */
+eslint.rules["jsdoc/require-returns"] = "off";
/**
-* Disable the rule which requires that function parameters are documented in JSDoc.
-*
-* @private
-*/
-eslint.rules[ 'jsdoc/require-param' ] = 'off';
-
+ * Disable the rule which requires that function parameters are documented in JSDoc.
+ *
+ * @private
+ */
+eslint.rules["jsdoc/require-param"] = "off";
// EXPORTS //
diff --git a/etc/eslint/env/index.js b/etc/eslint/env/index.js
index d8efc61bc709..2ce3f18240e3 100644
--- a/etc/eslint/env/index.js
+++ b/etc/eslint/env/index.js
@@ -1,305 +1,304 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
/**
-* ESLint default environments.
-*
-* @namespace env
-*/
+ * ESLint default environments.
+ *
+ * @namespace env
+ */
var env = {};
/**
-* Enable browser global variables.
-*
-* @name browser
-* @memberof env
-* @type {boolean}
-* @default true
-* @see [browser]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
-*/
-env[ 'browser' ] = true;
+ * Enable browser global variables.
+ *
+ * @name browser
+ * @memberof env
+ * @type {boolean}
+ * @default true
+ * @see [browser]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
+ */
+env["browser"] = true;
/**
-* Enable Node.js global variables and scoping.
-*
-* @name node
-* @memberof env
-* @type {boolean}
-* @default true
-* @see [node]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
-*/
-env[ 'node' ] = true;
+ * Enable Node.js global variables and scoping.
+ *
+ * @name node
+ * @memberof env
+ * @type {boolean}
+ * @default true
+ * @see [node]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
+ */
+env["node"] = true;
/**
-* Enable CommonJS global variables and scoping.
-*
-* @name commonjs
-* @memberof env
-* @type {boolean}
-* @default true
-* @see [commonjs]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
-*/
-env[ 'commonjs' ] = true;
+ * Enable CommonJS global variables and scoping.
+ *
+ * @name commonjs
+ * @memberof env
+ * @type {boolean}
+ * @default true
+ * @see [commonjs]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
+ */
+env["commonjs"] = true;
/**
-* Enable shared Browser and Node.js global variables and scoping.
-*
-* @name shared-node-browser
-* @memberof env
-* @type {boolean}
-* @default true
-* @see [shared-node-browser]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
-*/
-env[ 'shared-node-browser' ] = true;
+ * Enable shared Browser and Node.js global variables and scoping.
+ *
+ * @name shared-node-browser
+ * @memberof env
+ * @type {boolean}
+ * @default true
+ * @see [shared-node-browser]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
+ */
+env["shared-node-browser"] = true;
/**
-* Enable ES6 features.
-*
-* @name es6
-* @memberof env
-* @type {boolean}
-* @default true
-* @see [es6]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
-*/
-env[ 'es6' ] = true;
+ * Enable ES6 features.
+ *
+ * @name es6
+ * @memberof env
+ * @type {boolean}
+ * @default true
+ * @see [es6]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
+ */
+env["es6"] = true;
/**
-* Enable web worker global variables.
-*
-* @name worker
-* @memberof env
-* @type {boolean}
-* @default true
-* @see [worker]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
-*/
-env[ 'worker' ] = true;
+ * Enable web worker global variables.
+ *
+ * @name worker
+ * @memberof env
+ * @type {boolean}
+ * @default true
+ * @see [worker]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
+ */
+env["worker"] = true;
/**
-* Disable AMD global variables used for testing.
-*
-* @name amd
-* @memberof env
-* @type {boolean}
-* @default false
-* @see [amd]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
-*/
-env[ 'amd' ] = false;
+ * Disable AMD global variables used for testing.
+ *
+ * @name amd
+ * @memberof env
+ * @type {boolean}
+ * @default false
+ * @see [amd]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
+ */
+env["amd"] = false;
/**
-* Disable Mocha global variables used for testing.
-*
-* @name mocha
-* @memberof env
-* @type {boolean}
-* @default false
-* @see [mocha]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
-*/
-env[ 'mocha' ] = false;
+ * Disable Mocha global variables used for testing.
+ *
+ * @name mocha
+ * @memberof env
+ * @type {boolean}
+ * @default false
+ * @see [mocha]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
+ */
+env["mocha"] = false;
/**
-* Disable Jasmine global variables used for testing.
-*
-* @name jasmine
-* @memberof env
-* @type {boolean}
-* @default false
-* @see [jasmine]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
-*/
-env[ 'jasmine' ] = false;
+ * Disable Jasmine global variables used for testing.
+ *
+ * @name jasmine
+ * @memberof env
+ * @type {boolean}
+ * @default false
+ * @see [jasmine]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
+ */
+env["jasmine"] = false;
/**
-* Disable Jest global variables used for testing.
-*
-* @name jest
-* @memberof env
-* @type {boolean}
-* @default false
-* @see [jest]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
-*/
-env[ 'jest' ] = false;
+ * Disable Jest global variables used for testing.
+ *
+ * @name jest
+ * @memberof env
+ * @type {boolean}
+ * @default false
+ * @see [jest]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
+ */
+env["jest"] = false;
/**
-* Disable PhantomJS global variables used for testing.
-*
-* @name phantomjs
-* @memberof env
-* @type {boolean}
-* @default false
-* @see [phantomjs]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
-*/
-env[ 'phantomjs' ] = false;
+ * Disable PhantomJS global variables used for testing.
+ *
+ * @name phantomjs
+ * @memberof env
+ * @type {boolean}
+ * @default false
+ * @see [phantomjs]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
+ */
+env["phantomjs"] = false;
/**
-* Disable Protractor global variables used for testing.
-*
-* @name protractor
-* @memberof env
-* @type {boolean}
-* @default false
-* @see [protractor]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
-*/
-env[ 'protractor' ] = false;
+ * Disable Protractor global variables used for testing.
+ *
+ * @name protractor
+ * @memberof env
+ * @type {boolean}
+ * @default false
+ * @see [protractor]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
+ */
+env["protractor"] = false;
/**
-* Disable QUnit global variables used for testing.
-*
-* @name qunit
-* @memberof env
-* @type {boolean}
-* @default false
-* @see [qunit]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
-*/
-env[ 'qunit' ] = false;
+ * Disable QUnit global variables used for testing.
+ *
+ * @name qunit
+ * @memberof env
+ * @type {boolean}
+ * @default false
+ * @see [qunit]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
+ */
+env["qunit"] = false;
/**
-* Disable jQuery global variables used for testing.
-*
-* @name jquery
-* @memberof env
-* @type {boolean}
-* @default false
-* @see [jquery]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
-*/
-env[ 'jquery' ] = false;
+ * Disable jQuery global variables used for testing.
+ *
+ * @name jquery
+ * @memberof env
+ * @type {boolean}
+ * @default false
+ * @see [jquery]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
+ */
+env["jquery"] = false;
/**
-* Disable PrototypeJS global variables used for testing.
-*
-* @name prototypejs
-* @memberof env
-* @type {boolean}
-* @default false
-* @see [prototypejs]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
-*/
-env[ 'prototypejs' ] = false;
+ * Disable PrototypeJS global variables used for testing.
+ *
+ * @name prototypejs
+ * @memberof env
+ * @type {boolean}
+ * @default false
+ * @see [prototypejs]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
+ */
+env["prototypejs"] = false;
/**
-* Disable ShellJS global variables used for testing.
-*
-* @name shelljs
-* @memberof env
-* @type {boolean}
-* @default false
-* @see [shelljs]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
-*/
-env[ 'shelljs' ] = false;
+ * Disable ShellJS global variables used for testing.
+ *
+ * @name shelljs
+ * @memberof env
+ * @type {boolean}
+ * @default false
+ * @see [shelljs]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
+ */
+env["shelljs"] = false;
/**
-* Disable Meteor global variables used for testing.
-*
-* @name meteor
-* @memberof env
-* @type {boolean}
-* @default false
-* @see [meteor]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
-*/
-env[ 'meteor' ] = false;
+ * Disable Meteor global variables used for testing.
+ *
+ * @name meteor
+ * @memberof env
+ * @type {boolean}
+ * @default false
+ * @see [meteor]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
+ */
+env["meteor"] = false;
/**
-* Disable MongoDB global variables used for testing.
-*
-* @name mongo
-* @memberof env
-* @type {boolean}
-* @default false
-* @see [mongo]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
-*/
-env[ 'mongo' ] = false;
+ * Disable MongoDB global variables used for testing.
+ *
+ * @name mongo
+ * @memberof env
+ * @type {boolean}
+ * @default false
+ * @see [mongo]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
+ */
+env["mongo"] = false;
/**
-* Disable AppleScript global variables used for testing.
-*
-* @name applescript
-* @memberof env
-* @type {boolean}
-* @default false
-* @see [applescript]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
-*/
-env[ 'applescript' ] = false;
+ * Disable AppleScript global variables used for testing.
+ *
+ * @name applescript
+ * @memberof env
+ * @type {boolean}
+ * @default false
+ * @see [applescript]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
+ */
+env["applescript"] = false;
/**
-* Disable Nashorn global variables used for testing.
-*
-* @name nashorn
-* @memberof env
-* @type {boolean}
-* @default false
-* @see [nashorn]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
-*/
-env[ 'nashorn' ] = false;
+ * Disable Nashorn global variables used for testing.
+ *
+ * @name nashorn
+ * @memberof env
+ * @type {boolean}
+ * @default false
+ * @see [nashorn]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
+ */
+env["nashorn"] = false;
/**
-* Disable Service Worker global variables used for testing.
-*
-* @name serviceworker
-* @memberof env
-* @type {boolean}
-* @default false
-* @see [serviceworker]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
-*/
-env[ 'serviceworker' ] = false;
+ * Disable Service Worker global variables used for testing.
+ *
+ * @name serviceworker
+ * @memberof env
+ * @type {boolean}
+ * @default false
+ * @see [serviceworker]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
+ */
+env["serviceworker"] = false;
/**
-* Disable Atom test global variables used for testing.
-*
-* @name atomtest
-* @memberof env
-* @type {boolean}
-* @default false
-* @see [atomtest]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
-*/
-env[ 'atomtest' ] = false;
+ * Disable Atom test global variables used for testing.
+ *
+ * @name atomtest
+ * @memberof env
+ * @type {boolean}
+ * @default false
+ * @see [atomtest]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
+ */
+env["atomtest"] = false;
/**
-* Disable Ember test global variables used for testing.
-*
-* @name embertest
-* @memberof env
-* @type {boolean}
-* @default false
-* @see [embertest]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
-*/
-env[ 'embertest' ] = false;
+ * Disable Ember test global variables used for testing.
+ *
+ * @name embertest
+ * @memberof env
+ * @type {boolean}
+ * @default false
+ * @see [embertest]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
+ */
+env["embertest"] = false;
/**
-* Disable WebExtensions global variables used for testing.
-*
-* @name webextensions
-* @memberof env
-* @type {boolean}
-* @default false
-* @see [webextensions]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
-*/
-env[ 'webextensions' ] = false;
+ * Disable WebExtensions global variables used for testing.
+ *
+ * @name webextensions
+ * @memberof env
+ * @type {boolean}
+ * @default false
+ * @see [webextensions]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
+ */
+env["webextensions"] = false;
/**
-* Disable GreaseMonkey global variables used for testing.
-*
-* @name greasemonkey
-* @memberof env
-* @type {boolean}
-* @default false
-* @see [greasemonkey]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
-*/
-env[ 'greasemonkey' ] = false;
-
+ * Disable GreaseMonkey global variables used for testing.
+ *
+ * @name greasemonkey
+ * @memberof env
+ * @type {boolean}
+ * @default false
+ * @see [greasemonkey]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
+ */
+env["greasemonkey"] = false;
// EXPORTS //
diff --git a/etc/eslint/env/typescript.js b/etc/eslint/env/typescript.js
index 4f8f6ac38548..8952c3b23641 100644
--- a/etc/eslint/env/typescript.js
+++ b/etc/eslint/env/typescript.js
@@ -1,63 +1,62 @@
/**
-* @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';
+ * @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";
/**
-* ESLint default environments.
-*
-* @namespace env
-*/
+ * ESLint default environments.
+ *
+ * @namespace env
+ */
var env = {};
/**
-* Enable browser global variables.
-*
-* @name browser
-* @memberof env
-* @type {boolean}
-* @default true
-* @see [browser]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
-*/
-env[ 'browser' ] = true;
+ * Enable browser global variables.
+ *
+ * @name browser
+ * @memberof env
+ * @type {boolean}
+ * @default true
+ * @see [browser]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
+ */
+env["browser"] = true;
/**
-* Enable ES6 features.
-*
-* @name es6
-* @memberof env
-* @type {boolean}
-* @default true
-* @see [es6]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
-*/
-env[ 'es6' ] = true;
+ * Enable ES6 features.
+ *
+ * @name es6
+ * @memberof env
+ * @type {boolean}
+ * @default true
+ * @see [es6]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
+ */
+env["es6"] = true;
/**
-* Enable Node.js global variables and scoping.
-*
-* @name node
-* @memberof env
-* @type {boolean}
-* @default true
-* @see [node]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
-*/
-env[ 'node' ] = true;
-
+ * Enable Node.js global variables and scoping.
+ *
+ * @name node
+ * @memberof env
+ * @type {boolean}
+ * @default true
+ * @see [node]{@link https://eslint.org/docs/user-guide/configuring#specifying-environments}
+ */
+env["node"] = true;
// EXPORTS //
diff --git a/etc/eslint/overrides/index.js b/etc/eslint/overrides/index.js
index cb86b7a1f720..cd91f6e27dda 100644
--- a/etc/eslint/overrides/index.js
+++ b/etc/eslint/overrides/index.js
@@ -1,177 +1,185 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-
+var resolve = require("path").resolve;
// VARIABLES //
-var restrictedSyntaxConfig = [ 'error',
- 'ArrowFunctionExpression',
- 'ClassBody',
- 'ClassDeclaration',
- 'ClassExpression',
- 'DebuggerStatement',
- 'ExperimentalRestProperty',
- 'ExperimentalSpreadProperty',
+var restrictedSyntaxConfig = [
+ "error",
+ "ArrowFunctionExpression",
+ "ClassBody",
+ "ClassDeclaration",
+ "ClassExpression",
+ "DebuggerStatement",
+ "ExperimentalRestProperty",
+ "ExperimentalSpreadProperty",
// 'FunctionExpression',
- 'LabeledStatement',
- 'RestElement',
- 'SpreadElement',
- 'TaggedTemplateExpression',
- 'TemplateElement',
- 'TemplateLiteral',
- 'WithStatement',
- 'YieldExpression',
- 'JSXIdentifier',
- 'JSXNamespacedName',
- 'JSXMemberExpression',
- 'JSXEmptyExpression',
- 'JSXExpressionContainer',
- 'JSXElement',
- 'JSXClosingElement',
- 'JSXOpeningElement',
- 'JSXAttribute',
- 'JSXSpreadAttribute',
- 'JSXText',
- 'ExportDefaultDeclaration',
- 'ExportNamedDeclaration',
- 'ExportAllDeclaration',
- 'ExportSpecifier',
- 'ImportDeclaration',
- 'ImportSpecifier',
- 'ImportDefaultSpecifier',
- 'ImportNamespaceSpecifier'
+ "LabeledStatement",
+ "RestElement",
+ "SpreadElement",
+ "TaggedTemplateExpression",
+ "TemplateElement",
+ "TemplateLiteral",
+ "WithStatement",
+ "YieldExpression",
+ "JSXIdentifier",
+ "JSXNamespacedName",
+ "JSXMemberExpression",
+ "JSXEmptyExpression",
+ "JSXExpressionContainer",
+ "JSXElement",
+ "JSXClosingElement",
+ "JSXOpeningElement",
+ "JSXAttribute",
+ "JSXSpreadAttribute",
+ "JSXText",
+ "ExportDefaultDeclaration",
+ "ExportNamedDeclaration",
+ "ExportAllDeclaration",
+ "ExportSpecifier",
+ "ImportDeclaration",
+ "ImportSpecifier",
+ "ImportDefaultSpecifier",
+ "ImportNamespaceSpecifier",
];
-
// MAIN //
/**
-* ESLint overrides.
-*
-* @namespace overrides
-*/
+ * ESLint overrides.
+ *
+ * @namespace overrides
+ */
var overrides = [
{
- 'files': [ '[a-z].js' ],
- 'rules': {
- 'stdlib/repl-namespace-order': 'error'
- }
+ files: ["[a-z].js"],
+ rules: {
+ "stdlib/repl-namespace-order": "error",
+ },
},
{
- 'files': [ '**/benchmark/*.js' ],
- 'rules': {
- 'no-new-wrappers': 'warn',
- 'max-lines': [ 'warn', {
- 'max': 1000,
- 'skipBlankLines': true,
- 'skipComments': true
- }],
- 'no-restricted-syntax': restrictedSyntaxConfig,
- 'require-jsdoc': 'off',
- 'stdlib/jsdoc-private-annotation': 'off',
- 'stdlib/jsdoc-doctest': 'off'
- }
+ files: ["**/benchmark/*.js"],
+ rules: {
+ "no-new-wrappers": "warn",
+ "max-lines": [
+ "warn",
+ {
+ max: 1000,
+ skipBlankLines: true,
+ skipComments: true,
+ },
+ ],
+ "no-restricted-syntax": restrictedSyntaxConfig,
+ "require-jsdoc": "off",
+ "stdlib/jsdoc-private-annotation": "off",
+ "stdlib/jsdoc-doctest": "off",
+ },
},
{
- 'files': [ '**/examples/*.js' ],
- 'rules': {
- 'no-new-wrappers': 'warn',
- 'vars-on-top': 'off',
- 'no-console': 'off',
- 'require-jsdoc': 'off',
- 'stdlib/jsdoc-private-annotation': 'off',
- 'stdlib/jsdoc-doctest': 'off',
- 'stdlib/vars-order': 'off'
- }
+ files: ["**/examples/*.js"],
+ rules: {
+ "no-new-wrappers": "warn",
+ "vars-on-top": "off",
+ "no-console": "off",
+ "require-jsdoc": "off",
+ "stdlib/jsdoc-private-annotation": "off",
+ "stdlib/jsdoc-doctest": "off",
+ "stdlib/vars-order": "off",
+ },
},
{
- 'files': [ '**/test/*.js' ],
- 'rules': {
- 'no-empty-function': 'off',
- 'no-new-wrappers': 'warn',
- 'max-lines': [ 'warn', {
- 'max': 1000,
- 'skipBlankLines': true,
- 'skipComments': true
- }],
- 'no-restricted-syntax': restrictedSyntaxConfig,
- 'require-jsdoc': 'off',
- 'stdlib/jsdoc-private-annotation': 'off',
- 'stdlib/jsdoc-doctest': 'off',
- 'no-undefined': 'off'
- }
+ files: ["**/test/*.js"],
+ rules: {
+ "no-empty-function": "off",
+ "no-new-wrappers": "warn",
+ "max-lines": [
+ "warn",
+ {
+ max: 1000,
+ skipBlankLines: true,
+ skipComments: true,
+ },
+ ],
+ "no-restricted-syntax": restrictedSyntaxConfig,
+ "require-jsdoc": "off",
+ "stdlib/jsdoc-private-annotation": "off",
+ "stdlib/jsdoc-doctest": "off",
+ "no-undefined": "off",
+ },
},
{
- 'files': [ '*.md' ],
- 'rules': {
- 'eol-last': 'off',
- 'indent': [ 'error', 4, {
- 'SwitchCase': 0,
- 'VariableDeclarator': 1,
- 'outerIIFEBody': 1,
- 'MemberExpression': 1,
- 'FunctionDeclaration': {
- 'body': 1,
- 'parameters': 'off'
+ files: ["*.md"],
+ rules: {
+ "eol-last": "off",
+ indent: [
+ "error",
+ 4,
+ {
+ SwitchCase: 0,
+ VariableDeclarator: 1,
+ outerIIFEBody: 1,
+ MemberExpression: 1,
+ FunctionDeclaration: {
+ body: 1,
+ parameters: "off",
+ },
+ FunctionExpression: {
+ body: 1,
+ parameters: "off",
+ },
+ CallExpression: {
+ arguments: "off",
+ },
+ ArrayExpression: 1,
+ ObjectExpression: 1,
+ flatTernaryExpressions: true,
},
- 'FunctionExpression': {
- 'body': 1,
- 'parameters': 'off'
- },
- 'CallExpression': {
- 'arguments': 'off'
- },
- 'ArrayExpression': 1,
- 'ObjectExpression': 1,
- 'flatTernaryExpressions': true
- }],
- 'no-console': 'off',
- 'no-sync': 'off',
- 'no-tabs': 'error',
- 'no-undef': 'off',
- 'no-unused-vars': 'off',
- 'require-jsdoc': 'off',
- 'stdlib/jsdoc-private-annotation': 'off',
- 'stdlib/jsdoc-return-annotations-values': 'off',
- 'stdlib/return-annotations-values': 'off',
- 'strict': 'off',
- 'vars-on-top': 'off',
- 'node/no-unpublished-require': 'off'
- }
+ ],
+ "no-console": "off",
+ "no-sync": "off",
+ "no-tabs": "error",
+ "no-undef": "off",
+ "no-unused-vars": "off",
+ "require-jsdoc": "off",
+ "stdlib/jsdoc-private-annotation": "off",
+ "stdlib/jsdoc-return-annotations-values": "off",
+ "stdlib/return-annotations-values": "off",
+ strict: "off",
+ "vars-on-top": "off",
+ "node/no-unpublished-require": "off",
+ },
},
{
- 'files': [ '*.d.ts' ],
- 'extends': resolve( __dirname, '..', '.eslintrc.typescript.js' )
+ files: ["*.d.ts"],
+ extends: resolve(__dirname, "..", ".eslintrc.typescript.js"),
},
{
- 'files': [ '**/test/*.ts' ],
- 'extends': resolve( __dirname, '..', '.eslintrc.typescript.tests.js' )
- }
+ files: ["**/test/*.ts"],
+ extends: resolve(__dirname, "..", ".eslintrc.typescript.tests.js"),
+ },
];
-
// EXPORTS //
module.exports = overrides;
diff --git a/etc/eslint/overrides/repl_namespace.js b/etc/eslint/overrides/repl_namespace.js
index f3a06a7af100..16c04f7e1a30 100644
--- a/etc/eslint/overrides/repl_namespace.js
+++ b/etc/eslint/overrides/repl_namespace.js
@@ -1,40 +1,39 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// MAIN //
/**
-* ESLint overrides for REPL namespace files.
-*
-* @namespace overrides
-*/
+ * ESLint overrides for REPL namespace files.
+ *
+ * @namespace overrides
+ */
var overrides = [
{
- 'files': [ '[a-z].js' ],
- 'rules': {
- 'stdlib/repl-namespace-order': 'error'
- }
- }
+ files: ["[a-z].js"],
+ rules: {
+ "stdlib/repl-namespace-order": "error",
+ },
+ },
];
-
// EXPORTS //
module.exports = overrides;
diff --git a/etc/eslint/parser-options/features.js b/etc/eslint/parser-options/features.js
index 0fc7cad9187e..332158ab3306 100644
--- a/etc/eslint/parser-options/features.js
+++ b/etc/eslint/parser-options/features.js
@@ -1,64 +1,63 @@
/**
-* @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';
+ * @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";
/**
-* ESLint JavaScript language options.
-*
-* @namespace features
-*/
+ * ESLint JavaScript language options.
+ *
+ * @namespace features
+ */
var features = {};
/**
-* Do not allow return statements in the global scope.
-*
-* @name globalReturn
-* @memberof features
-* @type {boolean}
-* @default false
-* @see [globalReturn]{@link https://eslint.org/docs/user-guide/configuring#specifying-parser-options}
-*/
+ * Do not allow return statements in the global scope.
+ *
+ * @name globalReturn
+ * @memberof features
+ * @type {boolean}
+ * @default false
+ * @see [globalReturn]{@link https://eslint.org/docs/user-guide/configuring#specifying-parser-options}
+ */
features.globalReturn = false;
/**
-* Disable implied global strict mode.
-*
-* @name impliedStrict
-* @memberof features
-* @type {boolean}
-* @default false
-* @see [impliedStrict]{@link https://eslint.org/docs/user-guide/configuring#specifying-parser-options}
-*/
+ * Disable implied global strict mode.
+ *
+ * @name impliedStrict
+ * @memberof features
+ * @type {boolean}
+ * @default false
+ * @see [impliedStrict]{@link https://eslint.org/docs/user-guide/configuring#specifying-parser-options}
+ */
features.impliedStrict = false;
/**
-* Do not enable JSX.
-*
-* @name jsx
-* @memberof features
-* @type {boolean}
-* @default false
-* @see [jsx]{@link https://eslint.org/docs/user-guide/configuring#specifying-parser-options}
-*/
+ * Do not enable JSX.
+ *
+ * @name jsx
+ * @memberof features
+ * @type {boolean}
+ * @default false
+ * @see [jsx]{@link https://eslint.org/docs/user-guide/configuring#specifying-parser-options}
+ */
features.jsx = false;
-
// EXPORTS //
module.exports = features;
diff --git a/etc/eslint/parser-options/index.js b/etc/eslint/parser-options/index.js
index 9b172ae5627c..366d18e91cab 100644
--- a/etc/eslint/parser-options/index.js
+++ b/etc/eslint/parser-options/index.js
@@ -1,57 +1,56 @@
/**
-* @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';
+ * @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";
/**
-* ESLint parser options.
-*
-* @namespace options
-*/
+ * ESLint parser options.
+ *
+ * @namespace options
+ */
var options = {};
/**
-* ECMAScript version.
-*
-* @name ecmaVersion
-* @memberof options
-* @type {number}
-*/
-options.ecmaVersion = require( './version.js' );
+ * ECMAScript version.
+ *
+ * @name ecmaVersion
+ * @memberof options
+ * @type {number}
+ */
+options.ecmaVersion = require("./version.js");
/**
-* Source type.
-*
-* @name sourceType
-* @memberof options
-* @type {string}
-*/
-options.sourceType = require( './source_type.js' );
+ * Source type.
+ *
+ * @name sourceType
+ * @memberof options
+ * @type {string}
+ */
+options.sourceType = require("./source_type.js");
/**
-* Language features.
-*
-* @name ecmaFeatures
-* @memberof options
-* @type {Object}
-*/
-options.ecmaFeatures = require( './features.js' );
-
+ * Language features.
+ *
+ * @name ecmaFeatures
+ * @memberof options
+ * @type {Object}
+ */
+options.ecmaFeatures = require("./features.js");
// EXPORTS //
diff --git a/etc/eslint/parser-options/source_type.js b/etc/eslint/parser-options/source_type.js
index 908fa0806ac9..105c0d6341c5 100644
--- a/etc/eslint/parser-options/source_type.js
+++ b/etc/eslint/parser-options/source_type.js
@@ -1,23 +1,23 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// EXPORTS //
-module.exports = 'script';
+module.exports = "script";
diff --git a/etc/eslint/parser-options/typescript.js b/etc/eslint/parser-options/typescript.js
index c86c245fff58..169673610385 100644
--- a/etc/eslint/parser-options/typescript.js
+++ b/etc/eslint/parser-options/typescript.js
@@ -1,56 +1,54 @@
/**
-* @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';
+ * @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 path = require( 'path' );
-var rootDir = require( './../../../lib/node_modules/@stdlib/_tools/utils/root-dir' );
-
+var path = require("path");
+var rootDir = require("./../../../lib/node_modules/@stdlib/_tools/utils/root-dir");
// MAIN //
/**
-* ESLint parser options.
-*
-* @namespace options
-*/
+ * ESLint parser options.
+ *
+ * @namespace options
+ */
var options = {};
/**
-* The project's TypeScript configuration file.
-*
-* @name project
-* @memberof options
-* @type {string}
-*/
-options.project = path.join( rootDir(), 'tsconfig.json' );
+ * The project's TypeScript configuration file.
+ *
+ * @name project
+ * @memberof options
+ * @type {string}
+ */
+options.project = path.join(rootDir(), "tsconfig.json");
/**
-* The source type.
-*
-* @name sourceType
-* @memberof options
-* @type {string}
-*/
-options.sourceType = 'module';
-
+ * The source type.
+ *
+ * @name sourceType
+ * @memberof options
+ * @type {string}
+ */
+options.sourceType = "module";
// EXPORTS //
diff --git a/etc/eslint/parser-options/version.js b/etc/eslint/parser-options/version.js
index 64e2e847065d..d7c4c330d051 100644
--- a/etc/eslint/parser-options/version.js
+++ b/etc/eslint/parser-options/version.js
@@ -1,22 +1,22 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// EXPORTS //
diff --git a/etc/eslint/plugins/index.js b/etc/eslint/plugins/index.js
index 33df21f4017c..9c9b8abcec16 100644
--- a/etc/eslint/plugins/index.js
+++ b/etc/eslint/plugins/index.js
@@ -1,30 +1,25 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// ESLint plugins:
-var plugins = [
- 'node',
- 'stdlib',
- '@cspell'
-];
-
+var plugins = ["node", "stdlib", "@cspell"];
// EXPORTS //
diff --git a/etc/eslint/plugins/typescript.js b/etc/eslint/plugins/typescript.js
index 5553eb157e03..6e5fd3a71bc1 100644
--- a/etc/eslint/plugins/typescript.js
+++ b/etc/eslint/plugins/typescript.js
@@ -1,39 +1,38 @@
/**
-* @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';
+ * @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";
// ESLint plugins for TypeScript:
var plugins = [
// Allows linting $ExpectError and $ExpectType type assertions:
- 'eslint-plugin-expect-type',
+ "eslint-plugin-expect-type",
// Lint rules for import/export syntax:
- 'eslint-plugin-import',
+ "eslint-plugin-import",
// Required for JSDoc support:
- 'eslint-plugin-jsdoc',
+ "eslint-plugin-jsdoc",
// Required for TypeScript support:
- '@typescript-eslint'
+ "@typescript-eslint",
];
-
// EXPORTS //
module.exports = plugins;
diff --git a/etc/eslint/rules/best_practices.js b/etc/eslint/rules/best_practices.js
index e99f2f67eedb..0d1c4366a15b 100644
--- a/etc/eslint/rules/best_practices.js
+++ b/etc/eslint/rules/best_practices.js
@@ -1,1645 +1,1671 @@
/**
-* @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';
-
-/**
-* ESLint rules for enforcing best practices.
-*
-* @namespace rules
-*/
-var rules = {};
-
-/**
-* Never allow a setter to be defined without a paired getter.
-*
-* @name accessor-pairs
-* @memberof rules
-* @type {Array}
-* @see [accessor-pairs]{@link https://eslint.org/docs/rules/accessor-pairs}
-*
-* @example
-* // Bad...
-* var obj = {};
-* Object.defineProperty( obj, 'a', {
-* 'set': function set() {}
-* });
-*
-* @example
-* // Good...
-* var obj = {};
-* Object.defineProperty( obj, 'a', {
-* 'set': function set() {},
-* 'get': function get() {}
-* });
-*/
-rules[ 'accessor-pairs' ] = [ 'error', {
- 'setWithoutGet': true,
- 'getWithoutSet': false
-}];
-
-/**
-* Require a `return` statement in `Array` methods.
-*
-* @name array-callback-return
-* @memberof rules
-* @type {Array}
-* @see [array-callback-return]{@link https://eslint.org/docs/rules/array-callback-return}
-*
-* @example
-* // Bad...
-* function reduce( obj, item, i ) {
-* obj[ i ] = item;
-* }
-* var o = [ 1, 2, 3 ].reduce( reduce, {} );
-*
-* @example
-* // Good...
-* function reduce( obj, item, i ) {
-* obj[ i ] = item;
-* return obj;
-* }
-* var o = [ 1, 2, 3 ].reduce( reduce, {} );
-*/
-rules[ 'array-callback-return' ] = [ 'error', {
- 'allowImplicit': false
-}];
-
-/**
-* Never allow variables to be used outside of the block in which they were defined.
-*
-* @name block-scoped-var
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [block-scoped-var]{@link https://eslint.org/docs/rules/block-scoped-var}
-*
-* @example
-* // Bad...
-* if ( foo ) {
-* var bar = 5;
-* }
-* if ( bar ) {
-* // Do something...
-* }
-*
-* @example
-* // Good...
-* var bar;
-* if ( foo ) {
-* bar = 5;
-* }
-* if ( bar ) {
-* // Do something...
-* }
-*/
-rules[ 'block-scoped-var' ] = 'error';
-
-/**
-* Require class methods to use `this`, as any method which does not use `this` can be a `static` method.
-*
-* @name class-methods-use-this
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [class-methods-use-this]{@link https://eslint.org/docs/rules/class-methods-use-this}
-*
-* @example
-* // Bad...
-* class A {
-* constructor() {}
-* say() {
-* return 'Hello';
-* }
-* }
-*
-* @example
-* // Good...
-* class A {
-* constructor() {}
-* static say() {
-* return 'Hello';
-* }
-* }
-*/
-rules[ 'class-methods-use-this' ] = 'error';
-
-/**
-* Disable cyclomatic complexity.
-*
-* @name complexity
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [complexity]{@link https://eslint.org/docs/rules/complexity}
-*/
-rules[ 'complexity' ] = 'off';
-
-/**
-* Do not enforce consistent returns.
-*
-* @name consistent-return
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [consistent-return]{@link https://eslint.org/docs/rules/consistent-return}
-*
-* @example
-* // Okay...
-* function foo( x ) {
-* if ( x === 1 ) {
-* return NaN;
-* }
-* // No explicit return...
-* }
-*/
-rules[ 'consistent-return' ] = 'off';
-
-/**
-* Always require curly braces.
-*
-* @name curly
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [curly]{@link https://eslint.org/docs/rules/curly}
-*
-* @example
-* // Bad...
-* if ( x === 1 ) x += 1;
-*
-* @example
-* // Good...
-* if ( x === 1 ) {
-* x += 1;
-* }
-*/
-rules[ 'curly' ] = 'error';
-
-/**
-* Always require a `default` case in `switch` statements.
-*
-* @name default-case
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [default-case]{@link https://eslint.org/docs/rules/default-case}
-*
-* @example
-* // Bad...
-* switch( foo ) {
-* case 1:
-* break;
-* }
-*
-* @example
-* // Good...
-* switch( foo ) {
-* case 1:
-* break;
-* default:
-* break;
-* }
-*/
-rules[ 'default-case' ] = 'error';
-
-/**
-* Always require a `default` clause to be last in a `switch` statement.
-*
-* @name default-case-last
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [default-case]{@link https://eslint.org/docs/rules/default-case-last}
-*
-* @example
-* // Bad...
-* switch( foo ) {
-* default:
-* break;
-* case 1:
-* break;
-* }
-*
-* @example
-* // Good...
-* switch( foo ) {
-* case 1:
-* break;
-* default:
-* break;
-* }
-*/
-rules[ 'default-case-last' ] = 'error';
-
-/**
-* Always require default parameters to be last.
-*
-* @name default-param-last
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [default-param-last]{@link https://eslint.org/docs/rules/default-param-last}
-*
-* @example
-* // Bad...
-* function foo( a = 1, b ) {
-* // No-op...
-* }
-*
-* @example
-* // Good...
-* function foo( b, a = 1 ) {
-* // No-op...
-* }
-*/
-rules[ 'default-param-last' ] = 'error';
-
-/**
-* Require that a dot be on the same line as a property.
-*
-* @name dot-location
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'property' ]
-* @see [dot-location]{@link https://eslint.org/docs/rules/dot-location}
-*
-* @example
-* // Bad...
-* var obj = {
-* 'beep': 'boop'
-* };
-* var p = obj.
-* beep;
-*
-* @example
-* // Good...
-* var obj = {
-* 'beep': 'boop'
-* };
-* var p = obj
-* .beep;
-*
-* @example
-* // Better...
-* var obj = {
-* 'beep': 'boop'
-* };
-* var p = obj.beep;
-*/
-rules[ 'dot-location' ] = [ 'error', 'property' ];
-
-/**
-* Do not enforce using dot notation over square-bracket notation.
-*
-* @name dot-notation
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [dot-notation]{@link https://eslint.org/docs/rules/dot-notation}
-*/
-rules[ 'dot-notation' ] = 'off'; // TODO: revisit?
-
-/**
-* Always require `===` over `==`.
-*
-* @name eqeqeq
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'always' ]
-* @see [eqeqeq]{@link https://eslint.org/docs/rules/eqeqeq}
-*
-* @example
-* // Bad...
-* var bool = ( x == 3.14 );
-*
-* @example
-* // Good...
-* var bool = ( x === 3.14 );
-*/
-rules[ 'eqeqeq' ] = [ 'error', 'always' ];
-
-/**
-* A `for-in` loop should always filter results using an `if` statement.
-*
-* @name guard-for-in
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [guard-for-in]{@link https://eslint.org/docs/rules/guard-for-in}
-*
-* @example
-* // Bad...
-* for ( key in obj ) {
-* // Do something...
-* }
-*
-* @example
-* // Good...
-* var hasOwn = require( '@stdlib/assert/has-own-property' );
-*
-* for ( key in obj ) {
-* if ( hasOwn( obj, key ) ) {
-* // Do something...
-* }
-* }
-*/
-rules[ 'guard-for-in' ] = 'error';
-
-/**
-* Never allow more than one class per file.
-*
-* @name max-classes-per-file
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 1 ]
-* @see [max-classes-per-file]{@link https://eslint.org/docs/rules/max-classes-per-file}
-*/
-rules[ 'max-classes-per-file' ] = [ 'error', 1 ];
-
-/**
-* Never allow `alert`, `confirm`, or `prompt`.
-*
-* @name no-alert
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-alert]{@link https://eslint.org/docs/rules/no-alert}
-*
-* @example
-* // Bad...
-* alert( 'beep' );
-*/
-rules[ 'no-alert' ] = 'error';
-
-/**
-* Never allow `arguments.caller` or `arguments.callee` to be used, as they are deprecated.
-*
-* @name no-caller
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-caller]{@link https://eslint.org/docs/rules/no-caller}
-*
-* @example
-* // Bad...
-* function foo() {
-* var callee = arguments.callee;
-* }
-*/
-rules[ 'no-caller' ] = 'error';
-
-/**
-* Do not allow lexical declarations in case/default clauses.
-*
-* @name no-case-declarations
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-case-declarations]{@link https://eslint.org/docs/rules/no-case-declarations}
-*/
-rules[ 'no-case-declarations' ] = 'error';
-
-/**
-* Always require regex literals to escape division operators.
-*
-* @name no-div-regex
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-div-regex]{@link https://eslint.org/docs/rules/no-div-regex}
-*
-* @example
-* // Bad...
-* var re = /=foo/;
-*
-* @example
-* // Good...
-* var re = /\=foo/;
-*/
-rules[ 'no-div-regex' ] = 'error';
-
-/**
-* Prevent unnecessary `else` blocks when an `if` contains a `return` statement.
-*
-* @name no-else-return
-* @memberof rules
-* @type {Array}
-* @see [no-else-return]{@link https://eslint.org/docs/rules/no-else-return}
-*
-* @example
-* // Bad...
-* function foo( x, y ) {
-* if ( x === y ) {
-* return x;
-* } else {
-* return y;
-* }
-* }
-*
-* @example
-* // Good...
-* function foo( x, y ) {
-* if ( x === y ) {
-* return x;
-* }
-* return y;
-* }
-*/
-rules[ 'no-else-return' ] = [ 'error', {
- 'allowElseIf': false
-}];
-
-/**
-* Never allow an empty function.
-*
-* @name no-empty-function
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-empty-function]{@link https://eslint.org/docs/rules/no-empty-function}
-*
-* @example
-* // Bad...
-* function noop(){}
-*
-* @example
-* // Good...
-* function noop() {
-* // Do nothing...
-* }
-*/
-rules[ 'no-empty-function' ] = 'error';
-
-/**
-* Never allow an empty destructuring patterns.
-*
-* @name no-empty-pattern
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-empty-pattern]{@link https://eslint.org/docs/rules/no-empty-pattern}
-*
-* @example
-* // Bad...
-* var {} = foo();
-*
-* @example
-* // Good...
-* var { a = {} } = foo();
-*/
-rules[ 'no-empty-pattern' ] = 'error';
-
-/**
-* Never allow `null` comparisons.
-*
-* @name no-eq-null
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-eq-null]{@link https://eslint.org/docs/rules/no-eq-null}
-*
-* @example
-* // Bad...
-* if ( x == null ) {
-* // Do something...
-* }
-*
-* @example
-* // Good...
-* if ( x === false ) {
-* // Do something...
-* }
-*/
-rules[ 'no-eq-null' ] = 'error';
-
-/**
-* Never allow the use of `eval`.
-*
-* @name no-eval
-* @memberof rules
-* @type {Array}
-* @default 'error'
-* @see [no-eval]{@link https://eslint.org/docs/rules/no-eval}
-*
-* @example
-* // Bad...
-* var x = eval( '5' );
-*
-* @example
-* // Good...
-* var x = parseInt( '5', 10 );
-*/
-rules[ 'no-eval' ] = 'error';
-
-/**
-* Never allow extending native prototypes.
-*
-* @name no-extend-native
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-extend-native]{@link https://eslint.org/docs/rules/no-extend-native}
-*
-* @example
-* // Bad...
-* Object.prototype.beep = 'boop';
-*/
-rules[ 'no-extend-native' ] = 'error';
-
-/**
-* Prevent function binding when a function does not use `this`.
-*
-* @name no-extra-bind
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-extra-bind]{@link https://eslint.org/docs/rules/no-extra-bind}
-*
-* @example
-* // Bad...
-* function foo() {
-* bar();
-* }
-* var x = foo.bind( bar );
-*
-* @example
-* // Okay...
-* function foo() {
-* this.beep();
-* }
-* var x = foo.bind( bar );
-*/
-rules[ 'no-extra-bind' ] = 'error';
-
-/**
-* Do not allow unnecessary labels.
-*
-* @name no-extra-label
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-extra-label]{@link https://eslint.org/docs/rules/no-extra-label}
-*
-* @example
-* // Bad...
-* A: while ( true ) {
-* // Do something...
-* }
-*/
-rules[ 'no-extra-label' ] = 'error';
-
-/**
-* Prevent unintentional fall throughs in `switch` statements.
-*
-* @name no-fallthrough
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-fallthrough]{@link https://eslint.org/docs/rules/no-fallthrough}
-*
-* @example
-* // Bad...
-* switch ( x ) {
-* case 1:
-* foo();
-* case 2:
-* bar();
-* break;
-* default:
-* break;
-* }
-*
-* @example
-* // Good...
-* switch ( x ) {
-* case 1:
-* foo();
-* break;
-* case 2:
-* bar();
-* break;
-* default:
-* break;
-* }
-*
-* @example
-* // Okay...
-* switch ( x ) {
-* case 1:
-* case 2:
-* bar();
-* break;
-* default:
-* break;
-* }
-*/
-rules[ 'no-fallthrough' ] = 'error';
-
-/**
-* Prevent floating decimals; e.g., `2.`.
-*
-* @name no-floating-decimal
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-floating-decimal]{@link https://eslint.org/docs/rules/no-floating-decimal}
-*
-* @example
-* // Bad...
-* var x = 2.;
-*
-* @example
-* // Good...
-* var x = 2.0;
-*/
-rules[ 'no-floating-decimal' ] = 'error';
-
-/**
-* Do not allow assignment to native objects or read-only global variables.
-*
-* @name no-global-assign
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-global-assign]{@link https://eslint.org/docs/rules/no-global-assign}
-*
-* @example
-* // Bad...
-* Object = null;
-*/
-rules[ 'no-global-assign' ] = 'error';
-
-/**
-* Allow implicit type coercion.
-*
-* @name no-implicit-coercion
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [no-implicit-coercion]{@link https://eslint.org/docs/rules/no-implicit-coercion}
-*
-* @example
-* // Okay...
-* var str = '5';
-* var num = +str;
-*/
-rules[ 'no-implicit-coercion' ] = 'off';
-
-/**
-* Turn off checking for implicit globals in browser scripts, as code is primarily comprised of modules which have their own scope.
-*
-* @name no-implicit-globals
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [no-implicit-globals]{@link https://eslint.org/docs/rules/no-implicit-globals}
-*
-* @example
-* // Okay...
-* window.foo = 'bar';
-*/
-rules[ 'no-implicit-globals' ] = 'off';
-
-/**
-* Never allow implied use of `eval` with `setTimeout`, `setInterval`, and `execScript`.
-*
-* @name no-implied-eval
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-implied-eval]{@link https://eslint.org/docs/rules/no-implied-eval}
-*
-* @example
-* // Bad...
-* setTimeout( 'console.log("beep!");', 10 );
-*/
-rules[ 'no-implied-eval' ] = 'error';
-
-/**
-* Never allow the use of `this` outside of classes.
-
-* @name no-invalid-this
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-invalid-this]{@link https://eslint.org/docs/rules/no-invalid-this}
-*
-* @example
-* // Bad...
-* this.beep = 'boop';
-*
-* @example
-* // Good...
-* function Beep() {
-* this.boop = 'boop';
-* return this;
-* }
-*/
-rules[ 'no-invalid-this' ] = 'error';
-
-/**
-* Never allow the use of the deprecated `__iterator__` property.
-*
-* @name no-iterator
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-iterator]{@link https://eslint.org/docs/rules/no-iterator}
-*/
-rules[ 'no-iterator' ] = 'error';
-
-/**
-* Never allow the use of `labels`.
-*
-* @name no-labels
-* @memberof rules
-* @type {Array}
-* @see [no-labels]{@link https://eslint.org/docs/rules/no-labels}
-*
-* @example
-* // Bad...
-* label: while( true ) {
-* // Do something...
-* }
-*
-* @example
-* // Good...
-* while( true ) {
-* // Do something...
-* }
-*/
-rules[ 'no-labels' ] = [ 'error', {
- 'allowLoop': false,
- 'allowSwitch': false
-}];
-
-/**
-* Never allow standalone code blocks delimited by curly braces.
-*
-* @name no-lone-blocks
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-line-blocks]{@link https://eslint.org/docs/rules/no-lone-blocks}
-*
-* @example
-* // Bad...
-* {
-* function foo() {
-* // Do something...
-* }
-* }
-*
-* @example
-* // Good...
-* function foo() {
-* // Do something...
-* }
-*/
-rules[ 'no-lone-blocks' ] = 'error';
-
-/**
-* Never allow functions to be created within a loop.
-*
-* @name no-loop-func
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-loop-func]{@link https://eslint.org/docs/rules/no-loop-func}
-*
-* @example
-* // Bad...
-* var foo;
-* var i;
-*
-* foo = new Array( 10 );
-* for ( i = 0; i < foo.length; i++ ) {
-* foo[ i ] = function bar() {
-* return i;
-* };
-* }
-*
-* @example
-* // Good...
-* var foo;
-* var i;
-*
-* function bar( i ) {
-* return function bar() {
-* return i;
-* };
-* }
-*
-* foo = new Array( 10 );
-* for ( i = 0; i < foo.length; i++ ) {
-* foo[ i ] = bar( i );
-* }
-*/
-rules[ 'no-loop-func' ] = 'error';
-
-/**
-* Warn when magic numbers are used. NOTE: turned off due to overly aggressive consideration of "magic" numbers.
-*
-* @name no-magic-numbers
-* @memberof rules
-* @type {Array}
-* @see [no-magic-numbers]{@link https://eslint.org/docs/rules/no-magic-numbers}
-*/
-rules[ 'no-magic-numbers' ] = [ 'off', {
- 'ignoreArrayIndexes': true,
- 'enforceConst': false,
- 'detectObjects': false
-}];
-
-/**
-* Never allow multiple whitespace characters in expressions.
-*
-* @name no-multi-spaces
-* @memberof rules
-* @type {Array}
-* @default [ 'error', { 'ignoreEOLComments': true } ]
-* @see [no-multi-spaces]{@link https://eslint.org/docs/rules/no-multi-spaces}
-*
-* @example
-* // Bad...
-* var bool = ( x === true );
-*
-* @example
-* // Good...
-* var bool = ( x === true );
-*/
-rules[ 'no-multi-spaces' ] = [ 'error', {
- 'ignoreEOLComments': true
-}];
-
-/**
-* Never allow using a `\` character to create multi-line strings.
-*
-* @name no-multi-str
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-multi-str]{@link https://eslint.org/docs/rules/no-multi-str}
-*
-* @example
-* // Bad...
-* var str = 'Hello \
-* world!';
-*
-* @example;
-* // Good...
-* var str = 'Hello\nworld!';
-*/
-rules[ 'no-multi-str' ] = 'error';
-
-/**
-* Never allow use the `new` operator without assignment.
-*
-* @name no-new
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-new]{@link https://eslint.org/docs/rules/no-new}
-*
-* @example
-* // Bad...
-* new Foo();
-*
-* @example
-* // Good...
-* var f = new Foo();
-*/
-rules[ 'no-new' ] = 'error';
-
-/**
-* Never allow using the `Function` constructor to create functions.
-*
-* @name no-new-func
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-new-func]{@link https://eslint.org/docs/rules/no-new-func}
-*
-* @example
-* // Bad (most of the time)...
-* var foo = new Function( 'x', 'return x;' );
-*
-* @example
-* // Good...
-* function foo( x ) {
-* return x;
-* }
-*/
-rules[ 'no-new-func' ] = 'error';
-
-/**
-* Never allow using `String`, `Number`, and `Boolean` in place of primitives.
-*
-* @name no-new-wrappers
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-new-wrappers]{@link https://eslint.org/docs/rules/no-new-wrappers}
-*
-* @example
-* // Bad...
-* var bool = new Boolean( true );
-*
-* @example
-* // Good...
-* var bool = true;
-*/
-rules[ 'no-new-wrappers' ] = 'error';
-
-/**
-* Never allow octal literals that begin with a leading zero; e.g., 071 (=> 57).
-*
-* @name no-octal
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-octal]{@link https://eslint.org/docs/rules/no-octal}
-*
-* @example
-* // Bad...
-* var num = 071;
-*
-* @example
-* // Good...
-* var num = '071';
-*/
-rules[ 'no-octal' ] = 'error';
-
-/**
-* Never allow octal escape sequences, which are deprecated.
-*
-* @name no-octal-escape
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-octal-escape]{@link https://eslint.org/docs/rules/no-octal-escape}
-*
-* @example
-* // Bad...
-* var foo = 'Copyright \251';
-*
-* @example
-* // Good...
-* var foo = 'Copyright \u00A9';
-*/
-rules[ 'no-octal-escape' ] = 'error';
-
-/**
-* Allow parameter reassignment (although bugs can arise when doing so).
-*
-* @name no-param-reassign
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [no-param-reassign]{@link https://eslint.org/docs/rules/no-param-reassign}
-*
-* @example
-* // Okay...
-* function foo( x ) {
-* y = x;
-* return y;
-* }
-*/
-rules[ 'no-param-reassign' ] = 'off';
-
-/**
-* Never allow using deprecated `__proto__` property.
-*
-* @name no-proto
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-proto]{@link https://eslint.org/docs/rules/no-proto}
-*
-* @example
-* // Bad...
-* var proto = {}.__proto__;
-*
-* @example
-* // Good...
-* var getPrototypeOf = require( '@stdlib/utils/get-prototype-of' );
-*
-* var proto = getPrototypeOf( {} );
-*/
-rules[ 'no-proto' ] = 'error';
-
-/**
-* Never allow a variable to be declared multiple times within the same scope or for built-in globals to be redeclared. NOTE: turned off due to custom stdlib/no-redeclare rule which permits overriding of certain globals.
-*
-* @name no-redeclare
-* @memberof rules
-* @type {Array}
-* @default 'off'
-* @see [no-redeclare]{@link https://eslint.org/docs/rules/no-redeclare}
-*
-* @example
-* // Bad...
-* var a = 'beep';
-* // ...
-* var a = 'boop';
-*
-* @example
-* // Good...
-* var a = 'beep';
-* // ...
-* a = 'boop';
-*/
-rules[ 'no-redeclare' ] = 'off';
-
-/**
-* Do not restrict any object properties.
-*
-* @name no-restricted-properties
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [no-restricted-properties]{@link https://eslint.org/docs/rules/no-restricted-properties}
-*/
-rules[ 'no-restricted-properties' ] = 'off';
-
-/**
-* Never allow assignment in `return` statements.
-*
-* @name no-return-assign
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'always' ]
-* @see [no-return-assign]{@link https://eslint.org/docs/rules/no-return-assign}
-*
-* @example
-* // Bad...
-* function foo( x ) {
-* var bar;
-* return bar = x + 2;
-* }
-*
-* @example
-* // Good...
-* function foo( x ) {
-* return x + 2;
-* }
-*/
-rules[ 'no-return-assign' ] = [ 'error', 'always' ];
-
-/* eslint-disable stdlib/jsdoc-doctest-marker, stdlib/jsdoc-doctest-quote-props */
-
-/**
-* Never allow `return await`.
-*
-* @name no-return-await
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-return-await]{@link https://eslint.org/docs/rules/no-return-await}
-*
-* @example
-* // Bad...
-* async function foo() {
-* return await bar();
-* }
-*/
-rules[ 'no-return-await' ] = 'error';
-
-/* eslint-enable stdlib/jsdoc-doctest-marker stdlib/jsdoc-doctest-quote-props */
-
-/**
-* Never allow using `javascript:` in urls.
-*
-* @name no-script-url
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-script-url]{@link https://eslint.org/docs/rules/no-script-url}
-*
-* @example
-* // Bad...
-* location.href = 'javascript:void(0)';
-*/
-rules[ 'no-script-url' ] = 'error';
-
-/**
-* Never allow self-assignments, including properties.
-*
-* @name no-self-assign
-* @memberof rules
-* @type {Array}
-* @default [ 'error', {'props':true} ]
-* @see [no-self-assign]{@link https://eslint.org/docs/rules/no-self-assign}
-*
-* @example
-* // Bad...
-* foo = foo;
-*
-* @example
-* // Bad...
-* obj = { 'a': 'b' };
-* obj.a = obj.a;
-*/
-rules[ 'no-self-assign' ] = [ 'error', {
- 'props': true
-}];
-
-/**
-* Allow self-comparison (`NaN` check).
-*
-* @name no-self-compare
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [no-self-compare]{@link https://eslint.org/docs/rules/no-self-compare}
-*
-* @example
-* // Okay...
-* if ( x !== x ) {
-* // Handle NaN...
-* }
-*/
-rules[ 'no-self-compare' ] = 'off';
-
-/**
-* Never allow using a comma operator to separate multiple expressions where only a single expression is expected.
-*
-* @name no-sequences
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-sequences]{@link https://eslint.org/docs/rules/no-sequences}
-*
-* @example
-* // Bad...
-* var x = (3,5); // x = 5
-*
-* @example
-* // Good...
-* var x = 5;
-*/
-rules[ 'no-sequences' ] = 'error';
-
-/**
-* Require only `Error` objects to be thrown.
-*
-* @name no-throw-literal
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-throw-literal]{@link https://eslint.org/docs/rules/no-throw-literal}
-*
-* @example
-* // Bad...
-* throw 'beep';
-*
-* @example
-* // Good...
-* throw new Error( 'beep' );
-*/
-rules[ 'no-throw-literal' ] = 'error';
-
-/**
-* Allow unmodified loop conditions.
-*
-* @name no-unmodified-loop-condition
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [no-unmodified-loop-condition]{@link https://eslint.org/docs/rules/no-unmodified-loop-condition}
-*/
-rules[ 'no-unmodified-loop-condition' ] = 'off';
-
-/**
-* Never allow unused expressions.
-*
-* @name no-unused-expressions
-* @memberof rules
-* @type {Array}
-* @see [no-unused-expressions]{@link https://eslint.org/docs/rules/no-unused-expressions}
-*
-* @example
-* // Bad...
-* n + 1;
-*/
-rules[ 'no-unused-expressions' ] = [ 'error', {
- 'allowShortCircuit': false,
- 'allowTernary': false
-}];
-
-/**
-* Never allow unused labels.
-*
-* @name no-unused-labels
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-unused-labels]{@link https://eslint.org/docs/rules/no-unused-labels}
-*
-* @example
-* // Bad...
-* function foo() {
-* var x = 0;
-* A: while( true ) {
-* if ( x === 10 ) {
-* return;
-* }
-* x += 1;
-* }
-* }
-*/
-rules[ 'no-unused-labels' ] = 'error';
-
-/**
-* Ensure there are no regular expression backreferences that always successfully match zero-length and cannot match anything else.
-*
-* @name no-useless-backreference
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-useless-backreference]{@link https://eslint.org/docs/rules/no-useless-backreference}
-*
-* @example
-* // Bad...
-* var RE = /\1(a)/; // forward reference to (a);
-*
-* @example
-* // Good...
-* var RE = /(a)\1/; // reference to (a)
-*/
-rules[ 'no-useless-backreference' ] = 'error';
-
-/**
-* Never allow using `call` or `apply` when a normal function invocation will suffice.
-*
-* @name no-useless-call
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-useless-call]{@link https://eslint.org/docs/rules/no-useless-call}
-*
-* @example
-* // Bad...
-* var x = foo.call( null, 1, 2 );
-*
-* @example
-* // Good...
-* var x = foo( 1, 2 );
-*/
-rules[ 'no-useless-call' ] = 'error';
+ * @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";
+
+/**
+ * ESLint rules for enforcing best practices.
+ *
+ * @namespace rules
+ */
+var rules = {};
/**
-* Never allow unnecessary catch clauses.
-*
-* @name no-useless-catch
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-useless-catch]{@link https://eslint.org/docs/rules/no-useless-catch}
-*
-* @example
-* // Bad...
-* try {
-* throw new Error( 'beep' );
-* } catch ( err ) {
-* // Catch is unnecessary if we are just rethrowing...
-* throw err;
-* }
-*
-* @example
-* // Good...
-* try {
-* throw new Error( 'beep' );
-* } catch ( err ) {
-* if ( err instanceof TypeError) {
-* throw err;
-* }
-* }
-*/
-rules[ 'no-useless-catch' ] = 'error';
+ * Never allow a setter to be defined without a paired getter.
+ *
+ * @name accessor-pairs
+ * @memberof rules
+ * @type {Array}
+ * @see [accessor-pairs]{@link https://eslint.org/docs/rules/accessor-pairs}
+ *
+ * @example
+ * // Bad...
+ * var obj = {};
+ * Object.defineProperty( obj, 'a', {
+ * 'set': function set() {}
+ * });
+ *
+ * @example
+ * // Good...
+ * var obj = {};
+ * Object.defineProperty( obj, 'a', {
+ * 'set': function set() {},
+ * 'get': function get() {}
+ * });
+ */
+rules["accessor-pairs"] = [
+ "error",
+ {
+ setWithoutGet: true,
+ getWithoutSet: false,
+ },
+];
+
+/**
+ * Require a `return` statement in `Array` methods.
+ *
+ * @name array-callback-return
+ * @memberof rules
+ * @type {Array}
+ * @see [array-callback-return]{@link https://eslint.org/docs/rules/array-callback-return}
+ *
+ * @example
+ * // Bad...
+ * function reduce( obj, item, i ) {
+ * obj[ i ] = item;
+ * }
+ * var o = [ 1, 2, 3 ].reduce( reduce, {} );
+ *
+ * @example
+ * // Good...
+ * function reduce( obj, item, i ) {
+ * obj[ i ] = item;
+ * return obj;
+ * }
+ * var o = [ 1, 2, 3 ].reduce( reduce, {} );
+ */
+rules["array-callback-return"] = [
+ "error",
+ {
+ allowImplicit: false,
+ },
+];
+
+/**
+ * Never allow variables to be used outside of the block in which they were defined.
+ *
+ * @name block-scoped-var
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [block-scoped-var]{@link https://eslint.org/docs/rules/block-scoped-var}
+ *
+ * @example
+ * // Bad...
+ * if ( foo ) {
+ * var bar = 5;
+ * }
+ * if ( bar ) {
+ * // Do something...
+ * }
+ *
+ * @example
+ * // Good...
+ * var bar;
+ * if ( foo ) {
+ * bar = 5;
+ * }
+ * if ( bar ) {
+ * // Do something...
+ * }
+ */
+rules["block-scoped-var"] = "error";
+
+/**
+ * Require class methods to use `this`, as any method which does not use `this` can be a `static` method.
+ *
+ * @name class-methods-use-this
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [class-methods-use-this]{@link https://eslint.org/docs/rules/class-methods-use-this}
+ *
+ * @example
+ * // Bad...
+ * class A {
+ * constructor() {}
+ * say() {
+ * return 'Hello';
+ * }
+ * }
+ *
+ * @example
+ * // Good...
+ * class A {
+ * constructor() {}
+ * static say() {
+ * return 'Hello';
+ * }
+ * }
+ */
+rules["class-methods-use-this"] = "error";
+
+/**
+ * Disable cyclomatic complexity.
+ *
+ * @name complexity
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [complexity]{@link https://eslint.org/docs/rules/complexity}
+ */
+rules["complexity"] = "off";
+
+/**
+ * Do not enforce consistent returns.
+ *
+ * @name consistent-return
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [consistent-return]{@link https://eslint.org/docs/rules/consistent-return}
+ *
+ * @example
+ * // Okay...
+ * function foo( x ) {
+ * if ( x === 1 ) {
+ * return NaN;
+ * }
+ * // No explicit return...
+ * }
+ */
+rules["consistent-return"] = "off";
+
+/**
+ * Always require curly braces.
+ *
+ * @name curly
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [curly]{@link https://eslint.org/docs/rules/curly}
+ *
+ * @example
+ * // Bad...
+ * if ( x === 1 ) x += 1;
+ *
+ * @example
+ * // Good...
+ * if ( x === 1 ) {
+ * x += 1;
+ * }
+ */
+rules["curly"] = "error";
+
+/**
+ * Always require a `default` case in `switch` statements.
+ *
+ * @name default-case
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [default-case]{@link https://eslint.org/docs/rules/default-case}
+ *
+ * @example
+ * // Bad...
+ * switch( foo ) {
+ * case 1:
+ * break;
+ * }
+ *
+ * @example
+ * // Good...
+ * switch( foo ) {
+ * case 1:
+ * break;
+ * default:
+ * break;
+ * }
+ */
+rules["default-case"] = "error";
+
+/**
+ * Always require a `default` clause to be last in a `switch` statement.
+ *
+ * @name default-case-last
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [default-case]{@link https://eslint.org/docs/rules/default-case-last}
+ *
+ * @example
+ * // Bad...
+ * switch( foo ) {
+ * default:
+ * break;
+ * case 1:
+ * break;
+ * }
+ *
+ * @example
+ * // Good...
+ * switch( foo ) {
+ * case 1:
+ * break;
+ * default:
+ * break;
+ * }
+ */
+rules["default-case-last"] = "error";
+
+/**
+ * Always require default parameters to be last.
+ *
+ * @name default-param-last
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [default-param-last]{@link https://eslint.org/docs/rules/default-param-last}
+ *
+ * @example
+ * // Bad...
+ * function foo( a = 1, b ) {
+ * // No-op...
+ * }
+ *
+ * @example
+ * // Good...
+ * function foo( b, a = 1 ) {
+ * // No-op...
+ * }
+ */
+rules["default-param-last"] = "error";
+
+/**
+ * Require that a dot be on the same line as a property.
+ *
+ * @name dot-location
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'property' ]
+ * @see [dot-location]{@link https://eslint.org/docs/rules/dot-location}
+ *
+ * @example
+ * // Bad...
+ * var obj = {
+ * 'beep': 'boop'
+ * };
+ * var p = obj.
+ * beep;
+ *
+ * @example
+ * // Good...
+ * var obj = {
+ * 'beep': 'boop'
+ * };
+ * var p = obj
+ * .beep;
+ *
+ * @example
+ * // Better...
+ * var obj = {
+ * 'beep': 'boop'
+ * };
+ * var p = obj.beep;
+ */
+rules["dot-location"] = ["error", "property"];
+
+/**
+ * Do not enforce using dot notation over square-bracket notation.
+ *
+ * @name dot-notation
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [dot-notation]{@link https://eslint.org/docs/rules/dot-notation}
+ */
+rules["dot-notation"] = "off"; // TODO: revisit?
+
+/**
+ * Always require `===` over `==`.
+ *
+ * @name eqeqeq
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'always' ]
+ * @see [eqeqeq]{@link https://eslint.org/docs/rules/eqeqeq}
+ *
+ * @example
+ * // Bad...
+ * var bool = ( x == 3.14 );
+ *
+ * @example
+ * // Good...
+ * var bool = ( x === 3.14 );
+ */
+rules["eqeqeq"] = ["error", "always"];
+
+/**
+ * A `for-in` loop should always filter results using an `if` statement.
+ *
+ * @name guard-for-in
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [guard-for-in]{@link https://eslint.org/docs/rules/guard-for-in}
+ *
+ * @example
+ * // Bad...
+ * for ( key in obj ) {
+ * // Do something...
+ * }
+ *
+ * @example
+ * // Good...
+ * var hasOwn = require( '@stdlib/assert/has-own-property' );
+ *
+ * for ( key in obj ) {
+ * if ( hasOwn( obj, key ) ) {
+ * // Do something...
+ * }
+ * }
+ */
+rules["guard-for-in"] = "error";
+
+/**
+ * Never allow more than one class per file.
+ *
+ * @name max-classes-per-file
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 1 ]
+ * @see [max-classes-per-file]{@link https://eslint.org/docs/rules/max-classes-per-file}
+ */
+rules["max-classes-per-file"] = ["error", 1];
+
+/**
+ * Never allow `alert`, `confirm`, or `prompt`.
+ *
+ * @name no-alert
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-alert]{@link https://eslint.org/docs/rules/no-alert}
+ *
+ * @example
+ * // Bad...
+ * alert( 'beep' );
+ */
+rules["no-alert"] = "error";
+
+/**
+ * Never allow `arguments.caller` or `arguments.callee` to be used, as they are deprecated.
+ *
+ * @name no-caller
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-caller]{@link https://eslint.org/docs/rules/no-caller}
+ *
+ * @example
+ * // Bad...
+ * function foo() {
+ * var callee = arguments.callee;
+ * }
+ */
+rules["no-caller"] = "error";
+
+/**
+ * Do not allow lexical declarations in case/default clauses.
+ *
+ * @name no-case-declarations
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-case-declarations]{@link https://eslint.org/docs/rules/no-case-declarations}
+ */
+rules["no-case-declarations"] = "error";
+
+/**
+ * Always require regex literals to escape division operators.
+ *
+ * @name no-div-regex
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-div-regex]{@link https://eslint.org/docs/rules/no-div-regex}
+ *
+ * @example
+ * // Bad...
+ * var re = /=foo/;
+ *
+ * @example
+ * // Good...
+ * var re = /\=foo/;
+ */
+rules["no-div-regex"] = "error";
+
+/**
+ * Prevent unnecessary `else` blocks when an `if` contains a `return` statement.
+ *
+ * @name no-else-return
+ * @memberof rules
+ * @type {Array}
+ * @see [no-else-return]{@link https://eslint.org/docs/rules/no-else-return}
+ *
+ * @example
+ * // Bad...
+ * function foo( x, y ) {
+ * if ( x === y ) {
+ * return x;
+ * } else {
+ * return y;
+ * }
+ * }
+ *
+ * @example
+ * // Good...
+ * function foo( x, y ) {
+ * if ( x === y ) {
+ * return x;
+ * }
+ * return y;
+ * }
+ */
+rules["no-else-return"] = [
+ "error",
+ {
+ allowElseIf: false,
+ },
+];
+
+/**
+ * Never allow an empty function.
+ *
+ * @name no-empty-function
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-empty-function]{@link https://eslint.org/docs/rules/no-empty-function}
+ *
+ * @example
+ * // Bad...
+ * function noop(){}
+ *
+ * @example
+ * // Good...
+ * function noop() {
+ * // Do nothing...
+ * }
+ */
+rules["no-empty-function"] = "error";
+
+/**
+ * Never allow an empty destructuring patterns.
+ *
+ * @name no-empty-pattern
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-empty-pattern]{@link https://eslint.org/docs/rules/no-empty-pattern}
+ *
+ * @example
+ * // Bad...
+ * var {} = foo();
+ *
+ * @example
+ * // Good...
+ * var { a = {} } = foo();
+ */
+rules["no-empty-pattern"] = "error";
+
+/**
+ * Never allow `null` comparisons.
+ *
+ * @name no-eq-null
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-eq-null]{@link https://eslint.org/docs/rules/no-eq-null}
+ *
+ * @example
+ * // Bad...
+ * if ( x == null ) {
+ * // Do something...
+ * }
+ *
+ * @example
+ * // Good...
+ * if ( x === false ) {
+ * // Do something...
+ * }
+ */
+rules["no-eq-null"] = "error";
+
+/**
+ * Never allow the use of `eval`.
+ *
+ * @name no-eval
+ * @memberof rules
+ * @type {Array}
+ * @default 'error'
+ * @see [no-eval]{@link https://eslint.org/docs/rules/no-eval}
+ *
+ * @example
+ * // Bad...
+ * var x = eval( '5' );
+ *
+ * @example
+ * // Good...
+ * var x = parseInt( '5', 10 );
+ */
+rules["no-eval"] = "error";
+
+/**
+ * Never allow extending native prototypes.
+ *
+ * @name no-extend-native
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-extend-native]{@link https://eslint.org/docs/rules/no-extend-native}
+ *
+ * @example
+ * // Bad...
+ * Object.prototype.beep = 'boop';
+ */
+rules["no-extend-native"] = "error";
+
+/**
+ * Prevent function binding when a function does not use `this`.
+ *
+ * @name no-extra-bind
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-extra-bind]{@link https://eslint.org/docs/rules/no-extra-bind}
+ *
+ * @example
+ * // Bad...
+ * function foo() {
+ * bar();
+ * }
+ * var x = foo.bind( bar );
+ *
+ * @example
+ * // Okay...
+ * function foo() {
+ * this.beep();
+ * }
+ * var x = foo.bind( bar );
+ */
+rules["no-extra-bind"] = "error";
+
+/**
+ * Do not allow unnecessary labels.
+ *
+ * @name no-extra-label
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-extra-label]{@link https://eslint.org/docs/rules/no-extra-label}
+ *
+ * @example
+ * // Bad...
+ * A: while ( true ) {
+ * // Do something...
+ * }
+ */
+rules["no-extra-label"] = "error";
+
+/**
+ * Prevent unintentional fall throughs in `switch` statements.
+ *
+ * @name no-fallthrough
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-fallthrough]{@link https://eslint.org/docs/rules/no-fallthrough}
+ *
+ * @example
+ * // Bad...
+ * switch ( x ) {
+ * case 1:
+ * foo();
+ * case 2:
+ * bar();
+ * break;
+ * default:
+ * break;
+ * }
+ *
+ * @example
+ * // Good...
+ * switch ( x ) {
+ * case 1:
+ * foo();
+ * break;
+ * case 2:
+ * bar();
+ * break;
+ * default:
+ * break;
+ * }
+ *
+ * @example
+ * // Okay...
+ * switch ( x ) {
+ * case 1:
+ * case 2:
+ * bar();
+ * break;
+ * default:
+ * break;
+ * }
+ */
+rules["no-fallthrough"] = "error";
+
+/**
+ * Prevent floating decimals; e.g., `2.`.
+ *
+ * @name no-floating-decimal
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-floating-decimal]{@link https://eslint.org/docs/rules/no-floating-decimal}
+ *
+ * @example
+ * // Bad...
+ * var x = 2.;
+ *
+ * @example
+ * // Good...
+ * var x = 2.0;
+ */
+rules["no-floating-decimal"] = "error";
+
+/**
+ * Do not allow assignment to native objects or read-only global variables.
+ *
+ * @name no-global-assign
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-global-assign]{@link https://eslint.org/docs/rules/no-global-assign}
+ *
+ * @example
+ * // Bad...
+ * Object = null;
+ */
+rules["no-global-assign"] = "error";
+
+/**
+ * Allow implicit type coercion.
+ *
+ * @name no-implicit-coercion
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [no-implicit-coercion]{@link https://eslint.org/docs/rules/no-implicit-coercion}
+ *
+ * @example
+ * // Okay...
+ * var str = '5';
+ * var num = +str;
+ */
+rules["no-implicit-coercion"] = "off";
+
+/**
+ * Turn off checking for implicit globals in browser scripts, as code is primarily comprised of modules which have their own scope.
+ *
+ * @name no-implicit-globals
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [no-implicit-globals]{@link https://eslint.org/docs/rules/no-implicit-globals}
+ *
+ * @example
+ * // Okay...
+ * window.foo = 'bar';
+ */
+rules["no-implicit-globals"] = "off";
+
+/**
+ * Never allow implied use of `eval` with `setTimeout`, `setInterval`, and `execScript`.
+ *
+ * @name no-implied-eval
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-implied-eval]{@link https://eslint.org/docs/rules/no-implied-eval}
+ *
+ * @example
+ * // Bad...
+ * setTimeout( 'console.log("beep!");', 10 );
+ */
+rules["no-implied-eval"] = "error";
/**
-* Never allow concatenation of two string literals which can be combined as a single literal.
-*
-* @name no-useless-concat
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-useless-concat]{@link https://eslint.org/docs/rules/no-useless-concat}
-*
-* @example
-* // Bad...
-* var c = 'a' + 'b';
-*
-* @example
-* // Good...
-* var c = 'ab';
-*/
-rules[ 'no-useless-concat' ] = 'error';
+* Never allow the use of `this` outside of classes.
-/**
-* Prohibit unnecessary escaping.
-*
-* @name no-useless-escape
+* @name no-invalid-this
* @memberof rules
* @type {string}
* @default 'error'
-* @see [no-useless-escape]{@link https://eslint.org/docs/rules/no-useless-escape}
+* @see [no-invalid-this]{@link https://eslint.org/docs/rules/no-invalid-this}
*
* @example
* // Bad...
-* var str = 'He\l\lo';
-*
-* @example
-* // Good...
-* var str = 'Hello';
-*/
-rules[ 'no-useless-escape' ] = 'error';
-
-/**
-* Never allow redundant/unnecessary `return` statements.
-*
-* @name no-useless-return
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-useless-return]{@link https://eslint.org/docs/rules/no-useless-return}
+* this.beep = 'boop';
*
* @example
-* // Bad...
-* function foo( x ) {
-* if ( x === x ) {
-* return x;
-* }
-* return;
-* }
-*
-*@ example
* // Good...
-* function foo( x ) {
-* if ( x === x ) {
-* return x;
-* }
-* }
-*/
-rules[ 'no-useless-return' ] = 'error';
-
-/**
-* Allow using the `void` operator. Useful in pre-ES5 environments where `undefined` is mutable.
-*
-* @name no-void
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [no-void]{@link https://eslint.org/docs/rules/no-void}
-*
-* @example
-* // Okay...
-* if ( x === void 0 ) { // Check if `undefined`...
-* x = 'beep';
+* function Beep() {
+* this.boop = 'boop';
+* return this;
* }
*/
-rules[ 'no-void' ] = 'off';
-
-/**
-* Warn when source contains warning comments.
-*
-* @name no-warning-comments
-* @memberof rules
-* @type {Array}
-* @see [no-warning-comments]{@link https://eslint.org/docs/rules/no-warning-comments}
-*/
-rules[ 'no-warning-comments' ] = [ 'warn', {
- 'terms': [
- 'todo',
- 'warning',
- 'fixme',
- 'hack',
- 'optimize',
- 'xxx'
- ],
- 'location': 'start'
-}];
-
-/**
-* Never allow using the `with` statement.
-*
-* @name no-with
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-with]{@link https://eslint.org/docs/rules/no-with}
-*/
-rules[ 'no-with' ] = 'error';
+rules["no-invalid-this"] = "error";
+
+/**
+ * Never allow the use of the deprecated `__iterator__` property.
+ *
+ * @name no-iterator
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-iterator]{@link https://eslint.org/docs/rules/no-iterator}
+ */
+rules["no-iterator"] = "error";
+
+/**
+ * Never allow the use of `labels`.
+ *
+ * @name no-labels
+ * @memberof rules
+ * @type {Array}
+ * @see [no-labels]{@link https://eslint.org/docs/rules/no-labels}
+ *
+ * @example
+ * // Bad...
+ * label: while( true ) {
+ * // Do something...
+ * }
+ *
+ * @example
+ * // Good...
+ * while( true ) {
+ * // Do something...
+ * }
+ */
+rules["no-labels"] = [
+ "error",
+ {
+ allowLoop: false,
+ allowSwitch: false,
+ },
+];
+
+/**
+ * Never allow standalone code blocks delimited by curly braces.
+ *
+ * @name no-lone-blocks
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-line-blocks]{@link https://eslint.org/docs/rules/no-lone-blocks}
+ *
+ * @example
+ * // Bad...
+ * {
+ * function foo() {
+ * // Do something...
+ * }
+ * }
+ *
+ * @example
+ * // Good...
+ * function foo() {
+ * // Do something...
+ * }
+ */
+rules["no-lone-blocks"] = "error";
+
+/**
+ * Never allow functions to be created within a loop.
+ *
+ * @name no-loop-func
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-loop-func]{@link https://eslint.org/docs/rules/no-loop-func}
+ *
+ * @example
+ * // Bad...
+ * var foo;
+ * var i;
+ *
+ * foo = new Array( 10 );
+ * for ( i = 0; i < foo.length; i++ ) {
+ * foo[ i ] = function bar() {
+ * return i;
+ * };
+ * }
+ *
+ * @example
+ * // Good...
+ * var foo;
+ * var i;
+ *
+ * function bar( i ) {
+ * return function bar() {
+ * return i;
+ * };
+ * }
+ *
+ * foo = new Array( 10 );
+ * for ( i = 0; i < foo.length; i++ ) {
+ * foo[ i ] = bar( i );
+ * }
+ */
+rules["no-loop-func"] = "error";
+
+/**
+ * Warn when magic numbers are used. NOTE: turned off due to overly aggressive consideration of "magic" numbers.
+ *
+ * @name no-magic-numbers
+ * @memberof rules
+ * @type {Array}
+ * @see [no-magic-numbers]{@link https://eslint.org/docs/rules/no-magic-numbers}
+ */
+rules["no-magic-numbers"] = [
+ "off",
+ {
+ ignoreArrayIndexes: true,
+ enforceConst: false,
+ detectObjects: false,
+ },
+];
+
+/**
+ * Never allow multiple whitespace characters in expressions.
+ *
+ * @name no-multi-spaces
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', { 'ignoreEOLComments': true } ]
+ * @see [no-multi-spaces]{@link https://eslint.org/docs/rules/no-multi-spaces}
+ *
+ * @example
+ * // Bad...
+ * var bool = ( x === true );
+ *
+ * @example
+ * // Good...
+ * var bool = ( x === true );
+ */
+rules["no-multi-spaces"] = [
+ "error",
+ {
+ ignoreEOLComments: true,
+ },
+];
+
+/**
+ * Never allow using a `\` character to create multi-line strings.
+ *
+ * @name no-multi-str
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-multi-str]{@link https://eslint.org/docs/rules/no-multi-str}
+ *
+ * @example
+ * // Bad...
+ * var str = 'Hello \
+ * world!';
+ *
+ * @example;
+ * // Good...
+ * var str = 'Hello\nworld!';
+ */
+rules["no-multi-str"] = "error";
+
+/**
+ * Never allow use the `new` operator without assignment.
+ *
+ * @name no-new
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-new]{@link https://eslint.org/docs/rules/no-new}
+ *
+ * @example
+ * // Bad...
+ * new Foo();
+ *
+ * @example
+ * // Good...
+ * var f = new Foo();
+ */
+rules["no-new"] = "error";
+
+/**
+ * Never allow using the `Function` constructor to create functions.
+ *
+ * @name no-new-func
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-new-func]{@link https://eslint.org/docs/rules/no-new-func}
+ *
+ * @example
+ * // Bad (most of the time)...
+ * var foo = new Function( 'x', 'return x;' );
+ *
+ * @example
+ * // Good...
+ * function foo( x ) {
+ * return x;
+ * }
+ */
+rules["no-new-func"] = "error";
+
+/**
+ * Never allow using `String`, `Number`, and `Boolean` in place of primitives.
+ *
+ * @name no-new-wrappers
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-new-wrappers]{@link https://eslint.org/docs/rules/no-new-wrappers}
+ *
+ * @example
+ * // Bad...
+ * var bool = new Boolean( true );
+ *
+ * @example
+ * // Good...
+ * var bool = true;
+ */
+rules["no-new-wrappers"] = "error";
+
+/**
+ * Never allow octal literals that begin with a leading zero; e.g., 071 (=> 57).
+ *
+ * @name no-octal
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-octal]{@link https://eslint.org/docs/rules/no-octal}
+ *
+ * @example
+ * // Bad...
+ * var num = 071;
+ *
+ * @example
+ * // Good...
+ * var num = '071';
+ */
+rules["no-octal"] = "error";
+
+/**
+ * Never allow octal escape sequences, which are deprecated.
+ *
+ * @name no-octal-escape
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-octal-escape]{@link https://eslint.org/docs/rules/no-octal-escape}
+ *
+ * @example
+ * // Bad...
+ * var foo = 'Copyright \251';
+ *
+ * @example
+ * // Good...
+ * var foo = 'Copyright \u00A9';
+ */
+rules["no-octal-escape"] = "error";
+
+/**
+ * Allow parameter reassignment (although bugs can arise when doing so).
+ *
+ * @name no-param-reassign
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [no-param-reassign]{@link https://eslint.org/docs/rules/no-param-reassign}
+ *
+ * @example
+ * // Okay...
+ * function foo( x ) {
+ * y = x;
+ * return y;
+ * }
+ */
+rules["no-param-reassign"] = "off";
+
+/**
+ * Never allow using deprecated `__proto__` property.
+ *
+ * @name no-proto
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-proto]{@link https://eslint.org/docs/rules/no-proto}
+ *
+ * @example
+ * // Bad...
+ * var proto = {}.__proto__;
+ *
+ * @example
+ * // Good...
+ * var getPrototypeOf = require( '@stdlib/utils/get-prototype-of' );
+ *
+ * var proto = getPrototypeOf( {} );
+ */
+rules["no-proto"] = "error";
+
+/**
+ * Never allow a variable to be declared multiple times within the same scope or for built-in globals to be redeclared. NOTE: turned off due to custom stdlib/no-redeclare rule which permits overriding of certain globals.
+ *
+ * @name no-redeclare
+ * @memberof rules
+ * @type {Array}
+ * @default 'off'
+ * @see [no-redeclare]{@link https://eslint.org/docs/rules/no-redeclare}
+ *
+ * @example
+ * // Bad...
+ * var a = 'beep';
+ * // ...
+ * var a = 'boop';
+ *
+ * @example
+ * // Good...
+ * var a = 'beep';
+ * // ...
+ * a = 'boop';
+ */
+rules["no-redeclare"] = "off";
+
+/**
+ * Do not restrict any object properties.
+ *
+ * @name no-restricted-properties
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [no-restricted-properties]{@link https://eslint.org/docs/rules/no-restricted-properties}
+ */
+rules["no-restricted-properties"] = "off";
+
+/**
+ * Never allow assignment in `return` statements.
+ *
+ * @name no-return-assign
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'always' ]
+ * @see [no-return-assign]{@link https://eslint.org/docs/rules/no-return-assign}
+ *
+ * @example
+ * // Bad...
+ * function foo( x ) {
+ * var bar;
+ * return bar = x + 2;
+ * }
+ *
+ * @example
+ * // Good...
+ * function foo( x ) {
+ * return x + 2;
+ * }
+ */
+rules["no-return-assign"] = ["error", "always"];
-/**
-* Do not require the use of ES2018 named capture groups.
-*
-* @name prefer-named-capture-group
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [prefer-named-capture-group]{@link https://eslint.org/docs/rules/prefer-named-capture-group}
-*/
-rules[ 'prefer-named-capture-group' ] = 'off';
+/* eslint-disable stdlib/jsdoc-doctest-marker, stdlib/jsdoc-doctest-quote-props */
/**
-* Always require that promises are rejected with `Error` objects.
-*
-* @name prefer-promise-reject-errors
-* @memberof rules
-* @type {Array}
-* @see [prefer-promise-reject-errors]{@link https://eslint.org/docs/rules/prefer-promise-reject-errors}
-*/
-rules[ 'prefer-promise-reject-errors' ] = [ 'error', {
- 'allowEmptyReject': false
-}];
+ * Never allow `return await`.
+ *
+ * @name no-return-await
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-return-await]{@link https://eslint.org/docs/rules/no-return-await}
+ *
+ * @example
+ * // Bad...
+ * async function foo() {
+ * return await bar();
+ * }
+ */
+rules["no-return-await"] = "error";
-/**
-* Always require regular expression literals when not dynamically generating a regular expression.
-*
-* @name prefer-regex-literals
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [prefer-regex-literals]{@link https://eslint.org/docs/rules/prefer-regex-literals}
-*
-* @example
-* // Bad...
-* var re = new RegExp( 'foo' );
-*
-* @example
-* // Good...
-* var re = /foo/;
-*/
-rules[ 'prefer-regex-literals' ] = 'error';
+/* eslint-enable stdlib/jsdoc-doctest-marker stdlib/jsdoc-doctest-quote-props */
/**
-* Always require a `radix` parameter to `parseInt()`.
-*
-* @name radix
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'always' ]
-* @see [radix]{@link https://eslint.org/docs/rules/radix}
-*
-* @example
-* // Bad...
-* var x = parseInt( '8' );
-*
-* @example
-* // Good...
-* var x = parseInt( '8', 10 );
-*/
-rules[ 'radix' ] = [ 'error', 'always' ];
+ * Never allow using `javascript:` in urls.
+ *
+ * @name no-script-url
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-script-url]{@link https://eslint.org/docs/rules/no-script-url}
+ *
+ * @example
+ * // Bad...
+ * location.href = 'javascript:void(0)';
+ */
+rules["no-script-url"] = "error";
+
+/**
+ * Never allow self-assignments, including properties.
+ *
+ * @name no-self-assign
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', {'props':true} ]
+ * @see [no-self-assign]{@link https://eslint.org/docs/rules/no-self-assign}
+ *
+ * @example
+ * // Bad...
+ * foo = foo;
+ *
+ * @example
+ * // Bad...
+ * obj = { 'a': 'b' };
+ * obj.a = obj.a;
+ */
+rules["no-self-assign"] = [
+ "error",
+ {
+ props: true,
+ },
+];
+
+/**
+ * Allow self-comparison (`NaN` check).
+ *
+ * @name no-self-compare
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [no-self-compare]{@link https://eslint.org/docs/rules/no-self-compare}
+ *
+ * @example
+ * // Okay...
+ * if ( x !== x ) {
+ * // Handle NaN...
+ * }
+ */
+rules["no-self-compare"] = "off";
+
+/**
+ * Never allow using a comma operator to separate multiple expressions where only a single expression is expected.
+ *
+ * @name no-sequences
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-sequences]{@link https://eslint.org/docs/rules/no-sequences}
+ *
+ * @example
+ * // Bad...
+ * var x = (3,5); // x = 5
+ *
+ * @example
+ * // Good...
+ * var x = 5;
+ */
+rules["no-sequences"] = "error";
+
+/**
+ * Require only `Error` objects to be thrown.
+ *
+ * @name no-throw-literal
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-throw-literal]{@link https://eslint.org/docs/rules/no-throw-literal}
+ *
+ * @example
+ * // Bad...
+ * throw 'beep';
+ *
+ * @example
+ * // Good...
+ * throw new Error( 'beep' );
+ */
+rules["no-throw-literal"] = "error";
+
+/**
+ * Allow unmodified loop conditions.
+ *
+ * @name no-unmodified-loop-condition
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [no-unmodified-loop-condition]{@link https://eslint.org/docs/rules/no-unmodified-loop-condition}
+ */
+rules["no-unmodified-loop-condition"] = "off";
+
+/**
+ * Never allow unused expressions.
+ *
+ * @name no-unused-expressions
+ * @memberof rules
+ * @type {Array}
+ * @see [no-unused-expressions]{@link https://eslint.org/docs/rules/no-unused-expressions}
+ *
+ * @example
+ * // Bad...
+ * n + 1;
+ */
+rules["no-unused-expressions"] = [
+ "error",
+ {
+ allowShortCircuit: false,
+ allowTernary: false,
+ },
+];
+
+/**
+ * Never allow unused labels.
+ *
+ * @name no-unused-labels
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-unused-labels]{@link https://eslint.org/docs/rules/no-unused-labels}
+ *
+ * @example
+ * // Bad...
+ * function foo() {
+ * var x = 0;
+ * A: while( true ) {
+ * if ( x === 10 ) {
+ * return;
+ * }
+ * x += 1;
+ * }
+ * }
+ */
+rules["no-unused-labels"] = "error";
+
+/**
+ * Ensure there are no regular expression backreferences that always successfully match zero-length and cannot match anything else.
+ *
+ * @name no-useless-backreference
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-useless-backreference]{@link https://eslint.org/docs/rules/no-useless-backreference}
+ *
+ * @example
+ * // Bad...
+ * var RE = /\1(a)/; // forward reference to (a);
+ *
+ * @example
+ * // Good...
+ * var RE = /(a)\1/; // reference to (a)
+ */
+rules["no-useless-backreference"] = "error";
+
+/**
+ * Never allow using `call` or `apply` when a normal function invocation will suffice.
+ *
+ * @name no-useless-call
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-useless-call]{@link https://eslint.org/docs/rules/no-useless-call}
+ *
+ * @example
+ * // Bad...
+ * var x = foo.call( null, 1, 2 );
+ *
+ * @example
+ * // Good...
+ * var x = foo( 1, 2 );
+ */
+rules["no-useless-call"] = "error";
+
+/**
+ * Never allow unnecessary catch clauses.
+ *
+ * @name no-useless-catch
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-useless-catch]{@link https://eslint.org/docs/rules/no-useless-catch}
+ *
+ * @example
+ * // Bad...
+ * try {
+ * throw new Error( 'beep' );
+ * } catch ( err ) {
+ * // Catch is unnecessary if we are just rethrowing...
+ * throw err;
+ * }
+ *
+ * @example
+ * // Good...
+ * try {
+ * throw new Error( 'beep' );
+ * } catch ( err ) {
+ * if ( err instanceof TypeError) {
+ * throw err;
+ * }
+ * }
+ */
+rules["no-useless-catch"] = "error";
+
+/**
+ * Never allow concatenation of two string literals which can be combined as a single literal.
+ *
+ * @name no-useless-concat
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-useless-concat]{@link https://eslint.org/docs/rules/no-useless-concat}
+ *
+ * @example
+ * // Bad...
+ * var c = 'a' + 'b';
+ *
+ * @example
+ * // Good...
+ * var c = 'ab';
+ */
+rules["no-useless-concat"] = "error";
+
+/**
+ * Prohibit unnecessary escaping.
+ *
+ * @name no-useless-escape
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-useless-escape]{@link https://eslint.org/docs/rules/no-useless-escape}
+ *
+ * @example
+ * // Bad...
+ * var str = 'He\l\lo';
+ *
+ * @example
+ * // Good...
+ * var str = 'Hello';
+ */
+rules["no-useless-escape"] = "error";
+
+/**
+ * Never allow redundant/unnecessary `return` statements.
+ *
+ * @name no-useless-return
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-useless-return]{@link https://eslint.org/docs/rules/no-useless-return}
+ *
+ * @example
+ * // Bad...
+ * function foo( x ) {
+ * if ( x === x ) {
+ * return x;
+ * }
+ * return;
+ * }
+ *
+ *@ example
+ * // Good...
+ * function foo( x ) {
+ * if ( x === x ) {
+ * return x;
+ * }
+ * }
+ */
+rules["no-useless-return"] = "error";
+
+/**
+ * Allow using the `void` operator. Useful in pre-ES5 environments where `undefined` is mutable.
+ *
+ * @name no-void
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [no-void]{@link https://eslint.org/docs/rules/no-void}
+ *
+ * @example
+ * // Okay...
+ * if ( x === void 0 ) { // Check if `undefined`...
+ * x = 'beep';
+ * }
+ */
+rules["no-void"] = "off";
+
+/**
+ * Warn when source contains warning comments.
+ *
+ * @name no-warning-comments
+ * @memberof rules
+ * @type {Array}
+ * @see [no-warning-comments]{@link https://eslint.org/docs/rules/no-warning-comments}
+ */
+rules["no-warning-comments"] = [
+ "warn",
+ {
+ terms: ["todo", "warning", "fixme", "hack", "optimize", "xxx"],
+ location: "start",
+ },
+];
+
+/**
+ * Never allow using the `with` statement.
+ *
+ * @name no-with
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-with]{@link https://eslint.org/docs/rules/no-with}
+ */
+rules["no-with"] = "error";
+
+/**
+ * Do not require the use of ES2018 named capture groups.
+ *
+ * @name prefer-named-capture-group
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [prefer-named-capture-group]{@link https://eslint.org/docs/rules/prefer-named-capture-group}
+ */
+rules["prefer-named-capture-group"] = "off";
+
+/**
+ * Always require that promises are rejected with `Error` objects.
+ *
+ * @name prefer-promise-reject-errors
+ * @memberof rules
+ * @type {Array}
+ * @see [prefer-promise-reject-errors]{@link https://eslint.org/docs/rules/prefer-promise-reject-errors}
+ */
+rules["prefer-promise-reject-errors"] = [
+ "error",
+ {
+ allowEmptyReject: false,
+ },
+];
+
+/**
+ * Always require regular expression literals when not dynamically generating a regular expression.
+ *
+ * @name prefer-regex-literals
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [prefer-regex-literals]{@link https://eslint.org/docs/rules/prefer-regex-literals}
+ *
+ * @example
+ * // Bad...
+ * var re = new RegExp( 'foo' );
+ *
+ * @example
+ * // Good...
+ * var re = /foo/;
+ */
+rules["prefer-regex-literals"] = "error";
+
+/**
+ * Always require a `radix` parameter to `parseInt()`.
+ *
+ * @name radix
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'always' ]
+ * @see [radix]{@link https://eslint.org/docs/rules/radix}
+ *
+ * @example
+ * // Bad...
+ * var x = parseInt( '8' );
+ *
+ * @example
+ * // Good...
+ * var x = parseInt( '8', 10 );
+ */
+rules["radix"] = ["error", "always"];
/* eslint-disable stdlib/jsdoc-doctest-marker, stdlib/jsdoc-doctest-quote-props */
/**
-* Always require `async` functions to have an `await` expression.
-*
-* @name require-await
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [require-await]{@link https://eslint.org/docs/rules/require-await}
-*
-* @example
-* // Bad...
-* async function foo() {
-* bar();
-* }
-*
-* @example
-* // Good...
-* async function foo() {
-* await bar();
-* }
-*/
-rules[ 'require-await' ] = 'error';
+ * Always require `async` functions to have an `await` expression.
+ *
+ * @name require-await
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [require-await]{@link https://eslint.org/docs/rules/require-await}
+ *
+ * @example
+ * // Bad...
+ * async function foo() {
+ * bar();
+ * }
+ *
+ * @example
+ * // Good...
+ * async function foo() {
+ * await bar();
+ * }
+ */
+rules["require-await"] = "error";
/* eslint-enable stdlib/jsdoc-doctest-marker, stdlib/jsdoc-doctest-quote-props */
/**
-* Don't require the `u` flag on a regular expression.
-*
-* ## Notes
-*
-* - With the `u` flag set, regular expressions handle UTF-16 surrogate pairs correctly.
-*
-* @name require-unicode-regexp
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [require-unicode-regexp]{@link https://eslint.org/docs/rules/require-unicode-regexp}
-*
-* @example
-* // Bad...
-* var re = /^[👍]$/;
-*
-* @example
-* // Good...
-* var re = /^[👍]$/u;
-*/
-rules[ 'require-unicode-regexp' ] = 'off';
-
-/**
-* Always declare variables at the top of their scope to represent hoisting.
-*
-* @name vars-on-top
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [vars-on-top]{@link https://eslint.org/docs/rules/vars-on-top}
-*
-* @example
-* // Bad...
-* function foo() {
-* for ( var i = 0; i < 5; i++ ) {
-* // Do something...
-* }
-* var beep = 'boop';
-* }
-*
-* @example
-* // Good...
-* function foo() {
-* var beep;
-* var i;
-* for ( i = 0; i < 5; i++ ) {
-* // Do something...
-* }
-* beep = 'boop';
-* }
-*/
-rules[ 'vars-on-top' ] = 'error';
-
-/**
-* Always require an immediately invoked function expression (IIFE) to be wrapped.
-*
-* @name wrap-iife
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'inside' ]
-* @see [wrap-iife]{@link https://eslint.org/docs/rules/wrap-iife}
-*
-* @example
-* // Bad...
-* var x = function foo(){}();
-*
-* @example
-* // Good...
-* var x = (function foo(){})();
-*/
-rules[ 'wrap-iife' ] = [ 'error', 'inside' ];
-
-/**
-* Require that literals come after variables in conditions, except for ranges.
-*
-* @name yoda
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'never', {'exceptRange':true} ]
-* @see [yoda]{@link https://eslint.org/docs/rules/yoda}
-*
-* @example
-* // Bad...
-* if ( 3.14 === x ) {
-* // Do something...
-* }
-*
-* @example
-* // Good...
-* if ( x === 3.14 ) {
-* // Do something...
-* }
-*
-* @example
-* // Okay...
-* if ( -3.14 < x && x < 3.14 ) {
-* // Do something...
-* }
-*/
-rules[ 'yoda' ] = [ 'error', 'never', {
- 'exceptRange': true
-}];
-
+ * Don't require the `u` flag on a regular expression.
+ *
+ * ## Notes
+ *
+ * - With the `u` flag set, regular expressions handle UTF-16 surrogate pairs correctly.
+ *
+ * @name require-unicode-regexp
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [require-unicode-regexp]{@link https://eslint.org/docs/rules/require-unicode-regexp}
+ *
+ * @example
+ * // Bad...
+ * var re = /^[👍]$/;
+ *
+ * @example
+ * // Good...
+ * var re = /^[👍]$/u;
+ */
+rules["require-unicode-regexp"] = "off";
+
+/**
+ * Always declare variables at the top of their scope to represent hoisting.
+ *
+ * @name vars-on-top
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [vars-on-top]{@link https://eslint.org/docs/rules/vars-on-top}
+ *
+ * @example
+ * // Bad...
+ * function foo() {
+ * for ( var i = 0; i < 5; i++ ) {
+ * // Do something...
+ * }
+ * var beep = 'boop';
+ * }
+ *
+ * @example
+ * // Good...
+ * function foo() {
+ * var beep;
+ * var i;
+ * for ( i = 0; i < 5; i++ ) {
+ * // Do something...
+ * }
+ * beep = 'boop';
+ * }
+ */
+rules["vars-on-top"] = "error";
+
+/**
+ * Always require an immediately invoked function expression (IIFE) to be wrapped.
+ *
+ * @name wrap-iife
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'inside' ]
+ * @see [wrap-iife]{@link https://eslint.org/docs/rules/wrap-iife}
+ *
+ * @example
+ * // Bad...
+ * var x = function foo(){}();
+ *
+ * @example
+ * // Good...
+ * var x = (function foo(){})();
+ */
+rules["wrap-iife"] = ["error", "inside"];
+
+/**
+ * Require that literals come after variables in conditions, except for ranges.
+ *
+ * @name yoda
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'never', {'exceptRange':true} ]
+ * @see [yoda]{@link https://eslint.org/docs/rules/yoda}
+ *
+ * @example
+ * // Bad...
+ * if ( 3.14 === x ) {
+ * // Do something...
+ * }
+ *
+ * @example
+ * // Good...
+ * if ( x === 3.14 ) {
+ * // Do something...
+ * }
+ *
+ * @example
+ * // Okay...
+ * if ( -3.14 < x && x < 3.14 ) {
+ * // Do something...
+ * }
+ */
+rules["yoda"] = [
+ "error",
+ "never",
+ {
+ exceptRange: true,
+ },
+];
// EXPORTS //
diff --git a/etc/eslint/rules/es2015.js b/etc/eslint/rules/es2015.js
index 65af933ac185..d1ccef72ab2d 100644
--- a/etc/eslint/rules/es2015.js
+++ b/etc/eslint/rules/es2015.js
@@ -1,565 +1,578 @@
/**
-* @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';
-
-/**
-* ESLint rules for ES2015 features.
-*
-* @namespace
-*/
+ * @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";
+
+/**
+ * ESLint rules for ES2015 features.
+ *
+ * @namespace
+ */
var rules = {};
/**
-* Require braces around arrow function body.
-*
-* @name arrow-body-style
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'always' ]
-* @see [arrow-body-style]{@link https://eslint.org/docs/rules/arrow-body-style}
-*
-* @example
-* // Bad...
-* var foo = () => 0;
-*
-* @example
-* // Okay...
-* var foo = () => {
-* return 0;
-* };
-*/
-rules[ 'arrow-body-style' ] = [ 'error', 'always' ];
-
-/**
-* Require parentheses around array function arguments.
-*
-* @name arrow-parens
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'always' ]
-* @see [arrow-parens]{@link https://eslint.org/docs/rules/arrow-parens}
-*
-* @example
-* // Bad...
-* var foo = x => {
-* return x;
-* };
-*
-* @example
-* // Good...
-* var foo = ( x ) => {
-* return x;
-* };
-*/
-rules[ 'arrow-parens' ] = [ 'error', 'always' ];
-
-/**
-* Require a space before and after an arrow function's arrow.
-*
-* @name arrow-spacing
-* @memberof rules
-* @type {Array}
-* @see [arrow-spacing]{@link https://eslint.org/docs/rules/arrow-spacing}
-*
-* @example
-* // Bad...
-* var foo = ( x )=>{
-* return x;
-* };
-*
-* @example
-* // Good...
-* var foo = ( x ) => {
-* return x;
-* };
-*/
-rules[ 'arrow-spacing' ] = [ 'error', {
- 'before': true,
- 'after': true
-}];
-
-/**
-* Require that constructors of derived classes call `super()`.
-*
-* @name constructor-super
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [constructor-super]{@link https://eslint.org/docs/rules/constructor-super}
-*
-* @example
-* // Good...
-* class Foo {
-* constructor() {}
-* }
-*
-* @example
-* // Good...
-* class Foo extends Array {
-* constructor() {
-* super();
-* }
-* }
-*/
-rules[ 'constructor-super' ] = 'error';
-
-/**
-* Require a space between the `function` keyword and the star.
-*
-* @name generator-star-spacing
-* @memberof rules
-* @type {Array}
-* @see [generator-star-spacing]{@link https://eslint.org/docs/rules/generator-star-spacing}
-*
-* @example
-* // Bad...
-* function * foo() {
-* yield 5;
-* return 5;
-* }
-*
-* @example
-* // Bad...
-* function *foo() {
-* yield 5;
-* return 5;
-* }
-*
-* @example
-* // Good...
-* function* foo() {
-* yield 5;
-* return 5;
-* }
-*/
-rules[ 'generator-star-spacing' ] = [ 'error', {
- 'before': false,
- 'after': true
-}];
-
-/**
-* Never allow a class declaration to be reassigned.
-*
-* @name no-class-assign
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-class-assign]{@link https://eslint.org/docs/rules/no-class-assign}
-*
-* @example
-* // Bad...
-* class Foo {}
-* Foo = 'beep';
-*/
-rules[ 'no-class-assign' ] = 'error';
-
-/**
-* Never allow confusing usage of arrow functions.
-*
-* @name no-confusing-arrow
-* @memberof rules
-* @type {Array}
-* @see [no-confusing-arrow]{@link https://eslint.org/docs/rules/no-confusing-arrow}
-*/
-rules[ 'no-confusing-arrow' ] = [ 'error', {
- 'allowParens': false
-}];
-
-/**
-* Never allow a variable declared as a constant be reassigned in a non-ES2015 environment.
-*
-* @name no-const-assign
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-const-assign]{@link https://eslint.org/docs/rules/no-const-assign}
-*
-* @example
-* // Bad...
-* const x = 5;
-* x = 6;
-*
-* @example
-* // Good...
-* const x = 5;
-* const y = 6;
-*/
-rules[ 'no-const-assign' ] = 'error';
-
-/**
-* Never allow duplicate class members.
-*
-* @name no-dupe-class-members
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-duple-class-members]{@link https://eslint.org/docs/rules/no-dupe-class-members}
-*
-* @example
-* // Bad...
-* class Foo {
-* bar() {}
-* bar() {}
-* }
-*/
-rules[ 'no-dupe-class-members' ] = 'error';
-
-/**
-* Never allow duplicate `import` statements.
-*
-* @name no-duplicate-imports
-* @memberof rules
-* @type {Array}
-* @see [no-duplicate-imports]{@link https://eslint.org/docs/rules/no-duplicate-imports}
-*/
-rules[ 'no-duplicate-imports' ] = [ 'error', {
- 'includeExports': true
-}];
-
-/**
-* Never allow the use of the `new` operator with `Symbol`.
-*
-* @name no-new-symbol
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-new-symbol]{@link https://eslint.org/docs/rules/no-new-symbol}
-*
-* @example
-* // Bad...
-* var s = new Symbol( 'foo' );
-*
-* @example
-* // Good...
-* var s = Symbol( 'foo' );
-*/
-rules[ 'no-new-symbol' ] = 'error';
-
-/**
-* Restrict imports.
-*
-* @name no-restricted-imports
-* @memberof rules
-* @type {Array}
-* @see [no-restricted-imports]{@link https://eslint.org/docs/rules/no-restricted-imports}
-*/
-rules[ 'no-restricted-imports' ] = [ 'error', {
- 'paths': [
- 'lodash',
- 'underscore',
- 'async'
- ],
- 'patterns': [
- 'lodash*',
- 'async*'
- ]
-}];
-
-/**
-* Never allow `this` to be used before `super()` is called.
-*
-* @name no-this-before-super
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-this-before-super]{@link https://eslint.org/docs/rules/no-this-before-super}
-*/
-rules[ 'no-this-before-super' ] = 'error';
-
-/**
-* Never allow unnecessary computed keys.
-*
-* @name no-useless-computed-key
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-useless-computed-key]{@link https://eslint.org/docs/rules/no-useless-computed-key}
-*
-* @example
-* // Bad...
-* var obj = {
-* ['a']: 'b'
-* };
-*
-* @example
-* // Good...
-* var obj = {
-* 'a': 'b'
-* };
-*/
-rules[ 'no-useless-computed-key' ] = 'error';
-
-/**
-* Never allow useless class constructors.
-*
-* @name no-useless-constructor
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-useless-constructor]{@link https://eslint.org/docs/rules/no-useless-constructor}
-*
-* @example
-* // Bad...
-* class Foo {
-* constructor() {} // does not do anything
-* }
-*/
-rules[ 'no-useless-constructor' ] = 'error';
-
-/**
-* Never allow useless renaming of imports or exports.
-*
-* @name no-useless-rename
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-useless-rename]{@link https://eslint.org/docs/rules/no-useless-rename}
-*/
-rules[ 'no-useless-rename' ] = 'error';
-
-/**
-* Allow the use of `var`.
-*
-* @name no-var
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [no-var]{@link https://eslint.org/docs/rules/no-var}
-*
-* @example
-* // Okay...
-* var x = 5;
-*/
-rules[ 'no-var' ] = 'off';
-
-/**
-* Never use object shorthand.
-*
-* @name object-shortshand
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'never' ]
-* @see [object-shorthand]{@link https://eslint.org/docs/rules/object-shorthand}
-*
-* @example
-* // Bad...
-* var obj = { x, y, z };
-*/
-rules[ 'object-shorthand' ] = [ 'error', 'never' ];
-
-/**
-* Do not require arrow callbacks.
-*
-* @name prefer-arrow-callback
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [prefer-arrow-callback]{@link https://eslint.org/docs/rules/prefer-arrow-callback}
-*/
-rules[ 'prefer-arrow-callback' ] = 'off';
-
-/**
-* Prefer a `const` declaration if a `let` variable is not modified.
-*
-* @name prefer-const
-* @memberof rules
-* @type {Array}
-* @see [prefer-const]{@link https://eslint.org/docs/rules/prefer-const}
-*/
-rules[ 'prefer-const' ] = [ 'warn', {
- 'destructuring': 'any',
- 'ignoreReadBeforeAssign': false
-}];
-
-/**
-* Do not prefer destructuring.
-*
-* @name prefer-destructuring
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [prefer-destructuring]{@link https://eslint.org/docs/rules/prefer-destructuring}
-*/
-rules[ 'prefer-destructuring' ] = 'off';
-
-/**
-* Do not prefer numeric literals.
-*
-* @name prefer-numeric-literals
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [prefer-numeric-literals]{@link https://eslint.org/docs/rules/prefer-numeric-literals}
-*
-* @example
-* // Okay...
-* var b = parseInt( '111110111', 2 );
-*/
-rules[ 'prefer-numeric-literals' ] = 'off';
-
-/**
-* Do not prefer rest parameters.
-*
-* @name prefer-rest-params
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [prefer-rest-params]{@link https://eslint.org/docs/rules/prefer-rest-params}
-*/
-rules[ 'prefer-rest-params' ] = 'off';
-
-/**
-* Do not prefer the spread operator.
-*
-* @name prefer-spread
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [prefer-spread]{@link https://eslint.org/docs/rules/prefer-spread}
-*/
-rules[ 'prefer-spread' ] = 'off';
-
-/**
-* Do not prefer template literals.
-*
-* @name prefer-template
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [prefer-template]{@link https://eslint.org/docs/rules/prefer-template}
-*
-* @example
-* // Okay...
-* var name = 'Beep Boop';
-* var str = 'Hello, ' + name + '!';
-*/
-rules[ 'prefer-template' ] = 'off';
-
-/**
-* Require a `yield` keyword in generator functions.
-*
-* @name require-yield
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [require-yield]{@link https://eslint.org/docs/rules/require-yield}
-*
-* @example
-* // Bad...
-* function* foo() {
-* return 10;
-* }
-*
-* @example
-* // Good...
-* function* foo() {
-* yield 5;
-* return 10;
-* }
-*/
-rules[ 'require-yield' ] = 'error';
-
-/**
-* Never allow spacing between rest and spread operators and their expressions.
-*
-* @name rest-spread-spacing
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'never' ]
-* @see [rest-spread-spacing]{@link https://eslint.org/docs/rules/rest-spread-spacing}
-*/
-rules[ 'rest-spread-spacing' ] = [ 'error', 'never' ];
-
-/**
-* Do not require that imports be sorted.
-*
-* @name sort-imports
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [sort-imports]{@link https://eslint.org/docs/rules/sort-imports}
-*/
-rules[ 'sort-imports' ] = 'off';
-
-/**
-* Require Symbol descriptions.
-*
-* @name symbol-description
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [symbol-description]{@link https://eslint.org/docs/rules/symbol-description}
-*
-* @example
-* // Bad...
-* var s = Symbol();
-*
-* @example
-* // Good...
-* var s = Symbol( 'beep boop' );
-*/
-rules[ 'symbol-description' ] = 'error';
-
-/**
-* Never include spacing around template literal embedded expressions.
-*
-* @name template-curly-spacing
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'never' ]
-* @see [template-curly-spacing]{@link https://eslint.org/docs/rules/template-curly-spacing}
-*
-* @example
-* // Bad...
-* var s = `beep ${ boop }`;
-*
-* @example
-* // Good...
-* var s = `beep ${boop}`;
-*/
-rules[ 'template-curly-spacing' ] = [ 'error', 'never' ];
-
-/**
-* Require a space after, but not before, `yield` and `*`.
-*
-* @name yield-star-spacing
-* @memberof rules
-* @type {Array}
-* @see [yield-star-spacing]{@link https://eslint.org/docs/rules/yield-star-spacing}
-*
-* @example
-* // Bad...
-* function* foo() {
-* yield *bar();
-* }
-*
-* @example
-* // Bad...
-* function* foo() {
-* yield* bar();
-* }
-*/
-rules[ 'yield-star-spacing' ] = [ 'error', {
- 'before': false,
- 'after': true
-}];
-
+ * Require braces around arrow function body.
+ *
+ * @name arrow-body-style
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'always' ]
+ * @see [arrow-body-style]{@link https://eslint.org/docs/rules/arrow-body-style}
+ *
+ * @example
+ * // Bad...
+ * var foo = () => 0;
+ *
+ * @example
+ * // Okay...
+ * var foo = () => {
+ * return 0;
+ * };
+ */
+rules["arrow-body-style"] = ["error", "always"];
+
+/**
+ * Require parentheses around array function arguments.
+ *
+ * @name arrow-parens
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'always' ]
+ * @see [arrow-parens]{@link https://eslint.org/docs/rules/arrow-parens}
+ *
+ * @example
+ * // Bad...
+ * var foo = x => {
+ * return x;
+ * };
+ *
+ * @example
+ * // Good...
+ * var foo = ( x ) => {
+ * return x;
+ * };
+ */
+rules["arrow-parens"] = ["error", "always"];
+
+/**
+ * Require a space before and after an arrow function's arrow.
+ *
+ * @name arrow-spacing
+ * @memberof rules
+ * @type {Array}
+ * @see [arrow-spacing]{@link https://eslint.org/docs/rules/arrow-spacing}
+ *
+ * @example
+ * // Bad...
+ * var foo = ( x )=>{
+ * return x;
+ * };
+ *
+ * @example
+ * // Good...
+ * var foo = ( x ) => {
+ * return x;
+ * };
+ */
+rules["arrow-spacing"] = [
+ "error",
+ {
+ before: true,
+ after: true,
+ },
+];
+
+/**
+ * Require that constructors of derived classes call `super()`.
+ *
+ * @name constructor-super
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [constructor-super]{@link https://eslint.org/docs/rules/constructor-super}
+ *
+ * @example
+ * // Good...
+ * class Foo {
+ * constructor() {}
+ * }
+ *
+ * @example
+ * // Good...
+ * class Foo extends Array {
+ * constructor() {
+ * super();
+ * }
+ * }
+ */
+rules["constructor-super"] = "error";
+
+/**
+ * Require a space between the `function` keyword and the star.
+ *
+ * @name generator-star-spacing
+ * @memberof rules
+ * @type {Array}
+ * @see [generator-star-spacing]{@link https://eslint.org/docs/rules/generator-star-spacing}
+ *
+ * @example
+ * // Bad...
+ * function * foo() {
+ * yield 5;
+ * return 5;
+ * }
+ *
+ * @example
+ * // Bad...
+ * function *foo() {
+ * yield 5;
+ * return 5;
+ * }
+ *
+ * @example
+ * // Good...
+ * function* foo() {
+ * yield 5;
+ * return 5;
+ * }
+ */
+rules["generator-star-spacing"] = [
+ "error",
+ {
+ before: false,
+ after: true,
+ },
+];
+
+/**
+ * Never allow a class declaration to be reassigned.
+ *
+ * @name no-class-assign
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-class-assign]{@link https://eslint.org/docs/rules/no-class-assign}
+ *
+ * @example
+ * // Bad...
+ * class Foo {}
+ * Foo = 'beep';
+ */
+rules["no-class-assign"] = "error";
+
+/**
+ * Never allow confusing usage of arrow functions.
+ *
+ * @name no-confusing-arrow
+ * @memberof rules
+ * @type {Array}
+ * @see [no-confusing-arrow]{@link https://eslint.org/docs/rules/no-confusing-arrow}
+ */
+rules["no-confusing-arrow"] = [
+ "error",
+ {
+ allowParens: false,
+ },
+];
+
+/**
+ * Never allow a variable declared as a constant be reassigned in a non-ES2015 environment.
+ *
+ * @name no-const-assign
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-const-assign]{@link https://eslint.org/docs/rules/no-const-assign}
+ *
+ * @example
+ * // Bad...
+ * const x = 5;
+ * x = 6;
+ *
+ * @example
+ * // Good...
+ * const x = 5;
+ * const y = 6;
+ */
+rules["no-const-assign"] = "error";
+
+/**
+ * Never allow duplicate class members.
+ *
+ * @name no-dupe-class-members
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-duple-class-members]{@link https://eslint.org/docs/rules/no-dupe-class-members}
+ *
+ * @example
+ * // Bad...
+ * class Foo {
+ * bar() {}
+ * bar() {}
+ * }
+ */
+rules["no-dupe-class-members"] = "error";
+
+/**
+ * Never allow duplicate `import` statements.
+ *
+ * @name no-duplicate-imports
+ * @memberof rules
+ * @type {Array}
+ * @see [no-duplicate-imports]{@link https://eslint.org/docs/rules/no-duplicate-imports}
+ */
+rules["no-duplicate-imports"] = [
+ "error",
+ {
+ includeExports: true,
+ },
+];
+
+/**
+ * Never allow the use of the `new` operator with `Symbol`.
+ *
+ * @name no-new-symbol
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-new-symbol]{@link https://eslint.org/docs/rules/no-new-symbol}
+ *
+ * @example
+ * // Bad...
+ * var s = new Symbol( 'foo' );
+ *
+ * @example
+ * // Good...
+ * var s = Symbol( 'foo' );
+ */
+rules["no-new-symbol"] = "error";
+
+/**
+ * Restrict imports.
+ *
+ * @name no-restricted-imports
+ * @memberof rules
+ * @type {Array}
+ * @see [no-restricted-imports]{@link https://eslint.org/docs/rules/no-restricted-imports}
+ */
+rules["no-restricted-imports"] = [
+ "error",
+ {
+ paths: ["lodash", "underscore", "async"],
+ patterns: ["lodash*", "async*"],
+ },
+];
+
+/**
+ * Never allow `this` to be used before `super()` is called.
+ *
+ * @name no-this-before-super
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-this-before-super]{@link https://eslint.org/docs/rules/no-this-before-super}
+ */
+rules["no-this-before-super"] = "error";
+
+/**
+ * Never allow unnecessary computed keys.
+ *
+ * @name no-useless-computed-key
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-useless-computed-key]{@link https://eslint.org/docs/rules/no-useless-computed-key}
+ *
+ * @example
+ * // Bad...
+ * var obj = {
+ * ['a']: 'b'
+ * };
+ *
+ * @example
+ * // Good...
+ * var obj = {
+ * 'a': 'b'
+ * };
+ */
+rules["no-useless-computed-key"] = "error";
+
+/**
+ * Never allow useless class constructors.
+ *
+ * @name no-useless-constructor
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-useless-constructor]{@link https://eslint.org/docs/rules/no-useless-constructor}
+ *
+ * @example
+ * // Bad...
+ * class Foo {
+ * constructor() {} // does not do anything
+ * }
+ */
+rules["no-useless-constructor"] = "error";
+
+/**
+ * Never allow useless renaming of imports or exports.
+ *
+ * @name no-useless-rename
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-useless-rename]{@link https://eslint.org/docs/rules/no-useless-rename}
+ */
+rules["no-useless-rename"] = "error";
+
+/**
+ * Allow the use of `var`.
+ *
+ * @name no-var
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [no-var]{@link https://eslint.org/docs/rules/no-var}
+ *
+ * @example
+ * // Okay...
+ * var x = 5;
+ */
+rules["no-var"] = "off";
+
+/**
+ * Never use object shorthand.
+ *
+ * @name object-shortshand
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'never' ]
+ * @see [object-shorthand]{@link https://eslint.org/docs/rules/object-shorthand}
+ *
+ * @example
+ * // Bad...
+ * var obj = { x, y, z };
+ */
+rules["object-shorthand"] = ["error", "never"];
+
+/**
+ * Do not require arrow callbacks.
+ *
+ * @name prefer-arrow-callback
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [prefer-arrow-callback]{@link https://eslint.org/docs/rules/prefer-arrow-callback}
+ */
+rules["prefer-arrow-callback"] = "off";
+
+/**
+ * Prefer a `const` declaration if a `let` variable is not modified.
+ *
+ * @name prefer-const
+ * @memberof rules
+ * @type {Array}
+ * @see [prefer-const]{@link https://eslint.org/docs/rules/prefer-const}
+ */
+rules["prefer-const"] = [
+ "warn",
+ {
+ destructuring: "any",
+ ignoreReadBeforeAssign: false,
+ },
+];
+
+/**
+ * Do not prefer destructuring.
+ *
+ * @name prefer-destructuring
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [prefer-destructuring]{@link https://eslint.org/docs/rules/prefer-destructuring}
+ */
+rules["prefer-destructuring"] = "off";
+
+/**
+ * Do not prefer numeric literals.
+ *
+ * @name prefer-numeric-literals
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [prefer-numeric-literals]{@link https://eslint.org/docs/rules/prefer-numeric-literals}
+ *
+ * @example
+ * // Okay...
+ * var b = parseInt( '111110111', 2 );
+ */
+rules["prefer-numeric-literals"] = "off";
+
+/**
+ * Do not prefer rest parameters.
+ *
+ * @name prefer-rest-params
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [prefer-rest-params]{@link https://eslint.org/docs/rules/prefer-rest-params}
+ */
+rules["prefer-rest-params"] = "off";
+
+/**
+ * Do not prefer the spread operator.
+ *
+ * @name prefer-spread
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [prefer-spread]{@link https://eslint.org/docs/rules/prefer-spread}
+ */
+rules["prefer-spread"] = "off";
+
+/**
+ * Do not prefer template literals.
+ *
+ * @name prefer-template
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [prefer-template]{@link https://eslint.org/docs/rules/prefer-template}
+ *
+ * @example
+ * // Okay...
+ * var name = 'Beep Boop';
+ * var str = 'Hello, ' + name + '!';
+ */
+rules["prefer-template"] = "off";
+
+/**
+ * Require a `yield` keyword in generator functions.
+ *
+ * @name require-yield
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [require-yield]{@link https://eslint.org/docs/rules/require-yield}
+ *
+ * @example
+ * // Bad...
+ * function* foo() {
+ * return 10;
+ * }
+ *
+ * @example
+ * // Good...
+ * function* foo() {
+ * yield 5;
+ * return 10;
+ * }
+ */
+rules["require-yield"] = "error";
+
+/**
+ * Never allow spacing between rest and spread operators and their expressions.
+ *
+ * @name rest-spread-spacing
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'never' ]
+ * @see [rest-spread-spacing]{@link https://eslint.org/docs/rules/rest-spread-spacing}
+ */
+rules["rest-spread-spacing"] = ["error", "never"];
+
+/**
+ * Do not require that imports be sorted.
+ *
+ * @name sort-imports
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [sort-imports]{@link https://eslint.org/docs/rules/sort-imports}
+ */
+rules["sort-imports"] = "off";
+
+/**
+ * Require Symbol descriptions.
+ *
+ * @name symbol-description
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [symbol-description]{@link https://eslint.org/docs/rules/symbol-description}
+ *
+ * @example
+ * // Bad...
+ * var s = Symbol();
+ *
+ * @example
+ * // Good...
+ * var s = Symbol( 'beep boop' );
+ */
+rules["symbol-description"] = "error";
+
+/**
+ * Never include spacing around template literal embedded expressions.
+ *
+ * @name template-curly-spacing
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'never' ]
+ * @see [template-curly-spacing]{@link https://eslint.org/docs/rules/template-curly-spacing}
+ *
+ * @example
+ * // Bad...
+ * var s = `beep ${ boop }`;
+ *
+ * @example
+ * // Good...
+ * var s = `beep ${boop}`;
+ */
+rules["template-curly-spacing"] = ["error", "never"];
+
+/**
+ * Require a space after, but not before, `yield` and `*`.
+ *
+ * @name yield-star-spacing
+ * @memberof rules
+ * @type {Array}
+ * @see [yield-star-spacing]{@link https://eslint.org/docs/rules/yield-star-spacing}
+ *
+ * @example
+ * // Bad...
+ * function* foo() {
+ * yield *bar();
+ * }
+ *
+ * @example
+ * // Bad...
+ * function* foo() {
+ * yield* bar();
+ * }
+ */
+rules["yield-star-spacing"] = [
+ "error",
+ {
+ before: false,
+ after: true,
+ },
+];
// EXPORTS //
diff --git a/etc/eslint/rules/index.js b/etc/eslint/rules/index.js
index f94d9087418b..a41eafe200cc 100644
--- a/etc/eslint/rules/index.js
+++ b/etc/eslint/rules/index.js
@@ -1,56 +1,54 @@
/* eslint-disable function-paren-newline */
/**
-* @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.
-*/
+ * @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.
+ */
/* eslint-disable function-call-argument-newline */
-'use strict';
+"use strict";
// MODULES //
// FIXME: remove the next line and uncomment the subsequent line once all remark JSDoc ESLint rules are completed
-var merge = require( './../../../lib/node_modules/@stdlib/utils/merge' );
+var merge = require("./../../../lib/node_modules/@stdlib/utils/merge");
// var merge = require( './../utils/merge.js' );
-
// MAIN //
/**
-* ESLint rules.
-*
-* @namespace rules
-*/
+ * ESLint rules.
+ *
+ * @namespace rules
+ */
var rules = merge(
{},
- require( './programmer_errors.js' ),
- require( './best_practices.js' ),
- require( './spellcheck.js' ),
- require( './strict.js' ),
- require( './variables.js' ),
- require( './nodejs.js' ),
- require( './style.js' ),
- require( './es2015.js' ),
- require( './stdlib.js' )
+ require("./programmer_errors.js"),
+ require("./best_practices.js"),
+ require("./spellcheck.js"),
+ require("./strict.js"),
+ require("./variables.js"),
+ require("./nodejs.js"),
+ require("./style.js"),
+ require("./es2015.js"),
+ require("./stdlib.js"),
);
-
// EXPORTS //
module.exports = rules;
diff --git a/etc/eslint/rules/nodejs.js b/etc/eslint/rules/nodejs.js
index e3bb09f4a43d..9c97a77797a4 100644
--- a/etc/eslint/rules/nodejs.js
+++ b/etc/eslint/rules/nodejs.js
@@ -1,397 +1,413 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
/**
-* ESLint rules specific to running JavaScript on Node.js or in browsers with CommonJS.
-*
-* @namespace rules
-*/
+ * ESLint rules specific to running JavaScript on Node.js or in browsers with CommonJS.
+ *
+ * @namespace rules
+ */
var rules = {};
/**
-* Warn when a callback may be unintentionally called multiple times.
-*
-* @name node/callback-return
-* @memberof rules
-* @type {Array}
-* @see [node/callback-return]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/callback-return.md}
-*
-* @example
-* // Bad...
-* function foo( x, clbk ) {
-* if ( x === true ) {
-* clbk();
-* }
-* clbk();
-* }
-*
-* @example
-* // Good...
-* function foo( x, clbk ) {
-* if ( x === true ) {
-* return clbk();
-* }
-* clbk();
-* }
-*/
-rules[ 'node/callback-return' ] = [ 'warn', [
- 'callback',
- 'clbk',
- 'cb',
- 'done',
- 'next'
-]];
+ * Warn when a callback may be unintentionally called multiple times.
+ *
+ * @name node/callback-return
+ * @memberof rules
+ * @type {Array}
+ * @see [node/callback-return]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/callback-return.md}
+ *
+ * @example
+ * // Bad...
+ * function foo( x, clbk ) {
+ * if ( x === true ) {
+ * clbk();
+ * }
+ * clbk();
+ * }
+ *
+ * @example
+ * // Good...
+ * function foo( x, clbk ) {
+ * if ( x === true ) {
+ * return clbk();
+ * }
+ * clbk();
+ * }
+ */
+rules["node/callback-return"] = [
+ "warn",
+ ["callback", "clbk", "cb", "done", "next"],
+];
/* eslint-disable -- disable linting due to `import` statements throwing for doctest rules */
/**
-* Enforce use of `module.exports` as the export style over `exports`.
-*
-* @name node/file-extension-in-import
-* @memberof rules
-* @type {Array}
-* @see [node/file-extension-in-import]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/file-extension-in-import.md}
-*
-* @example
-* // Bad...
-* import foo from './path/to/a/file';
-*
-* @example
-* // Good...
-* import eslint from 'eslint';
-* import foo from './path/to/a/file.js';
-*/
-rules[ 'node/file-extension-in-import' ] = [ 'error', 'always', {
- 'tryExtensions': [ '.js', '.json', '.node', '.ts' ]
-}];
+ * Enforce use of `module.exports` as the export style over `exports`.
+ *
+ * @name node/file-extension-in-import
+ * @memberof rules
+ * @type {Array}
+ * @see [node/file-extension-in-import]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/file-extension-in-import.md}
+ *
+ * @example
+ * // Bad...
+ * import foo from './path/to/a/file';
+ *
+ * @example
+ * // Good...
+ * import eslint from 'eslint';
+ * import foo from './path/to/a/file.js';
+ */
+rules["node/file-extension-in-import"] = [
+ "error",
+ "always",
+ {
+ tryExtensions: [".js", ".json", ".node", ".ts"],
+ },
+];
/* eslint-enable */
/**
-* Enforce use of `module.exports` as the export style over `exports`.
-*
-* @name node/exports-style
-* @memberof rules
-* @type {Array}
-* @see [node/exports-style]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/exports-style.md}
-*
-* @example
-* // Bad...
-* exports.foo = 1;
-* exports.bar = 2;
-*
-* @example
-* // Good...
-* module.exports = {
-* 'foo': 1,
-* 'bar': 2
-* };
-*/
-rules[ 'node/exports-style' ] = [ 'error', 'module.exports' ];
+ * Enforce use of `module.exports` as the export style over `exports`.
+ *
+ * @name node/exports-style
+ * @memberof rules
+ * @type {Array}
+ * @see [node/exports-style]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/exports-style.md}
+ *
+ * @example
+ * // Bad...
+ * exports.foo = 1;
+ * exports.bar = 2;
+ *
+ * @example
+ * // Good...
+ * module.exports = {
+ * 'foo': 1,
+ * 'bar': 2
+ * };
+ */
+rules["node/exports-style"] = ["error", "module.exports"];
/**
-* Allow `require` to be used in a nested scope.
-*
-* @name node/global-require
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [node/global-require]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/global-require.md}
-*
-* @example
-* // Okay...
-* var f;
-* if ( x === 'foo' ) {
-* f = require( 'foo' );
-* } else {
-* f = require( 'bar' );
-* }
-*/
-rules[ 'node/global-require' ] = 'off';
+ * Allow `require` to be used in a nested scope.
+ *
+ * @name node/global-require
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [node/global-require]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/global-require.md}
+ *
+ * @example
+ * // Okay...
+ * var f;
+ * if ( x === 'foo' ) {
+ * f = require( 'foo' );
+ * } else {
+ * f = require( 'bar' );
+ * }
+ */
+rules["node/global-require"] = "off";
/**
-* Always handle callback error arguments.
-*
-* @name node/handle-callback-err
-* @memberof rules
-* @type {Array}
-* @default [ 'error', '^(err|error)$' ]
-* @see [node/handle-callback-err]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/handle-callback-err.md}
-*
-* @example
-* // Bad...
-* function foo( err, clbk ) {
-* return clbk();
-* }
-*
-* @example
-* // Good...
-* function foo( err, clbk ) {
-* if ( error ) {
-* throw error;
-* }
-* return clbk();
-* }
-*/
-rules[ 'node/handle-callback-err' ] = [ 'error', '^(err|error)$' ];
+ * Always handle callback error arguments.
+ *
+ * @name node/handle-callback-err
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', '^(err|error)$' ]
+ * @see [node/handle-callback-err]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/handle-callback-err.md}
+ *
+ * @example
+ * // Bad...
+ * function foo( err, clbk ) {
+ * return clbk();
+ * }
+ *
+ * @example
+ * // Good...
+ * function foo( err, clbk ) {
+ * if ( error ) {
+ * throw error;
+ * }
+ * return clbk();
+ * }
+ */
+rules["node/handle-callback-err"] = ["error", "^(err|error)$"];
/**
-* Disallow use of `exports = {}` aside from `module.exports = exports = {}`.
-*
-* @name node/no-exports-assign
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [node/no-exports-assign]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-exports-assign.md}
-*
-* @example
-* // Bad...
-* exports = {};
-*
-* @example
-* // Good...
-* module.exports.foo = 1;
-* exports.bar = 2;
-*
-* module.exports = {};
-*/
-rules[ 'node/no-exports-assign' ] = 'error';
+ * Disallow use of `exports = {}` aside from `module.exports = exports = {}`.
+ *
+ * @name node/no-exports-assign
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [node/no-exports-assign]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-exports-assign.md}
+ *
+ * @example
+ * // Bad...
+ * exports = {};
+ *
+ * @example
+ * // Good...
+ * module.exports.foo = 1;
+ * exports.bar = 2;
+ *
+ * module.exports = {};
+ */
+rules["node/no-exports-assign"] = "error";
/**
-* Only allow `require`d modules to be grouped together.
-*
-* @name node/no-mixed-requires
-* @memberof rules
-* @type {Array}
-* @see [node/no-mixed-requires]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-mixed-requires.md}
-*
-* @example
-* // Good...
-* var fs = require( 'fs' );
-* var foo = require( 'foo' );
-* var beep = require( '@stdlib/beep' );
-* var bar = require( './bar.js' );
-*/
-rules[ 'node/no-mixed-requires' ] = [ 'error', {
- 'grouping': false,
- 'allowCall': true
-}];
+ * Only allow `require`d modules to be grouped together.
+ *
+ * @name node/no-mixed-requires
+ * @memberof rules
+ * @type {Array}
+ * @see [node/no-mixed-requires]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-mixed-requires.md}
+ *
+ * @example
+ * // Good...
+ * var fs = require( 'fs' );
+ * var foo = require( 'foo' );
+ * var beep = require( '@stdlib/beep' );
+ * var bar = require( './bar.js' );
+ */
+rules["node/no-mixed-requires"] = [
+ "error",
+ {
+ grouping: false,
+ allowCall: true,
+ },
+];
/**
-* Never allow the use of `new require()`.
-*
-* @name node/no-new-require
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [node/no-new-require]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-new-require.md}
-*
-* @example
-* // Bad...
-* var foo = new require( 'foo' );
-*
-* @example
-* // Good...
-* var Foo = require( 'foo' );
-*
-* var foo = new Foo();
-*/
-rules[ 'node/no-new-require' ] = 'error';
+ * Never allow the use of `new require()`.
+ *
+ * @name node/no-new-require
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [node/no-new-require]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-new-require.md}
+ *
+ * @example
+ * // Bad...
+ * var foo = new require( 'foo' );
+ *
+ * @example
+ * // Good...
+ * var Foo = require( 'foo' );
+ *
+ * var foo = new Foo();
+ */
+rules["node/no-new-require"] = "error";
/**
-* Never allow naive directory and file path concatenation.
-*
-* @name node/no-path-concat
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [node/no-path-concat]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-path-concat.md}
-*
-* @example
-* // Bad...
-* var foo = require( __dirname + '/foo.js' );
-*
-* @example
-* // Good...
-* var join = require( 'path' ).join;
-* var foo = require( join( __dirname, 'foo.js' ) );
-*/
-rules[ 'node/no-path-concat' ] = 'error';
+ * Never allow naive directory and file path concatenation.
+ *
+ * @name node/no-path-concat
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [node/no-path-concat]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-path-concat.md}
+ *
+ * @example
+ * // Bad...
+ * var foo = require( __dirname + '/foo.js' );
+ *
+ * @example
+ * // Good...
+ * var join = require( 'path' ).join;
+ * var foo = require( join( __dirname, 'foo.js' ) );
+ */
+rules["node/no-path-concat"] = "error";
/**
-* Discourage use of `process.env()`. Use `@stdlib` package instead.
-*
-* @name node/no-process-env
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [node/no-process-env]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-process-env.md}
-*/
-rules[ 'node/no-process-env' ] = 'error';
+ * Discourage use of `process.env()`. Use `@stdlib` package instead.
+ *
+ * @name node/no-process-env
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [node/no-process-env]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-process-env.md}
+ */
+rules["node/no-process-env"] = "error";
/**
-* Warn when using `process.exit()`.
-*
-* @name node/no-process-exit
-* @memberof rules
-* @type {string}
-* @default 'warn'
-* @see [node/no-process-exit]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-process-exit.md}
-*/
-rules[ 'node/no-process-exit' ] = 'warn';
+ * Warn when using `process.exit()`.
+ *
+ * @name node/no-process-exit
+ * @memberof rules
+ * @type {string}
+ * @default 'warn'
+ * @see [node/no-process-exit]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-process-exit.md}
+ */
+rules["node/no-process-exit"] = "warn";
/**
-* Restrict the use of specific module when loaded by `require()`.
-*
-* @name node/no-restricted-require
-* @memberof rules
-* @type {Array}
-* @see [node/no-restricted-require]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-restricted-require.md}
-*/
-rules[ 'node/no-restricted-require' ] = [ 'error', [
- 'underscore',
- 'lodash',
- 'async'
-]];
+ * Restrict the use of specific module when loaded by `require()`.
+ *
+ * @name node/no-restricted-require
+ * @memberof rules
+ * @type {Array}
+ * @see [node/no-restricted-require]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-restricted-require.md}
+ */
+rules["node/no-restricted-require"] = [
+ "error",
+ ["underscore", "lodash", "async"],
+];
/**
-* Restrict the use of specific modules when loaded by `import` declarations.
-*
-* @name node/no-restricted-import
-* @memberof rules
-* @type {Array}
-* @see [node/no-restricted-import]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-restricted-import.md}
-*/
-rules[ 'node/no-restricted-import' ] = [ 'error', [
- 'underscore',
- 'lodash',
- 'async'
-]];
+ * Restrict the use of specific modules when loaded by `import` declarations.
+ *
+ * @name node/no-restricted-import
+ * @memberof rules
+ * @type {Array}
+ * @see [node/no-restricted-import]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-restricted-import.md}
+ */
+rules["node/no-restricted-import"] = [
+ "error",
+ ["underscore", "lodash", "async"],
+];
/**
-* Warn when using synchronous methods when an asynchronous version exists.
-*
-* @name node/no-sync
-* @memberof rules
-* @type {string}
-* @default 'warn'
-* @see [node/no-sync]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-sync.md}
-*/
-rules[ 'node/no-sync' ] = 'warn';
+ * Warn when using synchronous methods when an asynchronous version exists.
+ *
+ * @name node/no-sync
+ * @memberof rules
+ * @type {string}
+ * @default 'warn'
+ * @see [node/no-sync]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-sync.md}
+ */
+rules["node/no-sync"] = "warn";
/**
-* Disallow `bin` files that npm ignores.
-*
-* @name node/no-unpublished-bin
-* @memberof rules
-* @type {Array}
-* @see [node/no-unpublished-bin]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-unpublished-bin.md}
-*/
-rules[ 'node/no-unpublished-bin' ] = [ 'error' ];
+ * Disallow `bin` files that npm ignores.
+ *
+ * @name node/no-unpublished-bin
+ * @memberof rules
+ * @type {Array}
+ * @see [node/no-unpublished-bin]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-unpublished-bin.md}
+ */
+rules["node/no-unpublished-bin"] = ["error"];
/**
-* Disallow `import` declarations which import private modules.
-*
-* @name node/no-unpublished-import
-* @memberof rules
-* @type {Array}
-* @see [node/no-unpublished-import]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-unpublished-import.md}
-*/
-rules[ 'node/no-unpublished-import' ] = [ 'error', {
- 'allowModules': [],
- 'tryExtensions': [ '.js', '.json', '.node' ]
-}];
+ * Disallow `import` declarations which import private modules.
+ *
+ * @name node/no-unpublished-import
+ * @memberof rules
+ * @type {Array}
+ * @see [node/no-unpublished-import]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-unpublished-import.md}
+ */
+rules["node/no-unpublished-import"] = [
+ "error",
+ {
+ allowModules: [],
+ tryExtensions: [".js", ".json", ".node"],
+ },
+];
/**
-* Disallow `require()` expressions which import private modules.
-*
-* @name node/no-unpublished-require
-* @memberof rules
-* @type {Array}
-* @see [node/no-unpublished-require]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-unpublished-require.md}
-*/
-rules[ 'node/no-unpublished-require' ] = [ 'error', {
- 'allowModules': [],
- 'tryExtensions': [ '.js', '.json', '.node' ]
-}];
+ * Disallow `require()` expressions which import private modules.
+ *
+ * @name node/no-unpublished-require
+ * @memberof rules
+ * @type {Array}
+ * @see [node/no-unpublished-require]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-unpublished-require.md}
+ */
+rules["node/no-unpublished-require"] = [
+ "error",
+ {
+ allowModules: [],
+ tryExtensions: [".js", ".json", ".node"],
+ },
+];
/**
-* Disallow ECMAScript built-ins unsupported by Node.js version 0.12.
-*
-* @name node/no-unsupported-features/es-builtins
-* @memberof rules
-* @type {Array}
-* @see [node/no-unsupported-features/es-builtins]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-unsupported-features/es-builtins.md}
-*/
-rules[ 'node/no-unsupported-features/es-builtins' ] = [ 'error', {
- 'version': '>=0.12.18',
- 'ignores': []
-}];
+ * Disallow ECMAScript built-ins unsupported by Node.js version 0.12.
+ *
+ * @name node/no-unsupported-features/es-builtins
+ * @memberof rules
+ * @type {Array}
+ * @see [node/no-unsupported-features/es-builtins]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-unsupported-features/es-builtins.md}
+ */
+rules["node/no-unsupported-features/es-builtins"] = [
+ "error",
+ {
+ version: ">=0.12.18",
+ ignores: [],
+ },
+];
/**
-* Disallow ECMAScript syntax unsupported by Node.js version 0.12.
-*
-* @name node/no-unsupported-features/es-syntax
-* @memberof rules
-* @type {Array}
-* @see [node/no-unsupported-features/es-syntax]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-unsupported-features/es-syntax.md}
-*/
-rules[ 'node/no-unsupported-features/es-syntax' ] = [ 'error', {
- 'version': '>=0.12.18',
- 'ignores': []
-}];
+ * Disallow ECMAScript syntax unsupported by Node.js version 0.12.
+ *
+ * @name node/no-unsupported-features/es-syntax
+ * @memberof rules
+ * @type {Array}
+ * @see [node/no-unsupported-features/es-syntax]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-unsupported-features/es-syntax.md}
+ */
+rules["node/no-unsupported-features/es-syntax"] = [
+ "error",
+ {
+ version: ">=0.12.18",
+ ignores: [],
+ },
+];
/**
-* Disallow Node.js built-in APIs unsupported by Node.js version 0.12.
-*
-* @name node/no-unsupported-features/node-builtins
-* @memberof rules
-* @type {Array}
-* @see [node/no-unsupported-features/node-builtins]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-unsupported-features/node-builtins.md}
-*/
-rules[ 'node/no-unsupported-features/node-builtins' ] = [ 'error', {
- 'version': '>=0.12.18',
- 'ignores': []
-}];
+ * Disallow Node.js built-in APIs unsupported by Node.js version 0.12.
+ *
+ * @name node/no-unsupported-features/node-builtins
+ * @memberof rules
+ * @type {Array}
+ * @see [node/no-unsupported-features/node-builtins]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-unsupported-features/node-builtins.md}
+ */
+rules["node/no-unsupported-features/node-builtins"] = [
+ "error",
+ {
+ version: ">=0.12.18",
+ ignores: [],
+ },
+];
/**
-* Make ESLint come to address `process.exit()` as throw in code path analysis.
-*
-* @name node/process-exit-as-throw
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [node/process-exit-as-throw]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/process-exit-as-throw.md}
-*/
-rules[ 'node/process-exit-as-throw' ] = 'error';
+ * Make ESLint come to address `process.exit()` as throw in code path analysis.
+ *
+ * @name node/process-exit-as-throw
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [node/process-exit-as-throw]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/process-exit-as-throw.md}
+ */
+rules["node/process-exit-as-throw"] = "error";
/**
-* Suggest correct usage of shebang for `bin` files.
-*
-* @name node/shebang
-* @memberof rules
-* @type {Array}
-* @see [node/shebang]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/shebang.md}
-*/
-rules[ 'node/shebang' ] = [ 'off' ];
-
+ * Suggest correct usage of shebang for `bin` files.
+ *
+ * @name node/shebang
+ * @memberof rules
+ * @type {Array}
+ * @see [node/shebang]{@link https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/shebang.md}
+ */
+rules["node/shebang"] = ["off"];
// EXPORTS //
diff --git a/etc/eslint/rules/programmer_errors.js b/etc/eslint/rules/programmer_errors.js
index 1d315bbf0122..3d77a4a0be9f 100644
--- a/etc/eslint/rules/programmer_errors.js
+++ b/etc/eslint/rules/programmer_errors.js
@@ -1,890 +1,898 @@
/**
-* @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';
-
-/**
-* ESLint rules to catch programmer errors.
-*
-* @namespace rules
-*/
+ * @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";
+
+/**
+ * ESLint rules to catch programmer errors.
+ *
+ * @namespace rules
+ */
var rules = {};
/**
-* Never allow a `for` loop with a stop condition which can never be reached.
-*
-* @name for-direction
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [for-direction]{@link https://eslint.org/docs/rules/for-direction}
-*
-* @example
-* // Bad...
-* var i;
-* for ( i = 0; i < 10; i-- ) {
-* // Do something...
-* }
-*
-* @example
-* // Good...
-* var i;
-* for ( i = 0; i < 10; i++ ) {
-* // Do something...
-* }
-*/
-rules[ 'for-direction' ] = 'error';
-
-/**
-* Require a `return` statement in property getters.
-*
-* @name 'getter-return'
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [getter-return]{@link https://eslint.org/docs/rules/getter-return}
-*
-* @example
-* // Bad...
-* Object.defineProperty( {}, 'foo', {
-* 'get': function get() {
-* // No return...
-* }
-* });
-*
-* @example
-* // Good...
-* Object.defineProperty( {}, 'foo', {
-* 'get': function get() {
-* return 'bar'
-* }
-* });
-*/
-rules[ 'getter-return' ] = 'error';
-
-/**
-* Never allow using an async function as a `Promise` executor.
-*
-* @name no-async-promise-executor)
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-async-promise-executor)]{@link https://eslint.org/docs/rules/no-async-promise-executor}
-*/
-rules[ 'no-async-promise-executor' ] = 'error';
-
-/**
-* Warn when using `await` inside of loops.
-*
-* @name no-await-in-loop
-* @memberof rules
-* @type {string}
-* @default 'warn'
-* @see [no-await-in-loop]{@link https://eslint.org/docs/rules/no-await-in-loop}
-*/
-rules[ 'no-await-in-loop' ] = 'warn';
-
-/**
-* Never allow comparison to negative zero.
-*
-* @name no-compare-neg-zero
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-compare-neg-zero]{@link https://eslint.org/docs/rules/no-compare-neg-zero}
-*
-* @example
-* // Bad...
-* var x;
-* if ( x === -0 ) {
-* // Do something...
-* }
-*/
-rules[ 'no-compare-neg-zero' ] = 'error';
-
-/**
-* Never allow assignment in a conditional statement.
-*
-* @name no-cond-assign
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'always' ]
-* @see [no-cond-assign]{@link https://eslint.org/docs/rules/no-cond-assign}
-*
-* @example
-* // Bad...
-* var x;
-* if ( x = 0 ) {
-* b = 1;
-* }
-*
-* @example
-* // Good...
-* var x;
-* if ( x === 0 ) {
-* b = 1;
-* }
-*/
-rules[ 'no-cond-assign' ] = [ 'error', 'always' ];
-
-/**
-* Warn when using `console` in Node. Consider using a logger instead.
-*
-* @name no-console
-* @memberof rules
-* @type {string}
-* @default 'warn'
-* @see [no-console]{@link https://eslint.org/docs/rules/no-console}
-*
-* @example
-* // Avoid...
-* console.log( 'beep' );
-*
-* @example
-* // Custom logger:
-* debug( 'beep' );
-*/
-rules[ 'no-console' ] = 'warn';
-
-/**
-* Never allow constant expressions in conditions, except in loops.
-*
-* @name no-constant-condition
-* @memberof rules
-* @type {Array}
-* @default [ 'error', {'checkLoops':false} ]
-* @see [no-constant-condition]{@link https://eslint.org/docs/rules/no-constant-condition}
-*
-* @example
-* // Bad...
-* if ( false ) {
-* throw Error( 'beep' );
-* }
-*
-* @example
-* // Okay...
-* while ( true ) {
-* if ( foo === true ) {
-* break;
-* }
-* }
-*/
-rules[ 'no-constant-condition' ] = [ 'error', {
- 'checkLoops': false
-}];
-
-/**
-* Never allow control characters in regular expressions.
-*
-* @name no-control-regex
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-control-regex]{@link https://eslint.org/docs/rules/no-control-regex}
-*
-* @example
-* // Bad...
-* var re = /\x1f/;
-*
-* @example
-* // Good...
-* var re = /\x20/;
-*/
-rules[ 'no-control-regex' ] = 'error';
-
-/**
-* Never allow the `debugger` statement.
-*
-* @name no-debugger
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-debugger]{@link https://eslint.org/docs/rules/no-debugger}
-*
-* @example
-* // Bad...
-* function foo( bool ) {
-* if ( bool === true ) {
-* debugger;
-* return bool;
-* }
-* }
-*
-* @example
-* function foo( bool ) {
-* if ( bool === true ) {
-* return bool;
-* }
-* }
-*/
-rules[ 'no-debugger' ] = 'error';
-
-/**
-* Never allow duplicate parameter names when not in `strict mode`.
-*
-* @name no-dupe-args
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-dupe-args]{@link https://eslint.org/docs/rules/no-dupe-args}
-*
-* @example
-* // Bad...
-* function foo( a, b, a ) {
-* // Do something...
-* }
-*
-* @example
-* // Good...
-* function foo( a, b, c ) {
-* // Do something...
-* }
-*/
-rules[ 'no-dupe-args' ] = 'error';
-
-/**
-* Never allow duplicate keys in object literals, as doing so can lead to unexpected behavior.
-*
-* @name no-dupe-keys
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-dupe-keys]{@link https://eslint.org/docs/rules/no-dupe-keys}
-*
-* @example
-* // Bad...
-* var obj = {
-* 'bar': 'foo',
-* 'bar': 'beep'
-* };
-*
-* @example
-* // Good...
-* var obj = {
-* 'bar': 'foo',
-* 'baz': 'beep'
-* };
-*/
-rules[ 'no-dupe-keys' ] = 'error';
-
-/**
-* Never allow duplicate case labels.
-*
-* @name no-duplicate-case
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-duplicate-case]{@link https://eslint.org/docs/rules/no-duplicate-case}
-*
-* @example
-* // Bad...
-* var x = 1;
-* switch ( x ) {
-* case 1:
-* break;
-* case 2:
-* break;
-* case 1:
-* break;
-* default:
-* break;
-* }
-*
-* @example
-* // Good...
-* var x = 1;
-* switch ( x ) {
-* case 1:
-* break;
-* case 2:
-* break;
-* case 3:
-* break;
-* default:
-* break;
-* }
-*/
-rules[ 'no-duplicate-case' ] = 'error';
-
-/**
-* Never allow empty block statements, including when using `try/catch`.
-*
-* @name no-empty
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-empty]{@link https://eslint.org/docs/rules/no-empty}
-*
-* @example
-* // Bad...
-* if ( a === 'b' ) {}
-*
-* @example
-* // Bad...
-* try {
-* foo();
-* } catch( err ) {}
-*
-* @example
-* // Good...
-* if ( a === 'b' ) {
-* // Do nothing...
-* }
-*
-* @example
-* // Good...
-* try {
-* foo();
-* } catch( err ) {
-* // Do nothing...
-* }
-*/
-rules[ 'no-empty' ] = 'error';
-
-/**
-* Never allow empty character classes in regular expression literals.
-*
-* @name no-empty-character-class
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-empty-character-class]{@link https://eslint.org/docs/rules/no-empty-character-class}
-*
-* @example
-* // Bad...
-* var re = /^abc[]/;
-*
-* @example
-* // Good...
-* var re = /^abc[a-z]/;
-*/
-rules[ 'no-empty-character-class' ] = 'error';
-
-/**
-* Never allow reassignment of an exception parameter in a `catch` block.
-*
-* @name no-ex-assign
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-ex-assign]{@link https://eslint.org/docs/rules/no-ex-assign}
-*
-* @example
-* // Bad...
-* try {
-* foo();
-* } catch( err ) {
-* err = false;
-* }
-*
-* @example
-* // Good...
-* var bool;
-* try {
-* foo();
-* } catch( err ) {
-* bool = false;
-* }
-*/
-rules[ 'no-ex-assign' ] = 'error';
-
-/**
-* Never allow extra boolean casts in an `if` statement.
-*
-* @name no-extra-boolean-cast
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-extra-boolean-cast]{@link https://eslint.org/docs/rules/no-extra-boolean-cast}
-*
-* @example
-* // Bad...
-* if ( !!foo ) {
-* // Do something...
-* }
-*
-* @example
-* // Good...
-* if ( foo ) {
-* // Do something...
-* }
-*/
-rules[ 'no-extra-boolean-cast' ] = 'error';
-
-/**
-* Never allow unnecessary parentheses around function expressions.
-*
-* @name no-extra-parens
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'functions' ]
-* @see [no-extra-parens]{@link https://eslint.org/docs/rules/no-extra-parens}
-*
-* @example
-* // Bad...
-* (function foo() {
-* // Do something...
-* })
-*
-* @example
-* // Good...
-* function foo() {
-* // Do something...
-* }
-*/
-rules[ 'no-extra-parens' ] = [ 'error', 'functions' ];
-
-/**
-* Never allow unnecessary extra semicolons.
-*
-* @name no-extra-semi
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-extra-semi]{@link https://eslint.org/docs/rules/no-extra-semi}
-*
-* @example
-* // Bad...
-* var x = 5;;
-*
-* @example
-* // Good...
-* var x = 5;
-*/
-rules[ 'no-extra-semi' ] = 'error';
-
-/**
-* Never allow reassignment of a FunctionDeclaration.
-*
-* @name no-func-assign
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-func-assign]{@link https://eslint.org/docs/rules/no-func-assign}
-*
-* @example
-* // Bad...
-* function foo() {
-* // Do something...
-* }
-*
-* foo = 'beep';
-*
-* @example
-* // Good...
-* function foo() {
-* // Do something...
-* }
-*
-* var bar = 'beep';
-*/
-rules[ 'no-func-assign' ] = 'error';
-
-/**
-* Never allow assigning to imported bindings.
-*
-* @name no-import-assign
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-import-assign]{@link https://eslint.org/docs/rules/no-import-assign}
-*/
-rules[ 'no-import-assign' ] = 'error';
-
-/**
-* Never allow either function or variable declarations within inner block scopes.
-*
-* @name no-inner-declarations
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'both' ]
-* @see [no-inner-declarations]{@link https://eslint.org/docs/rules/no-inner-declarations}
-*
-* @example
-* // Bad...
-* if ( foo ) {
-* var bar = true;
-* }
-*
-* @example
-* // Good...
-* var bar;
-* if ( foo ) {
-* bar = true;
-* }
-*
-* @example
-* // Bad...
-* if ( foo ) {
-* function bar() {
-* // Do something...
-* }
-* bar();
-* }
-*
-* @example
-* // Good...
-* function bar() {
-* // Do something...
-* }
-*
-* if ( foo ) {
-* bar();
-* }
-*/
-rules[ 'no-inner-declarations' ] = [ 'error', 'both' ];
-
-/**
-* Never allow invalid regular expressions.
-*
-* @name no-invalid-regexp
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-invalid-regexp]{@link https://eslint.org/docs/rules/no-invalid-regexp}
-*
-* @example
-* // Bad...
-* var re = new RegExp( '[' );
-*
-* @example
-* // Good...
-* var re = new RegExp( '[a-z]' );
-*/
-rules[ 'no-invalid-regexp' ] = 'error';
-
-/**
-* Never allow irregular whitespace.
-*
-* @name no-irregular-whitespace
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-irregular-whitespace]{@link https://eslint.org/docs/rules/no-irregular-whitespace}
-*/
-rules[ 'no-irregular-whitespace' ] = 'error';
-
-/**
-* Never allow characters which are made with multiple code points in character class syntax.
-*
-* @name no-misleading-character-class
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-misleading-character-class]{@link https://eslint.org/docs/rules/no-misleading-character-class}
-*
-* @example
-* // Bad...
-* var re = /^[👍]$/;
-*
-* @example
-* // Good...
-* var re = /^[👍]$/u;
-*/
-rules[ 'no-misleading-character-class' ] = 'error';
-
-/**
-* Never allow calling of global objects as functions.
-*
-* @name no-obj-calls
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-obj-calls]{@link https://eslint.org/docs/rules/no-obj-calls}
-*
-* @example
-* // Bad...
-* var math = Math();
-*
-* @example
-* // Good...
-* var math = Math;
-*/
-rules[ 'no-obj-calls' ] = 'error';
-
-/**
-* Never allow direct use of `Object` prototype methods. Use a functional approach instead (i.e., use packages).
-*
-* @name no-prototype-builtins
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-prototype-builtins]{@link https://eslint.org/docs/rules/no-prototype-builtins}
-*
-* @example
-* // Bad...
-* var obj = {};
-* var bool = obj.hasOwnProperty( 'foo' );
-*
-* @example
-* // Good...
-* var obj = {};
-* var bool = Object.prototype.hasOwnProperty.call( obj, 'foo' );
-*/
-rules[ 'no-prototype-builtins' ] = 'error';
-
-/**
-* Never allow multiple consecutive spaces within a regular expression.
-*
-* @name no-regex-spaces
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-regex-spaces]{@link https://eslint.org/docs/rules/no-regex-spaces}
-*
-* @example
-* // Bad...
-* var re = /ab c/;
-*
-* @example
-* // Good...
-* var re = /ab {3}c/;
-*/
-rules[ 'no-regex-spaces' ] = 'error';
-
-/**
-* Never allow a sparse array to be initialized using an array literal and commas.
-*
-* @name no-sparse-arrays
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-sparse-arrays]{@link https://eslint.org/docs/rules/no-sparse-arrays}
-*
-* @example
-* // Bad...
-* var arr = [ 'a', , 'c' ];
-*
-* @example
-* // Good...
-* var arr = new Array( 3 );
-* arr[ 0 ] = 'a';
-* arr[ 2 ] = 'c';
-*/
-rules[ 'no-sparse-arrays' ] = 'error';
-
-/**
-* Allow template literal placeholder syntax in regular strings.
-*
-* @name no-template-curly-in-string
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [no-template-curly-in-string]{@link https://eslint.org/docs/rules/no-template-curly-in-string}
-*
-* @example
-* // Okay...
-* var str = 'Hello, ${name}!';
-*/
-rules[ 'no-template-curly-in-string' ] = 'off';
-
-/**
-* Never allow confusing multiline expressions.
-*
-* @name no-unexpected-multiline
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-unexpected-multiline]{@link https://eslint.org/docs/rules/no-unexpected-multiline}
-*
-* @example
-* // Bad...
-* var name = 'beep'
-* [ 1, 2, 3 ].concat( [ 4, 5, 6 ] );
-*
-* @example
-* // Good...
-* var name = 'beep';
-* [ 1, 2, 3 ].concat( [ 4, 5, 6 ] );
-*/
-rules[ 'no-unexpected-multiline' ] = 'error';
-
-/**
-* Never allow the presence of unreachable code.
-*
-* @name no-unreachable
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-unreachable]{@link https://eslint.org/docs/rules/no-unreachable}
-*
-* @example
-* // Bad...
-* function foo() {
-* return 10;
-* var x = 5;
-* }
-*
-* @example
-* // Good...
-* function foo() {
-* var x = 5;
-* return 10;
-* }
-*
-* @example
-* // Okay...
-* function foo() {
-* return bar();
-* function bar() {
-* return 'beep';
-* }
-* }
-*/
-rules[ 'no-unreachable' ] = 'error';
-
-/**
-* Never allow control flow statements in `finally` blocks.
-*
-* @name no-unsafe-finally
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-unsafe-finally]{@link https://eslint.org/docs/rules/no-unsafe-finally}
-*
-* @example
-* // Bad...
-* function foo() {
-* try {
-* return 1;
-* } catch ( err ) {
-* return 2;
-* } finally {
-* return 3; // 3 is returned before 1
-* }
-* }
-*
-* @example
-* // Good...
-* var bool;
-* function foo() {
-* try {
-* return 1;
-* } catch ( err ) {
-* return 2;
-* } finally {
-* bool = true;
-* }
-* }
-*/
-rules[ 'no-unsafe-finally' ] = 'error';
-
-/**
-* Never allow confusing negation of the left operand of relational operators.
-*
-* @name no-unsafe-negation
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-unsafe-negation]{@link https://eslint.org/docs/rules/no-unsafe-negation}
-*
-* @example
-* // Bad...
-* var x = -4 + 3;
-*
-* @example
-* // Good...
-* var x = 3 - 4;
-*/
-rules[ 'no-unsafe-negation' ] = 'error';
-
-/**
-* Never allow assignments that can lead to race conditions due to usage of await or yield.
-*
-* @name require-atomic-updates
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [require-atomic-updates]{@link https://eslint.org/docs/rules/require-atomic-updates}
-*/
-rules[ 'require-atomic-updates' ] = 'error';
-
-/**
-* Never allow direct comparison with `NaN`.
-*
-* @name use-isnan
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [use-isnan]{@link https://eslint.org/docs/rules/use-isnan}
-*
-* @example
-* // Bad...
-* if ( x === NaN ) {
-* // Do something...
-* }
-*
-* @example
-* // Good...
-* var isnan = require( '@stdlib/math/base/assert/is-nan' );
-* if ( isnan( x ) ) {
-* // Do something...
-* }
-*/
-rules[ 'use-isnan' ] = 'error';
-
-/**
-* Require valid JSDoc.
-*
-* @name valid-jsdoc
-* @memberof rules
-* @type {Array}
-* @see [valid-jsdoc]{@link https://eslint.org/docs/rules/valid-jsdoc}
-*/
-rules[ 'valid-jsdoc' ] = [ 'error', {
- 'prefer': {
- 'arg': 'param',
- 'argument': 'param',
- 'class': 'constructor',
- 'return': 'returns'
+ * Never allow a `for` loop with a stop condition which can never be reached.
+ *
+ * @name for-direction
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [for-direction]{@link https://eslint.org/docs/rules/for-direction}
+ *
+ * @example
+ * // Bad...
+ * var i;
+ * for ( i = 0; i < 10; i-- ) {
+ * // Do something...
+ * }
+ *
+ * @example
+ * // Good...
+ * var i;
+ * for ( i = 0; i < 10; i++ ) {
+ * // Do something...
+ * }
+ */
+rules["for-direction"] = "error";
+
+/**
+ * Require a `return` statement in property getters.
+ *
+ * @name 'getter-return'
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [getter-return]{@link https://eslint.org/docs/rules/getter-return}
+ *
+ * @example
+ * // Bad...
+ * Object.defineProperty( {}, 'foo', {
+ * 'get': function get() {
+ * // No return...
+ * }
+ * });
+ *
+ * @example
+ * // Good...
+ * Object.defineProperty( {}, 'foo', {
+ * 'get': function get() {
+ * return 'bar'
+ * }
+ * });
+ */
+rules["getter-return"] = "error";
+
+/**
+ * Never allow using an async function as a `Promise` executor.
+ *
+ * @name no-async-promise-executor)
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-async-promise-executor)]{@link https://eslint.org/docs/rules/no-async-promise-executor}
+ */
+rules["no-async-promise-executor"] = "error";
+
+/**
+ * Warn when using `await` inside of loops.
+ *
+ * @name no-await-in-loop
+ * @memberof rules
+ * @type {string}
+ * @default 'warn'
+ * @see [no-await-in-loop]{@link https://eslint.org/docs/rules/no-await-in-loop}
+ */
+rules["no-await-in-loop"] = "warn";
+
+/**
+ * Never allow comparison to negative zero.
+ *
+ * @name no-compare-neg-zero
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-compare-neg-zero]{@link https://eslint.org/docs/rules/no-compare-neg-zero}
+ *
+ * @example
+ * // Bad...
+ * var x;
+ * if ( x === -0 ) {
+ * // Do something...
+ * }
+ */
+rules["no-compare-neg-zero"] = "error";
+
+/**
+ * Never allow assignment in a conditional statement.
+ *
+ * @name no-cond-assign
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'always' ]
+ * @see [no-cond-assign]{@link https://eslint.org/docs/rules/no-cond-assign}
+ *
+ * @example
+ * // Bad...
+ * var x;
+ * if ( x = 0 ) {
+ * b = 1;
+ * }
+ *
+ * @example
+ * // Good...
+ * var x;
+ * if ( x === 0 ) {
+ * b = 1;
+ * }
+ */
+rules["no-cond-assign"] = ["error", "always"];
+
+/**
+ * Warn when using `console` in Node. Consider using a logger instead.
+ *
+ * @name no-console
+ * @memberof rules
+ * @type {string}
+ * @default 'warn'
+ * @see [no-console]{@link https://eslint.org/docs/rules/no-console}
+ *
+ * @example
+ * // Avoid...
+ * console.log( 'beep' );
+ *
+ * @example
+ * // Custom logger:
+ * debug( 'beep' );
+ */
+rules["no-console"] = "warn";
+
+/**
+ * Never allow constant expressions in conditions, except in loops.
+ *
+ * @name no-constant-condition
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', {'checkLoops':false} ]
+ * @see [no-constant-condition]{@link https://eslint.org/docs/rules/no-constant-condition}
+ *
+ * @example
+ * // Bad...
+ * if ( false ) {
+ * throw Error( 'beep' );
+ * }
+ *
+ * @example
+ * // Okay...
+ * while ( true ) {
+ * if ( foo === true ) {
+ * break;
+ * }
+ * }
+ */
+rules["no-constant-condition"] = [
+ "error",
+ {
+ checkLoops: false,
},
- 'requireReturn': false,
- 'requireReturnType': true,
- 'matchDescription': '.+',
- 'requireParamDescription': true,
- 'requireReturnDescription': true
-}];
-
-/**
-* Only allow the result of `typeof` to be compared against a select subset of known strings (e.g., 'string', 'undefined', etc.).
-*
-* @name valid-typeof
-* @memberof rules
-* @type {Array}
-* @default [ 'error', {'requireStringLiterals':true} ]
-* @see [valid-typeof]{@link https://eslint.org/docs/rules/valid-typeof}
-*
-* @example
-* // Bad...
-* var bool = ( typeof foo === undefined );
-*
-* @example
-* // Bad...
-* var bool = ( typeof foo === 'undeefined' );
-*
-* @example
-* // Good...
-* var bool = ( typeof foo === 'undefined' );
-*/
-rules[ 'valid-typeof' ] = [ 'error', {
- 'requireStringLiterals': true
-}];
-
+];
+
+/**
+ * Never allow control characters in regular expressions.
+ *
+ * @name no-control-regex
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-control-regex]{@link https://eslint.org/docs/rules/no-control-regex}
+ *
+ * @example
+ * // Bad...
+ * var re = /\x1f/;
+ *
+ * @example
+ * // Good...
+ * var re = /\x20/;
+ */
+rules["no-control-regex"] = "error";
+
+/**
+ * Never allow the `debugger` statement.
+ *
+ * @name no-debugger
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-debugger]{@link https://eslint.org/docs/rules/no-debugger}
+ *
+ * @example
+ * // Bad...
+ * function foo( bool ) {
+ * if ( bool === true ) {
+ * debugger;
+ * return bool;
+ * }
+ * }
+ *
+ * @example
+ * function foo( bool ) {
+ * if ( bool === true ) {
+ * return bool;
+ * }
+ * }
+ */
+rules["no-debugger"] = "error";
+
+/**
+ * Never allow duplicate parameter names when not in `strict mode`.
+ *
+ * @name no-dupe-args
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-dupe-args]{@link https://eslint.org/docs/rules/no-dupe-args}
+ *
+ * @example
+ * // Bad...
+ * function foo( a, b, a ) {
+ * // Do something...
+ * }
+ *
+ * @example
+ * // Good...
+ * function foo( a, b, c ) {
+ * // Do something...
+ * }
+ */
+rules["no-dupe-args"] = "error";
+
+/**
+ * Never allow duplicate keys in object literals, as doing so can lead to unexpected behavior.
+ *
+ * @name no-dupe-keys
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-dupe-keys]{@link https://eslint.org/docs/rules/no-dupe-keys}
+ *
+ * @example
+ * // Bad...
+ * var obj = {
+ * 'bar': 'foo',
+ * 'bar': 'beep'
+ * };
+ *
+ * @example
+ * // Good...
+ * var obj = {
+ * 'bar': 'foo',
+ * 'baz': 'beep'
+ * };
+ */
+rules["no-dupe-keys"] = "error";
+
+/**
+ * Never allow duplicate case labels.
+ *
+ * @name no-duplicate-case
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-duplicate-case]{@link https://eslint.org/docs/rules/no-duplicate-case}
+ *
+ * @example
+ * // Bad...
+ * var x = 1;
+ * switch ( x ) {
+ * case 1:
+ * break;
+ * case 2:
+ * break;
+ * case 1:
+ * break;
+ * default:
+ * break;
+ * }
+ *
+ * @example
+ * // Good...
+ * var x = 1;
+ * switch ( x ) {
+ * case 1:
+ * break;
+ * case 2:
+ * break;
+ * case 3:
+ * break;
+ * default:
+ * break;
+ * }
+ */
+rules["no-duplicate-case"] = "error";
+
+/**
+ * Never allow empty block statements, including when using `try/catch`.
+ *
+ * @name no-empty
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-empty]{@link https://eslint.org/docs/rules/no-empty}
+ *
+ * @example
+ * // Bad...
+ * if ( a === 'b' ) {}
+ *
+ * @example
+ * // Bad...
+ * try {
+ * foo();
+ * } catch( err ) {}
+ *
+ * @example
+ * // Good...
+ * if ( a === 'b' ) {
+ * // Do nothing...
+ * }
+ *
+ * @example
+ * // Good...
+ * try {
+ * foo();
+ * } catch( err ) {
+ * // Do nothing...
+ * }
+ */
+rules["no-empty"] = "error";
+
+/**
+ * Never allow empty character classes in regular expression literals.
+ *
+ * @name no-empty-character-class
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-empty-character-class]{@link https://eslint.org/docs/rules/no-empty-character-class}
+ *
+ * @example
+ * // Bad...
+ * var re = /^abc[]/;
+ *
+ * @example
+ * // Good...
+ * var re = /^abc[a-z]/;
+ */
+rules["no-empty-character-class"] = "error";
+
+/**
+ * Never allow reassignment of an exception parameter in a `catch` block.
+ *
+ * @name no-ex-assign
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-ex-assign]{@link https://eslint.org/docs/rules/no-ex-assign}
+ *
+ * @example
+ * // Bad...
+ * try {
+ * foo();
+ * } catch( err ) {
+ * err = false;
+ * }
+ *
+ * @example
+ * // Good...
+ * var bool;
+ * try {
+ * foo();
+ * } catch( err ) {
+ * bool = false;
+ * }
+ */
+rules["no-ex-assign"] = "error";
+
+/**
+ * Never allow extra boolean casts in an `if` statement.
+ *
+ * @name no-extra-boolean-cast
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-extra-boolean-cast]{@link https://eslint.org/docs/rules/no-extra-boolean-cast}
+ *
+ * @example
+ * // Bad...
+ * if ( !!foo ) {
+ * // Do something...
+ * }
+ *
+ * @example
+ * // Good...
+ * if ( foo ) {
+ * // Do something...
+ * }
+ */
+rules["no-extra-boolean-cast"] = "error";
+
+/**
+ * Never allow unnecessary parentheses around function expressions.
+ *
+ * @name no-extra-parens
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'functions' ]
+ * @see [no-extra-parens]{@link https://eslint.org/docs/rules/no-extra-parens}
+ *
+ * @example
+ * // Bad...
+ * (function foo() {
+ * // Do something...
+ * })
+ *
+ * @example
+ * // Good...
+ * function foo() {
+ * // Do something...
+ * }
+ */
+rules["no-extra-parens"] = ["error", "functions"];
+
+/**
+ * Never allow unnecessary extra semicolons.
+ *
+ * @name no-extra-semi
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-extra-semi]{@link https://eslint.org/docs/rules/no-extra-semi}
+ *
+ * @example
+ * // Bad...
+ * var x = 5;;
+ *
+ * @example
+ * // Good...
+ * var x = 5;
+ */
+rules["no-extra-semi"] = "error";
+
+/**
+ * Never allow reassignment of a FunctionDeclaration.
+ *
+ * @name no-func-assign
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-func-assign]{@link https://eslint.org/docs/rules/no-func-assign}
+ *
+ * @example
+ * // Bad...
+ * function foo() {
+ * // Do something...
+ * }
+ *
+ * foo = 'beep';
+ *
+ * @example
+ * // Good...
+ * function foo() {
+ * // Do something...
+ * }
+ *
+ * var bar = 'beep';
+ */
+rules["no-func-assign"] = "error";
+
+/**
+ * Never allow assigning to imported bindings.
+ *
+ * @name no-import-assign
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-import-assign]{@link https://eslint.org/docs/rules/no-import-assign}
+ */
+rules["no-import-assign"] = "error";
+
+/**
+ * Never allow either function or variable declarations within inner block scopes.
+ *
+ * @name no-inner-declarations
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'both' ]
+ * @see [no-inner-declarations]{@link https://eslint.org/docs/rules/no-inner-declarations}
+ *
+ * @example
+ * // Bad...
+ * if ( foo ) {
+ * var bar = true;
+ * }
+ *
+ * @example
+ * // Good...
+ * var bar;
+ * if ( foo ) {
+ * bar = true;
+ * }
+ *
+ * @example
+ * // Bad...
+ * if ( foo ) {
+ * function bar() {
+ * // Do something...
+ * }
+ * bar();
+ * }
+ *
+ * @example
+ * // Good...
+ * function bar() {
+ * // Do something...
+ * }
+ *
+ * if ( foo ) {
+ * bar();
+ * }
+ */
+rules["no-inner-declarations"] = ["error", "both"];
+
+/**
+ * Never allow invalid regular expressions.
+ *
+ * @name no-invalid-regexp
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-invalid-regexp]{@link https://eslint.org/docs/rules/no-invalid-regexp}
+ *
+ * @example
+ * // Bad...
+ * var re = new RegExp( '[' );
+ *
+ * @example
+ * // Good...
+ * var re = new RegExp( '[a-z]' );
+ */
+rules["no-invalid-regexp"] = "error";
+
+/**
+ * Never allow irregular whitespace.
+ *
+ * @name no-irregular-whitespace
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-irregular-whitespace]{@link https://eslint.org/docs/rules/no-irregular-whitespace}
+ */
+rules["no-irregular-whitespace"] = "error";
+
+/**
+ * Never allow characters which are made with multiple code points in character class syntax.
+ *
+ * @name no-misleading-character-class
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-misleading-character-class]{@link https://eslint.org/docs/rules/no-misleading-character-class}
+ *
+ * @example
+ * // Bad...
+ * var re = /^[👍]$/;
+ *
+ * @example
+ * // Good...
+ * var re = /^[👍]$/u;
+ */
+rules["no-misleading-character-class"] = "error";
+
+/**
+ * Never allow calling of global objects as functions.
+ *
+ * @name no-obj-calls
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-obj-calls]{@link https://eslint.org/docs/rules/no-obj-calls}
+ *
+ * @example
+ * // Bad...
+ * var math = Math();
+ *
+ * @example
+ * // Good...
+ * var math = Math;
+ */
+rules["no-obj-calls"] = "error";
+
+/**
+ * Never allow direct use of `Object` prototype methods. Use a functional approach instead (i.e., use packages).
+ *
+ * @name no-prototype-builtins
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-prototype-builtins]{@link https://eslint.org/docs/rules/no-prototype-builtins}
+ *
+ * @example
+ * // Bad...
+ * var obj = {};
+ * var bool = obj.hasOwnProperty( 'foo' );
+ *
+ * @example
+ * // Good...
+ * var obj = {};
+ * var bool = Object.prototype.hasOwnProperty.call( obj, 'foo' );
+ */
+rules["no-prototype-builtins"] = "error";
+
+/**
+ * Never allow multiple consecutive spaces within a regular expression.
+ *
+ * @name no-regex-spaces
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-regex-spaces]{@link https://eslint.org/docs/rules/no-regex-spaces}
+ *
+ * @example
+ * // Bad...
+ * var re = /ab c/;
+ *
+ * @example
+ * // Good...
+ * var re = /ab {3}c/;
+ */
+rules["no-regex-spaces"] = "error";
+
+/**
+ * Never allow a sparse array to be initialized using an array literal and commas.
+ *
+ * @name no-sparse-arrays
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-sparse-arrays]{@link https://eslint.org/docs/rules/no-sparse-arrays}
+ *
+ * @example
+ * // Bad...
+ * var arr = [ 'a', , 'c' ];
+ *
+ * @example
+ * // Good...
+ * var arr = new Array( 3 );
+ * arr[ 0 ] = 'a';
+ * arr[ 2 ] = 'c';
+ */
+rules["no-sparse-arrays"] = "error";
+
+/**
+ * Allow template literal placeholder syntax in regular strings.
+ *
+ * @name no-template-curly-in-string
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [no-template-curly-in-string]{@link https://eslint.org/docs/rules/no-template-curly-in-string}
+ *
+ * @example
+ * // Okay...
+ * var str = 'Hello, ${name}!';
+ */
+rules["no-template-curly-in-string"] = "off";
+
+/**
+ * Never allow confusing multiline expressions.
+ *
+ * @name no-unexpected-multiline
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-unexpected-multiline]{@link https://eslint.org/docs/rules/no-unexpected-multiline}
+ *
+ * @example
+ * // Bad...
+ * var name = 'beep'
+ * [ 1, 2, 3 ].concat( [ 4, 5, 6 ] );
+ *
+ * @example
+ * // Good...
+ * var name = 'beep';
+ * [ 1, 2, 3 ].concat( [ 4, 5, 6 ] );
+ */
+rules["no-unexpected-multiline"] = "error";
+
+/**
+ * Never allow the presence of unreachable code.
+ *
+ * @name no-unreachable
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-unreachable]{@link https://eslint.org/docs/rules/no-unreachable}
+ *
+ * @example
+ * // Bad...
+ * function foo() {
+ * return 10;
+ * var x = 5;
+ * }
+ *
+ * @example
+ * // Good...
+ * function foo() {
+ * var x = 5;
+ * return 10;
+ * }
+ *
+ * @example
+ * // Okay...
+ * function foo() {
+ * return bar();
+ * function bar() {
+ * return 'beep';
+ * }
+ * }
+ */
+rules["no-unreachable"] = "error";
+
+/**
+ * Never allow control flow statements in `finally` blocks.
+ *
+ * @name no-unsafe-finally
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-unsafe-finally]{@link https://eslint.org/docs/rules/no-unsafe-finally}
+ *
+ * @example
+ * // Bad...
+ * function foo() {
+ * try {
+ * return 1;
+ * } catch ( err ) {
+ * return 2;
+ * } finally {
+ * return 3; // 3 is returned before 1
+ * }
+ * }
+ *
+ * @example
+ * // Good...
+ * var bool;
+ * function foo() {
+ * try {
+ * return 1;
+ * } catch ( err ) {
+ * return 2;
+ * } finally {
+ * bool = true;
+ * }
+ * }
+ */
+rules["no-unsafe-finally"] = "error";
+
+/**
+ * Never allow confusing negation of the left operand of relational operators.
+ *
+ * @name no-unsafe-negation
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-unsafe-negation]{@link https://eslint.org/docs/rules/no-unsafe-negation}
+ *
+ * @example
+ * // Bad...
+ * var x = -4 + 3;
+ *
+ * @example
+ * // Good...
+ * var x = 3 - 4;
+ */
+rules["no-unsafe-negation"] = "error";
+
+/**
+ * Never allow assignments that can lead to race conditions due to usage of await or yield.
+ *
+ * @name require-atomic-updates
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [require-atomic-updates]{@link https://eslint.org/docs/rules/require-atomic-updates}
+ */
+rules["require-atomic-updates"] = "error";
+
+/**
+ * Never allow direct comparison with `NaN`.
+ *
+ * @name use-isnan
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [use-isnan]{@link https://eslint.org/docs/rules/use-isnan}
+ *
+ * @example
+ * // Bad...
+ * if ( x === NaN ) {
+ * // Do something...
+ * }
+ *
+ * @example
+ * // Good...
+ * var isnan = require( '@stdlib/math/base/assert/is-nan' );
+ * if ( isnan( x ) ) {
+ * // Do something...
+ * }
+ */
+rules["use-isnan"] = "error";
+
+/**
+ * Require valid JSDoc.
+ *
+ * @name valid-jsdoc
+ * @memberof rules
+ * @type {Array}
+ * @see [valid-jsdoc]{@link https://eslint.org/docs/rules/valid-jsdoc}
+ */
+rules["valid-jsdoc"] = [
+ "error",
+ {
+ prefer: {
+ arg: "param",
+ argument: "param",
+ class: "constructor",
+ return: "returns",
+ },
+ requireReturn: false,
+ requireReturnType: true,
+ matchDescription: ".+",
+ requireParamDescription: true,
+ requireReturnDescription: true,
+ },
+];
+
+/**
+ * Only allow the result of `typeof` to be compared against a select subset of known strings (e.g., 'string', 'undefined', etc.).
+ *
+ * @name valid-typeof
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', {'requireStringLiterals':true} ]
+ * @see [valid-typeof]{@link https://eslint.org/docs/rules/valid-typeof}
+ *
+ * @example
+ * // Bad...
+ * var bool = ( typeof foo === undefined );
+ *
+ * @example
+ * // Bad...
+ * var bool = ( typeof foo === 'undeefined' );
+ *
+ * @example
+ * // Good...
+ * var bool = ( typeof foo === 'undefined' );
+ */
+rules["valid-typeof"] = [
+ "error",
+ {
+ requireStringLiterals: true,
+ },
+];
// EXPORTS //
diff --git a/etc/eslint/rules/spellcheck.js b/etc/eslint/rules/spellcheck.js
index 8070c80b8c00..e7219e552426 100644
--- a/etc/eslint/rules/spellcheck.js
+++ b/etc/eslint/rules/spellcheck.js
@@ -1,125 +1,127 @@
/**
-* @license Apache-2.0
-*
-* Copyright (c) 2024 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.
-*/
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2024 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';
+"use strict";
/**
-* ESLint rules for spellchecking.
-*
-* @namespace rules
-*/
+ * ESLint rules for spellchecking.
+ *
+ * @namespace rules
+ */
var rules = {};
/**
-* Warn when encountering potentially misspelled words in comments and strings.
-*
-* @name @cspell/spellchecker
-* @memberof rules
-* @type {Array}
-* @see [spellchecker]{@link https://www.npmjs.com/package/@cspell/eslint-plugin}
-*
-* @example
-* // Bad...
-* var str = 'Functionl programming is a paradigm...';
-*
-* @example
-* // Good...
-* var str = 'Functional programming is a paradigm...';
-*/
-rules[ '@cspell/spellchecker' ] = [ 'warn', {
- 'checkComments': true,
- 'checkStrings': true,
- 'autoFix': false,
- 'checkIdentifiers': false,
- 'cspell': {
- 'allowCompoundWords': true,
- 'ignoreRegExpList': [
- '/[a-z0-9.]+\\(/gi', // ignore functions or methods invoked in comments
- '/var [a-zA-Z0-9]+/g', // ignore variable declarations
- '/[A-Z][a-z]+/g', // ignore proper nouns
- '/[A-Z]+/g', // ignore acronyms
- '/@stdlib\\/[a-z0-9/-]+/g', // ignore stdlib package paths
- '/@name [a-zA-Z0-9]+/g', // ignore identifier names in JSDoc
- '/\\/\\/ returns \'[^\']+\'/g', // ignore return value annotations
- '/setReadOnly\\( [.a-z0-9]+, \'[^\']+?\'/gi', // ignore namespace or prototype assignments
- '/```[\\s\\S]+?```/g', // ignore code blocks
- '/(?<!`)`[^`]+?`(?!`)/g', // ignore inline code
- '/\\\\{2,2}\\([\\s\\S]+?\\\\{2,2}\\)/g', // ignore LaTeX math expressions
- '/\\[[^\\]]+\\]/g', // ignore character classes in regular expressions or markdown links
- '/\\/\\/ exports: \\{[^}]+\\}/g', // ignore export annotations
- '/@param \\{[^}]+\\} [?[a-zA-Z0-9.]+]? -/g', // ignore parameter annotations in JSDoc
- '/@returns \\{[^}]+?\\}/g', // ignore returns annotations in JSDoc
- '/[xy][a-z]+/g', // lowercase parameters starting with x or y (e.g., xbuf)
- '/[a-z]+[xy]/g', // lowercase parameters ending with x or y (e.g., meanx)
- '/([\'"`])(.*/.*?)\\1/g', // ignore file paths
- '/\'[-\\w]+?\'/g' // ignore single-quoted strings containing only word characters or hyphens
- ],
- 'words': [
- 'BLAS',
- 'bonferroni',
- 'boop',
- 'clbk',
- 'congruential',
- 'convergents',
- 'coversed',
- 'dilogarithm',
- 'dtype',
- 'dtypes',
- 'exponentiated',
- 'evalpoly',
- 'evalrational',
- 'hommel',
- 'iget',
- 'iset',
- 'logcdf',
- 'logit',
- 'logpdf',
- 'logpmf',
- 'lpad',
- 'ltrim',
- 'napi',
- 'nargs',
- 'ncols',
- 'ndims',
- 'ndim',
- 'nout',
- 'ndarray',
- 'ndarrays',
- 'nrows',
- 'nsubmodes',
- 'pvalues',
- 'randn',
- 'randu',
- 'rpad',
- 'rtrim',
- 'significand',
- 'stdev',
- 'strided',
- 'stringifying',
- 'studentized',
- 'tricube',
- 'trigamma',
- 'uncapitalize',
- 'unregularized'
- ]
- }
-}];
-
+ * Warn when encountering potentially misspelled words in comments and strings.
+ *
+ * @name @cspell/spellchecker
+ * @memberof rules
+ * @type {Array}
+ * @see [spellchecker]{@link https://www.npmjs.com/package/@cspell/eslint-plugin}
+ *
+ * @example
+ * // Bad...
+ * var str = 'Functionl programming is a paradigm...';
+ *
+ * @example
+ * // Good...
+ * var str = 'Functional programming is a paradigm...';
+ */
+rules["@cspell/spellchecker"] = [
+ "warn",
+ {
+ checkComments: true,
+ checkStrings: true,
+ autoFix: false,
+ checkIdentifiers: false,
+ cspell: {
+ allowCompoundWords: true,
+ ignoreRegExpList: [
+ "/[a-z0-9.]+\\(/gi", // ignore functions or methods invoked in comments
+ "/var [a-zA-Z0-9]+/g", // ignore variable declarations
+ "/[A-Z][a-z]+/g", // ignore proper nouns
+ "/[A-Z]+/g", // ignore acronyms
+ "/@stdlib\\/[a-z0-9/-]+/g", // ignore stdlib package paths
+ "/@name [a-zA-Z0-9]+/g", // ignore identifier names in JSDoc
+ "/\\/\\/ returns '[^']+'/g", // ignore return value annotations
+ "/setReadOnly\\( [.a-z0-9]+, '[^']+?'/gi", // ignore namespace or prototype assignments
+ "/```[\\s\\S]+?```/g", // ignore code blocks
+ "/(?<!`)`[^`]+?`(?!`)/g", // ignore inline code
+ "/\\\\{2,2}\\([\\s\\S]+?\\\\{2,2}\\)/g", // ignore LaTeX math expressions
+ "/\\[[^\\]]+\\]/g", // ignore character classes in regular expressions or markdown links
+ "/\\/\\/ exports: \\{[^}]+\\}/g", // ignore export annotations
+ "/@param \\{[^}]+\\} [?[a-zA-Z0-9.]+]? -/g", // ignore parameter annotations in JSDoc
+ "/@returns \\{[^}]+?\\}/g", // ignore returns annotations in JSDoc
+ "/[xy][a-z]+/g", // lowercase parameters starting with x or y (e.g., xbuf)
+ "/[a-z]+[xy]/g", // lowercase parameters ending with x or y (e.g., meanx)
+ "/(['\"`])(.*/.*?)\\1/g", // ignore file paths
+ "/'[-\\w]+?'/g", // ignore single-quoted strings containing only word characters or hyphens
+ ],
+ words: [
+ "BLAS",
+ "bonferroni",
+ "boop",
+ "clbk",
+ "congruential",
+ "convergents",
+ "coversed",
+ "dilogarithm",
+ "dtype",
+ "dtypes",
+ "exponentiated",
+ "evalpoly",
+ "evalrational",
+ "hommel",
+ "iget",
+ "iset",
+ "logcdf",
+ "logit",
+ "logpdf",
+ "logpmf",
+ "lpad",
+ "ltrim",
+ "napi",
+ "nargs",
+ "ncols",
+ "ndims",
+ "ndim",
+ "nout",
+ "ndarray",
+ "ndarrays",
+ "nrows",
+ "nsubmodes",
+ "pvalues",
+ "randn",
+ "randu",
+ "rpad",
+ "rtrim",
+ "significand",
+ "stdev",
+ "strided",
+ "stringifying",
+ "studentized",
+ "tricube",
+ "trigamma",
+ "uncapitalize",
+ "unregularized",
+ ],
+ },
+ },
+];
// EXPORTS //
diff --git a/etc/eslint/rules/stdlib.js b/etc/eslint/rules/stdlib.js
index 58bf584b845a..6e53e651904c 100644
--- a/etc/eslint/rules/stdlib.js
+++ b/etc/eslint/rules/stdlib.js
@@ -1,4849 +1,4865 @@
/* eslint-disable stdlib/jsdoc-doctest-marker, stdlib/jsdoc-doctest, stdlib/jsdoc-example-require-spacing, stdlib/jsdoc-no-tabs */
/**
-* @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.
-*/
+ * @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';
+"use strict";
/**
-* ESLint rules specific to stdlib.
-*
-* @namespace rules
-*/
+ * ESLint rules specific to stdlib.
+ *
+ * @namespace rules
+ */
var rules = {};
/**
-* Require that comments start with an uppercase letter.
-*
-* @name capitalized-comments
-* @memberof rules
-* @type {string}
-*
-* @example
-* // Bad...
-* function square( x ) {
-* var out;
-*
-* // square the number:
-* out = x*x;
-* return out;
-* }
-*
-* @example
-* // Good...
-* function square( x ) {
-* var out;
-*
-* // Square the number:
-* out = x*x;
-* return out;
-* }
-*/
-rules[ 'stdlib/capitalized-comments' ] = [ 'warn', {
- 'whitelist': [
- 'eslint',
- 'eslint-enable',
- 'eslint-enable-next-line',
- 'eslint-disable',
- 'eslint-disable-next-line',
- 'returns',
- 'e.g.,',
- 'ndarray',
- 'rehype',
- 'remark',
- 'stdlib',
- 'throws'
- ]
-}];
+ * Require that comments start with an uppercase letter.
+ *
+ * @name capitalized-comments
+ * @memberof rules
+ * @type {string}
+ *
+ * @example
+ * // Bad...
+ * function square( x ) {
+ * var out;
+ *
+ * // square the number:
+ * out = x*x;
+ * return out;
+ * }
+ *
+ * @example
+ * // Good...
+ * function square( x ) {
+ * var out;
+ *
+ * // Square the number:
+ * out = x*x;
+ * return out;
+ * }
+ */
+rules["stdlib/capitalized-comments"] = [
+ "warn",
+ {
+ whitelist: [
+ "eslint",
+ "eslint-enable",
+ "eslint-enable-next-line",
+ "eslint-disable",
+ "eslint-disable-next-line",
+ "returns",
+ "e.g.,",
+ "ndarray",
+ "rehype",
+ "remark",
+ "stdlib",
+ "throws",
+ ],
+ },
+];
/**
-* Enforce that return annotation values match actual output.
-*
-* @name doctest
-* @memberof rules
-* @type {string}
-* @default 'off'
-*
-* @example
-* // Bad...
-* var x = 3.0;
-* // returns 2.0
-*
-* console.log( 'Hello World' );
-* // returns 'hello world'
-*
-* @example
-* // Good...
-* var x = 3.0;
-* // returns 3.0
-*
-* console.log( 'Hello World' );
-* // returns 'Hello World'
-*/
-rules[ 'stdlib/doctest' ] = 'off';
+ * Enforce that return annotation values match actual output.
+ *
+ * @name doctest
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ *
+ * @example
+ * // Bad...
+ * var x = 3.0;
+ * // returns 2.0
+ *
+ * console.log( 'Hello World' );
+ * // returns 'hello world'
+ *
+ * @example
+ * // Good...
+ * var x = 3.0;
+ * // returns 3.0
+ *
+ * console.log( 'Hello World' );
+ * // returns 'Hello World'
+ */
+rules["stdlib/doctest"] = "off";
/**
-* Enforce marker style conventions for return annotations.
-*
-* @name doctest-marker
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-* var x = 3.0;
-* // => 3.0
-*
-* console.log( 'Hello World' );
-* // returns 'Hello World'
-*
-* // => null
-*
-* @example
-* // Good...
-* var x = 3.0;
-* // returns 3.0
-*
-* console.log( 'Hello World' );
-* // => 'Hello World'
-*/
-rules[ 'stdlib/doctest-marker' ] = 'error';
+ * Enforce marker style conventions for return annotations.
+ *
+ * @name doctest-marker
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ * var x = 3.0;
+ * // => 3.0
+ *
+ * console.log( 'Hello World' );
+ * // returns 'Hello World'
+ *
+ * // => null
+ *
+ * @example
+ * // Good...
+ * var x = 3.0;
+ * // returns 3.0
+ *
+ * console.log( 'Hello World' );
+ * // => 'Hello World'
+ */
+rules["stdlib/doctest-marker"] = "error";
/* eslint-disable stdlib/jsdoc-doctest-quote-props */
/**
-* Enforce that property names in return annotations are quoted.
-*
-* @name doctest-quote-props
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-* var value = {
-* 'a': 1,
-* 'b': true,
-* 'c': [ 1, 2, 3 ]
-* };
-* var out = copy( value );
-* /* returns
-* {
-* a: 1,
-* b: true,
-* c: [ 1, 2, 3 ]
-* }
-* *\/
-*
-* @example
-* // Good...
-* var value = {
-* 'a': 1,
-* 'b': true,
-* 'c': [ 1, 2, 3 ]
-* };
-* var out = copy( value );
-* /* returns
-* {
-* 'a': 1,
-* 'b': true,
-* 'c': [ 1, 2, 3 ]
-* }
-* *\/
-*/
-rules[ 'stdlib/doctest-quote-props' ] = 'error';
+ * Enforce that property names in return annotations are quoted.
+ *
+ * @name doctest-quote-props
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ * var value = {
+ * 'a': 1,
+ * 'b': true,
+ * 'c': [ 1, 2, 3 ]
+ * };
+ * var out = copy( value );
+ * /* returns
+ * {
+ * a: 1,
+ * b: true,
+ * c: [ 1, 2, 3 ]
+ * }
+ * *\/
+ *
+ * @example
+ * // Good...
+ * var value = {
+ * 'a': 1,
+ * 'b': true,
+ * 'c': [ 1, 2, 3 ]
+ * };
+ * var out = copy( value );
+ * /* returns
+ * {
+ * 'a': 1,
+ * 'b': true,
+ * 'c': [ 1, 2, 3 ]
+ * }
+ * *\/
+ */
+rules["stdlib/doctest-quote-props"] = "error";
/* eslint-enable stdlib/jsdoc-doctest-quote-props */
/**
-* Require an empty line before single-line comments.
-*
-* @name empty-line-before-comment
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-* function square( x ) {
-* var out;
-* // Square the number:
-* out = x*x;
-* return out;
-* }
-*
-* @example
-* // Good...
-* function square( x ) {
-* var out;
-*
-* // Square the number:
-* out = x*x;
-* return out;
-* }
-*/
-rules[ 'stdlib/empty-line-before-comment' ] = 'error';
+ * Require an empty line before single-line comments.
+ *
+ * @name empty-line-before-comment
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ * function square( x ) {
+ * var out;
+ * // Square the number:
+ * out = x*x;
+ * return out;
+ * }
+ *
+ * @example
+ * // Good...
+ * function square( x ) {
+ * var out;
+ *
+ * // Square the number:
+ * out = x*x;
+ * return out;
+ * }
+ */
+rules["stdlib/empty-line-before-comment"] = "error";
/**
-* Disallow spaces between an opening parenthesis or bracket and a nested object or array expression at the end of a line.
-*
-* @name eol-open-bracket-spacing
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-* var log = require( '@stdlib/console/log' );
-*
-* log( {
-* 'foo': true
-* });
-*
-* log( [
-* 1,
-* 2,
-* 3
-* ]);
-*
-* log( [ {
-* 'bar': true
-* }]);
-*
-* @example
-* // Good...
-* var log = require( '@stdlib/console/log' );
-*
-* log({
-* 'foo': true
-* });
-*
-* log([
-* 1,
-* 2,
-* 3
-* ]);
-*
-* log([{
-* 'bar': true
-* }]);
-*/
-rules[ 'stdlib/eol-open-bracket-spacing' ] = 'error';
+ * Disallow spaces between an opening parenthesis or bracket and a nested object or array expression at the end of a line.
+ *
+ * @name eol-open-bracket-spacing
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ * var log = require( '@stdlib/console/log' );
+ *
+ * log( {
+ * 'foo': true
+ * });
+ *
+ * log( [
+ * 1,
+ * 2,
+ * 3
+ * ]);
+ *
+ * log( [ {
+ * 'bar': true
+ * }]);
+ *
+ * @example
+ * // Good...
+ * var log = require( '@stdlib/console/log' );
+ *
+ * log({
+ * 'foo': true
+ * });
+ *
+ * log([
+ * 1,
+ * 2,
+ * 3
+ * ]);
+ *
+ * log([{
+ * 'bar': true
+ * }]);
+ */
+rules["stdlib/eol-open-bracket-spacing"] = "error";
/**
-* Require blockquotes to have `2` character indentation.
-*
-* @name jsdoc-blockquote-indentation
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 2 ]
-* @see [blockquote-indentation]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-blockquote-indentation}
-*
-* @example
-* // Bad...
-*
-* /**
-* * Squares a number.
-* *
-* * > This is a blockquote.
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Squares a number.
-* *
-* * > This is a blockquote.
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*/
-rules[ 'stdlib/jsdoc-blockquote-indentation' ] = [ 'error', 2 ];
+ * Require blockquotes to have `2` character indentation.
+ *
+ * @name jsdoc-blockquote-indentation
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 2 ]
+ * @see [blockquote-indentation]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-blockquote-indentation}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * > This is a blockquote.
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * > This is a blockquote.
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ */
+rules["stdlib/jsdoc-blockquote-indentation"] = ["error", 2];
/**
-* Require checkboxes to be either empty (unchecked) or have an `x` (checked).
-*
-* @name jsdoc-checkbox-character-style
-* @memberof rules
-* @type {Array}
-* @see [checkbox-character-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-checkbox-character-style}
-*
-* @example
-* // Bad...
-*
-* /**
-* * Squares a number.
-* *
-* * - [X] Item
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Squares a number.
-* *
-* * - [x] Item
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*/
-rules[ 'stdlib/jsdoc-checkbox-character-style' ] = [
- 'error',
+ * Require checkboxes to be either empty (unchecked) or have an `x` (checked).
+ *
+ * @name jsdoc-checkbox-character-style
+ * @memberof rules
+ * @type {Array}
+ * @see [checkbox-character-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-checkbox-character-style}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * - [X] Item
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * - [x] Item
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ */
+rules["stdlib/jsdoc-checkbox-character-style"] = [
+ "error",
{
- 'checked': 'x',
- 'unchecked': ' '
- }
+ checked: "x",
+ unchecked: " ",
+ },
];
/**
-* Prevent checkboxes being followed by too much whitespace.
-*
-* @name jsdoc-checkbox-content-indent
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [checkbox-content-indent]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-checkbox-content-indent}
-*
-* @example
-* // Bad...
-*
-* /**
-* * Squares a number.
-* *
-* * - [ ] Item
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Squares a number.
-* *
-* * - [ ] Item
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*/
-rules[ 'stdlib/jsdoc-checkbox-content-indent' ] = 'error';
+ * Prevent checkboxes being followed by too much whitespace.
+ *
+ * @name jsdoc-checkbox-content-indent
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [checkbox-content-indent]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-checkbox-content-indent}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * - [ ] Item
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * - [ ] Item
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ */
+rules["stdlib/jsdoc-checkbox-content-indent"] = "error";
/**
-* Require `fenced` code block style.
-*
-* @name jsdoc-code-block-style
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'fenced' ]
-* @see [code-block-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-code-block-style}
-*
-* @example
-* // Bad...
-*
-* /**
-* * Squares a number.
-* *
-* * y = x;
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Squares a number.
-* *
-* * ```javascript
-* * y = x;
-* * ```
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*/
-rules[ 'stdlib/jsdoc-code-block-style' ] = [ 'error', 'fenced' ];
+ * Require `fenced` code block style.
+ *
+ * @name jsdoc-code-block-style
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'fenced' ]
+ * @see [code-block-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-code-block-style}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * y = x;
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * ```javascript
+ * * y = x;
+ * * ```
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ */
+rules["stdlib/jsdoc-code-block-style"] = ["error", "fenced"];
/**
-* Require fenced code blocks to have a language flag.
-*
-* @name jsdoc-fenced-code-flag
-* @memberof rules
-* @type {Array}
-* @see [fenced-code-flag]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-fenced-code-flag}
-*
-* @example
-* // Bad...
-*
-* /**
-* * Squares a number.
-* *
-* * ```
-* * y = x;
-* * ```
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Squares a number.
-* *
-* * ```javascript
-* * y = x;
-* * ```
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*/
-rules[ 'stdlib/jsdoc-fenced-code-flag' ] = [
- 'error', {
- 'allowEmpty': false
- }
+ * Require fenced code blocks to have a language flag.
+ *
+ * @name jsdoc-fenced-code-flag
+ * @memberof rules
+ * @type {Array}
+ * @see [fenced-code-flag]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-fenced-code-flag}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * ```
+ * * y = x;
+ * * ```
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * ```javascript
+ * * y = x;
+ * * ```
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ */
+rules["stdlib/jsdoc-fenced-code-flag"] = [
+ "error",
+ {
+ allowEmpty: false,
+ },
];
/**
-* Require lowercased definition labels.
-*
-* @name jsdoc-definition-case
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [definition-case]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-definition-case}
-*
-* @example
-* // Bad...
-*
-* /**
-* * Squares a [number][Number].
-* *
-* * [Number]: https://example.com
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Squares a [number][number].
-* *
-* * [number]: https://example.com
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*/
-rules[ 'stdlib/jsdoc-definition-case' ] = 'error';
+ * Require lowercased definition labels.
+ *
+ * @name jsdoc-definition-case
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [definition-case]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-definition-case}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Squares a [number][Number].
+ * *
+ * * [Number]: https://example.com
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Squares a [number][number].
+ * *
+ * * [number]: https://example.com
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ */
+rules["stdlib/jsdoc-definition-case"] = "error";
/**
-* Prevent consecutive whitespace in a definition.
-*
-* @name jsdoc-definition-spacing
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [definition-spacing]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-definition-spacing}
-*
-* @example
-* // Bad...
-*
-* /**
-* * Squares a [number][number documentation].
-* *
-* * [number documentation]: https://example.com
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Squares a [number][number documentation].
-* *
-* * [number documentation]: https://example.com
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*/
-rules[ 'stdlib/jsdoc-definition-spacing' ] = 'error';
+ * Prevent consecutive whitespace in a definition.
+ *
+ * @name jsdoc-definition-spacing
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [definition-spacing]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-definition-spacing}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Squares a [number][number documentation].
+ * *
+ * * [number documentation]: https://example.com
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Squares a [number][number documentation].
+ * *
+ * * [number documentation]: https://example.com
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ */
+rules["stdlib/jsdoc-definition-spacing"] = "error";
/**
-* Ensure that return annotations in JSDoc examples match the actual output.
-*
-* @name jsdoc-doctest
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-* /**
-* * Squares a number.
-* *
-* * @param {number} x - input value
-* * @returns {number} x*x
-* *
-* * @example
-* * var y = square( 3.0 );
-* * // returns 12.0
-* *
-* * y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*
-* @example
-* // Good...
-* /**
-* * Squares a number.
-* *
-* * @param {number} x - input value
-* * @returns {number} x*x
-* *
-* * @example
-* * var y = square( 3.0 );
-* * // returns 9.0
-* *
-* * y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*/
-rules[ 'stdlib/jsdoc-doctest' ] = 'error';
+ * Ensure that return annotations in JSDoc examples match the actual output.
+ *
+ * @name jsdoc-doctest
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ * /**
+ * * Squares a number.
+ * *
+ * * @param {number} x - input value
+ * * @returns {number} x*x
+ * *
+ * * @example
+ * * var y = square( 3.0 );
+ * * // returns 12.0
+ * *
+ * * y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ *
+ * @example
+ * // Good...
+ * /**
+ * * Squares a number.
+ * *
+ * * @param {number} x - input value
+ * * @returns {number} x*x
+ * *
+ * * @example
+ * * var y = square( 3.0 );
+ * * // returns 9.0
+ * *
+ * * y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ */
+rules["stdlib/jsdoc-doctest"] = "error";
/**
-* Ensure that only return annotations for real-valued return values always contain decimal points.
-*
-* @name jsdoc-doctest-decimal-point
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-* /**
-* * Squares a number.
-* *
-* * @param {number} x - input value
-* * @returns {number} x*x
-* *
-* * @example
-* * var y = square( 3.0 );
-* * // returns 9
-* *
-* * y = square( 2.0 );
-* * // returns 4
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*
-* @example
-* // Good...
-* /**
-* * Squares a number.
-* *
-* * @param {number} x - input value
-* * @returns {number} x*x
-* *
-* * @example
-* * var y = square( 3.0 );
-* * // returns 9.0
-* *
-* * y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*/
-rules[ 'stdlib/jsdoc-doctest-decimal-point' ] = 'error';
+ * Ensure that only return annotations for real-valued return values always contain decimal points.
+ *
+ * @name jsdoc-doctest-decimal-point
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ * /**
+ * * Squares a number.
+ * *
+ * * @param {number} x - input value
+ * * @returns {number} x*x
+ * *
+ * * @example
+ * * var y = square( 3.0 );
+ * * // returns 9
+ * *
+ * * y = square( 2.0 );
+ * * // returns 4
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ *
+ * @example
+ * // Good...
+ * /**
+ * * Squares a number.
+ * *
+ * * @param {number} x - input value
+ * * @returns {number} x*x
+ * *
+ * * @example
+ * * var y = square( 3.0 );
+ * * // returns 9.0
+ * *
+ * * y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ */
+rules["stdlib/jsdoc-doctest-decimal-point"] = "error";
/**
-* Enforce marker style conventions for return annotations in JSDoc examples.
-*
-* @name jsdoc-doctest-marker
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-* /**
-* * Squares a number.
-* *
-* * @param {number} x - input value
-* * @returns {number} x*x
-* *
-* * @example
-* * var y = square( 3.0 );
-* * // => 9.0
-* *
-* * console.log( square( 2.0 ) );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*
-* @example
-* // Good...
-* /**
-* * Squares a number.
-* *
-* * @param {number} x - input value
-* * @returns {number} x*x
-* *
-* * @example
-* * var y = square( 3.0 );
-* * // returns 9.0
-* *
-* * console.log( square( 2.0 ) );
-* * // => 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*/
-rules[ 'stdlib/jsdoc-doctest-marker' ] = 'error';
+ * Enforce marker style conventions for return annotations in JSDoc examples.
+ *
+ * @name jsdoc-doctest-marker
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ * /**
+ * * Squares a number.
+ * *
+ * * @param {number} x - input value
+ * * @returns {number} x*x
+ * *
+ * * @example
+ * * var y = square( 3.0 );
+ * * // => 9.0
+ * *
+ * * console.log( square( 2.0 ) );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ *
+ * @example
+ * // Good...
+ * /**
+ * * Squares a number.
+ * *
+ * * @param {number} x - input value
+ * * @returns {number} x*x
+ * *
+ * * @example
+ * * var y = square( 3.0 );
+ * * // returns 9.0
+ * *
+ * * console.log( square( 2.0 ) );
+ * * // => 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ */
+rules["stdlib/jsdoc-doctest-marker"] = "error";
/**
-* Require `_` be used as the emphasis marker.
-*
-* @name jsdoc-emphasis-marker
-* @memberof rules
-* @type {Array}
-* @default [ 'error', '_' ]
-* @see [emphasis-marker]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-emphasis-marker}
-*
-* @example
-* // Bad...
-*
-* /**
-* * Squares a *number*.
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Squares a _number_.
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*/
-rules[ 'stdlib/jsdoc-emphasis-marker' ] = [ 'error', '_' ];
+ * Require `_` be used as the emphasis marker.
+ *
+ * @name jsdoc-emphasis-marker
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', '_' ]
+ * @see [emphasis-marker]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-emphasis-marker}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Squares a *number*.
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Squares a _number_.
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ */
+rules["stdlib/jsdoc-emphasis-marker"] = ["error", "_"];
/**
-* Require empty lines before `@example` tags in JSDoc comments.
-*
-* @name jsdoc-empty-line-before-example
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-*
-* /**
-* * Rounds a numeric value toward positive infinity.
-* *
-* * @param {number} x - input value
-* * @returns {number} rounded value
-* * @example
-* * var v = ceil( -4.2 );
-* * // returns -4.0
-* * @example
-* * var v = ceil( 9.99999 );
-* * // returns 10.0
-* *\/
-* var ceil = Math.ceil;
-*
-* @example
-* // Good...
-*
-* /**
-* * Rounds a numeric value toward positive infinity.
-* *
-* * @param {number} x - input value
-* * @returns {number} rounded value
-* *
-* * @example
-* * var v = ceil( -4.2 );
-* * // returns -4.0
-* *
-* * @example
-* * var v = ceil( 9.99999 );
-* * // returns 10.0
-* *\/
-* var ceil = Math.ceil;
-*/
-rules[ 'stdlib/jsdoc-empty-line-before-example' ] = 'error';
+ * Require empty lines before `@example` tags in JSDoc comments.
+ *
+ * @name jsdoc-empty-line-before-example
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Rounds a numeric value toward positive infinity.
+ * *
+ * * @param {number} x - input value
+ * * @returns {number} rounded value
+ * * @example
+ * * var v = ceil( -4.2 );
+ * * // returns -4.0
+ * * @example
+ * * var v = ceil( 9.99999 );
+ * * // returns 10.0
+ * *\/
+ * var ceil = Math.ceil;
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Rounds a numeric value toward positive infinity.
+ * *
+ * * @param {number} x - input value
+ * * @returns {number} rounded value
+ * *
+ * * @example
+ * * var v = ceil( -4.2 );
+ * * // returns -4.0
+ * *
+ * * @example
+ * * var v = ceil( 9.99999 );
+ * * // returns 10.0
+ * *\/
+ * var ceil = Math.ceil;
+ */
+rules["stdlib/jsdoc-empty-line-before-example"] = "error";
/**
-* Enforce empty lines between requires and code in JSDoc examples.
-*
-* @name jsdoc-example-require-spacing
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-*
-* /**
-* * Fréchet distribution constructor.
-* *
-* * @module @stdlib/stats/base/dists/frechet/ctor
-* *
-* * @example
-* * var Frechet = require( '@stdlib/stats/base/dists/frechet/ctor' );
-* * var frechet = new Frechet( 1.0, 1.0, 0.5 );
-* *
-* * var y = frechet.cdf( 0.8 );
-* * // returns ~0.036
-* *\/
-*
-* @example
-* // Good...
-*
-* /**
-* * Fréchet distribution constructor.
-* *
-* * @module @stdlib/stats/base/dists/frechet/ctor
-* *
-* * @example
-* * var Frechet = require( '@stdlib/stats/base/dists/frechet/ctor' );
-* *
-* * var frechet = new Frechet( 1.0, 1.0, 0.5 );
-* *
-* * var y = frechet.cdf( 0.8 );
-* * // returns ~0.036
-* *\/
-*/
-rules[ 'stdlib/jsdoc-example-require-spacing' ] = 'error';
+ * Enforce empty lines between requires and code in JSDoc examples.
+ *
+ * @name jsdoc-example-require-spacing
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Fréchet distribution constructor.
+ * *
+ * * @module @stdlib/stats/base/dists/frechet/ctor
+ * *
+ * * @example
+ * * var Frechet = require( '@stdlib/stats/base/dists/frechet/ctor' );
+ * * var frechet = new Frechet( 1.0, 1.0, 0.5 );
+ * *
+ * * var y = frechet.cdf( 0.8 );
+ * * // returns ~0.036
+ * *\/
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Fréchet distribution constructor.
+ * *
+ * * @module @stdlib/stats/base/dists/frechet/ctor
+ * *
+ * * @example
+ * * var Frechet = require( '@stdlib/stats/base/dists/frechet/ctor' );
+ * *
+ * * var frechet = new Frechet( 1.0, 1.0, 0.5 );
+ * *
+ * * var y = frechet.cdf( 0.8 );
+ * * // returns ~0.036
+ * *\/
+ */
+rules["stdlib/jsdoc-example-require-spacing"] = "error";
/**
-* Require `\`` be used as the fenced code marker.
-*
-* @name jsdoc-fenced-code-marker
-* @memberof rules
-* @type {Array}
-* @default [ 'error', '`' ]
-* @see [fenced-code-marker]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-fenced-code-marker}
-*
-* @example
-* // Bad...
-*
-* /**
-* * Squares a number.
-* *
-* * ~~~javascript
-* * y = x;
-* * ~~~
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Squares a number.
-* *
-* * ```javascript
-* * y = x;
-* * ```
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*/
-rules[ 'stdlib/jsdoc-fenced-code-marker' ] = [ 'error', '`' ];
+ * Require `\`` be used as the fenced code marker.
+ *
+ * @name jsdoc-fenced-code-marker
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', '`' ]
+ * @see [fenced-code-marker]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-fenced-code-marker}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * ~~~javascript
+ * * y = x;
+ * * ~~~
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * ```javascript
+ * * y = x;
+ * * ```
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ */
+rules["stdlib/jsdoc-fenced-code-marker"] = ["error", "`"];
/**
-* Require definitions be placed at the end of the description.
-*
-* @name jsdoc-final-definition
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [final-definition]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-final-definition}
-*
-* @example
-* // Bad...
-*
-* /**
-* * Squares a [number][number].
-* *
-* * [number]: https://example.com
-* *
-* * Additional information.
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Squares a [number][number].
-* *
-* * Additional information.
-* *
-* * [number]: https://example.com
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*/
-rules[ 'stdlib/jsdoc-final-definition' ] = 'error';
+ * Require definitions be placed at the end of the description.
+ *
+ * @name jsdoc-final-definition
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [final-definition]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-final-definition}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Squares a [number][number].
+ * *
+ * * [number]: https://example.com
+ * *
+ * * Additional information.
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Squares a [number][number].
+ * *
+ * * Additional information.
+ * *
+ * * [number]: https://example.com
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ */
+rules["stdlib/jsdoc-final-definition"] = "error";
/**
-* Require first heading level be a level `2` heading in JSDoc comments. A level `1` heading is implied.
-*
-* @name jsdoc-first-heading-level
-* @memberof rules
-* @type {Array}
-* @see [first-heading-level]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-first-heading-level}
-*
-* @example
-* // Bad...
-*
-* /**
-* * Boop beep.
-* *
-* * # Beep
-* *
-* * Boop.
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Boop beep.
-* *
-* * ## Beep
-* *
-* * Boop.
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*/
-rules[ 'stdlib/jsdoc-first-heading-level' ] = [ 'error', 2 ];
+ * Require first heading level be a level `2` heading in JSDoc comments. A level `1` heading is implied.
+ *
+ * @name jsdoc-first-heading-level
+ * @memberof rules
+ * @type {Array}
+ * @see [first-heading-level]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-first-heading-level}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Boop beep.
+ * *
+ * * # Beep
+ * *
+ * * Boop.
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Boop beep.
+ * *
+ * * ## Beep
+ * *
+ * * Boop.
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ */
+rules["stdlib/jsdoc-first-heading-level"] = ["error", 2];
/**
-* Prevent too many spaces from being used to hard break.
-*
-* @name jsdoc-hard-break-spaces
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [hard-break-spaces]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-hard-break-spaces}
-*
-* @example
-* // Bad...
-*
-* /**
-* * Squares a number.
-* *
-* * Dots represent⋅⋅⋅
-* * spaces.
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Squares a number.
-* *
-* * Dots represent⋅⋅
-* * spaces.
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*/
-rules[ 'stdlib/jsdoc-hard-break-spaces' ] = 'error';
+ * Prevent too many spaces from being used to hard break.
+ *
+ * @name jsdoc-hard-break-spaces
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [hard-break-spaces]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-hard-break-spaces}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * Dots represent⋅⋅⋅
+ * * spaces.
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * Dots represent⋅⋅
+ * * spaces.
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ */
+rules["stdlib/jsdoc-hard-break-spaces"] = "error";
/**
-* Warn when headings increment by more than 1 level.
-*
-* @name jsdoc-heading-increment
-* @memberof rules
-* @type {string}
-* @default 'warn'
-* @see [heading-increment]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-heading-increment}
-*
-* @example
-* // Bad...
-*
-* /**
-* * Boop beep.
-* *
-* * ## Boop
-* *
-* * #### Beep
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Boop beep.
-* *
-* * ## Boop
-* *
-* * ### Beep
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*/
-rules[ 'stdlib/jsdoc-heading-increment' ] = 'warn';
+ * Warn when headings increment by more than 1 level.
+ *
+ * @name jsdoc-heading-increment
+ * @memberof rules
+ * @type {string}
+ * @default 'warn'
+ * @see [heading-increment]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-heading-increment}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Boop beep.
+ * *
+ * * ## Boop
+ * *
+ * * #### Beep
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Boop beep.
+ * *
+ * * ## Boop
+ * *
+ * * ### Beep
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ */
+rules["stdlib/jsdoc-heading-increment"] = "warn";
/**
-* Require `atx` heading style.
-*
-* @name jsdoc-heading-style
-* @memberof rules
-* @type {Array}
-* @see [heading-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-heading-style}
-*
-* @example
-* // Bad...
-*
-* /**
-* * Returns a pseudo-random number on `[0,1]`
-* *
-* * Beep
-* * ===
-* *
-* * ## Boop
-* *
-* * @returns {number} uniform random number
-* *
-* * @example
-* * var y = rand();
-* * // e.g., returns 0.5363925252089496
-* *\/
-* function rand() {
-* return Math.random();
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Returns a pseudo-random number on `[0,1]`
-* *
-* * # Beep
-* *
-* * ## Boop
-* *
-* * @returns {number} uniform random number
-* *
-* * @example
-* * var y = rand();
-* * // e.g., returns 0.5363925252089496
-* *\/
-* function rand() {
-* return Math.random();
-* }
-*/
-rules[ 'stdlib/jsdoc-heading-style' ] = [ 'error', 'atx' ];
+ * Require `atx` heading style.
+ *
+ * @name jsdoc-heading-style
+ * @memberof rules
+ * @type {Array}
+ * @see [heading-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-heading-style}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Returns a pseudo-random number on `[0,1]`
+ * *
+ * * Beep
+ * * ===
+ * *
+ * * ## Boop
+ * *
+ * * @returns {number} uniform random number
+ * *
+ * * @example
+ * * var y = rand();
+ * * // e.g., returns 0.5363925252089496
+ * *\/
+ * function rand() {
+ * return Math.random();
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Returns a pseudo-random number on `[0,1]`
+ * *
+ * * # Beep
+ * *
+ * * ## Boop
+ * *
+ * * @returns {number} uniform random number
+ * *
+ * * @example
+ * * var y = rand();
+ * * // e.g., returns 0.5363925252089496
+ * *\/
+ * function rand() {
+ * return Math.random();
+ * }
+ */
+rules["stdlib/jsdoc-heading-style"] = ["error", "atx"];
/**
-* Require that JSDoc descriptions start with an uppercase letter and end with a period.
-*
-* @name jsdoc-leading-description-sentence
-* @memberof rules
-* @type {Array}
-*
-* @example
-* // Bad...
-*
-* /**
-* * returns a pseudo-random number on `[0,1]`
-* *
-* * @returns {number} uniform random number
-* *
-* * @example
-* * var y = rand();
-* * // e.g., returns 0.5363925252089496
-* *\/
-* function rand() {
-* return Math.random();
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Returns a pseudo-random number on `[0,1]`.
-* *
-* * @returns {number} uniform random number
-* *
-* * @example
-* * var y = rand();
-* * // e.g., returns 0.5363925252089496
-* *\/
-* function rand() {
-* return Math.random();
-* }
-*/
-rules[ 'stdlib/jsdoc-leading-description-sentence' ] = [ 'error', {
- 'whitelist': [
- 'ndarray',
- 'rehype',
- 'remark',
- 'stdlib',
- 'x-axis',
- 'y-axis',
- '`x`',
- '`x`-value',
- '`y`',
- '`y`-value'
- ]
-}];
+ * Require that JSDoc descriptions start with an uppercase letter and end with a period.
+ *
+ * @name jsdoc-leading-description-sentence
+ * @memberof rules
+ * @type {Array}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * returns a pseudo-random number on `[0,1]`
+ * *
+ * * @returns {number} uniform random number
+ * *
+ * * @example
+ * * var y = rand();
+ * * // e.g., returns 0.5363925252089496
+ * *\/
+ * function rand() {
+ * return Math.random();
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Returns a pseudo-random number on `[0,1]`.
+ * *
+ * * @returns {number} uniform random number
+ * *
+ * * @example
+ * * var y = rand();
+ * * // e.g., returns 0.5363925252089496
+ * *\/
+ * function rand() {
+ * return Math.random();
+ * }
+ */
+rules["stdlib/jsdoc-leading-description-sentence"] = [
+ "error",
+ {
+ whitelist: [
+ "ndarray",
+ "rehype",
+ "remark",
+ "stdlib",
+ "x-axis",
+ "y-axis",
+ "`x`",
+ "`x`-value",
+ "`y`",
+ "`y`-value",
+ ],
+ },
+];
/**
-* Enforce that the copyright year in a stdlib license year matches the year the file was created.
-*
-* @name jsdoc-license-header-year
-* @memberof rules
-* @type {string}
-* @default 'error'
-*/
-rules[ 'stdlib/jsdoc-license-header-year' ] = 'off';
+ * Enforce that the copyright year in a stdlib license year matches the year the file was created.
+ *
+ * @name jsdoc-license-header-year
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ */
+rules["stdlib/jsdoc-license-header-year"] = "off";
/**
-* Require Unix linebreaks.
-*
-* @name jsdoc-jsdoc-linebreak-style
-* @memberof rules
-* @type {Array}
-* @see [linebreak-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-linebreak-style}
-*/
-rules[ 'stdlib/jsdoc-linebreak-style' ] = [ 'error', 'unix' ];
+ * Require Unix linebreaks.
+ *
+ * @name jsdoc-jsdoc-linebreak-style
+ * @memberof rules
+ * @type {Array}
+ * @see [linebreak-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-linebreak-style}
+ */
+rules["stdlib/jsdoc-linebreak-style"] = ["error", "unix"];
/**
-* Require that heading lengths be less than or equal to `80` characters.
-*
-* @name jsdoc-maximum-heading-length
-* @memberof rules
-* @type {Array}
-* @see [maximum-heading-length]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-maximum-heading-length}
-*
-* @example
-* // Bad...
-*
-* /**
-* * Beep boop.
-* *
-* * ## Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula
-* *
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Beep boop.
-* *
-* * ## Lorem ipsum dolor sit amet, consectetuer adipiscing elit
-* *
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*/
-rules[ 'stdlib/jsdoc-maximum-heading-length' ] = [ 'error', 80 ];
+ * Require that heading lengths be less than or equal to `80` characters.
+ *
+ * @name jsdoc-maximum-heading-length
+ * @memberof rules
+ * @type {Array}
+ * @see [maximum-heading-length]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-maximum-heading-length}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Beep boop.
+ * *
+ * * ## Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula
+ * *
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Beep boop.
+ * *
+ * * ## Lorem ipsum dolor sit amet, consectetuer adipiscing elit
+ * *
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ */
+rules["stdlib/jsdoc-maximum-heading-length"] = ["error", 80];
/**
-* Do not enforce a maximum line length.
-*
-* @name jsdoc-maximum-line-length
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [maximum-line-length]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-maximum-line-length}
-*
-* @example
-* // Bad...
-*
-* /**
-* * Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget * dolor. Aenean massa.
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*/
-rules[ 'stdlib/jsdoc-maximum-line-length' ] = [ 'off' ];
+ * Do not enforce a maximum line length.
+ *
+ * @name jsdoc-maximum-line-length
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [maximum-line-length]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-maximum-line-length}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget * dolor. Aenean massa.
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ */
+rules["stdlib/jsdoc-maximum-line-length"] = ["off"];
/**
-* Require double quotes for link titles.
-*
-* @name jsdoc-link-title-style
-* @memberof rules
-* @type {Array}
-* @see [link-title-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-link-title-style}
-*
-* @example
-* // Bad...
-*
-* /**
-* * Boop beep.
-* *
-* * [example](https://example.com (Example))
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Boop beep.
-* *
-* * [example](https://example.com "Example")
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*/
-rules[ 'stdlib/jsdoc-link-title-style' ] = [ 'error', '"' ];
+ * Require double quotes for link titles.
+ *
+ * @name jsdoc-link-title-style
+ * @memberof rules
+ * @type {Array}
+ * @see [link-title-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-link-title-style}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Boop beep.
+ * *
+ * * [example](https://example.com (Example))
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Boop beep.
+ * *
+ * * [example](https://example.com "Example")
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ */
+rules["stdlib/jsdoc-link-title-style"] = ["error", '"'];
/**
-* Prevent unnecessary indentation of list item bullets.
-*
-* @name jsdoc-list-item-bullet-indent
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [list-item-bullet-indent]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-list-item-bullet-indent}
-*
-* @example
-* // Bad...
-*
-* /**
-* * Squares a number.
-* *
-* * - Item
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Squares a number.
-* *
-* * - Item
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*/
-rules[ 'stdlib/jsdoc-list-item-bullet-indent' ] = 'error';
+ * Prevent unnecessary indentation of list item bullets.
+ *
+ * @name jsdoc-list-item-bullet-indent
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [list-item-bullet-indent]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-list-item-bullet-indent}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * - Item
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * - Item
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ */
+rules["stdlib/jsdoc-list-item-bullet-indent"] = "error";
/**
-* Prevent mixed indentation in list item content.
-*
-* @name jsdoc-list-item-content-indent
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [list-item-content-indent]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-list-item-content-indent}
-*
-* @example
-* // Bad...
-*
-* /**
-* * Squares a number.
-* *
-* * 1. Item
-* *
-* * 1. Item
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Squares a number.
-* *
-* * 1. Item
-* *
-* * 1. Item
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*/
-rules[ 'stdlib/jsdoc-list-item-content-indent' ] = 'error';
+ * Prevent mixed indentation in list item content.
+ *
+ * @name jsdoc-list-item-content-indent
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [list-item-content-indent]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-list-item-content-indent}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * 1. Item
+ * *
+ * * 1. Item
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * 1. Item
+ * *
+ * * 1. Item
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ */
+rules["stdlib/jsdoc-list-item-content-indent"] = "error";
/**
-* Require list items use tab-size indentation.
-*
-* @name jsdoc-list-item-indent
-* @memberof rules
-* @type {Array}
-* @see [list-item-indent]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-list-item-indent}
-*
-* @example
-* // Bad...
-*
-* /**
-* * Squares a number.
-* *
-* * Hello
-* * World
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-*
-* @example
-* // Good...
-*
-* /**
-* * Squares a number.
-* *
-* * - Hello
-* * - World
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-*
-* @example
-* // Good...
-*
-* /**
-* * Squares a number.
-* *
-* * - Beep
-* * boop
-* *
-* * - Bop
-* * bip
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-*/
-rules[ 'stdlib/jsdoc-list-item-indent' ] = [ 'error', 'tab-size' ];
+ * Require list items use tab-size indentation.
+ *
+ * @name jsdoc-list-item-indent
+ * @memberof rules
+ * @type {Array}
+ * @see [list-item-indent]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-list-item-indent}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * Hello
+ * * World
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * - Hello
+ * * - World
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * - Beep
+ * * boop
+ * *
+ * * - Bop
+ * * bip
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ */
+rules["stdlib/jsdoc-list-item-indent"] = ["error", "tab-size"];
/**
-* Require consistent list item spacing.
-*
-* @name jsdoc-list-item-spacing
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [list-item-spacing]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-list-item-spacing}
-*
-* @example
-* // Bad...
-*
-* /**
-* * Squares a number.
-* *
-* * - Beep
-* * - Boop
-* *
-* * - Boop
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-*
-* @example
-* // Good...
-*
-* /**
-* * Squares a number.
-* *
-* * - Beep
-* * - Boop
-* * - Boop
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-*
-* @example
-* // Okay...
-*
-* /**
-* * Squares a number.
-* *
-* * - Beep
-* *
-* * - Boop
-* *
-* * - Boop
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-*
-*/
-rules[ 'stdlib/jsdoc-list-item-spacing' ] = 'error';
+ * Require consistent list item spacing.
+ *
+ * @name jsdoc-list-item-spacing
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [list-item-spacing]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-list-item-spacing}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * - Beep
+ * * - Boop
+ * *
+ * * - Boop
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * - Beep
+ * * - Boop
+ * * - Boop
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ *
+ * @example
+ * // Okay...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * - Beep
+ * *
+ * * - Boop
+ * *
+ * * - Boop
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ *
+ */
+rules["stdlib/jsdoc-list-item-spacing"] = "error";
/**
-* Lint JSDoc descriptions using remark.
-*
-* @name jsdoc-markdown-remark
-* @memberof rules
-* @type {Array}
-*
-* @example
-* // Bad...
-*
-* /**
-* * Squares a number.
-* *
-* * ## Methods
-* *
-* * Do this. Do that.
-* *
-* * ## Methods
-* *
-* * Duplicate heading.
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Squares a number.
-* *
-* * ## Methods
-* *
-* * Do this. Do that.
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*/
-rules[ 'stdlib/jsdoc-markdown-remark' ] = [ 'error',
+ * Lint JSDoc descriptions using remark.
+ *
+ * @name jsdoc-markdown-remark
+ * @memberof rules
+ * @type {Array}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * ## Methods
+ * *
+ * * Do this. Do that.
+ * *
+ * * ## Methods
+ * *
+ * * Duplicate heading.
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * ## Methods
+ * *
+ * * Do this. Do that.
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ */
+rules["stdlib/jsdoc-markdown-remark"] = [
+ "error",
{
- 'config': require( './../../remark/.remarkrc.jsdoc.js' )
- }
+ config: require("./../../remark/.remarkrc.jsdoc.js"),
+ },
];
/**
-* Require angle-bracketed links to include a protocol.
-*
-* @name jsdoc-no-auto-link-without-protocol
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-auto-link-without-protocol]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-auto-link-without-protocol}
-*
-* @example
-* // Bad...
-*
-* /**
-* * Squares a number.
-* *
-* * <foo@bar.com>
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Squares a number.
-* *
-* * <mailto:foo@bar.com>
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*/
-rules[ 'stdlib/jsdoc-no-auto-link-without-protocol' ] = 'error';
+ * Require angle-bracketed links to include a protocol.
+ *
+ * @name jsdoc-no-auto-link-without-protocol
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-auto-link-without-protocol]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-auto-link-without-protocol}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * <foo@bar.com>
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * <mailto:foo@bar.com>
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ */
+rules["stdlib/jsdoc-no-auto-link-without-protocol"] = "error";
/**
-* Require blank lines in blockquotes have a marker.
-*
-* @name jsdoc-no-blockquote-without-marker
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-blockquote-without-marker]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-blockquote-without-marker}
-*
-* @example
-* // Bad...
-*
-* /**
-* * Squares a number.
-* *
-* * > This is a...
-* *
-* * > ...blockquote.
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Squares a number.
-* *
-* * > This is a...
-* * >
-* * > ...blockquote.
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*/
-rules[ 'stdlib/jsdoc-no-blockquote-without-marker' ] = 'error';
+ * Require blank lines in blockquotes have a marker.
+ *
+ * @name jsdoc-no-blockquote-without-marker
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-blockquote-without-marker]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-blockquote-without-marker}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * > This is a...
+ * *
+ * * > ...blockquote.
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * > This is a...
+ * * >
+ * * > ...blockquote.
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ */
+rules["stdlib/jsdoc-no-blockquote-without-marker"] = "error";
/**
-* Do not allow too many consecutive blank lines. NOTE: disabled to allow some discretion in terms of layout and readability.
-*
-* @name jsdoc-no-consecutive-blank-lines
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [no-consecutive-blank-lines]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-consecutive-blank-lines}
-*
-* @example
-* // Bad...
-*
-* /**
-* * Squares a number.
-* *
-* * ## Methods
-* *
-* *
-* * Discuss methods.
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Squares a number.
-* *
-* * ## Methods
-* *
-* * Discuss methods.
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*/
-rules[ 'stdlib/jsdoc-no-consecutive-blank-lines' ] = 'off';
+ * Do not allow too many consecutive blank lines. NOTE: disabled to allow some discretion in terms of layout and readability.
+ *
+ * @name jsdoc-no-consecutive-blank-lines
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [no-consecutive-blank-lines]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-consecutive-blank-lines}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * ## Methods
+ * *
+ * *
+ * * Discuss methods.
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * ## Methods
+ * *
+ * * Discuss methods.
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ */
+rules["stdlib/jsdoc-no-consecutive-blank-lines"] = "off";
/**
-* Do not allow duplicate definitions.
-*
-* @name jsdoc-no-duplicate-definitions
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-duplicate-definitions]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-duplicate-definitions}
-*
-* @example
-* // Bad...
-*
-* /**
-* * Squares a [number][number].
-* *
-* * [number]: https://example.com
-* * [number]: https://example.com
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Squares a [number][number].
-* *
-* * [number]: https://example.com
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*/
-rules[ 'stdlib/jsdoc-no-duplicate-definitions' ] = 'error';
+ * Do not allow duplicate definitions.
+ *
+ * @name jsdoc-no-duplicate-definitions
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-duplicate-definitions]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-duplicate-definitions}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Squares a [number][number].
+ * *
+ * * [number]: https://example.com
+ * * [number]: https://example.com
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Squares a [number][number].
+ * *
+ * * [number]: https://example.com
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ */
+rules["stdlib/jsdoc-no-duplicate-definitions"] = "error";
/**
-* Do not allow duplicate headings.
-*
-* @name jsdoc-no-duplicate-headings
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-duplicate-headings]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-duplicate-headings}
-*
-* @example
-* // Bad...
-*
-* /**
-* * Squares a number.
-* *
-* * ## Methods
-* *
-* * Discuss methods.
-* *
-* * ## Methods
-* *
-* * Discuss methods.
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Squares a number.
-* *
-* * ## Methods
-* *
-* * Discuss methods.
-* *
-* * ## Notes
-* *
-* * Discuss notes.
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*/
-rules[ 'stdlib/jsdoc-no-duplicate-headings' ] = 'error';
+ * Do not allow duplicate headings.
+ *
+ * @name jsdoc-no-duplicate-headings
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-duplicate-headings]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-duplicate-headings}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * ## Methods
+ * *
+ * * Discuss methods.
+ * *
+ * * ## Methods
+ * *
+ * * Discuss methods.
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * ## Methods
+ * *
+ * * Discuss methods.
+ * *
+ * * ## Notes
+ * *
+ * * Discuss notes.
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ */
+rules["stdlib/jsdoc-no-duplicate-headings"] = "error";
/**
-* Do not allow duplicate headings in the same section.
-*
-* @name jsdoc-no-duplicate-headings-in-section
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-duplicate-headings-in-section]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-duplicate-headings-in-section}
-*
-* @example
-* // Bad...
-*
-* /**
-* * Squares a number.
-* *
-* * ## Heading
-* *
-* * ### Subheading
-* *
-* * ### Subheading
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Squares a number.
-* *
-* * ## Heading 1
-* *
-* * ### Subheading
-* *
-* * ## Heading 2
-* *
-* * ### Subheading
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*/
-rules[ 'stdlib/jsdoc-no-duplicate-headings-in-section' ] = 'error';
+ * Do not allow duplicate headings in the same section.
+ *
+ * @name jsdoc-no-duplicate-headings-in-section
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-duplicate-headings-in-section]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-duplicate-headings-in-section}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * ## Heading
+ * *
+ * * ### Subheading
+ * *
+ * * ### Subheading
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * ## Heading 1
+ * *
+ * * ### Subheading
+ * *
+ * * ## Heading 2
+ * *
+ * * ### Subheading
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ */
+rules["stdlib/jsdoc-no-duplicate-headings-in-section"] = "error";
/**
-* Do not allow JSDoc tags to appear more than once in a JSDoc comment.
-*
-* @name jsdoc-no-duplicate-tags
-* @memberof rules
-* @type {Array}
-*
-* @example
-* // Bad...
-*
-* /**
-* * Squares a number.
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Squares a number.
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*/
-rules[ 'stdlib/jsdoc-no-duplicate-tags' ] = 'error';
+ * Do not allow JSDoc tags to appear more than once in a JSDoc comment.
+ *
+ * @name jsdoc-no-duplicate-tags
+ * @memberof rules
+ * @type {Array}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ */
+rules["stdlib/jsdoc-no-duplicate-tags"] = "error";
/**
-* Prevent use of emphasis in place of a heading.
-*
-* @name jsdoc-no-emphasis-as-heading
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-*
-* /**
-* * Boop beep.
-* *
-* * _Boop_
-* *
-* * Beep.
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Boop beep.
-* *
-* * ## Boop
-* *
-* * Beep.
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*/
-rules[ 'stdlib/jsdoc-no-emphasis-as-heading' ] = 'error';
+ * Prevent use of emphasis in place of a heading.
+ *
+ * @name jsdoc-no-emphasis-as-heading
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Boop beep.
+ * *
+ * * _Boop_
+ * *
+ * * Beep.
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Boop beep.
+ * *
+ * * ## Boop
+ * *
+ * * Beep.
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ */
+rules["stdlib/jsdoc-no-emphasis-as-heading"] = "error";
/**
-* Prevent empty URLs for links and images.
-*
-* @name jsdoc-no-empty-url
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-*
-* /**
-* * Boop [beep]().
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Boop [beep](http://foo.bar/baz).
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*/
-rules[ 'stdlib/jsdoc-no-empty-url' ] = 'error';
+ * Prevent empty URLs for links and images.
+ *
+ * @name jsdoc-no-empty-url
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Boop [beep]().
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Boop [beep](http://foo.bar/baz).
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ */
+rules["stdlib/jsdoc-no-empty-url"] = "error";
/**
-* Prevent indentation of heading content.
-*
-* @name jsdoc-no-heading-content-indent
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-*
-* /**
-* * Boop beep.
-* *
-* * ## Boop
-* *
-* * Beep.
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Boop beep.
-* *
-* * ## Boop
-* *
-* * Beep.
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*/
-rules[ 'stdlib/jsdoc-no-heading-content-indent' ] = 'error';
+ * Prevent indentation of heading content.
+ *
+ * @name jsdoc-no-heading-content-indent
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Boop beep.
+ * *
+ * * ## Boop
+ * *
+ * * Beep.
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Boop beep.
+ * *
+ * * ## Boop
+ * *
+ * * Beep.
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ */
+rules["stdlib/jsdoc-no-heading-content-indent"] = "error";
/**
-* Prevent indentation of headings.
-*
-* @name jsdoc-no-heading-indent
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-*
-* /**
-* * Boop beep.
-* *
-* * ## Boop
-* *
-* * Beep.
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Boop beep.
-* *
-* * ## Boop
-* *
-* * Beep.
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*/
-rules[ 'stdlib/jsdoc-no-heading-indent' ] = 'error';
+ * Prevent indentation of headings.
+ *
+ * @name jsdoc-no-heading-indent
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Boop beep.
+ * *
+ * * ## Boop
+ * *
+ * * Beep.
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Boop beep.
+ * *
+ * * ## Boop
+ * *
+ * * Beep.
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ */
+rules["stdlib/jsdoc-no-heading-indent"] = "error";
/**
-* Prevent paragraphs which appear to be h7+ "headings".
-*
-* @name jsdoc-no-heading-like-paragraph
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-*
-* /**
-* * Boop beep.
-* *
-* * ####### Boop
-* *
-* * Beep.
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Boop beep.
-* *
-* * ## Boop
-* *
-* * Beep.
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*/
-rules[ 'stdlib/jsdoc-no-heading-like-paragraph' ] = 'error';
+ * Prevent paragraphs which appear to be h7+ "headings".
+ *
+ * @name jsdoc-no-heading-like-paragraph
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Boop beep.
+ * *
+ * * ####### Boop
+ * *
+ * * Beep.
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Boop beep.
+ * *
+ * * ## Boop
+ * *
+ * * Beep.
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ */
+rules["stdlib/jsdoc-no-heading-like-paragraph"] = "error";
/**
-* Prevent headings from ending with specified characters.
-*
-* @name jsdoc-no-heading-punctuation
-* @memberof rules
-* @type {Array}
-* @default [ 'error', '.,;:!?' ]
-*
-* @example
-* // Bad...
-*
-* /**
-* * Boop beep.
-* *
-* * ## Boop!
-* *
-* * Beep.
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Boop beep.
-* *
-* * ## Boop
-* *
-* * Beep.
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*/
-rules[ 'stdlib/jsdoc-no-heading-punctuation' ] = [ 'error', '.,;:!?' ];
+ * Prevent headings from ending with specified characters.
+ *
+ * @name jsdoc-no-heading-punctuation
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', '.,;:!?' ]
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Boop beep.
+ * *
+ * * ## Boop!
+ * *
+ * * Beep.
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Boop beep.
+ * *
+ * * ## Boop
+ * *
+ * * Beep.
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ */
+rules["stdlib/jsdoc-no-heading-punctuation"] = ["error", ".,;:!?"];
/**
-* Prevent HTML from being used.
-*
-* @name jsdoc-no-html
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-*
-* /**
-* * Beep boop.
-* *
-* * <h2>References</h2>
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Beep boop.
-* *
-* * ## References
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*/
-rules[ 'stdlib/jsdoc-no-html' ] = 'error';
+ * Prevent HTML from being used.
+ *
+ * @name jsdoc-no-html
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Beep boop.
+ * *
+ * * <h2>References</h2>
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Beep boop.
+ * *
+ * * ## References
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ */
+rules["stdlib/jsdoc-no-html"] = "error";
/**
-* Prevent inline padding of markers.
-*
-* @name jsdoc-no-inline-padding
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-*
-* /**
-* * Boop: _ beep _.
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Boop: _beep_.
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*/
-rules[ 'stdlib/jsdoc-no-inline-padding' ] = 'error';
+ * Prevent inline padding of markers.
+ *
+ * @name jsdoc-no-inline-padding
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Boop: _ beep _.
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Boop: _beep_.
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ */
+rules["stdlib/jsdoc-no-inline-padding"] = "error";
/**
-* Prevent URLs without angle-brackets from being used.
-*
-* @name jsdoc-no-literal-urls
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-*
-* /**
-* * Boop beep.
-* *
-* * ## Links
-* *
-* * - http://foo.bar/baz
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Boop beep.
-* *
-* * ## Links
-* *
-* * - <http://foo.bar/baz>
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*/
-rules[ 'stdlib/jsdoc-no-literal-urls' ] = 'error';
+ * Prevent URLs without angle-brackets from being used.
+ *
+ * @name jsdoc-no-literal-urls
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Boop beep.
+ * *
+ * * ## Links
+ * *
+ * * - http://foo.bar/baz
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Boop beep.
+ * *
+ * * ## Links
+ * *
+ * * - <http://foo.bar/baz>
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ */
+rules["stdlib/jsdoc-no-literal-urls"] = "error";
/**
-* Require blank lines between Markdown block nodes in JSDoc descriptions.
-*
-* @name jsdoc-no-missing-blank-lines
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-*
-* /**
-* * Boop beep.
-* *
-* * ## Beep
-* * ### Boop
-* *
-* * Hello World.
-* * - Foo
-* * 1. Yes
-* * 2. No
-* * - Bar
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Boop beep.
-* *
-* * ## Beep
-* *
-* * ### Boop
-* *
-* * Hello World.
-* *
-* * - Foo
-* * 1. Yes
-* *
-* * 2. No
-* *
-* * - Bar
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*/
-rules[ 'stdlib/jsdoc-no-missing-blank-lines' ] = [ 'error', {
- 'exceptTightLists': true
-}];
+ * Require blank lines between Markdown block nodes in JSDoc descriptions.
+ *
+ * @name jsdoc-no-missing-blank-lines
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Boop beep.
+ * *
+ * * ## Beep
+ * * ### Boop
+ * *
+ * * Hello World.
+ * * - Foo
+ * * 1. Yes
+ * * 2. No
+ * * - Bar
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Boop beep.
+ * *
+ * * ## Beep
+ * *
+ * * ### Boop
+ * *
+ * * Hello World.
+ * *
+ * * - Foo
+ * * 1. Yes
+ * *
+ * * 2. No
+ * *
+ * * - Bar
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ */
+rules["stdlib/jsdoc-no-missing-blank-lines"] = [
+ "error",
+ {
+ exceptTightLists: true,
+ },
+];
/**
-* Disallow multiple blank lines in JSDoc comments.
-*
-* @name jsdoc-no-multiple-blank-lines
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-*
-* /**
-* * Boop beep.
-* *
-* *
-* * @returns {string} a value
-* *
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Boop beep.
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*/
-rules[ 'stdlib/jsdoc-no-multiple-blank-lines' ] = 'error';
+ * Disallow multiple blank lines in JSDoc comments.
+ *
+ * @name jsdoc-no-multiple-blank-lines
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Boop beep.
+ * *
+ * *
+ * * @returns {string} a value
+ * *
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Boop beep.
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ */
+rules["stdlib/jsdoc-no-multiple-blank-lines"] = "error";
/**
-* Allow multiple top-level headings.
-*
-* @name jsdoc-no-multiple-toplevel-headings
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [no-multiple-toplevel-headings]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-multiple-toplevel-headings}
-*
-* @example
-* // Okay...
-*
-* /**
-* * Boop beep.
-* *
-* * # Boop
-* *
-* * # Beep.
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*/
-rules[ 'stdlib/jsdoc-no-multiple-toplevel-headings' ] = 'off';
+ * Allow multiple top-level headings.
+ *
+ * @name jsdoc-no-multiple-toplevel-headings
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [no-multiple-toplevel-headings]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-multiple-toplevel-headings}
+ *
+ * @example
+ * // Okay...
+ *
+ * /**
+ * * Boop beep.
+ * *
+ * * # Boop
+ * *
+ * * # Beep.
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ */
+rules["stdlib/jsdoc-no-multiple-toplevel-headings"] = "off";
/**
-* Prevent indentation of paragraph content.
-*
-* @name jsdoc-no-paragraph-content-indent
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-*
-* /**
-* * Boop beep.
-* *
-* * ## Boop
-* *
-* * Beep.
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Boop beep.
-* *
-* * ## Boop
-* *
-* * Beep.
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*/
-rules[ 'stdlib/jsdoc-no-paragraph-content-indent' ] = 'error';
+ * Prevent indentation of paragraph content.
+ *
+ * @name jsdoc-no-paragraph-content-indent
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Boop beep.
+ * *
+ * * ## Boop
+ * *
+ * * Beep.
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Boop beep.
+ * *
+ * * ## Boop
+ * *
+ * * Beep.
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ */
+rules["stdlib/jsdoc-no-paragraph-content-indent"] = "error";
/**
-* Prevent references from being used like URLs.
-*
-* @name jsdoc-no-reference-like-url
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-*
-* /**
-* * Beep [boop](baz).
-* *
-* * [baz]: http://foo.bar/baz
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Beep [boop][baz].
-* *
-* * [baz]: http://foo.bar/baz
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*/
-rules[ 'stdlib/jsdoc-no-reference-like-url' ] = 'error';
+ * Prevent references from being used like URLs.
+ *
+ * @name jsdoc-no-reference-like-url
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Beep [boop](baz).
+ * *
+ * * [baz]: http://foo.bar/baz
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Beep [boop][baz].
+ * *
+ * * [baz]: http://foo.bar/baz
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ */
+rules["stdlib/jsdoc-no-reference-like-url"] = "error";
/**
-* Allow shell commands to be prefixed with `$` symbols.
-*
-* @name jsdoc-no-shell-dollars
-* @memberof rules
-* @type {string}
-* @default 'off'
-*
-* @example
-* // Bad...
-*
-* /**
-* * Beep boop.
-* *
-* * ```bash
-* * $ echo beep
-* * ```
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Beep boop.
-* *
-* * ```bash
-* * echo beep
-* * ```
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*/
-rules[ 'stdlib/jsdoc-no-shell-dollars' ] = 'off';
+ * Allow shell commands to be prefixed with `$` symbols.
+ *
+ * @name jsdoc-no-shell-dollars
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Beep boop.
+ * *
+ * * ```bash
+ * * $ echo beep
+ * * ```
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Beep boop.
+ * *
+ * * ```bash
+ * * echo beep
+ * * ```
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ */
+rules["stdlib/jsdoc-no-shell-dollars"] = "off";
/**
-* Prevent shortcut reference images.
-*
-* @name jsdoc-no-shortcut-reference-image
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-*
-* /**
-* * Beep ![boop].
-* *
-* * [boop]: http://foo.bar/baz.png
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Beep ![boop][].
-* *
-* * [boop]: http://foo.bar/baz.png
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*/
-rules[ 'stdlib/jsdoc-no-shortcut-reference-image' ] = 'error';
+ * Prevent shortcut reference images.
+ *
+ * @name jsdoc-no-shortcut-reference-image
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Beep ![boop].
+ * *
+ * * [boop]: http://foo.bar/baz.png
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Beep ![boop][].
+ * *
+ * * [boop]: http://foo.bar/baz.png
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ */
+rules["stdlib/jsdoc-no-shortcut-reference-image"] = "error";
/**
-* Prevent shortcut reference links.
-*
-* @name jsdoc-no-shortcut-reference-link
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-*
-* /**
-* * Beep [boop].
-* *
-* * [boop]: http://foo.bar/baz
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Beep [boop][boop].
-* *
-* * [boop]: http://foo.bar/baz
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*/
-rules[ 'stdlib/jsdoc-no-shortcut-reference-link' ] = 'error';
+ * Prevent shortcut reference links.
+ *
+ * @name jsdoc-no-shortcut-reference-link
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Beep [boop].
+ * *
+ * * [boop]: http://foo.bar/baz
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Beep [boop][boop].
+ * *
+ * * [boop]: http://foo.bar/baz
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ */
+rules["stdlib/jsdoc-no-shortcut-reference-link"] = "error";
/**
-* Prevent space-aligned asterisks for JSDoc comments.
-*
-* @name
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-*
-* /**
-* * Beep boop.
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Beep boop.
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*/
-rules[ 'stdlib/jsdoc-no-space-aligned-asterisks' ] = 'error';
+ * Prevent space-aligned asterisks for JSDoc comments.
+ *
+ * @name
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Beep boop.
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Beep boop.
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ */
+rules["stdlib/jsdoc-no-space-aligned-asterisks"] = "error";
/**
-* Prevent unnecessary indentation before tables.
-*
-* @name jsdoc-no-table-indentation
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-*
-* /**
-* * Boop beep.
-* *
-* * | x | y |
-* * | any | boop |
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Boop beep.
-* *
-* * | x | y |
-* * | any | boop |
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*/
-rules[ 'stdlib/jsdoc-no-table-indentation' ] = 'error';
+ * Prevent unnecessary indentation before tables.
+ *
+ * @name jsdoc-no-table-indentation
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Boop beep.
+ * *
+ * * | x | y |
+ * * | any | boop |
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Boop beep.
+ * *
+ * * | x | y |
+ * * | any | boop |
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ */
+rules["stdlib/jsdoc-no-table-indentation"] = "error";
/**
-* Forbid the use of tabs.
-*
-* @name jsdoc-no-tabs
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-*
-* /**
-* * Beep.
-* *
-* * - List item starting with a tab.
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Beep.
-* *
-* * - List item starting with spaces.
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*/
-rules[ 'stdlib/jsdoc-no-tabs' ] = 'error';
+ * Forbid the use of tabs.
+ *
+ * @name jsdoc-no-tabs
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Beep.
+ * *
+ * * - List item starting with a tab.
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Beep.
+ * *
+ * * - List item starting with spaces.
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ */
+rules["stdlib/jsdoc-no-tabs"] = "error";
/**
-* Prevent references to undefined definitions.
-*
-* @name jsdoc-no-undefined-references
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-*
-* /**
-* * Beep [boop][boop].
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Beep [boop][boop].
-* *
-* * [boop]: http://example.com
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*/
-rules[ 'stdlib/jsdoc-no-undefined-references' ] = 'error';
+ * Prevent references to undefined definitions.
+ *
+ * @name jsdoc-no-undefined-references
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Beep [boop][boop].
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Beep [boop][boop].
+ * *
+ * * [boop]: http://example.com
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ */
+rules["stdlib/jsdoc-no-undefined-references"] = "error";
/**
-* Forbid unused definitions.
-*
-* @name jsdoc-no-unused-definitions
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-*
-* /**
-* * Boop beep.
-* *
-* * [beep]: http://foo.bar/baz
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Boop [beep][beep].
-* *
-* * [beep]: http://foo.bar/baz
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*/
-rules[ 'stdlib/jsdoc-no-unused-definitions' ] = 'error';
+ * Forbid unused definitions.
+ *
+ * @name jsdoc-no-unused-definitions
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Boop beep.
+ * *
+ * * [beep]: http://foo.bar/baz
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Boop [beep][beep].
+ * *
+ * * [beep]: http://foo.bar/baz
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ */
+rules["stdlib/jsdoc-no-unused-definitions"] = "error";
/**
-* Require ordered lists use periods (e.g., `1.`, `2.`, etc).
-*
-* @name jsdoc-ordered-list-marker-style
-* @memberof rules
-* @type {Array}
-* @see [ordered-list-marker-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-ordered-list-marker-style}
-*
-* @example
-* // Bad...
-*
-* /**
-* * Squares a number.
-* *
-* * 1. foo
-* * 2) bar
-* * 3) beep
-* *
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Squares a number.
-* *
-* * 1. foo
-* * 2. bar
-* * 3. beep
-* *
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*/
-rules[ 'stdlib/jsdoc-ordered-list-marker-style' ] = [ 'error', '.' ];
+ * Require ordered lists use periods (e.g., `1.`, `2.`, etc).
+ *
+ * @name jsdoc-ordered-list-marker-style
+ * @memberof rules
+ * @type {Array}
+ * @see [ordered-list-marker-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-ordered-list-marker-style}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * 1. foo
+ * * 2) bar
+ * * 3) beep
+ * *
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * 1. foo
+ * * 2. bar
+ * * 3. beep
+ * *
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ */
+rules["stdlib/jsdoc-ordered-list-marker-style"] = ["error", "."];
/**
-* Prefer ordered, but allow discretion when determining appropriate ordered list marker value.
-*
-* @name jsdoc-ordered-list-marker-value
-* @memberof rules
-* @type {Array}
-* @default [ 'off', 'ordered' ]
-* @see [ordered-list-marker-value]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-ordered-list-marker-value}
-*
-* @example
-* // Okay...
-*
-* /**
-* * Squares a number.
-* *
-* * 1. foo
-* * 1. bar
-* * 1. beep
-* * 1. boop
-* *
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Squares a number.
-* *
-* * 1. foo
-* * 2. bar
-* * 3. beep
-* * 4. boop
-* *
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*/
-rules[ 'stdlib/jsdoc-ordered-list-marker-value' ] = [ 'off', 'ordered' ];
+ * Prefer ordered, but allow discretion when determining appropriate ordered list marker value.
+ *
+ * @name jsdoc-ordered-list-marker-value
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'off', 'ordered' ]
+ * @see [ordered-list-marker-value]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-ordered-list-marker-value}
+ *
+ * @example
+ * // Okay...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * 1. foo
+ * * 1. bar
+ * * 1. beep
+ * * 1. boop
+ * *
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * 1. foo
+ * * 2. bar
+ * * 3. beep
+ * * 4. boop
+ * *
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ */
+rules["stdlib/jsdoc-ordered-list-marker-value"] = ["off", "ordered"];
/**
-* Enforce that @private tags are not missing in unassigned function declarations.
-*
-* @name jsdoc-private-annotation
-* @memberof rules
-* @type {string}
-* @default 'warn'
-*
-* @example
-* // Bad...
-*
-* /**
-* * Squares a number.
-* *
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Squares a number.
-* *
-* * @private
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*/
-rules[ 'stdlib/jsdoc-private-annotation' ] = 'warn';
+ * Enforce that @private tags are not missing in unassigned function declarations.
+ *
+ * @name jsdoc-private-annotation
+ * @memberof rules
+ * @type {string}
+ * @default 'warn'
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * @private
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ */
+rules["stdlib/jsdoc-private-annotation"] = "warn";
/**
-* Require that JSDoc comments of functions are not missing `@throws` tags.
-*
-* @name jsdoc-require-throws-tags
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-*
-* /**
-* * Copies or deep clones a value to an arbitrary depth.
-* *
-* * @param {*} value - value to copy
-* * @param {NonNegativeInteger} [level=+infinity] - copy depth
-* * @returns {*} value copy
-* *\/
-* function copy( value, level ) {
-* var out;
-* if ( arguments.length > 1 ) {
-* if ( !isNonNegativeInteger( level ) ) {
-* throw new TypeError( 'invalid argument. `level` must be a nonnegative integer. Value: `' + level + '`.' );
-* }
-* if ( level === 0 ) {
-* return value;
-* }
-* } else {
-* level = PINF;
-* }
-* out = ( isArray( value ) ) ? new Array( value.length ) : {};
-* return deepCopy( value, out, [value], [out], level );
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Copies or deep clones a value to an arbitrary depth.
-* *
-* * @param {*} value - value to copy
-* * @param {NonNegativeInteger} [level=+infinity] - copy depth
-* * @throws {TypeError} second argument must be a nonnegative integer
-* * @returns {*} value copy
-* *\/
-* function copy( value, level ) {
-* var out;
-* if ( arguments.length > 1 ) {
-* if ( !isNonNegativeInteger( level ) ) {
-* throw new TypeError( 'invalid argument. `level` must be a nonnegative integer. Value: `' + level + '`.' );
-* }
-* if ( level === 0 ) {
-* return value;
-* }
-* } else {
-* level = PINF;
-* }
-* out = ( isArray( value ) ) ? new Array( value.length ) : {};
-* return deepCopy( value, out, [value], [out], level );
-* }
-*/
-rules[ 'stdlib/jsdoc-require-throws-tags' ] = 'error';
+ * Require that JSDoc comments of functions are not missing `@throws` tags.
+ *
+ * @name jsdoc-require-throws-tags
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Copies or deep clones a value to an arbitrary depth.
+ * *
+ * * @param {*} value - value to copy
+ * * @param {NonNegativeInteger} [level=+infinity] - copy depth
+ * * @returns {*} value copy
+ * *\/
+ * function copy( value, level ) {
+ * var out;
+ * if ( arguments.length > 1 ) {
+ * if ( !isNonNegativeInteger( level ) ) {
+ * throw new TypeError( 'invalid argument. `level` must be a nonnegative integer. Value: `' + level + '`.' );
+ * }
+ * if ( level === 0 ) {
+ * return value;
+ * }
+ * } else {
+ * level = PINF;
+ * }
+ * out = ( isArray( value ) ) ? new Array( value.length ) : {};
+ * return deepCopy( value, out, [value], [out], level );
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Copies or deep clones a value to an arbitrary depth.
+ * *
+ * * @param {*} value - value to copy
+ * * @param {NonNegativeInteger} [level=+infinity] - copy depth
+ * * @throws {TypeError} second argument must be a nonnegative integer
+ * * @returns {*} value copy
+ * *\/
+ * function copy( value, level ) {
+ * var out;
+ * if ( arguments.length > 1 ) {
+ * if ( !isNonNegativeInteger( level ) ) {
+ * throw new TypeError( 'invalid argument. `level` must be a nonnegative integer. Value: `' + level + '`.' );
+ * }
+ * if ( level === 0 ) {
+ * return value;
+ * }
+ * } else {
+ * level = PINF;
+ * }
+ * out = ( isArray( value ) ) ? new Array( value.length ) : {};
+ * return deepCopy( value, out, [value], [out], level );
+ * }
+ */
+rules["stdlib/jsdoc-require-throws-tags"] = "error";
/**
-* Enforce that property names in return annotations inside of example code are quoted using single quotes.
-*
-* @name jsdoc-doctest-quote-props
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-* /**
-* * Converts the first letter of each object key to uppercase.
-* *
-* * @param {Object} obj - source object
-* * @returns {Object} new object
-* *
-* * @example
-* * var obj1 = {
-* * 'aa': 1,
-* * 'bb': 2
-* * };
-* *
-* * var obj2 = capitalizeKeys( obj1 );
-* * // returns { Aa: 1, "Bb": 2 }
-* *\/
-* function capitalizeKeys( obj ) {
-* var out;
-* var key;
-* var k;
-* out = {};
-* for ( key in obj ) {
-* if ( hasOwnProp( obj, key ) ) {
-* if ( key === '' ) {
-* out[ key ] = obj[ key ];
-* } else {
-* k = key.charAt( 0 ).toUpperCase() + key.slice( 1 );
-* out[ k ] = obj[ key ];
-* }
-* }
-* }
-* return out;
-* }
-*
-* @example
-* // Good...
-* /**
-* * Converts the first letter of each object key to uppercase.
-* *
-* * @param {Object} obj - source object
-* * @returns {Object} new object
-* *
-* * @example
-* * var obj1 = {
-* * 'aa': 1,
-* * 'bb': 2
-* * };
-* *
-* * var obj2 = capitalizeKeys( obj1 );
-* * // returns { 'Aa': 1, 'Bb': 2 }
-* *\/
-* function capitalizeKeys( obj ) {
-* var out;
-* var key;
-* var k;
-* out = {};
-* for ( key in obj ) {
-* if ( hasOwnProp( obj, key ) ) {
-* if ( key === '' ) {
-* out[ key ] = obj[ key ];
-* } else {
-* k = key.charAt( 0 ).toUpperCase() + key.slice( 1 );
-* out[ k ] = obj[ key ];
-* }
-* }
-* }
-* return out;
-* }
-*/
-rules[ 'stdlib/jsdoc-doctest-quote-props' ] = 'error';
+ * Enforce that property names in return annotations inside of example code are quoted using single quotes.
+ *
+ * @name jsdoc-doctest-quote-props
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ * /**
+ * * Converts the first letter of each object key to uppercase.
+ * *
+ * * @param {Object} obj - source object
+ * * @returns {Object} new object
+ * *
+ * * @example
+ * * var obj1 = {
+ * * 'aa': 1,
+ * * 'bb': 2
+ * * };
+ * *
+ * * var obj2 = capitalizeKeys( obj1 );
+ * * // returns { Aa: 1, "Bb": 2 }
+ * *\/
+ * function capitalizeKeys( obj ) {
+ * var out;
+ * var key;
+ * var k;
+ * out = {};
+ * for ( key in obj ) {
+ * if ( hasOwnProp( obj, key ) ) {
+ * if ( key === '' ) {
+ * out[ key ] = obj[ key ];
+ * } else {
+ * k = key.charAt( 0 ).toUpperCase() + key.slice( 1 );
+ * out[ k ] = obj[ key ];
+ * }
+ * }
+ * }
+ * return out;
+ * }
+ *
+ * @example
+ * // Good...
+ * /**
+ * * Converts the first letter of each object key to uppercase.
+ * *
+ * * @param {Object} obj - source object
+ * * @returns {Object} new object
+ * *
+ * * @example
+ * * var obj1 = {
+ * * 'aa': 1,
+ * * 'bb': 2
+ * * };
+ * *
+ * * var obj2 = capitalizeKeys( obj1 );
+ * * // returns { 'Aa': 1, 'Bb': 2 }
+ * *\/
+ * function capitalizeKeys( obj ) {
+ * var out;
+ * var key;
+ * var k;
+ * out = {};
+ * for ( key in obj ) {
+ * if ( hasOwnProp( obj, key ) ) {
+ * if ( key === '' ) {
+ * out[ key ] = obj[ key ];
+ * } else {
+ * k = key.charAt( 0 ).toUpperCase() + key.slice( 1 );
+ * out[ k ] = obj[ key ];
+ * }
+ * }
+ * }
+ * return out;
+ * }
+ */
+rules["stdlib/jsdoc-doctest-quote-props"] = "error";
/**
-* Require that the horizontal rule style be three consecutive asterisks `* * *`.
-*
-* @name jsdoc-rule-style
-* @memberof rules
-* @type {Array}
-* @see [rule-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-rule-style}
-*
-* @example
-* // Bad...
-*
-* /**
-* * Squares a number.
-* *
-* * ---
-* *
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Squares a number.
-* *
-* * * * *
-* *
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*/
-rules[ 'stdlib/jsdoc-rule-style' ] = [ 'error', '* * *' ];
+ * Require that the horizontal rule style be three consecutive asterisks `* * *`.
+ *
+ * @name jsdoc-rule-style
+ * @memberof rules
+ * @type {Array}
+ * @see [rule-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-rule-style}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * ---
+ * *
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * * * *
+ * *
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ */
+rules["stdlib/jsdoc-rule-style"] = ["error", "* * *"];
/**
-* Require `*` be used as the strong marker.
-*
-* @name jsdoc-strong-marker
-* @memberof rules
-* @type {Array}
-* @default [ 'error', '*' ]
-* @see [strong-marker]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-strong-marker}
-*
-* @example
-* // Bad...
-*
-* /**
-* * Squares a __number__.
-* *
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Squares a **number**.
-* *
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*/
-rules[ 'stdlib/jsdoc-strong-marker' ] = [ 'error', '*' ];
+ * Require `*` be used as the strong marker.
+ *
+ * @name jsdoc-strong-marker
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', '*' ]
+ * @see [strong-marker]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-strong-marker}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Squares a __number__.
+ * *
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Squares a **number**.
+ * *
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ */
+rules["stdlib/jsdoc-strong-marker"] = ["error", "*"];
/**
-* Require table cell padding.
-*
-* @name jsdoc-table-cell-padding
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'padded' ]
-* @see [table-cell-padding]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-table-cell-padding}
-*
-* @example
-* // Bad...
-*
-* /**
-* * Boop beep.
-* *
-* * |Beep|Boop|
-* * |----|----|
-* * |foo |bar |
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Boop beep.
-* *
-* * | Beep | Boop |
-* * | ---- | ---- |
-* * | foo | bar |
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*/
-rules[ 'stdlib/jsdoc-table-cell-padding' ] = [ 'error', 'padded' ];
+ * Require table cell padding.
+ *
+ * @name jsdoc-table-cell-padding
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'padded' ]
+ * @see [table-cell-padding]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-table-cell-padding}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Boop beep.
+ * *
+ * * |Beep|Boop|
+ * * |----|----|
+ * * |foo |bar |
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Boop beep.
+ * *
+ * * | Beep | Boop |
+ * * | ---- | ---- |
+ * * | foo | bar |
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ */
+rules["stdlib/jsdoc-table-cell-padding"] = ["error", "padded"];
/**
-* Require table pipes to be aligned.
-*
-* @name jsdoc-table-pipe-alignment
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-*
-* /**
-* * Boop beep.
-* *
-* * | x | y |
-* * | any | boop |
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Boop beep.
-* *
-* * | x | y |
-* * | any | boop |
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*/
-rules[ 'stdlib/jsdoc-table-pipe-alignment' ] = 'error';
+ * Require table pipes to be aligned.
+ *
+ * @name jsdoc-table-pipe-alignment
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Boop beep.
+ * *
+ * * | x | y |
+ * * | any | boop |
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Boop beep.
+ * *
+ * * | x | y |
+ * * | any | boop |
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ */
+rules["stdlib/jsdoc-table-pipe-alignment"] = "error";
/**
-* Require pipes as fences for table rows.
-*
-* @name jsdoc-table-pipes
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-*
-* /**
-* * Boop beep.
-* *
-* * x | y
-* * any | boop
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Boop beep.
-* *
-* * | x | y |
-* * | any | boop |
-* *
-* * @returns {string} a value
-* *
-* * @example
-* * var str = beep();
-* * // returns 'boop'
-* *\/
-* function beep() {
-* return 'boop';
-* }
-*/
-rules[ 'stdlib/jsdoc-table-pipes' ] = 'error';
+ * Require pipes as fences for table rows.
+ *
+ * @name jsdoc-table-pipes
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Boop beep.
+ * *
+ * * x | y
+ * * any | boop
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Boop beep.
+ * *
+ * * | x | y |
+ * * | any | boop |
+ * *
+ * * @returns {string} a value
+ * *
+ * * @example
+ * * var str = beep();
+ * * // returns 'boop'
+ * *\/
+ * function beep() {
+ * return 'boop';
+ * }
+ */
+rules["stdlib/jsdoc-table-pipes"] = "error";
/**
-* Require that only allowed JSDoc tags are used.
-*
-* @name jsdoc-tag-names
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-*
-* /**
-* * Squares a number.
-* *
-* * @arg {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Squares a number.
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*/
-rules[ 'stdlib/jsdoc-tag-names' ] = 'error';
+ * Require that only allowed JSDoc tags are used.
+ *
+ * @name jsdoc-tag-names
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * @arg {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ */
+rules["stdlib/jsdoc-tag-names"] = "error";
/**
-* Require that JSDoc tags follow a specified order.
-*
-* @name jsdoc-tag-order
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-*
-* /**
-* * Squares a number.
-* *
-* * @returns {number} x squared
-* * @param {number} x - input number
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Squares a number.
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*/
-rules[ 'stdlib/jsdoc-tag-order' ] = 'error';
+ * Require that JSDoc tags follow a specified order.
+ *
+ * @name jsdoc-tag-order
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * @returns {number} x squared
+ * * @param {number} x - input number
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ */
+rules["stdlib/jsdoc-tag-order"] = "error";
/* eslint-disable stdlib/jsdoc-tag-spacing */
/**
-* Require that JSDoc tags are properly padded with spaces.
-*
-* @name jsdoc-tag-spacing
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-*
-* /**
-* * Squares a number.
-* *
-* * @param{number} x - input number
-* *@returns {number }x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Squares a number.
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*/
-rules[ 'stdlib/jsdoc-tag-spacing' ] = 'error';
+ * Require that JSDoc tags are properly padded with spaces.
+ *
+ * @name jsdoc-tag-spacing
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * @param{number} x - input number
+ * *@returns {number }x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ */
+rules["stdlib/jsdoc-tag-spacing"] = "error";
/* eslint-enable stdlib/jsdoc-tag-spacing */
/**
-* Require that type definitions of JSDoc tags do not contain any typos.
-*
-* @name jsdoc-typedef-typos
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-*
-* /**
-* * Squares a number.
-* *
-* * @param {number} x - input number
-* * @returns {numbr} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Squares a number.
-* *
-* * @param {number} x - input number
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*/
-rules[ 'stdlib/jsdoc-typedef-typos' ] = 'error';
+ * Require that type definitions of JSDoc tags do not contain any typos.
+ *
+ * @name jsdoc-typedef-typos
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * @param {number} x - input number
+ * * @returns {numbr} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * @param {number} x - input number
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ */
+rules["stdlib/jsdoc-typedef-typos"] = "error";
/**
-* Require that the unordered list marker be a dash `-`.
-*
-* @name jsdoc-unordered-list-marker-style
-* @memberof rules
-* @type {Array}
-* @default [ 'error', '-' ]
-* @see [unordered-list-marker-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-unordered-list-marker-style}
-*
-* @example
-* // Bad...
-*
-* /**
-* * Squares a number.
-* *
-* * * foo
-* * * bar
-* * * beep
-* * * boop
-* *
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*
-* @example
-* // Good...
-*
-* /**
-* * Squares a number.
-* *
-* * - foo
-* * - bar
-* * - beep
-* * - boop
-* *
-* * @returns {number} x squared
-* *
-* * @example
-* * var y = square( 2.0 );
-* * // returns 4.0
-* *\/
-* function square( x ) {
-* return x*x;
-* }
-*/
-rules[ 'stdlib/jsdoc-unordered-list-marker-style' ] = [ 'error', '-' ];
+ * Require that the unordered list marker be a dash `-`.
+ *
+ * @name jsdoc-unordered-list-marker-style
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', '-' ]
+ * @see [unordered-list-marker-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-unordered-list-marker-style}
+ *
+ * @example
+ * // Bad...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * * foo
+ * * * bar
+ * * * beep
+ * * * boop
+ * *
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * /**
+ * * Squares a number.
+ * *
+ * * - foo
+ * * - bar
+ * * - beep
+ * * - boop
+ * *
+ * * @returns {number} x squared
+ * *
+ * * @example
+ * * var y = square( 2.0 );
+ * * // returns 4.0
+ * *\/
+ * function square( x ) {
+ * return x*x;
+ * }
+ */
+rules["stdlib/jsdoc-unordered-list-marker-style"] = ["error", "-"];
/**
-* Enforce that the JSDoc comment documenting a package's main export adheres to stdlib conventions and contains the correct package path.
-*
-* @name jsdoc-main-export
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad @stdlib/assert/is-array` main export:
-*
-* /**
-* * Tests if a value is an array.
-* *
-* * @module @stdlib/assert/isarray
-* *
-* * @example
-* * var isArray = require( '@stdlib/assert/is-aray' );
-* *
-* * var bool = isArray( [] );
-* * // returns true
-* *
-* * bool = isArray( {} );
-* * // returns false
-* *\/
-*
-* @example
-* // Good `@stdlib/assert/is-array` main export:
-*
-* /**
-* * Test if a value is an array.
-* *
-* * @module @stdlib/assert/is-array
-* *
-* * @example
-* * var isArray = require( '@stdlib/assert/is-array' );
-* *
-* * var bool = isArray( [] );
-* * // returns true
-* *
-* * bool = isArray( {} );
-* * // returns false
-* *\/
-*/
-rules[ 'stdlib/jsdoc-main-export' ] = 'error';
+ * Enforce that the JSDoc comment documenting a package's main export adheres to stdlib conventions and contains the correct package path.
+ *
+ * @name jsdoc-main-export
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad @stdlib/assert/is-array` main export:
+ *
+ * /**
+ * * Tests if a value is an array.
+ * *
+ * * @module @stdlib/assert/isarray
+ * *
+ * * @example
+ * * var isArray = require( '@stdlib/assert/is-aray' );
+ * *
+ * * var bool = isArray( [] );
+ * * // returns true
+ * *
+ * * bool = isArray( {} );
+ * * // returns false
+ * *\/
+ *
+ * @example
+ * // Good `@stdlib/assert/is-array` main export:
+ *
+ * /**
+ * * Test if a value is an array.
+ * *
+ * * @module @stdlib/assert/is-array
+ * *
+ * * @example
+ * * var isArray = require( '@stdlib/assert/is-array' );
+ * *
+ * * var bool = isArray( [] );
+ * * // returns true
+ * *
+ * * bool = isArray( {} );
+ * * // returns false
+ * *\/
+ */
+rules["stdlib/jsdoc-main-export"] = "error";
/**
-* Disallow spaces between a closing parenthesis or bracket and a nested object or array expression at the beginning of a line.
-*
-* @name line-closing-bracket-spacing
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-* var log = require( '@stdlib/console/log' );
-*
-* log({
-* 'foo': true
-* } );
-*
-* log([
-* 1,
-* 2,
-* 3
-* ] );
-*
-* log([{
-* 'bar': true
-* } ] );
-*
-* @example
-* // Good...
-* var log = require( '@stdlib/console/log' );
-*
-* log({
-* 'foo': true
-* });
-*
-* log([
-* 1,
-* 2,
-* 3
-* ]);
-*
-* log([{
-* 'bar': true
-* }]);
-*/
-rules[ 'stdlib/line-closing-bracket-spacing' ] = 'error';
+ * Disallow spaces between a closing parenthesis or bracket and a nested object or array expression at the beginning of a line.
+ *
+ * @name line-closing-bracket-spacing
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ * var log = require( '@stdlib/console/log' );
+ *
+ * log({
+ * 'foo': true
+ * } );
+ *
+ * log([
+ * 1,
+ * 2,
+ * 3
+ * ] );
+ *
+ * log([{
+ * 'bar': true
+ * } ] );
+ *
+ * @example
+ * // Good...
+ * var log = require( '@stdlib/console/log' );
+ *
+ * log({
+ * 'foo': true
+ * });
+ *
+ * log([
+ * 1,
+ * 2,
+ * 3
+ * ]);
+ *
+ * log([{
+ * 'bar': true
+ * }]);
+ */
+rules["stdlib/line-closing-bracket-spacing"] = "error";
/**
-* Enforce that export statements are placed at the end of a file.
-*
-* @name module-exports-last
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-* var randn = require( './randn.js' );
-*
-* module.exports = randn;
-*
-* var factory = require( './factory.js' );
-*
-* module.exports.factory = factory;
-*
-* @example
-* // Good...
-* var randn = require( './randn.js' );
-* var factory = require( './factory.js' );
-*
-* module.exports = randn;
-* module.exports.factory = factory;
-*/
-rules[ 'stdlib/module-exports-last' ] = 'error';
+ * Enforce that export statements are placed at the end of a file.
+ *
+ * @name module-exports-last
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ * var randn = require( './randn.js' );
+ *
+ * module.exports = randn;
+ *
+ * var factory = require( './factory.js' );
+ *
+ * module.exports.factory = factory;
+ *
+ * @example
+ * // Good...
+ * var randn = require( './randn.js' );
+ * var factory = require( './factory.js' );
+ *
+ * module.exports = randn;
+ * module.exports.factory = factory;
+ */
+rules["stdlib/module-exports-last"] = "error";
/**
-* Enforce that a namespace `index.js` exports all packages in the respective namespace directory.
-*
-* @name namespace-export-all
-* @memberof rules
-* @type {string}
-* @default 'warn'
-*/
-rules[ 'stdlib/namespace-export-all' ] = 'warn';
+ * Enforce that a namespace `index.js` exports all packages in the respective namespace directory.
+ *
+ * @name namespace-export-all
+ * @memberof rules
+ * @type {string}
+ * @default 'warn'
+ */
+rules["stdlib/namespace-export-all"] = "warn";
/**
-* Enforce that packages in a namespace `index.js` file are listed in alphabetical order.
-*
-* @name namespace-index-order
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-* /*
-* * When adding modules to the namespace, ensure that they are added in alphabetical order * according to module name.
-* *\/
-*
-* // MODULES //
-*
-* var setReadOnly = require( '@stdlib/utils/define-read-only-property' );
-*
-* // MAIN //
-*
-* var ns = {};
-*
-* /**
-* * @name MAX_TYPED_ARRAY_LENGTH
-* * @memberof ns
-* * @see {@link module:@stdlib/constants/array/max-typed-array-length}
-* *\/
-* setReadOnly( ns, 'MAX_TYPED_ARRAY_LENGTH', require( '@stdlib/constants/array/max-typed-array-length' ) );
-*
-* /**
-* * @name MAX_ARRAY_LENGTH
-* * @memberof ns
-* * @see {@link module:@stdlib/constants/array/max-array-length}
-* *\/
-* setReadOnly( ns, 'MAX_ARRAY_LENGTH', require( '@stdlib/constants/array/max-array-length' ) );
-*
-* @example
-* // Good...
-* /*
-* * When adding modules to the namespace, ensure that they are added in alphabetical order * according to module name.
-* *\/
-*
-* // MODULES //
-*
-* var setReadOnly = require( '@stdlib/utils/define-read-only-property' );
-*
-* // MAIN //
-*
-* var ns = {};
-*
-* /**
-* * @name MAX_ARRAY_LENGTH
-* * @memberof ns
-* * @see {@link module:@stdlib/constants/array/max-array-length}
-* *\/
-* setReadOnly( ns, 'MAX_ARRAY_LENGTH', require( '@stdlib/constants/array/max-array-length' ) );
-*
-* /**
-* * @name MAX_TYPED_ARRAY_LENGTH
-* * @memberof ns
-* * @see {@link module:@stdlib/constants/array/max-typed-array-length}
-* *\/
-* setReadOnly( ns, 'MAX_TYPED_ARRAY_LENGTH', require( '@stdlib/constants/array/max-typed-array-length' ) );
-*/
-rules[ 'stdlib/namespace-index-order' ] = 'error';
+ * Enforce that packages in a namespace `index.js` file are listed in alphabetical order.
+ *
+ * @name namespace-index-order
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ * /*
+ * * When adding modules to the namespace, ensure that they are added in alphabetical order * according to module name.
+ * *\/
+ *
+ * // MODULES //
+ *
+ * var setReadOnly = require( '@stdlib/utils/define-read-only-property' );
+ *
+ * // MAIN //
+ *
+ * var ns = {};
+ *
+ * /**
+ * * @name MAX_TYPED_ARRAY_LENGTH
+ * * @memberof ns
+ * * @see {@link module:@stdlib/constants/array/max-typed-array-length}
+ * *\/
+ * setReadOnly( ns, 'MAX_TYPED_ARRAY_LENGTH', require( '@stdlib/constants/array/max-typed-array-length' ) );
+ *
+ * /**
+ * * @name MAX_ARRAY_LENGTH
+ * * @memberof ns
+ * * @see {@link module:@stdlib/constants/array/max-array-length}
+ * *\/
+ * setReadOnly( ns, 'MAX_ARRAY_LENGTH', require( '@stdlib/constants/array/max-array-length' ) );
+ *
+ * @example
+ * // Good...
+ * /*
+ * * When adding modules to the namespace, ensure that they are added in alphabetical order * according to module name.
+ * *\/
+ *
+ * // MODULES //
+ *
+ * var setReadOnly = require( '@stdlib/utils/define-read-only-property' );
+ *
+ * // MAIN //
+ *
+ * var ns = {};
+ *
+ * /**
+ * * @name MAX_ARRAY_LENGTH
+ * * @memberof ns
+ * * @see {@link module:@stdlib/constants/array/max-array-length}
+ * *\/
+ * setReadOnly( ns, 'MAX_ARRAY_LENGTH', require( '@stdlib/constants/array/max-array-length' ) );
+ *
+ * /**
+ * * @name MAX_TYPED_ARRAY_LENGTH
+ * * @memberof ns
+ * * @see {@link module:@stdlib/constants/array/max-typed-array-length}
+ * *\/
+ * setReadOnly( ns, 'MAX_TYPED_ARRAY_LENGTH', require( '@stdlib/constants/array/max-typed-array-length' ) );
+ */
+rules["stdlib/namespace-index-order"] = "error";
/**
-* Enforce that the `Array` constructor is invoked with the `new` keyword.
-*
-* @name new-cap-array
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-* var arr = Array( 101 );
-*
-* @example
-* // Good...
-* var arr = new Array( 101 );
-*/
-rules[ 'stdlib/new-cap-array' ] = 'error';
+ * Enforce that the `Array` constructor is invoked with the `new` keyword.
+ *
+ * @name new-cap-array
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ * var arr = Array( 101 );
+ *
+ * @example
+ * // Good...
+ * var arr = new Array( 101 );
+ */
+rules["stdlib/new-cap-array"] = "error";
/**
-* Enforce that error constructors are invoked with the `new` keyword.
-*
-* @name new-cap-error
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-* var err = Error( 'error message' );
-*
-* @example
-* // Good...
-* var err = new Error( 'error message' );
-*/
-rules[ 'stdlib/new-cap-error' ] = 'error';
+ * Enforce that error constructors are invoked with the `new` keyword.
+ *
+ * @name new-cap-error
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ * var err = Error( 'error message' );
+ *
+ * @example
+ * // Good...
+ * var err = new Error( 'error message' );
+ */
+rules["stdlib/new-cap-error"] = "error";
/**
-* Enforce that the `RegExp` constructor is invoked with the `new` keyword.
-*
-* @name new-cap-regexp
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-* var re = RegExp( '[0-9]' );
-*
-* @example
-* // Good...
-* var re = new RegExp( '[0-9]' );
-*/
-rules[ 'stdlib/new-cap-regexp' ] = 'error';
+ * Enforce that the `RegExp` constructor is invoked with the `new` keyword.
+ *
+ * @name new-cap-regexp
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ * var re = RegExp( '[0-9]' );
+ *
+ * @example
+ * // Good...
+ * var re = new RegExp( '[0-9]' );
+ */
+rules["stdlib/new-cap-regexp"] = "error";
/**
-* Enforce that `require()` calls have only string literals as parameters.
-*
-* @name no-dynamic-require
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-* var pkg = '@stdlib/math/base/special/betainc';
-* var betainc = require( pkg );
-*
-* @example
-* // Good...
-* var betainc = require( '@stdlib/math/base/special/betainc' );
-*/
-rules[ 'stdlib/no-dynamic-require' ] = 'error';
+ * Enforce that `require()` calls have only string literals as parameters.
+ *
+ * @name no-dynamic-require
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ * var pkg = '@stdlib/math/base/special/betainc';
+ * var betainc = require( pkg );
+ *
+ * @example
+ * // Good...
+ * var betainc = require( '@stdlib/math/base/special/betainc' );
+ */
+rules["stdlib/no-dynamic-require"] = "error";
/**
-* Disallow empty comments.
-*
-* @name no-empty-comments
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-* function square( x ) {
-* var out;
-*
-* //
-* out = x*x;
-* return out;
-* }
-*
-* @example
-* // Good...
-* function square( x ) {
-* var out;
-*
-* // Square the number:
-* out = x*x;
-* return out;
-* }
-*/
-rules[ 'stdlib/no-empty-comments' ] = 'error';
+ * Disallow empty comments.
+ *
+ * @name no-empty-comments
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ * function square( x ) {
+ * var out;
+ *
+ * //
+ * out = x*x;
+ * return out;
+ * }
+ *
+ * @example
+ * // Good...
+ * function square( x ) {
+ * var out;
+ *
+ * // Square the number:
+ * out = x*x;
+ * return out;
+ * }
+ */
+rules["stdlib/no-empty-comments"] = "error";
/**
-* Enforce that `require()` expressions are not immediately invoked.
-*
-* @name no-immediate-require
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-* var debug = require( 'debug' )( 'stdlib' );
-*
-* @example
-* // Good...
-* var logger = require( 'debug' );
-* var debug = logger( 'stdlib' );
-*/
-rules[ 'stdlib/no-immediate-require' ] = 'error';
+ * Enforce that `require()` expressions are not immediately invoked.
+ *
+ * @name no-immediate-require
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ * var debug = require( 'debug' )( 'stdlib' );
+ *
+ * @example
+ * // Good...
+ * var logger = require( 'debug' );
+ * var debug = logger( 'stdlib' );
+ */
+rules["stdlib/no-immediate-require"] = "error";
/**
-* Disallow `require()` calls of another package's internals.
-*
-* @name no-internal-require
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-* var betainc = require( '@stdlib/math/base/special/betainc/lib/index.js' );
-*
-* @example
-* // Good...
-* var betainc = require( '@stdlib/math/base/special/betainc' );
-*/
-rules[ 'stdlib/no-internal-require' ] = 'error';
+ * Disallow `require()` calls of another package's internals.
+ *
+ * @name no-internal-require
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ * var betainc = require( '@stdlib/math/base/special/betainc/lib/index.js' );
+ *
+ * @example
+ * // Good...
+ * var betainc = require( '@stdlib/math/base/special/betainc' );
+ */
+rules["stdlib/no-internal-require"] = "error";
/**
-* Disallow multiple blank lines.
-*
-* @name no-multiple-empty-lines
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-*
-* // MAIN //
-*
-* function xlogy( x, y ) {
-* if ( x === 0.0 && !isnan( y ) ) {
-* return 0.0;
-* }
-*
-* return x * ln( y );
-* }
-*
-* @example
-* // Good...
-*
-* // MAIN //
-*
-* function xlogy( x, y ) {
-* if ( x === 0.0 && !isnan( y ) ) {
-* return 0.0;
-* }
-* return x * ln( y );
-* }
-*/
-rules[ 'stdlib/no-multiple-empty-lines' ] = 'error';
+ * Disallow multiple blank lines.
+ *
+ * @name no-multiple-empty-lines
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ *
+ * // MAIN //
+ *
+ * function xlogy( x, y ) {
+ * if ( x === 0.0 && !isnan( y ) ) {
+ * return 0.0;
+ * }
+ *
+ * return x * ln( y );
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * // MAIN //
+ *
+ * function xlogy( x, y ) {
+ * if ( x === 0.0 && !isnan( y ) ) {
+ * return 0.0;
+ * }
+ * return x * ln( y );
+ * }
+ */
+rules["stdlib/no-multiple-empty-lines"] = "error";
/**
-* Disallow usage of the built-in global `Math` object.
-*
-* @name no-builtin-math
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-* var out = Math.exp( 2.0 );
-* // returns ~7.389
-*
-* @example
-* // Good...
-* var exp = require( '@stdlib/math/base/special/exp' );
-* var out = exp( 2.0 );
-* // returns ~7.389
-*/
-rules[ 'stdlib/no-builtin-math' ] = 'error';
+ * Disallow usage of the built-in global `Math` object.
+ *
+ * @name no-builtin-math
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ * var out = Math.exp( 2.0 );
+ * // returns ~7.389
+ *
+ * @example
+ * // Good...
+ * var exp = require( '@stdlib/math/base/special/exp' );
+ * var out = exp( 2.0 );
+ * // returns ~7.389
+ */
+rules["stdlib/no-builtin-math"] = "error";
/**
-* Enforce that only variables and functions are assigned to `module.exports`.
-*
-* @name no-dynamic-exports
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-* var normal = require( '@stdlib/random/base/normal' );
-* var beta = require( '@stdlib/random/base/beta' );
-*
-* // EXPORTS //
-*
-* module.exports = {
-* 'normal': normal,
-* 'beta': beta
-* };
-*
-* @example
-* // Good...
-* var normal = require( '@stdlib/random/base/normal' );
-* var beta = require( '@stdlib/random/base/beta' );
-*
-* // VARIABLES //
-*
-* var ns = {
-* 'normal': normal,
-* 'beta': beta
-* };
-*
-* // EXPORTS //
-*
-* module.exports = ns;
-*/
-rules[ 'stdlib/no-dynamic-exports' ] = 'error';
+ * Enforce that only variables and functions are assigned to `module.exports`.
+ *
+ * @name no-dynamic-exports
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ * var normal = require( '@stdlib/random/base/normal' );
+ * var beta = require( '@stdlib/random/base/beta' );
+ *
+ * // EXPORTS //
+ *
+ * module.exports = {
+ * 'normal': normal,
+ * 'beta': beta
+ * };
+ *
+ * @example
+ * // Good...
+ * var normal = require( '@stdlib/random/base/normal' );
+ * var beta = require( '@stdlib/random/base/beta' );
+ *
+ * // VARIABLES //
+ *
+ * var ns = {
+ * 'normal': normal,
+ * 'beta': beta
+ * };
+ *
+ * // EXPORTS //
+ *
+ * module.exports = ns;
+ */
+rules["stdlib/no-dynamic-exports"] = "error";
/**
-* Enforce that one does not use nested property access for `require()` expressions.
-*
-* @name no-nested-require
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-* var special = require( '@stdlib' ).math.base.special;
-*
-* @example
-* // Good...
-* var special = require( '@stdlib/math/base' ).special;
-*
-* @example
-* // Good...
-* var special = require( '@stdlib/math/base/special' );
-*/
-rules[ 'stdlib/no-nested-require' ] = 'error';
+ * Enforce that one does not use nested property access for `require()` expressions.
+ *
+ * @name no-nested-require
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ * var special = require( '@stdlib' ).math.base.special;
+ *
+ * @example
+ * // Good...
+ * var special = require( '@stdlib/math/base' ).special;
+ *
+ * @example
+ * // Good...
+ * var special = require( '@stdlib/math/base/special' );
+ */
+rules["stdlib/no-nested-require"] = "error";
/**
-* Disallow the use of the `new Array()` constructor.
-*
-* @name no-new-array
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-* var arr = new Array( 5 );
-* var i;
-* for ( i = 0; i < 5; i++ ) {
-* arr[ i ] = i;
-* }
-*
-* console.log( arr );
-* // => [ 0, 1, 2, 3, 4 ]
-*
-* @example
-* // Good...
-* var arr = [];
-* var i;
-* for ( i = 0; i < 5; i++ ) {
-* arr.push( i );
-* }
-*
-* console.log( arr );
-* // => [ 0, 1, 2, 3, 4 ]
-*/
-rules[ 'stdlib/no-new-array' ] = 'error';
+ * Disallow the use of the `new Array()` constructor.
+ *
+ * @name no-new-array
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ * var arr = new Array( 5 );
+ * var i;
+ * for ( i = 0; i < 5; i++ ) {
+ * arr[ i ] = i;
+ * }
+ *
+ * console.log( arr );
+ * // => [ 0, 1, 2, 3, 4 ]
+ *
+ * @example
+ * // Good...
+ * var arr = [];
+ * var i;
+ * for ( i = 0; i < 5; i++ ) {
+ * arr.push( i );
+ * }
+ *
+ * console.log( arr );
+ * // => [ 0, 1, 2, 3, 4 ]
+ */
+rules["stdlib/no-new-array"] = "error";
/**
-* Never allow a variable to be declared multiple times within the same scope or for built-in globals to be redeclared.
-*
-* @name no-redeclare
-* @memberof rules
-* @type {Array}
-* @see [no-redeclare]{@link https://eslint.org/docs/rules/no-redeclare}
-*
-* @example
-* // Bad...
-* var a = 'beep';
-* // ...
-* var a = 'boop';
-*
-* @example
-* // Good...
-* var a = 'beep';
-* // ...
-* a = 'boop';
-*/
-rules[ 'stdlib/no-redeclare' ] = [ 'error', {
- 'builtinGlobals': true,
- 'globalsWhitelist': [
- 'Array',
- 'ArrayBuffer',
- 'Boolean',
- 'Buffer', // Node.js
- 'DataView',
- 'Date',
- 'Error',
- 'EvalError',
- 'Float32Array',
- 'Float64Array',
- 'Function',
- 'Int8Array',
- 'Int16Array',
- 'Int32Array',
- 'Map',
- 'Number',
- 'Object',
- 'process', // Node.js
- 'Promise',
- 'Proxy',
- 'RangeError',
- 'ReferenceError',
- 'RegExp',
- 'Set',
- 'SharedArrayBuffer',
- 'String',
- 'Symbol',
- 'SyntaxError',
- 'TypeError',
- 'Uint8Array',
- 'Uint8ClampedArray',
- 'Uint16Array',
- 'Uint32Array',
- 'URIError',
- 'WebAssembly'
- ]
-}];
+ * Never allow a variable to be declared multiple times within the same scope or for built-in globals to be redeclared.
+ *
+ * @name no-redeclare
+ * @memberof rules
+ * @type {Array}
+ * @see [no-redeclare]{@link https://eslint.org/docs/rules/no-redeclare}
+ *
+ * @example
+ * // Bad...
+ * var a = 'beep';
+ * // ...
+ * var a = 'boop';
+ *
+ * @example
+ * // Good...
+ * var a = 'beep';
+ * // ...
+ * a = 'boop';
+ */
+rules["stdlib/no-redeclare"] = [
+ "error",
+ {
+ builtinGlobals: true,
+ globalsWhitelist: [
+ "Array",
+ "ArrayBuffer",
+ "Boolean",
+ "Buffer", // Node.js
+ "DataView",
+ "Date",
+ "Error",
+ "EvalError",
+ "Float32Array",
+ "Float64Array",
+ "Function",
+ "Int8Array",
+ "Int16Array",
+ "Int32Array",
+ "Map",
+ "Number",
+ "Object",
+ "process", // Node.js
+ "Promise",
+ "Proxy",
+ "RangeError",
+ "ReferenceError",
+ "RegExp",
+ "Set",
+ "SharedArrayBuffer",
+ "String",
+ "Symbol",
+ "SyntaxError",
+ "TypeError",
+ "Uint8Array",
+ "Uint8ClampedArray",
+ "Uint16Array",
+ "Uint32Array",
+ "URIError",
+ "WebAssembly",
+ ],
+ },
+];
/**
-* Never allow `require()` calls of absolute file paths.
-*
-* @name no-require-absolute-path
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-* var stdlib = require( '/path/to/stdlib' );
-*
-* @example
-* // Good...
-* var stdlib = require( '@stdlib' );
-*/
-rules[ 'stdlib/no-require-absolute-path' ] = 'error';
+ * Never allow `require()` calls of absolute file paths.
+ *
+ * @name no-require-absolute-path
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ * var stdlib = require( '/path/to/stdlib' );
+ *
+ * @example
+ * // Good...
+ * var stdlib = require( '@stdlib' );
+ */
+rules["stdlib/no-require-absolute-path"] = "error";
/**
-* Never allow `require()` calls to explicitly require `index.<ext>` files.
-*
-* @name no-require-index
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-* var debug = require( 'debug/index.js' );
-*
-* @example
-* // Good...
-* var debug = require( 'debug' );
-*/
-rules[ 'stdlib/no-require-index' ] = 'error';
+ * Never allow `require()` calls to explicitly require `index.<ext>` files.
+ *
+ * @name no-require-index
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ * var debug = require( 'debug/index.js' );
+ *
+ * @example
+ * // Good...
+ * var debug = require( 'debug' );
+ */
+rules["stdlib/no-require-index"] = "error";
/**
-* Never allow modules to require themselves.
-*
-* @name no-self-require
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-* var self = require( __filename );
-*
-* @example
-* // Good...
-* var other = require( './other.js' );
-*/
-rules[ 'stdlib/no-self-require' ] = 'error';
+ * Never allow modules to require themselves.
+ *
+ * @name no-self-require
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ * var self = require( __filename );
+ *
+ * @example
+ * // Good...
+ * var other = require( './other.js' );
+ */
+rules["stdlib/no-self-require"] = "error";
/**
-* Never allow unassigned `require()` calls.
-*
-* @name no-unassigned-require
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-* require( '@stdlib' );
-*
-* @example
-* // Good...
-* var stdlib = require( '@stdlib' );
-*/
-rules[ 'stdlib/no-unassigned-require' ] = 'error';
+ * Never allow unassigned `require()` calls.
+ *
+ * @name no-unassigned-require
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ * require( '@stdlib' );
+ *
+ * @example
+ * // Good...
+ * var stdlib = require( '@stdlib' );
+ */
+rules["stdlib/no-unassigned-require"] = "error";
/**
-* Enforce that packages are added to a REPL namespace object in alphabetical order according to alias (namespace key). Set by default to `off`, the rule is enabled for namespace files via overriding the default option.
-*
-* @name repl-namespace-order
-* @memberof rules
-* @type {string}
-* @default 'off'
-*
-* @example
-* // Bad...
-* var ns = [];
-*
-* ns.push({
-* 'alias': 'hasMapSupport',
-* 'path': '@stdlib/assert/has-map-support',
-* 'value': require( '@stdlib/assert/has-map-support' ),
-* 'type': 'Function',
-* 'related': []
-* });
-*
-* ns.push({
-* 'alias': 'hasInt8ArraySupport',
-* 'path': '@stdlib/assert/has-int8array-support',
-* 'value': require( '@stdlib/assert/has-int8array-support' ),
-* 'type': 'Function',
-* 'related': []
-* });
-*
-* @example
-* // Good...
-* var ns = [];
-*
-* ns.push({
-* 'alias': 'hasInt8ArraySupport',
-* 'path': '@stdlib/assert/has-int8array-support',
-* 'value': require( '@stdlib/assert/has-int8array-support' ),
-* 'type': 'Function',
-* 'related': []
-* });
-*
-* ns.push({
-* 'alias': 'hasMapSupport',
-* 'path': '@stdlib/assert/has-map-support',
-* 'value': require( '@stdlib/assert/has-map-support' ),
-* 'type': 'Function',
-* 'related': []
-* });
-*/
-rules[ 'stdlib/repl-namespace-order' ] = 'off';
+ * Enforce that packages are added to a REPL namespace object in alphabetical order according to alias (namespace key). Set by default to `off`, the rule is enabled for namespace files via overriding the default option.
+ *
+ * @name repl-namespace-order
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ *
+ * @example
+ * // Bad...
+ * var ns = [];
+ *
+ * ns.push({
+ * 'alias': 'hasMapSupport',
+ * 'path': '@stdlib/assert/has-map-support',
+ * 'value': require( '@stdlib/assert/has-map-support' ),
+ * 'type': 'Function',
+ * 'related': []
+ * });
+ *
+ * ns.push({
+ * 'alias': 'hasInt8ArraySupport',
+ * 'path': '@stdlib/assert/has-int8array-support',
+ * 'value': require( '@stdlib/assert/has-int8array-support' ),
+ * 'type': 'Function',
+ * 'related': []
+ * });
+ *
+ * @example
+ * // Good...
+ * var ns = [];
+ *
+ * ns.push({
+ * 'alias': 'hasInt8ArraySupport',
+ * 'path': '@stdlib/assert/has-int8array-support',
+ * 'value': require( '@stdlib/assert/has-int8array-support' ),
+ * 'type': 'Function',
+ * 'related': []
+ * });
+ *
+ * ns.push({
+ * 'alias': 'hasMapSupport',
+ * 'path': '@stdlib/assert/has-map-support',
+ * 'value': require( '@stdlib/assert/has-map-support' ),
+ * 'type': 'Function',
+ * 'related': []
+ * });
+ */
+rules["stdlib/repl-namespace-order"] = "off";
/**
-* Enforce that `require()` calls of files end with a whitelisted file extension.
-*
-* @name require-file-extensions
-* @memberof rules
-* @type {Array}
-* @default [ 'error', { 'extensionsWhitelist': [ '.js', '.json', '.node' ] } ]
-*
-* @example
-* // Bad...
-*
-* // Invalid file extension:
-* var readme = require( '@stdlib/array/int32/README.md' );
-*
-* // Missing file extension:
-* var debug = require( 'debug/src/browser' );
-*
-* @example
-* // Good...
-*
-* var Int32Array = require( '@stdlib/array/int32' );
-*
-* var debug = require( 'debug/src/browser.js' );
-*/
-rules[ 'stdlib/require-file-extensions' ] = [ 'error', {
- 'extensionsWhitelist': [
- '.js',
- '.json',
- '.node'
- ]
-}];
+ * Enforce that `require()` calls of files end with a whitelisted file extension.
+ *
+ * @name require-file-extensions
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', { 'extensionsWhitelist': [ '.js', '.json', '.node' ] } ]
+ *
+ * @example
+ * // Bad...
+ *
+ * // Invalid file extension:
+ * var readme = require( '@stdlib/array/int32/README.md' );
+ *
+ * // Missing file extension:
+ * var debug = require( 'debug/src/browser' );
+ *
+ * @example
+ * // Good...
+ *
+ * var Int32Array = require( '@stdlib/array/int32' );
+ *
+ * var debug = require( 'debug/src/browser.js' );
+ */
+rules["stdlib/require-file-extensions"] = [
+ "error",
+ {
+ extensionsWhitelist: [".js", ".json", ".node"],
+ },
+];
/**
-* Enforce that specified globals are explicitly required.
-*
-* @name require-globals
-* @memberof rules
-* @type {Array}
-*
-* @example
-* // Bad...
-* var arr = new Float32Array();
-*
-* @example
-* // Good...
-* var Float32Array = require( '@stdlib/array/float32' );
-*
-* var arr = new Float32Array();
-*/
-rules[ 'stdlib/require-globals' ] = [ 'error', {
- 'globals': [
- 'ArrayBuffer',
- 'BigInt', // ES11/ES2020
- 'BigInt64Array', // ES11/ES2020
- 'BigUint64Array', // ES11/ES2020
- 'Boolean',
- 'Buffer', // Node.js
- 'DataView',
- 'Float32Array',
- 'Float64Array',
- 'Function',
- 'Int8Array',
- 'Int16Array',
- 'Int32Array',
- 'Number',
- 'Object',
- 'Promise', // ES6/ES2015
- 'process', // Node.js
- 'Proxy', // ES6/2015
- 'SharedArrayBuffer',
- 'Symbol', // ES6/ES2015
- 'Uint8Array',
- 'Uint8ClampedArray',
- 'Uint16Array',
- 'Uint32Array'
- ]
-}];
+ * Enforce that specified globals are explicitly required.
+ *
+ * @name require-globals
+ * @memberof rules
+ * @type {Array}
+ *
+ * @example
+ * // Bad...
+ * var arr = new Float32Array();
+ *
+ * @example
+ * // Good...
+ * var Float32Array = require( '@stdlib/array/float32' );
+ *
+ * var arr = new Float32Array();
+ */
+rules["stdlib/require-globals"] = [
+ "error",
+ {
+ globals: [
+ "ArrayBuffer",
+ "BigInt", // ES11/ES2020
+ "BigInt64Array", // ES11/ES2020
+ "BigUint64Array", // ES11/ES2020
+ "Boolean",
+ "Buffer", // Node.js
+ "DataView",
+ "Float32Array",
+ "Float64Array",
+ "Function",
+ "Int8Array",
+ "Int16Array",
+ "Int32Array",
+ "Number",
+ "Object",
+ "Promise", // ES6/ES2015
+ "process", // Node.js
+ "Proxy", // ES6/2015
+ "SharedArrayBuffer",
+ "Symbol", // ES6/ES2015
+ "Uint8Array",
+ "Uint8ClampedArray",
+ "Uint16Array",
+ "Uint32Array",
+ ],
+ },
+];
/**
-* Disallow `require()` calls of relative paths which do not begin with a leading `./`.
-*
-* @name require-leading-slash
-* @memberof rules
-* @type {string}
-*
-* @example
-* // Bad...
-* var foo = require( 'foo/bar.js' );
-* var baz = require( '../baz.js' );
-*
-* @example
-* // Good...
-* var foo = require( './foo/bar.js' );
-* var baz = require( './../baz.js' );
-*/
-rules[ 'stdlib/require-leading-slash' ] = 'error';
+ * Disallow `require()` calls of relative paths which do not begin with a leading `./`.
+ *
+ * @name require-leading-slash
+ * @memberof rules
+ * @type {string}
+ *
+ * @example
+ * // Bad...
+ * var foo = require( 'foo/bar.js' );
+ * var baz = require( '../baz.js' );
+ *
+ * @example
+ * // Good...
+ * var foo = require( './foo/bar.js' );
+ * var baz = require( './../baz.js' );
+ */
+rules["stdlib/require-leading-slash"] = "error";
/**
-* Enforce spaces inside `require()` parentheses.
-*
-* @name require-spaces
-* @memberof rules
-* @type {string}
-*
-* @example
-* // Bad...
-* var foo = require('@stdlib/foo');
-*
-* @example
-* // Good...
-* var foo = require( '@stdlib/foo' );
-*/
-rules[ 'stdlib/require-spaces' ] = 'error';
+ * Enforce spaces inside `require()` parentheses.
+ *
+ * @name require-spaces
+ * @memberof rules
+ * @type {string}
+ *
+ * @example
+ * // Bad...
+ * var foo = require('@stdlib/foo');
+ *
+ * @example
+ * // Good...
+ * var foo = require( '@stdlib/foo' );
+ */
+rules["stdlib/require-spaces"] = "error";
/**
-* Enforce that `require()` calls follow a specified order.
-*
-* @name require-order
-* @memberof rules
-* @type {Array}
-*
-* @example
-* // Bad...
-* var validate = require( './validate.js' );
-* var math = require( '@stdlib/math' );
-* var debug = require( 'debug' );
-* var fs = require( 'fs' );
-*
-* @example
-* // Good...
-* var fs = require( 'fs' );
-* var debug = require( 'debug' );
-* var math = require( '@stdlib/math' );
-* var validate = require( './validate.js' );
-*/
-rules[ 'stdlib/require-order' ] = [ 'error', {
- 'order': [
- 'builtin',
- 'external',
- '/^@stdlib/',
- 'path'
- ]
-}];
+ * Enforce that `require()` calls follow a specified order.
+ *
+ * @name require-order
+ * @memberof rules
+ * @type {Array}
+ *
+ * @example
+ * // Bad...
+ * var validate = require( './validate.js' );
+ * var math = require( '@stdlib/math' );
+ * var debug = require( 'debug' );
+ * var fs = require( 'fs' );
+ *
+ * @example
+ * // Good...
+ * var fs = require( 'fs' );
+ * var debug = require( 'debug' );
+ * var math = require( '@stdlib/math' );
+ * var validate = require( './validate.js' );
+ */
+rules["stdlib/require-order"] = [
+ "error",
+ {
+ order: ["builtin", "external", "/^@stdlib/", "path"],
+ },
+];
/**
-* Enforce formatting of section header comments.
-*
-* @name section-headers
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad... (require two trailing slashes)
-*
-* // EXPORTS
-*
-* module.exports = {};
-*
-* @example
-* // Bad... (require a known header type)
-*
-* // EXPRTS //
-*
-* module.exports = {};
-*
-* @example
-* // Bad... (require all uppercase letters)
-*
-* // EXPorts //
-*
-* module.exports = {};
-*
-* @example
-* // Good...
-*
-* // EXPORTS //
-*
-* module.exports = {};
-*/
-rules[ 'stdlib/section-headers' ] = 'error';
+ * Enforce formatting of section header comments.
+ *
+ * @name section-headers
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad... (require two trailing slashes)
+ *
+ * // EXPORTS
+ *
+ * module.exports = {};
+ *
+ * @example
+ * // Bad... (require a known header type)
+ *
+ * // EXPRTS //
+ *
+ * module.exports = {};
+ *
+ * @example
+ * // Bad... (require all uppercase letters)
+ *
+ * // EXPorts //
+ *
+ * module.exports = {};
+ *
+ * @example
+ * // Good...
+ *
+ * // EXPORTS //
+ *
+ * module.exports = {};
+ */
+rules["stdlib/section-headers"] = "error";
/**
-* Ensure that a tape file starts with the expected test.
-*
-* @name first-unit-test
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-*
-* var tape = require( 'tape' );
-* var identity = require( './../lib' );
-*
-* tape( 'the function works correctly', function test( t ) {
-* t.strictEqual( identity( true ), true, 'returns true' );
-* t.end();
-* });
-*
-* @example
-* // Good...
-*
-* var tape = require( 'tape' );
-* var identity = require( './../lib' );
-*
-* tape( 'main export is a function', function test( t ) {
-* t.ok( true, __filename );
-* t.strictEqual( typeof identity, 'function', 'main export is a function' );
-* t.end();
-* });
-*/
-rules[ 'stdlib/first-unit-test' ] = 'error';
+ * Ensure that a tape file starts with the expected test.
+ *
+ * @name first-unit-test
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ *
+ * var tape = require( 'tape' );
+ * var identity = require( './../lib' );
+ *
+ * tape( 'the function works correctly', function test( t ) {
+ * t.strictEqual( identity( true ), true, 'returns true' );
+ * t.end();
+ * });
+ *
+ * @example
+ * // Good...
+ *
+ * var tape = require( 'tape' );
+ * var identity = require( './../lib' );
+ *
+ * tape( 'main export is a function', function test( t ) {
+ * t.ok( true, __filename );
+ * t.strictEqual( typeof identity, 'function', 'main export is a function' );
+ * t.end();
+ * });
+ */
+rules["stdlib/first-unit-test"] = "error";
/**
-* Require parentheses around ternary conditions.
-*
-* @name ternary-condition-parentheses
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-*
-* var randu = require( '@stdlib/random/base/randu' );
-*
-* var bool = randu() > 0.5 ? 1 : 0;
-*
-* @example
-* // Good...
-*
-* var randu = require( '@stdlib/random/base/randu' );
-*
-* var bool = ( randu() > 0.5 ) ? 1 : 0;
-*/
-rules[ 'stdlib/ternary-condition-parentheses' ] = 'error';
+ * Require parentheses around ternary conditions.
+ *
+ * @name ternary-condition-parentheses
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ *
+ * var randu = require( '@stdlib/random/base/randu' );
+ *
+ * var bool = randu() > 0.5 ? 1 : 0;
+ *
+ * @example
+ * // Good...
+ *
+ * var randu = require( '@stdlib/random/base/randu' );
+ *
+ * var bool = ( randu() > 0.5 ) ? 1 : 0;
+ */
+rules["stdlib/ternary-condition-parentheses"] = "error";
/**
-* Enforce that required stdlib constants have uppercase variable names.
-*
-* @name uppercase-required-constants
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-*
-* var eps = require( '@stdlib/constants/math/float64-eps' );
-*
-* @example
-* // Good...
-*
-* var EPS = require( '@stdlib/constants/math/float64-eps' );
-*/
-rules[ 'stdlib/uppercase-required-constants' ] = 'error';
+ * Enforce that required stdlib constants have uppercase variable names.
+ *
+ * @name uppercase-required-constants
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ *
+ * var eps = require( '@stdlib/constants/math/float64-eps' );
+ *
+ * @example
+ * // Good...
+ *
+ * var EPS = require( '@stdlib/constants/math/float64-eps' );
+ */
+rules["stdlib/uppercase-required-constants"] = "error";
/**
-* Require section headers to be padded with empty lines.
-*
-* @name section-header-empty-lines
-* @memberof rules
-* @type {string}
-* @default 'error'
-*
-* @example
-* // Bad...
-*
-* // EXPORTS //
-* module.exports = {};
-*
-* @example
-* // Good...
-*
-* // EXPORTS //
-*
-* module.exports = {};
-*/
-rules[ 'stdlib/section-header-empty-lines' ] = 'error';
+ * Require section headers to be padded with empty lines.
+ *
+ * @name section-header-empty-lines
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ *
+ * @example
+ * // Bad...
+ *
+ * // EXPORTS //
+ * module.exports = {};
+ *
+ * @example
+ * // Good...
+ *
+ * // EXPORTS //
+ *
+ * module.exports = {};
+ */
+rules["stdlib/section-header-empty-lines"] = "error";
/**
-* Require variable declarations inside of functions to be ordered by length.
-*
-* @name vars-order
-* @memberof rules
-* @type {string}
-*
-* @example
-* // Bad...
-*
-* function fizzBuzz() {
-* var i;
-* var out;
-*
-* for ( i = 1; i <= 100; i++ ) {
-* out = ( i % 5 === 0 ) ? "Buzz" : ( i % 3 === 0 ) ? "Fizz" : i;
-* console.log( out );
-* }
-* }
-*
-* @example
-* // Good...
-*
-* function fizzBuzz() {
-* var out;
-* var i;
-*
-* for ( i = 1; i <= 100; i++ ) {
-* out = ( i % 5 === 0 ) ? "Buzz" : ( i % 3 === 0 ) ? "Fizz" : i;
-* console.log( out );
-* }
-* }
-*/
-rules[ 'stdlib/vars-order' ] = [ 'error', {
- 'order': 'decreasing'
-}];
-
+ * Require variable declarations inside of functions to be ordered by length.
+ *
+ * @name vars-order
+ * @memberof rules
+ * @type {string}
+ *
+ * @example
+ * // Bad...
+ *
+ * function fizzBuzz() {
+ * var i;
+ * var out;
+ *
+ * for ( i = 1; i <= 100; i++ ) {
+ * out = ( i % 5 === 0 ) ? "Buzz" : ( i % 3 === 0 ) ? "Fizz" : i;
+ * console.log( out );
+ * }
+ * }
+ *
+ * @example
+ * // Good...
+ *
+ * function fizzBuzz() {
+ * var out;
+ * var i;
+ *
+ * for ( i = 1; i <= 100; i++ ) {
+ * out = ( i % 5 === 0 ) ? "Buzz" : ( i % 3 === 0 ) ? "Fizz" : i;
+ * console.log( out );
+ * }
+ * }
+ */
+rules["stdlib/vars-order"] = [
+ "error",
+ {
+ order: "decreasing",
+ },
+];
// EXPORTS //
diff --git a/etc/eslint/rules/strict.js b/etc/eslint/rules/strict.js
index e63f5063d59e..7037e3528559 100644
--- a/etc/eslint/rules/strict.js
+++ b/etc/eslint/rules/strict.js
@@ -1,55 +1,54 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
/**
-* ESLint rules for using strict mode.
-*
-* @namespace rules
-*/
+ * ESLint rules for using strict mode.
+ *
+ * @namespace rules
+ */
var rules = {};
/**
-* Always require `use strict` to be used globally.
-*
-* @name strict
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'global' ]
-* @see [strict]{@link https://eslint.org/docs/rules/strict}
-*
-* @example
-* // Bad...
-* function foo() {
-* 'use strict';
-* // Do something...
-* }
-*
-* @example
-* // Good...
-* 'use strict';
-* function foo(){
-* // Do something...
-* }
-*/
-rules[ 'strict' ] = [ 'error', 'global' ];
-
+ * Always require `use strict` to be used globally.
+ *
+ * @name strict
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'global' ]
+ * @see [strict]{@link https://eslint.org/docs/rules/strict}
+ *
+ * @example
+ * // Bad...
+ * function foo() {
+ * 'use strict';
+ * // Do something...
+ * }
+ *
+ * @example
+ * // Good...
+ * 'use strict';
+ * function foo(){
+ * // Do something...
+ * }
+ */
+rules["strict"] = ["error", "global"];
// EXPORTS //
diff --git a/etc/eslint/rules/style.js b/etc/eslint/rules/style.js
index debda46d3ce9..e40c4b782de7 100644
--- a/etc/eslint/rules/style.js
+++ b/etc/eslint/rules/style.js
@@ -1,2064 +1,2199 @@
/**
-* @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.
-*/
+ * @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";
+
+/**
+ * ESLint rules which enforce style.
+ *
+ * @namespace rules
+ */
+var rules = {};
-'use strict';
+/**
+ * Always requiring line breaks if line breaks already exist between array elements. NOTE: disabled to allow some freedom in determining best presentation. In general, prefer line breaks if already using line breaks.
+ *
+ * @name array-bracket-newline
+ * @memberof rules
+ * @type {Array}
+ * @see [array-bracket-newline]{@link https://eslint.org/docs/rules/array-bracket-newline}
+ *
+ * @example
+ * // Bad...
+ * var arr = [
+ * 1, 2
+ * ];
+ *
+ * @example
+ * // Good...
+ * var arr = [
+ * 1,
+ * 2
+ * ];
+ */
+rules["array-bracket-newline"] = [
+ "off",
+ {
+ multiline: true,
+ minItems: null,
+ },
+];
/**
-* ESLint rules which enforce style.
-*
-* @namespace rules
-*/
-var rules = {};
+ * Warn when not having spaces within array brackets. NOTE: disabled as difficult to enforce a general rule. Prefer spaces within array brackets, but allow discretion in balancing readability, clarity, and aesthetics.
+ *
+ * @name array-bracket-spacing
+ * @memberof rules
+ * @type {Array}
+ * @see [array-bracket-spacing]{@link https://eslint.org/docs/rules/array-bracket-spacing}
+ *
+ * @example
+ * // Bad...
+ * var arr = [5];
+ *
+ * @example
+ * // Good...
+ * var arr = [ 5 ];
+ *
+ * @example
+ * // Okay...
+ * var arr = [ [ 1 ], [ 2 ] ];
+ *
+ * @example
+ * // Okay...
+ * var arr = [[ 1 ], [ 2 ]];
+ *
+ * @example
+ * // Okay...
+ * var arr = [ [1], [2] ];
+ */
+rules["array-bracket-spacing"] = [
+ "off",
+ "always",
+ {
+ singleValue: true,
+ objectsInArrays: false,
+ arraysInArrays: false,
+ },
+];
/**
-* Always requiring line breaks if line breaks already exist between array elements. NOTE: disabled to allow some freedom in determining best presentation. In general, prefer line breaks if already using line breaks.
-*
-* @name array-bracket-newline
-* @memberof rules
-* @type {Array}
-* @see [array-bracket-newline]{@link https://eslint.org/docs/rules/array-bracket-newline}
-*
-* @example
-* // Bad...
-* var arr = [
-* 1, 2
-* ];
-*
-* @example
-* // Good...
-* var arr = [
-* 1,
-* 2
-* ];
-*/
-rules[ 'array-bracket-newline' ] = [ 'off', {
- 'multiline': true,
- 'minItems': null
-}];
+ * Enforce consistent line breaks between array elements.
+ *
+ * @name array-element-newline
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'consistent' ]
+ * @see [array-element-newline]{@link https://eslint.org/docs/rules/array-element-newline}
+ *
+ * @example
+ * // Bad...
+ * var arr = [
+ * 1, 2,
+ * 3
+ * ];
+ *
+ * @example
+ * // Okay...
+ * var arr = [ 1, 2, 3 ];
+ *
+ * @example
+ * // Okay...
+ * var arr = [
+ * 1,
+ * 2,
+ * 3
+ * ];
+ */
+rules["array-element-newline"] = ["error", "consistent"];
+
+/**
+ * Always require spaces in single-line blocks.
+ *
+ * @name block-spacing
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'always' ]
+ * @see [block-spacing]{@link https://eslint.org/docs/rules/block-spacing}
+ *
+ * @example
+ * // Bad...
+ * function foo( x ) {
+ * if ( x === 5 ) {return x;}
+ * }
+ *
+ * @example
+ * // Good...
+ * function foo( x ) {
+ * if ( x === 5 ) { return x; }
+ * }
+ */
+rules["block-spacing"] = ["error", "always"];
+
+/**
+ * Prefer "one true brace style", but allow consideration of readability and aesthetics.
+ *
+ * @name brace-style
+ * @memberof rules
+ * @type {Array}
+ * @see [brace-style]{@link https://eslint.org/docs/rules/brace-style}
+ *
+ * @example
+ * // Bad...
+ * function foo( x ) {
+ * if ( x !== x )
+ * {
+ * return NaN;
+ * }
+ * }
+ *
+ * @example
+ * // Bad...
+ * function foo( x ) {
+ * if ( x !== x ) { return NaN; }
+ * }
+ *
+ * @example
+ * // Good...
+ * if ( x < 10.0 ) {
+ * y = foo( x );
+ * } else {
+ * y = bar( x );
+ * }
+ *
+ * @example
+ * // Okay...
+ * if ( x < 10.0 ) {
+ * y = foo( x );
+ * }
+ * // Mid-range approximation...
+ * else if ( x < 20.0 ) {
+ * y = bar( x );
+ * }
+ * // Large approximation...
+ * else {
+ * y = beep( x );
+ * }
+ */
+rules["brace-style"] = [
+ "off",
+ "1tbs",
+ {
+ allowSingleLine: false,
+ },
+];
/**
-* Warn when not having spaces within array brackets. NOTE: disabled as difficult to enforce a general rule. Prefer spaces within array brackets, but allow discretion in balancing readability, clarity, and aesthetics.
-*
-* @name array-bracket-spacing
-* @memberof rules
-* @type {Array}
-* @see [array-bracket-spacing]{@link https://eslint.org/docs/rules/array-bracket-spacing}
-*
-* @example
-* // Bad...
-* var arr = [5];
-*
-* @example
-* // Good...
-* var arr = [ 5 ];
-*
-* @example
-* // Okay...
-* var arr = [ [ 1 ], [ 2 ] ];
-*
-* @example
-* // Okay...
-* var arr = [[ 1 ], [ 2 ]];
-*
-* @example
-* // Okay...
-* var arr = [ [1], [2] ];
-*/
-rules[ 'array-bracket-spacing' ] = [ 'off', 'always', {
- 'singleValue': true,
- 'objectsInArrays': false,
- 'arraysInArrays': false
-}];
+ * Require camelcased variable names, but relax the restriction for property names.
+ *
+ * @name camelcase
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', {'properties':'never'} ]
+ * @see [camelcase]{@link https://eslint.org/docs/rules/camelcase}
+ *
+ * @example
+ * // Bad...
+ * var beep_boop = true;
+ *
+ * @example
+ * // Good...
+ * var beepBoop = true;
+ *
+ * @example
+ * // Okay...
+ * var obj = {
+ * 'beep_boop': true
+ * };
+ */
+rules["camelcase"] = [
+ "error",
+ {
+ properties: "never",
+ },
+];
/**
-* Enforce consistent line breaks between array elements.
-*
-* @name array-element-newline
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'consistent' ]
-* @see [array-element-newline]{@link https://eslint.org/docs/rules/array-element-newline}
-*
-* @example
-* // Bad...
-* var arr = [
-* 1, 2,
-* 3
-* ];
-*
-* @example
-* // Okay...
-* var arr = [ 1, 2, 3 ];
-*
-* @example
-* // Okay...
-* var arr = [
-* 1,
-* 2,
-* 3
-* ];
-*/
-rules[ 'array-element-newline' ] = [ 'error', 'consistent' ];
+ * Require that the first letter of a comment be capitalized, but relax this restriction for inline comments.
+ *
+ * @name capitalized-comments
+ * @memberof rules
+ * @type {Array}
+ * @see [capitalized-comments]{@link https://eslint.org/docs/rules/capitalized-comments}
+ *
+ * @example
+ * // Good...
+ *
+ * @example
+ * // bad...
+ */
+rules["capitalized-comments"] = [
+ "off",
+ "always",
+ {
+ ignoreInlineComments: true,
+ },
+];
/**
-* Always require spaces in single-line blocks.
-*
-* @name block-spacing
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'always' ]
-* @see [block-spacing]{@link https://eslint.org/docs/rules/block-spacing}
-*
-* @example
-* // Bad...
-* function foo( x ) {
-* if ( x === 5 ) {return x;}
-* }
-*
-* @example
-* // Good...
-* function foo( x ) {
-* if ( x === 5 ) { return x; }
-* }
-*/
-rules[ 'block-spacing' ] = [ 'error', 'always' ];
+ * Never allow trailing commas.
+ *
+ * @name comma-dangle
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'never' ]
+ * @see [comma-dangle]{@link https://eslint.org/docs/rules/comma-dangle}
+ *
+ * @example
+ * // Bad...
+ * var obj = {
+ * 'beep': true,
+ * };
+ *
+ * @example
+ * // Good...
+ * var obj = {
+ * 'beep': true
+ * }
+ */
+rules["comma-dangle"] = ["error", "never"];
+
+/**
+ * Require a space after a comma, but never before.
+ *
+ * @name comma-spacing
+ * @memberof rules
+ * @type {Array}
+ * @see [comma-spacing]{@link https://eslint.org/docs/rules/comma-spacing}
+ *
+ * @example
+ * // Bad...
+ * var x = 5,y = 8;
+ *
+ * @example
+ * // Bad...
+ * var x = 5 ,y = 8;
+ *
+ * @example
+ * // Good...
+ * var x = 5, y = 8;
+ */
+rules["comma-spacing"] = [
+ "error",
+ {
+ before: false,
+ after: true,
+ },
+];
+
+/**
+ * Require a comma after and on the same line as an array element, object property, or variable declaration.
+ *
+ * @name comma-style
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'last' ]
+ * @see [comma-style]{@link https://eslint.org/docs/rules/comma-style}
+ *
+ * @example
+ * // Bad...
+ * var obj = {
+ * 'beep': true
+ * , 'boop': true
+ * };
+ *
+ * @example
+ * // Good...
+ * var obj = {
+ * 'beep': true,
+ * 'boop': true
+ * };
+ */
+rules["comma-style"] = ["error", "last"];
+
+/**
+ * Prefer using whitespace within computed properties. NOTE: disabled, as hard to enforce a general rule. While whitespace is preferred, readability and clarity is preferred to a greater extent.
+ *
+ * @name computed-property-spacing
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'off', 'always' ]
+ * @see [computed-property-spacing]{@link https://eslint.org/docs/rules/computed-property-spacing}
+ *
+ * @example
+ * // Bad...
+ * var x = obj[prop];
+ *
+ * @example
+ * // Okay...
+ * var i = 1;
+ * var x = (1+y[i]) * 10;
+ *
+ * @example
+ * // Good...
+ * var x = obj[ prop ];
+ */
+rules["computed-property-spacing"] = ["off", "always"];
+
+/**
+ * Require a `this` variable to only be aliased as `self`.
+ *
+ * @name consistent-this
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'self' ]
+ * @see [consistent-this]{@link https://eslint.org/docs/rules/consistent-this}
+ *
+ * @example
+ * // Bad...
+ * var that = this;
+ *
+ * @example
+ * // Good...
+ * var self = this;
+ */
+rules["consistent-this"] = ["error", "self"];
+
+/**
+ * Always require an end-of-line character at the end of non-empty files, thus allowing for appending to and concatenating files.
+ *
+ * @name eol-last
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'always' ]
+ * @see [eol-last]{@link https://eslint.org/docs/rules/eol-last}
+ */
+rules["eol-last"] = ["error", "always"];
+
+/**
+ * Never allow a space between function identifiers and their invocations.
+ *
+ * @name func-call-spacing
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'never' ]
+ * @see [func-call-spacing]{@link https://eslint.org/docs/rules/func-call-spacing}
+ *
+ * @example
+ * // Bad...
+ * foo ();
+ *
+ * @example
+ * // Good...
+ * foo();
+ */
+rules["func-call-spacing"] = ["error", "never"];
+
+/**
+ * Do not require that a variable name match a function name or property.
+ *
+ * @name func-name-matching
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [func-name-matching]{@link https://eslint.org/docs/rules/func-name-matching}
+ *
+ * @example
+ * // Okay...
+ * var f = obj.foo;
+ */
+rules["func-name-matching"] = "off";
+
+/**
+ * Always require that functions have a name to aid debugging.
+ *
+ * @name func-names
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'always' ]
+ * @see [func-names]{@link https://eslint.org/docs/rules/func-names}
+ *
+ * @example
+ * // Bad...
+ * var foo = function() {
+ * // Do something...
+ * };
+ *
+ * @example
+ * // Good...
+ * var foo = function foo() {
+ * // Do something...
+ * };
+ *
+ * @example
+ * // Better...
+ * function foo() {
+ * // Do something...
+ * }
+ */
+rules["func-names"] = ["error", "always"];
+
+/**
+ * Always require function declarations and never allow function expressions or arrow functions.
+ *
+ * @name func-style
+ * @memberof rules
+ * @type {Array}
+ * @see [func-style]{@link https://eslint.org/docs/rules/func-style}
+ *
+ * @example
+ * // Bad...
+ * var foo = function() {
+ * // Do something...
+ * };
+ *
+ * @example
+ * // Good...
+ * function foo() {
+ * // Do something...
+ * }
+ */
+rules["func-style"] = [
+ "error",
+ "declaration",
+ {
+ allowArrowFunctions: false,
+ },
+];
+
+/**
+ * Never allow linebreaks between arguments of a function call.
+ *
+ * @name function-call-argument-newline
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'never' ]
+ * @see [function-call-argument-newline]{@link https://eslint.org/docs/rules/function-call-argument-newline}
+ *
+ * @example
+ * // Bad...
+ * function foo(
+ * x,
+ * y
+ * ) {
+ * return x + y;
+ * }
+ *
+ * @example
+ * // Bad...
+ * console.log(
+ * 1,
+ * 2
+ * );
+ *
+ * @example
+ * // Good...
+ * function foo( x, y ) {
+ * return x + y;
+ * }
+ *
+ * @example
+ * // Good...
+ * console.log( 1, 2 );
+ */
+rules["function-call-argument-newline"] = ["error", "never"];
+
+/**
+ * Never allow linebreaks inside parentheses of function parameters or arguments.
+ *
+ * @name function-paren-newline
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'never' ]
+ * @see [function-paren-newline]{@link https://eslint.org/docs/rules/function-paren-newline}
+ *
+ * @example
+ * // Bad...
+ * function foo(
+ * x,
+ * y
+ * ) {
+ * return x + y;
+ * }
+ *
+ * @example
+ * // Bad...
+ * console.log(
+ * 1,
+ * 2
+ * );
+ *
+ * @example
+ * // Good...
+ * function foo( x, y ) {
+ * return x + y;
+ * }
+ *
+ * @example
+ * // Good...
+ * console.log( 1, 2 );
+ */
+rules["function-paren-newline"] = ["error", "never"];
+
+/**
+ * Do not blacklist any identifiers.
+ *
+ * @name id-blacklist
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [id-blacklist]{@link https://eslint.org/docs/rules/id-blacklist}
+ */
+rules["id-blacklist"] = "off";
+
+/**
+ * Warn if the length of an identifier name exceeds `25` characters.
+ *
+ * @name id-length
+ * @memberof rules
+ * @type {Array}
+ * @see [id-length]{@link https://eslint.org/docs/rules/id-length}
+ */
+rules["id-length"] = [
+ "warn",
+ {
+ min: 1,
+ max: 25,
+ properties: "never",
+ },
+];
+
+/**
+ * Do not impose draconian name restrictions.
+ *
+ * @name id-match
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [id-match]{@link https://eslint.org/docs/rules/id-match}
+ */
+rules["id-match"] = "off";
+
+/**
+ * Do not allow a newline before an arrow function body.
+ *
+ * @name implicit-arrow-linebreak
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'beside' ]
+ * @see [implicit-arrow-linebreak]{@link https://eslint.org/docs/rules/implicit-arrow-linebreak}
+ *
+ * @example
+ * // Bad...
+ * (foo) =>
+ * bar;
+ *
+ * @example
+ * // Okay...
+ * (foo) => bar;
+ */
+rules["implicit-arrow-linebreak"] = ["error", "beside"];
+
+/**
+ * Require tabs, except for `case` statements.
+ *
+ * @name indent
+ * @memberof rules
+ * @type {Array}
+ * @see [indent]{@link https://eslint.org/docs/rules/indent}
+ */
+rules["indent"] = [
+ "error",
+ "tab",
+ {
+ SwitchCase: 0,
+ VariableDeclarator: 1,
+ outerIIFEBody: 1,
+ MemberExpression: 1,
+ FunctionDeclaration: {
+ body: 1,
+ parameters: "off",
+ },
+ FunctionExpression: {
+ body: 1,
+ parameters: "off",
+ },
+ CallExpression: {
+ arguments: "off",
+ },
+ ArrayExpression: 1,
+ ObjectExpression: 1,
+ flatTernaryExpressions: true,
+ },
+];
+
+/**
+ * Disable rule for JSX quotes.
+ *
+ * @name jsx-quotes
+ * @memberof rules
+ * @type {string}
+ * @see [jsx-quotes]{@link https://eslint.org/docs/rules/jsx-quotes}
+ */
+rules["jsx-quotes"] = "off";
+
+/**
+ * Require a space after, but not before, the colon separating an object property from a corresponding value.
+ *
+ * @name key-spacing
+ * @memberof rules
+ * @type {Array}
+ * @see [key-spacing]{@link https://eslint.org/docs/rules/key-spacing}
+ *
+ * @example
+ * // Bad...
+ * var obj = {
+ * 'beep' : 'boop'
+ * };
+ *
+ * @example
+ * // Good...
+ * var obj = {
+ * 'beep': 'boop'
+ * };
+ */
+rules["key-spacing"] = [
+ "error",
+ {
+ beforeColon: false,
+ afterColon: true,
+ mode: "strict",
+ },
+];
/**
-* Prefer "one true brace style", but allow consideration of readability and aesthetics.
+* Require spaces around keywords.
*
-* @name brace-style
+* @name keyword-spacing
* @memberof rules
* @type {Array}
-* @see [brace-style]{@link https://eslint.org/docs/rules/brace-style}
-*
-* @example
-* // Bad...
-* function foo( x ) {
-* if ( x !== x )
-* {
-* return NaN;
-* }
-* }
+* @see [keyword-spacing]{@link https://eslint.org/docs/rules/keyword-spacing}
*
* @example
* // Bad...
-* function foo( x ) {
-* if ( x !== x ) { return NaN; }
-* }
-*
-* @example
-* // Good...
-* if ( x < 10.0 ) {
+* if( x < 10 ){
* y = foo( x );
-* } else {
+* }else{
* y = bar( x );
-* }
+}
*
* @example
-* // Okay...
-* if ( x < 10.0 ) {
+* // Good...
+* if ( x!== x ) {
* y = foo( x );
-* }
-* // Mid-range approximation...
-* else if ( x < 20.0 ) {
+* } else {
* y = bar( x );
* }
-* // Large approximation...
-* else {
-* y = beep( x );
-* }
*/
-rules[ 'brace-style' ] = [ 'off', '1tbs', {
- 'allowSingleLine': false
-}];
+rules["keyword-spacing"] = [
+ "error",
+ {
+ before: true,
+ after: true,
+ },
+];
/**
-* Require camelcased variable names, but relax the restriction for property names.
-*
-* @name camelcase
-* @memberof rules
-* @type {Array}
-* @default [ 'error', {'properties':'never'} ]
-* @see [camelcase]{@link https://eslint.org/docs/rules/camelcase}
-*
-* @example
-* // Bad...
-* var beep_boop = true;
-*
-* @example
-* // Good...
-* var beepBoop = true;
-*
-* @example
-* // Okay...
-* var obj = {
-* 'beep_boop': true
-* };
-*/
-rules[ 'camelcase' ] = [ 'error', {
- 'properties': 'never'
-}];
+ * Allow comments either above or beside code.
+ *
+ * @name line-comment-position
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [line-comment-position]{@link https://eslint.org/docs/rules/line-comment-position}
+ */
+rules["line-comment-position"] = "off";
+
+/**
+ * Enforce Unix-style line breaks.
+ *
+ * @name linebreak-style
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'unix' ]
+ * @see [linebreak-style]{@link https://eslint.org/docs/rules/linebreak-style}
+ */
+rules["linebreak-style"] = ["error", "unix"];
+
+/**
+ * Prefer empty lines before comments.
+ *
+ * @name lines-around-comment
+ * @memberof rules
+ * @type {Array}
+ * @see [lines-around-comment]{@link https://eslint.org/docs/rules/lines-around-comment}
+ *
+ * @example
+ * // Bad...
+ * var x = 5;
+ * // Line comment:
+ * var y = 10;
+ *
+ * @example
+ * // Good...
+ * var x = 5;
+ *
+ * // Line comment:
+ * var y = 10;
+ */
+rules["lines-around-comment"] = [
+ "off",
+ {
+ // NOTE: disabled to allow some discretion in terms of readability, clarity, and terseness.
+ beforeBlockComment: true,
+ afterBlockComment: false,
+ beforeLineComment: true,
+ afterLineComment: false,
+ allowBlockStart: true,
+ allowBlockEnd: true,
+ allowObjectStart: true,
+ allowObjectEnd: true,
+ allowArrayStart: true,
+ allowArrayEnd: true,
+ allowClassStart: true,
+ allowClassEnd: true,
+ },
+];
/**
-* Require that the first letter of a comment be capitalized, but relax this restriction for inline comments.
-*
-* @name capitalized-comments
-* @memberof rules
-* @type {Array}
-* @see [capitalized-comments]{@link https://eslint.org/docs/rules/capitalized-comments}
-*
-* @example
-* // Good...
-*
-* @example
-* // bad...
-*/
-rules[ 'capitalized-comments' ] = [ 'off', 'always', {
- 'ignoreInlineComments': true
-}];
+ * Do not allow lines between class members.
+ *
+ * @name lines-between-class-members
+ * @memberof rules
+ * @type {Array}
+ * @see [lines-between-class-members]{@link https://eslint.org/docs/rules/lines-between-class-members}
+ *
+ * @example
+ * // Bad...
+ * class Foo {
+ * bar() {}
+ *
+ * baz() {}
+ * }
+ *
+ * @example
+ * // Okay...
+ * class Foo {
+ * bar() {}
+ * baz() {}
+ * }
+ */
+rules["lines-between-class-members"] = [
+ "error",
+ "never",
+ {
+ exceptAfterSingleLine: false,
+ },
+];
/**
-* Never allow trailing commas.
-*
-* @name comma-dangle
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'never' ]
-* @see [comma-dangle]{@link https://eslint.org/docs/rules/comma-dangle}
-*
-* @example
-* // Bad...
-* var obj = {
-* 'beep': true,
-* };
-*
-* @example
-* // Good...
-* var obj = {
-* 'beep': true
-* }
-*/
-rules[ 'comma-dangle' ] = [ 'error', 'never' ];
+ * Enforce a maximum depth that blocks can be nested.
+ *
+ * @name max-depth
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', {'max': 5} ]
+ * @see [max-depth]{@link https://eslint.org/docs/rules/max-depth}
+ */
+rules["max-depth"] = [
+ "error",
+ {
+ max: 5,
+ },
+];
/**
-* Require a space after a comma, but never before.
-*
-* @name comma-spacing
-* @memberof rules
-* @type {Array}
-* @see [comma-spacing]{@link https://eslint.org/docs/rules/comma-spacing}
-*
-* @example
-* // Bad...
-* var x = 5,y = 8;
-*
-* @example
-* // Bad...
-* var x = 5 ,y = 8;
-*
-* @example
-* // Good...
-* var x = 5, y = 8;
-*/
-rules[ 'comma-spacing' ] = [ 'error', {
- 'before': false,
- 'after': true
-}];
+ * Do not allow a line to exceed a maximum line length.
+ *
+ * @name max-len
+ * @memberof rules
+ * @type {Array}
+ * @see [max-len]{@link https://eslint.org/docs/rules/max-len}
+ */
+rules["max-len"] = [
+ "warn",
+ {
+ code: 80,
+ tabWidth: 4,
+ ignoreComments: true,
+ ignoreUrls: true,
+ ignoreStrings: true,
+ ignoreTemplateLiterals: true,
+ ignoreRegExpLiterals: true,
+ },
+];
/**
-* Require a comma after and on the same line as an array element, object property, or variable declaration.
-*
-* @name comma-style
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'last' ]
-* @see [comma-style]{@link https://eslint.org/docs/rules/comma-style}
-*
-* @example
-* // Bad...
-* var obj = {
-* 'beep': true
-* , 'boop': true
-* };
-*
-* @example
-* // Good...
-* var obj = {
-* 'beep': true,
-* 'boop': true
-* };
-*/
-rules[ 'comma-style' ] = [ 'error', 'last' ];
+ * Limit the number of source code lines in a file.
+ *
+ * @name max-lines
+ * @memberof rules
+ * @type {Array}
+ * @see [max-lines]{@link https://eslint.org/docs/rules/max-lines}
+ */
+rules["max-lines"] = [
+ "warn",
+ {
+ max: 300,
+ skipBlankLines: true,
+ skipComments: true,
+ },
+];
/**
-* Prefer using whitespace within computed properties. NOTE: disabled, as hard to enforce a general rule. While whitespace is preferred, readability and clarity is preferred to a greater extent.
-*
-* @name computed-property-spacing
-* @memberof rules
-* @type {Array}
-* @default [ 'off', 'always' ]
-* @see [computed-property-spacing]{@link https://eslint.org/docs/rules/computed-property-spacing}
-*
-* @example
-* // Bad...
-* var x = obj[prop];
-*
-* @example
-* // Okay...
-* var i = 1;
-* var x = (1+y[i]) * 10;
-*
-* @example
-* // Good...
-* var x = obj[ prop ];
-*/
-rules[ 'computed-property-spacing' ] = [ 'off', 'always' ];
+ * Warn when a function contains more than `200` source code lines.
+ *
+ * @name max-lines-per-function
+ * @memberof rules
+ * @type {Array}
+ * @see [max-lines-per-function]{@link https://eslint.org/docs/rules/max-lines-per-function}
+ */
+rules["max-lines-per-function"] = [
+ "warn",
+ {
+ max: 200,
+ skipBlankLines: true,
+ skipComments: true,
+ IIFEs: true,
+ },
+];
/**
-* Require a `this` variable to only be aliased as `self`.
-*
-* @name consistent-this
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'self' ]
-* @see [consistent-this]{@link https://eslint.org/docs/rules/consistent-this}
-*
-* @example
-* // Bad...
-* var that = this;
-*
-* @example
-* // Good...
-* var self = this;
-*/
-rules[ 'consistent-this' ] = [ 'error', 'self' ];
+ * Limit the number of nested callbacks.
+ *
+ * @name max-nested-callbacks
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', {'max': 3} ]
+ * @see [max-nested-callbacks]{@link https://eslint.org/docs/rules/max-nested-callbacks}
+ */
+rules["max-nested-callbacks"] = [
+ "error",
+ {
+ max: 3,
+ },
+];
/**
-* Always require an end-of-line character at the end of non-empty files, thus allowing for appending to and concatenating files.
-*
-* @name eol-last
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'always' ]
-* @see [eol-last]{@link https://eslint.org/docs/rules/eol-last}
-*/
-rules[ 'eol-last' ] = [ 'error', 'always' ];
+ * Never allow more than `10` parameters.
+ *
+ * @name max-params
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', {'max': 10} ]
+ * @see [max-params]{@link https://eslint.org/docs/rules/max-params}
+ */
+rules["max-params"] = [
+ "error",
+ {
+ max: 10,
+ },
+];
/**
-* Never allow a space between function identifiers and their invocations.
-*
-* @name func-call-spacing
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'never' ]
-* @see [func-call-spacing]{@link https://eslint.org/docs/rules/func-call-spacing}
-*
-* @example
-* // Bad...
-* foo ();
-*
-* @example
-* // Good...
-* foo();
-*/
-rules[ 'func-call-spacing' ] = [ 'error', 'never' ];
+ * Warn when a function has more than `100` statements.
+ *
+ * @name max-statements
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'warn', {'max': 100} ]
+ * @see [max-statements]{@link https://eslint.org/docs/rules/max-statements}
+ */
+rules["max-statements"] = [
+ "warn",
+ {
+ max: 100,
+ },
+];
/**
-* Do not require that a variable name match a function name or property.
-*
-* @name func-name-matching
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [func-name-matching]{@link https://eslint.org/docs/rules/func-name-matching}
-*
-* @example
-* // Okay...
-* var f = obj.foo;
-*/
-rules[ 'func-name-matching' ] = 'off';
+ * Require only `1` statement per line.
+ *
+ * @name max-statements-per-line
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', {'max': 1} ]
+ * @see [max-statements-per-line]{@link https://eslint.org/docs/rules/max-statements-per-line}
+ */
+rules["max-statements-per-line"] = [
+ "error",
+ {
+ max: 1,
+ },
+];
/**
-* Always require that functions have a name to aid debugging.
-*
-* @name func-names
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'always' ]
-* @see [func-names]{@link https://eslint.org/docs/rules/func-names}
-*
-* @example
-* // Bad...
-* var foo = function() {
-* // Do something...
-* };
-*
-* @example
-* // Good...
-* var foo = function foo() {
-* // Do something...
-* };
-*
-* @example
-* // Better...
-* function foo() {
-* // Do something...
-* }
-*/
-rules[ 'func-names' ] = [ 'error', 'always' ];
-
-/**
-* Always require function declarations and never allow function expressions or arrow functions.
-*
-* @name func-style
-* @memberof rules
-* @type {Array}
-* @see [func-style]{@link https://eslint.org/docs/rules/func-style}
-*
-* @example
-* // Bad...
-* var foo = function() {
-* // Do something...
-* };
-*
-* @example
-* // Good...
-* function foo() {
-* // Do something...
-* }
-*/
-rules[ 'func-style' ] = [ 'error', 'declaration', {
- 'allowArrowFunctions': false
-}];
-
-/**
-* Never allow linebreaks between arguments of a function call.
-*
-* @name function-call-argument-newline
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'never' ]
-* @see [function-call-argument-newline]{@link https://eslint.org/docs/rules/function-call-argument-newline}
-*
-* @example
-* // Bad...
-* function foo(
-* x,
-* y
-* ) {
-* return x + y;
-* }
-*
-* @example
-* // Bad...
-* console.log(
-* 1,
-* 2
-* );
-*
-* @example
-* // Good...
-* function foo( x, y ) {
-* return x + y;
-* }
-*
-* @example
-* // Good...
-* console.log( 1, 2 );
-*/
-rules[ 'function-call-argument-newline' ] = [ 'error', 'never' ];
-
-/**
-* Never allow linebreaks inside parentheses of function parameters or arguments.
-*
-* @name function-paren-newline
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'never' ]
-* @see [function-paren-newline]{@link https://eslint.org/docs/rules/function-paren-newline}
-*
-* @example
-* // Bad...
-* function foo(
-* x,
-* y
-* ) {
-* return x + y;
-* }
-*
-* @example
-* // Bad...
-* console.log(
-* 1,
-* 2
-* );
-*
-* @example
-* // Good...
-* function foo( x, y ) {
-* return x + y;
-* }
-*
-* @example
-* // Good...
-* console.log( 1, 2 );
-*/
-rules[ 'function-paren-newline' ] = [ 'error', 'never' ];
-
-/**
-* Do not blacklist any identifiers.
-*
-* @name id-blacklist
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [id-blacklist]{@link https://eslint.org/docs/rules/id-blacklist}
-*/
-rules[ 'id-blacklist' ] = 'off';
-
-/**
-* Warn if the length of an identifier name exceeds `25` characters.
-*
-* @name id-length
-* @memberof rules
-* @type {Array}
-* @see [id-length]{@link https://eslint.org/docs/rules/id-length}
-*/
-rules[ 'id-length' ] = [ 'warn', {
- 'min': 1,
- 'max': 25,
- 'properties': 'never'
-}];
-
-/**
-* Do not impose draconian name restrictions.
-*
-* @name id-match
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [id-match]{@link https://eslint.org/docs/rules/id-match}
-*/
-rules[ 'id-match' ] = 'off';
-
-/**
-* Do not allow a newline before an arrow function body.
-*
-* @name implicit-arrow-linebreak
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'beside' ]
-* @see [implicit-arrow-linebreak]{@link https://eslint.org/docs/rules/implicit-arrow-linebreak}
-*
-* @example
-* // Bad...
-* (foo) =>
-* bar;
-*
-* @example
-* // Okay...
-* (foo) => bar;
-*/
-rules[ 'implicit-arrow-linebreak' ] = [ 'error', 'beside' ];
-
-/**
-* Require tabs, except for `case` statements.
-*
-* @name indent
-* @memberof rules
-* @type {Array}
-* @see [indent]{@link https://eslint.org/docs/rules/indent}
-*/
-rules[ 'indent' ] = [ 'error', 'tab', {
- 'SwitchCase': 0,
- 'VariableDeclarator': 1,
- 'outerIIFEBody': 1,
- 'MemberExpression': 1,
- 'FunctionDeclaration': {
- 'body': 1,
- 'parameters': 'off'
- },
- 'FunctionExpression': {
- 'body': 1,
- 'parameters': 'off'
- },
- 'CallExpression': {
- 'arguments': 'off'
- },
- 'ArrayExpression': 1,
- 'ObjectExpression': 1,
- 'flatTernaryExpressions': true
-}];
-
-/**
-* Disable rule for JSX quotes.
-*
-* @name jsx-quotes
-* @memberof rules
-* @type {string}
-* @see [jsx-quotes]{@link https://eslint.org/docs/rules/jsx-quotes}
-*/
-rules[ 'jsx-quotes' ] = 'off';
-
-/**
-* Require a space after, but not before, the colon separating an object property from a corresponding value.
-*
-* @name key-spacing
-* @memberof rules
-* @type {Array}
-* @see [key-spacing]{@link https://eslint.org/docs/rules/key-spacing}
-*
-* @example
-* // Bad...
-* var obj = {
-* 'beep' : 'boop'
-* };
-*
-* @example
-* // Good...
-* var obj = {
-* 'beep': 'boop'
-* };
-*/
-rules[ 'key-spacing' ] = [ 'error', {
- 'beforeColon': false,
- 'afterColon': true,
- 'mode': 'strict'
-}];
-
-/**
-* Require spaces around keywords.
-*
-* @name keyword-spacing
-* @memberof rules
-* @type {Array}
-* @see [keyword-spacing]{@link https://eslint.org/docs/rules/keyword-spacing}
-*
-* @example
-* // Bad...
-* if( x < 10 ){
-* y = foo( x );
-* }else{
-* y = bar( x );
-}
-*
-* @example
-* // Good...
-* if ( x!== x ) {
-* y = foo( x );
-* } else {
-* y = bar( x );
-* }
-*/
-rules[ 'keyword-spacing' ] = [ 'error', {
- 'before': true,
- 'after': true
-}];
-
-/**
-* Allow comments either above or beside code.
-*
-* @name line-comment-position
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [line-comment-position]{@link https://eslint.org/docs/rules/line-comment-position}
-*/
-rules[ 'line-comment-position' ] = 'off';
-
-/**
-* Enforce Unix-style line breaks.
-*
-* @name linebreak-style
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'unix' ]
-* @see [linebreak-style]{@link https://eslint.org/docs/rules/linebreak-style}
-*/
-rules[ 'linebreak-style' ] = [ 'error', 'unix' ];
-
-/**
-* Prefer empty lines before comments.
-*
-* @name lines-around-comment
-* @memberof rules
-* @type {Array}
-* @see [lines-around-comment]{@link https://eslint.org/docs/rules/lines-around-comment}
-*
-* @example
-* // Bad...
-* var x = 5;
-* // Line comment:
-* var y = 10;
-*
-* @example
-* // Good...
-* var x = 5;
-*
-* // Line comment:
-* var y = 10;
-*/
-rules[ 'lines-around-comment' ] = [ 'off', { // NOTE: disabled to allow some discretion in terms of readability, clarity, and terseness.
- 'beforeBlockComment': true,
- 'afterBlockComment': false,
- 'beforeLineComment': true,
- 'afterLineComment': false,
- 'allowBlockStart': true,
- 'allowBlockEnd': true,
- 'allowObjectStart': true,
- 'allowObjectEnd': true,
- 'allowArrayStart': true,
- 'allowArrayEnd': true,
- 'allowClassStart': true,
- 'allowClassEnd': true
-}];
-
-/**
-* Do not allow lines between class members.
-*
-* @name lines-between-class-members
-* @memberof rules
-* @type {Array}
-* @see [lines-between-class-members]{@link https://eslint.org/docs/rules/lines-between-class-members}
-*
-* @example
-* // Bad...
-* class Foo {
-* bar() {}
-*
-* baz() {}
-* }
-*
-* @example
-* // Okay...
-* class Foo {
-* bar() {}
-* baz() {}
-* }
-*/
-rules[ 'lines-between-class-members' ] = [ 'error', 'never', {
- 'exceptAfterSingleLine': false
-}];
-
-/**
-* Enforce a maximum depth that blocks can be nested.
-*
-* @name max-depth
-* @memberof rules
-* @type {Array}
-* @default [ 'error', {'max': 5} ]
-* @see [max-depth]{@link https://eslint.org/docs/rules/max-depth}
-*/
-rules[ 'max-depth' ] = [ 'error', {
- 'max': 5
-}];
-
-/**
-* Do not allow a line to exceed a maximum line length.
-*
-* @name max-len
-* @memberof rules
-* @type {Array}
-* @see [max-len]{@link https://eslint.org/docs/rules/max-len}
-*/
-rules[ 'max-len' ] = [ 'warn', {
- 'code': 80,
- 'tabWidth': 4,
- 'ignoreComments': true,
- 'ignoreUrls': true,
- 'ignoreStrings': true,
- 'ignoreTemplateLiterals': true,
- 'ignoreRegExpLiterals': true
-}];
-
-/**
-* Limit the number of source code lines in a file.
-*
-* @name max-lines
-* @memberof rules
-* @type {Array}
-* @see [max-lines]{@link https://eslint.org/docs/rules/max-lines}
-*/
-rules[ 'max-lines' ] = [ 'warn', {
- 'max': 300,
- 'skipBlankLines': true,
- 'skipComments': true
-}];
-
-/**
-* Warn when a function contains more than `200` source code lines.
-*
-* @name max-lines-per-function
-* @memberof rules
-* @type {Array}
-* @see [max-lines-per-function]{@link https://eslint.org/docs/rules/max-lines-per-function}
-*/
-rules[ 'max-lines-per-function' ] = [ 'warn', {
- 'max': 200,
- 'skipBlankLines': true,
- 'skipComments': true,
- 'IIFEs': true
-}];
-
-/**
-* Limit the number of nested callbacks.
-*
-* @name max-nested-callbacks
-* @memberof rules
-* @type {Array}
-* @default [ 'error', {'max': 3} ]
-* @see [max-nested-callbacks]{@link https://eslint.org/docs/rules/max-nested-callbacks}
-*/
-rules[ 'max-nested-callbacks' ] = [ 'error', {
- 'max': 3
-}];
-
-/**
-* Never allow more than `10` parameters.
-*
-* @name max-params
-* @memberof rules
-* @type {Array}
-* @default [ 'error', {'max': 10} ]
-* @see [max-params]{@link https://eslint.org/docs/rules/max-params}
-*/
-rules[ 'max-params' ] = [ 'error', {
- 'max': 10
-}];
-
-/**
-* Warn when a function has more than `100` statements.
-*
-* @name max-statements
-* @memberof rules
-* @type {Array}
-* @default [ 'warn', {'max': 100} ]
-* @see [max-statements]{@link https://eslint.org/docs/rules/max-statements}
-*/
-rules[ 'max-statements' ] = [ 'warn', {
- 'max': 100
-}];
-
-/**
-* Require only `1` statement per line.
-*
-* @name max-statements-per-line
-* @memberof rules
-* @type {Array}
-* @default [ 'error', {'max': 1} ]
-* @see [max-statements-per-line]{@link https://eslint.org/docs/rules/max-statements-per-line}
-*/
-rules[ 'max-statements-per-line' ] = [ 'error', {
- 'max': 1
-}];
-
-/**
-* Require multiline comments be "starred" blocks. NOTE: currently disabled as the rule only supports "aligned" starred blocks.
-*
-* @name multiline-comment-style
-* @memberof rules
-* @type {Array}
-* @default [ 'off', 'starred-block' ]
-* @see [multiline-comment-style]{@link https://eslint.org/docs/rules/multiline-comment-style}
-*/
-rules[ 'multiline-comment-style' ] = [ 'off', 'starred-block' ]; // TODO: enable once non-"aligned" blocks are supported
-
-/**
-* Allow same line or multiline ternary expressions.
-*
-* @name multiline-ternary
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [multiline-ternary]{@link https://eslint.org/docs/rules/multiline-ternary}
-*/
-rules[ 'multiline-ternary' ] = 'off';
-
-/**
-* Require all uppercase-started functions (and properties) be called with the `new` operator.
-*
-* @name new-cap
-* @memberof rules
-* @type {Array}
-* @see [new-cap]{@link https://eslint.org/docs/rules/new-cap}
-*/
-rules[ 'new-cap' ] = [ 'error', {
- 'newIsCap': false,
- 'capIsNew': true,
- 'properties': true
-}];
-
-/**
-* Require parentheses when invoking a function using the `new` operator.
-*
-* @name new-parens
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'always' ]
-* @see [new-parens]{@link https://eslint.org/docs/rules/new-parens}
-*
-* @example
-* // Bad...
-* var arr = new Array;
-*
-* @example
-* // Good...
-* var arr = new Array();
-*/
-rules[ 'new-parens' ] = [ 'error', 'always' ];
-
-/**
-* Do not enforce newlines within chained calls.
-*
-* @name newline-per-chained-call
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [newline-per-chained-call]{@link https://eslint.org/docs/rules/newline-per-chained-call}
-*/
-rules[ 'newline-per-chained-call' ] = 'off';
-
-/**
-* Never allow the use of the `Array` constructor when an array literal can be used.
-*
-* @name no-array-constructor
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-array-constructor]{@link https://eslint.org/docs/rules/no-array-constructor}
-*
-* @example
-* // Bad...
-* var arr = new Array( 1, 2, 3 );
-*
-* @example
-* // Good...
-* var arr = [ 1, 2, 3 ];
-*
-* @example
-* // Good...
-* var arr = new Array( 10 );
-*/
-rules[ 'no-array-constructor' ] = 'error';
-
-/**
-* Allow the use of bitwise operators.
-*
-* @name no-bitwise
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [no-bitwise]{@link https://eslint.org/docs/rules/no-bitwise}
-*
-* @example
-* var isOdd = x & 1;
-*/
-rules[ 'no-bitwise' ] = 'off';
-
-/**
-* Allow the use of the `continue` statement.
-*
-* @name no-continue
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [no-continue]{@link https://eslint.org/docs/rules/no-continue}
-*
-* @example
-* // Okay...
-* var i;
-* for ( i = 0; i < 10; i++ ) {
-* if ( i < 5 ) {
-* continue;
-* }
-* // Do something...
-* }
-*/
-rules[ 'no-continue' ] = 'off';
-
-/**
-* Allow inline comments.
-*
-* @name no-inline-comments
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [no-inline-comments]{@link https://eslint.org/docs/rules/no-inline-comments}
-*/
-rules[ 'no-inline-comments' ] = 'off';
-
-/**
-* Never allow an `if` statement to be the only statement in an `else` block.
-*
-* @name no-lonely-if
-* @memberof rules
-* @type {number}
-* @default 'error'
-* @see [no-lonely-if]{@link https://eslint.org/docs/rules/no-lonely-if}
-*
-* @example
-* // Bad...
-* if ( x < 10 ) {
-* // Do something...
-* } else {
-* if ( x < 20 ) {
-* // Do something else...
-* }
-* }
-*
-* @example
-* // Good...
-* if ( x < 10 ) {
-* // Do something...
-* } else if ( x < 20 ) {
-* // Do something else...
-* }
-*/
-rules[ 'no-lonely-if' ] = 'error';
-
-/**
-* Never allow mixed operators.
-*
-* @name no-mixed-operators
-* @memberof rules
-* @type {Array}
-* @see [no-mixed-operators]{@link https://eslint.org/docs/rules/no-mixed-operators}
-*
-* @example
-* // Bad...
-* var y = 3 + 5 * 6;
-*
-* @example
-* // Good...
-* var y = 3 + (5 * 6);
-*/
-rules[ 'no-mixed-operators' ] = [ 'error', {
- 'allowSamePrecedence': true
-}];
-
-/**
-* Never allow mixed spaces and tabs.
-*
-* @name no-mixed-spaces-and-tabs
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-mixed-spaces-and-tabs]{@link https://eslint.org/docs/rules/no-mixed-spaces-and-tabs}
-*/
-rules[ 'no-mixed-spaces-and-tabs' ] = 'error';
-
-/**
-* Allow a maximum of two empty lines.
-*
-* @name no-multiple-empty-lines
-* @memberof rules
-* @type {Array}
-* @default [ 'off', {'max':2} ]
-* @see [no-multiple-empty-lines]{@link https://eslint.org/docs/rules/no-multiple-empty-lines}
-*/
-rules[ 'no-multiple-empty-lines' ] = [ 'off', {
- 'max': 2,
- 'maxEOF': 1,
- 'maxBOF': 1
-}];
-
-/**
-* Never allow negated conditions when a non-negated condition is possible.
-*
-* @name no-negated-condition
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-negated-condition]{@link https://eslint.org/docs/rules/no-negated-condition}
-*
-* @example
-* // Bad...
-* if ( !x ) {
-* // Do something 1...
-* } else {
-* // Do something 2...
-* }
-*
-* @example
-* // Good...
-* if ( x ) {
-* // Do something 2...
-* } else {
-* // Do something 1...
-* }
-*/
-rules[ 'no-negated-condition' ] = 'error';
-
-/**
-* Never allow nested ternary expressions.
-*
-* @name no-nested-ternary
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-nested-ternary]{@link https://eslint.org/docs/rules/no-nested-ternary}
-*
-* @example
-* // Bad...
-* var z = ( x < 5 ) ? ( y < 10 ) ? 3 : 2 : 1;
-*
-* @example
-* // Good...
-* if ( x < 5 ) {
-* if ( y < 10 ) {
-* z = 3;
-* } else {
-* z = 2;
-* }
-* } else {
-* z = 1;
-* }
-*/
-rules[ 'no-nested-ternary' ] = 'error';
-
-/**
-* Never use the `new` operator to create a new Object, when the more concise `{}` syntax suffices.
-*
-* @name no-new-object
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-new-object]{@link https://eslint.org/docs/rules/no-new-object}
-*
-* @example
-* // Bad...
-* var obj = new Object();
-*
-* @example
-* // Good...
-* var obj = {};
-*/
-rules[ 'no-new-object' ] = 'error';
-
-/**
-* Never allow the use of `++` and `--`, except when incrementing during a `for` loop.
-*
-* @name no-plusplus
-* @memberof rules
-* @type {Array}
-* @default 'error'
-* @see [no-plusplus]{@link https://eslint.org/docs/rules/no-plusplus}
-*
-* @example
-* // Bad...
-* var i = 0;
-* i++;
-*
-* @example
-* // Good...
-* var i = 0;
-* i += 1;
-*
-* @example
-* // Okay...
-* var i = 0;
-* for ( i = 0; i < 10; i++ ) {
-* // Do something...
-* }
-*/
-rules[ 'no-plusplus' ] = [ 'error', {
- 'allowForLoopAfterthoughts': true
-}];
-
-/**
-* Restrict syntax.
-*
-* @name no-restricted-syntax
-* @memberof rules
-* @type {Array}
-* @see [no-restricted-syntax]{@link https://eslint.org/docs/rules/no-restricted-syntax}
-*/
-rules[ 'no-restricted-syntax' ] = [ 'error',
- 'ArrowFunctionExpression',
- 'ClassBody',
- 'ClassDeclaration',
- 'ClassExpression',
- 'DebuggerStatement',
- 'ExperimentalRestProperty',
- 'ExperimentalSpreadProperty',
- 'FunctionExpression',
- 'LabeledStatement',
- 'RestElement',
- 'SpreadElement',
- 'TaggedTemplateExpression',
- 'TemplateElement',
- 'TemplateLiteral',
- 'WithStatement',
- 'YieldExpression',
- 'JSXIdentifier',
- 'JSXNamespacedName',
- 'JSXMemberExpression',
- 'JSXEmptyExpression',
- 'JSXExpressionContainer',
- 'JSXElement',
- 'JSXClosingElement',
- 'JSXOpeningElement',
- 'JSXAttribute',
- 'JSXSpreadAttribute',
- 'JSXText',
- 'ExportDefaultDeclaration',
- 'ExportNamedDeclaration',
- 'ExportAllDeclaration',
- 'ExportSpecifier',
- 'ImportDeclaration',
- 'ImportSpecifier',
- 'ImportDefaultSpecifier',
- 'ImportNamespaceSpecifier'
+ * Require multiline comments be "starred" blocks. NOTE: currently disabled as the rule only supports "aligned" starred blocks.
+ *
+ * @name multiline-comment-style
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'off', 'starred-block' ]
+ * @see [multiline-comment-style]{@link https://eslint.org/docs/rules/multiline-comment-style}
+ */
+rules["multiline-comment-style"] = ["off", "starred-block"]; // TODO: enable once non-"aligned" blocks are supported
+
+/**
+ * Allow same line or multiline ternary expressions.
+ *
+ * @name multiline-ternary
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [multiline-ternary]{@link https://eslint.org/docs/rules/multiline-ternary}
+ */
+rules["multiline-ternary"] = "off";
+
+/**
+ * Require all uppercase-started functions (and properties) be called with the `new` operator.
+ *
+ * @name new-cap
+ * @memberof rules
+ * @type {Array}
+ * @see [new-cap]{@link https://eslint.org/docs/rules/new-cap}
+ */
+rules["new-cap"] = [
+ "error",
+ {
+ newIsCap: false,
+ capIsNew: true,
+ properties: true,
+ },
];
/**
-* Allow tabs.
-*
-* @name no-tabs
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [no-tabs]{@link https://eslint.org/docs/rules/no-tabs}
-*/
-rules[ 'no-tabs' ] = 'off';
-
-/**
-* Allow ternary operators.
-*
-* @name no-ternary
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [no-ternary]{@link https://eslint.org/docs/rules/no-ternary}
-*/
-rules[ 'no-ternary' ] = 'off';
-
-/**
-* Never allow trailing spaces.
-*
-* @name no-trailing-spaces
-* @memberof rules
-* @type {Array}
-* @default [ 'error', {'skipBlankLines': false} ]
-* @see [no-trailing-spaces]{@link https://eslint.org/docs/rules/no-trailing-spaces}
-*/
-rules[ 'no-trailing-spaces' ] = [ 'error', {
- 'skipBlankLines': false
-}];
-
-/**
-* Allow dangling underscores to indicate private members, but not for regular variables.
-*
-* @name no-underscore-dangle
-* @memberof rules
-* @type {Array}
-* @see [no-underscore-dangle]{@link https://eslint.org/docs/rules/no-underscore-dangle}
-*/
-rules[ 'no-underscore-dangle' ] = [ 'error', {
- 'allowAfterThis': true,
- 'allowAfterSuper': true
-}];
-
-/**
-* Never allow unneeded ternary condition expressions.
-*
-* @name no-unneeded-ternary
-* @memberof rules
-* @type {Array}
-* @default [ 'error', {'defaultAssignment': false} ]
-* @see [no-unneeded-ternary]{@link https://eslint.org/docs/rules/no-unneeded-ternary}
-*
-* @example
-* // Bad...
-* var bool = ( x === y ) ? true : false;
-*
-* @example
-* // Good...
-* var bool = ( x === y );
-*/
-rules[ 'no-unneeded-ternary' ] = [ 'error', {
- 'defaultAssignment': false
-}];
-
-/**
-* Never allow whitespace before a property.
-*
-* @name no-whitespace-before-property
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-whitespace-before-property]{@link https://eslint.org/docs/rules/no-whitespace-before-property}
-*
-* @example
-* // Bad...
-* var x = obj. x;
-*
-* @example
-* // Good...
-* var x = obj.x;
-*/
-rules[ 'no-whitespace-before-property' ] = 'error';
-
-/**
-* Require the single line statements of `if`, `else`, `while`, `do-while`, and `for` statements to be on the same line.
-*
-* @name nonblock-statement-body-position
-* @memberof rules
-* @type {Array}
-* @see [nonblock-statement-body-position]{@link https://eslint.org/docs/rules/nonblock-statement-body-position}
-*
-* @example
-* // Bad...
-* if ( x )
-* bar();
-*
-* @example
-* // Good...
-* if ( x ) {
-* bar();
-* }
-*
-* @example
-* // Okay, within the context of this rule, but discouraged...
-* if ( x ) bar();
-*/
-rules[ 'nonblock-statement-body-position' ] = [ 'error', 'beside' ];
-
-/**
-* Require consistent line breaks inside braces.
-*
-* @name object-curly-newline
-* @memberof rules
-* @type {Array}
-* @see [object-curly-newline]{@link https://eslint.org/docs/rules/object-curly-newline}
-*
-* @example
-* // Bad...
-* var obj = {
-* };
-*
-* @example
-* // Bad...
-* var obj = { 'foo': 'bar' };
-*
-* @example
-* // Okay...
-* var obj = {
-* 'foo': 'bar'
-* };
-*/
-rules[ 'object-curly-newline' ] = [ 'error', {
- 'ObjectExpression': {
- 'minProperties': 1,
- 'consistent': true
+ * Require parentheses when invoking a function using the `new` operator.
+ *
+ * @name new-parens
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'always' ]
+ * @see [new-parens]{@link https://eslint.org/docs/rules/new-parens}
+ *
+ * @example
+ * // Bad...
+ * var arr = new Array;
+ *
+ * @example
+ * // Good...
+ * var arr = new Array();
+ */
+rules["new-parens"] = ["error", "always"];
+
+/**
+ * Do not enforce newlines within chained calls.
+ *
+ * @name newline-per-chained-call
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [newline-per-chained-call]{@link https://eslint.org/docs/rules/newline-per-chained-call}
+ */
+rules["newline-per-chained-call"] = "off";
+
+/**
+ * Never allow the use of the `Array` constructor when an array literal can be used.
+ *
+ * @name no-array-constructor
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-array-constructor]{@link https://eslint.org/docs/rules/no-array-constructor}
+ *
+ * @example
+ * // Bad...
+ * var arr = new Array( 1, 2, 3 );
+ *
+ * @example
+ * // Good...
+ * var arr = [ 1, 2, 3 ];
+ *
+ * @example
+ * // Good...
+ * var arr = new Array( 10 );
+ */
+rules["no-array-constructor"] = "error";
+
+/**
+ * Allow the use of bitwise operators.
+ *
+ * @name no-bitwise
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [no-bitwise]{@link https://eslint.org/docs/rules/no-bitwise}
+ *
+ * @example
+ * var isOdd = x & 1;
+ */
+rules["no-bitwise"] = "off";
+
+/**
+ * Allow the use of the `continue` statement.
+ *
+ * @name no-continue
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [no-continue]{@link https://eslint.org/docs/rules/no-continue}
+ *
+ * @example
+ * // Okay...
+ * var i;
+ * for ( i = 0; i < 10; i++ ) {
+ * if ( i < 5 ) {
+ * continue;
+ * }
+ * // Do something...
+ * }
+ */
+rules["no-continue"] = "off";
+
+/**
+ * Allow inline comments.
+ *
+ * @name no-inline-comments
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [no-inline-comments]{@link https://eslint.org/docs/rules/no-inline-comments}
+ */
+rules["no-inline-comments"] = "off";
+
+/**
+ * Never allow an `if` statement to be the only statement in an `else` block.
+ *
+ * @name no-lonely-if
+ * @memberof rules
+ * @type {number}
+ * @default 'error'
+ * @see [no-lonely-if]{@link https://eslint.org/docs/rules/no-lonely-if}
+ *
+ * @example
+ * // Bad...
+ * if ( x < 10 ) {
+ * // Do something...
+ * } else {
+ * if ( x < 20 ) {
+ * // Do something else...
+ * }
+ * }
+ *
+ * @example
+ * // Good...
+ * if ( x < 10 ) {
+ * // Do something...
+ * } else if ( x < 20 ) {
+ * // Do something else...
+ * }
+ */
+rules["no-lonely-if"] = "error";
+
+/**
+ * Never allow mixed operators.
+ *
+ * @name no-mixed-operators
+ * @memberof rules
+ * @type {Array}
+ * @see [no-mixed-operators]{@link https://eslint.org/docs/rules/no-mixed-operators}
+ *
+ * @example
+ * // Bad...
+ * var y = 3 + 5 * 6;
+ *
+ * @example
+ * // Good...
+ * var y = 3 + (5 * 6);
+ */
+rules["no-mixed-operators"] = [
+ "error",
+ {
+ allowSamePrecedence: true,
},
- 'ObjectPattern': 'never',
- 'ImportDeclaration': 'never',
- 'ExportDeclaration': 'never'
-}];
-
-/**
-* Warn when not including spaces between curly braces.
-*
-* @name object-curly-spacing
-* @memberof rules
-* @type {Array}
-* @see [object-curly-spacing]{@link https://eslint.org/docs/rules/object-curly-spacing}
-*
-* @example
-* // Bad...
-* var obj = {'foo': 'bar'};
-*
-* @example
-* // Okay...
-* var obj = { 'foo': 'bar' };
-*
-* @example
-* // Okay...
-* var arr = [{ 'foo': 'bar' }];
-*
-* @example
-* // Okay...
-* var obj = { 'foo': [ 1, 2 ]};
-*/
-rules[ 'object-curly-spacing' ] = [ 'warn', 'always', {
- 'objectsInObjects': false,
- 'arraysInObjects': false
-}];
-
-/**
-* Require newlines between each object property.
-*
-* @name object-property-newline
-* memberof rules
-* @type {Array}
-* @see [object-property-newline]{@link https://eslint.org/docs/rules/object-property-newline}
-*
-* @example
-* // Bad...
-* var obj = {
-* 'foo': 'bar', 'beep': 'boop'
-* };
-*
-* @example
-* // Bad...
-* var obj = {
-* 'foo': 'bar',
-* 'beep': 'boop'
-* };
-*/
-rules[ 'object-property-newline' ] = [ 'error', {
- 'allowMultiplePropertiesPerLine': false
-}];
-
-/**
-* Require multiple variable declarations per function or block.
-*
-* @name one-var
-* @memberof rules
-* @type {Array}
-* @see [one-var]{@link https://eslint.org/docs/rules/one-var}
-*
-* @example
-* // Bad...
-* var x, y;
-*
-* @example
-* // Good...
-* var x;
-* var y;
-*/
-rules[ 'one-var' ] = [ 'error', {
- 'var': 'never',
- 'let': 'never',
- 'const': 'never'
-}];
-
-/**
-* Do not require newlines around variable declarations.
-*
-* @name one-var-declaration-per-line
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [one-var-declaration-per-line]{@link https://eslint.org/docs/rules/one-var-declaration-per-line}
-*
-* @example
-* // Bad...
-* var x,
-* y;
-*
-* @example
-* // Okay...
-* var x, y;
-*
-* @example
-* // Good...
-* var x;
-* var y;
-*/
-rules[ 'one-var-declaration-per-line' ] = 'off';
-
-/**
-* Prefer operator shorthand.
-*
-* @name operator-assignment
-* @memberof rules
-* @type {Array}
-* @default [ 'warn', 'always' ]
-* @see [operator-assignment]{@link https://eslint.org/docs/rules/operator-assignment}
-*
-* @example
-* // Bad...
-* var x;
-* x = x + 1;
-*
-* @example
-* // Good...
-* var x;
-* x += 1;
-*/
-rules[ 'operator-assignment' ] = [ 'warn', 'always' ];
+];
/**
-* Require that operators be placed on the end of the line.
-*
-* @name operator-linebreak
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'after' ]
-* @see [operator-linebreak]{@link https://eslint.org/docs/rules/operator-linebreak}
-*
-* @example
-* // Bad...
-* if (
-* x < 10
-* || x > 20
-* ) {
-* // Do something...
-* }
-*
-* @example
-* // Good...
-* if (
-* x < 10 ||
-* x > 20
-* ) {
-* // Do something...
-* }
-*/
-rules[ 'operator-linebreak' ] = [ 'error', 'after' ];
+ * Never allow mixed spaces and tabs.
+ *
+ * @name no-mixed-spaces-and-tabs
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-mixed-spaces-and-tabs]{@link https://eslint.org/docs/rules/no-mixed-spaces-and-tabs}
+ */
+rules["no-mixed-spaces-and-tabs"] = "error";
+
+/**
+ * Allow a maximum of two empty lines.
+ *
+ * @name no-multiple-empty-lines
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'off', {'max':2} ]
+ * @see [no-multiple-empty-lines]{@link https://eslint.org/docs/rules/no-multiple-empty-lines}
+ */
+rules["no-multiple-empty-lines"] = [
+ "off",
+ {
+ max: 2,
+ maxEOF: 1,
+ maxBOF: 1,
+ },
+];
/**
-* Never allow padded blocks.
-*
-* @name padded-blocks
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'never' ]
-* @see [padded-blocks]{@link https://eslint.org/docs/rules/padded-blocks}
-*
-* @example
-* // Bad...
-* if ( x < 10 ) {
-*
-* // Do something...
-*
-* }
-*
-* @example
-* // Good...
-* if ( x < 10 ) {
-* // Do something...
-* }
-*/
-rules[ 'padded-blocks' ] = [ 'error', 'never' ];
+ * Never allow negated conditions when a non-negated condition is possible.
+ *
+ * @name no-negated-condition
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-negated-condition]{@link https://eslint.org/docs/rules/no-negated-condition}
+ *
+ * @example
+ * // Bad...
+ * if ( !x ) {
+ * // Do something 1...
+ * } else {
+ * // Do something 2...
+ * }
+ *
+ * @example
+ * // Good...
+ * if ( x ) {
+ * // Do something 2...
+ * } else {
+ * // Do something 1...
+ * }
+ */
+rules["no-negated-condition"] = "error";
+
+/**
+ * Never allow nested ternary expressions.
+ *
+ * @name no-nested-ternary
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-nested-ternary]{@link https://eslint.org/docs/rules/no-nested-ternary}
+ *
+ * @example
+ * // Bad...
+ * var z = ( x < 5 ) ? ( y < 10 ) ? 3 : 2 : 1;
+ *
+ * @example
+ * // Good...
+ * if ( x < 5 ) {
+ * if ( y < 10 ) {
+ * z = 3;
+ * } else {
+ * z = 2;
+ * }
+ * } else {
+ * z = 1;
+ * }
+ */
+rules["no-nested-ternary"] = "error";
+
+/**
+ * Never use the `new` operator to create a new Object, when the more concise `{}` syntax suffices.
+ *
+ * @name no-new-object
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-new-object]{@link https://eslint.org/docs/rules/no-new-object}
+ *
+ * @example
+ * // Bad...
+ * var obj = new Object();
+ *
+ * @example
+ * // Good...
+ * var obj = {};
+ */
+rules["no-new-object"] = "error";
+
+/**
+ * Never allow the use of `++` and `--`, except when incrementing during a `for` loop.
+ *
+ * @name no-plusplus
+ * @memberof rules
+ * @type {Array}
+ * @default 'error'
+ * @see [no-plusplus]{@link https://eslint.org/docs/rules/no-plusplus}
+ *
+ * @example
+ * // Bad...
+ * var i = 0;
+ * i++;
+ *
+ * @example
+ * // Good...
+ * var i = 0;
+ * i += 1;
+ *
+ * @example
+ * // Okay...
+ * var i = 0;
+ * for ( i = 0; i < 10; i++ ) {
+ * // Do something...
+ * }
+ */
+rules["no-plusplus"] = [
+ "error",
+ {
+ allowForLoopAfterthoughts: true,
+ },
+];
/**
-* Specify padding between statements.
-*
-* @name padding-line-between-statements
-* @memberof rules
-* @type {Array}
-* @see [padding-line-between-statements]{@link https://eslint.org/docs/rules/padding-line-between-statements}
-*
-* @example
-* // Bad...
-* "use strict";
-* var x = 5;
-*
-* @example
-* // Good...
-* "use strict";
-*
-* var x = 5;
-*
-* @example
-* // Okay...
-* var x = 5;
-*
-* if ( x < 10 ) {
-* // Do something...
-* }
-*
-* @example
-* // Okay...
-* var x = 5;
-* if ( x < 10 ) {
-* // Do something...
-* }
-*
-* @example
-* // Okay...
-* function foo() {
-* var x = 5;
-* var y = x * 3;
-*
-* return y;
-* }
-*
-* @example
-* // Okay...
-* function foo( x ) {
-* var x = 5;
-* var y = x * 3;
-* return y;
-* }
-*/
-rules[ 'padding-line-between-statements' ] = [ 'error',
+ * Restrict syntax.
+ *
+ * @name no-restricted-syntax
+ * @memberof rules
+ * @type {Array}
+ * @see [no-restricted-syntax]{@link https://eslint.org/docs/rules/no-restricted-syntax}
+ */
+rules["no-restricted-syntax"] = [
+ "error",
+ "ArrowFunctionExpression",
+ "ClassBody",
+ "ClassDeclaration",
+ "ClassExpression",
+ "DebuggerStatement",
+ "ExperimentalRestProperty",
+ "ExperimentalSpreadProperty",
+ "FunctionExpression",
+ "LabeledStatement",
+ "RestElement",
+ "SpreadElement",
+ "TaggedTemplateExpression",
+ "TemplateElement",
+ "TemplateLiteral",
+ "WithStatement",
+ "YieldExpression",
+ "JSXIdentifier",
+ "JSXNamespacedName",
+ "JSXMemberExpression",
+ "JSXEmptyExpression",
+ "JSXExpressionContainer",
+ "JSXElement",
+ "JSXClosingElement",
+ "JSXOpeningElement",
+ "JSXAttribute",
+ "JSXSpreadAttribute",
+ "JSXText",
+ "ExportDefaultDeclaration",
+ "ExportNamedDeclaration",
+ "ExportAllDeclaration",
+ "ExportSpecifier",
+ "ImportDeclaration",
+ "ImportSpecifier",
+ "ImportDefaultSpecifier",
+ "ImportNamespaceSpecifier",
+];
- // Never allow a blank line before a directive...
+/**
+ * Allow tabs.
+ *
+ * @name no-tabs
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [no-tabs]{@link https://eslint.org/docs/rules/no-tabs}
+ */
+rules["no-tabs"] = "off";
+
+/**
+ * Allow ternary operators.
+ *
+ * @name no-ternary
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [no-ternary]{@link https://eslint.org/docs/rules/no-ternary}
+ */
+rules["no-ternary"] = "off";
+
+/**
+ * Never allow trailing spaces.
+ *
+ * @name no-trailing-spaces
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', {'skipBlankLines': false} ]
+ * @see [no-trailing-spaces]{@link https://eslint.org/docs/rules/no-trailing-spaces}
+ */
+rules["no-trailing-spaces"] = [
+ "error",
{
- 'blankLine': 'never',
- 'prev': '*',
- 'next': 'directive'
+ skipBlankLines: false,
},
+];
- // Always require a blank line after a directive...
+/**
+ * Allow dangling underscores to indicate private members, but not for regular variables.
+ *
+ * @name no-underscore-dangle
+ * @memberof rules
+ * @type {Array}
+ * @see [no-underscore-dangle]{@link https://eslint.org/docs/rules/no-underscore-dangle}
+ */
+rules["no-underscore-dangle"] = [
+ "error",
{
- 'blankLine': 'always',
- 'prev': 'directive',
- 'next': '*'
+ allowAfterThis: true,
+ allowAfterSuper: true,
},
+];
- // But allow directives to be grouped together...
+/**
+ * Never allow unneeded ternary condition expressions.
+ *
+ * @name no-unneeded-ternary
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', {'defaultAssignment': false} ]
+ * @see [no-unneeded-ternary]{@link https://eslint.org/docs/rules/no-unneeded-ternary}
+ *
+ * @example
+ * // Bad...
+ * var bool = ( x === y ) ? true : false;
+ *
+ * @example
+ * // Good...
+ * var bool = ( x === y );
+ */
+rules["no-unneeded-ternary"] = [
+ "error",
{
- 'blankLine': 'any',
- 'prev': 'directive',
- 'next': 'directive'
+ defaultAssignment: false,
},
+];
- // Allow discretion when inserting a blank line after `var` declarations...
+/**
+ * Never allow whitespace before a property.
+ *
+ * @name no-whitespace-before-property
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-whitespace-before-property]{@link https://eslint.org/docs/rules/no-whitespace-before-property}
+ *
+ * @example
+ * // Bad...
+ * var x = obj. x;
+ *
+ * @example
+ * // Good...
+ * var x = obj.x;
+ */
+rules["no-whitespace-before-property"] = "error";
+
+/**
+ * Require the single line statements of `if`, `else`, `while`, `do-while`, and `for` statements to be on the same line.
+ *
+ * @name nonblock-statement-body-position
+ * @memberof rules
+ * @type {Array}
+ * @see [nonblock-statement-body-position]{@link https://eslint.org/docs/rules/nonblock-statement-body-position}
+ *
+ * @example
+ * // Bad...
+ * if ( x )
+ * bar();
+ *
+ * @example
+ * // Good...
+ * if ( x ) {
+ * bar();
+ * }
+ *
+ * @example
+ * // Okay, within the context of this rule, but discouraged...
+ * if ( x ) bar();
+ */
+rules["nonblock-statement-body-position"] = ["error", "beside"];
+
+/**
+ * Require consistent line breaks inside braces.
+ *
+ * @name object-curly-newline
+ * @memberof rules
+ * @type {Array}
+ * @see [object-curly-newline]{@link https://eslint.org/docs/rules/object-curly-newline}
+ *
+ * @example
+ * // Bad...
+ * var obj = {
+ * };
+ *
+ * @example
+ * // Bad...
+ * var obj = { 'foo': 'bar' };
+ *
+ * @example
+ * // Okay...
+ * var obj = {
+ * 'foo': 'bar'
+ * };
+ */
+rules["object-curly-newline"] = [
+ "error",
{
- 'blankLine': 'any',
- 'prev': 'var',
- 'next': '*'
+ ObjectExpression: {
+ minProperties: 1,
+ consistent: true,
+ },
+ ObjectPattern: "never",
+ ImportDeclaration: "never",
+ ExportDeclaration: "never",
},
-
- // Allow discretion when inserting a blank line before `return` statements...
- {
- 'blankLine': 'any',
- 'prev': '*',
- 'next': 'return'
- }
];
/**
-* Do not require the use of object spread syntax when using `Object.assign`.
-*
-* @name prefer-object-spread
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [prefer-object-spread]{@link https://eslint.org/docs/rules/prefer-object-spread}
-*/
-rules[ 'prefer-object-spread' ] = 'off';
+ * Warn when not including spaces between curly braces.
+ *
+ * @name object-curly-spacing
+ * @memberof rules
+ * @type {Array}
+ * @see [object-curly-spacing]{@link https://eslint.org/docs/rules/object-curly-spacing}
+ *
+ * @example
+ * // Bad...
+ * var obj = {'foo': 'bar'};
+ *
+ * @example
+ * // Okay...
+ * var obj = { 'foo': 'bar' };
+ *
+ * @example
+ * // Okay...
+ * var arr = [{ 'foo': 'bar' }];
+ *
+ * @example
+ * // Okay...
+ * var obj = { 'foo': [ 1, 2 ]};
+ */
+rules["object-curly-spacing"] = [
+ "warn",
+ "always",
+ {
+ objectsInObjects: false,
+ arraysInObjects: false,
+ },
+];
/**
-* Always quote object literal property names.
-*
-* @name quote-props
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'always' ]
-* @see [quote-props]{@link https://eslint.org/docs/rules/quote-props}
-*
-* @example
-* // Bad...
-* var obj = {
-* foo: 'bar'
-* };
-*
-* @example
-* // Good...
-* var obj = {
-* 'foo': 'bar'
-* };
-*/
-rules[ 'quote-props' ] = [ 'error', 'always' ];
+ * Require newlines between each object property.
+ *
+ * @name object-property-newline
+ * memberof rules
+ * @type {Array}
+ * @see [object-property-newline]{@link https://eslint.org/docs/rules/object-property-newline}
+ *
+ * @example
+ * // Bad...
+ * var obj = {
+ * 'foo': 'bar', 'beep': 'boop'
+ * };
+ *
+ * @example
+ * // Bad...
+ * var obj = {
+ * 'foo': 'bar',
+ * 'beep': 'boop'
+ * };
+ */
+rules["object-property-newline"] = [
+ "error",
+ {
+ allowMultiplePropertiesPerLine: false,
+ },
+];
/**
-* Always use single quotes, except in the rare situation when needing to avoid escape.
-*
-* @name quotes
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'single' { 'avoidEscape': true }]
-* @see [quotes]{@link https://eslint.org/docs/rules/quotes}
-*
-* @example
-* // Bad...
-* var obj = {
-* "foo": "bar"
-* };
-*
-* @example
-* // Good...
-* var obj = {
-* 'foo': 'bar'
-* };
-*/
-rules[ 'quotes' ] = [ 'error', 'single', {
- 'avoidEscape': true
-}];
+ * Require multiple variable declarations per function or block.
+ *
+ * @name one-var
+ * @memberof rules
+ * @type {Array}
+ * @see [one-var]{@link https://eslint.org/docs/rules/one-var}
+ *
+ * @example
+ * // Bad...
+ * var x, y;
+ *
+ * @example
+ * // Good...
+ * var x;
+ * var y;
+ */
+rules["one-var"] = [
+ "error",
+ {
+ var: "never",
+ let: "never",
+ const: "never",
+ },
+];
/**
-* Require JSDoc comments.
-*
-* @name require-jsdoc
-* @memberof rules
-* @type {Array}
-* @see [require-jsdoc]{@link https://eslint.org/docs/rules/require-jsdoc}
-*/
-rules[ 'require-jsdoc' ] = [ 'error', {
- 'require': {
- 'FunctionDeclaration': true,
- 'ClassDeclaration': true,
- 'MethodDefinition': true,
- 'ArrowFunctionExpression': true
- }
-}];
+ * Do not require newlines around variable declarations.
+ *
+ * @name one-var-declaration-per-line
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [one-var-declaration-per-line]{@link https://eslint.org/docs/rules/one-var-declaration-per-line}
+ *
+ * @example
+ * // Bad...
+ * var x,
+ * y;
+ *
+ * @example
+ * // Okay...
+ * var x, y;
+ *
+ * @example
+ * // Good...
+ * var x;
+ * var y;
+ */
+rules["one-var-declaration-per-line"] = "off";
+
+/**
+ * Prefer operator shorthand.
+ *
+ * @name operator-assignment
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'warn', 'always' ]
+ * @see [operator-assignment]{@link https://eslint.org/docs/rules/operator-assignment}
+ *
+ * @example
+ * // Bad...
+ * var x;
+ * x = x + 1;
+ *
+ * @example
+ * // Good...
+ * var x;
+ * x += 1;
+ */
+rules["operator-assignment"] = ["warn", "always"];
+
+/**
+ * Require that operators be placed on the end of the line.
+ *
+ * @name operator-linebreak
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'after' ]
+ * @see [operator-linebreak]{@link https://eslint.org/docs/rules/operator-linebreak}
+ *
+ * @example
+ * // Bad...
+ * if (
+ * x < 10
+ * || x > 20
+ * ) {
+ * // Do something...
+ * }
+ *
+ * @example
+ * // Good...
+ * if (
+ * x < 10 ||
+ * x > 20
+ * ) {
+ * // Do something...
+ * }
+ */
+rules["operator-linebreak"] = ["error", "after"];
+
+/**
+ * Never allow padded blocks.
+ *
+ * @name padded-blocks
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'never' ]
+ * @see [padded-blocks]{@link https://eslint.org/docs/rules/padded-blocks}
+ *
+ * @example
+ * // Bad...
+ * if ( x < 10 ) {
+ *
+ * // Do something...
+ *
+ * }
+ *
+ * @example
+ * // Good...
+ * if ( x < 10 ) {
+ * // Do something...
+ * }
+ */
+rules["padded-blocks"] = ["error", "never"];
+
+/**
+ * Specify padding between statements.
+ *
+ * @name padding-line-between-statements
+ * @memberof rules
+ * @type {Array}
+ * @see [padding-line-between-statements]{@link https://eslint.org/docs/rules/padding-line-between-statements}
+ *
+ * @example
+ * // Bad...
+ * "use strict";
+ * var x = 5;
+ *
+ * @example
+ * // Good...
+ * "use strict";
+ *
+ * var x = 5;
+ *
+ * @example
+ * // Okay...
+ * var x = 5;
+ *
+ * if ( x < 10 ) {
+ * // Do something...
+ * }
+ *
+ * @example
+ * // Okay...
+ * var x = 5;
+ * if ( x < 10 ) {
+ * // Do something...
+ * }
+ *
+ * @example
+ * // Okay...
+ * function foo() {
+ * var x = 5;
+ * var y = x * 3;
+ *
+ * return y;
+ * }
+ *
+ * @example
+ * // Okay...
+ * function foo( x ) {
+ * var x = 5;
+ * var y = x * 3;
+ * return y;
+ * }
+ */
+rules["padding-line-between-statements"] = [
+ "error",
-/**
-* Always use semicolons.
-*
-* @name semi
-* @memberof rules
-* @type {Array}
-* @see [semi]{@link https://eslint.org/docs/rules/semi}
-*
-* @example
-* // Bad...
-* var x = 5
-*
-* @example
-* // Good...
-* var x = 5;
-*/
-rules[ 'semi' ] = [ 'error', 'always', {
- 'omitLastInOneLineBlock': false
-}];
+ // Never allow a blank line before a directive...
+ {
+ blankLine: "never",
+ prev: "*",
+ next: "directive",
+ },
-/**
-* Require a space after, but not before, a semicolon.
-*
-* @name semi-spacing
-* @memberof rules
-* @type {Array}
-* @see [semi-spacing]{@link https://eslint.org/docs/rules/semi-spacing}
-*
-* @example
-* // Bad...
-* var x = 5;y = 10;
-*
-* @example
-* // Okay...
-* var x = 5; y = 10;
-*
-* @example
-* // Good...
-* var x = 5;
-* var y = 10;
-*
-* @example
-* // Bad...
-* for (i = 0;i < 10;i++) {
-* // Do something...
-* }
-*
-* @example
-* // Good...
-* for ( i = 0; i < 10; i++ ) {
-* // Do something...
-* }
-*/
-rules[ 'semi-spacing' ] = [ 'error', {
- 'before': false,
- 'after': true
-}];
+ // Always require a blank line after a directive...
+ {
+ blankLine: "always",
+ prev: "directive",
+ next: "*",
+ },
-/**
-* Require semicolons be placed at the end of lines.
-*
-* @name semi-style
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'last' ]
-* @see [semi-style]{@link https://eslint.org/docs/rules/semi-style}
-*
-* @example
-* // Bad...
-* foo()
-* ;[ 1, 2, 3 ].forEach( bar )
-*
-* @example
-* // Good...
-* foo();
-* [ 1, 2, 3 ].forEach( bar );
-*/
-rules[ 'semi-style' ] = [ 'error', 'last' ];
+ // But allow directives to be grouped together...
+ {
+ blankLine: "any",
+ prev: "directive",
+ next: "directive",
+ },
-/**
-* Do not require object keys to be sorted.
-*
-* @name sort-keys
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [sort-keys]{@link https://eslint.org/docs/rules/sort-keys}
-*
-* @example
-* // Okay...
-* var obj = {
-* 'a': 1,
-* 'c': 3,
-* 'b': 2
-* };
-*/
-rules[ 'sort-keys' ] = 'off';
+ // Allow discretion when inserting a blank line after `var` declarations...
+ {
+ blankLine: "any",
+ prev: "var",
+ next: "*",
+ },
-/**
-* Do not require variables to be sorted.
-*
-* @name sort-vars
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [sort-vars]{@link https://eslint.org/docs/rules/sort-vars}
-*
-* @example
-* // Okay...
-* var x = 0;
-* var z = 2;
-* var y = 1;
-*/
-rules[ 'sort-vars' ] = 'off';
+ // Allow discretion when inserting a blank line before `return` statements...
+ {
+ blankLine: "any",
+ prev: "*",
+ next: "return",
+ },
+];
/**
-* Always include a space before blocks.
-*
-* @name space-before-blocks
-* @memberof rules
-* @type {Array}
-* @see [space-before-blocks]{@link https://eslint.org/docs/rules/space-before-blocks}
-*
-* @example
-* // Bad...
-* function noop(){
-* // Do nothing...
-* }
-*
-* @example
-* // Good...
-* function noop() {
-* // Do nothing...
-* }
-*/
-rules[ 'space-before-blocks' ] = [ 'error', {
- 'functions': 'always',
- 'keywords': 'always',
- 'classes': 'always'
-}];
+ * Do not require the use of object spread syntax when using `Object.assign`.
+ *
+ * @name prefer-object-spread
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [prefer-object-spread]{@link https://eslint.org/docs/rules/prefer-object-spread}
+ */
+rules["prefer-object-spread"] = "off";
+
+/**
+ * Always quote object literal property names.
+ *
+ * @name quote-props
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'always' ]
+ * @see [quote-props]{@link https://eslint.org/docs/rules/quote-props}
+ *
+ * @example
+ * // Bad...
+ * var obj = {
+ * foo: 'bar'
+ * };
+ *
+ * @example
+ * // Good...
+ * var obj = {
+ * 'foo': 'bar'
+ * };
+ */
+rules["quote-props"] = ["error", "always"];
+
+/**
+ * Always use single quotes, except in the rare situation when needing to avoid escape.
+ *
+ * @name quotes
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'single' { 'avoidEscape': true }]
+ * @see [quotes]{@link https://eslint.org/docs/rules/quotes}
+ *
+ * @example
+ * // Bad...
+ * var obj = {
+ * "foo": "bar"
+ * };
+ *
+ * @example
+ * // Good...
+ * var obj = {
+ * 'foo': 'bar'
+ * };
+ */
+rules["quotes"] = [
+ "error",
+ "single",
+ {
+ avoidEscape: true,
+ },
+];
/**
-* Never include a space before a named function parenthesis.
-*
-* @name space-before-function-paren
-* @memberof rules
-* @type {Array}
-* @see [space-before-function-paren]{@link https://eslint.org/docs/rules/space-before-function-paren}
-*
-* @example
-* // Bad...
-* function foo () {
-* // Do something...
-* }
-*
-* @example
-* // Good...
-* function foo() {
-* // Do something...
-* }
-*/
-rules[ 'space-before-function-paren' ] = [ 'error', {
- 'anonymous': 'always',
- 'named': 'never',
- 'asyncArrow': 'always'
-}];
+ * Require JSDoc comments.
+ *
+ * @name require-jsdoc
+ * @memberof rules
+ * @type {Array}
+ * @see [require-jsdoc]{@link https://eslint.org/docs/rules/require-jsdoc}
+ */
+rules["require-jsdoc"] = [
+ "error",
+ {
+ require: {
+ FunctionDeclaration: true,
+ ClassDeclaration: true,
+ MethodDefinition: true,
+ ArrowFunctionExpression: true,
+ },
+ },
+];
/**
-* Allow discretion when including space within parentheses.
-*
-* @name space-in-parens
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [space-in-parens]{@link https://eslint.org/docs/rules/space-in-parens}
-*
-* @example
-* // Good...
-* var y = foo( [ 1, 2, 3 ] );
-*
-* @example
-* // Okay...
-* var arr = new Float64Array([ 1, 2, 3 ]);
-*/
-rules[ 'space-in-parens' ] = 'off';
+ * Always use semicolons.
+ *
+ * @name semi
+ * @memberof rules
+ * @type {Array}
+ * @see [semi]{@link https://eslint.org/docs/rules/semi}
+ *
+ * @example
+ * // Bad...
+ * var x = 5
+ *
+ * @example
+ * // Good...
+ * var x = 5;
+ */
+rules["semi"] = [
+ "error",
+ "always",
+ {
+ omitLastInOneLineBlock: false,
+ },
+];
/**
-* Allow discretion when inserting space around infix operators.
-*
-* @name space-infix-ops
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [space-infix-ops]{@link https://eslint.org/docs/rules/space-infix-ops}
-*
-* @example
-* // Good...
-* var x = 5 + 3;
-*
-* @example
-* // Okay...
-* var x = (5+3) * (10-2);
-*/
-rules[ 'space-infix-ops' ] = 'off';
+ * Require a space after, but not before, a semicolon.
+ *
+ * @name semi-spacing
+ * @memberof rules
+ * @type {Array}
+ * @see [semi-spacing]{@link https://eslint.org/docs/rules/semi-spacing}
+ *
+ * @example
+ * // Bad...
+ * var x = 5;y = 10;
+ *
+ * @example
+ * // Okay...
+ * var x = 5; y = 10;
+ *
+ * @example
+ * // Good...
+ * var x = 5;
+ * var y = 10;
+ *
+ * @example
+ * // Bad...
+ * for (i = 0;i < 10;i++) {
+ * // Do something...
+ * }
+ *
+ * @example
+ * // Good...
+ * for ( i = 0; i < 10; i++ ) {
+ * // Do something...
+ * }
+ */
+rules["semi-spacing"] = [
+ "error",
+ {
+ before: false,
+ after: true,
+ },
+];
/**
-* Always include a space after unary word operators, and never include a space after unary operators.
-*
-* @name space-unary-ops
-* @memberof rules
-* @type {Array}
-* @see [space-unary-ops]{@link https://eslint.org/docs/rules/space-unary-ops}
-*
-* @example
-* // Bad...
-* delete(obj.a)
-*
-* @example
-* // Good...
-* delete obj.a
-*
-* @example
-* // Bad...
-* var x = '5';
-* var y = + x;
-*
-* @example
-* // Good...
-* var x = '5';
-* var y = +x;
-*/
-rules[ 'space-unary-ops' ] = [ 'error', {
- 'words': true,
- 'nonwords': false
-}];
+ * Require semicolons be placed at the end of lines.
+ *
+ * @name semi-style
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'last' ]
+ * @see [semi-style]{@link https://eslint.org/docs/rules/semi-style}
+ *
+ * @example
+ * // Bad...
+ * foo()
+ * ;[ 1, 2, 3 ].forEach( bar )
+ *
+ * @example
+ * // Good...
+ * foo();
+ * [ 1, 2, 3 ].forEach( bar );
+ */
+rules["semi-style"] = ["error", "last"];
+
+/**
+ * Do not require object keys to be sorted.
+ *
+ * @name sort-keys
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [sort-keys]{@link https://eslint.org/docs/rules/sort-keys}
+ *
+ * @example
+ * // Okay...
+ * var obj = {
+ * 'a': 1,
+ * 'c': 3,
+ * 'b': 2
+ * };
+ */
+rules["sort-keys"] = "off";
+
+/**
+ * Do not require variables to be sorted.
+ *
+ * @name sort-vars
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [sort-vars]{@link https://eslint.org/docs/rules/sort-vars}
+ *
+ * @example
+ * // Okay...
+ * var x = 0;
+ * var z = 2;
+ * var y = 1;
+ */
+rules["sort-vars"] = "off";
+
+/**
+ * Always include a space before blocks.
+ *
+ * @name space-before-blocks
+ * @memberof rules
+ * @type {Array}
+ * @see [space-before-blocks]{@link https://eslint.org/docs/rules/space-before-blocks}
+ *
+ * @example
+ * // Bad...
+ * function noop(){
+ * // Do nothing...
+ * }
+ *
+ * @example
+ * // Good...
+ * function noop() {
+ * // Do nothing...
+ * }
+ */
+rules["space-before-blocks"] = [
+ "error",
+ {
+ functions: "always",
+ keywords: "always",
+ classes: "always",
+ },
+];
/**
-* Always include a space after starting a comment.
-*
-* @name spaced-comment
-* @memberof rules
-* @type {Array}
-* @see [spaced-comment]{@link https://eslint.org/docs/rules/spaced-comment}
-*
-* @example
-* //Bad...
-*
-* @example
-* // Good...
-*/
-rules[ 'spaced-comment' ] = [ 'error', 'always', {
- 'block': {
- 'balanced': true
- }
-}];
+ * Never include a space before a named function parenthesis.
+ *
+ * @name space-before-function-paren
+ * @memberof rules
+ * @type {Array}
+ * @see [space-before-function-paren]{@link https://eslint.org/docs/rules/space-before-function-paren}
+ *
+ * @example
+ * // Bad...
+ * function foo () {
+ * // Do something...
+ * }
+ *
+ * @example
+ * // Good...
+ * function foo() {
+ * // Do something...
+ * }
+ */
+rules["space-before-function-paren"] = [
+ "error",
+ {
+ anonymous: "always",
+ named: "never",
+ asyncArrow: "always",
+ },
+];
/**
-* Require a space after, but not before, `switch` colons.
-*
-* @name switch-colon-spacing
-* @memberof rules
-* @type {Array}
-* @see [switch-colon-spacing]{@link https://eslint.org/docs/rules/switch-colon-spacing}
-*
-* @example
-* // Bad...
-* switch ( x ) {
-* case 1 : break;
-* }
-*
-* @example
-* // Bad...
-* switch ( x ) {
-* case 1 :break;
-* }
-*
-* @example
-* // Bad...
-* switch ( x ) {
-* case 1:break;
-* }
-*
-* @example
-* // Okay...
-* switch ( x ) {
-* case 1: break;
-* }
-*
-* @example
-* // Good...
-* switch ( x ) {
-* case 1:
-* break;
-* }
-*/
-rules[ 'switch-colon-spacing' ] = [ 'error', {
- 'before': false,
- 'after': true
-}];
+ * Allow discretion when including space within parentheses.
+ *
+ * @name space-in-parens
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [space-in-parens]{@link https://eslint.org/docs/rules/space-in-parens}
+ *
+ * @example
+ * // Good...
+ * var y = foo( [ 1, 2, 3 ] );
+ *
+ * @example
+ * // Okay...
+ * var arr = new Float64Array([ 1, 2, 3 ]);
+ */
+rules["space-in-parens"] = "off";
+
+/**
+ * Allow discretion when inserting space around infix operators.
+ *
+ * @name space-infix-ops
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [space-infix-ops]{@link https://eslint.org/docs/rules/space-infix-ops}
+ *
+ * @example
+ * // Good...
+ * var x = 5 + 3;
+ *
+ * @example
+ * // Okay...
+ * var x = (5+3) * (10-2);
+ */
+rules["space-infix-ops"] = "off";
+
+/**
+ * Always include a space after unary word operators, and never include a space after unary operators.
+ *
+ * @name space-unary-ops
+ * @memberof rules
+ * @type {Array}
+ * @see [space-unary-ops]{@link https://eslint.org/docs/rules/space-unary-ops}
+ *
+ * @example
+ * // Bad...
+ * delete(obj.a)
+ *
+ * @example
+ * // Good...
+ * delete obj.a
+ *
+ * @example
+ * // Bad...
+ * var x = '5';
+ * var y = + x;
+ *
+ * @example
+ * // Good...
+ * var x = '5';
+ * var y = +x;
+ */
+rules["space-unary-ops"] = [
+ "error",
+ {
+ words: true,
+ nonwords: false,
+ },
+];
/**
-* Do not allow one or more spaces between template tags and their literals.
-*
-* @name template-tag-spacing
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'never' ]
-* @see [template-tag-spacing]{@link https://eslint.org/docs/rules/template-tag-spacing}
-*
-* @example
-* // Bad...
-* var foo = bar `beep boop`;
-*
-* @example
-* // Good...
-* var foo = bar`beep boop`;
-*/
-rules[ 'template-tag-spacing' ] = [ 'error', 'never' ];
+ * Always include a space after starting a comment.
+ *
+ * @name spaced-comment
+ * @memberof rules
+ * @type {Array}
+ * @see [spaced-comment]{@link https://eslint.org/docs/rules/spaced-comment}
+ *
+ * @example
+ * //Bad...
+ *
+ * @example
+ * // Good...
+ */
+rules["spaced-comment"] = [
+ "error",
+ "always",
+ {
+ block: {
+ balanced: true,
+ },
+ },
+];
/**
-* Do not require a Unicode byte order mark (BOM), as we assume UTF-8.
-*
-* @name unicode-bom
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [unicode-bom]{@link https://eslint.org/docs/rules/unicode-bom}
-*/
-rules[ 'unicode-bom' ] = 'off';
+ * Require a space after, but not before, `switch` colons.
+ *
+ * @name switch-colon-spacing
+ * @memberof rules
+ * @type {Array}
+ * @see [switch-colon-spacing]{@link https://eslint.org/docs/rules/switch-colon-spacing}
+ *
+ * @example
+ * // Bad...
+ * switch ( x ) {
+ * case 1 : break;
+ * }
+ *
+ * @example
+ * // Bad...
+ * switch ( x ) {
+ * case 1 :break;
+ * }
+ *
+ * @example
+ * // Bad...
+ * switch ( x ) {
+ * case 1:break;
+ * }
+ *
+ * @example
+ * // Okay...
+ * switch ( x ) {
+ * case 1: break;
+ * }
+ *
+ * @example
+ * // Good...
+ * switch ( x ) {
+ * case 1:
+ * break;
+ * }
+ */
+rules["switch-colon-spacing"] = [
+ "error",
+ {
+ before: false,
+ after: true,
+ },
+];
/**
-* Do not require a regular expression literal to be wrapped in parentheses.
-*
-* @name wrap-regex
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [wrap-regex]{@link https://eslint.org/docs/rules/wrap-regex}
-*
-* @example
-* // Okay...
-* var bool = /b[eo]+p/.test( 'beep' );
-*/
-rules[ 'wrap-regex' ] = 'off';
-
+ * Do not allow one or more spaces between template tags and their literals.
+ *
+ * @name template-tag-spacing
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'never' ]
+ * @see [template-tag-spacing]{@link https://eslint.org/docs/rules/template-tag-spacing}
+ *
+ * @example
+ * // Bad...
+ * var foo = bar `beep boop`;
+ *
+ * @example
+ * // Good...
+ * var foo = bar`beep boop`;
+ */
+rules["template-tag-spacing"] = ["error", "never"];
+
+/**
+ * Do not require a Unicode byte order mark (BOM), as we assume UTF-8.
+ *
+ * @name unicode-bom
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [unicode-bom]{@link https://eslint.org/docs/rules/unicode-bom}
+ */
+rules["unicode-bom"] = "off";
+
+/**
+ * Do not require a regular expression literal to be wrapped in parentheses.
+ *
+ * @name wrap-regex
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [wrap-regex]{@link https://eslint.org/docs/rules/wrap-regex}
+ *
+ * @example
+ * // Okay...
+ * var bool = /b[eo]+p/.test( 'beep' );
+ */
+rules["wrap-regex"] = "off";
// EXPORTS //
diff --git a/etc/eslint/rules/typescript.js b/etc/eslint/rules/typescript.js
index fcf76a15677b..2435db59c56c 100644
--- a/etc/eslint/rules/typescript.js
+++ b/etc/eslint/rules/typescript.js
@@ -1,2711 +1,2727 @@
/**
-* @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.
-*/
+ * @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.
+ */
/* eslint-disable stdlib/jsdoc-doctest-marker, stdlib/jsdoc-doctest-quote-props */
-'use strict';
+"use strict";
// MODULES //
-var merge = require( './../../../lib/node_modules/@stdlib/utils/merge' );
-var mapValues = require( './../../../lib/node_modules/@stdlib/utils/map-values' );
-var constantFunction = require( './../../../lib/node_modules/@stdlib/utils/constant-function' );
-var defaults = require( './../.eslintrc.js' );
-
+var merge = require("./../../../lib/node_modules/@stdlib/utils/merge");
+var mapValues = require("./../../../lib/node_modules/@stdlib/utils/map-values");
+var constantFunction = require("./../../../lib/node_modules/@stdlib/utils/constant-function");
+var defaults = require("./../.eslintrc.js");
// MAIN //
/**
-* ESLint rules.
-*
-* @namespace rules
-*/
-var rules = merge( {}, mapValues( defaults.rules, constantFunction( 'off' ) ) );
-
-/**
-* Requires that function overload signatures be consecutive.
-*
-* @name adjacent-overload-signatures
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [adjacent-overload-signatures]{@link https://typescript-eslint.io/rules/adjacent-overload-signatures}
-*
-* @example
-* // Bad...
-* interface Foo {
-* foo( s: string ): void;
-* foo( n: number ): void;
-* bar(): void;
-* foo( sn: string | number ): void;
-* }
-*
-* // Good...
-* interface Foo {
-* foo( s: string ): void;
-* foo( n: number ): void;
-* foo( sn: string | number ): void;
-* bar(): void;
-* }
-*/
-rules[ '@typescript-eslint/adjacent-overload-signatures' ] = 'error';
-
-/**
-* Enforces the use of `Array<type>` for generic array type annotations.
-*
-* @name array-type
-* @memberof rules
-* @type {Array}
-* @default [ 'error', { 'default': 'generic' } ]
-* @see [array-type]{@link https://typescript-eslint.io/rules/array-type}
-*
-* @example
-* // Bad...
-* const bad: string[] = [];
-*
-* // Good...
-* const good: Array<string> = [];
-*/
-rules[ '@typescript-eslint/array-type' ] = [ 'error', {
- 'default': 'generic'
-}];
-
-/**
-* Enforces that `await` is used with a Promise.
-*
-* @name await-thenable
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [await-thenable]{@link https://typescript-eslint.io/rules/await-thenable}
-*
-* @example
-* // Bad...
-* function test() {
-* await 123;
-* }
-*
-* // Good...
-* async function test() {
-* await Promise.resolve();
-* }
-*/
-rules[ '@typescript-eslint/await-thenable' ] = 'error';
-
-/**
-* Disables the prohibition against TypeScript `@ts-` comments.
-*
-* @name ban-ts-comment
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [ban-ts-comment]{@link https://typescript-eslint.io/rules/ban-ts-comment}
-*
-* @example
-* // Okay...
-* // @ts-ignore
-* console.log( someVarThatDoesNotExist );
-*/
-rules[ '@typescript-eslint/ban-ts-comment' ] = 'off';
-
-/**
-* Disables the ban on certain TypeScript types like `{}` or `object`.
-*
-* @name ban-types
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [ban-types]{@link https://typescript-eslint.io/rules/ban-types}
-*
-* @example
-* // Okay...
-* type foo = {};
-* type bar = object;
-*/
-rules[ '@typescript-eslint/ban-types' ] = 'off';
-
-/**
-* Enforces the use of consistent type assertions.
-*
-* @name consistent-type-assertions
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [consistent-type-assertions]{@link https://typescript-eslint.io/rules/consistent-type-assertions}
-*
-* @example
-* // Bad...
-* let x = <number>someValue;
-*
-* // Good...
-* let x = someValue as number;
-*/
-rules[ '@typescript-eslint/consistent-type-assertions' ] = 'error';
-
-/**
-* Enforces consistent usage of type definitions either with `interface` or `type`.
-*
-* @name consistent-type-definitions
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [consistent-type-definitions]{@link https://typescript-eslint.io/rules/consistent-type-definitions}
-*
-* @example
-* // Bad...
-* type T = {};
-*
-* // Good...
-* interface T {}
-*/
-rules[ '@typescript-eslint/consistent-type-definitions' ] = 'error';
-
-/**
-* Disables the rule that requires dot notation when accessing properties.
-*
-* @name dot-notation
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [dot-notation]{@link https://typescript-eslint.io/rules/dot-notation}
-*
-* @example
-* // Okay...
-* let x = foo[ 'bar' ];
-* let y = foo.bar;
-*/
-rules[ '@typescript-eslint/dot-notation' ] = 'off';
-
-/**
-* Requires that functions have an explicit return type.
-*
-* @name explicit-function-return-type
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [explicit-function-return-type]{@link https://typescript-eslint.io/rules/explicit-function-return-type}
-*
-* @example
-* // Bad...
-* function test() {
-* return 42;
-* }
-*
-* // Good...
-* function test(): number {
-* return 42;
-* }
-*/
-rules[ '@typescript-eslint/explicit-function-return-type' ] = 'error';
-
-/**
-* Enforces explicit visibility declarations for class members.
-*
-* ## Notes
-*
-* - The 'no-public' option requires explicit visibility except for public members.
-*
-* @name explicit-member-accessibility
-* @memberof rules
-* @type {Array}
-* @default [ 'error', { 'accessibility': 'no-public' } ]
-* @see [explicit-member-accessibility]{@link https://typescript-eslint.io/rules/explicit-member-accessibility}
-*
-* @example
-* // Bad...
-* class MyClass {
-* memberWithoutVisibility = 'no explicit visibility';
-* }
-*
-* // Good...
-* class MyClass {
-* private memberWithVisibility = 'has explicit visibility';
-* }
-*/
-rules[ '@typescript-eslint/explicit-member-accessibility' ] = [
- 'error',
- {
- 'accessibility': 'no-public'
- }
-];
+ * ESLint rules.
+ *
+ * @namespace rules
+ */
+var rules = merge({}, mapValues(defaults.rules, constantFunction("off")));
+
+/**
+ * Requires that function overload signatures be consecutive.
+ *
+ * @name adjacent-overload-signatures
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [adjacent-overload-signatures]{@link https://typescript-eslint.io/rules/adjacent-overload-signatures}
+ *
+ * @example
+ * // Bad...
+ * interface Foo {
+ * foo( s: string ): void;
+ * foo( n: number ): void;
+ * bar(): void;
+ * foo( sn: string | number ): void;
+ * }
+ *
+ * // Good...
+ * interface Foo {
+ * foo( s: string ): void;
+ * foo( n: number ): void;
+ * foo( sn: string | number ): void;
+ * bar(): void;
+ * }
+ */
+rules["@typescript-eslint/adjacent-overload-signatures"] = "error";
/**
-* Requires explicit return and argument types on exported functions' and classes' public class methods.
-*
-* @name explicit-module-boundary-types
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [explicit-module-boundary-types]{@link https://typescript-eslint.io/rules/explicit-module-boundary-types}
-*
-* @example
-* // Bad...
-* export function badFunction( a ) {
-* return a;
-* }
-*
-* // Good...
-* export function goodFunction( a: string ): string {
-* return a;
-* }
-*/
-rules[ '@typescript-eslint/explicit-module-boundary-types' ] = 'error';
-
-/**
-* Enforces indentation with tabs.
-*
-* @name indent
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'tab' ]
-* @see [indent]{@link https://typescript-eslint.io/rules/indent}
-*
-* @example
-* // Bad...
-* function bad() {
-* return true;
-* }
-*
-* // Good...
-* function good() {
-* return true;
-* }
-*/
-rules[ '@typescript-eslint/indent' ] = [ 'error', 'tab' ];
-
-/**
-* Enforces a specific member delimiter style in interfaces and type literals.
-*
-* @name member-delimiter-style
-* @memberof rules
-* @type {Array}
-* @default [ 'error', { 'multiline': { 'delimiter': 'semi', 'requireLast': true }, 'singleline': { 'delimiter': 'semi', 'requireLast': false } } ]
-* @see [member-delimiter-style]{@link https://typescript-eslint.io/rules/member-delimiter-style}
-*
-* @example
-* // Bad...
-* interface Bad {
-* name: string,
-* age: number
-* }
-*
-* // Good...
-* interface Good {
-* name: string;
-* age: number;
-* }
-*/
-rules[ '@typescript-eslint/member-delimiter-style' ] = [
- 'error',
+ * Enforces the use of `Array<type>` for generic array type annotations.
+ *
+ * @name array-type
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', { 'default': 'generic' } ]
+ * @see [array-type]{@link https://typescript-eslint.io/rules/array-type}
+ *
+ * @example
+ * // Bad...
+ * const bad: string[] = [];
+ *
+ * // Good...
+ * const good: Array<string> = [];
+ */
+rules["@typescript-eslint/array-type"] = [
+ "error",
{
- 'multiline': {
- 'delimiter': 'semi',
- 'requireLast': true
- },
- 'singleline': {
- 'delimiter': 'semi',
- 'requireLast': false
- }
- }
+ default: "generic",
+ },
];
/**
-* Disables TypeScript's no-shadow rule.
-*
-* @name no-shadow
-* @memberof rules
-* @type {Array}
-* @default [ 'off', { 'hoist': 'all' } ]
-* @see [no-shadow]{@link https://typescript-eslint.io/rules/no-shadow}
-*
-* @example
-* // Okay...
-* const x = 1;
-* function example() {
-* const x = 2;
-* }
-*/
-rules[ '@typescript-eslint/no-shadow' ] = [ 'off', {
- 'hoist': 'all'
-}];
-
-/**
-* Disables the rule against the delete operator with computed key expressions.
-*
-* @name no-dynamic-delete
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [no-dynamic-delete]{@link https://typescript-eslint.io/rules/no-dynamic-delete}
-*
-* @example
-* // Okay...
-* delete object[ dynamicKey ];
-*/
-rules[ '@typescript-eslint/no-dynamic-delete' ] = 'off';
-
-/**
-* Disallows empty functions. Functions with a comment inside are not considered empty.
-*
-* @name no-empty-function
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-empty-function]{@link https://typescript-eslint.io/rules/no-empty-function}
-*
-* @example
-* // Bad...
-* function noOp() {}
-*
-* // Good...
-* function noOp() {
-* // intentional no-op
-* }
-*/
-rules[ '@typescript-eslint/no-empty-function' ] = 'error';
-
-/**
-* Disallows the declaration of empty interfaces.
-*
-* @name no-empty-interface
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-empty-interface]{@link https://typescript-eslint.io/rules/no-empty-interface}
-*
-* @example
-* // Bad...
-* interface Empty {}
-*
-* // Good...
-* interface NotEmpty {
-* data: string;
-* }
-*/
-rules[ '@typescript-eslint/no-empty-interface' ] = 'error';
-
-/**
-* Warns on usage of the `any` type.
-*
-* @name no-explicit-any
-* @memberof rules
-* @type {string}
-* @default 'warn'
-* @see [no-explicit-any]{@link https://typescript-eslint.io/rules/no-explicit-any}
-*
-* @example
-* // Bad...
-* function unsafe( arg: any ): any { return arg; }
-*
-* // Good...
-* function safe( arg: unknown ): unknown { return arg; }
-*/
-rules[ '@typescript-eslint/no-explicit-any' ] = 'warn';
-
-/**
-* Disallows classes that only have static members and don't need to be instantiated.
-*
-* @name no-extraneous-class
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-extraneous-class]{@link https://typescript-eslint.io/rules/no-extraneous-class}
-*
-* @example
-* // Bad...
-* class StaticOnly {
-* static doSomething() {}
-* }
-*
-* // Good...
-* namespace StaticOnly {
-* export function doSomething() {}
-* }
-*/
-rules[ '@typescript-eslint/no-extraneous-class' ] = 'error';
-
-/**
-* Requires Promises to be handled appropriately. Unhandled Promises can cause unexpected behavior.
-*
-* @name no-floating-promises
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-floating-promises]{@link https://typescript-eslint.io/rules/no-floating-promises}
-*
-* @example
-* // Bad...
-* new Promise( resolve => resolve() );
-*
-* // Good...
-* new Promise( resolve => resolve() ).catch( handleError );
-*/
-rules[ '@typescript-eslint/no-floating-promises' ] = 'error';
-
-/**
-* Disallows iterating over an array with a for-in loop. A for-of loop should be used instead.
-*
-* @name no-for-in-array
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-for-in-array]{@link https://typescript-eslint.io/rules/no-for-in-array}
-*
-* @example
-* // Bad...
-* const arr = [ 1, 2, 3 ];
-* for ( const i in arr ) {
-* console.log( arr[ i ] );
-* }
-*
-* // Good...
-* for ( const i of arr ) {
-* console.log( i );
-* }
-*/
-rules[ '@typescript-eslint/no-for-in-array' ] = 'error';
-
-/**
-* Disallows explicit type declarations for variables or parameters initialized to a number, string, or boolean.
-*
-* @name no-inferrable-types
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-inferrable-types]{@link https://typescript-eslint.io/rules/no-inferrable-types}
-*
-* @example
-* // Bad...
-* let x: number = 1;
-*
-* // Good...
-* let x = 1;
-*/
-rules[ '@typescript-eslint/no-inferrable-types' ] = 'error';
-
-/**
-* Disallows the incorrect use of `new` with interfaces or `new` for defining a constructor.
-*
-* @name no-misused-new
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-misused-new]{@link https://typescript-eslint.io/rules/no-misused-new}
-*
-* @example
-* // Bad...
-* interface I {
-* new (): I;
-* }
-*
-* // Good...
-* class C implements I {
-* constructor() {}
-* }
-*/
-rules[ '@typescript-eslint/no-misused-new' ] = 'error';
-
-/**
-* Disallows the use of custom TypeScript modules and namespaces.
-*
-* @name no-namespace
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-namespace]{@link https://typescript-eslint.io/rules/no-namespace}
-*
-* @example
-* // Bad...
-* module M {
-* export const x = 1;
-* }
-*
-* // Good...
-* namespace N {
-* export const x = 1;
-* }
-*/
-rules[ '@typescript-eslint/no-namespace' ] = 'error';
-
-/**
-* Disallows non-null assertions using the `!` postfix operator.
-*
-* @name no-non-null-assertion
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-non-null-assertion]{@link https://typescript-eslint.io/rules/no-non-null-assertion}
-*
-* @example
-* // Bad...
-* const x: number | null = null;
-* const y: number = x!;
-*
-* // Good...
-* if ( x !== null ) {
-* const y: number = x;
-* }
-*/
-rules[ '@typescript-eslint/no-non-null-assertion' ] = 'error';
-
-/**
-* Disables the rule against using `require` statements instead of import declarations.
-*
-* @name no-require-imports
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [no-require-imports]{@link https://typescript-eslint.io/rules/no-require-imports}
-*
-* @example
-* // Okay...
-* const module = require( 'module' );
-*/
-rules[ '@typescript-eslint/no-require-imports' ] = 'off';
-
-/**
-* Disallows aliases for `this`.
-*
-* @name no-this-alias
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-this-alias]{@link https://typescript-eslint.io/rules/no-this-alias}
-*
-* @example
-* // Bad...
-* const self = this;
-* const that = this;
-*
-* // Good...
-* function example() {
-* console.log( this );
-* }
-*/
-rules[ '@typescript-eslint/no-this-alias' ] = 'error';
-
-/**
-* Disables the rule against unnecessary boolean literal comparisons.
-*
-* @name no-unnecessary-boolean-literal-compare
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [no-unnecessary-boolean-literal-compare]{@link https://typescript-eslint.io/rules/no-unnecessary-boolean-literal-compare}
-*
-* @example
-* // Okay...
-* const x = true;
-* if ( x === true ) {
-* // ...
-* }
-*/
-rules[ '@typescript-eslint/no-unnecessary-boolean-literal-compare' ] = 'off';
-
-/**
-* Disallows unnecessary qualifiers (like namespaces or enum names) when the referenced item is accessible without them.
-*
-* @name no-unnecessary-qualifier
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-unnecessary-qualifier]{@link https://typescript-eslint.io/rules/no-unnecessary-qualifier}
-*
-* @example
-* // Bad...
-* namespace A {
-* export const B = 1;
-* }
-* const x = A.B;
-*
-* // Good...
-* const B = 1;
-* const x = B;
-*/
-rules[ '@typescript-eslint/no-unnecessary-qualifier' ] = 'error';
-
-/**
-* Disallows unnecessary type arguments in generics where the argument is the default.
-*
-* @name no-unnecessary-type-arguments
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-unnecessary-type-arguments]{@link https://typescript-eslint.io/rules/no-unnecessary-type-arguments}
-*
-* @example
-* // Bad...
-* function f<T = number>( x: T ) {
-* return x + x
-* }
-* f<number>();
-*
-* // Good...
-* function f<T>( x: T ) {
-* return x + x
-* }
-* f( 1 );
-* f<string>( 'a' );
-*/
-rules[ '@typescript-eslint/no-unnecessary-type-arguments' ] = 'error';
-
-/**
-* Disallows unnecessary type assertions that do not change the type of an expression.
-*
-* @name no-unnecessary-type-assertion
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-unnecessary-type-assertion]{@link https://typescript-eslint.io/rules/no-unnecessary-type-assertion}
-*
-* @example
-* // Bad...
-* const x: number = 10;
-* const y = x as number;
-*
-* // Good...
-* const x: number = 10;
-* const y = x;
-*/
-rules[ '@typescript-eslint/no-unnecessary-type-assertion' ] = 'error';
-
-/**
-* Disallows unused expressions which have no effect on the state of the program.
-*
-* @name no-unused-expressions
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-unused-expressions]{@link https://typescript-eslint.io/rules/no-unused-expressions}
-*
-* @example
-* // Bad...
-* 0;
-* if ( false ) {}
-*
-* // Good...
-* (() => {
-* const a = 0;
-* })();
-*/
-rules[ '@typescript-eslint/no-unused-expressions' ] = 'error';
-
-/**
-* Disables the rule against unused variables.
-*
-* @name no-unused-vars
-* @memberof rules
-* @type {string}
-* @default [ 'error', { 'args': 'after-used' } ]
-* @see [no-unused-vars]{@link https://typescript-eslint.io/rules/no-unused-vars}
-*
-* @example
-* // Bad...
-* function foo( x, y, z ) {
-* return x + y;
-* }
-*
-* // Okay...
-* function bar( x, y, z ) {
-* return y + z;
-* }
-*/
-rules[ '@typescript-eslint/no-unused-vars' ] = [ 'error', {
- 'args': 'after-used'
-}];
-
-/**
-* Disallows the use of variables before they are defined.
-*
-* @name no-use-before-define
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-use-before-define]{@link https://typescript-eslint.io/rules/no-use-before-define}
-*
-* @example
-* // Bad...
-* console.log( a );
-* let a = 10;
-*
-* // Good...
-* let b = 10;
-* console.log( b );
-*/
-rules[ '@typescript-eslint/no-use-before-define' ] = 'error';
-
-/**
-* Disallows the use of `require` statements except in import statements.
-*
-* @name no-var-requires
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-var-requires]{@link https://typescript-eslint.io/rules/no-var-requires}
-*
-* @example
-* // Bad...
-* const moduleA = require( 'moduleA' );
-*
-* // Good...
-* import moduleA from 'moduleA';
-*
-* import moduleA = require( 'moduleA' );
-*/
-rules[ '@typescript-eslint/no-var-requires' ] = 'error';
-
-/**
-* Disables the preference for `for-of` loops over standard `for` loops with index variables.
-*
-* @name prefer-for-of
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [prefer-for-of]{@link https://typescript-eslint.io/rules/prefer-for-of}
-*
-* @example
-* // Okay...
-* for ( let i = 0; i < myArray.length; i++ ) {
-* console.log( myArray[ i ] );
-* }
-*/
-rules[ '@typescript-eslint/prefer-for-of' ] = 'off';
-
-/**
-* Prefers function types instead of interfaces with call signatures.
-*
-* @name prefer-function-type
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [prefer-function-type]{@link https://typescript-eslint.io/rules/prefer-function-type}
-*
-* @example
-* // Bad...
-* interface Callable {
-* (): void;
-* }
-*
-* // Good...
-* type Callable = () => void;
-*/
-rules[ '@typescript-eslint/prefer-function-type' ] = 'error';
-
-/**
-* Prefers the use of the `namespace` keyword instead of `module` to declare custom TypeScript modules.
-*
-* @name prefer-namespace-keyword
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [prefer-namespace-keyword]{@link https://typescript-eslint.io/rules/prefer-namespace-keyword}
-*
-* @example
-* // Bad...
-* module M {
-* export const x = 1;
-* }
-*
-* // Good...
-* namespace M {
-* export const x = 1;
-* }
-*/
-rules[ '@typescript-eslint/prefer-namespace-keyword' ] = 'error';
-
-/**
-* Disables the rule that private members are marked as `readonly` if they're never modified outside of the constructor.
-*
-* @name prefer-readonly
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [prefer-readonly]{@link https://typescript-eslint.io/rules/prefer-readonly}
-*
-* @example
-* // Okay...
-* class MyClass {
-* private name: string;
-* constructor( name: string ) {
-* this.name = name;
-* }
-* }
-*/
-rules[ '@typescript-eslint/prefer-readonly' ] = 'off';
-
-/**
-* Disables the rule that functions which return promises must be async.
-*
-* @name promise-function-async
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [promise-function-async]{@link https://typescript-eslint.io/rules/promise-function-async}
-*
-* @example
-* // Okay...
-* function fetchWithoutAsync() {
-* return fetch( 'url' ).then( response => response.json() );
-* }
-*/
-rules[ '@typescript-eslint/promise-function-async' ] = 'off';
-
-/**
-* Enforces the consistent use of single quotes for string literals and allows avoiding escape for quotes.
-*
-* @name quotes
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'single', { 'avoidEscape': true } ]
-* @see [quotes]{@link https://typescript-eslint.io/rules/quotes}
-*
-* @example
-* // Bad...
-* const bad = "bad";
-*
-* // Good...
-* const good = 'good';
-* const goodEscape = "good's";
-*/
-rules[ '@typescript-eslint/quotes' ] = [
- 'error',
- 'single',
+ * Enforces that `await` is used with a Promise.
+ *
+ * @name await-thenable
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [await-thenable]{@link https://typescript-eslint.io/rules/await-thenable}
+ *
+ * @example
+ * // Bad...
+ * function test() {
+ * await 123;
+ * }
+ *
+ * // Good...
+ * async function test() {
+ * await Promise.resolve();
+ * }
+ */
+rules["@typescript-eslint/await-thenable"] = "error";
+
+/**
+ * Disables the prohibition against TypeScript `@ts-` comments.
+ *
+ * @name ban-ts-comment
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [ban-ts-comment]{@link https://typescript-eslint.io/rules/ban-ts-comment}
+ *
+ * @example
+ * // Okay...
+ * // @ts-ignore
+ * console.log( someVarThatDoesNotExist );
+ */
+rules["@typescript-eslint/ban-ts-comment"] = "off";
+
+/**
+ * Disables the ban on certain TypeScript types like `{}` or `object`.
+ *
+ * @name ban-types
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [ban-types]{@link https://typescript-eslint.io/rules/ban-types}
+ *
+ * @example
+ * // Okay...
+ * type foo = {};
+ * type bar = object;
+ */
+rules["@typescript-eslint/ban-types"] = "off";
+
+/**
+ * Enforces the use of consistent type assertions.
+ *
+ * @name consistent-type-assertions
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [consistent-type-assertions]{@link https://typescript-eslint.io/rules/consistent-type-assertions}
+ *
+ * @example
+ * // Bad...
+ * let x = <number>someValue;
+ *
+ * // Good...
+ * let x = someValue as number;
+ */
+rules["@typescript-eslint/consistent-type-assertions"] = "error";
+
+/**
+ * Enforces consistent usage of type definitions either with `interface` or `type`.
+ *
+ * @name consistent-type-definitions
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [consistent-type-definitions]{@link https://typescript-eslint.io/rules/consistent-type-definitions}
+ *
+ * @example
+ * // Bad...
+ * type T = {};
+ *
+ * // Good...
+ * interface T {}
+ */
+rules["@typescript-eslint/consistent-type-definitions"] = "error";
+
+/**
+ * Disables the rule that requires dot notation when accessing properties.
+ *
+ * @name dot-notation
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [dot-notation]{@link https://typescript-eslint.io/rules/dot-notation}
+ *
+ * @example
+ * // Okay...
+ * let x = foo[ 'bar' ];
+ * let y = foo.bar;
+ */
+rules["@typescript-eslint/dot-notation"] = "off";
+
+/**
+ * Requires that functions have an explicit return type.
+ *
+ * @name explicit-function-return-type
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [explicit-function-return-type]{@link https://typescript-eslint.io/rules/explicit-function-return-type}
+ *
+ * @example
+ * // Bad...
+ * function test() {
+ * return 42;
+ * }
+ *
+ * // Good...
+ * function test(): number {
+ * return 42;
+ * }
+ */
+rules["@typescript-eslint/explicit-function-return-type"] = "error";
+
+/**
+ * Enforces explicit visibility declarations for class members.
+ *
+ * ## Notes
+ *
+ * - The 'no-public' option requires explicit visibility except for public members.
+ *
+ * @name explicit-member-accessibility
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', { 'accessibility': 'no-public' } ]
+ * @see [explicit-member-accessibility]{@link https://typescript-eslint.io/rules/explicit-member-accessibility}
+ *
+ * @example
+ * // Bad...
+ * class MyClass {
+ * memberWithoutVisibility = 'no explicit visibility';
+ * }
+ *
+ * // Good...
+ * class MyClass {
+ * private memberWithVisibility = 'has explicit visibility';
+ * }
+ */
+rules["@typescript-eslint/explicit-member-accessibility"] = [
+ "error",
{
- 'avoidEscape': true
- }
+ accessibility: "no-public",
+ },
];
/**
-* Requires that `async` functions have an `await` expression.
-*
-* @name require-await
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [require-await]{@link https://typescript-eslint.io/rules/require-await}
-*
-* @example
-* // Bad...
-* async function bad() {
-* return 42;
-* }
-*
-* // Good...
-* async function good() {
-* return await someAsyncFunction();
-* }
-*/
-rules[ '@typescript-eslint/require-await' ] = 'error';
-
-/**
-* When adding two variables, operands must both be of type number or of type string.
-*
-* @name restrict-plus-operands
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [restrict-plus-operands]{@link https://typescript-eslint.io/rules/restrict-plus-operands}
-*
-* @example
-* // Bad...
-* const bad = 'The total is: ' + 42;
-*
-* // Good...
-* const good = 'The total is: ' + String(42);
-*/
-rules[ '@typescript-eslint/restrict-plus-operands' ] = 'error';
-
-/**
-* Enforces the use of semicolons after statements.
-*
-* @name semi
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'always' ]
-* @see [semi]{@link https://typescript-eslint.io/rules/semi}
-*
-* @example
-* // Bad...
-* const bad = 'no semi'
-*
-* // Good...
-* const good = 'semi';
-*/
-rules[ '@typescript-eslint/semi' ] = [ 'error', 'always' ];
-
-/**
-* Disables the rule for strict boolean expressions.
-*
-* @name strict-boolean-expressions
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [strict-boolean-expressions]{@link https://typescript-eslint.io/rules/strict-boolean-expressions}
-*
-* @example
-* // Okay...
-* if ( someValue ) {}
-*/
-rules[ '@typescript-eslint/strict-boolean-expressions' ] = 'off';
-
-/**
-* Enforces triple slash references (`/// <reference path="" />`) usage.
-*
-* @name triple-slash-reference
-* @memberof rules
-* @type {Array}
-* @default [ 'error', { 'path': 'always', 'types': 'prefer-import', 'lib': 'always' } ]
-* @see [triple-slash-reference]{@link https://typescript-eslint.io/rules/triple-slash-reference}
-*
-* @example
-* // Bad...
-* /// <reference lib="libname" />
-*
-* // Okay...
-* /// <reference types="@stdlib/types" />
-*/
-rules[ '@typescript-eslint/triple-slash-reference' ] = [
- 'error',
+ * Requires explicit return and argument types on exported functions' and classes' public class methods.
+ *
+ * @name explicit-module-boundary-types
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [explicit-module-boundary-types]{@link https://typescript-eslint.io/rules/explicit-module-boundary-types}
+ *
+ * @example
+ * // Bad...
+ * export function badFunction( a ) {
+ * return a;
+ * }
+ *
+ * // Good...
+ * export function goodFunction( a: string ): string {
+ * return a;
+ * }
+ */
+rules["@typescript-eslint/explicit-module-boundary-types"] = "error";
+
+/**
+ * Enforces indentation with tabs.
+ *
+ * @name indent
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'tab' ]
+ * @see [indent]{@link https://typescript-eslint.io/rules/indent}
+ *
+ * @example
+ * // Bad...
+ * function bad() {
+ * return true;
+ * }
+ *
+ * // Good...
+ * function good() {
+ * return true;
+ * }
+ */
+rules["@typescript-eslint/indent"] = ["error", "tab"];
+
+/**
+ * Enforces a specific member delimiter style in interfaces and type literals.
+ *
+ * @name member-delimiter-style
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', { 'multiline': { 'delimiter': 'semi', 'requireLast': true }, 'singleline': { 'delimiter': 'semi', 'requireLast': false } } ]
+ * @see [member-delimiter-style]{@link https://typescript-eslint.io/rules/member-delimiter-style}
+ *
+ * @example
+ * // Bad...
+ * interface Bad {
+ * name: string,
+ * age: number
+ * }
+ *
+ * // Good...
+ * interface Good {
+ * name: string;
+ * age: number;
+ * }
+ */
+rules["@typescript-eslint/member-delimiter-style"] = [
+ "error",
{
- 'path': 'always',
- 'types': 'prefer-import',
- 'lib': 'always'
- }
+ multiline: {
+ delimiter: "semi",
+ requireLast: true,
+ },
+ singleline: {
+ delimiter: "semi",
+ requireLast: false,
+ },
+ },
];
/**
-* Requires consistent spacing around type annotations.
-*
-* @name type-annotation-spacing
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [type-annotation-spacing]{@link https://typescript-eslint.io/rules/type-annotation-spacing}
-*
-* @example
-* // Bad...
-* let bad :number;
-*
-* // Good...
-* let good: number;
-*/
-rules[ '@typescript-eslint/type-annotation-spacing' ] = 'error';
-
-/**
-* Requires type annotations to exist.
-*
-* @name typedef
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [typedef]{@link https://typescript-eslint.io/rules/typedef}
-*
-* @example
-* // Bad...
-* let bad;
-*
-* // Good...
-* let good: number;
-*/
-rules[ '@typescript-eslint/typedef' ] = 'error';
-
-/**
-* Avoids using an unbound method reference outside of a method’s body.
-*
-* @name unbound-method
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [unbound-method]{@link https://typescript-eslint.io/rules/unbound-method}
-*
-* @example
-* // Bad...
-* const bad = this.handleClick;
-*
-* // Good...
-* const good = this.handleClick.bind( this );
-*/
-rules[ '@typescript-eslint/unbound-method' ] = 'error';
-
-/**
-* Enforces that overloaded members must be consecutive.
-*
-* @name unified-signatures
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [unified-signatures]{@link https://typescript-eslint.io/rules/unified-signatures}
-*
-* @example
-* // Bad...
-* declare function bad( x: number ): number;
-* // Some unrelated overload
-* declare function bad( x: string ): string;
-* declare function bad( x: number | string ): number | string;
-*
-* // Good...
-* declare function good( x: number ): number;
-* declare function good( x: number | string ): number | string;
-* declare function good( x: string ): string;
-*/
-rules[ '@typescript-eslint/unified-signatures' ] = 'error';
-
-/**
-* Requires parentheses around arrow function arguments.
-*
-* @name arrow-parens
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'always' ]
-* @see [arrow-parens]{@link https://eslint.org/docs/rules/arrow-parens}
-*
-* @example
-* // Bad...
-* const bad = x => x * x;
-*
-* // Good...
-* const good = ( x ) => x * x;
-*/
-rules[ 'arrow-parens' ] = [ 'error', 'always' ];
-
-/**
-* Enforces one true brace style in block statements.
-*
-* @name brace-style
-* @memberof rules
-* @type {Array}
-* @default [ 'error', '1tbs' ]
-* @see [brace-style]{@link https://eslint.org/docs/rules/brace-style}
-*
-* @example
-* // Bad...
-* if ( foo )
-* {
-* bar();
-* }
-*
-* // Good...
-* if ( foo ) {
-* bar();
-* }
-*/
-rules[ 'brace-style' ] = [ 'error', '1tbs' ];
-
-/**
-* Enforces that class methods utilize `this`.
-*
-* @name class-methods-use-this
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [class-methods-use-this]{@link https://eslint.org/docs/rules/class-methods-use-this}
-*
-* @example
-* // Bad...
-* class MyClass {
-* method() {
-* console.log('no this');
-* }
-* }
-*
-* // Good...
-* class MyClass {
-* method() {
-* console.log(this);
-* }
-* }
-*/
-rules[ 'class-methods-use-this' ] = 'error';
-
-/**
-* Disallows trailing commas.
-*
-* @name comma-dangle
-* @memberof rules
-* @type {string}
-* @default [ 'error', 'never' ]
-* @see [comma-dangle]{@link https://eslint.org/docs/rules/comma-dangle}
-*
-* @example
-* // Bad...
-* const foo = {
-* bar: 'baz',
-* qux: 'quux',
-* };
-*
-* // Okay...
-* const foo = {
-* bar: 'baz',
-* qux: 'quux'
-* };
-*/
-rules[ 'comma-dangle' ] = [ 'error', 'never' ];
-
-/**
-* Verifies calls of `super()` in constructors.
-*
-* @name constructor-super
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [constructor-super]{@link https://eslint.org/docs/rules/constructor-super}
-*
-* @example
-* // Bad...
-* class Bad extends Base {
-* constructor() {
-* console.log('missing super()');
-* }
-* }
-*
-* // Good...
-* class Good extends Base {
-* constructor() {
-* super();
-* console.log('has super()');
-* }
-* }
-*/
-rules[ 'constructor-super' ] = 'error';
-
-/**
-* Enforces consistent use of curly brace conventions.
-*
-* @name curly
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [curly]{@link https://eslint.org/docs/rules/curly}
-*
-* @example
-* // Bad...
-* if ( foo ) bar();
-*
-* // Good...
-* if ( foo ) {
-* bar();
-* }
-*/
-rules[ 'curly' ] = 'error';
-
-/**
-* Requires a default case in switch statements.
-*
-* @name default-case
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [default-case]{@link https://eslint.org/docs/rules/default-case}
-*
-* @example
-* // Bad...
-* switch ( foo ) {
-* case 1:
-* doSomething();
-* }
-*
-* // Good...
-* switch ( foo ) {
-* case 1:
-* doSomething();
-* break;
-* default:
-* doNothing();
-* }
-*/
-rules[ 'default-case' ] = 'error';
-
-/**
-* Disables the rule for dot notation.
-*
-* @name dot-notation
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [dot-notation]{@link https://eslint.org/docs/rules/dot-notation}
-*
-* @example
-* // Okay...
-* const x = foo[ 'bar' ];
-*/
-rules[ 'dot-notation' ] = 'off';
-
-/**
-* Enforces a newline at the end of files.
-*
-* @name eol-last
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [eol-last]{@link https://eslint.org/docs/rules/eol-last}
-*
-* @example
-* // Bad...
-* const bad = 'no newline';
-* // EOF
-*
-* // Good...
-* const good = 'newline';
-*
-* // EOF
-*/
-rules[ 'eol-last' ] = 'error';
-
-/**
-* Enforces the use of `===` and `!==` in place of `==` and `!=`.
-*
-* @name eqeqeq
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'always' ]
-* @see [eqeqeq]{@link https://eslint.org/docs/rules/eqeqeq}
-*
-* @example
-* // Bad...
-* if ( x == y ) {
-* // ...
-* }
-*
-* // Good...
-* if ( x === y ) {
-* // ...
-* }
-*/
-rules[ 'eqeqeq' ] = [ 'error', 'always' ];
-
-/**
-* Requires `for-in` loops to be filtered with an `if` statement.
-*
-* @name guard-for-in
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [guard-for-in]{@link https://eslint.org/docs/rules/guard-for-in}
-*
-* @example
-* // Bad...
-* for ( const key in object ) {
-* doSomething( object[ key ] );
-* }
-*
-* // Good...
-* for ( const key in object ) {
-* if ( Object.prototype.hasOwnProperty.call( object, key ) ) {
-* doSomething( object[ key ] );
-* }
-* }
-*/
-rules[ 'guard-for-in' ] = 'error';
-
-/**
-* Do not impose draconian name restrictions.
-*
-* @name id-match
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [id-match]{@link https://eslint.org/docs/rules/id-match}
-*
-* @example
-* // Good...
-* const foo = 'bar';
-*/
-rules[ 'id-match' ] = 'off';
-
-/**
-* Allow default exports in modules.
-*
-* @name import/no-default-export
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [import/no-default-export]{@link https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-default-export.md}
-*
-* @example
-* // Okay...
-* export default function myFunction() { }
-*/
-rules[ 'import/no-default-export' ] = 'off';
-
-/**
-* Reports use of a deprecated name.
-*
-* @name import/no-deprecated
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [import/no-deprecated]{@link https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-deprecated.md}
-*
-* @example
-* // Bad...
-* import { oldFunction } from 'lib'; // if oldFunction is deprecated
-*
-* // Good...
-* import { newFunction } from 'lib';
-*/
-rules[ 'import/no-deprecated' ] = 'error';
-
-/**
-* Ensures that there are no extraneous dependencies being imported.
-*
-* @name import/no-extraneous-dependencies
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [import/no-extraneous-dependencies]{@link https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-extraneous-dependencies.md}
-*
-* @example
-* // Good...
-* import fs from 'fs';
-*
-* // Bad...
-* import foo from 'some-extranous-module';
-*/
-rules[ 'import/no-extraneous-dependencies' ] = 'error';
-
-/**
-* Prevents importing the submodules of other modules.
-*
-* @name import/no-internal-modules
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [import/no-internal-modules]{@link https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-internal-modules.md}
-*
-* @example
-* // Bad...
-* import something from 'module/some/internal/path';
-*/
-rules[ 'import/no-internal-modules' ] = 'error';
-
-/**
-* Forbids import statements that import nothing.
-*
-* @name import/no-unassigned-import
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [import/no-unassigned-import]{@link https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-unassigned-import.md}
-*
-* @example
-* // Bad...
-* import 'myModule';
-*
-* // Good...
-* import foo from 'foo';
-*/
-rules[ 'import/no-unassigned-import' ] = 'error';
-
-/**
-* Enforces a specific order for import statements.
-*
-* @name import/order
-* @memberof rules
-* @type {Array}
-* @see [import/order]{@link https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/order.md}
-*
-* @example
-* // Given the configuration above, the following order is enforced:
-* // 1. Built-in modules (node)
-* // 2. External modules
-* // 3. Internal modules
-* // 4. Modules from a parent directory
-* // 5. Sibling modules from the same or a sibling's directory
-* // 6. Index of the current directory
-*
-* // Bad...
-* import sibling from './sibling';
-* import fs from 'fs';
-*
-* // Good...
-* import fs from 'fs';
-* import sibling from './sibling';
-*/
-rules[ 'import/order' ] = [
- 'error',
+ * Disables TypeScript's no-shadow rule.
+ *
+ * @name no-shadow
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'off', { 'hoist': 'all' } ]
+ * @see [no-shadow]{@link https://typescript-eslint.io/rules/no-shadow}
+ *
+ * @example
+ * // Okay...
+ * const x = 1;
+ * function example() {
+ * const x = 2;
+ * }
+ */
+rules["@typescript-eslint/no-shadow"] = [
+ "off",
{
- 'alphabetize': {
- 'caseInsensitive': false,
- 'order': 'ignore'
- },
- 'newlines-between': 'ignore',
- 'groups': [
- [
- 'builtin',
- 'external',
- 'internal',
- 'unknown',
- 'object',
- 'type'
- ],
- 'parent',
- [
- 'sibling',
- 'index'
- ]
- ],
- 'distinctGroup': false,
- 'pathGroupsExcludedImportTypes': [],
- 'pathGroups': [
- {
- 'pattern': './',
- 'patternOptions': {
- 'nocomment': true,
- 'dot': true
- },
- 'group': 'sibling',
- 'position': 'before'
- },
- {
- 'pattern': '.',
- 'patternOptions': {
- 'nocomment': true,
- 'dot': true
- },
- 'group': 'sibling',
- 'position': 'before'
- },
- {
- 'pattern': '..',
- 'patternOptions': {
- 'nocomment': true,
- 'dot': true
- },
- 'group': 'parent',
- 'position': 'before'
- },
- {
- 'pattern': '../',
- 'patternOptions': {
- 'nocomment': true,
- 'dot': true
- },
- 'group': 'parent',
- 'position': 'before'
- }
- ]
- }
+ hoist: "all",
+ },
];
/**
-* Enforces tab indentation.
-*
-* @name indent
-* @memberof rules
-* @type {string}
-* @default [ 'error', 'tab' ]
-* @see [indent]{@link https://eslint.org/docs/rules/indent}
-*/
-rules[ 'indent' ] = [ 'error', 'tab' ];
-
-/**
-* Ensures param names in JSDoc match those in the function declaration.
-*
-* @name jsdoc/check-param-names
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [check-param-names]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/check-param-names.md}
-*/
-rules[ 'jsdoc/check-param-names' ] = 'error';
-
-/**
-* Ensures property names in JSDoc are valid.
-*
-* @name jsdoc/check-property-names
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [check-property-names]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/check-property-names.md}
-*/
-rules[ 'jsdoc/check-property-names' ] = 'error';
-
-/**
-* Checks for invalid JSDoc syntax.
-*
-* @name jsdoc/check-syntax
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [check-syntax]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/check-syntax.md}
-*/
-rules[ 'jsdoc/check-syntax' ] = 'error';
+ * Disables the rule against the delete operator with computed key expressions.
+ *
+ * @name no-dynamic-delete
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [no-dynamic-delete]{@link https://typescript-eslint.io/rules/no-dynamic-delete}
+ *
+ * @example
+ * // Okay...
+ * delete object[ dynamicKey ];
+ */
+rules["@typescript-eslint/no-dynamic-delete"] = "off";
+
+/**
+ * Disallows empty functions. Functions with a comment inside are not considered empty.
+ *
+ * @name no-empty-function
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-empty-function]{@link https://typescript-eslint.io/rules/no-empty-function}
+ *
+ * @example
+ * // Bad...
+ * function noOp() {}
+ *
+ * // Good...
+ * function noOp() {
+ * // intentional no-op
+ * }
+ */
+rules["@typescript-eslint/no-empty-function"] = "error";
/**
- * Checks that JSDoc tag names are valid.
+ * Disallows the declaration of empty interfaces.
*
- * @name jsdoc/check-tag-names
+ * @name no-empty-interface
* @memberof rules
- * @type {Array}
+ * @type {string}
* @default 'error'
- * @see [check-tag-names]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/check-tag-names.md}
+ * @see [no-empty-interface]{@link https://typescript-eslint.io/rules/no-empty-interface}
+ *
+ * @example
+ * // Bad...
+ * interface Empty {}
+ *
+ * // Good...
+ * interface NotEmpty {
+ * data: string;
+ * }
*/
-rules['jsdoc/check-tag-names'] = 'error';
-
-/**
-* Checks for empty JSDoc tags.
-*
-* @name jsdoc/empty-tags
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [empty-tags]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/empty-tags.md}
-*/
-rules[ 'jsdoc/empty-tags' ] = 'error';
-
-/**
-* Checks that the @implements tag is used correctly on classes.
-*
-* @name jsdoc/implements-on-classes
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [implements-on-classes]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/implements-on-classes.md}
-*/
-rules[ 'jsdoc/implements-on-classes' ] = 'error';
-
-/**
-* Controls how and whether JSDoc blocks can be expressed as single or multiple line blocks.
-*
-* @name jsdoc/multiline-blocks
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [multiline-blocks]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/multiline-blocks.md}
-*/
-rules[ 'jsdoc/multiline-blocks' ] = 'error';
-
-/**
-* Prevents blank lines in block descriptions.
-*
-* @name jsdoc/no-blank-block-descriptions
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-blank-block-descriptions]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/no-blank-block-descriptions.md}
-*/
-rules[ 'jsdoc/no-blank-block-descriptions' ] = 'error';
-
-/**
-* Prevents use of default values in JSDoc tags.
-*
-* @name jsdoc/no-defaults
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-defaults]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/no-defaults.md}
-*/
-rules[ 'jsdoc/no-defaults' ] = 'error';
-
-/**
-* Prevents use of multiple asterisks at the beginning of lines.
-*
-* @name jsdoc/no-multi-asterisks
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-multi-asterisks]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/no-multi-asterisks.md}
-*/
-rules[ 'jsdoc/no-multi-asterisks' ] = 'error';
-
-/**
-* Requires that each JSDoc line starts with an asterisk.
-*
-* @name jsdoc/require-asterisk-prefix
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [require-asterisk-prefix]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/require-asterisk-prefix.md}
-*/
-rules[ 'jsdoc/require-asterisk-prefix' ] = 'error';
-
-/**
-* Requires that all functions have a description.
-*
-* @name jsdoc/require-description
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [require-description]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/require-description.md}
-*/
-rules[ 'jsdoc/require-description' ] = 'error';
-
-/**
-* Requires a hyphen before the @param description.
-*
-* @name jsdoc/require-hyphen-before-param-description
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [require-hyphen-before-param-description]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/require-hyphen-before-param-description.md}
-*/
-rules[ 'jsdoc/require-hyphen-before-param-description' ] = 'error';
-
-/**
-* Requires that all functions have JSDoc documentation.
-*
-* @name jsdoc/require-jsdoc
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [require-jsdoc]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/require-jsdoc.md}
-*/
-rules[ 'jsdoc/require-jsdoc' ] = 'error';
-
-/**
-* Requires that all function parameters are documented.
-*
-* @name jsdoc/require-param
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [require-param]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/require-param.md}
-*/
-rules[ 'jsdoc/require-param' ] = 'error';
-
-/**
-* Requires that @param tag has description value.
-*
-* @name jsdoc/require-param-description
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [require-param-description]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/require-param-description.md}
-*/
-rules[ 'jsdoc/require-param-description' ] = 'error';
-
-/**
-* Requires that all @param tags have names.
-*
-* @name jsdoc/require-param-name
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [require-param-name]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/require-param-name.md}
-*/
-rules[ 'jsdoc/require-param-name' ] = 'error';
-
-/**
-* Requires that all function properties are documented.
-*
-* @name jsdoc/require-property
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [require-property]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/require-property.md}
-*/
-rules[ 'jsdoc/require-property' ] = 'error';
-
-/**
-* Requires that @property tag has description value.
-*
-* @name jsdoc/require-property-description
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [require-property-description]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/require-property-description.md}
-*/
-rules[ 'jsdoc/require-property-description' ] = 'error';
-
-/**
-* Requires that all @property tags have names.
-*
-* @name jsdoc/require-property-name
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [require-property-name]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/require-property-name.md}
-*/
-rules[ 'jsdoc/require-property-name' ] = 'error';
-
-/**
-* Requires that @property tags have type values.
-*
-* @name jsdoc/require-property-type
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [require-property-type]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/require-property-type.md}
-*/
-rules[ 'jsdoc/require-property-type' ] = 'error';
-
-/**
-* Requires returns are documented.
-*
-* @name jsdoc/require-returns
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [require-returns]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/require-returns.md}
-*/
-rules[ 'jsdoc/require-returns' ] = 'error';
-
-/**
-* Requires a return statement in function body if a @returns tag is specified in JSDoc comment.
-*
-* @name jsdoc/require-returns-check
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [require-returns-check]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/require-returns-check.md}
-*/
-rules[ 'jsdoc/require-returns-check' ] = 'error';
-
-/**
-* Requires that @returns tag has description value.
-*
-* @name jsdoc/require-returns-description
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [require-returns-description]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/require-returns-description.md}
-*/
-rules[ 'jsdoc/require-returns-description' ] = 'error';
-
-/**
-* Requires that @throws statements are documented.
-*
-* @name jsdoc/require-throws
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [require-throws]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/require-throws.md}
-*/
-rules[ 'jsdoc/require-throws' ] = 'error';
-
-/**
-* Requires that tags are sorted alphabetically.
-*
-* @name jsdoc/sort-tags
-* @memberof rules
-* @type {string}
-* @default [ 'error', {...} ]
-* @see [sort-tags]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/sort-tags.md}
-*/
-rules[ 'jsdoc/sort-tags' ] = ['error', {
- 'linesBetween': 1,
- 'tagSequence': [
- {
- 'tags': [ 'param', 'throws', 'returns', 'see' ]
- },
- {
- 'tags': [ 'examples' ]
- }
- ],
- 'reportIntraTagGroupSpacing': false
-}];
-
-/**
-* Disables the JSDoc rule for checking alignment.
-*
-* @name jsdoc/check-alignment
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [check-alignment]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/check-alignment.md}
-*/
-rules[ 'jsdoc/check-alignment' ] = 'off';
-
-/**
-* Disables the JSDoc rule for checking indentation.
-*
-* @name jsdoc/check-indentation
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [check-indentation]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/check-indentation.md}
-*/
-rules[ 'jsdoc/check-indentation' ] = 'off';
-
-/**
-* Requires that JSDoc does not include types.
-*
-* ## Notes
-*
-* - We enable this rule as the type information in TypeScript is included in the signatures and does not need to be duplicated in the JSDoc comment.
-*
-* @name jsdoc/no-types
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-types]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/no-types.md}
-*/
-rules[ 'jsdoc/no-types' ] = 'error';
-
-/**
-* Enforces Unix linebreaks.
-*
-* @name linebreak-style
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'unix' ]
-* @see [linebreak-style]{@link https://eslint.org/docs/rules/linebreak-style}
-*
-* @example
-* // Bad...
-* const bad = 'Bad linebreak\r\n';
-*
-* // Good...
-* const good = 'Good linebreak\n';
-*/
-rules[ 'linebreak-style' ] = [ 'error', 'unix' ];
-
-/**
-* Enforces a maximum number of classes per file.
-*
-* @name max-classes-per-file
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 1 ]
-* @see [max-classes-per-file]{@link https://eslint.org/docs/rules/max-classes-per-file}
-*
-* @example
-* // Bad...
-* class Foo {}
-* class Bar {}
-*
-* // Good...
-* class Baz {}
-*/
-rules[ 'max-classes-per-file' ] = [ 'error', 1 ];
-
-/**
-* Enforces a maximum line length.
-*
-* @name max-len
-* @memberof rules
-* @type {Array}
-* @default [ 'error', { 'ignorePattern': '^import |\\/\\/ |\\/?\\* ', 'code': 1000 } ]
-* @see [max-len]{@link https://eslint.org/docs/rules/max-len}
-*
-* @example
-* // Good...
-* // This line can be very long because it is an import statement that we are choosing to ignore.
-* import { aVeryLongImportStatementIsHereAndWeWantToIgnoreItBecauseItMakesSenseToUs } from 'some-external-library';
-*/
-rules[ 'max-len' ] = [ 'error', {
- 'ignorePattern': '^import |\\/\\/ |\\/?\\* ',
- 'code': 1000
-}];
-
-/**
-* Enforces a maximum number of lines per file.
-*
-* @name max-lines
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 1000 ]
-* @see [max-lines]{@link https://eslint.org/docs/rules/max-lines}
-*/
-rules[ 'max-lines' ] = [ 'error', 1000 ];
-
-/**
-* Enforces the use of parentheses when invoking a constructor with no arguments.
-*
-* @name new-parens
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [new-parens]{@link https://eslint.org/docs/rules/new-parens}
-*
-* @example
-* // Bad...
-* const bad = new Foo;
-*
-* // Good...
-* const good = new Foo();
-*/
-rules[ 'new-parens' ] = 'error';
-
-/**
-* Disables the rule that requires a newline after each call in a method chain.
-*
-* @name newline-per-chained-call
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [newline-per-chained-call]{@link https://eslint.org/docs/rules/newline-per-chained-call}
-*/
-rules[ 'newline-per-chained-call' ] = 'off';
-
-/**
-* Disables the rule against bitwise operators.
-*
-* @name no-bitwise
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [no-bitwise]{@link https://eslint.org/docs/rules/no-bitwise}
-*/
-rules[ 'no-bitwise' ] = 'off';
-
-/**
-* Disallows the use of `arguments.caller` or `arguments.callee`.
-*
-* @name no-caller
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-caller]{@link https://eslint.org/docs/rules/no-caller}
-*
-* @example
-* // Bad...
-* function bad() {
-* const whoCalled = arguments.callee.caller;
-* }
-*
-* // Good...
-* function good() {
-* // Do not use arguments.callee or arguments.caller
-* }
-*/
-rules[ 'no-caller' ] = 'error';
-
-/**
-* Disallows assignment operators in conditional expressions.
-*
-* @name no-cond-assign
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-cond-assign]{@link https://eslint.org/docs/rules/no-cond-assign}
-*
-* @example
-* // Bad...
-* if ( x = y ) {
-* // ...
-* }
-*
-* // Good...
-* if ( x === y ) {
-* // ...
-* }
-*/
-rules[ 'no-cond-assign' ] = 'error';
-
-/**
-* Disallows the use of `console` methods.
-*
-* @name no-console
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-console]{@link https://eslint.org/docs/rules/no-console}
-*
-* @example
-* // Bad...
-* console.log( 'Here be dragons.' );
-*/
-rules[ 'no-console' ] = 'error';
-
-/**
-* Disallows the use of `debugger` statement.
-*
-* @name no-debugger
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-debugger]{@link https://eslint.org/docs/rules/no-debugger}
-*
-* @example
-* // Bad...
-* debugger;
-*/
-rules[ 'no-debugger' ] = 'error';
-
-/**
-* Disallows duplicate case labels in `switch` statements.
-*
-* @name no-duplicate-case
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-duplicate-case]{@link https://eslint.org/docs/rules/no-duplicate-case}
-*
-* @example
-* // Bad...
-* switch ( a ) {
-* case 1:
-* // ...
-* case 1:
-* // Duplicate case label.
-* }
-*
-* // Good...
-* switch (a) {
-* case 1:
-* // ...
-* case 2:
-* // ...
-* }
-*/
-rules[ 'no-duplicate-case' ] = 'error';
-
-/**
-* Disallows duplicate imports in a single file.
-*
-* @name no-duplicate-imports
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-duplicate-imports]{@link https://eslint.org/docs/rules/no-duplicate-imports}
-*
-* @example
-* // Bad...
-* import { a } from 'module';
-* import { b } from 'module';
-*
-* // Good...
-* import { a, b } from 'module';
-*/
-rules[ 'no-duplicate-imports' ] = 'error';
-
-/**
-* Disallows empty block statements.
-*
-* @name no-empty
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-empty]{@link https://eslint.org/docs/rules/no-empty}
-*
-* @example
-* // Bad...
-* if ( foo ) {
-* }
-*
-* // Good...
-* if ( foo ) {
-* // code
-* }
-*/
-rules[ 'no-empty' ] = 'error';
-
-/**
-* Disallows the use of `eval()`.
-*
-* @name no-eval
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-eval]{@link https://eslint.org/docs/rules/no-eval}
-*
-* @example
-* // Bad...
-* const obj = eval( '( { "a": 20 } )' );
-*
-* // Good...
-* const obj = ( { 'a': 20 } );
-*/
-rules[ 'no-eval' ] = 'error';
-
-/**
-* Disallows unnecessary function binding.
-*
-* @name no-extra-bind
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-extra-bind]{@link https://eslint.org/docs/rules/no-extra-bind}
-*
-* @example
-* // Bad...
-* const bad = function() {
-* console.log( this.a );
-* }.bind({ a: 'bad' });
-*
-* // Good...
-* const good = function() {
-* console.log( this.a );
-* };
-*/
-rules[ 'no-extra-bind' ] = 'error';
-
-/**
-* Disallows fallthrough of `case` statements in `switch` statements.
-*
-* @name no-fallthrough
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-fallthrough]{@link https://eslint.org/docs/rules/no-fallthrough}
-*
-* @example
-* // Bad...
-* switch ( foo ) {
-* case 1:
-* doSomething();
-* // no break and fallthrough is intentional here, but it's usually a mistake
-* case 2:
-* doSomethingElse();
-* }
-*
-* // Good...
-* switch ( foo ) {
-* case 1:
-* doSomething();
-* break;
-* case 2:
-* doSomethingElse();
-* }
-*/
-rules[ 'no-fallthrough' ] = 'error';
-
-/**
-* Disallows `this` keywords outside of classes or class-like objects.
-*
-* @name no-invalid-this
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-invalid-this]{@link https://eslint.org/docs/rules/no-invalid-this}
-*
-* @example
-* // Bad...
-* function bad() {
-* console.log( this );
-* }
-*
-* // Good...
-* class Good {
-* good() {
-* console.log( this );
-* }
-* }
-*/
-rules[ 'no-invalid-this' ] = 'error';
-
-/**
-* Disallows irregular whitespace outside of strings and comments.
-*
-* @name no-irregular-whitespace
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-irregular-whitespace]{@link https://eslint.org/docs/rules/no-irregular-whitespace}
-*/
-rules[ 'no-irregular-whitespace' ] = 'error';
-
-/**
-* Disables the rule against magic numbers.
-*
-* @name no-magic-numbers
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [no-magic-numbers]{@link https://eslint.org/docs/rules/no-magic-numbers}
-*/
-rules[ 'no-magic-numbers' ] = 'off';
+rules["@typescript-eslint/no-empty-interface"] = "error";
-/* eslint-disable stdlib/jsdoc-no-multiple-blank-lines */
+/**
+ * Warns on usage of the `any` type.
+ *
+ * @name no-explicit-any
+ * @memberof rules
+ * @type {string}
+ * @default 'warn'
+ * @see [no-explicit-any]{@link https://typescript-eslint.io/rules/no-explicit-any}
+ *
+ * @example
+ * // Bad...
+ * function unsafe( arg: any ): any { return arg; }
+ *
+ * // Good...
+ * function safe( arg: unknown ): unknown { return arg; }
+ */
+rules["@typescript-eslint/no-explicit-any"] = "warn";
/**
-* Disallows multiple empty lines, allowing a maximum of two.
-*
-* @name no-multiple-empty-lines
-* @memberof rules
-* @type {Array}
-* @default [ 'error', { 'max': 2 } ]
-* @see [no-multiple-empty-lines]{@link https://eslint.org/docs/rules/no-multiple-empty-lines}
-*
-* @example
-* // Bad...
-*
-*
-*
-* const bad = 'Too many empty lines';
-*
-* // Good...
-*
-* const good = 'Just enough empty lines';
-*/
-rules[ 'no-multiple-empty-lines' ] = [ 'error', {
- 'max': 2
-}];
+ * Disallows classes that only have static members and don't need to be instantiated.
+ *
+ * @name no-extraneous-class
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-extraneous-class]{@link https://typescript-eslint.io/rules/no-extraneous-class}
+ *
+ * @example
+ * // Bad...
+ * class StaticOnly {
+ * static doSomething() {}
+ * }
+ *
+ * // Good...
+ * namespace StaticOnly {
+ * export function doSomething() {}
+ * }
+ */
+rules["@typescript-eslint/no-extraneous-class"] = "error";
-/* eslint-enable stdlib/jsdoc-no-multiple-blank-lines */
+/**
+ * Requires Promises to be handled appropriately. Unhandled Promises can cause unexpected behavior.
+ *
+ * @name no-floating-promises
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-floating-promises]{@link https://typescript-eslint.io/rules/no-floating-promises}
+ *
+ * @example
+ * // Bad...
+ * new Promise( resolve => resolve() );
+ *
+ * // Good...
+ * new Promise( resolve => resolve() ).catch( handleError );
+ */
+rules["@typescript-eslint/no-floating-promises"] = "error";
/**
-* Disallows the use of the `Function` constructor to create new functions.
-*
-* @name no-new-func
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-new-func]{@link https://eslint.org/docs/rules/no-new-func}
-*
-* @example
-* // Bad...
-* const bad = new Function( 'a', 'b', 'return a + b' );
-*
-* // Good...
-* function good( a, b ) {
-* return a + b;
-* }
-*/
-rules[ 'no-new-func' ] = 'error';
-
-/**
-* Disallows creating new instances of `String`, `Number`, and `Boolean`.
-*
-* @name no-new-wrappers
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-new-wrappers]{@link https://eslint.org/docs/rules/no-new-wrappers}
-*
-* @example
-* // Bad...
-* const badString = new String( 'bad' );
-* const badNumber = new Number( 1 );
-* const badBoolean = new Boolean( false );
-*
-* // Good...
-* const goodString = 'good';
-* const goodNumber = 1;
-* const goodBoolean = false;
-*/
-rules[ 'no-new-wrappers' ] = 'error';
-
-/**
-* Disables the rule against reassigning parameters.
-*
-* @name no-param-reassign
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [no-param-reassign]{@link https://eslint.org/docs/rules/no-param-reassign}
-*/
-rules[ 'no-param-reassign' ] = 'off';
-
-/**
-* Disallows the unary operators `++` and `--`, except in `for` loop afterthoughts.
-*
-* @name no-plusplus
-* @memberof rules
-* @type {Array}
-* @default [ 'error', { 'allowForLoopAfterthoughts': true } ]
-* @see [no-plusplus]{@link https://eslint.org/docs/rules/no-plusplus}
-*
-* @example
-* // Bad...
-* let bad = 0;
-* bad++;
-*
-* // Good...
-* for ( let i = 0; i < 10; i++ ) {
-* // allowed in for loop afterthoughts
-* }
-*/
-rules[ 'no-plusplus' ] = [ 'error', {
- 'allowForLoopAfterthoughts': true
-}];
-
-/**
-* Disable rule disallowing redeclaring variables.
-*
-* @name no-redeclare
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [no-redeclare]{@link https://eslint.org/docs/rules/no-redeclare}
-*/
-rules[ 'no-redeclare' ] = 'off'; // NOTE: disabled due to erroneous lint error when declaring overloaded function definitions
-
-/**
-* Disallows importing specific modules.
-*
-* @name no-restricted-imports
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'lodash' ]
-* @see [no-restricted-imports]{@link https://eslint.org/docs/rules/no-restricted-imports}
-*/
-rules[ 'no-restricted-imports' ] = [ 'error', 'lodash' ];
-
-/**
-* Disallows specified syntax.
-*
-* @name no-restricted-syntax
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'ForInStatement' ]
-* @see [no-restricted-syntax]{@link https://eslint.org/docs/rules/no-restricted-syntax}
-*/
-rules[ 'no-restricted-syntax' ] = [ 'error', 'ForInStatement' ];
-
-/**
-* Disallows returning values from `await`.
-*
-* @name no-return-await
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-return-await]{@link https://eslint.org/docs/rules/no-return-await}
-*/
-rules[ 'no-return-await' ] = 'error';
-
-/**
-* Disallows the use of the comma operator.
-*
-* @name no-sequences
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-sequences]{@link https://eslint.org/docs/rules/no-sequences}
-*/
-rules[ 'no-sequences' ] = 'error';
-
-/**
-* Disables the rule against variable shadowing.
-*
-* @name no-shadow
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [no-shadow]{@link https://eslint.org/docs/rules/no-shadow}
-*/
-rules[ 'no-shadow' ] = 'off';
-
-/**
-* Disallows sparse arrays.
-*
-* @name no-sparse-arrays
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-sparse-arrays]{@link https://eslint.org/docs/rules/no-sparse-arrays}
-*/
-rules[ 'no-sparse-arrays' ] = 'error';
-
-/**
-* Disallows template literal placeholder syntax in regular strings.
-*
-* @name no-template-curly-in-string
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-template-curly-in-string]{@link https://eslint.org/docs/rules/no-template-curly-in-string}
-*/
-rules[ 'no-template-curly-in-string' ] = 'error';
-
-/**
-* Disallows throwing literals as exceptions.
-*
-* @name no-throw-literal
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-throw-literal]{@link https://eslint.org/docs/rules/no-throw-literal}
-*/
-rules[ 'no-throw-literal' ] = 'error';
-
-/**
-* Disallows trailing whitespace at the end of lines.
-*
-* @name no-trailing-spaces
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-trailing-spaces]{@link https://eslint.org/docs/rules/no-trailing-spaces}
-*/
-rules[ 'no-trailing-spaces' ] = 'error';
-
-/**
-* Disallows initializing variables to `undefined`.
-*
-* @name no-undef-init
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-undef-init]{@link https://eslint.org/docs/rules/no-undef-init}
-*/
-rules[ 'no-undef-init' ] = 'error';
-
-/**
-* Disallows dangling underscores in identifiers.
-*
-* @name no-underscore-dangle
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-underscore-dangle]{@link https://eslint.org/docs/rules/no-underscore-dangle}
-*/
-rules[ 'no-underscore-dangle' ] = 'error';
-
-/**
-* Disallows control flow statements in `finally` blocks.
-*
-* @name no-unsafe-finally
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-unsafe-finally]{@link https://eslint.org/docs/rules/no-unsafe-finally}
-*/
-rules[ 'no-unsafe-finally' ] = 'error';
-
-/**
-* Disallows unused labels.
-*
-* @name no-unused-labels
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-unused-labels]{@link https://eslint.org/docs/rules/no-unused-labels}
-*/
-rules[ 'no-unused-labels' ] = 'error';
-
-/**
-* Disallows unnecessary constructors.
-*
-* @name no-useless-constructor
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-useless-constructor]{@link https://eslint.org/docs/rules/no-useless-constructor}
-*/
-rules[ 'no-useless-constructor' ] = 'error';
-
-/**
-* Disables the rule against usage of the `void` operator.
-*
-* @name no-void
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [no-void]{@link https://eslint.org/docs/rules/no-void}
-*/
-rules[ 'no-void' ] = 'off';
-
-/**
-* Enforces the consistent use of object literal shorthand syntax where possible.
-*
-* @name object-shorthand
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'never' ]
-* @see [object-shorthand]{@link https://eslint.org/docs/rules/object-shorthand}
-*/
-rules[ 'object-shorthand' ] = [ 'error', 'never' ];
-
-/**
-* Enforces variables to be declared either separately or in a single declaration.
-*
-* @name one-var
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'never' ]
-* @see [one-var]{@link https://eslint.org/docs/rules/one-var}
-*/
-rules[ 'one-var' ] = [ 'error', 'never' ];
-
-/**
-* Disables the rule for padding lines between statements.
-*
-* @name padding-line-between-statements
-* @memberof rules
-* @type {Array}
-* @default [ 'off', { 'blankLine': 'always', 'prev': '*', 'next': 'return' } ]
-* @see [padding-line-between-statements]{@link https://eslint.org/docs/rules/padding-line-between-statements}
-*/
-rules[ 'padding-line-between-statements' ] = [ 'off', {
- 'blankLine': 'always',
- 'prev': '*',
- 'next': 'return'
-}];
-
-/**
-* Requires the use of `const` for variables that are never reassigned after declared.
-*
-* @name prefer-const
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [prefer-const]{@link https://eslint.org/docs/rules/prefer-const}
-*/
-rules[ 'prefer-const' ] = 'error';
-
-/**
-* Disables the preference for using object spread over `Object.assign`.
-*
-* @name prefer-object-spread
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [prefer-object-spread]{@link https://eslint.org/docs/rules/prefer-object-spread}
-*/
-rules[ 'prefer-object-spread' ] = 'off';
-
-/**
-* Disables the preference for template literals over string concatenation.
-*
-* @name prefer-template
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [prefer-template]{@link https://eslint.org/docs/rules/prefer-template}
-*/
-rules[ 'prefer-template' ] = 'off';
-
-/**
-* Enforces quote properties in object literals to be always present.
-*
-* @name quote-props
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'always' ]
-* @see [quote-props]{@link https://eslint.org/docs/rules/quote-props}
-*/
-rules[ 'quote-props' ] = [ 'error', 'always' ];
-
-/**
-* Disables the enforcement of the consistent use of either backticks, double, or single quotes.
-*
-* @name quotes
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [quotes]{@link https://eslint.org/docs/rules/quotes}
-*/
-rules[ 'quotes' ] = 'off';
-
-/**
-* Enforces passing the radix parameter to the `parseInt()` function.
-*
-* @name radix
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [radix]{@link https://eslint.org/docs/rules/radix}
-*
-* @example
-* // Bad...
-* const bad = parseInt( '123' );
-*
-* // Good...
-* const good = parseInt( '123', 10 );
-*/
-rules[ 'radix' ] = 'error';
-
-/**
-* Enforces consistent spacing before function parentheses.
-*
-* @name @typescript-eslint/space-before-function-paren
-* @memberof rules
-* @type {Array}
-* @default [ 'error', { 'anonymous': 'always', 'named': 'never', 'asyncArrow': 'always' } ]
-* @see [space-before-function-paren]{@link https://typescript-eslint.io/rules/space-before-function-paren}
-*/
-rules[ '@typescript-eslint/space-before-function-paren' ] = [
- 'error',
- {
- 'anonymous': 'always',
- 'named': 'never',
- 'asyncArrow': 'always'
- }
-];
+ * Disallows iterating over an array with a for-in loop. A for-of loop should be used instead.
+ *
+ * @name no-for-in-array
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-for-in-array]{@link https://typescript-eslint.io/rules/no-for-in-array}
+ *
+ * @example
+ * // Bad...
+ * const arr = [ 1, 2, 3 ];
+ * for ( const i in arr ) {
+ * console.log( arr[ i ] );
+ * }
+ *
+ * // Good...
+ * for ( const i of arr ) {
+ * console.log( i );
+ * }
+ */
+rules["@typescript-eslint/no-for-in-array"] = "error";
+
+/**
+ * Disallows explicit type declarations for variables or parameters initialized to a number, string, or boolean.
+ *
+ * @name no-inferrable-types
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-inferrable-types]{@link https://typescript-eslint.io/rules/no-inferrable-types}
+ *
+ * @example
+ * // Bad...
+ * let x: number = 1;
+ *
+ * // Good...
+ * let x = 1;
+ */
+rules["@typescript-eslint/no-inferrable-types"] = "error";
+
+/**
+ * Disallows the incorrect use of `new` with interfaces or `new` for defining a constructor.
+ *
+ * @name no-misused-new
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-misused-new]{@link https://typescript-eslint.io/rules/no-misused-new}
+ *
+ * @example
+ * // Bad...
+ * interface I {
+ * new (): I;
+ * }
+ *
+ * // Good...
+ * class C implements I {
+ * constructor() {}
+ * }
+ */
+rules["@typescript-eslint/no-misused-new"] = "error";
+
+/**
+ * Disallows the use of custom TypeScript modules and namespaces.
+ *
+ * @name no-namespace
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-namespace]{@link https://typescript-eslint.io/rules/no-namespace}
+ *
+ * @example
+ * // Bad...
+ * module M {
+ * export const x = 1;
+ * }
+ *
+ * // Good...
+ * namespace N {
+ * export const x = 1;
+ * }
+ */
+rules["@typescript-eslint/no-namespace"] = "error";
+
+/**
+ * Disallows non-null assertions using the `!` postfix operator.
+ *
+ * @name no-non-null-assertion
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-non-null-assertion]{@link https://typescript-eslint.io/rules/no-non-null-assertion}
+ *
+ * @example
+ * // Bad...
+ * const x: number | null = null;
+ * const y: number = x!;
+ *
+ * // Good...
+ * if ( x !== null ) {
+ * const y: number = x;
+ * }
+ */
+rules["@typescript-eslint/no-non-null-assertion"] = "error";
+
+/**
+ * Disables the rule against using `require` statements instead of import declarations.
+ *
+ * @name no-require-imports
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [no-require-imports]{@link https://typescript-eslint.io/rules/no-require-imports}
+ *
+ * @example
+ * // Okay...
+ * const module = require( 'module' );
+ */
+rules["@typescript-eslint/no-require-imports"] = "off";
+
+/**
+ * Disallows aliases for `this`.
+ *
+ * @name no-this-alias
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-this-alias]{@link https://typescript-eslint.io/rules/no-this-alias}
+ *
+ * @example
+ * // Bad...
+ * const self = this;
+ * const that = this;
+ *
+ * // Good...
+ * function example() {
+ * console.log( this );
+ * }
+ */
+rules["@typescript-eslint/no-this-alias"] = "error";
+
+/**
+ * Disables the rule against unnecessary boolean literal comparisons.
+ *
+ * @name no-unnecessary-boolean-literal-compare
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [no-unnecessary-boolean-literal-compare]{@link https://typescript-eslint.io/rules/no-unnecessary-boolean-literal-compare}
+ *
+ * @example
+ * // Okay...
+ * const x = true;
+ * if ( x === true ) {
+ * // ...
+ * }
+ */
+rules["@typescript-eslint/no-unnecessary-boolean-literal-compare"] = "off";
+
+/**
+ * Disallows unnecessary qualifiers (like namespaces or enum names) when the referenced item is accessible without them.
+ *
+ * @name no-unnecessary-qualifier
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-unnecessary-qualifier]{@link https://typescript-eslint.io/rules/no-unnecessary-qualifier}
+ *
+ * @example
+ * // Bad...
+ * namespace A {
+ * export const B = 1;
+ * }
+ * const x = A.B;
+ *
+ * // Good...
+ * const B = 1;
+ * const x = B;
+ */
+rules["@typescript-eslint/no-unnecessary-qualifier"] = "error";
+
+/**
+ * Disallows unnecessary type arguments in generics where the argument is the default.
+ *
+ * @name no-unnecessary-type-arguments
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-unnecessary-type-arguments]{@link https://typescript-eslint.io/rules/no-unnecessary-type-arguments}
+ *
+ * @example
+ * // Bad...
+ * function f<T = number>( x: T ) {
+ * return x + x
+ * }
+ * f<number>();
+ *
+ * // Good...
+ * function f<T>( x: T ) {
+ * return x + x
+ * }
+ * f( 1 );
+ * f<string>( 'a' );
+ */
+rules["@typescript-eslint/no-unnecessary-type-arguments"] = "error";
+
+/**
+ * Disallows unnecessary type assertions that do not change the type of an expression.
+ *
+ * @name no-unnecessary-type-assertion
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-unnecessary-type-assertion]{@link https://typescript-eslint.io/rules/no-unnecessary-type-assertion}
+ *
+ * @example
+ * // Bad...
+ * const x: number = 10;
+ * const y = x as number;
+ *
+ * // Good...
+ * const x: number = 10;
+ * const y = x;
+ */
+rules["@typescript-eslint/no-unnecessary-type-assertion"] = "error";
/**
-* Enforces consistent spacing inside parentheses.
-*
-* @name space-in-parens
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'always' ]
-* @see [space-in-parens]{@link https://eslint.org/docs/rules/space-in-parens}
-*/
-rules[ 'space-in-parens' ] = [ 'error', 'always' ];
-
-/**
-* Enforces consistent spacing after the `//` or `/*` in a comment.
-*
-* @name spaced-comment
-* @memberof rules
-* @type {Array}
-* @default [ 'error', 'always', { 'markers': [ '/' ] } ]
-* @see [spaced-comment]{@link https://eslint.org/docs/rules/spaced-comment}
-*/
-rules[ 'spaced-comment' ] = [ 'error', 'always', {
- 'markers': [ '/' ]
-}];
-
-/**
-* Enforces the use of `isNaN()` when checking for `NaN`.
-*
-* @name use-isnan
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [use-isnan]{@link https://eslint.org/docs/rules/use-isnan}
-*
-* @example
-* // Bad...
-* if ( foo === NaN ) {
-* // ...
-* }
-*
-* // Good...
-* if ( isNaN( foo ) ) {
-* // ...
-* }
-*/
-rules[ 'use-isnan' ] = 'error';
-
-/**
-* Enforces the style of conditions to avoid Yoda conditions.
-*
-* @name yoda
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [yoda]{@link https://eslint.org/docs/rules/yoda}
-*
-* @example
-* // Bad...
-* if ( 'red' === color ) {
-* // ...
-* }
-*
-* // Good...
-* if ( color === 'red' ) {
-* // ...
-* }
-*/
-rules[ 'yoda' ] = 'error';
-
-/**
-* Enforces that types indicated in special comments match the types of code values.
-*
-* @name expect-type
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [expect-type]{@link https://github.com/JoshuaKGoldberg/eslint-plugin-expect-type/blob/main/docs/rules/expect.md}
-*
-* @example
-* // Bad...
-* const str = 'abc'; // $ExpectType number
-*
-* // Good...
-* const val = 9001; // $ExpectType number
-*/
-rules[ 'expect-type/expect' ] = 'error';
+ * Disallows unused expressions which have no effect on the state of the program.
+ *
+ * @name no-unused-expressions
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-unused-expressions]{@link https://typescript-eslint.io/rules/no-unused-expressions}
+ *
+ * @example
+ * // Bad...
+ * 0;
+ * if ( false ) {}
+ *
+ * // Good...
+ * (() => {
+ * const a = 0;
+ * })();
+ */
+rules["@typescript-eslint/no-unused-expressions"] = "error";
+/**
+ * Disables the rule against unused variables.
+ *
+ * @name no-unused-vars
+ * @memberof rules
+ * @type {string}
+ * @default [ 'error', { 'args': 'after-used' } ]
+ * @see [no-unused-vars]{@link https://typescript-eslint.io/rules/no-unused-vars}
+ *
+ * @example
+ * // Bad...
+ * function foo( x, y, z ) {
+ * return x + y;
+ * }
+ *
+ * // Okay...
+ * function bar( x, y, z ) {
+ * return y + z;
+ * }
+ */
+rules["@typescript-eslint/no-unused-vars"] = [
+ "error",
+ {
+ args: "after-used",
+ },
+];
+
+/**
+ * Disallows the use of variables before they are defined.
+ *
+ * @name no-use-before-define
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-use-before-define]{@link https://typescript-eslint.io/rules/no-use-before-define}
+ *
+ * @example
+ * // Bad...
+ * console.log( a );
+ * let a = 10;
+ *
+ * // Good...
+ * let b = 10;
+ * console.log( b );
+ */
+rules["@typescript-eslint/no-use-before-define"] = "error";
+
+/**
+ * Disallows the use of `require` statements except in import statements.
+ *
+ * @name no-var-requires
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-var-requires]{@link https://typescript-eslint.io/rules/no-var-requires}
+ *
+ * @example
+ * // Bad...
+ * const moduleA = require( 'moduleA' );
+ *
+ * // Good...
+ * import moduleA from 'moduleA';
+ *
+ * import moduleA = require( 'moduleA' );
+ */
+rules["@typescript-eslint/no-var-requires"] = "error";
+
+/**
+ * Disables the preference for `for-of` loops over standard `for` loops with index variables.
+ *
+ * @name prefer-for-of
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [prefer-for-of]{@link https://typescript-eslint.io/rules/prefer-for-of}
+ *
+ * @example
+ * // Okay...
+ * for ( let i = 0; i < myArray.length; i++ ) {
+ * console.log( myArray[ i ] );
+ * }
+ */
+rules["@typescript-eslint/prefer-for-of"] = "off";
+
+/**
+ * Prefers function types instead of interfaces with call signatures.
+ *
+ * @name prefer-function-type
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [prefer-function-type]{@link https://typescript-eslint.io/rules/prefer-function-type}
+ *
+ * @example
+ * // Bad...
+ * interface Callable {
+ * (): void;
+ * }
+ *
+ * // Good...
+ * type Callable = () => void;
+ */
+rules["@typescript-eslint/prefer-function-type"] = "error";
+
+/**
+ * Prefers the use of the `namespace` keyword instead of `module` to declare custom TypeScript modules.
+ *
+ * @name prefer-namespace-keyword
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [prefer-namespace-keyword]{@link https://typescript-eslint.io/rules/prefer-namespace-keyword}
+ *
+ * @example
+ * // Bad...
+ * module M {
+ * export const x = 1;
+ * }
+ *
+ * // Good...
+ * namespace M {
+ * export const x = 1;
+ * }
+ */
+rules["@typescript-eslint/prefer-namespace-keyword"] = "error";
+
+/**
+ * Disables the rule that private members are marked as `readonly` if they're never modified outside of the constructor.
+ *
+ * @name prefer-readonly
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [prefer-readonly]{@link https://typescript-eslint.io/rules/prefer-readonly}
+ *
+ * @example
+ * // Okay...
+ * class MyClass {
+ * private name: string;
+ * constructor( name: string ) {
+ * this.name = name;
+ * }
+ * }
+ */
+rules["@typescript-eslint/prefer-readonly"] = "off";
+
+/**
+ * Disables the rule that functions which return promises must be async.
+ *
+ * @name promise-function-async
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [promise-function-async]{@link https://typescript-eslint.io/rules/promise-function-async}
+ *
+ * @example
+ * // Okay...
+ * function fetchWithoutAsync() {
+ * return fetch( 'url' ).then( response => response.json() );
+ * }
+ */
+rules["@typescript-eslint/promise-function-async"] = "off";
+
+/**
+ * Enforces the consistent use of single quotes for string literals and allows avoiding escape for quotes.
+ *
+ * @name quotes
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'single', { 'avoidEscape': true } ]
+ * @see [quotes]{@link https://typescript-eslint.io/rules/quotes}
+ *
+ * @example
+ * // Bad...
+ * const bad = "bad";
+ *
+ * // Good...
+ * const good = 'good';
+ * const goodEscape = "good's";
+ */
+rules["@typescript-eslint/quotes"] = [
+ "error",
+ "single",
+ {
+ avoidEscape: true,
+ },
+];
+
+/**
+ * Requires that `async` functions have an `await` expression.
+ *
+ * @name require-await
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [require-await]{@link https://typescript-eslint.io/rules/require-await}
+ *
+ * @example
+ * // Bad...
+ * async function bad() {
+ * return 42;
+ * }
+ *
+ * // Good...
+ * async function good() {
+ * return await someAsyncFunction();
+ * }
+ */
+rules["@typescript-eslint/require-await"] = "error";
+
+/**
+ * When adding two variables, operands must both be of type number or of type string.
+ *
+ * @name restrict-plus-operands
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [restrict-plus-operands]{@link https://typescript-eslint.io/rules/restrict-plus-operands}
+ *
+ * @example
+ * // Bad...
+ * const bad = 'The total is: ' + 42;
+ *
+ * // Good...
+ * const good = 'The total is: ' + String(42);
+ */
+rules["@typescript-eslint/restrict-plus-operands"] = "error";
+
+/**
+ * Enforces the use of semicolons after statements.
+ *
+ * @name semi
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'always' ]
+ * @see [semi]{@link https://typescript-eslint.io/rules/semi}
+ *
+ * @example
+ * // Bad...
+ * const bad = 'no semi'
+ *
+ * // Good...
+ * const good = 'semi';
+ */
+rules["@typescript-eslint/semi"] = ["error", "always"];
+
+/**
+ * Disables the rule for strict boolean expressions.
+ *
+ * @name strict-boolean-expressions
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [strict-boolean-expressions]{@link https://typescript-eslint.io/rules/strict-boolean-expressions}
+ *
+ * @example
+ * // Okay...
+ * if ( someValue ) {}
+ */
+rules["@typescript-eslint/strict-boolean-expressions"] = "off";
+
+/**
+ * Enforces triple slash references (`/// <reference path="" />`) usage.
+ *
+ * @name triple-slash-reference
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', { 'path': 'always', 'types': 'prefer-import', 'lib': 'always' } ]
+ * @see [triple-slash-reference]{@link https://typescript-eslint.io/rules/triple-slash-reference}
+ *
+ * @example
+ * // Bad...
+ * /// <reference lib="libname" />
+ *
+ * // Okay...
+ * /// <reference types="@stdlib/types" />
+ */
+rules["@typescript-eslint/triple-slash-reference"] = [
+ "error",
+ {
+ path: "always",
+ types: "prefer-import",
+ lib: "always",
+ },
+];
+
+/**
+ * Requires consistent spacing around type annotations.
+ *
+ * @name type-annotation-spacing
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [type-annotation-spacing]{@link https://typescript-eslint.io/rules/type-annotation-spacing}
+ *
+ * @example
+ * // Bad...
+ * let bad :number;
+ *
+ * // Good...
+ * let good: number;
+ */
+rules["@typescript-eslint/type-annotation-spacing"] = "error";
+
+/**
+ * Requires type annotations to exist.
+ *
+ * @name typedef
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [typedef]{@link https://typescript-eslint.io/rules/typedef}
+ *
+ * @example
+ * // Bad...
+ * let bad;
+ *
+ * // Good...
+ * let good: number;
+ */
+rules["@typescript-eslint/typedef"] = "error";
+
+/**
+ * Avoids using an unbound method reference outside of a method’s body.
+ *
+ * @name unbound-method
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [unbound-method]{@link https://typescript-eslint.io/rules/unbound-method}
+ *
+ * @example
+ * // Bad...
+ * const bad = this.handleClick;
+ *
+ * // Good...
+ * const good = this.handleClick.bind( this );
+ */
+rules["@typescript-eslint/unbound-method"] = "error";
+
+/**
+ * Enforces that overloaded members must be consecutive.
+ *
+ * @name unified-signatures
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [unified-signatures]{@link https://typescript-eslint.io/rules/unified-signatures}
+ *
+ * @example
+ * // Bad...
+ * declare function bad( x: number ): number;
+ * // Some unrelated overload
+ * declare function bad( x: string ): string;
+ * declare function bad( x: number | string ): number | string;
+ *
+ * // Good...
+ * declare function good( x: number ): number;
+ * declare function good( x: number | string ): number | string;
+ * declare function good( x: string ): string;
+ */
+rules["@typescript-eslint/unified-signatures"] = "error";
+
+/**
+ * Requires parentheses around arrow function arguments.
+ *
+ * @name arrow-parens
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'always' ]
+ * @see [arrow-parens]{@link https://eslint.org/docs/rules/arrow-parens}
+ *
+ * @example
+ * // Bad...
+ * const bad = x => x * x;
+ *
+ * // Good...
+ * const good = ( x ) => x * x;
+ */
+rules["arrow-parens"] = ["error", "always"];
+
+/**
+ * Enforces one true brace style in block statements.
+ *
+ * @name brace-style
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', '1tbs' ]
+ * @see [brace-style]{@link https://eslint.org/docs/rules/brace-style}
+ *
+ * @example
+ * // Bad...
+ * if ( foo )
+ * {
+ * bar();
+ * }
+ *
+ * // Good...
+ * if ( foo ) {
+ * bar();
+ * }
+ */
+rules["brace-style"] = ["error", "1tbs"];
+
+/**
+ * Enforces that class methods utilize `this`.
+ *
+ * @name class-methods-use-this
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [class-methods-use-this]{@link https://eslint.org/docs/rules/class-methods-use-this}
+ *
+ * @example
+ * // Bad...
+ * class MyClass {
+ * method() {
+ * console.log('no this');
+ * }
+ * }
+ *
+ * // Good...
+ * class MyClass {
+ * method() {
+ * console.log(this);
+ * }
+ * }
+ */
+rules["class-methods-use-this"] = "error";
+
+/**
+ * Disallows trailing commas.
+ *
+ * @name comma-dangle
+ * @memberof rules
+ * @type {string}
+ * @default [ 'error', 'never' ]
+ * @see [comma-dangle]{@link https://eslint.org/docs/rules/comma-dangle}
+ *
+ * @example
+ * // Bad...
+ * const foo = {
+ * bar: 'baz',
+ * qux: 'quux',
+ * };
+ *
+ * // Okay...
+ * const foo = {
+ * bar: 'baz',
+ * qux: 'quux'
+ * };
+ */
+rules["comma-dangle"] = ["error", "never"];
+
+/**
+ * Verifies calls of `super()` in constructors.
+ *
+ * @name constructor-super
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [constructor-super]{@link https://eslint.org/docs/rules/constructor-super}
+ *
+ * @example
+ * // Bad...
+ * class Bad extends Base {
+ * constructor() {
+ * console.log('missing super()');
+ * }
+ * }
+ *
+ * // Good...
+ * class Good extends Base {
+ * constructor() {
+ * super();
+ * console.log('has super()');
+ * }
+ * }
+ */
+rules["constructor-super"] = "error";
+
+/**
+ * Enforces consistent use of curly brace conventions.
+ *
+ * @name curly
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [curly]{@link https://eslint.org/docs/rules/curly}
+ *
+ * @example
+ * // Bad...
+ * if ( foo ) bar();
+ *
+ * // Good...
+ * if ( foo ) {
+ * bar();
+ * }
+ */
+rules["curly"] = "error";
+
+/**
+ * Requires a default case in switch statements.
+ *
+ * @name default-case
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [default-case]{@link https://eslint.org/docs/rules/default-case}
+ *
+ * @example
+ * // Bad...
+ * switch ( foo ) {
+ * case 1:
+ * doSomething();
+ * }
+ *
+ * // Good...
+ * switch ( foo ) {
+ * case 1:
+ * doSomething();
+ * break;
+ * default:
+ * doNothing();
+ * }
+ */
+rules["default-case"] = "error";
+
+/**
+ * Disables the rule for dot notation.
+ *
+ * @name dot-notation
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [dot-notation]{@link https://eslint.org/docs/rules/dot-notation}
+ *
+ * @example
+ * // Okay...
+ * const x = foo[ 'bar' ];
+ */
+rules["dot-notation"] = "off";
+
+/**
+ * Enforces a newline at the end of files.
+ *
+ * @name eol-last
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [eol-last]{@link https://eslint.org/docs/rules/eol-last}
+ *
+ * @example
+ * // Bad...
+ * const bad = 'no newline';
+ * // EOF
+ *
+ * // Good...
+ * const good = 'newline';
+ *
+ * // EOF
+ */
+rules["eol-last"] = "error";
+
+/**
+ * Enforces the use of `===` and `!==` in place of `==` and `!=`.
+ *
+ * @name eqeqeq
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'always' ]
+ * @see [eqeqeq]{@link https://eslint.org/docs/rules/eqeqeq}
+ *
+ * @example
+ * // Bad...
+ * if ( x == y ) {
+ * // ...
+ * }
+ *
+ * // Good...
+ * if ( x === y ) {
+ * // ...
+ * }
+ */
+rules["eqeqeq"] = ["error", "always"];
+
+/**
+ * Requires `for-in` loops to be filtered with an `if` statement.
+ *
+ * @name guard-for-in
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [guard-for-in]{@link https://eslint.org/docs/rules/guard-for-in}
+ *
+ * @example
+ * // Bad...
+ * for ( const key in object ) {
+ * doSomething( object[ key ] );
+ * }
+ *
+ * // Good...
+ * for ( const key in object ) {
+ * if ( Object.prototype.hasOwnProperty.call( object, key ) ) {
+ * doSomething( object[ key ] );
+ * }
+ * }
+ */
+rules["guard-for-in"] = "error";
+
+/**
+ * Do not impose draconian name restrictions.
+ *
+ * @name id-match
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [id-match]{@link https://eslint.org/docs/rules/id-match}
+ *
+ * @example
+ * // Good...
+ * const foo = 'bar';
+ */
+rules["id-match"] = "off";
+
+/**
+ * Allow default exports in modules.
+ *
+ * @name import/no-default-export
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [import/no-default-export]{@link https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-default-export.md}
+ *
+ * @example
+ * // Okay...
+ * export default function myFunction() { }
+ */
+rules["import/no-default-export"] = "off";
+
+/**
+ * Reports use of a deprecated name.
+ *
+ * @name import/no-deprecated
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [import/no-deprecated]{@link https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-deprecated.md}
+ *
+ * @example
+ * // Bad...
+ * import { oldFunction } from 'lib'; // if oldFunction is deprecated
+ *
+ * // Good...
+ * import { newFunction } from 'lib';
+ */
+rules["import/no-deprecated"] = "error";
+
+/**
+ * Ensures that there are no extraneous dependencies being imported.
+ *
+ * @name import/no-extraneous-dependencies
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [import/no-extraneous-dependencies]{@link https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-extraneous-dependencies.md}
+ *
+ * @example
+ * // Good...
+ * import fs from 'fs';
+ *
+ * // Bad...
+ * import foo from 'some-extranous-module';
+ */
+rules["import/no-extraneous-dependencies"] = "error";
+
+/**
+ * Prevents importing the submodules of other modules.
+ *
+ * @name import/no-internal-modules
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [import/no-internal-modules]{@link https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-internal-modules.md}
+ *
+ * @example
+ * // Bad...
+ * import something from 'module/some/internal/path';
+ */
+rules["import/no-internal-modules"] = "error";
+
+/**
+ * Forbids import statements that import nothing.
+ *
+ * @name import/no-unassigned-import
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [import/no-unassigned-import]{@link https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-unassigned-import.md}
+ *
+ * @example
+ * // Bad...
+ * import 'myModule';
+ *
+ * // Good...
+ * import foo from 'foo';
+ */
+rules["import/no-unassigned-import"] = "error";
+
+/**
+ * Enforces a specific order for import statements.
+ *
+ * @name import/order
+ * @memberof rules
+ * @type {Array}
+ * @see [import/order]{@link https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/order.md}
+ *
+ * @example
+ * // Given the configuration above, the following order is enforced:
+ * // 1. Built-in modules (node)
+ * // 2. External modules
+ * // 3. Internal modules
+ * // 4. Modules from a parent directory
+ * // 5. Sibling modules from the same or a sibling's directory
+ * // 6. Index of the current directory
+ *
+ * // Bad...
+ * import sibling from './sibling';
+ * import fs from 'fs';
+ *
+ * // Good...
+ * import fs from 'fs';
+ * import sibling from './sibling';
+ */
+rules["import/order"] = [
+ "error",
+ {
+ alphabetize: {
+ caseInsensitive: false,
+ order: "ignore",
+ },
+ "newlines-between": "ignore",
+ groups: [
+ ["builtin", "external", "internal", "unknown", "object", "type"],
+ "parent",
+ ["sibling", "index"],
+ ],
+ distinctGroup: false,
+ pathGroupsExcludedImportTypes: [],
+ pathGroups: [
+ {
+ pattern: "./",
+ patternOptions: {
+ nocomment: true,
+ dot: true,
+ },
+ group: "sibling",
+ position: "before",
+ },
+ {
+ pattern: ".",
+ patternOptions: {
+ nocomment: true,
+ dot: true,
+ },
+ group: "sibling",
+ position: "before",
+ },
+ {
+ pattern: "..",
+ patternOptions: {
+ nocomment: true,
+ dot: true,
+ },
+ group: "parent",
+ position: "before",
+ },
+ {
+ pattern: "../",
+ patternOptions: {
+ nocomment: true,
+ dot: true,
+ },
+ group: "parent",
+ position: "before",
+ },
+ ],
+ },
+];
+
+/**
+ * Enforces tab indentation.
+ *
+ * @name indent
+ * @memberof rules
+ * @type {string}
+ * @default [ 'error', 'tab' ]
+ * @see [indent]{@link https://eslint.org/docs/rules/indent}
+ */
+rules["indent"] = ["error", "tab"];
+
+/**
+ * Ensures param names in JSDoc match those in the function declaration.
+ *
+ * @name jsdoc/check-param-names
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [check-param-names]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/check-param-names.md}
+ */
+rules["jsdoc/check-param-names"] = "error";
+
+/**
+ * Ensures property names in JSDoc are valid.
+ *
+ * @name jsdoc/check-property-names
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [check-property-names]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/check-property-names.md}
+ */
+rules["jsdoc/check-property-names"] = "error";
+
+/**
+ * Checks for invalid JSDoc syntax.
+ *
+ * @name jsdoc/check-syntax
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [check-syntax]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/check-syntax.md}
+ */
+rules["jsdoc/check-syntax"] = "error";
+
+/**
+ * Checks that JSDoc tag names are valid.
+ *
+ * @name jsdoc/check-tag-names
+ * @memberof rules
+ * @type {Array}
+ * @default 'error'
+ * @see [check-tag-names]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/check-tag-names.md}
+ */
+rules["jsdoc/check-tag-names"] = "error";
+
+/**
+ * Checks for empty JSDoc tags.
+ *
+ * @name jsdoc/empty-tags
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [empty-tags]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/empty-tags.md}
+ */
+rules["jsdoc/empty-tags"] = "error";
+
+/**
+ * Checks that the @implements tag is used correctly on classes.
+ *
+ * @name jsdoc/implements-on-classes
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [implements-on-classes]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/implements-on-classes.md}
+ */
+rules["jsdoc/implements-on-classes"] = "error";
+
+/**
+ * Controls how and whether JSDoc blocks can be expressed as single or multiple line blocks.
+ *
+ * @name jsdoc/multiline-blocks
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [multiline-blocks]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/multiline-blocks.md}
+ */
+rules["jsdoc/multiline-blocks"] = "error";
+
+/**
+ * Prevents blank lines in block descriptions.
+ *
+ * @name jsdoc/no-blank-block-descriptions
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-blank-block-descriptions]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/no-blank-block-descriptions.md}
+ */
+rules["jsdoc/no-blank-block-descriptions"] = "error";
+
+/**
+ * Prevents use of default values in JSDoc tags.
+ *
+ * @name jsdoc/no-defaults
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-defaults]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/no-defaults.md}
+ */
+rules["jsdoc/no-defaults"] = "error";
+
+/**
+ * Prevents use of multiple asterisks at the beginning of lines.
+ *
+ * @name jsdoc/no-multi-asterisks
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-multi-asterisks]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/no-multi-asterisks.md}
+ */
+rules["jsdoc/no-multi-asterisks"] = "error";
+
+/**
+ * Requires that each JSDoc line starts with an asterisk.
+ *
+ * @name jsdoc/require-asterisk-prefix
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [require-asterisk-prefix]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/require-asterisk-prefix.md}
+ */
+rules["jsdoc/require-asterisk-prefix"] = "error";
+
+/**
+ * Requires that all functions have a description.
+ *
+ * @name jsdoc/require-description
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [require-description]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/require-description.md}
+ */
+rules["jsdoc/require-description"] = "error";
+
+/**
+ * Requires a hyphen before the @param description.
+ *
+ * @name jsdoc/require-hyphen-before-param-description
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [require-hyphen-before-param-description]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/require-hyphen-before-param-description.md}
+ */
+rules["jsdoc/require-hyphen-before-param-description"] = "error";
+
+/**
+ * Requires that all functions have JSDoc documentation.
+ *
+ * @name jsdoc/require-jsdoc
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [require-jsdoc]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/require-jsdoc.md}
+ */
+rules["jsdoc/require-jsdoc"] = "error";
+
+/**
+ * Requires that all function parameters are documented.
+ *
+ * @name jsdoc/require-param
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [require-param]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/require-param.md}
+ */
+rules["jsdoc/require-param"] = "error";
+
+/**
+ * Requires that @param tag has description value.
+ *
+ * @name jsdoc/require-param-description
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [require-param-description]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/require-param-description.md}
+ */
+rules["jsdoc/require-param-description"] = "error";
+
+/**
+ * Requires that all @param tags have names.
+ *
+ * @name jsdoc/require-param-name
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [require-param-name]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/require-param-name.md}
+ */
+rules["jsdoc/require-param-name"] = "error";
+
+/**
+ * Requires that all function properties are documented.
+ *
+ * @name jsdoc/require-property
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [require-property]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/require-property.md}
+ */
+rules["jsdoc/require-property"] = "error";
+
+/**
+ * Requires that @property tag has description value.
+ *
+ * @name jsdoc/require-property-description
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [require-property-description]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/require-property-description.md}
+ */
+rules["jsdoc/require-property-description"] = "error";
+
+/**
+ * Requires that all @property tags have names.
+ *
+ * @name jsdoc/require-property-name
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [require-property-name]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/require-property-name.md}
+ */
+rules["jsdoc/require-property-name"] = "error";
+
+/**
+ * Requires that @property tags have type values.
+ *
+ * @name jsdoc/require-property-type
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [require-property-type]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/require-property-type.md}
+ */
+rules["jsdoc/require-property-type"] = "error";
+
+/**
+ * Requires returns are documented.
+ *
+ * @name jsdoc/require-returns
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [require-returns]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/require-returns.md}
+ */
+rules["jsdoc/require-returns"] = "error";
+
+/**
+ * Requires a return statement in function body if a @returns tag is specified in JSDoc comment.
+ *
+ * @name jsdoc/require-returns-check
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [require-returns-check]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/require-returns-check.md}
+ */
+rules["jsdoc/require-returns-check"] = "error";
+
+/**
+ * Requires that @returns tag has description value.
+ *
+ * @name jsdoc/require-returns-description
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [require-returns-description]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/require-returns-description.md}
+ */
+rules["jsdoc/require-returns-description"] = "error";
+
+/**
+ * Requires that @throws statements are documented.
+ *
+ * @name jsdoc/require-throws
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [require-throws]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/require-throws.md}
+ */
+rules["jsdoc/require-throws"] = "error";
+
+/**
+ * Requires that tags are sorted alphabetically.
+ *
+ * @name jsdoc/sort-tags
+ * @memberof rules
+ * @type {string}
+ * @default [ 'error', {...} ]
+ * @see [sort-tags]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/sort-tags.md}
+ */
+rules["jsdoc/sort-tags"] = [
+ "error",
+ {
+ linesBetween: 1,
+ tagSequence: [
+ {
+ tags: ["param", "throws", "returns", "see"],
+ },
+ {
+ tags: ["examples"],
+ },
+ ],
+ reportIntraTagGroupSpacing: false,
+ },
+];
+
+/**
+ * Disables the JSDoc rule for checking alignment.
+ *
+ * @name jsdoc/check-alignment
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [check-alignment]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/check-alignment.md}
+ */
+rules["jsdoc/check-alignment"] = "off";
+
+/**
+ * Disables the JSDoc rule for checking indentation.
+ *
+ * @name jsdoc/check-indentation
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [check-indentation]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/check-indentation.md}
+ */
+rules["jsdoc/check-indentation"] = "off";
+
+/**
+ * Requires that JSDoc does not include types.
+ *
+ * ## Notes
+ *
+ * - We enable this rule as the type information in TypeScript is included in the signatures and does not need to be duplicated in the JSDoc comment.
+ *
+ * @name jsdoc/no-types
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-types]{@link https://github.com/gajus/eslint-plugin-jsdoc/tree/main/docs/rules/no-types.md}
+ */
+rules["jsdoc/no-types"] = "error";
+
+/**
+ * Enforces Unix linebreaks.
+ *
+ * @name linebreak-style
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'unix' ]
+ * @see [linebreak-style]{@link https://eslint.org/docs/rules/linebreak-style}
+ *
+ * @example
+ * // Bad...
+ * const bad = 'Bad linebreak\r\n';
+ *
+ * // Good...
+ * const good = 'Good linebreak\n';
+ */
+rules["linebreak-style"] = ["error", "unix"];
+
+/**
+ * Enforces a maximum number of classes per file.
+ *
+ * @name max-classes-per-file
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 1 ]
+ * @see [max-classes-per-file]{@link https://eslint.org/docs/rules/max-classes-per-file}
+ *
+ * @example
+ * // Bad...
+ * class Foo {}
+ * class Bar {}
+ *
+ * // Good...
+ * class Baz {}
+ */
+rules["max-classes-per-file"] = ["error", 1];
+
+/**
+ * Enforces a maximum line length.
+ *
+ * @name max-len
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', { 'ignorePattern': '^import |\\/\\/ |\\/?\\* ', 'code': 1000 } ]
+ * @see [max-len]{@link https://eslint.org/docs/rules/max-len}
+ *
+ * @example
+ * // Good...
+ * // This line can be very long because it is an import statement that we are choosing to ignore.
+ * import { aVeryLongImportStatementIsHereAndWeWantToIgnoreItBecauseItMakesSenseToUs } from 'some-external-library';
+ */
+rules["max-len"] = [
+ "error",
+ {
+ ignorePattern: "^import |\\/\\/ |\\/?\\* ",
+ code: 1000,
+ },
+];
+
+/**
+ * Enforces a maximum number of lines per file.
+ *
+ * @name max-lines
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 1000 ]
+ * @see [max-lines]{@link https://eslint.org/docs/rules/max-lines}
+ */
+rules["max-lines"] = ["error", 1000];
+
+/**
+ * Enforces the use of parentheses when invoking a constructor with no arguments.
+ *
+ * @name new-parens
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [new-parens]{@link https://eslint.org/docs/rules/new-parens}
+ *
+ * @example
+ * // Bad...
+ * const bad = new Foo;
+ *
+ * // Good...
+ * const good = new Foo();
+ */
+rules["new-parens"] = "error";
+
+/**
+ * Disables the rule that requires a newline after each call in a method chain.
+ *
+ * @name newline-per-chained-call
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [newline-per-chained-call]{@link https://eslint.org/docs/rules/newline-per-chained-call}
+ */
+rules["newline-per-chained-call"] = "off";
+
+/**
+ * Disables the rule against bitwise operators.
+ *
+ * @name no-bitwise
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [no-bitwise]{@link https://eslint.org/docs/rules/no-bitwise}
+ */
+rules["no-bitwise"] = "off";
+
+/**
+ * Disallows the use of `arguments.caller` or `arguments.callee`.
+ *
+ * @name no-caller
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-caller]{@link https://eslint.org/docs/rules/no-caller}
+ *
+ * @example
+ * // Bad...
+ * function bad() {
+ * const whoCalled = arguments.callee.caller;
+ * }
+ *
+ * // Good...
+ * function good() {
+ * // Do not use arguments.callee or arguments.caller
+ * }
+ */
+rules["no-caller"] = "error";
+
+/**
+ * Disallows assignment operators in conditional expressions.
+ *
+ * @name no-cond-assign
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-cond-assign]{@link https://eslint.org/docs/rules/no-cond-assign}
+ *
+ * @example
+ * // Bad...
+ * if ( x = y ) {
+ * // ...
+ * }
+ *
+ * // Good...
+ * if ( x === y ) {
+ * // ...
+ * }
+ */
+rules["no-cond-assign"] = "error";
+
+/**
+ * Disallows the use of `console` methods.
+ *
+ * @name no-console
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-console]{@link https://eslint.org/docs/rules/no-console}
+ *
+ * @example
+ * // Bad...
+ * console.log( 'Here be dragons.' );
+ */
+rules["no-console"] = "error";
+
+/**
+ * Disallows the use of `debugger` statement.
+ *
+ * @name no-debugger
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-debugger]{@link https://eslint.org/docs/rules/no-debugger}
+ *
+ * @example
+ * // Bad...
+ * debugger;
+ */
+rules["no-debugger"] = "error";
+
+/**
+ * Disallows duplicate case labels in `switch` statements.
+ *
+ * @name no-duplicate-case
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-duplicate-case]{@link https://eslint.org/docs/rules/no-duplicate-case}
+ *
+ * @example
+ * // Bad...
+ * switch ( a ) {
+ * case 1:
+ * // ...
+ * case 1:
+ * // Duplicate case label.
+ * }
+ *
+ * // Good...
+ * switch (a) {
+ * case 1:
+ * // ...
+ * case 2:
+ * // ...
+ * }
+ */
+rules["no-duplicate-case"] = "error";
+
+/**
+ * Disallows duplicate imports in a single file.
+ *
+ * @name no-duplicate-imports
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-duplicate-imports]{@link https://eslint.org/docs/rules/no-duplicate-imports}
+ *
+ * @example
+ * // Bad...
+ * import { a } from 'module';
+ * import { b } from 'module';
+ *
+ * // Good...
+ * import { a, b } from 'module';
+ */
+rules["no-duplicate-imports"] = "error";
+
+/**
+ * Disallows empty block statements.
+ *
+ * @name no-empty
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-empty]{@link https://eslint.org/docs/rules/no-empty}
+ *
+ * @example
+ * // Bad...
+ * if ( foo ) {
+ * }
+ *
+ * // Good...
+ * if ( foo ) {
+ * // code
+ * }
+ */
+rules["no-empty"] = "error";
+
+/**
+ * Disallows the use of `eval()`.
+ *
+ * @name no-eval
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-eval]{@link https://eslint.org/docs/rules/no-eval}
+ *
+ * @example
+ * // Bad...
+ * const obj = eval( '( { "a": 20 } )' );
+ *
+ * // Good...
+ * const obj = ( { 'a': 20 } );
+ */
+rules["no-eval"] = "error";
+
+/**
+ * Disallows unnecessary function binding.
+ *
+ * @name no-extra-bind
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-extra-bind]{@link https://eslint.org/docs/rules/no-extra-bind}
+ *
+ * @example
+ * // Bad...
+ * const bad = function() {
+ * console.log( this.a );
+ * }.bind({ a: 'bad' });
+ *
+ * // Good...
+ * const good = function() {
+ * console.log( this.a );
+ * };
+ */
+rules["no-extra-bind"] = "error";
+
+/**
+ * Disallows fallthrough of `case` statements in `switch` statements.
+ *
+ * @name no-fallthrough
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-fallthrough]{@link https://eslint.org/docs/rules/no-fallthrough}
+ *
+ * @example
+ * // Bad...
+ * switch ( foo ) {
+ * case 1:
+ * doSomething();
+ * // no break and fallthrough is intentional here, but it's usually a mistake
+ * case 2:
+ * doSomethingElse();
+ * }
+ *
+ * // Good...
+ * switch ( foo ) {
+ * case 1:
+ * doSomething();
+ * break;
+ * case 2:
+ * doSomethingElse();
+ * }
+ */
+rules["no-fallthrough"] = "error";
+
+/**
+ * Disallows `this` keywords outside of classes or class-like objects.
+ *
+ * @name no-invalid-this
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-invalid-this]{@link https://eslint.org/docs/rules/no-invalid-this}
+ *
+ * @example
+ * // Bad...
+ * function bad() {
+ * console.log( this );
+ * }
+ *
+ * // Good...
+ * class Good {
+ * good() {
+ * console.log( this );
+ * }
+ * }
+ */
+rules["no-invalid-this"] = "error";
+
+/**
+ * Disallows irregular whitespace outside of strings and comments.
+ *
+ * @name no-irregular-whitespace
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-irregular-whitespace]{@link https://eslint.org/docs/rules/no-irregular-whitespace}
+ */
+rules["no-irregular-whitespace"] = "error";
+
+/**
+ * Disables the rule against magic numbers.
+ *
+ * @name no-magic-numbers
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [no-magic-numbers]{@link https://eslint.org/docs/rules/no-magic-numbers}
+ */
+rules["no-magic-numbers"] = "off";
+
+/* eslint-disable stdlib/jsdoc-no-multiple-blank-lines */
+
+/**
+ * Disallows multiple empty lines, allowing a maximum of two.
+ *
+ * @name no-multiple-empty-lines
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', { 'max': 2 } ]
+ * @see [no-multiple-empty-lines]{@link https://eslint.org/docs/rules/no-multiple-empty-lines}
+ *
+ * @example
+ * // Bad...
+ *
+ *
+ *
+ * const bad = 'Too many empty lines';
+ *
+ * // Good...
+ *
+ * const good = 'Just enough empty lines';
+ */
+rules["no-multiple-empty-lines"] = [
+ "error",
+ {
+ max: 2,
+ },
+];
+
+/* eslint-enable stdlib/jsdoc-no-multiple-blank-lines */
+
+/**
+ * Disallows the use of the `Function` constructor to create new functions.
+ *
+ * @name no-new-func
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-new-func]{@link https://eslint.org/docs/rules/no-new-func}
+ *
+ * @example
+ * // Bad...
+ * const bad = new Function( 'a', 'b', 'return a + b' );
+ *
+ * // Good...
+ * function good( a, b ) {
+ * return a + b;
+ * }
+ */
+rules["no-new-func"] = "error";
+
+/**
+ * Disallows creating new instances of `String`, `Number`, and `Boolean`.
+ *
+ * @name no-new-wrappers
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-new-wrappers]{@link https://eslint.org/docs/rules/no-new-wrappers}
+ *
+ * @example
+ * // Bad...
+ * const badString = new String( 'bad' );
+ * const badNumber = new Number( 1 );
+ * const badBoolean = new Boolean( false );
+ *
+ * // Good...
+ * const goodString = 'good';
+ * const goodNumber = 1;
+ * const goodBoolean = false;
+ */
+rules["no-new-wrappers"] = "error";
+
+/**
+ * Disables the rule against reassigning parameters.
+ *
+ * @name no-param-reassign
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [no-param-reassign]{@link https://eslint.org/docs/rules/no-param-reassign}
+ */
+rules["no-param-reassign"] = "off";
+
+/**
+ * Disallows the unary operators `++` and `--`, except in `for` loop afterthoughts.
+ *
+ * @name no-plusplus
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', { 'allowForLoopAfterthoughts': true } ]
+ * @see [no-plusplus]{@link https://eslint.org/docs/rules/no-plusplus}
+ *
+ * @example
+ * // Bad...
+ * let bad = 0;
+ * bad++;
+ *
+ * // Good...
+ * for ( let i = 0; i < 10; i++ ) {
+ * // allowed in for loop afterthoughts
+ * }
+ */
+rules["no-plusplus"] = [
+ "error",
+ {
+ allowForLoopAfterthoughts: true,
+ },
+];
+
+/**
+ * Disable rule disallowing redeclaring variables.
+ *
+ * @name no-redeclare
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [no-redeclare]{@link https://eslint.org/docs/rules/no-redeclare}
+ */
+rules["no-redeclare"] = "off"; // NOTE: disabled due to erroneous lint error when declaring overloaded function definitions
+
+/**
+ * Disallows importing specific modules.
+ *
+ * @name no-restricted-imports
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'lodash' ]
+ * @see [no-restricted-imports]{@link https://eslint.org/docs/rules/no-restricted-imports}
+ */
+rules["no-restricted-imports"] = ["error", "lodash"];
+
+/**
+ * Disallows specified syntax.
+ *
+ * @name no-restricted-syntax
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'ForInStatement' ]
+ * @see [no-restricted-syntax]{@link https://eslint.org/docs/rules/no-restricted-syntax}
+ */
+rules["no-restricted-syntax"] = ["error", "ForInStatement"];
+
+/**
+ * Disallows returning values from `await`.
+ *
+ * @name no-return-await
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-return-await]{@link https://eslint.org/docs/rules/no-return-await}
+ */
+rules["no-return-await"] = "error";
+
+/**
+ * Disallows the use of the comma operator.
+ *
+ * @name no-sequences
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-sequences]{@link https://eslint.org/docs/rules/no-sequences}
+ */
+rules["no-sequences"] = "error";
+
+/**
+ * Disables the rule against variable shadowing.
+ *
+ * @name no-shadow
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [no-shadow]{@link https://eslint.org/docs/rules/no-shadow}
+ */
+rules["no-shadow"] = "off";
+
+/**
+ * Disallows sparse arrays.
+ *
+ * @name no-sparse-arrays
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-sparse-arrays]{@link https://eslint.org/docs/rules/no-sparse-arrays}
+ */
+rules["no-sparse-arrays"] = "error";
+
+/**
+ * Disallows template literal placeholder syntax in regular strings.
+ *
+ * @name no-template-curly-in-string
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-template-curly-in-string]{@link https://eslint.org/docs/rules/no-template-curly-in-string}
+ */
+rules["no-template-curly-in-string"] = "error";
+
+/**
+ * Disallows throwing literals as exceptions.
+ *
+ * @name no-throw-literal
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-throw-literal]{@link https://eslint.org/docs/rules/no-throw-literal}
+ */
+rules["no-throw-literal"] = "error";
+
+/**
+ * Disallows trailing whitespace at the end of lines.
+ *
+ * @name no-trailing-spaces
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-trailing-spaces]{@link https://eslint.org/docs/rules/no-trailing-spaces}
+ */
+rules["no-trailing-spaces"] = "error";
+
+/**
+ * Disallows initializing variables to `undefined`.
+ *
+ * @name no-undef-init
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-undef-init]{@link https://eslint.org/docs/rules/no-undef-init}
+ */
+rules["no-undef-init"] = "error";
+
+/**
+ * Disallows dangling underscores in identifiers.
+ *
+ * @name no-underscore-dangle
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-underscore-dangle]{@link https://eslint.org/docs/rules/no-underscore-dangle}
+ */
+rules["no-underscore-dangle"] = "error";
+
+/**
+ * Disallows control flow statements in `finally` blocks.
+ *
+ * @name no-unsafe-finally
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-unsafe-finally]{@link https://eslint.org/docs/rules/no-unsafe-finally}
+ */
+rules["no-unsafe-finally"] = "error";
+
+/**
+ * Disallows unused labels.
+ *
+ * @name no-unused-labels
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-unused-labels]{@link https://eslint.org/docs/rules/no-unused-labels}
+ */
+rules["no-unused-labels"] = "error";
+
+/**
+ * Disallows unnecessary constructors.
+ *
+ * @name no-useless-constructor
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-useless-constructor]{@link https://eslint.org/docs/rules/no-useless-constructor}
+ */
+rules["no-useless-constructor"] = "error";
+
+/**
+ * Disables the rule against usage of the `void` operator.
+ *
+ * @name no-void
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [no-void]{@link https://eslint.org/docs/rules/no-void}
+ */
+rules["no-void"] = "off";
+
+/**
+ * Enforces the consistent use of object literal shorthand syntax where possible.
+ *
+ * @name object-shorthand
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'never' ]
+ * @see [object-shorthand]{@link https://eslint.org/docs/rules/object-shorthand}
+ */
+rules["object-shorthand"] = ["error", "never"];
+
+/**
+ * Enforces variables to be declared either separately or in a single declaration.
+ *
+ * @name one-var
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'never' ]
+ * @see [one-var]{@link https://eslint.org/docs/rules/one-var}
+ */
+rules["one-var"] = ["error", "never"];
+
+/**
+ * Disables the rule for padding lines between statements.
+ *
+ * @name padding-line-between-statements
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'off', { 'blankLine': 'always', 'prev': '*', 'next': 'return' } ]
+ * @see [padding-line-between-statements]{@link https://eslint.org/docs/rules/padding-line-between-statements}
+ */
+rules["padding-line-between-statements"] = [
+ "off",
+ {
+ blankLine: "always",
+ prev: "*",
+ next: "return",
+ },
+];
+
+/**
+ * Requires the use of `const` for variables that are never reassigned after declared.
+ *
+ * @name prefer-const
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [prefer-const]{@link https://eslint.org/docs/rules/prefer-const}
+ */
+rules["prefer-const"] = "error";
+
+/**
+ * Disables the preference for using object spread over `Object.assign`.
+ *
+ * @name prefer-object-spread
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [prefer-object-spread]{@link https://eslint.org/docs/rules/prefer-object-spread}
+ */
+rules["prefer-object-spread"] = "off";
+
+/**
+ * Disables the preference for template literals over string concatenation.
+ *
+ * @name prefer-template
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [prefer-template]{@link https://eslint.org/docs/rules/prefer-template}
+ */
+rules["prefer-template"] = "off";
+
+/**
+ * Enforces quote properties in object literals to be always present.
+ *
+ * @name quote-props
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'always' ]
+ * @see [quote-props]{@link https://eslint.org/docs/rules/quote-props}
+ */
+rules["quote-props"] = ["error", "always"];
+
+/**
+ * Disables the enforcement of the consistent use of either backticks, double, or single quotes.
+ *
+ * @name quotes
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [quotes]{@link https://eslint.org/docs/rules/quotes}
+ */
+rules["quotes"] = "off";
+
+/**
+ * Enforces passing the radix parameter to the `parseInt()` function.
+ *
+ * @name radix
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [radix]{@link https://eslint.org/docs/rules/radix}
+ *
+ * @example
+ * // Bad...
+ * const bad = parseInt( '123' );
+ *
+ * // Good...
+ * const good = parseInt( '123', 10 );
+ */
+rules["radix"] = "error";
+
+/**
+ * Enforces consistent spacing before function parentheses.
+ *
+ * @name @typescript-eslint/space-before-function-paren
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', { 'anonymous': 'always', 'named': 'never', 'asyncArrow': 'always' } ]
+ * @see [space-before-function-paren]{@link https://typescript-eslint.io/rules/space-before-function-paren}
+ */
+rules["@typescript-eslint/space-before-function-paren"] = [
+ "error",
+ {
+ anonymous: "always",
+ named: "never",
+ asyncArrow: "always",
+ },
+];
+
+/**
+ * Enforces consistent spacing inside parentheses.
+ *
+ * @name space-in-parens
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'always' ]
+ * @see [space-in-parens]{@link https://eslint.org/docs/rules/space-in-parens}
+ */
+rules["space-in-parens"] = ["error", "always"];
+
+/**
+ * Enforces consistent spacing after the `//` or `/*` in a comment.
+ *
+ * @name spaced-comment
+ * @memberof rules
+ * @type {Array}
+ * @default [ 'error', 'always', { 'markers': [ '/' ] } ]
+ * @see [spaced-comment]{@link https://eslint.org/docs/rules/spaced-comment}
+ */
+rules["spaced-comment"] = [
+ "error",
+ "always",
+ {
+ markers: ["/"],
+ },
+];
+
+/**
+ * Enforces the use of `isNaN()` when checking for `NaN`.
+ *
+ * @name use-isnan
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [use-isnan]{@link https://eslint.org/docs/rules/use-isnan}
+ *
+ * @example
+ * // Bad...
+ * if ( foo === NaN ) {
+ * // ...
+ * }
+ *
+ * // Good...
+ * if ( isNaN( foo ) ) {
+ * // ...
+ * }
+ */
+rules["use-isnan"] = "error";
+
+/**
+ * Enforces the style of conditions to avoid Yoda conditions.
+ *
+ * @name yoda
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [yoda]{@link https://eslint.org/docs/rules/yoda}
+ *
+ * @example
+ * // Bad...
+ * if ( 'red' === color ) {
+ * // ...
+ * }
+ *
+ * // Good...
+ * if ( color === 'red' ) {
+ * // ...
+ * }
+ */
+rules["yoda"] = "error";
+
+/**
+ * Enforces that types indicated in special comments match the types of code values.
+ *
+ * @name expect-type
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [expect-type]{@link https://github.com/JoshuaKGoldberg/eslint-plugin-expect-type/blob/main/docs/rules/expect.md}
+ *
+ * @example
+ * // Bad...
+ * const str = 'abc'; // $ExpectType number
+ *
+ * // Good...
+ * const val = 9001; // $ExpectType number
+ */
+rules["expect-type/expect"] = "error";
// EXPORTS //
diff --git a/etc/eslint/rules/variables.js b/etc/eslint/rules/variables.js
index efdeb8a69522..c8525f626609 100644
--- a/etc/eslint/rules/variables.js
+++ b/etc/eslint/rules/variables.js
@@ -1,264 +1,269 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
/**
-* ESLint rules for variable declarations.
-*
-* @namespace rules
-*/
+ * ESLint rules for variable declarations.
+ *
+ * @namespace rules
+ */
var rules = {};
/**
-* Allow variables to be initialized either during declaration or otherwise.
-*
-* @name init-declarations
-* @memberof rules
-* @type {string}
-* @default 'off'
-* @see [init-declarations]{@link https://eslint.org/docs/rules/init-declarations}
-*
-* @example
-* // Okay...
-* var x;
-* var y;
-*
-* x = 5;
-* y = 10;
-*
-* @example
-* // Okay...
-* var y = 10;
-* var x = 5;
-*/
-rules[ 'init-declarations' ] = 'off';
+ * Allow variables to be initialized either during declaration or otherwise.
+ *
+ * @name init-declarations
+ * @memberof rules
+ * @type {string}
+ * @default 'off'
+ * @see [init-declarations]{@link https://eslint.org/docs/rules/init-declarations}
+ *
+ * @example
+ * // Okay...
+ * var x;
+ * var y;
+ *
+ * x = 5;
+ * y = 10;
+ *
+ * @example
+ * // Okay...
+ * var y = 10;
+ * var x = 5;
+ */
+rules["init-declarations"] = "off";
/**
-* Never allow variables to be deleted; only properties.
-*
-* @name no-delete-var
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-delete-var]{@link https://eslint.org/docs/rules/no-delete-var}
-*
-* @example
-* // Bad...
-* var x = 5;
-* delete x;
-*/
-rules[ 'no-delete-var' ] = 'error';
+ * Never allow variables to be deleted; only properties.
+ *
+ * @name no-delete-var
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-delete-var]{@link https://eslint.org/docs/rules/no-delete-var}
+ *
+ * @example
+ * // Bad...
+ * var x = 5;
+ * delete x;
+ */
+rules["no-delete-var"] = "error";
/**
-* Never allow a label to share a name with a variable.
-*
-* @name no-label-var
-* @memberof no-label-var
-* @type {string}
-* @default 'error'
-* @see [no-label-var]{@link https://eslint.org/docs/rules/no-label-var}
-*
-* @example
-* // Bad...
-* var x = 'beep';
-* x: while( true ) {
-* break x;
-* }
-*
-* @example
-* // Okay...
-* var x = 'beep';
-* y : while( true ) {
-* break y;
-* }
-*/
-rules[ 'no-label-var' ] = 'error';
+ * Never allow a label to share a name with a variable.
+ *
+ * @name no-label-var
+ * @memberof no-label-var
+ * @type {string}
+ * @default 'error'
+ * @see [no-label-var]{@link https://eslint.org/docs/rules/no-label-var}
+ *
+ * @example
+ * // Bad...
+ * var x = 'beep';
+ * x: while( true ) {
+ * break x;
+ * }
+ *
+ * @example
+ * // Okay...
+ * var x = 'beep';
+ * y : while( true ) {
+ * break y;
+ * }
+ */
+rules["no-label-var"] = "error";
/**
-* Never allow usage of specific global variable names.
-*
-* @name no-restricted-globals
-* @memberof rules
-* @type {Array}
-* @see [no-restricted-globals]{@link https://eslint.org/docs/rules/no-restricted-globals}
-*/
-rules[ 'no-restricted-globals' ] = [ 'error', 'event', 'fdescribe' ];
+ * Never allow usage of specific global variable names.
+ *
+ * @name no-restricted-globals
+ * @memberof rules
+ * @type {Array}
+ * @see [no-restricted-globals]{@link https://eslint.org/docs/rules/no-restricted-globals}
+ */
+rules["no-restricted-globals"] = ["error", "event", "fdescribe"];
/**
-* Allow shadowing of global variable names in a local scope.
-*
-* @name no-shadow
-* @memberof rules
-* @type {Array}
-* @see [no-shadow]{@link https://eslint.org/docs/rules/no-shadow}
-*
-* @example
-* // Okay...
-* var x = 'beep';
-* function foo() {
-* var x = 'boop';
-* }
-*/
-rules[ 'no-shadow' ] = 'off';
+ * Allow shadowing of global variable names in a local scope.
+ *
+ * @name no-shadow
+ * @memberof rules
+ * @type {Array}
+ * @see [no-shadow]{@link https://eslint.org/docs/rules/no-shadow}
+ *
+ * @example
+ * // Okay...
+ * var x = 'beep';
+ * function foo() {
+ * var x = 'boop';
+ * }
+ */
+rules["no-shadow"] = "off";
/**
-* Never allow reassignment of restricted names.
-*
-* @name no-shadow-restricted-names
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-shadow-restricted-names]{@link https://eslint.org/docs/rules/no-shadow-restricted-names}
-*
-* @example
-* // Bad...
-* function NaN() {
-* // Do something...
-* }
-*/
-rules[ 'no-shadow-restricted-names' ] = 'error';
+ * Never allow reassignment of restricted names.
+ *
+ * @name no-shadow-restricted-names
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-shadow-restricted-names]{@link https://eslint.org/docs/rules/no-shadow-restricted-names}
+ *
+ * @example
+ * // Bad...
+ * function NaN() {
+ * // Do something...
+ * }
+ */
+rules["no-shadow-restricted-names"] = "error";
/**
-* Never allow undeclared variables.
-*
-* @name no-undef
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-undef]{@link https://eslint.org/docs/rules/no-undef}
-*
-* @example
-* // Bad...
-* x = 5;
-*
-* @example
-* // Good...
-* var x = 5;
-*/
-rules[ 'no-undef' ] = 'error';
+ * Never allow undeclared variables.
+ *
+ * @name no-undef
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-undef]{@link https://eslint.org/docs/rules/no-undef}
+ *
+ * @example
+ * // Bad...
+ * x = 5;
+ *
+ * @example
+ * // Good...
+ * var x = 5;
+ */
+rules["no-undef"] = "error";
/**
-* Never allow a variable to be initialized as `undefined`.
-*
-* @name no-undef-init
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-undef-init]{@link https://eslint.org/docs/rules/no-undef-init}
-*
-* @example
-* // Bad...
-* var x = undefined;
-*
-* @example
-* // Good...
-* var x;
-*/
-rules[ 'no-undef-init' ] = 'error';
+ * Never allow a variable to be initialized as `undefined`.
+ *
+ * @name no-undef-init
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-undef-init]{@link https://eslint.org/docs/rules/no-undef-init}
+ *
+ * @example
+ * // Bad...
+ * var x = undefined;
+ *
+ * @example
+ * // Good...
+ * var x;
+ */
+rules["no-undef-init"] = "error";
/**
-* Never allow the use of `undefined`.
-*
-* @name no-undefined
-* @memberof rules
-* @type {string}
-* @default 'error'
-* @see [no-undefined]{@link https://eslint.org/docs/rules/no-undefined}
-*
-* @example
-* // Bad...
-* var x = undefined;
-*
-* @example
-* // Bad...
-* var undefined = 'beep';
-*
-* @example
-* // Good...
-* var x;
-*
-* @example
-* // Good...
-* var undef = 'beep';
-*/
-rules[ 'no-undefined' ] = 'error';
+ * Never allow the use of `undefined`.
+ *
+ * @name no-undefined
+ * @memberof rules
+ * @type {string}
+ * @default 'error'
+ * @see [no-undefined]{@link https://eslint.org/docs/rules/no-undefined}
+ *
+ * @example
+ * // Bad...
+ * var x = undefined;
+ *
+ * @example
+ * // Bad...
+ * var undefined = 'beep';
+ *
+ * @example
+ * // Good...
+ * var x;
+ *
+ * @example
+ * // Good...
+ * var undef = 'beep';
+ */
+rules["no-undefined"] = "error";
/**
-* Never allow unused variables, except for function arguments preceding a used argument.
-*
-* @name no-unused-vars
-* @memberof rules
-* @type {Array}
-* @see [no-unused-vars]{@link https://eslint.org/docs/rules/no-unused-vars}
-*
-* @example
-* // Bad...
-* var unused = 5;
-*
-* @example
-* // Bad...
-* function foo( a, b, c ) {
-* return 5;
-* }
-*
-* @example
-* // Good...
-* function foo( a, b, c ) {
-* return c;
-* }
-*/
-rules[ 'no-unused-vars' ] = [ 'error', {
- 'vars': 'all',
- 'args': 'after-used',
- 'caughtErrors': 'all'
-}];
+ * Never allow unused variables, except for function arguments preceding a used argument.
+ *
+ * @name no-unused-vars
+ * @memberof rules
+ * @type {Array}
+ * @see [no-unused-vars]{@link https://eslint.org/docs/rules/no-unused-vars}
+ *
+ * @example
+ * // Bad...
+ * var unused = 5;
+ *
+ * @example
+ * // Bad...
+ * function foo( a, b, c ) {
+ * return 5;
+ * }
+ *
+ * @example
+ * // Good...
+ * function foo( a, b, c ) {
+ * return c;
+ * }
+ */
+rules["no-unused-vars"] = [
+ "error",
+ {
+ vars: "all",
+ args: "after-used",
+ caughtErrors: "all",
+ },
+];
/**
-* Never allow a variable to be used before being declared (except for function declarations).
-*
-* @name no-use-before-define
-* @memberof rules
-* @type {Array}
-* @see [no-use-before-define]{@link https://eslint.org/docs/rules/no-use-before-define}
-*
-* @example
-* // Bad...
-* x = 5;
-* var x;
-*
-* @example
-* // Good...
-* var x;
-* x = 5;
-*
-* @example
-* // Okay...
-* function bar() {
-* return foo();
-* function foo(){}
-* }
-*/
-rules[ 'no-use-before-define' ] = [ 'error', {
- 'functions': false,
- 'classes': true
-}];
-
+ * Never allow a variable to be used before being declared (except for function declarations).
+ *
+ * @name no-use-before-define
+ * @memberof rules
+ * @type {Array}
+ * @see [no-use-before-define]{@link https://eslint.org/docs/rules/no-use-before-define}
+ *
+ * @example
+ * // Bad...
+ * x = 5;
+ * var x;
+ *
+ * @example
+ * // Good...
+ * var x;
+ * x = 5;
+ *
+ * @example
+ * // Okay...
+ * function bar() {
+ * return foo();
+ * function foo(){}
+ * }
+ */
+rules["no-use-before-define"] = [
+ "error",
+ {
+ functions: false,
+ classes: true,
+ },
+];
// EXPORTS //
diff --git a/etc/eslint/utils/copy.js b/etc/eslint/utils/copy.js
index 81f0daf9f2d6..fe90727eb2bb 100644
--- a/etc/eslint/utils/copy.js
+++ b/etc/eslint/utils/copy.js
@@ -1,41 +1,40 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// MAIN //
/**
-* Copies a JSON object.
-*
-* ## Notes
-*
-* - This function assumes a JSON-compatible input object, which is a valid assumption as we know that ESLint configuration files can be stored as JSON.
-*
-* @private
-* @param {Object} obj - object to copy
-* @returns {Object} object copy
-*/
-function copy( obj ) {
- return JSON.parse( JSON.stringify( obj ) );
+ * Copies a JSON object.
+ *
+ * ## Notes
+ *
+ * - This function assumes a JSON-compatible input object, which is a valid assumption as we know that ESLint configuration files can be stored as JSON.
+ *
+ * @private
+ * @param {Object} obj - object to copy
+ * @returns {Object} object copy
+ */
+function copy(obj) {
+ return JSON.parse(JSON.stringify(obj));
}
-
// EXPORTS //
module.exports = copy;
diff --git a/etc/eslint/utils/merge.js b/etc/eslint/utils/merge.js
index d3500613d794..2eef5704db05 100644
--- a/etc/eslint/utils/merge.js
+++ b/etc/eslint/utils/merge.js
@@ -1,61 +1,59 @@
/**
-* @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';
+ * @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 copy = require( './copy.js' );
-
+var copy = require("./copy.js");
// MAIN //
/**
-* Merges JSON-compatible objects into a destination object.
-*
-* ## Notes
-*
-* - This function assumes JSON-compatible input objects, which is a valid assumption as we know that ESLint configuration files can be stored as JSON.
-*
-* @private
-* @param {Object} dest - destination object
-* @param {...Object} o - objects to merge
-* @returns {Object} destination object
-*/
-function merge( dest ) {
+ * Merges JSON-compatible objects into a destination object.
+ *
+ * ## Notes
+ *
+ * - This function assumes JSON-compatible input objects, which is a valid assumption as we know that ESLint configuration files can be stored as JSON.
+ *
+ * @private
+ * @param {Object} dest - destination object
+ * @param {...Object} o - objects to merge
+ * @returns {Object} destination object
+ */
+function merge(dest) {
var keys;
var o;
var k;
var i;
var j;
- for ( i = 1; i < arguments.length; i++ ) {
- o = arguments[ i ];
- keys = Object.keys( o ); // Note: we are not concerned about backward compatibility with older browsers
- for ( j = 0; j < keys.length; j++ ) {
- k = keys[ j ];
- dest[ k ] = copy( o[ k ] );
+ for (i = 1; i < arguments.length; i++) {
+ o = arguments[i];
+ keys = Object.keys(o); // Note: we are not concerned about backward compatibility with older browsers
+ for (j = 0; j < keys.length; j++) {
+ k = keys[j];
+ dest[k] = copy(o[k]);
}
}
return dest;
}
-
// EXPORTS //
module.exports = merge;
diff --git a/etc/jsdoc/.jsdoc.json b/etc/jsdoc/.jsdoc.json
index a92d2b9579cc..92193c190a43 100644
--- a/etc/jsdoc/.jsdoc.json
+++ b/etc/jsdoc/.jsdoc.json
@@ -1,16 +1,14 @@
{
- "opts": {
- "encoding": "utf8",
- "destination": "./build/",
- "package": "",
- "readme": ""
- },
- "plugins": [
- "plugins/markdown"
- ],
- "templates": {
- "default": {
- "useLongnameInNav": false
- }
- }
+ "opts": {
+ "encoding": "utf8",
+ "destination": "./build/",
+ "package": "",
+ "readme": ""
+ },
+ "plugins": ["plugins/markdown"],
+ "templates": {
+ "default": {
+ "useLongnameInNav": false
+ }
+ }
}
diff --git a/etc/remark/.remarkrc.empty.js b/etc/remark/.remarkrc.empty.js
index 60d72b832e80..663424aea403 100644
--- a/etc/remark/.remarkrc.empty.js
+++ b/etc/remark/.remarkrc.empty.js
@@ -1,28 +1,27 @@
/**
-* @license Apache-2.0
-*
-* Copyright (c) 2024 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.
-*/
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2024 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';
+"use strict";
// MAIN //
var config = {};
-
// EXPORTS //
module.exports = config;
diff --git a/etc/remark/.remarkrc.js b/etc/remark/.remarkrc.js
index 881180a41dbe..74e1df62c318 100644
--- a/etc/remark/.remarkrc.js
+++ b/etc/remark/.remarkrc.js
@@ -1,30 +1,29 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// MAIN //
var config = {
- 'plugins': require( './plugins' )
+ plugins: require("./plugins"),
};
-
// EXPORTS //
module.exports = config;
diff --git a/etc/remark/.remarkrc.jsdoc.js b/etc/remark/.remarkrc.jsdoc.js
index f576d2dde95b..100a3381ae6e 100644
--- a/etc/remark/.remarkrc.jsdoc.js
+++ b/etc/remark/.remarkrc.jsdoc.js
@@ -1,30 +1,29 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// MAIN //
var config = {
- 'plugins': require( './plugins/jsdoc.js' )
+ plugins: require("./plugins/jsdoc.js"),
};
-
// EXPORTS //
module.exports = config;
diff --git a/etc/remark/plugins/eslint/index.js b/etc/remark/plugins/eslint/index.js
index 0f3e2d5e75b9..2b32377e2389 100644
--- a/etc/remark/plugins/eslint/index.js
+++ b/etc/remark/plugins/eslint/index.js
@@ -1,51 +1,58 @@
/**
-* @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';
+ * @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 resolve = require( 'path' ).resolve;
-var join = require( 'path' ).join;
-
+var resolve = require("path").resolve;
+var join = require("path").join;
// VARIABLES //
-var etc = resolve( __dirname, '..', '..', '..' );
-var config = join( etc, 'eslint', '.eslintrc.markdown.js' );
-var eslint = resolve( etc, '..', 'lib', 'node_modules', '@stdlib', '_tools', 'remark', 'plugins', 'remark-lint-eslint' );
+var etc = resolve(__dirname, "..", "..", "..");
+var config = join(etc, "eslint", ".eslintrc.markdown.js");
+var eslint = resolve(
+ etc,
+ "..",
+ "lib",
+ "node_modules",
+ "@stdlib",
+ "_tools",
+ "remark",
+ "plugins",
+ "remark-lint-eslint",
+);
var opts = {
- 'config': config,
- 'rules': {
- 'stdlib/doctest': 'error' // enable otherwise disabled lint rule
+ config: config,
+ rules: {
+ "stdlib/doctest": "error", // enable otherwise disabled lint rule
},
- 'ignore': false,
- 'useEslintrc': false
+ ignore: false,
+ useEslintrc: false,
};
-
// MAIN //
/**
-* Plugin.
-*/
-var plugin = [ require( eslint ).factory( opts ), [ 'error' ] ]; // eslint-disable-line stdlib/no-immediate-require, stdlib/no-dynamic-require
-
+ * Plugin.
+ */
+var plugin = [require(eslint).factory(opts), ["error"]]; // eslint-disable-line stdlib/no-immediate-require, stdlib/no-dynamic-require
// EXPORTS //
diff --git a/etc/remark/plugins/frontmatter/index.js b/etc/remark/plugins/frontmatter/index.js
index 7a42a95f6882..d179211a9085 100644
--- a/etc/remark/plugins/frontmatter/index.js
+++ b/etc/remark/plugins/frontmatter/index.js
@@ -1,35 +1,34 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
/**
-* Plugin.
-*/
-var plugin = [ require( 'remark-frontmatter' ) ];
+ * Plugin.
+ */
+var plugin = [require("remark-frontmatter")];
/**
-* Frontmatter preset.
-*
-* @see [remark-frontmatter]{@link https://github.com/remarkjs/remark-frontmatter}
-*/
-plugin.push( 'yaml' );
-
+ * Frontmatter preset.
+ *
+ * @see [remark-frontmatter]{@link https://github.com/remarkjs/remark-frontmatter}
+ */
+plugin.push("yaml");
// EXPORTS //
diff --git a/etc/remark/plugins/index.js b/etc/remark/plugins/index.js
index 71308d1c92a7..11fb06213aec 100644
--- a/etc/remark/plugins/index.js
+++ b/etc/remark/plugins/index.js
@@ -1,33 +1,32 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// MAIN //
var plugins = [];
-plugins.push( require( './frontmatter' ) );
-plugins = plugins.concat( require( './lint' ) );
-plugins.push( require( './eslint' ) );
-plugins.push( require( './lint-equations' ) );
-plugins.push( require( './validate-links' ) );
-
+plugins.push(require("./frontmatter"));
+plugins = plugins.concat(require("./lint"));
+plugins.push(require("./eslint"));
+plugins.push(require("./lint-equations"));
+plugins.push(require("./validate-links"));
// EXPORTS //
diff --git a/etc/remark/plugins/jsdoc.js b/etc/remark/plugins/jsdoc.js
index b92c8421b863..2ca9c01df45c 100644
--- a/etc/remark/plugins/jsdoc.js
+++ b/etc/remark/plugins/jsdoc.js
@@ -1,30 +1,29 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
// MAIN //
var plugins = [];
-plugins = plugins.concat( require( './lint/jsdoc.js' ) );
-plugins.push( require( './lint-equations' ) );
-
+plugins = plugins.concat(require("./lint/jsdoc.js"));
+plugins.push(require("./lint-equations"));
// EXPORTS //
diff --git a/etc/remark/plugins/lint-equations/index.js b/etc/remark/plugins/lint-equations/index.js
index 56e7a948925e..0f60b7fec1e2 100644
--- a/etc/remark/plugins/lint-equations/index.js
+++ b/etc/remark/plugins/lint-equations/index.js
@@ -1,41 +1,48 @@
/**
-* @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';
+ * @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 resolve = require( 'path' ).resolve;
-
+var resolve = require("path").resolve;
// VARIABLES //
-var etc = resolve( __dirname, '..', '..', '..' );
-var lint = resolve( etc, '..', 'lib', 'node_modules', '@stdlib', '_tools', 'remark', 'plugins', 'remark-lint-equations' );
-
+var etc = resolve(__dirname, "..", "..", "..");
+var lint = resolve(
+ etc,
+ "..",
+ "lib",
+ "node_modules",
+ "@stdlib",
+ "_tools",
+ "remark",
+ "plugins",
+ "remark-lint-equations",
+);
// MAIN //
/**
-* Plugin.
-*/
-var plugin = [ require( lint ), [ 'error' ] ]; // eslint-disable-line stdlib/no-dynamic-require
-
+ * Plugin.
+ */
+var plugin = [require(lint), ["error"]]; // eslint-disable-line stdlib/no-dynamic-require
// EXPORTS //
diff --git a/etc/remark/plugins/lint/index.js b/etc/remark/plugins/lint/index.js
index ae47361ca006..27fc380f65b0 100644
--- a/etc/remark/plugins/lint/index.js
+++ b/etc/remark/plugins/lint/index.js
@@ -1,1329 +1,1169 @@
/**
-* @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.
-*/
+ * @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.
+ */
/* eslint-disable stdlib/jsdoc-doctest-marker, stdlib/jsdoc-doctest-quote-props */
-'use strict';
-
-/**
-* Lint plugins.
-*/
-var plugins = [ require( 'remark-lint' ) ];
-
-/**
-* Require blockquotes to have `2` character indentation.
-*
-* @see [blockquote-indentation]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-blockquote-indentation}
-*
-* @example
-* <!-- Bad -->
-*
-* > Beep boop.
-*
-* @example
-* <!-- Good -->
-*
-* > Beep boop.
-*/
+"use strict";
+
+/**
+ * Lint plugins.
+ */
+var plugins = [require("remark-lint")];
+
+/**
+ * Require blockquotes to have `2` character indentation.
+ *
+ * @see [blockquote-indentation]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-blockquote-indentation}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * > Beep boop.
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * > Beep boop.
+ */
+plugins.push([require("remark-lint-blockquote-indentation"), ["error", 2]]);
+
+/**
+ * Require checkboxes to be either empty (unchecked) or have an `x` (checked).
+ *
+ * @see [checkbox-character-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-checkbox-character-style}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * - [X] checked
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * - [x] checked
+ */
plugins.push([
- require( 'remark-lint-blockquote-indentation' ),
- [ 'error', 2 ]
-]);
-
-/**
-* Require checkboxes to be either empty (unchecked) or have an `x` (checked).
-*
-* @see [checkbox-character-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-checkbox-character-style}
-*
-* @example
-* <!-- Bad -->
-*
-* - [X] checked
-*
-* @example
-* <!-- Good -->
-*
-* - [x] checked
-*/
-plugins.push([
- require( 'remark-lint-checkbox-character-style' ),
+ require("remark-lint-checkbox-character-style"),
[
- 'error',
+ "error",
{
- 'checked': 'x',
- 'unchecked': ' '
- }
- ]
+ checked: "x",
+ unchecked: " ",
+ },
+ ],
]);
/**
-* Prevent checkboxes being followed by too much white-space.
-*
-* @see [checkbox-content-indent]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-checkbox-content-indent}
-*
-* @example
-* <!-- Bad -->
-*
-* - [x] checked
-*
-* @example
-* <!-- Good -->
-*
-* - [x] checked
-*/
-plugins.push([
- require( 'remark-lint-checkbox-content-indent' ),
- [ 'error' ]
-]);
+ * Prevent checkboxes being followed by too much white-space.
+ *
+ * @see [checkbox-content-indent]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-checkbox-content-indent}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * - [x] checked
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * - [x] checked
+ */
+plugins.push([require("remark-lint-checkbox-content-indent"), ["error"]]);
/* eslint-disable stdlib/jsdoc-no-multiple-blank-lines */
/**
-* Require `fenced` code block style.
-*
-* @see [code-block-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-code-block-style}
-*
-* @example
-* <!-- Bad -->
-*
-*
-* code
-* code
-* code
-*
-* @example
-* <!-- Good -->
-*
-* ```javascript
-* code
-* code
-* code
-* ```
-*/
-plugins.push([
- require( 'remark-lint-code-block-style' ),
- [ 'error', 'fenced' ]
-]);
+ * Require `fenced` code block style.
+ *
+ * @see [code-block-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-code-block-style}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ *
+ * code
+ * code
+ * code
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * ```javascript
+ * code
+ * code
+ * code
+ * ```
+ */
+plugins.push([require("remark-lint-code-block-style"), ["error", "fenced"]]);
/* eslint-enable stdlib/jsdoc-no-multiple-blank-lines */
/**
-* Require lowercased definition labels.
-*
-* @see [definition-case]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-definition-case}
-*
-* @example
-* <!-- Bad -->
-*
-* [Example]: https://example.com
-*
-* @example
-* <!-- Good -->
-*
-* [example]: https://example.com
-*/
-plugins.push([
- require( 'remark-lint-definition-case' ),
- [ 'error' ]
-]);
-
-/**
-* Prevent consecutive whitespace in a definition.
-*
-* @see [definition-spacing]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-definition-spacing}
-*
-* @example
-* <!-- Bad -->
-*
-* [hello world]: https://example.com
-*
-* @example
-* <!-- Good -->
-*
-* [hello world]: https://example.com
-*/
-plugins.push([
- require( 'remark-lint-definition-spacing' ),
- [ 'error' ]
-]);
+ * Require lowercased definition labels.
+ *
+ * @see [definition-case]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-definition-case}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * [Example]: https://example.com
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * [example]: https://example.com
+ */
+plugins.push([require("remark-lint-definition-case"), ["error"]]);
+
+/**
+ * Prevent consecutive whitespace in a definition.
+ *
+ * @see [definition-spacing]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-definition-spacing}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * [hello world]: https://example.com
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * [hello world]: https://example.com
+ */
+plugins.push([require("remark-lint-definition-spacing"), ["error"]]);
/* eslint-disable stdlib/jsdoc-no-multiple-blank-lines */
/**
-* Require `_` be used as the emphasis marker.
-*
-* @see [emphasis-marker]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-emphasis-marker}
-*
-* @example
-* <!-- Bad -->
-*
-* *beep*
-*
-* @example
-* <!-- Good -->
-*
-* _beep_
-*/
-plugins.push([
- require( 'remark-lint-emphasis-marker' ),
- [ 'error', '_' ]
-]);
+ * Require `_` be used as the emphasis marker.
+ *
+ * @see [emphasis-marker]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-emphasis-marker}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * *beep*
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * _beep_
+ */
+plugins.push([require("remark-lint-emphasis-marker"), ["error", "_"]]);
/* eslint-enable stdlib/jsdoc-no-multiple-blank-lines */
/**
-* Require fenced code blocks to have a language flag.
-*
-* @see [fenced-code-flag]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-fenced-code-flag}
-*
-* @example
-* <!-- Bad -->
-*
-* ```
-* code
-* ```
-*
-* @example
-* <!-- Good -->
-*
-* ```text
-* code
-* ```
-*/
+ * Require fenced code blocks to have a language flag.
+ *
+ * @see [fenced-code-flag]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-fenced-code-flag}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * ```
+ * code
+ * ```
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * ```text
+ * code
+ * ```
+ */
plugins.push([
- require( 'remark-lint-fenced-code-flag' ),
+ require("remark-lint-fenced-code-flag"),
[
- 'error',
+ "error",
{
- 'allowEmpty': false
- }
- ]
-]);
-
-/**
-* Require backticks `\`` be used as the fenced code marker.
-*
-* @see [fenced-code-marker]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-fenced-code-marker}
-*
-* @example
-* <!-- Bad -->
-*
-* ~~~text
-* Code
-* ~~~
-*
-* @example
-* <!-- Good -->
-*
-* ```text
-* code
-* ```
-*/
-plugins.push([
- require( 'remark-lint-fenced-code-marker' ),
- [ 'error', '`' ]
-]);
-
-/**
-* Require a Markdown file to have the file extension `*.md`.
-*
-* @see [file-extension]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-file-extension}
-*/
-plugins.push([
- require( 'remark-lint-file-extension' ),
- [ 'error', 'md' ]
-]);
-
-/**
-* Require definitions be placed at the end of a file. Note that we turn this rule off due to definitions being wrapped in HTML tags.
-*
-* @see [final-definition]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-final-definition}
-*/
-plugins.push([
- require( 'remark-lint-final-definition' ),
- [ 'off' ]
-]);
-
-/**
-* Require a final newline (see <http://unix.stackexchange.com/questions/18743>).
-*
-* @see [final-newline]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-final-newline}
-*/
-plugins.push([
- require( 'remark-lint-final-newline' ),
- [ 'error' ]
-]);
-
-/**
-* Require first heading level be a level `1` heading.
-*
-* @see [first-heading-level]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-first-heading-level}
-*/
-plugins.push([
- require( 'remark-lint-first-heading-level' ),
- [ 'error', 1 ]
-]);
-
-/**
-* Prevent too many spaces from being used to hard break.
-*
-* @see [hard-break-spaces]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-hard-break-spaces}
-*/
-plugins.push([
- require( 'remark-lint-hard-break-spaces' ),
- [ 'error' ]
-]);
-
-/**
-* Warn when headings increment by more than 1 level. NOTE: temporarily disabled.
-*
-* @see [heading-increment]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-heading-increment}
-*/
-plugins.push([
- require( 'remark-lint-heading-increment' ),
- [ 'off' ]
-]);
-
-/**
-* Require `atx` heading style.
-*
-* @see [heading-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-heading-style}
-*
-* @example
-* <!-- Bad -->
-*
-* Beep
-* ===
-*
-* ## Boop
-*
-* @example
-* <!-- Good -->
-*
-* # Beep
-*
-* ## Boop
-*
-*/
-plugins.push([
- require( 'remark-lint-heading-style' ),
- [ 'error', 'atx' ]
-]);
-
-/**
-* Require Unix linebreaks.
-*
-* @see [linebreak-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-linebreak-style}
-*/
-plugins.push([
- require( 'remark-lint-linebreak-style' ),
- [ 'error', 'unix' ]
-]);
-
-/**
-* Require double quotes for link titles.
-*
-* @see [link-title-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-link-title-style}
-*
-* @example
-* <!-- Bad -->
-*
-* [example](https://example.com (Example))
-*
-* @example
-* <!-- Good -->
-*
-* [example](https://example.com "Example")
-*/
-plugins.push([
- require( 'remark-lint-link-title-style' ),
- [ 'error', '"' ]
-]);
-
-/**
-* Prevent unnecessary indentation of list bullets.
-*
-* @see [list-item-bullet-indent]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-list-item-bullet-indent}
-*
-* @example
-* <!-- Bad -->
-*
-* - Beep
-* - Boop
-*
-* @example
-* <!-- Good -->
-*
-* - Beep
-* - Boop
-*
-*/
-plugins.push([
- require( 'remark-lint-list-item-bullet-indent' ),
- [ 'error' ]
-]);
-
-/**
-* Require consistent indentation of list items.
-*
-* @see [list-item-content-indent]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-list-item-content-indent}
-*
-* @example
-* <!-- Bad -->
-*
-* 1. Beep
-*
-* 1. Boop
-*
-* @example
-* <!-- Good -->
-*
-* 1. Beep
-*
-* 1. Boop
-*
-*/
-plugins.push([
- require( 'remark-lint-list-item-content-indent' ),
- [ 'error' ]
-]);
-
-/**
-* Require list items use tab-size indentation.
-*
-* @see [list-item-indent]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-list-item-indent}
-*
-* @example
-* <!-- Bad -->
-*
-* - Hello
-* - World
-*
-* @example
-* <!-- Good -->
-*
-* - Hello
-* - World
-*
-* @example
-* <!-- Good -->
-*
-* - Beep
-* boop
-*
-* - Bop
-* bip
-*
-*/
-plugins.push([
- require( 'remark-lint-list-item-indent' ),
- [ 'error', 'tab-size' ]
-]);
-
-/**
-* Require consistent list item spacing.
-*
-* @see [list-item-spacing]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-list-item-spacing}
-*
-* @example
-* <!-- Bad -->
-*
-* - Beep
-* - Boop
-*
-* - Bop
-*
-* @example
-* <!-- Good -->
-*
-* - Beep
-* - Boop
-* - Bop
-*
-* @example
-* <!-- Okay -->
-*
-* - Beep
-*
-* - Boop
-*
-* - Bop
-*
-*/
-plugins.push([
- require( 'remark-lint-list-item-spacing' ),
- [ 'error' ]
-]);
-
-/**
-* Require that heading lengths be less than or equal to `80` characters.
-*
-* @see [maximum-heading-length]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-maximum-heading-length}
-*/
-plugins.push([
- require( 'remark-lint-maximum-heading-length' ),
- [ 'error', 80 ]
-]);
-
-/**
-* Do not enforce a maximum line length.
-*
-* @see [maximum-line-length]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-maximum-line-length}
-*/
-plugins.push([
- require( 'remark-lint-maximum-line-length' ),
- [ 'off' ]
-]);
-
-/**
-* Require all links have a protocol.
-*
-* @see [no-auto-link-without-protocol]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-auto-link-without-protocol}
-*
-* @example
-* <!-- Bad -->
-*
-* <foo@bar.com>
-*
-* @example
-* <!-- Good -->
-*
-* <mailto:foo@bar.com>
-*
-*/
-plugins.push([
- require( 'remark-lint-no-auto-link-without-protocol' ),
- [ 'error' ]
-]);
-
-/**
-* Require caret in blockquotes.
-*
-* @see [no-blockquote-without-marker]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-blockquote-without-marker}
-*
-* @example
-* <!-- Bad -->
-*
-* > Beep
-*
-* > boop
-*
-* @example
-* <!-- Good -->
-*
-* > Beep
-* >
-* > boop
-*
-*/
-plugins.push([
- require( 'remark-lint-no-blockquote-without-marker' ),
- [ 'error' ]
-]);
-
-/**
-* Allow consecutive blank lines.
-*
-* @see [no-consecutive-blank-lines]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-consecutive-blank-lines}
-*/
-plugins.push([
- require( 'remark-lint-no-consecutive-blank-lines' ),
- [ 'off' ]
-]);
-
-/**
-* Do not allow duplicate definitions.
-*
-* @see [no-duplicate-definitions]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-duplicate-definitions}
-*
-* @example
-* <!-- Bad -->
-*
-* [foo]: https://example.com
-* [foo]: https://github.com
-*
-* @example
-* <!-- Good -->
-*
-* [foo]: https://example.com
-* [bar]: https://github.com
-*
-*/
-plugins.push([
- require( 'remark-lint-no-duplicate-definitions' ),
- [ 'error' ]
-]);
-
-/**
-* Allow duplicate headings in different sections.
-*
-* @see [no-duplicate-headings]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-duplicate-headings}
-*
-* @example
-* <!-- Okay -->
-*
-* # Beep
-*
-* ## Boop
-*
-* ### Bop
-*
-* ## Beep
-*
-* ### Bop
-*
-*/
-plugins.push([
- require( 'remark-lint-no-duplicate-headings' ),
- [ 'off' ]
+ allowEmpty: false,
+ },
+ ],
]);
/**
-* Do not allow duplicate headings within a section.
-*
-* @see [no-duplicate-headings-in-section]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-duplicate-headings-in-section}
-*
-* @example
-* <!-- Bad -->
-*
-* # Beep
-*
-* ## Boop
-*
-* ## Boop
-*
-* @example
-* <!-- Good -->
-*
-* # Beep
-*
-* ## Boop
-*
-* ## Bop
-*
-*/
+ * Require backticks `\`` be used as the fenced code marker.
+ *
+ * @see [fenced-code-marker]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-fenced-code-marker}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * ~~~text
+ * Code
+ * ~~~
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * ```text
+ * code
+ * ```
+ */
+plugins.push([require("remark-lint-fenced-code-marker"), ["error", "`"]]);
+
+/**
+ * Require a Markdown file to have the file extension `*.md`.
+ *
+ * @see [file-extension]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-file-extension}
+ */
+plugins.push([require("remark-lint-file-extension"), ["error", "md"]]);
+
+/**
+ * Require definitions be placed at the end of a file. Note that we turn this rule off due to definitions being wrapped in HTML tags.
+ *
+ * @see [final-definition]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-final-definition}
+ */
+plugins.push([require("remark-lint-final-definition"), ["off"]]);
+
+/**
+ * Require a final newline (see <http://unix.stackexchange.com/questions/18743>).
+ *
+ * @see [final-newline]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-final-newline}
+ */
+plugins.push([require("remark-lint-final-newline"), ["error"]]);
+
+/**
+ * Require first heading level be a level `1` heading.
+ *
+ * @see [first-heading-level]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-first-heading-level}
+ */
+plugins.push([require("remark-lint-first-heading-level"), ["error", 1]]);
+
+/**
+ * Prevent too many spaces from being used to hard break.
+ *
+ * @see [hard-break-spaces]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-hard-break-spaces}
+ */
+plugins.push([require("remark-lint-hard-break-spaces"), ["error"]]);
+
+/**
+ * Warn when headings increment by more than 1 level. NOTE: temporarily disabled.
+ *
+ * @see [heading-increment]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-heading-increment}
+ */
+plugins.push([require("remark-lint-heading-increment"), ["off"]]);
+
+/**
+ * Require `atx` heading style.
+ *
+ * @see [heading-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-heading-style}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * Beep
+ * ===
+ *
+ * ## Boop
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * # Beep
+ *
+ * ## Boop
+ *
+ */
+plugins.push([require("remark-lint-heading-style"), ["error", "atx"]]);
+
+/**
+ * Require Unix linebreaks.
+ *
+ * @see [linebreak-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-linebreak-style}
+ */
+plugins.push([require("remark-lint-linebreak-style"), ["error", "unix"]]);
+
+/**
+ * Require double quotes for link titles.
+ *
+ * @see [link-title-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-link-title-style}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * [example](https://example.com (Example))
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * [example](https://example.com "Example")
+ */
+plugins.push([require("remark-lint-link-title-style"), ["error", '"']]);
+
+/**
+ * Prevent unnecessary indentation of list bullets.
+ *
+ * @see [list-item-bullet-indent]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-list-item-bullet-indent}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * - Beep
+ * - Boop
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * - Beep
+ * - Boop
+ *
+ */
+plugins.push([require("remark-lint-list-item-bullet-indent"), ["error"]]);
+
+/**
+ * Require consistent indentation of list items.
+ *
+ * @see [list-item-content-indent]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-list-item-content-indent}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * 1. Beep
+ *
+ * 1. Boop
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * 1. Beep
+ *
+ * 1. Boop
+ *
+ */
+plugins.push([require("remark-lint-list-item-content-indent"), ["error"]]);
+
+/**
+ * Require list items use tab-size indentation.
+ *
+ * @see [list-item-indent]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-list-item-indent}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * - Hello
+ * - World
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * - Hello
+ * - World
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * - Beep
+ * boop
+ *
+ * - Bop
+ * bip
+ *
+ */
+plugins.push([require("remark-lint-list-item-indent"), ["error", "tab-size"]]);
+
+/**
+ * Require consistent list item spacing.
+ *
+ * @see [list-item-spacing]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-list-item-spacing}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * - Beep
+ * - Boop
+ *
+ * - Bop
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * - Beep
+ * - Boop
+ * - Bop
+ *
+ * @example
+ * <!-- Okay -->
+ *
+ * - Beep
+ *
+ * - Boop
+ *
+ * - Bop
+ *
+ */
+plugins.push([require("remark-lint-list-item-spacing"), ["error"]]);
+
+/**
+ * Require that heading lengths be less than or equal to `80` characters.
+ *
+ * @see [maximum-heading-length]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-maximum-heading-length}
+ */
+plugins.push([require("remark-lint-maximum-heading-length"), ["error", 80]]);
+
+/**
+ * Do not enforce a maximum line length.
+ *
+ * @see [maximum-line-length]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-maximum-line-length}
+ */
+plugins.push([require("remark-lint-maximum-line-length"), ["off"]]);
+
+/**
+ * Require all links have a protocol.
+ *
+ * @see [no-auto-link-without-protocol]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-auto-link-without-protocol}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * <foo@bar.com>
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * <mailto:foo@bar.com>
+ *
+ */
+plugins.push([require("remark-lint-no-auto-link-without-protocol"), ["error"]]);
+
+/**
+ * Require caret in blockquotes.
+ *
+ * @see [no-blockquote-without-marker]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-blockquote-without-marker}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * > Beep
+ *
+ * > boop
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * > Beep
+ * >
+ * > boop
+ *
+ */
+plugins.push([require("remark-lint-no-blockquote-without-marker"), ["error"]]);
+
+/**
+ * Allow consecutive blank lines.
+ *
+ * @see [no-consecutive-blank-lines]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-consecutive-blank-lines}
+ */
+plugins.push([require("remark-lint-no-consecutive-blank-lines"), ["off"]]);
+
+/**
+ * Do not allow duplicate definitions.
+ *
+ * @see [no-duplicate-definitions]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-duplicate-definitions}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * [foo]: https://example.com
+ * [foo]: https://github.com
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * [foo]: https://example.com
+ * [bar]: https://github.com
+ *
+ */
+plugins.push([require("remark-lint-no-duplicate-definitions"), ["error"]]);
+
+/**
+ * Allow duplicate headings in different sections.
+ *
+ * @see [no-duplicate-headings]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-duplicate-headings}
+ *
+ * @example
+ * <!-- Okay -->
+ *
+ * # Beep
+ *
+ * ## Boop
+ *
+ * ### Bop
+ *
+ * ## Beep
+ *
+ * ### Bop
+ *
+ */
+plugins.push([require("remark-lint-no-duplicate-headings"), ["off"]]);
+
+/**
+ * Do not allow duplicate headings within a section.
+ *
+ * @see [no-duplicate-headings-in-section]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-duplicate-headings-in-section}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * # Beep
+ *
+ * ## Boop
+ *
+ * ## Boop
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * # Beep
+ *
+ * ## Boop
+ *
+ * ## Bop
+ *
+ */
plugins.push([
- require( 'remark-lint-no-duplicate-headings-in-section' ),
- [ 'error' ]
+ require("remark-lint-no-duplicate-headings-in-section"),
+ ["error"],
]);
/**
-* Never allow emphasis to be used in place of a heading.
-*
-* @see [no-emphasis-as-heading]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-emphasis-as-heading}
-*
-* @example
-* <!-- Bad -->
-*
-* _Beep_
-*
-* Beep boop.
-*
-* @example
-* <!-- Good -->
-*
-* ## Beep
-*
-* Beep boop
-*
-*/
+ * Never allow emphasis to be used in place of a heading.
+ *
+ * @see [no-emphasis-as-heading]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-emphasis-as-heading}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * _Beep_
+ *
+ * Beep boop.
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * ## Beep
+ *
+ * Beep boop
+ *
+ */
+plugins.push([require("remark-lint-no-emphasis-as-heading"), ["error"]]);
+
+/**
+ * Never allow empty URLs in images and links.
+ *
+ * @see [no-empty-url]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-empty-url}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * [foo]()
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * [foo](https://example.com)
+ *
+ */
+plugins.push([require("remark-lint-no-empty-url"), ["error"]]);
+
+/**
+ * Never allow filenames to begin with an article.
+ *
+ * @see [no-file-name-articles]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-file-name-articles}
+ */
+plugins.push([require("remark-lint-no-file-name-articles"), ["error"]]);
+
+/**
+ * Never allow consecutive dashes in filenames.
+ *
+ * @see [no-file-name-consecutive-dashes]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-file-name-consecutive-dashes}
+ */
plugins.push([
- require( 'remark-lint-no-emphasis-as-heading' ),
- [ 'error' ]
+ require("remark-lint-no-file-name-consecutive-dashes"),
+ ["error"],
]);
/**
-* Never allow empty URLs in images and links.
-*
-* @see [no-empty-url]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-empty-url}
-*
-* @example
-* <!-- Bad -->
-*
-* [foo]()
-*
-* @example
-* <!-- Good -->
-*
-* [foo](https://example.com)
-*
-*/
+ * Never allow filenames to contain irregular characters.
+ *
+ * @see [no-file-name-irregular-characters]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-file-name-irregular-characters}
+ */
plugins.push([
- require( 'remark-lint-no-empty-url' ),
- [ 'error']
+ require("remark-lint-no-file-name-irregular-characters"),
+ ["error", "\\.a-zA-Z0-9-_"],
]);
/**
-* Never allow filenames to begin with an article.
-*
-* @see [no-file-name-articles]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-file-name-articles}
-*/
+ * Never allow mixed case filenames.
+ *
+ * @see [no-file-name-mixed-case]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-file-name-mixed-case}
+ */
+plugins.push([require("remark-lint-no-file-name-mixed-case"), ["error"]]);
+
+/**
+ * Never allow filenames to begin or end with dashes.
+ *
+ * @see [no-file-name-outer-dashes]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-file-name-outer-dashes}
+ */
+plugins.push([require("remark-lint-no-file-name-outer-dashes"), ["error"]]);
+
+/**
+ * Never allow heading content indentation.
+ *
+ * @see [no-heading-content-indent]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-heading-content-indent}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * # Beep
+ *
+ * ## Boop
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * # Beep
+ *
+ * ## Boop
+ *
+ */
+plugins.push([require("remark-lint-no-heading-content-indent"), ["error"]]);
+
+/**
+ * Never allow heading indentation.
+ *
+ * @see [no-heading-indent]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-heading-indent}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * # Beep
+ *
+ * ## Beep
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * # Beep
+ *
+ * Beep boop.
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * # Beep
+ *
+ * ## Boop
+ *
+ * Beep boop.
+ *
+ */
+plugins.push([require("remark-lint-no-heading-indent"), ["error"]]);
+
+/**
+ * Never allow paragraphs which appear to be h7+ "headings".
+ *
+ * @see [no-heading-like-paragraph]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-heading-like-paragraph}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * ####### Beep
+ *
+ */
+plugins.push([require("remark-lint-no-heading-like-paragraph"), ["error"]]);
+
+/**
+ * Do not allow punctuation at the end of a heading.
+ *
+ * @see [no-heading-punctuation]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-heading-punctuation}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * ## Beep.
+ *
+ */
plugins.push([
- require( 'remark-lint-no-file-name-articles' ),
- [ 'error' ]
+ require("remark-lint-no-heading-punctuation"),
+ ["error", ".,;:!?"],
]);
/**
-* Never allow consecutive dashes in filenames.
-*
-* @see [no-file-name-consecutive-dashes]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-file-name-consecutive-dashes}
-*/
+ * Allow HTML.
+ *
+ * @see [no-html]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-html}
+ *
+ * @example
+ * <!-- Okay -->
+ *
+ * <section class="intro">
+ *
+ * Beep boop.
+ *
+ * </section>
+ */
+plugins.push([require("remark-lint-no-html"), ["off"]]);
+
+/**
+ * Never allow inline padding.
+ *
+ * @see [no-inline-padding]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-inline-padding}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * __ Beep __
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * __Beep__
+ *
+ */
+plugins.push([require("remark-lint-no-inline-padding"), ["error"]]);
+
+/**
+ * Never allow literal URLs without angle brackets.
+ *
+ * @see [no-literal-urls]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-literal-urls}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * https://example.com
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * <https://example.com>
+ *
+ */
+plugins.push([require("remark-lint-no-literal-urls"), ["error"]]);
+
+/**
+ * Require blank lines between block nodes.
+ *
+ * @see [no-missing-blank-lines]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-missing-blank-lines}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * # Beep
+ * ## Boop
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * # Beep
+ *
+ * ## Boop
+ *
+ */
plugins.push([
- require( 'remark-lint-no-file-name-consecutive-dashes' ),
- [ 'error' ]
-]);
-
-/**
-* Never allow filenames to contain irregular characters.
-*
-* @see [no-file-name-irregular-characters]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-file-name-irregular-characters}
-*/
-plugins.push([
- require( 'remark-lint-no-file-name-irregular-characters' ),
- [ 'error', '\\.a-zA-Z0-9-_' ]
-]);
-
-/**
-* Never allow mixed case filenames.
-*
-* @see [no-file-name-mixed-case]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-file-name-mixed-case}
-*/
-plugins.push([
- require( 'remark-lint-no-file-name-mixed-case' ),
- [ 'error' ]
-]);
-
-/**
-* Never allow filenames to begin or end with dashes.
-*
-* @see [no-file-name-outer-dashes]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-file-name-outer-dashes}
-*/
-plugins.push([
- require( 'remark-lint-no-file-name-outer-dashes' ),
- [ 'error' ]
-]);
-
-/**
-* Never allow heading content indentation.
-*
-* @see [no-heading-content-indent]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-heading-content-indent}
-*
-* @example
-* <!-- Bad -->
-*
-* # Beep
-*
-* ## Boop
-*
-* @example
-* <!-- Good -->
-*
-* # Beep
-*
-* ## Boop
-*
-*/
-plugins.push([
- require( 'remark-lint-no-heading-content-indent' ),
- [ 'error' ]
-]);
-
-/**
-* Never allow heading indentation.
-*
-* @see [no-heading-indent]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-heading-indent}
-*
-* @example
-* <!-- Bad -->
-*
-* # Beep
-*
-* ## Beep
-*
-* @example
-* <!-- Bad -->
-*
-* # Beep
-*
-* Beep boop.
-*
-* @example
-* <!-- Good -->
-*
-* # Beep
-*
-* ## Boop
-*
-* Beep boop.
-*
-*/
-plugins.push([
- require( 'remark-lint-no-heading-indent' ),
- [ 'error' ]
-]);
-
-/**
-* Never allow paragraphs which appear to be h7+ "headings".
-*
-* @see [no-heading-like-paragraph]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-heading-like-paragraph}
-*
-* @example
-* <!-- Bad -->
-*
-* ####### Beep
-*
-*/
-plugins.push([
- require( 'remark-lint-no-heading-like-paragraph' ),
- [ 'error' ]
-]);
-
-/**
-* Do not allow punctuation at the end of a heading.
-*
-* @see [no-heading-punctuation]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-heading-punctuation}
-*
-* @example
-* <!-- Bad -->
-*
-* ## Beep.
-*
-*/
-plugins.push([
- require( 'remark-lint-no-heading-punctuation' ),
- [ 'error', '.,;:!?' ]
-]);
-
-/**
-* Allow HTML.
-*
-* @see [no-html]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-html}
-*
-* @example
-* <!-- Okay -->
-*
-* <section class="intro">
-*
-* Beep boop.
-*
-* </section>
-*/
-plugins.push([
- require( 'remark-lint-no-html' ),
- [ 'off' ]
-]);
-
-/**
-* Never allow inline padding.
-*
-* @see [no-inline-padding]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-inline-padding}
-*
-* @example
-* <!-- Bad -->
-*
-* __ Beep __
-*
-* @example
-* <!-- Good -->
-*
-* __Beep__
-*
-*/
-plugins.push([
- require( 'remark-lint-no-inline-padding' ),
- [ 'error' ]
-]);
-
-/**
-* Never allow literal URLs without angle brackets.
-*
-* @see [no-literal-urls]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-literal-urls}
-*
-* @example
-* <!-- Bad -->
-*
-* https://example.com
-*
-* @example
-* <!-- Good -->
-*
-* <https://example.com>
-*
-*/
-plugins.push([
- require( 'remark-lint-no-literal-urls' ),
- [ 'error' ]
-]);
-
-/**
-* Require blank lines between block nodes.
-*
-* @see [no-missing-blank-lines]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-missing-blank-lines}
-*
-* @example
-* <!-- Bad -->
-*
-* # Beep
-* ## Boop
-*
-* @example
-* <!-- Good -->
-*
-* # Beep
-*
-* ## Boop
-*
-*/
-plugins.push([
- require( 'remark-lint-no-missing-blank-lines' ),
+ require("remark-lint-no-missing-blank-lines"),
[
- 'error',
+ "error",
{
- 'exceptTightLists': true
- }
- ]
+ exceptTightLists: true,
+ },
+ ],
]);
/**
-* Allow multiple top-level headings.
-*
-* @see [no-multiple-toplevel-headings]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-multiple-toplevel-headings}
-*
-* @example
-* <!-- Okay -->
-*
-* # Beep
-*
-* # Boop
-*
-*/
-plugins.push([
- require( 'remark-lint-no-multiple-toplevel-headings' ),
- [ 'off' ]
-]);
-
-/**
-* Never allow paragraph indentation.
-*
-* @see [no-paragraph-content-indent]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-paragraph-content-indent}
-*
-* @example
-* <!-- Bad -->
-*
-* # Beep
-*
-* Boop.
-*
-* @example
-* <!-- Good -->
-*
-* # Beep
-*
-* Boop.
-*/
-plugins.push([
- require( 'remark-lint-no-paragraph-content-indent' ),
- [ 'error' ]
-]);
-
-/**
-* Never allow references to be used like URLs.
-*
-* @see [no-reference-like-url]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-reference-like-url}
-*
-* @example
-* <!-- Bad -->
-*
-* [Beep](boop).
-*
-* [boop]: https://example.com
-*
-* @example
-* <!-- Good -->
-*
-* [Beep](https://example.com)
-*
-* [boop]: https://github.com
-*
-*/
-plugins.push([
- require( 'remark-lint-no-reference-like-url' ),
- [ 'error' ]
-]);
-
-/**
-* Allow shell commands to be prefixed with `$` symbols.
-*
-* @see [no-shell-dollars]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-shell-dollars}
-*
-* @example
-* <!-- Okay -->
-*
-* ```bash
-* $ echo beep
-* ```
-*/
-plugins.push([
- require( 'remark-lint-no-shell-dollars' ),
- [ 'off' ]
-]);
-
-/**
-* Never allow shortcut reference images.
-*
-* @see [no-shortcut-reference-image]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-shortcut-reference-image}
-*
-* @example
-* <!-- Bad -->
-*
-* ![foo]
-*
-* [foo]: https://example.com/1.png
-*
-* @example
-* <!-- Good -->
-*
-* ![foo][]
-*
-* [foo]: https://example.com/1.png
-*
-*/
-plugins.push([
- require( 'remark-lint-no-shortcut-reference-image' ),
- [ 'error' ]
-]);
-
-/**
-* Never allow shortcut reference links.
-*
-* @see [no-shortcut-reference-link]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-shortcut-reference-link}
-*
-* @example
-* <!-- Bad -->
-*
-* [foo]
-*
-* [foo]: https://example.com/1.png
-*
-* @example
-* <!-- Good -->
-*
-* [foo][]
-*
-* [foo]: https://example.com/1.png
-*
-*/
-plugins.push([
- require( 'remark-lint-no-shortcut-reference-link' ),
- [ 'error' ]
-]);
-
-/**
-* Never allow table indentation. Note that the exception is when a table correspond to a list item.
-*
-* @see [no-table-indentation]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-table-indentation}
-*
-* @example
-* <!-- Bad -->
-*
-* Beep.
-*
-* | Beep | Boop |
-* | ---- | ---- |
-* | foo | bar |
-*
-* @example
-* <!-- Good -->
-*
-* Beep.
-*
-* | Beep | Boop |
-* | ---- | ---- |
-* | foo | bar |
-*
-*/
-plugins.push([
- require( 'remark-lint-no-table-indentation' ),
- [ 'error' ]
-]);
-
-/**
-* Never allow the use of tabs.
-*
-* @see [no-tabs]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-tabs}
-*/
-plugins.push([
- require( 'remark-lint-no-tabs' ),
- [ 'error' ]
-]);
-
-/**
-* Never allow trailing whitespace.
-*
-* @see [no-trailing-spaces]{@link https://github.com/Trott/remark-lint-no-trailing-spaces}
-*/
+ * Allow multiple top-level headings.
+ *
+ * @see [no-multiple-toplevel-headings]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-multiple-toplevel-headings}
+ *
+ * @example
+ * <!-- Okay -->
+ *
+ * # Beep
+ *
+ * # Boop
+ *
+ */
+plugins.push([require("remark-lint-no-multiple-toplevel-headings"), ["off"]]);
+
+/**
+ * Never allow paragraph indentation.
+ *
+ * @see [no-paragraph-content-indent]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-paragraph-content-indent}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * # Beep
+ *
+ * Boop.
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * # Beep
+ *
+ * Boop.
+ */
+plugins.push([require("remark-lint-no-paragraph-content-indent"), ["error"]]);
+
+/**
+ * Never allow references to be used like URLs.
+ *
+ * @see [no-reference-like-url]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-reference-like-url}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * [Beep](boop).
+ *
+ * [boop]: https://example.com
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * [Beep](https://example.com)
+ *
+ * [boop]: https://github.com
+ *
+ */
+plugins.push([require("remark-lint-no-reference-like-url"), ["error"]]);
+
+/**
+ * Allow shell commands to be prefixed with `$` symbols.
+ *
+ * @see [no-shell-dollars]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-shell-dollars}
+ *
+ * @example
+ * <!-- Okay -->
+ *
+ * ```bash
+ * $ echo beep
+ * ```
+ */
+plugins.push([require("remark-lint-no-shell-dollars"), ["off"]]);
+
+/**
+ * Never allow shortcut reference images.
+ *
+ * @see [no-shortcut-reference-image]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-shortcut-reference-image}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * ![foo]
+ *
+ * [foo]: https://example.com/1.png
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * ![foo][]
+ *
+ * [foo]: https://example.com/1.png
+ *
+ */
+plugins.push([require("remark-lint-no-shortcut-reference-image"), ["error"]]);
+
+/**
+ * Never allow shortcut reference links.
+ *
+ * @see [no-shortcut-reference-link]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-shortcut-reference-link}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * [foo]
+ *
+ * [foo]: https://example.com/1.png
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * [foo][]
+ *
+ * [foo]: https://example.com/1.png
+ *
+ */
+plugins.push([require("remark-lint-no-shortcut-reference-link"), ["error"]]);
+
+/**
+ * Never allow table indentation. Note that the exception is when a table correspond to a list item.
+ *
+ * @see [no-table-indentation]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-table-indentation}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * Beep.
+ *
+ * | Beep | Boop |
+ * | ---- | ---- |
+ * | foo | bar |
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * Beep.
+ *
+ * | Beep | Boop |
+ * | ---- | ---- |
+ * | foo | bar |
+ *
+ */
+plugins.push([require("remark-lint-no-table-indentation"), ["error"]]);
+
+/**
+ * Never allow the use of tabs.
+ *
+ * @see [no-tabs]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-tabs}
+ */
+plugins.push([require("remark-lint-no-tabs"), ["error"]]);
+
+/**
+ * Never allow trailing whitespace.
+ *
+ * @see [no-trailing-spaces]{@link https://github.com/Trott/remark-lint-no-trailing-spaces}
+ */
// plugins.push([require( 'remark-lint-no-trailing-spaces' ), [ 'error' ]]); // NOTE: disabled as requiring an ES module in CommonJS is still experimental
/**
-* Never allow undefined references.
-*
-* @see [no-undefined-references]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-undefined-references}
-*
-* @example
-* <!-- Bad -->
-*
-* [foo][]
-*
-* @example
-* <!-- Good -->
-*
-* [foo][]
-*
-* [foo]: https://example.com
-*/
+ * Never allow undefined references.
+ *
+ * @see [no-undefined-references]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-undefined-references}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * [foo][]
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * [foo][]
+ *
+ * [foo]: https://example.com
+ */
+plugins.push([require("remark-lint-no-undefined-references"), ["error"]]);
+
+/**
+ * Never allow unused definitions.
+ *
+ * @see [no-unused-definitions]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-unused-definitions}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * [foo]: https://example.com
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * [foo][foo].
+ *
+ * [foo]: https://example.com
+ *
+ */
+plugins.push([require("remark-lint-no-unused-definitions"), ["error"]]);
+
+/**
+ * Require ordered lists to use periods (e.g., `1.`, `2.`, etc).
+ *
+ * @see [ordered-list-marker-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-ordered-list-marker-style}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * 1) Foo
+ * 2) Bar
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * 1. Foo
+ * 2. Bar
+ *
+ */
plugins.push([
- require( 'remark-lint-no-undefined-references' ),
- [ 'error' ]
+ require("remark-lint-ordered-list-marker-style"),
+ ["error", "."],
]);
/**
-* Never allow unused definitions.
-*
-* @see [no-unused-definitions]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-unused-definitions}
-*
-* @example
-* <!-- Bad -->
-*
-* [foo]: https://example.com
-*
-* @example
-* <!-- Good -->
-*
-* [foo][foo].
-*
-* [foo]: https://example.com
-*
-*/
+ * Prefer ordered, but allow discretion when determining appropriate ordered list marker value.
+ *
+ * @see [ordered-list-marker-value]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-ordered-list-marker-value}
+ *
+ * @example
+ * <!-- Okay -->
+ *
+ * 1. Foo
+ * 2. Bar
+ * 3. Beep
+ * 4. Boop
+ *
+ * @example
+ * <!-- Okay -->
+ *
+ * 1. Foo
+ * 1. Bar
+ * 1. Beep
+ * 1. Boop
+ *
+ */
plugins.push([
- require( 'remark-lint-no-unused-definitions' ),
- [ 'error' ]
-]);
-
-/**
-* Require ordered lists to use periods (e.g., `1.`, `2.`, etc).
-*
-* @see [ordered-list-marker-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-ordered-list-marker-style}
-*
-* @example
-* <!-- Bad -->
-*
-* 1) Foo
-* 2) Bar
-*
-* @example
-* <!-- Good -->
-*
-* 1. Foo
-* 2. Bar
-*
-*/
-plugins.push([
- require( 'remark-lint-ordered-list-marker-style' ),
- [ 'error', '.' ]
-]);
-
-/**
-* Prefer ordered, but allow discretion when determining appropriate ordered list marker value.
-*
-* @see [ordered-list-marker-value]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-ordered-list-marker-value}
-*
-* @example
-* <!-- Okay -->
-*
-* 1. Foo
-* 2. Bar
-* 3. Beep
-* 4. Boop
-*
-* @example
-* <!-- Okay -->
-*
-* 1. Foo
-* 1. Bar
-* 1. Beep
-* 1. Boop
-*
-*/
-plugins.push([
- require( 'remark-lint-ordered-list-marker-value' ),
- [ 'off', 'ordered' ]
+ require("remark-lint-ordered-list-marker-value"),
+ ["off", "ordered"],
]);
/* eslint-disable stdlib/jsdoc-no-multiple-blank-lines */
/**
-* Require that the horizontal rule style be three consecutive asterisks `---`.
-*
-* @see [rule-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-rule-style}
-*
-* @example
-* <!-- Bad -->
-*
-* ---
-*
-* @example
-* <!-- Good -->
-*
-* * * *
-*
-*/
-plugins.push([
- require( 'remark-lint-rule-style' ),
- [ 'error', '* * *' ]
-]);
+ * Require that the horizontal rule style be three consecutive asterisks `---`.
+ *
+ * @see [rule-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-rule-style}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * ---
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * * * *
+ *
+ */
+plugins.push([require("remark-lint-rule-style"), ["error", "* * *"]]);
/* eslint-enable stdlib/jsdoc-no-multiple-blank-lines */
/**
-* Set the strong marker to asterisks.
-*
-* @see [strong-marker]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-strong-marker}
-*
-* @example
-* <!-- Bad -->
-*
-* __Beep__.
-*
-* @example
-* <!-- Good -->
-*
-* **Beep**.
-*
-*/
-plugins.push([
- require( 'remark-lint-strong-marker' ),
- [ 'error', '*' ]
-]);
-
-/**
-* Require table padding.
-*
-* @see [table-cell-padding]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-table-cell-padding}
-*
-* @example
-* <!-- Bad -->
-*
-* |Beep|Boop|
-* |----|----|
-* |foo |bar |
-*
-* @example
-* <!-- Good -->
-*
-* | Beep | Boop |
-* | ---- | ---- |
-* | foo | bar |
-*
-*/
+ * Set the strong marker to asterisks.
+ *
+ * @see [strong-marker]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-strong-marker}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * __Beep__.
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * **Beep**.
+ *
+ */
+plugins.push([require("remark-lint-strong-marker"), ["error", "*"]]);
+
+/**
+ * Require table padding.
+ *
+ * @see [table-cell-padding]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-table-cell-padding}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * |Beep|Boop|
+ * |----|----|
+ * |foo |bar |
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * | Beep | Boop |
+ * | ---- | ---- |
+ * | foo | bar |
+ *
+ */
+plugins.push([require("remark-lint-table-cell-padding"), ["error", "padded"]]);
+
+/**
+ * Require table pipe alignment.
+ *
+ * @see [table-pipe-alignment]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-table-pipe-alignment}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * | Beep | Boop |
+ * | -- | -- |
+ * | foo | bar |
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * | Beep | Boop |
+ * | ---- | ---- |
+ * | foo | bar |
+ *
+ */
+plugins.push([require("remark-lint-table-pipe-alignment"), ["error"]]);
+
+/**
+ * Require table rows to be fenced in table pipes.
+ *
+ * @see [table-pipes]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-table-pipes}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * Beep | Boop
+ * ---- | ----
+ * foo | bar
+ *
+ * @example
+ * <!-- Good -->
+ *
+ * | Beep | Boop |
+ * | ---- | ---- |
+ * | foo | bar |
+ *
+ */
+plugins.push([require("remark-lint-table-pipes"), ["error"]]);
+
+/**
+ * Require that the unordered list marker be a dash `-`.
+ *
+ * @see [unordered-list-marker-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-unordered-list-marker-style}
+ *
+ * @example
+ * <!-- Bad -->
+ *
+ * * Beep
+ * * Boop
+ *
+ * @example
+ * <!-- Okay -->
+ *
+ * - Beep
+ *
+ * - Foo
+ * - Bar
+ *
+ * - Boop
+ *
+ */
plugins.push([
- require( 'remark-lint-table-cell-padding' ),
- [ 'error', 'padded' ]
+ require("remark-lint-unordered-list-marker-style"),
+ ["error", "-"],
]);
-/**
-* Require table pipe alignment.
-*
-* @see [table-pipe-alignment]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-table-pipe-alignment}
-*
-* @example
-* <!-- Bad -->
-*
-* | Beep | Boop |
-* | -- | -- |
-* | foo | bar |
-*
-* @example
-* <!-- Good -->
-*
-* | Beep | Boop |
-* | ---- | ---- |
-* | foo | bar |
-*
-*/
-plugins.push([
- require( 'remark-lint-table-pipe-alignment' ),
- [ 'error' ]
-]);
-
-/**
-* Require table rows to be fenced in table pipes.
-*
-* @see [table-pipes]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-table-pipes}
-*
-* @example
-* <!-- Bad -->
-*
-* Beep | Boop
-* ---- | ----
-* foo | bar
-*
-* @example
-* <!-- Good -->
-*
-* | Beep | Boop |
-* | ---- | ---- |
-* | foo | bar |
-*
-*/
-plugins.push([
- require( 'remark-lint-table-pipes' ),
- [ 'error' ]
-]);
-
-/**
-* Require that the unordered list marker be a dash `-`.
-*
-* @see [unordered-list-marker-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-unordered-list-marker-style}
-*
-* @example
-* <!-- Bad -->
-*
-* * Beep
-* * Boop
-*
-* @example
-* <!-- Okay -->
-*
-* - Beep
-*
-* - Foo
-* - Bar
-*
-* - Boop
-*
-*/
-plugins.push([
- require( 'remark-lint-unordered-list-marker-style' ),
- [ 'error', '-' ]
-]);
-
-
// EXPORTS //
module.exports = plugins;
diff --git a/etc/remark/plugins/lint/jsdoc.js b/etc/remark/plugins/lint/jsdoc.js
index aa442b211be3..f31e37175f2e 100644
--- a/etc/remark/plugins/lint/jsdoc.js
+++ b/etc/remark/plugins/lint/jsdoc.js
@@ -1,28 +1,27 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
/**
-* Lint plugins for linting Markdown in JSDoc comments.
-*/
-var plugins = [ require( 'remark-lint' ) ];
-
+ * Lint plugins for linting Markdown in JSDoc comments.
+ */
+var plugins = [require("remark-lint")];
// EXPORTS //
diff --git a/etc/remark/plugins/validate-links/index.js b/etc/remark/plugins/validate-links/index.js
index 28482a4aa5e9..219fcb382f04 100644
--- a/etc/remark/plugins/validate-links/index.js
+++ b/etc/remark/plugins/validate-links/index.js
@@ -1,38 +1,37 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
/**
-* Plugin.
-*/
-var plugin = [ require( 'remark-validate-links' ) ];
+ * Plugin.
+ */
+var plugin = [require("remark-validate-links")];
/**
-* Reference repository.
-*
-* @see [repository]{@link https://github.com/remarkjs/remark-validate-links#configuration}
-*/
+ * Reference repository.
+ *
+ * @see [repository]{@link https://github.com/remarkjs/remark-validate-links#configuration}
+ */
plugin.push({
- 'repository': 'stdlib-js/stdlib'
+ repository: "stdlib-js/stdlib",
});
-
// EXPORTS //
module.exports = plugin;
diff --git a/etc/typedoc/index.md b/etc/typedoc/index.md
index ba969fda0cd1..4890697bfcc8 100644
--- a/etc/typedoc/index.md
+++ b/etc/typedoc/index.md
@@ -36,7 +36,7 @@ limitations under the License.
<!-- /.banner -->
-* * *
+---
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
@@ -48,87 +48,87 @@ This is the TypeScript documentation for exported functions, methods, properties
## Resources
-- [**Installation**](#installation)
-- [**Homepage**][stdlib-homepage]
-- [**Documentation**][stdlib-documentation]
-- [**Source code**][stdlib-source]
-- [**Code coverage**][stdlib-code-coverage]
-- [**FAQ**][stdlib-faq]
+- [**Installation**](#installation)
+- [**Homepage**][stdlib-homepage]
+- [**Documentation**][stdlib-documentation]
+- [**Source code**][stdlib-source]
+- [**Code coverage**][stdlib-code-coverage]
+- [**FAQ**][stdlib-faq]
### External Resources
-- [**Twitter**][stdlib-twitter]
-- [**Gitter**][stdlib-gitter]
+- [**Twitter**][stdlib-twitter]
+- [**Gitter**][stdlib-gitter]
## Features
-- 150+ [special math functions][@stdlib/math/base/special].
+- 150+ [special math functions][@stdlib/math/base/special].
<div class="image" align="center">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@203839353bc74297fe641207270f7917d2bda560/docs/assets/readme/base_special_math.png" alt="Demo showcasing special math functions">
</div>
-- 35+ [probability distributions][@stdlib/stats/base/dists], with support for evaluating probability density functions (PDFs), cumulative distribution functions (CDFs), quantiles, moments, and more.
+- 35+ [probability distributions][@stdlib/stats/base/dists], with support for evaluating probability density functions (PDFs), cumulative distribution functions (CDFs), quantiles, moments, and more.
<div class="image" align="center">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@e13885087939c064c69aa43ee80ea52710de5591/docs/assets/readme/base_dists.png" alt="Demo showcasing probability distributions">
</div>
-- 40+ [seedable pseudorandom number generators][@stdlib/random/base] (PRNGs).
+- 40+ [seedable pseudorandom number generators][@stdlib/random/base] (PRNGs).
<div class="image" align="center">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@83dcd0fad98883320a8b1efc801b2fc1ed2a003d/docs/assets/readme/base_prngs.png" alt="Demo showcasing PRNGs">
</div>
-- 200+ general [utilities][@stdlib/utils] for data transformation, functional programming, and asynchronous control flow.
+- 200+ general [utilities][@stdlib/utils] for data transformation, functional programming, and asynchronous control flow.
<div class="image" align="center">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@e6eeea31e49d6db1b6f57ae59d2988d4b427e285/docs/assets/readme/utils.png" alt="Demo showcasing general utilities">
</div>
-- 200+ [assertion utilities][@stdlib/assert] for data validation and feature detection.
+- 200+ [assertion utilities][@stdlib/assert] for data validation and feature detection.
<div class="image" align="center">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@6970c8b4eb546a10712734d225c15863db9b2c92/docs/assets/readme/assert.png" alt="Demo showcasing assertion utilities">
</div>
-- 50+ [sample datasets][@stdlib/datasets] for testing and development.
+- 50+ [sample datasets][@stdlib/datasets] for testing and development.
<div class="image" align="center">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@f71a38e62247e31dc47d248f6f1b3e434abeb971/docs/assets/readme/datasets.png" alt="Demo showcasing sample datasets">
</div>
-- A [plot API][@stdlib/plot/ctor] for data visualization and exploratory data analysis.
+- A [plot API][@stdlib/plot/ctor] for data visualization and exploratory data analysis.
<div class="image" align="center">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@39d75174b24ea2a84828d9624643776a164478e4/docs/assets/readme/plot.png" alt="Demo showcasing plot API">
</div>
-- Native add-ons for interfacing with BLAS libraries, with pure JavaScript fallbacks.
+- Native add-ons for interfacing with BLAS libraries, with pure JavaScript fallbacks.
<div class="image" align="center">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@efede6af3ef957da08838903b0558441263adf85/docs/assets/readme/base_blas.png" alt="Demo showcasing BLAS APIs">
</div>
-- A [benchmark framework][@stdlib/bench/harness] supporting TAP.
+- A [benchmark framework][@stdlib/bench/harness] supporting TAP.
<div class="image" align="center">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@4833049f8d1895585bd51ec6fa97b8ca0d37c6fb/docs/assets/readme/benchmark.gif" alt="Demo showcasing benchmark framework">
</div>
-- REPL environment with integrated help and examples.
+- REPL environment with integrated help and examples.
<div class="image" align="center">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@3864ae6f86bbc215956c0e667d82d49a6eaca780/docs/assets/readme/repl.gif" alt="Demo showcasing REPL environment">
</div>
-- Can be bundled using [Browserify][browserify], [Webpack][webpack], and other bundlers for use in web browsers.
+- Can be bundled using [Browserify][browserify], [Webpack][webpack], and other bundlers for use in web browsers.
<div class="image" align="center">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@e54894a93697653dda22d11cd0aec1ccb292b7b8/docs/assets/readme/bundled.png" alt="Demo showcasing browser support">
</div>
-* * *
+---
## Installation
@@ -138,51 +138,51 @@ While this project's installation instructions defaults to using [npm][npm] for
### User Stories
-- I want to perform **data analysis** and/or **data science** related tasks in JavaScript and Node.js, similar to how I might use IPython, Julia, R, and/or MATLAB.
+- I want to perform **data analysis** and/or **data science** related tasks in JavaScript and Node.js, similar to how I might use IPython, Julia, R, and/or MATLAB.
- - Install the entire project as a [command-line utility](#install_command_line_utility).
+ - Install the entire project as a [command-line utility](#install_command_line_utility).
-- I am building a **web application**.
+- I am building a **web application**.
- - I plan on using [Browserify][browserify], [Webpack][webpack], and other bundlers for use in web browsers.
+ - I plan on using [Browserify][browserify], [Webpack][webpack], and other bundlers for use in web browsers.
- - Install [individual packages](#install_individual_packages). Installing the entire project is likely unnecessary and will lead to slower installation times.
+ - Install [individual packages](#install_individual_packages). Installing the entire project is likely unnecessary and will lead to slower installation times.
- - I would like to **vendor** a custom bundle containing various stdlib functionality.
+ - I would like to **vendor** a custom bundle containing various stdlib functionality.
- - Follow the steps for creating [custom bundles](#install_custom_bundles).
+ - Follow the steps for creating [custom bundles](#install_custom_bundles).
- - I would like to include stdlib functionality by just using a `script` tag.
+ - I would like to include stdlib functionality by just using a `script` tag.
- - Install one of the pre-built UMD [browser bundles](#install_browser_bundles) or consume one of the pre-built bundles via a CDN, such as [unpkg][unpkg].
+ - Install one of the pre-built UMD [browser bundles](#install_browser_bundles) or consume one of the pre-built bundles via a CDN, such as [unpkg][unpkg].
- - I am interested in using a substantial amount of functionality found in a top-level stdlib namespace and don't want to separately install hundreds of individual packages (e.g., if building an on-line calculator application and wanting all of stdlib's math functionality).
+ - I am interested in using a substantial amount of functionality found in a top-level stdlib namespace and don't want to separately install hundreds of individual packages (e.g., if building an on-line calculator application and wanting all of stdlib's math functionality).
- - Install one or more top-level [namespaces](#install_namespaces). Installing the entire project is likely unnecessary and will lead to slower installation times. Installing a top-level namespace is likely to mean installing functionality which will never be used; however, installing a top-level namespace is likely to be easier and less time-consuming than installing many individual packages separately.
+ - Install one or more top-level [namespaces](#install_namespaces). Installing the entire project is likely unnecessary and will lead to slower installation times. Installing a top-level namespace is likely to mean installing functionality which will never be used; however, installing a top-level namespace is likely to be easier and less time-consuming than installing many individual packages separately.
Concerning bundling, installing a top-level namespace should not be a concern, as individual functionality can still be independently required/imported. Project installation times may, however, be somewhat slower.
-- I am building a [Node.js][node-js] **server application**.
+- I am building a [Node.js][node-js] **server application**.
- - I am interested in using various functionality found in stdlib.
+ - I am interested in using various functionality found in stdlib.
- - Install [individual packages](#install_individual_packages). Installing the entire project is likely unnecessary and will lead to slower installation times.
+ - Install [individual packages](#install_individual_packages). Installing the entire project is likely unnecessary and will lead to slower installation times.
- - I am interested in using a substantial amount of functionality found in a top-level stdlib namespace and don't want to separately install hundreds of individual packages.
+ - I am interested in using a substantial amount of functionality found in a top-level stdlib namespace and don't want to separately install hundreds of individual packages.
- - Install one or more top-level [namespaces](#install_namespaces). Installing the entire project is likely unnecessary and will lead to slower installation times. Installing a top-level namespace is likely to mean installing functionality which will never be used; however, installing a top-level namespace is likely to be easier and less time-consuming than installing many individual packages separately.
+ - Install one or more top-level [namespaces](#install_namespaces). Installing the entire project is likely unnecessary and will lead to slower installation times. Installing a top-level namespace is likely to mean installing functionality which will never be used; however, installing a top-level namespace is likely to be easier and less time-consuming than installing many individual packages separately.
-- I am using **Deno**.
+- I am using **Deno**.
- - Use [skypack][skypack] to import [individual packages](#install_individual_packages).
+ - Use [skypack][skypack] to import [individual packages](#install_individual_packages).
-- I would like to use stdlib functionality in an [Observable][observable] notebook.
+- I would like to use stdlib functionality in an [Observable][observable] notebook.
- - Consume one of the pre-built [browser bundles](#install_browser_bundles) via a CDN, such as [unpkg][unpkg].
+ - Consume one of the pre-built [browser bundles](#install_browser_bundles) via a CDN, such as [unpkg][unpkg].
-- I want to hack at stdlib, possibly even creating **customized** builds to link to platform-specific native libraries (such as Intel's MKL or some other numerical library).
+- I want to hack at stdlib, possibly even creating **customized** builds to link to platform-specific native libraries (such as Intel's MKL or some other numerical library).
- - Install the project as a [system library](#install_system_library) by cloning this repository and following the [installation][stdlib-development] instructions as described in the [development guide][stdlib-development].
+ - Install the project as a [system library](#install_system_library) by cloning this repository and following the [installation][stdlib-development] instructions as described in the [development guide][stdlib-development].
<a name="install_complete_library"></a>
@@ -199,9 +199,12 @@ $ npm install @stdlib/stdlib
Once installed, stdlib packages can be individually required/imported to minimize load times and decrease bundle sizes. For example, to use `require`
```javascript
-var ndarray = require( '@stdlib/ndarray/ctor' );
+var ndarray = require("@stdlib/ndarray/ctor");
-var arr = ndarray( [ [ 1, 2 ], [ 3, 4 ] ] );
+var arr = ndarray([
+ [1, 2],
+ [3, 4],
+]);
// returns <ndarray>
```
@@ -210,9 +213,12 @@ and to use `import`
<!-- run-disable -->
```javascript
-import ndarray from '@stdlib/ndarray/ctor';
+import ndarray from "@stdlib/ndarray/ctor";
-var arr = ndarray( [ [ 1, 2 ], [ 3, 4 ] ] );
+var arr = ndarray([
+ [1, 2],
+ [3, 4],
+]);
// returns <ndarray>
```
@@ -233,9 +239,12 @@ $ npm install @stdlib/ndarray-ctor
Once installed, individual packages can be required/imported. For example, to use `require`
```javascript
-var ndarray = require( '@stdlib/ndarray-ctor' );
+var ndarray = require("@stdlib/ndarray-ctor");
-var arr = ndarray( [ [ 1, 2 ], [ 3, 4 ] ] );
+var arr = ndarray([
+ [1, 2],
+ [3, 4],
+]);
// returns <ndarray>
```
@@ -244,9 +253,12 @@ and to use `import`
<!-- run-disable -->
```javascript
-import ndarray from '@stdlib/ndarray-ctor';
+import ndarray from "@stdlib/ndarray-ctor";
-var arr = ndarray( [ [ 1, 2 ], [ 3, 4 ] ] );
+var arr = ndarray([
+ [1, 2],
+ [3, 4],
+]);
// returns <ndarray>
```
@@ -265,9 +277,9 @@ $ npm install @stdlib/math
Once installed, packages within a top-level namespace can be individually required/imported to minimize load times and decrease bundle sizes. For example, to use `require`
```javascript
-var sin = require( '@stdlib/math/base/special/sin' );
+var sin = require("@stdlib/math/base/special/sin");
-var v = sin( 3.14 );
+var v = sin(3.14);
// returns <number>
```
@@ -276,9 +288,9 @@ and to use `import`
<!-- run-disable -->
```javascript
-import sin from '@stdlib/math/base/special/sin';
+import sin from "@stdlib/math/base/special/sin";
-var v = sin( 3.14 );
+var v = sin(3.14);
// returns <number>
```
@@ -327,7 +339,10 @@ $ npm install @stdlib/dist-math-base-special-flat
and then include the following `<script>` tag in our HTML document
```html
-<script type="text/javascript" src="/path/to/@stdlib/dist-math-base-special-flat/build/bundle.min.js"></script>
+<script
+ type="text/javascript"
+ src="/path/to/@stdlib/dist-math-base-special-flat/build/bundle.min.js"
+></script>
```
making sure to modify the script path based on the local installation directory.
@@ -338,7 +353,7 @@ If no recognized module system is present, one can access bundle contents in ano
<script type="text/javascript">
// If no recognized module system present, exposed to global scope:
var erf = stdlib_math_base_special_flat.erf;
- console.log( erf( 0.5 ) );
+ console.log(erf(0.5));
</script>
```
@@ -386,32 +401,32 @@ Upon generating a bundle, the bundle can be loaded via a `<script>` tag as descr
To install as a system library (e.g., for the purposes of creating custom builds), follow the [download][stdlib-development], [configuration][stdlib-development], and [installation][stdlib-development] instructions as described in the [development guide][stdlib-development].
-* * *
+---
## Prerequisites
Installing and running stdlib for use in [Node.js][node-js] **requires** the following prerequisites:
-- [Node.js][node-js]: JavaScript runtime (version `>= 0.10`)
-- [npm][npm]: package manager (version `> 2.7.0`; if Node `< 1.0.0`, version `> 2.7.0` and `< 4.0.0`; if Node `<= 10.x.x`, version `> 2.7.0` and `< 6.0.0`)
+- [Node.js][node-js]: JavaScript runtime (version `>= 0.10`)
+- [npm][npm]: package manager (version `> 2.7.0`; if Node `< 1.0.0`, version `> 2.7.0` and `< 4.0.0`; if Node `<= 10.x.x`, version `> 2.7.0` and `< 6.0.0`)
Most functionality in stdlib is implemented in JavaScript and no further prerequisites are required to use stdlib (i.e., you can safely avoid installing any additional prerequisites); however, some implementations try to capture performance benefits by using [native bindings][node-js-add-ons] and/or [WebAssembly][webassembly]. While **not** required to run stdlib, as **every** stdlib implementation has a JavaScript fallback, the following dependencies are **required** for building native add-ons, including linking to BLAS and LAPACK libraries:
-- [GNU make][make]: development utility and task runner
-- [GNU bash][bash]: an sh-compatible shell
-- [gcc & g++][gcc] or [Clang][clang]: C/C++ compilation and linking (g++ version `>= 4.8`; clang version `>= 3.5`, Xcode version `>=8.3.1` on OS X)
-- [gfortran][gfortran]: Fortran compilation and linking (version `>= 4.8`)
+- [GNU make][make]: development utility and task runner
+- [GNU bash][bash]: an sh-compatible shell
+- [gcc & g++][gcc] or [Clang][clang]: C/C++ compilation and linking (g++ version `>= 4.8`; clang version `>= 3.5`, Xcode version `>=8.3.1` on OS X)
+- [gfortran][gfortran]: Fortran compilation and linking (version `>= 4.8`)
While **not** required to run stdlib, the following dependencies are **required** for automatically downloading external libraries:
-- [curl][curl], [wget][wget], or [fetch][fetch] (FreeBSD): utilities for downloading remote resources
+- [curl][curl], [wget][wget], or [fetch][fetch] (FreeBSD): utilities for downloading remote resources
The following external libraries can be automatically downloaded and compiled from source using `make`:
-- [OpenBLAS][openblas]: optimized BLAS library
-- [Electron][electron]: framework for cross-platform desktop applications
+- [OpenBLAS][openblas]: optimized BLAS library
+- [Electron][electron]: framework for cross-platform desktop applications
-* * *
+---
## Contributing
@@ -434,83 +449,44 @@ Copyright © 2016-2021. The Stdlib [Authors][stdlib-authors].
<section class="links">
[make]: https://www.gnu.org/software/make
-
[bash]: https://www.gnu.org/software/bash/
-
[curl]: http://curl.haxx.se/
-
[wget]: http://www.gnu.org/software/wget
-
[fetch]: http://www.freebsd.org/cgi/man.cgi?fetch%281%29
-
[node-js]: https://nodejs.org/en/
-
[npm]: https://www.npmjs.com/
-
[yarn]: https://yarnpkg.com/
-
[gcc]: http://gcc.gnu.org/
-
[clang]: http://clang.llvm.org/
-
[gfortran]: https://gcc.gnu.org/fortran/
-
[openblas]: https://github.com/xianyi/OpenBLAS
-
[electron]: https://electron.atom.io/
-
[webassembly]: http://webassembly.org/
-
[node-js-add-ons]: https://nodejs.org/api/addons.html
-
[browserify]: https://github.com/substack/node-browserify
-
[webpack]: https://webpack.js.org/
-
[unpkg]: https://unpkg.com/#/
-
[ipa-english]: https://en.wikipedia.org/wiki/Help:IPA/English
-
[stdlib-contributing]: https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md
-
[stdlib-development]: https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md
-
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
-
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stdlib/develop/LICENSE
-
[stdlib-homepage]: https://github.com/stdlib-js/stdlib
-
[stdlib-documentation]: https://github.com/stdlib-js/stdlib
-
[stdlib-faq]: https://github.com/stdlib-js/stdlib/blob/develop/FAQ.md
-
[stdlib-source]: https://github.com/stdlib-js/stdlib
-
[stdlib-bundles]: https://github.com/stdlib-js/stdlib/tree/develop/dist
-
[stdlib-code-coverage]: https://codecov.io/github/stdlib-js/stdlib/branch/develop
-
[stdlib-twitter]: https://x.com/stdlibjs
-
[stdlib-gitter]: https://gitter.im/stdlib-js/stdlib
-
[@stdlib/math/base/special]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special
-
[@stdlib/stats/base/dists]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists
-
[@stdlib/random/base]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/base
-
[@stdlib/assert]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert
-
[@stdlib/datasets]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/datasets
-
[@stdlib/utils]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils
-
[@stdlib/plot/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/plot/ctor
-
[@stdlib/bench/harness]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/bench/harness
-
[@stdlib/repl]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/repl
</section>
diff --git a/etc/typedoc/theme/assets/css/theme.css b/etc/typedoc/theme/assets/css/theme.css
index c3a3cba1fddc..ef431dc2a603 100644
--- a/etc/typedoc/theme/assets/css/theme.css
+++ b/etc/typedoc/theme/assets/css/theme.css
@@ -17,11 +17,11 @@
*/
.tsd-index-panel ul.tsd-index-list {
- -webkit-column-count: 1!important;
- -moz-column-count: 1!important;
- -ms-column-count: 1!important;
- -o-column-count: 1!important;
- column-count: 1!important;
+ -webkit-column-count: 1 !important;
+ -moz-column-count: 1 !important;
+ -ms-column-count: 1 !important;
+ -o-column-count: 1 !important;
+ column-count: 1 !important;
}
.tsd-page-title h1 {
diff --git a/etc/typedoc/theme/assets/js/theme.js b/etc/typedoc/theme/assets/js/theme.js
index 0215b2d176c0..910680906ff7 100644
--- a/etc/typedoc/theme/assets/js/theme.js
+++ b/etc/typedoc/theme/assets/js/theme.js
@@ -1,178 +1,184 @@
/**
-* @license Apache-2.0
-*
-* Copyright (c) 2019 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';
-
-( function () { // eslint-disable-line func-names, no-restricted-syntax
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2019 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";
+
+(function () {
+ // eslint-disable-line func-names, no-restricted-syntax
/**
- * Removes extraneous information from a path.
- *
- * @private
- * @param {string} txt - text 1
- * @returns {string} cleaned text
- */
- function cleanPath( txt ) {
+ * Removes extraneous information from a path.
+ *
+ * @private
+ * @param {string} txt - text 1
+ * @returns {string} cleaned text
+ */
+ function cleanPath(txt) {
var ch;
var j;
- if ( txt.charCodeAt( 0 ) === 34 ) {
- for ( j = 1; j < txt.length; j++ ) {
- ch = txt.charCodeAt( j );
- if ( ch === 34 ) {
- txt = txt.slice( 1, j );
+ if (txt.charCodeAt(0) === 34) {
+ for (j = 1; j < txt.length; j++) {
+ ch = txt.charCodeAt(j);
+ if (ch === 34) {
+ txt = txt.slice(1, j);
break;
}
}
}
- j = txt.indexOf( '/docs/types/' );
- if ( j >= 0 ) {
- txt = txt.slice( 0, j );
+ j = txt.indexOf("/docs/types/");
+ if (j >= 0) {
+ txt = txt.slice(0, j);
} else {
- j = txt.indexOf( '/index.d' );
- if ( j >= 0 ) {
- txt = txt.slice( 0, j );
+ j = txt.indexOf("/index.d");
+ if (j >= 0) {
+ txt = txt.slice(0, j);
}
}
return txt;
}
/**
- * Cleans up the document title.
- *
- * @private
- * @param {DOMElement} el - title element
- */
- function cleanTitle( el ) {
- var txt = cleanPath( el.innerHTML );
- var idx = txt.indexOf( 'stdlib' );
- if ( idx === -1 || idx === 1 ) { // e.g., '@stdlib/types/iter'
- txt = 'stdlib | ' + txt;
+ * Cleans up the document title.
+ *
+ * @private
+ * @param {DOMElement} el - title element
+ */
+ function cleanTitle(el) {
+ var txt = cleanPath(el.innerHTML);
+ var idx = txt.indexOf("stdlib");
+ if (idx === -1 || idx === 1) {
+ // e.g., '@stdlib/types/iter'
+ txt = "stdlib | " + txt;
} else {
- idx = txt.indexOf( ' | stdlib' );
- if ( idx === txt.length-9 ) { // e.g., 'foo/bar | stdlib'
- txt = 'stdlib | ' + txt.slice( 0, -9 );
+ idx = txt.indexOf(" | stdlib");
+ if (idx === txt.length - 9) {
+ // e.g., 'foo/bar | stdlib'
+ txt = "stdlib | " + txt.slice(0, -9);
}
}
el.innerHTML = txt;
}
/**
- * Cleans up link text.
- *
- * @private
- * @param {Array<DOMElement>} el - list of anchor elements to clean
- */
- function cleanLinks( el ) {
+ * Cleans up link text.
+ *
+ * @private
+ * @param {Array<DOMElement>} el - list of anchor elements to clean
+ */
+ function cleanLinks(el) {
var i;
- for ( i = 0; i < el.length; i++ ) {
- el[ i ].innerHTML = cleanPath( el[ i ].innerHTML );
+ for (i = 0; i < el.length; i++) {
+ el[i].innerHTML = cleanPath(el[i].innerHTML);
}
}
/**
- * Updates and removes extraneous information from a heading.
- *
- * @private
- * @param {string} txt - text
- * @returns {string} cleaned text
- */
- function cleanHeading( txt ) {
- if ( txt.indexOf( 'External module' ) === 0 ) {
- txt = 'Package: @stdlib/' + cleanPath( txt.slice( 16 ) );
+ * Updates and removes extraneous information from a heading.
+ *
+ * @private
+ * @param {string} txt - text
+ * @returns {string} cleaned text
+ */
+ function cleanHeading(txt) {
+ if (txt.indexOf("External module") === 0) {
+ txt = "Package: @stdlib/" + cleanPath(txt.slice(16));
}
return txt;
}
/**
- * Cleans up heading text.
- *
- * @private
- * @param {Array<DOMElement>} el - list of heading elements to clean
- */
- function cleanHeadings( el ) {
+ * Cleans up heading text.
+ *
+ * @private
+ * @param {Array<DOMElement>} el - list of heading elements to clean
+ */
+ function cleanHeadings(el) {
var i;
- for ( i = 0; i < el.length; i++ ) {
- el[ i ].innerHTML = cleanHeading( el[ i ].innerHTML );
+ for (i = 0; i < el.length; i++) {
+ el[i].innerHTML = cleanHeading(el[i].innerHTML);
}
}
/**
- * Updates a description.
- *
- * @private
- * @param {string} txt - description
- * @returns {string} updated description
- */
- function updateDescription( txt ) {
+ * Updates a description.
+ *
+ * @private
+ * @param {string} txt - description
+ * @returns {string} updated description
+ */
+ function updateDescription(txt) {
var ch;
- if ( txt.length === 0 ) {
+ if (txt.length === 0) {
return txt;
}
- ch = txt[ 0 ].toUpperCase();
- if ( ch !== txt[ 0 ] ) {
- txt = ch + txt.slice( 1 );
+ ch = txt[0].toUpperCase();
+ if (ch !== txt[0]) {
+ txt = ch + txt.slice(1);
}
- if ( txt.charCodeAt( txt.length-1 ) !== 46 ) { // .
- txt += '.';
+ if (txt.charCodeAt(txt.length - 1) !== 46) {
+ // .
+ txt += ".";
}
return txt;
}
/**
- * Updates `@param` and `@returns` descriptions.
- *
- * @private
- * @param {Array<DOMElement>} el - list of elements containing descriptions
- */
- function updateDescriptions( el ) {
+ * Updates `@param` and `@returns` descriptions.
+ *
+ * @private
+ * @param {Array<DOMElement>} el - list of elements containing descriptions
+ */
+ function updateDescriptions(el) {
var i;
- for ( i = 0; i < el.length; i++ ) {
- el[ i ].innerHTML = updateDescription( el[ i ].innerHTML );
+ for (i = 0; i < el.length; i++) {
+ el[i].innerHTML = updateDescription(el[i].innerHTML);
}
}
/**
- * Main execution sequence.
- *
- * @private
- */
+ * Main execution sequence.
+ *
+ * @private
+ */
function main() {
var el;
- el = document.querySelector( 'title' );
- cleanTitle( el );
+ el = document.querySelector("title");
+ cleanTitle(el);
- el = document.querySelectorAll( '.tsd-kind-external-module a' );
- cleanLinks( el );
+ el = document.querySelectorAll(".tsd-kind-external-module a");
+ cleanLinks(el);
- el = document.querySelectorAll( '.tsd-is-not-exported a' );
- cleanLinks( el );
+ el = document.querySelectorAll(".tsd-is-not-exported a");
+ cleanLinks(el);
- el = document.querySelectorAll( '.tsd-breadcrumb a' );
- cleanLinks( el );
+ el = document.querySelectorAll(".tsd-breadcrumb a");
+ cleanLinks(el);
- el = document.querySelectorAll( '.tsd-page-title h1' );
- cleanHeadings( el );
+ el = document.querySelectorAll(".tsd-page-title h1");
+ cleanHeadings(el);
- el = document.querySelectorAll( '.tsd-description .tsd-parameters .tsd-comment p' );
- updateDescriptions( el );
+ el = document.querySelectorAll(
+ ".tsd-description .tsd-parameters .tsd-comment p",
+ );
+ updateDescriptions(el);
- el = document.querySelectorAll( '.tsd-description .tsd-returns-title + p' );
- updateDescriptions( el );
+ el = document.querySelectorAll(".tsd-description .tsd-returns-title + p");
+ updateDescriptions(el);
}
main();
diff --git a/etc/typedoc/theme/partials/footer.hbs b/etc/typedoc/theme/partials/footer.hbs
index adb494a967a7..9ffa4a11a5b3 100644
--- a/etc/typedoc/theme/partials/footer.hbs
+++ b/etc/typedoc/theme/partials/footer.hbs
@@ -1,74 +1,140 @@
-
<footer>
- <div class="container">
- <h2>Legend</h2>
- <div class="tsd-legend-group">
- <ul class="tsd-legend">
- <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
- <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
- <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
- <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
- <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
- <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
- <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
- <li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
+ <div class="container">
+ <h2>Legend</h2>
+ <div class="tsd-legend-group">
+ <ul class="tsd-legend">
+ <li class="tsd-kind-module"><span
+ class="tsd-kind-icon"
+ >Module</span></li>
+ <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object
+ literal</span></li>
+ <li class="tsd-kind-variable"><span
+ class="tsd-kind-icon"
+ >Variable</span></li>
+ <li class="tsd-kind-function"><span
+ class="tsd-kind-icon"
+ >Function</span></li>
+ <li class="tsd-kind-function tsd-has-type-parameter"><span
+ class="tsd-kind-icon"
+ >Function with type parameter</span></li>
+ <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index
+ signature</span></li>
+ <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
+ <li class="tsd-kind-type-alias tsd-has-type-parameter"><span
+ class="tsd-kind-icon"
+ >Type alias with type parameter</span></li>
- </ul>
- <ul class="tsd-legend">
- <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
- <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
- <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
- <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
- </ul>
- <ul class="tsd-legend">
- <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
- <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
- <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
- <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
- <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
- </ul>
- <ul class="tsd-legend">
- <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
- <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
- <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
- <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
- <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
- </ul>
- <ul class="tsd-legend">
- <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
- <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
- </ul>
- <ul class="tsd-legend">
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
- <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
- </ul>
- <ul class="tsd-legend">
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
- <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
- </ul>
- <ul class="tsd-legend">
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
- <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
- </ul>
- </div>
+ </ul>
+ <ul class="tsd-legend">
+ <li class="tsd-kind-enum"><span
+ class="tsd-kind-icon"
+ >Enumeration</span></li>
+ <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration
+ member</span></li>
+ <li class="tsd-kind-property tsd-parent-kind-enum"><span
+ class="tsd-kind-icon"
+ >Property</span></li>
+ <li class="tsd-kind-method tsd-parent-kind-enum"><span
+ class="tsd-kind-icon"
+ >Method</span></li>
+ </ul>
+ <ul class="tsd-legend">
+ <li class="tsd-kind-interface"><span
+ class="tsd-kind-icon"
+ >Interface</span></li>
+ <li class="tsd-kind-interface tsd-has-type-parameter"><span
+ class="tsd-kind-icon"
+ >Interface with type parameter</span></li>
+ <li class="tsd-kind-constructor tsd-parent-kind-interface"><span
+ class="tsd-kind-icon"
+ >Constructor</span></li>
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span
+ class="tsd-kind-icon"
+ >Property</span></li>
+ <li class="tsd-kind-method tsd-parent-kind-interface"><span
+ class="tsd-kind-icon"
+ >Method</span></li>
+ <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span
+ class="tsd-kind-icon"
+ >Index signature</span></li>
+ </ul>
+ <ul class="tsd-legend">
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
+ <li class="tsd-kind-class tsd-has-type-parameter"><span
+ class="tsd-kind-icon"
+ >Class with type parameter</span></li>
+ <li class="tsd-kind-constructor tsd-parent-kind-class"><span
+ class="tsd-kind-icon"
+ >Constructor</span></li>
+ <li class="tsd-kind-property tsd-parent-kind-class"><span
+ class="tsd-kind-icon"
+ >Property</span></li>
+ <li class="tsd-kind-method tsd-parent-kind-class"><span
+ class="tsd-kind-icon"
+ >Method</span></li>
+ <li class="tsd-kind-accessor tsd-parent-kind-class"><span
+ class="tsd-kind-icon"
+ >Accessor</span></li>
+ <li class="tsd-kind-index-signature tsd-parent-kind-class"><span
+ class="tsd-kind-icon"
+ >Index signature</span></li>
+ </ul>
+ <ul class="tsd-legend">
+ <li
+ class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"
+ ><span class="tsd-kind-icon">Inherited constructor</span></li>
+ <li
+ class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"
+ ><span class="tsd-kind-icon">Inherited property</span></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span
+ class="tsd-kind-icon"
+ >Inherited method</span></li>
+ <li
+ class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"
+ ><span class="tsd-kind-icon">Inherited accessor</span></li>
+ </ul>
+ <ul class="tsd-legend">
+ <li
+ class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"
+ ><span class="tsd-kind-icon">Protected property</span></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span
+ class="tsd-kind-icon"
+ >Protected method</span></li>
+ <li
+ class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"
+ ><span class="tsd-kind-icon">Protected accessor</span></li>
+ </ul>
+ <ul class="tsd-legend">
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span
+ class="tsd-kind-icon"
+ >Private property</span></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span
+ class="tsd-kind-icon"
+ >Private method</span></li>
+ <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span
+ class="tsd-kind-icon"
+ >Private accessor</span></li>
+ </ul>
+ <ul class="tsd-legend">
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span
+ class="tsd-kind-icon"
+ >Static property</span></li>
+ <li
+ class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"
+ ><span class="tsd-kind-icon">Static method</span></li>
+ </ul>
</div>
+ </div>
- <div class="bottom-nav center border-top">
- <a href="https://opencollective.com/stdlib">Sponsor</a>
- /
- <a href="/docs/api/">Docs</a>
- /
- <a href="https://gitter.im/stdlib-js/stdlib">Chat</a>
- /
- <a href="https://x.com/stdlibjs">X</a>
- /
- <a href="https://github.com/stdlib-js/stdlib">Contribute</a>
- </div>
-</footer>
+ <div class="bottom-nav center border-top">
+ <a href="https://opencollective.com/stdlib">Sponsor</a>
+ /
+ <a href="/docs/api/">Docs</a>
+ /
+ <a href="https://gitter.im/stdlib-js/stdlib">Chat</a>
+ /
+ <a href="https://x.com/stdlibjs">X</a>
+ /
+ <a href="https://github.com/stdlib-js/stdlib">Contribute</a>
+ </div>
+</footer>
\ No newline at end of file
diff --git a/etc/typedoc/tsconfig.json b/etc/typedoc/tsconfig.json
index 021b96e9d549..474c7d52a78b 100644
--- a/etc/typedoc/tsconfig.json
+++ b/etc/typedoc/tsconfig.json
@@ -9,9 +9,7 @@
"checkJs": true,
"forceConsistentCasingInFileNames": true,
"keyofStringsOnly": false,
- "lib": [
- "es6"
- ],
+ "lib": ["es6"],
"module": "commonjs",
"moduleResolution": "node",
"newLine": "lf",
@@ -30,14 +28,12 @@
"strictNullChecks": true,
"suppressExcessPropertyErrors": false,
"suppressImplicitAnyIndexErrors": false,
- "typeRoots": [ "./../../" ],
+ "typeRoots": ["./../../"],
"types": []
},
"include": [
"./../../lib/node_modules/**/docs/types/index.d.ts",
"./../../lib/node_modules/**/@stdlib/types/index.d.ts"
],
- "exclude": [
- "node_modules"
- ]
+ "exclude": ["node_modules"]
}
diff --git a/etc/typescript/tsconfig.json b/etc/typescript/tsconfig.json
index f5bb973b1ce3..a77fe77ddcaa 100644
--- a/etc/typescript/tsconfig.json
+++ b/etc/typescript/tsconfig.json
@@ -9,9 +9,7 @@
"checkJs": true,
"forceConsistentCasingInFileNames": true,
"keyofStringsOnly": false,
- "lib": [
- "es6"
- ],
+ "lib": ["es6"],
"module": "commonjs",
"moduleResolution": "node",
"newLine": "lf",
@@ -30,14 +28,9 @@
"strictNullChecks": true,
"suppressExcessPropertyErrors": false,
"suppressImplicitAnyIndexErrors": false,
- "typeRoots": [ "." ],
+ "typeRoots": ["."],
"types": []
},
- "include": [
- "index.d.ts",
- "test.ts"
- ],
- "exclude": [
- "node_modules"
- ]
+ "include": ["index.d.ts", "test.ts"],
+ "exclude": ["node_modules"]
}
diff --git a/examples/index.js b/examples/index.js
index 46df2f64935d..bfef1bb6f5a3 100644
--- a/examples/index.js
+++ b/examples/index.js
@@ -1,29 +1,29 @@
/**
-* @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.
-*/
+ * @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';
+"use strict";
-var stdlib = require( './../lib' );
+var stdlib = require("./../lib");
// List sub-namespaces:
-var keys = stdlib.utils.objectKeys( stdlib );
-console.log( keys );
+var keys = stdlib.utils.objectKeys(stdlib);
+console.log(keys);
// Compute the value of sine:
-var y = stdlib.math.base.special.sin( 3.14 );
-console.log( y );
+var y = stdlib.math.base.special.sin(3.14);
+console.log(y);
diff --git a/examples/index.mjs b/examples/index.mjs
index 5b75ef86b3bc..8574da55efcc 100644
--- a/examples/index.mjs
+++ b/examples/index.mjs
@@ -1,29 +1,29 @@
/**
-* @license Apache-2.0
-*
-* Copyright (c) 2021 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.
-*/
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2021 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';
+"use strict";
-import stdlib from './../lib/index.js';
+import stdlib from "./../lib/index.js";
// List sub-namespaces:
-var keys = stdlib.utils.objectKeys( stdlib );
-console.log( keys );
+var keys = stdlib.utils.objectKeys(stdlib);
+console.log(keys);
// Compute the value of sine:
-var y = stdlib.math.base.special.sin( 3.14 );
-console.log( y );
+var y = stdlib.math.base.special.sin(3.14);
+console.log(y);
diff --git a/lib/index.js b/lib/index.js
index 16d6b6e5fef5..0b65e909a847 100644
--- a/lib/index.js
+++ b/lib/index.js
@@ -1,38 +1,37 @@
/**
-* @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.
-*/
+ * @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.
+ */
/* eslint-disable stdlib/jsdoc-main-export */
-'use strict';
+"use strict";
/**
-* Standard library.
-*
-* @module @stdlib/stdlib
-*
-* @example
-* var stdlib = require( '@stdlib/stdlib' );
-*/
+ * Standard library.
+ *
+ * @module @stdlib/stdlib
+ *
+ * @example
+ * var stdlib = require( '@stdlib/stdlib' );
+ */
// MODULES //
-var stdlib = require( './main.js' );
-
+var stdlib = require("./main.js");
// EXPORTS //
diff --git a/lib/main.js b/lib/main.js
index 5dd95f2583de..524c28cc8d7f 100644
--- a/lib/main.js
+++ b/lib/main.js
@@ -1,437 +1,435 @@
/**
-* @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';
+ * @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";
/*
-* When adding modules to the namespace, ensure that they are added in alphabetical order according to module name.
-*/
+ * When adding modules to the namespace, ensure that they are added in alphabetical order according to module name.
+ */
// MODULES //
-var setReadOnly = require( '@stdlib/utils/define-read-only-property' );
-
+var setReadOnly = require("@stdlib/utils/define-read-only-property");
// MAIN //
/**
-* Top-level namespace.
-*
-* @namespace stdlib
-*/
+ * Top-level namespace.
+ *
+ * @namespace stdlib
+ */
var stdlib = {};
/**
-* @name array
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/array}
-*/
-setReadOnly( stdlib, 'array', require( '@stdlib/array' ) );
-
-/**
-* @name assert
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/assert}
-*/
-setReadOnly( stdlib, 'assert', require( '@stdlib/assert' ) );
-
-/**
-* @name bench
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/bench}
-*/
-setReadOnly( stdlib, 'bench', require( '@stdlib/bench' ) );
-
-/**
-* @name bigint
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/bigint}
-*/
-setReadOnly( stdlib, 'bigint', require( '@stdlib/bigint' ) );
-
-/**
-* @name blas
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/blas}
-*/
-setReadOnly( stdlib, 'blas', require( '@stdlib/blas' ) );
-
-/**
-* @name boolean
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/boolean}
-*/
-setReadOnly( stdlib, 'boolean', require( '@stdlib/boolean' ) );
-
-/**
-* @name buffer
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/buffer}
-*/
-setReadOnly( stdlib, 'buffer', require( '@stdlib/buffer' ) );
-
-/**
-* @name cli
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/cli}
-*/
-setReadOnly( stdlib, 'cli', require( '@stdlib/cli' ) );
-
-/**
-* @name complex
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/complex}
-*/
-setReadOnly( stdlib, 'complex', require( '@stdlib/complex' ) );
-
-/**
-* @name console
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/console}
-*/
-setReadOnly( stdlib, 'console', require( '@stdlib/console' ) );
-
-/**
-* @name constants
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/constants}
-*/
-setReadOnly( stdlib, 'constants', require( '@stdlib/constants' ) );
-
-/**
-* @name datasets
-* @memberof stdlib
-* @readonly
-* @type {Function}
-* @see {@link module:@stdlib/datasets}
-*/
-setReadOnly( stdlib, 'datasets', require( '@stdlib/datasets' ) );
-
-/**
-* @name dstructs
-* @memberof stdlib
-* @readonly
-* @type {Function}
-* @see {@link module:@stdlib/dstructs}
-*/
-setReadOnly( stdlib, 'dstructs', require( '@stdlib/dstructs' ) );
-
-/**
-* @name error
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/error}
-*/
-setReadOnly( stdlib, 'error', require( '@stdlib/error' ) );
-
-/**
-* @name fs
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/fs}
-*/
-setReadOnly( stdlib, 'fs', require( '@stdlib/fs' ) );
-
-/**
-* @name function
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/function}
-*/
-setReadOnly( stdlib, 'function', require( '@stdlib/function' ) );
-
-/**
-* @name iter
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/iter}
-*/
-setReadOnly( stdlib, 'iter', require( '@stdlib/iter' ) );
-
-/**
-* @name lapack
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/lapack}
-*/
-setReadOnly( stdlib, 'lapack', require( '@stdlib/lapack' ) );
-
-/**
-* @name math
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/math}
-*/
-setReadOnly( stdlib, 'math', require( '@stdlib/math' ) );
-
-/**
-* @name ml
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/ml}
-*/
-setReadOnly( stdlib, 'ml', require( '@stdlib/ml' ) );
-
-/**
-* @name namespace
-* @memberof stdlib
-* @readonly
-* @type {Function}
-* @see {@link module:@stdlib/namespace}
-*/
-setReadOnly( stdlib, 'namespace', require( '@stdlib/namespace' ) );
-
-/**
-* @name ndarray
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/ndarray}
-*/
-setReadOnly( stdlib, 'ndarray', require( '@stdlib/ndarray' ) );
-
-/**
-* @name net
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/net}
-*/
-setReadOnly( stdlib, 'net', require( '@stdlib/net' ) );
-
-/**
-* @name nlp
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/nlp}
-*/
-setReadOnly( stdlib, 'nlp', require( '@stdlib/nlp' ) );
-
-/**
-* @name number
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/number}
-*/
-setReadOnly( stdlib, 'number', require( '@stdlib/number' ) );
-
-/**
-* @name object
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/object}
-*/
-setReadOnly( stdlib, 'object', require( '@stdlib/object' ) );
-
-/**
-* @name os
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/os}
-*/
-setReadOnly( stdlib, 'os', require( '@stdlib/os' ) );
-
-/**
-* @name plot
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/plot}
-*/
-setReadOnly( stdlib, 'plot', require( '@stdlib/plot' ) );
-
-/**
-* @name process
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/process}
-*/
-setReadOnly( stdlib, 'process', require( '@stdlib/process' ) );
-
-/**
-* @name proxy
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/proxy}
-*/
-setReadOnly( stdlib, 'proxy', require( '@stdlib/proxy' ) );
-
-/**
-* @name random
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/random}
-*/
-setReadOnly( stdlib, 'random', require( '@stdlib/random' ) );
-
-/**
-* @name regexp
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/regexp}
-*/
-setReadOnly( stdlib, 'regexp', require( '@stdlib/regexp' ) );
-
-/**
-* @name repl
-* @memberof stdlib
-* @readonly
-* @type {Function}
-* @see {@link module:@stdlib/repl}
-*/
-setReadOnly( stdlib, 'repl', require( '@stdlib/repl' ) );
-
-/**
-* @name simulate
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/simulate}
-*/
-setReadOnly( stdlib, 'simulate', require( '@stdlib/simulate' ) );
-
-/**
-* @name slice
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/slice}
-*/
-setReadOnly( stdlib, 'slice', require( '@stdlib/slice' ) );
-
-/**
-* @name stats
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/stats}
-*/
-setReadOnly( stdlib, 'stats', require( '@stdlib/stats' ) );
-
-/**
-* @name streams
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/streams}
-*/
-setReadOnly( stdlib, 'streams', require( '@stdlib/streams' ) );
-
-/**
-* @name strided
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/strided}
-*/
-setReadOnly( stdlib, 'strided', require( '@stdlib/strided' ) );
-
-/**
-* @name string
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/string}
-*/
-setReadOnly( stdlib, 'string', require( '@stdlib/string' ) );
-
-/**
-* @name symbol
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/symbol}
-*/
-setReadOnly( stdlib, 'symbol', require( '@stdlib/symbol' ) );
-
-/**
-* @name time
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/time}
-*/
-setReadOnly( stdlib, 'time', require( '@stdlib/time' ) );
-
-/**
-* @name types
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/types}
-*/
-setReadOnly( stdlib, 'types', require( '@stdlib/types' ) );
-
-/**
-* @name utils
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/utils}
-*/
-setReadOnly( stdlib, 'utils', require( '@stdlib/utils' ) );
-
-/**
-* @name wasm
-* @memberof stdlib
-* @readonly
-* @type {Namespace}
-* @see {@link module:@stdlib/wasm}
-*/
-setReadOnly( stdlib, 'wasm', require( '@stdlib/wasm' ) );
-
+ * @name array
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/array}
+ */
+setReadOnly(stdlib, "array", require("@stdlib/array"));
+
+/**
+ * @name assert
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/assert}
+ */
+setReadOnly(stdlib, "assert", require("@stdlib/assert"));
+
+/**
+ * @name bench
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/bench}
+ */
+setReadOnly(stdlib, "bench", require("@stdlib/bench"));
+
+/**
+ * @name bigint
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/bigint}
+ */
+setReadOnly(stdlib, "bigint", require("@stdlib/bigint"));
+
+/**
+ * @name blas
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/blas}
+ */
+setReadOnly(stdlib, "blas", require("@stdlib/blas"));
+
+/**
+ * @name boolean
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/boolean}
+ */
+setReadOnly(stdlib, "boolean", require("@stdlib/boolean"));
+
+/**
+ * @name buffer
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/buffer}
+ */
+setReadOnly(stdlib, "buffer", require("@stdlib/buffer"));
+
+/**
+ * @name cli
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/cli}
+ */
+setReadOnly(stdlib, "cli", require("@stdlib/cli"));
+
+/**
+ * @name complex
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/complex}
+ */
+setReadOnly(stdlib, "complex", require("@stdlib/complex"));
+
+/**
+ * @name console
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/console}
+ */
+setReadOnly(stdlib, "console", require("@stdlib/console"));
+
+/**
+ * @name constants
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/constants}
+ */
+setReadOnly(stdlib, "constants", require("@stdlib/constants"));
+
+/**
+ * @name datasets
+ * @memberof stdlib
+ * @readonly
+ * @type {Function}
+ * @see {@link module:@stdlib/datasets}
+ */
+setReadOnly(stdlib, "datasets", require("@stdlib/datasets"));
+
+/**
+ * @name dstructs
+ * @memberof stdlib
+ * @readonly
+ * @type {Function}
+ * @see {@link module:@stdlib/dstructs}
+ */
+setReadOnly(stdlib, "dstructs", require("@stdlib/dstructs"));
+
+/**
+ * @name error
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/error}
+ */
+setReadOnly(stdlib, "error", require("@stdlib/error"));
+
+/**
+ * @name fs
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/fs}
+ */
+setReadOnly(stdlib, "fs", require("@stdlib/fs"));
+
+/**
+ * @name function
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/function}
+ */
+setReadOnly(stdlib, "function", require("@stdlib/function"));
+
+/**
+ * @name iter
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/iter}
+ */
+setReadOnly(stdlib, "iter", require("@stdlib/iter"));
+
+/**
+ * @name lapack
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/lapack}
+ */
+setReadOnly(stdlib, "lapack", require("@stdlib/lapack"));
+
+/**
+ * @name math
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/math}
+ */
+setReadOnly(stdlib, "math", require("@stdlib/math"));
+
+/**
+ * @name ml
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/ml}
+ */
+setReadOnly(stdlib, "ml", require("@stdlib/ml"));
+
+/**
+ * @name namespace
+ * @memberof stdlib
+ * @readonly
+ * @type {Function}
+ * @see {@link module:@stdlib/namespace}
+ */
+setReadOnly(stdlib, "namespace", require("@stdlib/namespace"));
+
+/**
+ * @name ndarray
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/ndarray}
+ */
+setReadOnly(stdlib, "ndarray", require("@stdlib/ndarray"));
+
+/**
+ * @name net
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/net}
+ */
+setReadOnly(stdlib, "net", require("@stdlib/net"));
+
+/**
+ * @name nlp
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/nlp}
+ */
+setReadOnly(stdlib, "nlp", require("@stdlib/nlp"));
+
+/**
+ * @name number
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/number}
+ */
+setReadOnly(stdlib, "number", require("@stdlib/number"));
+
+/**
+ * @name object
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/object}
+ */
+setReadOnly(stdlib, "object", require("@stdlib/object"));
+
+/**
+ * @name os
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/os}
+ */
+setReadOnly(stdlib, "os", require("@stdlib/os"));
+
+/**
+ * @name plot
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/plot}
+ */
+setReadOnly(stdlib, "plot", require("@stdlib/plot"));
+
+/**
+ * @name process
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/process}
+ */
+setReadOnly(stdlib, "process", require("@stdlib/process"));
+
+/**
+ * @name proxy
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/proxy}
+ */
+setReadOnly(stdlib, "proxy", require("@stdlib/proxy"));
+
+/**
+ * @name random
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/random}
+ */
+setReadOnly(stdlib, "random", require("@stdlib/random"));
+
+/**
+ * @name regexp
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/regexp}
+ */
+setReadOnly(stdlib, "regexp", require("@stdlib/regexp"));
+
+/**
+ * @name repl
+ * @memberof stdlib
+ * @readonly
+ * @type {Function}
+ * @see {@link module:@stdlib/repl}
+ */
+setReadOnly(stdlib, "repl", require("@stdlib/repl"));
+
+/**
+ * @name simulate
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/simulate}
+ */
+setReadOnly(stdlib, "simulate", require("@stdlib/simulate"));
+
+/**
+ * @name slice
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/slice}
+ */
+setReadOnly(stdlib, "slice", require("@stdlib/slice"));
+
+/**
+ * @name stats
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/stats}
+ */
+setReadOnly(stdlib, "stats", require("@stdlib/stats"));
+
+/**
+ * @name streams
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/streams}
+ */
+setReadOnly(stdlib, "streams", require("@stdlib/streams"));
+
+/**
+ * @name strided
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/strided}
+ */
+setReadOnly(stdlib, "strided", require("@stdlib/strided"));
+
+/**
+ * @name string
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/string}
+ */
+setReadOnly(stdlib, "string", require("@stdlib/string"));
+
+/**
+ * @name symbol
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/symbol}
+ */
+setReadOnly(stdlib, "symbol", require("@stdlib/symbol"));
+
+/**
+ * @name time
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/time}
+ */
+setReadOnly(stdlib, "time", require("@stdlib/time"));
+
+/**
+ * @name types
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/types}
+ */
+setReadOnly(stdlib, "types", require("@stdlib/types"));
+
+/**
+ * @name utils
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/utils}
+ */
+setReadOnly(stdlib, "utils", require("@stdlib/utils"));
+
+/**
+ * @name wasm
+ * @memberof stdlib
+ * @readonly
+ * @type {Namespace}
+ * @see {@link module:@stdlib/wasm}
+ */
+setReadOnly(stdlib, "wasm", require("@stdlib/wasm"));
// EXPORTS //
diff --git a/lib/node_modules/@stdlib/stats/base/dists/cauchy/cdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/cauchy/cdf/README.md
index 0aac4fe50b7a..8dc0b0598c5b 100644
--- a/lib/node_modules/@stdlib/stats/base/dists/cauchy/cdf/README.md
+++ b/lib/node_modules/@stdlib/stats/base/dists/cauchy/cdf/README.md
@@ -171,7 +171,7 @@ Evaluates the [cumulative distribution function][cdf] (CDF) for a [Cauchy][cauch
```c
double out = stdlib_base_dists_cauchy_cdf( 0.5, 0.0, 2.0 );
-// returns ~0.333
+// returns ~0.578
```
The function accepts the following arguments:
@@ -214,8 +214,8 @@ static double random_uniform( const double min, const double max ) {
int main( void ) {
double gamma;
- double x;
double x0;
+ double x;
double y;
int i;
diff --git a/lib/node_modules/@stdlib/stats/base/dists/cauchy/cdf/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/cauchy/cdf/benchmark/benchmark.native.js
index c1aa56e0f595..ca79c0e8c6cb 100644
--- a/lib/node_modules/@stdlib/stats/base/dists/cauchy/cdf/benchmark/benchmark.native.js
+++ b/lib/node_modules/@stdlib/stats/base/dists/cauchy/cdf/benchmark/benchmark.native.js
@@ -31,10 +31,9 @@ var pkg = require( './../package.json' ).name;
// VARIABLES //
-
-var logcdf = tryRequire( resolve( __dirname, './../lib/native.js' ) );
+var cdf = tryRequire( resolve( __dirname, './../lib/native.js' ) );
var opts = {
- 'skip': ( logcdf instanceof Error )
+ 'skip': ( cdf instanceof Error )
};
@@ -60,7 +59,7 @@ bench( pkg+'::native', opts, function benchmark( b ) {
b.tic();
for ( i = 0; i < b.iterations; i++ ) {
- y = logcdf( x[ i % len ], x0[ i % len ], gamma[ i % len ] );
+ y = cdf( x[ i % len ], x0[ i % len ], gamma[ i % len ] );
if ( isnan( y ) ) {
b.fail( 'should not return NaN' );
}
diff --git a/lib/node_modules/@stdlib/stats/base/dists/cauchy/cdf/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/cauchy/cdf/examples/c/example.c
index 00b444b64f4d..b4dd33fadd0f 100644
--- a/lib/node_modules/@stdlib/stats/base/dists/cauchy/cdf/examples/c/example.c
+++ b/lib/node_modules/@stdlib/stats/base/dists/cauchy/cdf/examples/c/example.c
@@ -27,11 +27,12 @@ static double random_uniform( const double min, const double max ) {
int main( void ) {
double gamma;
- double x;
double x0;
double y;
+ double x;
int i;
+
for ( i = 0; i < 25; i++ ) {
x = random_uniform( 0.0, 10.0 );
x0 = random_uniform( 0.0, 10.0 );
diff --git a/lib/node_modules/@stdlib/stats/base/dists/cauchy/cdf/include/stdlib/stats/base/dists/cauchy/cdf.h b/lib/node_modules/@stdlib/stats/base/dists/cauchy/cdf/include/stdlib/stats/base/dists/cauchy/cdf.h
index 2f08f01d4e74..1e6273b4cbdc 100644
--- a/lib/node_modules/@stdlib/stats/base/dists/cauchy/cdf/include/stdlib/stats/base/dists/cauchy/cdf.h
+++ b/lib/node_modules/@stdlib/stats/base/dists/cauchy/cdf/include/stdlib/stats/base/dists/cauchy/cdf.h
@@ -27,7 +27,7 @@ extern "C" {
#endif
/**
-* Evaluates the cumulative distribution function (CDF) for a Weibull distribution with shape parameter `k` and scale parameter `lambda` at a value `x`.
+* Evaluates the cumulative distribution function (CDF) for a Cauchy distribution with location parameter `x0` and scale parameter `gamma` at a value `x`.
*/
double stdlib_base_dists_cauchy_cdf( const double x, const double x0, const double gamma );
diff --git a/test/test.cli.js b/test/test.cli.js
index 8ff5c7c71074..37e65d010fd6 100644
--- a/test/test.cli.js
+++ b/test/test.cli.js
@@ -1,186 +1,191 @@
/**
-* @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.
-*/
+ * @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.
+ */
/* eslint-disable no-restricted-syntax */
-'use strict';
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var exec = require( 'child_process' ).exec;
-var tape = require( 'tape' );
-var IS_BROWSER = require( '@stdlib/assert/is-browser' );
-var IS_WINDOWS = require( '@stdlib/assert/is-windows' );
-var readFileSync = require( '@stdlib/fs/read-file' ).sync;
-var CLI_COMMANDS = require( './../bin/cli_commands.json' );
-
+var resolve = require("path").resolve;
+var exec = require("child_process").exec;
+var tape = require("tape");
+var IS_BROWSER = require("@stdlib/assert/is-browser");
+var IS_WINDOWS = require("@stdlib/assert/is-windows");
+var readFileSync = require("@stdlib/fs/read-file").sync;
+var CLI_COMMANDS = require("./../bin/cli_commands.json");
// VARIABLES //
-var fpath = resolve( __dirname, '..', 'bin', 'cli' );
+var fpath = resolve(__dirname, "..", "bin", "cli");
var opts = {
- 'skip': IS_BROWSER || IS_WINDOWS
+ skip: IS_BROWSER || IS_WINDOWS,
};
-
// FIXTURES //
-var PKG_VERSION = require( './../package.json' ).version;
-
+var PKG_VERSION = require("./../package.json").version;
// TESTS //
-tape( 'command-line interface', function test( t ) {
- t.ok( true, __filename );
+tape("command-line interface", function test(t) {
+ t.ok(true, __filename);
t.end();
});
-tape( 'when invoked with a `--help` flag, the command-line interface prints the help text to `stderr`', opts, function test( t ) {
- var expected;
- var cmd;
-
- expected = readFileSync( resolve( __dirname, '..', 'bin', 'usage.txt' ), {
- 'encoding': 'utf8'
- });
- cmd = [
- process.execPath,
- fpath,
- '--help'
- ];
-
- exec( cmd.join( ' ' ), done );
-
- function done( error, stdout, stderr ) {
- if ( error ) {
- t.fail( error.message );
- } else {
- t.strictEqual( stdout.toString(), '', 'does not print to `stdout`' );
- t.strictEqual( stderr.toString(), expected+'\n', 'expected value' );
- }
- t.end();
- }
-});
+tape(
+ "when invoked with a `--help` flag, the command-line interface prints the help text to `stderr`",
+ opts,
+ function test(t) {
+ var expected;
+ var cmd;
-tape( 'when invoked with a `-h` flag, the command-line interface prints the help text to `stderr`', opts, function test( t ) {
- var expected;
- var cmd;
-
- expected = readFileSync( resolve( __dirname, '..', 'bin', 'usage.txt' ), {
- 'encoding': 'utf8'
- });
- cmd = [
- process.execPath,
- fpath,
- '-h'
- ];
-
- exec( cmd.join( ' ' ), done );
-
- function done( error, stdout, stderr ) {
- if ( error ) {
- t.fail( error.message );
- } else {
- t.strictEqual( stdout.toString(), '', 'does not print to `stdout`' );
- t.strictEqual( stderr.toString(), expected+'\n', 'expected value' );
+ expected = readFileSync(resolve(__dirname, "..", "bin", "usage.txt"), {
+ encoding: "utf8",
+ });
+ cmd = [process.execPath, fpath, "--help"];
+
+ exec(cmd.join(" "), done);
+
+ function done(error, stdout, stderr) {
+ if (error) {
+ t.fail(error.message);
+ } else {
+ t.strictEqual(stdout.toString(), "", "does not print to `stdout`");
+ t.strictEqual(stderr.toString(), expected + "\n", "expected value");
+ }
+ t.end();
}
- t.end();
- }
-});
+ },
+);
+
+tape(
+ "when invoked with a `-h` flag, the command-line interface prints the help text to `stderr`",
+ opts,
+ function test(t) {
+ var expected;
+ var cmd;
-tape( 'when invoked with a `--version` flag, the command-line interface prints the version to `stderr`', opts, function test( t ) {
- var cmd = [
- process.execPath,
- fpath,
- '--version'
- ];
-
- exec( cmd.join( ' ' ), done );
-
- function done( error, stdout, stderr ) {
- if ( error ) {
- t.fail( error.message );
- } else {
- t.strictEqual( stdout.toString(), '', 'does not print to `stdout`' );
- t.strictEqual( stderr.toString(), PKG_VERSION+'\n', 'expected value' );
+ expected = readFileSync(resolve(__dirname, "..", "bin", "usage.txt"), {
+ encoding: "utf8",
+ });
+ cmd = [process.execPath, fpath, "-h"];
+
+ exec(cmd.join(" "), done);
+
+ function done(error, stdout, stderr) {
+ if (error) {
+ t.fail(error.message);
+ } else {
+ t.strictEqual(stdout.toString(), "", "does not print to `stdout`");
+ t.strictEqual(stderr.toString(), expected + "\n", "expected value");
+ }
+ t.end();
}
- t.end();
- }
-});
-
-tape( 'when invoked with a `-V` flag, the command-line interface prints the version to `stderr`', opts, function test( t ) {
- var cmd = [
- process.execPath,
- fpath,
- '-V'
- ];
-
- exec( cmd.join( ' ' ), done );
-
- function done( error, stdout, stderr ) {
- if ( error ) {
- t.fail( error.message );
- } else {
- t.strictEqual( stdout.toString(), '', 'does not print to `stdout`' );
- t.strictEqual( stderr.toString(), PKG_VERSION+'\n', 'expected value' );
+ },
+);
+
+tape(
+ "when invoked with a `--version` flag, the command-line interface prints the version to `stderr`",
+ opts,
+ function test(t) {
+ var cmd = [process.execPath, fpath, "--version"];
+
+ exec(cmd.join(" "), done);
+
+ function done(error, stdout, stderr) {
+ if (error) {
+ t.fail(error.message);
+ } else {
+ t.strictEqual(stdout.toString(), "", "does not print to `stdout`");
+ t.strictEqual(stderr.toString(), PKG_VERSION + "\n", "expected value");
+ }
+ t.end();
}
- t.end();
- }
-});
+ },
+);
+
+tape(
+ "when invoked with a `-V` flag, the command-line interface prints the version to `stderr`",
+ opts,
+ function test(t) {
+ var cmd = [process.execPath, fpath, "-V"];
+
+ exec(cmd.join(" "), done);
+
+ function done(error, stdout, stderr) {
+ if (error) {
+ t.fail(error.message);
+ } else {
+ t.strictEqual(stdout.toString(), "", "does not print to `stdout`");
+ t.strictEqual(stderr.toString(), PKG_VERSION + "\n", "expected value");
+ }
+ t.end();
+ }
+ },
+);
-tape( 'the command-line interface prints the help text for individual commands to `stderr`', opts, function test( t ) {
- var command;
- var idx;
+tape(
+ "the command-line interface prints the help text for individual commands to `stderr`",
+ opts,
+ function test(t) {
+ var command;
+ var idx;
- idx = 0;
- next();
+ idx = 0;
+ next();
- function next() {
- var cmd;
+ function next() {
+ var cmd;
- command = CLI_COMMANDS[ idx ].command;
+ command = CLI_COMMANDS[idx].command;
- // Handle special case...
- if ( command === 'help [command]' ) {
- command = 'help';
- } else {
- command = 'help '+command;
- }
- cmd = [
- process.execPath,
- fpath,
- command
- ];
-
- exec( cmd.join( ' ' ), done );
- }
-
- function done( error, stdout, stderr ) {
- if ( error ) {
- t.fail( error.message );
- } else {
- t.strictEqual( stdout.toString(), '', '`'+command+'` does not print to `stdout`' );
- t.strictEqual( stderr.toString().length > 0, true, '`'+command+'` prints to `stderr`' );
+ // Handle special case...
+ if (command === "help [command]") {
+ command = "help";
+ } else {
+ command = "help " + command;
+ }
+ cmd = [process.execPath, fpath, command];
+
+ exec(cmd.join(" "), done);
}
- idx += 1;
- if ( idx < CLI_COMMANDS.length ) {
- return next();
+
+ function done(error, stdout, stderr) {
+ if (error) {
+ t.fail(error.message);
+ } else {
+ t.strictEqual(
+ stdout.toString(),
+ "",
+ "`" + command + "` does not print to `stdout`",
+ );
+ t.strictEqual(
+ stderr.toString().length > 0,
+ true,
+ "`" + command + "` prints to `stderr`",
+ );
+ }
+ idx += 1;
+ if (idx < CLI_COMMANDS.length) {
+ return next();
+ }
+ t.end();
}
- t.end();
- }
-});
+ },
+);
diff --git a/test/test.js b/test/test.js
index 1a8f5b5fc44d..b27a7a0560da 100644
--- a/test/test.js
+++ b/test/test.js
@@ -1,36 +1,35 @@
/**
-* @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.
-*/
+ * @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.
+ */
/* eslint-disable no-restricted-syntax */
-'use strict';
+"use strict";
// MODULES //
-var tape = require( 'tape' );
-var stdlib = require( './../lib' );
-
+var tape = require("tape");
+var stdlib = require("./../lib");
// TESTS //
-tape( 'main export is an object', function test( t ) {
- t.ok( true, __filename );
- t.equal( typeof stdlib, 'object', 'main export is an object' );
+tape("main export is an object", function test(t) {
+ t.ok(true, __filename);
+ t.equal(typeof stdlib, "object", "main export is an object");
t.end();
});
diff --git a/tools/ci/travis/node_npm_compatibility b/tools/ci/travis/node_npm_compatibility
index 077e33fbeab7..786ba643074c 100755
--- a/tools/ci/travis/node_npm_compatibility
+++ b/tools/ci/travis/node_npm_compatibility
@@ -1,63 +1,61 @@
#!/usr/bin/env node
/**
-* @license Apache-2.0
-*
-* Copyright (c) 2017 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.
-*/
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2017 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.
+ */
/*
-* Script to determine a compatible npm version range based on the current Node.js runtime.
-*
-* - Older versions of Node (>=0.10.0 <= 0.12.x) require an updated npm client to handle scoped packages, but should not use npm versions `>=4.0.0`, as more recent npm versions drop explicit backward compatibility support.
-* - Older versions of Node (<=5.x) do not have full ES2015/ES6 support.
-*/
-'use strict';
+ * Script to determine a compatible npm version range based on the current Node.js runtime.
+ *
+ * - Older versions of Node (>=0.10.0 <= 0.12.x) require an updated npm client to handle scoped packages, but should not use npm versions `>=4.0.0`, as more recent npm versions drop explicit backward compatibility support.
+ * - Older versions of Node (<=5.x) do not have full ES2015/ES6 support.
+ */
+"use strict";
// VARIABLES //
var NODE_VERSION = process.versions.node;
-
// FUNCTIONS //
/**
-* Returns a compatible npm version range based on the current Node.js runtime.
-*
-* @private
-* @returns {string} npm version range
-*/
+ * Returns a compatible npm version range based on the current Node.js runtime.
+ *
+ * @private
+ * @returns {string} npm version range
+ */
function version() {
- var major;
- var parts;
-
- parts = NODE_VERSION.split( '.' );
- major = parseInt( parts[ 0 ], 10 );
- if ( major <= 3 ) {
- return '>2.7.0 <4.0.0';
- }
- if ( major <= 5 ) {
- return '>2.7.0 <6.0.0';
- }
- if ( major <= 10 ) {
- return '>2.7.0 <7.0.0';
- }
- return '>2.7.0';
+ var major;
+ var parts;
+
+ parts = NODE_VERSION.split(".");
+ major = parseInt(parts[0], 10);
+ if (major <= 3) {
+ return ">2.7.0 <4.0.0";
+ }
+ if (major <= 5) {
+ return ">2.7.0 <6.0.0";
+ }
+ if (major <= 10) {
+ return ">2.7.0 <7.0.0";
+ }
+ return ">2.7.0";
}
-
// MAIN //
-console.log( version() ); // eslint-disable-line no-console
+console.log(version()); // eslint-disable-line no-console
diff --git a/tools/dev.md b/tools/dev.md
index 10bd4f726a00..c9b9b5b722c4 100644
--- a/tools/dev.md
+++ b/tools/dev.md
@@ -42,7 +42,7 @@ To package as a command-line tool, add the following to the platform-specific co
```bash
tab() {
- echo -n -e "\033]0;$*\007"
+ echo -n -e "\033]0;$*\007"
}
```
@@ -64,10 +64,10 @@ $ ls -R ./root/directory | grep ":$" | sed -e 's/:$//' -e 's/[^-][^\/]*\//--/g'
where
-- `-R`: recursively list subdirectories.
-- `s/[^-][^\/]*\//--/g`: replace directory path segments with `--`.
-- `s/^/ /`: indent.
-- `s/--/|/`: replace the first `--` with a vertical bar.
+- `-R`: recursively list subdirectories.
+- `s/[^-][^\/]*\//--/g`: replace directory path segments with `--`.
+- `s/^/ /`: indent.
+- `s/--/|/`: replace the first `--` with a vertical bar.
### git
@@ -95,7 +95,7 @@ where `-F` indicates to search for a fixed string. To search using a regular exp
#### Exclusion
-To exclude paths when using `find`, use membership inversion
+To exclude paths when using `find`, use membership inversion
```bash
$ find -type f -name foo.txt -regextype posix-extended -regex '.*/foo/([^b]+|(b([^a]|$)|ba([^r]|$)))+/.*'
@@ -113,10 +113,10 @@ $ perl -pi -w -e 's/search/replace/g;' $(find ./search/directory -type f)
where
-- `-e`: execute the command
-- `-w`: write warnings
-- `-p`: execute for each file
-- `-i`: edit in-place
+- `-e`: execute the command
+- `-w`: write warnings
+- `-p`: execute for each file
+- `-i`: edit in-place
If you encounter an error due to too many arguments, use `xargs`.
@@ -132,8 +132,8 @@ $ find "$PWD" -type f '!' -path "$PWD/.*" '!' -path "$PWD/deps/*" '!' -path "$PW
A few comments:
-- For simple cases, [`sed`][sed-find-and-replace] may be faster.
-- Be **very** careful when performing a multi-file find and in-place replace. Perform dry-runs and confirm expected results on a small file subset **before** performing on many files. You have been **warned**.
+- For simple cases, [`sed`][sed-find-and-replace] may be faster.
+- Be **very** careful when performing a multi-file find and in-place replace. Perform dry-runs and confirm expected results on a small file subset **before** performing on many files. You have been **warned**.
### Reorganization
@@ -160,7 +160,6 @@ $ find $PWD/path/to/parent/directory -type d -depth 1 -regex ".*" | while read -
<section class="links">
[sed-find-and-replace]: http://stackoverflow.com/questions/11392478/how-to-replace-a-string-in-multiple-files-in-linux-command-line
-
[bash-profile]: http://tldp.org/LDP/Bash-Beginners-Guide/html/sect_03_01.html
</section>
diff --git a/tools/docs/jsdoc/templates/html/publish.js b/tools/docs/jsdoc/templates/html/publish.js
index 397718f3ca08..7d7b78221c63 100644
--- a/tools/docs/jsdoc/templates/html/publish.js
+++ b/tools/docs/jsdoc/templates/html/publish.js
@@ -1,14 +1,14 @@
-'use strict';
-
-var doop = require('jsdoc/util/doop');
-var env = require('jsdoc/env');
-var fs = require('jsdoc/fs');
-var helper = require('jsdoc/util/templateHelper');
-var logger = require('jsdoc/util/logger');
-var path = require('jsdoc/path');
-var taffy = require('taffydb').taffy;
-var template = require('jsdoc/template');
-var util = require('util');
+"use strict";
+
+var doop = require("jsdoc/util/doop");
+var env = require("jsdoc/env");
+var fs = require("jsdoc/fs");
+var helper = require("jsdoc/util/templateHelper");
+var logger = require("jsdoc/util/logger");
+var path = require("jsdoc/path");
+var taffy = require("taffydb").taffy;
+var template = require("jsdoc/template");
+var util = require("util");
var htmlsafe = helper.htmlsafe;
var linkto = helper.linkto;
@@ -22,230 +22,269 @@ var view;
var outdir = path.normalize(env.opts.destination);
function find(spec) {
- return helper.find(data, spec);
+ return helper.find(data, spec);
}
function tutoriallink(tutorial) {
- return helper.toTutorial(tutorial, null, { tag: 'em', classname: 'disabled', prefix: 'Tutorial: ' });
+ return helper.toTutorial(tutorial, null, {
+ tag: "em",
+ classname: "disabled",
+ prefix: "Tutorial: ",
+ });
}
function getAncestorLinks(doclet) {
- return helper.getAncestorLinks(data, doclet);
+ return helper.getAncestorLinks(data, doclet);
}
function hashToLink(doclet, hash) {
- if ( !/^(#.+)/.test(hash) ) { return hash; }
+ if (!/^(#.+)/.test(hash)) {
+ return hash;
+ }
- var url = helper.createLink(doclet);
+ var url = helper.createLink(doclet);
- url = url.replace(/(#.+|$)/, hash);
- return '<a href="' + url + '">' + hash + '</a>';
+ url = url.replace(/(#.+|$)/, hash);
+ return '<a href="' + url + '">' + hash + "</a>";
}
function needsSignature(doclet) {
- var needsSig = false;
-
- // function and class definitions always get a signature
- if (doclet.kind === 'function' || doclet.kind === 'class') {
- needsSig = true;
- }
- // typedefs that contain functions get a signature, too
- else if (doclet.kind === 'typedef' && doclet.type && doclet.type.names &&
- doclet.type.names.length) {
- for (var i = 0, l = doclet.type.names.length; i < l; i++) {
- if (doclet.type.names[i].toLowerCase() === 'function') {
- needsSig = true;
- break;
- }
- }
- }
-
- return needsSig;
+ var needsSig = false;
+
+ // function and class definitions always get a signature
+ if (doclet.kind === "function" || doclet.kind === "class") {
+ needsSig = true;
+ }
+ // typedefs that contain functions get a signature, too
+ else if (
+ doclet.kind === "typedef" &&
+ doclet.type &&
+ doclet.type.names &&
+ doclet.type.names.length
+ ) {
+ for (var i = 0, l = doclet.type.names.length; i < l; i++) {
+ if (doclet.type.names[i].toLowerCase() === "function") {
+ needsSig = true;
+ break;
+ }
+ }
+ }
+
+ return needsSig;
}
function getSignatureAttributes(item) {
- var attributes = [];
+ var attributes = [];
- if (item.optional) {
- attributes.push('opt');
- }
+ if (item.optional) {
+ attributes.push("opt");
+ }
- if (item.nullable === true) {
- attributes.push('nullable');
- }
- else if (item.nullable === false) {
- attributes.push('non-null');
- }
+ if (item.nullable === true) {
+ attributes.push("nullable");
+ } else if (item.nullable === false) {
+ attributes.push("non-null");
+ }
- return attributes;
+ return attributes;
}
function updateItemName(item) {
- var attributes = getSignatureAttributes(item);
- var itemName = item.name || '';
-
- if (item.variable) {
- itemName = '…' + itemName;
- }
-
- if (attributes && attributes.length) {
- itemName = util.format( '%s<span class="signature-attributes">%s</span>', itemName,
- attributes.join(', ') );
- }
-
- return itemName;
+ var attributes = getSignatureAttributes(item);
+ var itemName = item.name || "";
+
+ if (item.variable) {
+ itemName = "…" + itemName;
+ }
+
+ if (attributes && attributes.length) {
+ itemName = util.format(
+ '%s<span class="signature-attributes">%s</span>',
+ itemName,
+ attributes.join(", "),
+ );
+ }
+
+ return itemName;
}
function addParamAttributes(params) {
- return params.filter(function(param) {
- return param.name && param.name.indexOf('.') === -1;
- }).map(updateItemName);
+ return params
+ .filter(function (param) {
+ return param.name && param.name.indexOf(".") === -1;
+ })
+ .map(updateItemName);
}
function buildItemTypeStrings(item) {
- var types = [];
+ var types = [];
- if (item && item.type && item.type.names) {
- item.type.names.forEach(function(name) {
- types.push( linkto(name, htmlsafe(name)) );
- });
- }
+ if (item && item.type && item.type.names) {
+ item.type.names.forEach(function (name) {
+ types.push(linkto(name, htmlsafe(name)));
+ });
+ }
- return types;
+ return types;
}
function buildAttribsString(attribs) {
- var attribsString = '';
+ var attribsString = "";
- if (attribs && attribs.length) {
- attribsString = htmlsafe( util.format('(%s) ', attribs.join(', ')) );
- }
+ if (attribs && attribs.length) {
+ attribsString = htmlsafe(util.format("(%s) ", attribs.join(", ")));
+ }
- return attribsString;
+ return attribsString;
}
function addNonParamAttributes(items) {
- var types = [];
+ var types = [];
- items.forEach(function(item) {
- types = types.concat( buildItemTypeStrings(item) );
- });
+ items.forEach(function (item) {
+ types = types.concat(buildItemTypeStrings(item));
+ });
- return types;
+ return types;
}
function addSignatureParams(f) {
- var params = f.params ? addParamAttributes(f.params) : [];
+ var params = f.params ? addParamAttributes(f.params) : [];
- f.signature = util.format( '%s(%s)', (f.signature || ''), params.join(', ') );
+ f.signature = util.format("%s(%s)", f.signature || "", params.join(", "));
}
function addSignatureReturns(f) {
- var attribs = [];
- var attribsString = '';
- var returnTypes = [];
- var returnTypesString = '';
-
- // jam all the return-type attributes into an array. this could create odd results (for example,
- // if there are both nullable and non-nullable return types), but let's assume that most people
- // who use multiple @return tags aren't using Closure Compiler type annotations, and vice-versa.
- if (f.returns) {
- f.returns.forEach(function(item) {
- helper.getAttribs(item).forEach(function(attrib) {
- if (attribs.indexOf(attrib) === -1) {
- attribs.push(attrib);
- }
- });
- });
-
- attribsString = buildAttribsString(attribs);
- }
-
- if (f.returns) {
- returnTypes = addNonParamAttributes(f.returns);
- }
- if (returnTypes.length) {
- returnTypesString = util.format( ' → %s{%s}', attribsString, returnTypes.join('|') );
- }
-
- f.signature = '<span class="signature">' + (f.signature || '') + '</span>' +
- '<span class="type-signature">' + returnTypesString + '</span>';
+ var attribs = [];
+ var attribsString = "";
+ var returnTypes = [];
+ var returnTypesString = "";
+
+ // jam all the return-type attributes into an array. this could create odd results (for example,
+ // if there are both nullable and non-nullable return types), but let's assume that most people
+ // who use multiple @return tags aren't using Closure Compiler type annotations, and vice-versa.
+ if (f.returns) {
+ f.returns.forEach(function (item) {
+ helper.getAttribs(item).forEach(function (attrib) {
+ if (attribs.indexOf(attrib) === -1) {
+ attribs.push(attrib);
+ }
+ });
+ });
+
+ attribsString = buildAttribsString(attribs);
+ }
+
+ if (f.returns) {
+ returnTypes = addNonParamAttributes(f.returns);
+ }
+ if (returnTypes.length) {
+ returnTypesString = util.format(
+ " → %s{%s}",
+ attribsString,
+ returnTypes.join("|"),
+ );
+ }
+
+ f.signature =
+ '<span class="signature">' +
+ (f.signature || "") +
+ "</span>" +
+ '<span class="type-signature">' +
+ returnTypesString +
+ "</span>";
}
function addSignatureTypes(f) {
- var types = f.type ? buildItemTypeStrings(f) : [];
+ var types = f.type ? buildItemTypeStrings(f) : [];
- f.signature = (f.signature || '') + '<span class="type-signature">' +
- (types.length ? ' :' + types.join('|') : '') + '</span>';
+ f.signature =
+ (f.signature || "") +
+ '<span class="type-signature">' +
+ (types.length ? " :" + types.join("|") : "") +
+ "</span>";
}
function addAttribs(f) {
- var attribs = helper.getAttribs(f);
- var attribsString = buildAttribsString(attribs);
+ var attribs = helper.getAttribs(f);
+ var attribsString = buildAttribsString(attribs);
- f.attribs = util.format('<span class="type-signature">%s</span>', attribsString);
+ f.attribs = util.format(
+ '<span class="type-signature">%s</span>',
+ attribsString,
+ );
}
function shortenPaths(files, commonPrefix) {
- Object.keys(files).forEach(function(file) {
- files[file].shortened = files[file].resolved.replace(commonPrefix, '')
- // always use forward slashes
- .replace(/\\/g, '/');
- });
-
- return files;
+ Object.keys(files).forEach(function (file) {
+ files[file].shortened = files[file].resolved
+ .replace(commonPrefix, "")
+ // always use forward slashes
+ .replace(/\\/g, "/");
+ });
+
+ return files;
}
function getPathFromDoclet(doclet) {
- if (!doclet.meta) {
- return null;
- }
+ if (!doclet.meta) {
+ return null;
+ }
- return doclet.meta.path && doclet.meta.path !== 'null' ?
- path.join(doclet.meta.path, doclet.meta.filename) :
- doclet.meta.filename;
+ return doclet.meta.path && doclet.meta.path !== "null"
+ ? path.join(doclet.meta.path, doclet.meta.filename)
+ : doclet.meta.filename;
}
function generate(title, docs, filename, resolveLinks) {
- resolveLinks = resolveLinks === false ? false : true;
+ resolveLinks = resolveLinks === false ? false : true;
- var docData = {
- env: env,
- title: title,
- docs: docs
- };
+ var docData = {
+ env: env,
+ title: title,
+ docs: docs,
+ };
- var outpath = path.join(outdir, filename),
- html = view.render('container.tmpl', docData);
+ var outpath = path.join(outdir, filename),
+ html = view.render("container.tmpl", docData);
- if (resolveLinks) {
- html = helper.resolveLinks(html); // turn {@link foo} into <a href="foodoc.html">foo</a>
- }
+ if (resolveLinks) {
+ html = helper.resolveLinks(html); // turn {@link foo} into <a href="foodoc.html">foo</a>
+ }
- fs.writeFileSync(outpath, html, 'utf8');
+ fs.writeFileSync(outpath, html, "utf8");
}
function generateSourceFiles(sourceFiles, encoding) {
- encoding = encoding || 'utf8';
- Object.keys(sourceFiles).forEach(function(file) {
- var source;
- // links are keyed to the shortened path in each doclet's `meta.shortpath` property
- var sourceOutfile = helper.getUniqueFilename(sourceFiles[file].shortened);
- helper.registerLink(sourceFiles[file].shortened, sourceOutfile);
-
- try {
- source = {
- kind: 'source',
- code: helper.htmlsafe( fs.readFileSync(sourceFiles[file].resolved, encoding) )
- };
- }
- catch(e) {
- logger.error('Error while generating source file %s: %s', file, e.message);
- }
-
- generate('Source: ' + sourceFiles[file].shortened, [source], sourceOutfile,
- false);
- });
+ encoding = encoding || "utf8";
+ Object.keys(sourceFiles).forEach(function (file) {
+ var source;
+ // links are keyed to the shortened path in each doclet's `meta.shortpath` property
+ var sourceOutfile = helper.getUniqueFilename(sourceFiles[file].shortened);
+ helper.registerLink(sourceFiles[file].shortened, sourceOutfile);
+
+ try {
+ source = {
+ kind: "source",
+ code: helper.htmlsafe(
+ fs.readFileSync(sourceFiles[file].resolved, encoding),
+ ),
+ };
+ } catch (e) {
+ logger.error(
+ "Error while generating source file %s: %s",
+ file,
+ e.message,
+ );
+ }
+
+ generate(
+ "Source: " + sourceFiles[file].shortened,
+ [source],
+ sourceOutfile,
+ false,
+ );
+ });
}
/**
@@ -260,72 +299,77 @@ function generateSourceFiles(sourceFiles, encoding) {
* @param {Array.<module:jsdoc/doclet.Doclet>} modules - The array of module doclets to search.
*/
function attachModuleSymbols(doclets, modules) {
- var symbols = {};
-
- // build a lookup table
- doclets.forEach(function(symbol) {
- symbols[symbol.longname] = symbols[symbol.longname] || [];
- symbols[symbol.longname].push(symbol);
- });
-
- return modules.map(function(module) {
- if (symbols[module.longname]) {
- module.modules = symbols[module.longname]
- // Only show symbols that have a description. Make an exception for classes, because
- // we want to show the constructor-signature heading no matter what.
- .filter(function(symbol) {
- return symbol.description || symbol.kind === 'class';
- })
- .map(function(symbol) {
- symbol = doop(symbol);
-
- if (symbol.kind === 'class' || symbol.kind === 'function') {
- symbol.name = symbol.name.replace('module:', '(require("') + '"))';
- }
-
- return symbol;
- });
- }
- });
+ var symbols = {};
+
+ // build a lookup table
+ doclets.forEach(function (symbol) {
+ symbols[symbol.longname] = symbols[symbol.longname] || [];
+ symbols[symbol.longname].push(symbol);
+ });
+
+ return modules.map(function (module) {
+ if (symbols[module.longname]) {
+ module.modules = symbols[module.longname]
+ // Only show symbols that have a description. Make an exception for classes, because
+ // we want to show the constructor-signature heading no matter what.
+ .filter(function (symbol) {
+ return symbol.description || symbol.kind === "class";
+ })
+ .map(function (symbol) {
+ symbol = doop(symbol);
+
+ if (symbol.kind === "class" || symbol.kind === "function") {
+ symbol.name = symbol.name.replace("module:", '(require("') + '"))';
+ }
+
+ return symbol;
+ });
+ }
+ });
}
function buildMemberNav(items, itemHeading, itemsSeen, linktoFn) {
- var nav = '';
-
- if (items.length) {
- var itemsNav = '';
-
- items.forEach(function(item) {
- if ( !hasOwnProp.call(item, 'longname') ) {
- itemsNav += '<li>' + linktoFn('', item.name) + '</li>';
- }
- else if ( !hasOwnProp.call(itemsSeen, item.longname) ) {
- var displayName;
- if (env.conf.templates.default.useLongnameInNav) {
- displayName = item.longname;
- } else {
- displayName = item.name;
- }
- itemsNav += '<li>' + linktoFn(item.longname, displayName.replace(/\b(module|event):/g, '')) + '</li>';
-
- itemsSeen[item.longname] = true;
- }
- });
-
- if (itemsNav !== '') {
- nav += '<h3>' + itemHeading + '</h3><ul>' + itemsNav + '</ul>';
- }
- }
-
- return nav;
+ var nav = "";
+
+ if (items.length) {
+ var itemsNav = "";
+
+ items.forEach(function (item) {
+ if (!hasOwnProp.call(item, "longname")) {
+ itemsNav += "<li>" + linktoFn("", item.name) + "</li>";
+ } else if (!hasOwnProp.call(itemsSeen, item.longname)) {
+ var displayName;
+ if (env.conf.templates.default.useLongnameInNav) {
+ displayName = item.longname;
+ } else {
+ displayName = item.name;
+ }
+ itemsNav +=
+ "<li>" +
+ linktoFn(
+ item.longname,
+ displayName.replace(/\b(module|event):/g, ""),
+ ) +
+ "</li>";
+
+ itemsSeen[item.longname] = true;
+ }
+ });
+
+ if (itemsNav !== "") {
+ nav += "<h3>" + itemHeading + "</h3><ul>" + itemsNav + "</ul>";
+ }
+ }
+
+ return nav;
}
function linktoTutorial(longName, name) {
- return tutoriallink(name);
+ return tutoriallink(name);
}
function linktoExternal(longName, name) {
- return linkto(longName, name.replace(/(^"|"$)/g, ''));
+ return linkto(longName, name.replace(/(^"|"$)/g, ""));
}
/**
@@ -343,39 +387,43 @@ function linktoExternal(longName, name) {
* @return {string} The HTML for the navigation sidebar.
*/
function buildNav(members) {
- var nav = '<h2><a href="index.html">Home</a></h2>';
- var seen = {};
- var seenTutorials = {};
-
- nav += buildMemberNav(members.modules, 'Modules', {}, linkto);
- nav += buildMemberNav(members.externals, 'Externals', seen, linktoExternal);
- nav += buildMemberNav(members.classes, 'Classes', seen, linkto);
- nav += buildMemberNav(members.events, 'Events', seen, linkto);
- nav += buildMemberNav(members.namespaces, 'Namespaces', seen, linkto);
- nav += buildMemberNav(members.mixins, 'Mixins', seen, linkto);
- nav += buildMemberNav(members.tutorials, 'Tutorials', seenTutorials, linktoTutorial);
- nav += buildMemberNav(members.interfaces, 'Interfaces', seen, linkto);
-
- if (members.globals.length) {
- var globalNav = '';
-
- members.globals.forEach(function(g) {
- if ( g.kind !== 'typedef' && !hasOwnProp.call(seen, g.longname) ) {
- globalNav += '<li>' + linkto(g.longname, g.name) + '</li>';
- }
- seen[g.longname] = true;
- });
-
- if (!globalNav) {
- // turn the heading into a link so you can actually get to the global page
- nav += '<h3>' + linkto('global', 'Global') + '</h3>';
- }
- else {
- nav += '<h3>Global</h3><ul>' + globalNav + '</ul>';
- }
- }
-
- return nav;
+ var nav = '<h2><a href="index.html">Home</a></h2>';
+ var seen = {};
+ var seenTutorials = {};
+
+ nav += buildMemberNav(members.modules, "Modules", {}, linkto);
+ nav += buildMemberNav(members.externals, "Externals", seen, linktoExternal);
+ nav += buildMemberNav(members.classes, "Classes", seen, linkto);
+ nav += buildMemberNav(members.events, "Events", seen, linkto);
+ nav += buildMemberNav(members.namespaces, "Namespaces", seen, linkto);
+ nav += buildMemberNav(members.mixins, "Mixins", seen, linkto);
+ nav += buildMemberNav(
+ members.tutorials,
+ "Tutorials",
+ seenTutorials,
+ linktoTutorial,
+ );
+ nav += buildMemberNav(members.interfaces, "Interfaces", seen, linkto);
+
+ if (members.globals.length) {
+ var globalNav = "";
+
+ members.globals.forEach(function (g) {
+ if (g.kind !== "typedef" && !hasOwnProp.call(seen, g.longname)) {
+ globalNav += "<li>" + linkto(g.longname, g.name) + "</li>";
+ }
+ seen[g.longname] = true;
+ });
+
+ if (!globalNav) {
+ // turn the heading into a link so you can actually get to the global page
+ nav += "<h3>" + linkto("global", "Global") + "</h3>";
+ } else {
+ nav += "<h3>Global</h3><ul>" + globalNav + "</ul>";
+ }
+ }
+
+ return nav;
}
/**
@@ -383,272 +431,320 @@ function buildNav(members) {
@param {object} opts
@param {Tutorial} tutorials
*/
-exports.publish = function(taffyData, opts, tutorials) {
- data = taffyData;
-
- var conf = env.conf.templates || {};
- conf.default = conf.default || {};
-
- var templatePath = path.normalize(opts.template);
- view = new template.Template( path.join(templatePath, 'tmpl') );
-
- // claim some special filenames in advance, so the All-Powerful Overseer of Filename Uniqueness
- // doesn't try to hand them out later
- var indexUrl = helper.getUniqueFilename('index');
- // don't call registerLink() on this one! 'index' is also a valid longname
-
- var globalUrl = helper.getUniqueFilename('global');
- helper.registerLink('global', globalUrl);
-
- // set up templating
- view.layout = conf.default.layoutFile ?
- path.getResourcePath(path.dirname(conf.default.layoutFile),
- path.basename(conf.default.layoutFile) ) :
- 'layout.tmpl';
-
- // set up tutorials for helper
- helper.setTutorials(tutorials);
-
- data = helper.prune(data);
- data.sort('longname, version, since');
- helper.addEventListeners(data);
-
- var sourceFiles = {};
- var sourceFilePaths = [];
- data().each(function(doclet) {
- doclet.attribs = '';
-
- if (doclet.examples) {
- doclet.examples = doclet.examples.map(function(example) {
- var caption, code;
-
- if (example.match(/^\s*<caption>([\s\S]+?)<\/caption>(\s*[\n\r])([\s\S]+)$/i)) {
- caption = RegExp.$1;
- code = RegExp.$3;
- }
-
- return {
- caption: caption || '',
- code: code || example
- };
- });
- }
- if (doclet.see) {
- doclet.see.forEach(function(seeItem, i) {
- doclet.see[i] = hashToLink(doclet, seeItem);
- });
- }
-
- // build a list of source files
- var sourcePath;
- if (doclet.meta) {
- sourcePath = getPathFromDoclet(doclet);
- sourceFiles[sourcePath] = {
- resolved: sourcePath,
- shortened: null
- };
- if (sourceFilePaths.indexOf(sourcePath) === -1) {
- sourceFilePaths.push(sourcePath);
- }
- }
- });
-
- // update outdir if necessary, then create outdir
- var packageInfo = ( find({kind: 'package'}) || [] ) [0];
- if (packageInfo && packageInfo.name) {
- outdir = path.join( outdir, packageInfo.name, (packageInfo.version || '') );
- }
- fs.mkPath(outdir);
-
- // copy the template's static files to outdir
- var fromDir = path.join(templatePath, 'static');
- var staticFiles = fs.ls(fromDir, 3);
-
- staticFiles.forEach(function(fileName) {
- var toDir = fs.toDir( fileName.replace(fromDir, outdir) );
- fs.mkPath(toDir);
- fs.copyFileSync(fileName, toDir);
- });
-
- // copy user-specified static files to outdir
- var staticFilePaths;
- var staticFileFilter;
- var staticFileScanner;
- if (conf.default.staticFiles) {
- // The canonical property name is `include`. We accept `paths` for backwards compatibility
- // with a bug in JSDoc 3.2.x.
- staticFilePaths = conf.default.staticFiles.include ||
- conf.default.staticFiles.paths ||
- [];
- staticFileFilter = new (require('jsdoc/src/filter')).Filter(conf.default.staticFiles);
- staticFileScanner = new (require('jsdoc/src/scanner')).Scanner();
-
- staticFilePaths.forEach(function(filePath) {
- var extraStaticFiles;
-
- filePath = path.resolve(env.pwd, filePath);
- extraStaticFiles = staticFileScanner.scan([filePath], 10, staticFileFilter);
-
- extraStaticFiles.forEach(function(fileName) {
- var sourcePath = fs.toDir(filePath);
- var toDir = fs.toDir( fileName.replace(sourcePath, outdir) );
- fs.mkPath(toDir);
- fs.copyFileSync(fileName, toDir);
- });
- });
- }
-
- if (sourceFilePaths.length) {
- sourceFiles = shortenPaths( sourceFiles, path.commonPrefix(sourceFilePaths) );
- }
- data().each(function(doclet) {
- var url = helper.createLink(doclet);
- helper.registerLink(doclet.longname, url);
-
- // add a shortened version of the full path
- var docletPath;
- if (doclet.meta) {
- docletPath = getPathFromDoclet(doclet);
- docletPath = sourceFiles[docletPath].shortened;
- if (docletPath) {
- doclet.meta.shortpath = docletPath;
- }
- }
- });
-
- data().each(function(doclet) {
- var url = helper.longnameToUrl[doclet.longname];
-
- if (url.indexOf('#') > -1) {
- doclet.id = helper.longnameToUrl[doclet.longname].split(/#/).pop();
- }
- else {
- doclet.id = doclet.name;
- }
-
- if ( needsSignature(doclet) ) {
- addSignatureParams(doclet);
- addSignatureReturns(doclet);
- addAttribs(doclet);
- }
- });
-
- // do this after the urls have all been generated
- data().each(function(doclet) {
- doclet.ancestors = getAncestorLinks(doclet);
-
- if (doclet.kind === 'member') {
- addSignatureTypes(doclet);
- addAttribs(doclet);
- }
-
- if (doclet.kind === 'constant') {
- addSignatureTypes(doclet);
- addAttribs(doclet);
- doclet.kind = 'member';
- }
- });
-
- var members = helper.getMembers(data);
- members.tutorials = tutorials.children;
-
- // output pretty-printed source files by default
- var outputSourceFiles = conf.default && conf.default.outputSourceFiles !== false ? true :
- false;
-
- // add template helpers
- view.find = find;
- view.linkto = linkto;
- view.resolveAuthorLinks = resolveAuthorLinks;
- view.tutoriallink = tutoriallink;
- view.htmlsafe = htmlsafe;
- view.outputSourceFiles = outputSourceFiles;
-
- // once for all
- view.nav = buildNav(members);
- attachModuleSymbols( find({ longname: {left: 'module:'} }), members.modules );
-
- // generate the pretty-printed source files first so other pages can link to them
- if (outputSourceFiles) {
- generateSourceFiles(sourceFiles, opts.encoding);
- }
-
- if (members.globals.length) { generate('Global', [{kind: 'globalobj'}], globalUrl); }
-
- // index page displays information from package.json and lists files
- var files = find({kind: 'file'}),
- packages = find({kind: 'package'});
-
- generate('Home',
- packages.concat(
- [{kind: 'mainpage', readme: opts.readme, longname: (opts.mainpagetitle) ? opts.mainpagetitle : 'Main Page'}]
- ).concat(files),
- indexUrl);
-
- // set up the lists that we'll use to generate pages
- var classes = taffy(members.classes);
- var modules = taffy(members.modules);
- var namespaces = taffy(members.namespaces);
- var mixins = taffy(members.mixins);
- var externals = taffy(members.externals);
- var interfaces = taffy(members.interfaces);
-
- Object.keys(helper.longnameToUrl).forEach(function(longname) {
- var myModules = helper.find(modules, {longname: longname});
- if (myModules.length) {
- generate('Module: ' + myModules[0].name, myModules, helper.longnameToUrl[longname]);
- }
-
- var myClasses = helper.find(classes, {longname: longname});
- if (myClasses.length) {
- generate('Class: ' + myClasses[0].name, myClasses, helper.longnameToUrl[longname]);
- }
-
- var myNamespaces = helper.find(namespaces, {longname: longname});
- if (myNamespaces.length) {
- generate('Namespace: ' + myNamespaces[0].name, myNamespaces, helper.longnameToUrl[longname]);
- }
-
- var myMixins = helper.find(mixins, {longname: longname});
- if (myMixins.length) {
- generate('Mixin: ' + myMixins[0].name, myMixins, helper.longnameToUrl[longname]);
- }
-
- var myExternals = helper.find(externals, {longname: longname});
- if (myExternals.length) {
- generate('External: ' + myExternals[0].name, myExternals, helper.longnameToUrl[longname]);
- }
-
- var myInterfaces = helper.find(interfaces, {longname: longname});
- if (myInterfaces.length) {
- generate('Interface: ' + myInterfaces[0].name, myInterfaces, helper.longnameToUrl[longname]);
- }
- });
-
- // TODO: move the tutorial functions to templateHelper.js
- function generateTutorial(title, tutorial, filename) {
- var tutorialData = {
- title: title,
- header: tutorial.title,
- content: tutorial.parse(),
- children: tutorial.children
- };
-
- var tutorialPath = path.join(outdir, filename),
- html = view.render('tutorial.tmpl', tutorialData);
-
- // yes, you can use {@link} in tutorials too!
- html = helper.resolveLinks(html); // turn {@link foo} into <a href="foodoc.html">foo</a>
-
- fs.writeFileSync(tutorialPath, html, 'utf8');
- }
-
- // tutorials can have only one parent so there is no risk for loops
- function saveChildren(node) {
- node.children.forEach(function(child) {
- generateTutorial('Tutorial: ' + child.title, child, helper.tutorialToUrl(child.name));
- saveChildren(child);
- });
- }
- saveChildren(tutorials);
+exports.publish = function (taffyData, opts, tutorials) {
+ data = taffyData;
+
+ var conf = env.conf.templates || {};
+ conf.default = conf.default || {};
+
+ var templatePath = path.normalize(opts.template);
+ view = new template.Template(path.join(templatePath, "tmpl"));
+
+ // claim some special filenames in advance, so the All-Powerful Overseer of Filename Uniqueness
+ // doesn't try to hand them out later
+ var indexUrl = helper.getUniqueFilename("index");
+ // don't call registerLink() on this one! 'index' is also a valid longname
+
+ var globalUrl = helper.getUniqueFilename("global");
+ helper.registerLink("global", globalUrl);
+
+ // set up templating
+ view.layout = conf.default.layoutFile
+ ? path.getResourcePath(
+ path.dirname(conf.default.layoutFile),
+ path.basename(conf.default.layoutFile),
+ )
+ : "layout.tmpl";
+
+ // set up tutorials for helper
+ helper.setTutorials(tutorials);
+
+ data = helper.prune(data);
+ data.sort("longname, version, since");
+ helper.addEventListeners(data);
+
+ var sourceFiles = {};
+ var sourceFilePaths = [];
+ data().each(function (doclet) {
+ doclet.attribs = "";
+
+ if (doclet.examples) {
+ doclet.examples = doclet.examples.map(function (example) {
+ var caption, code;
+
+ if (
+ example.match(
+ /^\s*<caption>([\s\S]+?)<\/caption>(\s*[\n\r])([\s\S]+)$/i,
+ )
+ ) {
+ caption = RegExp.$1;
+ code = RegExp.$3;
+ }
+
+ return {
+ caption: caption || "",
+ code: code || example,
+ };
+ });
+ }
+ if (doclet.see) {
+ doclet.see.forEach(function (seeItem, i) {
+ doclet.see[i] = hashToLink(doclet, seeItem);
+ });
+ }
+
+ // build a list of source files
+ var sourcePath;
+ if (doclet.meta) {
+ sourcePath = getPathFromDoclet(doclet);
+ sourceFiles[sourcePath] = {
+ resolved: sourcePath,
+ shortened: null,
+ };
+ if (sourceFilePaths.indexOf(sourcePath) === -1) {
+ sourceFilePaths.push(sourcePath);
+ }
+ }
+ });
+
+ // update outdir if necessary, then create outdir
+ var packageInfo = (find({ kind: "package" }) || [])[0];
+ if (packageInfo && packageInfo.name) {
+ outdir = path.join(outdir, packageInfo.name, packageInfo.version || "");
+ }
+ fs.mkPath(outdir);
+
+ // copy the template's static files to outdir
+ var fromDir = path.join(templatePath, "static");
+ var staticFiles = fs.ls(fromDir, 3);
+
+ staticFiles.forEach(function (fileName) {
+ var toDir = fs.toDir(fileName.replace(fromDir, outdir));
+ fs.mkPath(toDir);
+ fs.copyFileSync(fileName, toDir);
+ });
+
+ // copy user-specified static files to outdir
+ var staticFilePaths;
+ var staticFileFilter;
+ var staticFileScanner;
+ if (conf.default.staticFiles) {
+ // The canonical property name is `include`. We accept `paths` for backwards compatibility
+ // with a bug in JSDoc 3.2.x.
+ staticFilePaths =
+ conf.default.staticFiles.include || conf.default.staticFiles.paths || [];
+ staticFileFilter = new (require("jsdoc/src/filter").Filter)(
+ conf.default.staticFiles,
+ );
+ staticFileScanner = new (require("jsdoc/src/scanner").Scanner)();
+
+ staticFilePaths.forEach(function (filePath) {
+ var extraStaticFiles;
+
+ filePath = path.resolve(env.pwd, filePath);
+ extraStaticFiles = staticFileScanner.scan(
+ [filePath],
+ 10,
+ staticFileFilter,
+ );
+
+ extraStaticFiles.forEach(function (fileName) {
+ var sourcePath = fs.toDir(filePath);
+ var toDir = fs.toDir(fileName.replace(sourcePath, outdir));
+ fs.mkPath(toDir);
+ fs.copyFileSync(fileName, toDir);
+ });
+ });
+ }
+
+ if (sourceFilePaths.length) {
+ sourceFiles = shortenPaths(sourceFiles, path.commonPrefix(sourceFilePaths));
+ }
+ data().each(function (doclet) {
+ var url = helper.createLink(doclet);
+ helper.registerLink(doclet.longname, url);
+
+ // add a shortened version of the full path
+ var docletPath;
+ if (doclet.meta) {
+ docletPath = getPathFromDoclet(doclet);
+ docletPath = sourceFiles[docletPath].shortened;
+ if (docletPath) {
+ doclet.meta.shortpath = docletPath;
+ }
+ }
+ });
+
+ data().each(function (doclet) {
+ var url = helper.longnameToUrl[doclet.longname];
+
+ if (url.indexOf("#") > -1) {
+ doclet.id = helper.longnameToUrl[doclet.longname].split(/#/).pop();
+ } else {
+ doclet.id = doclet.name;
+ }
+
+ if (needsSignature(doclet)) {
+ addSignatureParams(doclet);
+ addSignatureReturns(doclet);
+ addAttribs(doclet);
+ }
+ });
+
+ // do this after the urls have all been generated
+ data().each(function (doclet) {
+ doclet.ancestors = getAncestorLinks(doclet);
+
+ if (doclet.kind === "member") {
+ addSignatureTypes(doclet);
+ addAttribs(doclet);
+ }
+
+ if (doclet.kind === "constant") {
+ addSignatureTypes(doclet);
+ addAttribs(doclet);
+ doclet.kind = "member";
+ }
+ });
+
+ var members = helper.getMembers(data);
+ members.tutorials = tutorials.children;
+
+ // output pretty-printed source files by default
+ var outputSourceFiles =
+ conf.default && conf.default.outputSourceFiles !== false ? true : false;
+
+ // add template helpers
+ view.find = find;
+ view.linkto = linkto;
+ view.resolveAuthorLinks = resolveAuthorLinks;
+ view.tutoriallink = tutoriallink;
+ view.htmlsafe = htmlsafe;
+ view.outputSourceFiles = outputSourceFiles;
+
+ // once for all
+ view.nav = buildNav(members);
+ attachModuleSymbols(find({ longname: { left: "module:" } }), members.modules);
+
+ // generate the pretty-printed source files first so other pages can link to them
+ if (outputSourceFiles) {
+ generateSourceFiles(sourceFiles, opts.encoding);
+ }
+
+ if (members.globals.length) {
+ generate("Global", [{ kind: "globalobj" }], globalUrl);
+ }
+
+ // index page displays information from package.json and lists files
+ var files = find({ kind: "file" }),
+ packages = find({ kind: "package" });
+
+ generate(
+ "Home",
+ packages
+ .concat([
+ {
+ kind: "mainpage",
+ readme: opts.readme,
+ longname: opts.mainpagetitle ? opts.mainpagetitle : "Main Page",
+ },
+ ])
+ .concat(files),
+ indexUrl,
+ );
+
+ // set up the lists that we'll use to generate pages
+ var classes = taffy(members.classes);
+ var modules = taffy(members.modules);
+ var namespaces = taffy(members.namespaces);
+ var mixins = taffy(members.mixins);
+ var externals = taffy(members.externals);
+ var interfaces = taffy(members.interfaces);
+
+ Object.keys(helper.longnameToUrl).forEach(function (longname) {
+ var myModules = helper.find(modules, { longname: longname });
+ if (myModules.length) {
+ generate(
+ "Module: " + myModules[0].name,
+ myModules,
+ helper.longnameToUrl[longname],
+ );
+ }
+
+ var myClasses = helper.find(classes, { longname: longname });
+ if (myClasses.length) {
+ generate(
+ "Class: " + myClasses[0].name,
+ myClasses,
+ helper.longnameToUrl[longname],
+ );
+ }
+
+ var myNamespaces = helper.find(namespaces, { longname: longname });
+ if (myNamespaces.length) {
+ generate(
+ "Namespace: " + myNamespaces[0].name,
+ myNamespaces,
+ helper.longnameToUrl[longname],
+ );
+ }
+
+ var myMixins = helper.find(mixins, { longname: longname });
+ if (myMixins.length) {
+ generate(
+ "Mixin: " + myMixins[0].name,
+ myMixins,
+ helper.longnameToUrl[longname],
+ );
+ }
+
+ var myExternals = helper.find(externals, { longname: longname });
+ if (myExternals.length) {
+ generate(
+ "External: " + myExternals[0].name,
+ myExternals,
+ helper.longnameToUrl[longname],
+ );
+ }
+
+ var myInterfaces = helper.find(interfaces, { longname: longname });
+ if (myInterfaces.length) {
+ generate(
+ "Interface: " + myInterfaces[0].name,
+ myInterfaces,
+ helper.longnameToUrl[longname],
+ );
+ }
+ });
+
+ // TODO: move the tutorial functions to templateHelper.js
+ function generateTutorial(title, tutorial, filename) {
+ var tutorialData = {
+ title: title,
+ header: tutorial.title,
+ content: tutorial.parse(),
+ children: tutorial.children,
+ };
+
+ var tutorialPath = path.join(outdir, filename),
+ html = view.render("tutorial.tmpl", tutorialData);
+
+ // yes, you can use {@link} in tutorials too!
+ html = helper.resolveLinks(html); // turn {@link foo} into <a href="foodoc.html">foo</a>
+
+ fs.writeFileSync(tutorialPath, html, "utf8");
+ }
+
+ // tutorials can have only one parent so there is no risk for loops
+ function saveChildren(node) {
+ node.children.forEach(function (child) {
+ generateTutorial(
+ "Tutorial: " + child.title,
+ child,
+ helper.tutorialToUrl(child.name),
+ );
+ saveChildren(child);
+ });
+ }
+ saveChildren(tutorials);
};
diff --git a/tools/docs/jsdoc/templates/html/static/css/jsdoc-default.css b/tools/docs/jsdoc/templates/html/static/css/jsdoc-default.css
index b88b0cca3fdd..ef9acf8577e9 100644
--- a/tools/docs/jsdoc/templates/html/static/css/jsdoc-default.css
+++ b/tools/docs/jsdoc/templates/html/static/css/jsdoc-default.css
@@ -1,353 +1,377 @@
@font-face {
- font-family: 'Open Sans';
- font-weight: normal;
- font-style: normal;
- src: url('../fonts/opensans-regular-webfont.eot');
- src:
- local('Open Sans'),
- local('OpenSans'),
- url('../fonts/opensans-regular-webfont.eot?#iefix') format('embedded-opentype'),
- url('../fonts/opensans-regular-webfont.woff') format('woff'),
- url('../fonts/opensans-regular-webfont.svg#open_sansregular') format('svg');
+ font-family: "Open Sans";
+ font-weight: normal;
+ font-style: normal;
+ src: url("../fonts/opensans-regular-webfont.eot");
+ src:
+ local("Open Sans"),
+ local("OpenSans"),
+ url("../fonts/opensans-regular-webfont.eot?#iefix")
+ format("embedded-opentype"),
+ url("../fonts/opensans-regular-webfont.woff") format("woff"),
+ url("../fonts/opensans-regular-webfont.svg#open_sansregular") format("svg");
}
@font-face {
- font-family: 'Open Sans Light';
- font-weight: normal;
- font-style: normal;
- src: url('../fonts/opensans-light-webfont.eot');
- src:
- local('Open Sans Light'),
- local('OpenSans Light'),
- url('../fonts/opensans-light-webfont.eot?#iefix') format('embedded-opentype'),
- url('../fonts/opensans-light-webfont.woff') format('woff'),
- url('../fonts/opensans-light-webfont.svg#open_sanslight') format('svg');
+ font-family: "Open Sans Light";
+ font-weight: normal;
+ font-style: normal;
+ src: url("../fonts/opensans-light-webfont.eot");
+ src:
+ local("Open Sans Light"),
+ local("OpenSans Light"),
+ url("../fonts/opensans-light-webfont.eot?#iefix")
+ format("embedded-opentype"),
+ url("../fonts/opensans-light-webfont.woff") format("woff"),
+ url("../fonts/opensans-light-webfont.svg#open_sanslight") format("svg");
}
-html
-{
- overflow: auto;
- background-color: #fff;
- font-size: 14px;
+html {
+ overflow: auto;
+ background-color: #fff;
+ font-size: 14px;
}
-body
-{
- font-family: 'Open Sans', sans-serif;
- line-height: 1.5;
- color: #4d4e53;
- background-color: white;
+body {
+ font-family: "Open Sans", sans-serif;
+ line-height: 1.5;
+ color: #4d4e53;
+ background-color: white;
}
-a, a:visited, a:active {
- color: #0095dd;
- text-decoration: none;
+a,
+a:visited,
+a:active {
+ color: #0095dd;
+ text-decoration: none;
}
a:hover {
- text-decoration: underline;
+ text-decoration: underline;
}
-header
-{
- display: block;
- padding: 0px 4px;
+header {
+ display: block;
+ padding: 0px 4px;
}
-tt, code, kbd, samp {
- font-family: Consolas, Monaco, 'Andale Mono', monospace;
+tt,
+code,
+kbd,
+samp {
+ font-family: Consolas, Monaco, "Andale Mono", monospace;
}
.class-description {
- font-size: 130%;
- line-height: 140%;
- margin-bottom: 1em;
- margin-top: 1em;
+ font-size: 130%;
+ line-height: 140%;
+ margin-bottom: 1em;
+ margin-top: 1em;
}
.class-description:empty {
- margin: 0;
+ margin: 0;
}
#main {
- float: left;
- width: 70%;
+ float: left;
+ width: 70%;
}
article dl {
- margin-bottom: 40px;
+ margin-bottom: 40px;
}
-section
-{
- display: block;
- background-color: #fff;
- padding: 12px 24px;
- border-bottom: 1px solid #ccc;
- margin-right: 30px;
+section {
+ display: block;
+ background-color: #fff;
+ padding: 12px 24px;
+ border-bottom: 1px solid #ccc;
+ margin-right: 30px;
}
.variation {
- display: none;
+ display: none;
}
.signature-attributes {
- font-size: 60%;
- color: #aaa;
- font-style: italic;
- font-weight: lighter;
+ font-size: 60%;
+ color: #aaa;
+ font-style: italic;
+ font-weight: lighter;
}
-nav
-{
- display: block;
- float: right;
- margin-top: 28px;
- width: 30%;
- box-sizing: border-box;
- border-left: 1px solid #ccc;
- padding-left: 16px;
+nav {
+ display: block;
+ float: right;
+ margin-top: 28px;
+ width: 30%;
+ box-sizing: border-box;
+ border-left: 1px solid #ccc;
+ padding-left: 16px;
}
nav ul {
- font-family: 'Lucida Grande', 'Lucida Sans Unicode', arial, sans-serif;
- font-size: 100%;
- line-height: 17px;
- padding: 0;
- margin: 0;
- list-style-type: none;
+ font-family: "Lucida Grande", "Lucida Sans Unicode", arial, sans-serif;
+ font-size: 100%;
+ line-height: 17px;
+ padding: 0;
+ margin: 0;
+ list-style-type: none;
}
-nav ul a, nav ul a:visited, nav ul a:active {
- font-family: Consolas, Monaco, 'Andale Mono', monospace;
- line-height: 18px;
- color: #4D4E53;
+nav ul a,
+nav ul a:visited,
+nav ul a:active {
+ font-family: Consolas, Monaco, "Andale Mono", monospace;
+ line-height: 18px;
+ color: #4d4e53;
}
nav h3 {
- margin-top: 12px;
+ margin-top: 12px;
}
nav li {
- margin-top: 6px;
+ margin-top: 6px;
}
footer {
- display: block;
- padding: 6px;
- margin-top: 12px;
- font-style: italic;
- font-size: 90%;
+ display: block;
+ padding: 6px;
+ margin-top: 12px;
+ font-style: italic;
+ font-size: 90%;
}
-h1, h2, h3, h4 {
- font-weight: 200;
- margin: 0;
+h1,
+h2,
+h3,
+h4 {
+ font-weight: 200;
+ margin: 0;
}
-h1
-{
- font-family: 'Open Sans Light', sans-serif;
- font-size: 48px;
- letter-spacing: -2px;
- margin: 12px 24px 20px;
+h1 {
+ font-family: "Open Sans Light", sans-serif;
+ font-size: 48px;
+ letter-spacing: -2px;
+ margin: 12px 24px 20px;
}
-h2, h3
-{
- font-size: 30px;
- font-weight: 700;
- letter-spacing: -1px;
- margin-bottom: 12px;
+h2,
+h3 {
+ font-size: 30px;
+ font-weight: 700;
+ letter-spacing: -1px;
+ margin-bottom: 12px;
}
-h4
-{
- font-size: 18px;
- letter-spacing: -0.33px;
- margin-bottom: 12px;
- color: #4d4e53;
+h4 {
+ font-size: 18px;
+ letter-spacing: -0.33px;
+ margin-bottom: 12px;
+ color: #4d4e53;
}
-h5, .container-overview .subsection-title
-{
- font-size: 120%;
- font-weight: bold;
- letter-spacing: -0.01em;
- margin: 8px 0 3px 0;
+h5,
+.container-overview .subsection-title {
+ font-size: 120%;
+ font-weight: bold;
+ letter-spacing: -0.01em;
+ margin: 8px 0 3px 0;
}
-h6
-{
- font-size: 100%;
- letter-spacing: -0.01em;
- margin: 6px 0 3px 0;
- font-style: italic;
+h6 {
+ font-size: 100%;
+ letter-spacing: -0.01em;
+ margin: 6px 0 3px 0;
+ font-style: italic;
}
-.ancestors { color: #999; }
-.ancestors a
-{
- color: #999 !important;
- text-decoration: none;
+.ancestors {
+ color: #999;
+}
+.ancestors a {
+ color: #999 !important;
+ text-decoration: none;
}
-.clear
-{
- clear: both;
+.clear {
+ clear: both;
}
-.important
-{
- font-weight: bold;
- color: #950B02;
+.important {
+ font-weight: bold;
+ color: #950b02;
}
.yes-def {
- text-indent: -1000px;
+ text-indent: -1000px;
}
.type-signature {
- color: #aaa;
+ color: #aaa;
}
-.name, .signature {
- font-family: Consolas, Monaco, 'Andale Mono', monospace;
+.name,
+.signature {
+ font-family: Consolas, Monaco, "Andale Mono", monospace;
}
-.details { margin-top: 14px; border-left: 2px solid #DDD; }
-.details dt { width: 120px; float: left; padding-left: 10px; padding-top: 6px; }
-.details dd { margin-left: 70px; }
-.details ul { margin: 0; }
-.details ul { list-style-type: none; }
-.details li { margin-left: 30px; padding-top: 6px; }
-.details pre.prettyprint { margin: 0 }
-.details .object-value { padding-top: 0; }
+.details {
+ margin-top: 14px;
+ border-left: 2px solid #ddd;
+}
+.details dt {
+ width: 120px;
+ float: left;
+ padding-left: 10px;
+ padding-top: 6px;
+}
+.details dd {
+ margin-left: 70px;
+}
+.details ul {
+ margin: 0;
+}
+.details ul {
+ list-style-type: none;
+}
+.details li {
+ margin-left: 30px;
+ padding-top: 6px;
+}
+.details pre.prettyprint {
+ margin: 0;
+}
+.details .object-value {
+ padding-top: 0;
+}
.description {
- margin-bottom: 1em;
- margin-top: 1em;
+ margin-bottom: 1em;
+ margin-top: 1em;
}
-.code-caption
-{
- font-style: italic;
- font-size: 107%;
- margin: 0;
+.code-caption {
+ font-style: italic;
+ font-size: 107%;
+ margin: 0;
}
-.prettyprint
-{
- border: 1px solid #ddd;
- width: 80%;
- overflow: auto;
+.prettyprint {
+ border: 1px solid #ddd;
+ width: 80%;
+ overflow: auto;
}
.prettyprint.source {
- width: inherit;
+ width: inherit;
}
-.prettyprint code
-{
- font-size: 100%;
- line-height: 18px;
- display: block;
- padding: 4px 12px;
- margin: 0;
- background-color: #fff;
- color: #4D4E53;
+.prettyprint code {
+ font-size: 100%;
+ line-height: 18px;
+ display: block;
+ padding: 4px 12px;
+ margin: 0;
+ background-color: #fff;
+ color: #4d4e53;
}
-.prettyprint code span.line
-{
- display: inline-block;
+.prettyprint code span.line {
+ display: inline-block;
}
-.prettyprint.linenums
-{
- padding-left: 70px;
- -webkit-user-select: none;
- -moz-user-select: none;
- -ms-user-select: none;
- user-select: none;
+.prettyprint.linenums {
+ padding-left: 70px;
+ -webkit-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
}
-.prettyprint.linenums ol
-{
- padding-left: 0;
+.prettyprint.linenums ol {
+ padding-left: 0;
}
-.prettyprint.linenums li
-{
- border-left: 3px #ddd solid;
+.prettyprint.linenums li {
+ border-left: 3px #ddd solid;
}
.prettyprint.linenums li.selected,
-.prettyprint.linenums li.selected *
-{
- background-color: lightyellow;
+.prettyprint.linenums li.selected * {
+ background-color: lightyellow;
}
-.prettyprint.linenums li *
-{
- -webkit-user-select: text;
- -moz-user-select: text;
- -ms-user-select: text;
- user-select: text;
+.prettyprint.linenums li * {
+ -webkit-user-select: text;
+ -moz-user-select: text;
+ -ms-user-select: text;
+ user-select: text;
}
-.params, .props
-{
- border-spacing: 0;
- border: 0;
- border-collapse: collapse;
+.params,
+.props {
+ border-spacing: 0;
+ border: 0;
+ border-collapse: collapse;
}
-.params .name, .props .name, .name code {
- color: #4D4E53;
- font-family: Consolas, Monaco, 'Andale Mono', monospace;
- font-size: 100%;
+.params .name,
+.props .name,
+.name code {
+ color: #4d4e53;
+ font-family: Consolas, Monaco, "Andale Mono", monospace;
+ font-size: 100%;
}
-.params td, .params th, .props td, .props th
-{
- border: 1px solid #ddd;
- margin: 0px;
- text-align: left;
- vertical-align: top;
- padding: 4px 6px;
- display: table-cell;
+.params td,
+.params th,
+.props td,
+.props th {
+ border: 1px solid #ddd;
+ margin: 0px;
+ text-align: left;
+ vertical-align: top;
+ padding: 4px 6px;
+ display: table-cell;
}
-.params thead tr, .props thead tr
-{
- background-color: #ddd;
- font-weight: bold;
+.params thead tr,
+.props thead tr {
+ background-color: #ddd;
+ font-weight: bold;
}
-.params .params thead tr, .props .props thead tr
-{
- background-color: #fff;
- font-weight: bold;
+.params .params thead tr,
+.props .props thead tr {
+ background-color: #fff;
+ font-weight: bold;
}
-.params th, .props th { border-right: 1px solid #aaa; }
-.params thead .last, .props thead .last { border-right: 1px solid #ddd; }
+.params th,
+.props th {
+ border-right: 1px solid #aaa;
+}
+.params thead .last,
+.props thead .last {
+ border-right: 1px solid #ddd;
+}
.params td.description > p:first-child,
-.props td.description > p:first-child
-{
- margin-top: 0;
- padding-top: 0;
+.props td.description > p:first-child {
+ margin-top: 0;
+ padding-top: 0;
}
.params td.description > p:last-child,
-.props td.description > p:last-child
-{
- margin-bottom: 0;
- padding-bottom: 0;
+.props td.description > p:last-child {
+ margin-bottom: 0;
+ padding-bottom: 0;
}
.disabled {
- color: #454545;
+ color: #454545;
}
diff --git a/tools/docs/jsdoc/templates/html/static/js/script.js b/tools/docs/jsdoc/templates/html/static/js/script.js
index ee9312936880..286990ba16fb 100644
--- a/tools/docs/jsdoc/templates/html/static/js/script.js
+++ b/tools/docs/jsdoc/templates/html/static/js/script.js
@@ -1,32 +1,31 @@
-(function() {
- 'use strict';
+(function () {
+ "use strict";
- var elements;
- var newChild;
- var parent;
- var tex;
- var el;
- var i;
+ var elements;
+ var newChild;
+ var parent;
+ var tex;
+ var el;
+ var i;
- elements = document.querySelectorAll( '.lang-tex' );
+ elements = document.querySelectorAll(".lang-tex");
- for ( i = 0; i < elements.length; i++ ) {
- el = elements[ i ];
+ for (i = 0; i < elements.length; i++) {
+ el = elements[i];
- // Get the TeX code:
- tex = el.querySelector( 'code' ).innerHTML;
+ // Get the TeX code:
+ tex = el.querySelector("code").innerHTML;
- // Create a new element for rendering TeX:
- newChild = document.createElement( 'div' );
+ // Create a new element for rendering TeX:
+ newChild = document.createElement("div");
- // Set the child's content:
- newChild.innerHTML = '\\[' + tex + '\\]';
+ // Set the child's content:
+ newChild.innerHTML = "\\[" + tex + "\\]";
- // Get a reference to the parent node:
- parent = el.parentNode;
-
- // Replace the old child:
- parent.replaceChild( newChild, el );
- }
+ // Get a reference to the parent node:
+ parent = el.parentNode;
+ // Replace the old child:
+ parent.replaceChild(newChild, el);
+ }
})();
diff --git a/tools/docs/jsdoc/templates/json/publish.js b/tools/docs/jsdoc/templates/json/publish.js
index 2fbe95f3a259..8dfa7cc22243 100644
--- a/tools/docs/jsdoc/templates/json/publish.js
+++ b/tools/docs/jsdoc/templates/json/publish.js
@@ -1,43 +1,40 @@
-'use strict';
+"use strict";
// MODULES //
-var transform = require( './transform.js' );
-
+var transform = require("./transform.js");
// VARIABLES //
var opts = {
- 'undocumented': true
+ undocumented: true,
};
-
// MAIN //
/**
-* Transforms an array of raw `doclet` objects and writes to `stdout`.
-*
-* @param {TAFFY} data - TAFFY database
-*/
-function publish( data ) {
+ * Transforms an array of raw `doclet` objects and writes to `stdout`.
+ *
+ * @param {TAFFY} data - TAFFY database
+ */
+function publish(data) {
var root;
var docs;
// Remove undocumented doclets:
- data( opts ).remove();
+ data(opts).remove();
// Retrieve an array of raw doclet objects:
docs = data().get();
// Transform the raw doclet array:
root = {};
- transform( root, docs );
+ transform(root, docs);
// Write to stdout:
- console.log( JSON.stringify( root ) );
+ console.log(JSON.stringify(root));
}
-
// EXPORTS //
module.exports = {};
diff --git a/tools/docs/jsdoc/templates/json/transform.js b/tools/docs/jsdoc/templates/json/transform.js
index 4622238e477d..9dd6decca401 100644
--- a/tools/docs/jsdoc/templates/json/transform.js
+++ b/tools/docs/jsdoc/templates/json/transform.js
@@ -1,41 +1,39 @@
-'use strict';
+"use strict";
// MODULES //
-var transforms = require( './transforms' );
-
+var transforms = require("./transforms");
// VARIABLES //
var map = {
- 'namespace': 'namespaces',
- 'mixin': 'mixins',
- 'function': 'functions',
- 'member': 'properties',
- 'event': 'events',
- 'class': 'classes'
+ namespace: "namespaces",
+ mixin: "mixins",
+ function: "functions",
+ member: "properties",
+ event: "events",
+ class: "classes",
};
var recurse = {
- 'namespace': true,
- 'mixin': true,
- 'function': false,
- 'member': true,
- 'event': false,
- 'class': true
+ namespace: true,
+ mixin: true,
+ function: false,
+ member: true,
+ event: false,
+ class: true,
};
-
// MAIN //
/**
-* Recursively transforms doclet nodes.
-*
-* @param {Object} parentNode - parent doclet node
-* @param {ObjectArray} childNodes - array of child nodes
-* @param {string} parentLongName - long form of a parent name
-*/
-function transform( parentNode, childNodes, parentLongName ) {
+ * Recursively transforms doclet nodes.
+ *
+ * @param {Object} parentNode - parent doclet node
+ * @param {ObjectArray} childNodes - array of child nodes
+ * @param {string} parentLongName - long form of a parent name
+ */
+function transform(parentNode, childNodes, parentLongName) {
var node;
var tmp;
var key;
@@ -45,43 +43,42 @@ function transform( parentNode, childNodes, parentLongName ) {
// Filter for child nodes...
tmp = [];
- for ( i = 0; i < childNodes.length; i++ ) {
- if ( childNodes[ i ].memberof === parentLongName ) {
- tmp.push( childNodes[ i ] );
+ for (i = 0; i < childNodes.length; i++) {
+ if (childNodes[i].memberof === parentLongName) {
+ tmp.push(childNodes[i]);
}
}
childNodes = tmp;
- if ( childNodes.length === 0 ) {
+ if (childNodes.length === 0) {
return;
}
// For each child node, apply a transformation...
- for ( i = 0; i < childNodes.length; i++ ) {
- node = childNodes[ i ];
+ for (i = 0; i < childNodes.length; i++) {
+ node = childNodes[i];
// Apply a transform...
- fcn = transforms[ node.kind ];
- if ( fcn === void 0 ) {
+ fcn = transforms[node.kind];
+ if (fcn === void 0) {
continue;
}
- out = fcn( node );
+ out = fcn(node);
// Cache the transformed node...
- key = map[ node.kind ];
- tmp = parentNode[ key ];
- if ( tmp === void 0 ) {
+ key = map[node.kind];
+ tmp = parentNode[key];
+ if (tmp === void 0) {
tmp = [];
- parentNode[ key ] = tmp;
+ parentNode[key] = tmp;
}
- tmp.push( out );
+ tmp.push(out);
// Check if we need to recurse...
- if ( recurse[ node.kind ] ) {
- transform( out, childNodes, node.longname );
+ if (recurse[node.kind]) {
+ transform(out, childNodes, node.longname);
}
}
}
-
// EXPORTS //
module.exports = transform;
diff --git a/tools/docs/jsdoc/templates/json/transforms/class/examples.js b/tools/docs/jsdoc/templates/json/transforms/class/examples.js
index 5eeaec223db9..8ca4a9d72049 100644
--- a/tools/docs/jsdoc/templates/json/transforms/class/examples.js
+++ b/tools/docs/jsdoc/templates/json/transforms/class/examples.js
@@ -1,22 +1,21 @@
-'use strict';
+"use strict";
/**
-* Transforms `examples` doclet elements.
-*
-* @param {Object[]} nodes - doclet elements
-* @returns {Object[]} filtered objects
-*/
-function transform( nodes ) {
+ * Transforms `examples` doclet elements.
+ *
+ * @param {Object[]} nodes - doclet elements
+ * @returns {Object[]} filtered objects
+ */
+function transform(nodes) {
var out;
var i;
- out = new Array( nodes.length );
- for ( i = 0; i < nodes.length; i++ ) {
- out[ i ] = nodes[ i ];
+ out = new Array(nodes.length);
+ for (i = 0; i < nodes.length; i++) {
+ out[i] = nodes[i];
}
return out;
}
-
// EXPORTS //
module.exports = transform;
diff --git a/tools/docs/jsdoc/templates/json/transforms/class/index.js b/tools/docs/jsdoc/templates/json/transforms/class/index.js
index 700117546238..2605471e8215 100644
--- a/tools/docs/jsdoc/templates/json/transforms/class/index.js
+++ b/tools/docs/jsdoc/templates/json/transforms/class/index.js
@@ -1,47 +1,45 @@
-'use strict';
+"use strict";
// MODULES //
-var transformExamples = require( './examples.js' );
-var transformParams = require( './params.js' );
-
+var transformExamples = require("./examples.js");
+var transformParams = require("./params.js");
// MAIN //
/**
-* Transforms a `event` doclet element.
-*
-* @param {Object} node - doclet element
-* @returns {Object} filtered object
-*/
-function transform( node ) {
+ * Transforms a `event` doclet element.
+ *
+ * @param {Object} node - doclet element
+ * @returns {Object} filtered object
+ */
+function transform(node) {
var out;
out = {
- 'name': node.name,
- 'description': node.description || '',
- 'extends': node.augments || [],
- 'fires': node.fires || '',
- 'constructor': {
- 'name': node.name,
- 'description': node.description
+ name: node.name,
+ description: node.description || "",
+ extends: node.augments || [],
+ fires: node.fires || "",
+ constructor: {
+ name: node.name,
+ description: node.description,
},
- 'access': node.access || '',
- 'virtual': !!node.virtual
+ access: node.access || "",
+ virtual: !!node.virtual,
};
- if ( node.examples ) {
- out.constructor.examples = transformExamples( node.examples );
+ if (node.examples) {
+ out.constructor.examples = transformExamples(node.examples);
} else {
out.constructor.examples = [];
}
- if ( node.params ) {
- out.constructor.parameters = transformParams( node.params );
+ if (node.params) {
+ out.constructor.parameters = transformParams(node.params);
} else {
out.constructor.parameters = [];
}
return out;
}
-
// EXPORTS //
module.exports = transform;
diff --git a/tools/docs/jsdoc/templates/json/transforms/class/params.js b/tools/docs/jsdoc/templates/json/transforms/class/params.js
index 9694af99c7b6..0e53e5bddd86 100644
--- a/tools/docs/jsdoc/templates/json/transforms/class/params.js
+++ b/tools/docs/jsdoc/templates/json/transforms/class/params.js
@@ -1,82 +1,79 @@
-'use strict';
+"use strict";
// MODULES //
-var hasOwn = require( '@stdlib/assert/has-own-property' );
-
+var hasOwn = require("@stdlib/assert/has-own-property");
// FUNCTIONS //
/**
-* Filters a `params` doclet element.
-*
-* @private
-* @param {Object} node - doclet element
-* @returns {Object} filtered object
-*/
-function filter( node ) {
+ * Filters a `params` doclet element.
+ *
+ * @private
+ * @param {Object} node - doclet element
+ * @returns {Object} filtered object
+ */
+function filter(node) {
var isNullable;
var isOptional;
var type;
var desc;
var val;
- if ( node.type ) {
- if ( node.type.names.length === 1 ) {
- type = node.type.names[ 0 ];
+ if (node.type) {
+ if (node.type.names.length === 1) {
+ type = node.type.names[0];
} else {
type = node.type.names;
}
} else {
- type = '';
+ type = "";
}
- desc = node.description || '';
- if ( hasOwn.call( node, 'defaultvalue' ) ) {
+ desc = node.description || "";
+ if (hasOwn.call(node, "defaultvalue")) {
val = node.defaultvalue;
} else {
- val = '';
+ val = "";
}
- if ( typeof node.optional === 'boolean' ) {
+ if (typeof node.optional === "boolean") {
isOptional = node.optional;
} else {
- isOptional = '';
+ isOptional = "";
}
- if ( typeof node.nullable === 'boolean' ) {
+ if (typeof node.nullable === "boolean") {
isNullable = node.nullable;
} else {
- isNullable = '';
+ isNullable = "";
}
return {
- 'name': node.name,
- 'type': type,
- 'description': desc,
- 'default': val,
- 'optional': isOptional,
- 'nullable': isNullable
+ name: node.name,
+ type: type,
+ description: desc,
+ default: val,
+ optional: isOptional,
+ nullable: isNullable,
};
}
-
// MAIN //
/**
-* Transforms `params` doclet elements.
-*
-* @param {Object[]} nodes - doclet elements
-* @returns {Object[]} filtered objects
-*/
-function transform( nodes ) {
+ * Transforms `params` doclet elements.
+ *
+ * @param {Object[]} nodes - doclet elements
+ * @returns {Object[]} filtered objects
+ */
+function transform(nodes) {
var out;
var i;
- out = new Array( nodes.length );
- for ( i = 0; i < nodes.length; i++ ) {
- out[ i ] = filter( nodes[ i ] );
+ out = new Array(nodes.length);
+ for (i = 0; i < nodes.length; i++) {
+ out[i] = filter(nodes[i]);
}
return out;
}
-
// EXPORTS //
module.exports = transform;
diff --git a/tools/docs/jsdoc/templates/json/transforms/event/examples.js b/tools/docs/jsdoc/templates/json/transforms/event/examples.js
index 5eeaec223db9..8ca4a9d72049 100644
--- a/tools/docs/jsdoc/templates/json/transforms/event/examples.js
+++ b/tools/docs/jsdoc/templates/json/transforms/event/examples.js
@@ -1,22 +1,21 @@
-'use strict';
+"use strict";
/**
-* Transforms `examples` doclet elements.
-*
-* @param {Object[]} nodes - doclet elements
-* @returns {Object[]} filtered objects
-*/
-function transform( nodes ) {
+ * Transforms `examples` doclet elements.
+ *
+ * @param {Object[]} nodes - doclet elements
+ * @returns {Object[]} filtered objects
+ */
+function transform(nodes) {
var out;
var i;
- out = new Array( nodes.length );
- for ( i = 0; i < nodes.length; i++ ) {
- out[ i ] = nodes[ i ];
+ out = new Array(nodes.length);
+ for (i = 0; i < nodes.length; i++) {
+ out[i] = nodes[i];
}
return out;
}
-
// EXPORTS //
module.exports = transform;
diff --git a/tools/docs/jsdoc/templates/json/transforms/event/index.js b/tools/docs/jsdoc/templates/json/transforms/event/index.js
index cb69f0929b65..e1d709f8c90a 100644
--- a/tools/docs/jsdoc/templates/json/transforms/event/index.js
+++ b/tools/docs/jsdoc/templates/json/transforms/event/index.js
@@ -1,46 +1,44 @@
-'use strict';
+"use strict";
// MODULES //
-var transformReturns = require( './returns.js' );
-var transformExamples = require( './examples.js' );
-var transformParams = require( './params.js' );
-
+var transformReturns = require("./returns.js");
+var transformExamples = require("./examples.js");
+var transformParams = require("./params.js");
// MAIN //
/**
-* Transforms a `event` doclet element.
-*
-* @param {Object} node - doclet element
-* @returns {Object} filtered object
-*/
-function transform( node ) {
+ * Transforms a `event` doclet element.
+ *
+ * @param {Object} node - doclet element
+ * @returns {Object} filtered object
+ */
+function transform(node) {
var out;
out = {
- 'name': node.name,
- 'description': node.description || '',
- 'access': node.access || '',
- 'virtual': !!node.virtual
+ name: node.name,
+ description: node.description || "",
+ access: node.access || "",
+ virtual: !!node.virtual,
};
- if ( node.returns ) {
- out.returns = transformReturns( node.returns );
+ if (node.returns) {
+ out.returns = transformReturns(node.returns);
}
- if ( node.examples ) {
- out.examples = transformExamples( node.examples );
+ if (node.examples) {
+ out.examples = transformExamples(node.examples);
} else {
out.examples = [];
}
- if ( node.params ) {
- out.parameters = transformParams( node.params );
+ if (node.params) {
+ out.parameters = transformParams(node.params);
} else {
out.parameters = [];
}
return out;
}
-
// EXPORTS //
module.exports = transform;
diff --git a/tools/docs/jsdoc/templates/json/transforms/event/params.js b/tools/docs/jsdoc/templates/json/transforms/event/params.js
index 9694af99c7b6..0e53e5bddd86 100644
--- a/tools/docs/jsdoc/templates/json/transforms/event/params.js
+++ b/tools/docs/jsdoc/templates/json/transforms/event/params.js
@@ -1,82 +1,79 @@
-'use strict';
+"use strict";
// MODULES //
-var hasOwn = require( '@stdlib/assert/has-own-property' );
-
+var hasOwn = require("@stdlib/assert/has-own-property");
// FUNCTIONS //
/**
-* Filters a `params` doclet element.
-*
-* @private
-* @param {Object} node - doclet element
-* @returns {Object} filtered object
-*/
-function filter( node ) {
+ * Filters a `params` doclet element.
+ *
+ * @private
+ * @param {Object} node - doclet element
+ * @returns {Object} filtered object
+ */
+function filter(node) {
var isNullable;
var isOptional;
var type;
var desc;
var val;
- if ( node.type ) {
- if ( node.type.names.length === 1 ) {
- type = node.type.names[ 0 ];
+ if (node.type) {
+ if (node.type.names.length === 1) {
+ type = node.type.names[0];
} else {
type = node.type.names;
}
} else {
- type = '';
+ type = "";
}
- desc = node.description || '';
- if ( hasOwn.call( node, 'defaultvalue' ) ) {
+ desc = node.description || "";
+ if (hasOwn.call(node, "defaultvalue")) {
val = node.defaultvalue;
} else {
- val = '';
+ val = "";
}
- if ( typeof node.optional === 'boolean' ) {
+ if (typeof node.optional === "boolean") {
isOptional = node.optional;
} else {
- isOptional = '';
+ isOptional = "";
}
- if ( typeof node.nullable === 'boolean' ) {
+ if (typeof node.nullable === "boolean") {
isNullable = node.nullable;
} else {
- isNullable = '';
+ isNullable = "";
}
return {
- 'name': node.name,
- 'type': type,
- 'description': desc,
- 'default': val,
- 'optional': isOptional,
- 'nullable': isNullable
+ name: node.name,
+ type: type,
+ description: desc,
+ default: val,
+ optional: isOptional,
+ nullable: isNullable,
};
}
-
// MAIN //
/**
-* Transforms `params` doclet elements.
-*
-* @param {Object[]} nodes - doclet elements
-* @returns {Object[]} filtered objects
-*/
-function transform( nodes ) {
+ * Transforms `params` doclet elements.
+ *
+ * @param {Object[]} nodes - doclet elements
+ * @returns {Object[]} filtered objects
+ */
+function transform(nodes) {
var out;
var i;
- out = new Array( nodes.length );
- for ( i = 0; i < nodes.length; i++ ) {
- out[ i ] = filter( nodes[ i ] );
+ out = new Array(nodes.length);
+ for (i = 0; i < nodes.length; i++) {
+ out[i] = filter(nodes[i]);
}
return out;
}
-
// EXPORTS //
module.exports = transform;
diff --git a/tools/docs/jsdoc/templates/json/transforms/event/returns.js b/tools/docs/jsdoc/templates/json/transforms/event/returns.js
index 4a93d455f9dc..e346ab49dd45 100644
--- a/tools/docs/jsdoc/templates/json/transforms/event/returns.js
+++ b/tools/docs/jsdoc/templates/json/transforms/event/returns.js
@@ -1,31 +1,30 @@
-'use strict';
+"use strict";
/**
-* Transforms `returns` doclet elements.
-*
-* @param {Object[]} nodes - doclet elements
-* @returns {Object} filtered object
-*/
-function transform( nodes ) {
+ * Transforms `returns` doclet elements.
+ *
+ * @param {Object[]} nodes - doclet elements
+ * @returns {Object} filtered object
+ */
+function transform(nodes) {
var type;
var desc;
- if ( nodes.type ) {
- if ( nodes.type.names.length === 1 ) {
- type = nodes.type.names[ 0 ];
+ if (nodes.type) {
+ if (nodes.type.names.length === 1) {
+ type = nodes.type.names[0];
} else {
type = nodes.type.names;
}
} else {
- type = '';
+ type = "";
}
- desc = nodes.description || '';
+ desc = nodes.description || "";
return {
- 'type': type,
- 'description': desc
+ type: type,
+ description: desc,
};
}
-
// EXPORTS //
module.exports = transform;
diff --git a/tools/docs/jsdoc/templates/json/transforms/function/examples.js b/tools/docs/jsdoc/templates/json/transforms/function/examples.js
index 5eeaec223db9..8ca4a9d72049 100644
--- a/tools/docs/jsdoc/templates/json/transforms/function/examples.js
+++ b/tools/docs/jsdoc/templates/json/transforms/function/examples.js
@@ -1,22 +1,21 @@
-'use strict';
+"use strict";
/**
-* Transforms `examples` doclet elements.
-*
-* @param {Object[]} nodes - doclet elements
-* @returns {Object[]} filtered objects
-*/
-function transform( nodes ) {
+ * Transforms `examples` doclet elements.
+ *
+ * @param {Object[]} nodes - doclet elements
+ * @returns {Object[]} filtered objects
+ */
+function transform(nodes) {
var out;
var i;
- out = new Array( nodes.length );
- for ( i = 0; i < nodes.length; i++ ) {
- out[ i ] = nodes[ i ];
+ out = new Array(nodes.length);
+ for (i = 0; i < nodes.length; i++) {
+ out[i] = nodes[i];
}
return out;
}
-
// EXPORTS //
module.exports = transform;
diff --git a/tools/docs/jsdoc/templates/json/transforms/function/index.js b/tools/docs/jsdoc/templates/json/transforms/function/index.js
index 6053e7da9238..893788de3e73 100644
--- a/tools/docs/jsdoc/templates/json/transforms/function/index.js
+++ b/tools/docs/jsdoc/templates/json/transforms/function/index.js
@@ -1,46 +1,44 @@
-'use strict';
+"use strict";
// MODULES //
-var transformReturns = require( './returns.js' );
-var transformExamples = require( './examples.js' );
-var transformParams = require( './params.js' );
-
+var transformReturns = require("./returns.js");
+var transformExamples = require("./examples.js");
+var transformParams = require("./params.js");
// MAIN //
/**
-* Transforms a `function` doclet element.
-*
-* @param {Object} node - doclet element
-* @returns {Object} filtered object
-*/
-function transform( node ) {
+ * Transforms a `function` doclet element.
+ *
+ * @param {Object} node - doclet element
+ * @returns {Object} filtered object
+ */
+function transform(node) {
var out;
out = {
- 'name': node.name,
- 'description': node.description || '',
- 'access': node.access || '',
- 'virtual': !!node.virtual
+ name: node.name,
+ description: node.description || "",
+ access: node.access || "",
+ virtual: !!node.virtual,
};
- if ( node.returns ) {
- out.returns = transformReturns( node.returns );
+ if (node.returns) {
+ out.returns = transformReturns(node.returns);
}
- if ( node.examples ) {
- out.examples = transformExamples( node.examples );
+ if (node.examples) {
+ out.examples = transformExamples(node.examples);
} else {
out.examples = [];
}
- if ( node.params ) {
- out.parameters = transformParams( node.params );
+ if (node.params) {
+ out.parameters = transformParams(node.params);
} else {
out.parameters = [];
}
return out;
}
-
// EXPORTS //
module.exports = transform;
diff --git a/tools/docs/jsdoc/templates/json/transforms/function/params.js b/tools/docs/jsdoc/templates/json/transforms/function/params.js
index 9694af99c7b6..0e53e5bddd86 100644
--- a/tools/docs/jsdoc/templates/json/transforms/function/params.js
+++ b/tools/docs/jsdoc/templates/json/transforms/function/params.js
@@ -1,82 +1,79 @@
-'use strict';
+"use strict";
// MODULES //
-var hasOwn = require( '@stdlib/assert/has-own-property' );
-
+var hasOwn = require("@stdlib/assert/has-own-property");
// FUNCTIONS //
/**
-* Filters a `params` doclet element.
-*
-* @private
-* @param {Object} node - doclet element
-* @returns {Object} filtered object
-*/
-function filter( node ) {
+ * Filters a `params` doclet element.
+ *
+ * @private
+ * @param {Object} node - doclet element
+ * @returns {Object} filtered object
+ */
+function filter(node) {
var isNullable;
var isOptional;
var type;
var desc;
var val;
- if ( node.type ) {
- if ( node.type.names.length === 1 ) {
- type = node.type.names[ 0 ];
+ if (node.type) {
+ if (node.type.names.length === 1) {
+ type = node.type.names[0];
} else {
type = node.type.names;
}
} else {
- type = '';
+ type = "";
}
- desc = node.description || '';
- if ( hasOwn.call( node, 'defaultvalue' ) ) {
+ desc = node.description || "";
+ if (hasOwn.call(node, "defaultvalue")) {
val = node.defaultvalue;
} else {
- val = '';
+ val = "";
}
- if ( typeof node.optional === 'boolean' ) {
+ if (typeof node.optional === "boolean") {
isOptional = node.optional;
} else {
- isOptional = '';
+ isOptional = "";
}
- if ( typeof node.nullable === 'boolean' ) {
+ if (typeof node.nullable === "boolean") {
isNullable = node.nullable;
} else {
- isNullable = '';
+ isNullable = "";
}
return {
- 'name': node.name,
- 'type': type,
- 'description': desc,
- 'default': val,
- 'optional': isOptional,
- 'nullable': isNullable
+ name: node.name,
+ type: type,
+ description: desc,
+ default: val,
+ optional: isOptional,
+ nullable: isNullable,
};
}
-
// MAIN //
/**
-* Transforms `params` doclet elements.
-*
-* @param {Object[]} nodes - doclet elements
-* @returns {Object[]} filtered objects
-*/
-function transform( nodes ) {
+ * Transforms `params` doclet elements.
+ *
+ * @param {Object[]} nodes - doclet elements
+ * @returns {Object[]} filtered objects
+ */
+function transform(nodes) {
var out;
var i;
- out = new Array( nodes.length );
- for ( i = 0; i < nodes.length; i++ ) {
- out[ i ] = filter( nodes[ i ] );
+ out = new Array(nodes.length);
+ for (i = 0; i < nodes.length; i++) {
+ out[i] = filter(nodes[i]);
}
return out;
}
-
// EXPORTS //
module.exports = transform;
diff --git a/tools/docs/jsdoc/templates/json/transforms/function/returns.js b/tools/docs/jsdoc/templates/json/transforms/function/returns.js
index 7f802c859441..f2dcb7d80e3b 100644
--- a/tools/docs/jsdoc/templates/json/transforms/function/returns.js
+++ b/tools/docs/jsdoc/templates/json/transforms/function/returns.js
@@ -1,31 +1,30 @@
-'use strict';
+"use strict";
/**
-* Transforms `returns` doclet elements.
-*
-* @param {Object[]} nodes - doclet elements
-* @returns {Object} filtered object
-*/
-function transform( nodes ) {
+ * Transforms `returns` doclet elements.
+ *
+ * @param {Object[]} nodes - doclet elements
+ * @returns {Object} filtered object
+ */
+function transform(nodes) {
var type;
var desc;
- if ( nodes[ 0 ].type ) {
- if ( nodes[ 0 ].type.names.length === 1 ) {
- type = nodes[ 0 ].type.names[ 0 ];
+ if (nodes[0].type) {
+ if (nodes[0].type.names.length === 1) {
+ type = nodes[0].type.names[0];
} else {
- type = nodes[ 0 ].type.names;
+ type = nodes[0].type.names;
}
} else {
- type = '';
+ type = "";
}
- desc = nodes[ 0 ].description || '';
+ desc = nodes[0].description || "";
return {
- 'type': type,
- 'description': desc
+ type: type,
+ description: desc,
};
}
-
// EXPORTS //
module.exports = transform;
diff --git a/tools/docs/jsdoc/templates/json/transforms/index.js b/tools/docs/jsdoc/templates/json/transforms/index.js
index 854c237c65d4..f19d5466f621 100644
--- a/tools/docs/jsdoc/templates/json/transforms/index.js
+++ b/tools/docs/jsdoc/templates/json/transforms/index.js
@@ -1,15 +1,14 @@
-'use strict';
+"use strict";
// MAIN //
var transforms = {};
-transforms.namespace = require( './namespace' );
-transforms.mixin = require( './mixin' );
-transforms.function = require( './function' );
-transforms.member = require( './member' );
-transforms.event = require( './event' );
-transforms.class = require( './class' );
-
+transforms.namespace = require("./namespace");
+transforms.mixin = require("./mixin");
+transforms.function = require("./function");
+transforms.member = require("./member");
+transforms.event = require("./event");
+transforms.class = require("./class");
// EXPORTS //
diff --git a/tools/docs/jsdoc/templates/json/transforms/member/index.js b/tools/docs/jsdoc/templates/json/transforms/member/index.js
index 4268b5f01bf4..e6cf8f031be0 100644
--- a/tools/docs/jsdoc/templates/json/transforms/member/index.js
+++ b/tools/docs/jsdoc/templates/json/transforms/member/index.js
@@ -1,32 +1,31 @@
-'use strict';
+"use strict";
/**
-* Transforms a `member` doclet element.
-*
-* @param {Object} node - doclet element
-* @returns {Object} filtered object
-*/
-function transform( node ) {
+ * Transforms a `member` doclet element.
+ *
+ * @param {Object} node - doclet element
+ * @returns {Object} filtered object
+ */
+function transform(node) {
var type;
- if ( node.type ) {
- if ( node.type.length === 1 ) {
- type = node.type[ 0 ];
+ if (node.type) {
+ if (node.type.length === 1) {
+ type = node.type[0];
} else {
type = node.type;
}
} else {
- type = '';
+ type = "";
}
return {
- 'name': node.name,
- 'description': node.description || '',
- 'type': type,
- 'access': node.access || '',
- 'virtual': !!node.virtual
+ name: node.name,
+ description: node.description || "",
+ type: type,
+ access: node.access || "",
+ virtual: !!node.virtual,
};
}
-
// EXPORTS //
module.exports = transform;
diff --git a/tools/docs/jsdoc/templates/json/transforms/mixin/index.js b/tools/docs/jsdoc/templates/json/transforms/mixin/index.js
index a5066744cc67..52c109c82ec0 100644
--- a/tools/docs/jsdoc/templates/json/transforms/mixin/index.js
+++ b/tools/docs/jsdoc/templates/json/transforms/mixin/index.js
@@ -1,21 +1,20 @@
-'use strict';
+"use strict";
/**
-* Transforms a `mixin` doclet element.
-*
-* @param {Object} node - doclet element
-* @returns {Object} filtered object
-*/
-function transform( node ) {
+ * Transforms a `mixin` doclet element.
+ *
+ * @param {Object} node - doclet element
+ * @returns {Object} filtered object
+ */
+function transform(node) {
return {
- 'name': node.name,
- 'description': node.description || '',
- 'access': node.access || '',
- 'virtual': !!node.virtual
+ name: node.name,
+ description: node.description || "",
+ access: node.access || "",
+ virtual: !!node.virtual,
};
}
-
// EXPORTS //
module.exports = transform;
diff --git a/tools/docs/jsdoc/templates/json/transforms/namespace/index.js b/tools/docs/jsdoc/templates/json/transforms/namespace/index.js
index 1fadcf107310..4a3e38757933 100644
--- a/tools/docs/jsdoc/templates/json/transforms/namespace/index.js
+++ b/tools/docs/jsdoc/templates/json/transforms/namespace/index.js
@@ -1,21 +1,20 @@
-'use strict';
+"use strict";
/**
-* Transforms a `namespace` doclet element.
-*
-* @param {Object} node - doclet element
-* @returns {Object} filtered object
-*/
-function transform( node ) {
+ * Transforms a `namespace` doclet element.
+ *
+ * @param {Object} node - doclet element
+ * @returns {Object} filtered object
+ */
+function transform(node) {
return {
- 'name': node.name,
- 'description': node.description || '',
- 'access': node.access || '',
- 'virtual': !!node.virtual
+ name: node.name,
+ description: node.description || "",
+ access: node.access || "",
+ virtual: !!node.virtual,
};
}
-
// EXPORTS //
module.exports = transform;
diff --git a/tools/docs/jsdoc/typedefs/README.md b/tools/docs/jsdoc/typedefs/README.md
index 6419bde73f66..a4e672144165 100644
--- a/tools/docs/jsdoc/typedefs/README.md
+++ b/tools/docs/jsdoc/typedefs/README.md
@@ -17,7 +17,6 @@ This directory contains [JSDoc][jsdoc] type definitions. Type definitions allow
<section class="links">
[jsdoc]: https://jsdoc.app/
-
[jsdoc-typedef]: https://jsdoc.app/tags-typedef.html
</section>
diff --git a/tools/docs/jsdoc/typedefs/arrays.js b/tools/docs/jsdoc/typedefs/arrays.js
index 39d8f333bd42..df3acf249d6f 100644
--- a/tools/docs/jsdoc/typedefs/arrays.js
+++ b/tools/docs/jsdoc/typedefs/arrays.js
@@ -1,157 +1,157 @@
/**
-* A typed array.
-*
-* @typedef {(Int8Array|Uint8Array|Uint8ClampedArray|Int16Array|Uint16Array|Int32Array|Uint32Array|Float32Array|Float64Array)} TypedArray
-*
-* @see [TypedArray]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray}
-* @see [Int8Array]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int8Array}
-* @see [Uint8Array]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array}
-* @see [Uint8ClampedArray]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8ClampedArray}
-* @see [Int16Array]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int16Array}
-* @see [Uint16Array]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint16Array}
-* @see [Int32Array]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int32Array}
-* @see [Uint32Array]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint32Array}
-* @see [Float32Array]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float32Array}
-* @see [Float64Array]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float64Array}
-*/
+ * A typed array.
+ *
+ * @typedef {(Int8Array|Uint8Array|Uint8ClampedArray|Int16Array|Uint16Array|Int32Array|Uint32Array|Float32Array|Float64Array)} TypedArray
+ *
+ * @see [TypedArray]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray}
+ * @see [Int8Array]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int8Array}
+ * @see [Uint8Array]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array}
+ * @see [Uint8ClampedArray]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8ClampedArray}
+ * @see [Int16Array]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int16Array}
+ * @see [Uint16Array]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint16Array}
+ * @see [Int32Array]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int32Array}
+ * @see [Uint32Array]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint32Array}
+ * @see [Float32Array]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float32Array}
+ * @see [Float64Array]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float64Array}
+ */
/**
-* An integer typed array.
-*
-* @typedef {(Int8Array|Uint8Array|Uint8ClampedArray|Int16Array|Uint16Array|Int32Array|Uint32Array)} IntegerTypedArray
-*
-* @see [TypedArray]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray}
-* @see [Int8Array]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int8Array}
-* @see [Uint8Array]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array}
-* @see [Uint8ClampedArray]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8ClampedArray}
-* @see [Int16Array]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int16Array}
-* @see [Uint16Array]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint16Array}
-* @see [Int32Array]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int32Array}
-* @see [Uint32Array]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint32Array}
-*/
+ * An integer typed array.
+ *
+ * @typedef {(Int8Array|Uint8Array|Uint8ClampedArray|Int16Array|Uint16Array|Int32Array|Uint32Array)} IntegerTypedArray
+ *
+ * @see [TypedArray]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray}
+ * @see [Int8Array]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int8Array}
+ * @see [Uint8Array]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array}
+ * @see [Uint8ClampedArray]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8ClampedArray}
+ * @see [Int16Array]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int16Array}
+ * @see [Uint16Array]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint16Array}
+ * @see [Int32Array]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int32Array}
+ * @see [Uint32Array]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint32Array}
+ */
/**
-* A numeric array.
-*
-* @typedef {(Array<number>|TypedArray)} NumericArray
-*/
+ * A numeric array.
+ *
+ * @typedef {(Array<number>|TypedArray)} NumericArray
+ */
/**
-* An array containing only number primitives.
-*
-* @typedef {Array<number>} NumberArray
-*/
+ * An array containing only number primitives.
+ *
+ * @typedef {Array<number>} NumberArray
+ */
/**
-* A numeric array containing only positive values.
-*
-* @typedef {NumericArray} PositiveNumericArray
-*/
+ * A numeric array containing only positive values.
+ *
+ * @typedef {NumericArray} PositiveNumericArray
+ */
/**
-* A numeric array containing only negative values.
-*
-* @typedef {NumericArray} NegativeNumericArray
-*/
+ * A numeric array containing only negative values.
+ *
+ * @typedef {NumericArray} NegativeNumericArray
+ */
/**
-* A numeric array containing only non-positive values.
-*
-* @typedef {NumericArray} NonPositiveNumericArray
-*/
+ * A numeric array containing only non-positive values.
+ *
+ * @typedef {NumericArray} NonPositiveNumericArray
+ */
/**
-* A numeric array containing only non-negative values.
-*
-* @typedef {NumericArray} NonNegativeNumericArray
-*/
+ * A numeric array containing only non-negative values.
+ *
+ * @typedef {NumericArray} NonNegativeNumericArray
+ */
/**
-* A numeric array containing only integer values.
-*
-* @typedef {(Array<number>|IntegerTypedArray)} IntegerArray
-*/
+ * A numeric array containing only integer values.
+ *
+ * @typedef {(Array<number>|IntegerTypedArray)} IntegerArray
+ */
/**
-* An integer array containing only positive integer values.
-*
-* @typedef {IntegerArray} PositiveIntegerArray
-*/
+ * An integer array containing only positive integer values.
+ *
+ * @typedef {IntegerArray} PositiveIntegerArray
+ */
/**
-* An integer array containing only negative integer values.
-*
-* @typedef {IntegerArray} NegativeIntegerArray
-*/
+ * An integer array containing only negative integer values.
+ *
+ * @typedef {IntegerArray} NegativeIntegerArray
+ */
/**
-* An integer array containing only non-positive integer values.
-*
-* @typedef {IntegerArray} NonPositiveIntegerArray
-*/
+ * An integer array containing only non-positive integer values.
+ *
+ * @typedef {IntegerArray} NonPositiveIntegerArray
+ */
/**
-* An integer array containing only nonnegative integer values.
-*
-* @typedef {IntegerArray} NonNegativeIntegerArray
-*/
+ * An integer array containing only nonnegative integer values.
+ *
+ * @typedef {IntegerArray} NonNegativeIntegerArray
+ */
/**
-* An array containing only string primitives.
-*
-* @typedef {Array<string>} StringArray
-*/
+ * An array containing only string primitives.
+ *
+ * @typedef {Array<string>} StringArray
+ */
/**
-* An array containing only boolean primitives.
-*
-* @typedef {Array<boolean>} BooleanArray
-*/
+ * An array containing only boolean primitives.
+ *
+ * @typedef {Array<boolean>} BooleanArray
+ */
/**
-* An array containing only plain objects.
-*
-* @typedef {Array<Object>} ObjectArray
-*/
+ * An array containing only plain objects.
+ *
+ * @typedef {Array<Object>} ObjectArray
+ */
/**
-* An array containing only functions.
-*
-* @typedef {Array<Function>} FunctionArray
-*/
+ * An array containing only functions.
+ *
+ * @typedef {Array<Function>} FunctionArray
+ */
/**
-* An array containing only other arrays.
-*
-* @typedef {Array<Array>} ArrayArray
-*/
+ * An array containing only other arrays.
+ *
+ * @typedef {Array<Array>} ArrayArray
+ */
/**
-* An empty array.
-*
-* @typedef {Array} EmptyArray
-*/
+ * An empty array.
+ *
+ * @typedef {Array} EmptyArray
+ */
/**
-* A numeric array in which all elements are non-negative and the sum of all elements is `1`.
-*
-* @typedef {NonNegativeNumericArray} ProbabilityArray
-*/
+ * A numeric array in which all elements are non-negative and the sum of all elements is `1`.
+ *
+ * @typedef {NonNegativeNumericArray} ProbabilityArray
+ */
/**
-* A 64-bit complex number array, in which the real and imaginary components are each stored as single-precision floating-point numbers.
-*
-* @typedef {Complex64Array} Complex64Array
-*/
+ * A 64-bit complex number array, in which the real and imaginary components are each stored as single-precision floating-point numbers.
+ *
+ * @typedef {Complex64Array} Complex64Array
+ */
/**
-* A 128-bit complex number array, in which the real and imaginary components are each stored as double-precision floating-point numbers.
-*
-* @typedef {Complex128Array} Complex128Array
-*/
+ * A 128-bit complex number array, in which the real and imaginary components are each stored as double-precision floating-point numbers.
+ *
+ * @typedef {Complex128Array} Complex128Array
+ */
/**
-* A complex number array.
-*
-* @typedef {(Complex64Array|Complex128Array)} ComplexArray
-*/
+ * A complex number array.
+ *
+ * @typedef {(Complex64Array|Complex128Array)} ComplexArray
+ */
diff --git a/tools/docs/jsdoc/typedefs/event_emitters.js b/tools/docs/jsdoc/typedefs/event_emitters.js
index 8d2ec607087a..5b30aa36697f 100644
--- a/tools/docs/jsdoc/typedefs/event_emitters.js
+++ b/tools/docs/jsdoc/typedefs/event_emitters.js
@@ -1,63 +1,63 @@
/**
-* An object which emits events.
-*
-* @typedef {Object} EventEmitter
-*
-* @see Node.js EventEmitter [documentation]{@link https://nodejs.org/api/events.html}
-*/
+ * An object which emits events.
+ *
+ * @typedef {Object} EventEmitter
+ *
+ * @see Node.js EventEmitter [documentation]{@link https://nodejs.org/api/events.html}
+ */
/**
-* A stream interface for reading from a data source.
-*
-* @typedef {EventEmitter} ReadableStream
-*
-* @see Node.js stream [documentation]{@link https://nodejs.org/api/stream.html}
-*/
+ * A stream interface for reading from a data source.
+ *
+ * @typedef {EventEmitter} ReadableStream
+ *
+ * @see Node.js stream [documentation]{@link https://nodejs.org/api/stream.html}
+ */
/**
-* A stream interface for writing to a destination.
-*
-* @typedef {EventEmitter} WritableStream
-*
-* @see Node.js stream [documentation]{@link https://nodejs.org/api/stream.html}
-*/
+ * A stream interface for writing to a destination.
+ *
+ * @typedef {EventEmitter} WritableStream
+ *
+ * @see Node.js stream [documentation]{@link https://nodejs.org/api/stream.html}
+ */
/**
-* A stream interface implementing both readable and writable stream interfaces.
-*
-* @typedef {EventEmitter} DuplexStream
-*
-* @see Node.js stream [documentation]{@link https://nodejs.org/api/stream.html}
-*/
+ * A stream interface implementing both readable and writable stream interfaces.
+ *
+ * @typedef {EventEmitter} DuplexStream
+ *
+ * @see Node.js stream [documentation]{@link https://nodejs.org/api/stream.html}
+ */
/**
-* A duplex stream where the output is causally connected to the input.
-*
-* @typedef {DuplexStream} TransformStream
-*
-* @see Node.js stream [documentation]{@link https://nodejs.org/api/stream.html}
-*/
+ * A duplex stream where the output is causally connected to the input.
+ *
+ * @typedef {DuplexStream} TransformStream
+ *
+ * @see Node.js stream [documentation]{@link https://nodejs.org/api/stream.html}
+ */
/**
-* A Node.js stream.
-*
-* @typedef {(ReadableStream|WritableStream|DuplexStream|TransformStream)} Stream
-*
-* @see Node.js stream [documentation]{@link https://nodejs.org/api/stream.html}
-*/
+ * A Node.js stream.
+ *
+ * @typedef {(ReadableStream|WritableStream|DuplexStream|TransformStream)} Stream
+ *
+ * @see Node.js stream [documentation]{@link https://nodejs.org/api/stream.html}
+ */
/**
-* An HTTP request object. This object provides access request status, headers, and data and implements the [Readable Stream]{@link https://nodejs.org/api/stream.html} interface.
-*
-* @typedef {EventEmitter} IncomingMessage
-*
-* @see Node.js HTTP [documentation]{@link https://nodejs.org/api/http.html}
-*/
+ * An HTTP request object. This object provides access request status, headers, and data and implements the [Readable Stream]{@link https://nodejs.org/api/stream.html} interface.
+ *
+ * @typedef {EventEmitter} IncomingMessage
+ *
+ * @see Node.js HTTP [documentation]{@link https://nodejs.org/api/http.html}
+ */
/**
-* An HTTP response object. This object implements, but does not inherit from, the [Writable Stream]{@link https://nodejs.org/api/stream.html} interface.
-*
-* @typedef {EventEmitter} ServerResponse
-*
-* @see Node.js HTTP [documentation]{@link https://nodejs.org/api/http.html}
-*/
+ * An HTTP response object. This object implements, but does not inherit from, the [Writable Stream]{@link https://nodejs.org/api/stream.html} interface.
+ *
+ * @typedef {EventEmitter} ServerResponse
+ *
+ * @see Node.js HTTP [documentation]{@link https://nodejs.org/api/http.html}
+ */
diff --git a/tools/docs/jsdoc/typedefs/functions.js b/tools/docs/jsdoc/typedefs/functions.js
index ba0b1255e99d..38fa90033461 100644
--- a/tools/docs/jsdoc/typedefs/functions.js
+++ b/tools/docs/jsdoc/typedefs/functions.js
@@ -1,11 +1,11 @@
/**
-* A function to be invoked after completing an asynchronous task.
-*
-* @typedef {Function} Callback
-*/
+ * A function to be invoked after completing an asynchronous task.
+ *
+ * @typedef {Function} Callback
+ */
/**
-* A callback whose first argument is either an `Error` or `null`.
-*
-* @typedef {Callback} Errback
-*/
+ * A callback whose first argument is either an `Error` or `null`.
+ *
+ * @typedef {Callback} Errback
+ */
diff --git a/tools/docs/jsdoc/typedefs/index.js b/tools/docs/jsdoc/typedefs/index.js
index d1c465040b35..d3c7b32e89a8 100644
--- a/tools/docs/jsdoc/typedefs/index.js
+++ b/tools/docs/jsdoc/typedefs/index.js
@@ -1,5 +1,5 @@
/**
-* A JavaScript primitive.
-*
-* @typedef {(number|string|boolean|null|undefined)} primitive
-*/
+ * A JavaScript primitive.
+ *
+ * @typedef {(number|string|boolean|null|undefined)} primitive
+ */
diff --git a/tools/docs/jsdoc/typedefs/ndarray.js b/tools/docs/jsdoc/typedefs/ndarray.js
index bff44cd4e4cb..9051adf8c9a3 100644
--- a/tools/docs/jsdoc/typedefs/ndarray.js
+++ b/tools/docs/jsdoc/typedefs/ndarray.js
@@ -1,35 +1,35 @@
/**
-* A multi-dimensional strided array.
-*
-* @typedef {Object} ndarray
-*/
+ * A multi-dimensional strided array.
+ *
+ * @typedef {Object} ndarray
+ */
/**
-* A 1-dimensional strided array.
-*
-* @typedef {ndarray} Vector
-*/
+ * A 1-dimensional strided array.
+ *
+ * @typedef {ndarray} Vector
+ */
/**
-* A 2-dimensional strided array.
-*
-* @typedef {ndarray} Matrix
-*/
+ * A 2-dimensional strided array.
+ *
+ * @typedef {ndarray} Matrix
+ */
/**
-* An ndarray-like object.
-*
-* @typedef {Object} ndarrayLike
-*/
+ * An ndarray-like object.
+ *
+ * @typedef {Object} ndarrayLike
+ */
/**
-* A 1-dimensional ndarray-like object.
-*
-* @typedef {Object} VectorLike
-*/
+ * A 1-dimensional ndarray-like object.
+ *
+ * @typedef {Object} VectorLike
+ */
/**
-* A 2-dimensional ndarray-like object.
-*
-* @typedef {Object} MatrixLike
-*/
+ * A 2-dimensional ndarray-like object.
+ *
+ * @typedef {Object} MatrixLike
+ */
diff --git a/tools/docs/jsdoc/typedefs/numbers.js b/tools/docs/jsdoc/typedefs/numbers.js
index 10759dbe7e42..1dc823739c35 100644
--- a/tools/docs/jsdoc/typedefs/numbers.js
+++ b/tools/docs/jsdoc/typedefs/numbers.js
@@ -1,206 +1,206 @@
/**
-* A double-precision floating-point number.
-*
-* @typedef {number} Float64
-*
-* @see [IEEE 754]{@link https://en.wikipedia.org/wiki/IEEE_754-1985}
-*/
+ * A double-precision floating-point number.
+ *
+ * @typedef {number} Float64
+ *
+ * @see [IEEE 754]{@link https://en.wikipedia.org/wiki/IEEE_754-1985}
+ */
/**
-* A single-precision floating-point number.
-*
-* @typedef {number} Float32
-*
-* @see [IEEE 754]{@link https://en.wikipedia.org/wiki/IEEE_754-1985}
-*/
+ * A single-precision floating-point number.
+ *
+ * @typedef {number} Float32
+ *
+ * @see [IEEE 754]{@link https://en.wikipedia.org/wiki/IEEE_754-1985}
+ */
/**
-* A half-precision floating-point number.
-*
-* @typedef {number} Float16
-*
-* @see [IEEE 754]{@link https://en.wikipedia.org/wiki/IEEE_754-1985}
-*/
+ * A half-precision floating-point number.
+ *
+ * @typedef {number} Float16
+ *
+ * @see [IEEE 754]{@link https://en.wikipedia.org/wiki/IEEE_754-1985}
+ */
/**
-* A 128-bit signed integer.
-*
-* @typedef {number} Int128
-*/
+ * A 128-bit signed integer.
+ *
+ * @typedef {number} Int128
+ */
/**
-* A 128-bit unsigned integer.
-*
-* @typedef {number} Uint128
-*/
+ * A 128-bit unsigned integer.
+ *
+ * @typedef {number} Uint128
+ */
/**
-* A 64-bit signed integer.
-*
-* @typedef {number} Int64
-*/
+ * A 64-bit signed integer.
+ *
+ * @typedef {number} Int64
+ */
/**
-* A 64-bit unsigned integer.
-*
-* @typedef {number} Uint64
-*/
+ * A 64-bit unsigned integer.
+ *
+ * @typedef {number} Uint64
+ */
/**
-* A 32-bit signed integer.
-*
-* @typedef {number} Int32
-*/
+ * A 32-bit signed integer.
+ *
+ * @typedef {number} Int32
+ */
/**
-* A 32-bit unsigned integer.
-*
-* @typedef {number} Uint32
-*/
+ * A 32-bit unsigned integer.
+ *
+ * @typedef {number} Uint32
+ */
/**
-* A 16-bit signed integer.
-*
-* @typedef {number} Int16
-*/
+ * A 16-bit signed integer.
+ *
+ * @typedef {number} Int16
+ */
/**
-* A 16-bit unsigned integer.
-*
-* @typedef {number} Uint16
-*/
+ * A 16-bit unsigned integer.
+ *
+ * @typedef {number} Uint16
+ */
/**
-* An 8-bit signed integer.
-*
-* @typedef {number} Int8
-*/
+ * An 8-bit signed integer.
+ *
+ * @typedef {number} Int8
+ */
/**
-* An 8-bit unsigned integer.
-*
-* @typedef {number} Uint8
-*/
+ * An 8-bit unsigned integer.
+ *
+ * @typedef {number} Uint8
+ */
/**
-* A number primitive which has an integer value.
-*
-* @typedef {number} integer
-*/
+ * A number primitive which has an integer value.
+ *
+ * @typedef {number} integer
+ */
/**
-* A number primitive which has an integer value on the interval `[-2147483648, 2147483647]`. This number may be interpreted by the runtime engine as a 32-bit integer, which may very well be the case after performing bitwise operations; e.g., `3.14|0`.
-*
-* @typedef {number} integer32
-*
-* @see [bitwise operators]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Bitwise_Operators}
-* @see [asm.js]{@link http://asmjs.org/spec/latest/}
-*/
+ * A number primitive which has an integer value on the interval `[-2147483648, 2147483647]`. This number may be interpreted by the runtime engine as a 32-bit integer, which may very well be the case after performing bitwise operations; e.g., `3.14|0`.
+ *
+ * @typedef {number} integer32
+ *
+ * @see [bitwise operators]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Bitwise_Operators}
+ * @see [asm.js]{@link http://asmjs.org/spec/latest/}
+ */
/**
-* A number primitive which has an integer value on the interval `[0, 4294967295]`.
-*
-* @typedef {number} uinteger32
-*/
+ * A number primitive which has an integer value on the interval `[0, 4294967295]`.
+ *
+ * @typedef {number} uinteger32
+ */
/**
-* A number primitive which has an integer value on the interval `[−32768, 32767]`.
-*
-* @typedef {number} integer16
-*/
+ * A number primitive which has an integer value on the interval `[−32768, 32767]`.
+ *
+ * @typedef {number} integer16
+ */
/**
-* A number primitive which has an integer value on the interval `[0, 65535]`.
-*
-* @typedef {number} uinteger16
-*/
+ * A number primitive which has an integer value on the interval `[0, 65535]`.
+ *
+ * @typedef {number} uinteger16
+ */
/**
-* A number primitive which has an integer value on the interval `[-128,127]`.
-*
-* @typedef {number} integer8
-*/
+ * A number primitive which has an integer value on the interval `[-128,127]`.
+ *
+ * @typedef {number} integer8
+ */
/**
-* A number primitive which has an integer value on the interval `[0,255]`.
-*
-* @typedef {number} uinteger8
-*/
+ * A number primitive which has an integer value on the interval `[0,255]`.
+ *
+ * @typedef {number} uinteger8
+ */
/**
-* A number primitive which has a nonnegative integer value.
-*
-* @typedef {integer} NonNegativeInteger
-*/
+ * A number primitive which has a nonnegative integer value.
+ *
+ * @typedef {integer} NonNegativeInteger
+ */
/**
-* A number primitive which has a positive integer value.
-*
-* @typedef {integer} PositiveInteger
-*/
+ * A number primitive which has a positive integer value.
+ *
+ * @typedef {integer} PositiveInteger
+ */
/**
-* A number primitive which has a nonpositive integer value.
-*
-* @typedef {integer} NonPositiveInteger
-*/
+ * A number primitive which has a nonpositive integer value.
+ *
+ * @typedef {integer} NonPositiveInteger
+ */
/**
-* A number primitive which has a negative integer value.
-*
-* @typedef {integer} NegativeInteger
-*/
+ * A number primitive which has a negative integer value.
+ *
+ * @typedef {integer} NegativeInteger
+ */
/**
-* A number primitive which has a nonnegative value.
-*
-* @typedef {number} NonNegativeNumber
-*/
+ * A number primitive which has a nonnegative value.
+ *
+ * @typedef {number} NonNegativeNumber
+ */
/**
-* A number primitive which has a positive value.
-*
-* @typedef {number} PositiveNumber
-*/
+ * A number primitive which has a positive value.
+ *
+ * @typedef {number} PositiveNumber
+ */
/**
-* A number primitive which has a nonpositive value.
-*
-* @typedef {number} NonPositiveNumber
-*/
+ * A number primitive which has a nonpositive value.
+ *
+ * @typedef {number} NonPositiveNumber
+ */
/**
-* A number primitive which has a negative value.
-*
-* @typedef {number} NegativeNumber
-*/
+ * A number primitive which has a negative value.
+ *
+ * @typedef {number} NegativeNumber
+ */
/**
-* A finite number primitive; i.e., neither `NaN` or positive or negative infinity.
-*
-* @typedef {number} FiniteNumber
-*/
+ * A finite number primitive; i.e., neither `NaN` or positive or negative infinity.
+ *
+ * @typedef {number} FiniteNumber
+ */
/**
-* A number primitive on the interval `[0,1]`.
-*
-* @typedef {number} Probability
-*/
+ * A number primitive on the interval `[0,1]`.
+ *
+ * @typedef {number} Probability
+ */
/**
-* A 64-bit complex number, in which the real and imaginary components are each stored as single-precision floating-point numbers.
-*
-* @typedef {Object} Complex64
-*/
+ * A 64-bit complex number, in which the real and imaginary components are each stored as single-precision floating-point numbers.
+ *
+ * @typedef {Object} Complex64
+ */
/**
-* A 128-bit complex number, in which the real and imaginary components are each stored as double-precision floating-point numbers.
-*
-* @typedef {Object} Complex128
-*/
+ * A 128-bit complex number, in which the real and imaginary components are each stored as double-precision floating-point numbers.
+ *
+ * @typedef {Object} Complex128
+ */
/**
-* A complex number.
-*
-* @typedef {(Complex64|Complex128)} Complex
-*/
+ * A complex number.
+ *
+ * @typedef {(Complex64|Complex128)} Complex
+ */
diff --git a/tools/docs/jsdoc/typedefs/objects.js b/tools/docs/jsdoc/typedefs/objects.js
index d139446e671a..336066707cc8 100644
--- a/tools/docs/jsdoc/typedefs/objects.js
+++ b/tools/docs/jsdoc/typedefs/objects.js
@@ -1,89 +1,89 @@
/**
-* An array-like object.
-*
-* @typedef {(Array|string|String|Object)} ArrayLike
-*/
+ * An array-like object.
+ *
+ * @typedef {(Array|string|String|Object)} ArrayLike
+ */
/**
-* An array-like object (excluding string primitives).
-*
-* @typedef {(Array|String|Object)} ArrayLikeObject
-*/
+ * An array-like object (excluding string primitives).
+ *
+ * @typedef {(Array|String|Object)} ArrayLikeObject
+ */
/**
-* A plain object; i.e., either `{}` or an object created via `Object.create( null )`.
-*
-* @typedef {Object} PlainObject
-*/
+ * A plain object; i.e., either `{}` or an object created via `Object.create( null )`.
+ *
+ * @typedef {Object} PlainObject
+ */
/**
-* A value which is object-like. Basically, any value which is not `null` and, when operated on by `typeof`, returns `object`.
-*
-* @typedef {Object} ObjectLike
-*/
+ * A value which is object-like. Basically, any value which is not `null` and, when operated on by `typeof`, returns `object`.
+ *
+ * @typedef {Object} ObjectLike
+ */
/**
-* An object which is valid JSON.
-*
-* @typedef {PlainObject} JSON
-*
-* @see [JSON]{@link http://www.json.org/}
-*/
+ * An object which is valid JSON.
+ *
+ * @typedef {PlainObject} JSON
+ *
+ * @see [JSON]{@link http://www.json.org/}
+ */
/**
-* An object containing function options.
-*
-* @typedef {PlainObject} Options
-*/
+ * An object containing function options.
+ *
+ * @typedef {PlainObject} Options
+ */
/**
-* An object that creates a namespace for its members.
-*
-* @typedef {Object} Namespace
-*/
+ * An object that creates a namespace for its members.
+ *
+ * @typedef {Object} Namespace
+ */
/**
-* A Node.js `Buffer` instance.
-*
-* @typedef {(Object|Uint8Array)} Buffer
-*
-* @see [Buffer]{@link https://nodejs.org/api/buffer.html}
-*/
+ * A Node.js `Buffer` instance.
+ *
+ * @typedef {(Object|Uint8Array)} Buffer
+ *
+ * @see [Buffer]{@link https://nodejs.org/api/buffer.html}
+ */
/**
-* A collection, which is defined as either an array, typed array, or an array-like object (excluding strings and functions).
-*
-* @typedef {(Array|TypedArray|Object)} Collection
-*/
+ * A collection, which is defined as either an array, typed array, or an array-like object (excluding strings and functions).
+ *
+ * @typedef {(Array|TypedArray|Object)} Collection
+ */
/**
-* An instance of the built-in `Date` object.
-*
-* @typedef {Date} Date
-*
-* @see [Date]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date}
-*/
+ * An instance of the built-in `Date` object.
+ *
+ * @typedef {Date} Date
+ *
+ * @see [Date]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date}
+ */
/**
-* An instance of the built-in `RegExp` object.
-*
-* @typedef {RegExp} RegExp
-*
-* @see [RegExp]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp}
-*/
+ * An instance of the built-in `RegExp` object.
+ *
+ * @typedef {RegExp} RegExp
+ *
+ * @see [RegExp]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp}
+ */
/**
-* An iterator protocol-compliant object.
-*
-* @typeof {Object} Iterator
-*
-* @see [Iteration protocols]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols}
-*/
+ * An iterator protocol-compliant object.
+ *
+ * @typeof {Object} Iterator
+ *
+ * @see [Iteration protocols]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols}
+ */
/**
-* An iterable protocol-compliant object.
-*
-* @typeof {Object} Iterable
-*
-* @see [Iteration protocols]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols}
-*/
+ * An iterable protocol-compliant object.
+ *
+ * @typeof {Object} Iterable
+ *
+ * @see [Iteration protocols]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols}
+ */
diff --git a/tools/docs/jsdoc/typedefs/random.js b/tools/docs/jsdoc/typedefs/random.js
index 1aaaddb2ae3a..43494a45ad7f 100644
--- a/tools/docs/jsdoc/typedefs/random.js
+++ b/tools/docs/jsdoc/typedefs/random.js
@@ -1,29 +1,29 @@
/**
-* A pseudorandom number generator (PRNG).
-*
-* @type {Function} PRNG
-*/
+ * A pseudorandom number generator (PRNG).
+ *
+ * @type {Function} PRNG
+ */
/**
-* A pseudorandom number generator (PRNG) seed for the 32-bit Mersenne Twister (MT19937) PRNG.
-*
-* @type {(uinteger32|Collection<uinteger32>)} PRNGSeedMT19937
-*/
+ * A pseudorandom number generator (PRNG) seed for the 32-bit Mersenne Twister (MT19937) PRNG.
+ *
+ * @type {(uinteger32|Collection<uinteger32>)} PRNGSeedMT19937
+ */
/**
-* A pseudorandom number generator (PRNG) state for the 32-bit Mersenne Twister (MT19937) PRNG.
-*
-* @type {Uint32Array} PRNGStateMT19937
-*/
+ * A pseudorandom number generator (PRNG) state for the 32-bit Mersenne Twister (MT19937) PRNG.
+ *
+ * @type {Uint32Array} PRNGStateMT19937
+ */
/**
-* A pseudorandom number generator (PRNG) seed for the MINSTD PRNG.
-*
-* @type {(integer32|Collection<integer32>)} PRNGSeedMINSTD
-*/
+ * A pseudorandom number generator (PRNG) seed for the MINSTD PRNG.
+ *
+ * @type {(integer32|Collection<integer32>)} PRNGSeedMINSTD
+ */
/**
-* A pseudorandom number generator (PRNG) state for the MINSTD PRNG.
-*
-* @type {Int32Array} PRNGStateMINSTD
-*/
+ * A pseudorandom number generator (PRNG) state for the MINSTD PRNG.
+ *
+ * @type {Int32Array} PRNGStateMINSTD
+ */
diff --git a/tools/docs/jsdoc/typedefs/strings.js b/tools/docs/jsdoc/typedefs/strings.js
index 785c3f99cf05..c36634611f5e 100644
--- a/tools/docs/jsdoc/typedefs/strings.js
+++ b/tools/docs/jsdoc/typedefs/strings.js
@@ -1,13 +1,13 @@
/**
-* A string which only contains `'0'` and `'1'` characters.
-*
-* @typedef {string} BinaryString
-*/
+ * A string which only contains `'0'` and `'1'` characters.
+ *
+ * @typedef {string} BinaryString
+ */
/**
-* A string primitive which is a valid URI.
-*
-* @typedef {string} URI
-*
-* @see [URI]{@link https://en.wikipedia.org/wiki/Uniform_Resource_Identifier}
-*/
+ * A string primitive which is a valid URI.
+ *
+ * @typedef {string} URI
+ *
+ * @see [URI]{@link https://en.wikipedia.org/wiki/Uniform_Resource_Identifier}
+ */
diff --git a/tools/git/hooks/README.md b/tools/git/hooks/README.md
index 33319920dc3a..f4b0e7901681 100644
--- a/tools/git/hooks/README.md
+++ b/tools/git/hooks/README.md
@@ -17,7 +17,6 @@ This directory contains [scripts][git-hooks] which execute when certain actions
<section class="links">
[git]: https://git-scm.com/
-
[git-hooks]: https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks
</section>
diff --git a/tools/lint/julia/README.md b/tools/lint/julia/README.md
index 42e022986ede..ddc1f861e9fb 100644
--- a/tools/lint/julia/README.md
+++ b/tools/lint/julia/README.md
@@ -22,7 +22,7 @@ Usage: <linter.jl> <file> <file> <file> ...
### Notes
-- Each provided filepath is resolved relative to the current working directory of the calling process.
+- Each provided filepath is resolved relative to the current working directory of the calling process.
</section>
diff --git a/tools/lint/r/README.md b/tools/lint/r/README.md
index 44a125b09803..bd12b6622095 100644
--- a/tools/lint/r/README.md
+++ b/tools/lint/r/README.md
@@ -22,7 +22,7 @@ Usage: <linter.R> <file> <file> <file> ...
### Notes
-- Each provided filepath is resolved relative to the current working directory of the calling process.
+- Each provided filepath is resolved relative to the current working directory of the calling process.
</section>
diff --git a/tools/lint/travis-conf/README.md b/tools/lint/travis-conf/README.md
index b02a7caeffa4..6cd04d39452b 100644
--- a/tools/lint/travis-conf/README.md
+++ b/tools/lint/travis-conf/README.md
@@ -22,7 +22,7 @@ Usage: <lint> <filepath>
### Notes
-- The provided `filepath` should be an absolute file path.
+- The provided `filepath` should be an absolute file path.
</section>
diff --git a/tools/make/README.md b/tools/make/README.md
index a2b918d0eeea..92ed58acc5c6 100644
--- a/tools/make/README.md
+++ b/tools/make/README.md
@@ -22,7 +22,7 @@ limitations under the License.
> Development utility.
-This project uses [`make`][make] as its development utility. For an overview of `make`, see the `make` [manual][make].
+This project uses [`make`][make] as its development utility. For an overview of `make`, see the `make` [manual][make].
## Usage
@@ -34,7 +34,7 @@ To view a list of available `Makefile` targets,
$ make help
```
-* * *
+---
#### REPL
@@ -44,7 +44,7 @@ To launch a REPL,
$ make repl
```
-* * *
+---
#### Notes
@@ -54,9 +54,9 @@ Annotating source code is a useful means for inlining action items and notes. Fo
```javascript
// FIXME: don't release the zalgo!
-function foo( cb ) {
- if ( bar ) {
- return asyncFcn( cb );
+function foo(cb) {
+ if (bar) {
+ return asyncFcn(cb);
}
cb();
}
@@ -70,14 +70,14 @@ $ make notes
The following annotations are recognized:
-- **TODO**: annotates a future task.
-- **FIXME**: annotates a problem.
-- **HACK**: annotates fragile/non-general solutions.
-- **WARNING**: annotates possible pitfalls or gotchas.
-- **OPTIMIZE**: annotates code which needs optimizing.
-- **NOTE**: annotates questions, comments, or anything which does not fit under `TODO`/`FIXME`/`HACK`/`WARNING`/`OPTIMIZE` and should be brought to a reader's attention.
+- **TODO**: annotates a future task.
+- **FIXME**: annotates a problem.
+- **HACK**: annotates fragile/non-general solutions.
+- **WARNING**: annotates possible pitfalls or gotchas.
+- **OPTIMIZE**: annotates code which needs optimizing.
+- **NOTE**: annotates questions, comments, or anything which does not fit under `TODO`/`FIXME`/`HACK`/`WARNING`/`OPTIMIZE` and should be brought to a reader's attention.
-* * *
+---
#### Files
@@ -103,9 +103,9 @@ $ make FILES_FILTER=".*/assert/is-nan/.*" list-files
**Notes**:
-- Most filters should begin with `.*/` and end with `/.*`, as a filter is used as a regular expression to test a file path.
+- Most filters should begin with `.*/` and end with `/.*`, as a filter is used as a regular expression to test a file path.
-- The `*_PATTERN` and `*_FILTER` environment variables map to `-name` and `-regex` options, respectively, for the `find` command. For certain types of operations, like regular expressions using `|` for alternative matches, you may need to use `*_FILTER` over `*_PATTERN`. For instance,
+- The `*_PATTERN` and `*_FILTER` environment variables map to `-name` and `-regex` options, respectively, for the `find` command. For certain types of operations, like regular expressions using `|` for alternative matches, you may need to use `*_FILTER` over `*_PATTERN`. For instance,
```bash
# List all `R` test fixtures...
@@ -254,7 +254,7 @@ To list all package names under a `@stdlib` descendant directory,
$ make SRC_DIR=./@stdlib/math/base list-pkgs-names
```
-* * *
+---
#### Package Examples
@@ -271,7 +271,7 @@ To limit which examples are run, use the same environment variables recognized b
$ make EXAMPLES_FILTER=".*/math/base/special/.*" EXAMPLES_PATTERN=index.js examples
```
-* * *
+---
#### Unit Tests
@@ -378,7 +378,7 @@ $ make TESTS_FILTER=".*/math/base/utils/.*" test-browsers
$ make TESTS_FILTER=".*/\@stdlib/utils/.*" test-view-browsers
```
-* * *
+---
#### Benchmarks
@@ -395,7 +395,7 @@ To limit which benchmarks are run, use the same environment variables recognized
$ make BENCHMARKS_FILTER=".*/math/base/special/.*" BENCHMARKS_PATTERN=benchmark.js benchmark
```
-* * *
+---
#### Documentation
@@ -411,7 +411,7 @@ To view the documentation in a local web browser,
$ make view-src-docs
```
-* * *
+---
#### Lint
@@ -469,7 +469,7 @@ To lint `package.json` files,
$ make lint-pkg-json
```
-* * *
+---
#### Complexity
@@ -509,7 +509,7 @@ To analyze only JavaScript files,
$ make SOURCES_FILTER=... TESTS_FILTER=... EXAMPLES_FILTER=... complexity-javascript
```
-* * *
+---
#### Dependencies
@@ -525,7 +525,7 @@ To check licenses of installed package dependencies,
$ make check-licenses
```
-* * *
+---
#### Bash Completion
@@ -546,11 +546,8 @@ and does not include targets declared via variables. Excluded targets could be i
<section class="links">
[make]: https://www.gnu.org/software/make/manual/make.html#Introduction
-
[jsdoc]: https://jsdoc.app/
-
[nvm]: https://github.com/creationix/nvm
-
[bash-completion]: https://www.gnu.org/software/bash/manual/bashref.html#Programmable-Completion
</section>
diff --git a/tools/make/lib/benchmark/README.md b/tools/make/lib/benchmark/README.md
index 151dbbad39d1..67bfd0590b7a 100644
--- a/tools/make/lib/benchmark/README.md
+++ b/tools/make/lib/benchmark/README.md
@@ -56,7 +56,7 @@ $ make benchmark
The command supports the following environment variables:
-- **BENCHMARKS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **BENCHMARKS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
This command is an **alias** for `benchmark-javascript`, which is documented below.
@@ -72,9 +72,9 @@ $ make benchmark-lang
The command supports the environment variables supported by each language-specific (`benchmark-<lang>`) command documented below.
-This command is useful when wanting to glob for benchmark files, irrespective of language, for a particular package in order to compare cross-language performance.
+This command is useful when wanting to glob for benchmark files, irrespective of language, for a particular package in order to compare cross-language performance.
-* * *
+---
### C
@@ -92,10 +92,10 @@ $ make benchmark-c
The command supports the following environment variables:
-- **BENCHMARKS_FILTER**: file path pattern; e.g., `.*/math/base/special/abs/.*`.
-- **BLAS**: BLAS library name; e.g., `openblas`.
-- **BLAS_DIR**: BLAS directory.
-- **C_COMPILER**: C compiler; e.g., `gcc`.
+- **BENCHMARKS_FILTER**: file path pattern; e.g., `.*/math/base/special/abs/.*`.
+- **BLAS**: BLAS library name; e.g., `openblas`.
+- **BLAS_DIR**: BLAS directory.
+- **C_COMPILER**: C compiler; e.g., `gcc`.
This command is useful when wanting to glob for C benchmark files (e.g., run all C benchmarks for a particular package).
@@ -111,14 +111,14 @@ $ make benchmark-c-files FILES='/foo/benchmark.c /bar/benchmark.c'
The command supports the following environment variables:
-- **FILES**: list of C benchmark files.
-- **BLAS**: BLAS library name; e.g., `openblas`.
-- **BLAS_DIR**: BLAS directory.
-- **C_COMPILER**: C compiler; e.g., `gcc`.
+- **FILES**: list of C benchmark files.
+- **BLAS**: BLAS library name; e.g., `openblas`.
+- **BLAS_DIR**: BLAS directory.
+- **C_COMPILER**: C compiler; e.g., `gcc`.
This command is useful when wanting to run a list of C benchmark files generated by some other command (e.g., a filtered list of changed C benchmark files obtained via `git diff`).
-* * *
+---
### C++
@@ -136,8 +136,8 @@ $ make benchmark-cpp
The command supports the following environment variables:
-- **BENCHMARKS_FILTER**: file path pattern; e.g., `.*/math/base/special/beta/.*`.
-- **CXX_COMPILER**: C++ compiler; e.g., `g++`.
+- **BENCHMARKS_FILTER**: file path pattern; e.g., `.*/math/base/special/beta/.*`.
+- **CXX_COMPILER**: C++ compiler; e.g., `g++`.
This command is useful when wanting to glob for C++ benchmark files (e.g., run all C++ benchmarks for a particular package).
@@ -153,12 +153,12 @@ $ make benchmark-cpp-files FILES='/foo/benchmark.cpp /bar/benchmark.cpp'
The command supports the following environment variables:
-- **FILES**: list of C++ benchmark files.
-- **CXX_COMPILER**: C++ compiler; e.g., `g++`.
+- **FILES**: list of C++ benchmark files.
+- **CXX_COMPILER**: C++ compiler; e.g., `g++`.
This command is useful when wanting to run a list of C++ benchmark files generated by some other command (e.g., a filtered list of changed C++ benchmark files obtained via `git diff`).
-* * *
+---
### Fortran
@@ -176,8 +176,8 @@ $ make benchmark-fortran
The command supports the following environment variables:
-- **BENCHMARKS_FILTER**: file path pattern; e.g., `.*/blas/base/daxpy/.*`.
-- **FORTRAN_COMPILER**: Fortran compiler; e.g., `gfortran`.
+- **BENCHMARKS_FILTER**: file path pattern; e.g., `.*/blas/base/daxpy/.*`.
+- **FORTRAN_COMPILER**: Fortran compiler; e.g., `gfortran`.
This command is useful when wanting to glob for Fortran benchmark files (e.g., run all Fortran benchmarks for a particular package).
@@ -193,12 +193,12 @@ $ make benchmark-fortran-files FILES='/foo/benchmark.f /bar/benchmark.f'
The command supports the following environment variables:
-- **FILES**: list of Fortran benchmark files.
-- **FORTRAN_COMPILER**: Fortran compiler; e.g., `gfortran`.
+- **FILES**: list of Fortran benchmark files.
+- **FORTRAN_COMPILER**: Fortran compiler; e.g., `gfortran`.
This command is useful when wanting to run a list of Fortran benchmark files generated by some other command (e.g., a filtered list of changed Fortran benchmark files obtained via `git diff`).
-* * *
+---
### JavaScript
@@ -214,7 +214,7 @@ $ make benchmark-javascript
The command supports the following environment variables:
-- **BENCHMARKS_FILTER**: file path pattern; e.g., `.*/utils/group-by/.*`.
+- **BENCHMARKS_FILTER**: file path pattern; e.g., `.*/utils/group-by/.*`.
This command is useful when wanting to glob for JavaScript benchmark files (e.g., run all JavaScript benchmarks for a particular package).
@@ -230,11 +230,11 @@ $ make benchmark-javascript-files FILES='/foo/benchmark.js /bar/benchmark.js'
The command supports the following environment variables:
-- **FILES**: list of JavaScript benchmark files.
+- **FILES**: list of JavaScript benchmark files.
This command is useful when wanting to run a list of JavaScript benchmark files generated by some other command (e.g., a filtered list of changed JavaScript benchmark files obtained via `git diff`).
-* * *
+---
### Julia
@@ -250,7 +250,7 @@ $ make benchmark-julia
The command supports the following environment variables:
-- **BENCHMARKS_FILTER**: file path pattern; e.g., `.*/math/base/special/erf/.*`.
+- **BENCHMARKS_FILTER**: file path pattern; e.g., `.*/math/base/special/erf/.*`.
This command is useful when wanting to glob for Julia benchmark files (e.g., run all Julia benchmarks for a particular package).
@@ -266,11 +266,11 @@ $ make benchmark-julia-files FILES='/foo/benchmark.jl /bar/benchmark.jl'
The command supports the following environment variables:
-- **FILES**: list of Julia benchmark files.
+- **FILES**: list of Julia benchmark files.
This command is useful when wanting to run a list of Julia benchmark files generated by some other command (e.g., a filtered list of changed Julia benchmark files obtained via `git diff`).
-* * *
+---
### Python
@@ -286,7 +286,7 @@ $ make benchmark-python
The command supports the following environment variables:
-- **BENCHMARKS_FILTER**: file path pattern; e.g., `.*/math/base/special/digamma/.*`.
+- **BENCHMARKS_FILTER**: file path pattern; e.g., `.*/math/base/special/digamma/.*`.
This command is useful when wanting to glob for Python benchmark files (e.g., run all Python benchmarks for a particular package).
@@ -302,11 +302,11 @@ $ make benchmark-python-files FILES='/foo/benchmark.py /bar/benchmark.py'
The command supports the following environment variables:
-- **FILES**: list of Python benchmark files.
+- **FILES**: list of Python benchmark files.
This command is useful when wanting to run a list of Python benchmark files generated by some other command (e.g., a filtered list of changed Python benchmark files obtained via `git diff`).
-* * *
+---
### R
@@ -322,7 +322,7 @@ $ make benchmark-r
The command supports the following environment variables:
-- **BENCHMARKS_FILTER**: file path pattern; e.g., `.*/math/base/special/expm1/.*`.
+- **BENCHMARKS_FILTER**: file path pattern; e.g., `.*/math/base/special/expm1/.*`.
This command is useful when wanting to glob for R benchmark files (e.g., run all R benchmarks for a particular package).
@@ -338,7 +338,7 @@ $ make benchmark-r-files FILES='/foo/benchmark.R /bar/benchmark.R'
The command supports the following environment variables:
-- **FILES**: list of R benchmark files.
+- **FILES**: list of R benchmark files.
This command is useful when wanting to run a list of R benchmark files generated by some other command (e.g., a filtered list of changed R benchmark files obtained via `git diff`).
diff --git a/tools/make/lib/bib/README.md b/tools/make/lib/bib/README.md
index 1bd69ad12283..76d33495a237 100644
--- a/tools/make/lib/bib/README.md
+++ b/tools/make/lib/bib/README.md
@@ -54,9 +54,9 @@ $ make citation-reference CITATION=@marsaglia:2000a
The command supports the following environment variables:
-- **CITATION**: citation identifier prefixed with an `@` symbol; e.g., `@marsaglia:2000a`.
-- **CITATION_REFERENCE_DATABASE**: path to a citation reference database; e.g., `/foo/bar/baz/bib.bib`.
-- **CITATION_REFERENCE_CSL**: path to a Citation Style Language (CSL) file; e.g., `/foo/bar/baz/style.csl`.
+- **CITATION**: citation identifier prefixed with an `@` symbol; e.g., `@marsaglia:2000a`.
+- **CITATION_REFERENCE_DATABASE**: path to a citation reference database; e.g., `/foo/bar/baz/bib.bib`.
+- **CITATION_REFERENCE_CSL**: path to a Citation Style Language (CSL) file; e.g., `/foo/bar/baz/style.csl`.
</section>
diff --git a/tools/make/lib/coverage-service/README.md b/tools/make/lib/coverage-service/README.md
index f7c837949972..e0351aefea6f 100644
--- a/tools/make/lib/coverage-service/README.md
+++ b/tools/make/lib/coverage-service/README.md
@@ -56,10 +56,10 @@ $ make coverage
The command supports the following environment variables:
-- **COVERAGE_SERVICE**: code coverage service name (e.g., `codecov`).
-- **LCOV_INFO**: path to `lcov.info` file which will be sent to the coverage service.
-- **COVERAGE_NAME**: coverage report name.
-- **CI_SERVICE**: continuous integration (CI) service from which the coverage report originates.
+- **COVERAGE_SERVICE**: code coverage service name (e.g., `codecov`).
+- **LCOV_INFO**: path to `lcov.info` file which will be sent to the coverage service.
+- **COVERAGE_NAME**: coverage report name.
+- **CI_SERVICE**: continuous integration (CI) service from which the coverage report originates.
#### coverage-codecov
@@ -73,9 +73,9 @@ $ make coverage-codecov
The command supports the following environment variables:
-- **LCOV_INFO**: path to `lcov.info` file which will be sent to the coverage service.
-- **COVERAGE_NAME**: coverage report name.
-- **CI_SERVICE**: continuous integration (CI) service from which the coverage report originates.
+- **LCOV_INFO**: path to `lcov.info` file which will be sent to the coverage service.
+- **COVERAGE_NAME**: coverage report name.
+- **CI_SERVICE**: continuous integration (CI) service from which the coverage report originates.
#### coverage-coveralls
@@ -89,9 +89,9 @@ $ make coverage-coveralls
The command supports the following environment variables:
-- **LCOV_INFO**: path to `lcov.info` file which will be sent to the coverage service.
-- **COVERALLS_REPO_TOKEN**: the secret repository token from [Coveralls][coveralls].
-- **CI_SERVICE**: continuous integration (CI) service from which the coverage report originates.
+- **LCOV_INFO**: path to `lcov.info` file which will be sent to the coverage service.
+- **COVERALLS_REPO_TOKEN**: the secret repository token from [Coveralls][coveralls].
+- **CI_SERVICE**: continuous integration (CI) service from which the coverage report originates.
</section>
@@ -110,9 +110,7 @@ The command supports the following environment variables:
<section class="links">
[make]: https://www.gnu.org/software/make/
-
[codecov]: https://codecov.io/
-
[coveralls]: https://coveralls.io/
</section>
diff --git a/tools/make/lib/dist/README.md b/tools/make/lib/dist/README.md
index 6f8acfed682b..c38ae4d27c2d 100644
--- a/tools/make/lib/dist/README.md
+++ b/tools/make/lib/dist/README.md
@@ -54,8 +54,8 @@ $ make npm-publish NPM_RELEASE_TYPE='patch' NPM_RELEASE_COMMIT_MESSAGE='New feat
The command supports the following environment variables:
-- **NPM_RELEASE_TYPE**: release type (e.g., `prepatch`, `patch`, `preminor`, `minor`, `premajor`, `major`, `prerelease`).
-- **NPM_RELEASE_COMMIT_MESSAGE**: release message.
+- **NPM_RELEASE_TYPE**: release type (e.g., `prepatch`, `patch`, `preminor`, `minor`, `premajor`, `major`, `prerelease`).
+- **NPM_RELEASE_COMMIT_MESSAGE**: release message.
This command commits changes to source control. Accordingly, this command should only be run on a clean working directory.
diff --git a/tools/make/lib/examples/README.md b/tools/make/lib/examples/README.md
index e4ae06ab649c..deaa0b3f8efa 100644
--- a/tools/make/lib/examples/README.md
+++ b/tools/make/lib/examples/README.md
@@ -56,7 +56,7 @@ $ make examples
The command supports the following environment variables:
-- **EXAMPLES_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **EXAMPLES_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
This command is an **alias** for `examples-javascript`, which is documented below.
@@ -72,9 +72,9 @@ $ make examples-lang
The command supports the environment variables supported by each language-specific (`examples-<lang>`) command documented below.
-This command is useful when wanting to glob for examples files, irrespective of language, for a particular package in order to compare cross-language behavior.
+This command is useful when wanting to glob for examples files, irrespective of language, for a particular package in order to compare cross-language behavior.
-* * *
+---
### C
@@ -92,10 +92,10 @@ $ make examples-c
The command supports the following environment variables:
-- **EXAMPLES_FILTER**: file path pattern; e.g., `.*/math/base/special/abs/.*`.
-- **BLAS**: BLAS library name; e.g., `openblas`.
-- **BLAS_DIR**: BLAS directory.
-- **C_COMPILER**: C compiler; e.g., `gcc`.
+- **EXAMPLES_FILTER**: file path pattern; e.g., `.*/math/base/special/abs/.*`.
+- **BLAS**: BLAS library name; e.g., `openblas`.
+- **BLAS_DIR**: BLAS directory.
+- **C_COMPILER**: C compiler; e.g., `gcc`.
This command is useful when wanting to glob for C examples files (e.g., run all C examples for a particular package).
@@ -111,14 +111,14 @@ $ make examples-c-files FILES='/foo/example.c /bar/example.c'
The command supports the following environment variables:
-- **FILES**: list of C examples files.
-- **BLAS**: BLAS library name; e.g., `openblas`.
-- **BLAS_DIR**: BLAS directory.
-- **C_COMPILER**: C compiler; e.g., `gcc`.
+- **FILES**: list of C examples files.
+- **BLAS**: BLAS library name; e.g., `openblas`.
+- **BLAS_DIR**: BLAS directory.
+- **C_COMPILER**: C compiler; e.g., `gcc`.
This command is useful when wanting to run a list of C examples files generated by some other command (e.g., a filtered list of changed C examples files obtained via `git diff`).
-* * *
+---
### C++
@@ -136,8 +136,8 @@ $ make examples-cpp
The command supports the following environment variables:
-- **EXAMPLES_FILTER**: file path pattern; e.g., `.*/math/base/special/beta/.*`.
-- **CXX_COMPILER**: C++ compiler; e.g., `g++`.
+- **EXAMPLES_FILTER**: file path pattern; e.g., `.*/math/base/special/beta/.*`.
+- **CXX_COMPILER**: C++ compiler; e.g., `g++`.
This command is useful when wanting to glob for C++ examples files (e.g., run all C++ examples for a particular package).
@@ -153,12 +153,12 @@ $ make examples-cpp-files FILES='/foo/example.cpp /bar/example.cpp'
The command supports the following environment variables:
-- **FILES**: list of C++ examples files.
-- **CXX_COMPILER**: C++ compiler; e.g., `g++`.
+- **FILES**: list of C++ examples files.
+- **CXX_COMPILER**: C++ compiler; e.g., `g++`.
This command is useful when wanting to run a list of C++ examples files generated by some other command (e.g., a filtered list of changed C++ examples files obtained via `git diff`).
-* * *
+---
### JavaScript
@@ -174,7 +174,7 @@ $ make examples-javascript
The command supports the following environment variables:
-- **EXAMPLES_FILTER**: file path pattern; e.g., `.*/utils/group-by/.*`.
+- **EXAMPLES_FILTER**: file path pattern; e.g., `.*/utils/group-by/.*`.
This command is useful when wanting to glob for JavaScript examples files (e.g., run all JavaScript examples for a particular package).
@@ -190,11 +190,11 @@ $ make examples-javascript-files FILES='/foo/example.js /bar/example.js'
The command supports the following environment variables:
-- **FILES**: list of JavaScript examples files.
+- **FILES**: list of JavaScript examples files.
This command is useful when wanting to run a list of JavaScript examples files generated by some other command (e.g., a filtered list of changed JavaScript examples files obtained via `git diff`).
-* * *
+---
### Markdown
@@ -210,7 +210,7 @@ $ make markdown-examples
The command supports the following environment variables:
-- **MARKDOWN_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **MARKDOWN_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
This command is an **alias** for `markdown-examples-javascript`, which is documented below.
@@ -226,7 +226,7 @@ $ make markdown-javascript-examples
The command supports the following environment variables:
-- **MARKDOWN_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **MARKDOWN_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
This command is useful when wanting to glob for Markdown files which may contain JavaScript examples (e.g., run all JavaScript examples found in Markdown files for a particular package).
@@ -242,7 +242,7 @@ $ make markdown-examples-javascript-files FILES='/foo/README.md /bar/README.md'
The command supports the following environment variables:
-- **FILES**: list of Markdown files.
+- **FILES**: list of Markdown files.
This command is useful when wanting to run JavaScript examples found in a list of Markdown files generated by some other command (e.g., a filtered list of changed Markdown files obtained via `git diff`).
diff --git a/tools/make/lib/git/README.md b/tools/make/lib/git/README.md
index 4a5383c8ed5f..39b049f4cbc4 100644
--- a/tools/make/lib/git/README.md
+++ b/tools/make/lib/git/README.md
@@ -107,7 +107,6 @@ This is useful for fixing commit messages which contain errors or do not adhere
<section class="links">
[make]: https://www.gnu.org/software/make/
-
[stdlib-style-guides-git]: https://github.com/stdlib-js/stdlib/blob/develop/docs/style-guides/git
</section>
diff --git a/tools/make/lib/help/README.md b/tools/make/lib/help/README.md
index 7c73598761ed..5017037af0f5 100644
--- a/tools/make/lib/help/README.md
+++ b/tools/make/lib/help/README.md
@@ -84,7 +84,7 @@ $ make list-variables
To remove duplicates, pipe to `uniq`. Note that the list of variables is **not** exhaustive, as the list does **not** include built-in variables.
-* * *
+---
### Debug
diff --git a/tools/make/lib/init/README.md b/tools/make/lib/init/README.md
index 62c3b9d8df09..8b1b0379a9f1 100644
--- a/tools/make/lib/init/README.md
+++ b/tools/make/lib/init/README.md
@@ -56,7 +56,7 @@ Performs development initialization tasks.
$ make init
```
-* * *
+---
### ESLint
@@ -100,7 +100,7 @@ Removes custom [ESLint][eslint] plugins.
$ make clean-eslint-plugins
```
-* * *
+---
### Git
@@ -133,11 +133,8 @@ $ make init-git-hooks
<section class="links">
[make]: https://www.gnu.org/software/make/
-
[git]: https://git-scm.com/
-
[git-hooks]: https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks
-
[eslint]: https://eslint.org/
</section>
diff --git a/tools/make/lib/install/README.md b/tools/make/lib/install/README.md
index 87c8c37d14ef..b0cc6e97baf7 100644
--- a/tools/make/lib/install/README.md
+++ b/tools/make/lib/install/README.md
@@ -28,22 +28,22 @@ limitations under the License.
This directory contains [`make`][make] rules for running the project's installation processes (e.g., managing [Node.js][node-js] environments, including `node_modules` dependencies and Node.js native [add-ons][node-js-add-ons]).
-- [Commands](#commands)
-
- - [Install](#install)
- - [Node.js](#nodejs)
- - [Boost](#boost)
- - [Cephes](#cephes)
- - [Cppcheck](#cppcheck)
- - [Electron](#electron)
- - [Emscripten SDK](#emscripten-sdk)
- - [LLVM](#llvm)
- - [OpenBLAS](#openblas)
- - [Python](#python)
- - [R](#r)
- - [ShellCheck](#shellcheck)
- - [WebAssembly Binary Toolkit](#wabt)
- - [WASI libc](#wasi-libc)
+- [Commands](#commands)
+
+ - [Install](#install)
+ - [Node.js](#nodejs)
+ - [Boost](#boost)
+ - [Cephes](#cephes)
+ - [Cppcheck](#cppcheck)
+ - [Electron](#electron)
+ - [Emscripten SDK](#emscripten-sdk)
+ - [LLVM](#llvm)
+ - [OpenBLAS](#openblas)
+ - [Python](#python)
+ - [R](#r)
+ - [ShellCheck](#shellcheck)
+ - [WebAssembly Binary Toolkit](#wabt)
+ - [WASI libc](#wasi-libc)
</section>
@@ -203,7 +203,7 @@ Removes all external library build artifacts.
$ make clean-deps-builds-all
```
-* * *
+---
<a name="nodejs"></a>
@@ -269,7 +269,7 @@ Removes Node.js native [add-ons][node-js-add-ons].
$ make clean-node-addons
```
-* * *
+---
<a name="boost"></a>
@@ -299,7 +299,7 @@ Removes compiled [Boost][boost] installation tests.
$ make clean-deps-boost-tests
```
-* * *
+---
<a name="cephes"></a>
@@ -329,7 +329,7 @@ Removes compiled [Cephes][cephes] installation tests.
$ make clean-deps-cephes-tests
```
-* * *
+---
<a name="cppcheck"></a>
@@ -359,7 +359,7 @@ Removes [Cppcheck][cppcheck] installation tests.
$ make clean-deps-cppcheck-tests
```
-* * *
+---
<a name="electron"></a>
@@ -389,7 +389,7 @@ Removes [Electron][electron] installation tests.
$ make clean-deps-electron-tests
```
-* * *
+---
<a name="emscripten-sdk"></a>
@@ -419,7 +419,7 @@ Removes [Emscripten SDK][emscripten-sdk] installation tests.
$ make clean-deps-emscripten-tests
```
-* * *
+---
<a name="llvm"></a>
@@ -449,7 +449,7 @@ Removes [LLVM][llvm] installation tests.
$ make clean-deps-llvm-tests
```
-* * *
+---
<a name="openblas"></a>
@@ -479,7 +479,7 @@ Removes compiled [OpenBLAS][openblas] installation tests.
$ make clean-deps-openblas-tests
```
-* * *
+---
<a name="python"></a>
@@ -509,7 +509,7 @@ Removes an installed Python dependencies.
$ make clean-deps-python
```
-* * *
+---
<a name="r"></a>
@@ -539,7 +539,7 @@ Removes an installed R dependencies.
$ make clean-deps-r
```
-* * *
+---
<a name="shellcheck"></a>
@@ -569,7 +569,7 @@ Removes [ShellCheck][shellcheck] installation tests.
$ make clean-deps-shellcheck-tests
```
-* * *
+---
<a name="wabt"></a>
@@ -599,7 +599,7 @@ Removes [WebAssembly Binary Toolkit][wabt] installation tests.
$ make clean-deps-wabt-tests
```
-* * *
+---
<a name="wasi-libc"></a>
@@ -646,29 +646,17 @@ $ make clean-deps-wasi-libc-tests
<section class="links">
[make]: https://www.gnu.org/software/make/
-
[boost]: http://www.boost.org/
-
[cephes]: http://www.moshier.net/#Cephes
-
[cppcheck]: http://cppcheck.sourceforge.net/
-
[electron]: https://www.electronjs.org/
-
[emscripten-sdk]: https://github.com/emscripten-core/emsdk
-
[llvm]: https://llvm.org
-
[node-js]: https://nodejs.org/en/
-
[node-js-add-ons]: https://nodejs.org/api/addons.html
-
[openblas]: https://github.com/xianyi/OpenBLAS
-
[shellcheck]: https://github.com/koalaman/shellcheck
-
[wabt]: https://github.com/WebAssembly/wabt
-
[wasi-libc]: https://github.com/WebAssembly/wasi-libc
</section>
diff --git a/tools/make/lib/licenses/README.md b/tools/make/lib/licenses/README.md
index aeb7a84c578e..ed45a235466a 100644
--- a/tools/make/lib/licenses/README.md
+++ b/tools/make/lib/licenses/README.md
@@ -76,8 +76,8 @@ $ make remove-license-headers
The command supports the following environment variables:
-- **FILES_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
-- **FILES_PATTERN**: filename pattern; e.g., `*.js`.
+- **FILES_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **FILES_PATTERN**: filename pattern; e.g., `*.js`.
#### insert-license-headers
@@ -91,8 +91,8 @@ $ make insert-license-headers
The command supports the following environment variables:
-- **FILES_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
-- **FILES_PATTERN**: filename pattern; e.g., `*.js`.
+- **FILES_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **FILES_PATTERN**: filename pattern; e.g., `*.js`.
#### update-license-headers
@@ -106,8 +106,8 @@ $ make update-license-headers
The command supports the following environment variables:
-- **FILES_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
-- **FILES_PATTERN**: filename pattern; e.g., `*.js`.
+- **FILES_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **FILES_PATTERN**: filename pattern; e.g., `*.js`.
#### list-licenses
diff --git a/tools/make/lib/lint/README.md b/tools/make/lib/lint/README.md
index 4eb7281d136f..b2d132213695 100644
--- a/tools/make/lib/lint/README.md
+++ b/tools/make/lib/lint/README.md
@@ -114,7 +114,7 @@ The command supports the environment variables supported by the `lint-javascript
This command is useful when wanting to glob for benchmark files for a particular package in order to lint all contained benchmark files.
-* * *
+---
### JavaScript
@@ -144,8 +144,8 @@ $ make lint-javascript-src
The command supports the following environment variables:
-- **SOURCES_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
-- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
+- **SOURCES_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
This command is useful when wanting to glob for JavaScript source files (e.g., lint all JavaScript source files for a particular package).
@@ -161,8 +161,8 @@ $ make lint-javascript-tests
The command supports the following environment variables:
-- **TESTS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
-- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
+- **TESTS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
This command is useful when wanting to glob for JavaScript test files (e.g., lint all JavaScript test files for a particular package).
@@ -178,8 +178,8 @@ $ make lint-javascript-examples
The command supports the following environment variables:
-- **EXAMPLES_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
-- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
+- **EXAMPLES_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
This command is useful when wanting to glob for JavaScript examples files (e.g., lint all JavaScript examples files for a particular package).
@@ -195,8 +195,8 @@ $ make lint-javascript-src
The command supports the following environment variables:
-- **BENCHMARKS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
-- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
+- **BENCHMARKS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
This command is useful when wanting to glob for JavaScript benchmark files (e.g., lint all JavaScript benchmark files for a particular package).
@@ -212,12 +212,12 @@ $ make lint-javascript-files FILES='/foo/index.js /bar/index.js'
The command supports the following environment variables:
-- **FILES**: list of JavaScript files.
-- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
+- **FILES**: list of JavaScript files.
+- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
This command is useful when wanting to lint a list of JavaScript files generated by some other command (e.g., a list of changed JavaScript files obtained via `git diff`).
-* * *
+---
### Julia
@@ -247,8 +247,8 @@ $ make lint-julia-src
The command supports the following environment variables:
-- **JULIA_SOURCES_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
-- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
+- **JULIA_SOURCES_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
This command is useful when wanting to glob for Julia source files (e.g., lint all Julia source files for a particular package).
@@ -264,8 +264,8 @@ $ make lint-julia-tests-fixtures
The command supports the following environment variables:
-- **JULIA_TESTS_FIXTURES_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
-- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
+- **JULIA_TESTS_FIXTURES_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
This command is useful when wanting to glob for Julia test fixture files (e.g., lint all Julia test fixture files for a particular package).
@@ -281,8 +281,8 @@ $ make lint-julia-examples
The command supports the following environment variables:
-- **JULIA_EXAMPLES_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
-- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
+- **JULIA_EXAMPLES_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
This command is useful when wanting to glob for Julia examples files (e.g., lint all Julia examples files for a particular package).
@@ -298,8 +298,8 @@ $ make lint-julia-src
The command supports the following environment variables:
-- **JULIA_BENCHMARKS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
-- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
+- **JULIA_BENCHMARKS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
This command is useful when wanting to glob for Julia benchmark files (e.g., lint all Julia benchmark files for a particular package).
@@ -315,12 +315,12 @@ $ make lint-julia-files FILES='/foo/file.jl /bar/file.jl'
The command supports the following environment variables:
-- **FILES**: list of Julia files.
-- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
+- **FILES**: list of Julia files.
+- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
This command is useful when wanting to lint a list of Julia files generated by some other command (e.g., a list of changed Julia files obtained via `git diff`).
-* * *
+---
### Python
@@ -350,8 +350,8 @@ $ make lint-python-src
The command supports the following environment variables:
-- **PYTHON_SOURCES_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
-- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
+- **PYTHON_SOURCES_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
This command is useful when wanting to glob for Python source files (e.g., lint all Python source files for a particular package).
@@ -367,8 +367,8 @@ $ make lint-python-tests-fixtures
The command supports the following environment variables:
-- **PYTHON_TESTS_FIXTURES_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
-- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
+- **PYTHON_TESTS_FIXTURES_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
This command is useful when wanting to glob for Python test fixture files (e.g., lint all Python test fixture files for a particular package).
@@ -384,8 +384,8 @@ $ make lint-python-examples
The command supports the following environment variables:
-- **PYTHON_EXAMPLES_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
-- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
+- **PYTHON_EXAMPLES_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
This command is useful when wanting to glob for Python examples files (e.g., lint all Python examples files for a particular package).
@@ -401,8 +401,8 @@ $ make lint-python-src
The command supports the following environment variables:
-- **PYTHON_BENCHMARKS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
-- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
+- **PYTHON_BENCHMARKS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
This command is useful when wanting to glob for Python benchmark files (e.g., lint all Python benchmark files for a particular package).
@@ -418,12 +418,12 @@ $ make lint-python-files FILES='/foo/file.py /bar/file.py'
The command supports the following environment variables:
-- **FILES**: list of Python files.
-- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
+- **FILES**: list of Python files.
+- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
This command is useful when wanting to lint a list of Python files generated by some other command (e.g., a list of changed Python files obtained via `git diff`).
-* * *
+---
### R
@@ -453,8 +453,8 @@ $ make lint-r-src
The command supports the following environment variables:
-- **R_SOURCES_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
-- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
+- **R_SOURCES_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
This command is useful when wanting to glob for R source files (e.g., lint all R source files for a particular package).
@@ -470,8 +470,8 @@ $ make lint-r-tests-fixtures
The command supports the following environment variables:
-- **R_TESTS_FIXTURES_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
-- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
+- **R_TESTS_FIXTURES_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
This command is useful when wanting to glob for R test fixture files (e.g., lint all R test fixture files for a particular package).
@@ -487,8 +487,8 @@ $ make lint-r-examples
The command supports the following environment variables:
-- **R_EXAMPLES_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
-- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
+- **R_EXAMPLES_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
This command is useful when wanting to glob for R examples files (e.g., lint all R examples files for a particular package).
@@ -504,8 +504,8 @@ $ make lint-r-src
The command supports the following environment variables:
-- **R_BENCHMARKS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
-- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
+- **R_BENCHMARKS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
This command is useful when wanting to glob for R benchmark files (e.g., lint all R benchmark files for a particular package).
@@ -521,12 +521,12 @@ $ make lint-r-files FILES='/foo/file.R /bar/file.R'
The command supports the following environment variables:
-- **FILES**: list of R files.
-- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
+- **FILES**: list of R files.
+- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
This command is useful when wanting to lint a list of R files generated by some other command (e.g., a list of changed R files obtained via `git diff`).
-* * *
+---
### Shell
@@ -542,8 +542,8 @@ $ make lint-shell
The command supports the following environment variables:
-- **SHELL_FILTER**: file path pattern; e.g., `.*/_tools/.*`.
-- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
+- **SHELL_FILTER**: file path pattern; e.g., `.*/_tools/.*`.
+- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
This command is useful when wanting to glob for shell script files (e.g., lint all shell scripts files in a particular directory).
@@ -559,12 +559,12 @@ $ make lint-shell-files FILES='/foo/file.sh /bar/file.sh'
The command supports the following environment variables:
-- **FILES**: list of shell script files.
-- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
+- **FILES**: list of shell script files.
+- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
This command is useful when wanting to lint a list of shell script files generated by some other command (e.g., a list of changed shell script files obtained via `git diff`).
-* * *
+---
### Markdown
@@ -580,8 +580,8 @@ $ make lint-markdown
The command supports the following environment variables:
-- **MARKDOWN_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
-- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
+- **MARKDOWN_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
This command is useful when wanting to glob for Markdown files (e.g., lint all Markdown files for a particular package).
@@ -597,12 +597,12 @@ $ make lint-markdown-files FILES='/foo/README.md /bar/README.md'
The command supports the following environment variables:
-- **FILES**: list of Markdown files.
-- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
+- **FILES**: list of Markdown files.
+- **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
This command is useful when wanting to lint a list of Markdown files generated by some other command (e.g., a list of changed Markdown files obtained via `git diff`).
-* * *
+---
### package.json
@@ -616,7 +616,7 @@ Lints `package.json` files.
$ make lint-pkg-json
```
-* * *
+---
### REPL Help
@@ -630,7 +630,7 @@ Lints REPL help files.
$ make lint-repl-help
```
-* * *
+---
### Configuration Files
@@ -664,7 +664,7 @@ Lints a [Travis CI][travis-ci-conf] configuration file
$ make lint-conf-travis
```
-* * *
+---
### Filenames
@@ -705,9 +705,7 @@ $ make lint-header-filenames
<section class="links">
[make]: https://www.gnu.org/software/make/
-
[codecov-yaml]: https://docs.codecov.com/docs/codecovyml-reference
-
[travis-ci-conf]: https://docs.travis-ci.com/user/customizing-the-build
</section>
diff --git a/tools/make/lib/markdown/README.md b/tools/make/lib/markdown/README.md
index cb41367aa819..ea0fe3cbfe03 100644
--- a/tools/make/lib/markdown/README.md
+++ b/tools/make/lib/markdown/README.md
@@ -56,9 +56,9 @@ $ make markdown-asset-url MARKDOWN_ASSET_PATH='./README.md'
The command supports the following environment variables:
-- **MARKDOWN_ASSET_PATH**: a file path relative to the project root directory; e.g., `./README.md`.
+- **MARKDOWN_ASSET_PATH**: a file path relative to the project root directory; e.g., `./README.md`.
-* * *
+---
### Namespace ToCs
@@ -74,8 +74,8 @@ $ make markdown-namespace-tocs
The command supports the following environment variables:
-- **MARKDOWN_PATTERN**: filename pattern; e.g., `*.md`.
-- **MARKDOWN_FILTER**: file path pattern; e.g., `.*/math/base/special/.*`
+- **MARKDOWN_PATTERN**: filename pattern; e.g., `*.md`.
+- **MARKDOWN_FILTER**: file path pattern; e.g., `.*/math/base/special/.*`
<!-- run-disable -->
@@ -97,11 +97,11 @@ $ make markdown-namespace-tocs-files FILES='/foo/foo.md /foo/bar.md'
The command supports the following environment variables:
-- **FILES**: list of Markdown files.
+- **FILES**: list of Markdown files.
This command is useful when wanting to process a list of Markdown files generated by some other command (e.g., a list of changed Markdown files obtained via `git diff`).
-* * *
+---
### Package URLs
@@ -117,8 +117,8 @@ $ make markdown-pkg-urls
The command supports the following environment variables:
-- **MARKDOWN_PATTERN**: filename pattern; e.g., `*.md`.
-- **MARKDOWN_FILTER**: file path pattern; e.g., `.*/math/base/special/.*`
+- **MARKDOWN_PATTERN**: filename pattern; e.g., `*.md`.
+- **MARKDOWN_FILTER**: file path pattern; e.g., `.*/math/base/special/.*`
<!-- run-disable -->
@@ -140,11 +140,11 @@ $ make markdown-pkg-urls-files FILES='/foo/foo.md /foo/bar.md'
The command supports the following environment variables:
-- **FILES**: list of Markdown files.
+- **FILES**: list of Markdown files.
This command is useful when wanting to process a list of Markdown files generated by some other command (e.g., a list of changed Markdown files obtained via `git diff`).
-* * *
+---
### Related Packages
@@ -160,8 +160,8 @@ $ make markdown-related
The command supports the following environment variables:
-- **MARKDOWN_PATTERN**: filename pattern; e.g., `*.md`.
-- **MARKDOWN_FILTER**: file path pattern; e.g., `.*/math/base/special/.*`
+- **MARKDOWN_PATTERN**: filename pattern; e.g., `*.md`.
+- **MARKDOWN_FILTER**: file path pattern; e.g., `.*/math/base/special/.*`
<!-- run-disable -->
@@ -183,11 +183,11 @@ $ make markdown-related-files FILES='/foo/foo.md /foo/bar.md'
The command supports the following environment variables:
-- **FILES**: list of Markdown files.
+- **FILES**: list of Markdown files.
This command is useful when wanting to process a list of Markdown files generated by some other command (e.g., a list of changed Markdown files obtained via `git diff`).
-* * *
+---
### Equations
@@ -203,8 +203,8 @@ $ make markdown-equations
The command supports the following environment variables:
-- **MARKDOWN_PATTERN**: filename pattern; e.g., `*.md`.
-- **MARKDOWN_FILTER**: file path pattern; e.g., `.*/math/base/special/.*`
+- **MARKDOWN_PATTERN**: filename pattern; e.g., `*.md`.
+- **MARKDOWN_FILTER**: file path pattern; e.g., `.*/math/base/special/.*`
<!-- run-disable -->
@@ -228,8 +228,8 @@ $ make markdown-img-equations
The command supports the following environment variables:
-- **MARKDOWN_PATTERN**: filename pattern; e.g., `*.md`.
-- **MARKDOWN_FILTER**: file path pattern; e.g., `.*/math/base/special/.*`
+- **MARKDOWN_PATTERN**: filename pattern; e.g., `*.md`.
+- **MARKDOWN_FILTER**: file path pattern; e.g., `.*/math/base/special/.*`
<!-- run-disable -->
@@ -251,7 +251,7 @@ $ make markdown-img-equations-files FILES='/foo/foo.md /foo/bar.md'
The command supports the following environment variables:
-- **FILES**: list of Markdown files.
+- **FILES**: list of Markdown files.
This command is useful when wanting to process a list of Markdown files generated by some other command (e.g., a list of changed Markdown files obtained via `git diff`).
@@ -267,8 +267,8 @@ $ make markdown-img-equations-src-urls
The command supports the following environment variables:
-- **MARKDOWN_PATTERN**: filename pattern; e.g., `*.md`.
-- **MARKDOWN_FILTER**: file path pattern; e.g., `.*/math/base/special/.*`
+- **MARKDOWN_PATTERN**: filename pattern; e.g., `*.md`.
+- **MARKDOWN_FILTER**: file path pattern; e.g., `.*/math/base/special/.*`
<!-- run-disable -->
@@ -292,7 +292,7 @@ $ make markdown-img-equations-src-urls-files FILES='/foo/foo.md /foo/bar.md'
The command supports the following environment variables:
-- **FILES**: list of Markdown files.
+- **FILES**: list of Markdown files.
This command is useful when wanting to process a list of Markdown files generated by some other command (e.g., a list of changed Markdown files obtained via `git diff`).
@@ -308,8 +308,8 @@ $ make markdown-svg-equations
The command supports the following environment variables:
-- **MARKDOWN_PATTERN**: filename pattern; e.g., `*.md`.
-- **MARKDOWN_FILTER**: file path pattern; e.g., `.*/math/base/special/.*`
+- **MARKDOWN_PATTERN**: filename pattern; e.g., `*.md`.
+- **MARKDOWN_FILTER**: file path pattern; e.g., `.*/math/base/special/.*`
<!-- run-disable -->
@@ -331,7 +331,7 @@ $ make markdown-svg-equations-files FILES='/foo/foo.md /foo/bar.md'
The command supports the following environment variables:
-- **FILES**: list of Markdown files.
+- **FILES**: list of Markdown files.
This command is useful when wanting to process a list of Markdown files generated by some other command (e.g., a list of changed Markdown files obtained via `git diff`).
@@ -347,8 +347,8 @@ $ make clean-markdown-svg-equations
The command supports the following environment variables:
-- **SVG_EQUATIONS_PATTERN**: filename pattern; e.g., `equation*.svg`.
-- **SVG_EQUATIONS_FILTER**: file path pattern; e.g., `.*/math/base/special/.*`
+- **SVG_EQUATIONS_PATTERN**: filename pattern; e.g., `equation*.svg`.
+- **SVG_EQUATIONS_FILTER**: file path pattern; e.g., `.*/math/base/special/.*`
<!-- run-disable -->
diff --git a/tools/make/lib/notes/README.md b/tools/make/lib/notes/README.md
index 456ab1e0c818..0a22524a58ac 100644
--- a/tools/make/lib/notes/README.md
+++ b/tools/make/lib/notes/README.md
@@ -56,7 +56,7 @@ $ make notes
The command supports the following environment variables:
-- **KEYWORDS**: pipe-delimited list of keywords identifying annotations; e.g., `TODO|FIXME|WARNING|HACK|NOTE|OPTIMIZE`.
+- **KEYWORDS**: pipe-delimited list of keywords identifying annotations; e.g., `TODO|FIXME|WARNING|HACK|NOTE|OPTIMIZE`.
Annotated comments will be output along with their associated filename and line number.
diff --git a/tools/make/lib/scaffold/README.md b/tools/make/lib/scaffold/README.md
index 56c01684d3dd..33094ae8c1df 100644
--- a/tools/make/lib/scaffold/README.md
+++ b/tools/make/lib/scaffold/README.md
@@ -56,8 +56,8 @@ $ make scaffold SCAFFOLD_PKG=<pkg>
The command expects the following environment variables to be set:
-- **SCAFFOLD_PKG**: package to scaffold, e.g., `math/base/special/sin`.
-- **SCAFFOLD_API_KEY**: API key for accessing the stdlib scaffolding service.
+- **SCAFFOLD_PKG**: package to scaffold, e.g., `math/base/special/sin`.
+- **SCAFFOLD_API_KEY**: API key for accessing the stdlib scaffolding service.
</section>
diff --git a/tools/make/lib/test-cov/README.md b/tools/make/lib/test-cov/README.md
index de0a786d5613..36995fa17715 100644
--- a/tools/make/lib/test-cov/README.md
+++ b/tools/make/lib/test-cov/README.md
@@ -56,8 +56,8 @@ $ make test-cov
The command supports the following environment variables:
-- **TESTS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
-- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
+- **TESTS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
<!-- run-disable -->
@@ -85,7 +85,7 @@ Removes coverage artifacts, such as reports and HTML pages.
$ make clean-cov
```
-* * *
+---
### JavaScript
@@ -101,8 +101,8 @@ $ make test-javascript-cov
The command supports the following environment variables:
-- **TESTS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
-- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
+- **TESTS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
<!-- run-disable -->
@@ -136,13 +136,13 @@ $ make clean-javascript-cov
<!-- Section to include notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
-* * *
+---
<section class="notes">
## Notes
-- Commands supporting a `TESTS_FILTER` environment variable are useful when wanting to glob for test files (e.g., run all tests for a particular package).
+- Commands supporting a `TESTS_FILTER` environment variable are useful when wanting to glob for test files (e.g., run all tests for a particular package).
</section>
diff --git a/tools/make/lib/test/README.md b/tools/make/lib/test/README.md
index 27b167c576eb..18de8aa7a1ae 100644
--- a/tools/make/lib/test/README.md
+++ b/tools/make/lib/test/README.md
@@ -56,8 +56,8 @@ $ make test
The command supports the following environment variables:
-- **TESTS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
-- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
+- **TESTS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
<!-- run-disable -->
@@ -77,8 +77,8 @@ $ make test-files FILES='/foo/test.js /bar/test.js'
The command supports the following environment variables:
-- **FILES**: list of test file paths.
-- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
+- **FILES**: list of test file paths.
+- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
#### test-local
@@ -92,8 +92,8 @@ $ make test-local
The command supports the following environment variables:
-- **TESTS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
-- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
+- **TESTS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
<!-- run-disable -->
@@ -113,8 +113,8 @@ $ make test-files-local FILES='/foo/test.js /bar/test.js'
The command supports the following environment variables:
-- **FILES**: list of test file paths.
-- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
+- **FILES**: list of test file paths.
+- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
#### test-summary
@@ -128,8 +128,8 @@ $ make test-summary
The command supports the following environment variables:
-- **TESTS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
-- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
+- **TESTS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
<!-- run-disable -->
@@ -149,8 +149,8 @@ $ make test-files-summary FILES='/foo/test.js /bar/test.js'
The command supports the following environment variables:
-- **FILES**: list of test file paths.
-- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
+- **FILES**: list of test file paths.
+- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
#### test-tap
@@ -164,8 +164,8 @@ $ make test-tap
The command supports the following environment variables:
-- **TESTS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
-- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
+- **TESTS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
<!-- run-disable -->
@@ -185,8 +185,8 @@ $ make test-files-tap FILES='/foo/test.js /bar/test.js'
The command supports the following environment variables:
-- **FILES**: list of test file paths.
-- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
+- **FILES**: list of test file paths.
+- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
#### test-xunit
@@ -200,8 +200,8 @@ $ make test-xunit
The command supports the following environment variables:
-- **TESTS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
-- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
+- **TESTS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
<!-- run-disable -->
@@ -221,10 +221,10 @@ $ make test-files-xunit FILES='/foo/test.js /bar/test.js'
The command supports the following environment variables:
-- **FILES**: list of test file paths.
-- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
+- **FILES**: list of test file paths.
+- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
-* * *
+---
### JavaScript
@@ -240,8 +240,8 @@ $ make test-javascript
The command supports the following environment variables:
-- **TESTS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
-- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
+- **TESTS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
<!-- run-disable -->
@@ -261,8 +261,8 @@ $ make test-javascript-files FILES='/foo/test.js /bar/test.js'
The command supports the following environment variables:
-- **FILES**: list of test file paths.
-- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
+- **FILES**: list of test file paths.
+- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
#### test-javascript-local
@@ -276,8 +276,8 @@ $ make test-javascript-local
The command supports the following environment variables:
-- **TESTS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
-- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
+- **TESTS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
<!-- run-disable -->
@@ -297,8 +297,8 @@ $ make test-javascript-files-local FILES='/foo/test.js /bar/test.js'
The command supports the following environment variables:
-- **FILES**: list of test file paths.
-- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
+- **FILES**: list of test file paths.
+- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
#### test-javascript-summary
@@ -312,8 +312,8 @@ $ make test-javascript-summary
The command supports the following environment variables:
-- **TESTS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
-- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
+- **TESTS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
<!-- run-disable -->
@@ -333,8 +333,8 @@ $ make test-javascript-files-summary FILES='/foo/test.js /bar/test.js'
The command supports the following environment variables:
-- **FILES**: list of test file paths.
-- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
+- **FILES**: list of test file paths.
+- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
#### test-javascript-min
@@ -348,8 +348,8 @@ $ make test-javascript-min
The command supports the following environment variables:
-- **TESTS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
-- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
+- **TESTS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
<!-- run-disable -->
@@ -369,8 +369,8 @@ $ make test-javascript-files-min FILES='/foo/test.js /bar/test.js'
The command supports the following environment variables:
-- **FILES**: list of test file paths.
-- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
+- **FILES**: list of test file paths.
+- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
#### test-javascript-tap
@@ -384,8 +384,8 @@ $ make test-javascript-tap
The command supports the following environment variables:
-- **TESTS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
-- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
+- **TESTS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
<!-- run-disable -->
@@ -405,8 +405,8 @@ $ make test-javascript-files-tap FILES='/foo/test.js /bar/test.js'
The command supports the following environment variables:
-- **FILES**: list of test file paths.
-- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
+- **FILES**: list of test file paths.
+- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
#### test-javascript-xunit
@@ -420,8 +420,8 @@ $ make test-javascript-xunit
The command supports the following environment variables:
-- **TESTS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
-- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
+- **TESTS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
<!-- run-disable -->
@@ -441,8 +441,8 @@ $ make test-javascript-files-xunit FILES='/foo/test.js /bar/test.js'
The command supports the following environment variables:
-- **FILES**: list of test file paths.
-- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
+- **FILES**: list of test file paths.
+- **FAST_FAIL**: flag indicating whether to stop running tests upon encountering a test failure.
</section>
@@ -450,15 +450,15 @@ The command supports the following environment variables:
<!-- Section to include notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
-* * *
+---
<section class="notes">
## Notes
-- Commands supporting a `FILES` environment variable are useful when wanting to run a list of test files generated by some other command (e.g., a list of changed test files obtained via `git diff`).
-- Commands supporting a `TESTS_FILTER` environment variable are useful when wanting to glob for test files (e.g., run all tests for a particular package).
-- For `-local` commands, "local" refers to the local development environment, as opposed to running in a headless browser or on CI.
+- Commands supporting a `FILES` environment variable are useful when wanting to run a list of test files generated by some other command (e.g., a list of changed test files obtained via `git diff`).
+- Commands supporting a `TESTS_FILTER` environment variable are useful when wanting to glob for test files (e.g., run all tests for a particular package).
+- For `-local` commands, "local" refers to the local development environment, as opposed to running in a headless browser or on CI.
</section>
diff --git a/tools/make/lib/wasm/README.md b/tools/make/lib/wasm/README.md
index aba0b95311bd..52bfbdb87e88 100644
--- a/tools/make/lib/wasm/README.md
+++ b/tools/make/lib/wasm/README.md
@@ -56,7 +56,7 @@ $ make wasm
The command supports the following environment variables:
-- **PKGS_WASM_PATTERN**: package pattern; e.g., `blas/base/daxpy-wasm`.
+- **PKGS_WASM_PATTERN**: package pattern; e.g., `blas/base/daxpy-wasm`.
If unable to compile WebAssemby artifacts, the command prints an error message and tries compiling WebAssembly artifacts for the next package.
@@ -72,7 +72,7 @@ $ make clean-wasm
The command supports the following environment variables:
-- **PKGS_WASM_PATTERN**: package pattern; e.g., `blas/base/daxpy-wasm`.
+- **PKGS_WASM_PATTERN**: package pattern; e.g., `blas/base/daxpy-wasm`.
</section>
diff --git a/tools/snippets/README.md b/tools/snippets/README.md
index 93db27a11734..b4587f708aed 100644
--- a/tools/snippets/README.md
+++ b/tools/snippets/README.md
@@ -37,7 +37,7 @@ limitations under the License.
## Usage
```javascript
-var todo = require( '@stdlib/<TODO: module path>' );
+var todo = require("@stdlib/<TODO: module path>");
```
#### todo( TODO )
@@ -45,7 +45,7 @@ var todo = require( '@stdlib/<TODO: module path>' );
TODO
```javascript
-var v = todo( 0.0 );
+var v = todo(0.0);
// returns TODO
```
@@ -70,7 +70,7 @@ var v = todo( 0.0 );
<!-- eslint no-undef: "error" -->
```javascript
-var todo = require( '@stdlib/<TODO: module path>' );
+var todo = require("@stdlib/<TODO: module path>");
todo();
```
diff --git a/tools/snippets/benchmark/benchmark.async.js b/tools/snippets/benchmark/benchmark.async.js
index d48d05f30de6..1364cf30b713 100644
--- a/tools/snippets/benchmark/benchmark.async.js
+++ b/tools/snippets/benchmark/benchmark.async.js
@@ -1,33 +1,32 @@
/**
-* @license Apache-2.0
-*
-* Copyright (c) 2025 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';
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2025 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 bench = require( '@stdlib/bench' );
-var pkg = require( './../package.json' ).name;
-var TODO = require( './../lib' );
-
+var bench = require("@stdlib/bench");
+var pkg = require("./../package.json").name;
+var TODO = require("./../lib");
// MAIN //
-bench( pkg, function benchmark( b ) {
+bench(pkg, function benchmark(b) {
var i;
i = 0;
@@ -37,15 +36,15 @@ bench( pkg, function benchmark( b ) {
function next() {
i += 1;
- if ( i <= b.iterations ) {
+ if (i <= b.iterations) {
// TODO: asynchronous task
- return setTimeout( next, 0 );
+ return setTimeout(next, 0);
}
b.toc();
- if ( TODO/* TODO condition */ ) {
- b.fail( 'something went wrong' );
+ if (TODO /* TODO condition */) {
+ b.fail("something went wrong");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
}
});
diff --git a/tools/snippets/benchmark/benchmark.js b/tools/snippets/benchmark/benchmark.js
index 0c646ddcf267..acd2cc265ce9 100644
--- a/tools/snippets/benchmark/benchmark.js
+++ b/tools/snippets/benchmark/benchmark.js
@@ -1,45 +1,44 @@
/**
-* @license Apache-2.0
-*
-* Copyright (c) 2025 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.
-*/
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2025 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';
+"use strict";
// MODULES //
-var bench = require( '@stdlib/bench' );
-var pkg = require( './../package.json' ).name;
-var TODO = require( './../lib' );
-
+var bench = require("@stdlib/bench");
+var pkg = require("./../package.json").name;
+var TODO = require("./../lib");
// MAIN //
-bench( pkg, function benchmark( b ) {
+bench(pkg, function benchmark(b) {
var i;
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
+ for (i = 0; i < b.iterations; i++) {
// TODO: synchronous task
- if ( TODO/* TODO: condition */ ) {
- b.fail( 'something went wrong' );
+ if (TODO /* TODO: condition */) {
+ b.fail("something went wrong");
}
}
b.toc();
- if ( TODO/* TODO: condition */ ) {
- b.fail( 'something went wrong' );
+ if (TODO /* TODO: condition */) {
+ b.fail("something went wrong");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
});
diff --git a/tools/snippets/benchmark/benchmark.length.js b/tools/snippets/benchmark/benchmark.length.js
index 813c02f29b45..4f5c056c678c 100644
--- a/tools/snippets/benchmark/benchmark.length.js
+++ b/tools/snippets/benchmark/benchmark.length.js
@@ -1,83 +1,81 @@
/**
-* @license Apache-2.0
-*
-* Copyright (c) 2025 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.
-*/
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2025 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';
+"use strict";
// MODULES //
-var bench = require( '@stdlib/bench' );
-var pow = require( '@stdlib/math/base/special/pow' );
-var pkg = require( './../package.json' ).name;
-var TODO = require( './../lib' );
-
+var bench = require("@stdlib/bench");
+var pow = require("@stdlib/math/base/special/pow");
+var pkg = require("./../package.json").name;
+var TODO = require("./../lib");
// FUNCTIONS //
/**
-* Creates a benchmark function.
-*
-* @private
-* @param {PositiveInteger} len - array length
-* @returns {Function} benchmark function
-*/
-function createBenchmark( len ) {
+ * Creates a benchmark function.
+ *
+ * @private
+ * @param {PositiveInteger} len - array length
+ * @returns {Function} benchmark function
+ */
+function createBenchmark(len) {
var x;
var i;
x = [];
- for ( i = 0; i < len; i++ ) {
- x.push( null ); // TODO: set values
+ for (i = 0; i < len; i++) {
+ x.push(null); // TODO: set values
}
return benchmark;
/**
- * Benchmark function.
- *
- * @private
- * @param {Benchmark} b - benchmark instance
- */
- function benchmark( b ) {
+ * Benchmark function.
+ *
+ * @private
+ * @param {Benchmark} b - benchmark instance
+ */
+ function benchmark(b) {
var i;
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
+ for (i = 0; i < b.iterations; i++) {
// TODO: synchronous task
- if ( TODO/* TODO: condition */ ) {
- b.fail( 'something went wrong' );
+ if (TODO /* TODO: condition */) {
+ b.fail("something went wrong");
}
}
b.toc();
- if ( TODO/* TODO: condition */ ) {
- b.fail( 'something went wrong' );
+ if (TODO /* TODO: condition */) {
+ b.fail("something went wrong");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
}
}
-
// MAIN //
/**
-* Main execution sequence.
-*
-* @private
-*/
+ * Main execution sequence.
+ *
+ * @private
+ */
function main() {
var len;
var min;
@@ -88,10 +86,10 @@ function main() {
min = 1; // 10^min
max = 6; // 10^max
- for ( i = min; i <= max; i++ ) {
- len = pow( 10, i );
- f = createBenchmark( len );
- bench( pkg+':len='+len, f );
+ for (i = min; i <= max; i++) {
+ len = pow(10, i);
+ f = createBenchmark(len);
+ bench(pkg + ":len=" + len, f);
}
}
diff --git a/tools/snippets/benchmark/benchmark.native.js b/tools/snippets/benchmark/benchmark.native.js
index 69b035a857c8..ccfedf1a5cb4 100644
--- a/tools/snippets/benchmark/benchmark.native.js
+++ b/tools/snippets/benchmark/benchmark.native.js
@@ -1,54 +1,52 @@
/**
-* @license Apache-2.0
-*
-* Copyright (c) 2025 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';
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2025 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 resolve = require( 'path' ).resolve;
-var bench = require( '@stdlib/bench' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-var pkg = require( './../package.json' ).name;
-
+var resolve = require("path").resolve;
+var bench = require("@stdlib/bench");
+var tryRequire = require("@stdlib/utils/try-require");
+var pkg = require("./../package.json").name;
// VARIABLES //
-var TODO = tryRequire( resolve( __dirname, './../lib/native.js' ) );
+var TODO = tryRequire(resolve(__dirname, "./../lib/native.js"));
var opts = {
- 'skip': ( TODO instanceof Error )
+ skip: TODO instanceof Error,
};
-
// MAIN //
-bench( pkg+'::native', opts, function benchmark( b ) {
+bench(pkg + "::native", opts, function benchmark(b) {
var i;
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
+ for (i = 0; i < b.iterations; i++) {
// TODO: synchronous task
- if ( TODO/* TODO: condition */ ) {
- b.fail( 'something went wrong' );
+ if (TODO /* TODO: condition */) {
+ b.fail("something went wrong");
}
}
b.toc();
- if ( TODO/* TODO: condition */ ) {
- b.fail( 'something went wrong' );
+ if (TODO /* TODO: condition */) {
+ b.fail("something went wrong");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
});
diff --git a/tools/snippets/benchmark/benchmark.wasm.js b/tools/snippets/benchmark/benchmark.wasm.js
index 66165f7620dd..f8206206ac7b 100644
--- a/tools/snippets/benchmark/benchmark.wasm.js
+++ b/tools/snippets/benchmark/benchmark.wasm.js
@@ -1,53 +1,51 @@
/**
-* @license Apache-2.0
-*
-* Copyright (c) 2025 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';
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2025 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 bench = require( '@stdlib/bench' );
-var hasWebAssemblySupport = require( '@stdlib/assert/has-wasm-support' );
-var pkg = require( './../package.json' ).name;
-var TODO = require( './../lib/wasm.js' );
-
+var bench = require("@stdlib/bench");
+var hasWebAssemblySupport = require("@stdlib/assert/has-wasm-support");
+var pkg = require("./../package.json").name;
+var TODO = require("./../lib/wasm.js");
// VARIABLES //
var opts = {
- 'skip': !hasWebAssemblySupport()
+ skip: !hasWebAssemblySupport(),
};
-
// MAIN //
-bench( pkg+'::wasm', opts, function benchmark( b ) {
+bench(pkg + "::wasm", opts, function benchmark(b) {
var i;
b.tic();
- for ( i = 0; i < b.iterations; i++ ) {
+ for (i = 0; i < b.iterations; i++) {
// TODO: synchronous task
- if ( TODO/* TODO: condition */ ) {
- b.fail( 'something went wrong' );
+ if (TODO /* TODO: condition */) {
+ b.fail("something went wrong");
}
}
b.toc();
- if ( TODO/* TODO: condition */ ) {
- b.fail( 'something went wrong' );
+ if (TODO /* TODO: condition */) {
+ b.fail("something went wrong");
}
- b.pass( 'benchmark finished' );
+ b.pass("benchmark finished");
b.end();
});
diff --git a/tools/snippets/bin/cli b/tools/snippets/bin/cli
index 7c1b87fb8167..4b168e5cfa0d 100755
--- a/tools/snippets/bin/cli
+++ b/tools/snippets/bin/cli
@@ -1,64 +1,63 @@
#!/usr/bin/env node
/**
-* @license Apache-2.0
-*
-* Copyright (c) 2025 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';
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2025 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 resolve = require( 'path' ).resolve;
-var readFileSync = require( '@stdlib/fs/read-file' ).sync;
-var CLI = require( '@stdlib/cli/ctor' );
-var foo = require( './../lib' );
-
+var resolve = require("path").resolve;
+var readFileSync = require("@stdlib/fs/read-file").sync;
+var CLI = require("@stdlib/cli/ctor");
+var foo = require("./../lib");
// MAIN //
/**
-* Main execution sequence.
-*
-* @private
-*/
+ * Main execution sequence.
+ *
+ * @private
+ */
function main() {
- var flags;
- var args;
- 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;
- }
-
- // Get any provided command-line arguments:
- args = cli.args();
-
- foo( args[ 0 ] ); // TODO: implementation
+ var flags;
+ var args;
+ 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;
+ }
+
+ // Get any provided command-line arguments:
+ args = cli.args();
+
+ foo(args[0]); // TODO: implementation
}
main();
diff --git a/tools/snippets/bin/cli_stdin b/tools/snippets/bin/cli_stdin
index 44868f9cab59..2e4aac5ba964 100644
--- a/tools/snippets/bin/cli_stdin
+++ b/tools/snippets/bin/cli_stdin
@@ -1,104 +1,103 @@
#!/usr/bin/env node
/**
-* @license Apache-2.0
-*
-* Copyright (c) 2025 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.
-*/
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2025 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';
+"use strict";
// MODULES //
-var resolve = require( 'path' ).resolve;
-var readFileSync = require( '@stdlib/fs/read-file' ).sync;
-var CLI = require( '@stdlib/cli/ctor' );
-var stdin = require( '@stdlib/process/read-stdin' );
-var stdinStream = require( '@stdlib/streams/node/stdin' );
-var reEOL = require( '@stdlib/regexp/eol' );
-var isRegExpString = require( '@stdlib/assert/is-regexp-string' );
-var reFromString = require( '@stdlib/utils/regexp-from-string' );
-var TODO = require( './../lib' );
-
+var resolve = require("path").resolve;
+var readFileSync = require("@stdlib/fs/read-file").sync;
+var CLI = require("@stdlib/cli/ctor");
+var stdin = require("@stdlib/process/read-stdin");
+var stdinStream = require("@stdlib/streams/node/stdin");
+var reEOL = require("@stdlib/regexp/eol");
+var isRegExpString = require("@stdlib/assert/is-regexp-string");
+var reFromString = require("@stdlib/utils/regexp-from-string");
+var TODO = require("./../lib");
// MAIN //
/**
-* Main execution sequence.
-*
-* @private
-* @returns {void}
-*/
+ * Main execution sequence.
+ *
+ * @private
+ * @returns {void}
+ */
function main() {
- var flags;
- var args;
- var opts;
- var cli;
+ var flags;
+ var args;
+ 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'
- })
- });
+ // 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;
- }
+ // Get any provided command-line options:
+ flags = cli.flags();
+ if (flags.help || flags.version) {
+ return;
+ }
- // Get any provided command-line arguments:
- args = cli.args();
+ // Get any provided command-line arguments:
+ args = cli.args();
- // Check if we are receiving data from `stdin`...
- opts = {};
- if ( !stdinStream.isTTY ) {
- if ( flags.split ) {
- if ( !isRegExpString( flags.split ) ) {
- flags.split = '/'+flags.split+'/';
- }
- opts.split = reFromString( flags.split );
- } else {
- opts.split = reEOL();
- }
- return stdin( onRead );
- }
- console.log( TODO( args[ 0 ] ) ); // eslint-disable-line no-console
+ // Check if we are receiving data from `stdin`...
+ opts = {};
+ if (!stdinStream.isTTY) {
+ if (flags.split) {
+ if (!isRegExpString(flags.split)) {
+ flags.split = "/" + flags.split + "/";
+ }
+ opts.split = reFromString(flags.split);
+ } else {
+ opts.split = reEOL();
+ }
+ return stdin(onRead);
+ }
+ console.log(TODO(args[0])); // eslint-disable-line no-console
- /**
- * Callback invoked upon reading from `stdin`.
- *
- * @private
- * @param {(Error|null)} error - error object
- * @param {Buffer} data - data
- * @returns {void}
- */
- function onRead( error, data ) {
- var lines;
- var i;
- if ( error ) {
- return cli.error( error );
- }
- lines = data.toString().split( opts.split );
- for ( i = 0; i < lines.length; i++ ) {
- console.log( TODO( lines[ i ] ) ); // eslint-disable-line no-console
- }
- }
+ /**
+ * Callback invoked upon reading from `stdin`.
+ *
+ * @private
+ * @param {(Error|null)} error - error object
+ * @param {Buffer} data - data
+ * @returns {void}
+ */
+ function onRead(error, data) {
+ var lines;
+ var i;
+ if (error) {
+ return cli.error(error);
+ }
+ lines = data.toString().split(opts.split);
+ for (i = 0; i < lines.length; i++) {
+ console.log(TODO(lines[i])); // eslint-disable-line no-console
+ }
+ }
}
main();
diff --git a/tools/snippets/c.md b/tools/snippets/c.md
index ebcdf6ff7a03..40d2fccedf07 100644
--- a/tools/snippets/c.md
+++ b/tools/snippets/c.md
@@ -4,7 +4,7 @@
<!-- C interface documentation. -->
-* * *
+---
<section class="c">
diff --git a/tools/snippets/cli.md b/tools/snippets/cli.md
index e62b3df9cad3..d065bc8661fd 100644
--- a/tools/snippets/cli.md
+++ b/tools/snippets/cli.md
@@ -4,7 +4,7 @@
<!-- Section for describing a command-line interface. -->
-* * *
+---
<section class="cli">
diff --git a/tools/snippets/equation.html b/tools/snippets/equation.html
index 31490d36d9ff..cfe444ac0cf1 100644
--- a/tools/snippets/equation.html
+++ b/tools/snippets/equation.html
@@ -1,8 +1,13 @@
<!-- <equation class="equation" label="eq:TODO" align="center" raw="TODO" alt="TODO"> -->
-<div class="equation" align="center" data-raw-text="TODO" data-equation="eq:TODO">
- <img src="TODO" alt="TODO">
- <br>
+<div
+ class="equation"
+ align="center"
+ data-raw-text="TODO"
+ data-equation="eq:TODO"
+>
+ <img src="TODO" alt="TODO" />
+ <br />
</div>
<!-- </equation> -->
diff --git a/tools/snippets/etc/cli_opts.json b/tools/snippets/etc/cli_opts.json
index 92119c456962..e47723eefff7 100644
--- a/tools/snippets/etc/cli_opts.json
+++ b/tools/snippets/etc/cli_opts.json
@@ -1,15 +1,8 @@
{
"string": [],
- "boolean": [
- "help",
- "version"
- ],
+ "boolean": ["help", "version"],
"alias": {
- "help": [
- "h"
- ],
- "version": [
- "V"
- ]
+ "help": ["h"],
+ "version": ["V"]
}
}
diff --git a/tools/snippets/examples/index.js b/tools/snippets/examples/index.js
index a9e69ac28ea0..4eb60c9c3f74 100644
--- a/tools/snippets/examples/index.js
+++ b/tools/snippets/examples/index.js
@@ -1,23 +1,23 @@
/**
-* @license Apache-2.0
-*
-* Copyright (c) 2025 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.
-*/
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2025 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';
+"use strict";
-var foo = require( './../lib' );
+var foo = require("./../lib");
// TODO: add example code
diff --git a/tools/snippets/figure.html b/tools/snippets/figure.html
index a53b2e5d6645..70ee2f3b476f 100644
--- a/tools/snippets/figure.html
+++ b/tools/snippets/figure.html
@@ -1,8 +1,8 @@
<!-- <figure class="figure" align="center" label="fig:TODO" src="./srv/scripts/TODO.js" alt="TODO"> -->
<div class="figure" align="center" data-figure="fig:TODO">
- <img src="TODO" alt="TODO">
- <br>
+ <img src="TODO" alt="TODO" />
+ <br />
</div>
<!-- </figure> -->
diff --git a/tools/snippets/lib/index.js b/tools/snippets/lib/index.js
index d553da142c86..5ba0f9839c93 100644
--- a/tools/snippets/lib/index.js
+++ b/tools/snippets/lib/index.js
@@ -1,39 +1,38 @@
/**
-* @license Apache-2.0
-*
-* Copyright (c) 2025 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.
-*/
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2025 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';
+"use strict";
/**
-* TODO: description
-*
-* @module @stdlib/<TODO: module path>
-*
-* @example
-* var TODO = require( '@stdlib/<TODO: module path>' );
-*
-* var v = TODO( 0.0 );
-* // returns TODO
-*/
+ * TODO: description
+ *
+ * @module @stdlib/<TODO: module path>
+ *
+ * @example
+ * var TODO = require( '@stdlib/<TODO: module path>' );
+ *
+ * var v = TODO( 0.0 );
+ * // returns TODO
+ */
// MODULES //
-var TODO = require( './main.js' );
-
+var TODO = require("./main.js");
// EXPORTS //
diff --git a/tools/snippets/lib/main.js b/tools/snippets/lib/main.js
index be644cf0fca6..f42c4d3e7a2d 100644
--- a/tools/snippets/lib/main.js
+++ b/tools/snippets/lib/main.js
@@ -1,40 +1,39 @@
/**
-* @license Apache-2.0
-*
-* Copyright (c) 2025 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.
-*/
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2025 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';
+"use strict";
// MAIN //
/**
-* TODO: description
-*
-* @param {<TODO: type>} TODO - TODO: param desc
-* @returns {<TODO: type>} TODO: desc
-*
-* @example
-* var v = TODO( 0.0 );
-* // returns TODO
-*/
+ * TODO: description
+ *
+ * @param {<TODO: type>} TODO - TODO: param desc
+ * @returns {<TODO: type>} TODO: desc
+ *
+ * @example
+ * var v = TODO( 0.0 );
+ * // returns TODO
+ */
function TODO() {
// TODO: implementation
}
-
// EXPORTS //
module.exports = TODO;
diff --git a/tools/snippets/lib/validate.js b/tools/snippets/lib/validate.js
index 6078bd3fb5fe..bd4ff7911bf7 100644
--- a/tools/snippets/lib/validate.js
+++ b/tools/snippets/lib/validate.js
@@ -1,62 +1,71 @@
/**
-* @license Apache-2.0
-*
-* Copyright (c) 2025 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.
-*/
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2025 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';
+"use strict";
// MODULES //
-var isPlainObject = require( '@stdlib/assert/is-plain-object' );
-var hasOwnProp = require( '@stdlib/assert/has-own-property' );
-var format = require( '@stdlib/string/format' );
-
+var isPlainObject = require("@stdlib/assert/is-plain-object");
+var hasOwnProp = require("@stdlib/assert/has-own-property");
+var format = require("@stdlib/string/format");
// MAIN //
/**
-* Validates function options.
-*
-* @private
-* @param {Object} opts - destination object
-* @param {Options} options - function options
-* @returns {(Error|null)} null or an error object
-*
-* @example
-* var opts = {};
-* var options = {};
-* var err = validate( opts, options );
-* if ( err ) {
-* throw err;
-* }
-*/
-function validate( opts, options ) {
- if ( !isPlainObject( options ) ) {
- return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
+ * Validates function options.
+ *
+ * @private
+ * @param {Object} opts - destination object
+ * @param {Options} options - function options
+ * @returns {(Error|null)} null or an error object
+ *
+ * @example
+ * var opts = {};
+ * var options = {};
+ * var err = validate( opts, options );
+ * if ( err ) {
+ * throw err;
+ * }
+ */
+function validate(opts, options) {
+ if (!isPlainObject(options)) {
+ return new TypeError(
+ format(
+ "invalid argument. Options argument must be an object. Value: `%s`.",
+ options,
+ ),
+ );
}
- if ( hasOwnProp( options, 'TODO' ) ) {
+ if (hasOwnProp(options, "TODO")) {
opts.TODO = options.TODO;
- if ( !isPlainObject( opts.TODO ) ) {
- return new TypeError( format( 'invalid option. `%s` option must be a TODO. Option: `%s`.', 'TODO', opts.TODO ) );
+ if (!isPlainObject(opts.TODO)) {
+ return new TypeError(
+ format(
+ "invalid option. `%s` option must be a TODO. Option: `%s`.",
+ "TODO",
+ opts.TODO,
+ ),
+ );
}
}
return null;
}
-
// EXPORTS //
module.exports = validate;
diff --git a/tools/snippets/test/test.cli.js b/tools/snippets/test/test.cli.js
index 61e11e246eee..4ee4e14cc610 100644
--- a/tools/snippets/test/test.cli.js
+++ b/tools/snippets/test/test.cli.js
@@ -1,144 +1,141 @@
/**
-* @license Apache-2.0
-*
-* Copyright (c) 2025 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';
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2025 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 resolve = require( 'path' ).resolve;
-var exec = require( 'child_process' ).exec;
-var tape = require( 'tape' );
-var IS_BROWSER = require( '@stdlib/assert/is-browser' );
-var IS_WINDOWS = require( '@stdlib/assert/is-windows' );
-var EXEC_PATH = require( '@stdlib/process/exec-path' );
-var readFileSync = require( '@stdlib/fs/read-file' ).sync;
-
+var resolve = require("path").resolve;
+var exec = require("child_process").exec;
+var tape = require("tape");
+var IS_BROWSER = require("@stdlib/assert/is-browser");
+var IS_WINDOWS = require("@stdlib/assert/is-windows");
+var EXEC_PATH = require("@stdlib/process/exec-path");
+var readFileSync = require("@stdlib/fs/read-file").sync;
// VARIABLES //
-var fpath = resolve( __dirname, '..', 'bin', 'cli' );
+var fpath = resolve(__dirname, "..", "bin", "cli");
var opts = {
- 'skip': IS_BROWSER || IS_WINDOWS
+ skip: IS_BROWSER || IS_WINDOWS,
};
-
// FIXTURES //
-var PKG_VERSION = require( './../package.json' ).version;
-
+var PKG_VERSION = require("./../package.json").version;
// TESTS //
-tape( 'command-line interface', function test( t ) {
- t.ok( true, __filename );
+tape("command-line interface", function test(t) {
+ t.ok(true, __filename);
t.end();
});
-tape( 'when invoked with a `--help` flag, the command-line interface prints the help text to `stderr`', opts, function test( t ) {
- var expected;
- var cmd;
-
- expected = readFileSync( resolve( __dirname, '..', 'docs', 'usage.txt' ), {
- 'encoding': 'utf8'
- });
- cmd = [
- EXEC_PATH,
- fpath,
- '--help'
- ];
-
- exec( cmd.join( ' ' ), done );
-
- function done( error, stdout, stderr ) {
- if ( error ) {
- t.fail( error.message );
- } else {
- t.strictEqual( stdout.toString(), '', 'does not print to `stdout`' );
- t.strictEqual( stderr.toString(), expected+'\n', 'expected value' );
+tape(
+ "when invoked with a `--help` flag, the command-line interface prints the help text to `stderr`",
+ opts,
+ function test(t) {
+ var expected;
+ var cmd;
+
+ expected = readFileSync(resolve(__dirname, "..", "docs", "usage.txt"), {
+ encoding: "utf8",
+ });
+ cmd = [EXEC_PATH, fpath, "--help"];
+
+ exec(cmd.join(" "), done);
+
+ function done(error, stdout, stderr) {
+ if (error) {
+ t.fail(error.message);
+ } else {
+ t.strictEqual(stdout.toString(), "", "does not print to `stdout`");
+ t.strictEqual(stderr.toString(), expected + "\n", "expected value");
+ }
+ t.end();
}
- t.end();
- }
-});
-
-tape( 'when invoked with a `-h` flag, the command-line interface prints the help text to `stderr`', opts, function test( t ) {
- var expected;
- var cmd;
-
- expected = readFileSync( resolve( __dirname, '..', 'docs', 'usage.txt' ), {
- 'encoding': 'utf8'
- });
- cmd = [
- EXEC_PATH,
- fpath,
- '-h'
- ];
-
- exec( cmd.join( ' ' ), done );
-
- function done( error, stdout, stderr ) {
- if ( error ) {
- t.fail( error.message );
- } else {
- t.strictEqual( stdout.toString(), '', 'does not print to `stdout`' );
- t.strictEqual( stderr.toString(), expected+'\n', 'expected value' );
+ },
+);
+
+tape(
+ "when invoked with a `-h` flag, the command-line interface prints the help text to `stderr`",
+ opts,
+ function test(t) {
+ var expected;
+ var cmd;
+
+ expected = readFileSync(resolve(__dirname, "..", "docs", "usage.txt"), {
+ encoding: "utf8",
+ });
+ cmd = [EXEC_PATH, fpath, "-h"];
+
+ exec(cmd.join(" "), done);
+
+ function done(error, stdout, stderr) {
+ if (error) {
+ t.fail(error.message);
+ } else {
+ t.strictEqual(stdout.toString(), "", "does not print to `stdout`");
+ t.strictEqual(stderr.toString(), expected + "\n", "expected value");
+ }
+ t.end();
}
- t.end();
- }
-});
-
-tape( 'when invoked with a `--version` flag, the command-line interface prints the version to `stderr`', opts, function test( t ) {
- var cmd = [
- EXEC_PATH,
- fpath,
- '--version'
- ];
-
- exec( cmd.join( ' ' ), done );
-
- function done( error, stdout, stderr ) {
- if ( error ) {
- t.fail( error.message );
- } else {
- t.strictEqual( stdout.toString(), '', 'does not print to `stdout`' );
- t.strictEqual( stderr.toString(), PKG_VERSION+'\n', 'expected value' );
+ },
+);
+
+tape(
+ "when invoked with a `--version` flag, the command-line interface prints the version to `stderr`",
+ opts,
+ function test(t) {
+ var cmd = [EXEC_PATH, fpath, "--version"];
+
+ exec(cmd.join(" "), done);
+
+ function done(error, stdout, stderr) {
+ if (error) {
+ t.fail(error.message);
+ } else {
+ t.strictEqual(stdout.toString(), "", "does not print to `stdout`");
+ t.strictEqual(stderr.toString(), PKG_VERSION + "\n", "expected value");
+ }
+ t.end();
}
- t.end();
- }
-});
-
-tape( 'when invoked with a `-V` flag, the command-line interface prints the version to `stderr`', opts, function test( t ) {
- var cmd = [
- EXEC_PATH,
- fpath,
- '-V'
- ];
-
- exec( cmd.join( ' ' ), done );
-
- function done( error, stdout, stderr ) {
- if ( error ) {
- t.fail( error.message );
- } else {
- t.strictEqual( stdout.toString(), '', 'does not print to `stdout`' );
- t.strictEqual( stderr.toString(), PKG_VERSION+'\n', 'expected value' );
+ },
+);
+
+tape(
+ "when invoked with a `-V` flag, the command-line interface prints the version to `stderr`",
+ opts,
+ function test(t) {
+ var cmd = [EXEC_PATH, fpath, "-V"];
+
+ exec(cmd.join(" "), done);
+
+ function done(error, stdout, stderr) {
+ if (error) {
+ t.fail(error.message);
+ } else {
+ t.strictEqual(stdout.toString(), "", "does not print to `stdout`");
+ t.strictEqual(stderr.toString(), PKG_VERSION + "\n", "expected value");
+ }
+ t.end();
}
- t.end();
- }
-});
+ },
+);
// TODO: additional tests
diff --git a/tools/snippets/test/test.js b/tools/snippets/test/test.js
index ab6b7d018893..cc79d599f824 100644
--- a/tools/snippets/test/test.js
+++ b/tools/snippets/test/test.js
@@ -1,34 +1,33 @@
/**
-* @license Apache-2.0
-*
-* Copyright (c) 2025 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.
-*/
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2025 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';
+"use strict";
// MODULES //
-var tape = require( 'tape' );
-var TODO = require( './../lib' );
-
+var tape = require("tape");
+var TODO = require("./../lib");
// TESTS //
-tape( 'main export is a function', function test( t ) {
- t.ok( true, __filename );
- t.strictEqual( typeof TODO, 'function', 'main export is a function' );
+tape("main export is a function", function test(t) {
+ t.ok(true, __filename);
+ t.strictEqual(typeof TODO, "function", "main export is a function");
t.end();
});
diff --git a/tools/snippets/test/test.native.js b/tools/snippets/test/test.native.js
index b46ab66277c6..2ee7515b747a 100644
--- a/tools/snippets/test/test.native.js
+++ b/tools/snippets/test/test.native.js
@@ -1,43 +1,41 @@
/**
-* @license Apache-2.0
-*
-* Copyright (c) 2025 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';
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2025 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 resolve = require( 'path' ).resolve;
-var tape = require( 'tape' );
-var tryRequire = require( '@stdlib/utils/try-require' );
-
+var resolve = require("path").resolve;
+var tape = require("tape");
+var tryRequire = require("@stdlib/utils/try-require");
// VARIABLES //
-var TODO = tryRequire( resolve( __dirname, './../lib/native.js' ) );
+var TODO = tryRequire(resolve(__dirname, "./../lib/native.js"));
var opts = {
- 'skip': ( TODO instanceof Error )
+ skip: TODO instanceof Error,
};
-
// TESTS //
-tape( 'main export is a function', opts, function test( t ) {
- t.ok( true, __filename );
- t.strictEqual( typeof TODO, 'function', 'main export is a function' );
+tape("main export is a function", opts, function test(t) {
+ t.ok(true, __filename);
+ t.strictEqual(typeof TODO, "function", "main export is a function");
t.end();
});
diff --git a/tools/snippets/test/test.stdin_cli.js b/tools/snippets/test/test.stdin_cli.js
index c9bd774e929d..9de5f836bd98 100644
--- a/tools/snippets/test/test.stdin_cli.js
+++ b/tools/snippets/test/test.stdin_cli.js
@@ -1,166 +1,169 @@
/**
-* @license Apache-2.0
-*
-* Copyright (c) 2025 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';
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2025 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 resolve = require( 'path' ).resolve;
-var exec = require( 'child_process' ).exec;
-var tape = require( 'tape' );
-var IS_BROWSER = require( '@stdlib/assert/is-browser' );
-var IS_WINDOWS = require( '@stdlib/assert/is-windows' );
-var EXEC_PATH = require( '@stdlib/process/exec-path' );
-var replace = require( '@stdlib/string/replace' );
-var readFileSync = require( '@stdlib/fs/read-file' ).sync;
-
+var resolve = require("path").resolve;
+var exec = require("child_process").exec;
+var tape = require("tape");
+var IS_BROWSER = require("@stdlib/assert/is-browser");
+var IS_WINDOWS = require("@stdlib/assert/is-windows");
+var EXEC_PATH = require("@stdlib/process/exec-path");
+var replace = require("@stdlib/string/replace");
+var readFileSync = require("@stdlib/fs/read-file").sync;
// VARIABLES //
-var fpath = resolve( __dirname, '..', 'bin', 'cli' );
+var fpath = resolve(__dirname, "..", "bin", "cli");
var opts = {
- 'skip': IS_BROWSER || IS_WINDOWS
+ skip: IS_BROWSER || IS_WINDOWS,
};
-
// FIXTURES //
-var PKG_VERSION = require( './../package.json' ).version;
-
+var PKG_VERSION = require("./../package.json").version;
// TESTS //
-tape( 'command-line interface', function test( t ) {
- t.ok( true, __filename );
+tape("command-line interface", function test(t) {
+ t.ok(true, __filename);
t.end();
});
-tape( 'when invoked with a `--help` flag, the command-line interface prints the help text to `stderr`', opts, function test( t ) {
- var expected;
- var cmd;
-
- expected = readFileSync( resolve( __dirname, '..', 'docs', 'usage.txt' ), {
- 'encoding': 'utf8'
- });
- cmd = [
- EXEC_PATH,
- fpath,
- '--help'
- ];
-
- exec( cmd.join( ' ' ), done );
-
- function done( error, stdout, stderr ) {
- if ( error ) {
- t.fail( error.message );
- } else {
- t.strictEqual( stdout.toString(), '', 'does not print to `stdout`' );
- t.strictEqual( stderr.toString(), expected+'\n', 'expected value' );
+tape(
+ "when invoked with a `--help` flag, the command-line interface prints the help text to `stderr`",
+ opts,
+ function test(t) {
+ var expected;
+ var cmd;
+
+ expected = readFileSync(resolve(__dirname, "..", "docs", "usage.txt"), {
+ encoding: "utf8",
+ });
+ cmd = [EXEC_PATH, fpath, "--help"];
+
+ exec(cmd.join(" "), done);
+
+ function done(error, stdout, stderr) {
+ if (error) {
+ t.fail(error.message);
+ } else {
+ t.strictEqual(stdout.toString(), "", "does not print to `stdout`");
+ t.strictEqual(stderr.toString(), expected + "\n", "expected value");
+ }
+ t.end();
}
- t.end();
- }
-});
-
-tape( 'when invoked with a `-h` flag, the command-line interface prints the help text to `stderr`', opts, function test( t ) {
- var expected;
- var cmd;
-
- expected = readFileSync( resolve( __dirname, '..', 'docs', 'usage.txt' ), {
- 'encoding': 'utf8'
- });
- cmd = [
- EXEC_PATH,
- fpath,
- '-h'
- ];
-
- exec( cmd.join( ' ' ), done );
-
- function done( error, stdout, stderr ) {
- if ( error ) {
- t.fail( error.message );
- } else {
- t.strictEqual( stdout.toString(), '', 'does not print to `stdout`' );
- t.strictEqual( stderr.toString(), expected+'\n', 'expected value' );
+ },
+);
+
+tape(
+ "when invoked with a `-h` flag, the command-line interface prints the help text to `stderr`",
+ opts,
+ function test(t) {
+ var expected;
+ var cmd;
+
+ expected = readFileSync(resolve(__dirname, "..", "docs", "usage.txt"), {
+ encoding: "utf8",
+ });
+ cmd = [EXEC_PATH, fpath, "-h"];
+
+ exec(cmd.join(" "), done);
+
+ function done(error, stdout, stderr) {
+ if (error) {
+ t.fail(error.message);
+ } else {
+ t.strictEqual(stdout.toString(), "", "does not print to `stdout`");
+ t.strictEqual(stderr.toString(), expected + "\n", "expected value");
+ }
+ t.end();
}
- t.end();
- }
-});
-
-tape( 'when invoked with a `--version` flag, the command-line interface prints the version to `stderr`', opts, function test( t ) {
- var cmd = [
- EXEC_PATH,
- fpath,
- '--version'
- ];
-
- exec( cmd.join( ' ' ), done );
-
- function done( error, stdout, stderr ) {
- if ( error ) {
- t.fail( error.message );
- } else {
- t.strictEqual( stdout.toString(), '', 'does not print to `stdout`' );
- t.strictEqual( stderr.toString(), PKG_VERSION+'\n', 'expected value' );
+ },
+);
+
+tape(
+ "when invoked with a `--version` flag, the command-line interface prints the version to `stderr`",
+ opts,
+ function test(t) {
+ var cmd = [EXEC_PATH, fpath, "--version"];
+
+ exec(cmd.join(" "), done);
+
+ function done(error, stdout, stderr) {
+ if (error) {
+ t.fail(error.message);
+ } else {
+ t.strictEqual(stdout.toString(), "", "does not print to `stdout`");
+ t.strictEqual(stderr.toString(), PKG_VERSION + "\n", "expected value");
+ }
+ t.end();
}
- t.end();
- }
-});
-
-tape( 'when invoked with a `-V` flag, the command-line interface prints the version to `stderr`', opts, function test( t ) {
- var cmd = [
- EXEC_PATH,
- fpath,
- '-V'
- ];
-
- exec( cmd.join( ' ' ), done );
-
- function done( error, stdout, stderr ) {
- if ( error ) {
- t.fail( error.message );
- } else {
- t.strictEqual( stdout.toString(), '', 'does not print to `stdout`' );
- t.strictEqual( stderr.toString(), PKG_VERSION+'\n', 'expected value' );
+ },
+);
+
+tape(
+ "when invoked with a `-V` flag, the command-line interface prints the version to `stderr`",
+ opts,
+ function test(t) {
+ var cmd = [EXEC_PATH, fpath, "-V"];
+
+ exec(cmd.join(" "), done);
+
+ function done(error, stdout, stderr) {
+ if (error) {
+ t.fail(error.message);
+ } else {
+ t.strictEqual(stdout.toString(), "", "does not print to `stdout`");
+ t.strictEqual(stderr.toString(), PKG_VERSION + "\n", "expected value");
+ }
+ t.end();
}
- t.end();
- }
-});
+ },
+);
-tape( 'the command-line interface does TODO', opts, function test( t ) {
+tape("the command-line interface does TODO", opts, function test(t) {
var opts;
var cmd;
cmd = [
EXEC_PATH,
- '-e',
- '"process.stdin.isTTY = true; process.argv[ 2 ] = \'TODO\'; require( \''+fpath+'\' );"'
+ "-e",
+ "\"process.stdin.isTTY = true; process.argv[ 2 ] = 'TODO'; require( '" +
+ fpath +
+ "' );\"",
];
opts = {};
- exec( cmd.join( ' ' ), opts, done );
+ exec(cmd.join(" "), opts, done);
- function done( error, stdout, stderr ) {
- if ( error ) {
- t.fail( error.message );
+ function done(error, stdout, stderr) {
+ if (error) {
+ t.fail(error.message);
} else {
- t.strictEqual( stdout.toString(), 'TODO', 'prints expected results to stdout' );
- t.strictEqual( stderr.toString(), '', 'does not print to `stderr`' );
+ t.strictEqual(
+ stdout.toString(),
+ "TODO",
+ "prints expected results to stdout",
+ );
+ t.strictEqual(stderr.toString(), "", "does not print to `stderr`");
}
t.end();
}
@@ -168,37 +171,40 @@ tape( 'the command-line interface does TODO', opts, function test( t ) {
// TODO: add additional tests
-tape( 'when used as a standard stream, if an error is encountered when reading from `stdin`, the command-line interface prints an error and sets a non-zero exit code', opts, function test( t ) {
- var script;
- var opts;
- var cmd;
-
- script = readFileSync( resolve( __dirname, 'fixtures', 'stdin_error.js.txt' ), {
- 'encoding': 'utf8'
- });
-
- // Replace single quotes with double quotes:
- script = replace( script, '\'', '"' );
-
- cmd = [
- EXEC_PATH,
- '-e',
- '\''+script+'\''
- ];
-
- opts = {
- 'cwd': __dirname
- };
-
- exec( cmd.join( ' ' ), opts, done );
-
- function done( error, stdout, stderr ) {
- if ( error ) {
- t.pass( error.message );
- t.strictEqual( error.code, 1, 'expected exit code' );
+tape(
+ "when used as a standard stream, if an error is encountered when reading from `stdin`, the command-line interface prints an error and sets a non-zero exit code",
+ opts,
+ function test(t) {
+ var script;
+ var opts;
+ var cmd;
+
+ script = readFileSync(
+ resolve(__dirname, "fixtures", "stdin_error.js.txt"),
+ {
+ encoding: "utf8",
+ },
+ );
+
+ // Replace single quotes with double quotes:
+ script = replace(script, "'", '"');
+
+ cmd = [EXEC_PATH, "-e", "'" + script + "'"];
+
+ opts = {
+ cwd: __dirname,
+ };
+
+ exec(cmd.join(" "), opts, done);
+
+ function done(error, stdout, stderr) {
+ if (error) {
+ t.pass(error.message);
+ t.strictEqual(error.code, 1, "expected exit code");
+ }
+ t.strictEqual(stdout.toString(), "", "does not print to `stdout`");
+ t.strictEqual(stderr.toString(), "Error: beep\n", "expected value");
+ t.end();
}
- t.strictEqual( stdout.toString(), '', 'does not print to `stdout`' );
- t.strictEqual( stderr.toString(), 'Error: beep\n', 'expected value' );
- t.end();
- }
-});
+ },
+);
diff --git a/tools/snippets/test/test.validate.js b/tools/snippets/test/test.validate.js
index c4bedccaee84..f9c593bf0b69 100644
--- a/tools/snippets/test/test.validate.js
+++ b/tools/snippets/test/test.validate.js
@@ -1,65 +1,61 @@
/**
-* @license Apache-2.0
-*
-* Copyright (c) 2025 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';
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2025 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 tape = require( 'tape' );
-var format = require( '@stdlib/string/format' );
-var validate = require( './../lib/validate.js' );
-
+var tape = require("tape");
+var format = require("@stdlib/string/format");
+var validate = require("./../lib/validate.js");
// TESTS //
-tape( 'main export is a function', function test( t ) {
- t.ok( true, __filename );
- t.strictEqual( typeof validate, 'function', 'main export is a function' );
+tape("main export is a function", function test(t) {
+ t.ok(true, __filename);
+ t.strictEqual(typeof validate, "function", "main export is a function");
t.end();
});
-tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) {
- var values;
- var err;
- var i;
-
- values = [
- '5',
- 5,
- NaN,
- true,
- false,
- void 0,
- null,
- [],
- function noop() {}
- ];
-
- for ( i = 0; i < values.length; i++ ) {
- err = validate( {}, values[ i ] );
- t.strictEqual( err instanceof TypeError, true, format( 'returns an error when provided %s', values[i] ) );
- }
- t.end();
-});
+tape(
+ "the function returns an error if provided an `options` argument which is not an object",
+ function test(t) {
+ var values;
+ var err;
+ var i;
+
+ values = ["5", 5, NaN, true, false, void 0, null, [], function noop() {}];
+
+ for (i = 0; i < values.length; i++) {
+ err = validate({}, values[i]);
+ t.strictEqual(
+ err instanceof TypeError,
+ true,
+ format("returns an error when provided %s", values[i]),
+ );
+ }
+ t.end();
+ },
+);
// TODO: add tests
-tape( 'the function returns `null` if all options are valid', function test( t ) {
+tape("the function returns `null` if all options are valid", function test(t) {
var options;
var opts;
var err;
@@ -67,27 +63,27 @@ tape( 'the function returns `null` if all options are valid', function test( t )
opts = {};
options = {}; // TODO: add options
- err = validate( opts, options );
- t.strictEqual( err, null, 'returns expected value' );
- t.deepEqual( opts, options, 'sets options' );
+ err = validate(opts, options);
+ t.strictEqual(err, null, "returns expected value");
+ t.deepEqual(opts, options, "sets options");
t.end();
});
-tape( 'the function will ignore unrecognized options', function test( t ) {
+tape("the function will ignore unrecognized options", function test(t) {
var options;
var opts;
var err;
opts = {};
options = {
- 'beep': true,
- 'boop': 'bop'
+ beep: true,
+ boop: "bop",
};
- err = validate( opts, options );
- t.strictEqual( err, null, 'returns expected value' );
- t.deepEqual( opts, {}, 'ignores unrecognized options' );
+ err = validate(opts, options);
+ t.strictEqual(err, null, "returns expected value");
+ t.deepEqual(opts, {}, "ignores unrecognized options");
t.end();
});
diff --git a/tsconfig.json b/tsconfig.json
index 39d2d41cb5b1..571dd28dd7f8 100644
--- a/tsconfig.json
+++ b/tsconfig.json
@@ -9,9 +9,7 @@
"checkJs": true,
"forceConsistentCasingInFileNames": true,
"keyofStringsOnly": false,
- "lib": [
- "es6"
- ],
+ "lib": ["es6"],
"module": "commonjs",
"moduleResolution": "node",
"newLine": "lf",
@@ -30,7 +28,7 @@
"strictNullChecks": true,
"suppressExcessPropertyErrors": false,
"suppressImplicitAnyIndexErrors": false,
- "typeRoots": [ "." ],
+ "typeRoots": ["."],
"types": []
},
"include": [
@@ -41,7 +39,5 @@
"lib/node_modules/**/@stdlib/types/index.d.ts",
"lib/node_modules/**/@stdlib/types/test.ts"
],
- "exclude": [
- "node_modules"
- ]
+ "exclude": ["node_modules"]
}