@rxap/ngx-marker-io 21.0.1-dev.0 → 21.0.1-dev.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.
- package/CHANGELOG.md +9 -0
- package/compodoc/changelog.html +8 -0
- package/compodoc/dependencies.html +4 -4
- package/compodoc/js/search/search_index.js +2 -2
- package/compodoc/properties.html +1 -1
- package/docs/documentation.json +10 -10
- package/docs/html/classes/MarkerIoService.html +2 -2
- package/docs/html/functions/provideMarkerIo.html +1 -1
- package/docs/html/index.html +2 -2
- package/docs/html/modules.html +1 -1
- package/docs/markdown/README.md +1 -1
- package/docs/markdown/classes/MarkerIoService.md +5 -5
- package/docs/markdown/functions/provideMarkerIo.md +2 -2
- package/docs/markdown/globals.md +2 -2
- package/docs/wiki/Class.MarkerIoService.md +4 -4
- package/docs/wiki/Function.provideMarkerIo.md +1 -1
- package/docs/wiki/globals.md +1 -1
- package/package.json +9 -9
- package/src/generators/init/generator.spec.ts +228 -0
|
@@ -0,0 +1,228 @@
|
|
|
1
|
+
import { readJson, Tree, writeJson } from '@nx/devkit';
|
|
2
|
+
import { createTreeWithEmptyWorkspace } from '@nx/devkit/testing';
|
|
3
|
+
import { readFileSync } from 'fs';
|
|
4
|
+
import { join } from 'path';
|
|
5
|
+
import initGenerator from './generator';
|
|
6
|
+
|
|
7
|
+
const mockFiles: Record<string, string> = ((globalThis as any).__mockFiles = {});
|
|
8
|
+
|
|
9
|
+
jest.mock('fs', () => {
|
|
10
|
+
const actual = jest.requireActual('fs');
|
|
11
|
+
const mockFiles = (): Record<string, string> => (globalThis as any).__mockFiles ?? {};
|
|
12
|
+
return {
|
|
13
|
+
...actual,
|
|
14
|
+
existsSync: (p: string) => p in mockFiles() || actual.existsSync(p),
|
|
15
|
+
readFileSync: (p: string, ...rest: any[]) =>
|
|
16
|
+
p in mockFiles() ? mockFiles()[p] : actual.readFileSync(p, ...rest),
|
|
17
|
+
};
|
|
18
|
+
});
|
|
19
|
+
|
|
20
|
+
jest.mock('@nx/devkit', () => ({
|
|
21
|
+
...jest.requireActual('@nx/devkit'),
|
|
22
|
+
installPackagesTask: jest.fn(),
|
|
23
|
+
}));
|
|
24
|
+
|
|
25
|
+
const pkg = JSON.parse(
|
|
26
|
+
readFileSync(join(__dirname, '..', '..', '..', 'package.json'), 'utf-8'),
|
|
27
|
+
);
|
|
28
|
+
const peers: Record<string, string> = pkg.peerDependencies ?? {};
|
|
29
|
+
const peerNames = Object.keys(peers);
|
|
30
|
+
|
|
31
|
+
describe('initGenerator', () => {
|
|
32
|
+
let tree: Tree;
|
|
33
|
+
|
|
34
|
+
beforeEach(() => {
|
|
35
|
+
tree = createTreeWithEmptyWorkspace();
|
|
36
|
+
jest.spyOn(console, 'log').mockImplementation(() => undefined);
|
|
37
|
+
jest.spyOn(console, 'warn').mockImplementation(() => undefined);
|
|
38
|
+
jest.spyOn(console, 'error').mockImplementation(() => undefined);
|
|
39
|
+
});
|
|
40
|
+
|
|
41
|
+
afterEach(() => jest.restoreAllMocks());
|
|
42
|
+
|
|
43
|
+
it('is a function exported as default', () => {
|
|
44
|
+
expect(typeof initGenerator).toBe('function');
|
|
45
|
+
});
|
|
46
|
+
|
|
47
|
+
if (peerNames.length) {
|
|
48
|
+
it('adds missing peer dependencies to the root package.json', async () => {
|
|
49
|
+
writeJson(tree, 'package.json', {
|
|
50
|
+
name: 'root',
|
|
51
|
+
dependencies: { [pkg.name]: '1.0.0' },
|
|
52
|
+
devDependencies: {},
|
|
53
|
+
});
|
|
54
|
+
await initGenerator(tree, {} as any);
|
|
55
|
+
const json = readJson(tree, 'package.json');
|
|
56
|
+
for (const [dep, version] of Object.entries(peers)) {
|
|
57
|
+
expect(json.dependencies[dep] ?? json.devDependencies[dep]).toBe(
|
|
58
|
+
version,
|
|
59
|
+
);
|
|
60
|
+
}
|
|
61
|
+
});
|
|
62
|
+
|
|
63
|
+
it('does not change package.json when all peers exist', async () => {
|
|
64
|
+
const deps = { [pkg.name]: '1.0.0', ...peers };
|
|
65
|
+
writeJson(tree, 'package.json', {
|
|
66
|
+
name: 'root',
|
|
67
|
+
dependencies: deps,
|
|
68
|
+
devDependencies: {},
|
|
69
|
+
});
|
|
70
|
+
await initGenerator(tree, {} as any);
|
|
71
|
+
expect(readJson(tree, 'package.json').dependencies).toEqual(deps);
|
|
72
|
+
});
|
|
73
|
+
|
|
74
|
+
it('adds peers to devDependencies when the package is a dev dependency', async () => {
|
|
75
|
+
writeJson(tree, 'package.json', {
|
|
76
|
+
name: 'root',
|
|
77
|
+
dependencies: {},
|
|
78
|
+
devDependencies: { [pkg.name]: '1.0.0' },
|
|
79
|
+
});
|
|
80
|
+
await initGenerator(tree, {} as any);
|
|
81
|
+
const json = readJson(tree, 'package.json');
|
|
82
|
+
if (/^@rxap\/(ngx|nest)/.test(pkg.name)) {
|
|
83
|
+
// runtime packages are moved to dependencies
|
|
84
|
+
expect(json.dependencies[pkg.name]).toBe('1.0.0');
|
|
85
|
+
expect(json.devDependencies[pkg.name]).toBeUndefined();
|
|
86
|
+
expect(json.dependencies[peerNames[0]]).toBe(peers[peerNames[0]]);
|
|
87
|
+
} else {
|
|
88
|
+
expect(json.devDependencies[peerNames[0]]).toBe(peers[peerNames[0]]);
|
|
89
|
+
}
|
|
90
|
+
});
|
|
91
|
+
} else {
|
|
92
|
+
it('does nothing when the package declares no peer dependencies', async () => {
|
|
93
|
+
writeJson(tree, 'package.json', { name: 'root', dependencies: {} });
|
|
94
|
+
const before = tree.read('package.json', 'utf-8');
|
|
95
|
+
await initGenerator(tree, {} as any);
|
|
96
|
+
expect(tree.read('package.json', 'utf-8')).toBe(before);
|
|
97
|
+
});
|
|
98
|
+
}
|
|
99
|
+
});
|
|
100
|
+
|
|
101
|
+
describe('initGenerator with mocked package metadata', () => {
|
|
102
|
+
const ownPkg = join(__dirname, '..', '..', '..', 'package.json');
|
|
103
|
+
const peerPkg = (name: string) =>
|
|
104
|
+
join('/virtual', 'node_modules', ...name.split('/'), 'package.json');
|
|
105
|
+
let tree: Tree;
|
|
106
|
+
let logs: string[];
|
|
107
|
+
|
|
108
|
+
const setOwn = (json: object) => {
|
|
109
|
+
mockFiles[ownPkg] = JSON.stringify(json);
|
|
110
|
+
};
|
|
111
|
+
|
|
112
|
+
beforeEach(() => {
|
|
113
|
+
for (const k of Object.keys(mockFiles)) delete mockFiles[k];
|
|
114
|
+
tree = createTreeWithEmptyWorkspace();
|
|
115
|
+
logs = [];
|
|
116
|
+
jest.spyOn(console, 'log').mockImplementation((m) => void logs.push(String(m)));
|
|
117
|
+
jest.spyOn(console, 'warn').mockImplementation(() => undefined);
|
|
118
|
+
jest.spyOn(console, 'error').mockImplementation(() => undefined);
|
|
119
|
+
});
|
|
120
|
+
|
|
121
|
+
afterEach(() => jest.restoreAllMocks());
|
|
122
|
+
|
|
123
|
+
it('logs and returns when package.json is missing', async () => {
|
|
124
|
+
const spy = jest.spyOn(require('fs'), 'existsSync');
|
|
125
|
+
spy.mockImplementation(() => false);
|
|
126
|
+
await initGenerator(tree, {} as any);
|
|
127
|
+
expect(console.error).toHaveBeenCalledWith(
|
|
128
|
+
expect.stringContaining('package.json not found'),
|
|
129
|
+
);
|
|
130
|
+
});
|
|
131
|
+
|
|
132
|
+
it('returns early without peer dependencies', async () => {
|
|
133
|
+
setOwn({ name: '@rxap/x' });
|
|
134
|
+
await initGenerator(tree, {} as any);
|
|
135
|
+
expect(logs).toContain('No peer dependencies found');
|
|
136
|
+
});
|
|
137
|
+
|
|
138
|
+
it('returns early when no peers are missing', async () => {
|
|
139
|
+
setOwn({ name: '@rxap/x', peerDependencies: { a: '1' } });
|
|
140
|
+
writeJson(tree, 'package.json', { dependencies: { a: '1' } });
|
|
141
|
+
await initGenerator(tree, {} as any);
|
|
142
|
+
expect(logs).toContain('No missing peer dependencies');
|
|
143
|
+
});
|
|
144
|
+
|
|
145
|
+
it('moves a plugin package from dependencies to devDependencies', async () => {
|
|
146
|
+
setOwn({ name: '@rxap/plugin-x', peerDependencies: { a: '1' } });
|
|
147
|
+
writeJson(tree, 'package.json', {
|
|
148
|
+
dependencies: { '@rxap/plugin-x': '2.0.0' },
|
|
149
|
+
});
|
|
150
|
+
await initGenerator(tree, {} as any);
|
|
151
|
+
const json = readJson(tree, 'package.json');
|
|
152
|
+
expect(json.dependencies['@rxap/plugin-x']).toBeUndefined();
|
|
153
|
+
expect(json.devDependencies['@rxap/plugin-x']).toBe('2.0.0');
|
|
154
|
+
expect(json.devDependencies['a']).toBe('1');
|
|
155
|
+
});
|
|
156
|
+
|
|
157
|
+
it('moves a nest package from devDependencies to dependencies', async () => {
|
|
158
|
+
setOwn({ name: '@rxap/nest-x', peerDependencies: { a: '1' } });
|
|
159
|
+
writeJson(tree, 'package.json', {
|
|
160
|
+
devDependencies: { '@rxap/nest-x': '2.0.0' },
|
|
161
|
+
});
|
|
162
|
+
await initGenerator(tree, {} as any);
|
|
163
|
+
const json = readJson(tree, 'package.json');
|
|
164
|
+
expect(json.dependencies['@rxap/nest-x']).toBe('2.0.0');
|
|
165
|
+
expect(json.dependencies['a']).toBe('1');
|
|
166
|
+
});
|
|
167
|
+
|
|
168
|
+
describe('peer init generators', () => {
|
|
169
|
+
const run = async (peerJson?: object, extra: Record<string, string> = {}) => {
|
|
170
|
+
setOwn({ name: '@rxap/nest-x', peerDependencies: { 'peer-a': '1' } });
|
|
171
|
+
writeJson(tree, 'package.json', { dependencies: { '@rxap/nest-x': '1' } });
|
|
172
|
+
if (peerJson) mockFiles[peerPkg('peer-a')] = JSON.stringify(peerJson);
|
|
173
|
+
Object.assign(mockFiles, extra);
|
|
174
|
+
await initGenerator(tree, { project: 'p' } as any);
|
|
175
|
+
};
|
|
176
|
+
const dir = join('/virtual', 'node_modules', 'peer-a');
|
|
177
|
+
|
|
178
|
+
it('skips peers without package.json', async () => {
|
|
179
|
+
await run();
|
|
180
|
+
expect(logs).toContain('Peer dependency peer-a has no package.json');
|
|
181
|
+
});
|
|
182
|
+
|
|
183
|
+
it('skips peers without generators', async () => {
|
|
184
|
+
await run({ name: 'peer-a' });
|
|
185
|
+
expect(logs).toContain('Peer dependency peer-a has no generators or schematics');
|
|
186
|
+
});
|
|
187
|
+
|
|
188
|
+
it('skips peers with missing generators file', async () => {
|
|
189
|
+
await run({ generators: './generators.json' });
|
|
190
|
+
expect(logs).toContain('Peer dependency peer-a has no generators or schematics file');
|
|
191
|
+
});
|
|
192
|
+
|
|
193
|
+
it('skips peers without init generator', async () => {
|
|
194
|
+
await run({ generators: './generators.json' }, {
|
|
195
|
+
[join(dir, 'generators.json')]: JSON.stringify({ generators: {} }),
|
|
196
|
+
});
|
|
197
|
+
expect(logs).toContain('Peer dependency peer-a has no init generator');
|
|
198
|
+
});
|
|
199
|
+
|
|
200
|
+
it('skips peers whose init generator file is missing', async () => {
|
|
201
|
+
await run({ generators: './generators.json' }, {
|
|
202
|
+
[join(dir, 'generators.json')]: JSON.stringify({ generators: { init: { factory: './gen' } } }),
|
|
203
|
+
});
|
|
204
|
+
expect(logs.some((l) => l.includes('has no init generator file'))).toBe(true);
|
|
205
|
+
});
|
|
206
|
+
|
|
207
|
+
it('skips peers whose init export is not a function', async () => {
|
|
208
|
+
jest.resetModules();
|
|
209
|
+
jest.doMock(join(dir, 'gen'), () => ({ default: 1 }), { virtual: true });
|
|
210
|
+
await run({ generators: './generators.json' }, {
|
|
211
|
+
[join(dir, 'generators.json')]: JSON.stringify({ generators: { init: { factory: './gen' } } }),
|
|
212
|
+
[join(dir, 'gen.js')]: '',
|
|
213
|
+
});
|
|
214
|
+
expect(logs).toContain('Peer dependency peer-a has no init generator function');
|
|
215
|
+
});
|
|
216
|
+
|
|
217
|
+
it('runs the init generator of a peer', async () => {
|
|
218
|
+
const peerInit = jest.fn();
|
|
219
|
+
jest.resetModules();
|
|
220
|
+
jest.doMock(join(dir, 'gen'), () => ({ default: peerInit }), { virtual: true });
|
|
221
|
+
await run({ schematics: './generators.json' }, {
|
|
222
|
+
[join(dir, 'generators.json')]: JSON.stringify({ generators: { init: { factory: './gen' } } }),
|
|
223
|
+
[join(dir, 'gen.js')]: '',
|
|
224
|
+
});
|
|
225
|
+
expect(peerInit).toHaveBeenCalledWith(tree, { project: 'p' });
|
|
226
|
+
});
|
|
227
|
+
});
|
|
228
|
+
});
|