Normalize Skillgym casing across docs and APIs (#41)

Author: V3RON

DICTIONARY.md

@@ -1,4 +1,4 @@
-# SkillGym Dictionary
+# Skillgym Dictionary
 
 This is the domain dictionary for `skillgym`.
 
@@ -8,7 +8,7 @@ Before adding or changing a term, check this file and ask the user for approval.
 
 ## Terms
 
-- `SkillGym`: The product, package, CLI, and repository.
+- `Skillgym`: The product, package, CLI, and repository.
 - `suite file`: Module file that exports one suite.
 - `suite`: User-authored collection of cases and optional workspace config.
 - `case`: One definition with a prompt, assertions, and optional metadata.
@@ -26,7 +26,7 @@ Before adding or changing a term, check this file and ask the user for approval.
 - `failure classification`: Stable category assigned to a failure.
 - `failure class`: The value representing a failure classification.
 - `result`: Pass/fail outcome object; not a session report.
-- `artifact`: Preserved file or directory written by SkillGym.
+- `artifact`: Preserved file or directory written by Skillgym.
 - `artifact directory`: Directory holding artifacts for one scope such as a suite run, execution, repetition, retry, or session.
 - `workspace`: Directory where the agent runs.
 - `no workspace`: Run directly in an existing working directory with no provisioning.

README.md

@@ -31,7 +31,7 @@ bun add --dev skillgym
 Create `skillgym.config.ts` in your project root, or in a parent directory that the suite can discover upward:
 
 ```ts
-import type { SkillGymConfig } from "skillgym";
+import type { SkillgymConfig } from "skillgym";
 
 const config = {
   run: {
@@ -67,7 +67,7 @@ const config = {
       },
     },
   },
-} satisfies SkillGymConfig;
+} satisfies SkillgymConfig;
 
 export default config;
 ```
@@ -179,13 +179,13 @@ The execution unit is one case x runner pair. `skillgym` expands the suite into
 
 `serial` is the default. `parallel` maximizes overlap across the full matrix up to the configured cap. `isolated-by-runner` is a middle ground when you want each runner to stay ordered internally but still allow different runners to overlap.
 
-For concurrent schedules, `run.maxParallel` defaults to `os.availableParallelism()`. This limits how many SkillGym executions are active at once; it does not pin or limit CPU cores used by an individual agent process.
+For concurrent schedules, `run.maxParallel` defaults to `os.availableParallelism()`. This limits how many Skillgym executions are active at once; it does not pin or limit CPU cores used by an individual agent process.
 
 Concurrent schedules do not copy or isolate the workspace by themselves. Overlapping executions may still interact through the same filesystem state and live runner output unless you use isolated workspaces. OpenCode, Codex, and Claude Code runtime state are isolated per execution under each artifact directory.
 
 `run.repeat` is useful when you want stability sampling instead of a single lucky pass. Each case x runner execution keeps running until it records the requested number of successful classified results, or stops early when one repetition still fails after exhausting `run.repeatFailure` retries.
 
-`run.repeatFailure` retries only the current repetition when it still counts as failed after result classification. SkillGym keeps all repetition and retry artifacts, averages visible duration and token metrics across the final results of completed successful repetitions, and preserves the full nested detail in `results.json`.
+`run.repeatFailure` retries only the current repetition when it still counts as failed after result classification. Skillgym keeps all repetition and retry artifacts, averages visible duration and token metrics across the final results of completed successful repetitions, and preserves the full nested detail in `results.json`.
 
 Artifacts for repeated executions are grouped under the stable case x runner directory using `repeat-N` directories, with retry sessions nested as `session-N` inside the repetition that needed recovery.
 

docs/assertions.md

@@ -48,7 +48,7 @@ Rules:
 
 ## Soft assertions
 
-`assert.soft` mirrors the sync assertion methods on the root `assert` export and the grouped SkillGym helpers.
+`assert.soft` mirrors the sync assertion methods on the root `assert` export and the grouped Skillgym helpers.
 
 - soft failures are collected in execution order
 - the runner throws a single `AssertionError` after `case_.assert(report, ctx)` completes

docs/workspaces.md

@@ -8,7 +8,7 @@
 - `shared`: create one workspace per suite run and reuse it across executions
 - `isolated`: create a fresh workspace per case x runner execution
 
-Use `none` when the agent should run in an existing directory. Use `shared` or `isolated` when the suite needs SkillGym to provision a workspace first.
+Use `none` when the agent should run in an existing directory. Use `shared` or `isolated` when the suite needs Skillgym to provision a workspace first.
 
 ## Suite-level workspace config
 
@@ -61,7 +61,7 @@ Behavior:
 - if omitted, none mode falls back to config `run.cwd`, then `process.cwd()`
 - `templateDir` and `bootstrap` are not allowed
 
-If a suite file does not export `workspace`, SkillGym falls back to config `run.workspace`, then to implicit `none` mode.
+If a suite file does not export `workspace`, Skillgym falls back to config `run.workspace`, then to implicit `none` mode.
 
 ## Shared mode
 

skillgym.config.js skillgym.config.tsskillgym.config.js renamed to skillgym.config.ts

@@ -1,3 +1,5 @@
+import { SkillgymConfig } from "./src/index";
+
 const config = {
   run: {
     cwd: ".",
@@ -34,6 +36,6 @@ const config = {
       },
     },
   },
-};
+} satisfies SkillgymConfig;
 
 export default config;

