Skip to content

Commit

Permalink
Increase line length to 100 and run formatter on everything
Browse files Browse the repository at this point in the history
  • Loading branch information
charlielee committed Feb 5, 2023
1 parent 419ae54 commit e2a4c59
Show file tree
Hide file tree
Showing 75 changed files with 248 additions and 662 deletions.
4 changes: 3 additions & 1 deletion .prettierrc
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
{}
{
"printWidth": 100
}
26 changes: 13 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,26 +21,26 @@ To build packages for Boats Animator for the current operating system run: `npm

If you find a bug or want to suggest an improvement:

* First check someone else hasn't already reported it in the [issues](https://github.com/charlielee/boats-animator/issues) section.
* If not, create a [new issue](https://github.com/charlielee/boats-animator/issues/new) for it.
* Please make sure to include a clear **title** and **description** as well as any relevant error messages, code snippets or screenshots.
- First check someone else hasn't already reported it in the [issues](https://github.com/charlielee/boats-animator/issues) section.
- If not, create a [new issue](https://github.com/charlielee/boats-animator/issues/new) for it.
- Please make sure to include a clear **title** and **description** as well as any relevant error messages, code snippets or screenshots.

## Submitting changes

If you're working on an improvement to Boats Animator it is usually good practise to add a comment to the [relevant issue](https://github.com/charlielee/boats-animator/issues). Once you are ready to submit your changes you should:

* Create a [new pull request](https://github.com/charlielee/boats-animator/pull/new/master) with a clear list of what you've done *([read more about pull requests](http://help.github.com/pull-requests/))*.
* The pull request should reference any relevant issues and have a clear title.
* The log messages for any commits should also be clear.
* The coding conventions for Boats Animator should be followed.
* If your pull request brings any visible changes, the Markdown based documentation in the `docs` directory should be updated.
- Create a [new pull request](https://github.com/charlielee/boats-animator/pull/new/master) with a clear list of what you've done _([read more about pull requests](http://help.github.com/pull-requests/))_.
- The pull request should reference any relevant issues and have a clear title.
- The log messages for any commits should also be clear.
- The coding conventions for Boats Animator should be followed.
- If your pull request brings any visible changes, the Markdown based documentation in the `docs` directory should be updated.

## Coding conventions

The following conventions should be observed in Boats Animator's code:

* Features with the `Webkit` prefix may be used if there is no standardised method available.
* Code should use **2 space indentation**.
* Trailing white space should be avoided.
* HTML classes and ids are `spaced-using-dashes`. JavaScript variables and functions are `spacedUsingCamelCase`.
* JavaScript functions should be documented using [JSDoc](http://usejsdoc.org/about-getting-started.html) notation.
- Features with the `Webkit` prefix may be used if there is no standardised method available.
- Code should use **2 space indentation**.
- Trailing white space should be avoided.
- HTML classes and ids are `spaced-using-dashes`. JavaScript variables and functions are `spacedUsingCamelCase`.
- JavaScript functions should be documented using [JSDoc](http://usejsdoc.org/about-getting-started.html) notation.
32 changes: 16 additions & 16 deletions docs/features/keyboard-shortcuts.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,23 @@
There are numerous keyboard shortcuts available in Boats Animator; here is a comprehensive list of all of them.

!!! note "Note for macOS users"
The `Command` key should be used in place of any shortcuts listed with `Ctrl` in them.
The `Command` key should be used in place of any shortcuts listed with `Ctrl` in them.

| Action | Primary | Alternative |
|-|-|-|
| Capture frame | **`Ctrl 1`** | **`Enter`** |
| Undo last frame | **`Ctrl Z`** | **`*`** |
| Delete current selected frame | **`Delete`** | **`Backspace`** |
| Toggle audio | **`Ctrl M`** | |
| Play / pause playback | **`Space`** | **`0`** |
| Toggle playback looping | **`8`** | |
| Live view | **`L`** | **`3`** |
| Display first frame | **`Ctrl Left`** | |
| Display last frame | **`Ctrl Right`** | |
| Display previous frame | **`Left`** | **`1`** |
| Display next frame | **`Right`** | **`2`** |
| Toggle grid overlay | **`4`** | |
| Toggle aspect ratio mask | **`5`** | |
| Action | Primary | Alternative |
| ----------------------------- | ---------------- | --------------- |
| Capture frame | **`Ctrl 1`** | **`Enter`** |
| Undo last frame | **`Ctrl Z`** | **`*`** |
| Delete current selected frame | **`Delete`** | **`Backspace`** |
| Toggle audio | **`Ctrl M`** | |
| Play / pause playback | **`Space`** | **`0`** |
| Toggle playback looping | **`8`** | |
| Live view | **`L`** | **`3`** |
| Display first frame | **`Ctrl Left`** | |
| Display last frame | **`Ctrl Right`** | |
| Display previous frame | **`Left`** | **`1`** |
| Display next frame | **`Right`** | **`2`** |
| Toggle grid overlay | **`4`** | |
| Toggle aspect ratio mask | **`5`** | |

## Shortcuts on a numeric keypad

Expand Down
4 changes: 1 addition & 3 deletions docs/features/menu-bar.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
The menu bar contains an assortment of options both to do with the current project and the program in general. The menu bar is located in the [Main Window](/interface/main-window).

!!! note "Note for macOS users"
The menu bar will show some additional items to those listed here. These features are part of macOS rather than Boats Animator.
The menu bar will show some additional items to those listed here. These features are part of macOS rather than Boats Animator.

### File menu

Expand Down Expand Up @@ -51,8 +51,6 @@ The menu bar contains an assortment of options both to do with the current proje

**Toggle Full Screen:** this sets the application to be full screen. Select this option again or use the keyboard shortcut `F11` to leave full screen.



### Help menu

**Documentation:** select this to view Boats Animator's [documentation](https://help.boatsanimator.com/) (the website you are currently on!).
Expand Down
2 changes: 1 addition & 1 deletion docs/features/status-bar.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ This is when a live-feed of the selected camera is displayed in the preview area

### Playback mode

This is when a captured frame is displayed in the preview area. Playback mode can be accessed either by selecting a captured frame from the frame-reel or by selecting the play button.
This is when a captured frame is displayed in the preview area. Playback mode can be accessed either by selecting a captured frame from the frame-reel or by selecting the play button.
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Boats Animator is a free, open-source stop motion animation program. This provid

If you come across a mistake with this documentation please consider [editing it](https://www.github.com/charlielee/boats-animator/tree/master/docs) on GitHub or [contacting the author](https://www.charlielee.uk/contact/) of this project.

* **Official homepage and downloads:** <https://www.charlielee.uk/boats-animator>
* **GitHub repository:** <https://github.com/charlielee/boats-animator>
* **Discord server:** <http://discord.boatsanimator.com>
- **Official homepage and downloads:** <https://www.charlielee.uk/boats-animator>
- **GitHub repository:** <https://github.com/charlielee/boats-animator>
- **Discord server:** <http://discord.boatsanimator.com>

![Main window](img/ba-0-11-0-screenshot-1.png)
2 changes: 1 addition & 1 deletion docs/interface/launcher-window.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ The version of Boats Animator you are currently using is displayed here. The [re

## News feed

This displays the latest news about Boats Animator. Select the title of a news item to view the full post.
This displays the latest news about Boats Animator. Select the title of a news item to view the full post.
5 changes: 3 additions & 2 deletions docs/interface/main-window.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ These buttons affect the playback of captured frames in the [preview area](#prev

**Stop playback:** this will stop playback and jump to the last frame captured.

**Next frame:** this displays one frame after the current frame being displayed.
**Next frame:** this displays one frame after the current frame being displayed.

**Last frame:** this displays the last frame captured.

Expand Down Expand Up @@ -117,6 +117,7 @@ Select this to change the folder Boats Animator exports captured frames to.
#### Export video

Select this to render the captured frames as a video file. You must capture at least one frame for this option to be available. See [Export Video](/features/export-video) for further information.

### Overlays

Overlays are visuals that display over the [preview area](#preview-area). They are for reference only and will not show on capture frames or exported videos.
Expand All @@ -137,4 +138,4 @@ This feature is used to synchronize taking images with a DSLR whose video output

#### Brightness Threshold

This value determines the brightness threshold (0 - 255) between a black frame (DSLR is taking a photo) and visible frame. Note that sufficiently dark scenes are indistinguishable from the black frames a DSLR outputs while taking a photo, so pictures may be erroneously captured as the brightness level floats around the threshold value.
This value determines the brightness threshold (0 - 255) between a black frame (DSLR is taking a photo) and visible frame. Note that sufficiently dark scenes are indistinguishable from the black frames a DSLR outputs while taking a photo, so pictures may be erroneously captured as the brightness level floats around the threshold value.
4 changes: 2 additions & 2 deletions docs/introduction/download.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Thank you for choosing to download Boats Animator! Here is a guide to installing
6. The first time you open Boats Animator you will be prompted to allow access to the camera. Select `OK` if you want to be able to capture images! ![Screenshot of allow camera access prompt](../img/download-mac-3.png)

!!! note "Note"
If you see the following message then select `Cancel`, press `control + click` on the `Boats Animator` entry and choose `Open`. This will display a different message with the option to open the program. This step is only necessary the first time you open Boats Animator.
If you see the following message then select `Cancel`, press `control + click` on the `Boats Animator` entry and choose `Open`. This will display a different message with the option to open the program. This step is only necessary the first time you open Boats Animator.

![Screenshot of developer can't be verified prompt](../img/download-mac-4.png) ![Screenshot of are you sure you want to open prompt](../img/download-mac-5.png)

Expand All @@ -32,7 +32,7 @@ Thank you for choosing to download Boats Animator! Here is a guide to installing
3. Boats Animator will now be added to your application menu.

!!! note "Note"
If you require a different Linux package type then please [visit the code repository](https://github.com/charlielee/boats-animator/) for instructions on building your own binaries.
If you require a different Linux package type then please [visit the code repository](https://github.com/charlielee/boats-animator/) for instructions on building your own binaries.

## Is Boats Animator safe? Why do I have to ignore certain security messages?

Expand Down

0 comments on commit e2a4c59

Please sign in to comment.