Skip to content

Commit 5f38c53

Browse files
Revise require imports (#3071)
- order (external first) - remove superfluous file extensions - new line after imports - deconstruct (only one time (in `check_config.js`)) - fix path (only one time (in `global-setup.js`))
1 parent d5395ee commit 5f38c53

32 files changed

+449
-48
lines changed

.eslintrc.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"extends": ["eslint:recommended", "plugin:prettier/recommended", "plugin:jsdoc/recommended"],
3-
"plugins": ["prettier", "jsdoc", "jest"],
3+
"plugins": ["prettier", "import", "jsdoc", "jest"],
44
"env": {
55
"browser": true,
66
"es2022": true,
@@ -23,6 +23,7 @@
2323
},
2424
"rules": {
2525
"eqeqeq": "error",
26+
"import/order": "error",
2627
"no-prototype-builtins": "off",
2728
"no-throw-literal": "error",
2829
"no-unused-vars": "off",

CHANGELOG.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ _This release is scheduled to be released on 2023-04-01._
3939
- Update `stylelint` dependencies, switch to `stylelint-config-standard` and handle `stylelint` issues, update `main.css` matching new rules
4040
- Update Eslint config, add new rule and handle issue
4141
- Convert lots of callbacks to async/await
42-
- Fixed Open-Meteo wind speed units
42+
- Revise require imports
4343

4444
### Fixed
4545

@@ -58,6 +58,7 @@ _This release is scheduled to be released on 2023-04-01._
5858
- Fix e2e tests (failed after async changes) by running calendar and newsfeed tests last
5959
- Lint: Use template literals instead of string concatenation
6060
- Fix default alert module to render HTML for title and message
61+
- Fixed Open-Meteo wind speed units
6162

6263
## [2.22.0] - 2023-01-01
6364

js/app.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ require("module-alias/register");
1010

1111
const fs = require("fs");
1212
const path = require("path");
13+
const envsub = require("envsub");
1314
const Log = require("logger");
1415
const Server = require(`${__dirname}/server`);
1516
const Utils = require(`${__dirname}/utils`);
1617
const defaultModules = require(`${__dirname}/../modules/default/defaultmodules`);
17-
const envsub = require("envsub");
1818

1919
// Get version number.
2020
global.version = require(`${__dirname}/../package.json`).version;

js/check_config.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
* By Rodrigo Ramírez Norambuena https://rodrigoramirez.com
66
* MIT Licensed.
77
*/
8-
const Linter = require("eslint").Linter;
9-
const linter = new Linter();
10-
118
const path = require("path");
129
const fs = require("fs");
10+
const { Linter } = require("eslint");
11+
12+
const linter = new Linter();
1313

1414
const rootPath = path.resolve(`${__dirname}/../`);
1515
const Log = require(`${rootPath}/js/logger.js`);

js/electron.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
"use strict";
22

33
const electron = require("electron");
4-
const core = require("./app.js");
5-
const Log = require("logger");
4+
const core = require("./app");
5+
const Log = require("./logger");
66

77
// Config
88
let config = process.env.config ? JSON.parse(process.env.config) : {};

js/node_helper.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
* By Michael Teeuw https://michaelteeuw.nl
55
* MIT Licensed.
66
*/
7-
const Class = require("./class.js");
8-
const Log = require("logger");
97
const express = require("express");
8+
const Log = require("logger");
9+
const Class = require("./class");
1010

1111
const NodeHelper = Class.extend({
1212
init() {

js/server.js

+6-6
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,18 @@
44
* By Michael Teeuw https://michaelteeuw.nl
55
* MIT Licensed.
66
*/
7-
const express = require("express");
7+
const fs = require("fs");
8+
const http = require("http");
9+
const https = require("https");
810
const path = require("path");
11+
const express = require("express");
912
const ipfilter = require("express-ipfilter").IpFilter;
10-
const fs = require("fs");
1113
const helmet = require("helmet");
1214
const socketio = require("socket.io");
13-
const http = require("http");
14-
const https = require("https");
1515

1616
const Log = require("logger");
17-
const Utils = require("./utils.js");
18-
const { cors, getConfig, getHtml, getVersion } = require("./server_functions.js");
17+
const Utils = require("./utils");
18+
const { cors, getConfig, getHtml, getVersion } = require("./server_functions");
1919

2020
/**
2121
* Server

js/server_functions.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
const fetch = require("./fetch");
21
const fs = require("fs");
32
const path = require("path");
43
const Log = require("logger");
4+
const fetch = require("./fetch");
55

66
/**
77
* Gets the config.

modules/default/calendar/calendarfetcher.js

+6-5
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,14 @@
44
* By Michael Teeuw https://michaelteeuw.nl
55
* MIT Licensed.
66
*/
7-
const CalendarUtils = require("./calendarutils");
8-
const Log = require("logger");
9-
const NodeHelper = require("node_helper");
7+
8+
const https = require("https");
9+
const digest = require("digest-fetch");
1010
const ical = require("node-ical");
1111
const fetch = require("fetch");
12-
const digest = require("digest-fetch");
13-
const https = require("https");
12+
const Log = require("logger");
13+
const NodeHelper = require("node_helper");
14+
const CalendarUtils = require("./calendarutils");
1415

1516
/**
1617
*

modules/default/calendar/calendarutils.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@
88
/**
99
* @external Moment
1010
*/
11-
const moment = require("moment");
1211
const path = require("path");
12+
const moment = require("moment");
1313
const zoneTable = require(path.join(__dirname, "windowsZones.json"));
14-
const Log = require("../../../js/logger.js");
14+
const Log = require("../../../js/logger");
1515

1616
const CalendarUtils = {
1717
/**

modules/default/calendar/debug.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
// Alias modules mentioned in package.js under _moduleAliases.
99
require("module-alias/register");
1010

11-
const CalendarFetcher = require("./calendarfetcher.js");
11+
const CalendarFetcher = require("./calendarfetcher");
1212

1313
const url = "https://calendar.google.com/calendar/ical/pkm1t2uedjbp0uvq1o7oj1jouo%40group.calendar.google.com/private-08ba559f89eec70dd74bbd887d0a3598/basic.ics"; // Standard test URL
1414
//const url = "https://www.googleapis.com/calendar/v3/calendars/primary/events/"; // URL for Bearer auth (must be configured in Google OAuth2 first)

modules/default/calendar/node_helper.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
* MIT Licensed.
66
*/
77
const NodeHelper = require("node_helper");
8-
const CalendarFetcher = require("./calendarfetcher.js");
98
const Log = require("logger");
9+
const CalendarFetcher = require("./calendarfetcher");
1010

1111
module.exports = NodeHelper.create({
1212
// Override start method.

modules/default/newsfeed/newsfeedfetcher.js

+5-4
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,13 @@
44
* By Michael Teeuw https://michaelteeuw.nl
55
* MIT Licensed.
66
*/
7-
const Log = require("logger");
7+
8+
const stream = require("stream");
89
const FeedMe = require("feedme");
9-
const NodeHelper = require("node_helper");
10-
const fetch = require("fetch");
1110
const iconv = require("iconv-lite");
12-
const stream = require("stream");
11+
const fetch = require("fetch");
12+
const Log = require("logger");
13+
const NodeHelper = require("node_helper");
1314

1415
/**
1516
* Responsible for requesting an update on the set interval and broadcasting the data.

modules/default/newsfeed/node_helper.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
*/
77

88
const NodeHelper = require("node_helper");
9-
const NewsfeedFetcher = require("./newsfeedfetcher.js");
109
const Log = require("logger");
10+
const NewsfeedFetcher = require("./newsfeedfetcher");
1111

1212
module.exports = NodeHelper.create({
1313
// Override start method.

modules/default/updatenotification/node_helper.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
const GitHelper = require("./git_helper");
2-
const defaultModules = require("../defaultmodules");
31
const NodeHelper = require("node_helper");
2+
const defaultModules = require("../defaultmodules");
3+
const GitHelper = require("./git_helper");
44

55
const ONE_MINUTE = 60 * 1000;
66

0 commit comments

Comments
 (0)