Compare commits
66 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| f579f181b4 | |||
| 9d6daa0430 | |||
| 58ae83f732 | |||
| 3971ce0c84 | |||
| d7e387765f | |||
| 3efde32e06 | |||
| 9814f3ade2 | |||
| 0f1fa22c46 | |||
| 47fdb00d5b | |||
| 6971b287b4 | |||
| 9f0d052bcb | |||
| 8752cd0a7e | |||
| 5704894cd3 | |||
| b67c936a65 | |||
| e26bb2b7dd | |||
| 88e377c425 | |||
| b6c13cc44d | |||
| 8a6058c421 | |||
| 9b3d77189a | |||
| eb21dcc4a4 | |||
| 66145c904e | |||
| 23f89eabf3 | |||
| 51ca619151 | |||
| 6a8c860c79 | |||
| 9fdbf7f154 | |||
| 50456fc004 | |||
| 1cb97cbf95 | |||
| f8ceff48b2 | |||
| 910cb4c8bf | |||
| 9bddf09aa7 | |||
| 4e8671a21d | |||
| 78c73ee713 | |||
| 5b768288c5 | |||
| 023aea2494 | |||
| ac839d5419 | |||
| 750f081c03 | |||
| 125be257d6 | |||
| d4c7fa8d6b | |||
| 9d41d036f5 | |||
| 94c38e21b3 | |||
| 6b3cd84b65 | |||
| b2f63efa18 | |||
| 1d749417a1 | |||
| 7dc98f9dd3 | |||
| 1ea207cda1 | |||
| ff365ee508 | |||
| a3226efd9a | |||
| f74a6bf2ad | |||
| d47ac4793d | |||
| 9a89b63cf9 | |||
| 4ee31f85ab | |||
| 2b518722df | |||
| 5f9bd73904 | |||
| 91f3c90607 | |||
| f518670443 | |||
| dc97693ec8 | |||
| 386504b0fb | |||
| a7c631bba1 | |||
| 5922249742 | |||
| 274b730492 | |||
| 5bdc3e8bcc | |||
| 5389034108 | |||
| a656e3e040 | |||
| 819c1dca0f | |||
| f3d641d1c1 | |||
| 1fd74928c5 |
@@ -1,5 +1,5 @@
|
|||||||
{
|
{
|
||||||
"gitzone": {
|
"@git.zone/cli": {
|
||||||
"projectType": "npm",
|
"projectType": "npm",
|
||||||
"module": {
|
"module": {
|
||||||
"githost": "code.foss.global",
|
"githost": "code.foss.global",
|
||||||
@@ -21,10 +21,16 @@
|
|||||||
"module-management",
|
"module-management",
|
||||||
"developer-tools"
|
"developer-tools"
|
||||||
]
|
]
|
||||||
|
},
|
||||||
|
"release": {
|
||||||
|
"registries": [
|
||||||
|
"https://verdaccio.lossless.digital",
|
||||||
|
"https://registry.npmjs.org"
|
||||||
|
],
|
||||||
|
"accessLevel": "public"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"npmci": {
|
"@ship.zone/szci": {
|
||||||
"npmGlobalTools": [],
|
"npmGlobalTools": []
|
||||||
"npmAccessLevel": "public"
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
2
.vscode/settings.json
vendored
2
.vscode/settings.json
vendored
@@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"json.schemas": [
|
"json.schemas": [
|
||||||
{
|
{
|
||||||
"fileMatch": ["/npmextra.json"],
|
"fileMatch": ["/.smartconfig.json"],
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
|
|||||||
226
changelog.md
226
changelog.md
@@ -1,5 +1,231 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## 2026-03-24 - 1.11.4 - fix(config)
|
||||||
|
rename npmextra configuration to .smartconfig.json and align publish packaging with updated config handling
|
||||||
|
|
||||||
|
- replaces packaged config file references from npmextra.json to .smartconfig.json
|
||||||
|
- updates publish module typings and null checks for tsPublishJson, package info, and file paths
|
||||||
|
- bumps build and runtime dependencies to newer compatible versions
|
||||||
|
- simplifies tsconfig.json by removing unused baseUrl and paths settings
|
||||||
|
- refreshes README content to document current CLI, registry, and package publishing behavior
|
||||||
|
|
||||||
|
## 2026-03-24 - 1.11.3 - fix(config)
|
||||||
|
replace npmextra with smartconfig for base registry resolution
|
||||||
|
|
||||||
|
- Switch the base registry source from npmextra.json to smartconfig.json for publish configuration.
|
||||||
|
- Update plugin imports and runtime config loading to use @push.rocks/smartconfig.
|
||||||
|
- Adjust packaged files and error messages to reference smartconfig.json consistently.
|
||||||
|
|
||||||
|
## 2026-03-05 - 1.11.2 - fix(deps)
|
||||||
|
bump @push.rocks/smartshell dependency to ^3.3.7 and update package version to 1.11.1
|
||||||
|
|
||||||
|
- package.json: version 1.11.0 -> 1.11.1
|
||||||
|
- package.json: @push.rocks/smartshell ^3.3.0 -> ^3.3.7
|
||||||
|
- ts/00_commitinfo_data.ts: version updated to 1.11.1
|
||||||
|
- changelog.md: added entry documenting the dependency bump and patch release
|
||||||
|
|
||||||
|
## 2026-03-05 - 1.11.1 - fix(deps)
|
||||||
|
bump @push.rocks/smartshell dependency to ^3.3.7
|
||||||
|
|
||||||
|
- package.json: @push.rocks/smartshell ^3.3.0 -> ^3.3.7
|
||||||
|
- Only dependency version updated (patch-level)
|
||||||
|
|
||||||
|
## 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
|
||||||
|
|
||||||
|
- Introduced GiteaAssets class to handle gitea asset fetching.
|
||||||
|
- Updated TsPublish and PublishModule classes to use GiteaAssets.
|
||||||
|
- Fixed queryParams in getFiles method of GiteaAssets.
|
||||||
|
|
||||||
|
## 2025-01-01 - 1.8.0 - feat(core)
|
||||||
|
Added GiteaAssets class for managing files in Gitea repositories
|
||||||
|
|
||||||
|
- Introduced GiteaAssets class to handle file retrieval from Gitea repositories.
|
||||||
|
- Added tests for GiteaAssets implementation.
|
||||||
|
- Updated plugins module to include smartrequest for HTTP requests.
|
||||||
|
|
||||||
|
## 2024-11-05 - 1.7.7 - fix(core)
|
||||||
|
Fix dependency resolution in package initialization
|
||||||
|
|
||||||
|
- Corrected the resolution of dependencies from tspublish.json against monorepo's package.json.
|
||||||
|
- Ensures unlisted dependencies in monorepo's package.json default to its version.
|
||||||
|
|
||||||
|
## 2024-11-05 - 1.7.6 - fix(tspublish)
|
||||||
|
Fix the logging of the number of found publish modules
|
||||||
|
|
||||||
|
- Corrected the way the number of publish modules is logged by using Object.keys(publishModules).length instead of publishModules.length.
|
||||||
|
|
||||||
|
## 2024-11-05 - 1.7.5 - fix(core)
|
||||||
|
Fix issue with tspublish.json name validation in TsPublish class
|
||||||
|
|
||||||
|
- Resolved incorrect JSON parsing and validation for 'name' property in tspublish.json in the TsPublish.publish method.
|
||||||
|
- Removed redundant JSON parse from plugin.smartfile.fs.toStringSync in publish method.
|
||||||
|
|
||||||
|
## 2024-11-05 - 1.7.4 - fix(classes.tspublish)
|
||||||
|
Refactor getModuleSubDirs method to streamline name validation for publish modules
|
||||||
|
|
||||||
|
- Moved the check for the presence of the 'name' field in tspublish.json from getModuleSubDirs to the publish method.
|
||||||
|
- Added log warning and continue flow if 'name' is not found during the publish process.
|
||||||
|
|
||||||
|
## 2024-11-05 - 1.7.3 - fix(TsPublish)
|
||||||
|
Add validation for tspublish.json name field
|
||||||
|
|
||||||
|
- Ensure that the tspublish.json file contains a valid name field before processing.
|
||||||
|
- Log a warning message if the name is not found in tspublish.json.
|
||||||
|
|
||||||
|
## 2024-11-05 - 1.7.2 - fix(project)
|
||||||
|
Fixed minor formatting issues and improved code consistency.
|
||||||
|
|
||||||
|
- Added missing semicolons for consistency
|
||||||
|
- Improved indentation in various files for better readability
|
||||||
|
- Corrected usage of newlines and whitespace across the codebase
|
||||||
|
|
||||||
|
## 2024-11-05 - 1.7.1 - fix(core)
|
||||||
|
Implement error handling for missing publish module directories
|
||||||
|
|
||||||
|
- Improved logging for package publish steps
|
||||||
|
- Enhanced CLI feedback messages during the publishing process
|
||||||
|
- Restructured package.json to ensure proper dependencies are published
|
||||||
|
|
||||||
|
## 2024-11-05 - 1.7.0 - feat(core)
|
||||||
|
Enhanced tspublish with ordered compilation and updated dependencies
|
||||||
|
|
||||||
|
- Added 'order' property to ITsPublishJson interface to ensure project compilation order.
|
||||||
|
- Updated development dependencies: @git.zone/tsbuild, @git.zone/tsbundle, @git.zone/tsrun, and @types/node.
|
||||||
|
|
||||||
|
## 2024-10-28 - 1.6.0 - feat(classes.publishmodule)
|
||||||
|
Added copying of readme and license files to publish directory
|
||||||
|
|
||||||
|
- Enhanced the createPublishModuleDir method in PublishModule class to copy the 'readme.md' and 'license' files to the publish directory.
|
||||||
|
|
||||||
|
## 2024-10-28 - 1.5.5 - fix(core)
|
||||||
|
Handled non-existent package in publish module to avoid errors
|
||||||
|
|
||||||
|
- Added error handling in TsPublish for packages not yet existing in the registry.
|
||||||
|
|
||||||
|
## 2024-10-28 - 1.5.4 - fix(core)
|
||||||
|
Fix issues with path keys in tsconfig and logger setup in logging.ts.
|
||||||
|
|
||||||
|
- Corrected the iteration over paths in the createTsconfigJson method of PublishModule.
|
||||||
|
- Fixed logger setup by ensuring console is enabled in logging.ts.
|
||||||
|
|
||||||
|
## 2024-10-28 - 1.5.3 - fix(core)
|
||||||
|
Fix incorrect logging and directory preparation
|
||||||
|
|
||||||
|
- Corrected logging to accurately report the number of detected publish modules.
|
||||||
|
- Ensured the publish directory is emptied before creating package.json.
|
||||||
|
|
||||||
|
## 2024-10-28 - 1.5.2 - fix(core)
|
||||||
|
Add logging for found publish modules
|
||||||
|
|
||||||
|
- Added console logging to display the count and list of discovered publish modules during the publish process.
|
||||||
|
- Included a startup log message indicating the beginning of the tspublish process.
|
||||||
|
|
||||||
|
## 2024-10-28 - 1.5.1 - fix(core)
|
||||||
|
Fixes handling of undefined paths in tsconfig generation.
|
||||||
|
|
||||||
|
- Added a null check for `paths` in the original tsconfig before modifying it.
|
||||||
|
- Enhanced testing by adding a test case for creating a TsPublish instance.
|
||||||
|
|
||||||
|
## 2024-10-28 - 1.5.0 - feat(classes.publishmodule)
|
||||||
|
Add method to create and write tsconfig.json during publish module setup
|
||||||
|
|
||||||
|
- Introduced createTsconfigJson method in PublishModule class to generate a tsconfig.json for each publishable module.
|
||||||
|
- Modified createPublishModuleDir method to include writing of tsconfig.json file.
|
||||||
|
|
||||||
|
## 2024-10-26 - 1.4.0 - feat(core)
|
||||||
|
Refactor directory reading and module discovery for publishing process
|
||||||
|
|
||||||
|
- Renamed 'readDirectory' method to 'getModuleSubDirs' for clarity in describing function purpose.
|
||||||
|
- Enhanced 'getModuleSubDirs' to return module information including parsed 'tspublish.json' data for each module.
|
||||||
|
- Introduced new 'interfaces' directory to define TypeScript interfaces like 'ITsPublishJson'.
|
||||||
|
|
||||||
|
## 2024-10-23 - 1.3.3 - fix(core)
|
||||||
|
Fix logging mechanism on existing package version check
|
||||||
|
|
||||||
|
- Changed the error handling mechanism when a package with the same version already exists to use logger and process exit instead of throwing an error.
|
||||||
|
|
||||||
|
## 2024-10-23 - 1.3.2 - fix(core)
|
||||||
|
Corrected file patterns in dynamically created package.json files.
|
||||||
|
|
||||||
|
- Fixed incorrect file pattern from 'ts_web/**/*' to 'ts_*/**/*' in package.json creation process to include all subdirectories starting with 'ts'.
|
||||||
|
|
||||||
|
## 2024-10-23 - 1.3.1 - fix(classes.publishmodule)
|
||||||
|
Fix template string in createPackageJson method for export path
|
||||||
|
|
||||||
|
- Corrected the syntax for template string in the exports path of created package.json
|
||||||
|
|
||||||
|
## 2024-10-21 - 1.3.0 - feat(core)
|
||||||
|
Add support for multiple registries in the publish process
|
||||||
|
|
||||||
|
- Updated the PublishModule class to handle multiple registries for publishing.
|
||||||
|
- Refactored the handling of tspublish.json by incorporating it into the PublishModule options.
|
||||||
|
- Implemented logic to parse registry access level and apply it during publication.
|
||||||
|
|
||||||
|
## 2024-10-21 - 1.2.4 - fix(publishmodule)
|
||||||
|
Fix syntax errors and improve formatting in classes.publishmodule.ts
|
||||||
|
|
||||||
|
- Fixed missing semicolons in multiple locations for improved syntax correctness.
|
||||||
|
- Improved the formatting for better code readability.
|
||||||
|
- Added --no-git-checks flag to the pnpm publish command.
|
||||||
|
|
||||||
## 2024-10-21 - 1.2.3 - fix(logs)
|
## 2024-10-21 - 1.2.3 - fix(logs)
|
||||||
Improve logging mechanism with structured logs for publish process
|
Improve logging mechanism with structured logs for publish process
|
||||||
|
|
||||||
|
|||||||
21
license
Normal file
21
license
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2024 Task Venture Capital GmbH
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
39
package.json
39
package.json
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@git.zone/tspublish",
|
"name": "@git.zone/tspublish",
|
||||||
"version": "1.2.3",
|
"version": "1.11.4",
|
||||||
"private": false,
|
"private": false,
|
||||||
"description": "A tool to publish multiple, concise, and small packages from monorepos, specifically for TypeScript projects within a git environment.",
|
"description": "A tool to publish multiple, concise, and small packages from monorepos, specifically for TypeScript projects within a git environment.",
|
||||||
"main": "dist_ts/index.js",
|
"main": "dist_ts/index.js",
|
||||||
@@ -9,20 +9,19 @@
|
|||||||
"author": "Task Venture Capital GmbH",
|
"author": "Task Venture Capital GmbH",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "(tstest test/ --web)",
|
"test": "(tstest test/ --verbose --testlog --timeout 30)",
|
||||||
"build": "(tsbuild --web --allowimplicitany)",
|
"build": "(tsbuild --web --allowimplicitany)",
|
||||||
"buildDocs": "(tsdoc)"
|
"buildDocs": "(tsdoc)"
|
||||||
},
|
},
|
||||||
"bin": {
|
"bin": {
|
||||||
"tspublish": "cli.js"
|
"tspublish": "./cli.js"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@git.zone/tsbuild": "^2.1.25",
|
"@git.zone/tsbuild": "^4.4.0",
|
||||||
"@git.zone/tsbundle": "^2.0.5",
|
"@git.zone/tsbundle": "^2.10.0",
|
||||||
"@git.zone/tsrun": "^1.2.46",
|
"@git.zone/tsrun": "^2.0.1",
|
||||||
"@git.zone/tstest": "^1.0.44",
|
"@git.zone/tstest": "^3.5.1",
|
||||||
"@push.rocks/tapbundle": "^5.0.15",
|
"@types/node": "^25.5.0"
|
||||||
"@types/node": "^22.7.7"
|
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
@@ -44,16 +43,21 @@
|
|||||||
"dist_ts_web/**/*",
|
"dist_ts_web/**/*",
|
||||||
"assets/**/*",
|
"assets/**/*",
|
||||||
"cli.js",
|
"cli.js",
|
||||||
"npmextra.json",
|
".smartconfig.json",
|
||||||
"readme.md"
|
"readme.md"
|
||||||
],
|
],
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@push.rocks/smartcli": "^4.0.11",
|
"@push.rocks/consolecolor": "^2.0.3",
|
||||||
"@push.rocks/smartfile": "^11.0.21",
|
"@push.rocks/smartcli": "^4.0.20",
|
||||||
"@push.rocks/smartlog": "^3.0.7",
|
"@push.rocks/smartconfig": "^6.0.1",
|
||||||
"@push.rocks/smartnpm": "^2.0.4",
|
"@push.rocks/smartdelay": "^3.0.5",
|
||||||
"@push.rocks/smartpath": "^5.0.18",
|
"@push.rocks/smartfile": "^13.1.2",
|
||||||
"@push.rocks/smartshell": "^3.0.6"
|
"@push.rocks/smartfs": "^1.5.0",
|
||||||
|
"@push.rocks/smartlog": "^3.2.1",
|
||||||
|
"@push.rocks/smartnpm": "^2.0.6",
|
||||||
|
"@push.rocks/smartpath": "^6.0.0",
|
||||||
|
"@push.rocks/smartrequest": "^5.0.1",
|
||||||
|
"@push.rocks/smartshell": "^3.3.8"
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"typescript",
|
"typescript",
|
||||||
@@ -66,5 +70,6 @@
|
|||||||
"modularity",
|
"modularity",
|
||||||
"module-management",
|
"module-management",
|
||||||
"developer-tools"
|
"developer-tools"
|
||||||
]
|
],
|
||||||
|
"packageManager": "pnpm@10.11.0+sha512.6540583f41cc5f628eb3d9773ecee802f4f9ef9923cc45b69890fb47991d4b092964694ec3a4f738a420c918a333062c8b925d312f42e4f0c263eb603551f977"
|
||||||
}
|
}
|
||||||
|
|||||||
9859
pnpm-lock.yaml
generated
9859
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
398
readme.md
398
readme.md
@@ -1,191 +1,349 @@
|
|||||||
# @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 a powerful CLI tool and library for managing and publishing multiple TypeScript packages from a monorepo. It automates the tedious parts of package publishing — discovery, dependency resolution, building, version validation, and multi-registry 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 dramatically 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 `ts*` directories
|
||||||
|
- 🎨 **Beautiful CLI Output** — Color-coded logging with progress bars and status indicators
|
||||||
|
- 🔍 **Version Collision Detection** — Prevents accidental overwrites by checking the registry first
|
||||||
|
- 🏗️ **Build Integration** — Automatically compiles TypeScript before publishing via `@git.zone/tsbuild`
|
||||||
|
- 🎯 **Smart Dependency Management** — Inherits dependency versions from your monorepo's `package.json`
|
||||||
|
- 🌐 **Multi-Registry Support** — Publish to npm, GitHub Packages, Gitea, or private registries
|
||||||
|
- 🔗 **Base Registry Inheritance** — Use `useBase` / `extendBase` to inherit registries from `.smartconfig.json`
|
||||||
|
- ⚡ **CLI Binary Support** — Automatically generates `cli.js` wrappers for publishable CLI packages
|
||||||
|
- 🧹 **Clean Builds** — Creates isolated `dist_publish_*` directories for each package
|
||||||
|
|
||||||
|
## 📥 Installation
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install @git.zone/tspublish
|
# Using pnpm (recommended)
|
||||||
|
pnpm add -D @git.zone/tspublish
|
||||||
|
|
||||||
|
# Global installation for CLI usage
|
||||||
|
pnpm add -g @git.zone/tspublish
|
||||||
```
|
```
|
||||||
|
|
||||||
Alternatively, if you are using yarn, the equivalent command would be:
|
## 🚀 Quick Start
|
||||||
|
|
||||||
```bash
|
### 1️⃣ Structure Your Monorepo
|
||||||
yarn add @git.zone/tspublish
|
|
||||||
```
|
|
||||||
|
|
||||||
These commands will add `@git.zone/tspublish` as a dependency in your `package.json` file and install the package into your `node_modules` directory.
|
Organize your packages using directories that start with `ts`:
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
`@git.zone/tspublish` is designed to manage the publishing of multiple, small-scale packages within monorepos. The following sections will guide you through its usage, from setting up your environment to effectively publishing packages.
|
|
||||||
|
|
||||||
### Getting Started with TypeScript and Module Setup
|
|
||||||
|
|
||||||
`@git.zone/tspublish` works with monorepos that are organized using TypeScript. The package structure should follow a convention where each submodule intended for publishing is located in a directory prefixed with `ts`, for example, `tsModuleName`. Each submodule directory should contain a `tspublish.json` file to correctly configure the package to be published separately. This file is critical for the `tspublish` process to identify valid package directories and should also include necessary metadata for the package.
|
|
||||||
|
|
||||||
Your monorepo structure might resemble:
|
|
||||||
|
|
||||||
```
|
```
|
||||||
my-monorepo/
|
my-awesome-monorepo/
|
||||||
├── ts-package1/
|
├── package.json # Main monorepo package.json (version is inherited)
|
||||||
│ ├── src/
|
├── tsconfig.json # Shared TypeScript config
|
||||||
│ ├── tspublish.json
|
├── .smartconfig.json # Optional: base registry configuration
|
||||||
├── ts-package2/
|
├── ts_core/ # Core package
|
||||||
│ ├── src/
|
│ ├── index.ts # Entry point
|
||||||
│ ├── tspublish.json
|
│ ├── readme.md # Package-specific documentation
|
||||||
|
│ └── tspublish.json # Publishing configuration
|
||||||
|
├── ts_utils/ # Utilities package
|
||||||
|
│ ├── index.ts
|
||||||
|
│ ├── readme.md
|
||||||
|
│ └── tspublish.json
|
||||||
|
└── ts_cli/ # CLI package
|
||||||
|
├── index.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 publishable directory:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"name": "@myorg/ts-package1",
|
"name": "@myorg/core",
|
||||||
"dependencies": {
|
"order": 1,
|
||||||
"some-dependency": "^1.0.0"
|
"dependencies": [
|
||||||
}
|
"@push.rocks/smartpromise",
|
||||||
|
"@push.rocks/smartfile"
|
||||||
|
],
|
||||||
|
"registries": [
|
||||||
|
"registry.npmjs.org:public"
|
||||||
|
],
|
||||||
|
"bin": []
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### 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` | The published package name (e.g., `@myorg/core`) |
|
||||||
|
| `order` | `number` | Build order for interdependent packages (lower builds first) |
|
||||||
|
| `dependencies` | `string[]` | Dependencies to include — versions are resolved from the monorepo's `package.json` |
|
||||||
|
| `registries` | `string[]` | Target registries with access level (format: `"url:accessLevel"`) |
|
||||||
|
| `bin` | `string[]` | CLI executable names (generates a `cli.js` wrapper automatically) |
|
||||||
|
|
||||||
```typescript
|
### 3️⃣ Publish
|
||||||
import { runCli } from '@git.zone/tspublish';
|
|
||||||
|
|
||||||
runCli();
|
```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.
|
That's it! tspublish will discover all `ts*` directories containing `tspublish.json`, build them in order, validate versions against the registry, and publish.
|
||||||
|
|
||||||
### Core Features
|
## 🎯 Advanced Usage
|
||||||
|
|
||||||
#### Publishing Modules
|
### Registry Configuration
|
||||||
|
|
||||||
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:
|
TSPublish offers three approaches for configuring target registries:
|
||||||
|
|
||||||
- **Reads all directories** within the specified monorepo path.
|
#### 1. Explicit Registries
|
||||||
- **Identifies directories** that start with `ts` and validates the presence of `tspublish.json`.
|
|
||||||
- **Logs** information about found packages for user awareness and debugging.
|
Define specific registries directly in `tspublish.json`:
|
||||||
- **Checks for collisions** with existing versions on the npm registry to prevent overriding published versions.
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"registries": [
|
||||||
|
"registry.npmjs.org:public",
|
||||||
|
"npm.pkg.github.com:private"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
The format is `"registryUrl:accessLevel"` where `accessLevel` is `public` or `private`.
|
||||||
|
|
||||||
|
#### 2. Use Base Configuration (`useBase`)
|
||||||
|
|
||||||
|
Inherit registries from your project's `.smartconfig.json` (managed by `@git.zone/cli`):
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"registries": ["useBase"]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
This reads from `.smartconfig.json` at the key `@git.zone/cli.release.registries`.
|
||||||
|
|
||||||
|
#### 3. Extend Base Configuration (`extendBase`)
|
||||||
|
|
||||||
|
Start with base registries and add or remove specific ones:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"registries": [
|
||||||
|
"extendBase",
|
||||||
|
"custom-registry.example.com:public",
|
||||||
|
"-https://registry.npmjs.org"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
The `-` prefix excludes a registry from the base configuration. All other entries (besides `extendBase`) are added.
|
||||||
|
|
||||||
|
#### Empty Registries
|
||||||
|
|
||||||
|
If `registries` is an empty array `[]`, the package will be built but **not published** — useful for internal-only packages that other packages depend on.
|
||||||
|
|
||||||
|
### Build Order Management
|
||||||
|
|
||||||
|
When packages depend on each other, use the `order` field to control build sequence:
|
||||||
|
|
||||||
|
```json
|
||||||
|
// ts_core/tspublish.json — builds first
|
||||||
|
{
|
||||||
|
"name": "@myorg/core",
|
||||||
|
"order": 1,
|
||||||
|
"dependencies": [],
|
||||||
|
"registries": ["useBase"],
|
||||||
|
"bin": []
|
||||||
|
}
|
||||||
|
|
||||||
|
// ts_utils/tspublish.json — builds second, depends on core
|
||||||
|
{
|
||||||
|
"name": "@myorg/utils",
|
||||||
|
"order": 2,
|
||||||
|
"dependencies": ["@myorg/core"],
|
||||||
|
"registries": ["useBase"],
|
||||||
|
"bin": []
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### CLI Binary Packages
|
||||||
|
|
||||||
|
For packages that ship CLI tools, specify the binary names in the `bin` array:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"name": "@myorg/cli",
|
||||||
|
"order": 3,
|
||||||
|
"dependencies": ["commander", "@myorg/core"],
|
||||||
|
"registries": ["registry.npmjs.org:public"],
|
||||||
|
"bin": ["my-cli", "my-tool"]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
TSPublish will:
|
||||||
|
1. Fetch the standard `cli.js` template from the `@git.zone/cli` assets repository
|
||||||
|
2. Adjust the import path to point to the correct `dist_*` folder
|
||||||
|
3. Configure the `bin` field in the generated `package.json`
|
||||||
|
|
||||||
|
### Programmatic Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { TsPublish } from '@git.zone/tspublish';
|
import { TsPublish } from '@git.zone/tspublish';
|
||||||
|
|
||||||
const tspublish = new TsPublish();
|
const publisher = new TsPublish();
|
||||||
await tspublish.publish('/path/to/your/monorepo');
|
await publisher.publish(process.cwd());
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Package Initialization
|
#### Custom Publishing Pipeline
|
||||||
|
|
||||||
Once valid submodules are identified, the `init` method in the `PublishModule` class initializes the publish module. This includes:
|
|
||||||
|
|
||||||
- Parsing `tspublish.json` for metadata.
|
|
||||||
- Constructing full paths for necessary operations.
|
|
||||||
- Verifying package existence to avoid duplication.
|
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PublishModule } from '@git.zone/tspublish';
|
import { TsPublish, PublishModule } from '@git.zone/tspublish';
|
||||||
|
|
||||||
const publishModule = new PublishModule({
|
const publisher = new TsPublish();
|
||||||
monoRepoDir: '/path/to/monorepo',
|
const modules = await publisher.getModuleSubDirs('./my-monorepo');
|
||||||
packageSubFolder: 'ts-package1',
|
|
||||||
});
|
|
||||||
|
|
||||||
await publishModule.init();
|
for (const [name, config] of Object.entries(modules)) {
|
||||||
|
const mod = new PublishModule(publisher, {
|
||||||
|
monoRepoDir: './my-monorepo',
|
||||||
|
packageSubFolder: name,
|
||||||
|
});
|
||||||
|
|
||||||
|
await mod.init(); // Resolve deps, validate version
|
||||||
|
await mod.createPublishModuleDir(); // Scaffold dist_publish_* directory
|
||||||
|
await mod.build(); // Compile TypeScript
|
||||||
|
await mod.publish(); // Publish to registries
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Creating `package.json`
|
## 🔧 How It Works
|
||||||
|
|
||||||
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 pipeline │
|
||||||
|
├──────────────────────────────────────────────────────────┤
|
||||||
|
│ │
|
||||||
|
│ 1. 🔍 Discovery │
|
||||||
|
│ Scan for ts* directories containing tspublish.json │
|
||||||
|
│ │
|
||||||
|
│ 2. 📋 Preparation │
|
||||||
|
│ Create dist_publish_* with generated package.json, │
|
||||||
|
│ tsconfig.json, source files, readme, and license │
|
||||||
|
│ │
|
||||||
|
│ 3. 🔨 Build │
|
||||||
|
│ Run `tsbuild tsfolders` in the publish directory │
|
||||||
|
│ │
|
||||||
|
│ 4. ✅ Validation │
|
||||||
|
│ Check npm registry — abort if version already exists │
|
||||||
|
│ │
|
||||||
|
│ 5. 🚀 Publish │
|
||||||
|
│ pnpm publish to each configured registry │
|
||||||
|
│ │
|
||||||
|
└──────────────────────────────────────────────────────────┘
|
||||||
|
```
|
||||||
|
|
||||||
|
For each discovered module, tspublish:
|
||||||
|
|
||||||
|
1. **Discovers** all directories starting with `ts` that contain a `tspublish.json`
|
||||||
|
2. **Resolves dependencies** from the monorepo's `package.json`, using the monorepo version for packages not found in `dependencies`
|
||||||
|
3. **Creates an isolated publish directory** (`dist_publish_<folder>`) with a generated `package.json`, `tsconfig.json`, source code copy, readme, and license
|
||||||
|
4. **Builds** the package using `pnpm run build` (which calls `tsbuild tsfolders`)
|
||||||
|
5. **Validates** against the target registry — if the name+version already exists, it exits with an error
|
||||||
|
6. **Publishes** to each configured registry via `pnpm publish`
|
||||||
|
|
||||||
|
## 📚 API Reference
|
||||||
|
|
||||||
|
### TsPublish
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
await publishModule.createPackageJson();
|
class TsPublish {
|
||||||
|
/** Publish all discovered modules in a monorepo directory */
|
||||||
|
async publish(monorepoDirPath: string): Promise<void>;
|
||||||
|
|
||||||
|
/** Discover and return all publishable modules with their tspublish.json configs */
|
||||||
|
async getModuleSubDirs(dirPath: string): Promise<Record<string, ITsPublishJson>>;
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
This creates a structured `package.json` which includes scripts to build your TypeScript files before publishing.
|
### PublishModule
|
||||||
|
|
||||||
#### 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
|
```typescript
|
||||||
await publishModule.createPublishModuleDir();
|
class PublishModule {
|
||||||
|
/** Initialize: resolve dependencies, validate version against registry */
|
||||||
|
async init(): Promise<void>;
|
||||||
|
|
||||||
|
/** Create the dist_publish_* directory with all necessary files */
|
||||||
|
async createPublishModuleDir(): Promise<void>;
|
||||||
|
|
||||||
|
/** Build the TypeScript package */
|
||||||
|
async build(): Promise<void>;
|
||||||
|
|
||||||
|
/** Publish to all 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.
|
### ITsPublishJson
|
||||||
|
|
||||||
### 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
|
```typescript
|
||||||
import { logger } from '@git.zone/tspublish/logging';
|
interface ITsPublishJson {
|
||||||
|
name: string; // Published package name
|
||||||
logger.log('info', 'Publishing process initialized');
|
order: number; // Build sequence (lower = earlier)
|
||||||
|
dependencies: string[]; // Dependencies to include from monorepo
|
||||||
|
registries: string[]; // Target registries ("url:accessLevel", "useBase", or "extendBase")
|
||||||
|
bin: string[]; // CLI binary names
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
This powerful logging helps in tracking the status of each step and understanding potential issues during the operations.
|
### GiteaAssets
|
||||||
|
|
||||||
### 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
|
```typescript
|
||||||
import { expect, tap } from '@push.rocks/tapbundle';
|
class GiteaAssets {
|
||||||
import * as tspublish from '@git.zone/tspublish';
|
constructor(options: { giteaBaseUrl: string; token?: string });
|
||||||
|
|
||||||
tap.test('Should run the CLI without errors', async () => {
|
/** Fetch files from a Gitea repository directory */
|
||||||
await tspublish.runCli();
|
async getFiles(owner: string, repo: string, directory: string, branch?: string): Promise<IRepoFile[]>;
|
||||||
expect(tspublish).toBeTruthy();
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.start();
|
/** Get the standard cli.js entry file template */
|
||||||
|
async getBinCliEntryFile(): Promise<IRepoFile>;
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Comprehensive usage example
|
## 🐛 Troubleshooting
|
||||||
|
|
||||||
Let's combine all the steps into a complete example where you prepare a monorepo, configure each module, and execute the publishing workflow.
|
| Problem | Solution |
|
||||||
|
|---------|----------|
|
||||||
|
| **"Package X already exists with version Y"** | Bump the version in your monorepo's `package.json` |
|
||||||
|
| **No publish modules found** | Ensure directories start with `ts` and contain a valid `tspublish.json` |
|
||||||
|
| **Build failures** | Check TypeScript errors — tspublish runs `tsbuild tsfolders` in the generated directory |
|
||||||
|
| **useBase/extendBase error** | Ensure `.smartconfig.json` has registries at `@git.zone/cli.release.registries` |
|
||||||
|
| **Missing dependency versions** | Add the dependency to your monorepo's `package.json` `dependencies` field |
|
||||||
|
|
||||||
Suppose you have a project structure as follows:
|
## License and Legal Information
|
||||||
|
|
||||||
```plaintext
|
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [license](./license) file.
|
||||||
my-monorepo/
|
|
||||||
├── ts-package1/
|
|
||||||
│ ├── src/
|
|
||||||
│ ├── tspublish.json
|
|
||||||
├── ts-package2/
|
|
||||||
│ ├── src/
|
|
||||||
│ ├── tspublish.json
|
|
||||||
```
|
|
||||||
|
|
||||||
Follow these steps:
|
**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.
|
||||||
|
|
||||||
1. Ensure each package has `tspublish.json` properly configured with necessary metadata.
|
### Trademarks
|
||||||
2. Create a CLI script such as `publish.js`:
|
|
||||||
|
|
||||||
```typescript
|
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.
|
||||||
import { runCli } from '@git.zone/tspublish';
|
|
||||||
|
|
||||||
runCli().then(() => {
|
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.
|
||||||
console.log('Publishing completed successfully');
|
|
||||||
}).catch((error) => {
|
|
||||||
console.error('Error during publishing:', error);
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
3. Execute your CLI script:
|
### Company Information
|
||||||
|
|
||||||
```bash
|
Task Venture Capital GmbH
|
||||||
node publish.js
|
Registered at District Court Bremen HRB 35230 HB, Germany
|
||||||
```
|
|
||||||
|
|
||||||
Your script will call `runCli`, which will traverse each `ts-package`, verify their publish readiness, and handle individual publishing processes.
|
For any legal inquiries or further information, please contact us via email at hello@task.vc.
|
||||||
|
|
||||||
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.
|
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.
|
||||||
undefined
|
|
||||||
|
|||||||
39
test/test.giteaassets.ts
Normal file
39
test/test.giteaassets.ts
Normal 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();
|
||||||
@@ -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';
|
import * as tspublish from '../ts/index.js';
|
||||||
|
|
||||||
tap.test('first test', async () => {
|
tap.test('first test', async () => {
|
||||||
console.log(tspublish);
|
console.log(tspublish);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
tap.test('should create a TsPublish instance', async () => {
|
||||||
|
const tspublishInstance = new tspublish.TsPublish();
|
||||||
|
expect(tspublishInstance).toBeTruthy();
|
||||||
|
});
|
||||||
|
|
||||||
tap.start();
|
tap.start();
|
||||||
|
|||||||
@@ -3,6 +3,6 @@
|
|||||||
*/
|
*/
|
||||||
export const commitinfo = {
|
export const commitinfo = {
|
||||||
name: '@git.zone/tspublish',
|
name: '@git.zone/tspublish',
|
||||||
version: '1.2.3',
|
version: '1.11.4',
|
||||||
description: 'A tool to publish multiple, concise, and small packages from monorepos, specifically for TypeScript projects within a git environment.'
|
description: 'A tool to publish multiple, concise, and small packages from monorepos, specifically for TypeScript projects within a git environment.'
|
||||||
}
|
}
|
||||||
|
|||||||
108
ts/classes.giteaassets.ts
Normal file
108
ts/classes.giteaassets.ts
Normal 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];
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,20 +1,31 @@
|
|||||||
import * as plugins from './plugins.js';
|
import * as plugins from './plugins.js';
|
||||||
import * as paths from './paths.js';
|
import * as paths from './paths.js';
|
||||||
import { logger } from './logging.js';
|
import { logger, logInfo, logSuccess, logWarn, logError, logBuild, logPublish, logOngoing, logStart, logDone } from './logging.js';
|
||||||
|
|
||||||
|
import { type ITsPublishJson } from './interfaces/index.js';
|
||||||
|
import type { TsPublish } from './classes.tspublish.js';
|
||||||
|
|
||||||
export interface IPublishModuleOptions {
|
export interface IPublishModuleOptions {
|
||||||
monoRepoDir: string;
|
monoRepoDir: string;
|
||||||
packageSubFolder: string;
|
packageSubFolder: string;
|
||||||
packageSubFolderFullPath?: string;
|
packageSubFolderFullPath?: string;
|
||||||
|
tsPublishJson?: ITsPublishJson;
|
||||||
publishModDirFullPath?: string;
|
publishModDirFullPath?: string;
|
||||||
name?: string;
|
name?: string;
|
||||||
version?: string;
|
version?: string;
|
||||||
dependencies?: { [key: string]: string };
|
dependencies?: { [key: string]: string };
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export interface IResolvedRegistry {
|
||||||
|
url: string;
|
||||||
|
accessLevel: string;
|
||||||
|
}
|
||||||
|
|
||||||
export class PublishModule {
|
export class PublishModule {
|
||||||
|
tsPublishRef: TsPublish;
|
||||||
public options: IPublishModuleOptions;
|
public options: IPublishModuleOptions;
|
||||||
constructor(options: IPublishModuleOptions) {
|
constructor(tsPublishRef: TsPublish, options: IPublishModuleOptions) {
|
||||||
|
this.tsPublishRef = tsPublishRef;
|
||||||
this.options = options;
|
this.options = options;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -28,35 +39,49 @@ export class PublishModule {
|
|||||||
if (!this.options.packageSubFolder.startsWith('ts')) {
|
if (!this.options.packageSubFolder.startsWith('ts')) {
|
||||||
throw new Error('subFolder must start with "ts"');
|
throw new Error('subFolder must start with "ts"');
|
||||||
}
|
}
|
||||||
const jsonData = plugins.smartfile.fs.toObjectSync(
|
const tspublishJsonPath = plugins.path.join(this.options.packageSubFolderFullPath, 'tspublish.json');
|
||||||
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);
|
||||||
const monoRepoPackageJson = JSON.parse(
|
|
||||||
plugins.smartfile.fs.toStringSync(plugins.path.join(this.options.monoRepoDir, 'package.json'))
|
// the package.json of the parent mono repo
|
||||||
)
|
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 = {
|
||||||
...this.options.dependencies,
|
...this.options.dependencies,
|
||||||
...(() => {
|
...(() => {
|
||||||
const resultDependencies = {};
|
const resultDependencies = {};
|
||||||
for (const dependency of jsonData.dependencies) {
|
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;
|
return resultDependencies;
|
||||||
})()
|
})(),
|
||||||
};
|
};
|
||||||
this.options.name = this.options.name || jsonData.name;
|
this.options.name = this.options.name || this.options.tsPublishJson!.name;
|
||||||
this.options.version = monoRepoPackageJson.version;
|
this.options.version = monoRepoPackageJson.version;
|
||||||
|
|
||||||
// now that we have a name and version, lets check if there is already a package under the same name and version.
|
// 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 smartnpmInstance = new plugins.smartnpm.NpmRegistry({}); // TODO: pass in options
|
||||||
const packageInfo = await smartnpmInstance.getPackageInfo(this.options.name);
|
let packageInfo: plugins.smartnpm.NpmPackage | undefined;
|
||||||
|
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) {
|
if (packageInfo) {
|
||||||
const availableVersions = packageInfo.allVersions.map((versionArg) => versionArg.version);
|
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)) {
|
if (availableVersions.includes(this.options.version!)) {
|
||||||
throw new Error(
|
logError(
|
||||||
`package ${this.options.name} already exists with version ${this.options.version}`
|
`Package ${this.options.name} already exists with version ${this.options.version}`
|
||||||
);
|
);
|
||||||
|
process.exit(1);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -70,6 +95,36 @@ export class PublishModule {
|
|||||||
return packageInfo.allVersions[0].version;
|
return packageInfo.allVersions[0].version;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public async createTsconfigJson() {
|
||||||
|
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[
|
||||||
|
path
|
||||||
|
][0] = `.${originalTsConfig.compilerOptions.paths[path][0]}`;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
const tsconfigJson = {
|
||||||
|
compilerOptions: {
|
||||||
|
experimentalDecorators: true,
|
||||||
|
useDefineForClassFields: false,
|
||||||
|
target: 'ES2022',
|
||||||
|
module: 'NodeNext',
|
||||||
|
moduleResolution: 'NodeNext',
|
||||||
|
esModuleInterop: true,
|
||||||
|
verbatimModuleSyntax: true,
|
||||||
|
paths: originalTsConfig?.compilerOptions?.paths,
|
||||||
|
},
|
||||||
|
exclude: ['dist_*/**/*.d.ts'],
|
||||||
|
};
|
||||||
|
return JSON.stringify(tsconfigJson, null, 2);
|
||||||
|
}
|
||||||
|
|
||||||
public async createPackageJson() {
|
public async createPackageJson() {
|
||||||
const packageJson = {
|
const packageJson = {
|
||||||
name: this.options.name,
|
name: this.options.name,
|
||||||
@@ -78,7 +133,7 @@ export class PublishModule {
|
|||||||
description: '',
|
description: '',
|
||||||
exports: {
|
exports: {
|
||||||
'.': {
|
'.': {
|
||||||
import: './dist_${this.options.packageSubFolder}/index.js',
|
import: `./dist_${this.options.packageSubFolder}/index.js`,
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
scripts: {
|
scripts: {
|
||||||
@@ -88,40 +143,192 @@ export class PublishModule {
|
|||||||
devDependencies: {
|
devDependencies: {
|
||||||
'@git.zone/tsbuild': await this.getLatestVersionOfPackage('@git.zone/tsbuild'),
|
'@git.zone/tsbuild': await this.getLatestVersionOfPackage('@git.zone/tsbuild'),
|
||||||
},
|
},
|
||||||
|
files: [
|
||||||
|
'ts/**/*',
|
||||||
|
'ts_*/**/*',
|
||||||
|
'dist/**/*',
|
||||||
|
'dist_*/**/*',
|
||||||
|
'dist_ts/**/*',
|
||||||
|
'dist_ts_web/**/*',
|
||||||
|
'assets/**/*',
|
||||||
|
'cli.js',
|
||||||
|
'.smartconfig.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);
|
return JSON.stringify(packageJson, null, 2);
|
||||||
}
|
}
|
||||||
|
|
||||||
public async createPublishModuleDir() {
|
public async createPublishModuleDir() {
|
||||||
|
logOngoing(`Creating publish directory for ${this.options.name}`);
|
||||||
this.options.publishModDirFullPath = plugins.path.join(
|
this.options.publishModDirFullPath = plugins.path.join(
|
||||||
this.options.monoRepoDir,
|
this.options.monoRepoDir,
|
||||||
`dist_publish_${this.options.packageSubFolder}`
|
`dist_publish_${this.options.packageSubFolder}`
|
||||||
);
|
);
|
||||||
|
|
||||||
// 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(),
|
|
||||||
'utf8'
|
|
||||||
);
|
|
||||||
await packageJson.write();
|
|
||||||
|
|
||||||
// ts folder
|
// Ensure empty directory
|
||||||
await plugins.smartfile.fs.copy(this.options.packageSubFolderFullPath, plugins.path.join(this.options.publishModDirFullPath, this.options.packageSubFolder))
|
const publishDir = plugins.smartfs.directory(this.options.publishModDirFullPath);
|
||||||
|
if (await publishDir.exists()) {
|
||||||
|
await publishDir.recursive().delete();
|
||||||
|
}
|
||||||
|
await publishDir.recursive().create();
|
||||||
|
|
||||||
|
// package.json
|
||||||
|
const packageJsonPath = plugins.path.join(this.options.publishModDirFullPath, 'package.json');
|
||||||
|
await plugins.smartfs.file(packageJsonPath).encoding('utf8').write(await this.createPackageJson());
|
||||||
|
|
||||||
|
// tsconfig.json
|
||||||
|
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
|
||||||
|
const destSubFolder = plugins.path.join(this.options.publishModDirFullPath, this.options.packageSubFolder);
|
||||||
|
await plugins.smartfs.directory(this.options.packageSubFolderFullPath!).recursive().copy(destSubFolder);
|
||||||
|
|
||||||
|
// readme
|
||||||
|
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
|
||||||
|
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() {
|
public async build() {
|
||||||
|
logBuild(`Building ${this.options.name}...`);
|
||||||
const smartshellInstance = new plugins.smartshell.Smartshell({
|
const smartshellInstance = new plugins.smartshell.Smartshell({
|
||||||
executor: 'bash',
|
executor: 'bash',
|
||||||
})
|
});
|
||||||
await smartshellInstance.exec(`cd ${this.options.publishModDirFullPath} && pnpm run build`);
|
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);
|
||||||
|
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 smartconfig.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 smartconfig.json if needed
|
||||||
|
if (hasUseBase || hasExtendBase) {
|
||||||
|
const smartconfigInstance = new plugins.smartconfig.Smartconfig(this.options.monoRepoDir);
|
||||||
|
const gitzoneConfig = smartconfigInstance.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 smartconfig.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() {
|
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({
|
const smartshellInstance = new plugins.smartshell.Smartshell({
|
||||||
executor: 'bash',
|
executor: 'bash',
|
||||||
})
|
});
|
||||||
await smartshellInstance.exec(`cd ${this.options.publishModDirFullPath} && pnpm publish`);
|
|
||||||
|
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 ${
|
||||||
|
registry.accessLevel === 'public' ? '--access public' : ''
|
||||||
|
} --no-git-checks --registry ${registryUrl}`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
logSuccess(`Successfully published ${this.options.name} v${this.options.version}!`);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,18 +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 plugins from './plugins.js';
|
||||||
|
import * as interfaces from './interfaces/index.js';
|
||||||
|
|
||||||
import { PublishModule } from './classes.publishmodule.js';
|
import { PublishModule } from './classes.publishmodule.js';
|
||||||
|
import { GiteaAssets } from './classes.giteaassets.js';
|
||||||
|
|
||||||
export class TsPublish {
|
export class TsPublish {
|
||||||
constructor() {}
|
public giteaAssetsInstance: GiteaAssets;
|
||||||
|
|
||||||
public async publish (monorepoDirArg: string) {
|
constructor() {
|
||||||
const publishModules = await this.readDirectory(monorepoDirArg);
|
this.giteaAssetsInstance = new GiteaAssets({
|
||||||
for (const publishModule of publishModules) {
|
giteaBaseUrl: 'https://code.foss.global',
|
||||||
const publishModuleInstance = new PublishModule({
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
public async publish(monorepoDirArg: string) {
|
||||||
|
logHeader('TSPublish - Module Publisher');
|
||||||
|
const publishModules = await this.getModuleSubDirs(monorepoDirArg);
|
||||||
|
logInfo(`Found ${Object.keys(publishModules).length} publish modules`);
|
||||||
|
logSeparator();
|
||||||
|
for (const publishModule of Object.keys(publishModules)) {
|
||||||
|
logPackage('Module found', `${publishModule} → ${publishModules[publishModule].name}`);
|
||||||
|
}
|
||||||
|
for (const publishModule of Object.keys(publishModules)) {
|
||||||
|
// lets check wether there is a name
|
||||||
|
if (!publishModules[publishModule].name) {
|
||||||
|
logWarn(`No name found in tspublish.json for ${publishModule}. Skipping...`);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
const publishModuleInstance = new PublishModule(this, {
|
||||||
monoRepoDir: monorepoDirArg,
|
monoRepoDir: monorepoDirArg,
|
||||||
packageSubFolder: publishModule,
|
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.init();
|
||||||
await publishModuleInstance.createPublishModuleDir();
|
await publishModuleInstance.createPublishModuleDir();
|
||||||
await publishModuleInstance.build();
|
await publishModuleInstance.build();
|
||||||
@@ -20,22 +42,32 @@ export class TsPublish {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
public async readDirectory (dirArg: string) {
|
public async getModuleSubDirs(dirArg: string) {
|
||||||
const subDirs = await plugins.smartfile.fs.listFolders(dirArg);
|
// List all directories
|
||||||
const publishModules: string[] = [];
|
const dirContents = await plugins.smartfs.directory(dirArg).list();
|
||||||
for (const subDir of subDirs) {
|
const publishModules: { [key: string]: interfaces.ITsPublishJson } = {};
|
||||||
if (!subDir.startsWith('ts')) {
|
|
||||||
|
for (const entry of dirContents) {
|
||||||
|
const subDirName = entry.name;
|
||||||
|
if (!subDirName.startsWith('ts')) {
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
const fileTree = await plugins.smartfile.fs.listFileTree(subDir, '**/*');
|
|
||||||
const hasPublishJson = fileTree.includes('tspublish.json');
|
// Check if this is a directory and has tspublish.json
|
||||||
if (!hasPublishJson) {
|
const subDirPath = plugins.path.join(dirArg, subDirName);
|
||||||
|
const tspublishJsonPath = plugins.path.join(subDirPath, 'tspublish.json');
|
||||||
|
|
||||||
|
if (!(await plugins.smartfs.file(tspublishJsonPath).exists())) {
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
logger.log('info', `found publish module: ${subDir}`);
|
|
||||||
publishModules.push(subDir);
|
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 ${publishModules.length} publish modules`);
|
logSuccess(`Found ${Object.keys(publishModules).length} publish modules`);
|
||||||
|
logInfo('Ordering publish modules...');
|
||||||
|
|
||||||
return publishModules;
|
return publishModules;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,9 +1,11 @@
|
|||||||
import * as paths from './paths.js';
|
import * as paths from './paths.js';
|
||||||
import { TsPublish } from './classes.tspublish.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 () => {
|
export const runCli = async () => {
|
||||||
|
logStart('tspublish');
|
||||||
const tspublish = new TsPublish();
|
const tspublish = new TsPublish();
|
||||||
await tspublish.publish(paths.cwd);
|
await tspublish.publish(paths.cwd);
|
||||||
}
|
};
|
||||||
|
|||||||
1
ts/interfaces/index.ts
Normal file
1
ts/interfaces/index.ts
Normal file
@@ -0,0 +1 @@
|
|||||||
|
export * from './tspublish.js';
|
||||||
13
ts/interfaces/tspublish.ts
Normal file
13
ts/interfaces/tspublish.ts
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
export interface ITsPublishJson {
|
||||||
|
/**
|
||||||
|
* the order assures that a project is compiled before another project
|
||||||
|
*/
|
||||||
|
order: number;
|
||||||
|
name: string;
|
||||||
|
dependencies: string[];
|
||||||
|
registries: string[];
|
||||||
|
/**
|
||||||
|
* allows the sepcification of bin names that invoke cli scripts
|
||||||
|
*/
|
||||||
|
bin: string[];
|
||||||
|
}
|
||||||
102
ts/logging.ts
102
ts/logging.ts
@@ -1,4 +1,104 @@
|
|||||||
import * as plugins from './plugins.js';
|
import * as plugins from './plugins.js';
|
||||||
import * as commitinfo from './00_commitinfo_data.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);
|
||||||
|
};
|
||||||
|
|||||||
@@ -2,6 +2,8 @@ import * as plugins from './plugins.js';
|
|||||||
|
|
||||||
export const cwd = process.cwd();
|
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');
|
export const nogitDir = plugins.path.join(packageDir, '.nogit');
|
||||||
|
|
||||||
|
|||||||
@@ -1,15 +1,21 @@
|
|||||||
// node native scope
|
// node native scope
|
||||||
import * as path from 'path';
|
import * as path from 'path';
|
||||||
export {
|
export { path };
|
||||||
path,
|
|
||||||
}
|
|
||||||
|
|
||||||
// @push.rocks scope
|
// @push.rocks scope
|
||||||
|
import * as consolecolor from '@push.rocks/consolecolor';
|
||||||
|
import * as smartconfig from '@push.rocks/smartconfig';
|
||||||
import * as smartfile from '@push.rocks/smartfile';
|
import * as smartfile from '@push.rocks/smartfile';
|
||||||
|
import { SmartFs, SmartFsProviderNode } from '@push.rocks/smartfs';
|
||||||
import * as smartcli from '@push.rocks/smartcli';
|
import * as smartcli from '@push.rocks/smartcli';
|
||||||
|
import * as smartdelay from '@push.rocks/smartdelay';
|
||||||
import * as smartlog from '@push.rocks/smartlog';
|
import * as smartlog from '@push.rocks/smartlog';
|
||||||
import * as smartnpm from '@push.rocks/smartnpm';
|
import * as smartnpm from '@push.rocks/smartnpm';
|
||||||
import * as smartpath from '@push.rocks/smartpath';
|
import * as smartpath from '@push.rocks/smartpath';
|
||||||
|
import * as smartrequest from '@push.rocks/smartrequest';
|
||||||
import * as smartshell from '@push.rocks/smartshell';
|
import * as smartshell from '@push.rocks/smartshell';
|
||||||
|
|
||||||
export { smartfile, smartcli, smartlog, smartnpm, smartpath, smartshell };
|
// Create a pre-configured SmartFs instance for Node.js filesystem operations
|
||||||
|
const smartfs = new SmartFs(new SmartFsProviderNode());
|
||||||
|
|
||||||
|
export { consolecolor, smartconfig, smartfile, smartfs, smartcli, smartdelay, smartlog, smartnpm, smartpath, smartrequest, smartshell };
|
||||||
|
|||||||
@@ -11,4 +11,4 @@
|
|||||||
"exclude": [
|
"exclude": [
|
||||||
"dist_*/**/*.d.ts"
|
"dist_*/**/*.d.ts"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
Reference in New Issue
Block a user