Merge pull request #8 from vitalics/1.4.x/fmt

fmt(patch): update jsx properties in common components
core(release): update release script

.github/workflows/release.yaml

@@ -44,12 +44,17 @@ jobs:
           git config --global user.email "github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>"
           echo "GIT_USER=${GITHUB_ACTOR}:${{ secrets.GITHUB_TOKEN }}" >> $GITHUB_ENV
       - run: pnpm release --type ${{ github.event.inputs.release_type || 'patch' }}
+      - run: |
+          TAG=`git describe --tags --abbrev=0`
+          RELEASE_LOG=$(<./releases/$TAG.md)
       - uses: fregante/release-with-changelog@v3
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           commit-template: "- {title} ← {hash}"
           template: |
             ### Changelog
+            $RELEASE_LOG
+            ### PRs
             {commits}
             Full changelog: {range}
             See [Previous releases](https://github.com/vitalics/Telegraph/tree/main/releases)

packages/docs/docs/tutorial/fmt/jsx.mdx

@@ -72,3 +72,4 @@ Better to wrap high-level component with `Fragment` component from `preact` libr
 - Each reply context should be call `render` function. As for previous limitation `render` function only for your using context.
 - `render` function in `default` function should be called with `rest/spread` operator, since `reply` function accepts text modifications(like bold, underline, etc.)
 - not all components can be combined with children(e.g. `Bold` and `Italic` can be combined)
+- do not crate component with many hierarchies. Better to use 1 hierary without depths.

packages/fmt/common/command.tsx

@@ -1,7 +1,7 @@
 import { Fragment, h, JSX } from 'preact';
 
 type Props = {
-  children: string | JSX.Element
+  name: string;
 };
 
 /**
@@ -16,6 +16,6 @@ type Props = {
  * @param {(S)} str command name
  * @return {*} string
  */
-export default function ({ children }: Props) {
-  return <Fragment>/{children}</Fragment>
+export default function ({ name }: Props) {
+  return <Fragment>/{name}</Fragment>
 }

packages/fmt/common/hash.tsx

@@ -1,9 +1,9 @@
 import { Fragment, h, JSX } from 'preact';
 
 type Props = {
-  children: string | JSX.Element;
+  hash: string;
 };
 
-export default function ({ children }: Props) {
-  return <Fragment>#{children}</Fragment>;
+export default function ({ hash }: Props) {
+  return <Fragment>#{hash}</Fragment>;
 }

packages/fmt/common/mention.tsx

@@ -1,7 +1,7 @@
 import { Fragment, h, JSX } from 'preact';
 
 type Props = {
-  children: string;
+  username: string;
 };
 
 /** 
@@ -13,6 +13,6 @@ type Props = {
  * <Mention>some_user_name</Mention>
  * // same as '@some_user_name'
  */
-export default function ({ children }: Props) {
-  return <Fragment>@{children}</Fragment>;
+export default function ({ username }: Props) {
+  return <Fragment>@{username}</Fragment>;
 }

packages/fmt/common/phone.tsx

@@ -3,7 +3,7 @@ import toString from 'preact-render-to-string'
 import { parsePhoneNumber, type PhoneNumberFormat } from 'awesome-phonenumber';
 
 export type Props = {
-  children: string | JSX.Element;
+  number: string | number | `+${number}`;
   format?: PhoneNumberFormat;
   /**
    * Region code for the phone number (only required if phoneNumber is on a national format). Example: 'SE' for Sweden, 'CH' for Switzerland, etc.
@@ -25,15 +25,11 @@ export type Props = {
  * @return {string} Phone number
  */
 export default function (props: Props) {
-  let phoneNumber: string;
-  if (typeof props.children === 'object') {
-    phoneNumber = toString(props.children);
-  } else {
-    phoneNumber = props.children.toString();
-  }
-  const parsed = parsePhoneNumber(phoneNumber, props?.regionCode)
+  const phoneNumber = props.number.toString();
+
+  const parsed = parsePhoneNumber(phoneNumber, props?.regionCode);
   if (!parsed.isValid()) {
-    throw new TypeError(`Phone "${props.children}" number is not valid`)
+    throw new TypeError(`Phone "${phoneNumber}" number is not valid`)
   }
   return <Fragment>{parsed.getNumber(props?.format)}</Fragment>;
 }

upcoming.md

@@ -1 +1,13 @@
+## core
 
+- add release log for new releases
+
+## packages
+
+[@tlgr/docs]
+
+- Add one more limitation about using JSX
+
+[@tlgr/fmt]
+
+- replace children properties from common components to another properties.