chore: merge pull request #14 from threeal/main

Version 0.2.0 Release

.github/dependabot.yaml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: daily
+    commit-message:
+      prefix: chore

README.md

@@ -21,30 +21,30 @@ $ npm install --global google-rank
 To retrieve the rank of a website for a specific keyword, run the `google-rank` tool followed by the website URL and the search keyword:
 
 ```
-$ google-rank wikipedia.org krakatoa
+$ google-rank wikipedia.org --keywords krakatoa
 
 Ranks for wikipedia.org website:
-1 krakatoa
+page 1  rank 1  krakatoa
 ```
 
 Multiple keywords can also be specified:
 
 ```
-$ google-rank wikipedia.org krakatoa mit 'social media'
+$ google-rank wikipedia.org --keywords krakatoa facebook 'social media'
 
 Ranks for wikipedia.org website:
-1 krakatoa
-2 mit
-1 social media
+page 1  rank 1  krakatoa
+page 2  rank 2  facebook
+page 1  rank 1  social media
 ```
 
 If the website is not found for the specified keywords, it will output the rank as `?`:
 
 ```
-$ google-rank wikipedia.org 'best city to travel'
+$ google-rank wikipedia.org --keywords 'best city to travel'
 
 Ranks for wikipedia.org website:
-? best city to travel
+page ?  rank ?  best city to travel
 ```
 
 ## License

lib/utils/arguments.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Represents the arguments and options of the program.
+ */
+export interface Arguments {
+    /** Website name. */
+    website: string;
+    /** Keywords to search for. */
+    keywords: string[];
+    /** Maximum page to search for. */
+    maxPage: number;
+}
+/**
+ * Represents the arguments and options parser of the program.
+ */
+export declare class ArgumentsParser {
+    #private;
+    /**
+     * Constructs a new instance of the arguments and options parser of the program.
+     */
+    constructor();
+    /**
+     * Parses the arguments and options of the program.
+     * @param argv - An optional array of strings representing the command-line arguments.
+     * @returns A promise that resolves to the arguments and options.
+     */
+    parse(argv?: readonly string[]): Promise<Arguments>;
+}

lib/utils/format.d.ts

@@ -0,0 +1,8 @@
+import { GoogleWebsiteRank } from "./google";
+/**
+ * Formats the rank of a keyword as a string.
+ * @param keyword - The keyword string.
+ * @param rank - The rank of the keyword.
+ * @returns A formatted string. The rank will be displayed as a question mark if it is undefined.
+ */
+export declare function formatKeywordRank(keyword: string, rank?: GoogleWebsiteRank): string;