inikit 1.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ajaykumar Nadar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,23 @@
+# Inikit
+
+Inikit is a Node.js project designed to streamline your development workflow.
+
+## Features
+
+- Modular and scalable architecture
+- Easy setup and configuration
+- Built with modern JavaScript
+
+## Getting Started
+
+```sh
+npx inikit@latest
+```
+
+## Contributing
+
+Contributions are welcome! Please open issues or submit pull requests.
+
+## License
+
+This project is licensed under the MIT License.

package/dist/index.js

@@ -0,0 +1,101 @@
+#!/usr/bin/env node
+import * as p from '@clack/prompts';
+import { chalkStderr } from 'chalk';
+import { titleCase, addCommitlint, addGit, addPrettier, createNextApp, } from './utils.js';
+import path from 'node:path';
+import packageJSON from './package.json' with { type: 'json' };
+const { cyan, green, yellow } = chalkStderr;
+const response = async () => await p.group({
+    projectName: () => {
+        p.log.info(`Welcome to ${green(titleCase(packageJSON.name) + ' v' + packageJSON.version)}\n- ${packageJSON.author.name} (${packageJSON.author.username})`);
+        return p.text({
+            message: `Enter the ${cyan('project name')}`,
+            placeholder: 'my-app',
+            defaultValue: 'my-app',
+            validate(input) {
+                if (input) {
+                    if (input.includes(' '))
+                        return 'Project name cannot contain spaces';
+                    if (input.toLowerCase() !== input)
+                        return 'Project name must be lowercase';
+                    if (input.startsWith('./'))
+                        return 'Project name cannot start with "./"';
+                    if (/[^a-zA-Z0-9-_]/.test(input))
+                        return 'Project name can only contain letters, numbers, dashes, and underscores';
+                }
+            },
+        });
+    },
+    framework: () => p.select({
+        message: `Select a ${cyan('framework')}`,
+        options: [
+            { value: 'next', label: 'Next.js', hint: 'recommended' },
+            // { value: 'react', label: 'React' },
+        ],
+    }),
+    typeScript: () => p.confirm({
+        message: `Do you want to use ${cyan('TypeScript?')}`,
+        initialValue: true, // Yes
+    }),
+    devTools: () => {
+        p.note('Press space to select/deselect, enter to confirm\nYou can select multiple options');
+        return p.multiselect({
+            message: `Select ${cyan('dev tools')}`,
+            options: [
+                { value: 'eslint', label: 'ESLint' },
+                { value: 'prettier', label: 'Prettier' },
+                {
+                    value: 'commitlint',
+                    label: 'Husky',
+                    hint: 'commitlint + husky + lint-staged',
+                },
+            ],
+            initialValues: ['eslint', 'prettier', 'commitlint'],
+        });
+    },
+    // libraries: () =>
+    // 	p.multiselect({
+    // 		message: `Select ${cyan('libraries')}`,
+    // 		options: [
+    // 			{ value: 'shadcn', label: 'Shadcn/ui' },
+    // 			{ value: 'prisma', label: 'Prisma' },
+    // 			{ value: 'authjs', label: 'Auth.js' },
+    // 		],
+    // 	}),
+}, {
+    // On Cancel callback that wraps the group
+    // So if the user cancels one of the prompts in the group this function will be called
+    onCancel: () => {
+        p.cancel('Operation cancelled.');
+        process.exit(0);
+    },
+});
+response()
+    .then(async (res) => {
+    const { projectName, typeScript, devTools } = res;
+    const projectPath = path.resolve(process.cwd(), projectName);
+    const nextSpinner = p.spinner();
+    nextSpinner.start(`Creating a new Next.js app in ${yellow(projectPath)}`);
+    await createNextApp(projectName, typeScript, devTools.includes('eslint'));
+    nextSpinner.stop(`Created ${projectName} at ${projectPath}`);
+    if (devTools.includes('prettier')) {
+        const prettierSpinner = p.spinner();
+        prettierSpinner.start(`Adding prettier to the project`);
+        await addPrettier(projectPath);
+        prettierSpinner.stop(`Added prettier configuration`);
+    }
+    await addGit(projectPath);
+    if (devTools.includes('commitlint')) {
+        const commitlintSpinner = p.spinner();
+        commitlintSpinner.start(`Adding husky and commitlint to the project`);
+        await addCommitlint(projectPath);
+        commitlintSpinner.stop(`Added husky and commitlint configuration`);
+    }
+    p.outro(green('Project initialized successfully!'));
+    process.exit(0);
+})
+    .catch(err => {
+    console.error(err);
+    p.outro('An error occurred: ' + err.message);
+    process.exit(1);
+});

