repo-subdir option

Author: jjallaire

src/core/path.ts

@@ -159,6 +159,14 @@ export function pathWithForwardSlashes(path: string) {
   return path.replace(/\\/g, "/");
 }
 
+export function ensureTrailingSlash(path: string) {
+  if (!path.endsWith("/")) {
+    return path + "/";
+  } else {
+    return path;
+  }
+}
+
 export function resolveGlobs(
   root: string,
   globs: string[],

src/project/types/book/book-config.ts

@@ -10,7 +10,11 @@ import { basename, join } from "path/mod.ts";
 
 import * as ld from "../../../core/lodash.ts";
 
-import { safeExistsSync } from "../../../core/path.ts";
+import {
+  ensureTrailingSlash,
+  pathWithForwardSlashes,
+  safeExistsSync,
+} from "../../../core/path.ts";
 import { FormatLanguage, Metadata } from "../../../config/types.ts";
 
 import {
@@ -44,6 +48,7 @@ import {
   kSiteReaderMode,
   kSiteRepoActions,
   kSiteRepoBranch,
+  kSiteRepoSubdir,
   kSiteRepoUrl,
   kSiteSidebar,
   kSiteSidebarStyle,
@@ -118,6 +123,7 @@ export async function bookProjectConfig(
     site[kSiteUrl] = book[kSiteUrl];
     site[kSitePath] = book[kSitePath];
     site[kSiteRepoUrl] = book[kSiteRepoUrl];
+    site[kSiteRepoSubdir] = book[kSiteRepoSubdir];
     site[kSiteRepoBranch] = book[kSiteRepoBranch];
     site[kSiteRepoActions] = book[kSiteRepoActions];
     site[kSiteNavbar] = book[kSiteNavbar];
@@ -190,7 +196,7 @@ export async function bookProjectConfig(
   // code tools
   const tools = [];
   if (site[kSiteRepoUrl]) {
-    const repoUrl = site[kSiteRepoUrl] as string;
+    const repoUrl = siteRepoUrl(site);
     const icon = repoUrlIcon(repoUrl);
     tools.push({
       text: "Source Code",
@@ -228,6 +234,19 @@ export async function bookProjectConfig(
   return websiteProjectConfig(projectDir, config, forceHtml);
 }
 
+function siteRepoUrl(site: Metadata) {
+  const repoUrl = site[kSiteRepoUrl] as string;
+  if (site[kSiteRepoSubdir]) {
+    const subdir = ensureTrailingSlash(site[kSiteRepoSubdir] as string);
+    const branch = site[kSiteRepoBranch] || "main";
+    return pathWithForwardSlashes(
+      join(repoUrl, `tree/${branch}/${subdir}`),
+    );
+  } else {
+    return repoUrl;
+  }
+}
+
 const variableRegex = /{{<\s*var\s+(.*?)\s*>}}/gm;
 function resolveVariables(value: string, config: ProjectConfig) {
   variableRegex.lastIndex = 0;

src/project/types/website/website-config.ts

@@ -28,6 +28,7 @@ import {
   kMarginHeader,
   kSitePath,
   kSiteRepoBranch,
+  kSiteRepoSubdir,
   kSiteRepoUrl,
   kSiteSidebar,
   kSiteSidebarFooter,
@@ -36,6 +37,7 @@ import {
   kSiteUrl,
   kWebsite,
 } from "./website-constants.ts";
+import { ensureTrailingSlash } from "../../../core/path.ts";
 type WebsiteConfigKey =
   | "title"
   | "image"
@@ -44,6 +46,7 @@ type WebsiteConfigKey =
   | "site-url"
   | "site-path"
   | "repo-url"
+  | "repo-subdir"
   | "repo-branch"
   | "repo-actions"
   | "navbar"
@@ -182,21 +185,28 @@ export function websiteRepoInfo(
 ): WebsiteRepoInfo | undefined {
   let repoUrl = websiteConfigString(kSiteRepoUrl, project);
   if (repoUrl) {
-    if (!repoUrl.endsWith("/")) {
-      repoUrl = repoUrl + "/";
-    }
-    // extract into base and path
-    const match = repoUrl.match(/(https?:\/\/(?:[^\/]+\/){3})(.*)/);
-    if (match) {
-      return {
-        baseUrl: match[1],
-        path: match[2] || "",
-      };
-    } else {
+    repoUrl = ensureTrailingSlash(repoUrl);
+    // is there an explicit subdir?
+    const repoSubdir = websiteConfigString(kSiteRepoSubdir, project);
+    if ((repoSubdir)) {
       return {
         baseUrl: repoUrl,
-        path: "",
+        path: ensureTrailingSlash(repoSubdir),
       };
+    } else {
+      // extract into base and path
+      const match = repoUrl.match(/(https?:\/\/(?:[^\/]+\/){3})(.*)/);
+      if (match) {
+        return {
+          baseUrl: match[1],
+          path: ensureTrailingSlash(match[2]) || "",
+        };
+      } else {
+        return {
+          baseUrl: repoUrl,
+          path: "",
+        };
+      }
     }
   } else {
     return undefined;

src/project/types/website/website-constants.ts

@@ -12,6 +12,7 @@ export const kSitePath = "site-path";
 export const kSiteTitle = "title";
 export const kSiteFavicon = "favicon";
 export const kSiteRepoUrl = "repo-url";
+export const kSiteRepoSubdir = "repo-subdir";
 export const kSiteRepoBranch = "repo-branch";
 export const kSiteRepoActions = "repo-actions";
 export const kSiteReaderMode = "reader-mode";

src/resources/editor/tools/vs-code.mjs

@@ -8858,6 +8858,11 @@ var require_yaml_intelligence_resources = __commonJS({
                   description: "Base URL for website source code repository"
                 }
               },
+              "repo-subdir": {
+                string: {
+                  description: "Subdirectory of repository containing website"
+                }
+              },
               "repo-branch": {
                 string: {
                   description: "Branch of website source code (defaults to `main`)"
@@ -16907,6 +16912,7 @@ var require_yaml_intelligence_resources = __commonJS({
         "Base URL for published website",
         "Path to site (defaults to \u2018/\u2019). Not required if you specify\n<code>site-url</code>.",
         "Base URL for website source code repository",
+        "Subdirectory of repository containing website or book",
         "Branch of website source code (defaults to <code>main</code>)",
         {
           short: "Links to source repository actions",
@@ -18390,6 +18396,7 @@ var require_yaml_intelligence_resources = __commonJS({
         "Base URL for published website",
         "Path to site (defaults to \u2018/\u2019). Not required if you specify\n<code>site-url</code>.",
         "Base URL for website source code repository",
+        "Subdirectory of repository containing website or book",
         "Branch of website source code (defaults to <code>main</code>)",
         {
           short: "Links to source repository actions",
@@ -18589,6 +18596,7 @@ var require_yaml_intelligence_resources = __commonJS({
         "Base URL for published website",
         "Path to site (defaults to \u2018/\u2019). Not required if you specify\n<code>site-url</code>.",
         "Base URL for website source code repository",
+        "Subdirectory of repository containing website or book",
         "Branch of website source code (defaults to <code>main</code>)",
         {
           short: "Links to source repository actions",

src/resources/editor/tools/yaml/web-worker.js

@@ -1837,6 +1837,11 @@
               "description": "Base URL for website source code repository"
             }
           },
+          "repo-subdir": {
+            "string": {
+              "description": "Subdirectory of repository containing website"
+            }
+          },
           "repo-branch": {
             "string": {
               "description": "Branch of website source code (defaults to `main`)"
@@ -9886,6 +9891,7 @@
     "Base URL for published website",
     "Path to site (defaults to ‘/’). Not required if you specify\n<code>site-url</code>.",
     "Base URL for website source code repository",
+    "Subdirectory of repository containing website or book",
     "Branch of website source code (defaults to <code>main</code>)",
     {
       "short": "Links to source repository actions",
@@ -11369,6 +11375,7 @@
     "Base URL for published website",
     "Path to site (defaults to ‘/’). Not required if you specify\n<code>site-url</code>.",
     "Base URL for website source code repository",
+    "Subdirectory of repository containing website or book",
     "Branch of website source code (defaults to <code>main</code>)",
     {
       "short": "Links to source repository actions",
@@ -11568,6 +11575,7 @@
     "Base URL for published website",
     "Path to site (defaults to ‘/’). Not required if you specify\n<code>site-url</code>.",
     "Base URL for website source code repository",
+    "Subdirectory of repository containing website or book",
     "Branch of website source code (defaults to <code>main</code>)",
     {
       "short": "Links to source repository actions",

src/resources/editor/tools/yaml/yaml-intelligence-resources.json

@@ -485,6 +485,9 @@
       repo-url:
         string:
           description: "Base URL for website source code repository"
+      repo-subdir:
+        string:
+          description: "Subdirectory of repository containing website"
       repo-branch:
         string:
           description: "Branch of website source code (defaults to `main`)"