22 Commits

Author SHA1 Message Date
b6c13cc44d 1.10.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
2025-08-08 12:06:41 +00:00
8a6058c421 feat(logging): Enhance logging and module publishing with color-coded output, progress tracking, and improved CLI startup 2025-08-08 12:06:41 +00:00
9b3d77189a 1.9.1
Some checks failed
Default (tags) / security (push) Failing after 1s
Default (tags) / test (push) Failing after 1s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2025-01-02 04:06:51 +01:00
eb21dcc4a4 fix(publishmodule): Fix incorrect CLI script path during publish module creation 2025-01-02 04:06:51 +01:00
66145c904e 1.9.0
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
2025-01-02 03:31:15 +01:00
23f89eabf3 feat(core): support cli tools inside mono repos. 2025-01-02 03:31:15 +01:00
51ca619151 1.8.0
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
2025-01-01 01:44:43 +01:00
6a8c860c79 feat(core): Added retrieval class for Gitea based assets. 2025-01-01 01:44:43 +01:00
9fdbf7f154 1.7.7
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-11-05 02:20:12 +01:00
50456fc004 fix(core): Fix dependency resolution in package initialization 2024-11-05 02:20:11 +01:00
1cb97cbf95 1.7.6
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-11-05 01:52:26 +01:00
f8ceff48b2 fix(tspublish): Fix the logging of the number of found publish modules 2024-11-05 01:52:26 +01:00
910cb4c8bf 1.7.5
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-11-05 00:51:08 +01:00
9bddf09aa7 fix(core): Fix issue with tspublish.json name validation in TsPublish class 2024-11-05 00:51:07 +01:00
4e8671a21d 1.7.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-11-05 00:47:16 +01:00
78c73ee713 fix(classes.tspublish): Refactor getModuleSubDirs method to streamline name validation for publish modules 2024-11-05 00:47:16 +01:00
5b768288c5 1.7.3
Some checks failed
Default (tags) / security (push) Failing after 0s
Default (tags) / test (push) Failing after 2s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2024-11-05 00:41:47 +01:00
023aea2494 fix(TsPublish): Add validation for tspublish.json name field 2024-11-05 00:41:46 +01:00
ac839d5419 1.7.2
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-11-05 00:34:56 +01:00
750f081c03 fix(project): Fixed minor formatting issues and improved code consistency. 2024-11-05 00:34:56 +01:00
125be257d6 1.7.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-11-05 00:33:43 +01:00
d4c7fa8d6b fix(core): Implement error handling for missing publish module directories 2024-11-05 00:33:42 +01:00
22 changed files with 4929 additions and 3230 deletions

Binary file not shown.

View File

@@ -0,0 +1,31 @@
# Code Style and Conventions
## Naming Conventions
- Interfaces prefixed with `I` (e.g., `ITsPublishJson`)
- Types prefixed with `T` (when applicable)
- All filenames in lowercase
- Class files named as `classes.<classname>.ts`
- Test files named as `test.<name>.ts` or `*.both.ts`, `*.node.ts`, `*.browser.ts`
## Import Style
- Module dependencies imported via `ts/plugins.ts`
- Use full path references: `plugins.myModule.myClass()`
- Import TypeScript files directly in tests, never compiled JavaScript
## Code Patterns
- Async/await preferred over callbacks
- Classes for main logic (TsPublish, PublishModule)
- Centralized logging via `logging.ts`
- Plugins pattern for external dependencies
## TypeScript Conventions
- Use type annotations
- Export classes and functions explicitly
- Module exports through index.ts
- Interfaces in separate interfaces/ directory
## File Organization
- Source code in `ts/` directory
- Tests in `test/` directory
- Compiled output in `dist_ts/`
- No uppercase in filenames

View File

