Skip to content

refactor: deprecate FormatType #4725

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
Aug 10, 2022
Merged

refactor: deprecate FormatType #4725

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
34 changes: 34 additions & 0 deletions .yarn/versions/2be8c391.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
releases:
"@yarnpkg/cli": patch
"@yarnpkg/core": minor
"@yarnpkg/plugin-essentials": patch

declined:
- "@yarnpkg/plugin-compat"
- "@yarnpkg/plugin-constraints"
- "@yarnpkg/plugin-dlx"
- "@yarnpkg/plugin-exec"
- "@yarnpkg/plugin-file"
- "@yarnpkg/plugin-git"
- "@yarnpkg/plugin-github"
- "@yarnpkg/plugin-http"
- "@yarnpkg/plugin-init"
- "@yarnpkg/plugin-interactive-tools"
- "@yarnpkg/plugin-link"
- "@yarnpkg/plugin-nm"
- "@yarnpkg/plugin-npm"
- "@yarnpkg/plugin-npm-cli"
- "@yarnpkg/plugin-pack"
- "@yarnpkg/plugin-patch"
- "@yarnpkg/plugin-pnp"
- "@yarnpkg/plugin-pnpm"
- "@yarnpkg/plugin-stage"
- "@yarnpkg/plugin-typescript"
- "@yarnpkg/plugin-version"
- "@yarnpkg/plugin-workspace-tools"
- "@yarnpkg/builder"
- "@yarnpkg/doctor"
- "@yarnpkg/extensions"
- "@yarnpkg/nm"
- "@yarnpkg/pnpify"
- "@yarnpkg/sdks"
26 changes: 13 additions & 13 deletions packages/plugin-essentials/sources/commands/add.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
import {BaseCommand, WorkspaceRequiredError} from '@yarnpkg/cli';
import {Cache, Configuration, Descriptor, FormatType, formatUtils, LightReport, MessageName} from '@yarnpkg/core';
import {Project, StreamReport, Workspace, Ident, InstallMode} from '@yarnpkg/core';
import {structUtils} from '@yarnpkg/core';
import {PortablePath} from '@yarnpkg/fslib';
import {Command, Option, Usage, UsageError} from 'clipanion';
import {prompt} from 'enquirer';
import * as t from 'typanion';

import * as suggestUtils from '../suggestUtils';
import {Hooks} from '..';
import {BaseCommand, WorkspaceRequiredError} from '@yarnpkg/cli';
import {Cache, Configuration, Descriptor, formatUtils, LightReport, MessageName} from '@yarnpkg/core';
import {Project, StreamReport, Workspace, Ident, InstallMode} from '@yarnpkg/core';
import {structUtils} from '@yarnpkg/core';
import {PortablePath} from '@yarnpkg/fslib';
import {Command, Option, Usage, UsageError} from 'clipanion';
import {prompt} from 'enquirer';
import * as t from 'typanion';

import * as suggestUtils from '../suggestUtils';
import {Hooks} from '..';

