1.5.5

changelog.md

@@ -1,5 +1,97 @@
 # Changelog
 
+## 2024-10-28 - 1.5.5 - fix(core)
+Handled non-existent package in publish module to avoid errors
+
+- Added error handling in TsPublish for packages not yet existing in the registry.
+
+## 2024-10-28 - 1.5.4 - fix(core)
+Fix issues with path keys in tsconfig and logger setup in logging.ts.
+
+- Corrected the iteration over paths in the createTsconfigJson method of PublishModule.
+- Fixed logger setup by ensuring console is enabled in logging.ts.
+
+## 2024-10-28 - 1.5.3 - fix(core)
+Fix incorrect logging and directory preparation
+
+- Corrected logging to accurately report the number of detected publish modules.
+- Ensured the publish directory is emptied before creating package.json.
+
+## 2024-10-28 - 1.5.2 - fix(core)
+Add logging for found publish modules
+
+- Added console logging to display the count and list of discovered publish modules during the publish process.
+- Included a startup log message indicating the beginning of the tspublish process.
+
+## 2024-10-28 - 1.5.1 - fix(core)
+Fixes handling of undefined paths in tsconfig generation.
+
+- Added a null check for `paths` in the original tsconfig before modifying it.
+- Enhanced testing by adding a test case for creating a TsPublish instance.
+
+## 2024-10-28 - 1.5.0 - feat(classes.publishmodule)
+Add method to create and write tsconfig.json during publish module setup
+
+- Introduced createTsconfigJson method in PublishModule class to generate a tsconfig.json for each publishable module.
+- Modified createPublishModuleDir method to include writing of tsconfig.json file.
+
+## 2024-10-26 - 1.4.0 - feat(core)
+Refactor directory reading and module discovery for publishing process
+
+- Renamed 'readDirectory' method to 'getModuleSubDirs' for clarity in describing function purpose.
+- Enhanced 'getModuleSubDirs' to return module information including parsed 'tspublish.json' data for each module.
+- Introduced new 'interfaces' directory to define TypeScript interfaces like 'ITsPublishJson'.
+
+## 2024-10-23 - 1.3.3 - fix(core)
+Fix logging mechanism on existing package version check
+
+- Changed the error handling mechanism when a package with the same version already exists to use logger and process exit instead of throwing an error.
+
+## 2024-10-23 - 1.3.2 - fix(core)
+Corrected file patterns in dynamically created package.json files.
+
+- Fixed incorrect file pattern from 'ts_web/**/*' to 'ts_*/**/*' in package.json creation process to include all subdirectories starting with 'ts'.
+
+## 2024-10-23 - 1.3.1 - fix(classes.publishmodule)
+Fix template string in createPackageJson method for export path
+
+- Corrected the syntax for template string in the exports path of created package.json
+
+## 2024-10-21 - 1.3.0 - feat(core)
+Add support for multiple registries in the publish process
+
+- Updated the PublishModule class to handle multiple registries for publishing.
+- Refactored the handling of tspublish.json by incorporating it into the PublishModule options.
+- Implemented logic to parse registry access level and apply it during publication.
+
+## 2024-10-21 - 1.2.4 - fix(publishmodule)
+Fix syntax errors and improve formatting in classes.publishmodule.ts
+
+- Fixed missing semicolons in multiple locations for improved syntax correctness.
+- Improved the formatting for better code readability.
+- Added --no-git-checks flag to the pnpm publish command.
+
+## 2024-10-21 - 1.2.3 - fix(logs)
+Improve logging mechanism with structured logs for publish process
+
+- Enhanced log messages to provide more clarity during module publishing.
+- Ensured logging captures steps of publish and init process in TsPublish and PublishModule classes respectively.
+
+## 2024-10-21 - 1.2.3 - fix(classes.publishmodule)
+Add missing 'type: module' to dynamically generated package.json
+
+- Ensure that the 'type: module' field is included in each dynamically generated package.json file for consistent module handling.
+
+## 2024-10-21 - 1.2.3 - fix(classes.publishmodule)
+Add missing 'type: module' to dynamically generated package.json
+
+- Ensure that the 'type: module' field is included in each dynamically generated package.json file for consistent module handling.
+
+## 2024-10-21 - 1.2.2 - fix(publishmodule)
+Fix bug in package.json creation for publish module
+
+- Fixed an issue where `package.json` was not being written to the publish module directory.
+
 ## 2024-10-21 - 1.2.1 - fix(package.json)
 Ensure bin field is properly restructured
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@git.zone/tspublish",
-  "version": "1.2.1",
+  "version": "1.5.5",
   "private": false,
   "description": "A tool to publish multiple, concise, and small packages from monorepos, specifically for TypeScript projects within a git environment.",
   "main": "dist_ts/index.js",
