@alessiofrittoli/package-configs 1.8.0-alpha.1 → 1.8.0-alpha.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alessiofrittoli/package-configs",
-  "version": "1.8.0-alpha.1",
+  "version": "1.8.0-alpha.10",
   "description": "Utility library that offers base configurations for your packages.",
   "type": "module",
   "author": {
@@ -193,6 +193,6 @@
     "//4a": "*********************************************************************",
     "//4b": "******************************* OTHER *******************************",
     "//4c": "*********************************************************************",
-    "postinstall": "node scripts/postinstall/index.ts"
+    "postinstall": "node scripts/postinstall/index.cjs"
   }
 }

package/scripts/postinstall/index.cjs

@@ -0,0 +1,74 @@
+const installDependencies = require('./install-dependencies.cjs')
+const { Chain } = require('@alessiofrittoli/chain-functions')
+const project = require('../../package.json')
+const { readFileSync } = require('fs')
+const path = require('path')
+
+/**
+ * Reads and parses the `package.json` file from the specified root directory.
+ *
+ * @param {string} root The root directory where the `package.json` file is located.
+ *
+ * @throws Will throw an error if the file cannot be read or parsed.
+ *
+ * @returns {Record<string, string | Record<string, string>> & { name: string }} The parsed contents of the `package.json` file as an object.
+ */
+const getPackageJson = root => JSON.parse(readFileSync(path.resolve(root, 'package.json')).toString())
+
+/**
+ * Determines if the script is running in an external project.
+ *
+ * @param {{ root: string; name: string }} project - The options object excluding the 'outputFile' property.
+ * @returns {boolean} A boolean indicating whether the script is running in an external project.
+ * @throws Will throw an error if `INIT_CWD` is not set or if the script cannot determine the project status.
+ */
+const isExternalPackage = ({ root, name }) => {
+	try {
+		const project = getPackageJson(root)
+
+		if (project.name.endsWith(name)) {
+			return false
+		}
+		return true
+	} catch (cause) {
+		throw new Error("Couldn't check if script is running in an external project.", { cause })
+	}
+}
+
+/**
+ * Retrieves the root directory of the current process.
+ *
+ * @returns {string} The root directory of the current process, determined by the `INIT_CWD` environment variable if set,
+ * 			otherwise the current working directory.
+ */
+const getProcessRoot = () => process.env.INIT_CWD || process.cwd()
+
+/**
+ * @type import('@alessiofrittoli/chain-functions/types').LastChainLink<() => void | Promise<void>>
+ */
+const lastChainLink = () => () => {
+	console.log({
+		package: project.name,
+		message: `Post-Install done. Thank you for installing ${project.name}!`,
+	})
+
+	process.exit(0)
+}
+
+/**
+ * @type import('@alessiofrittoli/chain-functions/types').ChainFactory<( params: { cwd: string; scriptsDir: string } ) => void | Promise<void>>
+ */
+const postInstallChain = [installDependencies, lastChainLink]
+
+const runChain = async () => {
+	const cwd = getProcessRoot()
+
+	if (!isExternalPackage({ name: project.name, root: cwd })) {
+		return process.exit(0)
+	}
+
+	await Chain.functions(postInstallChain)({ cwd, scriptsDir: path.resolve(__dirname, '../') })
+}
+
+// oxlint-disable-next-line typescript/no-floating-promises
+runChain()

package/scripts/postinstall/install-dependencies.cjs

