Compare commits

..

No commits in common. "master" and "v1.7.6" have entirely different histories.

10 changed files with 3209 additions and 4474 deletions

View File

@ -1,31 +1,5 @@
# Changelog # Changelog
## 2025-01-02 - 1.9.1 - fix(publishmodule)
Fix incorrect CLI script path during publish module creation
- Updated the `createBinCliSetup` method to correctly adjust the CLI script path.
- Replaced path in base64-decoded CLI file content from './dist_ts/index.js' to './dist_<packageSubFolder>/index.js'.
## 2025-01-02 - 1.9.0 - feat(core)
Refactor gitea asset handling and module initialization
- Introduced GiteaAssets class to handle gitea asset fetching.
- Updated TsPublish and PublishModule classes to use GiteaAssets.
- Fixed queryParams in getFiles method of GiteaAssets.
## 2025-01-01 - 1.8.0 - feat(core)
Added GiteaAssets class for managing files in Gitea repositories
- Introduced GiteaAssets class to handle file retrieval from Gitea repositories.
- Added tests for GiteaAssets implementation.
- Updated plugins module to include smartrequest for HTTP requests.
## 2024-11-05 - 1.7.7 - fix(core)
Fix dependency resolution in package initialization
- Corrected the resolution of dependencies from tspublish.json against monorepo's package.json.
- Ensures unlisted dependencies in monorepo's package.json default to its version.
## 2024-11-05 - 1.7.6 - fix(tspublish) ## 2024-11-05 - 1.7.6 - fix(tspublish)
Fix the logging of the number of found publish modules Fix the logging of the number of found publish modules

View File

