@git.zone/cli 2.13.8 → 2.13.11

package/ts/mod_format/format.packagejson.ts

@@ -1,196 +0,0 @@
-import * as plugins from './mod.plugins.js';
-import * as paths from '../paths.js';
-import * as gulpFunction from '@push.rocks/gulp-function';
-import { Project } from '../classes.project.js';
-
-import { logger } from '../gitzone.logging.js';
-
-/**
- * ensures a certain dependency
- */
-const ensureDependency = async (
-  packageJsonObjectArg: any,
-  position: 'dep' | 'devDep' | 'everywhere',
-  constraint: 'exclude' | 'include' | 'latest',
-  dependencyArg: string,
-) => {
-  const [packageName, version] = dependencyArg.includes('@')
-    ? dependencyArg.split('@').filter(Boolean)
-    : [dependencyArg, 'latest'];
-
-  const targetSections: string[] = [];
-
-  switch (position) {
-    case 'dep':
-      targetSections.push('dependencies');
-      break;
-    case 'devDep':
-      targetSections.push('devDependencies');
-      break;
-    case 'everywhere':
-      targetSections.push('dependencies', 'devDependencies');
-      break;
-  }
-
-  for (const section of targetSections) {
-    if (!packageJsonObjectArg[section]) {
-      packageJsonObjectArg[section] = {};
-    }
-
-    switch (constraint) {
-      case 'exclude':
-        delete packageJsonObjectArg[section][packageName];
-        break;
-      case 'include':
-        if (!packageJsonObjectArg[section][packageName]) {
-          packageJsonObjectArg[section][packageName] =
-            version === 'latest' ? '^1.0.0' : version;
-        }
-        break;
-      case 'latest':
-        // Fetch latest version from npm
-        try {
-          const registry = new plugins.smartnpm.NpmRegistry();
-          const packageInfo = await registry.getPackageInfo(packageName);
-          const latestVersion = packageInfo['dist-tags'].latest;
-          packageJsonObjectArg[section][packageName] = `^${latestVersion}`;
-        } catch (error) {
-          logger.log(
-            'warn',
-            `Could not fetch latest version for ${packageName}, using existing or default`,
-          );
-          if (!packageJsonObjectArg[section][packageName]) {
-            packageJsonObjectArg[section][packageName] =
-              version === 'latest' ? '^1.0.0' : version;
-          }
-        }
-        break;
-    }
-  }
-};
-
-export const run = async (projectArg: Project) => {
-  const formatStreamWrapper = new plugins.smartstream.StreamWrapper([
-    plugins.smartgulp.src([`package.json`]),
-    gulpFunction.forEach(async (fileArg: plugins.smartfile.SmartFile) => {
-      const npmextraConfig = new plugins.npmextra.Npmextra(paths.cwd);
-      const gitzoneData: any = npmextraConfig.dataFor('@git.zone/cli', {});
-      const fileString = fileArg.contents.toString();
-      const packageJson = JSON.parse(fileString);
-
-      // metadata
-      packageJson.repository = {
-        type: 'git',
-        url: `https://${gitzoneData.module.githost}/${gitzoneData.module.gitscope}/${gitzoneData.module.gitrepo}.git`,
-      };
-      ((packageJson.bugs = {
-        url: `https://${gitzoneData.module.githost}/${gitzoneData.module.gitscope}/${gitzoneData.module.gitrepo}/issues`,
-      }),
-        (packageJson.homepage = `https://${gitzoneData.module.githost}/${gitzoneData.module.gitscope}/${gitzoneData.module.gitrepo}#readme`));
-
-      // Check for module type
-      if (!packageJson.type) {
-        logger.log('info', `setting packageJson.type to "module"`);
-        packageJson.type = 'module';
-      }
-
-      // Check for private or public
-      if (packageJson.private !== undefined) {
-        logger.log(
-          'info',
-          'Success -> found private/public info in package.json!',
-        );
-      } else {
-        logger.log(
-          'error',
-          'found no private boolean! Setting it to private for now!',
-        );
-        packageJson.private = true;
-      }
-
-      // Check for license
-      if (packageJson.license) {
-        logger.log('info', 'Success -> found license in package.json!');
-      } else {
-        logger.log(
-          'error',
-          'found no license! Setting it to UNLICENSED for now!',
-        );
-        packageJson.license = 'UNLICENSED';
-      }
-
-      // Check for build script
-      if (packageJson.scripts.build) {
-        logger.log('info', 'Success -> found build script in package.json!');
-      } else {
-        logger.log(
-          'error',
-          'found no build script! Putting a placeholder there for now!',
-        );
-        packageJson.scripts.build = `echo "Not needed for now"`;
-      }
-
-      // Check for buildDocs script
-      if (!packageJson.scripts.buildDocs) {
-        logger.log(
-          'info',
-          'found no buildDocs script! Putting tsdoc script there now.',
-        );
-        packageJson.scripts.buildDocs = `tsdoc`;
-      }
-
-      // check for files
-      packageJson.files = [
-        'ts/**/*',
-        'ts_web/**/*',
-        'dist/**/*',
-        'dist_*/**/*',
-        'dist_ts/**/*',
-        'dist_ts_web/**/*',
-        'assets/**/*',
-        'cli.js',
-        'npmextra.json',
-        'readme.md',
-      ];
-
-      // check for dependencies
-      // Note: @push.rocks/tapbundle is deprecated - use @git.zone/tstest/tapbundle instead
-      await ensureDependency(
-        packageJson,
-        'devDep',
-        'exclude',
-        '@push.rocks/tapbundle',
-      );
-      await ensureDependency(
-        packageJson,
-        'devDep',
-        'latest',
-        '@git.zone/tstest',
-      );
-      await ensureDependency(
-        packageJson,
-        'devDep',
-        'latest',
-        '@git.zone/tsbuild',
-      );
-
-      // set overrides
-      const overridesContent = (await plugins.smartfs
-        .file(plugins.path.join(paths.assetsDir, 'overrides.json'))
-        .encoding('utf8')
-        .read()) as string;
-      const overrides = JSON.parse(overridesContent);
-      packageJson.pnpm = packageJson.pnpm || {};
-      packageJson.pnpm.overrides = overrides;
-
-      // exclude
-      // TODO
-
-      fileArg.setContentsFromString(JSON.stringify(packageJson, null, 2));
-    }),
-    plugins.smartgulp.replace(),
-  ]);
-  await formatStreamWrapper.run().catch((error) => {
-    console.log(error);
-  });
-};

