@simplysf/simply-utam-core 0.1.3 → 0.3.0
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/README.md +72 -14
- package/lib/forceignore/forceignore-manager.d.ts +30 -0
- package/lib/forceignore/forceignore-manager.js +30 -13
- package/lib/forceignore/forceignore-manager.js.map +1 -1
- package/lib/forceignore/index.d.ts +1 -1
- package/lib/forceignore/index.js +1 -1
- package/lib/forceignore/index.js.map +1 -1
- package/lib/gitignore/gitignore-manager.d.ts +64 -0
- package/lib/gitignore/gitignore-manager.js +96 -0
- package/lib/gitignore/gitignore-manager.js.map +1 -0
- package/lib/gitignore/index.d.ts +1 -0
- package/lib/gitignore/index.js +17 -0
- package/lib/gitignore/index.js.map +1 -0
- package/lib/index.d.ts +3 -1
- package/lib/index.js +3 -1
- package/lib/index.js.map +1 -1
- package/lib/namespaces/namespace-map.d.ts +18 -0
- package/lib/namespaces/namespace-map.js +75 -0
- package/lib/namespaces/namespace-map.js.map +1 -0
- package/lib/namespaces/namespace-rewriter.js +2 -47
- package/lib/namespaces/namespace-rewriter.js.map +1 -1
- package/lib/path-utils.d.ts +8 -0
- package/lib/path-utils.js +10 -0
- package/lib/path-utils.js.map +1 -1
- package/lib/scaffold/project-scaffolder.d.ts +75 -1
- package/lib/scaffold/project-scaffolder.js +267 -19
- package/lib/scaffold/project-scaffolder.js.map +1 -1
- package/lib/snapshot/capture.d.ts +56 -0
- package/lib/snapshot/capture.js +115 -0
- package/lib/snapshot/capture.js.map +1 -0
- package/lib/snapshot/console.d.ts +25 -0
- package/lib/snapshot/console.js +74 -0
- package/lib/snapshot/console.js.map +1 -0
- package/lib/snapshot/describe.d.ts +27 -0
- package/lib/snapshot/describe.js +76 -0
- package/lib/snapshot/describe.js.map +1 -0
- package/lib/snapshot/files.d.ts +85 -0
- package/lib/snapshot/files.js +185 -0
- package/lib/snapshot/files.js.map +1 -0
- package/lib/snapshot/find.d.ts +36 -0
- package/lib/snapshot/find.js +186 -0
- package/lib/snapshot/find.js.map +1 -0
- package/lib/snapshot/format.d.ts +96 -0
- package/lib/snapshot/format.js +100 -0
- package/lib/snapshot/format.js.map +1 -0
- package/lib/snapshot/header.d.ts +38 -0
- package/lib/snapshot/header.js +120 -0
- package/lib/snapshot/header.js.map +1 -0
- package/lib/snapshot/index.d.ts +13 -0
- package/lib/snapshot/index.js +28 -0
- package/lib/snapshot/index.js.map +1 -0
- package/lib/snapshot/locate.d.ts +61 -0
- package/lib/snapshot/locate.js +110 -0
- package/lib/snapshot/locate.js.map +1 -0
- package/lib/snapshot/lookup.d.ts +53 -0
- package/lib/snapshot/lookup.js +188 -0
- package/lib/snapshot/lookup.js.map +1 -0
- package/lib/snapshot/page-object-index.d.ts +149 -0
- package/lib/snapshot/page-object-index.js +806 -0
- package/lib/snapshot/page-object-index.js.map +1 -0
- package/lib/snapshot/page-object-packages.d.ts +41 -0
- package/lib/snapshot/page-object-packages.js +115 -0
- package/lib/snapshot/page-object-packages.js.map +1 -0
- package/lib/snapshot/path.d.ts +102 -0
- package/lib/snapshot/path.js +381 -0
- package/lib/snapshot/path.js.map +1 -0
- package/lib/snapshot/query-result.d.ts +20 -0
- package/lib/snapshot/query-result.js +32 -0
- package/lib/snapshot/query-result.js.map +1 -0
- package/lib/snapshot/selector.d.ts +103 -0
- package/lib/snapshot/selector.js +280 -0
- package/lib/snapshot/selector.js.map +1 -0
- package/lib/snapshot/tree.d.ts +76 -0
- package/lib/snapshot/tree.js +201 -0
- package/lib/snapshot/tree.js.map +1 -0
- package/lib/snapshot/walker.js +532 -0
- package/package.json +11 -3
- package/templates/dom-snapshot.steps.mjs +34 -0
- package/templates/wdio.conf.mjs +81 -4
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Copyright (c) 2026, SimplySF.
|
|
3
|
+
*
|
|
4
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
* you may not use this file except in compliance with the License.
|
|
6
|
+
* You may obtain a copy of the License at
|
|
7
|
+
*
|
|
8
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
*
|
|
10
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
* See the License for the specific language governing permissions and
|
|
14
|
+
* limitations under the License.
|
|
15
|
+
*/
|
|
16
|
+
import fs from 'node:fs';
|
|
17
|
+
import path from 'node:path';
|
|
18
|
+
/** Where `init` scaffolds the namespace map, relative to the project. */
|
|
19
|
+
export const DEFAULT_NAMESPACE_MAP = path.join('.utam', 'namespace-map.json');
|
|
20
|
+
/**
|
|
21
|
+
* Read a namespace map, or take the mappings given, sorted so longer, more specific prefixes match
|
|
22
|
+
* first. Internal to core: `rewrite` and the page-object index share it, so both read the file the
|
|
23
|
+
* same way.
|
|
24
|
+
*
|
|
25
|
+
* @param rootDir The project folder a relative `configFile` resolves against.
|
|
26
|
+
* @param configFile The map's path. Defaults to `.utam/namespace-map.json`.
|
|
27
|
+
* @param mappings Mappings to use instead of reading a file.
|
|
28
|
+
*/
|
|
29
|
+
export function resolveNamespaceMappings(rootDir, configFile, mappings) {
|
|
30
|
+
let rawMappings = {};
|
|
31
|
+
if (mappings) {
|
|
32
|
+
rawMappings = mappings;
|
|
33
|
+
}
|
|
34
|
+
else {
|
|
35
|
+
const configPath = configFile
|
|
36
|
+
? path.isAbsolute(configFile)
|
|
37
|
+
? configFile
|
|
38
|
+
: path.resolve(rootDir, configFile)
|
|
39
|
+
: path.join(rootDir, DEFAULT_NAMESPACE_MAP);
|
|
40
|
+
if (!fs.existsSync(configPath)) {
|
|
41
|
+
return {
|
|
42
|
+
sortedMappings: [],
|
|
43
|
+
configMissingOrEmpty: true,
|
|
44
|
+
notice: `Namespace configuration file not found at ${configPath}. Exiting cleanly.`,
|
|
45
|
+
};
|
|
46
|
+
}
|
|
47
|
+
try {
|
|
48
|
+
const configContent = fs.readFileSync(configPath, 'utf-8');
|
|
49
|
+
const parsed = JSON.parse(configContent);
|
|
50
|
+
if (parsed && typeof parsed === 'object' && !Array.isArray(parsed)) {
|
|
51
|
+
rawMappings = parsed;
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
catch (err) {
|
|
55
|
+
return {
|
|
56
|
+
sortedMappings: [],
|
|
57
|
+
configMissingOrEmpty: true,
|
|
58
|
+
notice: `Failed to parse namespace config file: ${err.message}`,
|
|
59
|
+
};
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
const mappingEntries = Object.entries(rawMappings).filter(([prefix, replacement]) => typeof prefix === 'string' && prefix.trim() && typeof replacement === 'string');
|
|
63
|
+
if (mappingEntries.length === 0) {
|
|
64
|
+
return {
|
|
65
|
+
sortedMappings: [],
|
|
66
|
+
configMissingOrEmpty: true,
|
|
67
|
+
notice: 'Namespace mapping object is empty. No rewrites required.',
|
|
68
|
+
};
|
|
69
|
+
}
|
|
70
|
+
return {
|
|
71
|
+
sortedMappings: [...mappingEntries].sort((a, b) => b[0].length - a[0].length),
|
|
72
|
+
configMissingOrEmpty: false,
|
|
73
|
+
};
|
|
74
|
+
}
|
|
75
|
+
//# sourceMappingURL=namespace-map.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"namespace-map.js","sourceRoot":"","sources":["../../src/namespaces/namespace-map.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,yEAAyE;AACzE,MAAM,CAAC,MAAM,qBAAqB,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC;AAS9E;;;;;;;;GAQG;AACH,MAAM,UAAU,wBAAwB,CACtC,OAAe,EACf,UAAmB,EACnB,QAAiC;IAEjC,IAAI,WAAW,GAA2B,EAAE,CAAC;IAE7C,IAAI,QAAQ,EAAE,CAAC;QACb,WAAW,GAAG,QAAQ,CAAC;IACzB,CAAC;SAAM,CAAC;QACN,MAAM,UAAU,GAAG,UAAU;YAC3B,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;gBAC3B,CAAC,CAAC,UAAU;gBACZ,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,UAAU,CAAC;YACrC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,qBAAqB,CAAC,CAAC;QAE9C,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;YAC/B,OAAO;gBACL,cAAc,EAAE,EAAE;gBAClB,oBAAoB,EAAE,IAAI;gBAC1B,MAAM,EAAE,6CAA6C,UAAU,oBAAoB;aACpF,CAAC;QACJ,CAAC;QAED,IAAI,CAAC;YACH,MAAM,aAAa,GAAG,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;YAC3D,MAAM,MAAM,GAAY,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;YAClD,IAAI,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;gBACnE,WAAW,GAAG,MAAgC,CAAC;YACjD,CAAC;QACH,CAAC;QAAC,OAAO,GAAY,EAAE,CAAC;YACtB,OAAO;gBACL,cAAc,EAAE,EAAE;gBAClB,oBAAoB,EAAE,IAAI;gBAC1B,MAAM,EAAE,0CAA2C,GAAa,CAAC,OAAO,EAAE;aAC3E,CAAC;QACJ,CAAC;IACH,CAAC;IAED,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,MAAM,CACvD,CAAC,CAAC,MAAM,EAAE,WAAW,CAAC,EAAE,EAAE,CAAC,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,IAAI,EAAE,IAAI,OAAO,WAAW,KAAK,QAAQ,CAC1G,CAAC;IAEF,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAChC,OAAO;YACL,cAAc,EAAE,EAAE;YAClB,oBAAoB,EAAE,IAAI;YAC1B,MAAM,EAAE,0DAA0D;SACnE,CAAC;IACJ,CAAC;IAED,OAAO;QACL,cAAc,EAAE,CAAC,GAAG,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;QAC7E,oBAAoB,EAAE,KAAK;KAC5B,CAAC;AACJ,CAAC"}
|
|
@@ -17,6 +17,7 @@ import fs from 'node:fs';
|
|
|
17
17
|
import path from 'node:path';
|
|
18
18
|
import { discoverProject } from '../discovery/index.js';
|
|
19
19
|
import { detectIndentation } from '../overrides/index.js';
|
|
20
|
+
import { resolveNamespaceMappings } from './namespace-map.js';
|
|
20
21
|
/**
|
|
21
22
|
* Recursively locates all *.utam.json files in a directory.
|
|
22
23
|
*
|
|
@@ -85,52 +86,6 @@ export function updateValueWithMappings(value, sortedMappings, changesList) {
|
|
|
85
86
|
}
|
|
86
87
|
return value;
|
|
87
88
|
}
|
|
88
|
-
function resolveMappings(rootDir, configFile, mappings) {
|
|
89
|
-
let rawMappings = {};
|
|
90
|
-
if (mappings) {
|
|
91
|
-
rawMappings = mappings;
|
|
92
|
-
}
|
|
93
|
-
else {
|
|
94
|
-
const configPath = configFile
|
|
95
|
-
? path.isAbsolute(configFile)
|
|
96
|
-
? configFile
|
|
97
|
-
: path.resolve(rootDir, configFile)
|
|
98
|
-
: path.join(rootDir, '.utam', 'namespace-map.json');
|
|
99
|
-
if (!fs.existsSync(configPath)) {
|
|
100
|
-
return {
|
|
101
|
-
sortedMappings: [],
|
|
102
|
-
configMissingOrEmpty: true,
|
|
103
|
-
notice: `Namespace configuration file not found at ${configPath}. Exiting cleanly.`,
|
|
104
|
-
};
|
|
105
|
-
}
|
|
106
|
-
try {
|
|
107
|
-
const configContent = fs.readFileSync(configPath, 'utf-8');
|
|
108
|
-
const parsed = JSON.parse(configContent);
|
|
109
|
-
if (parsed && typeof parsed === 'object' && !Array.isArray(parsed)) {
|
|
110
|
-
rawMappings = parsed;
|
|
111
|
-
}
|
|
112
|
-
}
|
|
113
|
-
catch (err) {
|
|
114
|
-
return {
|
|
115
|
-
sortedMappings: [],
|
|
116
|
-
configMissingOrEmpty: true,
|
|
117
|
-
notice: `Failed to parse namespace config file: ${err.message}`,
|
|
118
|
-
};
|
|
119
|
-
}
|
|
120
|
-
}
|
|
121
|
-
const mappingEntries = Object.entries(rawMappings).filter(([prefix, replacement]) => typeof prefix === 'string' && prefix.trim() && typeof replacement === 'string');
|
|
122
|
-
if (mappingEntries.length === 0) {
|
|
123
|
-
return {
|
|
124
|
-
sortedMappings: [],
|
|
125
|
-
configMissingOrEmpty: true,
|
|
126
|
-
notice: 'Namespace mapping object is empty. No rewrites required.',
|
|
127
|
-
};
|
|
128
|
-
}
|
|
129
|
-
return {
|
|
130
|
-
sortedMappings: [...mappingEntries].sort((a, b) => b[0].length - a[0].length),
|
|
131
|
-
configMissingOrEmpty: false,
|
|
132
|
-
};
|
|
133
|
-
}
|
|
134
89
|
function processSingleUtamFile(file, sortedMappings, dryRun) {
|
|
135
90
|
let fileContent;
|
|
136
91
|
let originalJson;
|
|
@@ -179,7 +134,7 @@ function processSingleUtamFile(file, sortedMappings, dryRun) {
|
|
|
179
134
|
export function rewriteUtamNamespaces(options = {}) {
|
|
180
135
|
const rootDir = path.resolve(options.rootDir ?? process.cwd());
|
|
181
136
|
const dryRun = Boolean(options.dryRun);
|
|
182
|
-
const resolution =
|
|
137
|
+
const resolution = resolveNamespaceMappings(rootDir, options.configFile, options.mappings);
|
|
183
138
|
if (resolution.configMissingOrEmpty) {
|
|
184
139
|
return {
|
|
185
140
|
filesScanned: 0,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"namespace-rewriter.js","sourceRoot":"","sources":["../../src/namespaces/namespace-rewriter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;
|
|
1
|
+
{"version":3,"file":"namespace-rewriter.js","sourceRoot":"","sources":["../../src/namespaces/namespace-rewriter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAC;AAiC9D;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,OAAe;IAC/C,MAAM,SAAS,GAAa,EAAE,CAAC;IAC/B,IAAI,CAAC;QACH,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5B,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,OAAO,GAAG,EAAE,CAAC,WAAW,CAAC,OAAO,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;QACjE,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC5B,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;YAChD,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;gBACxB,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;gBACxB,IACE,IAAI,KAAK,cAAc;oBACvB,IAAI,KAAK,MAAM;oBACf,IAAI,KAAK,MAAM;oBACf,IAAI,KAAK,KAAK;oBACd,IAAI,KAAK,SAAS;oBAClB,IAAI,KAAK,aAAa;oBACtB,IAAI,KAAK,gBAAgB,EACzB,CAAC;oBACD,SAAS,CAAC,IAAI,CAAC,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC,CAAC;gBACjD,CAAC;YACH,CAAC;iBAAM,IAAI,KAAK,CAAC,MAAM,EAAE,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;gBAC/D,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QACP,0CAA0C;IAC5C,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,uBAAuB,CACrC,KAAc,EACd,cAAuC,EACvC,WAAmC;IAEnC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,KAAK,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,IAAI,cAAc,EAAE,CAAC;YACnD,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC7B,MAAM,OAAO,GAAG,WAAW,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;gBACzD,WAAW,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;gBAC/C,OAAO,OAAO,CAAC;YACjB,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,uBAAuB,CAAC,IAAI,EAAE,cAAc,EAAE,WAAW,CAAC,CAAC,CAAC;IACzF,CAAC;IAED,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAChD,MAAM,UAAU,GAA4B,EAAE,CAAC;QAC/C,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC/C,UAAU,CAAC,GAAG,CAAC,GAAG,uBAAuB,CAAC,GAAG,EAAE,cAAc,EAAE,WAAW,CAAC,CAAC;QAC9E,CAAC;QACD,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,qBAAqB,CAC5B,IAAY,EACZ,cAAuC,EACvC,MAAe;IAEf,IAAI,WAAmB,CAAC;IACxB,IAAI,YAAqB,CAAC;IAC1B,IAAI,CAAC;QACH,WAAW,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC7C,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IACzC,CAAC;IAAC,OAAO,GAAY,EAAE,CAAC;QACtB,OAAO;YACL,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,EAAE;YACX,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,8BAA+B,GAAa,CAAC,OAAO,EAAE;SAC9D,CAAC;IACJ,CAAC;IAED,MAAM,WAAW,GAA2B,EAAE,CAAC;IAC/C,MAAM,WAAW,GAAG,uBAAuB,CAAC,YAAY,EAAE,cAAc,EAAE,WAAW,CAAC,CAAC;IAEvF,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7B,OAAO;YACL,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,EAAE;YACX,OAAO,EAAE,KAAK;SACf,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,MAAM,GAAG,iBAAiB,CAAC,WAAW,CAAC,CAAC;QAC9C,MAAM,eAAe,GAAG,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QAC9D,IAAI,eAAe,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACrD,aAAa,IAAI,IAAI,CAAC;QACxB,CAAC;QACD,EAAE,CAAC,aAAa,CAAC,IAAI,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IAED,OAAO;QACL,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,WAAW;QACpB,OAAO,EAAE,IAAI;KACd,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CAAC,UAAoC,EAAE;IAC1E,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IAC/D,MAAM,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAEvC,MAAM,UAAU,GAAG,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC3F,IAAI,UAAU,CAAC,oBAAoB,EAAE,CAAC;QACpC,OAAO;YACL,YAAY,EAAE,CAAC;YACf,aAAa,EAAE,CAAC;YAChB,iBAAiB,EAAE,CAAC;YACpB,MAAM;YACN,oBAAoB,EAAE,IAAI;YAC1B,MAAM,EAAE,UAAU,CAAC,MAAM;YACzB,OAAO,EAAE,EAAE;SACZ,CAAC;IACJ,CAAC;IAED,IAAI,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;IACpC,IAAI,CAAC,UAAU,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3C,MAAM,UAAU,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;QAC5C,UAAU,GAAG,UAAU,CAAC,kBAAkB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC;IAC5G,CAAC;IAED,MAAM,YAAY,GAAa,EAAE,CAAC;IAClC,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACnC,MAAM,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QACjG,YAAY,CAAC,IAAI,CAAC,GAAG,iBAAiB,CAAC,cAAc,CAAC,CAAC,CAAC;IAC1D,CAAC;IAED,MAAM,eAAe,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC;IAE1D,MAAM,MAAM,GAA4B;QACtC,YAAY,EAAE,eAAe,CAAC,MAAM;QACpC,aAAa,EAAE,CAAC;QAChB,iBAAiB,EAAE,CAAC;QACpB,MAAM;QACN,oBAAoB,EAAE,KAAK;QAC3B,OAAO,EAAE,EAAE;KACZ,CAAC;IAEF,KAAK,MAAM,IAAI,IAAI,eAAe,EAAE,CAAC;QACnC,MAAM,UAAU,GAAG,qBAAqB,CAAC,IAAI,EAAE,UAAU,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;QAClF,IAAI,UAAU,CAAC,OAAO,EAAE,CAAC;YACvB,MAAM,CAAC,aAAa,EAAE,CAAC;YACvB,MAAM,CAAC,iBAAiB,IAAI,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC;QACxD,CAAC;QACD,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAClC,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}
|
package/lib/path-utils.d.ts
CHANGED
|
@@ -14,3 +14,11 @@ export declare function toPosixRelative(dir: string): string;
|
|
|
14
14
|
* @returns True if the path is absolute on POSIX or Windows.
|
|
15
15
|
*/
|
|
16
16
|
export declare function isAbsoluteOnAnyPlatform(dir: string): boolean;
|
|
17
|
+
/**
|
|
18
|
+
* Whether a path normalized by toPosixRelative points outside the project root: absolute, or starting
|
|
19
|
+
* with '..'.
|
|
20
|
+
*
|
|
21
|
+
* @param dir - A path normalized by toPosixRelative.
|
|
22
|
+
* @returns True if the path is outside the project root.
|
|
23
|
+
*/
|
|
24
|
+
export declare function isOutsideProject(dir: string): boolean;
|
package/lib/path-utils.js
CHANGED
|
@@ -39,4 +39,14 @@ export function toPosixRelative(dir) {
|
|
|
39
39
|
export function isAbsoluteOnAnyPlatform(dir) {
|
|
40
40
|
return path.posix.isAbsolute(dir) || path.win32.isAbsolute(dir);
|
|
41
41
|
}
|
|
42
|
+
/**
|
|
43
|
+
* Whether a path normalized by toPosixRelative points outside the project root: absolute, or starting
|
|
44
|
+
* with '..'.
|
|
45
|
+
*
|
|
46
|
+
* @param dir - A path normalized by toPosixRelative.
|
|
47
|
+
* @returns True if the path is outside the project root.
|
|
48
|
+
*/
|
|
49
|
+
export function isOutsideProject(dir) {
|
|
50
|
+
return isAbsoluteOnAnyPlatform(dir) || dir === '..' || dir.startsWith('../');
|
|
51
|
+
}
|
|
42
52
|
//# sourceMappingURL=path-utils.js.map
|
package/lib/path-utils.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"path-utils.js","sourceRoot":"","sources":["../src/path-utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAElC,2FAA2F;AAE3F;;;;;;GAMG;AACH,MAAM,UAAU,eAAe,CAAC,GAAW;IACzC,OAAO,GAAG;SACP,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;SACnB,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC;SACvB,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;SACnB,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACzB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,uBAAuB,CAAC,GAAW;IACjD,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;AAClE,CAAC"}
|
|
1
|
+
{"version":3,"file":"path-utils.js","sourceRoot":"","sources":["../src/path-utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAElC,2FAA2F;AAE3F;;;;;;GAMG;AACH,MAAM,UAAU,eAAe,CAAC,GAAW;IACzC,OAAO,GAAG;SACP,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;SACnB,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC;SACvB,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;SACnB,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACzB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,uBAAuB,CAAC,GAAW;IACjD,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;AAClE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAAC,GAAW;IAC1C,OAAO,uBAAuB,CAAC,GAAG,CAAC,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;AAC/E,CAAC"}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { type ForceignoreResult } from '../forceignore/index.js';
|
|
2
|
+
import { type GitignoreResult } from '../gitignore/index.js';
|
|
2
3
|
/**
|
|
3
4
|
* Default location of external scaffold template files.
|
|
4
5
|
* Resolves to the templates directory in @simplysf/simply-utam-core whether in src or lib.
|
|
@@ -49,6 +50,10 @@ export interface ScaffoldOptions {
|
|
|
49
50
|
* Exact line that ends the .forceignore customization region. Defaults to '# -- END CUSTOMIZATION'.
|
|
50
51
|
*/
|
|
51
52
|
forceignoreRegionEnd?: string;
|
|
53
|
+
/**
|
|
54
|
+
* If false, leaves .gitignore untouched. Defaults to true.
|
|
55
|
+
*/
|
|
56
|
+
gitignore?: boolean;
|
|
52
57
|
}
|
|
53
58
|
/**
|
|
54
59
|
* Result details from executing project scaffolding.
|
|
@@ -78,7 +83,48 @@ export interface ScaffoldResult {
|
|
|
78
83
|
* What happened to .forceignore. Absent when the forceignore option is false.
|
|
79
84
|
*/
|
|
80
85
|
forceignore?: ForceignoreResult;
|
|
86
|
+
/**
|
|
87
|
+
* What happened to .gitignore. Absent when the gitignore option is false.
|
|
88
|
+
*/
|
|
89
|
+
gitignore?: GitignoreResult;
|
|
90
|
+
/**
|
|
91
|
+
* True when an existing wdio.conf.mjs was kept and doesn't capture DOM snapshots: its hooks have to
|
|
92
|
+
* be added by hand.
|
|
93
|
+
*/
|
|
94
|
+
snapshotHooksMissing: boolean;
|
|
95
|
+
/**
|
|
96
|
+
* What happened to the package.json "exports" entry for page objects. Absent without a package.json.
|
|
97
|
+
*/
|
|
98
|
+
pageObjectExports?: PageObjectExportsResult;
|
|
99
|
+
/**
|
|
100
|
+
* Problems scaffolding found but could not fix, such as an existing config that uses a different
|
|
101
|
+
* namespace than the one scaffolding would write.
|
|
102
|
+
*/
|
|
103
|
+
warnings: string[];
|
|
81
104
|
}
|
|
105
|
+
/**
|
|
106
|
+
* What ensurePageObjectExports did to package.json "exports": 'added' when the entry was written,
|
|
107
|
+
* 'unchanged' when "exports" already has it, 'skipped' when it could not be added safely.
|
|
108
|
+
*
|
|
109
|
+
* subpath is the "exports" key for page objects, such as './pageObjects/*'; a skipped result has none
|
|
110
|
+
* when the page object folder can't be exported. createdExports is true when package.json had no
|
|
111
|
+
* "exports" and now has one, which closes the package to imports of its root and of any subpath it
|
|
112
|
+
* does not list. reason says why the entry was skipped.
|
|
113
|
+
*/
|
|
114
|
+
export type PageObjectExportsResult = {
|
|
115
|
+
action: 'added';
|
|
116
|
+
subpath: string;
|
|
117
|
+
createdExports: boolean;
|
|
118
|
+
} | {
|
|
119
|
+
action: 'unchanged';
|
|
120
|
+
subpath: string;
|
|
121
|
+
createdExports: false;
|
|
122
|
+
} | {
|
|
123
|
+
action: 'skipped';
|
|
124
|
+
subpath?: string;
|
|
125
|
+
createdExports: false;
|
|
126
|
+
reason: string;
|
|
127
|
+
};
|
|
82
128
|
/**
|
|
83
129
|
* Loads an external template file from disk, performing token replacements.
|
|
84
130
|
*
|
|
@@ -110,9 +156,12 @@ export declare function generateUtamConfig(templatesDir?: string): Record<string
|
|
|
110
156
|
*
|
|
111
157
|
* @param sourceDir - The primary Salesforce source directory.
|
|
112
158
|
* @param templatesDir - Optional custom directory containing the template file.
|
|
159
|
+
* @param testDirs - The project's UTAM test folders. Those the template's globs don't reach, such as
|
|
160
|
+
* `test/utam` at the project root or `<sourceDir>/tests/utam`, are added to `specs` and
|
|
161
|
+
* `cucumberOpts.require`.
|
|
113
162
|
* @returns Formatted JavaScript module text for wdio.conf.mjs.
|
|
114
163
|
*/
|
|
115
|
-
export declare function generateWdioConfig(sourceDir: string, templatesDir?: string): string;
|
|
164
|
+
export declare function generateWdioConfig(sourceDir: string, templatesDir?: string, testDirs?: string[]): string;
|
|
116
165
|
/**
|
|
117
166
|
* Generates the .utam/namespace-map.json content by loading its external template.
|
|
118
167
|
*
|
|
@@ -135,6 +184,14 @@ export declare function generateHelloFeature(templatesDir?: string): string;
|
|
|
135
184
|
* @returns Formatted JavaScript module text for hello.steps.mjs.
|
|
136
185
|
*/
|
|
137
186
|
export declare function generateHelloSteps(templatesDir?: string): string;
|
|
187
|
+
/**
|
|
188
|
+
* Generates the dom-snapshot.steps.mjs step definitions (`I capture the DOM snapshot`) by loading
|
|
189
|
+
* their external template.
|
|
190
|
+
*
|
|
191
|
+
* @param templatesDir - Optional custom directory containing the template file.
|
|
192
|
+
* @returns The step definitions' JavaScript module text.
|
|
193
|
+
*/
|
|
194
|
+
export declare function generateSnapshotSteps(templatesDir?: string): string;
|
|
138
195
|
/**
|
|
139
196
|
* Non-destructively injects standard UTAM Wireit scripts and task configurations into a package.json object.
|
|
140
197
|
* Loads task definitions from external wireit.json template.
|
|
@@ -149,6 +206,23 @@ export declare function injectWireitConfiguration(packageJson: Record<string, un
|
|
|
149
206
|
addedScripts: string[];
|
|
150
207
|
addedTasks: string[];
|
|
151
208
|
};
|
|
209
|
+
/**
|
|
210
|
+
* Adds the package.json "exports" entry that lets compiled page objects import each other. The UTAM
|
|
211
|
+
* compiler writes those imports as extensionless subpaths of the project's own package name
|
|
212
|
+
* ('my-app/pageObjects/bar'), taken from the generator namespace, which Node resolves only through
|
|
213
|
+
* "exports", so the entry maps them to the .js files in the output folder. Only ever adds the one key:
|
|
214
|
+
* an existing entry is never changed, and an "exports" that can't be extended without restructuring it
|
|
215
|
+
* is left alone.
|
|
216
|
+
*
|
|
217
|
+
* @param packageJson - The existing package.json object.
|
|
218
|
+
* @param outputDir - The page object output folder, pageObjectsOutputDir in utam.config.json.
|
|
219
|
+
* @param importDir - The part of the namespace after the package name, 'pageObjects' for 'my-app/pageObjects/'.
|
|
220
|
+
* @returns The package.json object, updated or as given, and what was done.
|
|
221
|
+
*/
|
|
222
|
+
export declare function ensurePageObjectExports(packageJson: Record<string, unknown>, outputDir?: string, importDir?: string): {
|
|
223
|
+
packageJson: Record<string, unknown>;
|
|
224
|
+
result: PageObjectExportsResult;
|
|
225
|
+
};
|
|
152
226
|
/**
|
|
153
227
|
* Checks a package.json object for missing recommended devDependencies.
|
|
154
228
|
*
|