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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@alessiofrittoli/package-configs",
3
- "version": "1.8.0-alpha.1",
3
+ "version": "1.8.0-alpha.3",
4
4
  "description": "Utility library that offers base configurations for your packages.",
5
5
  "type": "module",
6
6
  "author": {
@@ -165,7 +165,6 @@
165
165
  "vitest": "^5.0.5"
166
166
  },
167
167
  "dependencies": {
168
- "@alessiofrittoli/chain-functions": "^2.7.0",
169
168
  "prompts": "^2.4.2"
170
169
  },
171
170
  "scripts": {
@@ -189,10 +188,6 @@
189
188
  "test:coverage": "pnpm test:watch --coverage",
190
189
  "test:coverage:ci": "pnpm test:ci --coverage",
191
190
  "test:serve-coverage": "http-server ./coverage --gzip true -p 0 -o /index.html --silent",
192
- "test:coverage:serve": "concurrently --prefix none --kill-others \"pnpm test:coverage\" \"pnpm test:serve-coverage\"",
193
- "//4a": "*********************************************************************",
194
- "//4b": "******************************* OTHER *******************************",
195
- "//4c": "*********************************************************************",
196
- "postinstall": "node scripts/postinstall/index.ts"
191
+ "test:coverage:serve": "concurrently --prefix none --kill-others \"pnpm test:coverage\" \"pnpm test:serve-coverage\""
197
192
  }
198
193
  }
