diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index dc64192..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2025-05-19T01:42:13.003Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9143416..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fs/read-json) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 29fd259..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fs/read-json) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 2984901..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 66eb8be..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '24 0 * * 4' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download 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 }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -199,7 +196,7 @@ function onJSON( error, data ) { ## Notice -This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. +This package is part of [stdlib][stdlib], a standard library with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. @@ -268,7 +265,7 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. -[@stdlib/fs/read-file]: https://github.com/stdlib-js/fs-read-file +[@stdlib/fs/read-file]: https://github.com/stdlib-js/fs-read-file/tree/esm diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 1ba4b83..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,80 +0,0 @@ -/** -* @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 bench = require( '@stdlib/bench-harness' ); -var instanceOf = require( '@stdlib/assert-instance-of' ); -var pkg = require( './../package.json' ).name; -var readJSON = require( './../lib' ); - - -// VARIABLES // - -var FILE = resolve( __dirname, '..', 'package.json' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var i; - - i = 0; - b.tic(); - - return next(); - - function next() { - i += 1; - if ( i <= b.iterations ) { - return readJSON( FILE, done ); - } - b.toc(); - b.pass( 'benchmark finished' ); - b.end(); - } - - function done( error ) { - if ( error ) { - b.fail( error.message ); - } - next(); - } -}); - -bench( pkg+':sync', function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = readJSON.sync( FILE ); - if ( out instanceof Error ) { - b.fail( out.message ); - } - } - b.toc(); - if ( instanceOf( out, Error ) ) { - b.fail( 'something went wrong' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 51117ef..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fs/read-json" -%% click B href "https://github.com/stdlib-js/fs-read-json/tree/main" -%% click C href "https://github.com/stdlib-js/fs-read-json/tree/production" -%% click D href "https://github.com/stdlib-js/fs-read-json/tree/esm" -%% click E href "https://github.com/stdlib-js/fs-read-json/tree/deno" -%% click F href "https://github.com/stdlib-js/fs-read-json/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fs/read-json -[production-url]: https://github.com/stdlib-js/fs-read-json/tree/production -[deno-url]: https://github.com/stdlib-js/fs-read-json/tree/deno -[deno-readme]: https://github.com/stdlib-js/fs-read-json/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/fs-read-json/tree/umd -[umd-readme]: https://github.com/stdlib-js/fs-read-json/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/fs-read-json/tree/esm -[esm-readme]: https://github.com/stdlib-js/fs-read-json/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 4e0e4b9..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import readJSON from '../docs/types/index'; -export = readJSON; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index c6e9294..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var v=function(n,r){return function(){return r||n((r={exports:{}}).exports,r),r.exports}};var q=v(function(P,g){ -var l=require('@stdlib/assert-is-string/dist').isPrimitive,S=require('@stdlib/assert-is-plain-object/dist'),b=require('@stdlib/assert-is-function/dist'),y=require('@stdlib/fs-read-file/dist'),h=require('@stdlib/string-remove-utf8-bom/dist'),s=require('@stdlib/utils-parse-json/dist'),w=require('@stdlib/assert-instance-of/dist'),c=require('@stdlib/error-tools-fmtprodmsg/dist');function E(n,r,a){var e,t;if(arguments.length<3)e={},t=r;else{if(l(r))e={encoding:r};else{if(!S(r))throw new TypeError(c('0OH3t',r));e=r}t=a}if(!b(t))throw new TypeError(c('0OH2b',t));y(n,e,O);function O(u,i){if(u)return t(u);if(i=i.toString(),e.encoding==="utf8"&&(i=h(i)),e.reviver?i=s(i,e.reviver):i=s(i),w(i,Error))return t(i);t(null,i)}}g.exports=E -});var d=v(function(R,o){ -var J=require('@stdlib/assert-is-string/dist').isPrimitive,N=require('@stdlib/assert-is-plain-object/dist'),j=require('@stdlib/fs-read-file/dist').sync,p=require('@stdlib/string-remove-utf8-bom/dist'),m=require('@stdlib/utils-parse-json/dist'),x=require('@stdlib/assert-instance-of/dist'),F=require('@stdlib/error-tools-fmtprodmsg/dist');function T(n,r){var a,e;if(arguments.length>1)if(J(r))a={encoding:r};else{if(!N(r))throw new TypeError(F('0OH3t',r));a=r}else a={};return e=j(n,a),x(e,Error)?e:(e=e.toString(),a.encoding==="utf8"&&(e=p(e)),a.reviver?m(e,a.reviver):m(e))}o.exports=T -});var V=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),f=q(),B=d();V(f,"sync",B);module.exports=f; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index c27dafb..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/async.js", "../lib/sync.js", "../lib/index.js"], - "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isString = require( '@stdlib/assert-is-string' ).isPrimitive;\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar isFunction = require( '@stdlib/assert-is-function' );\nvar readFile = require( '@stdlib/fs-read-file' );\nvar removeBOM = require( '@stdlib/string-remove-utf8-bom' );\nvar parseJSON = require( '@stdlib/utils-parse-json' );\nvar instanceOf = require( '@stdlib/assert-instance-of' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Asynchronously reads a file as JSON.\n*\n* @param {(string|Buffer|integer)} file - file path or file descriptor\n* @param {(Options|string)} [options] - options\n* @param {(string|null)} [options.encoding] - file encoding\n* @param {string} [options.flag] - file status flag\n* @param {Function} [options.reviver] - JSON reviver\n* @param {Callback} clbk - callback\n* @throws {TypeError} options argument must be either a string or an object\n* @throws {TypeError} callback argument must be a function\n*\n* @example\n* var resolve = require( 'path' ).resolve;\n*\n* readJSON( resolve( __dirname, '..', 'package.json' ), onJSON );\n*\n* function onJSON( error, data ) {\n* if ( error ) {\n* throw error;\n* }\n* console.dir( data );\n* }\n*/\nfunction readJSON( file, options, clbk ) {\n\tvar opts;\n\tvar done;\n\tif ( arguments.length < 3 ) {\n\t\topts = {};\n\t\tdone = options;\n\t} else {\n\t\tif ( isString( options ) ) {\n\t\t\topts = {\n\t\t\t\t'encoding': options\n\t\t\t};\n\t\t} else {\n\t\t\tif ( !isObject( options ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Options argument must be either a string or an object. Value: `%s`.', options ) );\n\t\t\t}\n\t\t\topts = options;\n\t\t}\n\t\tdone = clbk;\n\t}\n\tif ( !isFunction( done ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Callback argument must be a function. Value: `%s`.', done ) );\n\t}\n\treadFile( file, opts, onRead );\n\n\t/**\n\t* Callback invoked upon reading a file.\n\t*\n\t* @private\n\t* @param {(Error|null)} error - error object\n\t* @param {(Buffer|string)} file - file contents\n\t* @returns {void}\n\t*/\n\tfunction onRead( error, file ) {\n\t\tif ( error ) {\n\t\t\treturn done( error );\n\t\t}\n\t\tfile = file.toString();\n\t\tif ( opts.encoding === 'utf8' ) {\n\t\t\tfile = removeBOM( file );\n\t\t}\n\t\tif ( opts.reviver ) {\n\t\t\tfile = parseJSON( file, opts.reviver );\n\t\t} else {\n\t\t\tfile = parseJSON( file );\n\t\t}\n\t\tif ( instanceOf( file, Error ) ) {\n\t\t\treturn done( file );\n\t\t}\n\t\tdone( null, file );\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = readJSON;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isString = require( '@stdlib/assert-is-string' ).isPrimitive;\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar readFile = require( '@stdlib/fs-read-file' ).sync;\nvar removeBOM = require( '@stdlib/string-remove-utf8-bom' );\nvar parseJSON = require( '@stdlib/utils-parse-json' );\nvar instanceOf = require( '@stdlib/assert-instance-of' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Synchronously reads a file as JSON.\n*\n* @param {(string|Buffer|integer)} file - file path or file descriptor\n* @param {(Options|string)} [options] - options\n* @param {(string|null)} [options.encoding] - file encoding\n* @param {string} [options.flag] - file status flag\n* @param {Function} [options.reviver] - JSON reviver\n* @throws {TypeError} options argument must be either a string or an object\n* @returns {(JSON|Error)} JSON or an error\n*\n* @example\n* var resolve = require( 'path' ).resolve;\n* var instanceOf = require( '@stdlib/assert-instance-of' );\n*\n* var out = readJSONSync( resolve( __dirname, '..', 'package.json' ) );\n* if ( instanceOf( out, Error ) ) {\n* throw out;\n* }\n* console.dir( out );\n*/\nfunction readJSONSync( file, options ) {\n\tvar opts;\n\tvar f;\n\tif ( arguments.length > 1 ) {\n\t\tif ( isString( options ) ) {\n\t\t\topts = {\n\t\t\t\t'encoding': options\n\t\t\t};\n\t\t} else {\n\t\t\tif ( !isObject( options ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Options argument must be either a string or an object. Value: `%s`.', options ) );\n\t\t\t}\n\t\t\topts = options;\n\t\t}\n\t} else {\n\t\topts = {};\n\t}\n\tf = readFile( file, opts );\n\tif ( instanceOf( f, Error ) ) {\n\t\treturn f;\n\t}\n\tf = f.toString();\n\tif ( opts.encoding === 'utf8' ) {\n\t\tf = removeBOM( f );\n\t}\n\tif ( opts.reviver ) {\n\t\treturn parseJSON( f, opts.reviver );\n\t}\n\treturn parseJSON( f );\n}\n\n\n// EXPORTS //\n\nmodule.exports = readJSONSync;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Read a file as JSON.\n*\n* @module @stdlib/fs-read-json\n*\n* @example\n* var resolve = require( 'path' ).resolve;\n* var readJSON = require( '@stdlib/fs-read-json' );\n*\n* function onJSON( error, data ) {\n* if ( error ) {\n* throw error;\n* }\n* console.dir( data );\n* }\n*\n* readJSON( resolve( __dirname, '..', 'package.json' ), onJSON );\n*\n* @example\n* var resolve = require( 'path' ).resolve;\n* var instanceOf = require( '@stdlib/assert-instance-of' );\n* var readJSON = require( '@stdlib/fs-read-json' );\n*\n* var out = readJSON.sync( resolve( __dirname, '..', 'package.json' ) );\n* if ( instanceOf( out, Error ) ) {\n* throw out;\n* }\n* console.dir( out );\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar readJSON = require( './async.js' );\nvar sync = require( './sync.js' );\n\n\n// MAIN //\n\nsetReadOnly( readJSON, 'sync', sync );\n\n\n// EXPORTS //\n\nmodule.exports = readJSON;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,0BAA2B,EAAE,YACjDC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,4BAA6B,EACnDC,EAAW,QAAS,sBAAuB,EAC3CC,EAAY,QAAS,gCAAiC,EACtDC,EAAY,QAAS,0BAA2B,EAChDC,EAAa,QAAS,4BAA6B,EACnDC,EAAS,QAAS,uBAAwB,EA6B9C,SAASC,EAAUC,EAAMC,EAASC,EAAO,CACxC,IAAIC,EACAC,EACJ,GAAK,UAAU,OAAS,EACvBD,EAAO,CAAC,EACRC,EAAOH,MACD,CACN,GAAKV,EAAUU,CAAQ,EACtBE,EAAO,CACN,SAAYF,CACb,MACM,CACN,GAAK,CAACT,EAAUS,CAAQ,EACvB,MAAM,IAAI,UAAWH,EAAQ,wFAAyFG,CAAQ,CAAE,EAEjIE,EAAOF,CACR,CACAG,EAAOF,CACR,CACA,GAAK,CAACT,EAAYW,CAAK,EACtB,MAAM,IAAI,UAAWN,EAAQ,uEAAwEM,CAAK,CAAE,EAE7GV,EAAUM,EAAMG,EAAME,CAAO,EAU7B,SAASA,EAAQC,EAAON,EAAO,CAC9B,GAAKM,EACJ,OAAOF,EAAME,CAAM,EAWpB,GATAN,EAAOA,EAAK,SAAS,EAChBG,EAAK,WAAa,SACtBH,EAAOL,EAAWK,CAAK,GAEnBG,EAAK,QACTH,EAAOJ,EAAWI,EAAMG,EAAK,OAAQ,EAErCH,EAAOJ,EAAWI,CAAK,EAEnBH,EAAYG,EAAM,KAAM,EAC5B,OAAOI,EAAMJ,CAAK,EAEnBI,EAAM,KAAMJ,CAAK,CAClB,CACD,CAKAV,EAAO,QAAUS,ICjHjB,IAAAQ,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,0BAA2B,EAAE,YACjDC,EAAW,QAAS,gCAAiC,EACrDC,EAAW,QAAS,sBAAuB,EAAE,KAC7CC,EAAY,QAAS,gCAAiC,EACtDC,EAAY,QAAS,0BAA2B,EAChDC,EAAa,QAAS,4BAA6B,EACnDC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAcC,EAAMC,EAAU,CACtC,IAAIC,EACAC,EACJ,GAAK,UAAU,OAAS,EACvB,GAAKX,EAAUS,CAAQ,EACtBC,EAAO,CACN,SAAYD,CACb,MACM,CACN,GAAK,CAACR,EAAUQ,CAAQ,EACvB,MAAM,IAAI,UAAWH,EAAQ,wFAAyFG,CAAQ,CAAE,EAEjIC,EAAOD,CACR,MAEAC,EAAO,CAAC,EAGT,OADAC,EAAIT,EAAUM,EAAME,CAAK,EACpBL,EAAYM,EAAG,KAAM,EAClBA,GAERA,EAAIA,EAAE,SAAS,EACVD,EAAK,WAAa,SACtBC,EAAIR,EAAWQ,CAAE,GAEbD,EAAK,QACFN,EAAWO,EAAGD,EAAK,OAAQ,EAE5BN,EAAWO,CAAE,EACrB,CAKAZ,EAAO,QAAUQ,ICpCjB,IAAIK,EAAc,QAAS,uDAAwD,EAC/EC,EAAW,IACXC,EAAO,IAKXF,EAAaC,EAAU,OAAQC,CAAK,EAKpC,OAAO,QAAUD", - "names": ["require_async", "__commonJSMin", "exports", "module", "isString", "isObject", "isFunction", "readFile", "removeBOM", "parseJSON", "instanceOf", "format", "readJSON", "file", "options", "clbk", "opts", "done", "onRead", "error", "require_sync", "__commonJSMin", "exports", "module", "isString", "isObject", "readFile", "removeBOM", "parseJSON", "instanceOf", "format", "readJSONSync", "file", "options", "opts", "f", "setReadOnly", "readJSON", "sync"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 22d3c12..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,72 +0,0 @@ - -{{alias}}( file[, options], clbk ) - Asynchronously reads a file as JSON. - - Parameters - ---------- - file: string|Buffer|integer - Filename or file descriptor. - - options: Object|string (optional) - Options. If a string, the value is the encoding. - - options.encoding: string|null (optional) - Encoding. If the encoding option is set to `utf8` and the file has a - UTF-8 byte order mark (BOM), the byte order mark is *removed* before - attempting to parse as JSON. Default: null. - - options.flag: string (optional) - Flag. Default: 'r'. - - options.reviver: Function (optional) - JSON transformation function. - - clbk: Function - Callback to invoke upon reading file contents. - - Examples - -------- - > function onRead( error, data ) { - ... if ( error ) { - ... console.error( error.message ); - ... } else { - ... console.log( data ); - ... } - ... }; - > {{alias}}( './beep/boop.json', onRead ); - - -{{alias}}.sync( file[, options] ) - Synchronously reads a file as JSON. - - Parameters - ---------- - file: string|Buffer|integer - Filename or file descriptor. - - options: Object|string (optional) - Options. If a string, the value is the encoding. - - options.encoding: string|null (optional) - Encoding. If the encoding option is set to `utf8` and the file has a - UTF-8 byte order mark (BOM), the byte order mark is *removed* before - attempting to parse as JSON. Default: null. - - options.flag: string (optional) - Flag. Default: 'r'. - - options.reviver: Function (optional) - JSON transformation function. - - Returns - ------- - out: Error|JSON - File contents. - - Examples - -------- - > var out = {{alias}}.sync( './beep/boop.json' ); - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index d3dac56..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,175 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2020 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -import readJSON = require( './index' ); - -/** -* Callback function. -* -* @param error - error object -* @param data - results -*/ -function onLoad( error: Error | null, data?: Array | Buffer ): void { - if ( error || !data ) { - throw error; - } -} - - -// TESTS // - -// The function does not have a return value... -{ - readJSON( 'package.json', onLoad ); // $ExpectType void -} - -// The compiler throws an error if the function is provided a first argument which is not a string, buffer, or file descriptor... -{ - readJSON( false, onLoad ); // $ExpectError - readJSON( true, onLoad ); // $ExpectError - readJSON( null, onLoad ); // $ExpectError - readJSON( undefined, onLoad ); // $ExpectError - readJSON( [], onLoad ); // $ExpectError - readJSON( {}, onLoad ); // $ExpectError - readJSON( ( x: number ): number => x, onLoad ); // $ExpectError -} - -// The compiler throws an error if the function is provided a callback argument which is not a function with the expected signature... -{ - readJSON( '/path/to/package.json', 'abc' ); // $ExpectError - readJSON( '/path/to/package.json', 1 ); // $ExpectError - readJSON( '/path/to/package.json', false ); // $ExpectError - readJSON( '/path/to/package.json', true ); // $ExpectError - readJSON( '/path/to/package.json', null ); // $ExpectError - readJSON( '/path/to/package.json', undefined ); // $ExpectError - readJSON( '/path/to/package.json', [] ); // $ExpectError - readJSON( '/path/to/package.json', {} ); // $ExpectError - readJSON( '/path/to/package.json', ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an options argument which is not an object or string... -{ - readJSON( 'package.json', false, onLoad ); // $ExpectError - readJSON( 'package.json', true, onLoad ); // $ExpectError - readJSON( 'package.json', null, onLoad ); // $ExpectError - readJSON( 'package.json', undefined, onLoad ); // $ExpectError - readJSON( 'package.json', 123, onLoad ); // $ExpectError - readJSON( 'package.json', [], onLoad ); // $ExpectError - readJSON( 'package.json', ( x: number ): number => x, onLoad ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `encoding` option which is not a string or null... -{ - readJSON( 'package.json', { 'encoding': 123 }, onLoad ); // $ExpectError - readJSON( 'package.json', { 'encoding': true }, onLoad ); // $ExpectError - readJSON( 'package.json', { 'encoding': false }, onLoad ); // $ExpectError - readJSON( 'package.json', { 'encoding': [] }, onLoad ); // $ExpectError - readJSON( 'package.json', { 'encoding': {} }, onLoad ); // $ExpectError - readJSON( 'package.json', { 'encoding': ( x: number ): number => x }, onLoad ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `flag` option which is not a string... -{ - readJSON( 'package.json', { 'flag': 123 }, onLoad ); // $ExpectError - readJSON( 'package.json', { 'flag': true }, onLoad ); // $ExpectError - readJSON( 'package.json', { 'flag': false }, onLoad ); // $ExpectError - readJSON( 'package.json', { 'flag': null }, onLoad ); // $ExpectError - readJSON( 'package.json', { 'flag': [] }, onLoad ); // $ExpectError - readJSON( 'package.json', { 'flag': {} }, onLoad ); // $ExpectError - readJSON( 'package.json', { 'flag': ( x: number ): number => x }, onLoad ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `reviver` option which is not a function... -{ - readJSON( 'package.json', { 'reviver': 123 }, onLoad ); // $ExpectError - readJSON( 'package.json', { 'reviver': 'abc' }, onLoad ); // $ExpectError - readJSON( 'package.json', { 'reviver': true }, onLoad ); // $ExpectError - readJSON( 'package.json', { 'reviver': false }, onLoad ); // $ExpectError - readJSON( 'package.json', { 'reviver': null }, onLoad ); // $ExpectError - readJSON( 'package.json', { 'reviver': [] }, onLoad ); // $ExpectError - readJSON( 'package.json', { 'reviver': {} }, onLoad ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - readJSON(); // $ExpectError - readJSON( 'C:\\foo\\bar\\baz\\package.json' ); // $ExpectError -} - -// Attached to main export is a `sync` method which returns results or an error... -{ - readJSON.sync>( 'package.json' ); // $ExpectType Error | string[] -} - -// The compiler throws an error if the `sync` method is provided a first argument which is not a string, buffer, or file descriptor... -{ - readJSON.sync( false ); // $ExpectError - readJSON.sync( true ); // $ExpectError - readJSON.sync( null ); // $ExpectError - readJSON.sync( undefined ); // $ExpectError - readJSON.sync( [] ); // $ExpectError - readJSON.sync( {} ); // $ExpectError - readJSON.sync( ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `sync` method is provided an options argument which is not an object or string... -{ - readJSON.sync( 'package.json', null ); // $ExpectError - readJSON.sync( 'package.json', true ); // $ExpectError - readJSON.sync( 'package.json', false ); // $ExpectError - readJSON.sync( 'package.json', 123 ); // $ExpectError - readJSON.sync( 'package.json', [] ); // $ExpectError - readJSON.sync( 'package.json', ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `sync` method is provided an `encoding` option which is not a string or null... -{ - readJSON.sync( 'package.json', { 'encoding': 123 } ); // $ExpectError - readJSON.sync( 'package.json', { 'encoding': true } ); // $ExpectError - readJSON.sync( 'package.json', { 'encoding': false } ); // $ExpectError - readJSON.sync( 'package.json', { 'encoding': [] } ); // $ExpectError - readJSON.sync( 'package.json', { 'encoding': {} } ); // $ExpectError - readJSON.sync( 'package.json', { 'encoding': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `sync` method is provided a `flag` option which is not a string... -{ - readJSON.sync( 'package.json', { 'flag': 123 } ); // $ExpectError - readJSON.sync( 'package.json', { 'flag': true } ); // $ExpectError - readJSON.sync( 'package.json', { 'flag': false } ); // $ExpectError - readJSON.sync( 'package.json', { 'flag': null } ); // $ExpectError - readJSON.sync( 'package.json', { 'flag': [] } ); // $ExpectError - readJSON.sync( 'package.json', { 'flag': {} } ); // $ExpectError - readJSON.sync( 'package.json', { 'flag': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `sync` method is provided a `reviver` option which is not a function... -{ - readJSON.sync( 'package.json', { 'reviver': 'abc' } ); // $ExpectError - readJSON.sync( 'package.json', { 'reviver': 123 } ); // $ExpectError - readJSON.sync( 'package.json', { 'reviver': true } ); // $ExpectError - readJSON.sync( 'package.json', { 'reviver': false } ); // $ExpectError - readJSON.sync( 'package.json', { 'reviver': null } ); // $ExpectError - readJSON.sync( 'package.json', { 'reviver': [] } ); // $ExpectError - readJSON.sync( 'package.json', { 'reviver': {} } ); // $ExpectError -} - -// The compiler throws an error if the `sync` method is provided an unsupported number of arguments... -{ - readJSON.sync(); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 3df0446..0000000 --- a/examples/index.js +++ /dev/null @@ -1,52 +0,0 @@ -/** -* @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'; - -var resolve = require( 'path' ).resolve; -var instanceOf = require( '@stdlib/assert-instance-of' ); -var readJSON = require( './../lib' ); - -var file = resolve( __dirname, '..', 'package.json' ); - -// Synchronously read a JSON file... -var data = readJSON.sync( file, 'utf8' ); -console.log( instanceOf( data, Error ) ); -// => false - -data = readJSON.sync( 'beepboop', { - 'encoding': 'utf8' -}); -console.log( instanceOf( data, Error ) ); -// => true - -// Asynchronously read a JSON file... -readJSON( file, onJSON ); -readJSON( 'beepboop', onJSON ); - -function onJSON( error, data ) { - if ( error ) { - if ( error.code === 'ENOENT' ) { - console.error( 'JSON file does not exist.' ); - } else { - throw error; - } - } else { - console.log( 'Package description: %s', data.description ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 100% rename from docs/types/index.d.ts rename to index.d.ts diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..41434f6 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{isPrimitive as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string@v0.2.2-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.2-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.2-esm/index.mjs";import i,{sync as n}from"https://cdn.jsdelivr.net/gh/stdlib-js/fs-read-file@v0.2.2-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/string-remove-utf8-bom@v0.2.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-parse-json@v0.2.2-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-instance-of@v0.2.2-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";function f(e,n,f){var j,v;if(arguments.length<3)j={},v=n;else{if(s(n))j={encoding:n};else{if(!r(n))throw new TypeError(l("0OH3t",n));j=n}v=f}if(!t(v))throw new TypeError(l("0OH2b",v));i(e,j,(function(e,s){if(e)return v(e);s=s.toString(),"utf8"===j.encoding&&(s=o(s));s=j.reviver?d(s,j.reviver):d(s);if(m(s,Error))return v(s);v(null,s)}))}function j(e,t){var i,f;if(arguments.length>1)if(s(t))i={encoding:t};else{if(!r(t))throw new TypeError(l("0OH3t",t));i=t}else i={};return f=n(e,i),m(f,Error)?f:(f=f.toString(),"utf8"===i.encoding&&(f=o(f)),i.reviver?d(f,i.reviver):d(f))}e(f,"sync",j);export{f as default,j as sync}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..74a7c8c --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/async.js","../lib/sync.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { isPrimitive as isString } from '@stdlib/assert-is-string';\nimport isObject from '@stdlib/assert-is-plain-object';\nimport isFunction from '@stdlib/assert-is-function';\nimport readFile from '@stdlib/fs-read-file';\nimport removeBOM from '@stdlib/string-remove-utf8-bom';\nimport parseJSON from '@stdlib/utils-parse-json';\nimport instanceOf from '@stdlib/assert-instance-of';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Asynchronously reads a file as JSON.\n*\n* @param {(string|Buffer|integer)} file - file path or file descriptor\n* @param {(Options|string)} [options] - options\n* @param {(string|null)} [options.encoding] - file encoding\n* @param {string} [options.flag] - file status flag\n* @param {Function} [options.reviver] - JSON reviver\n* @param {Callback} clbk - callback\n* @throws {TypeError} options argument must be either a string or an object\n* @throws {TypeError} callback argument must be a function\n*\n* @example\n* var resolve = require( 'path' ).resolve;\n*\n* readJSON( resolve( __dirname, '..', 'package.json' ), onJSON );\n*\n* function onJSON( error, data ) {\n* if ( error ) {\n* throw error;\n* }\n* console.dir( data );\n* }\n*/\nfunction readJSON( file, options, clbk ) {\n\tvar opts;\n\tvar done;\n\tif ( arguments.length < 3 ) {\n\t\topts = {};\n\t\tdone = options;\n\t} else {\n\t\tif ( isString( options ) ) {\n\t\t\topts = {\n\t\t\t\t'encoding': options\n\t\t\t};\n\t\t} else {\n\t\t\tif ( !isObject( options ) ) {\n\t\t\t\tthrow new TypeError( format( '0OH3t', options ) );\n\t\t\t}\n\t\t\topts = options;\n\t\t}\n\t\tdone = clbk;\n\t}\n\tif ( !isFunction( done ) ) {\n\t\tthrow new TypeError( format( '0OH2b', done ) );\n\t}\n\treadFile( file, opts, onRead );\n\n\t/**\n\t* Callback invoked upon reading a file.\n\t*\n\t* @private\n\t* @param {(Error|null)} error - error object\n\t* @param {(Buffer|string)} file - file contents\n\t* @returns {void}\n\t*/\n\tfunction onRead( error, file ) {\n\t\tif ( error ) {\n\t\t\treturn done( error );\n\t\t}\n\t\tfile = file.toString();\n\t\tif ( opts.encoding === 'utf8' ) {\n\t\t\tfile = removeBOM( file );\n\t\t}\n\t\tif ( opts.reviver ) {\n\t\t\tfile = parseJSON( file, opts.reviver );\n\t\t} else {\n\t\t\tfile = parseJSON( file );\n\t\t}\n\t\tif ( instanceOf( file, Error ) ) {\n\t\t\treturn done( file );\n\t\t}\n\t\tdone( null, file );\n\t}\n}\n\n\n// EXPORTS //\n\nexport default readJSON;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { isPrimitive as isString } from '@stdlib/assert-is-string';\nimport isObject from '@stdlib/assert-is-plain-object';\nimport { sync as readFile } from '@stdlib/fs-read-file';\nimport removeBOM from '@stdlib/string-remove-utf8-bom';\nimport parseJSON from '@stdlib/utils-parse-json';\nimport instanceOf from '@stdlib/assert-instance-of';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Synchronously reads a file as JSON.\n*\n* @param {(string|Buffer|integer)} file - file path or file descriptor\n* @param {(Options|string)} [options] - options\n* @param {(string|null)} [options.encoding] - file encoding\n* @param {string} [options.flag] - file status flag\n* @param {Function} [options.reviver] - JSON reviver\n* @throws {TypeError} options argument must be either a string or an object\n* @returns {(JSON|Error)} JSON or an error\n*\n* @example\n* var resolve = require( 'path' ).resolve;\n* import instanceOf from '@stdlib/assert-instance-of';\n*\n* var out = readJSONSync( resolve( __dirname, '..', 'package.json' ) );\n* if ( instanceOf( out, Error ) ) {\n* throw out;\n* }\n* console.dir( out );\n*/\nfunction readJSONSync( file, options ) {\n\tvar opts;\n\tvar f;\n\tif ( arguments.length > 1 ) {\n\t\tif ( isString( options ) ) {\n\t\t\topts = {\n\t\t\t\t'encoding': options\n\t\t\t};\n\t\t} else {\n\t\t\tif ( !isObject( options ) ) {\n\t\t\t\tthrow new TypeError( format( '0OH3t', options ) );\n\t\t\t}\n\t\t\topts = options;\n\t\t}\n\t} else {\n\t\topts = {};\n\t}\n\tf = readFile( file, opts );\n\tif ( instanceOf( f, Error ) ) {\n\t\treturn f;\n\t}\n\tf = f.toString();\n\tif ( opts.encoding === 'utf8' ) {\n\t\tf = removeBOM( f );\n\t}\n\tif ( opts.reviver ) {\n\t\treturn parseJSON( f, opts.reviver );\n\t}\n\treturn parseJSON( f );\n}\n\n\n// EXPORTS //\n\nexport default readJSONSync;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Read a file as JSON.\n*\n* @module @stdlib/fs-read-json\n*\n* @example\n* var resolve = require( 'path' ).resolve;\n* import readJSON from '@stdlib/fs-read-json';\n*\n* function onJSON( error, data ) {\n* if ( error ) {\n* throw error;\n* }\n* console.dir( data );\n* }\n*\n* readJSON( resolve( __dirname, '..', 'package.json' ), onJSON );\n*\n* @example\n* var resolve = require( 'path' ).resolve;\n* import instanceOf from '@stdlib/assert-instance-of';\n* import readJSON from '@stdlib/fs-read-json';\n*\n* var out = readJSON.sync( resolve( __dirname, '..', 'package.json' ) );\n* if ( instanceOf( out, Error ) ) {\n* throw out;\n* }\n* console.dir( out );\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport readJSON from './async.js';\nimport sync from './sync.js';\n\n\n// MAIN //\n\nsetReadOnly( readJSON, 'sync', sync );\n\n\n// EXPORTS //\n\nexport default readJSON;\n"],"names":["readJSON","file","options","clbk","opts","done","arguments","length","isString","encoding","isObject","TypeError","format","isFunction","readFile","error","toString","removeBOM","reviver","parseJSON","instanceOf","Error","readJSONSync","f","setReadOnly","sync"],"mappings":";;43BA0DA,SAASA,EAAUC,EAAMC,EAASC,GACjC,IAAIC,EACAC,EACJ,GAAKC,UAAUC,OAAS,EACvBH,EAAO,CAAA,EACPC,EAAOH,MACD,CACN,GAAKM,EAAUN,GACdE,EAAO,CACNK,SAAYP,OAEP,CACN,IAAMQ,EAAUR,GACf,MAAM,IAAIS,UAAWC,EAAQ,QAASV,IAEvCE,EAAOF,CACP,CACDG,EAAOF,CACP,CACD,IAAMU,EAAYR,GACjB,MAAM,IAAIM,UAAWC,EAAQ,QAASP,IAEvCS,EAAUb,EAAMG,GAUhB,SAAiBW,EAAOd,GACvB,GAAKc,EACJ,OAAOV,EAAMU,GAEdd,EAAOA,EAAKe,WACW,SAAlBZ,EAAKK,WACTR,EAAOgB,EAAWhB,IAGlBA,EADIG,EAAKc,QACFC,EAAWlB,EAAMG,EAAKc,SAEtBC,EAAWlB,GAEnB,GAAKmB,EAAYnB,EAAMoB,OACtB,OAAOhB,EAAMJ,GAEdI,EAAM,KAAMJ,EACZ,GACF,CCtDA,SAASqB,EAAcrB,EAAMC,GAC5B,IAAIE,EACAmB,EACJ,GAAKjB,UAAUC,OAAS,EACvB,GAAKC,EAAUN,GACdE,EAAO,CACNK,SAAYP,OAEP,CACN,IAAMQ,EAAUR,GACf,MAAM,IAAIS,UAAWC,EAAQ,QAASV,IAEvCE,EAAOF,CACP,MAEDE,EAAO,CAAA,EAGR,OADAmB,EAAIT,EAAUb,EAAMG,GACfgB,EAAYG,EAAGF,OACZE,GAERA,EAAIA,EAAEP,WACiB,SAAlBZ,EAAKK,WACTc,EAAIN,EAAWM,IAEXnB,EAAKc,QACFC,EAAWI,EAAGnB,EAAKc,SAEpBC,EAAWI,GACnB,CCxBAC,EAAAxB,EAAA,OAAAyB"} \ No newline at end of file diff --git a/lib/async.js b/lib/async.js deleted file mode 100644 index 47a2f3f..0000000 --- a/lib/async.js +++ /dev/null @@ -1,114 +0,0 @@ -/** -* @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 isString = require( '@stdlib/assert-is-string' ).isPrimitive; -var isObject = require( '@stdlib/assert-is-plain-object' ); -var isFunction = require( '@stdlib/assert-is-function' ); -var readFile = require( '@stdlib/fs-read-file' ); -var removeBOM = require( '@stdlib/string-remove-utf8-bom' ); -var parseJSON = require( '@stdlib/utils-parse-json' ); -var instanceOf = require( '@stdlib/assert-instance-of' ); -var format = require( '@stdlib/string-format' ); - - -// MAIN // - -/** -* Asynchronously reads a file as JSON. -* -* @param {(string|Buffer|integer)} file - file path or file descriptor -* @param {(Options|string)} [options] - options -* @param {(string|null)} [options.encoding] - file encoding -* @param {string} [options.flag] - file status flag -* @param {Function} [options.reviver] - JSON reviver -* @param {Callback} clbk - callback -* @throws {TypeError} options argument must be either a string or an object -* @throws {TypeError} callback argument must be a function -* -* @example -* var resolve = require( 'path' ).resolve; -* -* readJSON( resolve( __dirname, '..', 'package.json' ), onJSON ); -* -* function onJSON( error, data ) { -* if ( error ) { -* throw error; -* } -* console.dir( data ); -* } -*/ -function readJSON( file, options, clbk ) { - var opts; - var done; - if ( arguments.length < 3 ) { - opts = {}; - done = options; - } else { - if ( isString( options ) ) { - opts = { - 'encoding': options - }; - } else { - if ( !isObject( options ) ) { - throw new TypeError( format( 'invalid argument. Options argument must be either a string or an object. Value: `%s`.', options ) ); - } - opts = options; - } - done = clbk; - } - if ( !isFunction( done ) ) { - throw new TypeError( format( 'invalid argument. Callback argument must be a function. Value: `%s`.', done ) ); - } - readFile( file, opts, onRead ); - - /** - * Callback invoked upon reading a file. - * - * @private - * @param {(Error|null)} error - error object - * @param {(Buffer|string)} file - file contents - * @returns {void} - */ - function onRead( error, file ) { - if ( error ) { - return done( error ); - } - file = file.toString(); - if ( opts.encoding === 'utf8' ) { - file = removeBOM( file ); - } - if ( opts.reviver ) { - file = parseJSON( file, opts.reviver ); - } else { - file = parseJSON( file ); - } - if ( instanceOf( file, Error ) ) { - return done( file ); - } - done( null, file ); - } -} - - -// EXPORTS // - -module.exports = readJSON; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4cb5e37..0000000 --- a/lib/index.js +++ /dev/null @@ -1,65 +0,0 @@ -/** -* @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'; - -/** -* Read a file as JSON. -* -* @module @stdlib/fs-read-json -* -* @example -* var resolve = require( 'path' ).resolve; -* var readJSON = require( '@stdlib/fs-read-json' ); -* -* function onJSON( error, data ) { -* if ( error ) { -* throw error; -* } -* console.dir( data ); -* } -* -* readJSON( resolve( __dirname, '..', 'package.json' ), onJSON ); -* -* @example -* var resolve = require( 'path' ).resolve; -* var instanceOf = require( '@stdlib/assert-instance-of' ); -* var readJSON = require( '@stdlib/fs-read-json' ); -* -* var out = readJSON.sync( resolve( __dirname, '..', 'package.json' ) ); -* if ( instanceOf( out, Error ) ) { -* throw out; -* } -* console.dir( out ); -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var readJSON = require( './async.js' ); -var sync = require( './sync.js' ); - - -// MAIN // - -setReadOnly( readJSON, 'sync', sync ); - - -// EXPORTS // - -module.exports = readJSON; diff --git a/lib/sync.js b/lib/sync.js deleted file mode 100644 index c161216..0000000 --- a/lib/sync.js +++ /dev/null @@ -1,89 +0,0 @@ -/** -* @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 isString = require( '@stdlib/assert-is-string' ).isPrimitive; -var isObject = require( '@stdlib/assert-is-plain-object' ); -var readFile = require( '@stdlib/fs-read-file' ).sync; -var removeBOM = require( '@stdlib/string-remove-utf8-bom' ); -var parseJSON = require( '@stdlib/utils-parse-json' ); -var instanceOf = require( '@stdlib/assert-instance-of' ); -var format = require( '@stdlib/string-format' ); - - -// MAIN // - -/** -* Synchronously reads a file as JSON. -* -* @param {(string|Buffer|integer)} file - file path or file descriptor -* @param {(Options|string)} [options] - options -* @param {(string|null)} [options.encoding] - file encoding -* @param {string} [options.flag] - file status flag -* @param {Function} [options.reviver] - JSON reviver -* @throws {TypeError} options argument must be either a string or an object -* @returns {(JSON|Error)} JSON or an error -* -* @example -* var resolve = require( 'path' ).resolve; -* var instanceOf = require( '@stdlib/assert-instance-of' ); -* -* var out = readJSONSync( resolve( __dirname, '..', 'package.json' ) ); -* if ( instanceOf( out, Error ) ) { -* throw out; -* } -* console.dir( out ); -*/ -function readJSONSync( file, options ) { - var opts; - var f; - if ( arguments.length > 1 ) { - if ( isString( options ) ) { - opts = { - 'encoding': options - }; - } else { - if ( !isObject( options ) ) { - throw new TypeError( format( 'invalid argument. Options argument must be either a string or an object. Value: `%s`.', options ) ); - } - opts = options; - } - } else { - opts = {}; - } - f = readFile( file, opts ); - if ( instanceOf( f, Error ) ) { - return f; - } - f = f.toString(); - if ( opts.encoding === 'utf8' ) { - f = removeBOM( f ); - } - if ( opts.reviver ) { - return parseJSON( f, opts.reviver ); - } - return parseJSON( f ); -} - - -// EXPORTS // - -module.exports = readJSONSync; diff --git a/package.json b/package.json index a166813..55d71c8 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Read a file as JSON.", "license": "Apache-2.0", - "author": { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - }, - "contributors": [ - { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - } - ], - "main": "./lib", - "directories": { - "benchmark": "./benchmark", - "doc": "./docs", - "example": "./examples", - "lib": "./lib", - "test": "./test" - }, - "types": "./docs/types", - "scripts": { - "test": "make test", - "test-cov": "make test-cov", - "examples": "make examples", - "benchmark": "make benchmark" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,41 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-instance-of": "^0.2.2", - "@stdlib/assert-is-function": "^0.2.2", - "@stdlib/assert-is-plain-object": "^0.2.2", - "@stdlib/assert-is-string": "^0.2.2", - "@stdlib/fs-read-file": "^0.2.2", - "@stdlib/string-format": "^0.2.2", - "@stdlib/string-remove-utf8-bom": "^0.2.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", - "@stdlib/utils-parse-json": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/assert-is-browser": "^0.2.2", - "@stdlib/utils-noop": "^0.2.2", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdfs", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..073f459 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Codestin Search App + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/fixtures/bad.json.txt b/test/fixtures/bad.json.txt deleted file mode 100644 index 853ee4e..0000000 --- a/test/fixtures/bad.json.txt +++ /dev/null @@ -1,3 +0,0 @@ -{ - 'bee: b'beep; -} diff --git a/test/fixtures/bom.json.txt b/test/fixtures/bom.json.txt deleted file mode 100644 index 6bfd528..0000000 --- a/test/fixtures/bom.json.txt +++ /dev/null @@ -1,6 +0,0 @@ -{ - "beep": "boop", - "bop": [1,2,3], - "bool": true, - "bap": null -} diff --git a/test/fixtures/good.json b/test/fixtures/good.json deleted file mode 100644 index ff00a49..0000000 --- a/test/fixtures/good.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "beep": "boop", - "bop": [1,2,3], - "bool": true, - "bap": null -} diff --git a/test/test.async.js b/test/test.async.js deleted file mode 100644 index a05d234..0000000 --- a/test/test.async.js +++ /dev/null @@ -1,331 +0,0 @@ -/** -* @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 join = require( 'path' ).join; -var tape = require( 'tape' ); -var IS_BROWSER = require( '@stdlib/assert-is-browser' ); -var noop = require( '@stdlib/utils-noop' ); -var readJSON = require( './../lib/async.js' ); - - -// VARIABLES // - -// Don't run tests in the browser...for now... -var opts = { - 'skip': IS_BROWSER // FIXME -}; - - -// FIXTURES // - -var goodJSON = join( __dirname, 'fixtures', 'good.json' ); -var badJSON = join( __dirname, 'fixtures', 'bad.json.txt' ); -var bomJSON = join( __dirname, 'fixtures', 'bom.json.txt' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof readJSON, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if provided an options argument which is neither a string nor object', function test( t ) { - var values; - var i; - - values = [ - 5, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - readJSON( goodJSON, value, noop ); - }; - } -}); - -tape( 'the function throws an error if provided a callback argument which is not a function', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - readJSON( goodJSON, value ); - }; - } -}); - -tape( 'the function throws an error if provided a callback argument which is not a function (encoding)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - readJSON( goodJSON, 'utf8', value ); - }; - } -}); - -tape( 'the function throws an error if provided a callback argument which is not a function (options object)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - readJSON( goodJSON, {}, value ); - }; - } -}); - -tape( 'if the function encounters an error when attempting to read a file, the function returns the error', opts, function test( t ) { - readJSON( 'beepboopbapbop', onRead ); - - function onRead( error ) { - if ( error ) { - t.ok( true, error.message ); - } else { - t.ok( false, 'expected an error' ); - } - t.end(); - } -}); - -tape( 'if the function encounters an error when attempting to read a file, the function returns the error (encoding)', opts, function test( t ) { - readJSON( 'beepboopbapbop', 'utf8', onRead ); - - function onRead( error ) { - if ( error ) { - t.ok( true, error.message ); - } else { - t.ok( false, 'expected an error' ); - } - t.end(); - } -}); - -tape( 'if the function encounters an error when attempting to read a file, the function returns the error (options object)', opts, function test( t ) { - readJSON( 'beepboopbapbop', { - 'encoding': 'utf8' - }, onRead ); - - function onRead( error ) { - if ( error ) { - t.ok( true, error.message ); - } else { - t.ok( false, 'expected an error' ); - } - t.end(); - } -}); - -tape( 'if the function encounters an error when attempting to parse file contents as JSON, the function returns the error', opts, function test( t ) { - readJSON( badJSON, onRead ); - - function onRead( error ) { - if ( error ) { - t.ok( true, error.message ); - } else { - t.ok( false, 'expected an error' ); - } - t.end(); - } -}); - -tape( 'if the function encounters an error when attempting to parse file contents as JSON, the function returns the error (encoding)', opts, function test( t ) { - readJSON( badJSON, 'utf8', onRead ); - - function onRead( error ) { - if ( error ) { - t.ok( true, error.message ); - } else { - t.ok( false, 'expected an error' ); - } - t.end(); - } -}); - -tape( 'if the function encounters an error when attempting to parse file contents as JSON, the function returns the error (options object)', opts, function test( t ) { - readJSON( badJSON, { - 'encoding': 'utf8' - }, onRead ); - - function onRead( error ) { - if ( error ) { - t.ok( true, error.message ); - } else { - t.ok( false, 'expected an error' ); - } - t.end(); - } -}); - -tape( 'the function reads a file as JSON', opts, function test( t ) { - var expected = require( goodJSON ); // eslint-disable-line stdlib/no-dynamic-require - - readJSON( goodJSON, onRead ); - - function onRead( error, actual ) { - if ( error ) { - t.ok( false, error.message ); - } - t.deepEqual( actual, expected, 'returns a file as JSON' ); - t.end(); - } -}); - -tape( 'the function reads a file as JSON using provided options (encoding)', opts, function test( t ) { - var expected = require( goodJSON ); // eslint-disable-line stdlib/no-dynamic-require - - readJSON( goodJSON, 'utf8', onRead ); - - function onRead( error, actual ) { - if ( error ) { - t.ok( false, error.message ); - } - t.deepEqual( actual, expected, 'returns a file as JSON' ); - t.end(); - } -}); - -tape( 'the function reads a file as JSON using provided options (options object)', opts, function test( t ) { - var expected = require( goodJSON ); // eslint-disable-line stdlib/no-dynamic-require - - readJSON( goodJSON, { - 'encoding': 'utf8' - }, onRead ); - - function onRead( error, actual ) { - if ( error ) { - t.ok( false, error.message ); - } - t.deepEqual( actual, expected, 'returns a file as JSON' ); - t.end(); - } -}); - -tape( 'the function supports reading a UTF-8 encoded file having a byte order mark (BOM) as JSON', opts, function test( t ) { - var expected = require( goodJSON ); // eslint-disable-line stdlib/no-dynamic-require - - readJSON( bomJSON, { - 'encoding': 'utf8' - }, onRead ); - - function onRead( error, actual ) { - if ( error ) { - t.ok( false, error.message ); - } - t.deepEqual( actual, expected, 'returns a file as JSON' ); - t.end(); - } -}); - -tape( 'the function supports providing a JSON reviver', opts, function test( t ) { - var expected = { - 'beep': 'boop', - 'bop': [ 1, 2, 3 ], - 'bool': true, - 'bap': 'woot' - }; - readJSON( goodJSON, { - 'reviver': reviver - }, onRead ); - - function onRead( error, actual ) { - if ( error ) { - t.ok( false, error.message ); - } - t.deepEqual( actual, expected, 'returns a file as JSON' ); - t.end(); - } - - function reviver( key, value ) { - if ( key === 'bap' ) { - return 'woot'; - } - return value; - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 1b48232..0000000 --- a/test/test.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @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 tape = require( 'tape' ); -var readJSON = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof readJSON, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a function to synchronously read a file as JSON', function test( t ) { - t.strictEqual( typeof readJSON.sync, 'function', 'has `sync` method' ); - t.end(); -}); diff --git a/test/test.sync.js b/test/test.sync.js deleted file mode 100644 index 14f6e75..0000000 --- a/test/test.sync.js +++ /dev/null @@ -1,189 +0,0 @@ -/** -* @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 join = require( 'path' ).join; -var tape = require( 'tape' ); -var IS_BROWSER = require( '@stdlib/assert-is-browser' ); -var instanceOf = require( '@stdlib/assert-instance-of' ); -var readJSON = require( './../lib/sync.js' ); - - -// VARIABLES // - -// Don't run tests in the browser...for now... -var opts = { - 'skip': IS_BROWSER // FIXME -}; - - -// FIXTURES // - -var goodJSON = join( __dirname, 'fixtures', 'good.json' ); -var badJSON = join( __dirname, 'fixtures', 'bad.json.txt' ); -var bomJSON = join( __dirname, 'fixtures', 'bom.json.txt' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof readJSON, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if provided an options argument which is neither a string nor object', function test( t ) { - var values; - var i; - - values = [ - 5, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - readJSON( goodJSON, value ); - }; - } -}); - -tape( 'if the function encounters an error when attempting to read a file, the function returns the error', opts, function test( t ) { - var out = readJSON( 'beepboopbapbop' ); - t.strictEqual( instanceOf( out, Error ), true, 'returns an error' ); - t.end(); -}); - -tape( 'if the function encounters an error when attempting to read a file, the function returns the error (options)', opts, function test( t ) { - var out; - - out = readJSON( 'beepboopbapbop', 'utf8' ); - t.strictEqual( instanceOf( out, Error ), true, 'returns an error' ); - - out = readJSON( 'beepboopbapbop', { - 'encoding': 'utf8' - }); - t.strictEqual( instanceOf( out, Error ), true, 'returns an error' ); - - t.end(); -}); - -tape( 'if the function encounters an error when attempting to parse file contents as JSON, the function returns the error', opts, function test( t ) { - var out = readJSON( badJSON ); - t.strictEqual( instanceOf( out, Error ), true, 'returns an error' ); - t.end(); -}); - -tape( 'if the function encounters an error when attempting to parse file contents as JSON, the function returns the error (options)', opts, function test( t ) { - var out; - - out = readJSON( badJSON, 'utf8' ); - t.strictEqual( instanceOf( out, Error ), true, 'returns an error' ); - - out = readJSON( badJSON, { - 'encoding': 'utf8' - }); - t.strictEqual( instanceOf( out, Error ), true, 'returns an error' ); - - t.end(); -}); - -tape( 'the function reads a file as JSON', opts, function test( t ) { - var expected; - var actual; - - expected = require( goodJSON ); // eslint-disable-line stdlib/no-dynamic-require - actual = readJSON( goodJSON ); - - t.deepEqual( actual, expected, 'returns a file as JSON' ); - - t.end(); -}); - -tape( 'the function reads a file as JSON using provided options', opts, function test( t ) { - var expected; - var actual; - - // String options: - expected = require( goodJSON ); // eslint-disable-line stdlib/no-dynamic-require - actual = readJSON( goodJSON, 'utf8' ); - - t.deepEqual( expected, actual, 'returns a file as JSON' ); - - // Object options: - actual = readJSON( goodJSON, { - 'encoding': 'utf8' - }); - - t.deepEqual( actual, expected, 'returns a file as JSON' ); - - t.end(); -}); - -tape( 'the function supports reading a UTF-8 encoded file having a byte order mark (BOM) as JSON', opts, function test( t ) { - var expected; - var actual; - - expected = require( goodJSON ); // eslint-disable-line stdlib/no-dynamic-require - actual = readJSON( bomJSON, { - 'encoding': 'utf8' - }); - - t.deepEqual( actual, expected, 'returns a file as JSON' ); - - t.end(); -}); - -tape( 'the function supports providing a JSON reviver', opts, function test( t ) { - var expected; - var actual; - - expected = { - 'beep': 'boop', - 'bop': [ 1, 2, 3 ], - 'bool': true, - 'bap': 'woot' - }; - actual = readJSON( goodJSON, { - 'reviver': reviver - }); - - t.deepEqual( actual, expected, 'deep equal' ); - t.end(); - - function reviver( key, value ) { - if ( key === 'bap' ) { - return 'woot'; - } - return value; - } -});