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.

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

Promote "info" fields out in artifacts for consistency with manifests. #644

Merged
merged 1 commit into from
Jul 26, 2022
+356 −313
Merged

Promote "info" fields out in artifacts for consistency with manifests. #644

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
6 changes: 3 additions & 3 deletions ce/ce/amf/contact.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

import { Dictionary } from '../interfaces/collections';
import { Contact as IContact } from '../interfaces/metadata/contact';
import { ValidationError } from '../interfaces/validation-error';
import { ValidationMessage } from '../interfaces/validation-message';
import { Entity } from '../yaml/Entity';
import { EntityMap } from '../yaml/EntityMap';
import { Strings } from '../yaml/strings';
Expand All @@ -15,7 +15,7 @@ export class Contact extends Entity implements IContact {

readonly roles = new Strings(undefined, this, 'role');
/** @internal */
override *validate(): Iterable<ValidationError> {
override *validate(): Iterable<ValidationMessage> {
yield* super.validate();
yield* this.validateChildKeys(['email', 'role']);
yield* this.validateChild('email', 'string');
Expand All @@ -27,7 +27,7 @@ export class Contacts extends EntityMap<YAMLDictionary, Contact> implements Dict
super(Contact, node, parent, key);
}
/** @internal */
override *validate(): Iterable<ValidationError> {
override *validate(): Iterable<ValidationMessage> {
yield* super.validate();
if (this.exists()) {
for (const [key, contact] of this) {
Expand Down
6 changes: 3 additions & 3 deletions ce/ce/amf/demands.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import { isMap, isScalar } from 'yaml';
import { i } from '../i18n';
import { ErrorKind } from '../interfaces/error-kind';
import { ValidationError } from '../interfaces/validation-error';
import { ValidationMessage } from '../interfaces/validation-message';
import { parseQuery } from '../mediaquery/media-query';
import { Session } from '../session';
import { Entity } from '../yaml/Entity';
Expand All @@ -30,7 +30,7 @@ export class Demands extends EntityMap<YAMLDictionary, DemandBlock> {
}

/** @internal */
override *validate(): Iterable<ValidationError> {
override *validate(): Iterable<ValidationMessage> {
yield* super.validate();

for (const [mediaQuery, demandBlock] of this) {
Expand Down Expand Up @@ -89,7 +89,7 @@ export class DemandBlock extends Entity {
}

/** @internal */
override *validate(): Iterable<ValidationError> {
override *validate(): Iterable<ValidationMessage> {
yield* this.validateChildKeys(['error', 'warning', 'message', 'seeAlso', 'requires', 'exports', 'install', 'unless']);

yield* super.validate();
Expand Down
4 changes: 2 additions & 2 deletions ce/ce/amf/exports.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@


import { Exports as IExports } from '../interfaces/metadata/exports';
import { ValidationError } from '../interfaces/validation-error';
import { ValidationMessage } from '../interfaces/validation-message';
import { BaseMap } from '../yaml/BaseMap';
import { ScalarMap } from '../yaml/ScalarMap';
import { StringsMap } from '../yaml/strings';
Expand All @@ -20,7 +20,7 @@ export class Exports extends BaseMap implements IExports {
contents: StringsMap = new StringsMap(undefined, this, 'contents');

/** @internal */
override *validate(): Iterable<ValidationError> {
override *validate(): Iterable<ValidationMessage> {
yield* super.validate();
yield* this.validateChildKeys(['paths', 'locations', 'properties', 'environment', 'tools', 'defines', 'aliases', 'contents']);
// todo: what validations do we need?
Expand Down
27 changes: 10 additions & 17 deletions ce/ce/amf/info.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,35 +3,28 @@

import { i } from '../i18n';
import { ErrorKind } from '../interfaces/error-kind';
import { Info as IInfo } from '../interfaces/metadata/info';
import { ValidationError } from '../interfaces/validation-error';
import { Validation } from '../interfaces/validation';
import { ValidationMessage } from '../interfaces/validation-message';
import { Entity } from '../yaml/Entity';
import { Flags } from '../yaml/Flags';
import { Options } from '../yaml/Options';


export class Info extends Entity implements IInfo {
get version(): string { return this.asString(this.getMember('version')) || ''; }
set version(value: string) { this.setMember('version', value); }

export class Info extends Entity implements Validation {
// See corresponding properties in MetadataFile
get id(): string { return this.asString(this.getMember('id')) || ''; }
set id(value: string) { this.setMember('id', value); }

get summary(): string | undefined { return this.asString(this.getMember('summary')); }
set summary(value: string | undefined) { this.setMember('summary', value); }
get version(): string { return this.asString(this.getMember('version')) || ''; }

get priority(): number | undefined { return this.asNumber(this.getMember('priority')) || 0; }
set priority(value: number | undefined) { this.setMember('priority', value); }
get summary(): string | undefined { return this.asString(this.getMember('summary')); }

get description(): string | undefined { return this.asString(this.getMember('description')); }
set description(value: string | undefined) { this.setMember('description', value); }

readonly flags = new Flags(undefined, this, 'options');
readonly options = new Options(undefined, this, 'options');

get dependencyOnly(): boolean { return this.flags.has('dependencyOnly'); }
set dependencyOnly(value: boolean) { this.flags.set('dependencyOnly', value); }
get priority(): number { return this.asNumber(this.getMember('priority')) || 0; }

/** @internal */
override *validate(): Iterable<ValidationError> {
override *validate(): Iterable<ValidationMessage> {
yield* super.validate();
yield* this.validateChildKeys(['version', 'id', 'summary', 'priority', 'description', 'options']);

Expand Down
32 changes: 16 additions & 16 deletions ce/ce/amf/installer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ import { Installer as IInstaller } from '../interfaces/metadata/installers/Insta
import { NupkgInstaller } from '../interfaces/metadata/installers/nupkg';
import { UnTarInstaller } from '../interfaces/metadata/installers/tar';
import { UnZipInstaller } from '../interfaces/metadata/installers/zip';
import { ValidationError } from '../interfaces/validation-error';
import { ValidationMessage } from '../interfaces/validation-message';
import { Entity } from '../yaml/Entity';
import { EntitySequence } from '../yaml/EntitySequence';
import { Flags } from '../yaml/Flags';
import { Options } from '../yaml/Options';
import { Strings } from '../yaml/strings';
import { Node, Yaml, YAMLDictionary } from '../yaml/yaml-types';

Expand Down Expand Up @@ -48,7 +48,7 @@ export class Installs extends EntitySequence<Installer> {
throw new Error('Unsupported node type');
}

override *validate(): Iterable<ValidationError> {
override *validate(): Iterable<ValidationMessage> {
yield* super.validate();
for (const each of this) {
yield* each.validate();
Expand All @@ -73,7 +73,7 @@ export class Installer extends Entity implements IInstaller {
return this.asString(this.getMember('nametag'));
}

override *validate(): Iterable<ValidationError> {
override *validate(): Iterable<ValidationMessage> {
yield* super.validate();
yield* this.validateChild('lang', 'string');
yield* this.validateChild('nametag', 'string');
Expand Down Expand Up @@ -107,7 +107,7 @@ abstract class FileInstallerNode extends Installer {

readonly transform = new Strings(undefined, this, 'transform');

override *validate(): Iterable<ValidationError> {
override *validate(): Iterable<ValidationMessage> {
yield* super.validate();
yield* this.validateChild('strip', 'number');
yield* this.validateChild('sha256', 'string');
Expand All @@ -119,7 +119,7 @@ class UnzipNode extends FileInstallerNode implements UnZipInstaller {
override get installerKind() { return 'unzip'; }

readonly location = new Strings(undefined, this, 'unzip');
override *validate(): Iterable<ValidationError> {
override *validate(): Iterable<ValidationMessage> {
yield* super.validate();
yield* this.validateChildKeys(['unzip', 'sha256', 'sha512', 'strip', 'transform', 'lang', 'nametag']);
}
Expand All @@ -128,7 +128,7 @@ class UnzipNode extends FileInstallerNode implements UnZipInstaller {
class UnTarNode extends FileInstallerNode implements UnTarInstaller {
override get installerKind() { return 'untar'; }
location = new Strings(undefined, this, 'untar');
override *validate(): Iterable<ValidationError> {
override *validate(): Iterable<ValidationMessage> {
yield* super.validate();
yield* this.validateChildKeys(['untar', 'sha256', 'sha512', 'strip', 'transform']);
}
Expand Down Expand Up @@ -169,7 +169,7 @@ class NupkgNode extends Installer implements NupkgInstaller {
}

readonly transform = new Strings(undefined, this, 'transform');
override *validate(): Iterable<ValidationError> {
override *validate(): Iterable<ValidationMessage> {
yield* super.validate();
yield* this.validateChildKeys(['nupkg', 'sha256', 'sha512', 'strip', 'transform', 'lang', 'nametag']);
}
Expand All @@ -194,22 +194,22 @@ class GitCloneNode extends Installer implements GitInstaller {
this.setMember('commit', value);
}

private flags = new Flags(undefined, this, 'options');
private options = new Options(undefined, this, 'options');

get full() {
return this.flags.has('full');
return this.options.has('full');
}

set full(value: boolean) {
this.flags.set('full', value);
this.options.set('full', value);
}

get recurse() {
return this.flags.has('recurse');
return this.options.has('recurse');
}

set recurse(value: boolean) {
this.flags.set('recurse', value);
this.options.set('recurse', value);
}

get subdirectory() {
Expand All @@ -221,14 +221,14 @@ class GitCloneNode extends Installer implements GitInstaller {
}

get espidf() {
return this.flags.has('espidf');
return this.options.has('espidf');
}

set espidf(value: boolean) {
this.flags.set('espidf', value);
this.options.set('espidf', value);
}

override *validate(): Iterable<ValidationError> {
override *validate(): Iterable<ValidationMessage> {
yield* super.validate();
yield* this.validateChildKeys(['git', 'commit', 'subdirectory', 'options', 'lang', 'nametag']);
yield* this.validateChild('commit', 'string');
Expand Down
Loading