src/assertions/assert.ts

@@ -6,9 +6,9 @@ import { outputAssertions } from "./output.js";
 import { skillAssertions } from "./skills.js";
 import { softAssert } from "./soft.js";
 import { toolCallAssertions } from "./tool-calls.js";
-import type { SkillGymAssert } from "./types.js";
+import type { SkillgymAssert } from "./types.js";
 
-export const assert: SkillGymAssert = Object.assign(nodeAssert, {
+export const assert: SkillgymAssert = Object.assign(nodeAssert, {
   classify<T>(failureClass: FailureClassInput, callback: () => T): T {
     try {
       return callback();

src/assertions/index.ts

@@ -13,8 +13,8 @@ export type {
   OutputAssertions,
   SkillAssertionOptions,
   SkillAssertions,
-  SkillGymAssert,
-  SkillGymSoftAssert,
+  SkillgymAssert,
+  SkillgymSoftAssert,
   SkillConfidence,
   StructuredCommandMatcher,
   ToolCallAssertions,

src/assertions/soft.ts

@@ -12,7 +12,7 @@ import type {
   FileReadAssertions,
   OutputAssertions,
   SkillAssertions,
-  SkillGymSoftAssert,
+  SkillgymSoftAssert,
   ToolCallAssertions,
 } from "./types.js";
 
@@ -45,7 +45,7 @@ const softAssertionGroups = {
   output: OutputAssertions;
 };
 
-export const softAssert: SkillGymSoftAssert = Object.assign(
+export const softAssert: SkillgymSoftAssert = Object.assign(
   createSoftNodeAssert(),
   softAssertionGroups,
 );

src/assertions/types.ts

@@ -162,16 +162,16 @@ export interface AssertionClassifier {
   <T>(failureClass: string | FailureClass, callback: () => T): T;
 }
 
-export type SkillGymSoftAssert = typeof nodeAssert & {
+export type SkillgymSoftAssert = typeof nodeAssert & {
   skills: SkillAssertions;
   commands: CommandAssertions;
   fileReads: FileReadAssertions;
   toolCalls: ToolCallAssertions;
   output: OutputAssertions;
 };
 
-export type SkillGymAssert = typeof nodeAssert & {
-  soft: SkillGymSoftAssert;
+export type SkillgymAssert = typeof nodeAssert & {
+  soft: SkillgymSoftAssert;
   skills: SkillAssertions;
   commands: CommandAssertions;
   fileReads: FileReadAssertions;

src/config.ts

@@ -58,7 +58,7 @@ export interface SnapshotConfig {
   tolerance: SnapshotToleranceConfig;
 }
 
-export interface SkillGymConfig {
+export interface SkillgymConfig {
   run?: {
     cwd?: string;
     outputDir?: string;
@@ -79,15 +79,15 @@ export interface SkillGymConfig {
   snapshots?: SnapshotConfig;
 }
 
-export interface LoadedSkillGymConfig {
+export interface LoadedSkillgymConfig {
   filePath?: string;
-  config: SkillGymConfig;
+  config: SkillgymConfig;
 }
 
 export async function loadConfig(options: {
   suitePath: string;
   configPath?: string;
-}): Promise<LoadedSkillGymConfig> {
+}): Promise<LoadedSkillgymConfig> {
   const filePath =
     options.configPath !== undefined
       ? path.resolve(options.configPath)
@@ -109,7 +109,7 @@ export async function loadConfig(options: {
   };
 }
 
-export function parseConfig(raw: unknown): SkillGymConfig {
+export function parseConfig(raw: unknown): SkillgymConfig {
   const record = parseObject(raw, undefined);
   ensureKnownKeys(record, TOP_LEVEL_KEYS, undefined);
 
@@ -132,7 +132,7 @@ export function resolveRunOptions(
     retryFailed?: string;
     tags?: string[];
   },
-  config: SkillGymConfig,
+  config: SkillgymConfig,
 ): {
   cwd: string;
   outputDir?: string;
@@ -184,7 +184,7 @@ export function resolveReporterOptions(
     reporter?: string;
     cwd?: string;
   },
-  loadedConfig: LoadedSkillGymConfig,
+  loadedConfig: LoadedSkillgymConfig,
 ): {
   reporter?: string;
   cwd: string;
@@ -204,7 +204,7 @@ export function resolveReporterOptions(
 
 export function getCaseExecutionOptions(
   case_: { timeoutMs?: number },
-  config: SkillGymConfig,
+  config: SkillgymConfig,
 ): {
   timeoutMs: number;
 } {
@@ -257,7 +257,7 @@ function readConfigModule(imported: unknown): unknown {
   return imported;
 }
 
-function resolveConfigPaths(config: SkillGymConfig, configDir: string): SkillGymConfig {
+function resolveConfigPaths(config: SkillgymConfig, configDir: string): SkillgymConfig {
   return {
     run:
       config.run === undefined
@@ -368,7 +368,7 @@ function looksPathLike(value: string): boolean {
   );
 }
 
-function parseRunConfig(value: unknown, configPath: string): SkillGymConfig["run"] | undefined {
+function parseRunConfig(value: unknown, configPath: string): SkillgymConfig["run"] | undefined {
   if (value === undefined) {
     return undefined;
   }
@@ -519,7 +519,7 @@ function parseScheduleMode(value: unknown, configPath: string): ScheduleMode {
 function parseDefaultsConfig(
   value: unknown,
   configPath: string,
-): SkillGymConfig["defaults"] | undefined {
+): SkillgymConfig["defaults"] | undefined {
   if (value === undefined) {
     return undefined;
   }
@@ -537,7 +537,7 @@ function parseDefaultsConfig(
 function parseSnapshotConfig(
   value: unknown,
   configPath: string,
-): SkillGymConfig["snapshots"] | undefined {
+): SkillgymConfig["snapshots"] | undefined {
   if (value === undefined) {
     return undefined;
   }
@@ -554,7 +554,7 @@ function parseSnapshotConfig(
   };
 }
 
-function parseRunnersConfig(value: unknown, configPath: string): SkillGymConfig["runners"] {
+function parseRunnersConfig(value: unknown, configPath: string): SkillgymConfig["runners"] {
   const record = parseObject(value, configPath);
 
   if (Object.keys(record).length === 0) {