@ -1,6 +1,6 @@
{ {
"name": "@git.zone/tspublish", "name": "@git.zone/tspublish",
"version": "1.9.1", "version": "1.7.6",
"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",
@ -14,7 +14,7 @@
"buildDocs": "(tsdoc)" "buildDocs": "(tsdoc)"
}, },
"bin": { "bin": {
"tspublish": "./cli.js" "tspublish": "cli.js"
}, },
"devDependencies": { "devDependencies": {
"@git.zone/tsbuild": "^2.1.85", "@git.zone/tsbuild": "^2.1.85",
@ -54,7 +54,6 @@
"@push.rocks/smartlog": "^3.0.7", "@push.rocks/smartlog": "^3.0.7",
"@push.rocks/smartnpm": "^2.0.4", "@push.rocks/smartnpm": "^2.0.4",
"@push.rocks/smartpath": "^5.0.18", "@push.rocks/smartpath": "^5.0.18",
"@push.rocks/smartrequest": "^2.0.23",
"@push.rocks/smartshell": "^3.0.6" "@push.rocks/smartshell": "^3.0.6"
}, },
"keywords": [ "keywords": [

7320
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

View File

@ -1,39 +0,0 @@
import { expect, tap } from '@push.rocks/tapbundle';
import * as giteaAssets from '../ts/classes.giteaassets.js';
let giteaAssetsInstance: giteaAssets.GiteaAssets;
tap.test('should create a GiteaAssets instance', async () => {
giteaAssetsInstance = new giteaAssets.GiteaAssets({
giteaBaseUrl: 'https://code.foss.global',
});
expect(giteaAssetsInstance).toBeInstanceOf(giteaAssets.GiteaAssets);
});
tap.test('should get files from a repository', async () => {
const files = await giteaAssetsInstance.getFiles('git.zone', 'cli', 'assets/templates/cli');
console.log(files);
for (const file of files) {
if (file.name.endsWith('cli.js')) {
console.log(atob(file.base64Content));
}
}
expect(files).toBeTruthy();
});
tap.test('should get files from a repository', async () => {
const files = await giteaAssetsInstance.getFiles('git.zone', 'cli', 'assets/templates/cli/cli.js');
console.log(files);
for (const file of files) {
if (file.name.endsWith('cli.js')) {
console.log(atob(file.base64Content));
}
}
expect(files).toBeTruthy();
});
tap.start();

View File

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

@ -1,103 +0,0 @@
import * as plugins from './plugins.js';
interface IRepoFile {
name: string;
path: string;
type: 'file' | 'dir';
download_url: string | null;
base64Content: string | null;
encoding: string | null;
}
interface IGiteaAssetsOptions {
giteaBaseUrl: string; // Base URL of your Gitea instance
token?: string; // Optional token for private repositories
}
export class GiteaAssets {
private baseUrl: string;
private headers: {[key: string]: string} = {};
constructor(options: IGiteaAssetsOptions) {
this.baseUrl = options.giteaBaseUrl
if (this.baseUrl.endsWith('/')) {
this.baseUrl = this.baseUrl.slice(0, -1);
}
this.baseUrl += '/api/v1';
this.headers = options.token
? { ...this.headers, 'Authorization': `token ${options.token}` }
: this.headers;
}
/**
* Get all files in a directory of a repository
* @param owner - Repository owner
* @param repo - Repository name
* @param directory - Directory path ('' for root)
* @param branch - Branch name (optional)
* @returns A list of files in the directory
*/
async getFiles(
owner: string,
repo: string,
directory: string,
branch?: string
): Promise<IRepoFile[]> {
try {
const response = await plugins.smartrequest.request(
this.baseUrl + `/repos/${owner}/${repo}/contents/${directory}`,
{
headers: this.headers,
method: 'GET',
queryParams: branch ? { ref: branch } : {},
}
)
if (!Array.isArray(response.body) && typeof response.body === 'object') {
response.body = [response.body];
} else if (Array.isArray(response.body)) {
for (const entry of response.body) {
if (entry.type === 'dir') {
continue;
} else if (entry.type === 'file') {
const response2 = await plugins.smartrequest.request(
this.baseUrl + `/repos/${owner}/${repo}/contents/${entry.path}`,
{
headers: this.headers,
method: 'GET',
queryParams: branch ? { ref: branch } : {},
}
);
entry.encoding = response2.body.encoding;
entry.content = response2.body.content;
}
}
}
// lets map to the IRepoFile interface
response.body = response.body.map((entry: any) => {
return {
name: entry.name,
path: entry.path,
type: entry.type,
download_url: entry.download_url,
base64Content: entry.content,
encoding: entry.encoding,
};
});
return response.body;
} catch (error) {
console.error('Error fetching repository files:', error);
throw error;
}
}
/**
* gets the current cli entry file from the code.foss.global/git.zone/cli repository
* @returns
*/
public async getBinCliEntryFile() {
const files = await this.getFiles('git.zone', 'cli', 'assets/templates/cli/cli.js');
return files[0];
}
}

View File

@ -2,8 +2,11 @@ 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';
import { type ITsPublishJson } from './interfaces/index.js'; export interface ITsPublishJson {
import type { TsPublish } from './classes.tspublish.js'; name: string;
dependencies: string[];
registries: string[];
}
export interface IPublishModuleOptions { export interface IPublishModuleOptions {
monoRepoDir: string; monoRepoDir: string;
@ -17,17 +20,15 @@ export interface IPublishModuleOptions {
} }
export class PublishModule { export class PublishModule {
tsPublishRef: TsPublish;
public options: IPublishModuleOptions; public options: IPublishModuleOptions;
constructor(tsPublishRef: TsPublish, options: IPublishModuleOptions) { constructor(options: IPublishModuleOptions) {
this.tsPublishRef = tsPublishRef;
this.options = options; this.options = options;
} }
public async init() { public async init() {
this.options.packageSubFolderFullPath = plugins.path.join( this.options.packageSubFolderFullPath = plugins.path.join(
this.options.monoRepoDir, this.options.monoRepoDir,
this.options.packageSubFolder this.options.packageSubFolder,
); );
// check requirements // check requirements
@ -35,24 +36,19 @@ export class PublishModule {
throw new Error('subFolder must start with "ts"'); throw new Error('subFolder must start with "ts"');
} }
this.options.tsPublishJson = 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'),
); );
// the package.json of the parent mono repo
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 this.options.tsPublishJson.dependencies) { for (const dependency of this.options.tsPublishJson.dependencies) {
if (monoRepoPackageJson.dependencies[dependency]) {
resultDependencies[dependency] = monoRepoPackageJson.dependencies[dependency]; resultDependencies[dependency] = monoRepoPackageJson.dependencies[dependency];
} else {
resultDependencies[dependency] = monoRepoPackageJson.version;
}
} }
return resultDependencies; return resultDependencies;
})(), })(),
@ -75,7 +71,7 @@ export class PublishModule {
if (availableVersions.includes(this.options.version)) { if (availableVersions.includes(this.options.version)) {
logger.log( logger.log(
'error', '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); process.exit(1);
} }
@ -93,13 +89,12 @@ export class PublishModule {
public async createTsconfigJson() { public async createTsconfigJson() {
const originalTsConfig = plugins.smartfile.fs.toObjectSync( const originalTsConfig = plugins.smartfile.fs.toObjectSync(
plugins.path.join(paths.cwd, 'tsconfig.json') plugins.path.join(paths.cwd, 'tsconfig.json'),
); );
if (originalTsConfig?.compilerOptions?.paths) { if (originalTsConfig?.compilerOptions?.paths) {
for (const path of Object.keys(originalTsConfig.compilerOptions.paths)) { for (const path of Object.keys(originalTsConfig.compilerOptions.paths)) {
originalTsConfig.compilerOptions.paths[ originalTsConfig.compilerOptions.paths[path][0] =
path `.${originalTsConfig.compilerOptions.paths[path][0]}`;
][0] = `.${originalTsConfig.compilerOptions.paths[path][0]}`;
} }
} }
const tsconfigJson = { const tsconfigJson = {
@ -148,15 +143,6 @@ export class PublishModule {
'npmextra.json', 'npmextra.json',
'readme.md', 'readme.md',
], ],
...this.options.tsPublishJson.bin ? {
bin: (() => {
const binObject: {[key: string]: string} = {};
for (const bin of this.options.tsPublishJson.bin) {
binObject[bin] = `./cli.js`;
}
return binObject;
})()
} : {},
}; };
return JSON.stringify(packageJson, null, 2); return JSON.stringify(packageJson, null, 2);
} }
@ -164,7 +150,7 @@ export class PublishModule {
public async createPublishModuleDir() { public async createPublishModuleDir() {
this.options.publishModDirFullPath = plugins.path.join( this.options.publishModDirFullPath = plugins.path.join(
this.options.monoRepoDir, this.options.monoRepoDir,
`dist_publish_${this.options.packageSubFolder}` `dist_publish_${this.options.packageSubFolder}`,
); );
await plugins.smartfile.fs.ensureEmptyDir(this.options.publishModDirFullPath); await plugins.smartfile.fs.ensureEmptyDir(this.options.publishModDirFullPath);
@ -172,38 +158,35 @@ export class PublishModule {
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(),
'utf8' 'utf8',
); );
await packageJson.write(); await packageJson.write();
// tsconfig.json // tsconfig.json
const tsconfigJson = await plugins.smartfile.SmartFile.fromString( const originalTsConfigJson = await plugins.smartfile.SmartFile.fromString(
plugins.path.join(this.options.publishModDirFullPath, 'tsconfig.json'), plugins.path.join(this.options.publishModDirFullPath, 'tsconfig.json'),
await this.createTsconfigJson(), await this.createTsconfigJson(),
'utf8' 'utf8',
); );
await tsconfigJson.write(); await originalTsConfigJson.write();
// ts subfolder, the folder that contains the source code and is being transpiled // ts folder
await plugins.smartfile.fs.copy( await plugins.smartfile.fs.copy(
this.options.packageSubFolderFullPath, this.options.packageSubFolderFullPath,
plugins.path.join(this.options.publishModDirFullPath, this.options.packageSubFolder) plugins.path.join(this.options.publishModDirFullPath, this.options.packageSubFolder),
); );
// readme // readme
await plugins.smartfile.fs.copy( await plugins.smartfile.fs.copy(
plugins.path.join(this.options.packageSubFolderFullPath, 'readme.md'), plugins.path.join(this.options.packageSubFolderFullPath, 'readme.md'),
plugins.path.join(this.options.publishModDirFullPath, 'readme.md') plugins.path.join(this.options.publishModDirFullPath, 'readme.md'),
); );
// license // license
await plugins.smartfile.fs.copy( await plugins.smartfile.fs.copy(
plugins.path.join(this.options.monoRepoDir, 'license'), plugins.path.join(this.options.monoRepoDir, 'license'),
plugins.path.join(this.options.publishModDirFullPath, 'license') plugins.path.join(this.options.publishModDirFullPath, 'license'),
); );
// cli stuff
this.createBinCliSetup();
} }
public async build() { public async build() {
@ -213,21 +196,6 @@ export class PublishModule {
await smartshellInstance.exec(`cd ${this.options.publishModDirFullPath} && pnpm run build`); await smartshellInstance.exec(`cd ${this.options.publishModDirFullPath} && pnpm run build`);
} }
public async createBinCliSetup() {
const binSetupApplies: boolean =
this.options.tsPublishJson.bin &&
Array.isArray(this.options.tsPublishJson.bin) &&
this.options.tsPublishJson.bin.length > 0;
const files = await this.tsPublishRef.giteaAssetsInstance.getFiles(
'git.zone',
'cli',
'assets/templates/cli/cli.js'
);
const indexPath = `./dist_${this.options.packageSubFolder}/index.js`;
const fileContent = atob(files[0].base64Content).replace('./dist_ts/index.js', indexPath);
await plugins.smartfile.memory.toFs(fileContent, plugins.path.join(this.options.publishModDirFullPath, 'cli.js'));
}
public async publish() { public async publish() {
const smartshellInstance = new plugins.smartshell.Smartshell({ const smartshellInstance = new plugins.smartshell.Smartshell({
executor: 'bash', executor: 'bash',
@ -239,7 +207,7 @@ export class PublishModule {
await smartshellInstance.exec( await smartshellInstance.exec(
`cd ${this.options.publishModDirFullPath} && pnpm publish ${ `cd ${this.options.publishModDirFullPath} && pnpm publish ${
registryAccessLevel === 'public' ? '--access public' : '' registryAccessLevel === 'public' ? '--access public' : ''
} --no-git-checks --registry https://${registryUrl}` } --no-git-checks --registry https://${registryUrl}`,
); );
} }
} }

View File

@ -3,16 +3,9 @@ import * as plugins from './plugins.js';
import * as interfaces from './interfaces/index.js'; import * as interfaces from './interfaces/index.js';
import { PublishModule } from './classes.publishmodule.js'; import { PublishModule } from './classes.publishmodule.js';
import { GiteaAssets } from './classes.giteaassets.js';
export class TsPublish { export class TsPublish {
public giteaAssetsInstance: GiteaAssets; constructor() {}
constructor() {
this.giteaAssetsInstance = new GiteaAssets({
giteaBaseUrl: 'https://code.foss.global',
});
}
public async publish(monorepoDirArg: string) { public async publish(monorepoDirArg: string) {
const publishModules = await this.getModuleSubDirs(monorepoDirArg); const publishModules = await this.getModuleSubDirs(monorepoDirArg);
@ -20,7 +13,7 @@ export class TsPublish {
for (const publishModule of Object.keys(publishModules)) { for (const publishModule of Object.keys(publishModules)) {
logger.log( logger.log(
'info', 'info',
`Publishing module: ${publishModule} -> ${publishModules[publishModule].name}` `Publishing module: ${publishModule} -> ${publishModules[publishModule].name}`,
); );
} }
for (const publishModule of Object.keys(publishModules)) { for (const publishModule of Object.keys(publishModules)) {
@ -29,7 +22,7 @@ export class TsPublish {
logger.log('warn', `no name found in tspublish.json for ${publishModule}. Skipping...`); logger.log('warn', `no name found in tspublish.json for ${publishModule}. Skipping...`);
continue; continue;
} }
const publishModuleInstance = new PublishModule(this, { const publishModuleInstance = new PublishModule({
monoRepoDir: monorepoDirArg, monoRepoDir: monorepoDirArg,
packageSubFolder: publishModule, packageSubFolder: publishModule,
}); });
@ -55,7 +48,7 @@ export class TsPublish {
logger.log('info', `found publish module: ${subDir}`); logger.log('info', `found publish module: ${subDir}`);
publishModules[subDir] = JSON.parse( publishModules[subDir] = JSON.parse(
plugins.smartfile.fs.toStringSync(plugins.path.join(subDir, 'tspublish.json')) plugins.smartfile.fs.toStringSync(plugins.path.join(subDir, 'tspublish.json')),
); );
} }
logger.log('ok', `found ${Object.keys(publishModules).length} publish modules`); logger.log('ok', `found ${Object.keys(publishModules).length} publish modules`);

View File

@ -6,8 +6,4 @@ export interface ITsPublishJson {
name: string; name: string;
dependencies: string[]; dependencies: string[];
registries: string[]; registries: string[];
/**
* allows the sepcification of bin names that invoke cli scripts
*/
bin: string[];
} }

View File

@ -9,7 +9,6 @@ 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 smartrequest from '@push.rocks/smartrequest';
import * as smartshell from '@push.rocks/smartshell'; import * as smartshell from '@push.rocks/smartshell';
export { smartfile, smartcli, smartdelay, smartlog, smartnpm, smartpath, smartrequest, smartshell }; export { smartfile, smartcli, smartdelay, smartlog, smartnpm, smartpath, smartshell };