@leo-h/create-nodejs-app 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Leonardo Henrique
+
+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,31 @@
+# @leo-h/create-nodejs-app
+
+![example](https://github.com/Leo-Henrique/create-nodejs-app/assets/72027449/c1d21542-293b-483d-a94b-3fb885a9e43e)
+
+Create a Node.js application with TypeScript with just one command and without worrying about environment or framework configurations. Dedicate your energy only to the business rules of your application.
+
+## Get started
+
+With NPM:
+
+```bash
+npm create @leo-h/nodejs-app
+```
+
+With Yarn:
+
+```bash
+yarn create @leo-h/nodejs-app
+```
+
+With PNPM:
+
+```bash
+pnpm create @leo-h/nodejs-app
+```
+
+## Features
+
+- **Fast**: All templates use [tsx](https://tsx.is/) to run Node.js with TypeScript and [unbuild](https://github.com/unjs/unbuild) to build the application. Both tools use [esbuild](https://esbuild.github.io/), an extremely fast packager also used by tools like [Vite](https://vitejs.dev/).
+
+- **Lint and code format**: All templates use [eslint](https://eslint.org/) to identify problems in the code and [prettier](https://prettier.io/) to ensure consistent code formatting. Both are integrated with [husky](https://typicode.github.io/husky/) and [lint-staged](https://github.com/lint-staged/lint-staged) to automatically run them before every commit you make with git.

package/dist/compose-app/copy-template.compose.js

@@ -0,0 +1 @@
+const index=require("../config/index.js"),promises=require("fs/promises"),path=require("path");async function copyTemplateCompose(o,s){const n=(e,r)=>{for(const t of r)if(path.basename(e)===t)return!0;return!1};await promises.cp(path.resolve(index.TEMPLATES_PATH,s),o,{recursive:!0,filter:e=>!n(e,["node_modules","pnpm-lock.yaml",".env","dist",".eslintcache"])})}exports.copyTemplateCompose=copyTemplateCompose;

package/dist/compose-app/replace-content-in-file.compose.js

@@ -0,0 +1 @@
+const promises=require("fs/promises");async function replaceContentInFileCompose(o,i){let e=await promises.readFile(o,"utf-8");for(const[t,n]of i)e=e.replaceAll(t,n);await promises.writeFile(o,e)}exports.replaceContentInFileCompose=replaceContentInFileCompose;

package/dist/config/index.js

@@ -0,0 +1 @@
+const path=require("path"),t=path.basename(path.resolve(__dirname,".."));t==="dist"?process.env.NODE_ENV="production":process.env.NODE_ENV="development";const o=path.resolve(__dirname,"../.."),GENERATED_APP_ROOT_PATH=process.env.NODE_ENV==="production"?process.cwd():path.resolve(o,"generated-apps"),TEMPLATES_PATH=path.resolve(o,"templates");path.resolve(TEMPLATES_PATH,"clean");exports.GENERATED_APP_ROOT_PATH=GENERATED_APP_ROOT_PATH;exports.TEMPLATES_PATH=TEMPLATES_PATH;

package/dist/index.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+const index=require("./config/index.js"),logs=require("./utils/logs.js"),onCancel=require("./utils/on-cancel.js"),fs=require("fs"),promises=require("fs/promises"),path=require("path"),picocolors=require("picocolors"),y=require("prompts"),copyTemplate_compose=require("./compose-app/copy-template.compose.js"),replaceContentInFile_compose=require("./compose-app/replace-content-in-file.compose.js"),packageName_validation=require("./validations/package-name.validation.js"),d=e=>(a,t)=>t.template==="api"?e:null,v=[{type:"text",name:"projectName",message:"What is your project name?",validate:async e=>(await promises.readdir(index.GENERATED_APP_ROOT_PATH)).includes(e)?"Already exists a folder with same name in current directory.":packageName_validation.packageNameValidation(e)},{type:"select",name:"packageManager",message:"What is your favorite package manager?",choices:[{title:"NPM",value:"npm"},{title:"Yarn",value:"yarn"},{title:"PNPM",value:"pnpm"}],initial:2},{type:"select",name:"template",message:"Select your template:",choices:[{title:"Clean",value:"clean"},{title:"API",value:"api"}]},{type:d("select"),name:"framework",message:"What is your favorite framework:",choices:[{title:"Fastify",value:"fastify"},{title:"Nest",value:"nest",disabled:!0},{title:"tRPC",value:"trpc",disabled:!0}],initial:0}];(async()=>{process.env.NODE_ENV==="development"&&!fs.existsSync(index.GENERATED_APP_ROOT_PATH)&&await promises.mkdir(index.GENERATED_APP_ROOT_PATH,{recursive:!0});const e=await y(v,{onCancel:onCancel.onCancelPrompt}),a=path.resolve(index.GENERATED_APP_ROOT_PATH,e.projectName);await copyTemplate_compose.copyTemplateCompose(a,e.framework?e.framework:"clean");const t=path.resolve(a,"package.json"),o=path.resolve(a,".env.example"),s=path.resolve(a,".husky/pre-commit");await Promise.all([replaceContentInFile_compose.replaceContentInFileCompose(t,[["app-name",e.projectName]]),replaceContentInFile_compose.replaceContentInFileCompose(o,[["app-name",e.projectName]]),replaceContentInFile_compose.replaceContentInFileCompose(s,[["pnpm",e.packageManager]])]),logs.successLog(`Success in creating new app ${picocolors.cyan(e.projectName)}!`,`> ${a}`)})();

package/dist/utils/logs.js

@@ -0,0 +1 @@
+const picocolors=require("picocolors");function successLog(o,...r){console.log(`${picocolors.green("\u2714")} ${o}`);for(const c of r)console.log(c)}function errorLog(o,...r){console.log(`${picocolors.red("\u2716")} ${o}`);for(const c of r)console.log(c)}exports.errorLog=errorLog;exports.successLog=successLog;

package/dist/utils/on-cancel.js

@@ -0,0 +1 @@
+const logs=require("./logs.js");function onCancelPrompt(){logs.errorLog("Script canceled."),process.exit(1)}exports.onCancelPrompt=onCancelPrompt;

package/dist/utils/to-pascal-case.js

@@ -0,0 +1 @@
+function toPascalCase(a){return a[0].toUpperCase()+a.slice(1)}exports.toPascalCase=toPascalCase;

package/dist/validations/package-name.validation.js

@@ -0,0 +1 @@
+const toPascalCase=require("../utils/to-pascal-case.js"),e=require("validate-npm-package-name");function packageNameValidation(s){const a=e(s);return a.validForNewPackages?!0:toPascalCase.toPascalCase(a.errors[0])}exports.packageNameValidation=packageNameValidation;

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@leo-h/create-nodejs-app",
+  "version": "1.0.0",
+  "packageManager": "pnpm@9.1.1",
+  "author": "Leonardo Henrique <leonardo0507.business@gmail.com>",
+  "description": "Create a modern Node.js app with TypeScript using one command.",
+  "license": "MIT",
+  "keywords": [
+    "node",
+    "node.js",
+    "typescript"
+  ],
+  "bin": {
+    "create-nodejs-app": "./dist/index.js"
+  },
+  "files": [
+    "./dist",
+    "./templates"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Leo-Henrique/create-nodejs-app"
+  },
+  "scripts": {
+    "prepare": "husky",
+    "start": "node ./dist/index.js",
+    "start:dev": "tsx ./src/index.ts",
+    "start:dev:watch": "tsx watch ./src/index.ts",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint . --ext .ts --max-warnings 0 --cache",
+    "lint:fix": "pnpm lint --fix",
+    "format": "prettier . --write --cache",
+    "test:unit": "vitest run",
+    "test:unit:watch": "vitest",
+    "test:coverage": "vitest run --coverage.enabled=true --coverage.all=false",
+    "template:create": "tsx ./scripts/create-template.script.ts",
+    "template:open": "tsx ./scripts/open-template.script.ts",
+    "prebuild": "rimraf ./dist",
+    "build": "unbuild",
+    "prepublishOnly": "pnpm build"
+  },
+  "dependencies": {
+    "commander": "12.1.0",
+    "picocolors": "1.0.1",
+    "prompts": "2.4.2",
+    "validate-npm-package-name": "5.0.1",
+    "zod": "3.23.8"
+  },
+  "devDependencies": {
+    "@faker-js/faker": "8.4.1",
+    "@types/node": "20.12.12",
+    "@types/prompts": "2.4.9",
+    "@types/validate-npm-package-name": "4.0.2",
+    "@typescript-eslint/eslint-plugin": "7.10.0",
+    "@typescript-eslint/parser": "7.10.0",
+    "conventional-changelog-conventionalcommits": "8.0.0",
+    "eslint": "8.57.0",
+    "eslint-config-prettier": "9.1.0",
+    "eslint-plugin-vitest": "0.4.0",
+    "husky": "9.0.11",
+    "lint-staged": "15.2.2",
+    "npm-run-all": "4.1.5",
+    "prettier": "3.2.5",
+    "rimraf": "5.0.7",
+    "tsx": "4.10.5",
+    "typescript": "5.4.5",
+    "unbuild": "2.0.0",
+    "vite-tsconfig-paths": "4.3.2",
+    "vitest": "1.6.0"
+  }
+}

package/templates/clean/.env.example

@@ -0,0 +1,5 @@
+# example: "development" ("development" | "test" | "production")
+NODE_ENV=
+
+# example: "app-name"
+APP_NAME=

package/templates/clean/.eslintignore

@@ -0,0 +1,2 @@
+node_modules
+dist

package/templates/clean/.eslintrc.json

@@ -0,0 +1,22 @@
+{
+  "root": true,
+  "env": {
+    "es2021": true,
+    "node": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier",
+    "plugin:vitest/recommended"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  },
+  "plugins": ["@typescript-eslint"],
+  "rules": {
+    "@typescript-eslint/no-unused-vars": "warn"
+  }
+}

package/templates/clean/.husky/pre-commit

@@ -0,0 +1 @@
+pnpm lint-staged

package/templates/clean/.lintstagedrc.json

@@ -0,0 +1,4 @@
+{
+  "*.{ts,json,yaml,yml,md}": "prettier --write --cache",
+  "*.ts": ["eslint --max-warnings 0 --fix --cache"]
+}

package/templates/clean/.prettierignore

@@ -0,0 +1,7 @@
+node_modules
+package-lock.json
+yarn.lock
+pnpm-lock.yaml
+.husky
+coverage
+dist

package/templates/clean/.prettierrc.json

@@ -0,0 +1,6 @@
+{
+  "arrowParens": "avoid",
+  "semi": true,
+  "singleQuote": false,
+  "tabWidth": 2
+}

package/templates/clean/.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+  "editor.formatOnSave": true,
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.codeActionsOnSave": {
+    "source.organizeImports": "explicit",
+    "source.fixAll.eslint": "explicit"
+  }
+}

