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

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.
@@ -1 +1 @@
1
- Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require("../standard-CObuhDHj.cjs");let t=require("oxlint");const{categories:n,rules:r,plugins:i}=e.t,a=e=>{let a=[...i||[],...e?.plugins||[]];return(0,t.defineConfig)({...e,categories:{...n,...e?.categories},plugins:a.length>0?a:void 0,rules:{...r,...e?.rules}})};exports.oxlintConfig=a;
1
+ Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require("../standard-BfZttPv4.cjs");let t=require("oxlint");const{categories:n,rules:r,options:i}=e.t,a=e=>(0,t.defineConfig)({...e,options:{...i,...e?.options},categories:{...n,...e?.categories},rules:{...r,...e?.rules}});exports.oxlintConfig=a;
@@ -1 +1 @@
1
- import{t as e}from"../standard-ty7dwh8r.mjs";import{defineConfig as t}from"oxlint";const{categories:n,rules:r,plugins:i}=e,a=e=>{let a=[...i||[],...e?.plugins||[]];return t({...e,categories:{...n,...e?.categories},plugins:a.length>0?a:void 0,rules:{...r,...e?.rules}})};export{a as oxlintConfig};
1
+ import{t as e}from"../standard-BQ3PXrMc.mjs";import{defineConfig as t}from"oxlint";const{categories:n,rules:r,options:i}=e,a=e=>t({...e,options:{...i,...e?.options},categories:{...n,...e?.categories},rules:{...r,...e?.rules}});export{a as oxlintConfig};
@@ -1 +1 @@
1
- Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require("../../standard-CObuhDHj.cjs");exports.standardProfile=e.t;
1
+ Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require("../../standard-BfZttPv4.cjs");exports.standardProfile=e.t;
@@ -1,2 +1,22 @@
1
- import { OxlintConfig } from "oxlint";
2
- export declare const standardProfile: OxlintConfig;
1
+ export declare const standardProfile: {
2
+ options: {
3
+ typeAware: true;
4
+ typeCheck: true;
5
+ };
6
+ categories: {
7
+ correctness: "warn";
8
+ };
9
+ rules: {
10
+ 'eslint/no-unused-vars': "error";
11
+ 'prefer-const': ["error", {
12
+ ignoreReadBeforeAssign: true;
13
+ }];
14
+ 'typescript/explicit-function-return-type': "error";
15
+ 'typescript/consistent-type-imports': "warn";
16
+ 'typescript/no-floating-promises': "error";
17
+ 'typescript/no-misused-promises': "error";
18
+ 'typescript/no-explicit-any': "error";
19
+ 'typescript/explicit-member-accessibility': "error";
20
+ 'no-param-reassign': "error";
21
+ };
22
+ };
@@ -1,2 +1,22 @@
1
- import { OxlintConfig } from "oxlint";
2
- export declare const standardProfile: OxlintConfig;
1
+ export declare const standardProfile: {
2
+ options: {
3
+ typeAware: true;
4
+ typeCheck: true;
5
+ };
6
+ categories: {
7
+ correctness: "warn";
8
+ };
9
+ rules: {
10
+ 'eslint/no-unused-vars': "error";
11
+ 'prefer-const': ["error", {
12
+ ignoreReadBeforeAssign: true;
13
+ }];
14
+ 'typescript/explicit-function-return-type': "error";
15
+ 'typescript/consistent-type-imports': "warn";
16
+ 'typescript/no-floating-promises': "error";
17
+ 'typescript/no-misused-promises': "error";
18
+ 'typescript/no-explicit-any': "error";
19
+ 'typescript/explicit-member-accessibility': "error";
20
+ 'no-param-reassign': "error";
21
+ };
22
+ };
@@ -1 +1 @@
1
- export{t as standardProfile}from"../../standard-ty7dwh8r.mjs";
1
+ export{t as standardProfile}from"../../standard-BQ3PXrMc.mjs";
@@ -0,0 +1 @@
1
+ const e={options:{typeAware:!0,typeCheck:!0},categories:{correctness:`warn`},rules:{"eslint/no-unused-vars":`error`,"prefer-const":[`error`,{ignoreReadBeforeAssign:!0}],"typescript/explicit-function-return-type":`error`,"typescript/consistent-type-imports":`warn`,"typescript/no-floating-promises":`error`,"typescript/no-misused-promises":`error`,"typescript/no-explicit-any":`error`,"typescript/explicit-member-accessibility":`error`,"no-param-reassign":`error`}};export{e as t};
@@ -0,0 +1 @@
1
+ const e={options:{typeAware:!0,typeCheck:!0},categories:{correctness:`warn`},rules:{"eslint/no-unused-vars":`error`,"prefer-const":[`error`,{ignoreReadBeforeAssign:!0}],"typescript/explicit-function-return-type":`error`,"typescript/consistent-type-imports":`warn`,"typescript/no-floating-promises":`error`,"typescript/no-misused-promises":`error`,"typescript/no-explicit-any":`error`,"typescript/explicit-member-accessibility":`error`,"no-param-reassign":`error`}};Object.defineProperty(exports,"t",{enumerable:!0,get:function(){return e}});
@@ -1 +1 @@
1
- Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});let e=require("typescript"),t=require("path"),n=require("fs");const r=(r={})=>{let{filepath:i=(0,t.resolve)(process.cwd(),`tsconfig.json`)}=r;if(!(0,n.existsSync)(i))throw Error(`No configuration file found.`,{cause:{filepath:i}});let a=(0,t.parse)(i).dir,o=(0,e.readConfigFile)(i,e.sys.readFile);return(0,e.parseJsonConfigFileContent)(o.config,e.sys,a)},i=(t={})=>{try{let{parsedTsConfig:n}=t,i=(n||r(t)).options.target;return i?i===e.ScriptTarget.Latest?`esnext`:e.ScriptTarget[i]?.toLowerCase():void 0}catch(e){console.error(e)}};exports.getTSConfigCompilerTarget=i,exports.parseTsConfig=r;
1
+ Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});let e=require("typescript"),t=require("path"),n=require("fs");const r=(r={})=>{let{filepath:i=(0,t.resolve)(process.cwd(),`tsconfig.json`)}=r;if(!(0,n.existsSync)(i))throw Error(`No configuration file found.`,{cause:{filepath:i}});let a=(0,t.parse)(i).dir,o=(0,e.readConfigFile)(i,t=>e.sys.readFile(t));return(0,e.parseJsonConfigFileContent)(o.config,e.sys,a)},i=(t={})=>{try{let{parsedTsConfig:n}=t,i=(n||r(t)).options.target;return i?i===e.ScriptTarget.Latest?`esnext`:e.ScriptTarget[i]?.toLowerCase():void 0}catch(e){console.error(e)}};exports.getTSConfigCompilerTarget=i,exports.parseTsConfig=r;
@@ -1 +1 @@
1
- import{ScriptTarget as e,parseJsonConfigFileContent as t,readConfigFile as n,sys as r}from"typescript";import{parse as i,resolve as a}from"path";import{existsSync as o}from"fs";const s=(e={})=>{let{filepath:s=a(process.cwd(),`tsconfig.json`)}=e;if(!o(s))throw Error(`No configuration file found.`,{cause:{filepath:s}});let c=i(s).dir,l=n(s,r.readFile);return t(l.config,r,c)},c=(t={})=>{try{let{parsedTsConfig:n}=t,r=(n||s(t)).options.target;return r?r===e.Latest?`esnext`:e[r]?.toLowerCase():void 0}catch(e){console.error(e)}};export{c as getTSConfigCompilerTarget,s as parseTsConfig};
1
+ import{ScriptTarget as e,parseJsonConfigFileContent as t,readConfigFile as n,sys as r}from"typescript";import{parse as i,resolve as a}from"path";import{existsSync as o}from"fs";const s=(e={})=>{let{filepath:s=a(process.cwd(),`tsconfig.json`)}=e;if(!o(s))throw Error(`No configuration file found.`,{cause:{filepath:s}});let c=i(s).dir,l=n(s,e=>r.readFile(e));return t(l.config,r,c)},c=(t={})=>{try{let{parsedTsConfig:n}=t,r=(n||s(t)).options.target;return r?r===e.Latest?`esnext`:e[r]?.toLowerCase():void 0}catch(e){console.error(e)}};export{c as getTSConfigCompilerTarget,s as parseTsConfig};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@alessiofrittoli/package-configs",
3
- "version": "1.7.0",
3
+ "version": "1.8.0-alpha.1",
4
4
  "description": "Utility library that offers base configurations for your packages.",
