feat(#35): config to prefer home tilde

README.md

@@ -85,6 +85,9 @@ following optional keys:
   files will be displayed as monospaced text with code highlighting if
   available. Default Markdown extensions are `['markdown', 'md', 'mdown',
   'mdwn', 'mkd', 'mkdn']`
+- **`"preferHomeTilde"`**\
+  Prefer using `~` as a placeholder for your home directory in URLs as well as
+  the `compoments` for `"pageTitle"` (default is `true`)
 
 ## Installation
 

src/app.ts

@@ -9,15 +9,25 @@ import { router as healthRouter } from './routes/health.js';
 import { router as staticRouter } from './routes/static.js';
 import { router as viewerRouter } from './routes/viewer.js';
 import { setupSockets } from './sockets.js';
-import { pathToURL, urlToPath } from './utils/path.js';
+import { pathToURL, preferredPath, urlToPath } from './utils/path.js';
 import { existsSync } from 'fs';
+import { homedir } from 'os';
 
 const app = express();
 app.use(express.json());
 app.use((req, res, next) => {
     res.locals.filepath = urlToPath(req.path);
     next();
 });
+if (config.preferHomeTilde) {
+    app.use((req, res, next) => {
+        if (res.locals.filepath.startsWith(homedir()) && !req.path.includes('~')) {
+            res.redirect(req.path.replace(homedir(), '/~'));
+        } else {
+            next();
+        }
+    });
+}
 app.use('/static', staticRouter);
 app.use('/health', healthRouter);
 app.use('/viewer', viewerRouter);
@@ -47,8 +57,8 @@ const openArgs = () => {
             console.log(`File not found: ${path}`);
             continue;
         }
-        const absolute = presolve(path);
-        const url = `${address}${pathToURL(absolute)}`;
+        const target = preferredPath(presolve(path));
+        const url = `${address}${pathToURL(target)}`;
         open(url);
     }
 };

src/parser/config.ts

@@ -10,12 +10,14 @@ type Config = {
     pageTitle?: string;
     mdExtensions: string[];
     timeout: number;
+    preferHomeTilde: boolean;
 };
 
 const defaultConfig: Config = {
     port: 31622,
     mdExtensions: ['markdown', 'md', 'mdown', 'mdwn', 'mkd', 'mkdn'],
     timeout: 10000,
+    preferHomeTilde: true,
 };
 
 const envConfigs: [string, keyof Config][] = [

src/routes/viewer.ts

@@ -5,15 +5,15 @@ import { Request, Response, Router } from 'express';
 
 import { messageClientsAt } from '../app.js';
 import config from '../parser/config.js';
-import { pathToURL, pcomponents, pmime } from '../utils/path.js';
+import { absPath, pathToURL, pcomponents, pmime, preferredPath } from '../utils/path.js';
 import { renderDirectory, renderTextFile } from '../parser/parser.js';
 
 export const router = Router();
 
 const liveContent = new Map<string, string>();
 
 const pageTitle = (path: string) => {
-    const comps = pcomponents(path);
+    const comps = pcomponents(preferredPath(path));
     if (config.pageTitle) {
         return eval(`
             const components = ${JSON.stringify(comps)};
@@ -74,7 +74,7 @@ router.get(/.*/, async (req: Request, res: Response) => {
             </body>
             <script>
                 window.VIV_PORT = "${config.port}";
-                window.VIV_PATH = "${req.path}";
+                window.VIV_PATH = "${absPath(req.path)}";
             </script>
             <script type="text/javascript" src="/static/client.js"></script>
         </html>

src/utils/path.ts

@@ -1,6 +1,7 @@
 import { execSync } from 'child_process';
 import { homedir } from 'os';
 import { basename as pbasename, dirname as pdirname, parse as pparse } from 'path';
+import config from '../parser/config.js';
 
 export const pmime = (path: string) => execSync(`file --mime-type -b '${path}'`).toString().trim();
 
@@ -9,7 +10,7 @@ export const pcomponents = (path: string) => {
     const components = new Array<string>();
     // directory
     let dir = parsed.dir;
-    while (dir !== '/' && dir !== '') {
+    while (dir !== '/' && dir !== '.') {
         components.unshift(pbasename(dir));
         dir = pdirname(dir);
     }
@@ -20,12 +21,17 @@ export const pcomponents = (path: string) => {
     return components;
 };
 
+export const absPath = (path: string) => path.replace(/^\/~/, homedir()).replace(/\/+$/, '');
+
 export const urlToPath = (url: string) => {
-    const path = decodeURIComponent(url.replace(/^\/(viewer|health)/, ''))
-        .replace(/^\/~/, homedir())
-        .replace(/\/+$/, '');
+    const path = absPath(decodeURIComponent(url.replace(/^\/(viewer|health)/, '')));
     return path === '' ? '/' : path;
 };
 
-export const pathToURL = (path: string, route: string = 'viewer') =>
-    `/${route}${encodeURIComponent(path).replaceAll('%2F', '/')}`;
+export const pathToURL = (path: string, route: string = 'viewer') => {
+    const withoutPrefix = path.startsWith('/') ? path.slice(1) : path;
+    return `/${route}/${encodeURIComponent(withoutPrefix).replaceAll('%2F', '/')}`;
+};
+
+export const preferredPath = (path: string): string =>
+    config.preferHomeTilde && path.startsWith(homedir()) ? path.replace(homedir(), '~') : path;