feat(docz-core): support for configuring the separator during slugifying

core/docz-core/src/lib/Entries.ts

@@ -91,7 +91,7 @@ export class Entries {
     const createEntry = async (file: string) => {
       try {
         const ast = await parseMdx(file)
-        const entry = new Entry(ast, file, src)
+        const entry = new Entry(ast, file, src, config)
 
         if (this.repoEditUrl) entry.setLink(this.repoEditUrl)
         const { settings, ...rest } = entry

core/docz-core/src/lib/Entry.ts

@@ -11,6 +11,8 @@ import {
 
 import * as paths from '../config/paths'
 
+import { Config } from './commands/args'
+
 const createId = (file: string) =>
   crypto
     .createHash('md5')
@@ -46,15 +48,15 @@ export class Entry {
     [key: string]: any
   }
 
-  constructor(ast: any, file: string, src: string) {
+  constructor(ast: any, file: string, src: string, config: Config) {
     const filepath = this.getFilepath(file, src)
     const parsed = getParsedData(ast)
     const name = this.getName(filepath, parsed)
 
     this.id = createId(file)
     this.filepath = filepath
     this.link = null
-    this.slug = this.slugify(filepath)
+    this.slug = this.slugify(filepath, config.separator)
     this.route = this.getRoute(parsed)
     this.name = name
     this.order = parsed.order || 0
@@ -85,11 +87,11 @@ export class Entry {
     return parsed && parsed.name ? parsed.name : filename
   }
 
-  private slugify(filepath: string): string {
+  private slugify(filepath: string, separator: string): string {
     const ext = path.extname(filepath)
     const fileWithoutExt = filepath.replace(ext, '')
 
-    return slugify(fileWithoutExt)
+    return slugify(fileWithoutExt, { separator })
   }
 
   private getRoute(parsed: any): string {

core/docz-core/src/states/config.ts

@@ -18,6 +18,7 @@ interface Payload {
   native: boolean
   codeSandbox: boolean
   themeConfig: ThemeConfig
+  separator: string
 }
 
 const getInitialConfig = (config: Config): Payload => {
@@ -34,6 +35,7 @@ const getInitialConfig = (config: Config): Payload => {
     native: config.native,
     codeSandbox: config.codeSandbox,
     themeConfig: config.themeConfig,
+    separator: config.separator,
   }
 }
 

packages/docz-core/src/commands/args.ts

@@ -79,6 +79,8 @@ export interface Argv {
   hashRouter: boolean
   wrapper?: string
   indexHtml?: string
+  /* slugify separator */
+  separator: string
 }
 
 export interface Config extends Argv {
@@ -202,4 +204,8 @@ export const args = (env: Env) => (yargs: any) => {
     type: 'boolean',
     default: getEnv('docz.sourcemaps') || true,
   })
+  yargs.positional('separator', {
+    type: 'string',
+    default: getEnv('docz.separator', '-'),
+  })
 }