fix(create-cli): update ci provider options and their validation

Author: hanna-skryl

packages/create-cli/src/index.ts

@@ -43,7 +43,7 @@ const argv = await yargs(hideBin(process.argv))
   .option('ci', {
     type: 'string',
     choices: CI_PROVIDERS,
-    describe: 'CI/CD integration (github, gitlab, or skip)',
+    describe: 'CI/CD integration (github, gitlab, or none)',
   })
   .check(parsed => {
     validatePluginSlugs(bindings, parsed.plugins);

packages/create-cli/src/lib/setup/ci.ts

@@ -1,6 +1,12 @@
 import { select } from '@inquirer/prompts';
 import { logger } from '@code-pushup/utils';
-import type { CiProvider, CliArgs, ConfigContext, Tree } from './types.js';
+import {
+  CI_PROVIDERS,
+  type CiProvider,
+  type CliArgs,
+  type ConfigContext,
+  type Tree,
+} from './types.js';
 
 const GITHUB_WORKFLOW_PATH = '.github/workflows/code-pushup.yml';
 const GITLAB_CONFIG_PATH = '.gitlab-ci.yml';
@@ -11,16 +17,16 @@ export async function promptCiProvider(cliArgs: CliArgs): Promise<CiProvider> {
     return cliArgs.ci;
   }
   if (cliArgs.yes) {
-    return 'skip';
+    return 'none';
   }
   return select<CiProvider>({
     message: 'CI/CD integration:',
     choices: [
       { name: 'GitHub Actions', value: 'github' },
       { name: 'GitLab CI/CD', value: 'gitlab' },
-      { name: 'Skip', value: 'skip' },
+      { name: 'none', value: 'none' },
     ],
-    default: 'skip',
+    default: 'none',
   });
 }
 
@@ -36,7 +42,7 @@ export async function resolveCi(
     case 'gitlab':
       await writeGitLabConfig(tree);
       break;
-    case 'skip':
+    case 'none':
       break;
   }
 }
@@ -118,5 +124,6 @@ async function resolveGitLabFilePath(tree: Tree): Promise<string> {
 }
 
 function isCiProvider(value: string | undefined): value is CiProvider {
-  return value === 'github' || value === 'gitlab' || value === 'skip';
+  const validValues: readonly string[] = CI_PROVIDERS;
+  return value != null && validValues.includes(value);
 }

packages/create-cli/src/lib/setup/ci.unit.test.ts

@@ -11,16 +11,16 @@ vi.mock('@inquirer/prompts', () => ({
 }));
 
 describe('promptCiProvider', () => {
-  it.each(['github', 'gitlab', 'skip'] as const)(
+  it.each(['github', 'gitlab', 'none'] as const)(
     'should return %j when --ci %s is provided',
     async ci => {
       await expect(promptCiProvider({ ci })).resolves.toBe(ci);
       expect(select).not.toHaveBeenCalled();
     },
   );
 
-  it('should return "skip" when --yes is provided', async () => {
-    await expect(promptCiProvider({ yes: true })).resolves.toBe('skip');
+  it('should return "none" when --yes is provided', async () => {
+    await expect(promptCiProvider({ yes: true })).resolves.toBe('none');
     expect(select).not.toHaveBeenCalled();
   });
 
@@ -31,7 +31,7 @@ describe('promptCiProvider', () => {
     expect(select).toHaveBeenCalledWith(
       expect.objectContaining({
         message: 'CI/CD integration:',
-        default: 'skip',
+        default: 'none',
       }),
     );
   });
@@ -154,12 +154,12 @@ describe('resolveCi', () => {
     });
   });
 
-  describe('skip', () => {
-    it('should make no changes when provider is skip', async () => {
+  describe('none', () => {
+    it('should make no changes when provider is none', async () => {
       vol.fromJSON({ 'package.json': '{}' }, MEMFS_VOLUME);
       const tree = createTree(MEMFS_VOLUME);
 
-      await resolveCi(tree, 'skip', STANDALONE_CONTEXT);
+      await resolveCi(tree, 'none', STANDALONE_CONTEXT);
 
       expect(tree.listChanges()).toStrictEqual([]);
     });

packages/create-cli/src/lib/setup/types.ts

@@ -1,7 +1,7 @@
 import type { PluginMeta } from '@code-pushup/models';
 import type { MonorepoTool } from '@code-pushup/utils';
 
-export const CI_PROVIDERS = ['github', 'gitlab', 'skip'] as const;
+export const CI_PROVIDERS = ['github', 'gitlab', 'none'] as const;
 export type CiProvider = (typeof CI_PROVIDERS)[number];
 
 export const CONFIG_FILE_FORMATS = ['ts', 'js', 'mjs'] as const;