pxt-core 13.2.9 → 13.2.10

package/built/tests/cli-test/cli/localrepos.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Name of the machine-local file, at the root of a target checkout, that maps
+ * GitHub repositories to local directories for `pxt serve`. It holds paths of
+ * the developer's machine, so it is meant to stay out of source control.
+ */
+export declare const LOCAL_CONFIG_NAME = "pxtlocal.json";
+/**
+ * Contents of pxtlocal.json.
+ */
+export interface LocalConfig {
+    /**
+     * Maps a GitHub repository ("owner/repo") to the local directory holding
+     * its checkout, absolute or relative to the directory of pxtlocal.json.
+     */
+    localRepos?: pxt.Map<string>;
+}
+/**
+ * Repository metadata, in the shape the MakeCode GitHub proxy returns it.
+ */
+export interface LocalRepoMeta {
+    name: string;
+    description: string;
+}
+/**
+ * Refs listing, in the shape the MakeCode GitHub proxy returns it.
+ */
+export interface LocalRepoRefs {
+    refs: pxt.Map<string>;
+}
+/**
+ * Builds the map of GitHub repositories that `pxt serve` resolves from local
+ * directories.
+ *
+ * Entries come from pxtlocal.json in `targetDir`, when the file exists, with
+ * relative directories resolved against `targetDir`. Each `flagValue`
+ * ("owner/repo=dir", relative directories resolved against `cwd`) is applied
+ * after the file and replaces a file entry for the same repository.
+ *
+ * Returns the map from lowercase "owner/repo" to absolute directory. Throws a
+ * user error when pxtlocal.json is not valid JSON, or an entry names
+ * something other than a repository or a directory that does not exist.
+ */
+export declare function loadLocalRepos(targetDir: string, flagValues: string[], cwd: string): pxt.Map<string>;
+/**
+ * Answers a request for an aliased repository in the shape the MakeCode
+ * GitHub proxy answers it, reading the repository's local directory. The
+ * request is the path after "gh/":
+ *
+ * - "owner/repo": the repository metadata ({@link LocalRepoMeta}); the
+ *   description is the one in the repository's root pxt.json, if any
+ * - "owner/repo/refs": the refs listing ({@link LocalRepoRefs}), always
+ *   empty, because an aliased repository serves its working tree whatever
+ *   ref is asked for
+ * - "owner/repo[/path]/text": the files of the package at `path` (the
+ *   repository root when omitted), keyed by file name: its pxt.json and
+ *   every file that pxt.json lists
+ *
+ * Throws an error carrying the HTTP `statusCode` to answer with: 404 when
+ * the repository is not aliased, or when the package's pxt.json or a file it
+ * lists does not exist; 400 when the path lies outside the repository's
+ * directory, the pxt.json is not valid or lists a file outside the package's
+ * directory, or the request matches none of the forms above. Every error is
+ * also written to the console.
+ */
+export declare function resolveLocalRepoRequest(localRepos: pxt.Map<string>, request: string): LocalRepoMeta | LocalRepoRefs | pxt.Map<string>;

package/built/tests/cli-test/tests/cli-test/clirunner.d.ts

@@ -0,0 +1,2 @@
+/// <reference path="../../../../pxtlib.d.ts" />
+import "mocha";

package/built/tests/simdriver-test/simdriverrunner.d.ts

@@ -0,0 +1,2 @@
+/// <reference path="../../pxtsim.d.ts" />
+import "mocha";