Merge pull request #125 from ruedap/improve-search-results

Improve search results

.github/workflows/test.yml

@@ -21,5 +21,5 @@ jobs:
       - name: Build
         run: npm run build
 
-      - name: Cmd
-        run: npm run cmd
+      - name: Test command
+        run: npm run test:cmd

assets/info.plist

@@ -3,9 +3,9 @@
 <plist version="1.0">
 <dict>
 	<key>name</key>
-	<string>Font Awesome 5.14.0.0</string>
+	<string>Font Awesome 5.14.0.1</string>
 	<key>version</key>
-	<string>5.14.0.0</string>
+	<string>5.14.0.1</string>
 	<key>webaddress</key>
 	<string>https://github.com/ruedap/alfred-font-awesome-workflow</string>
 	<key>readme</key>
@@ -16,13 +16,15 @@
 	<string>Search through Font Awesome icons</string>
 	<key>bundleid</key>
 	<string>com.ruedap.font-awesome</string>
+	<key>disabled</key>
+	<false/>
 	<key>connections</key>
 	<dict>
 		<key>06116C11-3F9B-438E-A515-7D3CA35574BE</key>
 		<array>
 			<dict>
 				<key>destinationuid</key>
-				<string>61DCB2DD-8EF7-447E-BED3-63AA4B73235C</string>
+				<string>AA55FF93-E3ED-430B-B08E-62236574DD0F</string>
 				<key>modifiers</key>
 				<integer>0</integer>
 				<key>modifiersubtext</key>
@@ -114,8 +116,6 @@
 			</dict>
 		</array>
 	</dict>
-	<key>disabled</key>
-	<false/>
 	<key>objects</key>
 	<array>
 		<dict>
@@ -256,25 +256,21 @@
 		<dict>
 			<key>config</key>
 			<dict>
-				<key>concurrently</key>
-				<false/>
-				<key>escaping</key>
-				<integer>0</integer>
-				<key>script</key>
-				<string>open {query}</string>
-				<key>scriptargtype</key>
-				<integer>0</integer>
-				<key>scriptfile</key>
+				<key>browser</key>
 				<string></string>
-				<key>type</key>
-				<integer>0</integer>
+				<key>spaces</key>
+				<string></string>
+				<key>url</key>
+				<string></string>
+				<key>utf8</key>
+				<false/>
 			</dict>
 			<key>type</key>
-			<string>alfred.workflow.action.script</string>
+			<string>alfred.workflow.action.openurl</string>
 			<key>uid</key>
-			<string>61DCB2DD-8EF7-447E-BED3-63AA4B73235C</string>
+			<string>AA55FF93-E3ED-430B-B08E-62236574DD0F</string>
 			<key>version</key>
-			<integer>2</integer>
+			<integer>1</integer>
 		</dict>
 		<dict>
 			<key>config</key>
@@ -305,51 +301,51 @@
 		<key>06116C11-3F9B-438E-A515-7D3CA35574BE</key>
 		<dict>
 			<key>xpos</key>
-			<integer>500</integer>
+			<integer>230</integer>
 			<key>ypos</key>
-			<real>340</real>
+			<integer>350</integer>
 		</dict>
 		<key>21557827-8003-42B7-A042-16D4C9278FEC</key>
 		<dict>
 			<key>xpos</key>
-			<integer>300</integer>
+			<integer>30</integer>
 			<key>ypos</key>
-			<real>120</real>
+			<integer>130</integer>
 		</dict>
 		<key>2D5AC270-69DB-4E00-BE29-B7F4927E632A</key>
 		<dict>
 			<key>xpos</key>
-			<integer>500</integer>
+			<integer>230</integer>
 			<key>ypos</key>
-			<real>10</real>
+			<integer>20</integer>
 		</dict>
-		<key>61DCB2DD-8EF7-447E-BED3-63AA4B73235C</key>
+		<key>8CBC1CA3-D946-4766-9551-505842A4BE52</key>
 		<dict>
 			<key>xpos</key>
-			<integer>700</integer>
+			<integer>430</integer>
 			<key>ypos</key>
-			<real>340</real>
+			<integer>130</integer>
 		</dict>
-		<key>8CBC1CA3-D946-4766-9551-505842A4BE52</key>
+		<key>8EEB02DD-09BA-4657-A9D8-ACE675D342BC</key>
 		<dict>
 			<key>xpos</key>
-			<integer>700</integer>
+			<integer>230</integer>
 			<key>ypos</key>
-			<real>120</real>
+			<integer>130</integer>
 		</dict>
-		<key>8EEB02DD-09BA-4657-A9D8-ACE675D342BC</key>
+		<key>AA55FF93-E3ED-430B-B08E-62236574DD0F</key>
 		<dict>
 			<key>xpos</key>
-			<integer>500</integer>
+			<integer>430</integer>
 			<key>ypos</key>
