Skip to content

Commit

Permalink
Changes in structure of library
Browse files Browse the repository at this point in the history
Sub directories "renderer" and "main" don't exist anymore. The
containing files now have respective suffixes instead, like all the
other modules.

It seems easier and should take less maintenance in the praxis.
  • Loading branch information
c3er committed Sep 8, 2024
1 parent 0a9c710 commit 10a69a5
Show file tree
Hide file tree
Showing 42 changed files with 64 additions and 65 deletions.
6 changes: 3 additions & 3 deletions app/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ const remote = require("@electron/remote")
const about = require("./lib/aboutRenderer")
const common = require("./lib/common")
const contentBlocking = require("./lib/contentBlockingRenderer")
const dialog = require("./lib/renderer/dialog")
const documentRendering = require("./lib/renderer/documentRendering")
const dialog = require("./lib/dialogRenderer")
const documentRendering = require("./lib/documentRenderingRenderer")
const dragDrop = require("./lib/dragDropRenderer")
const encodingLib = require("./lib/encodingRenderer")
const error = require("./lib/errorRenderer")
Expand All @@ -19,7 +19,7 @@ const ipc = require("./lib/ipcRenderer")
const log = require("./lib/log")
const navigation = require("./lib/navigationRenderer")
const rawText = require("./lib/rawTextRenderer")
const renderer = require("./lib/renderer/common")
const renderer = require("./lib/commonRenderer")
const search = require("./lib/searchRenderer")
const settings = require("./lib/settingsRenderer")
const toc = require("./lib/tocRenderer")
Expand Down
4 changes: 2 additions & 2 deletions app/lib/aboutMain.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ const path = require("path")

const common = require("./common")
const ipc = require("./ipcMain")
const menu = require("./main/menu")
const packageJson = require("./main/packageJson")
const menu = require("./menuMain")
const packageJson = require("./packageJsonMain")

const ABOUT_DIALOG_MENU_ID = "about"

Expand Down
2 changes: 1 addition & 1 deletion app/lib/aboutRenderer.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
const dialog = require("./renderer/dialog")
const dialog = require("./dialogRenderer")
const ipc = require("./ipcRenderer")

let electron
Expand Down
4 changes: 2 additions & 2 deletions app/lib/main/cli.js → app/lib/cliMain.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
const path = require("path")

const log = require("../log")
const log = require("./log")

let electron

const DEFAULT_FILE = path.join(__dirname, "..", "..", "..", "README.md")
const DEFAULT_FILE = path.join(__dirname, "..", "..", "README.md")

