Skip to content

refactor: Consolidate adding dependencies #11131

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.

Sign up for GitHub

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 1 commit into from
Jun 8, 2018
Merged

refactor: Consolidate adding dependencies #11131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
41 changes: 18 additions & 23 deletions packages/schematics/angular/application/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ import {
addProjectToWorkspace,
getWorkspace,
} from '../utility/config';
import { NodeDependencyType, addPackageJsonDependency } from '../utility/dependencies';
import { latestVersions } from '../utility/latest-versions';
import { validateProjectName } from '../utility/validation';
import { Schema as ApplicationOptions } from './schema';
Expand Down Expand Up @@ -60,29 +61,23 @@ import { Schema as ApplicationOptions } from './schema';

function addDependenciesToPackageJson() {
return (host: Tree) => {
const packageJsonPath = 'package.json';

if (!host.exists('package.json')) { return host; }

const source = host.read('package.json');
if (!source) { return host; }

const sourceText = source.toString('utf-8');
const json = JSON.parse(sourceText);

if (!json['devDependencies']) {
json['devDependencies'] = {};
}

json.devDependencies = {
'@angular/compiler-cli': latestVersions.Angular,
'@angular-devkit/build-angular': latestVersions.DevkitBuildAngular,
'typescript': latestVersions.TypeScript,
// De-structure last keeps existing user dependencies.
...json.devDependencies,
};

host.overwrite(packageJsonPath, JSON.stringify(json, null, 2));
[
{
type: NodeDependencyType.Dev,
name: '@angular/compiler-cli',
version: latestVersions.Angular,
},
{
type: NodeDependencyType.Dev,
name: '@angular-devkit/build-angular',
version: latestVersions.DevkitBuildAngular,
},
{
type: NodeDependencyType.Dev,
name: 'typescript',
version: latestVersions.TypeScript,
},
].forEach(dependency => addPackageJsonDependency(host, dependency));

return host;
};
Expand Down
86 changes: 42 additions & 44 deletions packages/schematics/angular/library/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,23 +27,15 @@ import {
addProjectToWorkspace,
getWorkspace,
} from '../utility/config';
import {
NodeDependencyType,
addPackageJsonDependency,
} from '../utility/dependencies';
import { latestVersions } from '../utility/latest-versions';
import { validateProjectName } from '../utility/validation';
import { Schema as LibraryOptions } from './schema';


type PackageJsonPartialType = {
scripts: {
[key: string]: string;
},
dependencies: {
[key: string]: string;
},
devDependencies: {
[key: string]: string;
},
};

interface UpdateJsonFn<T> {
(obj: T): T | void;
}
Expand Down Expand Up @@ -96,39 +88,45 @@ function updateTsConfig(packageName: string, distRoot: string) {
function addDependenciesToPackageJson() {

return (host: Tree) => {
if (!host.exists('package.json')) { return host; }

return updateJsonFile(host, 'package.json', (json: PackageJsonPartialType) => {


if (!json['dependencies']) {
json['dependencies'] = {};
}

json.dependencies = {
'@angular/common': latestVersions.Angular,
'@angular/core': latestVersions.Angular,
'@angular/compiler': latestVersions.Angular,
// De-structure last keeps existing user dependencies.
...json.dependencies,
};

if (!json['devDependencies']) {
json['devDependencies'] = {};
}
[
{
type: NodeDependencyType.Dev,
name: '@angular/compiler-cli',
version: latestVersions.Angular,
},
{
type: NodeDependencyType.Dev,
name: '@angular-devkit/build-ng-packagr',
version: latestVersions.DevkitBuildNgPackagr,
},
{
type: NodeDependencyType.Dev,
name: '@angular-devkit/build-angular',
version: latestVersions.DevkitBuildNgPackagr,
},
{
type: NodeDependencyType.Dev,
name: 'ng-packagr',
version: '^3.0.0',
},
{
type: NodeDependencyType.Dev,
name: 'tsickle',
version: '>=0.29.0',
},
{
type: NodeDependencyType.Dev,
name: 'tslib',
version: '^1.9.0',
},
{
type: NodeDependencyType.Dev,
name: 'typescript',
version: latestVersions.TypeScript,
},
].forEach(dependency => addPackageJsonDependency(host, dependency));

json.devDependencies = {
'@angular/compiler-cli': latestVersions.Angular,
'@angular-devkit/build-ng-packagr': latestVersions.DevkitBuildNgPackagr,
'@angular-devkit/build-angular': latestVersions.DevkitBuildNgPackagr,
'ng-packagr': '^3.0.0',
'tsickle': '>=0.29.0',
'tslib': '^1.9.0',
'typescript': latestVersions.TypeScript,
// De-structure last keeps existing user dependencies.
...json.devDependencies,
};
});
return host;
};
}

Expand Down
60 changes: 14 additions & 46 deletions packages/schematics/angular/migrations/update-6/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,16 @@ import {
} from '@angular-devkit/schematics';
import { NodePackageInstallTask } from '@angular-devkit/schematics/tasks';
import { AppConfig, CliConfig } from '../../utility/config';
import { latestVersions } from '../../utility/latest-versions';
import {
appendPropertyInAstObject,
NodeDependency,
NodeDependencyType,
addPackageJsonDependency,
} from '../../utility/dependencies';
import {
appendValueInAstArray,
findPropertyInAstObject,
} from './json-utils';
} from '../../utility/json-utils';
import { latestVersions } from '../../utility/latest-versions';

const defaults = {
appRoot: 'src',
Expand Down Expand Up @@ -649,49 +653,13 @@ function updateSpecTsConfig(config: CliConfig): Rule {

function updatePackageJson(config: CliConfig) {
return (host: Tree, context: SchematicContext) => {
const pkgPath = '/package.json';
const buffer = host.read(pkgPath);
if (buffer == null) {
throw new SchematicsException('Could not read package.json');
}
const pkgAst = parseJsonAst(buffer.toString(), JsonParseMode.Strict);

if (pkgAst.kind != 'object') {
throw new SchematicsException('Error reading package.json');
}

const devDependenciesNode = findPropertyInAstObject(pkgAst, 'devDependencies');
if (devDependenciesNode && devDependenciesNode.kind != 'object') {
throw new SchematicsException('Error reading package.json; devDependency is not an object.');
}

const recorder = host.beginUpdate(pkgPath);
const depName = '@angular-devkit/build-angular';
if (!devDependenciesNode) {
// Haven't found the devDependencies key, add it to the root of the package.json.
appendPropertyInAstObject(recorder, pkgAst, 'devDependencies', {
[depName]: latestVersions.DevkitBuildAngular,
});
} else {
// Check if there's a build-angular key.
const buildAngularNode = findPropertyInAstObject(devDependenciesNode, depName);

if (!buildAngularNode) {
// No build-angular package, add it.
appendPropertyInAstObject(
recorder,
devDependenciesNode,
depName,
latestVersions.DevkitBuildAngular,
);
} else {
const { end, start } = buildAngularNode;
recorder.remove(start.offset, end.offset - start.offset);
recorder.insertRight(start.offset, JSON.stringify(latestVersions.DevkitBuildAngular));
}
}

host.commitUpdate(recorder);
const dependency: NodeDependency = {
type: NodeDependencyType.Dev,
name: '@angular-devkit/build-angular',
version: latestVersions.DevkitBuildAngular,
overwrite: true,
};
addPackageJsonDependency(host, dependency);

context.addTask(new NodePackageInstallTask({
packageManager: config.packageManager === 'default' ? undefined : config.packageManager,
Expand Down
21 changes: 9 additions & 12 deletions packages/schematics/angular/service-worker/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,10 @@ import {
getWorkspace,
getWorkspacePath,
} from '../utility/config';
import { addPackageJsonDependency, getPackageJsonDependency } from '../utility/dependencies';
import { getAppModulePath } from '../utility/ng-ast-utils';
import { Schema as ServiceWorkerOptions } from './schema';

const packageJsonPath = '/package.json';

function updateConfigFile(options: ServiceWorkerOptions): Rule {
return (host: Tree, context: SchematicContext) => {
context.logger.debug('updating config file.');
Expand Down Expand Up @@ -72,17 +71,15 @@ function addDependencies(): Rule {
return (host: Tree, context: SchematicContext) => {
const packageName = '@angular/service-worker';
context.logger.debug(`adding dependency (${packageName})`);
const buffer = host.read(packageJsonPath);
if (buffer === null) {
throw new SchematicsException('Could not find package.json');
const coreDep = getPackageJsonDependency(host, '@angular/core');
if (coreDep === null) {
throw new SchematicsException('Could not find version.');
}

const packageObject = JSON.parse(buffer.toString());

const ngCoreVersion = packageObject.dependencies['@angular/core'];
packageObject.dependencies[packageName] = ngCoreVersion;

host.overwrite(packageJsonPath, JSON.stringify(packageObject, null, 2));
const platformServerDep = {
...coreDep,
name: packageName,
};
addPackageJsonDependency(host, platformServerDep);

return host;
};
Expand Down
20 changes: 9 additions & 11 deletions packages/schematics/angular/universal/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ import * as ts from 'typescript';
import { findNode, getDecoratorMetadata } from '../utility/ast-utils';
import { InsertChange } from '../utility/change';
import { getWorkspace } from '../utility/config';
import { addPackageJsonDependency, getPackageJsonDependency } from '../utility/dependencies';
import { findBootstrapModuleCall, findBootstrapModulePath } from '../utility/ng-ast-utils';
import { Schema as UniversalOptions } from './schema';

Expand Down Expand Up @@ -172,18 +173,15 @@ function addServerTransition(options: UniversalOptions): Rule {

function addDependencies(): Rule {
return (host: Tree) => {
const pkgPath = '/package.json';
const buffer = host.read(pkgPath);
if (buffer === null) {
throw new SchematicsException('Could not find package.json');
const coreDep = getPackageJsonDependency(host, '@angular/core');
if (coreDep === null) {
throw new SchematicsException('Could not find version.');
}

const pkg = JSON.parse(buffer.toString());

const ngCoreVersion = pkg.dependencies['@angular/core'];
pkg.dependencies['@angular/platform-server'] = ngCoreVersion;

host.overwrite(pkgPath, JSON.stringify(pkg, null, 2));
const platformServerDep = {
...coreDep,
name: '@angular/platform-server',
};
addPackageJsonDependency(host, platformServerDep);

return host;
};
Expand Down
Loading