Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(angular): add migration to remove karma generator defaults #16400

Merged
merged 1 commit into from
Apr 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions packages/angular/migrations.json
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,12 @@
"version": "16.0.0-beta.1",
"description": "Replace @nrwl/angular with @nx/angular",
"implementation": "./src/migrations/update-16-0-0-add-nx-packages/update-16-0-0-add-nx-packages"
},
"remove-karma-defaults-from-generators": {
"cli": "nx",
"version": "16.0.0-beta.6",
"description": "Remove karma as default unitTestRunner from nxJson and project configurations",
"implementation": "./src/migrations/update-16-0-0/remove-karma-defaults"
}
},
"packageJsonUpdates": {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,195 @@
import {
addProjectConfiguration,
readNxJson,
readProjectConfiguration,
updateNxJson,
} from '@nx/devkit';
import { createTreeWithEmptyWorkspace } from '@nx/devkit/testing';
import removeKarmaDefaults from './remove-karma-defaults';

describe('removeKarmaDefaults', () => {
it('should remove karma as default unit test runner from nx.json when exists', async () => {
// ARRANGE
const tree = createTreeWithEmptyWorkspace();

const nxJson = readNxJson(tree);
nxJson.generators = {
'@nrwl/angular:application': {
unitTestRunner: 'karma',
},
'@nrwl/angular:library': {
unitTestRunner: 'karma',
},
'@nrwl/angular:host': {
unitTestRunner: 'karma',
},
'@nrwl/angular:remote': {
unitTestRunner: 'karma',
},
};
updateNxJson(tree, nxJson);

// ACT
await removeKarmaDefaults(tree);

// ASSERT
expect(readNxJson(tree).generators).toMatchInlineSnapshot(`
{
"@nrwl/angular:application": {},
"@nrwl/angular:host": {},
"@nrwl/angular:library": {},
"@nrwl/angular:remote": {},
}
`);
});

it('should only remove karma as default unit test runner from nx.json when set', async () => {
// ARRANGE
const tree = createTreeWithEmptyWorkspace();

const nxJson = readNxJson(tree);
nxJson.generators = {
'@nrwl/angular:application': {
style: 'scss',
unitTestRunner: 'karma',
},
'@nrwl/angular:library': {
unitTestRunner: 'jest',
},
'@nrwl/angular:host': {
style: 'scss',
unitTestRunner: 'karma',
},
'@nrwl/angular:remote': {
unitTestRunner: 'jest',
},
};
updateNxJson(tree, nxJson);

// ACT
await removeKarmaDefaults(tree);

// ASSERT
expect(readNxJson(tree).generators).toMatchInlineSnapshot(`
{
"@nrwl/angular:application": {
"style": "scss",
},
"@nrwl/angular:host": {
"style": "scss",
},
"@nrwl/angular:library": {
"unitTestRunner": "jest",
},
"@nrwl/angular:remote": {
"unitTestRunner": "jest",
},
}
`);
});

it('should not remove karma as default unit test runner from unsupported generator', async () => {
// ARRANGE
const tree = createTreeWithEmptyWorkspace();

const nxJson = readNxJson(tree);
nxJson.generators = {
'@my/custom:plugin': {
style: 'scss',
unitTestRunner: 'karma',
},
};
updateNxJson(tree, nxJson);

// ACT
await removeKarmaDefaults(tree);

// ASSERT
expect(readNxJson(tree).generators).toMatchInlineSnapshot(`
{
"@my/custom:plugin": {
"style": "scss",
"unitTestRunner": "karma",
},
}
`);
});

it('should remove karma as default for project specific generators', async () => {
// ARRANGE
const tree = createTreeWithEmptyWorkspace();
addProjectConfiguration(tree, 'test', {
name: 'test',
root: '.',
sourceRoot: 'src',
generators: {
'@nrwl/angular:application': {
style: 'scss',
unitTestRunner: 'karma',
},
},
});

// ACT
await removeKarmaDefaults(tree);

// ASSERT
expect(readProjectConfiguration(tree, 'test').generators)
.toMatchInlineSnapshot(`
{
"@nrwl/angular:application": {
"style": "scss",
},
}
`);
});

it('should remove karma when using nested generator default syntax', async () => {
// ARRANGE
const tree = createTreeWithEmptyWorkspace();

const nxJson = readNxJson(tree);
nxJson.generators = {
'@nrwl/angular:application': {
style: 'scss',
unitTestRunner: 'karma',
},
'@nrwl/angular:library': {
unitTestRunner: 'jest',
},
'@nrwl/angular': {
host: {
style: 'scss',
unitTestRunner: 'karma',
},
remote: {
unitTestRunner: 'jest',
},
},
};
updateNxJson(tree, nxJson);

// ACT
await removeKarmaDefaults(tree);

// ASSERT
expect(readNxJson(tree).generators).toMatchInlineSnapshot(`
{
"@nrwl/angular": {
"host": {
"style": "scss",
},
"remote": {
"unitTestRunner": "jest",
},
},
"@nrwl/angular:application": {
"style": "scss",
},
"@nrwl/angular:library": {
"unitTestRunner": "jest",
},
}
`);
});
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
import type {
NxJsonConfiguration,
ProjectConfiguration,
Tree,
} from '@nx/devkit';
import {
formatFiles,
getProjects,
readNxJson,
updateNxJson,
updateProjectConfiguration,
} from '@nx/devkit';

const GENERATORS = ['application', 'library', 'host', 'remote'];
const CANDIDATE_GENERATOR_COLLECTIONS = ['@nrwl/angular', '@nx/angular'];

export default async function removeKarmaDefaults(tree: Tree) {
const nxJson = readNxJson(tree);

if (nxJson.generators) {
const updatedConfig = updateUnitTestRunner(nxJson.generators);

if (updatedConfig) {
updateNxJson(tree, nxJson);
}
}

const projects = getProjects(tree);

for (const [projectName, projectConfig] of projects) {
if (projectConfig.generators) {
const updatedProject = updateUnitTestRunner(projectConfig.generators);

if (updatedProject) {
updateProjectConfiguration(tree, projectName, projectConfig);
}
}
}
Coly010 marked this conversation as resolved.
Show resolved Hide resolved

await formatFiles(tree);
}

function updateUnitTestRunner(
generatorsConfig:
| NxJsonConfiguration['generators']
| ProjectConfiguration['generators']
) {
const generators = Object.entries(generatorsConfig);

let updatedConfig = false;
for (const [generatorName, generatorDefaults] of generators) {
if (CANDIDATE_GENERATOR_COLLECTIONS.includes(generatorName)) {
for (const possibleGenerator of GENERATORS) {
if (
generatorDefaults[possibleGenerator] &&
generatorDefaults[possibleGenerator]['unitTestRunner'] &&
generatorDefaults[possibleGenerator]['unitTestRunner'] === 'karma'
) {
generatorsConfig[generatorName][possibleGenerator]['unitTestRunner'] =
undefined;
updatedConfig = true;
}
}
}

if (
!GENERATORS.map((v) => `@nrwl/angular:${v}`).includes(generatorName) &&
!GENERATORS.map((v) => `@nx/angular:${v}`).includes(generatorName)
) {
continue;
}

if (
generatorDefaults['unitTestRunner'] &&
generatorDefaults['unitTestRunner'] === 'karma'
) {
generatorsConfig[generatorName]['unitTestRunner'] = undefined;
updatedConfig = true;
}
}

return updatedConfig;
}