1.2.2

changelog.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 2024-10-21 - 1.2.2 - fix(publishmodule)
+Fix bug in package.json creation for publish module
+
+- Fixed an issue where `package.json` was not being written to the publish module directory.
+
+## 2024-10-21 - 1.2.1 - fix(package.json)
+Ensure bin field is properly restructured
+
+- Fixed the structure of the package.json to ensure the bin field is accurately set.
+
+## 2024-10-21 - 1.2.0 - feat(core)
+Enhance package publication workflow with dependency handling and CLI improvements.
+
+- Updated package description and keywords in package.json and npmextra.json.
+- Integrated dependency extraction from root package.json into sub-package tspublish.json during initialization.
+- Added build and publish script executions for each submodule.
+- Improved CLI documentation and usage guidance in readme.md.
+
 ## 2024-10-21 - 1.1.0 - feat(core)
 Add runCli function to execute TsPublish process
 

npmextra.json

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

package.json

@@ -1,8 +1,8 @@
 {
   "name": "@git.zone/tspublish",
-  "version": "1.1.0",
+  "version": "1.2.2",
   "private": false,
-  "description": "publish multiple, concise and small packages from monorepos",
+  "description": "A tool to publish multiple, concise, and small packages from monorepos, specifically for TypeScript projects within a git environment.",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
   "type": "module",
@@ -13,13 +13,16 @@
     "build": "(tsbuild --web --allowimplicitany)",
     "buildDocs": "(tsdoc)"
   },
+  "bin": {
+    "tspublish": "cli.js"
+  },
   "devDependencies": {
     "@git.zone/tsbuild": "^2.1.25",
     "@git.zone/tsbundle": "^2.0.5",
     "@git.zone/tsrun": "^1.2.46",
     "@git.zone/tstest": "^1.0.44",
     "@push.rocks/tapbundle": "^5.0.15",
-    "@types/node": "^22.7.6"
+    "@types/node": "^22.7.7"
   },
   "repository": {
     "type": "git",
@@ -49,6 +52,19 @@
     "@push.rocks/smartfile": "^11.0.21",
     "@push.rocks/smartlog": "^3.0.7",
     "@push.rocks/smartnpm": "^2.0.4",
-    "@push.rocks/smartpath": "^5.0.18"
+    "@push.rocks/smartpath": "^5.0.18",
-  }
+    "@push.rocks/smartshell": "^3.0.6"
+  },
+  "keywords": [
+    "typescript",
+    "monorepo",
+    "package",
+    "publish",
+    "npm",
+    "automation",
+    "git",
+    "modularity",
+    "module-management",
+    "developer-tools"
+  ]
 }

pnpm-lock.yaml

@@ -23,6 +23,9 @@ importers:
       '@push.rocks/smartpath':
         specifier: ^5.0.18
         version: 5.0.18
+      '@push.rocks/smartshell':
+        specifier: ^3.0.6
+        version: 3.0.6
     devDependencies:
       '@git.zone/tsbuild':
         specifier: ^2.1.25
@@ -32,16 +35,16 @@ importers:
         version: 2.0.15
       '@git.zone/tsrun':
         specifier: ^1.2.46
-        version: 1.2.49(@types/node@22.7.6)
+        version: 1.2.49(@types/node@22.7.7)
       '@git.zone/tstest':
         specifier: ^1.0.44
-        version: 1.0.90(@types/node@22.7.6)
+        version: 1.0.90(@types/node@22.7.7)
       '@push.rocks/tapbundle':
         specifier: ^5.0.15
         version: 5.3.0
       '@types/node':
-        specifier: ^22.7.6
+        specifier: ^22.7.7
-        version: 22.7.6
+        version: 22.7.7
 
 packages:
 
@@ -809,8 +812,8 @@ packages:
   '@types/node-forge@1.3.11':
     resolution: {integrity: sha512-FQx220y22OKNTqaByeBGqHWYz4cl94tpcxeFdvBo3wjG6XPBuZ0BNgNZRV5J5TFmmcsJ4IzsLkmGRiQbnYsBEQ==}
 
