summaryrefslogtreecommitdiff
path: root/ext/js/core
diff options
context:
space:
mode:
authortoasted-nutbread <toasted-nutbread@users.noreply.github.com>2024-02-18 08:01:22 -0500
committerGitHub <noreply@github.com>2024-02-18 13:01:22 +0000
commit90449bc745546f0f25bc93ee4b06d21b7c0210e8 (patch)
tree728153aaa4588a7340c3f3a45008989c0f5521b3 /ext/js/core
parentc2e3f60e51529f05284fea5f5bc1afcd1674f5ca (diff)
Log update (#701)
* Don't export Logger * Rename logger.js to log.js * Move helper function * Update extension name configuration * Simplify docs * Move issue URL to a field * Simplify context * Remove optional params that are never used * Configure backend * Update eslint * Simplify * Rename function * Simplify _api reference * Simplify docs * Remove unused log levels (except 'log') * Add log function * Rename for more clear intent * Use log.log
Diffstat (limited to 'ext/js/core')
-rw-r--r--ext/js/core/log-utilities.js28
-rw-r--r--ext/js/core/log.js (renamed from ext/js/core/logger.js)103
2 files changed, 75 insertions, 56 deletions
diff --git a/ext/js/core/log-utilities.js b/ext/js/core/log-utilities.js
new file mode 100644
index 00000000..b7e0c914
--- /dev/null
+++ b/ext/js/core/log-utilities.js
@@ -0,0 +1,28 @@
+/*
+ * Copyright (C) 2024 Yomitan Authors
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+/**
+ * @param {import('log').LogLevel} errorLevel
+ * @returns {number}
+ */
+export function logErrorLevelToNumber(errorLevel) {
+ switch (errorLevel) {
+ case 'warn': return 1;
+ case 'error': return 2;
+ default: return 0;
+ }
+}
diff --git a/ext/js/core/logger.js b/ext/js/core/log.js
index 6cf1cc1f..8401cc2b 100644
--- a/ext/js/core/logger.js
+++ b/ext/js/core/log.js
@@ -20,35 +20,59 @@ import {EventDispatcher} from './event-dispatcher.js';
import {ExtensionError} from './extension-error.js';
/**
- * This class handles logging of messages to the console and triggering
- * an event for log calls.
+ * This class handles logging of messages to the console and triggering an event for log calls.
* @augments EventDispatcher<import('log').Events>
*/
-export class Logger extends EventDispatcher {
- /**
- * Creates a new instance.
- */
+class Logger extends EventDispatcher {
constructor() {
super();
/** @type {string} */
- this._extensionName = 'Yomitan';
- try {
- const {name, version} = chrome.runtime.getManifest();
- this._extensionName = `${name} ${version}`;
- } catch (e) {
- // NOP
- }
+ this._extensionName = 'Extension';
+ /** @type {?string} */
+ this._issueUrl = 'https://github.com/themoeway/yomitan/issues';
+ }
+
+ /**
+ * @param {string} extensionName
+ */
+ configure(extensionName) {
+ this._extensionName = extensionName;
+ }
+
+ /**
+ * @param {unknown} message
+ * @param {...unknown} optionalParams
+ */
+ log(message, ...optionalParams) {
+ /* eslint-disable no-console */
+ console.log(message, ...optionalParams);
+ /* eslint-enable no-console */
+ }
+
+ /**
+ * Logs a warning.
+ * @param {unknown} error The error to log. This is typically an `Error` or `Error`-like object.
+ */
+ warn(error) {
+ this.logGenericError(error, 'warn');
}
/**
- * Logs a generic error. This will trigger the 'log' event with the same arguments as the function invocation.
+ * Logs an error.
* @param {unknown} error The error to log. This is typically an `Error` or `Error`-like object.
- * @param {import('log').LogLevel} level The level to log at. Values include `'info'`, `'debug'`, `'warn'`, and `'error'`.
- * Other values will be logged at a non-error level.
- * @param {?import('log').LogContext} [context] An optional context object for the error which should typically include a `url` field.
*/
- log(error, level, context = null) {
- if (typeof context !== 'object' || context === null) {
+ error(error) {
+ this.logGenericError(error, 'error');
+ }
+
+ /**
+ * Logs a generic error.
+ * @param {unknown} error The error to log. This is typically an `Error` or `Error`-like object.
+ * @param {import('log').LogLevel} level
+ * @param {import('log').LogContext} [context]
+ */
+ logGenericError(error, level, context) {
+ if (typeof context === 'undefined') {
context = {url: location.href};
}
@@ -103,52 +127,19 @@ export class Logger extends EventDispatcher {
if (typeof errorData !== 'undefined') {
message += `\nData: ${JSON.stringify(errorData, null, 4)}`;
}
- message += '\n\nIssues can be reported at https://github.com/themoeway/yomitan/issues';
+ if (this._issueUrl !== null) {
+ message += `\n\nIssues can be reported at ${this._issueUrl}`;
+ }
/* eslint-disable no-console */
switch (level) {
case 'log': console.log(message); break;
- case 'info': console.info(message); break;
- case 'debug': console.debug(message); break;
case 'warn': console.warn(message); break;
case 'error': console.error(message); break;
}
/* eslint-enable no-console */
- this.trigger('log', {error, level, context});
- }
-
- /**
- * Logs a warning. This function invokes `log` internally.
- * @param {unknown} error The error to log. This is typically an `Error` or `Error`-like object.
- * @param {?import('log').LogContext} context An optional context object for the error which should typically include a `url` field.
- */
- warn(error, context = null) {
- this.log(error, 'warn', context);
- }
-
- /**
- * Logs an error. This function invokes `log` internally.
- * @param {unknown} error The error to log. This is typically an `Error` or `Error`-like object.
- * @param {?import('log').LogContext} context An optional context object for the error which should typically include a `url` field.
- */
- error(error, context = null) {
- this.log(error, 'error', context);
- }
-
- /**
- * @param {import('log').LogLevel} errorLevel
- * @returns {import('log').LogErrorLevelValue}
- */
- getLogErrorLevelValue(errorLevel) {
- switch (errorLevel) {
- case 'log':
- case 'info':
- case 'debug':
- return 0;
- case 'warn': return 1;
- case 'error': return 2;
- }
+ this.trigger('logGenericError', {error, level, context});
}
}