44 Commits

Author SHA1 Message Date
47fdb00d5b v1.10.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
2025-12-15 20:01:32 +00:00
6971b287b4 fix(.serena): cleanup: remove .serena assistant memories, cache and project config 2025-12-15 20:01:32 +00:00
9f0d052bcb 1.10.3
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-08-18 02:18:11 +00:00
8752cd0a7e fix(devDependencies): Bump development dependencies and add local Claude settings 2025-08-18 02:18:11 +00:00
5704894cd3 1.10.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
2025-08-18 00:31:33 +00:00
b67c936a65 fix(dependencies): Update dependency versions and add local Claude settings 2025-08-18 00:31:33 +00:00
e26bb2b7dd 1.10.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-08-08 12:17:25 +00:00
88e377c425 fix(core): Refactor smartrequest usage, update dependency versions, and improve documentation and tests 2025-08-08 12:17:25 +00:00
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
17 changed files with 8160 additions and 4434 deletions

View File

@@ -1,5 +1,149 @@
# Changelog
## 2025-12-15 - 1.10.4 - fix(.serena)
cleanup: remove .serena assistant memories, cache and project config
- Removed multiple .serena/memories markdown files (code_style_conventions.md, logging_improvements_2025.md, project_overview.md, smartrequest_api_update_2025.md, suggested_commands.md, task_completion_checklist.md) — these were assistant metadata/notes
- Removed .serena/project.yml (project configuration for the assistant)
- Removed .serena/cache/typescript/document_symbols_cache_v23-06-25.pkl (generated symbol cache)
## 2025-08-18 - 1.10.3 - fix(devDependencies)
Bump development dependencies and add local Claude settings
- Bumped @git.zone/tsbuild from ^2.6.4 to ^2.6.6 in package.json
- Bumped @push.rocks/smartnpm from ^2.0.4 to ^2.0.6 in package.json
- Added .claude/settings.local.json for local Claude permissions/configuration
## 2025-08-18 - 1.10.2 - fix(dependencies)
Update dependency versions and add local Claude settings
- Bump devDependency @git.zone/tstest from ^2.3.2 to ^2.3.4
- Bump dependency @push.rocks/smartfile from ^11.2.5 to ^11.2.7
- Bump dependency @push.rocks/smartrequest from ^4.2.1 to ^4.2.2
- Bump dependency @push.rocks/smartshell from ^3.2.3 to ^3.3.0
- Add .claude/settings.local.json (local Claude permissions/config)
## 2025-08-08 - 1.10.1 - fix(core)
Refactor smartrequest usage, update dependency versions, and improve documentation and tests
- Refactored getFiles method in classes.giteaassets to use SmartRequest builder and handle branch query parameters.
- Updated package.json dependency versions for smartfile, smartlog, tsbuild, tsbundle, and tstest.
- Added pnpm-workspace.yaml configuration for onlyBuiltDependencies.
- Enhanced readme with detailed usage instructions, CI/CD integration examples, and advanced feature descriptions.
- Updated test files to import tapbundle from @git.zone/tstest instead of @push.rocks/tapbundle.
- Added .claude/settings.local.json for managing local permissions.
## 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

View File

