Skip to content

Commit

Permalink
Applied prettier.
Browse files Browse the repository at this point in the history
  • Loading branch information
ransome1 committed Jan 17, 2025
1 parent b2033ba commit dfde333
Show file tree
Hide file tree
Showing 49 changed files with 590 additions and 572 deletions.
9 changes: 5 additions & 4 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@ name: Bug report
about: Report a bug and help improving sleek
title: ''
labels: 'bug'

---

## Bug Report

### Important ###
Please follow this template strictly when reporting bugs.
### Important

Please follow this template strictly when reporting bugs.

Reports that do not adhere to this template will not be addressed and will be closed.

Expand All @@ -26,10 +26,11 @@ Explain what you expected to happen.
Explain what actually happened.

**Steps to Reproduce:**

1. Open the app.
2. Click on 'X' button.
3. Observe the unexpected behavior.
4. ...

**Screenshots:**
If applicable, include screenshots that demonstrate the bug.
If applicable, include screenshots that demonstrate the bug.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ blank_issues_enabled: false
contact_links:
- name: Get help in GitHub Discussions
url: https://github.com/ransome1/sleek/discussions
about: Have a question? Not sure if your issue affects everyone reproducibly? The quickest way to get help is on GitHub Discussions!
about: Have a question? Not sure if your issue affects everyone reproducibly? The quickest way to get help is on GitHub Discussions!
12 changes: 7 additions & 5 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,20 @@ name: Feature request
about: Suggest a feature for sleek
title: ''
labels: 'feature request'

---

## Feature Request

### Important ###
### Important

Requests that do not adhere to this template will not be addressed and will be closed.