-  '@types/node@22.7.6':
+  '@types/node@22.7.7':
-    resolution: {integrity: sha512-/d7Rnj0/ExXDMcioS78/kf1lMzYk4BZV8MZGTBKzTGZ6/406ukkbYlIsZmMPhcR5KlkunDHQLrtAVmSq7r+mSw==}
+    resolution: {integrity: sha512-SRxCrrg9CL/y54aiMCG3edPKdprgMVGDXjA3gB8UmmBW5TcXzRUYAh8EWzTnSJFAd1rgImPELza+A3bJ+qxz8Q==}
 
   '@types/parse5@6.0.3':
     resolution: {integrity: sha512-SuT16Q1K51EAVPz1K29DJ/sXjhSQ0zjvsypYJ6tlwVsRV9jwW5Adq2ch8Dq8kDBCkYnELS7N7VNCSB5nC56t/g==}
@@ -3457,22 +3460,22 @@ snapshots:
     transitivePeerDependencies:
       - supports-color
 
-  '@git.zone/tsrun@1.2.49(@types/node@22.7.6)':
+  '@git.zone/tsrun@1.2.49(@types/node@22.7.7)':
     dependencies:
       '@push.rocks/smartfile': 11.0.21
       '@push.rocks/smartshell': 3.0.6
-      ts-node: 10.9.2(@types/node@22.7.6)(typescript@5.5.2)
+      ts-node: 10.9.2(@types/node@22.7.7)(typescript@5.5.2)
       typescript: 5.5.2
     transitivePeerDependencies:
       - '@swc/core'
       - '@swc/wasm'
       - '@types/node'
 
-  '@git.zone/tstest@1.0.90(@types/node@22.7.6)':
+  '@git.zone/tstest@1.0.90(@types/node@22.7.7)':
     dependencies:
       '@api.global/typedserver': 3.0.51
       '@git.zone/tsbundle': 2.0.15
-      '@git.zone/tsrun': 1.2.49(@types/node@22.7.6)
+      '@git.zone/tsrun': 1.2.49(@types/node@22.7.7)
       '@push.rocks/consolecolor': 2.0.2
       '@push.rocks/smartbrowser': 2.0.6
       '@push.rocks/smartdelay': 3.0.5
@@ -4303,14 +4306,14 @@ snapshots:
 
   '@types/accepts@1.3.7':
     dependencies:
-      '@types/node': 22.7.6
+      '@types/node': 22.7.7
 
   '@types/babel__code-frame@7.0.6': {}
 
   '@types/body-parser@1.19.5':
     dependencies:
       '@types/connect': 3.4.38
-      '@types/node': 22.7.6
+      '@types/node': 22.7.7
 
   '@types/buffer-json@2.0.3': {}
 
@@ -4324,17 +4327,17 @@ snapshots:
 
   '@types/clean-css@4.2.11':
     dependencies:
-      '@types/node': 22.7.6
+      '@types/node': 22.7.7
       source-map: 0.6.1
 
   '@types/co-body@6.1.3':
     dependencies:
-      '@types/node': 22.7.6
+      '@types/node': 22.7.7
       '@types/qs': 6.9.16
 
   '@types/connect@3.4.38':
     dependencies:
-      '@types/node': 22.7.6
+      '@types/node': 22.7.7
 
   '@types/content-disposition@0.5.8': {}
 
@@ -4347,11 +4350,11 @@ snapshots:
       '@types/connect': 3.4.38
       '@types/express': 5.0.0
       '@types/keygrip': 1.0.6
-      '@types/node': 22.7.6
+      '@types/node': 22.7.7
 
   '@types/cors@2.8.17':
     dependencies:
-      '@types/node': 22.7.6
+      '@types/node': 22.7.7
 
   '@types/debounce@1.2.4': {}
 
