From 2289288ae0bcf3541c69cf837b8d75dd395fcb60 Mon Sep 17 00:00:00 2001 From: stdlib-bot <noreply@stdlib.io> Date: Thu, 9 Nov 2023 03:19:26 +0000 Subject: [PATCH] Auto-generated commit --- .github/workflows/publish.yml | 52 +----------------------- README.md | 4 +- inherited-property-descriptors/README.md | 6 ++- 3 files changed, 8 insertions(+), 54 deletions(-) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 0037bdbc..e4a7c7c6 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -1,7 +1,7 @@ #/ # @license Apache-2.0 # -# Copyright (c) 2021 The Stdlib Authors. +# 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. @@ -46,7 +46,7 @@ jobs: publish: # Define display name: - name: 'Publish package to npm' + name: 'Publish top-level package to npm' # Define the type of virtual host machine on which to run the job: runs-on: ubuntu-latest @@ -103,54 +103,6 @@ jobs: SLUG=${{ github.repository }} git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" --follow-tags - # Remove CLI: - - name: 'Remove CLI' - if: ${{ github.ref == 'refs/heads/main' }} - run: | - # Exit if the package does not have a CLI: - if ! grep -q '"bin":' package.json; then - exit 0 - fi - rm -rf ./bin/cli - rm -f test/test.cli.js - rm -f etc/cli_opts.json - rm -f docs/usage.txt - - # For all dependencies, check in all *.js files if they are still used; if not, remove them: - jq -r '.dependencies | keys[]' ./package.json | while read -r dep; do - dep=$(echo "$dep" | xargs) - if ! grep -q "$dep" lib/** && ! grep -q -s "$dep" manifest.json && ! grep -q -s "$dep" include.gypi; then - jq --indent 2 "del(.dependencies[\"$dep\"])" ./package.json > ./package.json.tmp - mv ./package.json.tmp ./package.json - fi - done - jq -r '.devDependencies | keys[]' ./package.json | while read -r dep; do - if [[ "$dep" != "@stdlib"* ]]; then - continue - fi - dep=$(echo "$dep" | xargs) - if ! grep -q "$dep" lib/** && ! grep -q -s "$dep" manifest.json && ! grep -q -s "$dep" include.gypi; then - jq --indent 2 "del(.devDependencies[\"$dep\"])" ./package.json > ./package.json.tmp - mv ./package.json.tmp ./package.json - fi - done - - # Remove CLI section: - find . -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?<section class=\"cli\">[\s\S]+?<\!\-\- \/.cli \-\->//" - - # Remove CLI from package.json: - jq -r 'del(.bin)' package.json > package.json.tmp - mv package.json.tmp package.json - - # Add entry for CLI package to See Also section of README.md: - cliPkgName=$(jq -r '.name' package.json)-cli - escapedPkg=$(echo "$cliPkgName" | sed -e 's/\//\\\//g') - escapedPkg=$(echo "$escapedPkg" | sed -e 's/\@/\\\@/g') - find . -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/<section class=\"related\">(?:\n\n\* \* \*\n\n## See Also\n\n)?/<section class=\"related\">\n\n## See Also\n\n- <span class=\"package-name\">[\`$escapedPkg\`][$escapedPkg]<\/span><span class=\"delimiter\">: <\/span><span class=\"description\">CLI package for use as a command-line utility.<\/span>\n/" - - # Add link definition for CLI package to README.md: - find . -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/<section class=\"links\">/<section class=\"links\">\n\n[$escapedPkg]: https:\/\/www.npmjs.com\/package\/$escapedPkg/" - # Replace GitHub MathJax equations with SVGs: - name: 'Replace GitHub MathJax equations with SVGs' run: | diff --git a/README.md b/README.md index 5d220147..216907bc 100644 --- a/README.md +++ b/README.md @@ -447,8 +447,8 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. [npm-image]: http://img.shields.io/npm/v/@stdlib/utils.svg [npm-url]: https://npmjs.org/package/@stdlib/utils -[test-image]: https://github.com/stdlib-js/utils/actions/workflows/test.yml/badge.svg?branch=v0.1.1 -[test-url]: https://github.com/stdlib-js/utils/actions/workflows/test.yml?query=branch:v0.1.1 +[test-image]: https://github.com/stdlib-js/utils/actions/workflows/test.yml/badge.svg?branch=main +[test-url]: https://github.com/stdlib-js/utils/actions/workflows/test.yml?query=branch:main [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/utils/main.svg [coverage-url]: https://codecov.io/github/stdlib-js/utils?branch=main diff --git a/inherited-property-descriptors/README.md b/inherited-property-descriptors/README.md index 827b5d65..2648ca79 100644 --- a/inherited-property-descriptors/README.md +++ b/inherited-property-descriptors/README.md @@ -36,6 +36,8 @@ var inheritedPropertyDescriptors = require( '@stdlib/utils/inherited-property-de Returns an object's inherited [property descriptors][@stdlib/utils/property-descriptors]. +<!-- eslint-disable id-length --> + ```javascript function Foo() { this.a = 'b'; @@ -51,6 +53,8 @@ var desc = inheritedPropertyDescriptors( f ); By default, the function walks an object's entire prototype chain. To limit the inheritance level, provide a `level` argument. +<!-- eslint-disable id-length --> + ```javascript var inherit = require( '@stdlib/utils/inherit' ); @@ -153,8 +157,6 @@ console.log( desc ); <!-- <related-links> --> -[@stdlib/utils/property-descriptors]: https://github.com/stdlib-js/utils/tree/main/property-descriptors - [@stdlib/utils/property-descriptors-in]: https://github.com/stdlib-js/utils/tree/main/property-descriptors-in [@stdlib/utils/inherited-keys]: https://github.com/stdlib-js/utils/tree/main/inherited-keys