@@ -0,0 +1,49 @@
# Logging Improvements - January 2025
## Overview
Enhanced TSPublish logging system with @push.rocks/smartlog and @push.rocks/consolecolor for better visual feedback and user experience.
## Changes Made
### 1. Dependencies
- Added @push.rocks/consolecolor (v2.0.3) for colored console output
### 2. Enhanced logging.ts
- Created color-coded log level indicators with emojis
- Added specialized logging functions:
- `logInfo()` - Cyan info messages
- `logSuccess()` - Green success messages
- `logWarn()` - Orange warning messages
- `logError()` - Red error messages
- `logStart()` - Blue start indicators
- `logDone()` - Green completion indicators
- `logPackage()` - Package-specific messages with icons
- `logBuild()` - Build messages with hammer icon
- `logPublish()` - Publish messages with rocket icon
- `logOngoing()` - Ongoing operations with spinner icon
- Added visual helpers:
- `logSeparator()` - Cyan line separator
- `logHeader()` - Colored section headers
- `logProgress()` - Progress bar with percentage
### 3. Updated classes.tspublish.ts
- Added colored header at startup
- Module discovery uses colored bullets
- Progress tracking for module processing
- Better visual separation between phases
### 4. Updated classes.publishmodule.ts
- Added visual indicators for each operation phase
- Build process shows building status and completion
- Publishing shows rocket icon and success message
- NPM registry checks have clearer warnings
### 5. Updated index.ts
- Replaced console.log with logStart()
## Benefits
- Clearer visual hierarchy of information
- Easier to track progress through long operations
- Better distinction between info, warnings, and errors
- More professional and polished CLI output
- Semantic icons make status immediately recognizable

View File

@@ -0,0 +1,45 @@
# TSPublish Project Overview
## Purpose
TSPublish is a tool designed to publish multiple, concise, and small packages from monorepos, specifically for TypeScript projects within a git environment. It helps manage and automate the publishing of individual packages from a monorepo structure.
## Tech Stack
- **Language**: TypeScript
- **Runtime**: Node.js
- **Package Manager**: pnpm (v10.11.0)
- **Build Tool**: @git.zone/tsbuild
- **Testing**: @git.zone/tstest with @push.rocks/tapbundle
- **CLI Framework**: @push.rocks/smartcli
- **Logging**: @push.rocks/smartlog (currently basic usage)
## Main Dependencies
- @push.rocks/smartcli - CLI interface
- @push.rocks/smartdelay - Delay utilities
- @push.rocks/smartfile - File operations
- @push.rocks/smartlog - Logging
- @push.rocks/smartnpm - NPM registry interactions
- @push.rocks/smartpath - Path utilities
- @push.rocks/smartrequest - HTTP requests
- @push.rocks/smartshell - Shell command execution
## Project Structure
- `ts/` - TypeScript source files
- `index.ts` - Main entry point
- `classes.tspublish.ts` - Main TsPublish class
- `classes.publishmodule.ts` - PublishModule class for individual packages
- `classes.giteaassets.ts` - Gitea assets management
- `logging.ts` - Logger configuration
- `plugins.ts` - External dependencies
- `paths.ts` - Path constants
- `interfaces/` - TypeScript interfaces
- `test/` - Test files
- `dist_ts/` - Compiled JavaScript output
- `cli.js` - CLI entry point (bin script)
## Key Features
1. Scans monorepo for directories starting with "ts"
2. Validates packages via tspublish.json files
3. Creates package.json dynamically for each module
4. Builds TypeScript code before publishing
5. Checks npm registry for version conflicts
6. Publishes packages to npm registry

View File

@@ -0,0 +1,34 @@
# Suggested Commands for TSPublish Development
## Build & Test Commands
- `pnpm build` - Build the TypeScript project (runs tsbuild --web --allowimplicitany)
- `pnpm test` - Run the test suite (runs tstest test/ --web)
- `pnpm buildDocs` - Generate documentation (runs tsdoc)
## Development Commands
- `tsx ts/index.ts` - Run the main entry point directly
- `tsx test/test.ts` - Run specific test file
- `tstest test/test.some.ts --verbose` - Run specific test with verbose output
- `tsbuild check test/**/* --skiplibcheck` - Type check test files
## Package Management
- `pnpm install` - Install dependencies
- `pnpm install --save-dev <package>` - Install dev dependency
- `pnpm add <package>` - Add production dependency
## Git Commands (Linux)
- `git status` - Check repository status
- `git diff` - View changes
- `git log` - View commit history
- `git mv <old> <new>` - Move/rename files preserving history
## File System Commands (Linux)
- `ls` - List directory contents
- `cd` - Change directory
- `find` - Find files
- `grep` - Search file contents
- `cat` - Display file contents
## CLI Usage
- `./cli.js` - Run the tspublish CLI
- `node cli.js` - Alternative way to run CLI