@@ -4363,14 +4366,14 @@ snapshots:
 
   '@types/express-serve-static-core@4.19.6':
     dependencies:
-      '@types/node': 22.7.6
+      '@types/node': 22.7.7
       '@types/qs': 6.9.16
       '@types/range-parser': 1.2.7
       '@types/send': 0.17.4
 
   '@types/express-serve-static-core@5.0.0':
     dependencies:
-      '@types/node': 22.7.6
+      '@types/node': 22.7.7
       '@types/qs': 6.9.16
       '@types/range-parser': 1.2.7
       '@types/send': 0.17.4
@@ -4391,21 +4394,21 @@ snapshots:
 
   '@types/from2@2.3.5':
     dependencies:
-      '@types/node': 22.7.6
+      '@types/node': 22.7.7
 
   '@types/fs-extra@11.0.4':
     dependencies:
       '@types/jsonfile': 6.1.4
-      '@types/node': 22.7.6
+      '@types/node': 22.7.7
 
   '@types/glob@8.1.0':
     dependencies:
       '@types/minimatch': 5.1.2
-      '@types/node': 22.7.6
+      '@types/node': 22.7.7
 
   '@types/gunzip-maybe@1.4.2':
     dependencies:
-      '@types/node': 22.7.6
+      '@types/node': 22.7.7
 
   '@types/hast@3.0.4':
     dependencies:
@@ -4439,7 +4442,7 @@ snapshots:
 
   '@types/jsonfile@6.1.4':
     dependencies:
-      '@types/node': 22.7.6
+      '@types/node': 22.7.7
 
   '@types/keygrip@1.0.6': {}
 
@@ -4456,7 +4459,7 @@ snapshots:
       '@types/http-errors': 2.0.4
       '@types/keygrip': 1.0.6
       '@types/koa-compose': 3.2.8
-      '@types/node': 22.7.6
+      '@types/node': 22.7.7
 
   '@types/mdast@4.0.4':
     dependencies:
@@ -4478,9 +4481,9 @@ snapshots:
 
   '@types/node-forge@1.3.11':
     dependencies:
-      '@types/node': 22.7.6
+      '@types/node': 22.7.7
 
-  '@types/node@22.7.6':
+  '@types/node@22.7.7':
     dependencies:
       undici-types: 6.19.8
 
@@ -4501,12 +4504,12 @@ snapshots:
   '@types/send@0.17.4':
     dependencies:
       '@types/mime': 1.3.5
-      '@types/node': 22.7.6
+      '@types/node': 22.7.7
 
   '@types/serve-static@1.15.7':
     dependencies:
       '@types/http-errors': 2.0.4
-      '@types/node': 22.7.6
+      '@types/node': 22.7.7
       '@types/send': 0.17.4
 
   '@types/sinon-chai@3.2.12':
@@ -4524,11 +4527,11 @@ snapshots:
 
   '@types/tar-stream@2.2.3':
     dependencies:
-      '@types/node': 22.7.6
+      '@types/node': 22.7.7
 
   '@types/through2@2.0.41':
     dependencies:
-      '@types/node': 22.7.6
+      '@types/node': 22.7.7
 
   '@types/trusted-types@2.0.7': {}
 
@@ -4548,15 +4551,15 @@ snapshots:
 
   '@types/ws@7.4.7':
     dependencies:
-      '@types/node': 22.7.6
+      '@types/node': 22.7.7
 
   '@types/ws@8.5.12':
     dependencies:
-      '@types/node': 22.7.6
+      '@types/node': 22.7.7
 
   '@types/yauzl@2.10.3':
     dependencies:
-      '@types/node': 22.7.6
+      '@types/node': 22.7.7
     optional: true
 
   '@ungap/structured-clone@1.2.0': {}
@@ -5093,7 +5096,7 @@ snapshots:
     dependencies:
       '@types/cookie': 0.4.1
       '@types/cors': 2.8.17
-      '@types/node': 22.7.6
+      '@types/node': 22.7.7
       accepts: 1.3.8
       base64id: 2.0.0
       cookie: 0.4.2
