@minecraft/core-build-tasks 1.0.0

package/README.md

@@ -0,0 +1,5 @@
+# Core Build Tasks
+
+This package contains common build tasks used through the src-ts turbo build. If a task is used by `just` in multiple packages, it is moved into this package to reduce duplication. An example of this is the api-extractor task which is used by almost all packages in the src-ts subdirectory.
+
+This subdirectory only runs the `build` step, and more specifically, only runs `tsc` today since this package itself defines build tasks, so it must be kept lightweight.

package/lib/index.d.ts

@@ -0,0 +1 @@
+export * from './tasks';

package/lib/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./tasks"), exports);
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB"}

package/lib/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/index.test.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+(0, vitest_1.describe)('Remove when tests are added', () => {
+    (0, vitest_1.it)('Is always true', () => {
+        (0, vitest_1.expect)(true).toBe(true);
+    });
+});
+//# sourceMappingURL=index.test.js.map

package/lib/index.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":";;AAAA,mCAA8C;AAE9C,IAAA,iBAAQ,EAAC,6BAA6B,EAAE,GAAG,EAAE;IACzC,IAAA,WAAE,EAAC,gBAAgB,EAAE,GAAG,EAAE;QACtB,IAAA,eAAM,EAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/lib/tasks/api-extractor.d.ts

@@ -0,0 +1,6 @@
+/**
+ * A just task which executes API extractor based on the api-extractor.json configuration in the root of a package.
+ * @param jsonFile - the api-extractor.json file to use
+ * @beta
+ */
+export declare function apiExtractorTask(jsonFile: string, localBuild: boolean): () => Promise<void>;

package/lib/tasks/api-extractor.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.apiExtractorTask = void 0;
+const api_extractor_1 = require("@microsoft/api-extractor");
+/**
+ * A just task which executes API extractor based on the api-extractor.json configuration in the root of a package.
+ * @param jsonFile - the api-extractor.json file to use
+ * @beta
+ */
+function apiExtractorTask(jsonFile, localBuild) {
+    return () => {
+        console.log(`Running a ${localBuild ? 'local' : 'production'} api extractor build.`);
+        const apiExtractorJsonPath = jsonFile;
+        const extractorConfig = api_extractor_1.ExtractorConfig.loadFileAndPrepare(apiExtractorJsonPath);
+        const extractorResult = api_extractor_1.Extractor.invoke(extractorConfig, {
+            // Equivalent to the "--local" command-line parameter
+            localBuild,
+            // Equivalent to the "--verbose" command-line parameter
+            showVerboseMessages: true,
+        });
+        if (extractorResult.succeeded) {
+            console.log(`API Extractor completed successfully`);
+            process.exitCode = 0;
+            return Promise.resolve();
+        }
+        const message = `API Extractor did not complete successfully. ${extractorResult.errorCount} errors found and ${extractorResult.warningCount} warnings found. These must be addressed for the test to succeed.`;
+        console.error(message);
+        process.exitCode = 1;
+        return Promise.reject(new Error(message));
+    };
+}
+exports.apiExtractorTask = apiExtractorTask;
+//# sourceMappingURL=api-extractor.js.map

package/lib/tasks/api-extractor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-extractor.js","sourceRoot":"","sources":["../../src/tasks/api-extractor.ts"],"names":[],"mappings":";;;AAAA,4DAAuF;AAEvF;;;;GAIG;AACH,SAAgB,gBAAgB,CAAC,QAAgB,EAAE,UAAmB;IAClE,OAAO,GAAG,EAAE;QACR,OAAO,CAAC,GAAG,CAAC,aAAa,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,uBAAuB,CAAC,CAAC;QAErF,MAAM,oBAAoB,GAAW,QAAQ,CAAC;QAC9C,MAAM,eAAe,GAAoB,+BAAe,CAAC,kBAAkB,CAAC,oBAAoB,CAAC,CAAC;QAElG,MAAM,eAAe,GAAoB,yBAAS,CAAC,MAAM,CAAC,eAAe,EAAE;YACvE,qDAAqD;YACrD,UAAU;YAEV,uDAAuD;YACvD,mBAAmB,EAAE,IAAI;SAC5B,CAAC,CAAC;QAEH,IAAI,eAAe,CAAC,SAAS,EAAE;YAC3B,OAAO,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC;YACpD,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;YACrB,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;SAC5B;QAED,MAAM,OAAO,GAAG,gDAAgD,eAAe,CAAC,UAAU,qBAAqB,eAAe,CAAC,YAAY,mEAAmE,CAAC;QAE/M,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACvB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;QACrB,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;IAC9C,CAAC,CAAC;AACN,CAAC;AA3BD,4CA2BC"}

