@adbayb/create 0.14.0 → 1.0.0

package/README.md

@@ -4,15 +4,7 @@
 </div>
 <p></p>
 
-## Usage
+## 🚀 Usage
 
 -   `cd my-project-root-folder`
--   `npm init @adbayb --yes` or `npx @adbayb/create`
-
-## TODO
-
--   Github actions (integrate and release)
--   PNPM
--   @adbayb/scripts usage 
--   Monorepo by default with project_name, packages/*, examples/*, docs/, .config (?) folder
--   Renovatebot
+-   `npm init @adbayb`

package/bin/index.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+"use strict";var e=require("termost");e.helpers.exec("stack create",{hasLiveOutput:!0});
+//# sourceMappingURL=index.js.map

package/bin/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/index.ts"],
+  "sourcesContent": ["#!/usr/bin/env node\n\n/**\n * Package proxy using `@adbayb/stack` to benefit from NPM initializer `npm init @adbayb`\n * @see https://docs.npmjs.com/cli/v9/commands/npm-init\n */\nimport { helpers } from \"termost\";\n\nhelpers.exec(\"stack create\", { hasLiveOutput: true });\n"],
+  "mappings": ";aAMA,IAAAA,EAAwB,mBAExB,UAAQ,KAAK,eAAgB,CAAE,cAAe,EAAK,CAAC",
+  "names": ["import_termost"]
+}

package/package.json

@@ -1,32 +1,42 @@
 {
-	"name": "@adbayb/create",
-	"version": "0.14.0",
-	"publishConfig": {
-		"access": "public"
-	},
-	"description": "My opinionated scaffolding tool",
-	"bin": "cli/index.js",
-	"scripts": {
-		"start": "./cli/index.js"
-	},
-	"keywords": [
-		"setup",
-		"scaffolding",
-		"development"
-	],
-	"author": {
-		"name": "Ayoub Adib",
-		"email": "adbayb@gmail.com",
-		"url": "https://twitter.com/adbayb"
-	},
-	"repository": {
-		"type": "git",
-		"url": "https://github.com/adbayb/stack.git",
-		"directory": "packages/create"
-	},
-	"license": "MIT",
-	"dependencies": {
-		"ora": "5.4.1"
-	},
-	"gitHead": "7126c134205832bb8a4a2d2505c1cb631a711df9"
-}
+  "name": "@adbayb/create",
+  "version": "1.0.0",
+  "description": "My opinionated scaffolding tool",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "bin",
+    "templates"
+  ],
+  "bin": "bin/index.js",
+  "source": "src/index.ts",
+  "main": "bin/index.js",
+  "platform": "node",
+  "keywords": [
+    "setup",
+    "scaffolding",
+    "development"
+  ],
+  "author": {
+    "name": "Ayoub Adib",
+    "email": "adbayb@gmail.com",
+    "url": "https://twitter.com/adbayb"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/adbayb/stack.git",
+    "directory": "packages/create"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "@adbayb/stack": "^1.0.0",
+    "termost": "^0.9.0"
+  },
+  "scripts": {
+    "prestart": "pnpm build",
+    "start": "bin/index.js",
+    "build": "quickbundle build && chmod +x bin/index.js",
+    "watch": "quickbundle watch"
+  }
+}

package/CHANGELOG.md

