Skip to content

fix(schematics): remove experimental workspace API type usage #2644

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

Merged
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
10 changes: 10 additions & 0 deletions src/schematics/interfaces.ts
Original file line number Diff line number Diff line change
Expand Up @@ -74,3 +74,13 @@ export interface FSHost {
writeFileSync(src: string, data: string): void;
renameSync(src: string, dest: string): void;
}

export interface WorkspaceProject {
projectType?: string;
architect?: Record<string, { builder: string; options?: Record<string, any> }>;
}

export interface Workspace {
defaultProject?: string;
projects: Record<string, WorkspaceProject>;
}
9 changes: 4 additions & 5 deletions src/schematics/ng-add-ssr.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import { SchematicsException, Tree, SchematicContext } from '@angular-devkit/schematics';
import { experimental } from '@angular-devkit/core';
import {
addDependencies,
generateFirebaseRc,
Expand All @@ -8,15 +7,15 @@ import {
safeReadJSON,
stringifyFormatted
} from './ng-add-common';
import { FirebaseJSON } from './interfaces';
import { FirebaseJSON, Workspace, WorkspaceProject } from './interfaces';

import { default as defaultDependencies, firebaseFunctions as firebaseFunctionsDependencies } from './versions.json';
import { dirname, join } from 'path';

// We consider a project to be a universal project if it has a `server` architect
// target. If it does, it knows how to build the application's server.
export const isUniversalApp = (
project: experimental.workspace.WorkspaceProject
project: WorkspaceProject
) => project.architect && project.architect.server;

function emptyFirebaseJson(source: string) {
Expand Down Expand Up @@ -106,10 +105,10 @@ export const addFirebaseFunctionsDependencies = (tree: Tree, context: SchematicC
};

export const setupUniversalDeployment = (config: {
project: experimental.workspace.WorkspaceProject;
project: WorkspaceProject;
options: NgAddNormalizedOptions;
workspacePath: string;
workspace: experimental.workspace.WorkspaceSchema;
workspace: Workspace;
tree: Tree;
}) => {
const { tree, workspacePath, workspace, options } = config;
Expand Down
7 changes: 3 additions & 4 deletions src/schematics/ng-add-static.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import { SchematicsException, Tree, SchematicContext } from '@angular-devkit/schematics';
import { experimental } from '@angular-devkit/core';
import {
addDependencies,
generateFirebaseRc,
Expand All @@ -8,7 +7,7 @@ import {
safeReadJSON,
stringifyFormatted
} from './ng-add-common';
import { FirebaseJSON } from './interfaces';
import { FirebaseJSON, Workspace, WorkspaceProject } from './interfaces';

import { default as defaultDependencies } from './versions.json';

Expand Down Expand Up @@ -82,10 +81,10 @@ export const addFirebaseHostingDependencies = (tree: Tree, context: SchematicCon
};

export const setupStaticDeployment = (config: {
project: experimental.workspace.WorkspaceProject;
project: WorkspaceProject;
options: NgAddNormalizedOptions;
workspacePath: string;
workspace: experimental.workspace.WorkspaceSchema;
workspace: Workspace;
tree: Tree;
}) => {
const { tree, workspacePath, workspace, options } = config;
Expand Down
10 changes: 5 additions & 5 deletions src/schematics/ng-add.ts
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
import { SchematicContext, SchematicsException, Tree } from '@angular-devkit/schematics';
import { NodePackageInstallTask, RunSchematicTask } from '@angular-devkit/schematics/tasks';
import { experimental, JsonParseMode, parseJson } from '@angular-devkit/core';
import { JsonParseMode, parseJson } from '@angular-devkit/core';
import { listProjects, projectPrompt, projectTypePrompt } from './utils';

import { Workspace } from './interfaces';
import { DeployOptions, NgAddNormalizedOptions } from './ng-add-common';
import { addFirebaseFunctionsDependencies, setupUniversalDeployment } from './ng-add-ssr';
import { addFirebaseHostingDependencies, setupStaticDeployment } from './ng-add-static';

function getWorkspace(
host: Tree
): { path: string; workspace: experimental.workspace.WorkspaceSchema } {
): { path: string; workspace: Workspace } {
const possibleFiles = ['/angular.json', '/.angular.json'];
const path = possibleFiles.filter(p => host.exists(p))[0];

Expand All @@ -19,12 +19,12 @@ function getWorkspace(
}
const content = configBuffer.toString();

let workspace: experimental.workspace.WorkspaceSchema;
let workspace: Workspace;
try {
workspace = (parseJson(
content,
JsonParseMode.Loose
) as {}) as experimental.workspace.WorkspaceSchema;
) as {}) as Workspace;
} catch (e) {
throw new SchematicsException(`Could not parse angular.json: ` + e.message);
}
Expand Down
5 changes: 2 additions & 3 deletions src/schematics/utils.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import { experimental } from '@angular-devkit/core';
import { readFileSync } from 'fs';
import { FirebaseRc, Project } from './interfaces';
import { FirebaseRc, Project, WorkspaceProject } from './interfaces';
import { join } from 'path';
import { isUniversalApp } from './ng-add-ssr';

Expand Down Expand Up @@ -56,7 +55,7 @@ export const projectPrompt = (projects: Project[]) => {
});
};

export const projectTypePrompt = (project: experimental.workspace.WorkspaceProject) => {
export const projectTypePrompt = (project: WorkspaceProject) => {
if (isUniversalApp(project)) {
return require('inquirer').prompt({
type: 'confirm',
Expand Down