14 Commits

12 changed files with 3182 additions and 4138 deletions

@@ -1,5 +1,47 @@
# Changelog # 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) ## 2024-10-23 - 1.3.3 - fix(core)
Fix logging mechanism on existing package version check Fix logging mechanism on existing package version check

@@ -1,6 +1,6 @@
{ {
"name": "@git.zone/tspublish", "name": "@git.zone/tspublish",
"version": "1.3.3", "version": "1.5.5",
"private": false, "private": false,
"description": "A tool to publish multiple, concise, and small packages from monorepos, specifically for TypeScript projects within a git environment.", "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", "main": "dist_ts/index.js",
@@ -49,6 +49,7 @@
], ],
"dependencies": { "dependencies": {
"@push.rocks/smartcli": "^4.0.11", "@push.rocks/smartcli": "^4.0.11",
"@push.rocks/smartdelay": "^3.0.5",
"@push.rocks/smartfile": "^11.0.21", "@push.rocks/smartfile": "^11.0.21",
"@push.rocks/smartlog": "^3.0.7", "@push.rocks/smartlog": "^3.0.7",
"@push.rocks/smartnpm": "^2.0.4", "@push.rocks/smartnpm": "^2.0.4",

7195
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); console.log(tspublish);
}); });
tap.test('should create a TsPublish instance', async () => {
const tspublishInstance = new tspublish.TsPublish();
expect(tspublishInstance).toBeTruthy();
});
tap.start(); tap.start();

@@ -3,6 +3,6 @@
*/ */
export const commitinfo = { export const commitinfo = {
name: '@git.zone/tspublish', name: '@git.zone/tspublish',
version: '1.3.3', version: '1.5.5',
description: 'A tool to publish multiple, concise, and small packages from monorepos, specifically for TypeScript projects within a git environment.' 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. // 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 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) { if (packageInfo) {
const availableVersions = packageInfo.allVersions.map((versionArg) => versionArg.version); const availableVersions = packageInfo.allVersions.map((versionArg) => versionArg.version);
logger.log('info', `available versions are: ${availableVersions.toString()}`); logger.log('info', `available versions are: ${availableVersions.toString()}`);
@@ -76,6 +82,33 @@ export class PublishModule {
return packageInfo.allVersions[0].version; 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() { public async createPackageJson() {
const packageJson = { const packageJson = {
name: this.options.name, name: this.options.name,
@@ -115,9 +148,9 @@ export class PublishModule {
this.options.monoRepoDir, this.options.monoRepoDir,
`dist_publish_${this.options.packageSubFolder}` `dist_publish_${this.options.packageSubFolder}`
); );
await plugins.smartfile.fs.ensureEmptyDir(this.options.publishModDirFullPath);
// package.json // package.json
await plugins.smartfile.fs.ensureEmptyDir(this.options.publishModDirFullPath);
const packageJson = await plugins.smartfile.SmartFile.fromString( const packageJson = await plugins.smartfile.SmartFile.fromString(
plugins.path.join(this.options.publishModDirFullPath, 'package.json'), plugins.path.join(this.options.publishModDirFullPath, 'package.json'),
await this.createPackageJson(), await this.createPackageJson(),
@@ -125,6 +158,14 @@ export class PublishModule {
); );
await packageJson.write(); 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 // ts folder
await plugins.smartfile.fs.copy( await plugins.smartfile.fs.copy(
this.options.packageSubFolderFullPath, this.options.packageSubFolderFullPath,

@@ -1,5 +1,6 @@
import { logger } from './logging.js'; import { logger } from './logging.js';
import * as plugins from './plugins.js'; import * as plugins from './plugins.js';
import * as interfaces from './interfaces/index.js';
import { PublishModule } from './classes.publishmodule.js'; import { PublishModule } from './classes.publishmodule.js';
@@ -7,8 +8,12 @@ export class TsPublish {
constructor() {} constructor() {}
public async publish (monorepoDirArg: string) { public async publish (monorepoDirArg: string) {
const publishModules = await this.readDirectory(monorepoDirArg); const publishModules = await this.getModuleSubDirs(monorepoDirArg);
for (const publishModule of publishModules) { 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({ const publishModuleInstance = new PublishModule({
monoRepoDir: monorepoDirArg, monoRepoDir: monorepoDirArg,
packageSubFolder: publishModule, 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 subDirs = await plugins.smartfile.fs.listFolders(dirArg);
const publishModules: string[] = []; const publishModules: {[key: string]: interfaces.ITsPublishJson} = {};
for (const subDir of subDirs) { for (const subDir of subDirs) {
if (!subDir.startsWith('ts')) { if (!subDir.startsWith('ts')) {
continue; continue;
@@ -33,7 +38,7 @@ export class TsPublish {
continue; continue;
} }
logger.log('info', `found publish module: ${subDir}`); 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`); logger.log('ok', `found ${publishModules.length} publish modules`);
return publishModules; return publishModules;

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

1
ts/interfaces/index.ts Normal file

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

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

@@ -1,4 +1,5 @@
import * as plugins from './plugins.js'; import * as plugins from './plugins.js';
import * as commitinfo from './00_commitinfo_data.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 // @push.rocks scope
import * as smartfile from '@push.rocks/smartfile'; import * as smartfile from '@push.rocks/smartfile';
import * as smartcli from '@push.rocks/smartcli'; import * as smartcli from '@push.rocks/smartcli';
import * as smartdelay from '@push.rocks/smartdelay';
import * as smartlog from '@push.rocks/smartlog'; import * as smartlog from '@push.rocks/smartlog';
import * as smartnpm from '@push.rocks/smartnpm'; import * as smartnpm from '@push.rocks/smartnpm';
import * as smartpath from '@push.rocks/smartpath'; import * as smartpath from '@push.rocks/smartpath';
import * as smartshell from '@push.rocks/smartshell'; import * as smartshell from '@push.rocks/smartshell';
export { smartfile, smartcli, smartlog, smartnpm, smartpath, smartshell }; export { smartfile, smartcli, smartdelay, smartlog, smartnpm, smartpath, smartshell };