package/templates/clean/build.config.ts

@@ -0,0 +1,55 @@
+import { readdirSync } from "fs";
+import { resolve } from "path";
+import { BuildOptions, defineBuildConfig } from "unbuild";
+import packageJson from "./package.json";
+import { compilerOptions } from "./tsconfig.json";
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+const getAllFiles = (path: string) => {
+  return readdirSync(path, {
+    recursive: true,
+    encoding: "utf-8",
+  })
+    .filter(reading => reading.endsWith(".ts"))
+    .map(filename => `${path}/${filename}`);
+};
+
+const pathAliases = Object.keys(compilerOptions.paths).reduce(
+  (resolvedAliases, alias) => {
+    const unbuildAlias = alias.replace("/*", "");
+    const unbuildPath = compilerOptions.paths[
+      alias as keyof typeof compilerOptions.paths
+    ][0].replace("/*", "");
+
+    resolvedAliases[unbuildAlias] = resolve(
+      compilerOptions.baseUrl,
+      unbuildPath,
+    );
+
+    return resolvedAliases;
+  },
+  {} as BuildOptions["alias"],
+);
+
+export default defineBuildConfig({
+  outDir: "./dist",
+  entries: ["./src/index.ts"],
+  clean: true,
+  alias: pathAliases,
+  externals: Object.keys(packageJson.dependencies),
+  rollup: {
+    emitCJS: true,
+    cjsBridge: true,
+    inlineDependencies: true,
+    output: {
+      format: "cjs",
+      entryFileNames: "[name].js",
+      preserveModules: true,
+      strict: false,
+    },
+    esbuild: {
+      minifySyntax: true,
+      treeShaking: true,
+    },
+  },
+});

