VSinerva/freesewing
1
0
Fork 0
Code Activity

feat: Better scripts for markdown maintenance

Browse source
This commit is contained in:
joostdecock 2021-10-17 10:00:25 +02:00
parent 4d5eb39d71
commit 308a4455e5
1 changed files with 34 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

39
scripts/addpatterndocs.js
View file

@ -21,6 +21,8 @@ const i18n = require('../packages/i18n/dist')
const capitalize = require('../packages/utils/capitalize') const capitalize = require('../packages/utils/capitalize')
const missing = [] const missing = []
const lacking = []
const extra = []
const file = 'en.md' const file = 'en.md'
const subpages = [ const subpages = [
'cutting', 'cutting',
@ -82,12 +84,24 @@ const present = folder => {
} }
} }
const getSubFolders = folder => fs
.readdirSync(folder, {withFileTypes: true })
.filter(dirent => dirent.isDirectory())
.map(dirent => dirent.name)
const checkOptionDocs = () => { const checkOptionDocs = () => {
const steps = ['markdown', 'org', 'docs', 'patterns'] const steps = ['markdown', 'org', 'docs', 'patterns']
for (const pattern of pi.list) { for (const pattern of pi.list) {
const Pattern = require(`../packages/${pattern}/dist`) const Pattern = require(`../packages/${pattern}/dist`)
// Index page, // Index page,
const folder = path.join(...steps, pattern) const folder = path.join(...steps, pattern)
const subFolders = getSubFolders(folder)
for (const page of subpages) {
if (subFolders.indexOf(page) === -1) lacking.push(path.join(folder, page))
}
for (const sub of subFolders) {
if (subpages.indexOf(sub) === -1) extra.push(path.join(folder, sub))
}
if (!present(folder)) { if (!present(folder)) {
fs.mkdirSync(folder, { recursive: true }) fs.mkdirSync(folder, { recursive: true })
fs.writeFileSync( fs.writeFileSync(
@ -108,8 +122,12 @@ const checkOptionDocs = () => {
} }
// Options // Options
let optionFolders = getSubFolders(path.join(...steps, pattern, 'options'))
for (const option of pi.options[pattern]) { for (const option of pi.options[pattern]) {
const folder = path.join('markdown', 'org', 'docs', 'patterns', pattern, 'options', option.toLowerCase()) // Remove this from the folder list
const i = optionFolders.indexOf(option.toLowerCase())
optionFolders.splice(i, 1)
const folder = path.join(...steps, pattern, 'options', option.toLowerCase())
if (!present(folder)) { if (!present(folder)) {
missing.push(path.join(folder, file)) missing.push(path.join(folder, file))
fs.mkdirSync(folder, { recursive: true }) fs.mkdirSync(folder, { recursive: true })
@ -119,12 +137,23 @@ const checkOptionDocs = () => {
) )
} }
} }
// Now check for extra folders
for (const subfolder of optionFolders) {
extra.push(path.join(...steps, pattern, 'options', subfolder))
}
} }
if (missing.length < 1) console.log("\n 🎉 Everything looks fine 😀\n") if (missing.length < 1 && extra.length < 1 && lacking.length < 1) {
else { console.log("\n 🎉 Everything looks fine 😀\n")
console.log("\n", 'Added documenation pages for the following options:', "\n\n") } else {
for (const line of missing) console.log(line) if (missing.length > 0) {
console.log("\n", 'Added documenation pages for the following options:', "\n\n")
for (const line of missing) console.log(line)
}
if (extra.length > 0) {
console.log("\n", 'Found extra folders that should not be there:', "\n\n")
for (const line of extra) console.log(line)
}
} }
} }