@@ -1,6 +1,6 @@
{
"name": "@git.zone/tspublish",
"version": "1.5.0",
"version": "1.10.4",
"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",
@@ -9,20 +9,19 @@
"author": "Task Venture Capital GmbH",
"license": "MIT",
"scripts": {
"test": "(tstest test/ --web)",
"test": "(tstest test/ --verbose --testlog --timeout 30)",
"build": "(tsbuild --web --allowimplicitany)",
"buildDocs": "(tsdoc)"
},
"bin": {
"tspublish": "cli.js"
"tspublish": "./cli.js"
},
"devDependencies": {
"@git.zone/tsbuild": "^2.1.25",
"@git.zone/tsbundle": "^2.0.5",
"@git.zone/tsrun": "^1.2.46",
"@git.zone/tstest": "^1.0.44",
"@push.rocks/tapbundle": "^5.0.15",
"@types/node": "^22.7.7"
"@git.zone/tsbuild": "^2.6.6",
"@git.zone/tsbundle": "^2.5.1",
"@git.zone/tsrun": "^1.3.3",
"@git.zone/tstest": "^2.3.4",
"@types/node": "^22.8.7"
},
"repository": {
"type": "git",
@@ -48,12 +47,15 @@
"readme.md"
],
"dependencies": {
"@push.rocks/consolecolor": "^2.0.3",
"@push.rocks/smartcli": "^4.0.11",
"@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/smartshell": "^3.0.6"
"@push.rocks/smartdelay": "^3.0.5",
"@push.rocks/smartfile": "^11.2.7",
"@push.rocks/smartlog": "^3.1.8",
"@push.rocks/smartnpm": "^2.0.6",
"@push.rocks/smartpath": "^6.0.0",
"@push.rocks/smartrequest": "^4.2.2",
"@push.rocks/smartshell": "^3.3.0"
},
"keywords": [
"typescript",
@@ -66,5 +68,6 @@
"modularity",
"module-management",
"developer-tools"
]
],
"packageManager": "pnpm@10.11.0+sha512.6540583f41cc5f628eb3d9773ecee802f4f9ef9923cc45b69890fb47991d4b092964694ec3a4f738a420c918a333062c8b925d312f42e4f0c263eb603551f977"
}

11546
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

4
pnpm-workspace.yaml Normal file
View File

@@ -0,0 +1,4 @@
onlyBuiltDependencies:
- esbuild
- mongodb-memory-server
- puppeteer

426
readme.md
View File

