Skip to content

docs: add descriptive module docstring for npm package handler #4601

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

docs: add descriptive module docstring for npm package handler #4601

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions src/packagedcode/npm.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
# See http://www.apache.org/licenses/LICENSE-2.0 for the license text.
# See https://github.com/nexB/scancode-toolkit for support or download.
# See https://aboutcode.org for more information about nexB OSS projects.
#


import base64
import io
import fnmatch
Expand All @@ -30,13 +31,13 @@
import saneyaml

"""
Handle Node.js npm packages
per https://docs.npmjs.com/files/package.json
"""
This module helps ScanCode understand and work with Node.js (npm) packages.

It reads information from package.json files, such as the package name,
version, dependencies, and other metadata. This helps ScanCode detect
licenses, dependencies, and package details when scanning JavaScript projects.
"""
To check https://github.com/npm/normalize-package-data
"""



SCANCODE_DEBUG_PACKAGE = os.environ.get('SCANCODE_DEBUG_PACKAGE', False)
Expand Down