@git.zone/cli 2.13.10 → 2.13.11

package/ts/mod_format/format.copy.ts

@@ -1,93 +0,0 @@
-import type { Project } from '../classes.project.js';
-import * as plugins from './mod.plugins.js';
-import { logger } from '../gitzone.logging.js';
-
-export const run = async (projectArg: Project) => {
-  const gitzoneConfig = await projectArg.gitzoneConfig;
-
-  // Get copy configuration from npmextra.json
-  const npmextraConfig = new plugins.npmextra.Smartconfig();
-  const copyConfig = npmextraConfig.dataFor<any>('gitzone.format.copy', {
-    patterns: [],
-  });
-
-  if (!copyConfig.patterns || copyConfig.patterns.length === 0) {
-    logger.log('info', 'No copy patterns configured in npmextra.json');
-    return;
-  }
-
-  for (const pattern of copyConfig.patterns) {
-    if (!pattern.from || !pattern.to) {
-      logger.log('warn', 'Invalid copy pattern - missing "from" or "to" field');
-      continue;
-    }
-
-    try {
-      // Handle glob patterns
-      const entries = await plugins.smartfs
-        .directory('.')
-        .recursive()
-        .filter(pattern.from)
-        .list();
-      const files = entries.map((entry) => entry.path);
-
-      for (const file of files) {
-        const sourcePath = file;
-        let destPath = pattern.to;
-
-        // If destination is a directory, preserve filename
-        if (pattern.to.endsWith('/')) {
-          const filename = plugins.path.basename(file);
-          destPath = plugins.path.join(pattern.to, filename);
-        }
-
-        // Handle template variables in destination path
-        if (pattern.preservePath) {
-          const relativePath = plugins.path.relative(
-            plugins.path.dirname(pattern.from.replace(/\*/g, '')),
-            file,
-          );
-          destPath = plugins.path.join(pattern.to, relativePath);
-        }
-
-        // Ensure destination directory exists
-        await plugins.smartfs
-          .directory(plugins.path.dirname(destPath))
-          .recursive()
-          .create();
-
-        // Copy file
-        await plugins.smartfs.file(sourcePath).copy(destPath);
-        logger.log('info', `Copied ${sourcePath} to ${destPath}`);
-      }
-    } catch (error) {
-      logger.log(
-        'error',
-        `Failed to copy pattern ${pattern.from}: ${error.message}`,
-      );
-    }
-  }
-};
-
-/**
- * Example npmextra.json configuration:
- * {
- *   "gitzone": {
- *     "format": {
- *       "copy": {
- *         "patterns": [
- *           {
- *             "from": "src/assets/*",
- *             "to": "dist/assets/",
- *             "preservePath": true
- *           },
- *           {
- *             "from": "config/*.json",
- *             "to": "dist/"
- *           }
- *         ]
- *       }
- *     }
- *   }
- * }
- */

package/ts/mod_format/format.gitignore.ts

@@ -1,54 +0,0 @@
-import * as plugins from './mod.plugins.js';
-import * as paths from '../paths.js';
-
-import { Project } from '../classes.project.js';
-
-import { logger } from '../gitzone.logging.js';
-const gitignorePath = plugins.path.join(paths.cwd, './.gitignore');
-
-export const run = async (projectArg: Project) => {
-  const gitignoreExists = await plugins.smartfs.file(gitignorePath).exists();
-  let customContent = '';
-
-  if (gitignoreExists) {
-    // lets get the existing gitignore file
-    const existingGitIgnoreString = (await plugins.smartfs
-      .file(gitignorePath)
-      .encoding('utf8')
-      .read()) as string;
-
-    // Check for different custom section markers
-    const customMarkers = ['#------# custom', '# custom'];
-    for (const marker of customMarkers) {
-      const splitResult = existingGitIgnoreString.split(marker);
-      if (splitResult.length > 1) {
-        // Get everything after the marker (excluding the marker itself)
-        customContent = splitResult[1].trim();
-        break;
-      }
-    }
-  }
-
-  // Write the template
-  const templateModule = await import('../mod_template/index.js');
-  const ciTemplate = await templateModule.getTemplate('gitignore');
-  await ciTemplate.writeToDisk(paths.cwd);
-
-  // Append the custom content if it exists
-  if (customContent) {
-    const newGitignoreContent = (await plugins.smartfs
-      .file(gitignorePath)
-      .encoding('utf8')
-      .read()) as string;
-    // The template already ends with "#------# custom", so just append the content
-    const finalContent =
-      newGitignoreContent.trimEnd() + '\n' + customContent + '\n';
-    await plugins.smartfs
-      .file(gitignorePath)
-      .encoding('utf8')
-      .write(finalContent);
-    logger.log('info', 'Updated .gitignore while preserving custom section!');
-  } else {
-    logger.log('info', 'Added a .gitignore!');
-  }
-};