@@ -0,0 +1,196 @@
+const { openSync, existsSync, readFileSync, writeFileSync } = require('fs')
+const { ReadStream, WriteStream } = require('tty')
+const { execSync } = require('child_process')
+const prompts = require('prompts')
+const path = require('path')
+
+// // example writing user input data to stdout
+
+// // const { openSync } = require('fs')
+// // const { ReadStream, WriteStream } = require('tty')
+// // const inputPath = process.platform === 'win32' ? 'CONIN$' : '/dev/tty'
+// // const outputPath = process.platform === 'win32' ? 'CONOUT$' : '/dev/tty'
+
+// // const stdin = new ReadStream(openSync(inputPath, 'r'))
+// // const stdout = new WriteStream(openSync(outputPath, 'w'))
+// const stdin = process.stdin
+// const stdout = process.stdout
+
+// stdin.setRawMode(true)
+// stdin.resume()
+
+// stdin.on( 'data', (data) => {
+// 	stdout.write( data.toString() )
+
+// 	if (data.includes('\x03')) {
+// 		stdin.setRawMode(false)
+// 		process.exit(0)
+// 	}
+// } )
+
+/**
+ * Check whether script is running in a CI environment.
+ *
+ * @remarks Check if `CI` or `GITHUB_ACTIONS` is `true` or `GITHUB_WORKFLOW` is defined.
+ *
+ * @returns `true` if the script is running in a CI environment, `false` otherwise.
+ */
+const isCIEnv = () =>
+	process.env.CI === 'true' ||
+	process.env.GITHUB_ACTIONS === 'true' ||
+	typeof process.env.GITHUB_WORKFLOW !== 'undefined'
+
+/**
+ * Removes duplicate values from an array.
+ *
+ * @param	array The input array.
+ * @returns	The filtered array.
+ */
+const arrayUnique = array => (array.length <= 0 ? array : [...new Set(array)])
+
+/**
+ * @type import('@alessiofrittoli/chain-functions/types').ChainLink<( params: { cwd: string; scriptsDir: string } ) => void | Promise<void>>
+ */
+const installDependencies = next => async params => {
+	if (isCIEnv()) {
+		return next(params)
+	}
+
+	const { cwd, scriptsDir } = params
+
+	try {
+		const stateFilePath = path.resolve(scriptsDir, 'post-install-data.json')
+
+		if (existsSync(stateFilePath)) {
+			try {
+				const file = JSON.parse(
+					readFileSync(path.resolve(scriptsDir, 'post-install-data.json'), 'utf-8'),
+				)
+				if (file.installDependencies.done) {
+					return next(params)
+				}
+			} catch {
+				return next(params)
+			}
+		}
+
+		const inputPath = process.platform === 'win32' ? 'CONIN$' : '/dev/tty'
+		const outputPath = process.platform === 'win32' ? 'CONOUT$' : '/dev/tty'
+		const stdin = !process.stdin.isTTY ? new ReadStream(openSync(inputPath, 'r')) : undefined
+		const stdout = !process.stdin.isTTY ? new WriteStream(openSync(outputPath, 'w')) : undefined
+
+		const { installDeps } = await prompts([
+			{
+				type: 'confirm',
+				name: 'installDeps',
+				message: 'Would you like to install optional dependencies?',
+				initial: true,
+				stdin,
+				stdout,
+			},
+		])
+
+		if (!installDeps) {
+			return next(params)
+		}
+
+		const { _dependenciesChoice } = await prompts([
+			{
+				type: 'multiselect',
+				name: '_dependenciesChoice',
+				message: "Please, select which tool you're going to use",
+				stdin,
+				stdout,
+				choices: [
+					{
+						title: 'Vite',
+						selected: true,
+						description: 'Will install Vite',
+						value: ['vite'],
+					},
+					{
+						title: 'Vitest',
+						selected: true,
+						description: 'Will install Vitest',
+						value: ['vitest', '@vitest/coverage-v8'],
+					},
+					{
+						title: 'Oxlint',
+						selected: true,
+						description: 'Will install Oxlint',
+						value: ['oxlint', 'oxlint-tsgolint'],
+					},
+					{
+						title: 'Prettier',
+						selected: true,
+						description: 'Will install Prettier',
+						value: ['prettier', 'prettier-plugin-sort-imports'],
+					},
+					{
+						title: 'tsdown',
+						selected: true,
+						description: 'Will install tsdown',
+						value: ['tsdown'],
+					},
+					{
+						title: 'ESLint',
+						selected: false,
+						description: 'Will install ESLint dev dependencies',
+						value: [
+							'eslint',
+							'@eslint/compat',
+							'@eslint/eslintrc',
+							'@eslint/js',
+							'globals',
+							'typescript-eslint',
+						],
+					},
+					{
+						title: 'Next.js',
+						description: 'Will install Next.js related ESLint dev dependencies',
+						selected: false,
+						value: [
+							'eslint',
+							'@eslint/compat',
+							'@eslint/eslintrc',
+							'@eslint/js',
+							'globals',
+							'typescript-eslint',
+						],
+					},
+				],
+			},
+		])
+
+		if (!_dependenciesChoice) {
+			return next(params)
+		}
+
+		const dependenciesChoice = arrayUnique(_dependenciesChoice.flatMap(choice => choice))
+
+		if (dependenciesChoice.length <= 0) {
+			return next(params)
+		}
+
+		let engine = 'npm'
+
+		try {
+			execSync('pnpm -v', { cwd, stdio: 'ignore' })
+			engine = 'pnpm'
+		} catch {
+			engine = 'npm'
+		}
+
+		const installCommand = engine === 'npm' ? 'npm install --save-dev' : 'pnpm add --save-dev'
+
+		execSync(`${installCommand} ${dependenciesChoice.join(' ')}`, { cwd, stdio: 'ignore' })
+
+		writeFileSync(stateFilePath, JSON.stringify({ installDependencies: { done: true } }))
+
+		return next(params)
+	} catch {
+		return next(params)
+	}
+}
+
+module.exports = installDependencies

