Skip to content

Commit

Permalink
Add Prettier with config matching main repo (#111)
Browse files Browse the repository at this point in the history
* Add Prettier with config matching main repo

* Run Prettier on all files
  • Loading branch information
j-f1 authored Mar 4, 2023
1 parent d7274c2 commit 89cf9a1
Show file tree
Hide file tree
Showing 74 changed files with 1,035 additions and 870 deletions.
14 changes: 6 additions & 8 deletions .github/ISSUE_TEMPLATE/DOCUMENTATION.yml
Original file line number Diff line number Diff line change
@@ -1,22 +1,20 @@
name: "🗄️ Documentation"
name: '🗄️ Documentation'
description: Create a new ticket for documentation you would like to create or would like creating.
title: "🗄️ [Documentation] - <title>"
labels: [
"documentation"
]
title: '🗄️ [Documentation] - <title>'
labels: ['documentation']
body:
- type: textarea
id: description
attributes:
label: "Description"
label: 'Description'
description: Please enter an explicit description of what you would like documenting
placeholder: Short and explicit description of your idea...
validations:
required: true
- type: textarea
id: screenshot
attributes:
label: "Screenshots"
label: 'Screenshots'
description: If applicable, add screenshots to help explain what you would like documenting.
value: |
![DESCRIPTION](LINK.png)
Expand All @@ -26,7 +24,7 @@ body:
- type: dropdown
id: category
attributes:
label: "Category"
label: 'Category'
description: What category does this idea fall into?
multiple: true
options:
Expand Down
14 changes: 5 additions & 9 deletions .github/ISSUE_TEMPLATE/IMPROVEMENT.yml
Original file line number Diff line number Diff line change
@@ -1,25 +1,21 @@
name: "⭐ Documentation Improvement"
name: '⭐ Documentation Improvement'
description: Create a new ticket to improve existing documentation.
title: "⭐ [Documentation] - <title>"
labels: [
"documentation",
"enhancement"
]
title: '⭐ [Documentation] - <title>'
labels: ['documentation', 'enhancement']
body:
- type: textarea
id: description
attributes:
label: "Description"
label: 'Description'
description: Please enter a description of what needs changing
placeholder: What needs changing?
validations:
required: true
- type: input
id: url
attributes:
label: "Documentation URL"
label: 'Documentation URL'
description: Please enter the GitHub URL to the documentation file
placeholder: ex. https://github.com/USERNAME/REPO_NAME/blob/main/docs/Budgeting/categories.md
validations:
required: true

18 changes: 8 additions & 10 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -1,30 +1,28 @@
name: "🐛 Bug Report"
name: '🐛 Bug Report'
description: Create a new ticket for a bug.
title: "🐛 [BUG] - <title>"
labels: [
"bug"
]
title: '🐛 [BUG] - <title>'
labels: ['bug']
body:
- type: textarea
id: description
attributes:
label: "Description"
label: 'Description'
description: Please enter an explicit description of your issue
placeholder: Short and explicit description of your incident...
validations:
required: true
- type: input
id: reprod-url
attributes:
label: "Reproduction URL"
label: 'Reproduction URL'
description: Please enter your GitHub URL to provide a reproduction of the issue
placeholder: ex. https://github.com/USERNAME/REPO-NAME
validations:
required: true
- type: textarea
id: reprod
attributes:
label: "Reproduction steps"
label: 'Reproduction steps'
description: Please enter an explicit description of your issue
value: |
1. Go to '...'
Expand All @@ -37,7 +35,7 @@ body:
- type: textarea
id: screenshot
attributes:
label: "Screenshots"
label: 'Screenshots'
description: If applicable, add screenshots to help explain your problem.
value: |
![DESCRIPTION](LINK.png)
Expand All @@ -47,7 +45,7 @@ body:
- type: dropdown
id: browsers
attributes:
label: "Browsers"
label: 'Browsers'
description: What browsers are you seeing the problem on ?
multiple: true
options:
Expand Down
12 changes: 5 additions & 7 deletions .github/ISSUE_TEMPLATE/change-request.yml
Original file line number Diff line number Diff line change
@@ -1,22 +1,20 @@
name: "🔧 Change Request"
name: '🔧 Change Request'
description: Create a new ticket for a change to the site, this doesn't include documentation.
title: "🔧 [CHANGE] - <title>"
labels: [
"change"
]
title: '🔧 [CHANGE] - <title>'
labels: ['change']
body:
- type: textarea
id: description
attributes:
label: "Description"
label: 'Description'
description: Please enter an explicit description of what you would like to change
placeholder: Short and explicit description of your change idea...
validations:
required: true
- type: textarea
id: expbehav
attributes:
label: "Expected behavior"
label: 'Expected behavior'
description: Please explain how your change should work
placeholder: Short and explicit description of your how this change should work.
validations:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ permissions:
id-token: write

concurrency:
group: "pages"
group: 'pages'
cancel-in-progress: true

jobs:
Expand All @@ -24,7 +24,7 @@ jobs:
- name: Setup Node
uses: actions/setup-node@v3
with:
node-version: "16"
node-version: '16'
cache: npm
- name: Setup Pages
uses: actions/configure-pages@v2
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/stale.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Close inactive issues
on:
schedule:
- cron: "30 1 * * *"
- cron: '30 1 * * *'

jobs:
close-issues:
Expand All @@ -14,9 +14,9 @@ jobs:
with:
days-before-issue-stale: 90
days-before-issue-close: 30
stale-issue-label: "stale"
stale-issue-message: "🚧🚨 This issue is being marked as stale due to 90 days of inactivity. 🚧🚨"
close-issue-message: "🚧🚨 This issue was closed because it has been inactive for 14 days since being marked as stale. 🚧🚨"
stale-issue-label: 'stale'
stale-issue-message: '🚧🚨 This issue is being marked as stale due to 90 days of inactivity. 🚧🚨'
close-issue-message: '🚧🚨 This issue was closed because it has been inactive for 14 days since being marked as stale. 🚧🚨'
days-before-pr-stale: -1
days-before-pr-close: -1
only-labels: 'needs triage'
Expand Down
2 changes: 2 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.docusaurus
build
5 changes: 5 additions & 0 deletions .prettierrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"singleQuote": true,
"trailingComma": "all",
"arrowParens": "avoid"
}
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ more_data:
or: arrays
---
```

### Document Headings

The below shows how a document should be laid out.
Expand Down
9 changes: 5 additions & 4 deletions docs/Accounts/Transactions/bulk-editing-transactions.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'Bulk Actions'
title: 'Bulk Actions'
---

It can be extremely useful to be able to bulk edit or duplicate a number of transactions at once.
Expand Down Expand Up @@ -32,15 +32,15 @@ Then Search or Filter to identify the transactions that you wish to change and s

![](/img/bulk-edit/4.png)

Now you are ready to alter one or more components of these selected transactions. Go to the drop down top right (in this case the arrow below “30 transactions”)
Now you are ready to alter one or more components of these selected transactions. Go to the drop down top right (in this case the arrow below “30 transactions”)

![](/img/bulk-edit/5.png)

Now select the component you wish to change. In this case we are going to add a Note

![](/img/bulk-edit/6.png)

Press “Enter” and all the selected transactions are changed.
Press “Enter” and all the selected transactions are changed.

![](/img/bulk-edit/7.png)

Expand All @@ -49,6 +49,7 @@ Here is another example. This time to bulk change a Category.
![](/img/bulk-edit/8.png)

### Duplicating transactions

To duplicate transactions (one or more), simply navigate to the Accounts page as described above, and select the tick box in the left hand column. Once selected, go to the drop down menu on the top right of the page, above the table header. Open the menu and select “Duplicate”. Your newly duplicated transactions will appear in the transactions table!

![](/img/duplicate-transactions.png)
![](/img/duplicate-transactions.png)
1 change: 0 additions & 1 deletion docs/Accounts/Transactions/importing-trans.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,3 @@ Actual will automatically try to avoid duplicate transactions. This works best w
After checking the **id**, Actual will look for transactions around the same date, with the same amount, and with a similar payee. If it thinks the transaction already exists, it will avoid creating a duplicate. This means you can manually enter a transaction, and later it will be matched when you import it from a file.

It will always favor the imported transaction. It if matches a manually-entered transaction, it will update the date to match the imported transaction. **Keeping dates in sync with your bank is important** as it allows you compare the balance at any point in time with your bank.

10 changes: 5 additions & 5 deletions docs/Accounts/addaccount.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This page explains how to manage Bank Accounts within your Actual instance.

## Adding a new account

You can add an account to your budget at any time, however when you first install Actual you can use the `Add Account` button in the middle of the screen.
You can add an account to your budget at any time, however when you first install Actual you can use the `Add Account` button in the middle of the screen.

![](/img/AddAccount.png)

Expand All @@ -16,10 +16,10 @@ You can also add an account using the `+` button next to the account list, as sh

A box will appear asking you to fill in a few options

* Give your account a name
* Decide what type your account is
* Is the account on or off budget
* The current account balance
- Give your account a name
- Decide what type your account is
- Is the account on or off budget
- The current account balance

:::note
Off budget means that the balance is not reflected when you assign money to categories in your budget register
Expand Down
2 changes: 1 addition & 1 deletion docs/Accounts/connecting-your-bank.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ Title: 'Conn Bank'

# Connecting Your Bank

This will be added in a future release of Actual!
This will be added in a future release of Actual!
3 changes: 1 addition & 2 deletions docs/Accounts/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ Depending on your usage, savings accounts can either be on or off the budget. If
2. Fill out the form describing the account.
3. Press **Create**


## Closing or deleting an account

1. Navigate to the account by clicking on it in the sidebar
Expand All @@ -29,4 +28,4 @@ Depending on your usage, savings accounts can either be on or off the budget. If

You can still access this account under **Closed Accounts** in the sidebar, and even reopen it from the same actions menu.

**If you want to delete an account** even if it has existing balances, in the popup after selecting **Close Account**, click the **force close** at the bottom.
**If you want to delete an account** even if it has existing balances, in the popup after selecting **Close Account**, click the **force close** at the bottom.
1 change: 0 additions & 1 deletion docs/Accounts/payees.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,3 @@ You can individually select payees and merge them if you like, but filtering & m
## Transfer payees

[Transfers](/accounts/transfers/) are just special payees that indicate which account to transfer to/from. Since they are payees, you can create rules like normal which will automatically create transfers. Find them at the bottom of the **Manage Payees** screen if you want to create custom rules.

20 changes: 11 additions & 9 deletions docs/Accounts/reconcile.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,26 @@ title: 'Reconciliation'
---

# Reconciliation
Keeping your Actual account ledgers consistent with your band ledgers is important to maintain a healthy budget and know exactly how much currency is available to spend. Some choose to reconcile monthly, weekly, or even daily. Actual provides the Reconciliation tool to help manage this process.

Keeping your Actual account ledgers consistent with your band ledgers is important to maintain a healthy budget and know exactly how much currency is available to spend. Some choose to reconcile monthly, weekly, or even daily. Actual provides the Reconciliation tool to help manage this process.

## Work flow
When you reconcile, you will be comparing your bank statement, print or online, against Actual's ledger for that account. If you have made transactions against the budget that have not been verified against your account the **cleared** flag will be shown in grey. If the transaction has been moved out of the pending section (online) of your bank statement, click the grey circle to turn it green. This is a visual indication that the transaction is in both your budget and in your account statement, and they match.

By clicking on the green balance in the header of the account view, two more category balances will come into view. The **cleared total** only includes transactions that have been cleared while the **uncleared total** will represent the transactions you have entered but may not have entered the bank statement yet.
When you reconcile, you will be comparing your bank statement, print or online, against Actual's ledger for that account. If you have made transactions against the budget that have not been verified against your account the **cleared** flag will be shown in grey. If the transaction has been moved out of the pending section (online) of your bank statement, click the grey circle to turn it green. This is a visual indication that the transaction is in both your budget and in your account statement, and they match.

By clicking on the green balance in the header of the account view, two more category balances will come into view. The **cleared total** only includes transactions that have been cleared while the **uncleared total** will represent the transactions you have entered but may not have entered the bank statement yet.

![](/img/reconcile-1.png)

## Starting the Reconciliation tool

Press the icon that has 3 horizontally spaced dots in the right hand corner of the account ledger and then press **Reconcile**.

Let's imagine that we have just checked our account balance for our Ally Savings account and the current balance is $1229.18. We enter the balance we want to match into the Reconciliation tool and press **Reconcile**.
Let's imagine that we have just checked our account balance for our Ally Savings account and the current balance is $1229.18. We enter the balance we want to match into the Reconciliation tool and press **Reconcile**.

![](/img/reconcile-2.png)

The tool will tell us exactly how much is different than the budget ledger. Now we can check the Actual ledger against the bank ledger and watch the difference come closer to 0. In this case, we're looking for transactions that add up to 262.72. This is much easier by looking at the Actual ledger and bank statement side by side to match the transactions.
The tool will tell us exactly how much is different than the budget ledger. Now we can check the Actual ledger against the bank ledger and watch the difference come closer to 0. In this case, we're looking for transactions that add up to 262.72. This is much easier by looking at the Actual ledger and bank statement side by side to match the transactions.

![](/img/reconcile-3.png)

Expand All @@ -30,18 +32,18 @@ When the cleared amount of the Actual account ledger and the value you entered i

## Using the Reconciliation tool for Off-Budget Asset tracking

Some use off-budget accounts to track values of assets such as vehicles, real estate, retirement accounts, or other investment accounts or property. The reconciliation tool is useful to update these values as well. Let's say we have a house that was valued at 358,700 but with current changes in the market it is now valued at 385,000. We go to the ledger for the house, choose the reconciliation tool, and enter 385,000 as the new value into the tool.
Some use off-budget accounts to track values of assets such as vehicles, real estate, retirement accounts, or other investment accounts or property. The reconciliation tool is useful to update these values as well. Let's say we have a house that was valued at 358,700 but with current changes in the market it is now valued at 385,000. We go to the ledger for the house, choose the reconciliation tool, and enter 385,000 as the new value into the tool.

![](/img/reconcile-5.png)

The tool tells us that we have a gain of 26,400.

![](/img/reconcile-6.png)

We can enter this difference into the ledger. We used **Reconciliation** as the payee, but you can use whatever payee you'd like. By using a payee that is not used anywhere else you can find these adjustment transactions using the search features more easily.
We can enter this difference into the ledger. We used **Reconciliation** as the payee, but you can use whatever payee you'd like. By using a payee that is not used anywhere else you can find these adjustment transactions using the search features more easily.

![](/img/reconcile-7.png)

When you finish entering the transaction, make sure you **clear** it by clicking on the grey checkmark on the right hand side. You should now have a reconciliation tool that is reporting that it is finished and you can enjoy a new higher net worth.
When you finish entering the transaction, make sure you **clear** it by clicking on the grey checkmark on the right hand side. You should now have a reconciliation tool that is reporting that it is finished and you can enjoy a new higher net worth.

![](/img/reconcile-8.png)
![](/img/reconcile-8.png)
Loading

0 comments on commit 89cf9a1

Please sign in to comment.