miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

fix(angular): set projectName as the default source for relevant generators (#15664)

Browse Source
This commit is contained in:
Leosvel Pérez Espinosa 2023-03-14 16:38:35 +00:00 committed by GitHub
parent 425c13448b
commit ca8d24b3d4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
32 changed files with 61 additions and 187 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/generated/packages/angular/generators/component-cypress-spec.json
View File

@ -11,6 +11,7 @@
"projectName": {
"type": "string",
"description": "The name of the project.",
"$default": { "$source": "projectName", "index": 0 },
"examples": ["ui-samples"],
"x-priority": "important"
},

1
docs/generated/packages/angular/generators/component-test.json
View File

@ -11,6 +11,7 @@
"project": {
"type": "string",
"description": "The name of the project where the component is located.",
"$default": { "$source": "projectName", "index": 0 },
"x-dropdown": "projects",
"x-prompt": "What project is the component located in?",
"x-priority": "important"

1
docs/generated/packages/angular/generators/component.json
View File

@ -19,6 +19,7 @@
"project": {
"type": "string",
"description": "The name of the project.",
"$default": { "$source": "projectName", "index": 0 },
"x-dropdown": "projects"
},
"name": {

1
docs/generated/packages/angular/generators/cypress-component-configuration.json
View File

@ -12,6 +12,7 @@
"project": {
"type": "string",
"description": "The name of the project to add cypress component testing configuration to",
"$default": { "$source": "projectName", "index": 0 },
"x-dropdown": "projects",
"x-prompt": "What project should we add Cypress component testing to?",
"x-priority": "important"

1
docs/generated/packages/angular/generators/scam-directive.json
View File

@ -25,6 +25,7 @@
"project": {
"type": "string",
"description": "The name of the project.",
"$default": { "$source": "projectName", "index": 0 },
"x-dropdown": "projects"
},
"name": {

1
docs/generated/packages/angular/generators/scam-pipe.json
View File

@ -25,6 +25,7 @@
"project": {
"type": "string",
"description": "The name of the project.",
"$default": { "$source": "projectName", "index": 0 },
"x-dropdown": "projects"
},
"name": {

1
docs/generated/packages/angular/generators/scam.json
View File

@ -25,6 +25,7 @@
"project": {
"type": "string",
"description": "The name of the project.",
"$default": { "$source": "projectName", "index": 0 },
"x-dropdown": "projects"
},
"name": {

1
docs/generated/packages/angular/generators/web-worker.json
View File

@ -17,6 +17,7 @@
"project": {
"type": "string",
"description": "The name of the project.",
"$default": { "$source": "projectName", "index": 0 },
"x-dropdown": "projects",
"x-priority": "important"
},

4
packages/angular/src/generators/component-cypress-spec/schema.json
View File

@ -8,6 +8,10 @@
"projectName": {
"type": "string",
"description": "The name of the project.",
"$default": {
"$source": "projectName",
"index": 0
},
"examples": ["ui-samples"],
"x-priority": "important"
},

4
packages/angular/src/generators/component-test/schema.json
View File

@ -8,6 +8,10 @@
"project": {
"type": "string",
"description": "The name of the project where the component is located.",
"$default": {
"$source": "projectName",
"index": 0
},
"x-dropdown": "projects",
"x-prompt": "What project is the component located in?",
"x-priority": "important"

14
packages/angular/src/generators/component/__snapshots__/component.spec.ts.snap
View File

@ -42,20 +42,6 @@ export class ExampleComponent {
"
`;
exports[`component Generator --path should infer project from path and generate component correctly 1`] = `
"import { Component } from '@angular/core';
@Component({
selector: 'example',
templateUrl: './example.component.html',
styleUrls: ['./example.component.css']
})
export class ExampleComponent {
}
"
`;
exports[`component Generator secondary entry points should create the component correctly and export it in the entry point 1`] = `
"import { Component } from '@angular/core';

83
packages/angular/src/generators/component/component.spec.ts
View File

@ -1,4 +1,3 @@
import type { ProjectGraph } from '@nrwl/devkit';
import {
addProjectConfiguration,
stripIndents,
@ -8,14 +7,6 @@ import {
import { createTreeWithEmptyWorkspace } from '@nrwl/devkit/testing';
import componentGenerator from './component';
let projectGraph: ProjectGraph;
jest.mock('@nrwl/devkit', () => {
return {
...jest.requireActual('@nrwl/devkit'),
createProjectGraphAsync: jest.fn().mockImplementation(() => projectGraph),
};
});
describe('component Generator', () => {
it('should create the component correctly and export it in the entry point when "export=true"', async () => {
// ARRANGE
@ -420,50 +411,6 @@ describe('component Generator', () => {
);
});
it('should infer project from path and generate component correctly', async () => {
// ARRANGE
const tree = createTreeWithEmptyWorkspace({ layout: 'apps-libs' });
addProjectConfiguration(tree, 'lib1', {
projectType: 'library',
sourceRoot: 'libs/lib1/src',
root: 'libs/lib1',
});
tree.write(
'libs/lib1/src/lib/lib.module.ts',
`
import { NgModule } from '@angular/core';
@NgModule({
declarations: [],
exports: []
})
export class LibModule {}`
);
projectGraph = {
nodes: {
lib1: {
name: 'lib1',
type: 'lib',
data: { root: 'libs/lib1' } as any,
},
},
dependencies: {},
};
// ACT
await componentGenerator(tree, {
name: 'example',
path: 'libs/lib1/src/lib/mycomp',
});
// ASSERT
const componentSource = tree.read(
'libs/lib1/src/lib/mycomp/example/example.component.ts',
'utf-8'
);
expect(componentSource).toMatchSnapshot();
});
it('should throw if the path specified is not under the project root', async () => {
// ARRANGE
const tree = createTreeWithEmptyWorkspace({ layout: 'apps-libs' });
@ -495,36 +442,6 @@ describe('component Generator', () => {
})
).rejects.toThrow();
});
it('should throw when path and projects are not provided and defaultProject is not set', async () => {
// ARRANGE
const tree = createTreeWithEmptyWorkspace({ layout: 'apps-libs' });
addProjectConfiguration(tree, 'lib1', {
projectType: 'library',
sourceRoot: 'libs/lib1/src',
root: 'libs/lib1',
});
tree.write(
'libs/lib1/src/lib/lib.module.ts',
`
import { NgModule } from '@angular/core';
@NgModule({
declarations: [],
exports: []
})
export class LibModule {}`
);
tree.write('libs/lib1/src/index.ts', 'export * from "./lib/lib.module";');
// ACT & ASSERT
await expect(
componentGenerator(tree, {
name: 'example',
export: false,
})
).rejects.toThrow();
});
});
describe('--module', () => {

6
packages/angular/src/generators/component/component.ts
View File

@ -1,11 +1,11 @@
import type { Tree } from '@nrwl/devkit';
import { formatFiles, stripIndents } from '@nrwl/devkit';
import { lt } from 'semver';
import { checkPathUnderProjectRoot } from '../utils/path';
import { getInstalledAngularVersionInfo } from '../utils/version-utils';
import { exportComponentInEntryPoint } from './lib/component';
import { normalizeOptions } from './lib/normalize-options';
import type { Schema } from './schema';
import { getInstalledAngularVersionInfo } from '../utils/version-utils';
import { lt } from 'semver';
import { checkPathUnderProjectRoot } from '../utils/path';
export async function componentGenerator(tree: Tree, rawOptions: Schema) {
const installedAngularVersionInfo = getInstalledAngularVersionInfo(tree);

43
packages/angular/src/generators/component/lib/normalize-options.ts
View File

@ -1,52 +1,14 @@
import type { Tree } from '@nrwl/devkit';
import {
createProjectGraphAsync,
joinPathFragments,
readNxJson,
readProjectConfiguration,
} from '@nrwl/devkit';
import { joinPathFragments, readProjectConfiguration } from '@nrwl/devkit';
import type { NormalizedSchema, Schema } from '../schema';
import {
createProjectRootMappings,
findProjectForPath,
} from 'nx/src/project-graph/utils/find-project-for-path';
async function findProjectFromOptions(options: Schema) {
const projectGraph = await createProjectGraphAsync();
const projectRootMappings = createProjectRootMappings(projectGraph.nodes);
// path can be undefined when running on the root of the workspace, we default to the root
// to handle standalone layouts
return findProjectForPath(options.path || '', projectRootMappings);
}
export async function normalizeOptions(
tree: Tree,
options: Schema
): Promise<NormalizedSchema> {
const project =
options.project ??
(await findProjectFromOptions(options)) ??
readNxJson(tree).defaultProject;
if (!project) {
// path is hidden, so if not provided we don't suggest setting it
if (!options.path) {
throw new Error(
'No "project" was specified and "defaultProject" is not set in the workspace configuration. Please provide the "project" option and try again.'
);
}
// path was provided, so it's wrong and we should mention it
throw new Error(
'The provided "path" is wrong and no "project" was specified and "defaultProject" is not set in the workspace configuration. ' +
'Please provide a correct "path" or provide the "project" option instead and try again.'
);
}
const { projectType, root, sourceRoot } = readProjectConfiguration(
tree,
project
options.project
);
const projectSourceRoot = sourceRoot ?? joinPathFragments(root, 'src');
const path =
@ -59,7 +21,6 @@ export async function normalizeOptions(
return {
...options,
path,
project,
projectSourceRoot,
};
}

3
packages/angular/src/generators/component/schema.d.ts vendored
View File

@ -1,7 +1,7 @@
export interface Schema {
name: string;
project: string;
path?: string;
project?: string;
displayBlock?: boolean;
inlineStyle?: boolean;
inlineTemplate?: boolean;
@ -21,6 +21,5 @@ export interface Schema {
export interface NormalizedSchema extends Schema {
path: string;
project: string;
projectSourceRoot: string;
}

4
packages/angular/src/generators/component/schema.json
View File

@ -16,6 +16,10 @@
"project": {
"type": "string",
"description": "The name of the project.",
"$default": {
"$source": "projectName",
"index": 0
},
"x-dropdown": "projects"
},
"name": {

4
packages/angular/src/generators/cypress-component-configuration/schema.json
View File

@ -9,6 +9,10 @@
"project": {
"type": "string",
"description": "The name of the project to add cypress component testing configuration to",
"$default": {
"$source": "projectName",
"index": 0
},
"x-dropdown": "projects",
"x-prompt": "What project should we add Cypress component testing to?",
"x-priority": "important"

10
packages/angular/src/generators/scam-directive/lib/normalize-options.ts
View File

@ -1,19 +1,14 @@
import type { Tree } from '@nrwl/devkit';
import {
joinPathFragments,
readNxJson,
readProjectConfiguration,
} from '@nrwl/devkit';
import { joinPathFragments, readProjectConfiguration } from '@nrwl/devkit';
import type { NormalizedSchema, Schema } from '../schema';
export function normalizeOptions(
tree: Tree,
options: Schema
): NormalizedSchema {
const project = options.project ?? readNxJson(tree).defaultProject;
const { projectType, root, sourceRoot } = readProjectConfiguration(
tree,
project
options.project
);
const projectSourceRoot = sourceRoot ?? joinPathFragments(root, 'src');
const path =
@ -29,7 +24,6 @@ export function normalizeOptions(
flat: options.flat ?? true,
inlineScam: options.inlineScam ?? true,
path,
project,
projectSourceRoot,
};
}

4
packages/angular/src/generators/scam-directive/scam-directive.ts
View File

@ -2,7 +2,6 @@ import type { Tree } from '@nrwl/devkit';
import {
formatFiles,
normalizePath,
readNxJson,
readProjectConfiguration,
} from '@nrwl/devkit';
import { exportScam } from '../utils/export-scam';
@ -41,8 +40,7 @@ function checkPathUnderProjectRoot(tree: Tree, options: Partial<Schema>) {
return;
}
const project = options.project ?? readNxJson(tree).defaultProject;
const { root } = readProjectConfiguration(tree, project);
const { root } = readProjectConfiguration(tree, options.project);
let pathToDirective = normalizePath(options.path);
pathToDirective = pathToDirective.startsWith('/')

3
packages/angular/src/generators/scam-directive/schema.d.ts vendored
View File

@ -1,7 +1,7 @@
export interface Schema {
name: string;
project: string;
path?: string;
project?: string;
skipTests?: boolean;
inlineScam?: boolean;
flat?: boolean;
@ -15,6 +15,5 @@ export interface NormalizedSchema extends Schema {
flat: boolean;
inlineScam: boolean;
path: string;
project: string;
projectSourceRoot: string;
}

4
packages/angular/src/generators/scam-directive/schema.json
View File

@ -22,6 +22,10 @@
"project": {
"type": "string",
"description": "The name of the project.",
"$default": {
"$source": "projectName",
"index": 0
},
"x-dropdown": "projects"
},
"name": {

10
packages/angular/src/generators/scam-pipe/lib/normalize-options.ts
View File

@ -1,19 +1,14 @@
import type { Tree } from '@nrwl/devkit';
import {
joinPathFragments,
readNxJson,
readProjectConfiguration,
} from '@nrwl/devkit';
import { joinPathFragments, readProjectConfiguration } from '@nrwl/devkit';
import type { NormalizedSchema, Schema } from '../schema';
export function normalizeOptions(
tree: Tree,
options: Schema
): NormalizedSchema {
const project = options.project ?? readNxJson(tree).defaultProject;
const { projectType, root, sourceRoot } = readProjectConfiguration(
tree,
project
options.project
);
const projectSourceRoot = sourceRoot ?? joinPathFragments(root, 'src');
const path =
@ -29,7 +24,6 @@ export function normalizeOptions(
flat: options.flat ?? true,
inlineScam: options.inlineScam ?? true,
path,
project,
projectSourceRoot,
};
}

4
packages/angular/src/generators/scam-pipe/scam-pipe.ts
View File

@ -2,7 +2,6 @@ import type { Tree } from '@nrwl/devkit';
import {
formatFiles,
normalizePath,
readNxJson,
readProjectConfiguration,
} from '@nrwl/devkit';
import { exportScam } from '../utils/export-scam';
@ -41,8 +40,7 @@ function checkPathUnderProjectRoot(tree: Tree, options: Partial<Schema>) {
return;
}
const project = options.project ?? readNxJson(tree).defaultProject;
const { root } = readProjectConfiguration(tree, project);
const { root } = readProjectConfiguration(tree, options.project);
let pathToPipe = normalizePath(options.path);
pathToPipe = pathToPipe.startsWith('/') ? pathToPipe.slice(1) : pathToPipe;

3
packages/angular/src/generators/scam-pipe/schema.d.ts vendored
View File

@ -1,7 +1,7 @@
export interface Schema {
name: string;
project: string;
path?: string;
project?: string;
skipTests?: boolean;
inlineScam?: boolean;
flat?: boolean;
@ -13,6 +13,5 @@ export interface NormalizedSchema extends Schema {
flat: boolean;
inlineScam: boolean;
path: string;
project: string;
projectSourceRoot: string;
}

4
packages/angular/src/generators/scam-pipe/schema.json
View File

@ -22,6 +22,10 @@
"project": {
"type": "string",
"description": "The name of the project.",
"$default": {
"$source": "projectName",
"index": 0
},
"x-dropdown": "projects"
},
"name": {

10
packages/angular/src/generators/scam/lib/normalize-options.ts
View File

@ -1,19 +1,14 @@
import type { Tree } from '@nrwl/devkit';
import {
joinPathFragments,
readNxJson,
readProjectConfiguration,
} from '@nrwl/devkit';
import { joinPathFragments, readProjectConfiguration } from '@nrwl/devkit';
import type { NormalizedSchema, Schema } from '../schema';
export function normalizeOptions(
tree: Tree,
options: Schema
): NormalizedSchema {
const project = options.project ?? readNxJson(tree).defaultProject;
const { projectType, root, sourceRoot } = readProjectConfiguration(
tree,
project
options.project
);
const projectSourceRoot = sourceRoot ?? joinPathFragments(root, 'src');
const path =
@ -28,7 +23,6 @@ export function normalizeOptions(
export: options.export ?? true,
inlineScam: options.inlineScam ?? true,
path,
project,
projectSourceRoot,
};
}

3
packages/angular/src/generators/scam/scam.ts
View File

@ -41,8 +41,7 @@ function checkPathUnderProjectRoot(tree: Tree, options: Partial<Schema>) {
return;
}
const project = options.project ?? readNxJson(tree).defaultProject;
const { root } = readProjectConfiguration(tree, project);
const { root } = readProjectConfiguration(tree, options.project);
let pathToComponent = normalizePath(options.path);
pathToComponent = pathToComponent.startsWith('/')

3
packages/angular/src/generators/scam/schema.d.ts vendored
View File

@ -1,7 +1,7 @@
export interface Schema {
name: string;
project: string;
path?: string;
project?: string;
displayBlock?: boolean;
inlineStyle?: boolean;
inlineTemplate?: boolean;
@ -22,6 +22,5 @@ export interface NormalizedSchema extends Schema {
export: boolean;
inlineScam: boolean;
path: string;
project: string;
projectSourceRoot: string;
}

4
packages/angular/src/generators/scam/schema.json
View File

@ -22,6 +22,10 @@
"project": {
"type": "string",
"description": "The name of the project.",
"$default": {
"$source": "projectName",
"index": 0
},
"x-dropdown": "projects"
},
"name": {

6
packages/angular/src/generators/utils/file-info.ts
View File

@ -2,16 +2,15 @@ import {
joinPathFragments,
names,
normalizePath,
readNxJson,
readProjectConfiguration,
Tree,
} from '@nrwl/devkit';
export type GenerationOptions = {
name: string;
project: string;
flat?: boolean;
path?: string;
project?: string;
type?: string;
};
export type FileInfo = {
@ -46,10 +45,9 @@ function getFileInfo(
options: GenerationOptions,
defaultType: string
): FileInfo {
const project = options.project ?? readNxJson(tree).defaultProject;
const { root, sourceRoot, projectType } = readProjectConfiguration(
tree,
project
options.project
);
const { fileName: normalizedName } = names(options.name);

3
packages/angular/src/generators/utils/path.ts
View File

@ -39,8 +39,7 @@ export function checkPathUnderProjectRoot(
return;
}
const project = projectName ?? readNxJson(tree).defaultProject;
const { root } = readProjectConfiguration(tree, project);
const { root } = readProjectConfiguration(tree, projectName);
let pathToComponent = normalizePath(path);
pathToComponent = pathToComponent.startsWith('/')

4
packages/angular/src/generators/web-worker/schema.json
View File

@ -14,6 +14,10 @@
"project": {
"type": "string",
"description": "The name of the project.",
"$default": {
"$source": "projectName",
"index": 0
},
"x-dropdown": "projects",
"x-priority": "important"
},