Skip to content

JS: More efficient nested package naming #19516

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

Merged
merged 2 commits into from
May 22, 2025
Merged

JS: More efficient nested package naming #19516

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1e8a49f
JS: More efficient nested package naming
asgerf May 19, 2025
317e61d
JS: Update UnresolvableImports to handle nested packages
asgerf May 19, 2025
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
29 changes: 16 additions & 13 deletions javascript/ql/lib/semmle/javascript/NPM.qll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,25 +22,27 @@ class PackageJson extends JsonObject {
pragma[nomagic]
string getDeclaredPackageName() { result = this.getPropStringValue("name") }

/**
* Gets the nearest `package.json` file found in the parent directories, if any.
*/
PackageJson getEnclosingPackage() {
result.getFolder() = packageInternalParent*(this.getFolder().getParentContainer())
}

/**
* Gets the name of this package.
* If the package is located under the package `pkg1` and its relative path is `foo/bar`, then the resulting package name will be `pkg1/foo/bar`.
*/
string getPackageName() {
result = this.getDeclaredPackageName()
or
exists(
PackageJson parentPkg, Container currentDir, Container parentDir, string parentPkgName,
string pkgNameDiff
|
currentDir = this.getJsonFile().getParentContainer() and
parentDir = parentPkg.getJsonFile().getParentContainer() and
parentPkgName = parentPkg.getPropStringValue("name") and
parentDir.getAChildContainer+() = currentDir and
pkgNameDiff = currentDir.getAbsolutePath().suffix(parentDir.getAbsolutePath().length()) and
not exists(pkgNameDiff.indexOf("/node_modules/")) and
result = parentPkgName + pkgNameDiff and
not parentPkg.isPrivate()
not exists(this.getDeclaredPackageName()) and
exists(PackageJson parent |
parent = this.getEnclosingPackage() and
not parent.isPrivate() and
result =
parent.getDeclaredPackageName() +
this.getFolder().getRelativePath().suffix(parent.getFolder().getRelativePath().length())
)
}

Expand Down Expand Up @@ -405,5 +407,6 @@ class NpmPackage extends @folder {
*/
private Folder packageInternalParent(Container c) {
result = c.getParentContainer() and
not c.(Folder).getBaseName() = "node_modules"
not c.(Folder).getBaseName() = "node_modules" and
not c = any(PackageJson pkg).getFolder()
}
2 changes: 1 addition & 1 deletion javascript/ql/src/NodeJS/UnresolvableImport.ql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ where
not exists(r.getImportedModule()) and
// no enclosing NPM package declares a dependency on `mod`
forex(NpmPackage pkg, PackageJson pkgJson |
pkg.getAModule() = r.getTopLevel() and pkgJson = pkg.getPackageJson()
pkg.getAModule() = r.getTopLevel() and pkgJson = pkg.getPackageJson().getEnclosingPackage*()
|
not pkgJson.declaresDependency(mod, _) and
not pkgJson.getPeerDependencies().getADependency(mod, _) and
Expand Down
1 change: 0 additions & 1 deletion javascript/ql/test/library-tests/NPM/tests.expected
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@ modules
| src/node_modules/nested | nested | src/node_modules/nested/tst3.js:1:1:2:13 | <toplevel> |
| src/node_modules/nested/node_modules/a | a | src/node_modules/nested/node_modules/a/index.js:1:1:1:25 | <toplevel> |
| src/node_modules/parent-module | parent-module | src/node_modules/parent-module/main.js:1:1:2:0 | <toplevel> |
| src/node_modules/parent-module | parent-module | src/node_modules/parent-module/sub-module/main.js:1:1:2:0 | <toplevel> |
| src/node_modules/parent-module/sub-module | parent-module/sub-module | src/node_modules/parent-module/sub-module/main.js:1:1:2:0 | <toplevel> |
| src/node_modules/third-party-module | third-party-module | src/node_modules/third-party-module/fancy.js:1:1:4:0 | <toplevel> |
npm
Expand Down