package/scripts/postinstall/index.ts

@@ -1,84 +0,0 @@
-import type { ChainFactory, LastChainLink } from '@alessiofrittoli/chain-functions/types'
-import { installDependencies } from './install-dependencies.ts'
-import project from '../../package.json' with { type: 'json' }
-import { Chain } from '@alessiofrittoli/chain-functions'
-import { readFileSync } from 'fs'
-import { resolve } from 'path'
-
-/**
- * Represents a package in the project.
- *
- */
-interface Package {
-	/**
-	 * The root directory of the project.
-	 *
-	 */
-	root: string
-	/**
-	 * The name of the project.
-	 *
-	 */
-	name: string
-}
-
-type PackageJson = Record<string, string | Record<string, string>> & { name: string }
-
-/**
- * Reads and parses the `package.json` file from the specified root directory.
- *
- * @param root - The root directory where the `package.json` file is located.
- * @returns The parsed contents of the `package.json` file as an object.
- * @throws Will throw an error if the file cannot be read or parsed.
- */
-const getPackageJson = (root: Package['root']): PackageJson =>
-	JSON.parse(readFileSync(resolve(root, 'package.json')).toString()) as PackageJson
-
-/**
- * Determines if the script is running in an external project.
- *
- * @param project - The options object excluding the 'outputFile' property.
- * @returns A boolean indicating whether the script is running in an external project.
- * @throws Will throw an error if `INIT_CWD` is not set or if the script cannot determine the project status.
- */
-const isExternalPackage = ({ root, name }: Package): boolean => {
-	try {
-		const project = getPackageJson(root)
-
-		if (project.name.endsWith(name)) {
-			return false
-		}
-		return true
-	} catch (cause) {
-		throw new Error("Couldn't check if script is running in an external project.", { cause })
-	}
-}
-
-/**
- * Retrieves the root directory of the current process.
- *
- * @returns The root directory of the current process, determined by the `INIT_CWD` environment variable if set,
- * 			otherwise the current working directory.
- */
-const getProcessRoot = (): string => process.env.INIT_CWD || process.cwd()
-
-export type PostInstallChainFn = () => void | Promise<void>
-
-const lastChainLink: LastChainLink<PostInstallChainFn> = () => () => {
-	console.log({
-		package: project.name,
-		message: `Post-Install done. Thank you for installing ${project.name}!`,
-	})
-}
-
-const postInstallChain: ChainFactory<PostInstallChainFn> = [installDependencies, lastChainLink]
-
-const runChain = async (): Promise<void> => {
-	if (!isExternalPackage({ name: project.name, root: getProcessRoot() })) {
-		return
-	}
-
-	await Chain.functions(postInstallChain)()
-}
-
-runChain().catch(console.error)

