1.9.116

changelog.md

@@ -0,0 +1,58 @@
+# Changelog
+
+## 2024-06-23 - 1.9.116 - fix(dependencies)
+Update @git.zone/tsdoc to version 1.3.5
+
+- Updated the @git.zone/tsdoc dependency in package.json and pnpm-lock.yaml from version 1.3.4 to 1.3.5
+- Removed the outdated changelog.md file.
+
+
+```
+## 2024-06-23 - 1.9.114 - fix(format)
+Fixed formatting issues across multiple TypeScript files.
+
+## 2024-06-23 - 1.9.113 - fix(mod_commit)
+Remove extra new lines in changelog.
+
+## 2024-06-23 - 1.9.112 - fix(core)
+Update changelog formatting and remove outdated entries.
+
+## 2024-06-23 - 1.9.111 - fix(changelog)
+Remove outdated changelog entries and update formatting.
+
+## 2024-06-23 - 1.9.110 - fix(dependencies)
+Update @git.zone/tsdoc to version 1.3.4.
+
+## 2024-06-23 - 1.9.109 - fix(changelog)
+Remove outdated entries and adjust formatting in changelog.
+
+## 2024-06-23 - 1.9.108 - fix(dependencies)
+Update @git.zone/tsdoc dependency to version 1.3.2.
+
+## 2024-06-23 - 1.9.107 - fix(changelog)
+Remove placeholder entries and adjust formatting in changelog.
+
+## 2024-06-23 - 1.9.106 - fix(dependencies)
+Updated @git.zone/tsdoc from version 1.3.0 to 1.3.1.
+
+## 2024-06-23 - 1.9.105 - fix(dependencies)
+Updated @git.zone/tsdoc dependency from 1.2.2 to 1.3.0 in package.json and pnpm-lock.yaml.
+
+## 2024-06-23 - 1.9.104 - fix(changelog)
+Remove placeholder entries and adjust formatting in changelog.
+
+## 2024-06-23 - 1.9.103 - fix(changelog)
+Fix changelog to remove placeholder entries and adjust formatting.
+
+## 2024-06-23 - 1.9.102 - fix(logging)
+Optimize logger instantiation and configuration.
+
+## 2024-06-23 - 1.9.101 - fix(metadata)
+Ensure accurate project metadata in package.json.
+
+## 2024-06-23 - 1.9.100 - fix(dependencies)
+Updated @git.zone/tsdoc dependency version to ^1.2.2 in package.json and pnpm-lock.yaml.
+
+## 2024-06-23 - 1.9.99 - fix(mod_commit)
+Fix variable reassignment issue in changelog writing step.
+```

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@git.zone/cli",
   "private": false,
-  "version": "1.9.97",
+  "version": "1.9.116",
   "description": "A CLI toolbelt to streamline local development cycles by using various gitzone utilities.",
   "main": "dist_ts/index.ts",
   "typings": "dist_ts/index.d.ts",
