Skip to content
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

Jump to bottom

Update npm to use the cli for package and version queries #2356

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Update npm to use the cli for package and version queries #2356

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
01e637e
Update npm to use the cli for package and version queries
bondz Jun 2, 2024
64d6013
fix double @ bug
bondz Jun 2, 2024
83e1c79
fuzzy search no longer required
bondz Jun 2, 2024
a52cc1e
fix for mgnl
bondz Jun 2, 2024
fac074f
Pass linter
bondz Jun 3, 2024
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
59 changes: 25 additions & 34 deletions src/npm.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,34 +26,8 @@ export const createNpmSearchHandler =
return [];
}
// Add optional keyword parameter
const keywordParameter =
keywords?.length > 0 ? `+keywords:${keywords.join(",")}` : "";
const keywordParameter = keywords?.length > 0 ? keywords.join(" ") : "";

const queryPackagesUrl = keywordParameter
? `https://api.npms.io/v2/search?size=20&q=${searchTerm}${keywordParameter}`
: `https://api.npms.io/v2/search/suggestions?q=${searchTerm}&size=20`;

// Query the API with the package name
const queryPackages = [
"-s",
"-H",
"Accept: application/json",
queryPackagesUrl,
];
// We need to remove the '@' at the end of the searchTerm before querying versions
const queryVersions = [
"-s",
"-H",
"Accept: application/vnd.npm.install-v1+json",
`https://registry.npmjs.org/${searchTerm.slice(0, -1)}`,
];
// If the end of our token is '@', then we want to generate version suggestions
// Otherwise, we want packages
const out = (query: string) =>
executeShellCommand({
command: "curl",
args: query[query.length - 1] === "@" ? queryVersions : queryPackages,
});
// If our token starts with '@', then a 2nd '@' tells us we want
// versions.
// Otherwise, '@' anywhere else in the string will indicate the same.
Expand All @@ -62,9 +36,15 @@ export const createNpmSearchHandler =
: searchTerm.includes("@");

try {
const data = JSON.parse((await out(searchTerm)).stdout);
if (shouldGetVersion) {
// create dist tags suggestions
const out = () =>
executeShellCommand({
command: "npm",
args: ["--json", "info", searchTerm.slice(0, -1)],
});

const data = JSON.parse((await out()).stdout);

const versions = Object.entries(data["dist-tags"] || {}).map(
([key, value]) => ({
name: key,
Expand All @@ -73,17 +53,24 @@ export const createNpmSearchHandler =
) as Fig.Suggestion[];
// create versions
versions.push(
...Object.keys(data.versions)
...data.versions
.map((version) => ({ name: version }) as Fig.Suggestion)
.reverse()
);
return versions;
}

const results = keywordParameter ? data.results : data;
const out = () =>
executeShellCommand({
command: "npm",
args: ["--json", "search", keywordParameter, searchTerm],
});

const results = JSON.parse((await out()).stdout);

return results.map((item) => ({
name: item.package.name,
description: item.package.description,
name: item.name,
description: item.description,
})) as Fig.Suggestion[];
} catch (error) {
console.error({ error });
Expand All @@ -106,7 +93,11 @@ export const npmSearchGenerator: Fig.Generator = {
// we see the first '@' so we can generate version suggestions
return !(oldToken.includes("@") && newToken.includes("@"));
},
getQueryTerm: "@",
getQueryTerm: (token) => {
// If we are looking for versions, there's no need filter the
// search anymore, otherwise use the query the user entered
return token.endsWith("@") ? "" : token;
},
cache: {
ttl: 1000 * 60 * 60 * 24 * 2, // 2 days
},
Expand Down
Loading