View File

@@ -0,0 +1,29 @@
# Task Completion Checklist
When completing any development task on TSPublish:
## 1. Build Verification
- Run `pnpm build` to ensure TypeScript compiles without errors
- No use of --skiplibcheck flag
## 2. Test Execution
- Run `pnpm test` to verify all tests pass
- For specific test files: `tsx test/test.specific.ts`
## 3. Type Checking
- Type check test files: `tsbuild check test/**/* --skiplibcheck`
- Type check source files: `pnpm build`
## 4. Code Quality
- Ensure changes are focused and goal-oriented
- Verify no unnecessary modifications were made
- Check that code follows existing patterns and conventions
## 5. Documentation
- Update readme.hints.md if new insights discovered
- Update readme.plan.md if working from a plan
## 6. Version Control
- Use `git mv` for file renames to preserve history
- Make small, focused commits
- Never commit without explicit user request

68
.serena/project.yml Normal file
View File

@@ -0,0 +1,68 @@
# language of the project (csharp, python, rust, java, typescript, go, cpp, or ruby)
# * For C, use cpp
# * For JavaScript, use typescript
# Special requirements:
# * csharp: Requires the presence of a .sln file in the project folder.
language: typescript
# whether to use the project's gitignore file to ignore files
# Added on 2025-04-07
ignore_all_files_in_gitignore: true
# list of additional paths to ignore
# same syntax as gitignore, so you can use * and **
# Was previously called `ignored_dirs`, please update your config if you are using that.
# Added (renamed)on 2025-04-07
ignored_paths: []
# whether the project is in read-only mode
# If set to true, all editing tools will be disabled and attempts to use them will result in an error
# Added on 2025-04-18
read_only: false
# list of tool names to exclude. We recommend not excluding any tools, see the readme for more details.
# Below is the complete list of tools for convenience.
# To make sure you have the latest list of tools, and to view their descriptions,
# execute `uv run scripts/print_tool_overview.py`.
#
# * `activate_project`: Activates a project by name.
# * `check_onboarding_performed`: Checks whether project onboarding was already performed.
# * `create_text_file`: Creates/overwrites a file in the project directory.
# * `delete_lines`: Deletes a range of lines within a file.
# * `delete_memory`: Deletes a memory from Serena's project-specific memory store.
# * `execute_shell_command`: Executes a shell command.
# * `find_referencing_code_snippets`: Finds code snippets in which the symbol at the given location is referenced.
# * `find_referencing_symbols`: Finds symbols that reference the symbol at the given location (optionally filtered by type).
# * `find_symbol`: Performs a global (or local) search for symbols with/containing a given name/substring (optionally filtered by type).
# * `get_current_config`: Prints the current configuration of the agent, including the active and available projects, tools, contexts, and modes.
# * `get_symbols_overview`: Gets an overview of the top-level symbols defined in a given file or directory.
# * `initial_instructions`: Gets the initial instructions for the current project.
# Should only be used in settings where the system prompt cannot be set,
# e.g. in clients you have no control over, like Claude Desktop.
# * `insert_after_symbol`: Inserts content after the end of the definition of a given symbol.
# * `insert_at_line`: Inserts content at a given line in a file.
# * `insert_before_symbol`: Inserts content before the beginning of the definition of a given symbol.
# * `list_dir`: Lists files and directories in the given directory (optionally with recursion).
# * `list_memories`: Lists memories in Serena's project-specific memory store.
# * `onboarding`: Performs onboarding (identifying the project structure and essential tasks, e.g. for testing or building).
# * `prepare_for_new_conversation`: Provides instructions for preparing for a new conversation (in order to continue with the necessary context).
# * `read_file`: Reads a file within the project directory.
# * `read_memory`: Reads the memory with the given name from Serena's project-specific memory store.
# * `remove_project`: Removes a project from the Serena configuration.
# * `replace_lines`: Replaces a range of lines within a file with new content.
# * `replace_symbol_body`: Replaces the full definition of a symbol.
# * `restart_language_server`: Restarts the language server, may be necessary when edits not through Serena happen.
# * `search_for_pattern`: Performs a search for a pattern in the project.
# * `summarize_changes`: Provides instructions for summarizing the changes made to the codebase.
# * `switch_modes`: Activates modes by providing a list of their names
# * `think_about_collected_information`: Thinking tool for pondering the completeness of collected information.
# * `think_about_task_adherence`: Thinking tool for determining whether the agent is still on track with the current task.
# * `think_about_whether_you_are_done`: Thinking tool for determining whether the task is truly completed.
# * `write_memory`: Writes a named memory (for future reference) to Serena's project-specific memory store.
excluded_tools: []
# initial prompt for the project. It will always be given to the LLM upon activating the project
# (contrary to the memories, which are loaded on demand).
initial_prompt: ""
project_name: "tspublish"

