الإيداع الأول

.eslintrc.json

@@ -0,0 +1,37 @@
+{
+  "root": true,
+  "env": {
+    "es6": true,
+    "node": false,
+    "browser": false
+  },
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  },
+  "extends": ["eslint:recommended", "plugin:jsdoc/recommended"],
+  "plugins": ["jsdoc"],
+  "rules": {
+    "no-console": "error",
+    "jsdoc/no-defaults": "off",
+    "jsdoc/require-param-description": "off",
+    "jsdoc/require-property-description": "off",
+    "jsdoc/require-returns-description": "off"
+  },
+  "overrides": [
+    {
+      "files": ["{test,tests}/**/*"],
+      "env": {
+        "mocha": true,
+        "es6": true,
+        "node": false,
+        "browser": false
+      },
+      "extends": ["eslint:recommended", "plugin:mocha/recommended"],
+      "plugins": ["mocha"],
+      "rules": {
+        "mocha/max-top-level-suites": "off"
+      }
+    }
+  ]
+}

.gitattributes

@@ -0,0 +1,6 @@
+# الكشف التلقائي عن الملفات النصية وإجراء تسوية LF
+* text=auto eol=lf
+
+# تشير إلى جميع الملفات الثنائية حقاً التي ينبغي تعديلها
+*.png binary
+*.jpg binary

.github/workflows/docs.yml

@@ -0,0 +1,49 @@
+name: توليد الوثائق
+
+on:
+  release:
+    types: [released, published]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: 'pages'
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    environment:
+      name: صفحات-جيتهاب
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: الفحص
+        uses: actions/checkout@v4
+
+      - name: إعداد Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 'lts/*'
+          registry-url: https://registry.npmjs.org
+
+      - name: تثبيت التبعيات
+        run: npm ci
+
+      - name: توليد الوثائق
+        run: npm run docs
+
+      - name: إعداد الصفحات
+        uses: actions/configure-pages@v4
+
+      - name: رفع الملف
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './docs'
+
+      - name: النشر على صفحات جيتهاب
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/release.yml

@@ -0,0 +1,37 @@
+name: إصدار
+
+on:
+  workflow_dispatch:
+
+jobs:
+  release:
+    permissions:
+      contents: write
+      issues: write
+      pull-requests: write
+
+    name: إصدار
+    runs-on: ubuntu-latest
+    steps:
+      - name: الفحص
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: إعداد Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 'lts/*'
+          registry-url: https://registry.npmjs.org
+
+      - name: تثبيت التبعيات
+        run: npm ci && npm i --no-save @semantic-release/changelog @semantic-release/git
+
+      - name: توليد الأنواع
+        run: npm run types
+
+      - name: الإصدار
+        run: npx semantic-release
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test.yml

@@ -0,0 +1,37 @@
+name: إختبار
+on:
+  push:
+  pull_request:
+
+concurrency:
+  # المجموعة بناءً على اسم العملية والطلب المسحوب إذا وُجد، إذا لم يوجد طلب مسحوب، دعها تعمل حتى تعمل علامات النقل
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: إختبار
+    runs-on: ubuntu-latest
+    steps:
+      - name: الفحص
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: إعداد Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 'lts/*'
+          registry-url: https://registry.npmjs.org
+
+      - name: تثبيت التبعيات
+        run: npm ci
+
+      - name: فحص الكود
+        run: npm run lint
+
+      - name: تنسيق الكود
+        run: npm run format
+
+      - name: إختبار الكود
+        run: npm test

.gitignore

@@ -0,0 +1,134 @@
+# الناتج المولد
+types/
+docs/
+
+# السجلات
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# تقارير التشخيص (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# بيانات التشغيل
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# الدليل للمكتبات المؤشرة التي تولدها jscoverage/JSCover
+lib-cov
+
+# دليل التغطية المستخدم من قبل أدوات مثل istanbul
+coverage
+*.lcov
+
+# تغطية اختبار nyc
+.nyc_output
+
+# تخزين مؤقت لـ Grunt (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# دليل تبعيات Bower (https://bower.io/)
+bower_components
+
+# تكوين node-waf
+.lock-wscript
+
+# الإضافات الثنائية المترجمة (https://nodejs.org/api/addons.html)
+build/Release
+
+# دلائل التبعيات
+node_modules/
+jspm_packages/
+
+# دليل تبعيات Snowpack (https://snowpack.dev/)
+web_modules/
+
+# ذاكرة التخزين المؤقت لـ TypeScript
+*.tsbuildinfo
+
+# دليل ذاكرة التخزين المؤقت لـ npm الاختياري
+.npm
+
+# ذاكرة التخزين المؤقت لـ eslint الاختيارية
+.eslintcache
+
+# ذاكرة التخزين المؤقت لـ stylelint الاختيارية
+.stylelintcache
+
+# ذاكرة التخزين المؤقت لـ Microbundle
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# سجل REPL الاختياري
+.node_repl_history
+
+# ناتج 'npm pack'
+*.tgz
+
+# ملف النزاهة لـ Yarn
+.yarn-integrity
+
+# ملفات متغيرات البيئة dotenv
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# ذاكرة التخزين المؤقت لـ parcel-bundler (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# ناتج بناء Next.js
+.next
+out
+
+# ناتج بناء/توليد Nuxt.js
+.nuxt
+dist
+
+# ملفات Gatsby
+.cache/
+# قم بالتعليق على السطر الخاص بالعامة إذا كان مشروعك يستخدم Gatsby وليس Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# ناتج بناء vuepress
+.vuepress/dist
+
+# دليل مؤقت وذاكرة التخزين المؤقت لـ vuepress v2.x
+.temp
+.cache
+
+# ذاكرة التخزين المؤقت والملفات المولدة لـ Docusaurus
+.docusaurus
+
+# دلائل Serverless
+.serverless/
+
+# ذاكرة التخزين المؤقت لـ FuseBox
+.fusebox/
+
+# ملفات DynamoDB المحلية
+.dynamodb/
+
+# ملف منفذ TernJS
+.tern-port
+
+# يخزن إصدارات VSCode المستخدمة لاختبار إضافات VSCode
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

.prettierrc.json

@@ -0,0 +1,8 @@
+{
+  "tabWidth": 2,
+  "semi": false,
+  "useTabs": false,
+  "singleQuote": true,
+  "endOfLine": "lf",
+  "trailingComma": "none"
+}

.releaserc.json

@@ -0,0 +1,17 @@
+{
+  "branches": [
+    "+([0-9])?(.{+([0-9]),x}).x",
+    "main",
+    "next",
+    { "name": "beta", "prerelease": true },
+    { "name": "alpha", "prerelease": true }
+  ],
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    "@semantic-release/changelog",
+    "@semantic-release/npm",
+    "@semantic-release/git",
+    "@semantic-release/github"
+  ]
+}

.vscode/extensions.json

@@ -0,0 +1,16 @@
+{
+  "recommendations": [
+    "streetsidesoftware.code-spell-checker-arabic",
+    "streetsidesoftware.code-spell-checker",
+    "usernamehw.errorlens",
+    "dbaeumer.vscode-eslint",
+    "yzhang.markdown-all-in-one",
+    "christian-kohler.npm-intellisense",
+    "christian-kohler.path-intellisense",
+    "idered.npm",
+    "esbenp.prettier-vscode",
+    "gruntfuggly.todo-tree",
+    "chakrounanas.turbo-console-log",
+    "redhat.vscode-yaml"
+  ]
+}