sapegin
diff --git a/‎.github/workflows/node.js.yml
Copy file name to clipboard
-6Lines changed: 0 additions & 6 deletions b/‎.github/workflows/node.js.yml
Copy file name to clipboard
-6Lines changed: 0 additions & 6 deletions
diff --git a/‎.github/workflows/release.yml
Copy file name to clipboard
+6-20Lines changed: 6 additions & 20 deletions b/‎.github/workflows/release.yml
Copy file name to clipboard
+6-20Lines changed: 6 additions & 20 deletions
diff --git a/‎.prettierignore
Copy file name to clipboard
-1Lines changed: 0 additions & 1 deletion b/‎.prettierignore
Copy file name to clipboard
-1Lines changed: 0 additions & 1 deletion
diff --git a/‎Contributing.md
Copy file name to clipboard
-6Lines changed: 0 additions & 6 deletions b/‎Contributing.md
Copy file name to clipboard
-6Lines changed: 0 additions & 6 deletions
diff --git a/‎Readme.md
Copy file name to clipboard
+3-3Lines changed: 3 additions & 3 deletions b/‎Readme.md
Copy file name to clipboard
+3-3Lines changed: 3 additions & 3 deletions
diff --git a/‎docs/Readme.md
Copy file name to clipboard
+124Lines changed: 124 additions & 0 deletions b/‎docs/Readme.md
Copy file name to clipboard
+124Lines changed: 124 additions & 0 deletions
diff --git a/‎packages/richtypo-rules-common/Readme.md renamed to ‎docs/rules/CommonRules.md
Copy file name to clipboard
+11-10Lines changed: 11 additions & 10 deletions b/‎packages/richtypo-rules-common/Readme.md renamed to ‎docs/rules/CommonRules.md
Copy file name to clipboard
+11-10Lines changed: 11 additions & 10 deletions
diff --git a/‎packages/richtypo-rules-en/Readme.md renamed to ‎docs/rules/EnglishRules.md
Copy file name to clipboard
+10-8Lines changed: 10 additions & 8 deletions b/‎packages/richtypo-rules-en/Readme.md renamed to ‎docs/rules/EnglishRules.md
Copy file name to clipboard
+10-8Lines changed: 10 additions & 8 deletions
diff --git a/‎packages/richtypo-rules-fr/Readme.md renamed to ‎docs/rules/FrenchRules.md
Copy file name to clipboard
+6-5Lines changed: 6 additions & 5 deletions b/‎packages/richtypo-rules-fr/Readme.md renamed to ‎docs/rules/FrenchRules.md
Copy file name to clipboard
+6-5Lines changed: 6 additions & 5 deletions
diff --git a/‎packages/richtypo-rules-ru/Readme.md renamed to ‎docs/rules/RussianRules.md
Copy file name to clipboard
+8-8Lines changed: 8 additions & 8 deletions b/‎packages/richtypo-rules-ru/Readme.md renamed to ‎docs/rules/RussianRules.md
Copy file name to clipboard
+8-8Lines changed: 8 additions & 8 deletions
@@ -10,12 +10,6 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - name: Set up Git
-        run: |
-          git config --global user.name "Richtypo Bot"
-          git config --global user.email "${BOT_EMAIL}"
-        env:
-          BOT_EMAIL: ${{ secrets.BOT_EMAIL }}
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
 
@@ -1,34 +1,20 @@
-name: Release
+name: Semantic Release
 on:
   push:
     branches:
       - master
 jobs:
-  build:
+  release:
+    name: Release
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
           node-version-file: .nvmrc
           cache: 'npm'
-      - name: Set up Git
-        run: |
-          git config --global user.name "Richtypo Bot"
-          git config --global user.email "${BOT_EMAIL}"
-          git remote set-url origin "https://x-access-token:${GH_TOKEN}@github.com/sapegin/richtypo.js.git"
-        env:
-          GH_TOKEN: ${{ secrets.GH_TOKEN }}
-          BOT_EMAIL: ${{ secrets.BOT_EMAIL }}
-      - name: Set up npm
-        run: echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" >> ~/.npmrc 2> /dev/null
-        env:
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
       - run: npm ci
-      - name: Publish
-        run: |
-          npx lerna version --yes --create-release=github
-          npx lerna publish from-git --yes
-        env:
-          GH_TOKEN: ${{ secrets.GH_TOKEN }}
+      - env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx semantic-release
@@ -1,3 +1,2 @@
 package.json
 dist/
