Skip to content

Commit

Permalink
Separate typescript-versions into own package
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewbranch committed Apr 14, 2020
1 parent 8817225 commit ad42efb
Show file tree
Hide file tree
Showing 16 changed files with 177 additions and 156 deletions.
1 change: 1 addition & 0 deletions packages/definitions-parser/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
},
"dependencies": {
"@definitelytyped/header-parser": "^0.0.23-next.0",
"@definitelytyped/typescript-versions": "0.0.23-next.0",
"@definitelytyped/utils": "^0.0.23-next.0",
"@types/node": "^12.12.29",
"fs-extra": "^8.1.0",
Expand Down
4 changes: 2 additions & 2 deletions packages/definitions-parser/src/lib/definition-parser.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ import {
join,
flatMap,
unique,
unmangleScopedPackage,
TypeScriptVersion
unmangleScopedPackage
} from "@definitelytyped/utils";
import { TypeScriptVersion } from "@definitelytyped/typescript-versions";

function matchesVersion(typingsDataRaw: TypingsDataRaw, version: TypingVersion, considerLibraryMinorVersion: boolean) {
return (
Expand Down
11 changes: 2 additions & 9 deletions packages/definitions-parser/src/packages.ts
Original file line number Diff line number Diff line change
@@ -1,14 +1,7 @@
import assert = require("assert");
import { Author } from "@definitelytyped/header-parser";
import {
FS,
mapValues,
assertSorted,
unmangleScopedPackage,
Semver,
TypeScriptVersion,
AllTypeScriptVersion
} from "@definitelytyped/utils";
import { FS, mapValues, assertSorted, unmangleScopedPackage, Semver } from "@definitelytyped/utils";
import { AllTypeScriptVersion, TypeScriptVersion } from "@definitelytyped/typescript-versions";
import { readDataFile } from "./data-file";
import { scopeName, typesDirectoryName } from "./lib/settings";
import { parseVersionFromDirectoryName } from "./parse-definitions";
Expand Down
2 changes: 1 addition & 1 deletion packages/header-parser/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
"url": "https://github.com/DefinitelyTyped/tools/issues"
},
"dependencies": {
"@definitelytyped/utils": "^0.0.23-next.0",
"@definitelytyped/typescript-versions": "0.0.23-next.0",
"@types/parsimmon": "^1.10.1",
"parsimmon": "^1.13.0"
},
Expand Down
6 changes: 1 addition & 5 deletions packages/header-parser/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import pm = require("parsimmon");
import { AllTypeScriptVersion, TypeScriptVersion } from "@definitelytyped/utils";
import { AllTypeScriptVersion, TypeScriptVersion } from "@definitelytyped/typescript-versions";

/*
Expand Down Expand Up @@ -36,10 +36,6 @@ export interface ParseError {
readonly expected: readonly string[];
}

export function isTypeScriptVersion(str: string): str is TypeScriptVersion {
return TypeScriptVersion.all.includes(str as TypeScriptVersion);
}

export function makeTypesVersionsForPackageJson(typesVersions: readonly TypeScriptVersion[]): unknown {
if (typesVersions.length === 0) {
return undefined;
Expand Down
8 changes: 4 additions & 4 deletions packages/publisher/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions packages/publisher/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
"dependencies": {
"@definitelytyped/definitions-parser": "^0.0.23-next.0",
"@definitelytyped/header-parser": "^0.0.23-next.0",
"@definitelytyped/typescript-versions": "0.0.23-next.0",
"@definitelytyped/utils": "^0.0.23-next.0",
"@octokit/rest": "^16.1.0",
"adal-node": "^0.1.22",
Expand Down
9 changes: 1 addition & 8 deletions packages/publisher/src/lib/package-publisher.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
import assert = require("assert");
import {
Logger,
joinPaths,
readFileAndWarn,
TypeScriptVersion,
NpmPublishClient,
Registry
} from "@definitelytyped/utils";
import { Logger, joinPaths, readFileAndWarn, NpmPublishClient, Registry } from "@definitelytyped/utils";
import { NotNeededPackage, AnyPackage } from "@definitelytyped/definitions-parser";
import { ChangedTyping } from "./versions";
import { outputDirectory } from "../util/util";
Expand Down
3 changes: 3 additions & 0 deletions packages/typescript-versions/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# @definitelytyped/typescript-versions

List of supported TypeScript versions.
19 changes: 19 additions & 0 deletions packages/typescript-versions/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"name": "@definitelytyped/typescript-versions",
"version": "0.0.23-next.0",
"description": "List of supported TypeScript versions",
"author": "Andrew Branch <[email protected]>",
"homepage": "https://github.com/microsoft/DefinitelyTyped-tools#readme",
"license": "MIT",
"main": "dist/index.js",
"publishConfig": {
"access": "public"
},
"repository": {
"type": "git",
"url": "git+https://github.com/microsoft/DefinitelyTyped-tools.git"
},
"bugs": {
"url": "https://github.com/microsoft/DefinitelyTyped-tools/issues"
}
}
126 changes: 126 additions & 0 deletions packages/typescript-versions/src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
import assert from "assert";

/*
# How to add new version of Typescript #
For the RC:
1. Add a new version to the end of `supportedTags`.
2. Update failing tests.
3. Publish and update dependents.
For the release:
1. Add new versions to the end of `TypeScriptVersion` and `supported`.
2. Update failing tests.
3. Publish and update dependents.
# How to deprecate versions on Definitely Typed #
1. Move versions from `TypeScriptVersion` to `UnsupportedTypeScriptVersion`.
2. Move versions from `supported` to `unsupported`.
3. Remove entry from `supportedTags`.
4. Update failing tests.
5. Publish and update dependents.
*/

/** Parseable but unsupported TypeScript versions. */
export type UnsupportedTypeScriptVersion = "2.0" | "2.1" | "2.2" | "2.3" | "2.4" | "2.5" | "2.6" | "2.7";
/**
* Parseable and supported TypeScript versions.
* Only add to this list if we will support this version on DefinitelyTyped.
*/
export type TypeScriptVersion =
| "2.8"
| "2.9"
| "3.0"
| "3.1"
| "3.2"
| "3.3"
| "3.4"
| "3.5"
| "3.6"
| "3.7"
| "3.8"
| "3.9";

export type AllTypeScriptVersion = UnsupportedTypeScriptVersion | TypeScriptVersion;

export namespace TypeScriptVersion {
export const supported: readonly TypeScriptVersion[] = [
"2.8",
"2.9",
"3.0",
"3.1",
"3.2",
"3.3",
"3.4",
"3.5",
"3.6",
"3.7",
"3.8",
"3.9"
];
export const unsupported: readonly UnsupportedTypeScriptVersion[] = [
"2.0",
"2.1",
"2.2",
"2.3",
"2.4",
"2.5",
"2.6",
"2.7"
];
export const all: readonly AllTypeScriptVersion[] = [...unsupported, ...supported];
export const lowest = supported[0];
/** Latest version that may be specified in a `// TypeScript Version:` header. */
export const latest = supported[supported.length - 1];

/** @deprecated */
export function isPrerelease(_version: TypeScriptVersion): boolean {
return false;
}

export function isSupported(v: AllTypeScriptVersion): v is TypeScriptVersion {
return supported.indexOf(v as TypeScriptVersion) > -1;
}

export function range(min: TypeScriptVersion): readonly TypeScriptVersion[] {
return supported.filter(v => v >= min);
}

const supportedTags: readonly string[] = [
"ts2.8",
"ts2.9",
"ts3.0",
"ts3.1",
"ts3.2",
"ts3.3",
"ts3.4",
"ts3.5",
"ts3.6",
"ts3.7",
"ts3.8",
"ts3.9",
"latest"
];

/** List of NPM tags that should be changed to point to the latest version. */
export function tagsToUpdate(v: TypeScriptVersion): readonly string[] {
const idx = supportedTags.indexOf(`ts${v}`);
assert(idx !== -1);
return supportedTags.slice(idx);
}

export function previous(v: TypeScriptVersion): TypeScriptVersion | undefined {
const index = supported.indexOf(v);
assert(index !== -1);
return index === 0 ? undefined : supported[index - 1];
}

export function isRedirectable(v: TypeScriptVersion): boolean {
return all.indexOf(v) >= all.indexOf("3.1");
}
}
8 changes: 8 additions & 0 deletions packages/typescript-versions/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"extends": "../../tsconfig.base.json",
"compilerOptions": {
"rootDir": "src",
"outDir": "dist"
},
"include": ["src"]
}
1 change: 1 addition & 0 deletions packages/utils/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
"url": "https://github.com/DefinitelyTyped/tools/issues"
},
"dependencies": {
"@definitelytyped/typescript-versions": "0.0.23-next.0",
"@types/node": "^12.12.29",
"charm": "^1.0.2",
"fs-extra": "^8.1.0",
Expand Down
Loading

0 comments on commit ad42efb

Please sign in to comment.