package/lib/tasks/clean.d.ts

@@ -0,0 +1,2 @@
+export declare const DEFAULT_CLEAN_DIRECTORIES: string[];
+export declare function cleanTask(dirs: string[]): () => void;

package/lib/tasks/clean.js

@@ -0,0 +1,21 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cleanTask = exports.DEFAULT_CLEAN_DIRECTORIES = void 0;
+const path_1 = __importDefault(require("path"));
+const rimraf_1 = __importDefault(require("rimraf"));
+exports.DEFAULT_CLEAN_DIRECTORIES = ['temp', 'lib', 'dist'];
+function cleanTask(dirs) {
+    return () => {
+        for (const dir of dirs) {
+            console.log(`Cleaning ${dir}`);
+            (0, rimraf_1.default)(path_1.default.resolve(process.cwd(), dir), () => {
+                // no-op on unable to clean
+            });
+        }
+    };
+}
+exports.cleanTask = cleanTask;
+//# sourceMappingURL=clean.js.map

package/lib/tasks/clean.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clean.js","sourceRoot":"","sources":["../../src/tasks/clean.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AACxB,oDAA4B;AAEf,QAAA,yBAAyB,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;AAEjE,SAAgB,SAAS,CAAC,IAAc;IACpC,OAAO,GAAG,EAAE;QACR,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;YACpB,OAAO,CAAC,GAAG,CAAC,YAAY,GAAG,EAAE,CAAC,CAAC;YAC/B,IAAA,gBAAM,EAAC,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,CAAC,EAAE,GAAG,EAAE;gBAC1C,2BAA2B;YAC/B,CAAC,CAAC,CAAC;SACN;IACL,CAAC,CAAC;AACN,CAAC;AATD,8BASC"}

package/lib/tasks/coreLint.d.ts

@@ -0,0 +1,2 @@
+import type { TaskFunction } from 'just-scripts';
+export declare function coreLint(files: string[], fix?: boolean): TaskFunction;

package/lib/tasks/coreLint.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.coreLint = void 0;
+const fs_1 = require("fs");
+const just_scripts_1 = require("just-scripts");
+const path_1 = __importDefault(require("path"));
+const process_1 = __importDefault(require("process"));
+function coreLint(files, fix) {
+    (0, just_scripts_1.task)('verify-lint', () => {
+        // If the process working directory does not have an `.eslintrc.js` file, fail the build
+        const lintConfig = path_1.default.resolve(process_1.default.cwd(), '.eslintrc.js');
+        if (!(0, fs_1.existsSync)(lintConfig)) {
+            throw new Error(`.eslintrc.js not found at ${lintConfig}.`);
+        }
+    });
+    (0, just_scripts_1.task)('eslint', (0, just_scripts_1.eslintTask)({ files, fix }));
+    (0, just_scripts_1.task)('prettier-fix', (0, just_scripts_1.prettierTask)({ files }));
+    (0, just_scripts_1.task)('prettier-check', (0, just_scripts_1.prettierCheckTask)({ files }));
+    return (0, just_scripts_1.series)('verify-lint', 'eslint', (0, just_scripts_1.condition)('prettier-check', () => !fix), (0, just_scripts_1.condition)('prettier-fix', () => !!fix));
+}
+exports.coreLint = coreLint;
+//# sourceMappingURL=coreLint.js.map