-			<real>120</real>
+			<integer>350</integer>
 		</dict>
 		<key>CE9A7E05-0277-46D5-941F-E5DEC7D9F6F7</key>
 		<dict>
 			<key>xpos</key>
-			<integer>500</integer>
+			<integer>230</integer>
 			<key>ypos</key>
-			<real>230</real>
+			<integer>240</integer>
 		</dict>
 	</dict>
 	<key>variablesdontexport</key>

package.json

@@ -13,16 +13,16 @@
     "build": "npm run clean && npm run compile && npm run package && npm run compress",
     "build:open": "npm run build && npm run open",
     "open": "open ./dist/Font-Awesome.alfredworkflow",
-    "cmd:find": "./dist/font-awesome-workflow --find font-awesome flag",
-    "cmd:put:name": "./dist/font-awesome-workflow --put-name font-awesome",
-    "cmd:put:code": "./dist/font-awesome-workflow --put-code font-awesome",
-    "cmd:put:ref": "./dist/font-awesome-workflow --put-ref font-awesome",
-    "cmd:put:url": "./dist/font-awesome-workflow --put-url font-awesome",
-    "cmd:put": "npm run cmd:put:name && npm run cmd:put:code && npm run cmd:put:ref && npm run cmd:put:url",
-    "cmd": "npm run cmd:find && npm run cmd:put",
     "exec": "npm run clean && npm run compile && node ./dist/index.js",
     "test": "jest",
     "test:watch": "jest --watchAll",
+    "test:cmd:find": "./dist/font-awesome-workflow --find font-awesome flag",
+    "test:cmd:put:name": "./dist/font-awesome-workflow --put-name font-awesome",
+    "test:cmd:put:code": "./dist/font-awesome-workflow --put-code font-awesome",
+    "test:cmd:put:ref": "./dist/font-awesome-workflow --put-ref font-awesome",
+    "test:cmd:put:url": "./dist/font-awesome-workflow --put-url font-awesome",
+    "test:cmd:put": "npm run test:cmd:put:name && npm run test:cmd:put:code && npm run test:cmd:put:ref && npm run test:cmd:put:url",
+    "test:cmd": "npm run test:cmd:find && npm run test:cmd:put",
     "fmt": "prettier --write .",
     "lint": "eslint . --ext 'ts,js'",
     "lint:fix": "eslint . --fix --ext 'ts,js'",

renovate.json