function extractInternalTarget(args) {
return args.find(arg => arg.startsWith("#"))
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion app/lib/contentBlockingMain.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
const common = require("./common")
const ipc = require("./ipcMain")
const log = require("./log")
const menu = require("./main/menu")
const menu = require("./menuMain")
const navigation = require("./navigationMain")

const UNBLOCK_CONTENT_MENU_ID = "unblock-content"
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
const hljs = require("highlight.js")

const metadata = require("./metadata")
const toc = require("../tocRenderer.js")
const metadata = require("./metadataRenderer")
const toc = require("./tocRenderer")

let _markdown

Expand Down Expand Up @@ -77,7 +77,7 @@ exports.reset = options => {
.use(require("markdown-it-task-checkbox"), { disabled: false })

if (options.emojisEnabled) {
_markdown.use(require("../../../node_modules/markdown-it-emoji/dist/markdown-it-emoji.js"))
_markdown.use(require("markdown-it-emoji/dist/markdown-it-emoji.js"))
}

_shallRenderAsMarkdown = options.renderAsMarkdown
Expand Down
2 changes: 1 addition & 1 deletion app/lib/dragDropRenderer.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
const dialog = require("./renderer/dialog")
const dialog = require("./dialogRenderer")
const ipc = require("./ipcRenderer")
const navigation = require("./navigationRenderer")

Expand Down
2 changes: 1 addition & 1 deletion app/lib/encodingMain.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
const encodingShared = require("./encodingShared")
const ipc = require("./ipcMain")
const storage = require("./main/storage")
const storage = require("./storageMain")

let _mainMenu

Expand Down
2 changes: 1 addition & 1 deletion app/lib/errorRenderer.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
const dialog = require("./renderer/dialog")
const dialog = require("./dialogRenderer")

const DIALOG_ID = "error"

Expand Down
8 changes: 4 additions & 4 deletions app/lib/main/fileHistory.js → app/lib/fileHistoryMain.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
const ipc = require("../ipcMain")
const menu = require("./menu")
const navigation = require("../navigationMain")
const storage = require("./storage")
const ipc = require("./ipcMain")
const menu = require("./menuMain")
const navigation = require("./navigationMain")
const storage = require("./storageMain")

let electron

Expand Down
8 changes: 0 additions & 8 deletions app/lib/main/packageJson.js

This file was deleted.

File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion app/lib/navigationMain.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
const encodingLib = require("./encodingMain")
const ipc = require("./ipcMain")
const menu = require("./main/menu")
const menu = require("./menuMain")

const BACK_MENU_ID = "back"
const FORWARD_MENU_ID = "forward"
Expand Down
2 changes: 1 addition & 1 deletion app/lib/navigationRenderer.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ const common = require("./common")
const error = require("./errorRenderer")
const file = require("./file")
const ipc = require("./ipcRenderer")
const renderer = require("./renderer/common")
const renderer = require("./commonRenderer")

let electron

Expand Down
7 changes: 7 additions & 0 deletions app/lib/packageJsonMain.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
const fs = require("fs")
const path = require("path")

let _obj

exports.obj = () =>
_obj ?? (_obj = JSON.parse(fs.readFileSync(path.join(__dirname, "..", "..", "package.json"))))
2 changes: 1 addition & 1 deletion app/lib/rawTextMain.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const ipc = require("./ipcMain")
const menu = require("./main/menu")
const menu = require("./menuMain")

const VIEW_RAW_TEXT_MENU_ID = "view-raw-text"

Expand Down
2 changes: 1 addition & 1 deletion app/lib/searchMain.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const ipc = require("./ipcMain")
const menu = require("./main/menu")
const menu = require("./menuMain")

const shared = require("./searchShared")

Expand Down
4 changes: 2 additions & 2 deletions app/lib/searchRenderer.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
const dialog = require("./renderer/dialog")
const dialog = require("./dialogRenderer")
const ipc = require("./ipcRenderer")
const renderer = require("./renderer/common")
const renderer = require("./commonRenderer")

const shared = require("./searchShared")

Expand Down
6 changes: 3 additions & 3 deletions app/lib/settingsMain.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
const fileHistory = require("./main/fileHistory")
const fileHistory = require("./fileHistoryMain")
const fileLib = require("./file")
const ipc = require("./ipcMain")
const menu = require("./main/menu")
const menu = require("./menuMain")
const navigation = require("./navigationMain")
const storage = require("./main/storage")
const storage = require("./storageMain")
const toc = require("./tocMain")

const SETTINGS_MENU_ID = "settings"
Expand Down
2 changes: 1 addition & 1 deletion app/lib/settingsRenderer.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const common = require("./common")
const dialog = require("./renderer/dialog")
const dialog = require("./dialogRenderer")
const fileLib = require("./file")
const ipc = require("./ipcRenderer")

Expand Down
8 changes: 4 additions & 4 deletions app/lib/main/storage.js → app/lib/storageMain.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
const fs = require("fs")
const path = require("path")

const common = require("../common")
const dragDrop = require("../dragDropShared")
const log = require("../log")
const navigation = require("../navigationMain")
const common = require("./common")
const dragDrop = require("./dragDropShared")
const log = require("./log")
const navigation = require("./navigationMain")

let electron

Expand Down
4 changes: 2 additions & 2 deletions app/lib/tocMain.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
const ipc = require("./ipcMain")
const menu = require("./main/menu")
const menu = require("./menuMain")
const navigation = require("./navigationMain")
const storage = require("./main/storage")
const storage = require("./storageMain")

const shared = require("./tocShared")

Expand Down
2 changes: 1 addition & 1 deletion app/lib/tocRenderer.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
const common = require("./common")
const ipc = require("./ipcRenderer")
const metadata = require("./renderer/metadata")
const metadata = require("./metadataRenderer")

const shared = require("./tocShared")

Expand Down
2 changes: 1 addition & 1 deletion app/lib/zoomMain.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
const ipc = require("./ipcMain")
const settings = require("./settingsMain")
const storage = require("./main/storage")
const storage = require("./storageMain")

const STEP = 0.1
const MIN_FACTOR = 0.1
Expand Down
8 changes: 4 additions & 4 deletions app/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,20 @@ const electron = require("electron")
const remote = require("@electron/remote/main")

const about = require("./lib/aboutMain")
const cli = require("./lib/main/cli")
const cli = require("./lib/cliMain")
const common = require("./lib/common")
const contentBlocking = require("./lib/contentBlockingMain")
const encodingLib = require("./lib/encodingMain")
const error = require("./lib/errorMain")
const fileHistory = require("./lib/main/fileHistory")
const fileHistory = require("./lib/fileHistoryMain")
const ipc = require("./lib/ipcMain")
const log = require("./lib/log")
const menu = require("./lib/main/menu")
const menu = require("./lib/menuMain")
const navigation = require("./lib/navigationMain")
const rawText = require("./lib/rawTextMain")
const search = require("./lib/searchMain")
const settings = require("./lib/settingsMain")
const storage = require("./lib/main/storage")
const storage = require("./lib/storageMain")
const toc = require("./lib/tocMain")
const zoom = require("./lib/zoomMain")

Expand Down
4 changes: 2 additions & 2 deletions test/integration.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ describe("Integration tests with single app instance", () => {
})

describe('Library "storage"', () => {
const storage = require("../app/lib/main/storage")
const storage = require("../app/lib/storageMain")

describe("Application settings", () => {
let applicationSettings
Expand Down Expand Up @@ -693,7 +693,7 @@ describe("Integration tests with their own app instance each", () => {
})

describe("Recent files list", () => {
const fileHistory = require("../app/lib/main/fileHistory")
const fileHistory = require("../app/lib/fileHistoryMain")

async function subMenuItems(id) {
return await _app.evaluate(
Expand Down
2 changes: 1 addition & 1 deletion test/libAbout.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ describe("About dialog", () => {

describe("Renderer part", () => {
const about = require("../app/lib/aboutRenderer")
const dialog = require("../app/lib/renderer/dialog")
const dialog = require("../app/lib/dialogRenderer")
const ipc = require("../app/lib/ipcRenderer")

beforeEach(() => {
Expand Down
2 changes: 1 addition & 1 deletion test/libDialog.spec.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
const assert = require("assert")

const dialog = require("../app/lib/renderer/dialog")
const dialog = require("../app/lib/dialogRenderer")

describe("Dialog", () => {
beforeEach(dialog.reset)
Expand Down
2 changes: 1 addition & 1 deletion test/libDocumentRendering.spec.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
const assert = require("assert")
const lodashClonedeep = require("lodash.clonedeep")

const documentRendering = require("../app/lib/renderer/documentRendering")
const documentRendering = require("../app/lib/documentRenderingRenderer")

describe("Document rendering", () => {
const defaultOptions = {
Expand Down
2 changes: 1 addition & 1 deletion test/libDragDrop.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ const mocking = require("./mocking")
describe("Drag & drop", () => {
describe("Renderer part", () => {
const error = require("../app/lib/errorRenderer")
const dialog = require("../app/lib/renderer/dialog")
const dialog = require("../app/lib/dialogRenderer")
const dragDrop = require("../app/lib/dragDropRenderer")
const ipc = require("../app/lib/ipcRenderer")

Expand Down
2 changes: 1 addition & 1 deletion test/libEncoding.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ describe("Encoding library", () => {
describe("Main part", () => {
const encodingLib = require("../app/lib/encodingMain")
const ipc = require("../app/lib/ipcMain")
const storage = require("../app/lib/main/storage")
const storage = require("../app/lib/storageMain")

const encoding = "utf16le"
const filename = "testfile"
Expand Down
2 changes: 1 addition & 1 deletion test/libError.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ describe("Error dialog", () => {
})

describe("Renderer part", () => {
const dialog = require("../app/lib/renderer/dialog")
const dialog = require("../app/lib/dialogRenderer")
const error = require("../app/lib/errorRenderer")

beforeEach(() => {
Expand Down
2 changes: 1 addition & 1 deletion test/libMetadata.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ const assert = require("assert")

const lib = require("./testLib")

const metadata = require("../app/lib/renderer/metadata")
const metadata = require("../app/lib/metadataRenderer")

describe("Markdown metadata rendering", () => {
describe("metadata.hide", () => {
Expand Down
2 changes: 1 addition & 1 deletion test/libNavigation.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ describe("Navigation", () => {
describe("Main part", () => {
const ipc = require("../app/lib/ipcMain")
const navigation = require("../app/lib/navigationMain")
const storage = require("../app/lib/main/storage")
const storage = require("../app/lib/storageMain")

function prepareAssertion(expectedFilePath) {
mocking.clear()
Expand Down
2 changes: 1 addition & 1 deletion test/libSearch.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ describe("Search", () => {

describe("Renderer part", () => {
const ipc = require("../app/lib/ipcRenderer")
const renderer = require("../app/lib/renderer/common")
const renderer = require("../app/lib/commonRenderer")
const search = require("../app/lib/searchRenderer")

function initSearch() {
Expand Down
4 changes: 2 additions & 2 deletions test/libSettings.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ const lib = require("./testLib")
const mocking = require("./mocking")

const ipc = require("../app/lib/ipcShared")
const storage = require("../app/lib/main/storage")
const storage = require("../app/lib/storageMain")

function registerSettingsMessage(expectedApplicationSettings, expectedDocumentSettings) {
mocking.register.ipc.rendererOn(
Expand Down Expand Up @@ -65,7 +65,7 @@ describe("Settings", () => {
})

describe("Renderer part", () => {
const dialog = require("../app/lib/renderer/dialog")
const dialog = require("../app/lib/dialogRenderer")
const ipc = require("../app/lib/ipcRenderer")
const settings = require("../app/lib/settingsRenderer")

Expand Down
2 changes: 1 addition & 1 deletion test/libStorage.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ const assert = require("assert")
const lib = require("./testLib")
const mocking = require("./mocking")

const storage = require("../app/lib/main/storage")
const storage = require("../app/lib/storageMain")

describe("Storage", () => {
describe("File history", () => {
Expand Down
2 changes: 1 addition & 1 deletion test/libToc.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ const assert = require("assert")
const lib = require("./testLib")
const mocking = require("./mocking")

const documentRendering = require("../app/lib/renderer/documentRendering")
const documentRendering = require("../app/lib/documentRenderingRenderer")
const toc = require("../app/lib/tocRenderer")

function assertSections(content, rootSection) {
Expand Down
2 changes: 1 addition & 1 deletion test/libZoom.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ describe("Zoom library", () => {
describe("Main part", () => {
const ipc = require("../app/lib/ipcMain")
const settings = require("../app/lib/settingsMain")
const storage = require("../app/lib/main/storage")
const storage = require("../app/lib/storageMain")

const zoom = require("../app/lib/zoomMain")

Expand Down

0 comments on commit 10a69a5

Please sign in to comment.