refactor params and move couple utils from pullarticles to pathustils

Author: laidrivm

src/generate.tsx

@@ -69,19 +69,16 @@ interface SiteGenerationConfig {
  * Generate static site with configurable options
  * @param config Site generation configuration
  */
-async function generateSite(config: SiteGenerationConfig = {}): void {
-  const {
-    articlesPath = process.env.ARTICLES,
-    publicPath = process.env.PUBLIC,
-    source = process.env.SOURCE
-  } = config
-
+async function generateSite(): void {
+  const articlesPath = process.env.ARTICLES
+  const publicPath = process.env.PUBLIC
+  const source = process.env.SOURCE
   const indexes: Indexes = []
   const pages: PageEntry[] = []
 
   try {
     if (source !== 'local') {
-      await pullArticles(articlesPath)
+      await pullArticles()
     }
 
     const processConfig: ArticleProcessingConfig = {
@@ -97,7 +94,7 @@ async function generateSite(config: SiteGenerationConfig = {}): void {
     await generateSitemap(publicPath, pages)
 
     if (source !== 'local') {
-      await cleanupArticlesDirectory(articlesPath)
+      await cleanupArticlesDirectory()
     }
 
     console.log('Static site generation completed successfully.')

src/pathutils.ts

@@ -1,4 +1,4 @@
-import {join} from 'path'
+import {join, extname, dirname, resolve} from 'path'
 
 import type {SupportedLanguage, Index} from './types'
 
@@ -68,3 +68,41 @@ export function isLanguageDirectory(path: string): boolean {
   const candidate = parts[parts.length - 1]
   return validLanguages.includes(candidate as SupportedLanguage)
 }
+
+/**
+ * Check if a file is an image based on its extension
+ * @param filename Filename to check
+ * @returns Boolean indicating if file is an image
+ */
+export function isImage(filename: string): boolean {
+  const IMAGE_EXTENSIONS: string[] = [
+    '.png',
+    '.jpg',
+    '.jpeg',
+    '.gif',
+    '.svg',
+    '.webp'
+  ]
+  const ext = extname(filename).toLowerCase()
+  return IMAGE_EXTENSIONS.includes(ext)
+}
+
+/**
+ * Get the directory name of a path
+ * @param filePath Path to extract directory from
+ * @returns Directory part of the path
+ */
+export function getDirname(filePath: string): string {
+  return dirname(filePath)
+}
+
+/**
+ * Resolve a path from current working directory
+ * @param paths Path segments to resolve
+ * @returns Resolved absolute path
+ */
+export function resolvePath(...paths: string[]): string {
+  return resolve(...paths)
+}
+
+export { join }

src/pullarticles.ts

@@ -1,34 +1,11 @@
 import fs from 'fs/promises'
-import path from 'path'
 
 import {Octokit} from 'octokit'
 import {Buffer} from 'buffer/'
 
-const IGNORE_LIST: string[] = ['README.md', '.git', '.gitignore']
-const IMAGE_EXTENSIONS: string[] = [
-  '.png',
-  '.jpg',
-  '.jpeg',
-  '.gif',
-  '.svg',
-  '.webp'
-]
+import {join, isImage, getDirname, resolvePath} from './pathutils'
 
-/**
- * Parse GitHub repository details from URL
- * @param sourceUrl GitHub repository URL
- * @returns Object with owner and repo
- */
-function parseRepoDetails(sourceUrl: string): {owner: string; repo: string} {
-  const repoUrl = new URL(sourceUrl)
-  const [owner, repo] = repoUrl.pathname.split('/').filter(Boolean)
-
-  if (!owner || !repo) {
-    throw new Error('Invalid repository URL')
-  }
-
-  return {owner, repo}
-}
+const IGNORE_LIST: string[] = ['README.md', '.git', '.gitignore', 'LICENSE']
 
 /**
  * Create Octokit instance based on authentication
@@ -42,17 +19,23 @@ function createOctokitClient(githubToken?: string): Octokit {
 }
 
 /**
- * Check if a file is an image based on its extension
- * @param filename Filename to check
- * @returns Boolean indicating if file is an image
+ * Parse GitHub repository details from URL
+ * @param sourceUrl GitHub repository URL
+ * @returns Object with owner and repo
  */
-function isImage(filename: string): boolean {
-  const ext = path.extname(filename).toLowerCase()
-  return IMAGE_EXTENSIONS.includes(ext)
+function parseRepoDetails(sourceUrl: string): {owner: string; repo: string} {
+  const repoUrl = new URL(sourceUrl)
+  const [owner, repo] = repoUrl.pathname.split('/').filter(Boolean)
+
+  if (!owner || !repo) {
+    throw new Error('Invalid repository URL')
+  }
+
+  return {owner, repo}
 }
 
 /**
- * Download both markdowns or images
+ * Download both markdowns and images
  * @param octokit Octokit client
  * @param owner Repository owner
  * @param repo Repository name
@@ -76,8 +59,8 @@ async function downloadFile(
     // Decode file content (GitHub API returns base64 encoded content)
     const fileContent = Buffer.from(data.content, 'base64')
 
-    const localFilePath = path.join(articlesDir, item.path)
-    await fs.mkdir(path.dirname(localFilePath), {recursive: true})
+    const localFilePath = join(articlesDir, item.path)
+    await fs.mkdir(getDirname(localFilePath), {recursive: true})
 
     if (item.name.endsWith('.md')) {
       // For markdown files, convert to utf-8 string before writing
@@ -141,29 +124,15 @@ async function processRepoContents(
 
 /**
  * Pull articles and images from a GitHub repository
- * @param articlePath Destination path for articles
- * @param config Configuration options
  */
-async function pullArticles(
-  articlePath: string,
-  config?: {
-    githubToken?: string
-    sourceUrl?: string
-  }
-): Promise<void> {
+async function pullArticles(): Promise<void> {
   try {
-    const githubToken = config?.githubToken || process.env.GITHUB_TOKEN
-    const sourceUrl = config?.sourceUrl || process.env.SOURCE
+    const octokit = createOctokitClient(process.env.GITHUB_TOKEN)
+    const {owner, repo} = parseRepoDetails(process.env.SOURCE)
+    const articlesDir = resolvePath(process.cwd(), process.env.ARTICLE)
 
-    const octokit = createOctokitClient(githubToken)
-
-    const {owner, repo} = parseRepoDetails(sourceUrl)
-
-    const articlesDir = path.resolve(process.cwd(), articlePath)
     await fs.mkdir(articlesDir, {recursive: true})
-
     await processRepoContents(octokit, owner, repo, '', articlesDir)
-
     console.log('Article and image pull completed successfully')
   } catch (error) {
     console.error('Error pulling articles and images:', error)