59 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
9d41d036f5 1.7.0
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:21 +01:00
94c38e21b3 feat(core): Enhanced tspublish with ordered compilation and updated dependencies 2024-11-05 00:33:21 +01:00
6b3cd84b65 1.6.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-28 21:53:19 +01:00
b2f63efa18 feat(classes.publishmodule): Added copying of readme and license files to publish directory 2024-10-28 21:53:18 +01:00
1d749417a1 1.5.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-10-28 15:57:31 +01:00
7dc98f9dd3 fix(core): Handled non-existent package in publish module to avoid errors 2024-10-28 15:57:31 +01:00
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
0f4c2cbba4 1.2.3
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-21 14:37:34 +02:00
0b68a2dd57 fix(logs): Improve logging mechanism with structured logs for publish process 2024-10-21 14:37:33 +02:00
fda3204cfb update 2024-10-21 14:37:23 +02:00
76a1da6ca5 1.2.2
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
2024-10-21 14:28:43 +02:00
1653e48714 fix(publishmodule): Fix bug in package.json creation for publish module 2024-10-21 14:28:42 +02:00
1017cb84a6 1.2.1
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-10-21 13:27:15 +02:00
25d2703a36 fix(package.json): Ensure bin field is properly restructured 2024-10-21 13:27:14 +02:00
5c4ae278a2 1.2.0
Some checks failed
Default (tags) / security (push) Failing after 1s
Default (tags) / test (push) Failing after 3s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2024-10-21 13:21:48 +02:00
a88e417e2f feat(core): Enhance package publication workflow with dependency handling and CLI improvements. 2024-10-21 13:21:47 +02:00
25 changed files with 1687 additions and 409 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,192 @@
# 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
- 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
- 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)
Improve logging mechanism with structured logs for publish process
- Enhanced log messages to provide more clarity during module publishing.
- Ensured logging captures steps of publish and init process in TsPublish and PublishModule classes respectively.
## 2024-10-21 - 1.2.3 - fix(classes.publishmodule)
Add missing 'type: module' to dynamically generated package.json
- Ensure that the 'type: module' field is included in each dynamically generated package.json file for consistent module handling.
## 2024-10-21 - 1.2.3 - fix(classes.publishmodule)
Add missing 'type: module' to dynamically generated package.json
- Ensure that the 'type: module' field is included in each dynamically generated package.json file for consistent module handling.
## 2024-10-21 - 1.2.2 - fix(publishmodule)
Fix bug in package.json creation for publish module
- Fixed an issue where `package.json` was not being written to the publish module directory.
## 2024-10-21 - 1.2.1 - fix(package.json)
Ensure bin field is properly restructured
- Fixed the structure of the package.json to ensure the bin field is accurately set.
## 2024-10-21 - 1.2.0 - feat(core)
Enhance package publication workflow with dependency handling and CLI improvements.
- Updated package description and keywords in package.json and npmextra.json.
- Integrated dependency extraction from root package.json into sub-package tspublish.json during initialization.
- Added build and publish script executions for each submodule.
- Improved CLI documentation and usage guidance in readme.md.
## 2024-10-21 - 1.1.0 - feat(core)
Add runCli function to execute TsPublish process

View File

