feat: add starter-nextjs to templates

Author: ymehmetcan

.changeset/gentle-zebras-pick.md

@@ -1,5 +1,7 @@
 ---
-'@commencis/cli': minor
+'@commencis/cli': major
 ---
 
 feat: update starter-react-vite to v2.10.0
+
+feat: add starter-nextjs to templates

package.json

@@ -69,6 +69,7 @@
     "typescript": "5.9.3"
   },
   "templateDependencies": {
+    "@commencis/starter-nextjs": "1.0.0",
     "@commencis/starter-react-vite": "2.10.0",
     "@commencis/template-markdown": "1.0.0"
   }

src/config/template.config.ts

@@ -4,11 +4,34 @@ type TemplateConfig = {
   name: string;
   url: string;
   filesToRemove?: string[];
+  scriptsToRemove?: string[];
+  dependenciesToRemove?: string[];
+  devDependenciesToRemove?: string[];
   path?: string;
 };
 export type TemplateData = TemplateConfig & { version: string };
 
 export const templateConfigMap = {
+  nextjs: {
+    name: '@commencis/starter-nextjs',
+    url: 'https://github.com/Commencis/starter-nextjs.git',
+    filesToRemove: [
+      '.git/',
+      '.github/',
+      '.changeset/',
+      'assets/',
+      'CHANGELOG.md',
+      'README.md',
+      'LICENSE',
+      'renovate.json',
+    ],
+    scriptsToRemove: ['changeset', 'changeset:version'],
+    dependenciesToRemove: [],
+    devDependenciesToRemove: [
+      '@changesets/cli',
+      '@svitejs/changesets-changelog-github-compact',
+    ],
+  },
   'react-vite': {
     name: '@commencis/starter-react-vite',
     url: 'https://github.com/Commencis/starter-react-vite.git',
@@ -22,6 +45,12 @@ export const templateConfigMap = {
       'LICENSE',
       'renovate.json',
     ],
+    scriptsToRemove: ['changeset', 'version'],
+    dependenciesToRemove: [],
+    devDependenciesToRemove: [
+      '@changesets/cli',
+      '@svitejs/changesets-changelog-github-compact',
+    ],
   },
   'template-markdown': {
     name: '@commencis/template-markdown',

src/helpers/setupTemplate.ts

@@ -19,7 +19,15 @@ export async function setupTemplate(
   projectName: string,
   targetPath: string = process.cwd()
 ): Promise<void> {
-  const { name, url, version, filesToRemove } = getTemplateDataById(templateId);
+  const {
+    name,
+    url,
+    version,
+    filesToRemove,
+    scriptsToRemove,
+    dependenciesToRemove,
+    devDependenciesToRemove,
+  } = getTemplateDataById(templateId);
   const {
     name: mdExtensionName,
     url: mdExtensionUrl,
@@ -69,7 +77,13 @@ export async function setupTemplate(
     await fs.writeFile(path.join(tempDir, 'README.md'), readmeMd);
 
     // Update package.json
-    const { templateVersion } = await updatePackageData(tempDir, projectName);
+    const { templateVersion } = await updatePackageData({
+      directoryPath: tempDir,
+      projectName,
+      scriptsToRemove,
+      dependenciesToRemove,
+      devDependenciesToRemove,
+    });
 
     // Copy files to the target directory
     await fs.cp(tempDir, targetDir, { recursive: true, force: true });

src/helpers/updatePackageData.ts

@@ -2,11 +2,25 @@ import fs from 'node:fs/promises';
 import path from 'node:path';
 
 import { PACKAGE_DEFAULTS } from '@/constants';
+import { omitKeys } from '@/utils/omitKeys';
 
-export async function updatePackageData(
-  directoryPath: string,
-  projectName: string
-): Promise<{ templateVersion: string }> {
+type UpdatePackageDataArgs = {
+  directoryPath: string;
+  projectName: string;
+  scriptsToRemove?: string[];
+  dependenciesToRemove?: string[];
+  devDependenciesToRemove?: string[];
+};
+
+export async function updatePackageData({
+  directoryPath,
+  projectName,
+  scriptsToRemove,
+  dependenciesToRemove,
+  devDependenciesToRemove,
+}: UpdatePackageDataArgs): Promise<{
+  templateVersion: string;
+}> {
   try {
     const packageJsonPath = path.join(directoryPath, 'package.json');
     const packageJsonData = await fs.readFile(packageJsonPath, 'utf-8');
@@ -18,15 +32,28 @@ export async function updatePackageData(
       author: _author,
       version: templateVersion,
       build,
+      scripts,
+      dependencies,
+      devDependencies,
       ...originalPackageJsonData
     } = JSON.parse(packageJsonData);
 
+    const updatedScripts = omitKeys(scripts, scriptsToRemove);
+    const updatedDependencies = omitKeys(dependencies, dependenciesToRemove);
+    const updatedDevDependencies = omitKeys(
+      devDependencies,
+      devDependenciesToRemove
+    );
+
     const updatedPackageJson = {
       name: projectName,
       version: PACKAGE_DEFAULTS.version,
       build,
       license: PACKAGE_DEFAULTS.license,
       private: PACKAGE_DEFAULTS.private,
+      scripts: updatedScripts,
+      dependencies: updatedDependencies,
+      devDependencies: updatedDevDependencies,
       ...originalPackageJsonData,
     };
 

src/prompts/getSelectedTemplate.ts

@@ -8,6 +8,10 @@ export async function getSelectedTemplate(): Promise<TemplateId> {
     name: 'templateId',
     message: 'Choose a starter template for your project:',
     choices: [
+      {
+        message: 'Next.js',
+        name: 'nextjs',
+      },
       {
         message: 'React-Vite',
         name: 'react-vite',

src/types/template.types.ts

@@ -1,3 +1,3 @@
-export type TemplateId = 'react-vite';
+export type TemplateId = 'react-vite' | 'nextjs';
 
 export type ExtensionId = 'template-markdown';

src/utils/omitKeys.ts

@@ -0,0 +1,14 @@
+export function omitKeys<T extends Record<string, unknown>>(
+  obj: T | undefined,
+  keysToRemove: string[] | undefined
+): T | undefined {
+  if (!obj) {
+    return obj;
+  }
+  if (!keysToRemove?.length) {
+    return obj;
+  }
+  return Object.fromEntries(
+    Object.entries(obj).filter(([key]) => !keysToRemove.includes(key))
+  ) as T;
+}