package/ts/mod_format/format.prettier.ts

@@ -1,66 +0,0 @@
-import * as plugins from './mod.plugins.js';
-import prettier from 'prettier';
-import { Project } from '../classes.project.js';
-
-import { logger } from '../gitzone.logging.js';
-
-const prettierDefaultTypeScriptConfig: prettier.Options = {
-  printWidth: 100,
-  parser: 'typescript',
-  singleQuote: true,
-};
-
-const prettierDefaultMarkdownConfig: prettier.Options = {
-  singleQuote: true,
-  printWidth: 100,
-  parser: 'markdown',
-};
-
-const filesToFormat = [
-  `ts/**/*.ts`,
-  `test/**/*.ts`,
-  `readme.md`,
-  `docs/**/*.md`,
-];
-
-const choosePrettierConfig = (fileArg: plugins.smartfile.SmartFile) => {
-  switch (fileArg.parsedPath.ext) {
-    case '.ts':
-      return prettierDefaultTypeScriptConfig;
-    case '.md':
-      return prettierDefaultMarkdownConfig;
-    default:
-      return {};
-  }
-};
-
-const prettierTypeScriptPipestop = plugins.through2.obj(
-  async (fileArg: plugins.smartfile.SmartFile, enc, cb) => {
-    const fileString = fileArg.contentBuffer.toString();
-    const chosenConfig = choosePrettierConfig(fileArg);
-    const filePasses = await prettier.check(fileString, chosenConfig);
-    if (filePasses) {
-      logger.log('info', `OK! -> ${fileArg.path} passes!`);
-      cb(null);
-    } else {
-      logger.log('info', `${fileArg.path} is being reformated!`);
-      const formatedFileString = await prettier.format(
-        fileString,
-        chosenConfig,
-      );
-      fileArg.setContentsFromString(formatedFileString);
-      cb(null, fileArg);
-    }
-  },
-);
-
-export const run = async (projectArg: Project) => {
-  const formatStreamWrapper = new plugins.smartstream.StreamWrapper([
-    plugins.smartgulp.src(filesToFormat),
-    prettierTypeScriptPipestop,
-    plugins.smartgulp.replace(),
-  ]);
-  await formatStreamWrapper.run().catch((error) => {
-    console.log(error);
-  });
-};