@@ -11,7 +11,7 @@
     "gzone": "./cli.js"
   },
   "scripts": {
-    "test": "(npm run clean && npm run prepareTest && npm run testCli && npm run testCommit && npm run testDeprecate && npm run testVersion && npm run testReadme && npm run testFormat && npm run testUpdate && npm run testTemplateNpm && npm run testTemplateLit) && rm -rf test",
+    "test": "(npm run clean && npm run prepareTest && npm run testCli && npm run testFormat && npm run testCommit && npm run testDeprecate && npm run testVersion && npm run testReadme && npm run testUpdate && npm run testTemplateNpm && npm run testTemplateLit) && rm -rf test",
     "build": "(tsbuild --web --allowimplicitany)",
     "clean": "(rm -rf test/)",
     "prepareTest": "(git clone https://gitlab.com/sandboxzone/sandbox-npmts.git test/)",
@@ -30,7 +30,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://code.foss.global/git.zone/cli.git"
+    "url": "https://code.foss.global/git.zone/cli.git"
   },
   "keywords": [
     "CLI",
@@ -48,17 +48,18 @@
   "author": "Task Venture Capital GmbH",
   "license": "MIT",
   "bugs": {
-    "url": "https://gitlab.com/gitzone/private/gitzone/issues"
+    "url": "https://code.foss.global/git.zone/cli/issues"
   },
   "homepage": "https://pages.foss.global/git.zone/cli",
   "devDependencies": {
     "@git.zone/tsbuild": "^2.1.80",
     "@git.zone/tsrun": "^1.2.46",
     "@git.zone/tstest": "^1.0.90",
-    "@types/node": "^20.14.7"
+    "@types/node": "^20.14.8"
   },
   "dependencies": {
-    "@push.rocks/commitinfo": "^1.0.11",
+    "@git.zone/tsdoc": "^1.3.5",
+    "@push.rocks/commitinfo": "^1.0.12",
     "@push.rocks/early": "^4.0.4",
     "@push.rocks/gulp-function": "^3.0.7",
     "@push.rocks/lik": "^6.0.15",

ts/00_commitinfo_data.ts

@@ -1,8 +1,8 @@
 /**
- * autocreated commitinfo by @pushrocks/commitinfo
+ * autocreated commitinfo by @push.rocks/commitinfo
  */
 export const commitinfo = {
   name: '@git.zone/cli',
-  version: '1.9.97',
+  version: '1.9.116',
   description: 'A CLI toolbelt to streamline local development cycles by using various gitzone utilities.'
 }

ts/classes.gitzoneconfig.ts

@@ -17,7 +17,7 @@ export interface IGitzoneConfigData {
     license: string;
     projectDomain: string;
   };
-  copy: {[key: string]: string}
+  copy: { [key: string]: string };
   npmciOptions: {
     npmAccessLevel: 'public' | 'private';
   };

ts/classes.project.ts

@@ -1,4 +1,4 @@
-import * as plugins from './plugins.js'
+import * as plugins from './plugins.js';
 import * as paths from './paths.js';
 
 import { GitzoneConfig } from './classes.gitzoneconfig.js';

ts/gitzone.cli.ts

@@ -15,7 +15,7 @@ export let run = async () => {
   await smartupdateInstance.check(
     'gitzone',
     projectInfo.npm.version,
-    'http://gitzone.gitlab.io/gitzone/changelog.html'
+    'http://gitzone.gitlab.io/gitzone/changelog.html',
   );
   console.log('---------------------------------------------');
   gitzoneSmartcli.addVersion(projectInfo.npm.version);

ts/gitzone.logging.ts

@@ -1,15 +1,6 @@
+import { commitinfo } from '@push.rocks/commitinfo';
 import * as plugins from './plugins.js';
 
-export const logger = new plugins.smartlog.Smartlog({
+export const logger = plugins.smartlog.Smartlog.createForCommitinfo(commitinfo);
-  minimumLogLevel: 'silly',
-  logContext: {
-    company: 'Task Venture Capital GmbH',
-    companyunit: 'Lossless Cloud',
-    containerName: 'local',
-    environment: 'local',
-    runtime: 'node',
-    zone: 'gitzone',
-  },
-});
 
 logger.addLogDestination(new plugins.smartlogDestinationLocal.DestinationLocal());

ts/mod_commit/index.ts

@@ -5,6 +5,19 @@ import * as paths from '../paths.js';
 import { logger } from '../gitzone.logging.js';
 
 export const run = async (argvArg: any) => {
+  logger.log('info', `gathering facts...`);
+  const aidoc = new plugins.tsdoc.AiDoc();
+  await aidoc.start();
+
+  const nextCommitObject = await aidoc.buildNextCommitObject(paths.cwd);
+
+  logger.log('info', `---------
+    Next recommended commit would be:
+    ===========
+    -> ${nextCommitObject.recommendedNextVersion}:
+    -> ${nextCommitObject.recommendedNextVersionLevel}(${nextCommitObject.recommendedNextVersionScope}): ${nextCommitObject.recommendedNextVersionMessage}
+    ===========
+  `);
   const commitInteract = new plugins.smartinteract.SmartInteract();
   commitInteract.addQuestions([
     {
@@ -12,19 +25,19 @@ export const run = async (argvArg: any) => {
       name: `commitType`,
       message: `Choose TYPE of the commit:`,
       choices: [`fix`, `feat`, `BREAKING CHANGE`],
-      default: `fix`,
+      default: nextCommitObject.recommendedNextVersionLevel,
     },
     {
       type: 'input',
       name: `commitScope`,
       message: `What is the SCOPE of the commit:`,
-      default: `core`,
+      default: nextCommitObject.recommendedNextVersionScope,
     },
     {
       type: `input`,
       name: `commitDescription`,
       message: `What is the DESCRIPTION of the commit?`,
-      default: `update`,
+      default: nextCommitObject.recommendedNextVersionMessage,
     },
     {
       type: 'confirm',
@@ -52,10 +65,19 @@ export const run = async (argvArg: any) => {
     sourceFilePaths: [],
   });
 
-  logger.log('info', `Baking commitinfo into code`);
+  logger.log('info', `Baking commitinfo into code ...`);
   const commitInfo = new plugins.commitinfo.CommitInfo(paths.cwd, commitVersionType);
   await commitInfo.writeIntoPotentialDirs();
 
+  logger.log('info', `Writing changelog.md ...`);
+  let changelog = nextCommitObject.changelog;
+  changelog = changelog.replaceAll('{{nextVersion}}', (await commitInfo.getNextPlannedVersion()).versionString);
+  changelog = changelog.replaceAll('{{nextVersionScope}}', `${await answerBucket.getAnswerFor('commitType')}(${await answerBucket.getAnswerFor('commitScope')})`);
+  changelog = changelog.replaceAll('{{nextVersionMessage}}', nextCommitObject.recommendedNextVersionMessage);
+  changelog = changelog.replaceAll('{{nextVersionDetails}}', '- ' + nextCommitObject.recommendedNextVersionDetails.join('\n- '));
+
+  await plugins.smartfile.memory.toFs(changelog, plugins.path.join(paths.cwd, `changelog.md`));
+
   logger.log('info', `Staging files for commit:`);
   await smartshellInstance.exec(`git add -A`);
   await smartshellInstance.exec(`git commit -m "${commitString}"`);

ts/mod_commit/mod.plugins.ts

@@ -1,7 +1,10 @@
 export * from '../plugins.js';
 
 import * as commitinfo from '@push.rocks/commitinfo';
+import * as smartfile from '@push.rocks/smartfile';
 import * as smartinteract from '@push.rocks/smartinteract';
 import * as smartshell from '@push.rocks/smartshell';
 
-export { commitinfo, smartinteract, smartshell };
+import * as tsdoc from '@git.zone/tsdoc';
+
+export { commitinfo, smartfile, smartinteract, smartshell, tsdoc };

ts/mod_format/format.copy.ts

@@ -3,4 +3,4 @@ import * as plugins from '../plugins.js';
 
 export const run = async (projectArg: Project) => {
   const gitzoneConfig = await projectArg.gitzoneConfig;
-}
+};

ts/mod_format/format.license.ts

@@ -4,15 +4,21 @@ import { Project } from '../classes.project.js';
 
 import { logger } from '../gitzone.logging.js';
 
-const incompatibleLicenses: string[] = [
+const incompatibleLicenses: string[] = ['AGPL', 'GPL', 'SSPL'];
-  "AGPL",
-  "GPL",
-  "SSPL",
-];
 
 export const run = async (projectArg: Project) => {
+  const nodeModulesInstalled = await plugins.smartfile.fs.isDirectory(
+    plugins.path.join(paths.cwd, 'node_modules'),
+  );
+  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);
+  const licenseCheckResult = await licenseChecker.excludeLicenseWithinPath(
+    paths.cwd,
+    incompatibleLicenses,
+  );
   if (licenseCheckResult.failingModules.length === 0) {
     logger.log('info', 'Success -> licenses passed!');
   } else {

ts/mod_format/format.npmextra.ts

@@ -48,7 +48,7 @@ export const run = async (projectArg: Project) => {
           plugins.smartobject.smartAdd(
             npmextraJson.gitzone,
             expectedRepoInformationItem,
-            cliProvidedValue
+            cliProvidedValue,
           );
         }
       }

ts/mod_format/format.packagejson.ts

@@ -12,7 +12,7 @@ const ensureDependency = async (
   packageJsonObjectArg: any,
   position: 'dep' | 'devDep' | 'everywhere',
   constraint: 'exclude' | 'include' | 'latest',
-  dependencyArg: string
+  dependencyArg: string,
 ) => {};
 
 export const run = async (projectArg: Project) => {
@@ -26,14 +26,13 @@ export const run = async (projectArg: Project) => {
 
       // metadata
       packageJson.repository = {
-        "type": "git",
+        type: 'git',
-        "url": `git+https://${gitzoneData.module.githost}/${gitzoneData.module.gitscope}/${gitzoneData.module.gitrepo}.git`
+        url: `git+https://${gitzoneData.module.githost}/${gitzoneData.module.gitscope}/${gitzoneData.module.gitrepo}.git`,
       };
-      packageJson.bugs = {
+      (packageJson.bugs = {
-        "url": `https://${gitzoneData.module.githost}/${gitzoneData.module.gitscope}/${gitzoneData.module.gitrepo}/issues`
+        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`;
+        (packageJson.homepage = `https://${gitzoneData.module.githost}/${gitzoneData.module.gitscope}/${gitzoneData.module.gitrepo}#readme`);
-
 
       // Check for module type
       if (!packageJson.type) {

ts/mod_format/format.prettier.ts

@@ -43,7 +43,7 @@ const prettierTypeScriptPipestop = plugins.through2.obj(
       fileArg.setContentsFromString(formatedFileString);
       cb(null, fileArg);
     }
-  }
+  },
 );
 
 export const run = async (projectArg: Project) => {

ts/mod_format/format.readme.ts

@@ -1,47 +1,31 @@
 import * as plugins from './mod.plugins.js';
 import * as paths from '../paths.js';
-import { GitzoneConfig } from '../classes.gitzoneconfig.js';
-import { Project } from '../classes.project.js';
 
-export const run = async (projectArg: Project) => {
+export const run = async () => {
   const readmePath = plugins.path.join(paths.cwd, 'readme.md');
-  const readmeFile = await plugins.smartfile.SmartFile.fromFilePath(readmePath);
+  const readmeHintsPath = plugins.path.join(paths.cwd, 'readme.hints.md');
 
-  // lets do our transformation
+  // Check and initialize readme.md if it doesn't exist
-
+  const readmeExists = await plugins.smartfile.fs.fileExists(readmePath);
-  let usageInfo: string = '';
+  if (!readmeExists) {
-  const gitzoneConfig = await GitzoneConfig.fromCwd();
+    await plugins.smartfile.fs.toFs(
-
+      '# Project Readme\n\nThis is the initial readme file.',
-  if (readmeFile) {
+      readmePath,
-    const readmeFileString = readmeFile.contentBuffer.toString();
+    );
-    const stringArray1 = readmeFileString.split('## Usage\n');
+    console.log('Initialized readme.md');
-    if (stringArray1[1]) {
+  } else {
-      const stringArray2 = stringArray1[1].split(
+    console.log('readme.md already exists');
-        '\nFor further information read the linked docs at the top of this readme.'
-      );
-      const stringArray3 = stringArray2[0].split('\n\n## Contribution');
-      usageInfo = stringArray3[0];
-    }
   }
 
-  if (gitzoneConfig.data.module && gitzoneConfig.data.module.license === 'MIT') {
+  // Check and initialize readme.hints.md if it doesn't exist
-    usageInfo +=
+  const readmeHintsExists = await plugins.smartfile.fs.fileExists(readmeHintsPath);
-      '\n\n## Contribution\n\n' +
+  if (!readmeHintsExists) {
-      'We are always happy for code contributions. If you are not the code contributing type that is ok. ' +
+    await plugins.smartfile.fs.toFs(
-      'Still, maintaining Open Source repositories takes considerable time and thought. ' +
+      '# Project Readme Hints\n\nThis is the initial readme hints file.',
-      'If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: ' +
+      readmeHintsPath,
-      'You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)\n';
+    );
+    console.log('Initialized readme.hints.md');
+  } else {
+    console.log('readme.hints.md already exists');
   }
-
-  const templateModule = await import('../mod_template/index.js');
-  const readmeTemplate = await templateModule.getTemplate('readme');
-  console.log(gitzoneConfig.data);
-  await readmeTemplate.supplyVariables({
-    module: {
-      ...gitzoneConfig.data.module,
-    },
-    usageInfo,
-  });
-  await readmeTemplate.askCliForMissingVariables();
-  await readmeTemplate.writeToDisk(paths.cwd);
 };

ts/mod_format/index.ts

@@ -34,5 +34,5 @@ export let run = async (write: boolean = true): Promise<any> => {
 
   // format readme.md
   const formatReadme = await import('./format.readme.js');
-  // await formatReadme.run();
+  await formatReadme.run();
 };

ts/mod_format/mod.plugins.ts

@@ -10,4 +10,14 @@ import * as smartnpm from '@push.rocks/smartnpm';
 import * as smartstream from '@push.rocks/smartstream';
 import * as through2 from 'through2';
 
-export { lik, smartfile, smartgulp, smartinteract, smartlegal, smartobject, smartnpm, smartstream, through2 };
+export {
+  lik,
+  smartfile,
+  smartgulp,
+  smartinteract,
+  smartlegal,
+  smartobject,
+  smartnpm,
+  smartstream,
+  through2,
+};

ts/mod_meta/meta.classes.meta.ts

@@ -73,7 +73,7 @@ export class Meta {
     // write .meta.json to disk
     plugins.smartfile.memory.toFsSync(
       JSON.stringify(this.metaRepoData, null, 2),
-      this.filePaths.metaJson
+      this.filePaths.metaJson,
     );
     // write .gitignore to disk
     plugins.smartfile.memory.toFsSync(await this.generateGitignore(), this.filePaths.gitIgnore);
@@ -104,12 +104,12 @@ export class Meta {
       if (
         preExistingFolderArg !== '.git' &&
         !Object.keys(projects).find((projectFolder) =>
-          projectFolder.startsWith(preExistingFolderArg)
+          projectFolder.startsWith(preExistingFolderArg),
         )
       ) {
         const response = await plugins.smartinteraction.SmartInteract.getCliConfirmation(
           `Do you want to delete superfluous directory >>${preExistingFolderArg}<< ?`,
-          true
+          true,
         );
         if (response) {
           logger.log('warn', `Deleting >>${preExistingFolderArg}<<!`);
@@ -131,7 +131,7 @@ export class Meta {
     logger.log('info', `found ${missingRepos.length} missing repos`);
     for (const missingRepo of missingRepos) {
       await this.smartshellInstance.exec(
-        `cd ${this.cwd} && git clone ${this.metaRepoData.projects[missingRepo]} ${missingRepo}`
+        `cd ${this.cwd} && git clone ${this.metaRepoData.projects[missingRepo]} ${missingRepo}`,
       );
     }
 
@@ -140,7 +140,7 @@ export class Meta {
 
     logger.log('info', `persist changes with a git commit`);
     await this.smartshellInstance.exec(
-      `cd ${this.cwd} && git add -A && git commit -m "updated structure"`
+      `cd ${this.cwd} && git add -A && git commit -m "updated structure"`,
     );
     await this.syncToRemote();
 
@@ -166,7 +166,7 @@ export class Meta {
         JSON.stringify({
           projects: {},
         }),
-        this.filePaths.metaJson
+        this.filePaths.metaJson,
       );
       logger.log(`success`, `created a new .meta.json in directory ${this.cwd}`);
       await plugins.smartfile.memory.toFs(
@@ -174,14 +174,14 @@ export class Meta {
           name: this.dirName,
           version: '1.0.0',
         }),
-        this.filePaths.packageJson
+        this.filePaths.packageJson,
       );
       logger.log(`success`, `created a new package.json in directory ${this.cwd}`);
     } else {
       logger.log(`error`, `directory ${this.cwd} already has a .metaJson file. Doing nothing.`);
     }
     await this.smartshellInstance.exec(
-      `cd ${this.cwd} && git add -A && git commit -m "feat(project): init meta project for ${this.dirName}"`
+      `cd ${this.cwd} && git add -A && git commit -m "feat(project): init meta project for ${this.dirName}"`,
     );
     await this.updateLocalRepos();
   }
@@ -203,7 +203,7 @@ export class Meta {
     await this.sortMetaRepoData();
     await this.writeToDisk();
     await this.smartshellInstance.exec(
-      `cd ${this.cwd} && git add -A && git commit -m "feat(project): add ${projectNameArg}"`
+      `cd ${this.cwd} && git add -A && git commit -m "feat(project): add ${projectNameArg}"`,
     );
     await this.updateLocalRepos();
   }

ts/mod_open/index.ts

@@ -5,11 +5,11 @@ export let run = (argvArg) => {
   let projectInfo = new plugins.projectinfo.ProjectInfo(paths.cwd);
   if (argvArg._[1] === 'ci') {
     plugins.smartopen.openUrl(
-      `https://gitlab.com/${projectInfo.git.gituser}/${projectInfo.git.gitrepo}/settings/ci_cd`
+      `https://gitlab.com/${projectInfo.git.gituser}/${projectInfo.git.gitrepo}/settings/ci_cd`,
     );
   } else if (argvArg._[1] === 'pipelines') {
     plugins.smartopen.openUrl(
-      `https://gitlab.com/${projectInfo.git.gituser}/${projectInfo.git.gitrepo}/pipelines`
+      `https://gitlab.com/${projectInfo.git.gituser}/${projectInfo.git.gitrepo}/pipelines`,
     );
   }
 };

ts/mod_standard/index.ts

@@ -22,7 +22,7 @@ export let run = () => {
         return projects;
       })()}
     * format a project with 'gitzone format'
-  `
+  `,
   );
   done.resolve();
   return done.promise;

ts/paths.ts

@@ -2,7 +2,7 @@ import * as plugins from './plugins.js';
 
 export let packageDir = plugins.path.join(
   plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url),
-  '../'
+  '../',
 );
 export let assetsDir = plugins.path.join(packageDir, './assets');
 export let templatesDir = plugins.path.join(assetsDir, 'templates');