View File

@@ -1,5 +1,76 @@
# Changelog
## 2025-08-08 - 1.10.0 - feat(logging)
Enhance logging and module publishing with color-coded output, progress tracking, and improved CLI startup
- Refactored logging to introduce color-coded symbols and helper functions (logInfo, logWarn, logSuccess, logBuild, logPublish, etc.)
- Added visual components such as headers, separators, and progress indicators for better operational visibility
- Integrated enhanced logging into module publishing and CLI startup, replacing generic console logs
- Updated various configuration and documentation files to reflect new code style conventions and dependency updates
## 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)
Fix the logging of the number of found publish modules
- Corrected the way the number of publish modules is logged by using Object.keys(publishModules).length instead of publishModules.length.
## 2024-11-05 - 1.7.5 - fix(core)
Fix issue with tspublish.json name validation in TsPublish class
- Resolved incorrect JSON parsing and validation for 'name' property in tspublish.json in the TsPublish.publish method.
- Removed redundant JSON parse from plugin.smartfile.fs.toStringSync in publish method.
## 2024-11-05 - 1.7.4 - fix(classes.tspublish)
Refactor getModuleSubDirs method to streamline name validation for publish modules
- Moved the check for the presence of the 'name' field in tspublish.json from getModuleSubDirs to the publish method.
- Added log warning and continue flow if 'name' is not found during the publish process.
## 2024-11-05 - 1.7.3 - fix(TsPublish)
Add validation for tspublish.json name field
- Ensure that the tspublish.json file contains a valid name field before processing.
- Log a warning message if the name is not found in tspublish.json.
## 2024-11-05 - 1.7.2 - fix(project)
Fixed minor formatting issues and improved code consistency.
- Added missing semicolons for consistency
- Improved indentation in various files for better readability
- Corrected usage of newlines and whitespace across the codebase
## 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

View File

@@ -1,6 +1,6 @@
{
"name": "@git.zone/tspublish",
"version": "1.7.0",
"version": "1.10.0",
"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",
@@ -14,7 +14,7 @@
"buildDocs": "(tsdoc)"
},
"bin": {
"tspublish": "cli.js"
"tspublish": "./cli.js"
},
"devDependencies": {
"@git.zone/tsbuild": "^2.1.85",
@@ -48,12 +48,14 @@
"readme.md"
],
"dependencies": {
"@push.rocks/consolecolor": "^2.0.3",
"@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",
"@push.rocks/smartpath": "^5.0.18",
"@push.rocks/smartrequest": "^2.0.23",
"@push.rocks/smartshell": "^3.0.6"
},
"keywords": [
@@ -67,5 +69,6 @@
"modularity",
"module-management",
"developer-tools"
]
],
"packageManager": "pnpm@10.11.0+sha512.6540583f41cc5f628eb3d9773ecee802f4f9ef9923cc45b69890fb47991d4b092964694ec3a4f738a420c918a333062c8b925d312f42e4f0c263eb603551f977"
}

