skir 0.0.1

package/dist/types.d.ts

@@ -0,0 +1,375 @@
+/**
+ * @fileoverview Public types present in the interface between the compiler and
+ * language plugins.
+ */
+import type { z } from "zod";
+/**
+ * Generates code in one programming language from a set of parsed Skir modules.
+ */
+export interface CodeGenerator<Config = unknown> {
+    readonly id: string;
+    readonly version: string;
+    readonly configType: z.ZodType<Config>;
+    generateCode(input: CodeGenerator.Input<Config>): CodeGenerator.Output;
+}
+export declare namespace CodeGenerator {
+    interface Input<Config> {
+        readonly modules: ReadonlyArray<Module>;
+        readonly recordMap: ReadonlyMap<RecordKey, RecordLocation>;
+        readonly config: Config;
+    }
+    interface Output {
+        readonly files: readonly OutputFile[];
+    }
+    interface OutputFile {
+        readonly path: string;
+        readonly code: string;
+    }
+}
+/** One line in a module. */
+export interface CodeLine {
+    /** Zero-based. */
+    readonly lineNumber: number;
+    readonly line: string;
+    readonly position: number;
+    readonly modulePath: string;
+}
+/** A lexical token. */
+export interface Token {
+    /** Empty if the token is the special token for EOF. */
+    readonly text: string;
+    /** Measured in number of characters from the start of the module. */
+    readonly position: number;
+    readonly line: CodeLine;
+    /** Zero-based. */
+    readonly colNumber: number;
+}
+export type Casing = "lowerCamel" | "lower_underscore" | "UpperCamel" | "UPPER_UNDERSCORE";
+/** A user error in a module. */
+export type SkirError = {
+    readonly token: Token;
+    /** Convention: starts with a capital letter. */
+    readonly message: string;
+    readonly expected?: undefined;
+    readonly errorIsInOtherModule?: true;
+} | {
+    readonly token: Token;
+    /** Convention: starts with a lowercase letter. */
+    readonly expected: string;
+    readonly message?: undefined;
+    readonly errorIsInOtherModule?: undefined;
+};
+export interface ErrorSink {
+    push(error: SkirError): void;
+}
+/**
+ * Holds a value of type T and possible errors registered during the computation
+ * of the value.
+ */
+export interface Result<T> {
+    readonly result: T;
+    readonly errors: readonly SkirError[];
+}
+export type Primitive = "bool" | "int32" | "int64" | "uint64" | "float32" | "float64" | "timestamp" | "string" | "bytes";
+export interface PrimitiveType {
+    kind: "primitive";
+    primitive: Primitive;
+}
+/**
+ * A reference to a record, e.g. 'Foobar' or 'foo.Bar' or '.Foo.Bar'.
+ * One of the possible unresolved value types. The corresponding resolved value
+ * type is `ResolvedRecordRef`.
+ */
+export interface UnresolvedRecordRef {
+    readonly kind: "record";
+    /**
+     * The different pieces in the name, e.g. ['Foo', 'Bar'].
+     * Cannot be empty.
+     */
+    readonly nameParts: readonly Token[];
+    /**
+     * True if the reference starts with a dot, e.g. ".Foo.Bar".
+     * In this example, "Foo" is to be found at the top-level of the module.
+     */
+    readonly absolute: boolean;
+}
+/** Uniquely identifies a record within a module set. */
+export type RecordKey = string;
+export interface ResolvedRecordRef {
+    readonly kind: "record";
+    readonly key: RecordKey;
+    readonly recordType: "struct" | "enum";
+    readonly nameParts: ReadonlyArray<{
+        /**
+         * A single name in the type reference.
+         * Can refer to either a report or a module alias.
+         */
+        token: Token;
+        /**
+         * Either the definition of the record or the aliased import declaration.
+         */
+        declaration: Record | ImportAlias;
+    }>;
+    /**
+     * Last token in the type reference. For example, if the type reference is
+     * ".Foo.Bar", this is the token for "Bar".
+     */
+    readonly refToken: Token;
+}
+export interface MutableFieldPathItem {
+    /** The field name token in the field path. */
+    readonly name: Token;
+    /** The field declaration in the record definition. */
+    declaration?: Field;
+}
+/** A field or a sequence of field for keying items in an array. */
+export interface MutableFieldPath<Mutable extends boolean = true> {
+    /** The "|" token. */
+    readonly pipeToken: Token;
+    /**
+     * A non-empty sequence of field names.
+     * If the key type is an enum type, the last field name is guaranteed to be
+     * "kind".
+     */
+    readonly path: ReadonlyArray<Mutable extends true ? MutableFieldPathItem : Readonly<MutableFieldPathItem>>;
+    /** The type used to key every item: either a primitive or an enum. */
+    keyType: PrimitiveType | ResolvedRecordRef;
+}
+export type FieldPath<Mutable extends boolean = boolean> = Mutable extends true ? MutableFieldPath : Readonly<MutableFieldPath<false>>;
+export interface ArrayType<Type = ResolvedType, Mutable extends boolean = boolean> {
+    readonly kind: "array";
+    readonly item: Type;
+    /**
+     * If set, the value obtained by following the field path from an item can be
+     * used as a unique key for the item. The user takes responsibility for
+     * ensuring that not two items in the array have the same key.
+     * The item type must be a struct type.
+     */
+    readonly key: FieldPath<Mutable> | undefined;
+}
+export type UnresolvedArrayType = ArrayType<UnresolvedType>;
+export type MutableArrayType = ArrayType<ResolvedType, true>;
+export interface OptionalType<Type = ResolvedType> {
+    readonly kind: "optional";
+    readonly other: Type;
+}
+/**
+ * Result of parsing a type from a `.skir` file, without resolving the record
+ * references.
+ */
+export type UnresolvedType = PrimitiveType | UnresolvedRecordRef | UnresolvedArrayType | OptionalType<UnresolvedType>;
+/**
+ * Result of recursively resolving the record references in an unresolved type.
+ * When Mutable is true, the optional field path of an array type can be
+ * modified.
+ */
+export type ResolvedType<Mutable extends boolean = boolean> = PrimitiveType | ResolvedRecordRef | ArrayType<ResolvedType, Mutable> | OptionalType<ResolvedType<Mutable>>;
+export type MutableResolvedType = ResolvedType<true>;
+/** Field of a struct or enum. */
+export interface MutableField<Mutable extends boolean = true> {
+    readonly kind: "field";
+    readonly name: Token;
+    readonly number: number;
+    /** May only be undefined if the field is a constant in an enum. */
+    readonly unresolvedType: UnresolvedType | undefined;
+    /** May only be undefined if the field is a constant in an enum. */
+    type: ResolvedType<Mutable> | undefined;
+    /**
+     * Evaluates to true if the value type of the field depends on the record
+     * where the field is defined. If `Struct.DEFAULT.field` is or contains
+     * `Struct.DEFAULT`, then the dependency is "hard", otherwise it is "soft".
+     *
+     * Examples:
+     *   struct A { s: string; }  // false
+     *   struct B { b: B; }       // "hard"
+     *   struct C { c: C?; }      // "soft"
+     *   struct D { d: [D]; }     // "soft"
+     *   struct E { f: F; }       // "hard"
+     *   struct F { e: E; }       // "hard"
+     *   struct G { b: B; }       // false
+     *   struct H { i: I; }       // "soft"
+     *   enum I { h: H; }         // "soft"
+     */
+    isRecursive: false | "soft" | "hard";
+}
+/** Field of a struct or enum. */
+export type Field<Mutable extends boolean = boolean> = Mutable extends true ? MutableField : Readonly<MutableField<false>>;
+/** A 'removed' declaration in a struct or enum. */
+export interface Removed {
+    readonly kind: "removed";
+    /** The 'removed' keyword token. */
+    readonly removedToken: Token;
+    readonly numbers: readonly number[];
+}
+/** A declaration within a record. */
+export type RecordLevelDeclaration<Mutable extends boolean = boolean> = Field | Removed | Record<Mutable>;
+export type MutableRecordLevelDeclaration = RecordLevelDeclaration<true>;
+export type Numbering = "" | "implicit" | "explicit" | "broken";
+/** Definition of a struct or enum type. */
+export interface Record<Mutable extends boolean = boolean> {
+    readonly kind: "record";
+    /** Uniquely identifies the record within the module set. */
+    readonly key: RecordKey;
+    readonly name: Token;
+    readonly recordType: "struct" | "enum";
+    /** Maps a field or nested record name to the corresponding declaration. */
+    readonly nameToDeclaration: {
+        [n: string]: RecordLevelDeclaration<Mutable>;
+    };
+    readonly declarations: ReadonlyArray<RecordLevelDeclaration<Mutable>>;
+    readonly fields: ReadonlyArray<Field<Mutable>>;
+    readonly nestedRecords: ReadonlyArray<Record<Mutable>>;
+    readonly numbering: Numbering;
+    readonly removedNumbers: readonly number[];
+    /**
+     * A number which uniquely identifies this record, if specified.
+     * Syntax: `struct Foo(123) { ... }`
+     */
+    readonly recordNumber: number | null;
+    /**
+     * If the record is a struct, 1 + the maximum field number.
+     * Zero if the record is an enum.
+     */
+    readonly numSlots: number;
+    /**
+     * If the record is a struct, 1 + the maximum of all field numbers and removed
+     * numbers.
+     * Zero if the record is an enum.
+     */
+    readonly numSlotsInclRemovedNumbers: number;
+}
+export type MutableRecord = Record<true>;
+export interface MutableImport {
+    readonly kind: "import";
+    readonly importedNames: Token[];
+    /** The token corresponding to the quoted string. */
+    readonly modulePath: Token;
+    resolvedModulePath?: string;
+}
+export type Import<Mutable extends boolean = boolean> = Mutable extends true ? MutableImport : Readonly<MutableImport>;
+export interface MutableImportAlias {
+    readonly kind: "import-alias";
+    /** The alias. */
+    readonly name: Token;
+    /** The token corresponding to the quoted string. */
+    readonly modulePath: Token;
+    resolvedModulePath?: string;
+}
+export type ImportAlias<Mutable extends boolean = boolean> = Mutable extends true ? MutableImportAlias : Readonly<MutableImportAlias>;
+export interface MutableMethod<Mutable extends boolean = true> {
+    readonly kind: "method";
+    readonly name: Token;
+    readonly unresolvedRequestType: UnresolvedType;
+    readonly unresolvedResponseType: UnresolvedType;
+    requestType: ResolvedType<Mutable> | undefined;
+    responseType: ResolvedType<Mutable> | undefined;
+    readonly number: number;
+    readonly hasExplicitNumber: boolean;
+}
+export type Method<Mutable extends boolean = boolean> = Mutable extends true ? MutableMethod : Readonly<MutableMethod<false>>;
+/** A `const` declaration. */
+export interface MutableConstant<Mutable extends boolean = true> {
+    readonly kind: "constant";
+    readonly name: Token;
+    readonly unresolvedType: UnresolvedType;
+    type: ResolvedType<Mutable> | undefined;
+    readonly value: Value;
+    valueAsDenseJson: DenseJson | undefined;
+}
+export type Constant<Mutable extends boolean = boolean> = Mutable extends true ? MutableConstant : Readonly<MutableConstant<false>>;
+/** A name:value entry of an object. */
+export interface MutableObjectEntry<Mutable extends boolean = true> {
+    readonly name: Token;
+    readonly value: Value<Mutable>;
+}
+export type ObjectEntry<Mutable extends boolean = boolean> = Mutable extends true ? MutableObjectEntry : Readonly<MutableObjectEntry<false>>;
+/** An object value, for example `{r: 255, g: 0, b: 0}`. */
+export interface MutableObjectValue<Mutable extends boolean = true> {
+    readonly kind: "object";
+    readonly token: Token;
+    readonly entries: Readonly<{
+        [f: string]: ObjectEntry<Mutable>;
+    }>;
+    partial: boolean;
+    type?: RecordKey;
+}
+export type ObjectValue<Mutable extends boolean = boolean> = Mutable extends true ? MutableObjectValue : Readonly<MutableObjectValue<false>>;
+/** An array value, for example `[0, 1, 2]`. */
+export interface MutableArrayValue<Mutable extends boolean = true> {
+    readonly kind: "array";
+    readonly token: Token;
+    readonly items: ReadonlyArray<Value<Mutable>>;
+    key?: FieldPath | undefined;
+}
+export type ArrayValue<Mutable extends boolean = boolean> = Mutable extends true ? MutableArrayValue : Readonly<MutableArrayValue<false>>;
+/** One of: a quoted string, a number, `true`, `false`. */
+export interface MutableLiteralValue {
+    readonly kind: "literal";
+    readonly token: Token;
+    type?: PrimitiveType | {
+        kind: "enum";
+        key: RecordKey;
+    } | {
+        kind: "null";
+    };
+}
+export type LiteralValue<Mutable extends boolean = boolean> = Mutable extends true ? MutableLiteralValue : Readonly<MutableLiteralValue>;
+/** The value on the right side of the `=` symbol of a `const` declaration. */
+export type Value<Mutable extends boolean = boolean> = ObjectValue<Mutable> | ArrayValue<Mutable> | LiteralValue<Mutable>;
+export type MutableValue = Value<true>;
+/** Result of serializing a skir value to dense JSON format. */
+export type DenseJson = null | boolean | number | string | readonly DenseJson[];
+/** A declaration which can appear at the top-level of a module. */
+export type ModuleLevelDeclaration<Mutable extends boolean = boolean> = Record<Mutable> | Import<Mutable> | ImportAlias<Mutable> | Method<Mutable> | Constant<Mutable>;
+export type MutableModuleLevelDeclaration = ModuleLevelDeclaration<true>;
+export type Declaration<Mutable extends boolean = boolean> = RecordLevelDeclaration<Mutable> | ModuleLevelDeclaration<Mutable>;
+export type MutableDeclaration = Declaration<true>;
+/**
+ * Contains the definition of a record and information about where the record
+ * was defined.
+ */
+export interface RecordLocation<Mutable extends boolean = boolean> {
+    readonly kind: "record-location";
+    readonly record: Record<Mutable>;
+    /**
+     * Chain of records from the top-level record to `record` included.
+     * Every record is nested within the record preceding it in the chain.
+     */
+    readonly recordAncestors: readonly Record[];
+    readonly modulePath: string;
+}
+export type MutableRecordLocation = RecordLocation<true>;
+/** The set of names from one module imported to another module. */
+export type ImportedNames = {
+    kind: "all";
+    alias: string;
+} | {
+    kind: "some";
+    names: ReadonlySet<string>;
+};
+export interface Module<Mutable extends boolean = boolean> {
+    readonly kind: "module";
+    readonly path: string;
+    readonly sourceCode: string;
+    readonly nameToDeclaration: {
+        [n: string]: ModuleLevelDeclaration<Mutable>;
+    };
+    readonly declarations: ReadonlyArray<ModuleLevelDeclaration<Mutable>>;
+    /**
+     * Maps the path (to another module) to the corresponding import declarations in
+     * this module.
+     */
+    readonly pathToImportedNames: {
+        [path: string]: ImportedNames;
+    };
+    /**
+     * All the record declared in the module, at the top-level or not.
+     * Depth-first: "Foo.Bar" will appear before "Foo".
+     */
+    readonly records: Mutable extends true ? MutableRecordLocation[] : readonly RecordLocation[];
+    readonly methods: ReadonlyArray<Method<Mutable>>;
+    readonly constants: ReadonlyArray<Constant<Mutable>>;
+}
+/** Can be assigned to a `Module`. */
+export type MutableModule = Module<true>;
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAM7B;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,MAAM,GAAG,OAAO;IAC7C,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACvC,YAAY,CAAC,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,aAAa,CAAC,MAAM,CAAC;CACxE;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,UAAiB,KAAK,CAAC,MAAM;QAC3B,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;QACxC,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;QAC3D,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;KACzB;IAED,UAAiB,MAAM;QACrB,QAAQ,CAAC,KAAK,EAAE,SAAS,UAAU,EAAE,CAAC;KACvC;IAED,UAAiB,UAAU;QACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;KACvB;CACF;AAMD,4BAA4B;AAC5B,MAAM,WAAW,QAAQ;IACvB,kBAAkB;IAClB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;AAED,uBAAuB;AACvB,MAAM,WAAW,KAAK;IACpB,uDAAuD;IACvD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,qEAAqE;IACrE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,kBAAkB;IAClB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,MAAM,MAAM,GACd,YAAY,GACZ,kBAAkB,GAClB,YAAY,GACZ,kBAAkB,CAAC;AAMvB,gCAAgC;AAChC,MAAM,MAAM,SAAS,GACjB;IACE,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,gDAAgD;IAChD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,oBAAoB,CAAC,EAAE,IAAI,CAAC;CACtC,GACD;IACE,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,kDAAkD;IAClD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC;IAC7B,QAAQ,CAAC,oBAAoB,CAAC,EAAE,SAAS,CAAC;CAC3C,CAAC;AAEN,MAAM,WAAW,SAAS;IACxB,IAAI,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,MAAM,CAAC,CAAC;IACvB,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IACnB,QAAQ,CAAC,MAAM,EAAE,SAAS,SAAS,EAAE,CAAC;CACvC;AAMD,MAAM,MAAM,SAAS,GACjB,MAAM,GACN,OAAO,GACP,OAAO,GACP,QAAQ,GACR,SAAS,GACT,SAAS,GACT,WAAW,GACX,QAAQ,GACR,OAAO,CAAC;AAEZ,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,WAAW,CAAC;IAClB,SAAS,EAAE,SAAS,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IAExB;;;OAGG;IACH,QAAQ,CAAC,SAAS,EAAE,SAAS,KAAK,EAAE,CAAC;IAErC;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;CAC5B;AAED,wDAAwD;AACxD,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAE/B,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,QAAQ,CAAC,GAAG,EAAE,SAAS,CAAC;IACxB,QAAQ,CAAC,UAAU,EAAE,QAAQ,GAAG,MAAM,CAAC;IAEvC,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAC;QAChC;;;WAGG;QACH,KAAK,EAAE,KAAK,CAAC;QACb;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,WAAW,CAAC;KACnC,CAAC,CAAC;IAEH;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC;CAC1B;AAED,MAAM,WAAW,oBAAoB;IACnC,8CAA8C;IAC9C,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IACrB,sDAAsD;IACtD,WAAW,CAAC,EAAE,KAAK,CAAC;CACrB;AAED,mEAAmE;AACnE,MAAM,WAAW,gBAAgB,CAAC,OAAO,SAAS,OAAO,GAAG,IAAI;IAC9D,qBAAqB;IACrB,QAAQ,CAAC,SAAS,EAAE,KAAK,CAAC;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,aAAa,CAC1B,OAAO,SAAS,IAAI,GAAG,oBAAoB,GAAG,QAAQ,CAAC,oBAAoB,CAAC,CAC7E,CAAC;IACF,sEAAsE;IACtE,OAAO,EAAE,aAAa,GAAG,iBAAiB,CAAC;CAC5C;AAED,MAAM,MAAM,SAAS,CAAC,OAAO,SAAS,OAAO,GAAG,OAAO,IACrD,OAAO,SAAS,IAAI,GAChB,gBAAgB,GAChB,QAAQ,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC;AAExC,MAAM,WAAW,SAAS,CACxB,IAAI,GAAG,YAAY,EACnB,OAAO,SAAS,OAAO,GAAG,OAAO;IAEjC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB;;;;;OAKG;IACH,QAAQ,CAAC,GAAG,EAAE,SAAS,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;CAC9C;AAED,MAAM,MAAM,mBAAmB,GAAG,SAAS,CAAC,cAAc,CAAC,CAAC;AAC5D,MAAM,MAAM,gBAAgB,GAAG,SAAS,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;AAE7D,MAAM,WAAW,YAAY,CAAC,IAAI,GAAG,YAAY;IAC/C,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GACtB,aAAa,GACb,mBAAmB,GACnB,mBAAmB,GACnB,YAAY,CAAC,cAAc,CAAC,CAAC;AAEjC;;;;GAIG;AACH,MAAM,MAAM,YAAY,CAAC,OAAO,SAAS,OAAO,GAAG,OAAO,IACtD,aAAa,GACb,iBAAiB,GACjB,SAAS,CAAC,YAAY,EAAE,OAAO,CAAC,GAChC,YAAY,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;AAExC,MAAM,MAAM,mBAAmB,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;AAErD,iCAAiC;AACjC,MAAM,WAAW,YAAY,CAAC,OAAO,SAAS,OAAO,GAAG,IAAI;IAC1D,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IACrB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,mEAAmE;IACnE,QAAQ,CAAC,cAAc,EAAE,cAAc,GAAG,SAAS,CAAC;IACpD,mEAAmE;IACnE,IAAI,EAAE,YAAY,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;IACxC;;;;;;;;;;;;;;;OAeG;IACH,WAAW,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;CACtC;AAED,iCAAiC;AACjC,MAAM,MAAM,KAAK,CAAC,OAAO,SAAS,OAAO,GAAG,OAAO,IACjD,OAAO,SAAS,IAAI,GAAG,YAAY,GAAG,QAAQ,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;AAEtE,mDAAmD;AACnD,MAAM,WAAW,OAAO;IACtB,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,mCAAmC;IACnC,QAAQ,CAAC,YAAY,EAAE,KAAK,CAAC;IAC7B,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;CACrC;AAED,qCAAqC;AACrC,MAAM,MAAM,sBAAsB,CAAC,OAAO,SAAS,OAAO,GAAG,OAAO,IAChE,KAAK,GACL,OAAO,GACP,MAAM,CAAC,OAAO,CAAC,CAAC;AAEpB,MAAM,MAAM,6BAA6B,GAAG,sBAAsB,CAAC,IAAI,CAAC,CAAC;AAEzE,MAAM,MAAM,SAAS,GAEjB,EAAE,GAEF,UAAU,GAEV,UAAU,GAEV,QAAQ,CAAC;AAEb,2CAA2C;AAC3C,MAAM,WAAW,MAAM,CAAC,OAAO,SAAS,OAAO,GAAG,OAAO;IACvD,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,4DAA4D;IAC5D,QAAQ,CAAC,GAAG,EAAE,SAAS,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IACrB,QAAQ,CAAC,UAAU,EAAE,QAAQ,GAAG,MAAM,CAAC;IACvC,2EAA2E;IAC3E,QAAQ,CAAC,iBAAiB,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC,OAAO,CAAC,CAAA;KAAE,CAAC;IAC7E,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC,CAAC;IACtE,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;IAC/C,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;IACvD,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,cAAc,EAAE,SAAS,MAAM,EAAE,CAAC;IAC3C;;;OAGG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,0BAA0B,EAAE,MAAM,CAAC;CAC7C;AAED,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;AAEzC,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,QAAQ,CAAC,aAAa,EAAE,KAAK,EAAE,CAAC;IAChC,oDAAoD;IACpD,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC;IAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,MAAM,MAAM,CAAC,OAAO,SAAS,OAAO,GAAG,OAAO,IAAI,OAAO,SAAS,IAAI,GACxE,aAAa,GACb,QAAQ,CAAC,aAAa,CAAC,CAAC;AAE5B,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC;IAC9B,iBAAiB;IACjB,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IACrB,oDAAoD;IACpD,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC;IAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,MAAM,WAAW,CAAC,OAAO,SAAS,OAAO,GAAG,OAAO,IACvD,OAAO,SAAS,IAAI,GAAG,kBAAkB,GAAG,QAAQ,CAAC,kBAAkB,CAAC,CAAC;AAE3E,MAAM,WAAW,aAAa,CAAC,OAAO,SAAS,OAAO,GAAG,IAAI;IAC3D,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IACrB,QAAQ,CAAC,qBAAqB,EAAE,cAAc,CAAC;IAC/C,QAAQ,CAAC,sBAAsB,EAAE,cAAc,CAAC;IAChD,WAAW,EAAE,YAAY,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;IAC/C,YAAY,EAAE,YAAY,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;IAGhD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAC;CACrC;AAED,MAAM,MAAM,MAAM,CAAC,OAAO,SAAS,OAAO,GAAG,OAAO,IAClD,OAAO,SAAS,IAAI,GAAG,aAAa,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;AAExE,6BAA6B;AAC7B,MAAM,WAAW,eAAe,CAAC,OAAO,SAAS,OAAO,GAAG,IAAI;IAC7D,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IACrB,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;IACxC,IAAI,EAAE,YAAY,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;IACxC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,gBAAgB,EAAE,SAAS,GAAG,SAAS,CAAC;CACzC;AAED,MAAM,MAAM,QAAQ,CAAC,OAAO,SAAS,OAAO,GAAG,OAAO,IACpD,OAAO,SAAS,IAAI,GAChB,eAAe,GACf,QAAQ,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC;AAEvC,uCAAuC;AACvC,MAAM,WAAW,kBAAkB,CAAC,OAAO,SAAS,OAAO,GAAG,IAAI;IAChE,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;CAChC;AAED,MAAM,MAAM,WAAW,CAAC,OAAO,SAAS,OAAO,GAAG,OAAO,IACvD,OAAO,SAAS,IAAI,GAChB,kBAAkB,GAClB,QAAQ,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;AAE1C,2DAA2D;AAC3D,MAAM,WAAW,kBAAkB,CAAC,OAAO,SAAS,OAAO,GAAG,IAAI;IAChE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,OAAO,CAAC,CAAA;KAAE,CAAC,CAAC;IAClE,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB;AAED,MAAM,MAAM,WAAW,CAAC,OAAO,SAAS,OAAO,GAAG,OAAO,IACvD,OAAO,SAAS,IAAI,GAChB,kBAAkB,GAClB,QAAQ,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;AAE1C,+CAA+C;AAC/C,MAAM,WAAW,iBAAiB,CAAC,OAAO,SAAS,OAAO,GAAG,IAAI;IAC/D,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;IAC9C,GAAG,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;CAC7B;AAED,MAAM,MAAM,UAAU,CAAC,OAAO,SAAS,OAAO,GAAG,OAAO,IACtD,OAAO,SAAS,IAAI,GAChB,iBAAiB,GACjB,QAAQ,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC;AAEzC,0DAA0D;AAC1D,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,IAAI,CAAC,EAAE,aAAa,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,SAAS,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;CAC5E;AAED,MAAM,MAAM,YAAY,CAAC,OAAO,SAAS,OAAO,GAAG,OAAO,IACxD,OAAO,SAAS,IAAI,GAChB,mBAAmB,GACnB,QAAQ,CAAC,mBAAmB,CAAC,CAAC;AAEpC,8EAA8E;AAC9E,MAAM,MAAM,KAAK,CAAC,OAAO,SAAS,OAAO,GAAG,OAAO,IAC/C,WAAW,CAAC,OAAO,CAAC,GACpB,UAAU,CAAC,OAAO,CAAC,GACnB,YAAY,CAAC,OAAO,CAAC,CAAC;AAE1B,MAAM,MAAM,YAAY,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;AAEvC,+DAA+D;AAC/D,MAAM,MAAM,SAAS,GAAG,IAAI,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,SAAS,EAAE,CAAC;AAEhF,mEAAmE;AACnE,MAAM,MAAM,sBAAsB,CAAC,OAAO,SAAS,OAAO,GAAG,OAAO,IAChE,MAAM,CAAC,OAAO,CAAC,GACf,MAAM,CAAC,OAAO,CAAC,GACf,WAAW,CAAC,OAAO,CAAC,GACpB,MAAM,CAAC,OAAO,CAAC,GACf,QAAQ,CAAC,OAAO,CAAC,CAAC;AAEtB,MAAM,MAAM,6BAA6B,GAAG,sBAAsB,CAAC,IAAI,CAAC,CAAC;AAEzE,MAAM,MAAM,WAAW,CAAC,OAAO,SAAS,OAAO,GAAG,OAAO,IACrD,sBAAsB,CAAC,OAAO,CAAC,GAC/B,sBAAsB,CAAC,OAAO,CAAC,CAAC;AAEpC,MAAM,MAAM,kBAAkB,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;AAEnD;;;GAGG;AACH,MAAM,WAAW,cAAc,CAAC,OAAO,SAAS,OAAO,GAAG,OAAO;IAC/D,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC;IACjC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;IACjC;;;OAGG;IACH,QAAQ,CAAC,eAAe,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5C,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,MAAM,qBAAqB,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;AAEzD,mEAAmE;AACnE,MAAM,MAAM,aAAa,GACrB;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAC9B;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CAAE,CAAC;AAEjD,MAAM,WAAW,MAAM,CAAC,OAAO,SAAS,OAAO,GAAG,OAAO;IACvD,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAE5B,QAAQ,CAAC,iBAAiB,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC,OAAO,CAAC,CAAA;KAAE,CAAC;IAC7E,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC,CAAC;IAEtE;;;OAGG;IACH,QAAQ,CAAC,mBAAmB,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,CAAA;KAAE,CAAC;IAEhE;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,SAAS,IAAI,GAClC,qBAAqB,EAAE,GACvB,SAAS,cAAc,EAAE,CAAC;IAE9B,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;IAEjD,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;CACtD;AAED,qCAAqC;AACrC,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

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

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "skir",
+  "version": "0.0.1",
+  "description": "",
+  "homepage": "https://github.com/gepheum/skir#readme",
+  "bugs": {
+    "url": "https://github.com/gepheum/skir/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/gepheum/skir.git"
+  },
+  "license": "ISC",
+  "author": "Tyler Fibonacci <gepheum@gmail.com>",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    },
+    "./dist/*": {
+      "import": "./dist/*",
+      "require": "./dist/*"
+    }
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "bin": "./dist/compiler.js",
+  "files": [
+    "dist",
+    "src",
+    "!**/*.test.ts"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "format:check": "prettier --check \"src/**/*.ts\"",
+    "skir": "npm run build && node ./dist/compiler.js",
+    "test": "mocha",
+    "lint": "eslint src/**/*.ts",
+    "lint:fix": "eslint src/**/*.ts --fix"
+  },
+  "dependencies": {
+    "glob": "^11.0.1",
+    "watcher": "^2.3.1",
+    "yaml": "^2.7.1",
+    "zod": "^3.24.3",
+    "zod-validation-error": "^3.4.0"
+  },
+  "devDependencies": {
+    "@types/mocha": "^10.0.1",
+    "@types/node": "^20.6.0",
+    "@typescript-eslint/eslint-plugin": "^6.13.0",
+    "@typescript-eslint/parser": "^6.13.0",
+    "eslint": "^8.54.0",
+    "prettier-plugin-organize-imports": "^4.2.0",
+    "buckwheat": "^1.1.2",
+    "mocha": "^10.2.0",
+    "prettier": "^3.2.4",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.2.2"
+  }
+}

