Compare commits
14 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 9814f3ade2 | |||
| 0f1fa22c46 | |||
| 47fdb00d5b | |||
| 6971b287b4 | |||
| 9f0d052bcb | |||
| 8752cd0a7e | |||
| 5704894cd3 | |||
| b67c936a65 | |||
| e26bb2b7dd | |||
| 88e377c425 | |||
| b6c13cc44d | |||
| 8a6058c421 | |||
| 9b3d77189a | |||
| eb21dcc4a4 |
57
changelog.md
57
changelog.md
@@ -1,5 +1,62 @@
|
||||
# Changelog
|
||||
|
||||
## 2025-12-16 - 1.11.0 - feat(publish)
|
||||
add registry resolution (useBase/extendBase) and migrate filesystem operations to async SmartFs; improve publish flow and docs
|
||||
|
||||
- Add resolveRegistries supporting 'useBase' and 'extendBase' and explicit registries; reads base registries from npmextra.json at @git.zone/cli.release
|
||||
- Migrate sync smartfile APIs to async @push.rocks/smartfs and expose smartfs and npmextra via plugins
|
||||
- Ensure publish directory is recreated cleanly and use async file copy/read/write for package, tsconfig, readme and license
|
||||
- Handle empty registries by skipping publish with a warning and throw a clear error if useBase/extendBase is used but no base registries configured
|
||||
- Publish now normalizes registry URLs and supports accessLevel per-registry when running pnpm publish
|
||||
- Update README: registry configuration docs, issue reporting/security section and various wording/formatting improvements; bump several dependencies/devDependencies
|
||||
|
||||
## 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
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
{
|
||||
"gitzone": {
|
||||
"@git.zone/cli": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "code.foss.global",
|
||||
@@ -21,10 +21,16 @@
|
||||
"module-management",
|
||||
"developer-tools"
|
||||
]
|
||||
},
|
||||
"release": {
|
||||
"registries": [
|
||||
"https://verdaccio.lossless.digital",
|
||||
"https://registry.npmjs.org"
|
||||
],
|
||||
"accessLevel": "public"
|
||||
}
|
||||
},
|
||||
"npmci": {
|
||||
"npmGlobalTools": [],
|
||||
"npmAccessLevel": "public"
|
||||
"@ship.zone/szci": {
|
||||
"npmGlobalTools": []
|
||||
}
|
||||
}
|
||||
35
package.json
35
package.json
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@git.zone/tspublish",
|
||||
"version": "1.9.0",
|
||||
"version": "1.11.0",
|
||||
"private": false,
|
||||
"description": "A tool to publish multiple, concise, and small packages from monorepos, specifically for TypeScript projects within a git environment.",
|
||||
"main": "dist_ts/index.js",
|
||||
@@ -9,7 +9,7 @@
|
||||
"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)"
|
||||
},
|
||||
@@ -17,12 +17,11 @@
|
||||
"tspublish": "./cli.js"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@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.8.7"
|
||||
"@git.zone/tsbuild": "^4.0.2",
|
||||
"@git.zone/tsbundle": "^2.6.3",
|
||||
"@git.zone/tsrun": "^2.0.1",
|
||||
"@git.zone/tstest": "^3.1.3",
|
||||
"@types/node": "^25.0.2"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
@@ -48,14 +47,17 @@
|
||||
"readme.md"
|
||||
],
|
||||
"dependencies": {
|
||||
"@push.rocks/smartcli": "^4.0.11",
|
||||
"@push.rocks/consolecolor": "^2.0.3",
|
||||
"@push.rocks/npmextra": "^5.3.3",
|
||||
"@push.rocks/smartcli": "^4.0.19",
|
||||
"@push.rocks/smartdelay": "^3.0.5",
|
||||
"@push.rocks/smartfile": "^11.0.21",
|
||||
"@push.rocks/smartlog": "^3.0.7",
|
||||
"@push.rocks/smartnpm": "^2.0.4",
|
||||
"@push.rocks/smartpath": "^5.0.18",
|
||||
"@push.rocks/smartrequest": "^2.0.23",
|
||||
"@push.rocks/smartshell": "^3.0.6"
|
||||
"@push.rocks/smartfile": "^13.1.2",
|
||||
"@push.rocks/smartfs": "^1.3.1",
|
||||
"@push.rocks/smartlog": "^3.1.10",
|
||||
"@push.rocks/smartnpm": "^2.0.6",
|
||||
"@push.rocks/smartpath": "^6.0.0",
|
||||
"@push.rocks/smartrequest": "^5.0.1",
|
||||
"@push.rocks/smartshell": "^3.3.0"
|
||||
},
|
||||
"keywords": [
|
||||
"typescript",
|
||||
@@ -68,5 +70,6 @@
|
||||
"modularity",
|
||||
"module-management",
|
||||
"developer-tools"
|
||||
]
|
||||
],
|
||||
"packageManager": "pnpm@10.11.0+sha512.6540583f41cc5f628eb3d9773ecee802f4f9ef9923cc45b69890fb47991d4b092964694ec3a4f738a420c918a333062c8b925d312f42e4f0c263eb603551f977"
|
||||
}
|
||||
|
||||
9116
pnpm-lock.yaml
generated
9116
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
509
readme.md
509
readme.md
@@ -1,193 +1,412 @@
|
||||
# @git.zone/tspublish
|
||||
# @git.zone/tspublish 🚀
|
||||
|
||||
publish multiple, concise and small packages from monorepos
|
||||
> **Effortlessly publish multiple TypeScript packages from your monorepo**
|
||||
|
||||
## Install
|
||||
[](https://www.npmjs.com/package/@git.zone/tspublish)
|
||||
[](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.
|
||||
|
||||
## Issue Reporting and Security
|
||||
|
||||
For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly.
|
||||
|
||||
### ✨ 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');
|
||||
|
||||
#### 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);
|
||||
// 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();
|
||||
}
|
||||
```
|
||||
|
||||
3. Execute your CLI script:
|
||||
### Registry Configuration
|
||||
|
||||
```bash
|
||||
node publish.js
|
||||
TSPublish supports multiple registries with different access levels. You have three approaches:
|
||||
|
||||
#### 1️⃣ Explicit Registries
|
||||
|
||||
Define specific registries directly in your `tspublish.json`:
|
||||
|
||||
```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
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Your script will call `runCli`, which will traverse each `ts-package`, verify their publish readiness, and handle individual publishing processes.
|
||||
#### 2️⃣ Use Base Configuration (`useBase`)
|
||||
|
||||
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
|
||||
Inherit registries from your project's `npmextra.json` configuration (managed by `gitzone config`):
|
||||
|
||||
```json
|
||||
{
|
||||
"registries": ["useBase"]
|
||||
}
|
||||
```
|
||||
|
||||
This reads from `npmextra.json` under `@git.zone/cli.release.registries`.
|
||||
|
||||
#### 3️⃣ Extend Base Configuration (`extendBase`)
|
||||
|
||||
Start with base registries and add/remove specific ones:
|
||||
|
||||
```json
|
||||
{
|
||||
"registries": [
|
||||
"extendBase",
|
||||
"custom-registry.example.com:public",
|
||||
"-https://registry.npmjs.org" // Exclude this registry
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
The `-` prefix excludes a registry from the base configuration.
|
||||
|
||||
#### Empty Registries
|
||||
|
||||
If no registries are configured, the package will be built but **not published** (a warning is logged).
|
||||
|
||||
### 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
|
||||
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}>
|
||||
}
|
||||
```
|
||||
|
||||
### PublishModule Class
|
||||
|
||||
```typescript
|
||||
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>
|
||||
}
|
||||
```
|
||||
|
||||
### ITsPublishJson Interface
|
||||
|
||||
```typescript
|
||||
interface ITsPublishJson {
|
||||
name: string // Package name
|
||||
order: number // Build order
|
||||
dependencies: string[] // Dependencies to include
|
||||
registries: string[] // Target registries
|
||||
bin: string[] // CLI binaries
|
||||
}
|
||||
```
|
||||
|
||||
## 🐛 Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
**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
|
||||
|
||||
**No publish modules found**
|
||||
- Ensure your packages follow the `ts-*` naming convention
|
||||
- Check that each package has a valid `tspublish.json`
|
||||
|
||||
**Build failures**
|
||||
- Verify TypeScript configuration
|
||||
- Check that all dependencies are installed
|
||||
- Review the build output for specific errors
|
||||
|
||||
**useBase/extendBase error**
|
||||
- Ensure your `npmextra.json` has registries configured at `@git.zone/cli.release.registries`
|
||||
- Use `gitzone config add <registry-url>` to configure base registries
|
||||
|
||||
## License and Legal Information
|
||||
|
||||
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [LICENSE](./LICENSE) file.
|
||||
|
||||
**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.
|
||||
|
||||
### Trademarks
|
||||
|
||||
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 or third parties, 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 or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.
|
||||
|
||||
### Company Information
|
||||
|
||||
Task Venture Capital GmbH
|
||||
Registered at District Court Bremen HRB 35230 HB, Germany
|
||||
|
||||
For any legal inquiries or further information, please contact us via email at hello@task.vc.
|
||||
|
||||
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.
|
||||
@@ -1,4 +1,4 @@
|
||||
import { expect, tap } from '@push.rocks/tapbundle';
|
||||
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||
import * as giteaAssets from '../ts/classes.giteaassets.js';
|
||||
|
||||
let giteaAssetsInstance: giteaAssets.GiteaAssets;
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
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 () => {
|
||||
|
||||
@@ -3,6 +3,6 @@
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@git.zone/tspublish',
|
||||
version: '1.9.0',
|
||||
version: '1.11.0',
|
||||
description: 'A tool to publish multiple, concise, and small packages from monorepos, specifically for TypeScript projects within a git environment.'
|
||||
}
|
||||
|
||||
@@ -44,37 +44,42 @@ export class GiteaAssets {
|
||||
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) {
|
||||
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 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;
|
||||
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
|
||||
response.body = response.body.map((entry: any) => {
|
||||
responseBody = responseBody.map((entry: any) => {
|
||||
return {
|
||||
name: entry.name,
|
||||
path: entry.path,
|
||||
@@ -85,7 +90,7 @@ export class GiteaAssets {
|
||||
};
|
||||
});
|
||||
|
||||
return response.body;
|
||||
return responseBody;
|
||||
} catch (error) {
|
||||
console.error('Error fetching repository files:', error);
|
||||
throw error;
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
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';
|
||||
@@ -16,6 +16,11 @@ export interface IPublishModuleOptions {
|
||||
dependencies?: { [key: string]: string };
|
||||
}
|
||||
|
||||
export interface IResolvedRegistry {
|
||||
url: string;
|
||||
accessLevel: string;
|
||||
}
|
||||
|
||||
export class PublishModule {
|
||||
tsPublishRef: TsPublish;
|
||||
public options: IPublishModuleOptions;
|
||||
@@ -34,14 +39,14 @@ export class PublishModule {
|
||||
if (!this.options.packageSubFolder.startsWith('ts')) {
|
||||
throw new Error('subFolder must start with "ts"');
|
||||
}
|
||||
this.options.tsPublishJson = plugins.smartfile.fs.toObjectSync(
|
||||
plugins.path.join(this.options.packageSubFolderFullPath, 'tspublish.json')
|
||||
);
|
||||
const tspublishJsonPath = plugins.path.join(this.options.packageSubFolderFullPath, 'tspublish.json');
|
||||
const tspublishJsonContent = await plugins.smartfs.file(tspublishJsonPath).encoding('utf8').read();
|
||||
this.options.tsPublishJson = JSON.parse(tspublishJsonContent as string);
|
||||
|
||||
// the package.json of the parent mono repo
|
||||
const monoRepoPackageJson = JSON.parse(
|
||||
plugins.smartfile.fs.toStringSync(plugins.path.join(this.options.monoRepoDir, 'package.json'))
|
||||
);
|
||||
const packageJsonPath = plugins.path.join(this.options.monoRepoDir, 'package.json');
|
||||
const packageJsonContent = await plugins.smartfs.file(packageJsonPath).encoding('utf8').read();
|
||||
const monoRepoPackageJson = JSON.parse(packageJsonContent as string);
|
||||
|
||||
this.options.dependencies = {
|
||||
...this.options.dependencies,
|
||||
@@ -66,16 +71,15 @@ export class PublishModule {
|
||||
try {
|
||||
packageInfo = await smartnpmInstance.getPackageInfo(this.options.name);
|
||||
} catch (error) {
|
||||
logger.log('warn', `package does not yet seem to exist. Proceeding in 10 seconds...`);
|
||||
logWarn(`Package ${this.options.name} does not yet seem to exist. Proceeding in 10 seconds...`);
|
||||
await plugins.smartdelay.delayFor(10000);
|
||||
}
|
||||
if (packageInfo) {
|
||||
const availableVersions = packageInfo.allVersions.map((versionArg) => versionArg.version);
|
||||
logger.log('info', `available versions are: ${availableVersions.toString()}`);
|
||||
logInfo(`Available versions for ${this.options.name}: ${availableVersions.join(', ')}`);
|
||||
if (availableVersions.includes(this.options.version)) {
|
||||
logger.log(
|
||||
'error',
|
||||
`package ${this.options.name} already exists with version ${this.options.version}`
|
||||
logError(
|
||||
`Package ${this.options.name} already exists with version ${this.options.version}`
|
||||
);
|
||||
process.exit(1);
|
||||
}
|
||||
@@ -92,9 +96,12 @@ export class PublishModule {
|
||||
}
|
||||
|
||||
public async createTsconfigJson() {
|
||||
const originalTsConfig = plugins.smartfile.fs.toObjectSync(
|
||||
plugins.path.join(paths.cwd, 'tsconfig.json')
|
||||
);
|
||||
const tsconfigPath = plugins.path.join(paths.cwd, 'tsconfig.json');
|
||||
let originalTsConfig: any = null;
|
||||
if (await plugins.smartfs.file(tsconfigPath).exists()) {
|
||||
const tsconfigContent = await plugins.smartfs.file(tsconfigPath).encoding('utf8').read();
|
||||
originalTsConfig = JSON.parse(tsconfigContent as string);
|
||||
}
|
||||
if (originalTsConfig?.compilerOptions?.paths) {
|
||||
for (const path of Object.keys(originalTsConfig.compilerOptions.paths)) {
|
||||
originalTsConfig.compilerOptions.paths[
|
||||
@@ -162,55 +169,52 @@ export class PublishModule {
|
||||
}
|
||||
|
||||
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);
|
||||
|
||||
// Ensure empty directory
|
||||
const publishDir = plugins.smartfs.directory(this.options.publishModDirFullPath);
|
||||
if (await publishDir.exists()) {
|
||||
await publishDir.recursive().delete();
|
||||
}
|
||||
await publishDir.recursive().create();
|
||||
|
||||
// package.json
|
||||
const packageJson = await plugins.smartfile.SmartFile.fromString(
|
||||
plugins.path.join(this.options.publishModDirFullPath, 'package.json'),
|
||||
await this.createPackageJson(),
|
||||
'utf8'
|
||||
);
|
||||
await packageJson.write();
|
||||
const packageJsonPath = plugins.path.join(this.options.publishModDirFullPath, 'package.json');
|
||||
await plugins.smartfs.file(packageJsonPath).encoding('utf8').write(await this.createPackageJson());
|
||||
|
||||
// tsconfig.json
|
||||
const tsconfigJson = await plugins.smartfile.SmartFile.fromString(
|
||||
plugins.path.join(this.options.publishModDirFullPath, 'tsconfig.json'),
|
||||
await this.createTsconfigJson(),
|
||||
'utf8'
|
||||
);
|
||||
await tsconfigJson.write();
|
||||
const tsconfigJsonPath = plugins.path.join(this.options.publishModDirFullPath, 'tsconfig.json');
|
||||
await plugins.smartfs.file(tsconfigJsonPath).encoding('utf8').write(await this.createTsconfigJson());
|
||||
|
||||
// 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)
|
||||
);
|
||||
const destSubFolder = plugins.path.join(this.options.publishModDirFullPath, this.options.packageSubFolder);
|
||||
await plugins.smartfs.directory(this.options.packageSubFolderFullPath).recursive().copy(destSubFolder);
|
||||
|
||||
// readme
|
||||
await plugins.smartfile.fs.copy(
|
||||
plugins.path.join(this.options.packageSubFolderFullPath, 'readme.md'),
|
||||
plugins.path.join(this.options.publishModDirFullPath, 'readme.md')
|
||||
);
|
||||
const readmeSrc = plugins.path.join(this.options.packageSubFolderFullPath, 'readme.md');
|
||||
const readmeDest = plugins.path.join(this.options.publishModDirFullPath, 'readme.md');
|
||||
await plugins.smartfs.file(readmeSrc).copy(readmeDest);
|
||||
|
||||
// license
|
||||
await plugins.smartfile.fs.copy(
|
||||
plugins.path.join(this.options.monoRepoDir, 'license'),
|
||||
plugins.path.join(this.options.publishModDirFullPath, 'license')
|
||||
);
|
||||
const licenseSrc = plugins.path.join(this.options.monoRepoDir, 'license');
|
||||
const licenseDest = plugins.path.join(this.options.publishModDirFullPath, 'license');
|
||||
await plugins.smartfs.file(licenseSrc).copy(licenseDest);
|
||||
|
||||
// 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() {
|
||||
@@ -223,22 +227,108 @@ export class PublishModule {
|
||||
'cli',
|
||||
'assets/templates/cli/cli.js'
|
||||
);
|
||||
await plugins.smartfile.memory.toFs(atob(files[0].base64Content), plugins.path.join(this.options.publishModDirFullPath, 'cli.js'));
|
||||
const indexPath = `./dist_${this.options.packageSubFolder}/index.js`;
|
||||
const fileContent = atob(files[0].base64Content).replace('./dist_ts/index.js', indexPath);
|
||||
const cliJsPath = plugins.path.join(this.options.publishModDirFullPath, 'cli.js');
|
||||
await plugins.smartfs.file(cliJsPath).encoding('utf8').write(fileContent);
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolves the registries to publish to based on tspublish.json configuration.
|
||||
* Supports:
|
||||
* - "useBase": Use only registries from npmextra.json
|
||||
* - "extendBase": Use base registries + additions, with exclusions via "-" prefix
|
||||
* - Explicit registries: Direct registry URLs in format "url:accessLevel"
|
||||
*/
|
||||
private async resolveRegistries(): Promise<IResolvedRegistry[]> {
|
||||
const rawRegistries = this.options.tsPublishJson?.registries || [];
|
||||
|
||||
// Empty → skip publishing
|
||||
if (rawRegistries.length === 0) {
|
||||
return [];
|
||||
}
|
||||
|
||||
const hasUseBase = rawRegistries.includes('useBase');
|
||||
const hasExtendBase = rawRegistries.includes('extendBase');
|
||||
|
||||
let baseRegistries: string[] = [];
|
||||
let baseAccessLevel = 'public';
|
||||
|
||||
// Load base registries from npmextra.json if needed
|
||||
if (hasUseBase || hasExtendBase) {
|
||||
const npmextraInstance = new plugins.npmextra.Npmextra(this.options.monoRepoDir);
|
||||
const gitzoneConfig = npmextraInstance.dataFor<any>('@git.zone/cli', {});
|
||||
baseRegistries = gitzoneConfig?.release?.registries || [];
|
||||
baseAccessLevel = gitzoneConfig?.release?.accessLevel || 'public';
|
||||
|
||||
if (baseRegistries.length === 0) {
|
||||
throw new Error(
|
||||
`useBase/extendBase specified in tspublish.json but no registries configured in npmextra.json at @git.zone/cli.release.registries`
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
// useBase: Only base registries
|
||||
if (hasUseBase) {
|
||||
return baseRegistries.map((url) => ({ url, accessLevel: baseAccessLevel }));
|
||||
}
|
||||
|
||||
// extendBase: Base registries + additions - exclusions
|
||||
if (hasExtendBase) {
|
||||
const exclusions = rawRegistries
|
||||
.filter((r) => r.startsWith('-'))
|
||||
.map((r) => r.slice(1)); // remove '-' prefix
|
||||
|
||||
const additions = rawRegistries.filter((r) => r !== 'extendBase' && !r.startsWith('-'));
|
||||
|
||||
// Filter out excluded base registries
|
||||
const result: IResolvedRegistry[] = baseRegistries
|
||||
.filter((url) => !exclusions.includes(url))
|
||||
.map((url) => ({ url, accessLevel: baseAccessLevel }));
|
||||
|
||||
// Add explicit registries
|
||||
for (const addition of additions) {
|
||||
const parts = addition.split(':');
|
||||
const url = parts[0];
|
||||
const access = parts[1] || 'public';
|
||||
result.push({ url, accessLevel: access });
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
// Explicit registries only (original behavior)
|
||||
return rawRegistries.map((r) => {
|
||||
const parts = r.split(':');
|
||||
const url = parts[0];
|
||||
const access = parts[1] || 'public';
|
||||
return { url, accessLevel: access };
|
||||
});
|
||||
}
|
||||
|
||||
public async publish() {
|
||||
const registries = await this.resolveRegistries();
|
||||
|
||||
// Handle empty registries
|
||||
if (registries.length === 0) {
|
||||
logWarn(`No registries configured for ${this.options.name}. Skipping publish.`);
|
||||
return;
|
||||
}
|
||||
|
||||
logPublish(`Publishing ${this.options.name} v${this.options.version} to ${registries.length} registry(ies)...`);
|
||||
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];
|
||||
|
||||
for (const registry of registries) {
|
||||
const registryUrl = registry.url.startsWith('https://') ? registry.url : `https://${registry.url}`;
|
||||
logOngoing(`Publishing to ${registryUrl}...`);
|
||||
await smartshellInstance.exec(
|
||||
`cd ${this.options.publishModDirFullPath} && pnpm publish ${
|
||||
registryAccessLevel === 'public' ? '--access public' : ''
|
||||
} --no-git-checks --registry https://${registryUrl}`
|
||||
registry.accessLevel === 'public' ? '--access public' : ''
|
||||
} --no-git-checks --registry ${registryUrl}`
|
||||
);
|
||||
}
|
||||
logSuccess(`Successfully published ${this.options.name} v${this.options.version}!`);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
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';
|
||||
|
||||
@@ -15,24 +15,26 @@ export class TsPublish {
|
||||
}
|
||||
|
||||
public async publish(monorepoDirArg: string) {
|
||||
logHeader('TSPublish - Module Publisher');
|
||||
const publishModules = await this.getModuleSubDirs(monorepoDirArg);
|
||||
logger.log('info', `Found ${Object.keys(publishModules).length} publish modules:`);
|
||||
logInfo(`Found ${Object.keys(publishModules).length} publish modules`);
|
||||
logSeparator();
|
||||
for (const publishModule of Object.keys(publishModules)) {
|
||||
logger.log(
|
||||
'info',
|
||||
`Publishing module: ${publishModule} -> ${publishModules[publishModule].name}`
|
||||
);
|
||||
logPackage('Module found', `${publishModule} → ${publishModules[publishModule].name}`);
|
||||
}
|
||||
for (const publishModule of Object.keys(publishModules)) {
|
||||
// lets check wether there is a name
|
||||
if (!publishModules[publishModule].name) {
|
||||
logger.log('warn', `no name found in tspublish.json for ${publishModule}. Skipping...`);
|
||||
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();
|
||||
@@ -41,25 +43,30 @@ export class TsPublish {
|
||||
}
|
||||
|
||||
public async getModuleSubDirs(dirArg: string) {
|
||||
const subDirs = await plugins.smartfile.fs.listFolders(dirArg);
|
||||
// List all directories
|
||||
const dirContents = await plugins.smartfs.directory(dirArg).list();
|
||||
const publishModules: { [key: string]: interfaces.ITsPublishJson } = {};
|
||||
for (const subDir of subDirs) {
|
||||
if (!subDir.startsWith('ts')) {
|
||||
continue;
|
||||
}
|
||||
const fileTree = await plugins.smartfile.fs.listFileTree(subDir, '**/*');
|
||||
const hasPublishJson = fileTree.includes('tspublish.json');
|
||||
if (!hasPublishJson) {
|
||||
|
||||
for (const entry of dirContents) {
|
||||
const subDirName = entry.name;
|
||||
if (!subDirName.startsWith('ts')) {
|
||||
continue;
|
||||
}
|
||||
|
||||
logger.log('info', `found publish module: ${subDir}`);
|
||||
publishModules[subDir] = JSON.parse(
|
||||
plugins.smartfile.fs.toStringSync(plugins.path.join(subDir, 'tspublish.json'))
|
||||
);
|
||||
// Check if this is a directory and has tspublish.json
|
||||
const subDirPath = plugins.path.join(dirArg, subDirName);
|
||||
const tspublishJsonPath = plugins.path.join(subDirPath, 'tspublish.json');
|
||||
|
||||
if (!(await plugins.smartfs.file(tspublishJsonPath).exists())) {
|
||||
continue;
|
||||
}
|
||||
|
||||
logPackage('Found module', subDirName);
|
||||
const tspublishContent = await plugins.smartfs.file(tspublishJsonPath).encoding('utf8').read();
|
||||
publishModules[subDirName] = JSON.parse(tspublishContent as string);
|
||||
}
|
||||
logger.log('ok', `found ${Object.keys(publishModules).length} publish modules`);
|
||||
logger.log('info', `Ordering publish modules...`);
|
||||
logSuccess(`Found ${Object.keys(publishModules).length} publish modules`);
|
||||
logInfo('Ordering publish modules...');
|
||||
|
||||
return publishModules;
|
||||
}
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
import * as paths from './paths.js';
|
||||
import { TsPublish } from './classes.tspublish.js';
|
||||
import { logStart } from './logging.js';
|
||||
|
||||
export * from './classes.tspublish.js';
|
||||
|
||||
export const runCli = async () => {
|
||||
console.log('Starting tspublish...');
|
||||
logStart('tspublish');
|
||||
const tspublish = new TsPublish();
|
||||
await tspublish.publish(paths.cwd);
|
||||
};
|
||||
|
||||
@@ -3,3 +3,102 @@ import * as commitinfo from './00_commitinfo_data.js';
|
||||
|
||||
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);
|
||||
};
|
||||
|
||||
@@ -3,7 +3,10 @@ import * as path from 'path';
|
||||
export { path };
|
||||
|
||||
// @push.rocks scope
|
||||
import * as consolecolor from '@push.rocks/consolecolor';
|
||||
import * as npmextra from '@push.rocks/npmextra';
|
||||
import * as smartfile from '@push.rocks/smartfile';
|
||||
import { SmartFs, SmartFsProviderNode } from '@push.rocks/smartfs';
|
||||
import * as smartcli from '@push.rocks/smartcli';
|
||||
import * as smartdelay from '@push.rocks/smartdelay';
|
||||
import * as smartlog from '@push.rocks/smartlog';
|
||||
@@ -12,4 +15,7 @@ import * as smartpath from '@push.rocks/smartpath';
|
||||
import * as smartrequest from '@push.rocks/smartrequest';
|
||||
import * as smartshell from '@push.rocks/smartshell';
|
||||
|
||||
export { smartfile, smartcli, smartdelay, smartlog, smartnpm, smartpath, smartrequest, smartshell };
|
||||
// Create a pre-configured SmartFs instance for Node.js filesystem operations
|
||||
const smartfs = new SmartFs(new SmartFsProviderNode());
|
||||
|
||||
export { consolecolor, npmextra, smartfile, smartfs, smartcli, smartdelay, smartlog, smartnpm, smartpath, smartrequest, smartshell };
|
||||
|
||||
Reference in New Issue
Block a user