dev: fix empty matching bug

Author: tianhaoz95

README.md

@@ -26,6 +26,8 @@ npm test                        # Run unit tests
 
 ### Run integration test
 
+#### If target is readable-readme
+
 Integration test will run a full scan on the current directory like the installed GitHub actions.
 
 ```bash
@@ -34,10 +36,21 @@ export GITHUB_TOKEN=[the GitHub identity you want to use]
 npm start
 ```
 
+#### If target is another repository
+
+> for now, the remote repository must be public
+
+```bash
+export GITHUB_REPOSITORY=username/repo
+source ./script/setupRemoteTest.sh
+export GITHUB_TOKEN=[the GitHub identity you want to use]
+npm start
+```
+
 ### Build lib
 
 ```bash
-npm run build
+npm run build # The compiled code will be in ./lib
 ```
 
 ## Roadmap

script/setupRemoteTest.sh

@@ -0,0 +1,12 @@
+# GITHUB_REPOSITORY has to be set before running this script
+
+export REMOTE_TEST_DIR=/tmp/readable-readme-test
+export GITHUB_REF=refs/heads/master
+export GITHUB_WORKFLOW=test_workflow
+export GITHUB_ACTION=readable-readme
+export RRLOG=false
+
+mkdir -p ${REMOTE_TEST_DIR}
+git clone https://github.com/${GITHUB_REPOSITORY}.git ${REMOTE_TEST_DIR}/${GITHUB_REPOSITORY}
+
+export GITHUB_WORKSPACE=${REMOTE_TEST_DIR}/${GITHUB_REPOSITORY}

src/util.ts

@@ -285,7 +285,15 @@ export function getLintFileList(workspaceDir: string): string[] {
   // TODO(tianhaoz95): add test for this.
   const readmeIgnoreFilename = path.join(workspaceDir, "/.readmeignore");
   const ignoreList = getReadmeIgnoreList(readmeIgnoreFilename);
+  rrlog("ignore list found: " + JSON.stringify(ignoreList));
   const rawWorkspaceFiles = listFiles(workspaceDir);
+  rrlog("rawWorkspaceFiles size: " + rawWorkspaceFiles.length.toString());
+  if (ignoreList.length === 0) {
+    // match with empty ignorelist will return empty list, so just return
+    rrlog("ignorelist is empty, proceed with all markdown files");
+    return rawWorkspaceFiles;
+  }
   const workspaceFiles = micromatch(rawWorkspaceFiles, ignoreList);
+  rrlog("workspaceFiles size: " + workspaceFiles.length.toString());
   return workspaceFiles;
 }