Refactor to TypeScript and Telegraf v4

.editorconfig

@@ -9,8 +9,6 @@ charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 
-[*.md]
-trim_trailing_whitespace = false
-
-[*.txt]
-trim_trailing_whitespace = false
+[*.{yml,yaml}]
+indent_style = space
+indent_size = 2

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.github/dependabot.yml

@@ -0,0 +1,20 @@
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/"
+    open-pull-requests-limit: 30
+    schedule:
+      interval: "weekly"
+      time: "03:37" # UTC
+    commit-message:
+      prefix: "build(npm):"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    commit-message:
+      prefix: "ci(actions):"

.github/workflows/nodejs.yml

@@ -0,0 +1,27 @@
+name: Node.js
+
+on:
+  push:
+  pull_request:
+  schedule:
+    # Check if it works with current dependencies (weekly on Wednesday 2:32 UTC)
+    - cron: '32 2 * * 3'
+
+jobs:
+  test:
+    name: Node.js ${{ matrix.node-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        node-version:
+          - 16
+          - 14
+          - 12
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm install
+      - run: npm test

.gitignore

@@ -1,34 +1,6 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-
-# Runtime data
-pids
-*.pid
-*.seed
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
+.nyc_output
+/*-*.*.*.tgz
 coverage
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (http://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directory
+dist
 node_modules
-
-# Optional npm cache directory
-.npm
-
-# Optional REPL history
-.node_repl_history
-package-lock.json
+yarn.lock

README.md

@@ -0,0 +1,3 @@
+# i18n for grammY and Telegraf
+
+This fork is now available as [@grammyjs/i18n](https://github.com/grammyjs/i18n) and works with both grammY and Telegraf.

examples/example-grammy-bot.ts

@@ -0,0 +1,65 @@
+import * as path from 'path'
+
+import {Bot, Context as BaseContext, session} from 'grammy'
+
+import {I18n, pluralize, I18nContext} from '../source'
+
+interface Session {
+  apples?: number;
+}
+
+interface MyContext extends BaseContext {
+  readonly i18n: I18nContext;
+  session: Session;
+}
+
+// I18n options
+const i18n = new I18n({
+  directory: path.resolve(__dirname, 'locales'),
+  defaultLanguage: 'en',
+  sessionName: 'session',
+  useSession: true,
+  templateData: {
+    pluralize,
+    uppercase: (value: string) => value.toUpperCase(),
+  },
+})
+
+const bot = new Bot<MyContext>(process.env['BOT_TOKEN']!)
+bot.use(session())
+bot.use(i18n.middleware())
+
+// Start message handler
+bot.command('start', async ctx => ctx.reply(ctx.i18n.t('greeting'), {parse_mode: 'HTML'}))
+
+// Set locale to `en`
+bot.command('en', async ctx => {
+  ctx.i18n.locale('en-US')
+  return ctx.reply(ctx.i18n.t('greeting'), {parse_mode: 'HTML'})
+})
+
+// Set locale to `ru`
+bot.command('ru', async ctx => {
+  ctx.i18n.locale('ru')
+  return ctx.reply(ctx.i18n.t('greeting'), {parse_mode: 'HTML'})
+})
+
+// Add apple to cart
+bot.command('add', async ctx => {
+  ctx.session.apples = ctx.session.apples ?? 0
+  ctx.session.apples++
+  const message = ctx.i18n.t('cart', {apples: ctx.session.apples})
+  return ctx.reply(message)
+})
+
+// Add apple to cart
+bot.command('cart', async ctx => {
+  const message = ctx.i18n.t('cart', {apples: ctx.session.apples ?? 0})
+  return ctx.reply(message)
+})
+
+// Checkout
+bot.command('checkout', async ctx => ctx.reply(ctx.i18n.t('checkout')))
+
+// eslint-disable-next-line @typescript-eslint/no-floating-promises
+bot.start()

examples/example-telegraf-bot.ts

@@ -0,0 +1,65 @@
+import * as path from 'path'
+
+import {Telegraf, Context as BaseContext, session} from 'telegraf'
+
+import {I18n, pluralize, I18nContext} from '../source'
+
+interface Session {
+  apples?: number;
+}
+
+interface MyContext extends BaseContext {
+  readonly i18n: I18nContext;
+  session: Session;
+}
+
+// I18n options
+const i18n = new I18n({
+  directory: path.resolve(__dirname, 'locales'),
+  defaultLanguage: 'en',
+  sessionName: 'session',
+  useSession: true,
+  templateData: {
+    pluralize,
+    uppercase: (value: string) => value.toUpperCase(),
+  },
+})
+
+const bot = new Telegraf<MyContext>(process.env['BOT_TOKEN']!)
+bot.use(session())
+bot.use(i18n.middleware())
+
+// Start message handler
+bot.command('start', async ctx => ctx.reply(ctx.i18n.t('greeting'), {parse_mode: 'HTML'}))
+
+// Set locale to `en`
+bot.command('en', async ctx => {
+  ctx.i18n.locale('en-US')
+  return ctx.reply(ctx.i18n.t('greeting'), {parse_mode: 'HTML'})
+})
+
+// Set locale to `ru`
+bot.command('ru', async ctx => {
+  ctx.i18n.locale('ru')
+  return ctx.reply(ctx.i18n.t('greeting'), {parse_mode: 'HTML'})
+})
+
+// Add apple to cart
+bot.command('add', async ctx => {
+  ctx.session.apples = ctx.session.apples ?? 0
+  ctx.session.apples++
+  const message = ctx.i18n.t('cart', {apples: ctx.session.apples})
+  return ctx.reply(message)
+})
+
+// Add apple to cart
+bot.command('cart', async ctx => {
+  const message = ctx.i18n.t('cart', {apples: ctx.session.apples ?? 0})
+  return ctx.reply(message)
+})
+
+// Checkout
+bot.command('checkout', async ctx => ctx.reply(ctx.i18n.t('checkout')))
+
+// eslint-disable-next-line @typescript-eslint/no-floating-promises
+bot.launch()

examples/locales/en.yaml

@@ -1,3 +1,4 @@
 greeting: <b>Hello ${uppercase(from.first_name)}!</b>
 cart: ${from.first_name}, in your cart ${pluralize(apples, 'apple', 'apples')}
 checkout: Thank you
+help: help