package/src/casing.ts

@@ -0,0 +1,64 @@
+import type { Casing, ErrorSink, Token } from "./types.js";
+
+/** Registers an error if the given token does not match the expected casing. */
+export function validate(
+  name: Token,
+  expected: "lower_underscore" | "UpperCamel" | "UPPER_UNDERSCORE",
+  errors: ErrorSink,
+): void {
+  if (!caseMatches(name.text, expected)) {
+    errors.push({
+      token: name,
+      expected: expected,
+    });
+  }
+}
+
+export function convertCase(
+  text: string,
+  source: Casing,
+  target: Casing,
+): string {
+  let words: string[];
+  switch (source) {
+    case "lowerCamel":
+    case "UpperCamel":
+      words = text.split(/(?=[A-Z])/).map((w) => w.toLowerCase());
+      break;
+    case "lower_underscore":
+      words = text.split("_");
+      break;
+    case "UPPER_UNDERSCORE":
+      words = text.split("_").map((w) => w.toLowerCase());
+      break;
+  }
+  switch (target) {
+    case "lowerCamel":
+      return words.map((w, i) => (i ? capitalize(w) : w)).join("");
+    case "lower_underscore":
+      return words.join("_");
+    case "UpperCamel":
+      return words.map(capitalize).join("");
+    case "UPPER_UNDERSCORE":
+      return words.map((w) => w.toUpperCase()).join("_");
+  }
+}
+
+/** Returns a new string with the first letter of `name` capitalized. */
+export function capitalize(name: string): string {
+  return name[0]!.toUpperCase() + name.slice(1);
+}
+
+export function caseMatches(
+  name: string,
+  expected: "lower_underscore" | "UpperCamel" | "UPPER_UNDERSCORE",
+): boolean {
+  switch (expected) {
+    case "lower_underscore":
+      return /^[a-z][0-9a-z]*(_[a-z][0-9a-z]*)*$/.test(name);
+    case "UpperCamel":
+      return /^[A-Z][0-9A-Za-z]*$/.test(name);
+    case "UPPER_UNDERSCORE":
+      return /^[A-Z][0-9A-Z]*(_[A-Z][0-9A-Z]*)*$/.test(name);
+  }
+}