feat(Reader): v0.1.0

Author: xwcoder

.editorconfig

@@ -0,0 +1,11 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true

.env.development

@@ -0,0 +1 @@
+NODE_ENV=development

.env.production

@@ -0,0 +1 @@
+NODE_ENV=production

.eslintrc.js

@@ -0,0 +1,61 @@
+module.exports = {
+  root: true,
+  env: {
+    browser: true,
+    node: true,
+    es2023: true,
+  },
+  parser: '@typescript-eslint/parser',
+  plugins: [
+    '@typescript-eslint',
+    'sonarjs',
+  ],
+  extends: [
+    'airbnb',
+    'plugin:react/jsx-runtime',
+    'plugin:sonarjs/recommended',
+    'plugin:import/typescript',
+  ],
+  settings: {
+    'import/core-modules': ['electron'],
+    'import/resolver': {
+      typescript: {},
+      node: {
+        extensions: ['.ts', '.tsx', '.js', '.jsx'],
+      },
+    },
+  },
+  rules: {
+    'max-len': ['error', { code: 120 }],
+    complexity: ['error', { max: 10 }],
+    semi: ['error', 'never'],
+    'no-confusing-arrow': ['off'],
+    'no-restricted-syntax': ['off'],
+    'no-unused-vars': ['off'],
+    '@typescript-eslint/no-unused-vars': ['error'],
+    'no-nested-ternary': ['off'],
+
+    'react/jsx-filename-extension': ['error', { extensions: ['.tsx'] }],
+    'react/require-default-props': ['off'],
+    'jsx-a11y/click-events-have-key-events': ['off'],
+    'jsx-a11y/interactive-supports-focus': ['off'],
+
+    'import/extensions': ['error', {
+      js: 'never',
+      jsx: 'never',
+      ts: 'never',
+      tsx: 'never',
+      json: 'always',
+    }],
+    'import/no-extraneous-dependencies': ['error', {
+      devDependencies: [
+        '**/*.test.js',
+        '**/*.spec.js',
+        'build/**/*',
+        './*.js',
+        './*.ts',
+      ],
+    }],
+    'import/prefer-default-export': ['off'],
+  },
+}

.github/workflows/release.yml

@@ -0,0 +1,29 @@
+name: Release
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  Release:
+    strategy:
+      matrix:
+        os: [macos-latest, ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    permissions: write-all
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+      - name: Install dependens
+        run: npm ci
+      - name: Build
+        run: npm run build
+      - name: Pre release
+        run: node scripts/prepackage.js
+      - name: Publish
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: npm run publish
+

.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+
+node_modules/
+
+out/
+dist/

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit ${1}

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx lint-staged

.lintstagedrc.json

@@ -0,0 +1,3 @@
+{
+  "*.{js,jsx,ts,tsx}": "eslint"
+}

README.md

@@ -1 +1,26 @@
-# emo
+# emo
+
+I wish to develop **emo** as an **all in one** application. Now, it includes the follow apps:
+  - **Reader** - A rss reader.
+
+## Features
+- Support dark mode.
+- Support i18n (English and Simplified).
+- Support data sharing and synchronization between devices using cloud storage.
+
+## Reader
+![Reader screenshot](./docs/images/screenshot.png)
+
+### Keyboard shortcus
+- g then i: Go to Unread items
+- g then s: Go to Starred items
+- g then a: Go to All items
+- \* then a: Select all items
+- \* then n: Deselect all items
+- x: Select/Deselect item
+- s: Toggle star
+- j: Next item
+- k: Previous item
+- o: Open item
+- u: Close item
+- v: Open item in browser