package/ts/mod_format/format.readme.ts

@@ -1,29 +0,0 @@
-import * as plugins from './mod.plugins.js';
-import * as paths from '../paths.js';
-
-export const run = async () => {
-  const readmePath = plugins.path.join(paths.cwd, 'readme.md');
-  const readmeHintsPath = plugins.path.join(paths.cwd, 'readme.hints.md');
-
-  // Check and initialize readme.md if it doesn't exist
-  const readmeExists = await plugins.smartfs.file(readmePath).exists();
-  if (!readmeExists) {
-    await plugins.smartfs.file(readmePath)
-      .encoding('utf8')
-      .write('# Project Readme\n\nThis is the initial readme file.');
-    console.log('Initialized readme.md');
-  } else {
-    console.log('readme.md already exists');
-  }
-
-  // Check and initialize readme.hints.md if it doesn't exist
-  const readmeHintsExists = await plugins.smartfs.file(readmeHintsPath).exists();
-  if (!readmeHintsExists) {
-    await plugins.smartfs.file(readmeHintsPath)
-      .encoding('utf8')
-      .write('# Project Readme Hints\n\nThis is the initial readme hints file.');
-    console.log('Initialized readme.hints.md');
-  } else {
-    console.log('readme.hints.md already exists');
-  }
-};

package/ts/mod_format/format.templates.ts

@@ -1,79 +0,0 @@
-import * as plugins from './mod.plugins.js';
-import * as paths from '../paths.js';
-
-import { logger } from '../gitzone.logging.js';
-import { Project } from '../classes.project.js';
-
-/**
- * takes care of updating files from templates
- */
-export const run = async (project: Project) => {
-  const templateModule = await import('../mod_template/index.js');
-
-  // update vscode
-  const vscodeTemplate = await templateModule.getTemplate('vscode');
-  await vscodeTemplate.writeToDisk(paths.cwd);
-  logger.log('info', `Updated vscode template!`);
-
-  // update gitlab ci and Dockerfile
-  switch (project.gitzoneConfig.data.projectType) {
-    case 'npm':
-    case 'wcc':
-      if (project.gitzoneConfig.data.npmciOptions.npmAccessLevel === 'public') {
-        const ciTemplateDefault =
-          await templateModule.getTemplate('ci_default');
-        ciTemplateDefault.writeToDisk(paths.cwd);
-      } else {
-        const ciTemplateDefault =
-          await templateModule.getTemplate('ci_default_private');
-        ciTemplateDefault.writeToDisk(paths.cwd);
-      }
-      logger.log('info', 'Updated .gitlabci.yml!');
-      break;
-    case 'service':
-    case 'website':
-      const ciTemplateDocker = await templateModule.getTemplate('ci_docker');
-      await ciTemplateDocker.writeToDisk(paths.cwd);
-      logger.log('info', 'Updated CI/CD config files!');
-
-      // lets care about docker
-      const dockerTemplate =
-        await templateModule.getTemplate('dockerfile_service');
-      dockerTemplate.writeToDisk(paths.cwd);
-      logger.log('info', 'Updated Dockerfile!');
-
-      // lets care about cli
-      const cliTemplate = await templateModule.getTemplate('cli');
-      await cliTemplate.writeToDisk(paths.cwd);
-      logger.log('info', 'Updated cli.ts.js and cli.js!');
-      break;
-    default:
-      break;
-  }
-
-  // update html
-  if (project.gitzoneConfig.data.projectType === 'website') {
-    const websiteUpdateTemplate =
-      await templateModule.getTemplate('website_update');
-    const variables = {
-      assetbrokerUrl: project.gitzoneConfig.data.module.assetbrokerUrl,
-      legalUrl: project.gitzoneConfig.data.module.legalUrl,
-    };
-    console.log(
-      'updating website template with variables\n',
-      JSON.stringify(variables, null, 2),
-    );
-    websiteUpdateTemplate.supplyVariables(variables);
-    await websiteUpdateTemplate.writeToDisk(paths.cwd);
-    logger.log('info', `Updated html for website!`);
-  } else if (project.gitzoneConfig.data.projectType === 'service') {
-    const websiteUpdateTemplate =
-      await templateModule.getTemplate('service_update');
-    await websiteUpdateTemplate.writeToDisk(paths.cwd);
-    logger.log('info', `Updated html for element template!`);
-  } else if (project.gitzoneConfig.data.projectType === 'wcc') {
-    const wccUpdateTemplate = await templateModule.getTemplate('wcc_update');
-    await wccUpdateTemplate.writeToDisk(paths.cwd);
-    logger.log('info', `Updated html for wcc template!`);
-  }
-};

