const path = require("path");

const fs = require("fs");

const log = require("fancy-log");

const newer = require("gulp-newer");

const sourcemaps = require("gulp-sourcemaps");

const del = require("del");

const rename = require("gulp-rename");

const concat = require("gulp-concat");

const merge2 = require("merge2");

const mkdirp = require("mkdirp");

const { src, dest, task, parallel, series, watch } = require("gulp");

const { append, transform } = require("gulp-insert");

const { prependFile } = require("./scripts/build/prepend");

const { exec, readJson, needsUpdate, getDiffTool, getDirSize, rm } = require("./scripts/build/utils");

const { runConsoleTests, refBaseline, localBaseline, refRwcBaseline, localRwcBaseline } = require("./scripts/build/tests");

const { buildProject, cleanProject, watchProject } = require("./scripts/build/projects");

const cmdLineOptions = require("./scripts/build/options");

const copyright = "CopyrightNotice.txt";

const cleanTasks = [];

const buildScripts = () => buildProject("scripts");

task("scripts", buildScripts);

task("scripts").description = "Builds files in the 'scripts' folder.";

const cleanScripts = () => cleanProject("scripts");

const libraries = readJson("./src/lib/libs.json");

const libs = libraries.libs.map(lib => {

const relativeSources = ["header.d.ts"].concat(libraries.sources && libraries.sources[lib] || [lib + ".d.ts"]);

const relativeTarget = libraries.paths && libraries.paths[lib] || ("lib." + lib + ".d.ts");

const sources = relativeSources.map(s => path.posix.join("src/lib", s));

const target = `built/local/${relativeTarget}`;

return { target, relativeTarget, sources };

const generateLibs = () => {

task("lib", generateLibs);

task("lib").description = "Builds the library targets";

const cleanLib = () => del(libs.map(lib => lib.target));

const watchLib = () => watch(["src/lib/**/*"], generateLibs);

const diagnosticInformationMapTs = "src/compiler/diagnosticInformationMap.generated.ts";

const diagnosticMessagesJson = "src/compiler/diagnosticMessages.json";

const diagnosticMessagesGeneratedJson = "src/compiler/diagnosticMessages.generated.json";

const generateDiagnostics = async () => {

task("generate-diagnostics", series(buildScripts, generateDiagnostics));

task("generate-diagnostics").description = "Generates a diagnostic file in TypeScript based on an input JSON file";

const cleanDiagnostics = () => del([diagnosticInformationMapTs, diagnosticMessagesGeneratedJson]);

const watchDiagnostics = () => watch(["src/compiler/diagnosticMessages.json"], task("generate-diagnostics"));

const generatedLCGFile = "built/local/enu/diagnosticMessages.generated.json.lcg";

const localizationTargets = ["cs", "de", "es", "fr", "it", "ja", "ko", "pl", "pt-br", "ru", "tr", "zh-cn", "zh-tw"]

.map(f => f.toLowerCase())

.map(f => `built/local/${f}/diagnosticMessages.generated.json`)

.concat(generatedLCGFile);

const localize = async () => {

const buildShims = () => buildProject("src/shims");

const cleanShims = () => cleanProject("src/shims");

const buildDebugTools = () => buildProject("src/debug");

const cleanDebugTools = () => cleanProject("src/debug");

const buildShimsAndTools = parallel(buildShims, buildDebugTools);

const lkgPreBuild = parallel(generateLibs, series(buildScripts, generateDiagnostics, buildShimsAndTools));

const buildTsc = () => buildProject("src/tsc");

task("tsc", series(lkgPreBuild, buildTsc));

task("tsc").description = "Builds the command-line compiler";

const cleanTsc = () => cleanProject("src/tsc");

task("clean-tsc", cleanTsc);

task("clean-tsc").description = "Cleans outputs for the command-line compiler";

const watchTsc = () => watchProject("src/tsc");

task("watch-tsc", series(lkgPreBuild, parallel(watchLib, watchDiagnostics, watchTsc)));

task("watch-tsc").description = "Watch for changes and rebuild the command-line compiler only.";

const localPreBuild = parallel(generateLibs, series(buildScripts, generateDiagnostics, buildShimsAndTools, buildTsc));

const preBuild = cmdLineOptions.lkg ? lkgPreBuild : localPreBuild;

const buildServices = (() => {

// build typescriptServices.out.js

const buildTypescriptServicesOut = () => buildProject("src/typescriptServices/tsconfig.json", cmdLineOptions);

// create typescriptServices.js

const createTypescriptServicesJs = () => src("built/local/typescriptServices.out.js")

.pipe(dest("built/local"));

// create typescriptServices.d.ts

const createTypescriptServicesDts = () => src("built/local/typescriptServices.out.d.ts")

.pipe(dest("built/local"));

// create typescript.js

const createTypescriptJs = () => src("built/local/typescriptServices.js")

.pipe(dest("built/local"));

// create typescript.d.ts

const createTypescriptDts = () => src("built/local/typescriptServices.d.ts")

.pipe(dest("built/local"));

// create typescript_standalone.d.ts

const createTypescriptStandaloneDts = () => src("built/local/typescriptServices.d.ts")

.pipe(dest("built/local"));

return series(

buildTypescriptServicesOut,

createTypescriptServicesJs,

createTypescriptServicesDts,

createTypescriptJs,

createTypescriptDts,

createTypescriptStandaloneDts,

);

task("services", series(preBuild, buildServices));

task("services").description = "Builds the language service";

task("services").flags = {

" --built": "Compile using the built version of the compiler."

const cleanServices = async () => {

task("clean-services", cleanServices);

task("clean-services").description = "Cleans outputs for the language service";

const watchServices = () => watch([

], series(preBuild, buildServices));

task("watch-services", series(preBuild, parallel(watchLib, watchDiagnostics, watchServices)));

task("watch-services").description = "Watches for changes and rebuild language service only";

task("watch-services").flags = {

" --built": "Compile using the built version of the compiler."

const buildServer = () => buildProject("src/tsserver", cmdLineOptions);

task("tsserver", series(preBuild, buildServer));

task("tsserver").description = "Builds the language server";

task("tsserver").flags = {

" --built": "Compile using the built version of the compiler."

const cleanServer = () => cleanProject("src/tsserver");

task("clean-tsserver", cleanServer);

task("clean-tsserver").description = "Cleans outputs for the language server";

const watchServer = () => watchProject("src/tsserver", cmdLineOptions);

task("watch-tsserver", series(preBuild, parallel(watchLib, watchDiagnostics, watchServer)));

task("watch-tsserver").description = "Watch for changes and rebuild the language server only";

task("watch-tsserver").flags = {

" --built": "Compile using the built version of the compiler."

task("min", series(preBuild, parallel(buildTsc, buildServer)));

task("min").description = "Builds only tsc and tsserver";

task("min").flags = {

" --built": "Compile using the built version of the compiler."

task("clean-min", series(cleanTsc, cleanServer));

task("clean-min").description = "Cleans outputs for tsc and tsserver";

task("watch-min", series(preBuild, parallel(watchLib, watchDiagnostics, watchTsc, watchServer)));

task("watch-min").description = "Watches for changes to a tsc and tsserver only";

task("watch-min").flags = {

" --built": "Compile using the built version of the compiler."

const buildLssl = (() => {

// build tsserverlibrary.out.js

const buildServerLibraryOut = () => buildProject("src/tsserverlibrary/tsconfig.json", cmdLineOptions);

// create tsserverlibrary.js

const createServerLibraryJs = () => src("built/local/tsserverlibrary.out.js")

.pipe(dest("built/local"));

// create tsserverlibrary.d.ts

const createServerLibraryDts = () => src("built/local/tsserverlibrary.out.d.ts")

.pipe(dest("built/local"));

return series(

buildServerLibraryOut,

createServerLibraryJs,

createServerLibraryDts,

);

task("lssl", series(preBuild, buildLssl));

task("lssl").description = "Builds language service server library";

task("lssl").flags = {

" --built": "Compile using the built version of the compiler."

const cleanLssl = async () => {

task("clean-lssl", cleanLssl);

task("clean-lssl").description = "Clean outputs for the language service server library";

const watchLssl = () => watch([

], buildLssl);

task("watch-lssl", series(preBuild, parallel(watchLib, watchDiagnostics, watchLssl)));

task("watch-lssl").description = "Watch for changes and rebuild tsserverlibrary only";

task("watch-lssl").flags = {

" --built": "Compile using the built version of the compiler."

const buildTests = () => buildProject("src/testRunner");

task("tests", series(preBuild, parallel(buildLssl, buildTests)));

task("tests").description = "Builds the test infrastructure";

task("tests").flags = {

" --built": "Compile using the built version of the compiler."

const cleanTests = () => cleanProject("src/testRunner");

task("clean-tests", cleanTests);

task("clean-tests").description = "Cleans the outputs for the test infrastructure";

const watchTests = () => watchProject("src/testRunner", cmdLineOptions);

const buildEslintRules = () => buildProject("scripts/eslint");

task("build-eslint-rules", buildEslintRules);

task("build-eslint-rules").description = "Compiles eslint rules to js";

const cleanEslintRules = () => cleanProject("scripts/eslint");

task("clean-eslint-rules", cleanEslintRules);

task("clean-eslint-rules").description = "Cleans the outputs for the eslint rules";

const runEslintRulesTests = () => runConsoleTests("scripts/eslint/built/tests", "mocha-fivemat-progress-reporter", /*runInParallel*/ false, /*watchMode*/ false);

task("run-eslint-rules-tests", series(buildEslintRules, runEslintRulesTests));

task("run-eslint-rules-tests").description = "Runs the eslint rule tests";

const eslint = (folder) => async () => {

const lintScripts = eslint("scripts");

lintScripts.displayName = "lint-scripts";

task("lint-scripts", series([buildEslintRules, lintScripts]));

task("lint-scripts").description = "Runs eslint on the scripts sources.";

const lintCompiler = eslint("src");

lintCompiler.displayName = "lint-compiler";

task("lint-compiler", series([buildEslintRules, lintCompiler]));

task("lint-compiler").description = "Runs eslint on the compiler sources.";

task("lint-compiler").flags = {

" --ci": "Runs eslint additional rules",

const lint = series([buildEslintRules, lintScripts, lintCompiler]);

lint.displayName = "lint";

task("lint", series([buildEslintRules, lint]));

task("lint").description = "Runs eslint on the compiler and scripts sources.";

task("lint").flags = {

" --ci": "Runs eslint additional rules",

const buildCancellationToken = () => buildProject("src/cancellationToken");

const cleanCancellationToken = () => cleanProject("src/cancellationToken");

const buildTypingsInstaller = () => buildProject("src/typingsInstaller");

const cleanTypingsInstaller = () => cleanProject("src/typingsInstaller");

const buildWatchGuard = () => buildProject("src/watchGuard");

const cleanWatchGuard = () => cleanProject("src/watchGuard");

const generateTypesMap = () => src("src/server/typesMap.json")

.pipe(newer("built/local/typesMap.json"))

.pipe(transform(contents => (JSON.parse(contents), contents))) // validates typesMap.json is valid JSON

.pipe(dest("built/local"));

task("generate-types-map", generateTypesMap);

const cleanTypesMap = () => del("built/local/typesMap.json");

const builtLocalDiagnosticMessagesGeneratedJson = "built/local/diagnosticMessages.generated.json";

const copyBuiltLocalDiagnosticMessages = () => src(diagnosticMessagesGeneratedJson)

.pipe(newer(builtLocalDiagnosticMessagesGeneratedJson))

.pipe(dest("built/local"));

const cleanBuiltLocalDiagnosticMessages = () => del(builtLocalDiagnosticMessagesGeneratedJson);

const buildOtherOutputs = parallel(buildCancellationToken, buildTypingsInstaller, buildWatchGuard, generateTypesMap, copyBuiltLocalDiagnosticMessages);

task("other-outputs", series(preBuild, buildOtherOutputs));

task("other-outputs").description = "Builds miscelaneous scripts and documents distributed with the LKG";

task("local", series(preBuild, parallel(localize, buildTsc, buildServer, buildServices, buildLssl, buildOtherOutputs)));

task("local").description = "Builds the full compiler and services";

task("local").flags = {

" --built": "Compile using the built version of the compiler."

task("watch-local", series(preBuild, parallel(watchLib, watchDiagnostics, watchTsc, watchServices, watchServer, watchLssl)));

task("watch-local").description = "Watches for changes to projects in src/ (but does not execute tests).";

task("watch-local").flags = {

" --built": "Compile using the built version of the compiler."

const preTest = parallel(buildTsc, buildTests, buildServices, buildLssl);

preTest.displayName = "preTest";

const postTest = (done) => cmdLineOptions.lint ? lint(done) : done();

const runTests = () => runConsoleTests("built/local/run.js", "mocha-fivemat-progress-reporter", /*runInParallel*/ false, /*watchMode*/ false);

task("runtests", series(preBuild, preTest, runTests, postTest));

task("runtests").description = "Runs the tests using the built run.js file.";

task("runtests").flags = {

"-t --tests=<regex>": "Pattern for tests to run.",

" --failed": "Runs tests listed in '.failed-tests'.",

"-r --reporter=<reporter>": "The mocha reporter to use.",

"-i --break": "Runs tests in inspector mode (NodeJS 8 and later)",

" --keepFailed": "Keep tests in .failed-tests even if they pass",

" --light": "Run tests in light mode (fewer verifications, but tests run faster)",

" --dirty": "Run tests without first cleaning test output directories",

" --stackTraceLimit=<limit>": "Sets the maximum number of stack frames to display. Use 'full' to show all frames.",

" --no-color": "Disables color",

" --no-lint": "Disables lint",

" --timeout=<ms>": "Overrides the default test timeout.",

" --built": "Compile using the built version of the compiler.",

" --shards": "Total number of shards running tests (default: 1)",

" --shardId": "1-based ID of this shard (default: 1)",

const runTestsParallel = () => runConsoleTests("built/local/run.js", "min", /*runInParallel*/ cmdLineOptions.workers > 1, /*watchMode*/ false);

task("runtests-parallel", series(preBuild, preTest, runTestsParallel, postTest));

task("runtests-parallel").description = "Runs all the tests in parallel using the built run.js file.";

task("runtests-parallel").flags = {

" --no-lint": "disables lint.",

" --light": "Run tests in light mode (fewer verifications, but tests run faster).",

" --keepFailed": "Keep tests in .failed-tests even if they pass.",

" --dirty": "Run tests without first cleaning test output directories.",

" --stackTraceLimit=<limit>": "Sets the maximum number of stack frames to display. Use 'full' to show all frames.",

" --workers=<number>": "The number of parallel workers to use.",

" --timeout=<ms>": "Overrides the default test timeout.",

" --built": "Compile using the built version of the compiler.",

" --shards": "Total number of shards running tests (default: 1)",

" --shardId": "1-based ID of this shard (default: 1)",

task("test-browser-integration", () => exec(process.execPath, ["scripts/browserIntegrationTest.js"]));

task("test-browser-integration").description = "Runs scripts/browserIntegrationTest.ts which tests that typescript.js loads in a browser";

task("diff", () => exec(getDiffTool(), [refBaseline, localBaseline], { ignoreExitCode: true, waitForExit: false }));

task("diff").description = "Diffs the compiler baselines using the diff tool specified by the 'DIFF' environment variable";

task("diff-rwc", () => exec(getDiffTool(), [refRwcBaseline, localRwcBaseline], { ignoreExitCode: true, waitForExit: false }));

task("diff-rwc").description = "Diffs the RWC baselines using the diff tool specified by the 'DIFF' environment variable";

const baselineAccept = (localBaseline, refBaseline) => merge2(

.pipe(rm(refBaseline)));

task("baseline-accept", () => baselineAccept(localBaseline, refBaseline));

task("baseline-accept").description = "Makes the most recent test results the new baseline, overwriting the old baseline";

task("baseline-accept-rwc", () => baselineAccept(localRwcBaseline, refRwcBaseline));

task("baseline-accept-rwc").description = "Makes the most recent rwc test results the new baseline, overwriting the old baseline";

const buildLoggedIO = () => buildProject("src/loggedIO/tsconfig-tsc-instrumented.json");

const cleanLoggedIO = () => del("built/local/loggedIO.js");

const buildInstrumenter = () => buildProject("src/instrumenter");

const cleanInstrumenter = () => cleanProject("src/instrumenter");

const tscInstrumented = () => exec(process.execPath, ["built/local/instrumenter.js", "record", cmdLineOptions.tests || "iocapture", "built/local/tsc.js"]);

task("tsc-instrumented", series(lkgPreBuild, parallel(localize, buildTsc, buildServer, buildServices, buildLssl, buildLoggedIO, buildInstrumenter), tscInstrumented));

task("tsc-instrumented").description = "Builds an instrumented tsc.js";

task("tsc-instrumented").flags = {

"-t --tests=<testname>": "The test to run."

const updateSublime = () => src(["built/local/tsserver.js", "built/local/tsserver.js.map"])

.pipe(dest("../TypeScript-Sublime-Plugin/tsserver/"));

task("update-sublime", updateSublime);

task("update-sublime").description = "Updates the sublime plugin's tsserver";

const buildImportDefinitelyTypedTests = () => buildProject("scripts/importDefinitelyTypedTests");

const cleanImportDefinitelyTypedTests = () => cleanProject("scripts/importDefinitelyTypedTests");

const importDefinitelyTypedTests = () => exec(process.execPath, ["scripts/importDefinitelyTypedTests/importDefinitelyTypedTests.js", "./", "../DefinitelyTyped"]);

task("importDefinitelyTypedTests", series(buildImportDefinitelyTypedTests, importDefinitelyTypedTests));

task("importDefinitelyTypedTests").description = "Runs the importDefinitelyTypedTests script to copy DT's tests to the TS-internal RWC tests";

const buildReleaseTsc = () => buildProject("src/tsc/tsconfig.release.json");

const cleanReleaseTsc = () => cleanProject("src/tsc/tsconfig.release.json");

const cleanBuilt = () => del("built");

const produceLKG = async () => {

task("LKG", series(lkgPreBuild, parallel(localize, buildTsc, buildServer, buildServices, buildLssl, buildOtherOutputs, buildReleaseTsc), produceLKG));

task("LKG").description = "Makes a new LKG out of the built js files";

task("LKG").flags = {

" --built": "Compile using the built version of the compiler.",

task("lkg", series("LKG"));

const generateSpec = () => exec("cscript", ["//nologo", "scripts/word2md.js", path.resolve("doc/TypeScript Language Specification - ARCHIVED.docx"), path.resolve("doc/spec-ARCHIVED.md")]);

task("generate-spec", series(buildScripts, generateSpec));

task("generate-spec").description = "Generates a Markdown version of the Language Specification";

task("clean", series(parallel(cleanTasks), cleanBuilt));

task("clean").description = "Cleans build outputs";

const configureNightly = () => exec(process.execPath, ["scripts/configurePrerelease.js", "dev", "package.json", "src/compiler/corePublic.ts"]);

task("configure-nightly", series(buildScripts, configureNightly));

task("configure-nightly").description = "Runs scripts/configurePrerelease.ts to prepare a build for nightly publishing";

const configureInsiders = () => exec(process.execPath, ["scripts/configurePrerelease.js", "insiders", "package.json", "src/compiler/corePublic.ts"]);

task("configure-insiders", series(buildScripts, configureInsiders));

task("configure-insiders").description = "Runs scripts/configurePrerelease.ts to prepare a build for insiders publishing";

const configureExperimental = () => exec(process.execPath, ["scripts/configurePrerelease.js", "experimental", "package.json", "src/compiler/corePublic.ts"]);

task("configure-experimental", series(buildScripts, configureExperimental));

task("configure-experimental").description = "Runs scripts/configurePrerelease.ts to prepare a build for experimental publishing";

const createLanguageServicesBuild = () => exec(process.execPath, ["scripts/createLanguageServicesBuild.js"]);

task("create-language-services-build", series(buildScripts, createLanguageServicesBuild));

task("create-language-services-build").description = "Runs scripts/createLanguageServicesBuild.ts to prepare a build which only has the require('typescript') JS.";

const publishNightly = () => exec("npm", ["publish", "--tag", "next"]);

task("publish-nightly", series(task("clean"), task("LKG"), task("clean"), task("runtests-parallel"), publishNightly));

task("publish-nightly").description = "Runs `npm publish --tag next` to create a new nightly build on npm";

const watchRuntests = () => watch(["built/local/*.js", "tests/cases/**/*.ts", "tests/cases/**/tsconfig.json"], { delay: 5000 }, async () => {

task("watch", series(preBuild, preTest, parallel(watchLib, watchDiagnostics, watchServices, watchLssl, watchTests, watchRuntests)));

task("watch").description = "Watches for changes and rebuilds and runs tests in parallel.";

task("watch").flags = {

"-t --tests=<regex>": "Pattern for tests to run. Forces tests to be run in a single worker.",

" --failed": "Runs tests listed in '.failed-tests'. Forces tests to be run in a single worker.",

"-r --reporter=<reporter>": "The mocha reporter to use.",

" --keepFailed": "Keep tests in .failed-tests even if they pass",

" --light": "Run tests in light mode (fewer verifications, but tests run faster)",

" --dirty": "Run tests without first cleaning test output directories",

" --stackTraceLimit=<limit>": "Sets the maximum number of stack frames to display. Use 'full' to show all frames.",

" --no-color": "Disables color",

" --no-lint": "Disables lint",

" --timeout=<ms>": "Overrides the default test timeout.",

" --workers=<number>": "The number of parallel workers to use.",

" --built": "Compile using the built version of the compiler.",

task("default", series("local"));

task("default").description = "Runs 'local'";

task("help", () => exec("gulp", ["--tasks", "--depth", "1", "--sort-tasks"], { hidePrompt: true }));

task("help").description = "Prints the top-level tasks.";