@@ -5,10 +5,22 @@
"githost": "code.foss.global",
"gitscope": "git.zone",
"gitrepo": "tspublish",
"description": "publish multiple, concise and small packages from monorepos",
"description": "A tool to publish multiple, concise, and small packages from monorepos, specifically for TypeScript projects within a git environment.",
"npmPackagename": "@git.zone/tspublish",
"license": "MIT",
"projectDomain": "git.zone"
"projectDomain": "git.zone",
"keywords": [
"typescript",
"monorepo",
"package",
"publish",
"npm",
"automation",
"git",
"modularity",
"module-management",
"developer-tools"
]
}
},
"npmci": {

View File

@@ -1,8 +1,8 @@
{
"name": "@git.zone/tspublish",
"version": "1.1.0",
"version": "1.10.0",
"private": false,
"description": "publish multiple, concise and small packages from monorepos",
"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",
"typings": "dist_ts/index.d.ts",
"type": "module",
@@ -13,13 +13,16 @@
"build": "(tsbuild --web --allowimplicitany)",
"buildDocs": "(tsdoc)"
},
"bin": {
"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.6"
"@types/node": "^22.8.7"
},
"repository": {
"type": "git",
@@ -45,10 +48,27 @@
"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/smartpath": "^5.0.18",
"@push.rocks/smartrequest": "^2.0.23",
"@push.rocks/smartshell": "^3.0.6"
},
"keywords": [
"typescript",
"monorepo",
"package",
"publish",
"npm",
"automation",
"git",
"modularity",
"module-management",
"developer-tools"
],
"packageManager": "pnpm@10.11.0+sha512.6540583f41cc5f628eb3d9773ecee802f4f9ef9923cc45b69890fb47991d4b092964694ec3a4f738a420c918a333062c8b925d312f42e4f0c263eb603551f977"
}

881
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

190
readme.md
View File