@@ -22,7 +22,7 @@
     "@git.zone/tsrun": "^1.2.46",
     "@git.zone/tstest": "^1.0.44",
     "@push.rocks/tapbundle": "^5.0.15",
-    "@types/node": "^22.7.6"
+    "@types/node": "^22.7.7"
   },
   "repository": {
     "type": "git",
@@ -49,6 +49,7 @@
   ],
   "dependencies": {
     "@push.rocks/smartcli": "^4.0.11",
+    "@push.rocks/smartdelay": "^3.0.5",
     "@push.rocks/smartfile": "^11.0.21",
     "@push.rocks/smartlog": "^3.0.7",
     "@push.rocks/smartnpm": "^2.0.4",

test/test.ts

@@ -5,4 +5,9 @@ tap.test('first test', async () => {
   console.log(tspublish);
 });
 
+tap.test('should create a TsPublish instance', async () => {
+  const tspublishInstance = new tspublish.TsPublish();
+  expect(tspublishInstance).toBeTruthy();
+});
+
 tap.start();

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@git.zone/tspublish',
-  version: '1.2.1',
+  version: '1.5.5',
   description: 'A tool to publish multiple, concise, and small packages from monorepos, specifically for TypeScript projects within a git environment.'
 }

ts/classes.publishmodule.ts

@@ -2,10 +2,17 @@ import * as plugins from './plugins.js';
 import * as paths from './paths.js';
 import { logger } from './logging.js';
 
+export interface ITsPublishJson {
+  name: string;
+  dependencies: string[];
+  registries: string[];
+}
+
 export interface IPublishModuleOptions {
   monoRepoDir: string;
   packageSubFolder: string;
   packageSubFolderFullPath?: string;
+  tsPublishJson?: ITsPublishJson;
   publishModDirFullPath?: string;
   name?: string;
   version?: string;
@@ -28,35 +35,40 @@ export class PublishModule {
     if (!this.options.packageSubFolder.startsWith('ts')) {
       throw new Error('subFolder must start with "ts"');
     }
-    const jsonData = plugins.smartfile.fs.toObjectSync(
+    this.options.tsPublishJson = plugins.smartfile.fs.toObjectSync(
       plugins.path.join(this.options.packageSubFolderFullPath, 'tspublish.json')
     );
     const monoRepoPackageJson = JSON.parse(
       plugins.smartfile.fs.toStringSync(plugins.path.join(this.options.monoRepoDir, 'package.json'))
-    )
+    );
     this.options.dependencies = {
       ...this.options.dependencies,
       ...(() => {
         const resultDependencies = {};
-        for (const dependency of jsonData.dependencies) {
+        for (const dependency of this.options.tsPublishJson.dependencies) {
           resultDependencies[dependency] = monoRepoPackageJson.dependencies[dependency];
         }
         return resultDependencies;
-      })()
+      })(),
     };
-    this.options.name = this.options.name || jsonData.name;
+    this.options.name = this.options.name || this.options.tsPublishJson.name;
     this.options.version = monoRepoPackageJson.version;
 
     // now that we have a name and version, lets check if there is already a package under the same name and version.
     const smartnpmInstance = new plugins.smartnpm.NpmRegistry({}); // TODO: pass in options
-    const packageInfo = await smartnpmInstance.getPackageInfo(this.options.name);
+    let packageInfo: plugins.smartnpm.NpmPackage;
+    try {
+      packageInfo = await smartnpmInstance.getPackageInfo(this.options.name);
+    } catch (error) {
+      logger.log('warn', `package does not yet seem to exist. Proceeding in 10 seconds...`);
+      await plugins.smartdelay.delayFor(10000);
+    }
     if (packageInfo) {
       const availableVersions = packageInfo.allVersions.map((versionArg) => versionArg.version);
       logger.log('info', `available versions are: ${availableVersions.toString()}`);
       if (availableVersions.includes(this.options.version)) {
-        throw new Error(
-          `package ${this.options.name} already exists with version ${this.options.version}`
-        );
+        logger.log('error', `package ${this.options.name} already exists with version ${this.options.version}`);
+        process.exit(1);
       }
     }
   }