package/ts/mod_format/format.tsconfig.ts

@@ -1,31 +0,0 @@
-import * as plugins from './mod.plugins.js';
-import * as paths from '../paths.js';
-
-import { logger } from '../gitzone.logging.js';
-import { Project } from '../classes.project.js';
-
-export const run = async (projectArg: Project) => {
-  // lets care about tsconfig.json
-  logger.log('info', 'Formatting tsconfig.json...');
-  const factory = plugins.smartfile.SmartFileFactory.nodeFs();
-  const tsconfigSmartfile = await factory.fromFilePath(
-    plugins.path.join(paths.cwd, 'tsconfig.json'),
-  );
-  const tsconfigObject = JSON.parse(tsconfigSmartfile.parseContentAsString());
-  tsconfigObject.compilerOptions = tsconfigObject.compilerOptions || {};
-  tsconfigObject.compilerOptions.baseUrl = '.';
-  tsconfigObject.compilerOptions.paths = {};
-  const tsPublishMod = await import('@git.zone/tspublish');
-  const tsPublishInstance = new tsPublishMod.TsPublish();
-  const publishModules = await tsPublishInstance.getModuleSubDirs(paths.cwd);
-  for (const publishModule of Object.keys(publishModules)) {
-    const publishConfig = publishModules[publishModule];
-    tsconfigObject.compilerOptions.paths[`${publishConfig.name}`] = [
-      `./${publishModule}/index.js`,
-    ];
-  }
-  await tsconfigSmartfile.editContentAsString(async () => {
-    return JSON.stringify(tsconfigObject, null, 2);
-  });
-  await tsconfigSmartfile.write();
-};

package/ts/mod_format/formatters/npmextra.formatter.ts

