@bscotch/stitch-config 0.2.0

package/LICENSE.md

@@ -0,0 +1,29 @@
+# License for the Stitch Monorepo
+
+License information for the content of this git repository. The various packages in this repo are developed by [Butterscotch Shenanigans](https://www.bscotch.net) ("Bscotch").
+
+## License files
+
+Whenever a `LICENSE` file is found in a folder, or a license is specified by a `package.json` or similar manifest file, that license takes precedence for all files in that folder and its subfolders.
+
+This is the root-most `LICENSE` file, and therefore dictates the default licensing in this repository.
+
+## Stitch name and logo
+
+![Stitch Logo](https://img.bscotch.net/fit-in/256x256/logos/stitch.png "The Stitch Logo, copyright and trademark Butterscotch Shenanigans, all rights reserved.")
+
+Stitch™ and its logo are trademarks of Bscotch. Bscotch reserves all rights to Stitch and its logo.
+
+Stitch Logo ©2022 by Bscotch. All rights reserved.
+
+## Other code and content
+
+Everything found in this project, except for the Stitch name and logo as described above or unless otherwise specified by a more proximal LICENSE file, falls under the MIT license (https://opensource.org/license/mit/):
+
+Copyright 2023 Butterscotch Shenanigans
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,11 @@
+# Stitch Config
+
+[Stitch](https://github.com/bscotch/stitch) is a collection of tools for managing [GameMaker](https://gamemaker.io) projects, developed by [Butterscotch Shenanigans](https://www.bscotch.net/).
+
+Stitch projects make use of some shared libraries and resources. This package provides schemas and utilities to help manage the `stitch.config.json` file, which lives alongside a GameMaker project's `.yyp` file and is used for configuration of various Stitch features.
+
+The `stitch.config.json` file is used for configuration options that:
+
+- Are specific to the project (i.e. not general configuration)
+- Must be followed by all collaborators on that project
+- Are not machine-dependent nor user-dependent

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './schema.js';
+export declare const stitchConfigFilename = "stitch.config.json";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAE5B,eAAO,MAAM,oBAAoB,uBAAuB,CAAC"}

package/dist/index.js

@@ -0,0 +1,3 @@
+export * from './schema.js';
+export const stitchConfigFilename = 'stitch.config.json';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAE5B,MAAM,CAAC,MAAM,oBAAoB,GAAG,oBAAoB,CAAC"}

package/dist/schema.d.ts

@@ -0,0 +1,125 @@
+import { z } from 'zod';
+export declare const jsonSchemaUrl = "https://raw.githubusercontent.com/bscotch/stitch/develop/packages/config/schemas/stitch.config.schema.json";
+export type StitchConfig = z.infer<typeof stitchConfigSchema>;
+export declare const stitchConfigSchema: z.ZodObject<{
+    $schema: z.ZodDefault<z.ZodLiteral<"https://raw.githubusercontent.com/bscotch/stitch/develop/packages/config/schemas/stitch.config.schema.json">>;
+    textureGroupAssignments: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
+    audioGroupAssignments: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
+    runtimeVersion: z.ZodOptional<z.ZodString>;
+    newSpriteRules: z.ZodOptional<z.ZodObject<{
+        allowedNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        allowedNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        allowedNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, z.ZodTypeAny, "passthrough">>>;
+    newSoundRules: z.ZodOptional<z.ZodObject<{
+        allowedNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        defaults: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+            mono: z.ZodOptional<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            mono?: boolean | undefined;
+        }, {
+            mono?: boolean | undefined;
+        }>>>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        allowedNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        defaults: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+            mono: z.ZodOptional<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            mono?: boolean | undefined;
+        }, {
+            mono?: boolean | undefined;
+        }>>>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        allowedNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        defaults: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+            mono: z.ZodOptional<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            mono?: boolean | undefined;
+        }, {
+            mono?: boolean | undefined;
+        }>>>;
+    }, z.ZodTypeAny, "passthrough">>>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    $schema: z.ZodDefault<z.ZodLiteral<"https://raw.githubusercontent.com/bscotch/stitch/develop/packages/config/schemas/stitch.config.schema.json">>;
+    textureGroupAssignments: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
+    audioGroupAssignments: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
+    runtimeVersion: z.ZodOptional<z.ZodString>;
+    newSpriteRules: z.ZodOptional<z.ZodObject<{
+        allowedNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        allowedNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        allowedNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, z.ZodTypeAny, "passthrough">>>;
+    newSoundRules: z.ZodOptional<z.ZodObject<{
+        allowedNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        defaults: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+            mono: z.ZodOptional<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            mono?: boolean | undefined;
+        }, {
+            mono?: boolean | undefined;
+        }>>>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        allowedNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        defaults: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+            mono: z.ZodOptional<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            mono?: boolean | undefined;
+        }, {
+            mono?: boolean | undefined;
+        }>>>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        allowedNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        defaults: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+            mono: z.ZodOptional<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            mono?: boolean | undefined;
+        }, {
+            mono?: boolean | undefined;
+        }>>>;
+    }, z.ZodTypeAny, "passthrough">>>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    $schema: z.ZodDefault<z.ZodLiteral<"https://raw.githubusercontent.com/bscotch/stitch/develop/packages/config/schemas/stitch.config.schema.json">>;
+    textureGroupAssignments: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
+    audioGroupAssignments: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
+    runtimeVersion: z.ZodOptional<z.ZodString>;
+    newSpriteRules: z.ZodOptional<z.ZodObject<{
+        allowedNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        allowedNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        allowedNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, z.ZodTypeAny, "passthrough">>>;
+    newSoundRules: z.ZodOptional<z.ZodObject<{
+        allowedNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        defaults: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+            mono: z.ZodOptional<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            mono?: boolean | undefined;
+        }, {
+            mono?: boolean | undefined;
+        }>>>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        allowedNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        defaults: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+            mono: z.ZodOptional<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            mono?: boolean | undefined;
+        }, {
+            mono?: boolean | undefined;
+        }>>>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        allowedNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        defaults: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+            mono: z.ZodOptional<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            mono?: boolean | undefined;
+        }, {
+            mono?: boolean | undefined;
+        }>>>;
+    }, z.ZodTypeAny, "passthrough">>>;
+}, z.ZodTypeAny, "passthrough">>;
+//# sourceMappingURL=schema.d.ts.map

