Add a prompt for GitHub repo

Author: skirtles-code

src/index.ts

@@ -14,13 +14,18 @@ type Config = {
   targetDirName: string
   targetDirPath: string
   templateDirPath: string
+  githubPath: string
+  githubUrl: string
+  githubIssues: string
+  githubRepository: string
 }
 
 async function init() {
   const cwd = process.cwd()
 
   let result: {
     packageName?: string
+    githubPath?: string
   } = {}
 
   try {
@@ -31,6 +36,11 @@ async function init() {
           type: 'text',
           message: 'Package name',
           initial: '@skirtle/test-project'
+        }, {
+          name: 'githubPath',
+          type: 'text',
+          message: 'GitHub path, e.g. skirtles-code/test-project (optional)',
+          initial: ''
         }
       ],
       {
@@ -52,12 +62,23 @@ async function init() {
     process.exit(1)
   }
 
+  const githubPath = result.githubPath
+
+  if (githubPath && !/[\w-]+\/[\w-]+/.test(githubPath)) {
+    console.log('Invalid GitHub path: ' + githubPath)
+    process.exit(1)
+  }
+
   const unscopedPackageName = scopedPackageName.replace(/.*\//, '')
   const shortUnscopedPackageName = unscopedPackageName.replace(/^vue-/, '')
   const projectName = unscopedPackageName.replace(/-+/g, ' ').trim().split(' ').map(s => s[0].toUpperCase() + s.slice(1)).join(' ')
   const globalVariableName = projectName.replace(/ /g, '')
   const targetDirName = unscopedPackageName
 
+  const githubUrl = githubPath ? `https://github.com/${githubPath}` : ''
+  const githubIssues = githubPath ? `${githubUrl}/issues` : ''
+  const githubRepository = githubPath ? `git+${githubUrl}.git` : ''
+
   const targetDirPath = path.join(cwd, targetDirName)
 
   if (fs.existsSync(targetDirPath)) {
@@ -77,7 +98,11 @@ async function init() {
     globalVariableName,
     targetDirName,
     targetDirPath,
-    templateDirPath
+    templateDirPath,
+    githubPath,
+    githubUrl,
+    githubIssues,
+    githubRepository
   }
 
   copyTemplate('base', config)
@@ -134,6 +159,9 @@ function copyFiles(templateFile: string, config: Config) {
       .replace(/@unscopedPackageName@/g, config.unscopedPackageName)
       .replace(/@globalVariableName@/g, config.globalVariableName)
       .replace(/@scopedPackageName@/g, config.scopedPackageName)
+      .replace(/@githubUrl@/g, config.githubUrl)
+      .replace(/@githubIssues@/g, config.githubIssues)
+      .replace(/@githubRepository@/g, config.githubRepository)
 
     fs.writeFileSync(targetPath, content)
   } else {

src/template/base/packages/@projectName@/package.json

@@ -6,9 +6,12 @@
   "license": "",
   "description": "",
   "keywords": [],
-  "homepage": "",
-  "bugs": "",
-  "repository": "",
+  "homepage": "@githubUrl@",
+  "bugs": "@githubIssues@",
+  "repository": {
+    "type": "git",
+    "url": "@githubRepository@"
+  },
   "sideEffects": false,
   "main": "dist/@[email protected]",
   "module": "dist/@[email protected]",

src/template/base/packages/docs/.vitepress/config.mts

@@ -55,9 +55,9 @@ export default ({ mode }: { mode: string }) => defineConfigWithTheme({
       { text: 'Guide', link: '/introduction' }
     ],
 
-    // socialLinks: [
-    //   { icon: 'github', link: 'https://github.com/' }
-    // ],
+    socialLinks: [
+      { icon: 'github', link: '@githubUrl@' }
+    ],
 
     sidebar: [
       {