@@ -70,14 +82,42 @@ export class PublishModule {
     return packageInfo.allVersions[0].version;
   }
 
+  public async createTsconfigJson() {
+    const originalTsConfig = plugins.smartfile.fs.toObjectSync(
+      plugins.path.join(paths.cwd, 'tsconfig.json')
+    );
+    if (originalTsConfig?.compilerOptions?.paths) {
+      for (const path of Object.keys(originalTsConfig.compilerOptions.paths)) {
+        originalTsConfig.compilerOptions.paths[path][0] = `.${originalTsConfig.compilerOptions.paths[path][0]}`;
+      }
+    }
+    const tsconfigJson = {
+      compilerOptions: {
+        experimentalDecorators: true,
+        useDefineForClassFields: false,
+        target: 'ES2022',
+        module: 'NodeNext',
+        moduleResolution: 'NodeNext',
+        esModuleInterop: true,
+        verbatimModuleSyntax: true,
+        paths: originalTsConfig?.compilerOptions?.paths,
+      },
+      exclude: [
+        'dist_*/**/*.d.ts',
+      ],
+    };
+    return JSON.stringify(tsconfigJson, null, 2);
+  }
+
   public async createPackageJson() {
     const packageJson = {
       name: this.options.name,
       version: this.options.version,
+      type: 'module',
       description: '',
       exports: {
         '.': {
-          import: './dist_${this.options.packageSubFolder}/index.js',
+          import: `./dist_${this.options.packageSubFolder}/index.js`,
         },
       },
       scripts: {
@@ -87,6 +127,18 @@ export class PublishModule {
       devDependencies: {
         '@git.zone/tsbuild': await this.getLatestVersionOfPackage('@git.zone/tsbuild'),
       },
+      files: [
+        'ts/**/*',
+        'ts_*/**/*',
+        'dist/**/*',
+        'dist_*/**/*',
+        'dist_ts/**/*',
+        'dist_ts_web/**/*',
+        'assets/**/*',
+        'cli.js',
+        'npmextra.json',
+        'readme.md',
+      ],
     };
     return JSON.stringify(packageJson, null, 2);
   }
@@ -96,30 +148,51 @@ export class PublishModule {
       this.options.monoRepoDir,
       `dist_publish_${this.options.packageSubFolder}`
     );
-    
-    // package.json
     await plugins.smartfile.fs.ensureEmptyDir(this.options.publishModDirFullPath);
+
+    // package.json
     const packageJson = await plugins.smartfile.SmartFile.fromString(
       plugins.path.join(this.options.publishModDirFullPath, 'package.json'),
       await this.createPackageJson(),
       'utf8'
     );
+    await packageJson.write();
+
+    // tsconfig.json
+    const originalTsConfigJson = await plugins.smartfile.SmartFile.fromString(
+      plugins.path.join(this.options.publishModDirFullPath, 'tsconfig.json'),
+      await this.createTsconfigJson(),
+      'utf8'
+    );
+    await originalTsConfigJson.write();
 
     // ts folder
-    await plugins.smartfile.fs.copy(this.options.packageSubFolderFullPath, plugins.path.join(this.options.publishModDirFullPath, this.options.packageSubFolder)) 
+    await plugins.smartfile.fs.copy(
+      this.options.packageSubFolderFullPath,
+      plugins.path.join(this.options.publishModDirFullPath, this.options.packageSubFolder)
+    );
   }
 
   public async build() {
     const smartshellInstance = new plugins.smartshell.Smartshell({
       executor: 'bash',
-    })
+    });
     await smartshellInstance.exec(`cd ${this.options.publishModDirFullPath} && pnpm run build`);
   }
 
   public async publish() {
     const smartshellInstance = new plugins.smartshell.Smartshell({
       executor: 'bash',
-    })
-    await smartshellInstance.exec(`cd ${this.options.publishModDirFullPath} && pnpm publish`);
+    });
+    for (const registry of this.options.tsPublishJson.registries) {
+      const registryArray = registry.split(':');
+      const registryUrl = registryArray[0];
+      const registryAccessLevel = registryArray[1];
+      await smartshellInstance.exec(
+        `cd ${this.options.publishModDirFullPath} && pnpm publish ${
+          registryAccessLevel === 'public' ? '--access public' : ''
+        } --no-git-checks --registry https://${registryUrl}`
+      );
+    }
   }
 }