package/lib/tasks/coreLint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"coreLint.js","sourceRoot":"","sources":["../../src/tasks/coreLint.ts"],"names":[],"mappings":";;;;;;AAAA,2BAAgC;AAEhC,+CAAoG;AACpG,gDAAwB;AACxB,sDAA8B;AAE9B,SAAgB,QAAQ,CAAC,KAAe,EAAE,GAAa;IACnD,IAAA,mBAAI,EAAC,aAAa,EAAE,GAAG,EAAE;QACrB,wFAAwF;QACxF,MAAM,UAAU,GAAG,cAAI,CAAC,OAAO,CAAC,iBAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC,CAAC;QAC/D,IAAI,CAAC,IAAA,eAAU,EAAC,UAAU,CAAC,EAAE;YACzB,MAAM,IAAI,KAAK,CAAC,6BAA6B,UAAU,GAAG,CAAC,CAAC;SAC/D;IACL,CAAC,CAAC,CAAC;IACH,IAAA,mBAAI,EAAC,QAAQ,EAAE,IAAA,yBAAU,EAAC,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;IAC3C,IAAA,mBAAI,EAAC,cAAc,EAAE,IAAA,2BAAY,EAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IAC9C,IAAA,mBAAI,EAAC,gBAAgB,EAAE,IAAA,gCAAiB,EAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IAErD,OAAO,IAAA,qBAAM,EACT,aAAa,EACb,QAAQ,EACR,IAAA,wBAAS,EAAC,gBAAgB,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,EACvC,IAAA,wBAAS,EAAC,cAAc,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CACzC,CAAC;AACN,CAAC;AAlBD,4BAkBC"}

package/lib/tasks/index.d.ts

@@ -0,0 +1,4 @@
+export * from './api-extractor';
+export * from './clean';
+export * from './coreLint';
+export * from './vitest';

package/lib/tasks/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./api-extractor"), exports);
+__exportStar(require("./clean"), exports);
+__exportStar(require("./coreLint"), exports);
+__exportStar(require("./vitest"), exports);
+//# sourceMappingURL=index.js.map

package/lib/tasks/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/tasks/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAAgC;AAChC,0CAAwB;AACxB,6CAA2B;AAC3B,2CAAyB"}

package/lib/tasks/vitest.d.ts

@@ -0,0 +1 @@
+export declare function vitestTask(): () => void;

package/lib/tasks/vitest.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.vitestTask = void 0;
+const child_process_1 = require("child_process");
+function vitestTask() {
+    return () => {
+        (0, child_process_1.execSync)('vitest', { stdio: 'inherit' });
+    };
+}
+exports.vitestTask = vitestTask;
+//# sourceMappingURL=vitest.js.map

package/lib/tasks/vitest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vitest.js","sourceRoot":"","sources":["../../src/tasks/vitest.ts"],"names":[],"mappings":";;;AAAA,iDAAyC;AAEzC,SAAgB,UAAU;IACtB,OAAO,GAAG,EAAE;QACR,IAAA,wBAAQ,EAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7C,CAAC,CAAC;AACN,CAAC;AAJD,gCAIC"}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@minecraft/core-build-tasks",
+  "version": "1.0.0",
+  "description": "Common build tasks uses through this repository",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "author": "Raphael Landaverde (rlanda@microsoft.com)",
+  "scripts": {
+    "build-tools": "just-scripts build-tools",
+    "clean-tools": "just-scripts clean-tools",
+    "test": "just-scripts test"
+  },
+  "files": [
+    "lib"
+  ],
+  "dependencies": {
+    "@rushstack/node-core-library": "^3.59.6",
+    "@microsoft/api-extractor": "^7.38.3",
+    "rimraf": "^3.0.2",
+    "vitest": "^0.34.6",
+    "webpack": "^5.86.0"
+  },
+  "devDependencies": {
+    "@types/node": "^14.0.0 || ^16.0.0 || ^18.0.0",
+    "@types/rimraf": "^3.0.2",
+    "just-scripts": "^2.1.3",
+    "ts-node": "^10.9.1",
+    "tsconfig": "*",
+    "typescript": "^5.2.2"
+  }
+}