feat(nx-plugin): rename artefact to artifacts

Author: AS

packages/models/docs/models-reference.md

@@ -1,5 +1,16 @@
 # Code PushUp models reference
 
+## ArtifactGenerationCommand
+
+_Object containing the following properties:_
+
+| Property           | Description                                                | Type                       |
+| :----------------- | :--------------------------------------------------------- | :------------------------- |
+| **`command`** (\*) | Generate artifact files                                    | `string` (_min length: 1_) |
+| `args`             | Arguments to be passed to the artifact generation command. | `Array<string>`            |
+
+_(\*) Required._
+
 ## AuditDetails
 
 Detailed information
@@ -1227,14 +1238,14 @@ _Object containing the following properties:_
 
 _All properties are optional._
 
-## PluginArtefactOptions
+## PluginArtifactOptions
 
 _Object containing the following properties:_
 
-| Property                  | Type                        |
-| :------------------------ | :-------------------------- |
-| `generateArtefacts`       | [ToolCommand](#toolcommand) |
-| **`artefactsPaths`** (\*) | `string \| Array<string>`   |
+| Property                  | Type                                                    |
+| :------------------------ | :------------------------------------------------------ |
+| `generateArtifacts`       | [ArtifactGenerationCommand](#artifactgenerationcommand) |
+| **`artifactsPaths`** (\*) | `string` _or_ `Array<string>` (_min: 1_)                |
 
 _(\*) Required._
 
@@ -1442,17 +1453,6 @@ Primitive row
 
 _Array of [TableCellValue](#tablecellvalue) (\_optional & nullable_) items.\_
 
-## ToolCommand
-
-_Object containing the following properties:_
-
-| Property           | Description                         | Type                       |
-| :----------------- | :---------------------------------- | :------------------------- |
-| **`command`** (\*) | Command to run the tool.            | `string` (_min length: 1_) |
-| `args`             | Arguments to be passed to the tool. | `Array<string>`            |
-
-_(\*) Required._
-
 ## Tree
 
 _Union of the following possible types:_

packages/models/src/index.ts

@@ -134,5 +134,5 @@ export {
 export { uploadConfigSchema, type UploadConfig } from './lib/upload-config.js';
 export {
   artifactGenerationCommand,
-  pluginArtefactOptionsSchema,
+  pluginArtifactOptionsSchema,
 } from './lib/configuration.js';

packages/models/src/lib/configuration.ts

@@ -4,21 +4,21 @@ import { z } from 'zod';
  * Generic schema for a tool command configuration, reusable across plugins.
  */
 export const artifactGenerationCommand = z.object({
-  command: z.string({ description: 'Generate artefact files' }).min(1),
+  command: z.string({ description: 'Generate artifact files' }).min(1),
   args: z
     .array(z.string(), {
-      description: 'Arguments to be passed to the artefact generation command.',
+      description: 'Arguments to be passed to the artifact generation command.',
     })
     .optional(),
 });
 
-export type ArtefactGenerationCommand = z.infer<
+export type ArtifactGenerationCommand = z.infer<
   typeof artifactGenerationCommand
 >;
 
-export const pluginArtefactOptionsSchema = z.object({
-  generateArtefacts: artifactGenerationCommand.optional(),
-  artefactsPaths: z.union([z.string(), z.array(z.string()).min(1)]),
+export const pluginArtifactOptionsSchema = z.object({
+  generateArtifacts: artifactGenerationCommand.optional(),
+  artifactsPaths: z.union([z.string(), z.array(z.string()).min(1)]),
 });
 
-export type PluginArtefactOptions = z.infer<typeof pluginArtefactOptionsSchema>;
+export type PluginArtifactOptions = z.infer<typeof pluginArtifactOptionsSchema>;

packages/models/src/lib/configuration.unit.test.ts

@@ -1,7 +1,7 @@
 import { describe, expect, it } from 'vitest';
 import {
   artifactGenerationCommand,
-  pluginArtefactOptionsSchema,
+  pluginArtifactOptionsSchema,
 } from './configuration.js';
 
 describe('artifactGenerationCommand', () => {
@@ -37,61 +37,61 @@ describe('artifactGenerationCommand', () => {
   });
 });
 
-describe('pluginArtefactOptionsSchema', () => {
-  it('should validate with only artefactsPaths as string', () => {
-    const data = { artefactsPaths: 'dist/report.json' };
-    expect(pluginArtefactOptionsSchema.safeParse(data)).toStrictEqual({
+describe('pluginArtifactOptionsSchema', () => {
+  it('should validate with only artifactsPaths as string', () => {
+    const data = { artifactsPaths: 'dist/report.json' };
+    expect(pluginArtifactOptionsSchema.safeParse(data)).toStrictEqual({
       success: true,
       data: {
-        artefactsPaths: 'dist/report.json',
+        artifactsPaths: 'dist/report.json',
       },
     });
   });
 
-  it('should validate with artefactsPaths as array of strings', () => {
-    const data = { artefactsPaths: ['dist/report.json', 'dist/summary.json'] };
-    expect(pluginArtefactOptionsSchema.safeParse(data)).toStrictEqual({
+  it('should validate with artifactsPaths as array of strings', () => {
+    const data = { artifactsPaths: ['dist/report.json', 'dist/summary.json'] };
+    expect(pluginArtifactOptionsSchema.safeParse(data)).toStrictEqual({
       success: true,
       data: {
-        artefactsPaths: ['dist/report.json', 'dist/summary.json'],
+        artifactsPaths: ['dist/report.json', 'dist/summary.json'],
       },
     });
   });
 
-  it('should fail if artefactsPaths is an empty array', () => {
-    const data = { artefactsPaths: [] };
-    expect(pluginArtefactOptionsSchema.safeParse(data).success).toBe(false);
+  it('should fail if artifactsPaths is an empty array', () => {
+    const data = { artifactsPaths: [] };
+    expect(pluginArtifactOptionsSchema.safeParse(data).success).toBe(false);
   });
 
-  it('should validate with generateArtefacts and artefactsPaths', () => {
+  it('should validate with generateArtifacts and artifactsPaths', () => {
     const data = {
-      generateArtefacts: { command: 'npm', args: ['run', 'build'] },
-      artefactsPaths: ['dist/report.json'],
+      generateArtifacts: { command: 'npm', args: ['run', 'build'] },
+      artifactsPaths: ['dist/report.json'],
     };
-    expect(pluginArtefactOptionsSchema.safeParse(data)).toStrictEqual({
+    expect(pluginArtifactOptionsSchema.safeParse(data)).toStrictEqual({
       success: true,
       data: {
-        generateArtefacts: { command: 'npm', args: ['run', 'build'] },
-        artefactsPaths: ['dist/report.json'],
+        generateArtifacts: { command: 'npm', args: ['run', 'build'] },
+        artifactsPaths: ['dist/report.json'],
       },
     });
   });
 
-  it('should fail if artefactsPaths is missing', () => {
-    const data = { generateArtefacts: { command: 'npm' } };
-    expect(pluginArtefactOptionsSchema.safeParse(data).success).toBe(false);
+  it('should fail if artifactsPaths is missing', () => {
+    const data = { generateArtifacts: { command: 'npm' } };
+    expect(pluginArtifactOptionsSchema.safeParse(data).success).toBe(false);
   });
 
-  it('should fail if artefactsPaths is not string or array of strings', () => {
-    const data = { artefactsPaths: 123 };
-    expect(pluginArtefactOptionsSchema.safeParse(data).success).toBe(false);
+  it('should fail if artifactsPaths is not string or array of strings', () => {
+    const data = { artifactsPaths: 123 };
+    expect(pluginArtifactOptionsSchema.safeParse(data).success).toBe(false);
   });
 
-  it('should fail if generateArtefacts is invalid', () => {
+  it('should fail if generateArtifacts is invalid', () => {
     const data = {
-      generateArtefacts: { command: '' },
-      artefactsPaths: 'dist/report.json',
+      generateArtifacts: { command: '' },
+      artifactsPaths: 'dist/report.json',
     };
-    expect(pluginArtefactOptionsSchema.safeParse(data).success).toBe(false);
+    expect(pluginArtifactOptionsSchema.safeParse(data).success).toBe(false);
   });
 });