@@ -1,7 +1,5 @@
 {
-  "extends": [
-    "config:base"
-  ],
+  "extends": ["config:base"],
   "enabledManagers": ["npm"],
   "ignoreDeprecated": true,
   "timezone": "Asia/Tokyo",

src/alfred/response.test.ts

@@ -3,7 +3,6 @@ import { toJson, TResponse } from "./response";
 const response: TResponse = {
   items: [
     {
-      uid: "f26e",
       title: "500px",
       subtitle: "Paste class name: fa-500px",
       arg: "f26e",
@@ -13,7 +12,6 @@ const response: TResponse = {
       },
     },
     {
-      uid: "f271",
       title: "calendar-plus",
       subtitle: "Paste class name: fa-calendar-plus",
       arg: "f217",
@@ -28,6 +26,6 @@ const response: TResponse = {
 test("toJson", () => {
   const actual = toJson(response);
   const expected =
-    '{"items":[{"uid":"f26e","title":"500px","subtitle":"Paste class name: fa-500px","arg":"f26e","icon":{"type":"fileicon","path":"./icons/500px.png"}},{"uid":"f271","title":"calendar-plus","subtitle":"Paste class name: fa-calendar-plus","arg":"f217","icon":{"type":"fileicon","path":"./icons/calendar-plus.png"}}]}';
+    '{"items":[{"title":"500px","subtitle":"Paste class name: fa-500px","arg":"f26e","icon":{"type":"fileicon","path":"./icons/500px.png"}},{"title":"calendar-plus","subtitle":"Paste class name: fa-calendar-plus","arg":"f217","icon":{"type":"fileicon","path":"./icons/calendar-plus.png"}}]}';
   expect(actual).toBe(expected);
 });

src/alfred/response.ts

@@ -19,7 +19,8 @@ type TText = Readonly<{
 }>;
 
 export type TResponseItem = Readonly<{
-  uid: string;
+  // NOTE: If you would like Alfred to always show the results in the order you return them from your script, exclude the UID field.
+  uid?: string;
   title: string;
   subtitle: string;
   arg: string; // recommended

src/icons.test.ts

@@ -1,7 +1,7 @@
 import { getAllIcons, toResponseItem } from "./icons";
 
 test("toResponseItem()", () => {
-  const faIconObject = {
+  const iconObject = {
     name: "font-awesome",
     free: ["brands"],
     label: "Font Awesome",
@@ -10,9 +10,8 @@ test("toResponseItem()", () => {
     unicode: "f2b4",
   };
 
-  const actual = toResponseItem(faIconObject);
+  const actual = toResponseItem(iconObject);
   const expected = {
-    uid: "font-awesome",
     title: "font-awesome",
     subtitle: "Paste class name: fa-font-awesome",
     arg: "font-awesome",
@@ -25,13 +24,12 @@ test("getAllIcons()", () => {
   const allIcons = getAllIcons();
   expect(allIcons.items.length).toBe(1448);
 
-  const faIcon = allIcons.items.find((icon) => icon.uid === "font-awesome");
-  const faIconExpected = {
+  const actual = allIcons.items.find((icon) => icon.arg === "font-awesome");
+  const expected = {
     arg: "font-awesome",
     icon: { path: "./icons/font-awesome.png" },
     subtitle: "Paste class name: fa-font-awesome",
     title: "font-awesome",
-    uid: "font-awesome",
   };
-  expect(faIcon).toStrictEqual(faIconExpected);
+  expect(actual).toStrictEqual(expected);
 });

src/icons.ts

@@ -3,7 +3,6 @@ import { getAllIconsObject, TIconObject } from "./assets/icons_object";
 
 export const toResponseItem = (iconObject: TIconObject): TResponseItem => {
   return {
-    uid: iconObject.name,
     title: iconObject.name,
     subtitle: `Paste class name: fa-${iconObject.name}`,
     arg: iconObject.name,

src/index.ts

@@ -3,54 +3,61 @@ import { putCode, putName, putRef, putUrl } from "./put";
 import { getArgs, getFlagArgs, includesFlag } from "./query";
 import { search, toJson } from "./search";
 
-const FLAG_FIND = "--find";
-const FLAG_PUT_NAME = "--put-name";
-const FLAG_PUT_CODE = "--put-code";
-const FLAG_PUT_REF = "--put-ref";
-const FLAG_PUT_URL = "--put-url";
+const FLAG = {
+  FIND: "--find",
+  PUT: {
+    NAME: "--put-name",
+    CODE: "--put-code",
+    REF: "--put-ref",
+    URL: "--put-url",
+  },
+};
+
+const output = (str: string): void => {
+  process.stdout.write(str); // NOTE: Output to Alfred
+};
 
 const main = () => {
   const args = getArgs();
   const list = getAllIconsObject();
-  const keys = ["name", "search.terms"];
 
-  if (includesFlag(args, FLAG_FIND)) {
-    const query = getFlagArgs(args, FLAG_FIND);
-    const searchResult = search(list, keys, query);
-    console.log(toJson(searchResult)); // NOTE: Output to Alfred
+  if (includesFlag(args, FLAG.FIND)) {
+    const query = getFlagArgs(args, FLAG.FIND);
+    const searchResult = search(list, query);
+    output(toJson(searchResult));
     return;
   }
 
-  if (includesFlag(args, FLAG_PUT_NAME)) {
-    const query = getFlagArgs(args, FLAG_PUT_NAME);
+  if (includesFlag(args, FLAG.PUT.NAME)) {
+    const query = getFlagArgs(args, FLAG.PUT.NAME);
     const result = putName(query);
-    result && console.log(result); // NOTE: Output to Alfred
+    result && output(result);
     return;
   }
 
-  if (includesFlag(args, FLAG_PUT_CODE)) {
-    const query = getFlagArgs(args, FLAG_PUT_CODE);
+  if (includesFlag(args, FLAG.PUT.CODE)) {
+    const query = getFlagArgs(args, FLAG.PUT.CODE);
     const result = putCode(query);
-    result && console.log(result); // NOTE: Output to Alfred
+    result && output(result);
     return;
   }
 
-  if (includesFlag(args, FLAG_PUT_REF)) {
-    const query = getFlagArgs(args, FLAG_PUT_REF);
+  if (includesFlag(args, FLAG.PUT.REF)) {
+    const query = getFlagArgs(args, FLAG.PUT.REF);
     const result = putRef(query);
-    result && console.log(result); // NOTE: Output to Alfred
+    result && output(result);
     return;
   }
 
-  if (includesFlag(args, FLAG_PUT_URL)) {
-    const query = getFlagArgs(args, FLAG_PUT_URL);
+  if (includesFlag(args, FLAG.PUT.URL)) {
+    const query = getFlagArgs(args, FLAG.PUT.URL);
     const result = putUrl(query);
-    result && console.log(result); // NOTE: Output to Alfred
+    result && output(result);
     return;
   }
 
   // NOTE: No flags
-  console.log(toJson(search(list, keys, ""))); // NOTE: Output to Alfred
+  output(toJson(search(list, "")));
 };
 
 main();

src/put.ts

@@ -1,7 +1,6 @@
-import { TResponseItem } from "./alfred/response";
 import { getAllIconsObject, TIconObject } from "./assets/icons_object";
 
-type Query = TResponseItem["uid"];
+type Query = string;
 
 const getIconObject = (query: Query): TIconObject | undefined => {
   const allIconsObject = getAllIconsObject();