@@ -1,90 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-# [0.14.0](https://github.com/adbayb/stack/compare/v0.13.0...v0.14.0) (2022-04-03)
-
-**Note:** Version bump only for package @adbayb/create
-
-
-
-
-
-# [0.13.0](https://github.com/adbayb/stack/compare/v0.12.0...v0.13.0) (2022-04-03)
-
-**Note:** Version bump only for package @adbayb/create
-
-
-
-
-
-# [0.12.0](https://github.com/adbayb/stack/compare/v0.11.0...v0.12.0) (2022-04-01)
-
-
-### Features
-
-* update dependencies ([4dcd403](https://github.com/adbayb/stack/commit/4dcd4039c0dac3596129db05657fa5a85deaceab))
-
-
-
-
-
-# [0.11.0](https://github.com/adbayb/stack/compare/v0.10.0...v0.11.0) (2022-03-31)
-
-
-### Features
-
-* **scripts:** use built-in package manager to resolve bin instead of yarn ([80a5fd4](https://github.com/adbayb/stack/commit/80a5fd4776b4f36ac6e583e289342bfe2474e22e))
-
-
-
-
-
-# [0.10.0](https://github.com/adbayb/stack/compare/v0.9.0...v0.10.0) (2021-11-25)
-
-### Features
-
--   **prettier-config:** make prettier a peer dependency ([7ff4fe8](https://github.com/adbayb/stack/commit/7ff4fe86438dbccfebe27ad71fabd2108e1b848e))
-
-# [0.9.0](https://github.com/adbayb/stack/compare/v0.8.0...v0.9.0) (2021-11-23)
-
-**Note:** Version bump only for package @adbayb/create
-
-# [0.8.0](https://github.com/adbayb/stack/compare/v0.7.0...v0.8.0) (2021-11-23)
-
-### Features
-
--   **create:** use husky v4 ([982c8be](https://github.com/adbayb/stack/commit/982c8bea835f1610d578175071b6d52e83cc8e92))
-
-# [0.7.0](https://github.com/adbayb/stack/compare/v0.6.1...v0.7.0) (2021-07-17)
-
-### Features
-
--   update dependencies ([6efb186](https://github.com/adbayb/stack/commit/6efb1864152fc7c1a2a697e0795fd2f104cfd09e))
-
-# [0.6.0](https://github.com/adbayb/stack/compare/v0.5.0...v0.6.0) (2021-04-05)
-
-### Features
-
--   **terminal-kit:** add library ([4c515b0](https://github.com/adbayb/stack/commit/4c515b0094beadf12d7169dc658a7de8917bfbde))
-
-# [0.5.0](https://github.com/adbayb/create/compare/v0.4.0...v0.5.0) (2021-04-03)
-
-### Bug Fixes
-
--   **eslint-config:** make padding rule compatible with import rule ([80ac540](https://github.com/adbayb/create/commit/80ac5402c6cb319d669d3af261d6b69b6bf49486))
-
-### Features
-
--   **create:** remove adbayb pkg from create ([885f3d0](https://github.com/adbayb/create/commit/885f3d09f99cfbfd84729331bf06c2de10eb2bfe))
--   **create:** switch from npm to yarn ([f0021a4](https://github.com/adbayb/create/commit/f0021a4241e04bdca823087a41bb3dac6b040309))
--   **scripts:** add clean command ([977e83f](https://github.com/adbayb/create/commit/977e83fc629a021b5b8f5d501ec363ecb5a5f4c2))
-
-# [0.4.0](https://github.com/adbayb/create/compare/v0.3.0...v0.4.0) (2021-03-27)
-
-**Note:** Version bump only for package @adbayb/create
-
-# 0.3.0 (2021-03-22)
-
-**Note:** Version bump only for package @adbayb/create

package/cli/constants.js

@@ -1,10 +0,0 @@
-const path = require("path");
-
-const PROJECT_FOLDER = process.cwd();
-const PACKAGE_FOLDER = path.resolve(__dirname, "../");
-const TEMPLATES_FOLDER = path.join(PACKAGE_FOLDER, "templates");
-
-module.exports = {
-	PROJECT_FOLDER,
-	TEMPLATES_FOLDER,
-};

package/cli/helpers.js

@@ -1,90 +0,0 @@
-const childProcess = require("child_process");
-const fs = require("fs");
-const path = require("path");
-const { PROJECT_FOLDER } = require("./constants");
-
-const fsPromises = fs.promises;
-const isObject = (value) => {
-	return value !== null && typeof value === "object";
-};
-
-const merge = (target, ...sources) => {
-	if (sources.length === 0) {
-		return target;
-	}
-
-	const source = sources[0];
-
-	for (const key in source) {
-		const sourceValue = source[key];
-		const targetValue = target[key];
-
-		if (isObject(sourceValue) && isObject(targetValue)) {
-			target[key] = merge(targetValue, sourceValue);
-		} else {
-			target[key] = sourceValue;
-		}
-	}
-
-	sources.shift();
-
-	return merge(target, ...sources);
-};
-
-const exec = (command) => {
-	return new Promise((resolve, reject) => {
-		childProcess.exec(
-			command,
-			{
-				cwd: PROJECT_FOLDER,
-				stdio: "pipe",
-			},
-			(error, stdout) => {
-				if (error) {
-					reject(error);
-				} else {
-					resolve(stdout.replace(/(\r?\n|\r)$/, ""));
-				}
-			}
-		);
-	});
-};
-
-const createLogger = () => {
-	const logs = [];
-
-	return {
-		log(message, level = "log") {
-			logs.push({ message, level });
-		},
-		flush() {
-			logs.forEach(({ message, level }) => console[level](message));
-		},
-	};
-};
-
-const logger = createLogger();
-const writeFileToProject = (baseName, content, checkIfExists) => {
-	if (checkIfExists) {
-		const destFileName = path.join(PROJECT_FOLDER, baseName);
-
-		if (fs.existsSync(destFileName)) {
-			logger.log(
-				`File ${baseName} already exists, please consider reviewing it manually`
-			);
-		}
-	}
-
-	return fsPromises.writeFile(
-		path.join(PROJECT_FOLDER, baseName),
-		content,
-		"utf-8"
-	);
-};
-
-module.exports = {
-	exec,
-	logger,
-	merge,
-	writeFileToProject,
-};

package/cli/index.js

@@ -1,151 +0,0 @@
-#!/usr/bin/env node
-
-const path = require("path");
-const fs = require("fs");
-const ora = require("ora");
-const { exec, merge, writeFileToProject, logger } = require("./helpers");
-const { PROJECT_FOLDER, TEMPLATES_FOLDER } = require("./constants");
-
-const fsPromises = fs.promises;
-
-const processPkg = async () => {
-	let rootPath = PROJECT_FOLDER;
-	let repositoryUrl = "";
-
-	try {
-		[repositoryUrl, rootPath] = await Promise.all([
-			exec("git remote get-url --push origin"),
-			exec("git rev-parse --show-toplevel"),
-		]);
-	} catch (error) {
-		// Nothing
-	}
-
-	const isMonorepo = rootPath !== PROJECT_FOLDER;
-	const directory = isMonorepo
-		? PROJECT_FOLDER.replace(new RegExp(`^${rootPath}/`), "")
-		: "";
-
-	let pkgConfig = {
-		author: {
-			name: "Ayoub Adib",
-			email: "adbayb@gmail.com",
-			url: "https://twitter.com/adbayb",
-		},
-		repository: {
-			type: "git",
-			url: repositoryUrl,
-			...(isMonorepo && { directory }),
-		},
-		license: "MIT",
-		scripts: {
-			verify: "yarn lint & tsc --noEmit",
-			fix: "yarn lint --fix",
-			lint: "eslint . --ignore-path .gitignore",
-			format: "prettier . --ignore-path .gitignore --ignore-path .prettierignore --write",
-		},
-		prettier: "@adbayb/prettier-config",
-		eslintConfig: {
-			...(isMonorepo && { root: true }), // https://eslint.org/docs/user-guide/configuring#configuration-cascading-and-hierarchy
-			extends: "@adbayb",
-		},
-		husky: {
-			hooks: {
-				"pre-commit": "lint-staged",
-			},
-		},
-		"lint-staged": {
-			"**/*.{js,jsx,ts,tsx}": ["yarn lint"],
-			"**/*.{json,md,mdx,html,css}": ["yarn format"],
-		},
-	};
-
-	const targetPkg = path.join(PROJECT_FOLDER, "package.json");
-
-	if (fs.existsSync(targetPkg)) {
-		pkgConfig = merge(require(targetPkg), pkgConfig);
-	}
-
-	return writeFileToProject(
-		"package.json",
-		JSON.stringify(pkgConfig, null, 2)
-	);
-};
-
-const copyTemplates = async () => {
-	const files = await fsPromises.readdir(TEMPLATES_FOLDER);
-
-	return Promise.all(
-		files.map(async (sourceFileName) => {
-			return new Promise((resolve, reject) => {
-				// @note: we suffix all templates with `.tmpl` to avoid npm publish postprocessing
-				// By default, .gitignore and .npmrc are excluded and using "files" package.json field
-				// solves the issue partially since npm post-transform by renaming .gitignore to .npmignore
-				const destinationFileName = path.parse(sourceFileName).name;
-
-				fs.copyFile(
-					path.join(TEMPLATES_FOLDER, sourceFileName),
-					path.join(PROJECT_FOLDER, destinationFileName),
-					(error) => {
-						if (error) {
-							reject(error.toString());
-						} else {
-							resolve();
-						}
-					}
-				);
-			});
-		})
-	);
-};
-
-const install = async () => {
-	await exec("yarn add typescript@latest --dev");
-	await exec("yarn add eslint@latest --dev");
-	await exec("yarn add prettier@latest --dev");
-	await exec("yarn add @adbayb/eslint-config@latest --dev");
-	await exec("yarn add @adbayb/prettier-config@latest --dev");
-	await exec("yarn add @adbayb/ts-config@latest --dev");
-	await exec("yarn add @adbayb/create@latest --dev"); // @todo: replace with @adbayb/scripts once ready (scripts should hoist the husky and other core dev packages)
-};
-
-const clean = async () => {
-	try {
-		await exec("yarn lint");
-		await exec("yarn format");
-	} catch (error) {
-		// @note: encapsulate lint/format logic to be error tolerant in case of new project without any files
-	}
-};
-
-const run = async () => {
-	const spinner = ora().start();
-	const runStep = async (message, asyncFunction) => {
-		try {
-			spinner.start();
-			spinner.text = message;
-			await asyncFunction();
-			spinner.succeed();
-		} catch (error) {
-			spinner.fail();
-
-			throw error;
-		}
-	};
-
-	await runStep("Apply templates", copyTemplates);
-	await runStep("Process `package.json`", processPkg);
-	await runStep("Install dependencies", install);
-	await runStep("Verify and clean project with 🦦 standards", clean);
-	spinner.stop();
-	logger.flush();
-};
-
-// @todo: future version => add possibility to specifiy language source (typescript / javascript / ...) via cli args ?
-try {
-	run();
-} catch (error) {
-	logger.log(error.toString(), "error");
-	logger.flush();
-	process.exit(1);
-}

package/templates/.editorconfig.tmpl

@@ -1,4 +0,0 @@
-root = true
-
-[*]
-indent_size = 4

package/templates/.gitignore.tmpl

@@ -1,116 +0,0 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-lerna-debug.log*
-
-# Diagnostic reports (https://nodejs.org/api/report.html)
-report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-*.lcov
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
-node_modules/
-jspm_packages/
-
-# Snowpack dependency directory (https://snowpack.dev/)
-web_modules/
-
-# TypeScript cache
-*.tsbuildinfo
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-# Microbundle cache
-.rpt2_cache/
-.rts2_cache_cjs/
-.rts2_cache_es/
-.rts2_cache_umd/
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variables file
-.env
-.env.test
-
-# parcel-bundler cache (https://parceljs.org/)
-.cache
-.parcel-cache
-
-# Next.js build output
-.next
-out
-
-# Nuxt.js build / generate output
-.nuxt
-dist
-
-# Gatsby files
-.cache/
-# Comment in the public line in if your project uses Gatsby and not Next.js
-# https://nextjs.org/blog/next-9-1#public-directory-support
-# public
-
-# vuepress build output
-.vuepress/dist
-
-# Serverless directories
-.serverless/
-
-# FuseBox cache
-.fusebox/
-
-# DynamoDB Local files
-.dynamodb/
-
-# TernJS port file
-.tern-port
-
-# Stores VSCode versions used for testing VSCode extensions
-.vscode-test
-
-# yarn v2
-.yarn/cache
-.yarn/unplugged
-.yarn/build-state.yml
-.yarn/install-state.gz
-.pnp.*

package/templates/.npmrc.tmpl

@@ -1 +0,0 @@
-save-exact=true

package/templates/tsconfig.json.tmpl

@@ -1,3 +0,0 @@
-{
-	"extends": "@adbayb/ts-config"
-}