@@ -1,191 +1,375 @@
# @git.zone/tspublish
# @git.zone/tspublish 🚀
publish multiple, concise and small packages from monorepos
> **Effortlessly publish multiple TypeScript packages from your monorepo**
## Install
[![npm version](https://img.shields.io/npm/v/@git.zone/tspublish.svg)](https://www.npmjs.com/package/@git.zone/tspublish)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
To install `@git.zone/tspublish`, you can use npm. To use the latest stable version, run:
## 🌟 What is tspublish?
`@git.zone/tspublish` is your Swiss Army knife for managing and publishing multiple TypeScript packages from a monorepo. It automates the tedious parts of package publishing while giving you full control over the process. Whether you're maintaining a suite of microservices, a component library, or any collection of related packages, tspublish makes your life easier.
### ✨ Key Features
- 📦 **Automatic Package Discovery** - Scans your monorepo for publishable packages
- 🎨 **Beautiful CLI Output** - Color-coded logging with progress indicators
- 🔍 **Version Collision Detection** - Prevents accidental overwrites
- 🏗️ **Build Integration** - Automatically builds TypeScript before publishing
- 🎯 **Smart Dependency Management** - Inherits dependencies from your monorepo
- 🌐 **Multi-Registry Support** - Publish to npm, GitHub packages, or private registries
-**Zero Config** - Works out of the box with sensible defaults
## 📥 Installation
### As a Development Dependency (Recommended)
```bash
npm install @git.zone/tspublish
# Using pnpm (recommended)
pnpm add -D @git.zone/tspublish
# Using npm
npm install --save-dev @git.zone/tspublish
# Using yarn
yarn add -D @git.zone/tspublish
```
Alternatively, if you are using yarn, the equivalent command would be:
### Global Installation
```bash
yarn add @git.zone/tspublish
npm install -g @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.
## 🚀 Quick Start
## Usage
### 1⃣ Structure Your Monorepo
`@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:
Organize your packages with the `ts` prefix convention:
```
my-monorepo/
├── ts-package1/
│ ├── src/
├── tspublish.json
├── ts-package2/
│ ├── src/
── tspublish.json
my-awesome-monorepo/
├── package.json # Main monorepo package.json
├── tsconfig.json # Shared TypeScript config
├── ts-core/ # Core package
├── ts/ # TypeScript source files
│ ├── readme.md # Package documentation
── tspublish.json # Publishing configuration
├── ts-utils/ # Utilities package
│ ├── ts/
│ ├── readme.md
│ └── tspublish.json
└── ts-cli/ # CLI package
├── ts/
├── readme.md
└── tspublish.json
```
### Configuring `tspublish.json`
### 2 Configure Each Package
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:
Create a `tspublish.json` in each package directory:
```json
{
"name": "@myorg/ts-package1",
"dependencies": {
"some-dependency": "^1.0.0"
}
"name": "@myorg/core",
"order": 1,
"dependencies": [
"@push.rocks/smartpromise",
"@push.rocks/smartfile"
],
"registries": [
"registry.npmjs.org:public",
"npm.pkg.github.com:private"
],
"bin": ["my-cli"]
}
```
### Running the CLI
#### Configuration Options
`@git.zone/tspublish` includes a CLI that simplifies the publishing process. Begin by importing the CLI runner in a script within your project:
| Field | Type | Description |
|-------|------|-------------|
| `name` | string | Package name (required) |
| `order` | number | Build order for interdependent packages |
| `dependencies` | string[] | Dependencies from the monorepo to include |
| `registries` | string[] | Target registries with access level |
| `bin` | string[] | CLI executable names |
```typescript
import { runCli } from '@git.zone/tspublish';
### 3⃣ Run the Publisher
runCli();
#### Command Line
```bash
# From your monorepo root
npx tspublish
```
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.
#### Programmatic Usage
```typescript
import { TsPublish } from '@git.zone/tspublish';
const tspublish = new TsPublish();
await tspublish.publish('/path/to/your/monorepo');
const publisher = new TsPublish();
await publisher.publish(process.cwd());
```
#### Package Initialization
## 🎯 Advanced Usage
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.
### Custom Publishing Pipeline
```typescript
import { PublishModule } from '@git.zone/tspublish';
import { TsPublish, PublishModule } from '@git.zone/tspublish';
const publishModule = new PublishModule({
monoRepoDir: '/path/to/monorepo',
packageSubFolder: 'ts-package1',
});
// Initialize the publisher
const publisher = new TsPublish();
await publishModule.init();
// Get all publishable modules
const modules = await publisher.getModuleSubDirs('./my-monorepo');
// Custom processing for each module
for (const [name, config] of Object.entries(modules)) {
const module = new PublishModule(publisher, {
monoRepoDir: './my-monorepo',
packageSubFolder: name
});
// Initialize module
await module.init();
// Create publish directory
await module.createPublishModuleDir();
// Custom build step
console.log(`Building ${config.name}...`);
await module.build();
// Publish to registries
await module.publish();
}
```
#### Creating `package.json`
### Registry Configuration
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:
TSPublish supports multiple registries with different access levels:
```json
{
"registries": [
"registry.npmjs.org:public", // Public npm package
"npm.pkg.github.com:private", // Private GitHub package
"my-company.jfrog.io/npm:restricted" // Corporate registry
]
}
```
### Build Order Management
When packages depend on each other, use the `order` field to ensure correct build sequence:
```json
// ts-core/tspublish.json
{
"name": "@myorg/core",
"order": 1,
"dependencies": []
}
// ts-utils/tspublish.json
{
"name": "@myorg/utils",
"order": 2,
"dependencies": ["@myorg/core"]
}
```
### CLI Binary Configuration
For packages that include CLI tools:
```json
{
"name": "@myorg/cli",
"bin": ["my-cli", "my-tool"],
"dependencies": ["commander", "chalk"]
}
```
This automatically generates the necessary `cli.js` wrapper and configures the package.json `bin` field.
## 🎨 Beautiful Output
TSPublish provides rich, colored console output with:
- 📊 Progress bars for multi-package operations
- 🎯 Clear status indicators ( info, ✓ success, ⚠ warning, ✖ error)
- 📦 Package-specific icons and formatting
- 🚀 Visual separators between operation phases
## 🔧 How It Works
1. **Discovery Phase** 🔍
- Scans for directories starting with `ts`
- Validates `tspublish.json` presence
- Orders packages by dependency
2. **Preparation Phase** 📋
- Creates temporary `dist_publish_*` directories
- Generates package.json from tspublish.json
- Copies source files and assets
- Sets up TypeScript configuration
3. **Build Phase** 🔨
- Runs TypeScript compilation
- Generates declaration files
- Prepares distribution bundle
4. **Validation Phase**
- Checks npm registry for existing versions
- Prevents accidental overwrites
- Validates package metadata
5. **Publishing Phase** 🚀
- Publishes to configured registries
- Handles authentication
- Reports success/failure
## 🤝 Integration with CI/CD
### GitHub Actions
```yaml
name: Publish Packages
on:
push:
tags:
- 'v*'
jobs:
publish:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: pnpm/action-setup@v2
with:
version: 8
- uses: actions/setup-node@v3
with:
node-version: '20'
cache: 'pnpm'
- run: pnpm install
- run: pnpm build
- run: npx tspublish
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
```
### GitLab CI
```yaml
publish:
stage: deploy
image: node:20
before_script:
- npm install -g pnpm
- pnpm install
script:
- pnpm build
- npx tspublish
only:
- tags
```
## 📚 API Reference
### TsPublish Class
```typescript
await publishModule.createPackageJson();
class TsPublish {
// Publish all packages in a monorepo
async publish(monorepoDirPath: string): Promise<void>
// Get all publishable module configurations
async getModuleSubDirs(dirPath: string): Promise<{[key: string]: ITsPublishJson}>
}
```
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:
### PublishModule Class
```typescript
await publishModule.createPublishModuleDir();
class PublishModule {
// Initialize the module for publishing
async init(): Promise<void>
// Create the publishing directory structure
async createPublishModuleDir(): Promise<void>
// Build the TypeScript package
async build(): Promise<void>
// Publish to configured registries
async publish(): Promise<void>
}
```
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:
### ITsPublishJson Interface
```typescript
import { logger } from '@git.zone/tspublish/logging';
logger.log('info', 'Publishing process initialized');
interface ITsPublishJson {
name: string // Package name
order: number // Build order
dependencies: string[] // Dependencies to include
registries: string[] // Target registries
bin: string[] // CLI binaries
}
```
This powerful logging helps in tracking the status of each step and understanding potential issues during the operations.
## 🐛 Troubleshooting
### Testing with tapbundle
### Common Issues
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`:
**Package already exists with version X.X.X**
- TSPublish detected a version collision
- Update your monorepo's package.json version
- Or unpublish the existing version if appropriate
```typescript
import { expect, tap } from '@push.rocks/tapbundle';
import * as tspublish from '@git.zone/tspublish';
**No publish modules found**
- Ensure your packages follow the `ts-*` naming convention
- Check that each package has a valid `tspublish.json`
tap.test('Should run the CLI without errors', async () => {
await tspublish.runCli();
expect(tspublish).toBeTruthy();
});
**Build failures**
- Verify TypeScript configuration
- Check that all dependencies are installed
- Review the build output for specific errors
tap.start();
```
## 🔮 Future Features
### Comprehensive usage example
- 🎯 Selective publishing with pattern matching
- 🔄 Automatic version bumping strategies
- 📊 Dry-run mode with detailed preview
- 🏷️ Git tag integration
- 📝 Changelog generation
- 🔐 Enhanced authentication handling
Let's combine all the steps into a complete example where you prepare a monorepo, configure each module, and execute the publishing workflow.
## License and Legal Information
Suppose you have a project structure as follows:
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
```plaintext
my-monorepo/
├── ts-package1/
│ ├── src/
│ ├── tspublish.json
├── ts-package2/
│ ├── src/
│ ├── tspublish.json
```
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
Follow these steps:
### Trademarks
1. Ensure each package has `tspublish.json` properly configured with necessary metadata.
2. Create a CLI script such as `publish.js`:
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
```typescript
import { runCli } from '@git.zone/tspublish';
### Company Information
runCli().then(() => {
console.log('Publishing completed successfully');
}).catch((error) => {
console.error('Error during publishing:', error);
});
```
Task Venture Capital GmbH
Registered at District court Bremen HRB 35230 HB, Germany
3. Execute your CLI script:
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
```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
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

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

@@ -0,0 +1,39 @@
import { expect, tap } from '@git.zone/tstest/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

@@ -1,8 +1,13 @@
import { expect, expectAsync, tap } from '@push.rocks/tapbundle';
import { expect, tap } from '@git.zone/tstest/tapbundle';
import * as tspublish from '../ts/index.js';
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.5.0',
version: '1.10.4',
description: 'A tool to publish multiple, concise, and small packages from monorepos, specifically for TypeScript projects within a git environment.'
}

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

@@ -0,0 +1,108 @@
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 requestBuilder = plugins.smartrequest.SmartRequest.create()
.url(this.baseUrl + `/repos/${owner}/${repo}/contents/${directory}`)
.headers(this.headers);
if (branch) {
requestBuilder.query({ ref: branch });
}
const response = await requestBuilder.get();
let responseBody = await response.json();
if (!Array.isArray(responseBody) && typeof responseBody === 'object') {
responseBody = [responseBody];
} else if (Array.isArray(responseBody)) {
for (const entry of responseBody) {
if (entry.type === 'dir') {
continue;
} else if (entry.type === 'file') {
const requestBuilder2 = plugins.smartrequest.SmartRequest.create()
.url(this.baseUrl + `/repos/${owner}/${repo}/contents/${entry.path}`)
.headers(this.headers);
if (branch) {
requestBuilder2.query({ ref: branch });
}
const response2 = await requestBuilder2.get();
const response2Body = await response2.json();
entry.encoding = response2Body.encoding;
entry.content = response2Body.content;
}
}
}
// lets map to the IRepoFile interface
responseBody = responseBody.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 responseBody;
} 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;
})(),
@@ -56,12 +62,20 @@ export class PublishModule {
// now that we have a name and version, lets check if there is already a package under the same name and version.
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)) {
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);
}
}
@@ -80,8 +94,12 @@ export class PublishModule {
const originalTsConfig = plugins.smartfile.fs.toObjectSync(
plugins.path.join(paths.cwd, 'tsconfig.json')
);
for (const path of originalTsConfig.compilerOptions.paths) {
originalTsConfig.compilerOptions.paths[path][0] = `.${originalTsConfig.compilerOptions.paths[path][0]}`;
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: {
@@ -92,11 +110,9 @@ export class PublishModule {
moduleResolution: 'NodeNext',
esModuleInterop: true,
verbatimModuleSyntax: true,
paths: originalTsConfig.compilerOptions.paths,
paths: originalTsConfig?.compilerOptions?.paths,
},
exclude: [
'dist_*/**/*.d.ts',
],
exclude: ['dist_*/**/*.d.ts'],
};
return JSON.stringify(tsconfigJson, null, 2);
}
@@ -131,18 +147,28 @@ 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}`
);
await plugins.smartfile.fs.ensureEmptyDir(this.options.publishModDirFullPath);
// package.json
await plugins.smartfile.fs.ensureEmptyDir(this.options.publishModDirFullPath);
const packageJson = await plugins.smartfile.SmartFile.fromString(
plugins.path.join(this.options.publishModDirFullPath, 'package.json'),
await this.createPackageJson(),
@@ -151,28 +177,61 @@ 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)
);
// 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',
});
@@ -186,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,19 +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);
logInfo(`Found ${Object.keys(publishModules).length} publish modules`);
logSeparator();
for (const publishModule of Object.keys(publishModules)) {
const publishModuleInstance = new PublishModule({
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();
@@ -21,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;
@@ -33,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,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);
}
};

View File

@@ -1,5 +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,15 +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, smartshell };
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"
]
}
}