package/dist/package.json

@@ -0,0 +1,60 @@
+{
+    "name": "inikit",
+    "version": "1.1.0",
+    "description": "Inikit is a CLI tool that scaffolds modern Next.js projects with integrated support for TypeScript, ESLint, Prettier, and commitlint to enforce a robust development workflow.",
+    "main": "./dist/index.js",
+    "scripts": {
+        "test": "echo \"Error: no test specified\" && exit 1",
+        "build": "npx eslint . && npm run clean && tsc && cp -r templates dist/templates",
+        "clean": "rm -rf dist",
+        "dev": "tsx index.ts",
+        "prepare": "husky",
+        "deploy": "npm run build && npm publish --access public"
+    },
+    "bin": {
+        "inikit": "./dist/index.js"
+    },
+    "files": [
+        "dist"
+    ],
+    "keywords": [
+        "inikit",
+        "cli",
+        "nextjs",
+        "typescript",
+        "eslint",
+        "prettier",
+        "commitlint",
+        "scaffold",
+        "development",
+        "tools"
+    ],
+    "author": {
+        "username": "ajaykumarn3000",
+        "url": "https://ajaykumarn3000.github.io",
+        "name": "Ajaykumar Nadar",
+        "email": "ajaykumarn3000@gmail.com"
+    },
+    "license": "MIT",
+    "type": "module",
+    "devDependencies": {
+        "@commitlint/cli": "^19.8.1",
+        "@commitlint/config-conventional": "^19.8.1",
+        "@eslint/js": "^9.27.0",
+        "@eslint/json": "^0.12.0",
+        "@eslint/markdown": "^6.4.0",
+        "@types/node": "^22.15.21",
+        "eslint": "^9.27.0",
+        "globals": "^16.2.0",
+        "husky": "^9.1.7",
+        "prettier": "^3.5.3",
+        "typescript": "^5.8.3",
+        "typescript-eslint": "^8.32.1"
+    },
+    "dependencies": {
+        "@clack/prompts": "^0.11.0",
+        "chalk": "^5.4.1",
+        "execa": "^9.5.3",
+        "tsx": "^4.19.4"
+    }
+}

package/dist/templates/commitlint/commitlint.config.js

@@ -0,0 +1,26 @@
+const config = {
+	extends: ['@commitlint/config-conventional'],
+	rules: {
+		'header-max-length': [2, 'always', 100], // Enforce a 100-character limit for commit messages
+		'type-enum': [
+			2,
+			'always',
+			[
+				'feat',
+				'fix',
+				'docs',
+				'style',
+				'refactor',
+				'perf',
+				'test',
+				'build',
+				'ci',
+				'chore',
+				'revert',
+			],
+		],
+	},
+};
+
+// eslint-disable-next-line no-undef
+module.exports = config;

package/dist/templates/husky/commit-msg

@@ -0,0 +1 @@
+npx commitlint --edit $1

package/dist/templates/husky/pre-commit

@@ -0,0 +1,2 @@
+npm run lint
+npx prettier . --write

package/dist/templates/prettier/.prettierignore

@@ -0,0 +1,5 @@
+node_modules
+public
+build
+.prettierignore
+.prettierrc

package/dist/templates/prettier/.prettierrc

@@ -0,0 +1,16 @@
+{
+	"arrowParens": "avoid",
+	"bracketSpacing": true,
+	"endOfLine": "lf",
+	"bracketSameLine": true,
+	"cursorOffset": -1,
+	"printWidth": 80,
+	"plugins": ["prettier-plugin-tailwindcss"],
+	"proseWrap": "always",
+	"jsxSingleQuote": true,
+	"trailingComma": "es5",
+	"tabWidth": 2,
+	"semi": true,
+	"singleQuote": true,
+	"useTabs": true
+}

