Skip to content
This repository was archived by the owner on Apr 4, 2025. It is now read-only.

@angular-devkit: Filter project names #739

Closed
wants to merge 4 commits into from
Closed
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
1 change: 1 addition & 0 deletions packages/angular_devkit/architect/src/architect.ts
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ export interface BuilderConfiguration<OptionsT = {}> {

export interface TargetSpecifier<OptionsT = {}> {
project: string;
projectFilter?: experimental.workspace.projectFilter;
target: string;
configuration?: string;
overrides?: Partial<OptionsT>;
Expand Down
10 changes: 8 additions & 2 deletions packages/angular_devkit/core/src/workspace/workspace.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ export class WorkspaceNotYetLoadedException extends BaseException {
}


export type projectFilter = (project: WorkspaceProject, name: string) => boolean;

export class Workspace {
private readonly _workspaceSchemaPath = join(normalize(__dirname), 'workspace-schema.json');
private _workspaceSchema: JsonObject;
Expand Down Expand Up @@ -109,8 +111,12 @@ export class Workspace {
return this._workspace.newProjectRoot;
}

listProjectNames(): string[] {
return Object.keys(this._workspace.projects);
listProjectNames(filter?: projectFilter): string[] {
const projectNames = Object.keys(this._workspace.projects);

return filter ? projectNames.filter((name) =>
filter(this._workspace.projects[name], name),
) : projectNames;
}

getProject(projectName: string): WorkspaceProject {
Expand Down
74 changes: 67 additions & 7 deletions packages/angular_devkit/core/src/workspace/workspace_spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ import {
ProjectNotFoundException,
Workspace,
WorkspaceNotYetLoadedException,
projectFilter,
} from './workspace';
import { WorkspaceProject, WorkspaceSchema, WorkspaceTool } from './workspace-schema';


describe('Workspace', () => {
const host = new NodeJsSyncHost();
const root = normalize(__dirname);
// The content of this JSON object should be kept in sync with the path below:
// tests/@angular_devkit/workspace/angular-workspace.json
// tests/@angular_devkit/core/workspace/angular-workspace.json
const workspaceJson: WorkspaceSchema = {
version: 1,
newProjectRoot: './projects',
Expand Down Expand Up @@ -98,8 +98,47 @@ describe('Workspace', () => {
},
},
},
lib: {
root: 'projects/lib',
projectType: 'library',
prefix: 'lib',
architect: {
'build': {
'builder': '@angular-devkit/build-ng-packagr:build',
'options': {
'project': 'projects/lib/ng-package.json',
},
'configurations': {
'production': {
'project': 'projects/lib/ng-package.prod.json',
},
},
},
test: {
'builder': '@angular-devkit/build-angular:karma',
'options': {
'main': 'projects/lib/src/test.ts',
'tsConfig': 'projects/lib/tsconfig.spec.json',
'karmaConfig': 'projects/lib/karma.conf.js',
},
},
lint: {
'builder': '@angular-devkit/build-angular:tslint',
'options': {
'tsConfig': [
'projects/lib/tsconfig.lint.json',
'projects/lib/tsconfig.spec.json',
],
'exclude': [
'**/node_modules/**',
],
},
},
},
},
},
};

const appProject = {
...workspaceJson.projects['app'],
// Tools should not be returned when getting a project.
Expand Down Expand Up @@ -167,10 +206,26 @@ describe('Workspace', () => {
).subscribe(undefined, done.fail, done);
});

it('lists project names', (done) => {
it('lists all project names', (done) => {
const workspace = new Workspace(root, host);
workspace.loadWorkspaceFromJson(workspaceJson).pipe(
tap((ws) => expect(ws.listProjectNames()).toEqual(['app', 'lib'])),
).subscribe(undefined, done.fail, done);
});

it('lists project names filtered by project property value', (done) => {
const workspace = new Workspace(root, host);
const librariesFilter: projectFilter = (project, name) => project.projectType === 'library';
workspace.loadWorkspaceFromJson(workspaceJson).pipe(
tap((ws) => expect(ws.listProjectNames(librariesFilter)).toEqual(['lib'])),
).subscribe(undefined, done.fail, done);
});

it('lists filtered project names', (done) => {
const workspace = new Workspace(root, host);
const nameFilter: projectFilter = (project, name) => name.startsWith('a');
workspace.loadWorkspaceFromJson(workspaceJson).pipe(
tap((ws) => expect(ws.listProjectNames()).toEqual(['app'])),
tap((ws) => expect(ws.listProjectNames(nameFilter)).toEqual(['app'])),
).subscribe(undefined, done.fail, done);
});

Expand All @@ -196,7 +251,11 @@ describe('Workspace', () => {
});

it('gets default project when there is a single one', (done) => {
const customWorkspaceJson = { ...workspaceJson, defaultProject: undefined };
const customWorkspaceJson: WorkspaceSchema = {
...workspaceJson,
defaultProject: undefined,
projects: { app: {...workspaceJson.projects.app}},
};
const workspace = new Workspace(root, host);
workspace.loadWorkspaceFromJson(customWorkspaceJson).pipe(
tap((ws) => expect(ws.getDefaultProjectName()).toEqual('app')),
Expand All @@ -213,16 +272,17 @@ describe('Workspace', () => {

it('gets project by path', (done) => {
const workspace = new Workspace(root, host);
const appRoot = normalize(workspaceJson.projects.app.root);
workspace.loadWorkspaceFromJson(workspaceJson).pipe(
tap((ws) => expect(ws.getProjectByPath(ws.root)).toEqual('app')),
tap((ws) => expect(ws.getProjectByPath(appRoot)).toEqual('app')),
).subscribe(undefined, done.fail, done);
});

it('gets closest project by path', (done) => {
const app = workspaceJson.projects['app'];
const anotherAppRoot = join(normalize(app.root), 'folder');
const customWorkspaceJson = { ...workspaceJson, projects: {
'app': app,
...workspaceJson.projects,
'another-app': { ...app, root: anotherAppRoot},
} };
const workspace = new Workspace(root, host);
Expand Down
38 changes: 38 additions & 0 deletions tests/@angular_devkit/core/workspace/angular-workspace.json
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,44 @@
}
}
}
},
"lib": {
"root": "projects/lib",
"projectType": "library",
"prefix": "lib",
"architect": {
"build": {
"builder": "@angular-devkit/build-ng-packagr:build",
"options": {
"project": "projects/lib/ng-package.json"
},
"configurations": {
"production": {
"project": "projects/lib/ng-package.prod.json"
}
}
},
"test": {
"builder": "@angular-devkit/build-angular:karma",
"options": {
"main": "projects/lib/src/test.ts",
"tsConfig": "projects/lib/tsconfig.spec.json",
"karmaConfig": "projects/lib/karma.conf.js"
}
},
"lint": {
"builder": "@angular-devkit/build-angular:tslint",
"options": {
"tsConfig": [
"projects/lib/tsconfig.lint.json",
"projects/lib/tsconfig.spec.json"
],
"exclude": [
"**/node_modules/**"
]
}
}
}
}
}
}