package/scripts/postinstall/install-dependencies.ts

@@ -1,132 +0,0 @@
-import type { ChainLink } from '@alessiofrittoli/chain-functions/types'
-import type { PostInstallChainFn } from '.'
-import { execSync } from 'child_process'
-import prompts from 'prompts'
-
-/**
- * Check whether script is running in a CI environment.
- *
- * @remarks Check if `CI` or `GITHUB_ACTIONS` is `true` or `GITHUB_WORKFLOW` is defined.
- *
- * @returns `true` if the script is running in a CI environment, `false` otherwise.
- */
-const isCIEnv = (): boolean =>
-	process.env.CI === 'true' ||
-	process.env.GITHUB_ACTIONS === 'true' ||
-	typeof process.env.GITHUB_WORKFLOW !== 'undefined'
-
-/**
- * Removes duplicate values from an array.
- *
- * @param	array The input array.
- * @returns	The filtered array.
- */
-export const arrayUnique = <T>(array: T[]): T[] => (array.length <= 0 ? array : [...new Set(array)])
-
-export const installDependencies: ChainLink<PostInstallChainFn> = next => async (): Promise<void> => {
-	if (isCIEnv()) {
-		return next()
-	}
-
-	try {
-		const { installDeps } = await prompts([
-			{
-				type: 'confirm',
-				name: 'installDeps',
-				message: 'Would you like to install optional dependencies?',
-				initial: true,
-			},
-		])
-
-		if (!installDeps) {
-			return next()
-		}
-
-		const { _dependenciesChoice } = await prompts([
-			{
-				type: 'multiselect',
-				name: '_dependenciesChoice',
-				message: "Please, select which tool you're going to use",
-				choices: [
-					{
-						title: 'Vite',
-						selected: true,
-						description: 'Will install Vite',
-						value: ['vite'],
-					},
-					{
-						title: 'Vitest',
-						selected: true,
-						description: 'Will install Vitest',
-						value: ['vitest', '@vitest/coverage-v8'],
-					},
-					{
-						title: 'Oxlint',
-						selected: true,
-						description: 'Will install Oxlint',
-						value: ['oxlint', 'oxlint-tsgolint'],
-					},
-					{
-						title: 'Prettier',
-						selected: true,
-						description: 'Will install Prettier',
-						value: ['prettier', 'prettier-plugin-sort-imports'],
-					},
-					{
-						title: 'tsdown',
-						selected: true,
-						description: 'Will install tsdown',
-						value: ['tsdown'],
-					},
-					{
-						title: 'ESLint',
-						selected: false,
-						description: 'Will install ESLint dev dependencies',
-						value: [
-							'eslint',
-							'@eslint/compat',
-							'@eslint/eslintrc',
-							'@eslint/js',
-							'globals',
-							'typescript-eslint',
-						],
-					},
-					{
-						title: 'Next.js',
-						description: 'Will install Next.js related ESLint dev dependencies',
-						selected: false,
-						value: [
-							'eslint',
-							'@eslint/compat',
-							'@eslint/eslintrc',
-							'@eslint/js',
-							'globals',
-							'typescript-eslint',
-						],
-					},
-				],
-			},
-		])
-
-		if (!_dependenciesChoice) {
-			return next()
-		}
-
-		const dependenciesChoice = arrayUnique((_dependenciesChoice as string[][]).flatMap(c => c))
-
-		let engine: 'npm' | 'pnpm' = 'npm'
-
-		try {
-			execSync('pnpm -v', { stdio: 'ignore' })
-			engine = 'pnpm'
-		} catch {
-			engine = 'npm'
-		}
-
-		const installCommand = engine === 'npm' ? 'npm install' : 'pnpm i'
-
-		execSync(`${installCommand} ${dependenciesChoice.join(' ')}`, { stdio: 'inherit' })
-	} catch {
-		return next()
-	}
-}