5
5
  "type": "module",
6
6
  "author": {
@@ -39,7 +39,8 @@
39
39
  "module": "./dist/index.mjs",
40
40
  "types": "./dist/index.d.mts",
41
41
  "files": [
42
- "dist"
42
+ "dist",
43
+ "scripts/postinstall"
43
44
  ],
44
45
  "exports": {
45
46
  ".": {
@@ -80,6 +81,7 @@
80
81
  "eslint-plugin-react-server-components": "^1.2.0",
81
82
  "globals": "^17.12.0",
82
83
  "oxlint": "^1.85.0",
84
+ "oxlint-tsgolint": "^7.0.2004",
83
85
  "prettier": "^3.9.9",
84
86
  "prettier-plugin-sort-imports": "^1.8.11",
85
87
  "tsdown": "^0.23.0",
@@ -113,6 +115,9 @@
113
115
  "oxlint": {
114
116
  "optional": true
115
117
  },
118
+ "oxlint-tsgolint": {
119
+ "optional": true
120
+ },
116
121
  "prettier": {
117
122
  "optional": true
118
123
  },
@@ -141,6 +146,7 @@
141
146
  "@eslint/eslintrc": "^3.3.7",
142
147
  "@eslint/js": "^10.0.1",
143
148
  "@types/node": "^24.13.2",
149
+ "@types/prompts": "^2.4.9",
144
150
  "@vitest/coverage-v8": "5.0.5",
145
151
  "concurrently": "^10.0.6",
146
152
  "eslint": "^10.11.0",
@@ -148,25 +154,26 @@
148
154
  "eslint-plugin-react-server-components": "^1.2.0",
149
155
  "globals": "^17.13.0",
150
156
  "http-server": "^14.1.1",
151
- "jiti": "^2.7.0",
152
157
  "oxlint": "^1.89.0",
158
+ "oxlint-tsgolint": "^7.0.2004",
153
159
  "prettier": "^3.9.10",
154
- "prettier-plugin-organize-imports": "^4.3.0",
155
- "prettier-plugin-sh": "^0.20.2",
156
160
  "prettier-plugin-sort-imports": "^1.8.11",
157
- "prettier-plugin-tailwindcss": "^0.8.1",
158
161
  "tsdown": "^0.23.1",
159
162
  "typescript": "6.0.3",
160
163
  "typescript-eslint": "^8.72.0",
161
164
  "vite": "^8.3.5",
162
165
  "vitest": "^5.0.5"
163
166
  },
167
+ "dependencies": {
168
+ "@alessiofrittoli/chain-functions": "^2.7.0",
169
+ "prompts": "^2.4.2"
170
+ },
164
171
  "scripts": {
165
172
  "//1a": "*********************************************************************",
166
173
  "//1b": "******************** DEV - BUILD - LINT - RELEASE *******************",
167
174
  "//1c": "*********************************************************************",
168
175
  "dev": "tsdown --watch",
169
- "build": "pnpm lint && pnpm tsc && pnpm tsdown",
176
+ "build": "pnpm lint && pnpm tsdown",
170
177
  "eslint": "eslint -c legacy-eslint.config.ts --report-unused-disable-directives --max-warnings 0 --cache --cache-location .cache/eslint",
171
178
  "lint": "oxlint --report-unused-disable-directives --max-warnings 0",
172
179
  "release": "node scripts/release.ts --verbose --npm",
@@ -182,6 +189,10 @@
182
189
  "test:coverage": "pnpm test:watch --coverage",
183
190
  "test:coverage:ci": "pnpm test:ci --coverage",
184
191
  "test:serve-coverage": "http-server ./coverage --gzip true -p 0 -o /index.html --silent",
185
- "test:coverage:serve": "concurrently --prefix none --kill-others \"pnpm test:coverage\" \"pnpm test:serve-coverage\""
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"
186
197
  }
187
198
  }
@@ -0,0 +1,84 @@
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)
@@ -0,0 +1,132 @@
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
+ }
@@ -1 +0,0 @@
1
- const e={categories:{correctness:`warn`},plugins:[`eslint`,`typescript`,`unicorn`,`oxc`],rules:{"eslint/no-unused-vars":`error`,"prefer-const":[`error`,{ignoreReadBeforeAssign:!0}],"typescript/explicit-function-return-type":`error`,"typescript/consistent-type-imports":`warn`,"typescript/no-floating-promises":`error`,"typescript/no-misused-promises":`error`,"typescript/no-explicit-any":`error`,"typescript/explicit-member-accessibility":`error`,"no-param-reassign":`error`}};Object.defineProperty(exports,"t",{enumerable:!0,get:function(){return e}});
@@ -1 +0,0 @@
1
- const e={categories:{correctness:`warn`},plugins:[`eslint`,`typescript`,`unicorn`,`oxc`],rules:{"eslint/no-unused-vars":`error`,"prefer-const":[`error`,{ignoreReadBeforeAssign:!0}],"typescript/explicit-function-return-type":`error`,"typescript/consistent-type-imports":`warn`,"typescript/no-floating-promises":`error`,"typescript/no-misused-promises":`error`,"typescript/no-explicit-any":`error`,"typescript/explicit-member-accessibility":`error`,"no-param-reassign":`error`}};export{e as t};