custom output directory and baseURL

jamespohalloran · Nov 13, 2022 · 66d3e20 · 66d3e20
1 parent ac1ad81
commit 66d3e20
Show file tree

Hide file tree

Showing 5 changed files with 59 additions and 19 deletions.
diff --git a/packages/link-proofer/README.md b/packages/link-proofer/README.md
@@ -95,6 +95,20 @@ jobs:
           CI: true
 ```
 
+## CLI Usage
+
+```
+Usage: linkproofer [options]
+
+Options:
+  -h, --help                   display help for command
+  -V, --version                output the version number
+  -f, --files <files>          Filepath pattern for files in which linkproofer should check for links
+  -v, --verbose <verbose>      Log out all checked links (not just the failures)
+  -o, --outputDir <outputDir>  Directory to put the compiled output files. (Default dist). This         directory should be added to your .gitignore
+  -b, --baseURL <baseURL>      baseURL to use for relative links.
+```
+
 ## Checking links on local deployment
 
 TODO
diff --git a/packages/link-proofer/package.json b/packages/link-proofer/package.json
@@ -1,6 +1,6 @@
 {
   "name": "linkproofer",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "Tool to check for broken links in a project",
   "source": "src/index.ts",
   "files": [

diff --git a/packages/link-proofer/src/index.ts b/packages/link-proofer/src/index.ts
@@ -16,10 +16,17 @@ export async function init(args: any) {
       "-v, --verbose <verbose>",
       "Log out all checked links (not just the failures)"
     )
+    .option(
+      "-o, --outputDir <outputDir>",
+      "Directory to put the compiled output files. (Default dist). This directory should be added to your .gitignore"
+    )
+    .option("-b, --baseURL <baseURL>", "baseURL to use for relative links.")
     .action(async (options) => {
       await checkFiles({
         filePattern: options.files,
         verbose: options.verbose,
+        outputDir: options.outputDir,
+        baseURL: options.baseURL,
       });
     });
 

diff --git a/packages/link-proofer/src/link-proofer.ts b/packages/link-proofer/src/link-proofer.ts
@@ -12,10 +12,11 @@ interface LinkList {
 }
 
 const getLinkProofFile = async (
-  filePattern: string | string[]
+  filePattern: string | string[],
+  outputDir: string,
+  baseURL: string
 ): Promise<LinkList[]> => {
   const linkproofFilename = "linkproof";
-  const outputDir = "dist";
 
   const defaultPattern = `**/*.${linkproofFilename}.{ts,js}`;
   //glob for all files ending in .linkproof.ts or linkproof.js outside of dist
@@ -50,24 +51,13 @@ const getLinkProofFile = async (
     )
   );
 
-  // if (fs.existsSync(path.join(process.cwd(), `${linkproofFilename}.ts`))) {
-  //   hasTs = true;
-  // } else if (
-  //   fs.existsSync(!path.join(process.cwd(), `${linkproofFilename}.js`) as any)
-  // ) {
-  //   throw new Error(
-  //     `No ${linkproofFilename}.ts or linkproof.js file found in project root`
-  //   );
-  // }
-
   await build({
     entryPoints: entries,
     bundle: true,
     platform: "node",
     target: "node17",
-    outdir: path.join(process.cwd(), "dist"),
+    outdir: path.join(process.cwd(), outputDir),
     allowOverwrite: true,
-    //outfile: path.join(process.cwd(), "dist", `${linkproofFilename}.out.js`),
   });
 
   let result: LinkList[] = [];
@@ -78,12 +68,20 @@ const getLinkProofFile = async (
 
       const linkProofFile = await require(path.join(
         process.cwd(),
-        "dist",
+        outputDir,
         entryJs
       )).default;
 
       const valueKeys = Object.keys(linkProofFile).map((key: any) => {
-        return { key, value: linkProofFile[key] } as LinkList;
+        //join baseUrl and linkProofFile[key] without messing up http:// or https://
+
+        const val = linkProofFile[key].startsWith("/")
+          ? baseURL.replace(/\/$/, "") + linkProofFile[key]
+          : linkProofFile[key];
+        return {
+          key: key,
+          value: val,
+        } as LinkList;
       });
       result = [...result, ...valueKeys];
     })
@@ -95,10 +93,17 @@ const getLinkProofFile = async (
 export interface CheckFilesProps {
   filePattern: string | string[];
   verbose: boolean;
+  outputDir: string;
+  baseURL: string;
 }
 
-export const checkFiles = async ({ filePattern, verbose }: CheckFilesProps) => {
-  const linkproofFile = await getLinkProofFile(filePattern);
+export const checkFiles = async ({
+  filePattern,
+  verbose,
+  outputDir = "dist",
+  baseURL,
+}: CheckFilesProps) => {
+  const linkproofFile = await getLinkProofFile(filePattern, outputDir, baseURL);
   await checkLinkProofFile(linkproofFile, verbose);
 };
 

diff --git a/readme.md b/readme.md
@@ -95,6 +95,20 @@ jobs:
           CI: true
 ```
 
+## CLI Usage
+
+```
+Usage: linkproofer [options]
+
+Options:
+  -h, --help                   display help for command
+  -V, --version                output the version number
+  -f, --files <files>          Filepath pattern for files in which linkproofer should check for links
+  -v, --verbose <verbose>      Log out all checked links (not just the failures)
+  -o, --outputDir <outputDir>  Directory to put the compiled output files. (Default dist). This         directory should be added to your .gitignore
+  -b, --baseURL <baseURL>      baseURL to use for relative links.
+```
+
 ## Checking links on local deployment
 
 TODO