Skip to content
This repository has been archived by the owner on Jul 12, 2022. It is now read-only.

Commit

Permalink
Merge pull request #138 from YarnSpinnerTool/136-clean-up-tagline
Browse files Browse the repository at this point in the history
136 clean up tagline
  • Loading branch information
setho246 authored Oct 6, 2021
2 parents 4e0df7b + 1a65815 commit c27c037
Show file tree
Hide file tree
Showing 8 changed files with 956 additions and 605 deletions.
3 changes: 0 additions & 3 deletions .github/issue-branch.yml

This file was deleted.

34 changes: 0 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,2 @@
# YarnSpinnerEditor
**An editor for Yarn Spinner written in Electron / TypeScript.**

Using Webpack v5.32.0, Monaco Editor v0.23.0, & ESLint.

| **Useful NPM commands/aliases:** ||
|---|---|
|npm install| *Installs node module dependencies*|
|npm start|*Alias for npm run build && electron-forge start*|
|npm run lint| *Checks that all files abide by our ESLint parser rules.*|
|npm run lint-fix|*Fixes any ESLint parser errors, where possible.*|

<br>

| **Important NPM info:** |
|---|
* NPM works through the package.json file. If there is a dependency in this file, it means we have explicitly declared "We need this package for our app". Each package is able to require their own sub-packages that ***THEY*** need to run. All of these packages are downloaded and stored in the `node_modules` folder.
* `node_modules` IS NOT COMMITED TO GIT. This means that changes to this folder are not uploaded.
* `npm install` is used to install all packages in the package.json file, and more can be installed by the command: `npm install <packageName>`. If a module has been required by someone else, you need to run this command to bring your installation up to date.

<br>

|**Important git/github info**|
|--|
* Commenting `/cib` on an issue will create a new branch that matches the name and number.
* Please format all commit messages as `#X - What the commit is`, where X is the __ISSUE__ number.
* Remember that all master can be merged into any branch at any time without issues to bring a branch up to date. This can be done in GitKraken by checking out master to make sure you're up to date locally, checkout the branch in question, then drag the master branch onto the branch name. If you have questions, ask Seth.
*

Coding style and rules, subject to change.

| Object Type | Stylistic Convention |
|---|---|
| Constants | UPPERCASE |
| File names | lowercase |
| Everything else | camelCase |
13 changes: 7 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "yarnspinnereditor",
"name": "experimentalyarnspinnereditor",
"version": "0.0.10",
"description": "A new editor for Yarn Spinner",
"main": ".webpack/main",
Expand All @@ -10,7 +10,7 @@
"publish": "electron-forge publish",
"lint": "npx eslint src/ --ext .ts --max-warnings 0",
"lint-fix": "npx eslint src/ --ext .ts --fix",
"web": "webpack --config ./webpack.web.js"
"web": "webpack --config ./webpack.web.js"
},
"keywords": [],
"author": "UTAS Project Team (YarnSpinnerEditor)",
Expand All @@ -23,7 +23,7 @@
"icon": "./assets/icons/YSLogo.png",
"appCategoryType": "public.app-category.utilities",
"extendInfo": "assets/Info.plist",
"name": "Yarn Spinner Editor v0.0.10",
"name": "Experimental Yarn Spinner Editor v0.0.10",
"extraResource": [
"assets/icons/yarnIcon.png",
"assets/icons/YSLogo.png"
Expand All @@ -33,7 +33,7 @@
{
"name": "@electron-forge/maker-squirrel",
"config": {
"name": "yarnspinnereditor"
"name": "ExperimentalYarnSpinnerEditor"
}
},
{
Expand All @@ -56,8 +56,8 @@
"name": "@electron-forge/publisher-github",
"config": {
"repository": {
"owner": "setho246",
"name": "YarnSpinnerEditor"
"owner": "YarnSpinnerTool",
"name": "ExperimentalYarnSpinnerEditor"
}
},
"draft": true
Expand Down Expand Up @@ -96,6 +96,7 @@
"@electron-forge/maker-squirrel": "^6.0.0-beta.59",
"@electron-forge/maker-zip": "^6.0.0-beta.59",
"@electron-forge/plugin-webpack": "6.0.0-beta.59",
"@types/node": "^16.10.3",
"@typescript-eslint/eslint-plugin": "^4.0.1",
"@typescript-eslint/parser": "^4.0.1",
"@vercel/webpack-asset-relocator-loader": "1.6.0",
Expand Down
3 changes: 0 additions & 3 deletions src/controllers/WebIPC.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,11 @@ export class WebIPC
{
yarnFileManager: YarnFileManager
editor: EditorController
fileOpenCount : number

constructor(fileManager: YarnFileManager, editor: EditorController)
{
this.yarnFileManager = fileManager;
this.editor = editor;
this.fileOpenCount = 0;
document.getElementById("file-input").addEventListener("change", this.readFile.bind(this), false);
}

Expand All @@ -24,7 +22,6 @@ export class WebIPC
*/
createNewFile(): void
{
// this.yarnFileManager.createEmptyFile();
addFileToDisplay(this.yarnFileManager.createEmptyFile());
this.editor.setValue(this.yarnFileManager.getCurrentOpenFile().getContents());
this.editor.setReadOnly(false);
Expand Down
4 changes: 2 additions & 2 deletions src/controllers/YarnSettings.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ export function setupSettingsDefaults(): void
});

settings.setSync("font", {
fontname: "Roboto",
fontname: "Roboto, sans-serif",
code: {
fontname: "Roboto"
fontname: "Roboto, sans-serif"
}
});
}
Expand Down
2 changes: 1 addition & 1 deletion src/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@
</div>

<div id="iconThree" horizontal layout>
<p>Yarn Spinner Editor, check out Minecraft!</p>
<p>Experimental Yarn Spinner Editor! Good luck with your game!</p>
<div id="yarnIconDiv">
<img id='YSLogo' src="../img/YSLogo.png" />
</div>
Expand Down
3 changes: 2 additions & 1 deletion src/renderer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ import { EditorController } from "./controllers/EditorController";
import { setActiveFile, addFileToDisplay } from "./controllers/DomHelpers";
import { getThemeName, getFontString, setupSettingsDefaults } from "./controllers/YarnSettings";

setupSettingsDefaults();

const yarnFileManager = new YarnFileManager();
const yarnNodeList = new YarnNodeList();
const themeReader = new ThemeReader();
Expand All @@ -44,7 +46,6 @@ if (ELECTRON_AVAILABLE)
const RendererIPC = require("./controllers/RendererIPC");

ipcHandler = new RendererIPC.RendererIPC(yarnFileManager, editor);
setupSettingsDefaults();
}
else
{
Expand Down
Loading

0 comments on commit c27c037

Please sign in to comment.