// eslint-disable-next-line arca/no-default-export
export default class AddCommand extends BaseCommand {
Expand Down Expand Up @@ -162,10 +162,10 @@ export default class AddCommand extends BaseCommand {

const unsupportedPrefix = pseudoDescriptor.match(/^(https?:|git@github)/);
if (unsupportedPrefix)
throw new UsageError(`It seems you are trying to add a package using a ${formatUtils.pretty(configuration, `${unsupportedPrefix[0]}...`, FormatType.RANGE)} url; we now require package names to be explicitly specified.\nTry running the command again with the package name prefixed: ${formatUtils.pretty(configuration, `yarn add`, FormatType.CODE)} ${formatUtils.pretty(configuration, structUtils.makeDescriptor(structUtils.makeIdent(null, `my-package`), `${unsupportedPrefix[0]}...`), FormatType.DESCRIPTOR)}`);
throw new UsageError(`It seems you are trying to add a package using a ${formatUtils.pretty(configuration, `${unsupportedPrefix[0]}...`, formatUtils.Type.RANGE)} url; we now require package names to be explicitly specified.\nTry running the command again with the package name prefixed: ${formatUtils.pretty(configuration, `yarn add`, formatUtils.Type.CODE)} ${formatUtils.pretty(configuration, structUtils.makeDescriptor(structUtils.makeIdent(null, `my-package`), `${unsupportedPrefix[0]}...`), formatUtils.Type.DESCRIPTOR)}`);

if (!request)
throw new UsageError(`The ${formatUtils.pretty(configuration, pseudoDescriptor, FormatType.CODE)} string didn't match the required format (package-name@range). Did you perhaps forget to explicitly reference the package name?`);
throw new UsageError(`The ${formatUtils.pretty(configuration, pseudoDescriptor, formatUtils.Type.CODE)} string didn't match the required format (package-name@range). Did you perhaps forget to explicitly reference the package name?`);

const target = suggestTarget(workspace, request, {
dev: this.dev,
Expand Down
20 changes: 10 additions & 10 deletions packages/plugin-essentials/sources/commands/remove.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
import {BaseCommand, WorkspaceRequiredError} from '@yarnpkg/cli';
import {Configuration, Cache, Descriptor, Project, formatUtils, FormatType} from '@yarnpkg/core';
import {StreamReport, Workspace, InstallMode} from '@yarnpkg/core';
import {structUtils} from '@yarnpkg/core';
import {Command, Option, Usage, UsageError} from 'clipanion';
import micromatch from 'micromatch';
import * as t from 'typanion';
import {BaseCommand, WorkspaceRequiredError} from '@yarnpkg/cli';
import {Configuration, Cache, Descriptor, Project, formatUtils} from '@yarnpkg/core';
import {StreamReport, Workspace, InstallMode} from '@yarnpkg/core';
import {structUtils} from '@yarnpkg/core';
import {Command, Option, Usage, UsageError} from 'clipanion';
import micromatch from 'micromatch';
import * as t from 'typanion';

import * as suggestUtils from '../suggestUtils';
import {Hooks} from '..';
import * as suggestUtils from '../suggestUtils';
import {Hooks} from '..';

// eslint-disable-next-line arca/no-default-export
export default class RemoveCommand extends BaseCommand {
Expand Down Expand Up @@ -149,7 +149,7 @@ export default class RemoveCommand extends BaseCommand {
: `this`;

if (unreferencedPatterns.length > 0)
throw new UsageError(`${patterns} ${formatUtils.prettyList(configuration, unreferencedPatterns, FormatType.CODE)} ${dont} match any packages referenced by ${which} workspace`);
throw new UsageError(`${patterns} ${formatUtils.prettyList(configuration, unreferencedPatterns, formatUtils.Type.CODE)} ${dont} match any packages referenced by ${which} workspace`);

if (hasChanged) {
await configuration.triggerMultipleHooks(
Expand Down
16 changes: 8 additions & 8 deletions packages/plugin-essentials/sources/commands/set/version.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import {BaseCommand} from '@yarnpkg/cli';
import {Configuration, StreamReport, MessageName, Report, Manifest, FormatType, YarnVersion, ReportError} from '@yarnpkg/core';
import {execUtils, formatUtils, httpUtils, miscUtils, semverUtils} from '@yarnpkg/core';
import {Filename, PortablePath, ppath, xfs, npath} from '@yarnpkg/fslib';
import {Command, Option, Usage, UsageError} from 'clipanion';
import semver from 'semver';
import {BaseCommand} from '@yarnpkg/cli';
import {Configuration, StreamReport, MessageName, Report, Manifest, YarnVersion, ReportError} from '@yarnpkg/core';
import {execUtils, formatUtils, httpUtils, miscUtils, semverUtils} from '@yarnpkg/core';
import {Filename, PortablePath, ppath, xfs, npath} from '@yarnpkg/fslib';
import {Command, Option, Usage, UsageError} from 'clipanion';
import semver from 'semver';

export type Tags = {
latest: Record<string, string>;
Expand Down Expand Up @@ -131,10 +131,10 @@ export default class SetVersionCommand extends BaseCommand {
const filePrefix = `file://`;

if (bundleRef.url.startsWith(filePrefix)) {
report.reportInfo(MessageName.UNNAMED, `Retrieving ${formatUtils.pretty(configuration, bundleRef.url, FormatType.PATH)}`);
report.reportInfo(MessageName.UNNAMED, `Retrieving ${formatUtils.pretty(configuration, bundleRef.url, formatUtils.Type.PATH)}`);
return await xfs.readFilePromise(bundleRef.url.slice(filePrefix.length) as PortablePath);
} else {
report.reportInfo(MessageName.UNNAMED, `Downloading ${formatUtils.pretty(configuration, bundleRef.url, FormatType.URL)}`);
report.reportInfo(MessageName.UNNAMED, `Downloading ${formatUtils.pretty(configuration, bundleRef.url, formatUtils.Type.URL)}`);
return await httpUtils.get(bundleRef.url, {configuration});
}
};
Expand Down
26 changes: 13 additions & 13 deletions packages/plugin-essentials/sources/commands/up.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
import {BaseCommand, WorkspaceRequiredError} from '@yarnpkg/cli';
import {IdentHash, structUtils} from '@yarnpkg/core';
import {Project, StreamReport, Workspace, InstallMode} from '@yarnpkg/core';
import {Cache, Configuration, Descriptor, LightReport, MessageName, MinimalResolveOptions, formatUtils, FormatType} from '@yarnpkg/core';
import {Command, Option, Usage, UsageError} from 'clipanion';
import {prompt} from 'enquirer';
import micromatch from 'micromatch';
import * as t from 'typanion';

import * as suggestUtils from '../suggestUtils';
import {Hooks} from '..';
import {BaseCommand, WorkspaceRequiredError} from '@yarnpkg/cli';
import {IdentHash, structUtils} from '@yarnpkg/core';
import {Project, StreamReport, Workspace, InstallMode} from '@yarnpkg/core';
import {Cache, Configuration, Descriptor, LightReport, MessageName, MinimalResolveOptions, formatUtils} from '@yarnpkg/core';
import {Command, Option, Usage, UsageError} from 'clipanion';
import {prompt} from 'enquirer';
import micromatch from 'micromatch';
import * as t from 'typanion';

import * as suggestUtils from '../suggestUtils';
import {Hooks} from '..';

// eslint-disable-next-line arca/no-default-export
export default class UpCommand extends BaseCommand {
Expand Down Expand Up @@ -223,9 +223,9 @@ export default class UpCommand extends BaseCommand {
}

if (unreferencedPatterns.length > 1)
throw new UsageError(`Patterns ${formatUtils.prettyList(configuration, unreferencedPatterns, FormatType.CODE)} don't match any packages referenced by any workspace`);
throw new UsageError(`Patterns ${formatUtils.prettyList(configuration, unreferencedPatterns, formatUtils.Type.CODE)} don't match any packages referenced by any workspace`);
if (unreferencedPatterns.length > 0)
throw new UsageError(`Pattern ${formatUtils.prettyList(configuration, unreferencedPatterns, FormatType.CODE)} doesn't match any packages referenced by any workspace`);
throw new UsageError(`Pattern ${formatUtils.prettyList(configuration, unreferencedPatterns, formatUtils.Type.CODE)} doesn't match any packages referenced by any workspace`);

const allSuggestions = await Promise.all(allSuggestionsPromises);

Expand Down
6 changes: 6 additions & 0 deletions packages/yarnpkg-core/sources/Configuration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,13 @@ export type SupportedArchitectures = {
libc: Array<string> | null;
};

/**
* @deprecated Use {@link formatUtils.Type}
*/
export type FormatType = formatUtils.Type;
/**
* @deprecated Use {@link formatUtils.Type}
*/
export const FormatType = formatUtils.Type;

export type BaseSettingsDefinition<T extends SettingsType = SettingsType> = {
Expand Down
4 changes: 2 additions & 2 deletions packages/yarnpkg-core/sources/Project.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import v8 from 'v8
import zlib from 'zlib';

import {Cache, CacheOptions} from './Cache';
import {Configuration, FormatType} from './Configuration';
import {Configuration} from './Configuration';
import {Fetcher, FetchOptions} from './Fetcher';
import {Installer, BuildDirective, BuildType, InstallStatus} from './Installer';
import {LegacyMigrationResolver} from './LegacyMigrationResolver';
Expand Down Expand Up @@ -924,7 +924,7 @@ export class Project {
}-${
process.arch
}) is supported by this package, but is missing from the ${
formatUtils.pretty(this.configuration, `supportedArchitectures`, FormatType.SETTING)
formatUtils.pretty(this.configuration, `supportedArchitectures`, formatUtils.Type.SETTING)
} setting`);
}

Expand Down