FilesExpand file tree

main

/

update-filepaths.ts

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

executable file

·

232 lines (196 loc) · 7.03 KB

main

/

update-filepaths.ts

Copy path

Top

File metadata and controls

• Code
• Blame

executable file

·

232 lines (196 loc) · 7.03 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

// @purpose Writer tool

// @description Update content filenames to match short titles

import fs from 'fs'

import path from 'path'

import { program } from 'commander'

import GithubSlugger from 'github-slugger'

import { decode } from 'html-entities'

import { execFileSync } from 'child_process'

import walkFiles from '@/workflows/walk-files'

import frontmatter from '@/frame/lib/read-frontmatter'

import { renderContent } from '@/content-render/index'

import { isPathWithin } from '@/content-render/lib/is-path-within'

import fpt from '@/versions/lib/non-enterprise-default-version'

import { allVersions } from '@/versions/lib/all-versions'

import type { PageFrontmatter, Context } from '@/types'

interface ScriptOptions {

force?: boolean

excludeDirs?: boolean

paths?: string[]

dryRun?: boolean

verbose: boolean

}

const context: Context = {

currentLanguage: 'en',

currentVersionObj: allVersions[fpt],

}

program

.description(

'Update filepaths to match short titles, unless frontmatter override is present. Processes both files and directories by default.',

)

.option('-f, --force', 'Update paths even if frontmatter override is present')

.option('-e, --exclude-dirs', 'Exclude directories')

.option(

'-p, --paths [paths...]',

`One or more specific paths to process (e.g., copilot or content/copilot/how-tos/file.md)`,

)

.option('-d, --dry-run', 'Preview changes without actually making them')

.option('-v, --verbose', 'Verbose')

.parse(process.argv)

const options: ScriptOptions = program.opts()

const isDirectoryCheck = (file: string): boolean => file.endsWith('index.md')

// The script takes about 2 seconds per file, so divide by 30 instead of 60 to get the minutes.

const estimateScriptMinutes = (numberOfFiles: number): string => {

const estNum = Math.round(numberOfFiles / 30)

return estNum === 0 ? '<1' : estNum.toString()

}

// main processes files sequentially because move-content must move files before directories,

// and deepest directories before parents.

// Async does not shorten this work because each path move depends on the ordered result.

async function main(): Promise<void> {

const slugger = new GithubSlugger()

const contentDir: string = path.join(process.cwd(), 'content')

const filesToProcess: string[] = sortFiles(filterFiles(contentDir, options))

if (filesToProcess.length === 0) {

console.log('No files to process')

return

}

if (!options.dryRun) {

const estimate = estimateScriptMinutes(filesToProcess.length)

console.log(`Processing ${filesToProcess.length} files`)

console.log(`Estimated time: ${estimate} min\n`)

}

for (const file of filesToProcess) {

try {

slugger.reset()

const result = await processFile(file, slugger, options)

if (!result) continue

moveFile(result, options)

} catch (error) {

console.error(`Failed to process ${file}:`, error)

}

}

}

async function processFile(

file: string,

slugger: GithubSlugger,

scriptOptions: ScriptOptions,

): Promise<string[] | null> {

const { data } = frontmatter(fs.readFileSync(file, 'utf8')) as unknown as {

data: PageFrontmatter

}

const isDirectory = isDirectoryCheck(file)

const processPage: boolean = determineProcessStatus(data, isDirectory, scriptOptions)

if (!processPage) return null

let stringToSlugify: string = data.shortTitle || data.title

if (stringToSlugify.includes('{%')) {

stringToSlugify = await renderContent(stringToSlugify, context, { textOnly: true })

}

// Slug shortTitle, or title when shortTitle is absent, to get the target basename.

const slug: string = slugger.slug(decode(stringToSlugify))

let basename: string

if (isDirectory) {

basename = path.basename(path.dirname(file))

} else {

basename = path.basename(file, '.md')

}

if (slug === basename) return null

const newPath = isDirectory

? path.join(path.dirname(path.dirname(file)), slug, 'index.md')

: path.join(path.dirname(file), `${slug}.md`)

const getContentPath = (filePath: string): string => {

const relativePath = path.relative(process.cwd(), filePath)

return isDirectory ? path.dirname(relativePath) : relativePath

}

const contentPath = getContentPath(file)

const newContentPath = getContentPath(newPath)

return [contentPath, newContentPath]

}

function moveFile(result: string[], scriptOptions: ScriptOptions): void {

const [contentPath, newContentPath] = result

if (scriptOptions.dryRun) {

console.log('Move:\n', contentPath, '\nto:\n', newContentPath, '\n')

return

}

// move-content handles file moves, redirects, and children updates.

const stdout = execFileSync(

'tsx',

[

'src/content-render/scripts/move-content.ts',

'--no-git',

'--verbose',

contentPath,

newContentPath,

],

{ encoding: 'utf8' },

)

// Print only Moving or Renamed lines unless verbose; full move-content output is noisy.

const moveMsg = stdout.split('\n').find((l) => l.startsWith('Moving') || l.startsWith('Renamed'))

if (moveMsg && !options.verbose) {

console.log(moveMsg, '\n')

} else {

console.log(stdout, '\n')

}

}

function sortFiles(filesArray: string[]): string[] {

// Move files before directories, then deepest directories before parents.

return filesArray.toSorted((a, b) => {

if (!isDirectoryCheck(a) && isDirectoryCheck(b)) {

return -1

}

if (isDirectoryCheck(a) && !isDirectoryCheck(b)) {

return 1

}

if (!isDirectoryCheck(a) && !isDirectoryCheck(b)) {

return 0

}

if (isDirectoryCheck(a) && isDirectoryCheck(b)) {

const aDepth = a.split(path.sep).length

const bDepth = b.split(path.sep).length

return bDepth - aDepth

}

return 0

})

}

function filterFiles(contentDir: string, scriptOptions: ScriptOptions) {

return walkFiles(contentDir, ['.md']).filter((file: string) => {

// Keep README paths unchanged.

if (file.endsWith('README.md')) return false

// Keep early access paths unchanged.

if (file.includes('early-access')) return false

// Keep the homepage path unchanged.

if (path.relative(contentDir, file) === 'index.md') return false

// Keep product landing paths unchanged.

if (path.relative(contentDir, file).split(path.sep)[1] === 'index.md') return false

if (!scriptOptions.paths) return true

return scriptOptions.paths.some((p: string) => {

// Accept full content paths like content/foo/bar.md or top-level dirs like copilot.

if (!p.startsWith('content')) {

p = path.join('content', p)

}

if (!fs.existsSync(p)) {

console.error(`${p} not found`)

process.exit(1)

}

return isPathWithin(path.relative(process.cwd(), file), p)

})

})

}

function determineProcessStatus(

data: PageFrontmatter,

isDirectory: boolean,

scriptOptions: ScriptOptions,

): boolean {

// exclude-dirs prevents directory moves even when force is set.

if (isDirectory && scriptOptions.excludeDirs) {

return false

}

if (scriptOptions.force) {

return true

}

if (data.allowTitleToDifferFromFilename) {

return false

}

return true

}

main()