@@ -1,84 +0,0 @@
1
- import type { ChainFactory, LastChainLink } from '@alessiofrittoli/chain-functions/types'
2
- import { installDependencies } from './install-dependencies.ts'
3
- import project from '../../package.json' with { type: 'json' }
4
- import { Chain } from '@alessiofrittoli/chain-functions'
5
- import { readFileSync } from 'fs'
6
- import { resolve } from 'path'
7
-
8
- /**
9
- * Represents a package in the project.
10
- *
11
- */
12
- interface Package {
13
- /**
14
- * The root directory of the project.
15
- *
16
- */
17
- root: string
18
- /**
19
- * The name of the project.
20
- *
21
- */
22
- name: string
23
- }
24
-
25
- type PackageJson = Record<string, string | Record<string, string>> & { name: string }
26
-
27
- /**
28
- * Reads and parses the `package.json` file from the specified root directory.
29
- *
30
- * @param root - The root directory where the `package.json` file is located.
31
- * @returns The parsed contents of the `package.json` file as an object.
32
- * @throws Will throw an error if the file cannot be read or parsed.
33
- */
34
- const getPackageJson = (root: Package['root']): PackageJson =>
35
- JSON.parse(readFileSync(resolve(root, 'package.json')).toString()) as PackageJson
36
-
37
- /**
38
- * Determines if the script is running in an external project.
39
- *
40
- * @param project - The options object excluding the 'outputFile' property.
41
- * @returns A boolean indicating whether the script is running in an external project.
42
- * @throws Will throw an error if `INIT_CWD` is not set or if the script cannot determine the project status.
43
- */
44
- const isExternalPackage = ({ root, name }: Package): boolean => {
45
- try {
46
- const project = getPackageJson(root)
47
-
48
- if (project.name.endsWith(name)) {
49
- return false
50
- }
51
- return true
52
- } catch (cause) {
53
- throw new Error("Couldn't check if script is running in an external project.", { cause })
54
- }
55
- }
56
-
57
- /**
58
- * Retrieves the root directory of the current process.
59
- *
60
- * @returns The root directory of the current process, determined by the `INIT_CWD` environment variable if set,
61
- * otherwise the current working directory.
62
- */
63
- const getProcessRoot = (): string => process.env.INIT_CWD || process.cwd()
64
-
65
- export type PostInstallChainFn = () => void | Promise<void>
66
-
67
- const lastChainLink: LastChainLink<PostInstallChainFn> = () => () => {
68
- console.log({
69
- package: project.name,
70
- message: `Post-Install done. Thank you for installing ${project.name}!`,
71
- })
72
- }
73
-
74
- const postInstallChain: ChainFactory<PostInstallChainFn> = [installDependencies, lastChainLink]
75
-
76
- const runChain = async (): Promise<void> => {
77
- if (!isExternalPackage({ name: project.name, root: getProcessRoot() })) {
78
- return
79
- }
80
-
81
- await Chain.functions(postInstallChain)()
82
- }
83
-
84
- runChain().catch(console.error)
@@ -1,132 +0,0 @@
1
- import type { ChainLink } from '@alessiofrittoli/chain-functions/types'
2
- import type { PostInstallChainFn } from '.'
3
- import { execSync } from 'child_process'
4
- import prompts from 'prompts'
5
-
6
- /**
7
- * Check whether script is running in a CI environment.
8
- *
9
- * @remarks Check if `CI` or `GITHUB_ACTIONS` is `true` or `GITHUB_WORKFLOW` is defined.
10
- *
11
- * @returns `true` if the script is running in a CI environment, `false` otherwise.
12
- */
13
- const isCIEnv = (): boolean =>
14
- process.env.CI === 'true' ||
15
- process.env.GITHUB_ACTIONS === 'true' ||
16
- typeof process.env.GITHUB_WORKFLOW !== 'undefined'
17
-
18
- /**
19
- * Removes duplicate values from an array.
20
- *
21
- * @param array The input array.
22
- * @returns The filtered array.
23
- */
24
- export const arrayUnique = <T>(array: T[]): T[] => (array.length <= 0 ? array : [...new Set(array)])
25
-
26
- export const installDependencies: ChainLink<PostInstallChainFn> = next => async (): Promise<void> => {
27
- if (isCIEnv()) {
28
- return next()
29
- }
30
-
31
- try {
32
- const { installDeps } = await prompts([
33
- {
34
- type: 'confirm',
35
- name: 'installDeps',
36
- message: 'Would you like to install optional dependencies?',
37
- initial: true,
38
- },
39
- ])
40
-
41
- if (!installDeps) {
42
- return next()
43
- }
44
-
45
- const { _dependenciesChoice } = await prompts([
46
- {
47
- type: 'multiselect',
48
- name: '_dependenciesChoice',
49
- message: "Please, select which tool you're going to use",
50
- choices: [
51
- {
52
- title: 'Vite',
53
- selected: true,
54
- description: 'Will install Vite',
55
- value: ['vite'],
56
- },
57
- {
58
- title: 'Vitest',
59
- selected: true,
60
- description: 'Will install Vitest',
61
- value: ['vitest', '@vitest/coverage-v8'],
62
- },
63
- {
64
- title: 'Oxlint',
65
- selected: true,
66
- description: 'Will install Oxlint',
67
- value: ['oxlint', 'oxlint-tsgolint'],
68
- },
69
- {
70
- title: 'Prettier',
71
- selected: true,
72
- description: 'Will install Prettier',
73
- value: ['prettier', 'prettier-plugin-sort-imports'],
74
- },
75
- {
76
- title: 'tsdown',
77
- selected: true,
78
- description: 'Will install tsdown',
79
- value: ['tsdown'],
80
- },
81
- {
82
- title: 'ESLint',
83
- selected: false,
84
- description: 'Will install ESLint dev dependencies',
85
- value: [
86
- 'eslint',
87
- '@eslint/compat',
88
- '@eslint/eslintrc',
89
- '@eslint/js',
90
- 'globals',
91
- 'typescript-eslint',
92
- ],
93
- },
94
- {
95
- title: 'Next.js',
96
- description: 'Will install Next.js related ESLint dev dependencies',
97
- selected: false,
98
- value: [
99
- 'eslint',
100
- '@eslint/compat',
101
- '@eslint/eslintrc',
102
- '@eslint/js',
103
- 'globals',
104
- 'typescript-eslint',
105
- ],
106
- },
107
- ],
108
- },
109
- ])
110
-
111
- if (!_dependenciesChoice) {
112
- return next()
113
- }
114
-
115
- const dependenciesChoice = arrayUnique((_dependenciesChoice as string[][]).flatMap(c => c))
116
-
117
- let engine: 'npm' | 'pnpm' = 'npm'
118
-
119
- try {
120
- execSync('pnpm -v', { stdio: 'ignore' })
121
- engine = 'pnpm'
122
- } catch {
123
- engine = 'npm'
124
- }
125
-
126
- const installCommand = engine === 'npm' ? 'npm install' : 'pnpm i'
127
-
128
- execSync(`${installCommand} ${dependenciesChoice.join(' ')}`, { stdio: 'inherit' })
129
- } catch {
130
- return next()
131
- }
132
- }