16 Commits

12 changed files with 534 additions and 273 deletions

@@ -1,5 +1,52 @@
# Changelog
## 2024-11-05 - 1.7.1 - fix(core)
Implement error handling for missing publish module directories
- Improved logging for package publish steps
- Enhanced CLI feedback messages during the publishing process
- Restructured package.json to ensure proper dependencies are published
## 2024-11-05 - 1.7.0 - feat(core)
Enhanced tspublish with ordered compilation and updated dependencies
- Added 'order' property to ITsPublishJson interface to ensure project compilation order.
- Updated development dependencies: @git.zone/tsbuild, @git.zone/tsbundle, @git.zone/tsrun, and @types/node.
## 2024-10-28 - 1.6.0 - feat(classes.publishmodule)
Added copying of readme and license files to publish directory
- Enhanced the createPublishModuleDir method in PublishModule class to copy the 'readme.md' and 'license' files to the publish directory.
## 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

@@ -1,6 +1,6 @@
{
"name": "@git.zone/tspublish",
"version": "1.5.0",
"version": "1.7.1",
"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",
@@ -17,12 +17,12 @@
"tspublish": "cli.js"
},
"devDependencies": {
"@git.zone/tsbuild": "^2.1.25",
"@git.zone/tsbundle": "^2.0.5",
"@git.zone/tsrun": "^1.2.46",
"@git.zone/tsbuild": "^2.1.85",
"@git.zone/tsbundle": "^2.1.0",
"@git.zone/tsrun": "^1.3.3",
"@git.zone/tstest": "^1.0.44",
"@push.rocks/tapbundle": "^5.0.15",
"@types/node": "^22.7.7"
"@types/node": "^22.8.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",

695
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

@@ -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();

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

@@ -56,7 +56,13 @@ export class PublishModule {
// 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()}`);
@@ -80,8 +86,10 @@ export class PublishModule {
const originalTsConfig = plugins.smartfile.fs.toObjectSync(
plugins.path.join(paths.cwd, 'tsconfig.json')
);
for (const path of originalTsConfig.compilerOptions.paths) {
originalTsConfig.compilerOptions.paths[path][0] = `.${originalTsConfig.compilerOptions.paths[path][0]}`;
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: {
@@ -92,7 +100,7 @@ export class PublishModule {
moduleResolution: 'NodeNext',
esModuleInterop: true,
verbatimModuleSyntax: true,
paths: originalTsConfig.compilerOptions.paths,
paths: originalTsConfig?.compilerOptions?.paths,
},
exclude: [
'dist_*/**/*.d.ts',
@@ -140,9 +148,9 @@ export class PublishModule {
this.options.monoRepoDir,
`dist_publish_${this.options.packageSubFolder}`
);
await plugins.smartfile.fs.ensureEmptyDir(this.options.publishModDirFullPath);
// package.json
await plugins.smartfile.fs.ensureEmptyDir(this.options.publishModDirFullPath);
const packageJson = await plugins.smartfile.SmartFile.fromString(
plugins.path.join(this.options.publishModDirFullPath, 'package.json'),
await this.createPackageJson(),
@@ -163,6 +171,18 @@ export class PublishModule {
this.options.packageSubFolderFullPath,
plugins.path.join(this.options.publishModDirFullPath, this.options.packageSubFolder)
);
// readme
await plugins.smartfile.fs.copy(
plugins.path.join(this.options.packageSubFolderFullPath, 'readme.md'),
plugins.path.join(this.options.publishModDirFullPath, 'readme.md')
);
// license
await plugins.smartfile.fs.copy(
plugins.path.join(this.options.monoRepoDir, 'license'),
plugins.path.join(this.options.publishModDirFullPath, 'license')
);
}
public async build() {

@@ -9,6 +9,10 @@ export class TsPublish {
public async publish (monorepoDirArg: string) {
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,

@@ -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);
}

@@ -1,4 +1,8 @@
export interface ITsPublishJson {
/**
* the order assures that a project is compiled before another project
*/
order: number;
name: string;
dependencies: string[];
registries: string[];

@@ -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();

@@ -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 };

@@ -6,7 +6,7 @@
"module": "NodeNext",
"moduleResolution": "NodeNext",
"esModuleInterop": true,
"verbatimModuleSyntax": true
"verbatimModuleSyntax": true,
},
"exclude": [
"dist_*/**/*.d.ts"