@@ -1,174 +0,0 @@
-import { BaseFormatter } from '../classes.baseformatter.js';
-import type { IPlannedChange } from '../interfaces.format.js';
-import * as plugins from '../mod.plugins.js';
-import { logger, logVerbose } from '../../gitzone.logging.js';
-
-/**
- * Migrates npmextra.json from old namespace keys to new package-scoped keys
- */
-const migrateNamespaceKeys = (npmextraJson: any): boolean => {
-  let migrated = false;
-  const migrations = [
-    { oldKey: 'gitzone', newKey: '@git.zone/cli' },
-    { oldKey: 'tsdoc', newKey: '@git.zone/tsdoc' },
-    { oldKey: 'npmdocker', newKey: '@git.zone/tsdocker' },
-    { oldKey: 'npmci', newKey: '@ship.zone/szci' },
-    { oldKey: 'szci', newKey: '@ship.zone/szci' },
-  ];
-  for (const { oldKey, newKey } of migrations) {
-    if (npmextraJson[oldKey]) {
-      if (!npmextraJson[newKey]) {
-        // New key doesn't exist - simple rename
-        npmextraJson[newKey] = npmextraJson[oldKey];
-      } else {
-        // New key exists - merge old into new (old values don't overwrite new)
-        npmextraJson[newKey] = {
-          ...npmextraJson[oldKey],
-          ...npmextraJson[newKey],
-        };
-      }
-      delete npmextraJson[oldKey];
-      migrated = true;
-    }
-  }
-  return migrated;
-};
-
-/**
- * Migrates npmAccessLevel from @ship.zone/szci to @git.zone/cli.release.accessLevel
- */
-const migrateAccessLevel = (npmextraJson: any): boolean => {
-  const szciConfig = npmextraJson['@ship.zone/szci'];
-
-  if (!szciConfig?.npmAccessLevel) {
-    return false;
-  }
-
-  const gitzoneConfig = npmextraJson['@git.zone/cli'] || {};
-  if (gitzoneConfig?.release?.accessLevel) {
-    delete szciConfig.npmAccessLevel;
-    return true;
-  }
-
-  if (!npmextraJson['@git.zone/cli']) {
-    npmextraJson['@git.zone/cli'] = {};
-  }
-  if (!npmextraJson['@git.zone/cli'].release) {
-    npmextraJson['@git.zone/cli'].release = {};
-  }
-
-  npmextraJson['@git.zone/cli'].release.accessLevel = szciConfig.npmAccessLevel;
-  delete szciConfig.npmAccessLevel;
-
-  return true;
-};
-
-export class NpmextraFormatter extends BaseFormatter {
-  get name(): string {
-    return 'npmextra';
-  }
-
-  async analyze(): Promise<IPlannedChange[]> {
-    const changes: IPlannedChange[] = [];
-    const npmextraPath = 'npmextra.json';
-
-    // Check if file exists
-    const exists = await plugins.smartfs.file(npmextraPath).exists();
-    if (!exists) {
-      logVerbose('npmextra.json does not exist, skipping');
-      return changes;
-    }
-
-    // Read current content
-    const currentContent = (await plugins.smartfs
-      .file(npmextraPath)
-      .encoding('utf8')
-      .read()) as string;
-
-    // Parse and compute new content
-    const npmextraJson = JSON.parse(currentContent);
-
-    // Apply migrations (these are automatic, non-interactive)
-    migrateNamespaceKeys(npmextraJson);
-    migrateAccessLevel(npmextraJson);
-
-    // Ensure namespaces exist
-    if (!npmextraJson['@git.zone/cli']) {
-      npmextraJson['@git.zone/cli'] = {};
-    }
-    if (!npmextraJson['@ship.zone/szci']) {
-      npmextraJson['@ship.zone/szci'] = {};
-    }
-
-    const newContent = JSON.stringify(npmextraJson, null, 2);
-
-    // Only add change if content differs
-    if (newContent !== currentContent) {
-      changes.push({
-        type: 'modify',
-        path: npmextraPath,
-        module: this.name,
-        description: 'Migrate and format npmextra.json',
-        content: newContent,
-      });
-    }
-
-    return changes;
-  }
-
-  async applyChange(change: IPlannedChange): Promise<void> {
-    if (change.type !== 'modify' || !change.content) return;
-
-    // Parse the content to check for missing required fields
-    const npmextraJson = JSON.parse(change.content);
-
-    // Check for missing required module information
-    const expectedRepoInformation: string[] = [
-      'projectType',
-      'module.githost',
-      'module.gitscope',
-      'module.gitrepo',
-      'module.description',
-      'module.npmPackagename',
-      'module.license',
-    ];
-
-    const interactInstance = new plugins.smartinteract.SmartInteract();
-    for (const expectedRepoInformationItem of expectedRepoInformation) {
-      if (
-        !plugins.smartobject.smartGet(
-          npmextraJson['@git.zone/cli'],
-          expectedRepoInformationItem,
-        )
-      ) {
-        interactInstance.addQuestions([
-          {
-            message: `What is the value of ${expectedRepoInformationItem}`,
-            name: expectedRepoInformationItem,
-            type: 'input',
-            default: 'undefined variable',
-          },
-        ]);
-      }
-    }
-
-    const answerbucket = await interactInstance.runQueue();
-    for (const expectedRepoInformationItem of expectedRepoInformation) {
-      const cliProvidedValue = answerbucket.getAnswerFor(
-        expectedRepoInformationItem,
-      );
-      if (cliProvidedValue) {
-        plugins.smartobject.smartAdd(
-          npmextraJson['@git.zone/cli'],
-          expectedRepoInformationItem,
-          cliProvidedValue,
-        );
-      }
-    }
-
-    // Write the final content
-    const finalContent = JSON.stringify(npmextraJson, null, 2);
-    await this.modifyFile(change.path, finalContent);
-    logger.log('info', 'Updated npmextra.json');
-  }
-}