Merge pull request #48 from techfg/fix/rename-basepath-option

fix: `basePath` option name should align with Astro `base` option name (#46)

src/index.mjs

@@ -155,7 +155,7 @@ function astroRehypeRelativeMarkdownLinks(opts = {}) {
 
       // Debugging
       debug("--------------------------------------");
-      debug("BasePath                             : %s", options.basePath);
+      debug("Base path                            : %s", options.base);
       debug("ContentDir                           : %s", contentDir);
       debug("CollectionPathMode                   : %s", collectionPathMode);
       debug("TrailingSlashMode                    : %s", trailingSlashMode);

src/index.test.mjs

@@ -401,14 +401,14 @@ describe("astroRehypeRelativeMarkdownLinks", () => {
       await runValidationTest(context, { contentPath: "src" }));
   });
 
-  describe("config option - basePath", () => {
+  describe("config option - base", () => {
     test("should prefix base to output on file paths that exist", async () => {
       const input = '<a href="./fixtures/test.md">foo</a>';
       const { value: actual } = await rehype()
         .use(testSetupRehype)
         .use(astroRehypeRelativeMarkdownLinks, {
           contentPath: "src",
-          basePath: "/testBase",
+          base: "/testBase",
         })
         .process(input);
 

src/options.mjs

@@ -34,20 +34,20 @@ export const OptionsSchema = z.object({
     .union([z.literal("subdirectory"), z.literal("root")])
     .default("subdirectory"),
   /**
-   * @name basePath
+   * @name base
    * @reference https://docs.astro.build/en/reference/configuration-reference/#base
    * @description
    * The base path to deploy to. Astro will use this path as the root for your pages and assets both in development and in production build.
-   *
+   * @example
    * In the example below, `astro dev` will start your server at `/docs`.
-   *
+   * 
    * ```js
    * {
    *   base: '/docs'
    * }
    * ```
    */
-  basePath: z.string().optional(),
+  base: z.string().optional(),
   /**
    * @name trailingSlash
    * @default `ignore`

src/options.test.mjs

@@ -130,17 +130,17 @@ describe("validateOptions", () => {
     });
   });
 
-  describe("basePath", () => {
-    test("should have expected basePath default", () => {
-      expectsValidOption({}, "basePath", defaultOptions.basePath);
+  describe("base", () => {
+    test("should have expected base default", () => {
+      expectsValidOption({}, "base", defaultOptions.base);
     });
 
-    test("should be basePath value specified when provided", () => {
-      expectsValidOption({ basePath: "foobar" }, "basePath", "foobar");
+    test("should be base value specified when provided", () => {
+      expectsValidOption({ base: "foobar" }, "base", "foobar");
     });
 
-    test("should fail when baesPath not a string", () => {
-      expectsZodError({ basePath: {} }, "invalid_type");
+    test("should fail when base not a string", () => {
+      expectsZodError({ base: {} }, "invalid_type");
     });
   });
 

src/utils.mjs

@@ -103,15 +103,15 @@ export const splitPathFromQueryAndFragment = (url) => {
 /** @type {import('./utils.d.ts').NormaliseAstroOutputPath} */
 export const normaliseAstroOutputPath = (initialPath, options = {}) => {
   const buildPath = () => {
-    if (!options.basePath) {
+    if (!options.base) {
       return initialPath;
     }
 
-    if (options.basePath.startsWith(URL_PATH_SEPARATOR)) {
-      return path.join(options.basePath, initialPath);
+    if (options.base.startsWith(URL_PATH_SEPARATOR)) {
+      return path.join(options.base, initialPath);
     }
 
-    return URL_PATH_SEPARATOR + path.join(options.basePath, initialPath);
+    return URL_PATH_SEPARATOR + path.join(options.base, initialPath);
   };
 
   if (!initialPath) {

src/utils.test.mjs

@@ -206,31 +206,31 @@ describe("normaliseAstroOutputPath", () => {
   describe("prefix base to path", () => {
     test("base with no slashes", () => {
       const actual = normaliseAstroOutputPath("/foo-testing-test", {
-        basePath: "base",
+        base: "base",
       });
 
       assert.equal(actual, "/base/foo-testing-test");
     });
 
     test("base with slash at start", () => {
       const actual = normaliseAstroOutputPath("/foo-testing-test", {
-        basePath: "/base",
+        base: "/base",
       });
 
       assert.equal(actual, "/base/foo-testing-test");
     });
 
     test("base with slash at end", () => {
       const actual = normaliseAstroOutputPath("/foo-testing-test", {
-        basePath: "base/",
+        base: "base/",
       });
 
       assert.equal(actual, "/base/foo-testing-test");
     });
 
     test("base with slash at start and end", () => {
       const actual = normaliseAstroOutputPath("/foo-testing-test", {
-        basePath: "/base/",
+        base: "/base/",
       });
 
       assert.equal(actual, "/base/foo-testing-test");