7413
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

View File

@@ -172,11 +172,13 @@ Follow these steps:
```typescript
import { runCli } from '@git.zone/tspublish';
runCli().then(() => {
console.log('Publishing completed successfully');
}).catch((error) => {
console.error('Error during publishing:', error);
});
runCli()
.then(() => {
console.log('Publishing completed successfully');
})
.catch((error) => {
console.error('Error during publishing:', error);
});
```
3. Execute your CLI script:
@@ -188,4 +190,4 @@ node publish.js
Your script will call `runCli`, which will traverse each `ts-package`, verify their publish readiness, and handle individual publishing processes.
By following these comprehensive guidelines and utilizing the structured approach provided by `@git.zone/tspublish`, you can efficiently manage and publish multiple sub-packages from within a monorepo, facilitating organized, modular package management in projects of any scale.
undefined
undefined

39
test/test.giteaassets.ts Normal file
View File

@@ -0,0 +1,39 @@
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 = {
name: '@git.zone/tspublish',
version: '1.7.0',
version: '1.10.0',
description: 'A tool to publish multiple, concise, and small packages from monorepos, specifically for TypeScript projects within a git environment.'
}

103
ts/classes.giteaassets.ts Normal file
View File

@@ -0,0 +1,103 @@
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

@@ -1,12 +1,9 @@
import * as plugins from './plugins.js';
import * as paths from './paths.js';
import { logger } from './logging.js';
import { logger, logInfo, logSuccess, logWarn, logError, logBuild, logPublish, logOngoing, logStart, logDone } from './logging.js';
export interface ITsPublishJson {
name: string;
dependencies: string[];
registries: string[];
}
import { type ITsPublishJson } from './interfaces/index.js';
import type { TsPublish } from './classes.tspublish.js';
export interface IPublishModuleOptions {
monoRepoDir: string;
@@ -20,8 +17,10 @@ export interface IPublishModuleOptions {
}
export class PublishModule {
tsPublishRef: TsPublish;
public options: IPublishModuleOptions;
constructor(options: IPublishModuleOptions) {
constructor(tsPublishRef: TsPublish, options: IPublishModuleOptions) {
this.tsPublishRef = tsPublishRef;
this.options = options;
}
@@ -38,15 +37,22 @@ export class PublishModule {
this.options.tsPublishJson = plugins.smartfile.fs.toObjectSync(
plugins.path.join(this.options.packageSubFolderFullPath, 'tspublish.json')
);
// the package.json of the parent mono repo
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 this.options.tsPublishJson.dependencies) {
resultDependencies[dependency] = monoRepoPackageJson.dependencies[dependency];
if (monoRepoPackageJson.dependencies[dependency]) {
resultDependencies[dependency] = monoRepoPackageJson.dependencies[dependency];
} else {
resultDependencies[dependency] = monoRepoPackageJson.version;
}
}
return resultDependencies;
})(),
@@ -60,14 +66,16 @@ export class PublishModule {
try {
packageInfo = await smartnpmInstance.getPackageInfo(this.options.name);
} catch (error) {
logger.log('warn', `package does not yet seem to exist. Proceeding in 10 seconds...`);
logWarn(`Package ${this.options.name} 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()}`);
logInfo(`Available versions for ${this.options.name}: ${availableVersions.join(', ')}`);
if (availableVersions.includes(this.options.version)) {
logger.log('error', `package ${this.options.name} already exists with version ${this.options.version}`);
logError(
`Package ${this.options.name} already exists with version ${this.options.version}`
);
process.exit(1);
}
}
@@ -88,7 +96,9 @@ export class PublishModule {
);
if (originalTsConfig?.compilerOptions?.paths) {
for (const path of Object.keys(originalTsConfig.compilerOptions.paths)) {
originalTsConfig.compilerOptions.paths[path][0] = `.${originalTsConfig.compilerOptions.paths[path][0]}`;
originalTsConfig.compilerOptions.paths[
path
][0] = `.${originalTsConfig.compilerOptions.paths[path][0]}`;
}
}
const tsconfigJson = {
@@ -102,9 +112,7 @@ export class PublishModule {
verbatimModuleSyntax: true,
paths: originalTsConfig?.compilerOptions?.paths,
},
exclude: [
'dist_*/**/*.d.ts',
],
exclude: ['dist_*/**/*.d.ts'],
};
return JSON.stringify(tsconfigJson, null, 2);
}
@@ -139,11 +147,21 @@ export class PublishModule {
'npmextra.json',
'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);
}
public async createPublishModuleDir() {
logOngoing(`Creating publish directory for ${this.options.name}`);
this.options.publishModDirFullPath = plugins.path.join(
this.options.monoRepoDir,
`dist_publish_${this.options.packageSubFolder}`
@@ -159,14 +177,14 @@ export class PublishModule {
await packageJson.write();
// tsconfig.json
const originalTsConfigJson = await plugins.smartfile.SmartFile.fromString(
const tsconfigJson = await plugins.smartfile.SmartFile.fromString(
plugins.path.join(this.options.publishModDirFullPath, 'tsconfig.json'),
await this.createTsconfigJson(),
'utf8'
);
await originalTsConfigJson.write();
await tsconfigJson.write();
// ts folder
// ts subfolder, the folder that contains the source code and is being transpiled
await plugins.smartfile.fs.copy(
this.options.packageSubFolderFullPath,
plugins.path.join(this.options.publishModDirFullPath, this.options.packageSubFolder)
@@ -183,16 +201,37 @@ export class PublishModule {
plugins.path.join(this.options.monoRepoDir, 'license'),
plugins.path.join(this.options.publishModDirFullPath, 'license')
);
// cli stuff
this.createBinCliSetup();
}
public async build() {
logBuild(`Building ${this.options.name}...`);
const smartshellInstance = new plugins.smartshell.Smartshell({
executor: 'bash',
});
await smartshellInstance.exec(`cd ${this.options.publishModDirFullPath} && pnpm run build`);
logSuccess(`Build completed for ${this.options.name}`);
}
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() {
logPublish(`Publishing ${this.options.name} v${this.options.version}...`);
const smartshellInstance = new plugins.smartshell.Smartshell({
executor: 'bash',
});
@@ -206,5 +245,6 @@ export class PublishModule {
} --no-git-checks --registry https://${registryUrl}`
);
}
logSuccess(`Successfully published ${this.options.name} v${this.options.version}!`);
}
}

View File

@@ -1,23 +1,40 @@
import { logger } from './logging.js';
import { logger, logInfo, logSuccess, logWarn, logError, logHeader, logPackage, logProgress, logSeparator, logStart, logDone } from './logging.js';
import * as plugins from './plugins.js';
import * as interfaces from './interfaces/index.js';
import { PublishModule } from './classes.publishmodule.js';
import { GiteaAssets } from './classes.giteaassets.js';
export class TsPublish {
constructor() {}
public giteaAssetsInstance: GiteaAssets;
public async publish (monorepoDirArg: string) {
constructor() {
this.giteaAssetsInstance = new GiteaAssets({
giteaBaseUrl: 'https://code.foss.global',
});
}
public async publish(monorepoDirArg: string) {
logHeader('TSPublish - Module Publisher');
const publishModules = await this.getModuleSubDirs(monorepoDirArg);
logger.log('info', `Found ${Object.keys(publishModules).length} publish modules:`);
logInfo(`Found ${Object.keys(publishModules).length} publish modules`);
logSeparator();
for (const publishModule of Object.keys(publishModules)) {
logger.log('info', `Publishing module: ${publishModule} -> ${publishModules[publishModule].name}`);
logPackage('Module found', `${publishModule} ${publishModules[publishModule].name}`);
}
for (const publishModule of Object.keys(publishModules)) {
const publishModuleInstance = new PublishModule({
// lets check wether there is a name
if (!publishModules[publishModule].name) {
logWarn(`No name found in tspublish.json for ${publishModule}. Skipping...`);
continue;
}
const publishModuleInstance = new PublishModule(this, {
monoRepoDir: monorepoDirArg,
packageSubFolder: publishModule,
});
const moduleCount = Object.keys(publishModules).indexOf(publishModule) + 1;
const totalCount = Object.keys(publishModules).length;
logProgress(moduleCount, totalCount, publishModules[publishModule].name || publishModule);
await publishModuleInstance.init();
await publishModuleInstance.createPublishModuleDir();
await publishModuleInstance.build();
@@ -25,9 +42,9 @@ export class TsPublish {
}
}
public async getModuleSubDirs (dirArg: string) {
public async getModuleSubDirs(dirArg: string) {
const subDirs = await plugins.smartfile.fs.listFolders(dirArg);
const publishModules: {[key: string]: interfaces.ITsPublishJson} = {};
const publishModules: { [key: string]: interfaces.ITsPublishJson } = {};
for (const subDir of subDirs) {
if (!subDir.startsWith('ts')) {
continue;
@@ -37,10 +54,15 @@ export class TsPublish {
if (!hasPublishJson) {
continue;
}
logger.log('info', `found publish module: ${subDir}`);
publishModules[subDir] = JSON.parse(plugins.smartfile.fs.toStringSync(plugins.path.join(subDir, 'tspublish.json')));
logPackage('Found module', subDir);
publishModules[subDir] = JSON.parse(
plugins.smartfile.fs.toStringSync(plugins.path.join(subDir, 'tspublish.json'))
);
}
logger.log('ok', `found ${publishModules.length} publish modules`);
logSuccess(`Found ${Object.keys(publishModules).length} publish modules`);
logInfo('Ordering publish modules...');
return publishModules;
}
}
}

View File

@@ -1,10 +1,11 @@
import * as paths from './paths.js';
import { TsPublish } from './classes.tspublish.js';
import { logStart } from './logging.js';
export * from './classes.tspublish.js'
export * from './classes.tspublish.js';
export const runCli = async () => {
console.log('Starting tspublish...');
logStart('tspublish');
const tspublish = new TsPublish();
await tspublish.publish(paths.cwd);
}
};

View File

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

View File

@@ -2,4 +2,103 @@ import * as plugins from './plugins.js';
import * as commitinfo from './00_commitinfo_data.js';
export const logger = plugins.smartlog.Smartlog.createForCommitinfo(commitinfo.commitinfo);
logger.enableConsole();
logger.enableConsole();
// Color-coded log level indicators
const logIcons = {
info: plugins.consolecolor.coloredString('', 'cyan'),
success: plugins.consolecolor.coloredString('✓', 'green'),
warn: plugins.consolecolor.coloredString('⚠', 'orange'),
error: plugins.consolecolor.coloredString('✖', 'red'),
start: plugins.consolecolor.coloredString('▶', 'blue'),
done: plugins.consolecolor.coloredString('✔', 'green'),
package: plugins.consolecolor.coloredString('📦', 'blue'),
build: plugins.consolecolor.coloredString('🔨', 'cyan'),
publish: plugins.consolecolor.coloredString('🚀', 'green'),
};
// Helper function for info messages with color
export const logInfo = (message: string, data?: any) => {
const coloredMessage = `${logIcons.info} ${plugins.consolecolor.coloredString(message, 'cyan')}`;
logger.log('info', coloredMessage, data);
};
// Helper function for success messages
export const logSuccess = (message: string, data?: any) => {
const coloredMessage = `${logIcons.success} ${plugins.consolecolor.coloredString(message, 'green')}`;
logger.log('ok', coloredMessage, data);
};
// Helper function for warning messages
export const logWarn = (message: string, data?: any) => {
const coloredMessage = `${logIcons.warn} ${plugins.consolecolor.coloredString(message, 'orange')}`;
logger.log('warn', coloredMessage, data);
};
// Helper function for error messages
export const logError = (message: string, data?: any) => {
const coloredMessage = `${logIcons.error} ${plugins.consolecolor.coloredString(message, 'red')}`;
logger.log('error', coloredMessage, data);
};
// Helper function for start of operations
export const logStart = (operation: string) => {
const coloredMessage = `${logIcons.start} ${plugins.consolecolor.coloredString(`Starting ${operation}...`, 'blue')}`;
logger.log('info', coloredMessage);
};
// Helper function for completion of operations
export const logDone = (operation: string) => {
const coloredMessage = `${logIcons.done} ${plugins.consolecolor.coloredString(`Completed ${operation}`, 'green')}`;
logger.log('ok', coloredMessage);
};
// Helper function for package-related messages
export const logPackage = (message: string, packageName: string) => {
const coloredMessage = `${logIcons.package} ${message}: ${plugins.consolecolor.coloredString(packageName, 'blue', 'white')}`;
logger.log('info', coloredMessage);
};
// Helper function for build-related messages
export const logBuild = (message: string) => {
const coloredMessage = `${logIcons.build} ${plugins.consolecolor.coloredString(message, 'cyan')}`;
logger.log('info', coloredMessage);
};
// Helper function for publish-related messages
export const logPublish = (message: string) => {
const coloredMessage = `${logIcons.publish} ${plugins.consolecolor.coloredString(message, 'green')}`;
logger.log('info', coloredMessage);
};
// Create a visual separator for different phases
export const logSeparator = () => {
const separator = plugins.consolecolor.coloredString('━'.repeat(60), 'cyan');
console.log(separator);
};
// Create a header for major sections
export const logHeader = (title: string) => {
logSeparator();
const header = plugins.consolecolor.coloredString(` ${title.toUpperCase()} `, 'white', 'blue');
console.log(header);
logSeparator();
};
// Helper for indicating ongoing operations
export const logOngoing = (text: string) => {
const spinnerIcon = plugins.consolecolor.coloredString('⟳', 'cyan');
const coloredMessage = `${spinnerIcon} ${plugins.consolecolor.coloredString(text, 'cyan')}`;
logger.log('info', coloredMessage);
};
// Progress indicator helper
export const logProgress = (current: number, total: number, item: string) => {
const percentage = Math.round((current / total) * 100);
const progressBar = '█'.repeat(Math.floor(percentage / 5)) + '░'.repeat(20 - Math.floor(percentage / 5));
const coloredProgress = plugins.consolecolor.coloredString(
`[${progressBar}] ${percentage}% - ${item}`,
percentage === 100 ? 'green' : 'blue'
);
logger.log('info', coloredProgress);
};

View File

@@ -2,6 +2,8 @@ import * as plugins from './plugins.js';
export const cwd = process.cwd();
export const packageDir = plugins.path.join(plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url), '..');
export const packageDir = plugins.path.join(
plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url),
'..',
);
export const nogitDir = plugins.path.join(packageDir, '.nogit');

View File

@@ -1,16 +1,16 @@
// node native scope
import * as path from 'path';
export {
path,
}
export { path };
// @push.rocks scope
import * as consolecolor from '@push.rocks/consolecolor';
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 smartrequest from '@push.rocks/smartrequest';
import * as smartshell from '@push.rocks/smartshell';
export { smartfile, smartcli, smartdelay, smartlog, smartnpm, smartpath, smartshell };
export { consolecolor, smartfile, smartcli, smartdelay, smartlog, smartnpm, smartpath, smartrequest, smartshell };

View File

@@ -7,8 +7,10 @@
"moduleResolution": "NodeNext",
"esModuleInterop": true,
"verbatimModuleSyntax": true,
"baseUrl": ".",
"paths": {}
},
"exclude": [
"dist_*/**/*.d.ts"
]
}
}