22 Commits

Author SHA1 Message Date
1ea207cda1 1.5.4
Some checks failed
Default (tags) / security (push) Failing after 0s
Default (tags) / test (push) Failing after 0s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2024-10-28 01:36:24 +01:00
ff365ee508 fix(core): Fix issues with path keys in tsconfig and logger setup in logging.ts. 2024-10-28 01:36:24 +01:00
a3226efd9a 1.5.3
Some checks failed
Default (tags) / security (push) Failing after 0s
Default (tags) / test (push) Failing after 0s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2024-10-28 01:30:40 +01:00
f74a6bf2ad fix(core): Fix incorrect logging and directory preparation 2024-10-28 01:30:39 +01:00
d47ac4793d 1.5.2
Some checks failed
Default (tags) / security (push) Failing after 2s
Default (tags) / test (push) Failing after 1s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2024-10-28 01:27:01 +01:00
9a89b63cf9 fix(core): Add logging for found publish modules 2024-10-28 01:27:00 +01:00
4ee31f85ab 1.5.1
Some checks failed
Default (tags) / security (push) Failing after 0s
Default (tags) / test (push) Failing after 0s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2024-10-28 01:24:52 +01:00
2b518722df fix(core): Fixes handling of undefined paths in tsconfig generation. 2024-10-28 01:24:52 +01:00
5f9bd73904 1.5.0
Some checks failed
Default (tags) / security (push) Failing after 2s
Default (tags) / test (push) Failing after 0s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2024-10-28 01:21:06 +01:00
91f3c90607 feat(classes.publishmodule): Add method to create and write tsconfig.json during publish module setup 2024-10-28 01:21:06 +01:00
f518670443 1.4.0
Some checks failed
Default (tags) / security (push) Failing after 0s
Default (tags) / test (push) Failing after 1s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2024-10-26 14:08:23 +02:00
dc97693ec8 feat(core): Refactor directory reading and module discovery for publishing process 2024-10-26 14:08:23 +02:00
386504b0fb 1.3.3
Some checks failed
Default (tags) / security (push) Failing after 0s
Default (tags) / test (push) Failing after 4s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2024-10-23 15:59:26 +02:00
a7c631bba1 fix(core): Fix logging mechanism on existing package version check 2024-10-23 15:59:26 +02:00
5922249742 1.3.2
Some checks failed
Default (tags) / security (push) Failing after 4s
Default (tags) / test (push) Failing after 1s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2024-10-23 15:49:22 +02:00
274b730492 fix(core): Corrected file patterns in dynamically created package.json files. 2024-10-23 15:49:22 +02:00
5bdc3e8bcc 1.3.1
Some checks failed
Default (tags) / security (push) Failing after 1s
Default (tags) / test (push) Failing after 0s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2024-10-23 15:48:32 +02:00
5389034108 fix(classes.publishmodule): Fix template string in createPackageJson method for export path 2024-10-23 15:48:32 +02:00
a656e3e040 1.3.0
Some checks failed
Default (tags) / security (push) Failing after 3s
Default (tags) / test (push) Failing after 2s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2024-10-21 16:01:08 +02:00
819c1dca0f feat(core): Add support for multiple registries in the publish process 2024-10-21 16:01:08 +02:00
f3d641d1c1 1.2.4
Some checks failed
Default (tags) / security (push) Failing after 2s
Default (tags) / test (push) Failing after 2s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2024-10-21 14:51:12 +02:00
1fd74928c5 fix(publishmodule): Fix syntax errors and improve formatting in classes.publishmodule.ts 2024-10-21 14:51:12 +02:00
11 changed files with 3237 additions and 4150 deletions

View File

@ -1,5 +1,71 @@
# Changelog # Changelog
## 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) ## 2024-10-21 - 1.2.3 - fix(logs)
Improve logging mechanism with structured logs for publish process Improve logging mechanism with structured logs for publish process

View File

