Allow overriding base url through baseUrl option

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## [Unreleased]
 
+### Added
+
+- Allow overriding base url through `baseUrl` option ([#343](https://github.com/marp-team/marp-cli/pull/343))
+
 ## v1.0.1 - 2021-04-27
 
 ### Changed

jest.config.js

@@ -1,6 +1,6 @@
 const { jsWithBabel } = require('ts-jest/presets')
 
-const esModules = ['ansi-regex', 'file-url', 'strip-ansi']
+const esModules = ['ansi-regex', 'strip-ansi']
 
 module.exports = {
   collectCoverageFrom: ['src/**/*.ts', 'src/**/*.tsx'],

package.json

@@ -91,7 +91,6 @@
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-import": "^2.22.1",
     "eslint-plugin-jest": "^24.3.6",
-    "file-url": "^4.0.0",
     "get-stdin": "^9.0.0",
     "image-size": "^1.0.0",
     "is-wsl": "^2.2.0",
@@ -150,6 +149,7 @@
     "yargs": "^16.2.0"
   },
   "resolutions": {
+    "normalize-package-data": "^3.0.2",
     "pug": "^3.0.2",
     "pug-runtime": "^3.0.1"
   },

src/config.ts

@@ -20,6 +20,7 @@ type Overwrite<T, U> = Omit<T, Extract<keyof T, keyof U>> & U
 interface IMarpCLIArguments {
   _?: string[]
   allowLocalFiles?: boolean
+  baseUrl?: string
   bespoke?: {
     osc?: boolean
     progress?: boolean
@@ -183,6 +184,7 @@ export class MarpCLIConfig {
       type,
       allowLocalFiles:
         this.args.allowLocalFiles ?? this.conf.allowLocalFiles ?? false,
+      baseUrl: this.args.baseUrl ?? this.conf.baseUrl,
       engine: this.engine.klass,
       globalDirectives: {
         description: this.args.description ?? this.conf.description,

src/converter.ts

@@ -45,6 +45,7 @@ export const mimeTypes = {
 
 export interface ConverterOption {
   allowLocalFiles: boolean
+  baseUrl?: string
   engine: Engine
   globalDirectives: { theme?: string } & Partial<TemplateMeta>
   html?: MarpOptions['html']
@@ -104,13 +105,21 @@ export class Converter {
     }: { fallbackToPrintableTemplate?: boolean } = {}
   ): Promise<TemplateResult> {
     const { lang, globalDirectives, type } = this.options
+
     const isFile = (f: File | undefined): f is File =>
       !!f && f.type === FileType.File
 
-    const resolveBase = async (f: File) =>
-      isChromeInWSLHost(generatePuppeteerLaunchArgs().executablePath)
-        ? `file:${await resolveWSLPathToHost(f.absolutePath)}`
-        : f.absoluteFileScheme
+    const resolveBase = async (f?: File) => {
+      if (this.options.baseUrl) return this.options.baseUrl
+
+      if (isFile(f) && type !== ConvertType.html) {
+        return isChromeInWSLHost(generatePuppeteerLaunchArgs().executablePath)
+          ? `file:${await resolveWSLPathToHost(f.absolutePath)}`
+          : f.absoluteFileScheme
+      }
+
+      return undefined
+    }
 
     let additionals = ''
 
@@ -128,10 +137,7 @@ export class Converter {
     return await template({
       ...(this.options.templateOption || {}),
       lang,
-      base:
-        isFile(file) && type !== ConvertType.html
-          ? await resolveBase(file)
-          : undefined,
+      base: await resolveBase(file),
       notifyWS:
         isFile(file) && this.options.watch && type === ConvertType.html
           ? await notifier.register(file.absolutePath)

src/file.ts

@@ -4,7 +4,6 @@ import os from 'os'
 import path from 'path'
 import * as url from 'url'
 import { promisify } from 'util'
-import fileUrl from 'file-url'
 import getStdin from 'get-stdin'
 import globby, { GlobbyOptions } from 'globby'
 import mkdirp from 'mkdirp'
@@ -44,11 +43,7 @@ export class File {
   }
 
   get absoluteFileScheme(): string {
-    if (url.pathToFileURL)
-      return url.pathToFileURL(this.absolutePath).toString()
-
-    // Fallback for Node < v10.12.0
-    return fileUrl(this.absolutePath)
+    return url.pathToFileURL(this.absolutePath).toString()
   }
 
   convert(output: string | false | undefined, opts: FileConvertOption): File {

src/marp-cli.ts

@@ -22,10 +22,13 @@ enum OptionGroup {
 }
 
 export interface MarpCLIInternalOptions {
+  baseUrl?: string
   stdin: boolean
   throwErrorAlways: boolean
 }
 
+export type MarpCLIAPIOptions = Pick<MarpCLIInternalOptions, 'baseUrl'>
+
 export type ObservationHelper = { stop: () => void }
 
 const resolversForObservation: Array<(helper: ObservationHelper) => void> = []
@@ -38,7 +41,7 @@ Usage:
 
 export const marpCli = async (
   argv: string[],
-  { stdin: defaultStdin, throwErrorAlways }: MarpCLIInternalOptions
+  { baseUrl, stdin: defaultStdin, throwErrorAlways }: MarpCLIInternalOptions
 ): Promise<number> => {
   let server: Server | undefined
   let watcherInstance: Watcher | undefined
@@ -215,6 +218,7 @@ export const marpCli = async (
       })
 
     const args = {
+      baseUrl, // It's not intended using by the consumer so can't set through CLI arguments
       ...program.argv,
       _: program.argv._.map((v) => v.toString()),
     }
@@ -385,10 +389,11 @@ export const waitForObservation = () =>
     resolversForObservation.push(res)
   })
 
-export const apiInterface = (argv: string[] = []) => {
+export const apiInterface = (argv: string[], opts: MarpCLIAPIOptions = {}) => {
   resetExecutablePath()
 
   return marpCli(argv, {
+    ...opts,
     stdin: false,
     throwErrorAlways: true,
   })

test/converter.ts

@@ -215,6 +215,17 @@ describe('Converter', () => {
         )
       })
     })
+
+    describe('with baseUrl option', () => {
+      it('overrides <base> href attribute to specific URL in every kind of conversion', async () => {
+        for (const type of Object.values(ConvertType)) {
+          const converter = instance({ type, baseUrl: 'https://example.com/' })
+          const { result } = await converter.convert(md, dummyFile)
+
+          expect(result).toContain('<base href="https://example.com/">')
+        }
+      })
+    })
   })
 
   describe('#convertFile', () => {

test/index.ts

@@ -14,13 +14,14 @@ afterEach(() => {
 describe('Marp CLI API interface', () => {
   it('runs Marp CLI with specific options', async () => {
     const marpCliSpy = jest.spyOn(marpCli, 'marpCli').mockResolvedValue(0)
-    const ret = await api([])
+    const ret = await api([], { baseUrl: 'https://example.com/' })
 
     expect(ret).toBe(0)
     expect(marpCliSpy).toHaveBeenCalled()
 
     const opts: marpCli.MarpCLIInternalOptions = marpCliSpy.mock.calls[0][1]
 
+    expect(opts.baseUrl).toBe('https://example.com/')
     expect(opts.stdin).toBe(false)
     expect(opts.throwErrorAlways).toBe(true)
   })