package/ts/mod_format/format.license.ts

@@ -1,32 +0,0 @@
-import * as plugins from './mod.plugins.js';
-import * as paths from '../paths.js';
-import { Project } from '../classes.project.js';
-
-import { logger } from '../gitzone.logging.js';
-
-const incompatibleLicenses: string[] = ['AGPL', 'GPL', 'SSPL'];
-
-export const run = async (projectArg: Project) => {
-  const nodeModulesInstalled = await plugins.smartfs
-    .directory(plugins.path.join(paths.cwd, 'node_modules'))
-    .exists();
-  if (!nodeModulesInstalled) {
-    logger.log('warn', 'No node_modules found. Skipping license check');
-    return;
-  }
-  const licenseChecker = await plugins.smartlegal.createLicenseChecker();
-  const licenseCheckResult = await licenseChecker.excludeLicenseWithinPath(
-    paths.cwd,
-    incompatibleLicenses,
-  );
-  if (licenseCheckResult.failingModules.length === 0) {
-    logger.log('info', 'Success -> licenses passed!');
-  } else {
-    logger.log('error', 'Error -> licenses failed. Here is why:');
-    for (const failedModule of licenseCheckResult.failingModules) {
-      console.log(
-        `${failedModule.name} fails with license ${failedModule.license}`,
-      );
-    }
-  }
-};

package/ts/mod_format/format.npmextra.ts

@@ -1,151 +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';
-
-/**
- * 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;
-      console.log(`Migrated npmextra.json: ${oldKey} -> ${newKey}`);
-    }
-  }
-  return migrated;
-};
-
-/**
- * Migrates npmAccessLevel from @ship.zone/szci to @git.zone/cli.release.accessLevel
- * This is a one-time migration for projects using the old location
- */
-const migrateAccessLevel = (npmextraJson: any): boolean => {
-  const szciConfig = npmextraJson['@ship.zone/szci'];
-
-  // Check if szci has npmAccessLevel that needs to be migrated
-  if (!szciConfig?.npmAccessLevel) {
-    return false;
-  }
-
-  // Check if we already have the new location
-  const gitzoneConfig = npmextraJson['@git.zone/cli'] || {};
-  if (gitzoneConfig?.release?.accessLevel) {
-    // Already migrated, just remove from szci
-    delete szciConfig.npmAccessLevel;
-    return true;
-  }
-
-  // Ensure @git.zone/cli and release exist
-  if (!npmextraJson['@git.zone/cli']) {
-    npmextraJson['@git.zone/cli'] = {};
-  }
-  if (!npmextraJson['@git.zone/cli'].release) {
-    npmextraJson['@git.zone/cli'].release = {};
-  }
-
-  // Migrate the value
-  npmextraJson['@git.zone/cli'].release.accessLevel = szciConfig.npmAccessLevel;
-  delete szciConfig.npmAccessLevel;
-
-  console.log(`Migrated npmAccessLevel to @git.zone/cli.release.accessLevel`);
-  return true;
-};
-
-/**
- * runs the npmextra file checking
- */
-export const run = async (projectArg: Project) => {
-  const formatSmartstream = new plugins.smartstream.StreamWrapper([
-    plugins.smartgulp.src([`smartconfig.json`]),
-    gulpFunction.forEach(async (fileArg: plugins.smartfile.SmartFile) => {
-      const fileString = fileArg.contents.toString();
-      const npmextraJson = JSON.parse(fileString);
-
-      // Migrate old namespace keys to new package-scoped keys
-      migrateNamespaceKeys(npmextraJson);
-
-      // Migrate npmAccessLevel from szci to @git.zone/cli.release.accessLevel
-      migrateAccessLevel(npmextraJson);
-
-      if (!npmextraJson['@git.zone/cli']) {
-        npmextraJson['@git.zone/cli'] = {};
-      }
-
-      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,
-          );
-        }
-      }
-
-      // delete obsolete
-      // tbd
-
-      if (!npmextraJson['@ship.zone/szci']) {
-        npmextraJson['@ship.zone/szci'] = {};
-      }
-
-      fileArg.setContentsFromString(JSON.stringify(npmextraJson, null, 2));
-    }),
-    plugins.smartgulp.replace(),
-  ]);
-  await formatSmartstream.run().catch((error) => {
-    console.log(error);
-  });
-};

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.Smartconfig(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',
-        'smartconfig.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');
-  }
-};