Merge pull request #26 from tclxshunquan-wang/feat/docs

refactor: update licensing structure and enhance website documentation

Author: tianyingchun

.github/workflows/gh-pages.yml

@@ -16,9 +16,9 @@ jobs:
       contents: write
     concurrency:
       group: ${{ github.workflow }}-${{ github.ref }}
-    defaults:
-      run:
-        working-directory: website
+    # defaults:
+    #   run:
+    #     working-directory: website
     strategy:
       matrix:
         node-version: [20.x]
@@ -32,13 +32,13 @@ jobs:
       - name: 📥 Install Dependencies
         run: yarn --frozen-lockfile
 
-      - name: Unit tests
+      - name: Build packages
         run: |
-          yarn test
+          yarn g:build
 
-      - name: Build
+      - name: Build website
         run: |
-          yarn build:ghpage
+          yarn g:build-website
 
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v4

LICENSE

@@ -0,0 +1,36 @@
+# License
+
+Copyright (C) Hyperse (Yuantai Information Technology (Shanghai) Co., Ltd)
+
+This software is available under two different licenses:
+
+- GNU General Public License version 3 (GPLv3) as Hyperse Community Edition
+- Hyperse Commercial License (HCL)
+
+The default Hyperse license, without a valid Hyperse Commercial License agreement, is the Open-Source GPLv3 license.
+
+## GNU General Public License version 3 (GPLv3)
+
+If you decide to choose the GPLv3 license, you must comply with the following terms:
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+## Hyperse Commercial License (HCL)
+
+Alternatively, commercial and supported versions of the program - also known as
+Commercial Distributions - must be used in accordance with the terms and conditions
+contained in a separate written agreement between you and (Hyperse Co., Ltd)
+For more information about the Hyperse Commercial License (HCL) please contact hi@hyperse.net.
+
+For more details about licensing, please [visit here](https://raw.githubusercontent.com/hyperse-io/.github/refs/heads/main/LICENSE.md).

LICENSE.md

@@ -11,7 +11,7 @@
   <a aria-label="Top language" href="https://github.com/hyperse-io/logger/search?l=typescript">
     <img alt="GitHub top language" src="https://img.shields.io/github/languages/top/hyperse-io/logger?style=flat-square&labelColor=000&color=blue">
   </a>
-  <a aria-label="Licence" href="https://github.com/hyperse-io/logger/blob/main/LICENSE">
+  <a aria-label="Licence" href="https://github.com/hyperse-io/logger/blob/main/LICENSE.md">
     <img alt="Licence" src="https://img.shields.io/github/license/hyperse-io/logger?style=flat-square&labelColor=000000" />
   </a>
 
@@ -332,4 +332,4 @@ Hyperse Logger is designed for high-performance applications:
 
 ## License
 
-This project is licensed under the [MIT LICENSE](./LICENSE).
+This project is licensed under the [MIT LICENSE](./LICENSE.md).

README.md

@@ -3,7 +3,7 @@
 % reference for other constraints: https://github.com/babel/babel/blob/main/constraints.pro
 
 % Enforces the license in all public workspaces while removing it from private workspaces
-gen_enforced_field(WorkspaceCwd, 'license', 'SEE LICENSE IN FILE \'LICENSE\'') :-
+gen_enforced_field(WorkspaceCwd, 'license', 'SEE LICENSE IN FILE \'LICENSE.md\'') :-
   \+ workspace_field(WorkspaceCwd, 'private', true).
 
 % Enforces that a dependency doesn't appear in both `dependencies` and `devDependencies`

constraints.pro

@@ -23,7 +23,7 @@
     "url": "https://github.com/hyperse-io"
   },
   "type": "module",
-  "license": "SEE LICENSE IN FILE 'LICENSE'",
+  "license": "SEE LICENSE IN FILE 'LICENSE.md'",
   "workspaces": [
     "website",
     "packages/*",
@@ -36,6 +36,7 @@
     "?build-release": "When https://github.com/atlassian/changesets/issues/432 has a solution we can remove this trick",
     "g:build-release": "yarn workspaces foreach -At run build-release",
     "g:build-local": "yarn workspaces foreach -At run build",
+    "g:build-website": "yarn workspace @hyperse/logger-website run build:ghpage",
     "g:test": "yarn workspaces foreach -At run test",
     "g:test-unit": "yarn workspaces foreach --all -ptv run test-unit",
     "g:test-e2e": "yarn workspaces foreach -At run test-e2e",
@@ -65,7 +66,7 @@
     "@hyperse/ts-node": "^1.0.3",
     "commitizen": "^4.3.1",
     "cz-conventional-changelog": "^3.3.0",
-    "eslint": "^9.30.1",
+    "eslint": "^9.32.0",
     "husky": "^9.1.7",
     "lint-staged": "^16.1.2",
     "npm-run-all": "^4.1.5",

package.json

@@ -12,7 +12,7 @@
     "url": "https://github.com/hyperse-io"
   },
   "type": "module",
-  "license": "SEE LICENSE IN FILE 'LICENSE'",
+  "license": "SEE LICENSE IN FILE 'LICENSE.md'",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -52,7 +52,7 @@
     "@types/node": "^24.0.10",
     "@vitest/coverage-istanbul": "^3.2.4",
     "@vitest/ui": "^3.2.4",
-    "eslint": "^9.30.1",
+    "eslint": "^9.32.0",
     "jsdom": "26.1.0",
     "npm-run-all": "4.1.5",
     "rimraf": "^6.0.1",

packages/logger-plugin-console/package.json

@@ -6,6 +6,12 @@ import { mergeConsoleOptions } from './helpers/helper-merge-options.js';
 import type { ConsoleOptions } from './types/type-options.js';
 import type { ConsolePluginContext } from './types/type-plugin.js';
 
+/**
+ * Creates a new logger plugin that outputs formatted log messages to the console.
+ *
+ * @param options - Optional configuration options for the plugin.
+ * @returns A new logger plugin that outputs formatted log messages to the console.
+ */
 export const createConsolePlugin = (
   options?: ConsoleOptions
 ): LoggerPlugin<ConsolePluginContext> => {

packages/logger-plugin-console/src/create-console-plugin.ts

@@ -71,11 +71,11 @@ export type ConsoleOptions = {
   /**
    * If true, the timestamp on each message logged to the console will be displayed using the 24 hour clock instead of the 12 hour clock. Keep in mind that the timestamp of when a log was logged to the console is only displayed when `showTimestamp` is also true.
    *
-   * ### **24 hour clock:**
+   * **24 hour clock:**
    *
    * `[ 13:27:55.33 ] pow`
    *
-   * ### **12 hour clock:**
+   * **12 hour clock:**
    *
    * `[ 1:27:55.33 PM ] pow`
    * @default true

packages/logger-plugin-console/src/types/type-options.ts

@@ -12,7 +12,7 @@
     "url": "https://github.com/hyperse-io"
   },
   "type": "module",
-  "license": "SEE LICENSE IN FILE 'LICENSE'",
+  "license": "SEE LICENSE IN FILE 'LICENSE.md'",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -50,7 +50,7 @@
     "@types/node": "^24.0.10",
     "@vitest/coverage-istanbul": "^3.2.4",
     "@vitest/ui": "^3.2.4",
-    "eslint": "^9.30.1",
+    "eslint": "^9.32.0",
     "jsdom": "26.1.0",
     "npm-run-all": "4.1.5",
     "rimraf": "^6.0.1",