dotenv-diff 2.4.6 → 2.4.7
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/CHANGELOG.md +10 -0
- package/README.md +8 -2
- package/dist/src/cli/run.d.ts.map +1 -1
- package/dist/src/cli/run.js +5 -6
- package/dist/src/cli/run.js.map +1 -1
- package/dist/src/commands/compare.d.ts +2 -2
- package/dist/src/commands/compare.d.ts.map +1 -1
- package/dist/src/commands/compare.js +15 -1
- package/dist/src/commands/compare.js.map +1 -1
- package/dist/src/commands/scanUsage.d.ts +3 -5
- package/dist/src/commands/scanUsage.d.ts.map +1 -1
- package/dist/src/commands/scanUsage.js +1 -1
- package/dist/src/commands/scanUsage.js.map +1 -1
- package/dist/src/config/constants.d.ts +42 -0
- package/dist/src/config/constants.d.ts.map +1 -0
- package/dist/src/config/constants.js +54 -0
- package/dist/src/config/constants.js.map +1 -0
- package/dist/src/config/options.d.ts +1 -1
- package/dist/src/config/options.d.ts.map +1 -1
- package/dist/src/config/options.js +1 -1
- package/dist/src/config/options.js.map +1 -1
- package/dist/src/config/types.d.ts +153 -199
- package/dist/src/config/types.d.ts.map +1 -1
- package/dist/src/config/types.js +1 -9
- package/dist/src/config/types.js.map +1 -1
- package/dist/src/core/compareScan.d.ts +1 -0
- package/dist/src/core/compareScan.d.ts.map +1 -1
- package/dist/src/core/compareScan.js +1 -0
- package/dist/src/core/compareScan.js.map +1 -1
- package/dist/src/core/determineComparisonFile.d.ts +1 -1
- package/dist/src/core/determineComparisonFile.d.ts.map +1 -1
- package/dist/src/core/determineComparisonFile.js +2 -8
- package/dist/src/core/determineComparisonFile.js.map +1 -1
- package/dist/src/core/envPairing.d.ts.map +1 -1
- package/dist/src/core/envPairing.js +5 -2
- package/dist/src/core/envPairing.js.map +1 -1
- package/dist/src/core/fixEnv.d.ts.map +1 -1
- package/dist/src/core/fixEnv.js +2 -1
- package/dist/src/core/fixEnv.js.map +1 -1
- package/dist/src/core/frameworkDetector.d.ts +2 -2
- package/dist/src/core/frameworkDetector.d.ts.map +1 -1
- package/dist/src/core/frameworkDetector.js +0 -1
- package/dist/src/core/frameworkDetector.js.map +1 -1
- package/dist/src/core/frameworkValidator.d.ts +2 -2
- package/dist/src/core/frameworkValidator.d.ts.map +1 -1
- package/dist/src/core/frameworkValidator.js +0 -1
- package/dist/src/core/frameworkValidator.js.map +1 -1
- package/dist/src/core/frameworks/nextJsRules.d.ts +2 -2
- package/dist/src/core/frameworks/nextJsRules.d.ts.map +1 -1
- package/dist/src/core/frameworks/nextJsRules.js +18 -21
- package/dist/src/core/frameworks/nextJsRules.js.map +1 -1
- package/dist/src/core/frameworks/sveltekitRules.d.ts +2 -2
- package/dist/src/core/frameworks/sveltekitRules.d.ts.map +1 -1
- package/dist/src/core/frameworks/sveltekitRules.js +41 -30
- package/dist/src/core/frameworks/sveltekitRules.js.map +1 -1
- package/dist/src/core/helpers/normalizePath.d.ts +6 -0
- package/dist/src/core/helpers/normalizePath.d.ts.map +1 -0
- package/dist/src/core/helpers/normalizePath.js +8 -0
- package/dist/src/core/helpers/normalizePath.js.map +1 -0
- package/dist/src/core/helpers/updateTotals.d.ts +1 -2
- package/dist/src/core/helpers/updateTotals.d.ts.map +1 -1
- package/dist/src/core/helpers/updateTotals.js.map +1 -1
- package/dist/src/core/processComparisonFile.d.ts +6 -14
- package/dist/src/core/processComparisonFile.d.ts.map +1 -1
- package/dist/src/core/processComparisonFile.js.map +1 -1
- package/dist/src/core/scanJsonOutput.d.ts +78 -2
- package/dist/src/core/scanJsonOutput.d.ts.map +1 -1
- package/dist/src/core/scanJsonOutput.js +5 -4
- package/dist/src/core/scanJsonOutput.js.map +1 -1
- package/dist/src/index.js +7 -0
- package/dist/src/index.js.map +1 -1
- package/dist/src/services/codeBaseScanner.d.ts.map +1 -1
- package/dist/src/services/codeBaseScanner.js +59 -22
- package/dist/src/services/codeBaseScanner.js.map +1 -1
- package/dist/src/services/ensureFilesOrPrompt.d.ts.map +1 -1
- package/dist/src/services/ensureFilesOrPrompt.js +5 -2
- package/dist/src/services/ensureFilesOrPrompt.js.map +1 -1
- package/dist/src/services/envDiscovery.d.ts.map +1 -1
- package/dist/src/services/envDiscovery.js +22 -9
- package/dist/src/services/envDiscovery.js.map +1 -1
- package/dist/src/services/git.d.ts.map +1 -1
- package/dist/src/services/git.js +10 -9
- package/dist/src/services/git.js.map +1 -1
- package/dist/src/services/scanOutputToConsole.d.ts +2 -4
- package/dist/src/services/scanOutputToConsole.d.ts.map +1 -1
- package/dist/src/services/scanOutputToConsole.js +5 -4
- package/dist/src/services/scanOutputToConsole.js.map +1 -1
- package/dist/src/ui/compare/printIssues.d.ts +1 -1
- package/dist/src/ui/compare/printIssues.d.ts.map +1 -1
- package/dist/src/ui/compare/printIssues.js +0 -1
- package/dist/src/ui/compare/printIssues.js.map +1 -1
- package/dist/src/ui/compare/printStats.d.ts +1 -1
- package/dist/src/ui/compare/printStats.d.ts.map +1 -1
- package/dist/src/ui/compare/printStats.js +0 -1
- package/dist/src/ui/compare/printStats.js.map +1 -1
- package/dist/src/ui/scan/printConsolelogWarning.d.ts.map +1 -1
- package/dist/src/ui/scan/printConsolelogWarning.js +3 -1
- package/dist/src/ui/scan/printConsolelogWarning.js.map +1 -1
- package/dist/src/ui/scan/printFrameworkWarnings.d.ts +2 -2
- package/dist/src/ui/scan/printFrameworkWarnings.d.ts.map +1 -1
- package/dist/src/ui/scan/printFrameworkWarnings.js +0 -1
- package/dist/src/ui/scan/printFrameworkWarnings.js.map +1 -1
- package/dist/src/ui/scan/printMissing.d.ts.map +1 -1
- package/dist/src/ui/scan/printMissing.js +3 -1
- package/dist/src/ui/scan/printMissing.js.map +1 -1
- package/dist/src/ui/scan/printProgress.d.ts +15 -0
- package/dist/src/ui/scan/printProgress.d.ts.map +1 -0
- package/dist/src/ui/scan/printProgress.js +35 -0
- package/dist/src/ui/scan/printProgress.js.map +1 -0
- package/dist/src/ui/scan/printSecrets.d.ts +1 -1
- package/dist/src/ui/scan/printSecrets.d.ts.map +1 -1
- package/dist/src/ui/scan/printSecrets.js +3 -2
- package/dist/src/ui/scan/printSecrets.js.map +1 -1
- package/dist/src/ui/shared/printFixTips.d.ts +1 -1
- package/dist/src/ui/shared/printFixTips.d.ts.map +1 -1
- package/dist/src/ui/shared/printFixTips.js +0 -1
- package/dist/src/ui/shared/printFixTips.js.map +1 -1
- package/dist/src/ui/shared/printProgress.d.ts +24 -0
- package/dist/src/ui/shared/printProgress.d.ts.map +1 -0
- package/dist/src/ui/shared/printProgress.js +43 -0
- package/dist/src/ui/shared/printProgress.js.map +1 -0
- package/dist/src/ui/shared/setupGlobalConfig.d.ts +1 -1
- package/dist/src/ui/shared/setupGlobalConfig.d.ts.map +1 -1
- package/dist/src/ui/shared/setupGlobalConfig.js +0 -1
- package/dist/src/ui/shared/setupGlobalConfig.js.map +1 -1
- package/package.json +1 -1
|
@@ -1,12 +1,18 @@
|
|
|
1
|
+
import { ALLOWED_CATEGORIES } from './constants.js';
|
|
1
2
|
import { type SecretFinding } from '../core/secretDetectors.js';
|
|
2
3
|
import { type ExampleSecretWarning } from '../core/exampleSecretDetector.js';
|
|
3
|
-
export type
|
|
4
|
-
export
|
|
4
|
+
export type SupportedFramework = 'sveltekit' | 'nextjs';
|
|
5
|
+
export type DetectedFramework = SupportedFramework | 'unknown';
|
|
6
|
+
/**
|
|
7
|
+
* Framework-specific warning about environment variable usage
|
|
8
|
+
* From rules defined for each supported framework (SvelteKit, Next.js)
|
|
9
|
+
*/
|
|
10
|
+
export interface FrameworkWarning {
|
|
5
11
|
variable: string;
|
|
6
12
|
reason: string;
|
|
7
13
|
file: string;
|
|
8
14
|
line: number;
|
|
9
|
-
framework:
|
|
15
|
+
framework: SupportedFramework;
|
|
10
16
|
}
|
|
11
17
|
export type Duplicate = {
|
|
12
18
|
key: string;
|
|
@@ -16,43 +22,21 @@ export interface DuplicateResult {
|
|
|
16
22
|
dupsEnv: Duplicate[];
|
|
17
23
|
dupsEx: Duplicate[];
|
|
18
24
|
}
|
|
19
|
-
export declare const ALLOWED_CATEGORIES: readonly ["missing", "extra", "empty", "mismatch", "duplicate", "gitignore"];
|
|
20
25
|
export type Category = (typeof ALLOWED_CATEGORIES)[number];
|
|
21
|
-
/**
|
|
22
|
-
*
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
ignore: string[];
|
|
34
|
-
ignoreRegex: RegExp[];
|
|
35
|
-
cwd: string;
|
|
36
|
-
only?: Category[];
|
|
37
|
-
compare: boolean;
|
|
38
|
-
scanUsage: boolean;
|
|
39
|
-
includeFiles: string[];
|
|
40
|
-
excludeFiles: string[];
|
|
41
|
-
showUnused: boolean;
|
|
42
|
-
showStats: boolean;
|
|
43
|
-
files?: string[];
|
|
44
|
-
noColor?: boolean;
|
|
45
|
-
secrets: boolean;
|
|
46
|
-
strict: boolean | undefined;
|
|
47
|
-
ignoreUrls?: string[];
|
|
48
|
-
uppercaseKeys: boolean;
|
|
49
|
-
expireWarnings: boolean;
|
|
50
|
-
inconsistentNamingWarnings: boolean;
|
|
51
|
-
};
|
|
52
|
-
/** Type representing the raw options for the comparison
|
|
53
|
-
* These are the options that are directly passed to the comparison function without any processing or validation.
|
|
26
|
+
/**
|
|
27
|
+
* Raw options as received directly from the CLI argument parser.
|
|
28
|
+
*
|
|
29
|
+
* These values are intentionally loose and reflect how flags are actually
|
|
30
|
+
* provided by the user:
|
|
31
|
+
* - Values may be missing
|
|
32
|
+
* - Lists may be strings or string arrays
|
|
33
|
+
* - No defaults are applied
|
|
34
|
+
* - No validation or normalization has happened yet
|
|
35
|
+
*
|
|
36
|
+
* This type should only be used at the CLI boundary and passed into the
|
|
37
|
+
* normalization step that produces {@link Options}.
|
|
54
38
|
*/
|
|
55
|
-
export
|
|
39
|
+
export interface RawOptions {
|
|
56
40
|
checkValues?: boolean;
|
|
57
41
|
ci?: boolean;
|
|
58
42
|
yes?: boolean;
|
|
@@ -79,37 +63,48 @@ export type RawOptions = {
|
|
|
79
63
|
uppercaseKeys?: boolean;
|
|
80
64
|
expireWarnings?: boolean;
|
|
81
65
|
inconsistentNamingWarnings?: boolean;
|
|
82
|
-
}
|
|
66
|
+
}
|
|
83
67
|
/**
|
|
84
|
-
*
|
|
85
|
-
*
|
|
68
|
+
* Normalized and validated options used internally by the application.
|
|
69
|
+
*
|
|
70
|
+
* These options represent the final, safe configuration that the rest of the
|
|
71
|
+
* codebase can rely on. All values are:
|
|
72
|
+
* - Fully normalized (no string | string[] unions)
|
|
73
|
+
* - Resolved to absolute paths where applicable
|
|
74
|
+
* - Filled with defaults for omitted flags
|
|
75
|
+
* - Validated and ready for use
|
|
76
|
+
*
|
|
77
|
+
* This type should be used everywhere outside of CLI parsing and option
|
|
78
|
+
* normalization logic.
|
|
86
79
|
*/
|
|
87
|
-
export
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
80
|
+
export interface Options {
|
|
81
|
+
checkValues: boolean;
|
|
82
|
+
isCiMode: boolean;
|
|
83
|
+
isYesMode: boolean;
|
|
84
|
+
allowDuplicates: boolean;
|
|
85
|
+
fix: boolean;
|
|
86
|
+
json: boolean;
|
|
87
|
+
envFlag: string | undefined;
|
|
88
|
+
exampleFlag: string | undefined;
|
|
89
|
+
ignore: string[];
|
|
90
|
+
ignoreRegex: RegExp[];
|
|
91
|
+
cwd: string;
|
|
92
|
+
only: Category[];
|
|
93
|
+
compare: boolean;
|
|
94
|
+
scanUsage: boolean;
|
|
95
|
+
includeFiles: string[];
|
|
96
|
+
excludeFiles: string[];
|
|
97
|
+
showUnused: boolean;
|
|
98
|
+
showStats: boolean;
|
|
99
|
+
files: string[];
|
|
100
|
+
noColor: boolean;
|
|
101
|
+
secrets: boolean;
|
|
102
|
+
strict: boolean;
|
|
103
|
+
ignoreUrls: string[];
|
|
104
|
+
uppercaseKeys: boolean;
|
|
105
|
+
expireWarnings: boolean;
|
|
106
|
+
inconsistentNamingWarnings: boolean;
|
|
107
|
+
}
|
|
113
108
|
/**
|
|
114
109
|
* Represents a single usage of an environment variable in the codebase.
|
|
115
110
|
*/
|
|
@@ -118,20 +113,45 @@ export interface EnvUsage {
|
|
|
118
113
|
file: string;
|
|
119
114
|
line: number;
|
|
120
115
|
column: number;
|
|
121
|
-
pattern: 'process.env' | 'import.meta.env' | 'sveltekit'
|
|
116
|
+
pattern: 'process.env' | 'import.meta.env' | 'sveltekit';
|
|
122
117
|
context: string;
|
|
123
118
|
isLogged?: boolean;
|
|
124
119
|
}
|
|
120
|
+
export type VariableUsages = Record<string, EnvUsage[]>;
|
|
121
|
+
/**
|
|
122
|
+
* Options for scanning the codebase
|
|
123
|
+
*/
|
|
125
124
|
export interface ScanOptions {
|
|
126
125
|
cwd: string;
|
|
127
126
|
include: string[];
|
|
128
127
|
exclude: string[];
|
|
129
128
|
ignore: string[];
|
|
130
129
|
ignoreRegex: RegExp[];
|
|
131
|
-
files
|
|
132
|
-
secrets
|
|
133
|
-
ignoreUrls
|
|
130
|
+
files: string[];
|
|
131
|
+
secrets: boolean;
|
|
132
|
+
ignoreUrls: string[];
|
|
133
|
+
json: boolean;
|
|
134
134
|
}
|
|
135
|
+
/**
|
|
136
|
+
* Extends the basic ScanOptions with additional parameters.
|
|
137
|
+
* All of these options are optional, as they may not be needed for every scan.
|
|
138
|
+
*/
|
|
139
|
+
export interface ScanUsageOptions extends ScanOptions {
|
|
140
|
+
envPath?: string | undefined;
|
|
141
|
+
examplePath?: string | undefined;
|
|
142
|
+
fix?: boolean;
|
|
143
|
+
showUnused?: boolean;
|
|
144
|
+
showStats?: boolean;
|
|
145
|
+
isCiMode?: boolean;
|
|
146
|
+
allowDuplicates?: boolean;
|
|
147
|
+
strict?: boolean;
|
|
148
|
+
uppercaseKeys?: boolean;
|
|
149
|
+
expireWarnings?: boolean;
|
|
150
|
+
inconsistentNamingWarnings?: boolean;
|
|
151
|
+
}
|
|
152
|
+
/**
|
|
153
|
+
* Result of scanning the codebase for environment variable usages.
|
|
154
|
+
*/
|
|
135
155
|
export interface ScanResult {
|
|
136
156
|
used: EnvUsage[];
|
|
137
157
|
missing: string[];
|
|
@@ -145,16 +165,10 @@ export interface ScanResult {
|
|
|
145
165
|
};
|
|
146
166
|
secrets: SecretFinding[];
|
|
147
167
|
duplicates: {
|
|
148
|
-
env?:
|
|
149
|
-
|
|
150
|
-
count: number;
|
|
151
|
-
}>;
|
|
152
|
-
example?: Array<{
|
|
153
|
-
key: string;
|
|
154
|
-
count: number;
|
|
155
|
-
}>;
|
|
168
|
+
env?: Duplicate[];
|
|
169
|
+
example?: Duplicate[];
|
|
156
170
|
};
|
|
157
|
-
frameworkWarnings?:
|
|
171
|
+
frameworkWarnings?: FrameworkWarning[];
|
|
158
172
|
exampleWarnings?: ExampleSecretWarning[];
|
|
159
173
|
logged: EnvUsage[];
|
|
160
174
|
uppercaseWarnings?: UppercaseWarning[];
|
|
@@ -162,103 +176,33 @@ export interface ScanResult {
|
|
|
162
176
|
inconsistentNamingWarnings?: InconsistentNamingWarning[];
|
|
163
177
|
fileContentMap?: Map<string, string>;
|
|
164
178
|
}
|
|
165
|
-
/**
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
files?: string[];
|
|
175
|
-
allowDuplicates?: boolean;
|
|
176
|
-
strict?: boolean;
|
|
177
|
-
uppercaseKeys?: boolean;
|
|
178
|
-
expireWarnings?: boolean;
|
|
179
|
-
inconsistentNamingWarnings?: boolean;
|
|
180
|
-
}
|
|
181
|
-
export interface ScanJsonEntry {
|
|
182
|
-
stats?: {
|
|
183
|
-
filesScanned: number;
|
|
184
|
-
totalUsages: number;
|
|
185
|
-
uniqueVariables: number;
|
|
186
|
-
warningsCount: number;
|
|
187
|
-
duration: number;
|
|
179
|
+
/**
|
|
180
|
+
* Type representing a single entry in the comparison results
|
|
181
|
+
* This entry contains the environment variable and its example value.
|
|
182
|
+
*/
|
|
183
|
+
export type CompareJsonEntry = {
|
|
184
|
+
env: string;
|
|
185
|
+
example: string;
|
|
186
|
+
skipped?: {
|
|
187
|
+
reason: string;
|
|
188
188
|
};
|
|
189
|
-
missing?: Array<{
|
|
190
|
-
variable: string;
|
|
191
|
-
usages: Array<{
|
|
192
|
-
file: string;
|
|
193
|
-
line: number;
|
|
194
|
-
pattern: string;
|
|
195
|
-
context: string;
|
|
196
|
-
}>;
|
|
197
|
-
}>;
|
|
198
|
-
unused?: string[];
|
|
199
|
-
allUsages?: Array<{
|
|
200
|
-
variable: string;
|
|
201
|
-
file: string;
|
|
202
|
-
line: number;
|
|
203
|
-
pattern: string;
|
|
204
|
-
context: string;
|
|
205
|
-
}>;
|
|
206
|
-
comparedAgainst?: string;
|
|
207
|
-
totalEnvVariables?: number;
|
|
208
|
-
secrets?: Array<{
|
|
209
|
-
file: string;
|
|
210
|
-
line: number;
|
|
211
|
-
message: string;
|
|
212
|
-
snippet: string;
|
|
213
|
-
}>;
|
|
214
189
|
duplicates?: {
|
|
215
|
-
env?:
|
|
216
|
-
|
|
217
|
-
count: number;
|
|
218
|
-
}>;
|
|
219
|
-
example?: Array<{
|
|
220
|
-
key: string;
|
|
221
|
-
count: number;
|
|
222
|
-
}>;
|
|
190
|
+
env?: Duplicate[];
|
|
191
|
+
example?: Duplicate[];
|
|
223
192
|
};
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
context: string;
|
|
229
|
-
}>;
|
|
230
|
-
expireWarnings?: Array<{
|
|
231
|
-
key: string;
|
|
232
|
-
date: string;
|
|
233
|
-
daysLeft: number;
|
|
234
|
-
}>;
|
|
235
|
-
uppercaseWarnings?: Array<{
|
|
236
|
-
key: string;
|
|
237
|
-
suggestion: string;
|
|
238
|
-
}>;
|
|
239
|
-
inconsistentNamingWarnings?: Array<{
|
|
240
|
-
key1: string;
|
|
241
|
-
key2: string;
|
|
242
|
-
suggestion: string;
|
|
243
|
-
}>;
|
|
244
|
-
frameworkWarnings?: Array<{
|
|
245
|
-
variable: string;
|
|
246
|
-
reason: string;
|
|
247
|
-
file: string;
|
|
248
|
-
line: number;
|
|
249
|
-
framework: string;
|
|
250
|
-
}>;
|
|
251
|
-
exampleWarnings?: Array<{
|
|
193
|
+
missing?: string[];
|
|
194
|
+
extra?: string[];
|
|
195
|
+
empty?: string[];
|
|
196
|
+
valueMismatches?: Array<{
|
|
252
197
|
key: string;
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
severity: string;
|
|
198
|
+
expected: string;
|
|
199
|
+
actual: string;
|
|
256
200
|
}>;
|
|
257
|
-
|
|
258
|
-
}
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
201
|
+
ok?: boolean;
|
|
202
|
+
};
|
|
203
|
+
/**
|
|
204
|
+
* Options for comparing environment files (--compare flag).
|
|
205
|
+
*/
|
|
262
206
|
export interface ComparisonOptions {
|
|
263
207
|
checkValues: boolean;
|
|
264
208
|
cwd: string;
|
|
@@ -275,30 +219,24 @@ export interface ComparisonOptions {
|
|
|
275
219
|
expireWarnings?: boolean;
|
|
276
220
|
inconsistentNamingWarnings?: boolean;
|
|
277
221
|
}
|
|
222
|
+
/**
|
|
223
|
+
* Represents a resolved pair of environment files used for comparison.
|
|
224
|
+
*
|
|
225
|
+
* A FilePair describes one concrete comparison unit consisting of:
|
|
226
|
+
* - an environment file (e.g. `.env`, `.env.production`)
|
|
227
|
+
* - the example file it should be compared against
|
|
228
|
+
*/
|
|
278
229
|
export interface FilePair {
|
|
230
|
+
/** The name of the environment file (e.g. ".env", ".env.production") */
|
|
279
231
|
envName: string;
|
|
232
|
+
/** Absolute path to the environment file */
|
|
280
233
|
envPath: string;
|
|
234
|
+
/** Absolute path to the example file this env file is compared against */
|
|
281
235
|
examplePath: string;
|
|
282
236
|
}
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
export type PairContext = {
|
|
287
|
-
envName: string;
|
|
288
|
-
envPath: string;
|
|
289
|
-
exampleName: string;
|
|
290
|
-
examplePath: string;
|
|
291
|
-
exists: {
|
|
292
|
-
env: boolean;
|
|
293
|
-
example: boolean;
|
|
294
|
-
};
|
|
295
|
-
currentFull?: Record<string, string>;
|
|
296
|
-
exampleFull?: Record<string, string>;
|
|
297
|
-
currentKeys?: string[];
|
|
298
|
-
exampleKeys?: string[];
|
|
299
|
-
current?: Record<string, string>;
|
|
300
|
-
example?: Record<string, string>;
|
|
301
|
-
};
|
|
237
|
+
/**
|
|
238
|
+
* Result of filtering comparison results based on categories
|
|
239
|
+
*/
|
|
302
240
|
export type Filtered = {
|
|
303
241
|
missing: string[];
|
|
304
242
|
extra?: string[];
|
|
@@ -308,27 +246,43 @@ export type Filtered = {
|
|
|
308
246
|
expected: string;
|
|
309
247
|
actual: string;
|
|
310
248
|
}>;
|
|
311
|
-
duplicatesEnv:
|
|
312
|
-
|
|
313
|
-
count: number;
|
|
314
|
-
}>;
|
|
315
|
-
duplicatesEx: Array<{
|
|
316
|
-
key: string;
|
|
317
|
-
count: number;
|
|
318
|
-
}>;
|
|
249
|
+
duplicatesEnv: Duplicate[];
|
|
250
|
+
duplicatesEx: Duplicate[];
|
|
319
251
|
gitignoreIssue: {
|
|
320
252
|
reason: 'no-gitignore' | 'not-ignored';
|
|
321
253
|
} | null;
|
|
322
254
|
};
|
|
255
|
+
/**
|
|
256
|
+
* Result of the exit code determination after scanning or comparing.
|
|
257
|
+
*/
|
|
258
|
+
export interface ExitResult {
|
|
259
|
+
exitWithError: boolean;
|
|
260
|
+
}
|
|
261
|
+
/**
|
|
262
|
+
* Warning about environment variable keys that are not uppercase.
|
|
263
|
+
*/
|
|
323
264
|
export interface UppercaseWarning {
|
|
324
265
|
key: string;
|
|
325
266
|
suggestion: string;
|
|
326
267
|
}
|
|
268
|
+
/**
|
|
269
|
+
* Warning about environment variable keys that have expiration dates.
|
|
270
|
+
* fx:
|
|
271
|
+
*
|
|
272
|
+
* # @expire 2025-12-31
|
|
273
|
+
* API_KEY=
|
|
274
|
+
*
|
|
275
|
+
* This will generate a warning that API_KEY expires on 2025-12-31.
|
|
276
|
+
*/
|
|
327
277
|
export interface ExpireWarning {
|
|
328
278
|
key: string;
|
|
329
279
|
date: string;
|
|
330
280
|
daysLeft: number;
|
|
331
281
|
}
|
|
282
|
+
/**
|
|
283
|
+
* Warning about inconsistent naming of environment variable keys.
|
|
284
|
+
* fx: If you have both SECRET_KEY and SECRETKEY (inconsistent naming)
|
|
285
|
+
*/
|
|
332
286
|
export interface InconsistentNamingWarning {
|
|
333
287
|
key1: string;
|
|
334
288
|
key2: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/config/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAG7E,MAAM,MAAM,
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/config/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAG7E,MAAM,MAAM,kBAAkB,GAAG,WAAW,GAAG,QAAQ,CAAC;AAGxD,MAAM,MAAM,iBAAiB,GAAG,kBAAkB,GAAG,SAAS,CAAC;AAE/D;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,kBAAkB,CAAC;CAC/B;AAGD,MAAM,MAAM,SAAS,GAAG;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAGvD,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,SAAS,EAAE,CAAC;IACrB,MAAM,EAAE,SAAS,EAAE,CAAC;CACrB;AAGD,MAAM,MAAM,QAAQ,GAAG,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE3D;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,UAAU;IACzB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,EAAE,CAAC,EAAE,OAAO,CAAC;IACb,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC3B,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAChC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACzB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACjC,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACjC,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC1B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,0BAA0B,CAAC,EAAE,OAAO,CAAC;CACtC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,OAAO;IACtB,WAAW,EAAE,OAAO,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;IACnB,eAAe,EAAE,OAAO,CAAC;IACzB,GAAG,EAAE,OAAO,CAAC;IACb,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,QAAQ,EAAE,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;IACnB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,UAAU,EAAE,OAAO,CAAC;IACpB,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,OAAO,CAAC;IAChB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,aAAa,EAAE,OAAO,CAAC;IACvB,cAAc,EAAE,OAAO,CAAC;IACxB,0BAA0B,EAAE,OAAO,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,aAAa,GAAG,iBAAiB,GAAG,WAAW,CAAC;IACzD,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAGD,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;AAExD;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,WAAW;IACnD,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,0BAA0B,CAAC,EAAE,OAAO,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,QAAQ,EAAE,CAAC;IACjB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,KAAK,EAAE;QACL,YAAY,EAAE,MAAM,CAAC;QACrB,WAAW,EAAE,MAAM,CAAC;QACpB,eAAe,EAAE,MAAM,CAAC;QACxB,aAAa,EAAE,MAAM,CAAC;QACtB,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,OAAO,EAAE,aAAa,EAAE,CAAC;IACzB,UAAU,EAAE;QACV,GAAG,CAAC,EAAE,SAAS,EAAE,CAAC;QAClB,OAAO,CAAC,EAAE,SAAS,EAAE,CAAC;KACvB,CAAC;IACF,iBAAiB,CAAC,EAAE,gBAAgB,EAAE,CAAC;IACvC,eAAe,CAAC,EAAE,oBAAoB,EAAE,CAAC;IACzC,MAAM,EAAE,QAAQ,EAAE,CAAC;IACnB,iBAAiB,CAAC,EAAE,gBAAgB,EAAE,CAAC;IACvC,cAAc,CAAC,EAAE,aAAa,EAAE,CAAC;IACjC,0BAA0B,CAAC,EAAE,yBAAyB,EAAE,CAAC;IACzD,cAAc,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAC7B,UAAU,CAAC,EAAE;QACX,GAAG,CAAC,EAAE,SAAS,EAAE,CAAC;QAClB,OAAO,CAAC,EAAE,SAAS,EAAE,CAAC;KACvB,CAAC;IACF,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,eAAe,CAAC,EAAE,KAAK,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC3E,EAAE,CAAC,EAAE,OAAO,CAAC;CACd,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,WAAW,EAAE,OAAO,CAAC;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAC5C,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC;IAClB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,0BAA0B,CAAC,EAAE,OAAO,CAAC;CACtC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,QAAQ;IACvB,wEAAwE;IACxE,OAAO,EAAE,MAAM,CAAC;IAEhB,4CAA4C;IAC5C,OAAO,EAAE,MAAM,CAAC;IAEhB,0EAA0E;IAC1E,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,UAAU,CAAC,EAAE,KAAK,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACtE,aAAa,EAAE,SAAS,EAAE,CAAC;IAC3B,YAAY,EAAE,SAAS,EAAE,CAAC;IAC1B,cAAc,EAAE;QAAE,MAAM,EAAE,cAAc,GAAG,aAAa,CAAA;KAAE,GAAG,IAAI,CAAC;CACnE,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,aAAa,EAAE,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,uBAAuB,EAAE,OAAO,CAAC;CAClC"}
|
package/dist/src/config/types.js
CHANGED
|
@@ -1,12 +1,4 @@
|
|
|
1
|
+
import { ALLOWED_CATEGORIES } from './constants.js';
|
|
1
2
|
import {} from '../core/secretDetectors.js';
|
|
2
3
|
import {} from '../core/exampleSecretDetector.js';
|
|
3
|
-
// Allowed categories for comparison
|
|
4
|
-
export const ALLOWED_CATEGORIES = [
|
|
5
|
-
'missing',
|
|
6
|
-
'extra',
|
|
7
|
-
'empty',
|
|
8
|
-
'mismatch',
|
|
9
|
-
'duplicate',
|
|
10
|
-
'gitignore',
|
|
11
|
-
];
|
|
12
4
|
//# sourceMappingURL=types.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/config/types.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/config/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAAsB,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAA6B,MAAM,kCAAkC,CAAC"}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import type { ScanResult } from '../config/types.js';
|
|
2
2
|
/**
|
|
3
3
|
* Compares the scan result with the environment variables.
|
|
4
|
+
* This function identifies missing and unused environment variables.
|
|
4
5
|
* @param scanResult - The result of the scan.
|
|
5
6
|
* @param envVariables - The environment variables to compare against.
|
|
6
7
|
* @returns The comparison result.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"compareScan.d.ts","sourceRoot":"","sources":["../../../src/core/compareScan.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAErD
|
|
1
|
+
{"version":3,"file":"compareScan.d.ts","sourceRoot":"","sources":["../../../src/core/compareScan.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAErD;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,UAAU,EAAE,UAAU,EACtB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GAC/C,UAAU,CAYZ"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Compares the scan result with the environment variables.
|
|
3
|
+
* This function identifies missing and unused environment variables.
|
|
3
4
|
* @param scanResult - The result of the scan.
|
|
4
5
|
* @param envVariables - The environment variables to compare against.
|
|
5
6
|
* @returns The comparison result.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"compareScan.js","sourceRoot":"","sources":["../../../src/core/compareScan.ts"],"names":[],"mappings":"AAEA
|
|
1
|
+
{"version":3,"file":"compareScan.js","sourceRoot":"","sources":["../../../src/core/compareScan.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CACjC,UAAsB,EACtB,YAAgD;IAEhD,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;IACtE,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IAEnD,MAAM,OAAO,GAAG,CAAC,GAAG,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAClE,MAAM,MAAM,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAEjE,OAAO;QACL,GAAG,UAAU;QACb,OAAO;QACP,MAAM;KACP,CAAC;AACJ,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"determineComparisonFile.d.ts","sourceRoot":"","sources":["../../../src/core/determineComparisonFile.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"determineComparisonFile.d.ts","sourceRoot":"","sources":["../../../src/core/determineComparisonFile.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAI3D,KAAK,cAAc,GAAG;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,gBAAgB,GACrB,cAAc,GAAG,SAAS,CA0B5B"}
|
|
@@ -1,13 +1,7 @@
|
|
|
1
1
|
import fs from 'fs';
|
|
2
2
|
import path from 'path';
|
|
3
|
-
import {} from '../config/types.js';
|
|
4
3
|
import { resolveFromCwd } from './helpers/resolveFromCwd.js';
|
|
5
|
-
|
|
6
|
-
'.env',
|
|
7
|
-
'.env.example',
|
|
8
|
-
'.env.local',
|
|
9
|
-
'.env.production',
|
|
10
|
-
];
|
|
4
|
+
import { DEFAULT_ENV_CANDIDATES } from '../config/constants.js';
|
|
11
5
|
/**
|
|
12
6
|
* Determines which file to use for comparison based on provided options
|
|
13
7
|
* @param {ScanUsageOptions} opts - Scan configuration options
|
|
@@ -28,7 +22,7 @@ export function determineComparisonFile(opts) {
|
|
|
28
22
|
}
|
|
29
23
|
}
|
|
30
24
|
// Auto-discovery: look for common env files relative to cwd
|
|
31
|
-
for (const candidate of
|
|
25
|
+
for (const candidate of DEFAULT_ENV_CANDIDATES) {
|
|
32
26
|
const fullPath = path.resolve(opts.cwd, candidate);
|
|
33
27
|
if (fs.existsSync(fullPath)) {
|
|
34
28
|
return { path: fullPath, name: candidate };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"determineComparisonFile.js","sourceRoot":"","sources":["../../../src/core/determineComparisonFile.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"determineComparisonFile.js","sourceRoot":"","sources":["../../../src/core/determineComparisonFile.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAOhE;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CACrC,IAAsB;IAEtB,sDAAsD;IAEtD,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;QACrB,MAAM,CAAC,GAAG,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACrD,IAAI,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;YACrB,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;QAC5D,CAAC;IACH,CAAC;IAED,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,MAAM,CAAC,GAAG,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACjD,IAAI,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;YACrB,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QACxD,CAAC;IACH,CAAC;IAED,4DAA4D;IAC5D,KAAK,MAAM,SAAS,IAAI,sBAAsB,EAAE,CAAC;QAC/C,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QACnD,IAAI,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5B,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;QAC7C,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"envPairing.d.ts","sourceRoot":"","sources":["../../../src/core/envPairing.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;
|
|
1
|
+
{"version":3,"file":"envPairing.d.ts","sourceRoot":"","sources":["../../../src/core/envPairing.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAG9D;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,SAAS,GAAG,KAAK,CAAC,QAAQ,CAAC,CAgC7D"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import fs from 'fs';
|
|
2
2
|
import path from 'path';
|
|
3
|
+
import { DEFAULT_ENV_FILE, DEFAULT_EXAMPLE_FILE } from '../config/constants.js';
|
|
3
4
|
/**
|
|
4
5
|
* Pairs each environment file with its corresponding example file.
|
|
5
6
|
* @param d - The discovery object containing environment and example file information.
|
|
@@ -14,8 +15,10 @@ export function pairWithExample(d) {
|
|
|
14
15
|
if (envAbs === path.resolve(d.cwd, d.primaryExample))
|
|
15
16
|
continue;
|
|
16
17
|
}
|
|
17
|
-
const suffix = envName ===
|
|
18
|
-
const exampleName = suffix
|
|
18
|
+
const suffix = envName === DEFAULT_ENV_FILE ? '' : envName.replace(DEFAULT_ENV_FILE, '');
|
|
19
|
+
const exampleName = suffix
|
|
20
|
+
? `${DEFAULT_EXAMPLE_FILE}${suffix}`
|
|
21
|
+
: d.primaryExample;
|
|
19
22
|
const envPathCurrent = path.resolve(d.cwd, envName);
|
|
20
23
|
const examplePathCurrent = d.exampleFlag && !d.envFlag
|
|
21
24
|
? path.resolve(d.cwd, d.primaryExample)
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"envPairing.js","sourceRoot":"","sources":["../../../src/core/envPairing.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"envPairing.js","sourceRoot":"","sources":["../../../src/core/envPairing.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAEhF;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,CAAY;IAC1C,MAAM,KAAK,GAAoB,EAAE,CAAC;IAClC,MAAM,IAAI,GAAG,CAAC,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;IAEjE,KAAK,MAAM,OAAO,IAAI,IAAI,EAAE,CAAC;QAC3B,IAAI,CAAC,CAAC,WAAW,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;YAChC,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;YAC5C,IAAI,MAAM,KAAK,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,cAAc,CAAC;gBAAE,SAAS;QACjE,CAAC;QAED,MAAM,MAAM,GACV,OAAO,KAAK,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC;QAC5E,MAAM,WAAW,GAAG,MAAM;YACxB,CAAC,CAAC,GAAG,oBAAoB,GAAG,MAAM,EAAE;YACpC,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC;QAErB,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACpD,MAAM,kBAAkB,GACtB,CAAC,CAAC,WAAW,IAAI,CAAC,CAAC,CAAC,OAAO;YACzB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,cAAc,CAAC;YACvC,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;gBAC/C,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,WAAW,CAAC;gBAClC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,cAAc,CAAC,CAAC;QAE9C,KAAK,CAAC,IAAI,CAAC;YACT,OAAO;YACP,OAAO,EAAE,cAAc;YACvB,WAAW,EAAE,kBAAkB;SAChC,CAAC,CAAC;IACL,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fixEnv.d.ts","sourceRoot":"","sources":["../../../src/core/fixEnv.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"fixEnv.d.ts","sourceRoot":"","sources":["../../../src/core/fixEnv.ts"],"names":[],"mappings":"AAKA,UAAU,iBAAiB;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,UAAU,SAAS;IACjB,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAC5B,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,gBAAgB,EAAE,OAAO,CAAC;CAC3B;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG;IACtD,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,SAAS,CAAC;CACnB,CA0FA"}
|
package/dist/src/core/fixEnv.js
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import fs from 'fs';
|
|
2
2
|
import path from 'path';
|
|
3
3
|
import { isEnvIgnoredByGit, isGitRepo, findGitRoot } from '../services/git.js';
|
|
4
|
+
import { DEFAULT_GITIGNORE_ENV_PATTERNS } from '../config/constants.js';
|
|
4
5
|
/**
|
|
5
6
|
* Applies fixes to the .env and .env.example files based on the detected issues.
|
|
6
7
|
*
|
|
@@ -105,7 +106,7 @@ function updateGitignoreForEnv(envPath) {
|
|
|
105
106
|
return false;
|
|
106
107
|
}
|
|
107
108
|
// Need to add patterns
|
|
108
|
-
const patterns =
|
|
109
|
+
const patterns = DEFAULT_GITIGNORE_ENV_PATTERNS;
|
|
109
110
|
if (fs.existsSync(gitignorePath)) {
|
|
110
111
|
const current = fs.readFileSync(gitignorePath, 'utf8');
|
|
111
112
|
const existingLines = current.split(/\r?\n/).map((l) => l.trim());
|