CLI: Generate .gitignore file by default

fuma-nama · Aug 15, 2023 · 3b0f469 · 3b0f469
1 parent f5c4761
commit 3b0f469
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 74 deletions.
diff --git a/.changeset/cold-phones-applaud.md b/.changeset/cold-phones-applaud.md
@@ -0,0 +1,5 @@
+---
+'create-next-docs-app': patch
+---
+
+Generate .gitignore file by default
diff --git a/examples/advanced/.gitignore b/examples/advanced/.gitignore
diff --git a/examples/simple/.gitignore b/examples/simple/.gitignore
diff --git a/packages/create-next-docs/index.ts b/packages/create-next-docs/index.ts
@@ -69,6 +69,9 @@ async function main() {
   info.message('Updating README.md')
   generateReadme(path.join(dest, 'README.md'), name)
 
+  info.message('Adding .gitignore')
+  generateGitIgnore(path.join(dest, '.gitignore'))
+
   info.stop('Project Generated')
 
   outro(color.bgGreen(color.bold('Done')))
@@ -134,6 +137,34 @@ function generateReadme(path: string, projectName: string) {
   fs.writeFileSync(path, content)
 }
 
+function generateGitIgnore(path: string) {
+  const ignores = [
+    // deps
+    '/node_modules',
+    '/.pnp',
+    '.pnp.js',
+    // outputs
+    '.contentlayer',
+    '/coverage',
+    '/.next/',
+    '/out/',
+    '/build',
+    '.DS_Store',
+    '*.pem',
+    // debug logs
+    'npm-debug.log*',
+    'yarn-debug.log*',
+    'yarn-error.log*',
+
+    '.env*.local',
+    '.vercel',
+    '*.tsbuildinfo',
+    'next-env.d.ts'
+  ]
+
+  fs.writeFileSync(path, ignores.join('\n'))
+}
+
 function copy(
   from: string,
   to: string,