package/dist/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAQxB,eAAO,MAAM,aAAa,+GACoF,CAAC;AAE/G,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAC9D,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gCAwD5B,CAAC"}

package/dist/schema.js

@@ -0,0 +1,46 @@
+import { z } from 'zod';
+const allowedNames = z
+    .array(z.string())
+    .optional()
+    .describe('A list of regex patterns that new assets must match. Enforced by supported Stitch utilities.');
+export const jsonSchemaUrl = 'https://raw.githubusercontent.com/bscotch/stitch/develop/packages/config/schemas/stitch.config.schema.json';
+export const stitchConfigSchema = z
+    .object({
+    $schema: z.literal(jsonSchemaUrl).default(jsonSchemaUrl),
+    textureGroupAssignments: z
+        .record(z.string())
+        .default({})
+        .describe('A map of resource tree paths to texture groups name. Supported Stitch utilities will use this to assign sprites in those paths (recursively) to the specified texture group.'),
+    audioGroupAssignments: z
+        .record(z.string())
+        .default({})
+        .describe('A map of resource tree paths to audio groups name. Supported Stitch utilities will use this to assign sounds in those paths (recursively) to the specified audio group.'),
+    runtimeVersion: z
+        .string()
+        .optional()
+        .describe('When set, supported Stitch utilities will preferentially use this GameMaker runtime version.'),
+    newSpriteRules: z
+        .object({ allowedNames })
+        .passthrough()
+        .optional()
+        .describe('Rules for creating new sprite resources, followed by supported Stitch utilities.'),
+    newSoundRules: z
+        .object({
+        allowedNames,
+        defaults: z
+            .record(z.object({
+            mono: z
+                .boolean()
+                .optional()
+                .describe('Whether to default new sounds to mono. When not set, the default is stereo.'),
+        }))
+            .optional()
+            .describe('Default properties for new sound assets, by name pattern. E.g. `{".*":{ mono: true}}` defaults all new sounds to mono. The first matching pattern is used.'),
+    })
+        .passthrough()
+        .optional()
+        .describe('Rules for creating new sound resources, followed by supported Stitch utilities.'),
+})
+    .passthrough()
+    .describe('Stitch configuration schema. Stitch utilities may support subsets of this configuration.');
+//# sourceMappingURL=schema.js.map

package/dist/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,YAAY,GAAG,CAAC;KACnB,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;KACjB,QAAQ,EAAE;KACV,QAAQ,CACP,8FAA8F,CAC/F,CAAC;AACJ,MAAM,CAAC,MAAM,aAAa,GACxB,4GAA4G,CAAC;AAG/G,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC;KAChC,MAAM,CAAC;IACN,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC;IACxD,uBAAuB,EAAE,CAAC;SACvB,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SAClB,OAAO,CAAC,EAAE,CAAC;SACX,QAAQ,CACP,8KAA8K,CAC/K;IACH,qBAAqB,EAAE,CAAC;SACrB,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SAClB,OAAO,CAAC,EAAE,CAAC;SACX,QAAQ,CACP,yKAAyK,CAC1K;IACH,cAAc,EAAE,CAAC;SACd,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,8FAA8F,CAC/F;IACH,cAAc,EAAE,CAAC;SACd,MAAM,CAAC,EAAE,YAAY,EAAE,CAAC;SACxB,WAAW,EAAE;SACb,QAAQ,EAAE;SACV,QAAQ,CACP,kFAAkF,CACnF;IACH,aAAa,EAAE,CAAC;SACb,MAAM,CAAC;QACN,YAAY;QACZ,QAAQ,EAAE,CAAC;aACR,MAAM,CACL,CAAC,CAAC,MAAM,CAAC;YACP,IAAI,EAAE,CAAC;iBACJ,OAAO,EAAE;iBACT,QAAQ,EAAE;iBACV,QAAQ,CACP,6EAA6E,CAC9E;SACJ,CAAC,CACH;aACA,QAAQ,EAAE;aACV,QAAQ,CACP,4JAA4J,CAC7J;KACJ,CAAC;SACD,WAAW,EAAE;SACb,QAAQ,EAAE;SACV,QAAQ,CACP,iFAAiF,CAClF;CACJ,CAAC;KACD,WAAW,EAAE;KACb,QAAQ,CACP,0FAA0F,CAC3F,CAAC"}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@bscotch/stitch-config",
+  "version": "0.2.0",
+  "description": "Schemas and utilities for the stitch.config.json file.",
+  "keywords": [
+    "stitch",
+    "bscotch"
+  ],
+  "homepage": "https://github.com/bscotch/stitch/tree/develop/packages/config#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bscotch/stitch.git",
+    "directory": "packages/config"
+  },
+  "license": "MIT",
+  "type": "module",
+  "main": "dist/index.js",
+  "dependencies": {
+    "zod": "3.22.4"
+  },
+  "devDependencies": {
+    "source-map-support": "0.5.21",
+    "typescript": "5.3.3",
+    "zod-to-json-schema": "3.21.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc --build && node scripts/update-schemas.mjs",
+    "watch": "tsc --build --watch"
+  }
+}