package/dist/utils.js

@@ -0,0 +1,51 @@
+import { $ } from 'execa';
+import { copyFileSync, existsSync, cpSync } from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'url';
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const templateDir = path.join(__dirname, 'templates');
+export const titleCase = (str) => {
+    return str
+        .split(' ')
+        .map(word => word.charAt(0).toUpperCase() + word.slice(1))
+        .join(' ');
+};
+export const createNextApp = async (appName, typeScript, eslint) => {
+    const { stdout } = await $({
+        cwd: process.cwd(),
+    }) `npx create-next-app@latest ${appName} ${typeScript ? '--ts' : '--js'} ${eslint ? '--eslint' : '--no-eslint'} --app --turbopack --use-npm --yes --disable-git`;
+    return stdout;
+};
+export const addPrettier = async (appPath) => {
+    await $({
+        cwd: appPath,
+    }) `npm install -D prettier prettier-plugin-tailwindcss`;
+    cpSync(path.join(templateDir, 'prettier'), path.resolve(appPath), {
+        force: true,
+        recursive: true,
+    });
+};
+export const addGit = async (appPath) => {
+    if (existsSync(path.resolve(appPath, '.git'))) {
+        return 'Git already initialized';
+    }
+    await $({
+        cwd: appPath,
+    }) `git init`;
+};
+export const addCommitlint = async (appPath) => {
+    await $({
+        cwd: appPath,
+    }) `npm install -D husky @commitlint/config-conventional @commitlint/cli`;
+    await $({
+        cwd: appPath,
+    }) `npx husky init`;
+    cpSync(path.join(templateDir, 'husky'), path.resolve(appPath, '.husky'), {
+        force: true,
+        recursive: true,
+    });
+    copyFileSync(path.join(templateDir, 'commitlint', 'commitlint.config.js'), path.resolve(appPath, 'commitlint.config.js'));
+    await $({
+        cwd: appPath,
+    }) `npm run prepare`;
+};

package/package.json

@@ -0,0 +1,60 @@
+{
+	"name": "inikit",
+	"version": "1.1.0",
+	"description": "Inikit is a CLI tool that scaffolds modern Next.js projects with integrated support for TypeScript, ESLint, Prettier, and commitlint to enforce a robust development workflow.",
+	"main": "./dist/index.js",
+	"scripts": {
+		"test": "echo \"Error: no test specified\" && exit 1",
+		"build": "npx eslint . && npm run clean && tsc && cp -r templates dist/templates",
+		"clean": "rm -rf dist",
+		"dev": "tsx index.ts",
+		"prepare": "husky",
+		"deploy": "npm run build && npm publish --access public"
+	},
+	"bin": {
+		"inikit": "./dist/index.js"
+	},
+	"files": [
+		"dist"
+	],
+	"keywords": [
+		"inikit",
+		"cli",
+		"nextjs",
+		"typescript",
+		"eslint",
+		"prettier",
+		"commitlint",
+		"scaffold",
+		"development",
+		"tools"
+	],
+	"author": {
+		"username": "ajaykumarn3000",
+		"url": "https://ajaykumarn3000.github.io",
+		"name": "Ajaykumar Nadar",
+		"email": "ajaykumarn3000@gmail.com"
+	},
+	"license": "MIT",
+	"type": "module",
+	"devDependencies": {
+		"@commitlint/cli": "^19.8.1",
+		"@commitlint/config-conventional": "^19.8.1",
+		"@eslint/js": "^9.27.0",
+		"@eslint/json": "^0.12.0",
+		"@eslint/markdown": "^6.4.0",
+		"@types/node": "^22.15.21",
+		"eslint": "^9.27.0",
+		"globals": "^16.2.0",
+		"husky": "^9.1.7",
+		"prettier": "^3.5.3",
+		"typescript": "^5.8.3",
+		"typescript-eslint": "^8.32.1"
+	},
+	"dependencies": {
+		"@clack/prompts": "^0.11.0",
+		"chalk": "^5.4.1",
+		"execa": "^9.5.3",
+		"tsx": "^4.19.4"
+	}
+}