@@ -2,6 +2,192 @@
publish multiple, concise and small packages from monorepos
## How to create the docs
## Install
To create docs run gitzone aidoc.
To install `@git.zone/tspublish`, you can use npm. To use the latest stable version, run:
```bash
npm install @git.zone/tspublish
```
Alternatively, if you are using yarn, the equivalent command would be:
```bash
yarn add @git.zone/tspublish
```
These commands will add `@git.zone/tspublish` as a dependency in your `package.json` file and install the package into your `node_modules` directory.
## Usage
`@git.zone/tspublish` is designed to manage the publishing of multiple, small-scale packages within monorepos. The following sections will guide you through its usage, from setting up your environment to effectively publishing packages.
### Getting Started with TypeScript and Module Setup
`@git.zone/tspublish` works with monorepos that are organized using TypeScript. The package structure should follow a convention where each submodule intended for publishing is located in a directory prefixed with `ts`, for example, `tsModuleName`. Each submodule directory should contain a `tspublish.json` file to correctly configure the package to be published separately. This file is critical for the `tspublish` process to identify valid package directories and should also include necessary metadata for the package.
Your monorepo structure might resemble:
```
my-monorepo/
├── ts-package1/
│ ├── src/
│ ├── tspublish.json
├── ts-package2/
│ ├── src/
│ ├── tspublish.json
```
### Configuring `tspublish.json`
Each submodule must include a `tspublish.json` within its directory. This JSON file should include essential details for your publishable package, including its dependencies. Here's a basic example of what `tspublish.json` could look like:
```json
{
"name": "@myorg/ts-package1",
"dependencies": {
"some-dependency": "^1.0.0"
}
}
```
### Running the CLI
`@git.zone/tspublish` includes a CLI that simplifies the publishing process. Begin by importing the CLI runner in a script within your project:
```typescript
import { runCli } from '@git.zone/tspublish';
runCli();
```
This function call orchestrates the publishing operation. It reads each directory prefixed with `ts`, looks for a `tspublish.json`, and creates an individual package based on the gathered data.
### Core Features
#### Publishing Modules
The core functionality provided by `@git.zone/tspublish` involves processing directories to check for valid submodules that are ready to be published. This occurs via the `publish` method in `TsPublish` class. This method does the following:
- **Reads all directories** within the specified monorepo path.
- **Identifies directories** that start with `ts` and validates the presence of `tspublish.json`.
- **Logs** information about found packages for user awareness and debugging.
- **Checks for collisions** with existing versions on the npm registry to prevent overriding published versions.
```typescript
import { TsPublish } from '@git.zone/tspublish';
const tspublish = new TsPublish();
await tspublish.publish('/path/to/your/monorepo');
```
#### Package Initialization
Once valid submodules are identified, the `init` method in the `PublishModule` class initializes the publish module. This includes:
- Parsing `tspublish.json` for metadata.
- Constructing full paths for necessary operations.
- Verifying package existence to avoid duplication.
```typescript
import { PublishModule } from '@git.zone/tspublish';
const publishModule = new PublishModule({
monoRepoDir: '/path/to/monorepo',
packageSubFolder: 'ts-package1',
});
await publishModule.init();
```
#### Creating `package.json`
Part of the publishing process involves automatically creating a `package.json` tailored to each submodule. This dynamically generated JSON will incorporate dependencies from `tspublish.json` and associate them with the latest version of `tsbuild` from the registry:
```typescript
await publishModule.createPackageJson();
```
This creates a structured `package.json` which includes scripts to build your TypeScript files before publishing.
#### Constructing Publish-ready Directory
After all configurations are verified and the `package.json` is created, the submodule is ready to be published. This step involves setting up a `dist_publish_` directory specific to each module:
```typescript
await publishModule.createPublishModuleDir();
```
The above method ensures that each module's source files are copied and prepared under a dedicated directory meant for packaging and distribution.
### Logging and Debugging
The package includes a structured logging mechanism using `smartlog` which provides insights into the publishing process, helping in runtime debugging and status tracking of operations:
```typescript
import { logger } from '@git.zone/tspublish/logging';
logger.log('info', 'Publishing process initialized');
```
This powerful logging helps in tracking the status of each step and understanding potential issues during the operations.
### Testing with tapbundle
To ensure that your publishing workflow is functioning correctly, you can utilize the test suite set up with `tapbundle`. This library facilitates behavior-driven testing for your monorepo. Below is a basic test setup to verify the import and initial function accessibility of `@git.zone/tspublish`:
```typescript
import { expect, tap } from '@push.rocks/tapbundle';
import * as tspublish from '@git.zone/tspublish';
tap.test('Should run the CLI without errors', async () => {
await tspublish.runCli();
expect(tspublish).toBeTruthy();
});
tap.start();
```
### Comprehensive usage example
Let's combine all the steps into a complete example where you prepare a monorepo, configure each module, and execute the publishing workflow.
Suppose you have a project structure as follows:
```plaintext
my-monorepo/
├── ts-package1/
│ ├── src/
│ ├── tspublish.json
├── ts-package2/
│ ├── src/
│ ├── tspublish.json
```
Follow these steps:
1. Ensure each package has `tspublish.json` properly configured with necessary metadata.
2. Create a CLI script such as `publish.js`:
```typescript
import { runCli } from '@git.zone/tspublish';
runCli()
.then(() => {
console.log('Publishing completed successfully');
})
.catch((error) => {
console.error('Error during publishing:', error);
});
```
3. Execute your CLI script:
```bash
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

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

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

View File

@@ -3,6 +3,6 @@
*/
export const commitinfo = {
name: '@git.zone/tspublish',
version: '1.1.0',
description: 'publish multiple, concise and small packages from monorepos'
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,11 +1,15 @@
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';
import { type ITsPublishJson } from './interfaces/index.js';
import type { TsPublish } from './classes.tspublish.js';
export interface IPublishModuleOptions {
monoRepoDir: string;
packageSubFolder: string;
packageSubFolderFullPath?: string;
tsPublishJson?: ITsPublishJson;
publishModDirFullPath?: string;
name?: string;
version?: string;
@@ -13,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;
}
@@ -28,29 +34,49 @@ export class PublishModule {
if (!this.options.packageSubFolder.startsWith('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')
);
this.options.dependencies = this.options.dependencies || {};
// 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,
...jsonData.dependencies,
...(() => {
const resultDependencies = {};
for (const dependency of this.options.tsPublishJson.dependencies) {
if (monoRepoPackageJson.dependencies[dependency]) {
resultDependencies[dependency] = monoRepoPackageJson.dependencies[dependency];
} else {
resultDependencies[dependency] = monoRepoPackageJson.version;
}
}
return resultDependencies;
})(),
};
this.options.name = this.options.name || jsonData.name;
this.options.version = plugins.smartfile.fs.toObjectSync(
plugins.path.join(this.options.monoRepoDir, 'package.json')
).version;
this.options.name = this.options.name || this.options.tsPublishJson.name;
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.
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) {
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)) {
throw new 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);
}
}
}
@@ -64,14 +90,42 @@ export class PublishModule {
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() {
const packageJson = {
name: this.options.name,
version: this.options.version,
type: 'module',
description: '',
exports: {
'.': {
import: './dist_${this.options.packageSubFolder}/index.js',
import: `./dist_${this.options.packageSubFolder}/index.js`,
},
},
scripts: {
@@ -81,25 +135,116 @@ export class PublishModule {
devDependencies: {
'@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',
],
...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}`
);
// package.json
await plugins.smartfile.fs.ensureEmptyDir(this.options.publishModDirFullPath);
// package.json
const packageJson = await plugins.smartfile.SmartFile.fromString(
plugins.path.join(this.options.publishModDirFullPath, 'package.json'),
await this.createPackageJson(),
'utf8'
);
await packageJson.write();
// ts folder
await plugins.smartfile.fs.copy(this.options.packageSubFolderFullPath, plugins.path.join(this.options.publishModDirFullPath, this.options.packageSubFolder))
// tsconfig.json
const tsconfigJson = await plugins.smartfile.SmartFile.fromString(
plugins.path.join(this.options.publishModDirFullPath, 'tsconfig.json'),
await this.createTsconfigJson(),
'utf8'
);
await tsconfigJson.write();
// 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)
);
// 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')
);
// 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',
});
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}`
);
}
logSuccess(`Successfully published ${this.options.name} v${this.options.version}!`);
}
}

View File

@@ -1,25 +1,50 @@
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) {
const publishModules = await this.readDirectory(monorepoDirArg);
for (const publishModule of publishModules) {
const publishModuleInstance = new PublishModule({
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);
logInfo(`Found ${Object.keys(publishModules).length} publish modules`);
logSeparator();
for (const publishModule of Object.keys(publishModules)) {
logPackage('Module found', `${publishModule}${publishModules[publishModule].name}`);
}
for (const publishModule of Object.keys(publishModules)) {
// 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();
await publishModuleInstance.publish();
}
}
public async readDirectory (dirArg: string) {
public async getModuleSubDirs(dirArg: string) {
const subDirs = await plugins.smartfile.fs.listFolders(dirArg);
const publishModules: string[] = [];
const publishModules: { [key: string]: interfaces.ITsPublishJson } = {};
for (const subDir of subDirs) {
if (!subDir.startsWith('ts')) {
continue;
@@ -29,10 +54,15 @@ export class TsPublish {
if (!hasPublishJson) {
continue;
}
logger.log('info', `found publish module: ${subDir}`);
publishModules.push(subDir);
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,9 +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 () => {
logStart('tspublish');
const tspublish = new TsPublish();
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,13 @@
export interface ITsPublishJson {
/**
* the order assures that a project is compiled before another project
*/
order: number;
name: string;
dependencies: string[];
registries: string[];
/**
* allows the sepcification of bin names that invoke cli scripts
*/
bin: string[];
}

View File

@@ -1,4 +1,104 @@
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();
// 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,14 +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, smartlog, smartnpm, smartpath, };
export { consolecolor, smartfile, smartcli, smartdelay, smartlog, smartnpm, smartpath, smartrequest, smartshell };

View File

@@ -6,9 +6,11 @@
"module": "NodeNext",
"moduleResolution": "NodeNext",
"esModuleInterop": true,
"verbatimModuleSyntax": true
"verbatimModuleSyntax": true,
"baseUrl": ".",
"paths": {}
},
"exclude": [
"dist_*/**/*.d.ts"
]
}
}