package/templates/clean/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "app-name",
+  "version": "1.0.0",
+  "private": true,
+  "scripts": {
+    "prepare": "husky",
+    "start": "node ./dist/index.js",
+    "start:dev": "tsx watch ./src/index.ts",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint . --ext .ts --max-warnings 0 --cache",
+    "lint:fix": "pnpm lint --fix",
+    "format": "prettier . --write --cache",
+    "test:unit": "vitest run",
+    "test:unit:watch": "vitest",
+    "test:coverage": "vitest run --coverage.enabled=true --coverage.all=false",
+    "prebuild": "rimraf ./dist",
+    "build": "unbuild"
+  },
+  "dependencies": {
+    "dotenv": "16.4.5",
+    "zod": "3.23.8"
+  },
+  "devDependencies": {
+    "@faker-js/faker": "8.4.1",
+    "@types/node": "20.12.12",
+    "@typescript-eslint/eslint-plugin": "7.10.0",
+    "@typescript-eslint/parser": "7.10.0",
+    "eslint": "8.57.0",
+    "eslint-config-prettier": "9.1.0",
+    "eslint-plugin-vitest": "0.4.0",
+    "husky": "9.0.11",
+    "lint-staged": "15.2.5",
+    "prettier": "3.2.5",
+    "rimraf": "5.0.7",
+    "tsx": "4.11.0",
+    "typescript": "5.4.5",
+    "unbuild": "2.0.0",
+    "vite-tsconfig-paths": "4.3.2",
+    "vitest": "1.6.0"
+  }
+}