Skip to content

Conversation

@Om-A-osc
Copy link
Contributor


type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:

  • task: lint_filenames
    status: passed
  • task: lint_editorconfig
    status: passed
  • task: lint_markdown
    status: na
  • task: lint_package_json
    status: na
  • task: lint_repl_help
    status: na
  • task: lint_javascript_src
    status: na
  • task: lint_javascript_cli
    status: na
  • task: lint_javascript_examples
    status: na
  • task: lint_javascript_tests
    status: na
  • task: lint_javascript_benchmarks
    status: na
  • task: lint_python
    status: na
  • task: lint_r
    status: na
  • task: lint_c_src
    status: na
  • task: lint_c_examples
    status: na
  • task: lint_c_benchmarks
    status: na
  • task: lint_c_tests_fixtures
    status: na
  • task: lint_shell
    status: na
  • task: lint_typescript_declarations
    status: passed
  • task: lint_typescript_tests
    status: na
  • task: lint_license_headers
    status: passed

Add missing "private" key to keys.json

Description

What is the purpose of this pull request?

This pull request:

  • Adds the private key to the keys.json reference file, as it is currently the only top-level package.json key missing from the reference despite being used across the codebase.

Related Issues

Does this pull request have any related issues?

None.

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

Background

I scanned all package.json files in the repository to identify which top-level keys are currently in use and compared them against the reference keys.json file. The scan revealed that private is the only key currently in use that is missing from the reference.

After discussion with @kgryte on Zulip, it was confirmed that the private key is intentional and should be included in the reference. It must be there so that CI lint checks for certain
package.json files do not fail.

#dev-questions > Regarding `package.json` linting.

Verification

The following shell script can be used to verify this finding by running it from the root of the project:

#!/usr/bin/env sh
set -e

if ! command -v jq >/dev/null 2>&1; then
    echo "Error: jq is required but not installed."
    exit 1
fi

# KEYS.JSON REFERENCE
REFERENCE_KEYS=$(cat <<'EOF'
name
version
description
license
licenses
author
maintainers
contributors
funding
bin
main
exports
browser
unpkg
gypfile
directories
types
scripts
homepage
repository
repositories
bugs
dependencies
optionalDependencies
devDependencies
engines
os
keywords
__stdlib__
EOF
)

FOUND_FILE=$(mktemp)
REF_FILE=$(mktemp)
trap 'rm -f "$FOUND_FILE" "$REF_FILE"' EXIT

find . -type f -name "package.json" \
    | while read -r file; do
        if jq -e 'type == "object"' "$file" >/dev/null 2>&1; then
            jq -r 'keys[]' "$file"
        fi
    done \
    | sort -u > "$FOUND_FILE"

printf "%s\n" "$REFERENCE_KEYS" | sort > "$REF_FILE"

echo "EXTRA (found but not in reference)"
comm -23 "$FOUND_FILE" "$REF_FILE"

echo
echo "MISSING (in reference but not found)"
comm -13 "$FOUND_FILE" "$REF_FILE"
hfhfh

Checklist

Please ensure the following tasks are completed before submitting this pull request.

AI Assistance

When authoring the changes proposed in this PR, did you use any kind of AI assistance?

  • Yes
  • No

@stdlib-js/reviewers

---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
@stdlib-bot stdlib-bot added Tools Issue or pull request related to project tooling. Needs Review A pull request which needs code review. labels Jan 25, 2026
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
@Om-A-osc
Copy link
Contributor Author

@kgryte Please take a look at this PR and the referenced PR to better understand the issue, and let me know how you think we should proceed. #9886

Copy link
Member

@kgryte kgryte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@kgryte kgryte removed the Needs Review A pull request which needs code review. label Jan 25, 2026
@kgryte kgryte merged commit 7026b3e into stdlib-js:develop Jan 25, 2026
10 checks passed
@kgryte kgryte changed the title chore: added missing key causing lint failure in _tools/package-json/standardize/lib/keys.json chore: add support for private key in _tools/package-json/standardize Jan 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Tools Issue or pull request related to project tooling.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants