Fix: Address feedback

webhintio · Feb 5, 2018 · 7ea02a1 · 7ea02a1
1 parent 6e59753
commit 7ea02a1
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/src/lib/types.ts b/src/lib/types.ts
@@ -75,11 +75,17 @@ export interface IORA {
     text: string;
 }
 
+/**
+ * Represent an user in a npm package.
+ */
 export type NpmMaintainer = {
     email: string;
     username: string;
 };
 
+/**
+ * Represent the result of a npm search.
+ */
 export type NpmPackage = {
     date: Date;
     description: string;

diff --git a/src/lib/utils/resource-loader.ts b/src/lib/utils/resource-loader.ts
@@ -325,11 +325,19 @@ const filterPackages = (packages: Array<NpmPackage>, initTerm: string) => {
 export const getExternalRulesFromNpm = async () => {
     const rules = await getNpmPackages('sonarwhal-rule');
 
+    /*
+     * We need to filter the results because the search can
+     * include other packages that doesn't start with `sonarwhal-rule`.
+     */
     return filterPackages(rules, 'sonarwhal-rule');
 };
 
 export const getCoreRulesFromNpm = async () => {
     const rules = await getNpmPackages('@sonarwhal/rule');
 
+    /*
+     * We need to filter the results because the search can
+     * include other packages that doesn't start with `@sonarwhal/rule`.
+     */
     return filterPackages(rules, '@sonarwhal/rule');
 };