ts/classes.tspublish.ts

@@ -1,5 +1,6 @@
 import { logger } from './logging.js';
 import * as plugins from './plugins.js';
+import * as interfaces from './interfaces/index.js';
 
 import { PublishModule } from './classes.publishmodule.js';
 
@@ -7,8 +8,12 @@ export class TsPublish {
   constructor() {}
 
   public async publish (monorepoDirArg: string) {
-    const publishModules = await this.readDirectory(monorepoDirArg);
-    for (const publishModule of publishModules) {
+    const publishModules = await this.getModuleSubDirs(monorepoDirArg);
+    logger.log('info', `Found ${Object.keys(publishModules).length} publish modules:`);
+    for (const publishModule of Object.keys(publishModules)) {
+      logger.log('info', `Publishing module: ${publishModule} -> ${publishModules[publishModule].name}`);
+    }
+    for (const publishModule of Object.keys(publishModules)) {
       const publishModuleInstance = new PublishModule({
         monoRepoDir: monorepoDirArg,
         packageSubFolder: publishModule,
@@ -20,9 +25,9 @@ export class TsPublish {
     }
   }
 
-  public async readDirectory (dirArg: string) {
+  public async getModuleSubDirs (dirArg: string) {
     const subDirs = await plugins.smartfile.fs.listFolders(dirArg);
-    const publishModules: string[] = [];
+    const publishModules: {[key: string]: interfaces.ITsPublishJson} = {};
     for (const subDir of subDirs) {
       if (!subDir.startsWith('ts')) {
         continue;
@@ -33,7 +38,7 @@ export class TsPublish {
         continue;
       }
       logger.log('info', `found publish module: ${subDir}`);
-      publishModules.push(subDir);
+      publishModules[subDir] = JSON.parse(plugins.smartfile.fs.toStringSync(plugins.path.join(subDir, 'tspublish.json')));
     }
     logger.log('ok', `found ${publishModules.length} publish modules`);
     return publishModules;

ts/index.ts

@@ -4,6 +4,7 @@ import { TsPublish } from './classes.tspublish.js';
 export * from './classes.tspublish.js'
 
 export const runCli = async () => {
+  console.log('Starting tspublish...');
   const tspublish = new TsPublish();
   await tspublish.publish(paths.cwd);
 }

ts/interfaces/index.ts

@@ -0,0 +1 @@
+export * from './tspublish.js';

ts/interfaces/tspublish.ts

@@ -0,0 +1,5 @@
+export interface ITsPublishJson {
+  name: string;
+  dependencies: string[];
+  registries: string[];
+}

ts/logging.ts

@@ -1,4 +1,5 @@
 import * as plugins from './plugins.js';
 import * as commitinfo from './00_commitinfo_data.js';
 
-export const logger = plugins.smartlog.Smartlog.createForCommitinfo(commitinfo.commitinfo);
+export const logger = plugins.smartlog.Smartlog.createForCommitinfo(commitinfo.commitinfo);
+logger.enableConsole();

ts/plugins.ts

@@ -7,9 +7,10 @@ export {
 // @push.rocks scope
 import * as smartfile from '@push.rocks/smartfile';
 import * as smartcli from '@push.rocks/smartcli';
+import * as smartdelay from '@push.rocks/smartdelay';
 import * as smartlog from '@push.rocks/smartlog';
 import * as smartnpm from '@push.rocks/smartnpm';
 import * as smartpath from '@push.rocks/smartpath';
 import * as smartshell from '@push.rocks/smartshell';
 
-export { smartfile, smartcli, smartlog, smartnpm, smartpath, smartshell };
+export { smartfile, smartcli, smartdelay, smartlog, smartnpm, smartpath, smartshell };