Initial commit

.eslintrc.js

@@ -0,0 +1,54 @@
+module.exports = {
+  root: true,
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:vue/vue3-recommended',
+    'prettier',
+  ],
+  parserOptions: {
+    parser: '@typescript-eslint/parser',
+  },
+  plugins: ['@typescript-eslint', 'prettier'],
+  rules: {
+    semi: ['error', 'never'],
+    '@typescript-eslint/no-unused-vars': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    'no-useless-escape': 'warn',
+    '@typescript-eslint/no-import-type-side-effects': 'error',
+    '@typescript-eslint/consistent-type-imports': [
+      'error',
+      { fixStyle: 'inline-type-imports' },
+    ],
+    '@typescript-eslint/ban-types': [
+      'error',
+      {
+        extendDefaults: true,
+        types: {
+          Function: false,
+          '{}': false,
+        },
+      },
+    ],
+    quotes: [
+      'error',
+      'single',
+      {
+        allowTemplateLiterals: true,
+        avoidEscape: true,
+      },
+    ],
+    'max-len': [
+      'warn',
+      {
+        code: 85,
+        ignoreComments: true,
+        ignoreUrls: true,
+        ignoreStrings: true,
+        ignoreTemplateLiterals: true,
+        ignoreRegExpLiterals: true,
+      },
+    ],
+  },
+}

.github/workflows/release.yml

@@ -0,0 +1,42 @@
+name: Release Obsidian plugin
+
+on:
+  push:
+    tags:
+      - '*'
+
+env:
+  PLUGIN_NAME: obsidian-teleprompter
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18.x'
+
+      - name: Build plugin
+        id: build
+        run: |
+          npm install
+          npm run build
+          mkdir ${{ env.PLUGIN_NAME }}
+          cp dist/main.js dist/manifest.json dist/versions.json dist/styles.css ${{ env.PLUGIN_NAME }}
+          zip -r ${{ env.PLUGIN_NAME }}.zip ${{ env.PLUGIN_NAME }}
+
+      - name: Create release
+        id: create_release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          tag="${GITHUB_REF#refs/tags/}"
+
+          gh release create "$tag" \
+            --title="$tag" \
+            --draft \
+            dist/main.js dist/manifest.json dist/styles.css ${{ env.PLUGIN_NAME }}.zip

.gitignore

@@ -0,0 +1,16 @@
+# Intellij
+*.iml
+.idea
+
+# npm
+node_modules
+pnpm-lock.yaml
+package-lock.json
+yarn.lock
+
+# build
+main.js
+*.js.map
+styles.css
+
+dist

.postcssrc.js

@@ -0,0 +1,5 @@
+module.exports = () => {
+  return {
+    plugins: [require('postcss-prefixwrap')(`.app-teleprompter`)],
+  }
+}

.prettierrc

@@ -0,0 +1,8 @@
+{
+  "semi": false,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "singleAttributePerLine": true,
+  "eslintIntegration": true,
+  "tabWidth": 2
+}

CONTRIBUTING.md

@@ -0,0 +1,45 @@
+# Contributing to Obsidian Teleprompter
+Thank you for considering contributing to Obsidian Teleprompter!
+
+## How Can I Contribute?
+
+There are several ways to contribute to this project:
+
+1. **Report Bugs**: If you encounter a bug or issue, please 
+[create a new issue](https://github.com/lumetrium/obsidian-teleprompter/issues/new). 
+Be sure to provide as much detail as possible, 
+including your environment and any steps to reproduce the issue.
+
+2. **Suggest Enhancements**: If you have an idea for an improvement or feature, 
+feel free to [start a discussion](https://github.com/lumetrium/obsidian-teleprompter/discussions/new/choose). 
+Please check for existing discussions to avoid duplication.
+
+3. **Submit Pull Requests**: If you would like to contribute code, 
+please fork this repository, create a new branch, make your changes, 
+and submit a pull request. Be sure to include a clear and concise description 
+of your changes.
+
+## Getting Started
+
+To get started with contributing, follow these steps:
+
+1. Fork the repository on GitHub.
+2. Clone your forked repository to your local machine.
+3. Create a new branch for your changes: `git checkout -b feature/your-feature-name`.
+4. Make your changes and commit them with a descriptive commit message.
+5. Push your changes to your fork on GitHub: `git push origin feature/your-feature-name`.
+6. Open a pull request to the main repository. Please include a clear title and description of your changes.
+
+## Development
+
+1. Install the dependencies with `yarn install`
+2. Start the development server with `yarn dev`
+3. In your file manager, navigate to `<vault>/.obsidian/plugins/`
+4. Create a symlink to the `obsidian-teleprompter/dist` folder
+5. Open Obsidian and enable the plugin in the settings
+
+## Building
+
+```bash
+yarn build
+```