If your feature request is more of a **loose idea** and you are **unsure about its implementation or potential impact**, please discuss it first in the [GitHub Discussions section](https://github.com/ransome1/sleek/discussions).

### What problem does it solve? ###
### What problem does it solve?

Write a detailed explanation of the problem addressed by this feature. Describe the intended functionality and how it contributes to improving the overall app experience.

### How does the user interface change to accommodate this request? ###
Get creative; Provide a detailed description of how you envision incorporating this feature into sleek.
### How does the user interface change to accommodate this request?

Get creative; Provide a detailed description of how you envision incorporating this feature into sleek.
68 changes: 33 additions & 35 deletions .github/workflows/code-scan.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,32 +17,32 @@ jobs:
name: njsscan
runs-on: ubuntu-latest
steps:
- name: Checkout the code
uses: actions/checkout@master
- name: nodejsscan scan
id: njsscan
uses: ajinabraham/njsscan-action@master
with:
args: '. --sarif --output results.sarif || true'
- name: Upload njsscan report
uses: github/codeql-action/upload-sarif@v3
with:
sarif_file: results.sarif
- name: Checkout the code
uses: actions/checkout@master
- name: nodejsscan scan
id: njsscan
uses: ajinabraham/njsscan-action@master
with:
args: '. --sarif --output results.sarif || true'
- name: Upload njsscan report
uses: github/codeql-action/upload-sarif@v3
with:
sarif_file: results.sarif
codecov:
needs: njsscan
name: Codecov
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
language: [ 'javascript' ]
language: ['javascript']
steps:
- name: Checkout code
uses: actions/checkout@master
- name: Set up latest available Nodejs
uses: actions/setup-node@master
- name: Install dependencies
run: yarn install
run: yarn install
- name: Build
run: yarn build
- name: Run tests
Expand All @@ -58,31 +58,29 @@ jobs:
strategy:
fail-fast: false
matrix:
language: [ 'javascript' ]
language: ['javascript']
steps:
- name: Checkout repository
uses: actions/checkout@master
- name: Set up latest available Nodejs
uses: actions/setup-node@master
- name: Initialize CodeQL
uses: github/codeql-action/init@v3
with:
languages: ${{ matrix.language }}
- name: Autobuild
uses: github/codeql-action/autobuild@v3
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v3
- name: Checkout repository
uses: actions/checkout@master
- name: Set up latest available Nodejs
uses: actions/setup-node@master
- name: Initialize CodeQL
uses: github/codeql-action/init@v3
with:
languages: ${{ matrix.language }}
- name: Autobuild
uses: github/codeql-action/autobuild@v3
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v3
mirror:
name: Mirror code to opencode.net
runs-on: ubuntu-latest
needs: codeql
steps:
- uses: actions/checkout@master
with:
fetch-depth: 0
- uses: pixta-dev/repository-mirroring-action@v1
with:
target_repo_url:
[email protected]:ransome/sleek.git
ssh_private_key:
${{ secrets.GITLAB_SSH_PRIVATE_KEY }}
- uses: actions/checkout@master
with:
fetch-depth: 0
- uses: pixta-dev/repository-mirroring-action@v1
with:
target_repo_url: [email protected]:ransome/sleek.git
ssh_private_key: ${{ secrets.GITLAB_SSH_PRIVATE_KEY }}
16 changes: 8 additions & 8 deletions .github/workflows/prepare-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ jobs:
name: Trigger Flathub build bot
runs-on: ubuntu-latest
steps:
- name: Trigger Flathub build
uses: peter-evans/repository-dispatch@v3
with:
token: ${{ secrets.TRIGGER_FLATHUB_BUILD }}
repository: ransome1/com.github.ransome1.sleek
event-type: trigger-flathub-build
client-payload: '{"commit_id": "${{ github.sha }}"}'
- name: Trigger Flathub build
uses: peter-evans/repository-dispatch@v3
with:
token: ${{ secrets.TRIGGER_FLATHUB_BUILD }}
repository: ransome1/com.github.ransome1.sleek
event-type: trigger-flathub-build
client-payload: '{"commit_id": "${{ github.sha }}"}'
macos:
name: MacOS (Prepare release)
runs-on: ${{ matrix.os }}
Expand Down Expand Up @@ -98,4 +98,4 @@ jobs:
with:
max_attempts: 5
github_token: ${{ secrets.github_token }}
release: ${{ startsWith(github.ref, 'refs/tags/') }}
release: ${{ startsWith(github.ref, 'refs/tags/') }}
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Contribution Guidelines

Click here to see sleek's [contributing guidelines](https://github.com/ransome1/sleek/wiki/Contributing-Guidelines).
Click here to see sleek's [contributing guidelines](https://github.com/ransome1/sleek/wiki/Contributing-Guidelines).
2 changes: 1 addition & 1 deletion FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
github: ransome1
github: ransome1
5 changes: 4 additions & 1 deletion PRIVACY.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Privacy Policy for sleek

This document contains the types of information that is collected by sleek and how I as its developer use it.

I myself am very sensible about my own privacy and in these days of massive and needless collection of personal data, I want sleek to be different. I am not interested in who sleek's users are and will therefore not gather any sensitive data.
Expand All @@ -8,11 +9,13 @@ However, I want to know how many users are actively using sleek and, in case a u
The analysis can be disabled in the settings window.

## Event logging

Events are mostly clicks on buttons, checkboxes, links and so on. This information is valuable to me, as it tells me which features are used and which ones are not. Those insights help me keeping sleek clean of unnecessary features that will interfere with sleek's usability. This type of logging will not collect any personal information like the content of your todos or filters. It will only tell me which elements have been clicked.

## Cookies

sleek itself doesn't use cookies. Data that needs to be persisted is written to a local file that does not transfer anywhere else.

By using sleek, you hereby consent to this Privacy Policy.

If you have additional questions or require more information about this Privacy Policy, do not hesitate to contact me.
If you have additional questions or require more information about this Privacy Policy, do not hesitate to contact me.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# sleek

![image](https://github.com/ransome1/sleek/assets/11188741/304d2da2-e8bd-4901-9d12-04a0f5426317)

### sleek is an open-source (FOSS) todo manager based on the todo.txt syntax. It's available for Windows, macOS and Linux
Expand All @@ -10,43 +11,50 @@ All classic todo.txt attributes are supported and enhanced by additional feature
sleek is available for Windows, macOS and Linux, and in several languages. [Screenshots can be found here](https://github.com/ransome1/sleek/wiki/Screenshots). For more detailed information, [please refer to the sleek wiki](https://github.com/ransome1/sleek/wiki).

### ❤️ Sponsor sleek
Pushing sleek to the Apple and Microsoft app stores creates annual costs. You can help covering these by [sponsoring the project](https://github.com/sponsors/ransome1).

The project is also participating in GitSponsors, a platform that supports open-source developers through funding:

[<img src="https://api.gitsponsors.com/api/badge/img?id=301463691" height="20">](https://api.gitsponsors.com/api/badge/link?p=D8BfxYAU1DxX1VNxduDJQbIUSYf6yxW/d0eMica/OVIxkPYetoBj4zOxaMZ2M2UWztuE+Q9zJ62tLJqTewz4UzgisFtstXsGEBi0GLqJTMhvroMtJREbEjD6DFlvykacEc+7ak5lmmxN6ZECCJbm7w==)
Pushing sleek to the Apple and Microsoft app stores creates annual costs. You can help covering these by [sponsoring the project](https://github.com/sponsors/ransome1).

### 👩🏾‍💻 This project needs your support

sleek's backlog is becoming increasingly populated, yet our capacity remains limited. If you are skilled in `React`, `TypeScript`, `Electron`, or `Jest/Playwright` you can support this project. Here you'll find our backlog: https://github.com/users/ransome1/projects/3. For those interested, [we've updated our contribution guidelines](https://github.com/ransome1/sleek/wiki/Contributing-Guidelines). The `develop` branch reflects the most recent progress.

### Get sleek from Apple Mac App Store

https://apps.apple.com/us/app/sleek-todo-manager/id1614704209

### Get sleek from Microsoft Store

<a href="//www.microsoft.com/store/apps/9NWM2WXF60KR?cid=storebadge&ocid=badge" target="blank"><img src='https://developer.microsoft.com/store/badges/images/English_get-it-from-MS.png' alt='English badge' width='180'/></a>

### Get sleek from Snap Store

[![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/sleek)

Install sleek from [Snap Store](https://snapcraft.io/sleek) using: `sudo snap install sleek`

### Get sleek from Flathub

<a href="https://flathub.org/apps/details/com.github.ransome1.sleek" target="blank"><img width='180' alt="Download on Flathub" src="https://flathub.org/assets/badges/flathub-badge-en.png"/></a>

Install sleek from [Flathub](https://flathub.org/apps/details/com.github.ransome1.sleek) using: `flatpak install flathub com.github.ransome1.sleek`

Run it using: `flatpak run com.github.ransome1.sleek`

### Get sleek from Homebrew

Install sleek from [Homebrew](https://formulae.brew.sh/cask/sleek).
`brew install --cask sleek`

### Get sleek from Arch User Repository

Install sleek from [AUR](https://aur.archlinux.org/packages/sleek/).

1. Setup [Yay](https://github.com/Jguer/yay#installation)
2. `yay -S sleek`

### Download sleek

You can download sleek for Windows, macOS and Linux from

- [SourceForge](https://sourceforge.net/p/sleek/)
- [GitHub](https://github.com/ransome1/sleek/releases/latest)
10 changes: 5 additions & 5 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@
The following versions of sleek are provided with security updates.

| Version | Supported |
|---------|-----------|
| 2.x.x | |
| 1.x.x | |
| 0.x.x | |
| ------- | --------- |
| 2.x.x ||
| 1.x.x ||
| 0.x.x ||

## Reporting a Vulnerability

If you find a vulnerability in sleek, please send as much detail as possible to [email protected].
If you find a vulnerability in sleek, please send as much detail as possible to [email protected].
4 changes: 2 additions & 2 deletions electron-builder.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ dmg:
width: 550
height: 400
x: 130
y: 410
y: 410
masDev:
entitlements: ./build/entitlements.mas.plist
entitlementsInherit: ./build/entitlements.mas.inherit.plist
Expand Down Expand Up @@ -59,7 +59,7 @@ win:
arch:
- arm64
- x64
- ia32
- ia32
icon: ./resources/icon.ico
artifactName: ${productName}-${version}-win-${arch}.${ext}
nsis:
Expand Down
22 changes: 11 additions & 11 deletions snap/snapcraft.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: sleek
base: core24
version: "2.0.16-rc.1"
version: '2.0.16-rc.1'
summary: todo.txt manager for Linux, free and open-source (FOSS)
description: |
sleek is an open-source (FOSS) todo manager based on the todo.txt syntax. Stripped down to only the most necessary features, and with a clean and simple interface, sleek aims to help you focus on getting things done.
Expand All @@ -27,23 +27,23 @@ apps:
environment:
DISABLE_WAYLAND: 1
TMPDIR: $XDG_RUNTIME_DIR
PATH: "$SNAP/usr/sbin:$SNAP/usr/bin:$SNAP/sbin:$SNAP/bin:$PATH"
PATH: '$SNAP/usr/sbin:$SNAP/usr/bin:$SNAP/sbin:$SNAP/bin:$PATH'
SNAP_DESKTOP_RUNTIME: $SNAP/gnome-platform
GTK_USE_PORTAL: '1'
extensions: [gnome]
plugs:
- desktop
- home
- browser-support
- network
- removable-media
- desktop
- home
- browser-support
- network
- removable-media
parts:
sleek:
plugin: nil
build-environment:
- PATH: "$PATH:$SNAPCRAFT_PART_BUILD/node_modules/.bin"
- PATH: '$PATH:$SNAPCRAFT_PART_BUILD/node_modules/.bin'
build-snaps:
- node/22/stable
- node/22/stable
source: .
override-build: |
if [ -n "$http_proxy" ]; then
Expand All @@ -58,9 +58,9 @@ parts:
mv dist/linux* \
$SNAPCRAFT_PART_INSTALL/sleek
stage-packages:
- libnss3
- libnss3
cleanup:
after: [ sleek ]
after: [sleek]
plugin: nil
build-snaps: [gnome-42-2204]
override-prime: |
Expand Down
Loading

0 comments on commit dfde333

Please sign in to comment.