@@ -6958,14 +6961,14 @@ snapshots:
 
   trough@2.2.0: {}
 
-  ts-node@10.9.2(@types/node@22.7.6)(typescript@5.5.2):
+  ts-node@10.9.2(@types/node@22.7.7)(typescript@5.5.2):
     dependencies:
       '@cspotcode/source-map-support': 0.8.1
       '@tsconfig/node10': 1.0.11
       '@tsconfig/node12': 1.0.11
       '@tsconfig/node14': 1.0.3
       '@tsconfig/node16': 1.0.4
-      '@types/node': 22.7.6
+      '@types/node': 22.7.7
       acorn: 8.13.0
       acorn-walk: 8.3.4
       arg: 4.1.3

readme.md

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

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@git.zone/tspublish',
-  version: '1.1.0',
+  version: '1.2.2',
-  description: 'publish multiple, concise and small packages from monorepos'
+  description: 'A tool to publish multiple, concise, and small packages from monorepos, specifically for TypeScript projects within a git environment.'
 }

ts/classes.publishmodule.ts

@@ -31,15 +31,21 @@ export class PublishModule {
     const jsonData = plugins.smartfile.fs.toObjectSync(
       plugins.path.join(this.options.packageSubFolderFullPath, 'tspublish.json')
     );
-    this.options.dependencies = this.options.dependencies || {};
+    const monoRepoPackageJson = JSON.parse(
+      plugins.smartfile.fs.toStringSync(plugins.path.join(this.options.monoRepoDir, 'package.json'))
+    )
     this.options.dependencies = {
       ...this.options.dependencies,
-      ...jsonData.dependencies,
+      ...(() => {
+        const resultDependencies = {};
+        for (const dependency of jsonData.dependencies) {
+          resultDependencies[dependency] = monoRepoPackageJson.dependencies[dependency];
+        }
+        return resultDependencies;
+      })()
     };
     this.options.name = this.options.name || jsonData.name;
-    this.options.version = plugins.smartfile.fs.toObjectSync(
+    this.options.version = monoRepoPackageJson.version;
-      plugins.path.join(this.options.monoRepoDir, 'package.json')
-    ).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
@@ -98,8 +104,23 @@ export class PublishModule {
       await this.createPackageJson(),
       'utf8'
     );
+    await packageJson.write();
 
     // ts folder
     await plugins.smartfile.fs.copy(this.options.packageSubFolderFullPath, plugins.path.join(this.options.publishModDirFullPath, this.options.packageSubFolder)) 
   }
+
+  public async build() {
+    const smartshellInstance = new plugins.smartshell.Smartshell({
+      executor: 'bash',
+    })
+    await smartshellInstance.exec(`cd ${this.options.publishModDirFullPath} && pnpm run build`);
+  }
+
+  public async publish() {
+    const smartshellInstance = new plugins.smartshell.Smartshell({
+      executor: 'bash',
+    })
+    await smartshellInstance.exec(`cd ${this.options.publishModDirFullPath} && pnpm publish`);
+  }
 }

ts/classes.tspublish.ts

@@ -14,6 +14,9 @@ export class TsPublish {
         packageSubFolder: publishModule,
       });
       await publishModuleInstance.init();
+      await publishModuleInstance.createPublishModuleDir();
+      await publishModuleInstance.build();
+      await publishModuleInstance.publish();
     }
   }
 

ts/plugins.ts

@@ -10,5 +10,6 @@ import * as smartcli from '@push.rocks/smartcli';
 import * as smartlog from '@push.rocks/smartlog';
 import * as smartnpm from '@push.rocks/smartnpm';
 import * as smartpath from '@push.rocks/smartpath';
+import * as smartshell from '@push.rocks/smartshell';
 
-export { smartfile, smartcli, smartlog, smartnpm, smartpath, };
+export { smartfile, smartcli, smartlog, smartnpm, smartpath, smartshell };