@ -1,6 +1,6 @@
{ {
"name": "@git.zone/tspublish", "name": "@git.zone/tspublish",
"version": "1.2.3", "version": "1.5.4",
"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",

7192
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

View File

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

View File

@ -3,6 +3,6 @@
*/ */
export const commitinfo = { export const commitinfo = {
name: '@git.zone/tspublish', name: '@git.zone/tspublish',
version: '1.2.3', version: '1.5.4',
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.'
} }

View File

@ -2,10 +2,17 @@ import * as plugins from './plugins.js';
import * as paths from './paths.js'; import * as paths from './paths.js';
import { logger } from './logging.js'; import { logger } from './logging.js';
export interface ITsPublishJson {
name: string;
dependencies: string[];
registries: string[];
}
export interface IPublishModuleOptions { export interface IPublishModuleOptions {
monoRepoDir: string; monoRepoDir: string;
packageSubFolder: string; packageSubFolder: string;
packageSubFolderFullPath?: string; packageSubFolderFullPath?: string;
tsPublishJson?: ITsPublishJson;
publishModDirFullPath?: string; publishModDirFullPath?: string;
name?: string; name?: string;
version?: string; version?: string;
@ -28,23 +35,23 @@ export class PublishModule {
if (!this.options.packageSubFolder.startsWith('ts')) { if (!this.options.packageSubFolder.startsWith('ts')) {
throw new Error('subFolder must start with "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') plugins.path.join(this.options.packageSubFolderFullPath, 'tspublish.json')
); );
const monoRepoPackageJson = JSON.parse( const monoRepoPackageJson = JSON.parse(
plugins.smartfile.fs.toStringSync(plugins.path.join(this.options.monoRepoDir, 'package.json')) plugins.smartfile.fs.toStringSync(plugins.path.join(this.options.monoRepoDir, 'package.json'))
) );
this.options.dependencies = { this.options.dependencies = {
...this.options.dependencies, ...this.options.dependencies,
...(() => { ...(() => {
const resultDependencies = {}; const resultDependencies = {};
for (const dependency of jsonData.dependencies) { for (const dependency of this.options.tsPublishJson.dependencies) {
resultDependencies[dependency] = monoRepoPackageJson.dependencies[dependency]; resultDependencies[dependency] = monoRepoPackageJson.dependencies[dependency];
} }
return resultDependencies; 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; 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. // now that we have a name and version, lets check if there is already a package under the same name and version.
@ -54,9 +61,8 @@ export class PublishModule {
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()}`);
if (availableVersions.includes(this.options.version)) { if (availableVersions.includes(this.options.version)) {
throw new Error( logger.log('error', `package ${this.options.name} already exists with version ${this.options.version}`);
`package ${this.options.name} already exists with version ${this.options.version}` process.exit(1);
);
} }
} }
} }
@ -70,6 +76,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,
@ -78,7 +111,7 @@ export class PublishModule {
description: '', description: '',
exports: { exports: {
'.': { '.': {
import: './dist_${this.options.packageSubFolder}/index.js', import: `./dist_${this.options.packageSubFolder}/index.js`,
}, },
}, },
scripts: { scripts: {
@ -88,6 +121,18 @@ export class PublishModule {
devDependencies: { devDependencies: {
'@git.zone/tsbuild': await this.getLatestVersionOfPackage('@git.zone/tsbuild'), '@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); return JSON.stringify(packageJson, null, 2);
} }
@ -97,9 +142,9 @@ export class PublishModule {
this.options.monoRepoDir, this.options.monoRepoDir,
`dist_publish_${this.options.packageSubFolder}` `dist_publish_${this.options.packageSubFolder}`
); );
// package.json
await plugins.smartfile.fs.ensureEmptyDir(this.options.publishModDirFullPath); await plugins.smartfile.fs.ensureEmptyDir(this.options.publishModDirFullPath);
// package.json
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(),
@ -107,21 +152,41 @@ 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(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() { public async build() {
const smartshellInstance = new plugins.smartshell.Smartshell({ const smartshellInstance = new plugins.smartshell.Smartshell({
executor: 'bash', executor: 'bash',
}) });
await smartshellInstance.exec(`cd ${this.options.publishModDirFullPath} && pnpm run build`); await smartshellInstance.exec(`cd ${this.options.publishModDirFullPath} && pnpm run build`);
} }
public async publish() { public async publish() {
const smartshellInstance = new plugins.smartshell.Smartshell({ const smartshellInstance = new plugins.smartshell.Smartshell({
executor: 'bash', 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}`
);
}
} }
} }

View File

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

View File

@ -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
View File

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

View File

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

View File

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