-/.nx/workspace-data
@@ -21,9 +21,3 @@ Or run tests in watch mode:
 ```bash
 npm run test:watch
 ```
-
-To update Jest snapshots:
-
-```bash
-npm run test:jest -- -u
-```
@@ -2,9 +2,9 @@
 
 [![npm](https://img.shields.io/npm/v/richtypo.svg)](https://www.npmjs.com/package/richtypo) [![Codecov](https://codecov.io/gh/sapegin/richtypo.js/branch/master/graph/badge.svg)](https://codecov.io/gh/sapegin/richtypo.js) [![Node.js CI status](https://github.com/sapegin/richtypo.js/workflows/Node.js%20CI/badge.svg)](https://github.com/sapegin/richtypo.js/actions)
 
-Richtypo prepares your texts to publication on web: applies typography rules like quotes (`"` → `“”`), dashes (`-` → `—`) and non-breaking spaces to make text prettier and more readable.
+Richtypo prepares your texts to publication by improving typography, like fancy quotes (`"` → `“”`), dashes (`-` → `—`), and adding non-breaking spaces to make the text prettier and more readable by avoiding undesired line breaks.
 
-Richtypo comes with [typography rules](#rule-packages) for English, French, and Russian, but you can customize them and create your own rules — each rule is an independent JavaScript function.
+Richtypo comes with [typography rules](docs/Readme.md#rules) for English, French, and Russian, and you can customize them and create your own rules — each rule is an independent JavaScript function.
 
 Have a look at [the example page](https://sapegin.github.io/richtypo.js/) and [its source](https://github.com/sapegin/richtypo.js/tree/master/example/src).
 
@@ -21,7 +21,7 @@ Have a look at [the example page](https://sapegin.github.io/richtypo.js/) and [i
 
 ## Documentation
 
-[Read the docs](packages/richtypo/Readme.md).
+[Read the docs](docs/Readme.md).
 
 ## Changelog
 
 
@@ -0,0 +1,124 @@
+# Richtypo: HTML typography enhancer for Node.js
+
+## Installation
+
+```bash
+npm install richtypo
+```
+
+## Rules
+
+These modules contain recommended typography rules for different languages:
+
+- [richtypo/rules/en](rules/EnglishRules.md): English
+- [richtypo/rules/fr](rules/FrenchRules.md): French
+- [richtypo/rules/ru](rules/RussianRules.md): Russian
+
+## Usage
+
+### Basic usage
+
+```javascript
+import richtypo from 'richtypo';
+import rules from 'richtypo/rules/en';
+
+const text =
+  'There are 1000 "rules" to enrich your text with Richtypo.';
+
+richtypo(rules, text);
+```
+
+Will produce something like that:
+
+```html
+There are 1,000 “rules” to&nbsp;enrich your text with&nbsp;Richtypo.
+```
+
+> [!NOTE]  
+> The default export of `richtypo/rules/en` contains recommended rules, but you can import each rule separately, see below.
+
+> [!NOTE]  
+> `&nbsp;` is actually rendered by Richtypo as the Unicode character for non-breaking-space (`\xA0`) which works well with any modern browser. We use `&nbsp;` in the examples to make it visible.
+
+> [!NOTE]  
+> Richtypo works better when the input text is cleared from special characters. Use the [he package](https://github.com/mathiasbynens/he) and its [decode function](https://github.com/mathiasbynens/he#hedecodehtml-options) to remove special characters.
+
+### Rules composition
+
+Run only rules you need by importing them separately:
+
+```javascript
+import richtypo from 'richtypo';
+import { spaces, quotes } from 'richtypo/rules/en';
+
+const text =
+  'There are 1000 "rules" to enrich your text with RichTypo.';
+
+// this will only run spaces and quotes rules
+richtypo([spaces, quotes], text);
+```
+
+> [!NOTE]  
+> Have a look at [the example page](https://sapegin.github.io/richtypo.js/) and [its source](https://github.com/sapegin/richtypo.js/tree/master/example/src).
+
+### Custom rules
+
+Rules are JavaScript functions that take a string and return a transformed string. For example, a rule that replaces three dots (`...`) with an ellipsis (`…`) can look like this:
+
+```javascript
+function ellipsis(text) {
+  return text.replace(/\.{2,}/gim, '…');
+}
+```
+
+And then you use it as any other rule:
+
+```javascript
+import richtypo from 'richtypo';
+richtypo(ellipsis, 'Typography everywhere...');
+// -> Typography everywhere…
+```
+
+### Common rules
+
+The [richtypo/rules/common](https://github.com/sapegin/richtypo.js/tree/master/packages/richtypo/rules/common) module contains common typography rules that you can use or extend in your own rules.
+
+For example, the `ellipsis` rule replaces `...` with `…` symbol. Rather than you having to write that rule yourself, you can reexport it as part of your rules.
+
+```js
+import { ellipsis } from 'richtypo/rules/common';
+
+export default {
+  quoteToUnderscore,
+  ellipsis
+};
+```
+
+Some rules such as the `quotes` rule are factory rules and need to be “configured”.
+
+```js
+import { ellipsis, quotesFactory } from 'richtypo/rules/common';
+
+export default {
+  ellipsis,
+  quotes: quotesFactory({ openingQuote: '«', closingQuote: '»' })
+};
+```
+
+Check out the [complete list of common rules](rules/CommonRules.md).
+
+### Definitions
+
+The common rules module exports `definitions`, convenience constants that you can use in your own rules. For example, `definitions.quotes` is set as `'["“”«»‘’]'`, which allows you to write:
+
+```js
+import { definitions } from 'richtypo/rules/common';
+
+function quoteToUnderscore(text) {
+  return text.replace(new RegExp(`${definitions.quotes}`, 'gm'), '_');
+}
+
+export default {
+  quoteToUnderscore
+};
+```
@@ -1,18 +1,19 @@
 # Richtypo common typography rules
 
-A convenience package to create [Richtypo](https://github.com/sapegin/richtypo.js) typography rules for different languages.
+A convenience module to create [Richtypo](https://github.com/sapegin/richtypo.js) typography rules for different languages.
 
-It includes definitions, rules and rule factories.
+It includes definitions, rules, and rule factories.
 
-### Definitions
+## Definitions
 
 Use definitions to improve readability of your rules:
 
 ```js
-import { definitions } from 'richtypo-common-rules';
+import { definitions } from 'richtypo/rules/common';
 const { space, nbsp } = definitions;
-export const numberSigns = text =>
-  text.replace(new RegExp(`№${space}`, 'g'), `№${nbsp}`);
+export function numberSigns(text) {
+  return text.replace(new RegExp(`№${space}`, 'g'), `№${nbsp}`);
+}
 ```
 
 | Definition name     | Description                                                                                                                                |
@@ -33,12 +34,12 @@ export const numberSigns = text =>
 | **`tag`**           | matches any HTML tag                                                                                                                       |
 | **`upperLetter`**   | any uppercase European or Cyrillic letter                                                                                                  |
 
-### Rules
+## Rules
 
 Rules are available as named exports:
 
 ```js
-import { abbrs } from 'richtypo-common-rules';
+import { abbrs } from 'richtypo/rules/common';
 ```
 
 | Rule name            | Description                                                             | Input               | Output                                |
@@ -55,12 +56,12 @@ import { abbrs } from 'richtypo-common-rules';
 
 _¹ `&nbsp;` is actually rendered as a symbol (`\xA0`), not an HTML entity. We use `&nbsp;` only in the docs for readability._
 
-### Rule factories
+## Rule factories
 
 Use factory rules to customize some common rules, like quotes, for your language. For example, quotes in English are written as `“”` while in French they are written as `«»`.
 
 ```js
-import { quotesFactory } from 'richtypo-rules-common';
+import { quotesFactory } from 'richtypo/rules/common';
 export const quotes = quotesFactory({
   openingQuote: '«',
   closingQuote: '»'
 
@@ -1,4 +1,6 @@
-# Richtypo English Rule Package
+# Richtypo English typography rules
+
+The English typography rules for [Richtypo](https://github.com/sapegin/richtypo.js).
 
 Converts this:
 
@@ -18,17 +20,17 @@ on&nbsp;sunny&nbsp;morning…
 > [!NOTE]  
 > `&#x202f;` is and HTML entity for a non-breaking thin space, `&#x2009;` for a thin space, and `&nbsp;` for a normal-width non-breaking space. HTML entities are shown only for clarity, since the spacing characters are invisible, Richtypo inserts Unicode characters instead, so it can be used for HTML, Markdown, or plan text.
 
-### Installation
+## Installation
 
 ```bash
-npm install --save richtypo richtypo-rules-en
+npm install --save richtypo
 ```
 
 ### Basic usage
 
 ```javascript
 import richtypo from 'richtypo';
-import rules from 'richtypo-rules-en';
+import rules from 'richtypo/rules/en';
 
 const text = `The quick brown FOX - weighting 47 kg - jumps over "the lazy dog" on sunny morning...`;
 
@@ -38,18 +40,18 @@ richtypo(rules, text);
 //   jumps over “the lazy dog” on&nbsp;sunny&nbsp;morning…
 ```
 
-The default export of `richtypo-rules-en` contains _recommended_ rules (marked with ¹ in a table below), but you can import each rule separately:
+The default export of `richtypo/rules/en` contains _recommended_ rules (marked with ¹ in a table below), but you can import each rule separately:
 
 ```js
 import richtypo from 'richtypo';
-import { quotes, numberSeparators } from 'richtypo-rules-en';
+import { quotes, numberSeparators } from 'richtypo/rules/en';
 richtypo([quotes, numberSeparators], 'Text "in quotes" - 123456.78');
 // → Text “in quotes” - 123,456.78
 ```
 
-See more examples in [Richtypo docs](https://github.com/sapegin/richtypo.js).
+See more examples in the [Richtypo docs](../Readme.md).
 
-### The rules
+## Rules
 
 | Rule                  | Description                                                                     | Input                    | Output                                                     |
 | --------------------- | ------------------------------------------------------------------------------- | ------------------------ | ---------------------------------------------------------- |
 
@@ -2,17 +2,18 @@
 
 The French typography rules for [Richtypo](https://github.com/sapegin/richtypo.js).
 
-### Installation
+## Installation
 
 ```bash
-npm install --save richtypo-rules-fr
+npm install --save richtypo
 ```
 
-### The rules
+## Rules
 
-The rules of this package include the `spaces`, `abbr`, `emdash`, `amp`, `ellipsis` rules that are directly imported from the [`richtypo-rules-common` package](https://github.com/sapegin/richtypo.js/packages/richtypo-rules-common).
+The rules of this module include the `spaces`, `abbr`, `emdash`, `amp`, `ellipsis` rules that are directly imported from the [`richtypo/rules/common` module](./CommonRules.md).
 
-_For better readability, the non-breaking space symbol `&nbsp;` is replaced with two underscores `__` and the narrow non-breaking space symbol `&#x202f;` with a single underscore `_`\_
+> [!NOTE]  
+> For better readability, the non-breaking space symbol `&nbsp;` is replaced with two underscores `__` and the narrow non-breaking space symbol `&#x202f;` with a single underscore `_`.
 
 | Rule                   | Description                                                                                       | Input                                            | Output                                               |
 | ---------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------ | ---------------------------------------------------- |
 
@@ -17,17 +17,17 @@ to this:
 и&nbsp;ваши уши будут торчать <nobr>из-за</nobr>&nbsp;туч.
 ```
 
-### Installation
+## Installation
 
 ```bash
-npm install --save richtypo richtypo-rules-ru
+npm install --save richtypo
 ```
 
-### Basic usage
+## Basic usage
 
 ```javascript
 import richtypo from 'richtypo';
-import rules from 'richtypo-rules-ru';
+import rules from 'richtypo/rules/ru';
 
 const text =
   'Настругал Папа Карло тысячу БУРАТИН 29 февраля - ' +
@@ -39,21 +39,21 @@ richtypo(rules, text);
 //    используйте «Ричтайпо» и&nbsp;ваши уши будут торчать <nobr>из-за</nobr>&nbsp;туч.
 ```
 
-The default export of `richtypo-rules-ru` contains _recommended_ rules (marked with ¹ in a table below), but you can import each rule separately:
+The default export of `richtypo/rules/ru` contains _recommended_ rules (marked with ¹ in a table below), but you can import each rule separately:
 
 ```js
 import richtypo from 'richtypo';
-import { quotes, numberSeparators } from 'richtypo-rules-ru';
+import { quotes, numberSeparators } from 'richtypo/rules/ru';
 richtypo(
   [quotes, numberSeparators],
   'Текст "в кавычках" - 123456,78'
 );
 // -> Текст «в кавычках» - 123&#x202f;456,78
 ```
 
-See more examples in [Richtypo docs](https://github.com/sapegin/richtypo.js).
+See more examples in [Richtypo docs](../Readme.md).
 
-### The rules
+## Rules
 
 | Rule                   | Description                                                                                      | Input                | Output                     |
 | ---------------------- | ------------------------------------------------------------------------------------------------ | -------------------- | -------------------------- |
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,2 @@`
`1`	`1`	`package.json`
`2`	`2`	`dist/`
`3`		`-/.nx/workspace-data`